ssh-publickey 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b36f93c81f7da614c5cee2607f98884dafdc571cf1b1e9f6ae648e2ffbd9563f
+  data.tar.gz: 77567cac8bd9eaf0fb657beb16aa64fb5aad11943314858d68ab1513483eaec2
+SHA512:
+  metadata.gz: 623fb771883a64e32b2de5ea98639e98df9160fcd0bee2e0688eb5fcd86a38d8d3c30b4140d0ca55de8befeb361f1dab32f01478a05a089d7962e6af2f361b6f
+  data.tar.gz: c27a6629d01d0a9b45934d6abc6fdc46ead9ad7e80ac0604e85343f59b320694550e3008729c193ea8b2cf3c2716bd80ae9c2bbed662b599f62d91bb25c551d4

data/README.md

@@ -0,0 +1,15 @@
+# Convert SSH public key from/to RFC4716/OpenSSH format
+
+Examples:
+
+~~~ruby
+require 'ssh-publickey'
+
+# Convert key
+SSHPublicKey.openssh_to_rfc4716(k_openssh)
+SSHPublicKey.rfc4716_to_openssh(k_rfc4716)
+
+# Test key
+SSHPublicKey.is_openssh?(k)
+SSHPublicKey.is_rfc4716?(k)
+~~~

data/lib/ssh-publickey.rb

