minisign 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fff86c56cc4091b4517b01304262f097451c801847f4593d1bb99df4bef760f
-  data.tar.gz: 4c3ffd93d6dd729a25b6eabd9773d3a226e27c1066329972132d87ab5b5d49cc
+  metadata.gz: 90f8322a99590a021707a0f91aa959090352ed35571364ea536b298a03896f06
+  data.tar.gz: 63f0cbc1604e551fc16e5bc4cd0456cbb2818cb30994bdd0aedc109bbb7e3dae
 SHA512:
-  metadata.gz: 2bf06fbf6e88b3a003d5b62d245e8085f749a24a36022b66b4fa6d7f7901b5e2eececc0c107dd0ee1969cb4fa09dd28212695f401f1b8f4e5e2c8cc6adf85671
-  data.tar.gz: cf5da0f974244ea824bd8ffd5a3f41dd875eac858c213429918a1b0da1445b35a9a479ac8ed1131b33eaaab7ad609dd6cd6dc98852b2e29afff83cb389327acd
+  metadata.gz: cf80345096982044eb942d0ddafaf9f1546006d543cff34b7ad424e962f930229a6241958627f2339d76a893dbcfb4b5266a88b056c98b3e491e1be7877ab66f
+  data.tar.gz: cbd7a29a71c353745fc6ffe95259368bf959c3418bfd32fae4cce1ede6baa1e449cf27bebc81410aacd2451d8284acd52448860a240d3ea4864ab53b3142f6a3

data/lib/minisign/key_pair.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Minisign
+  # Generate a Minisign secret and public key
+  class KeyPair
+    include Minisign::Utils
+
+    def initialize(password = nil)
+      @password = password
+      @key_id = SecureRandom.bytes(8)
+      @signing_key = Ed25519::SigningKey.generate
+
+      @checksum = blake2b256("Ed#{key_data}")
+      @keynum_sk = "#{key_data}#{@checksum}"
+
+      @kdf_salt = SecureRandom.bytes(32)
+      @keynum_sk = xor(kdf_output, @keynum_sk.bytes).pack('C*') if @password
+      @kdf_algorithm = password.nil? ? [0, 0].pack('U*') : 'Sc'
+    end
+
+    # @return [Minisign::PrivateKey]
+    def private_key
+      @kdf_opslimit = kdf_opslimit_bytes.pack('C*')
+      @kdf_memlimit = kdf_memlimit_bytes.pack('C*')
+      data = "Ed#{@kdf_algorithm}B2#{@kdf_salt}#{@kdf_opslimit}#{@kdf_memlimit}#{@keynum_sk}"
+      Minisign::PrivateKey.new(
+        "untrusted comment: minisign secret key\n#{Base64.strict_encode64(data)}",
+        @password
+      )
+    end
+
+    # @return [Minisign::PublicKey]
+    def public_key
+      data = Base64.strict_encode64("Ed#{@key_id}#{@signing_key.verify_key.to_bytes}")
+      Minisign::PublicKey.new(data)
+    end
+
+    private
+
+    def kdf_output
+      derive_key(
+        @password,
+        @kdf_salt,
+        kdf_opslimit_bytes.pack('V*').unpack('N*').sum,
+        kdf_memlimit_bytes.pack('V*').unpack('N*').sum
+      )
+    end
+
+    def key_data
+      @key_data ||= "#{@key_id}#{@signing_key.to_bytes}#{@signing_key.verify_key.to_bytes}"
+    end
+
+    # 🤷
+    # https://github.com/RubyCrypto/rbnacl/blob/3e8d8f8822e2b8eeba215e6be027e8ee210edfb9/lib/rbnacl/password_hash/scrypt.rb#L33-L34
+    def kdf_opslimit_bytes
+      [0, 0, 0, 2, 0, 0, 0, 0]
+    end
+
+    def kdf_memlimit_bytes
+      [0, 0, 0, 64, 0, 0, 0, 0]
+    end
+  end
+end

data/lib/minisign/private_key.rb

@@ -1,73 +1,101 @@
 # frozen_string_literal: true
 
 module Minisign
-  # Parse ed25519 signing key from minisign private key
+  # The private key used to create signatures
   class PrivateKey
     include Utils
-    attr_reader :signature_algorithm, :kdf_algorithm, :cksum_algorithm, :kdf_salt, :kdf_opslimit, :kdf_memlimit,
-                :key_id, :public_key, :secret_key, :checksum
-
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Layout/LineLength
+    attr_reader :key_id
 
     # Parse signing information from the minisign private key
     #
     # @param str [String] The minisign private key
+    # @param password [String] The password used to encrypt the private key
     # @example
-    #   Minisign::PrivateKey.new('RWRTY0IyEf+yYa5eAX38PgdrI3TMxwy+3sgzpgcZWQXhOKqdf9sAAAACAAAAAAAAAEAAAAAAHe8Olzttgk6k5pZyT3CyCTcTAV0bLN3kq5CUqhLjqSdYZ6oEWs/S7ztaephS+/jwnuOElLBKkg3Sd56jzyvMwL4qStNUTyPDqckNjniw2SlowmHN8n5NnR47gvqjo96E+vakpw8v5PE=', 'password')
+    #   Minisign::PrivateKey.new(File.read("test/minisign.key"), 'password')
     def initialize(str, password = nil)
-      contents = str.split("\n")
-      bytes = Base64.decode64(contents.last).bytes
-      @signature_algorithm, @kdf_algorithm, @cksum_algorithm =
-        [bytes[0..1], bytes[2..3], bytes[4..5]].map { |a| a.pack('U*') }
-      @kdf_salt = bytes[6..37]
-      @kdf_opslimit = bytes[38..45].pack('V*').unpack('N*').sum
-      @kdf_memlimit = bytes[46..53].pack('V*').unpack('N*').sum
-      kdf_output = derive_key(password, @kdf_salt, @kdf_opslimit, @kdf_memlimit)
-      @key_id, @secret_key, @public_key, @checksum = xor(kdf_output, bytes[54..157])
-    end
-    # rubocop:enable Layout/LineLength
-    # rubocop:enable Metrics/AbcSize
-
-    # @return [String] the <kdf_output> used to xor the ed25519 keys
-    def derive_key(password, kdf_salt, kdf_opslimit, kdf_memlimit)
-      RbNaCl::PasswordHash.scrypt(
-        password,
-        kdf_salt.pack('C*'),
-        kdf_opslimit,
-        kdf_memlimit,
-        104
-      ).bytes
-    end
-
-    # rubocop:disable Layout/LineLength
-
-    # @return [Array<32 bit unsigned ints>] the byte array containing the key id, the secret and public ed25519 keys, and the checksum
-    def xor(kdf_output, contents)
-      # rubocop:enable Layout/LineLength
-      xored = kdf_output.each_with_index.map do |b, i|
-        contents[i] ^ b
-      end
-      [xored[0..7], xored[8..39], xored[40..71], xored[72..103]]
+      comment, data = str.split("\n")
+      @password = password
+      decoded = Base64.decode64(data)
+      @untrusted_comment = comment.split('untrusted comment: ').last
+      @bytes = decoded.bytes
+      @kdf_salt, @kdf_opslimit, @kdf_memlimit = scrypt_params(@bytes)
+      @key_id, @ed25519_private_key_bytes, @ed25519_public_key_bytes, @checksum = key_data(password, @bytes[54..157])
+      assert_valid_key!
     end
 
-    # @return [Ed25519::SigningKey] the ed25519 signing key
-    def ed25519_signing_key
-      Ed25519::SigningKey.new(@secret_key.pack('C*'))
+    # Get the corresponding public key from the private key
+    #
+    # @return [Minisign::PublicKey]
+    def public_key
+      data = Base64.strict_encode64("Ed#{@key_id.pack('C*')}#{@ed25519_public_key_bytes.pack('C*')}")
+      Minisign::PublicKey.new(data)
     end
 
-    # @return [String] the signature in the .minisig format that can be written to a file.
-    def sign(filename, message)
+    # Sign a file/message
+    #
+    # @param filename [String] The filename to be used in the trusted comment section
+    # @param message [String] The file's contents
+    # @param comment [String] An optional trusted comment to be included in the signature
+    # @return [Minisign::Signature]
+    def sign(filename, message, comment = nil)
       signature = ed25519_signing_key.sign(blake2b512(message))
-      trusted_comment = "timestamp:#{Time.now.to_i}\tfile:#{filename}\thashed"
+      trusted_comment = comment || "timestamp:#{Time.now.to_i}\tfile:#{filename}\thashed"
       global_signature = ed25519_signing_key.sign("#{signature}#{trusted_comment}")
-      [
+      Minisign::Signature.new([
         'untrusted comment: <arbitrary text>',
         Base64.strict_encode64("ED#{@key_id.pack('C*')}#{signature}"),
         "trusted comment: #{trusted_comment}",
         Base64.strict_encode64(global_signature),
         ''
-      ].join("\n")
+      ].join("\n"))
+    end
+
+    # @return [String] A string in the minisign.pub format
+    def to_s
+      kdf_salt = @kdf_salt.pack('C*')
+      kdf_opslimit = [@kdf_opslimit, 0].pack('L*')
+      kdf_memlimit = [@kdf_memlimit, 0].pack('L*')
+      keynum_sk = key_data(@password,
+                           @key_id + @ed25519_private_key_bytes + @ed25519_public_key_bytes + @checksum).flatten
+      data = "Ed#{kdf_algorithm}B2#{kdf_salt}#{kdf_opslimit}#{kdf_memlimit}#{keynum_sk.pack('C*')}"
+      "untrusted comment: #{@untrusted_comment}\n#{Base64.strict_encode64(data)}\n"
+    end
+
+    private
+
+    def signature_algorithm
+      @bytes[0..1].pack('U*')
+    end
+
+    def cksum_algorithm
+      @bytes[4..5].pack('U*')
+    end
+
+    def kdf_algorithm
+      @bytes[2..3].pack('U*')
+    end
+
+    def scrypt_params(bytes)
+      [bytes[6..37], bytes[38..45].pack('V*').unpack('N*').sum, bytes[46..53].pack('V*').unpack('N*').sum]
+    end
+
+    # @raise [RuntimeError] if the extracted public key does not match the derived public key
+    def assert_valid_key!
+      raise 'Missing password for encrypted key' if kdf_algorithm.bytes.sum != 0 && @password.nil?
+      raise 'Wrong password for that key' if @ed25519_public_key_bytes != ed25519_signing_key.verify_key.to_bytes.bytes
+    end
+
+    def key_data(password, bytes)
+      if password
+        kdf_output = derive_key(password, @kdf_salt.pack('C*'), @kdf_opslimit, @kdf_memlimit)
+        bytes = xor(kdf_output, bytes)
+      end
+      [bytes[0..7], bytes[8..39], bytes[40..71], bytes[72..103]]
+    end
+
+    # @return [Ed25519::SigningKey] the ed25519 signing key
+    def ed25519_signing_key
+      Ed25519::SigningKey.new(@ed25519_private_key_bytes.pack('C*'))
     end
   end
 end

data/lib/minisign/public_key.rb

@@ -1,49 +1,80 @@
 # frozen_string_literal: true
 
 module Minisign
-  # Parse ed25519 verify key from minisign public key
+  # The public key used to verify signatures
   class PublicKey
     include Utils
-    # Parse the ed25519 verify key from the minisign public key
+    # Read a minisign public key
     #
     # @param str [String] The minisign public key
     # @example
     #   Minisign::PublicKey.new('RWTg6JXWzv6GDtDphRQ/x7eg0LaWBcTxPZ7i49xEeiqXVcR+r79OZRWM')
+    #   # or from a file:
+    #   Minisign::PublicKey.new(File.read('test/minisign.pub'))
     def initialize(str)
-      @decoded = Base64.strict_decode64(str)
-      @public_key = @decoded[10..]
-      @verify_key = Ed25519::VerifyKey.new(@public_key)
+      @lines = str.split("\n")
+      @decoded = Base64.strict_decode64(@lines.last)
     end
 
     # @return [String] the key id
     # @example
-    #   Minisign::PublicKey.new('RWTg6JXWzv6GDtDphRQ/x7eg0LaWBcTxPZ7i49xEeiqXVcR+r79OZRWM').key_id
+    #   public_key.key_id
     #   #=> "E86FECED695E8E0"
     def key_id
-      @decoded[2..9].bytes.map { |c| c.to_s(16) }.reverse.join.upcase
+      key_id_binary_string.bytes.map { |c| c.to_s(16) }.reverse.join.upcase
     end
 
     # Verify a message's signature
     #
