openssl-additions 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c002f0205350fca421c6edb69f29e96cb17691b2878211542ead695aeb59fe8f
-  data.tar.gz: ecdbaf9fc58ab1d58a04df73ebdd14c59e4ed3efe72e86fee3bad7d00d18cbdd
+  metadata.gz: '07362825a73c86976d2405912f1edb3525e685d3e0e29322e8ce25cc1df3b3ca'
+  data.tar.gz: e547d3b7f72ecac40a5c180685c22b983b0e5b1179a6b4c09947aeee15bc6bad
 SHA512:
-  metadata.gz: 6fba57730fb6e4967ab67b97c94a7c82fd907b2b0dfbcbdbbeb059f79e3d745eb16e40ce6e90c71b3ffdf12234f13335e237ccd5386581cdefe338751f46f4d0
-  data.tar.gz: 2ba9996f6dcdc468d8bff817d5a8c8ebc6e8b97eb5146c11ded5fdacd2081f5a9223d0598638879879e42ba2b7fc6c92a6c20501d69d734f5e12cdf40b261182
+  metadata.gz: 977cd5463beca1c0f59f4ab4f470cd9149e8bc9c672701b592697e2c57d3a0a26218a69839d73e870b14314f91365a5cf55c3a86308a255a34982635a2e89ca5
+  data.tar.gz: 3bb1d9f777ffd936311ab4fe1eed977e5c9cd18e2ab42b8e942ce2eebc88bba01a0379912e229ff1da2e90a297c2d926d4e53a123767dcf1043fb9702c72e11e

data/lib/openssl/ssh_pkey.rb

@@ -44,6 +44,124 @@ module OpenSSL::PKey
     end
   end
 
+  # Create a new `OpenSSL::PKey` from a PuTTY private key.
+  #
+  # Given a PuTTY version 2 key file ("PPK"), an equivalent instance of an
+  # `OpenSSL::PKey::PKey` subclass will be derived representing the same
+  # key parameters.
+  #
+  # @param s [String] the PuTTY PPK file contents to convert.
+  #
+  # @yield if the key data passed is an encrypted private key, the block
+  #   (if provided) will be called.
+  #
+  # @return [OpenSSL::PKey::PKey] the OpenSSL-compatible key object.
+  #
+  # @raise OpenSSL::PKey::PKeyError] if anything went wrong with the conversion
+  #   process.
+  #
+  def self.from_putty_key(s, &blk)
+    lines = s.gsub("\r\n", "\n").gsub("\r", "\n").split("\n")
+
+    unless lines.shift =~ /\APuTTY-User-Key-File-2: ([a-z0-9-]+)\z/
+      raise OpenSSL::PKey::PKeyError,
+            "No PuTTY key file header found"
+    end
+
+    keytype = $1
+
+    key = case keytype
+          when 'ssh-rsa'
+            OpenSSL::PKey::RSA.new
+          when 'ssh-dss'
+            OpenSSL::PKey::DSA.new
+          when /ecdsa-sha2-/
+            OpenSSL::PKey::EC.new
+          else
+            raise OpenSSL::PKey::PKeyError,
+                  "Unknown key type #{keytype}"
+          end
+
+    unless lines.shift =~ /\AEncryption: (none|aes256-cbc)\z/
+      raise OpenSSL::PKey::PKeyError,
+            "Missing or invalid PuTTY Encryption line"
+    end
+
+    cipher = $1
+
+    if cipher != "none"
+      yield if block_given?
+      raise OpenSSL::PKey::PKeyError,
+            "Encrypted PuTTY keys are not (yet) supported"
+    end
+
+    unless lines.shift =~ /\AComment: /
+      raise OpenSSL::PKey::PKeyError,
+            "Missing or invalid PuTTY Comment line"
+    end
+
+    unless lines.shift =~ /\APublic-Lines: (\d+)\z/
+      raise OpenSSL::PKey::PKeyError,
+            "Missing or invalid PuTTY Public-Lines line"
+    end
+
+    line_count = $1.to_i
+
+    if lines.length < line_count
+      raise OpenSSL::PKey::PKeyError,
+            "Invalid Public-Lines value, only #{lines.length} lines remaining in file"
+    end
+
+    pubkey = lines[0, line_count].join.unpack("m").first
+
+    lines = lines[line_count..-1]
+
+    unless lines.shift =~ /Private-Lines: (\d+)\z/
+      raise OpenSSL::PKey::PKeyError,
+            "Missing or invalid PuTTY Private-Lines line"
+    end
+
+    line_count = $1.to_i
+
+    if lines.length < line_count
+      raise OpenSSL::PKey::PKeyError,
+            "Invalid Private-Lines value, only #{lines.length} lines remaining in file"
+    end
+
+    privkey = lines[0, line_count].join.unpack("m").first
+
+    case key
+    when OpenSSL::PKey::RSA
+      _kt, e, n        = ssh_key_lv_decode(pubkey,  3).map { |c| ssh_key_mpi_decode(c) }
+      d, p, q, iqmp, _ = ssh_key_lv_decode(privkey, 4).map { |c| ssh_key_mpi_decode(c) }
+
+      key.set_key(n, e, d)
+      key.set_factors(p, q)
+      key.set_crt_params(d % (p - 1), d % (q - 1), iqmp)
+    when OpenSSL::PKey::DSA
+      _kt, p, q, g, y = ssh_key_lv_decode(pubkey,  5).map { |c| ssh_key_mpi_decode(c) }
+      x, _            = ssh_key_lv_decode(privkey, 1).map { |c| ssh_key_mpi_decode(c) }
+
+      key.set_key(y, x)
+      key.set_pqg(p, q, g)
+    when OpenSSL::PKey::EC
+      _kt, curve, w = ssh_key_lv_decode(pubkey, 3)
+      p, _          = ssh_key_lv_decode(privkey, 1).map { |c| ssh_key_mpi_decode(c) }
+
+      begin
+        key = OpenSSL::PKey::EC.new(SSH_CURVE_NAME_MAP[curve])
+      rescue TypeError
+        raise OpenSSL::PKey::PKeyError,
+              "Unknown curve identifier #{curve}"
+      end
+
+      key.public_key  = OpenSSL::PKey::EC::Point.new(key.group, w)
+      key.private_key = p
+    end
+
+    key
+  end
+
   private
 
   def self.decode_private_ssh_key(s, &blk)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openssl-additions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler