Skip to content

Commit

Permalink
Add Marshal support to X509 objects
Browse files Browse the repository at this point in the history
This allows for example to use Rails' cache to store these objects. Without this patch you'd get errors like "TypeError (no _dump_data is defined for class OpenSSL::X509::Certificate)"

Note that the X509::Revoked class doesn't need the newly introduced modules as the DER output of X509::CRL already includes these.
  • Loading branch information
bdewater committed Oct 29, 2019
1 parent 7676dec commit 44e75e6
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 0 deletions.
26 changes: 26 additions & 0 deletions lib/openssl/x509.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@

module OpenSSL
module X509
module Marshal
def self.included(base)
base.extend(ClassMethods)
end

module ClassMethods
def _load(string)
new(string)
end
end

def _dump(_level)
to_der
end
end

class ExtensionFactory
def create_extension(*arg)
if arg.size > 1
Expand Down Expand Up @@ -41,6 +57,8 @@ def create_ext_from_hash(hash)
end

class Extension
include Marshal

def ==(other)
return false unless Extension === other
to_der == other.to_der
Expand Down Expand Up @@ -116,6 +134,8 @@ def authority_key_identifier
end

class Name
include Marshal

module RFC2253DN
Special = ',=+<>#;'
HexChar = /[0-9a-fA-F]/
Expand Down Expand Up @@ -219,6 +239,8 @@ def pretty_print(q)
end

class Attribute
include Marshal

def ==(other)
return false unless Attribute === other
to_der == other.to_der
Expand All @@ -232,6 +254,7 @@ def cleanup
end

class Certificate
include Marshal
include Extension::SubjectKeyIdentifier
include Extension::AuthorityKeyIdentifier

Expand All @@ -248,6 +271,7 @@ def pretty_print(q)
end

class CRL
include Marshal
include Extension::AuthorityKeyIdentifier

def ==(other)
Expand All @@ -264,6 +288,8 @@ def ==(other)
end

class Request
include Marshal

def ==(other)
return false unless Request === other
to_der == other.to_der
Expand Down
11 changes: 11 additions & 0 deletions test/test_x509attr.rb
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ def test_eq
assert_equal true, attr1 == attr2
assert_equal false, attr1 == attr3
end

def test_marshal
val = OpenSSL::ASN1::Set([
OpenSSL::ASN1::UTF8String("abc123")
])
attr = OpenSSL::X509::Attribute.new("challengePassword", val)
deserialized = Marshal.load(Marshal.dump(attr))

assert_equal attr.oid, deserialized.oid
assert_equal attr.value.value[0].value, deserialized.value.value[0].value
end
end

end
15 changes: 15 additions & 0 deletions test/test_x509cert.rb
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,21 @@ def test_eq
assert_equal false, cert3 == cert4
end

def test_marshal
now = Time.now
cacert = issue_cert(@ca, @rsa1024, 1, [], nil, nil,
not_before: now, not_after: now + 3600)
cert = issue_cert(@ee1, @rsa2048, 2, [], cacert, @rsa1024,
not_before: now, not_after: now + 3600)
deserialized = Marshal.load(Marshal.dump(cert))

assert_equal cert.issuer, deserialized.issuer
assert_equal cert.subject, deserialized.subject
assert_equal cert.public_key.to_der, deserialized.public_key.to_der
assert_equal cert.not_before, deserialized.not_before
assert_equal cert.not_after, deserialized.not_after
end

private

def certificate_error_returns_false
Expand Down
15 changes: 15 additions & 0 deletions test/test_x509crl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,21 @@ def test_eq
assert_equal true, rev2 == crl2.revoked[1]
end

def test_marshal
now = Time.now

cacert = issue_cert(@ca, @rsa1024, 1, [], nil, nil)
crl = issue_crl([], 1, now, now + 3600, [], cacert, @rsa1024, "sha256")
rev = OpenSSL::X509::Revoked.new.tap { |rev|
rev.serial = 1
rev.time = now
}
crl.add_revoked(rev)

assert_equal crl, Marshal.load(Marshal.dump(crl))
assert_equal crl.revoked[0], Marshal.load(Marshal.dump(crl)).revoked[0]
end

private

def crl_error_returns_false
Expand Down
8 changes: 8 additions & 0 deletions test/test_x509ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,14 @@ def test_eq
assert_equal false, ext1 == ext3
end

def test_marshal
ef = OpenSSL::X509::ExtensionFactory.new
ext = ef.create_extension("basicConstraints", "critical, CA:TRUE, pathlen:2")
deserialized = Marshal.load(Marshal.dump(ext))

assert_equal ext.to_h, deserialized.to_h
end

def test_value_der
ext = OpenSSL::X509::Extension.new(@basic_constraints.to_der)
assert_equal @basic_constraints_value.to_der, ext.value_der
Expand Down
7 changes: 7 additions & 0 deletions test/test_x509name.rb
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,13 @@ def test_equality
assert_equal false, name0.eql?(name2)
end

def test_marshal
name = OpenSSL::X509::Name.new([["DC", "org"], ["DC", "ruby-lang"], ["CN", "bar.ruby-lang.org"]])
deserialized = Marshal.load(Marshal.dump(name))

assert_equal name.to_s, deserialized.to_s
end

def test_dup
name = OpenSSL::X509::Name.parse("/CN=ruby-lang.org")
assert_equal(name.to_der, name.dup.to_der)
Expand Down
9 changes: 9 additions & 0 deletions test/test_x509req.rb
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,15 @@ def test_eq
assert_equal false, req1 == req3
end

def test_marshal
req = issue_csr(0, @dn, @rsa1024, "sha256")
deserialized = Marshal.load(Marshal.dump(req))

assert_equal req.version, deserialized.version
assert_equal req.subject, deserialized.subject
assert_equal req.public_key.to_der, deserialized.public_key.to_der
end

private

def request_error_returns_false
Expand Down

0 comments on commit 44e75e6

Please sign in to comment.