-    # @param sig [Minisign::Signature]
+    # @param signature [Minisign::Signature]
     # @param message [String] the content that was signed
     # @return [String] the trusted comment
     # @raise Ed25519::VerifyError on invalid signatures
     # @raise RuntimeError on tampered trusted comments
-    def verify(sig, message)
-      ensure_matching_key_ids(sig.key_id, key_id)
-      @verify_key.verify(sig.signature, blake2b512(message))
+    # @raise RuntimeError on mismatching key ids
+    def verify(signature, message)
+      assert_matching_key_ids!(signature.key_id, key_id)
+      ed25519_verify_key.verify(signature.signature, blake2b512(message))
       begin
-        @verify_key.verify(sig.trusted_comment_signature, sig.signature + sig.trusted_comment)
+        ed25519_verify_key.verify(signature.trusted_comment_signature, signature.signature + signature.trusted_comment)
       rescue Ed25519::VerifyError
         raise 'Comment signature verification failed'
       end
-      "Signature and comment signature verified\nTrusted comment: #{sig.trusted_comment}"
+      "Signature and comment signature verified\nTrusted comment: #{signature.trusted_comment}"
+    end
+
+    # @return [String] The public key that can be written to a file
+    def to_s
+      "untrusted comment: #{untrusted_comment}\n#{key_data}\n"
     end
 
     private
 
-    def ensure_matching_key_ids(key_id1, key_id2)
+    def untrusted_comment
+      if @lines.length == 1
+        "minisign public key #{key_id}"
+      else
+        @lines.first.split('untrusted comment: ').last
+      end
+    end
+
+    def key_id_binary_string
+      @decoded[2..9]
+    end
+
+    def ed25519_public_key_binary_string
+      @decoded[10..]
+    end
+
+    def ed25519_verify_key
+      Ed25519::VerifyKey.new(ed25519_public_key_binary_string)
+    end
+
+    def key_data
+      Base64.strict_encode64("Ed#{key_id_binary_string}#{ed25519_public_key_binary_string}")
+    end
+
+    def assert_matching_key_ids!(key_id1, key_id2)
       raise "Signature key id is #{key_id1}\nbut the key id in the public key is #{key_id2}" unless key_id1 == key_id2
     end
   end

data/lib/minisign/signature.rb

@@ -26,15 +26,21 @@ module Minisign
       @lines[2].split('trusted comment: ')[1]
     end
 
+    # @return [String] the signature for the trusted comment
     def trusted_comment_signature
       Base64.decode64(@lines[3])
     end
 
-    # @return [String] the signature
+    # @return [String] the global signature
     def signature
       encoded_signature[10..]
     end
 
+    # @return [String] The signature that can be written to a file
+    def to_s
+      "#{@lines.join("\n")}\n"
+    end
+
     private
 
     def encoded_signature

data/lib/minisign/utils.rb

@@ -3,8 +3,30 @@
 module Minisign
   # Helpers used in multiple classes
   module Utils
+    def blake2b256(message)
+      RbNaCl::Hash::Blake2b.digest(message, { digest_size: 32 })
+    end
+
     def blake2b512(message)
-      OpenSSL::Digest.new('BLAKE2b512').digest(message)
+      RbNaCl::Hash::Blake2b.digest(message, { digest_size: 64 })
+    end
+
+    # @return [Array<32 bit unsigned ints>]
+    def xor(kdf_output, contents)
+      kdf_output.each_with_index.map do |b, i|
+        contents[i] ^ b
+      end
+    end
+
+    # @return [String] the <kdf_output> used to xor the ed25519 keys
+    def derive_key(password, kdf_salt, kdf_opslimit, kdf_memlimit)
+      RbNaCl::PasswordHash.scrypt(
+        password,
+        kdf_salt,
+        kdf_opslimit,
+        kdf_memlimit,
+        104
+      ).bytes
     end
   end
 end

data/lib/minisign.rb

@@ -2,10 +2,10 @@
 
 require 'ed25519'
 require 'base64'
-require 'openssl'
 require 'rbnacl'
 
 require 'minisign/utils'
 require 'minisign/public_key'
 require 'minisign/signature'
 require 'minisign/private_key'
+require 'minisign/key_pair'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minisign
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Jesse Shawl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ed25519
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/minisign.rb
+- lib/minisign/key_pair.rb
 - lib/minisign/private_key.rb
 - lib/minisign/public_key.rb
 - lib/minisign/signature.rb