@@ -0,0 +1,131 @@
+require_relative 'ssh-publickey/version'
+
+# Convert SSH public key from/to RFC4716/OpenSSH format
+#
+class SSHPublicKey
+    # Report public key processing error
+    class PublicKeyError < StandardError
+    end
+
+    
+    # Maximum text size in a line for PEM format
+    LINE_BREAK = 70
+
+    
+    # Regex for authorized key
+    AUTHORIZED_KEY_REGEX =
+        /^(?:    (?<directives>(?:[!-~]|\s(?=.*"))+) \s+ )?   # Options
+                 (?<type>      [a-z0-9_-]+)          \s+      # Type
+                 (?<key>       [A-Za-z0-9+\/]+=*)             # Key
+          (?:\s+ (?<comment>.*?)                     \s* )?   # Comments
+         $/x
+
+    
+    # Regex for OpenSSH public key
+    # Same as authorized keys but without directives
+    PUBKEY_OPENSSH_REGEX =
+        /^       (?<type>   [a-z0-9_-]+)             \s+      # Type
+                 (?<key>    [A-Za-z0-9+\/]+=*)                # Key
+          (?:\s+ (?<comment>.*?)                     \s* )?   # Comments
+         $/x
+
+    
+    # Regex for RFC4716 public key
+    PUBKEY_RFC4716_REGEX =
+        /^----\sBEGIN\sSSH2\sPUBLIC\sKEY\s----\R
+          (?<tags> (?:[^:\p{Space}\p{Cntrl}]{1,64}            # Tags
+                      \s*:\s*
+                      (?:[^\\\r\n]*\\\R)* [^\\\r\n]+\R)*)
+          (?<key>  (?:[A-Za-z0-9+\/]+\R)*                     # Key
+                   [A-Za-z0-9+\/]+=*\R)
+          ----\sEND\sSSH2\sPUBLIC\sKEY\s----
+         $/xmu
+
+
+    # :nodoc:
+    PUBKEY_RFC4716_HEADERTAG_REGEX = 
+        /[^:\p{Space}\p{Cntrl}]{1,64}
+            \s*:\s*   
+            (?:[^\\\r\n]*\\\R)*[^\\\r\n]+\R/xmu
+
+    
+    # Convert a public key in OpenSSH format to RFC4716 format
+    #
+    # @param  [String] pubkey   public key in OpenSSH format
+    #
+    # @return [String] public key in RFC4716 format
+    #
+    def self.openssh_to_rfc4716(pubkey)
+        unless m = AUTHORIZED_KEY_REGEX.match(pubkey)
+            raise PublicKeyError, "invalid OpenSSH public key"
+        end
+
+        # Lines are limited to 72 8-bytes char
+        #  - limit ourselves to 70 to keep room for \\ and \n
+        #  - comment part can be unicode so 1 char can be more that 1 byte
+        linesize = 0
+        comment  = "Comment: #{m[:comment]}"
+                      .each_char.slice_before {|c|
+                           bytesize = c.bytes.size 
+                           if linesize + bytesize > LINE_BREAK
+                           then linesize  = 0        ; true
+                           else linesize += bytesize ; false
+                           end
+                      }.map(&:join).join("\\\n")
+        key      = m[:key].scan(/.{1,70}/).join("\n")
+        
+        reskey   = []
+        reskey   << "---- BEGIN SSH2 PUBLIC KEY ----"
+        reskey   << comment
+        reskey   << key
+        reskey   << "---- END SSH2 PUBLIC KEY ----"
+        reskey.join("\n")
+    end
+
+    
+    # Convert a public key in RFC4716 format to OpenSSH format
+    #
+    # @param  [String] pubkey   public key in RFC4716 format
+    #
+    # @return [String] public key in OpenSSH format
+    #
+    def self.rfc4716_to_openssh(pubkey)
+        unless m = PUBKEY_RFC4716_REGEX.match(pubkey) 
+            raise PublicKeyError, "invalid RFC4716 public key"
+        end
+
+        key        = m[:key].gsub(/\R/, '')
+        keydata    = m[:key].unpack1('m')
+        len        = keydata.unpack1('N')
+        type       = keydata[4,len]
+        tags       = Hash[m[:tags].scan(PUBKEY_RFC4716_HEADERTAG_REGEX)
+                                  .map {|tag| tag.gsub(/\\\R/, '').strip }
+                                  .map {|tag| tag.split(/\s*:\s*/, 2)    }]
+        comment    = tags.transform_keys {|k| k.downcase }['comment']
+        directives = nil
+        
+        [directives, type,  key, comment ].compact.join(' ')
+    end
+
+
+    # Test if a public key is in OpenSSH format
+    #
+    # @param  [String] pubkey   public key in RFC4716 format
+    #
+    # @return [Boolean] 
+    #
+    def self.is_openssh?(pubkey)
+        PUBKEY_RFC4716_REGEX.match?(pubkey)
+    end
+
+    
+    # Test if a public key is in RFC4716 format
+    #
+    # @param  [String] pubkey   public key in RFC4716 format
+    #
+    # @return [Boolean]
+    #
+    def self.is_rfc4716?(pubkey)
+        PUBKEY_RFC4716_REGEX.match?(pubkey)
+    end
+end

data/lib/ssh-publickey/version.rb

@@ -0,0 +1,4 @@
+class SSHPublicKey
+    # Current version
+    VERSION = '0.1'
+end

data/ssh-publickey.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/ssh-publickey/version'
+
+Gem::Specification.new do |s|
+    s.name        = 'ssh-publickey'
+    s.version     = SSHPublicKey::VERSION
+    s.summary     = "SSH public key conversion"
+    s.description = "Convert SSH public key from/to RFC4716/OpenSSH format"
+    s.authors     = [ "Stéphane D'Alu" ]
+    s.email       = [ 'stephane.dalu@insa-lyon.fr' ]
+    s.files       = %w[ README.md ssh-publickey.gemspec ] + Dir['lib/**/*.rb']
+    s.homepage    = 'https://gitlab.com/sdalu/ssh-publickey'
+    s.license     = 'MIT'
+
+    s.add_development_dependency 'yard', '~>0'
+    s.add_development_dependency 'rake', '~>13'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: ssh-publickey
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Stéphane D'Alu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+description: Convert SSH public key from/to RFC4716/OpenSSH format
+email:
+- stephane.dalu@insa-lyon.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ssh-publickey.rb
+- lib/ssh-publickey/version.rb
+- ssh-publickey.gemspec
+homepage: https://gitlab.com/sdalu/ssh-publickey
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: SSH public key conversion
+test_files: []