elliptic 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50c1f0afa4d55fd9b936ddc1ef0c38ede63054432aae99aa2b717ba21bc819c7
-  data.tar.gz: e9d57e5bfece39941288e66fd9b087d99660dfa25a42e723b69f96f85c690fd0
+  metadata.gz: b669851bc198139a145ad4e0fcec669c63e5510836322db51787ceb8d09362c5
+  data.tar.gz: 1a125a73561286cf5670085f910e8c37c0ed48c9564400219885a24526dbe0de
 SHA512:
-  metadata.gz: 56cc6e7d72f921b61701d6ca2d1d25383b91377607752db4f96a7d12c56881fdfda1bcccfe2177ff8695114de81822ea9fbc8b0ccecfa1546f4c678393b2b933
-  data.tar.gz: c8ec4acab2b3495b8937bee4e7488d6d3922b31a6ec13473a877ea30249319e0c8eacc4c89062cd76d3e1a4c078c95d36579b2b420b2a55e931ace6be9b69692
+  metadata.gz: 9f1ed708148cf5c8dd47ab00c22dfeee9ce43f3967c1626b7f1ed90947d0fb01512e2dbbd6ce0e43ef49a913a59abec48c80c86ba95854d89d62f9061c0daaa8
+  data.tar.gz: bb86040e5624540f3f66368b0f1c1759fe2d0e1eaf0bc2c882f0c14d0e72b4cb685de6baebd84008262fb5f07cfe9775fa40394bf79fcef0142642113bab26ad

data/README.md

@@ -194,7 +194,9 @@ That's all the magic.
 
 
 
-## Public Key Formats
+### Private / Public Key Formats
+
+#### Intro
 
 To get the all-in-one-string
 public key from a point with the coordinates x and y
