Object
Generate a new keypair and return an SSHKey object
The default behavior when providing no options will generate a 2048-bit RSA keypair.
options<~Hash>:
:type<~String> - "rsa" or "dsa", "rsa" by default
:bits<~Integer> - Bit length
:comment<~String> - Comment to use for the public key, defaults to ""
:passphrase<~String> - Encrypt the key with this passphrase
# File lib/sshkey.rb, line 26 def generate(options = {}) type = options[:type] || "rsa" # JRuby modulus size must range from 512 to 1024 default_bits = type == "rsa" ? 2048 : 1024 bits = options[:bits] || default_bits cipher = OpenSSL::Cipher::Cipher.new("AES-128-CBC") if options[:passphrase] case type.downcase when "rsa" then new(OpenSSL::PKey::RSA.generate(bits).to_pem(cipher, options[:passphrase]), options) when "dsa" then new(OpenSSL::PKey::DSA.generate(bits).to_pem(cipher, options[:passphrase]), options) else raise "Unknown key type: #{type}" end end
Fingerprints
Accepts either a public or private key
MD5 fingerprint for the given SSH key
# File lib/sshkey.rb, line 73 def md5_fingerprint(key) if key.match(/PRIVATE/) new(key).md5_fingerprint else Digest::MD5.hexdigest(decoded_key(key)).gsub(fingerprint_regex, '\1:\2') end end
Create a new SSHKey object
private_key - Existing RSA or DSA private key
options<~Hash>
:comment<~String> - Comment to use for the public key, defaults to ""
:passphrase<~String> - If the key is encrypted, supply the passphrase
:directives<~Array> - Options prefixed to the public key
# File lib/sshkey.rb, line 153 def initialize(private_key, options = {}) @passphrase = options[:passphrase] @comment = options[:comment] || "" self.directives = options[:directives] || [] begin @key_object = OpenSSL::PKey::RSA.new(private_key, passphrase) @type = "rsa" rescue @key_object = OpenSSL::PKey::DSA.new(private_key, passphrase) @type = "dsa" end end
SHA1 fingerprint for the given SSH key
# File lib/sshkey.rb, line 83 def sha1_fingerprint(key) if key.match(/PRIVATE/) new(key).sha1_fingerprint else Digest::SHA1.hexdigest(decoded_key(key)).gsub(fingerprint_regex, '\1:\2') end end
Bits
Returns ssh public key bits or false depending on the validity of the public key provided
ssh_public_key<~String> - "ssh-rsa AAAAB3NzaC1yc2EA...."
# File lib/sshkey.rb, line 64 def ssh_public_key_bits(ssh_public_key) unpacked_byte_array( *parse_ssh_public_key(ssh_public_key) ).last.size * 8 end
Validate an existing SSH public key
Returns true or false depending on the validity of the public key provided
ssh_public_key<~String> - "ssh-rsa AAAAB3NzaC1yc2EA...."
# File lib/sshkey.rb, line 50 def valid_ssh_public_key?(ssh_public_key) ssh_type, encoded_key = parse_ssh_public_key(ssh_public_key) SSH_CONVERSION[SSH_TYPES.invert[ssh_type]].size == unpacked_byte_array(ssh_type, encoded_key).size rescue false end
Determine the length (bits) of the key as an integer
# File lib/sshkey.rb, line 211 def bits self.class.ssh_public_key_bits(ssh_public_key) end
# File lib/sshkey.rb, line 272 def directives=(directives) @directives = Array[directives].flatten.compact end
Fetch the encrypted RSA/DSA private key using the passphrase provided
If no passphrase is set, returns the unencrypted private key
# File lib/sshkey.rb, line 178 def encrypted_private_key return private_key unless passphrase key_object.to_pem(OpenSSL::Cipher::Cipher.new("AES-128-CBC"), passphrase) end
Fingerprints
MD5 fingerprint for the given SSH public key
# File lib/sshkey.rb, line 200 def md5_fingerprint Digest::MD5.hexdigest(ssh_public_key_conversion).gsub(/(.{2})(?=.)/, '\1:\2') end
Fetch the RSA/DSA private key
rsa_private_key and dsa_private_key are aliased for backward compatibility
# File lib/sshkey.rb, line 169 def private_key key_object.to_pem end
Fetch the RSA/DSA public key
rsa_public_key and dsa_public_key are aliased for backward compatibility
# File lib/sshkey.rb, line 186 def public_key key_object.public_key.to_pem end
Randomart
Generate OpenSSH compatible ASCII art fingerprints See www.opensource.apple.com/source/OpenSSH/OpenSSH-175/openssh/key.c (key_fingerprint_randomart function)
Example: +--[ RSA 2048]----+ |o+ o.. | |..+.o | | ooo | |.++. o | |o + S | |.. + o . | | . + . | | . . | | Eo. | -----------------
# File lib/sshkey.rb, line 232 def randomart fieldsize_x = 17 fieldsize_y = 9 x = fieldsize_x / 2 y = fieldsize_y / 2 raw_digest = Digest::MD5.digest(ssh_public_key_conversion) num_bytes = raw_digest.bytesize field = Array.new(fieldsize_x) { Array.new(fieldsize_y) {0} } raw_digest.bytes.each do |byte| 4.times do x += (byte & 0x1 != 0) ? 1 : -1 y += (byte & 0x2 != 0) ? 1 : -1 x = [[x, 0].max, fieldsize_x - 1].min y = [[y, 0].max, fieldsize_y - 1].min field[x][y] += 1 if (field[x][y] < num_bytes - 2) byte >>= 2 end end field[fieldsize_x / 2][fieldsize_y / 2] = num_bytes - 1 field[x][y] = num_bytes augmentation_string = " .o+=*BOX@%&#/^SE" output = "+--#{sprintf("[%4s %4u]", type.upcase, bits)}----+\n" fieldsize_y.times do |y| output << "|" fieldsize_x.times do |x| output << augmentation_string[[field[x][y], num_bytes].min] end output << "|" output << "\n" end output << "+#{"-" * fieldsize_x}+" output end
Generated with the Darkfish Rdoc Generator 2.