Class: R509::SPKI

Inherits:

Object

• Object
• R509::SPKI

show all

Includes:

IOHelpers

Defined in:

lib/r509/spki.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) key readonly

  Returns the value of attribute key.

• - (Object) spki readonly

  Returns the value of attribute spki.

Instance Method Summary (collapse)

• - (Integer) bit_strength

  Returns the bit strength of the key used to create the SPKI.

• - (String) curve_name

  Returns the short name of the elliptic curve used to generate the public key if the key is EC.

• - (Boolean) dsa?

  Returns whether the public key is DSA.

• - (Boolean) ec?

  Returns whether the public key is EC.

• - (SPKI) initialize(opts = {}) constructor

  A new instance of SPKI.

• - (String) key_algorithm

  Returns key algorithm (RSA/DSA).

• - (OpenSSL::PKey::RSA) public_key

  Public key.

• - (Boolean) rsa?

  Returns whether the public key is RSA.

• - (String) to_der

  Converts the SPKI into the DER format.

• - (String) to_pem (also: #to_s)

  Converts the SPKI into the PEM format.

• - (Boolean) verify_signature

  Verifies the integrity of the signature on the SPKI.

• - (Object) write_der(filename_or_io)

  Writes the SPKI into the DER format.

• - (Object) write_pem(filename_or_io)

  Writes the SPKI into the PEM format.

Methods included from IOHelpers

#read_data, read_data, #write_data, write_data

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# File 'lib/r509/spki.rb', line 14

def initialize(opts={})
  if not opts.kind_of?(Hash)
    raise ArgumentError, 'Must provide a hash of options'
  elsif not opts.has_key?(:spki) and not opts.has_key?(:key)
    raise ArgumentError, 'Must provide either :spki or :key'
  end

  if opts.has_key?(:key)
    if opts[:key].kind_of?(R509::PrivateKey)
      @key = opts[:key]
    else
      @key = R509::PrivateKey.new(:key => opts[:key])
    end
  end
  if opts.has_key?(:spki)
    spki = opts[:spki]
    # first let's try cleaning up the input a bit so OpenSSL is happy with it
    # OpenSSL hates SPKAC=
    spki.sub!("SPKAC=","")
    # it really hates newlines (Firefox loves 'em)
    # so let's normalize line endings
    spki.gsub!(/\r\n?/, "\n")
    # and nuke 'em
    spki.gsub!("\n", "")
    # ...and leading/trailing whitespace
    spki.strip!
    @spki = OpenSSL::Netscape::SPKI.new(spki)
    if not @key.nil? and not @spki.verify(@key.public_key) then
      raise R509Error, 'Key does not match SPKI.'
    end
  end
  # create the SPKI from the private key if it wasn't passed in
  if @spki.nil?
    @spki = OpenSSL::Netscape::SPKI.new
    @spki.public_key = @key.public_key
    if @key.dsa?
      #only DSS1 is acceptable for DSA signing in OpenSSL < 1.0
      #post-1.0 you can sign with anything, but let's be conservative
      #see: http://www.ruby-doc.org/stdlib-1.9.3/libdoc/openssl/rdoc/OpenSSL/PKey/DSA.html
      message_digest = R509::MessageDigest.new('dss1')
    elsif opts.has_key?(:message_digest)
      message_digest = R509::MessageDigest.new(opts[:message_digest])
    else
      message_digest = R509::MessageDigest.new('sha1')
    end
    @spki.sign(@key.key,message_digest.digest)
  end
end

10
11
12

# File 'lib/r509/spki.rb', line 10

def key
  @key
end

10
11
12

# File 'lib/r509/spki.rb', line 10

def spki
  @spki
end

129
130
131
132
133
134
135
136
137

# File 'lib/r509/spki.rb', line 129

def bit_strength
  if self.rsa?
    return @spki.public_key.n.num_bits
  elsif self.dsa?
    return @spki.public_key.p.num_bits
  elsif self.ec?
    raise R509::R509Error, 'Bit strength is not available for EC at this time.'
  end
end

143
144
145
146
147
148
149

# File 'lib/r509/spki.rb', line 143

def curve_name
  if self.ec?
    @spki.public_key.group.curve_name
  else
    raise R509::R509Error, 'Curve name is only available with EC SPKIs'
  end
end

116
117
118

# File 'lib/r509/spki.rb', line 116

def dsa?
  @spki.public_key.kind_of?(OpenSSL::PKey::DSA)
end

123
124
125

# File 'lib/r509/spki.rb', line 123

def ec?
  @spki.public_key.kind_of?(OpenSSL::PKey::EC)
end

154
155
156
157
158
159
160
161
162

# File 'lib/r509/spki.rb', line 154

def key_algorithm
  if self.rsa?
    :rsa
  elsif self.dsa?
    :dsa
  elsif self.ec?
    :ec
  end
end

64
65
66

# File 'lib/r509/spki.rb', line 64

def public_key
  @spki.public_key
end

109
110
111

# File 'lib/r509/spki.rb', line 109

def rsa?
  @spki.public_key.kind_of?(OpenSSL::PKey::RSA)
end

86
87
88

# File 'lib/r509/spki.rb', line 86

def to_der
  @spki.to_der
end

77
78
79

# File 'lib/r509/spki.rb', line 77

def to_pem
  @spki.to_pem
end

70
71
72

# File 'lib/r509/spki.rb', line 70

def verify_signature
  @spki.verify(public_key)
end

102
103
104

# File 'lib/r509/spki.rb', line 102

def write_der(filename_or_io)
  write_data(filename_or_io, @spki.to_der)
end

94
95
96

# File 'lib/r509/spki.rb', line 94

def write_pem(filename_or_io)
  write_data(filename_or_io, @spki.to_pem)
end