@@ -237,6 +239,112 @@ point.to_s( :compressed )
 #=> "02e37648435c60dcd181b3d41d50857ba5b5abebe279429aa76558f6653f1658f2"
 ```
 
+####  PEM, DER, BASE64(DER)
+
+**Export**
+
+To export a private or public key to
+the Privacy Enhanced Mail (PEM) format use `to_pem`:
+
+
+``` ruby
+private_key = EC::PrivateKey.generate
+private_key.to_pem
+#=> "-----BEGIN EC PRIVATE KEY-----
+#    MHQCAQEEIDIWkCIC58Yo1E5noSiXbHdR/8zUqB+vvTK4nSk8tZ1RoAcGBSuBBAAK
+#    oUQDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA13Z8Zif5Mh+qavIr/6HpI/Kq
+#    Q0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA==
+#    -----END EC PRIVATE KEY-----"
+
+public_key = private_key.public_key
+public_key.to_pem
+#=> "-----BEGIN PUBLIC KEY-----
+#    MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA
+#    13Z8Zif5Mh+qavIr/6HpI/KqQ0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA==
+#    -----END PUBLIC KEY-----"
+```
+
+To export a private or public key to
+the (binary) Distinguished Encoding Rules (DER)
+in ASN.1 format use `to_der`:
+
+``` ruby
+private_key.to_der
+#=> "\xA1D\x03B\x00\x04\xA2Y|\xAD\x87\xAB|1
+#     \xF8\xAB\xA9\xD3\xD6h\x93e\x9D\xF5\xE5\xAF\x01\x16\xC2\x80
+#     \xD7v|f'\xF92\x1F\xAAj\xF2+\xFF\xA1\xE9#\xF2\xAACF\xE7\xB8
+#     \xE6b\b?`\xA4B\x16\xA3\xB5F7\xCC\t\x81\xCB\xBAd"
+
+public_key = private_key.public_key
+public_key.to_der
+#=> "0V0\x10\x06\a*\x86H\xCE=\x02\x01\x06\x05+\x81\x04\x00
+#    \x03B\x00\x04\xA2Y|\xAD\x87\xAB|1\xF8\xAB\xA9
+#    \xD3\xD6h\x93e\x9D\xF5\xE5\xAF\x01\x16\xC2\x80\xD7v|f'\xF92
+#    \x1F\xAAj\xF2+\xFF\xA1\xE9#\xF2\xAACF\xE7\xB8\xE6b
+#    \b?`\xA4B\x16\xA3\xB5F7\xCC\t\x81\xCB\xBAd"
+```
+
+To export a private or public key to
+the Base64-encoded Distinguished Encoding Rules (DER)
+in ASN.1 format use `to_base64`:
+
+``` ruby
+private_key.to_base64
+#=> "MHQCAQEEIDIWkCIC58Yo1E5noSiXbHdR/8zUqB+vvTK4nSk8tZ1RoAcGBSuBBAAK
+#    oUQDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA13Z8Zif5Mh+qavIr/6HpI/Kq
+#    Q0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA=="
+
+public_key = private_key.public_key
+public_key.to_base64
+#=> "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA
+#    13Z8Zif5Mh+qavIr/6HpI/KqQ0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA=="
+```
+
+**Import**
+
+To import a private or public key
+in the PEM or DER format use the all-in-one convenience constructor:
+
+
+``` ruby
+private_key = EC::PrivateKey.new( "-----BEGIN EC PRIVATE KEY-----
+    MHQCAQEEIDIWkCIC58Yo1E5noSiXbHdR/8zUqB+vvTK4nSk8tZ1RoAcGBSuBBAAK
+    oUQDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA13Z8Zif5Mh+qavIr/6HpI/Kq
+    Q0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA==
+    -----END EC PRIVATE KEY-----" )
+
+public_key = EC::PublicKey.new( "-----BEGIN PUBLIC KEY-----
+    MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEoll8rYerfDH4q6nT1miTZZ315a8BFsKA
+    13Z8Zif5Mh+qavIr/6HpI/KqQ0bnuOZiCD9gpEIWo7VGN8wJgcu6ZA==
+    -----END PUBLIC KEY-----" )
+
+## or
+
+private_key = EC::PrivateKey.new( "\xA1D\x03B\x00\x04\xA2Y|\xAD\x87\xAB|1
+     \xF8\xAB\xA9\xD3\xD6h\x93e\x9D\xF5\xE5\xAF\x01\x16\xC2\x80
+     \xD7v|f'\xF92\x1F\xAAj\xF2+\xFF\xA1\xE9#\xF2\xAACF\xE7\xB8
+     \xE6b\b?`\xA4B\x16\xA3\xB5F7\xCC\t\x81\xCB\xBAd".b )
+
+public_key = EC::PublicKey.new( "0V0\x10\x06\a*\x86H\xCE=\x02\x01\x06\x05+\x81\x04\x00
+    \x03B\x00\x04\xA2Y|\xAD\x87\xAB|1\xF8\xAB\xA9
+    \xD3\xD6h\x93e\x9D\xF5\xE5\xAF\x01\x16\xC2\x80\xD7v|f'\xF92
+    \x1F\xAAj\xF2+\xFF\xA1\xE9#\xF2\xAACF\xE7\xB8\xE6b
+    \b?`\xA4B\x16\xA3\xB5F7\xCC\t\x81\xCB\xBAd".b )
+```
+
+or use the decode/from helper:
+
+``` ruby
+private_key = EC::PrivateKey.decode_pem( ... )     # or from_pem( ... )
+              EC::PrivateKey.decode_der( ... )     # or from_der( ... )
+              EC::PrivateKey.decode_base64( ... )  # or from_base64( ... )
+
+public_key  = EC::PublicKey.decode_pem( ... )      # or from_pem( ... )
+              EC::PublicKey.decode_der( ... )      # or from_der( ... )
+              EC::PublicKey.decode_base64( ... )   # or from_base64( ... )
+```
+
+
 
 That's it.
 

data/lib/elliptic.rb

@@ -5,39 +5,14 @@ require 'openssl'
 
 ## our own code
 require 'elliptic/version'    # note: let version always go first
+require 'elliptic/private_key'
+require 'elliptic/public_key'
+require 'elliptic/signature'
 
 
 
 module EC
 
-
-
-  class Signature
-
-    def self.decode_der( der )
-      asn1 = OpenSSL::ASN1.decode(der )
-      r = asn1.value[0].value.to_i
-      s = asn1.value[1].value.to_i
-      new(r, s)
-    end
-
-    attr_reader :r, :s
-    def initialize(r, s)
-      @r, @s = r, s
-    end
-
-    def to_der
-      asn1 = OpenSSL::ASN1::Sequence.new [
-          OpenSSL::ASN1::Integer.new( @r ),
-          OpenSSL::ASN1::Integer.new( @s ),
-        ]
-      asn1.to_der
-    end
-  end ## class Signature
-
-
-
-
   ## "cached" / available groups for now include:
   GROUP = {
     ## todo/check: is there a more direct way to get a group object?
@@ -93,123 +68,6 @@ module EC
 
 
 
-
-  class PublicKey
-    def self.convert( *args, **kwargs )
-      if args.size==1 && args[0].is_a?( PublicKey )
-        args[0]   ## pass through as is (already a public key)
-      else
-        new( *args, group: kwargs[:group] )
-      end
-    end
-
-
-
-    def initialize( *args, group: nil )
-      point = if args.size == 2   ## assume (x,y) raw integer points
-                 @pt = Point.new( *args, group: group )
-                 @pt.to_ec_point ## convert point to openssl (native) class
-              else
-                ##  "restore"  public key (only) from point for verify
-                ## - OpenSSL::PKey::EC::Point   ## assume public key only (restore pkey object for verify?)
-                ## - Point
-                if args[0].is_a?( Point )
-                  @pt = args[0]
-                  @pt.to_ec_point
-                else
-                  args[0]  ## assume it is already OpenSSL::PKey::EC::Point
-                end
-              end
-
-      ## note: (auto)get group from point
-      @pkey = OpenSSL::PKey::EC.new( point.group )
-      @pkey.public_key = point
-    end
-
-    def group() @pkey.group; end
-
-
-    def point
-      ## cache returned point - why? why not?
-      @pt ||= Point.new( @pkey.public_key )
-      @pt
-    end
-
-
-
-    def verify?( message, signature )
-      signature_der = signature.to_der
-      @pkey.dsa_verify_asn1( message, signature_der )
-    end
-    alias_method :valid_signature?, :verify?
-
-    ## helpers for debugging
-    def to_text() @pkey.to_text; end
-    def public?() @pkey.public?; end   ## todo/check: keep - needed? - why? why not?
-  end # class PublicKey
-
-
-
-
-  class PrivateKey
-    def self.convert( *args, **kwargs )
-      if args.size==1 && args[0].is_a?( PrivateKey )
-        args[0]   ## pass through as is (alread a private key)
-      else
-        new( args[0], group: kwargs[:group] )
-      end
-    end
-
-
-    def self.generate( group: nil ) new( group: group ); end
-
-    def initialize( input=nil, group: nil )
-      ec_group = GROUP[ group || 'secp256k1' ]
-      @pkey = OpenSSL::PKey::EC.new( ec_group )
-
-      if input.nil?     ## auto-generate new key
-        @pkey.generate_key
-      else
-        num = if input.is_a?( String )  ## assume hex string
-                input.to_i( 16 )
-              else                      ## assume integer
-                input
-              end
-        @pkey.private_key = OpenSSL::BN.new( num )
-        ## auto-calculate public key too
-        @pkey.public_key = @pkey.group.generator.mul( @pkey.private_key )
-      end
-    end
-
-    def to_i()  @pkey.private_key.to_i;           end
-    ## todo/check/fix: make it always a 32 byte (64 hex chars) string
-    ##                    even with leading zeros !!! - why? why not?
-    def to_s()  @pkey.private_key.to_i.to_s(16);  end
-
-    def group() @pkey.group; end
-
-
-    def public_key
-      ## cache returned public key - why? why not?
-      @pub ||= PublicKey.new( @pkey.public_key )
-      @pub
-    end
-
-
-    def sign( message )
-      signature_der = @pkey.dsa_sign_asn1( message )
-      Signature.decode_der( signature_der )
-    end
-
-    ## helpers for debugging
-    def to_text()  @pkey.to_text; end
-    def private?() @pkey.private?; end    ## todo/check: keep - needed? - why? why not?
- end # class PrivateKey
-
-
-
-
-
   def self.sign( message, priv_key )
     signer = PrivateKey.convert( priv_key )
     signer.sign( message )

data/lib/elliptic/version.rb

@@ -3,8 +3,8 @@
 
 module EC
 
-  MAJOR = 0
-  MINOR = 2
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elliptic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc