Class: Net::SSH::Transport::CipherFactory

Inherits:
Object
  • Object
show all
Defined in:
lib/net/ssh/transport/cipher_factory.rb

Overview

Implements a factory of OpenSSL cipher algorithms.

Constant Summary collapse

SSH_TO_OSSL =

Maps the SSH name of a cipher to it's corresponding OpenSSL name

{
  "3des-cbc"                    => "des-ede3-cbc",
  "blowfish-cbc"                => "bf-cbc",
  "aes256-cbc"                  => "aes-256-cbc",
  "aes192-cbc"                  => "aes-192-cbc",
  "aes128-cbc"                  => "aes-128-cbc",
  "idea-cbc"                    => "idea-cbc",
  "cast128-cbc"                 => "cast-cbc",
  "[email protected]" => "aes-256-cbc",
  "arcfour128"                  => "rc4",
  "arcfour256"                  => "rc4",
  "arcfour512"                  => "rc4",
  "arcfour"                     => "rc4",
  "camellia128-cbc"             => "camellia-128-cbc",
  "camellia192-cbc"             => "camellia-192-cbc",
  "camellia256-cbc"             => "camellia-256-cbc",
  "[email protected]" => "camellia-128-cbc",
  "[email protected]" => "camellia-192-cbc",
  "[email protected]" => "camellia-256-cbc",

  "3des-ctr"                    => "des-ede3",
  "blowfish-ctr"                => "bf-ecb",
  "aes256-ctr"                  => "aes-256-ecb",
  "aes192-ctr"                  => "aes-192-ecb",
  "aes128-ctr"                  => "aes-128-ecb",
  "cast128-ctr"                 => "cast5-ecb",
  "camellia128-ctr"             => "camellia-128-ecb",
  "camellia192-ctr"             => "camellia-192-ecb",
  "camellia256-ctr"             => "camellia-256-ecb",
  "[email protected]" => "camellia-128-ecb",
  "[email protected]" => "camellia-192-ecb",
  "[email protected]" => "camellia-256-ecb",

  "none"                        => "none",
}
KEY_LEN_OVERRIDE =

Ruby's OpenSSL bindings always return a key length of 16 for RC4 ciphers resulting in the error: OpenSSL::CipherError: key length too short. The following ciphers will override this key length.

{
  "arcfour256"                  => 32,
  "arcfour512"                  => 64
}

Class Method Summary collapse

Class Method Details

.get(name, options = {}) ⇒ Object

Retrieves a new instance of the named algorithm. The new instance will be initialized using an iv and key generated from the given iv, key, shared, hash and digester values. Additionally, the cipher will be put into encryption or decryption mode, based on the value of the encrypt parameter.


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/net/ssh/transport/cipher_factory.rb', line 69

def self.get(name, options={})
  ossl_name = SSH_TO_OSSL[name] or raise NotImplementedError, "unimplemented cipher `#{name}'"
  return IdentityCipher if ossl_name == "none"
  cipher = OpenSSL::Cipher::Cipher.new(ossl_name)

  cipher.send(options[:encrypt] ? :encrypt : :decrypt)

  cipher.padding = 0

  cipher.extend(Net::SSH::Transport::CTR) if (name =~ /-ctr(@openssh.org)?$/)
  cipher.iv      = Net::SSH::Transport::KeyExpander.expand_key(cipher.iv_len, options[:iv], options) if ossl_name != "rc4"

  key_len = KEY_LEN_OVERRIDE[name] || cipher.key_len
  cipher.key_len = key_len
  cipher.key     = Net::SSH::Transport::KeyExpander.expand_key(key_len, options[:key], options)
  cipher.update(" " * 1536) if (ossl_name == "rc4" && name != "arcfour")

  return cipher
end

.get_lengths(name) ⇒ Object

Returns a two-element array containing the [ key-length, block-size ] for the named cipher algorithm. If the cipher algorithm is unknown, or is “none”, 0 is returned for both elements of the tuple.


93
94
95
96
97
98
99
100
101
102
# File 'lib/net/ssh/transport/cipher_factory.rb', line 93

def self.get_lengths(name)
  ossl_name = SSH_TO_OSSL[name]
  return [0, 0] if ossl_name.nil? || ossl_name == "none"

  cipher = OpenSSL::Cipher::Cipher.new(ossl_name)
  key_len = KEY_LEN_OVERRIDE[name] || cipher.key_len
  cipher.key_len = key_len
  
  return [key_len, ossl_name=="rc4" ? 8 : cipher.block_size]
end

.supported?(name) ⇒ Boolean

Returns true if the underlying OpenSSL library supports the given cipher, and false otherwise.

Returns:

  • (Boolean)

58
59
60
61
62
# File 'lib/net/ssh/transport/cipher_factory.rb', line 58

def self.supported?(name)
  ossl_name = SSH_TO_OSSL[name] or raise NotImplementedError, "unimplemented cipher `#{name}'"
  return true if ossl_name == "none"
  return OpenSSL::Cipher.ciphers.include?(ossl_name)
end