Package paramiko :: Module rsakey :: Class RSAKey
[show private | hide private]
[frames | no frames]

Type RSAKey

object --+    
         |    
      PKey --+
             |
            RSAKey


Representation of an RSA key which can be used to sign and verify SSH2 data.
Method Summary
  __init__(self, msg, data)
Create a new instance of this public key type.
  __hash__(self)
string __str__(self)
Return a string of an SSH Message made up of the public part(s) of this key.
RSAKey generate(bits, progress_func)
Generate a new private RSA key. (Static method)
string get_name(self)
Return the name of this private key implementation.
  read_private_key_file(self, filename, password)
Read private key contents from a file into this object.
Message sign_ssh_data(self, randpool, data)
Sign a blob of data with this private key, and return a Message representing an SSH signature message.
boolean verify_ssh_sig(self, data, msg)
Given a blob of data, and an SSH message representing a signature of that data, verify that it was signed with this key.
  write_private_key_file(self, filename, password)
Write private key contents into a file.
  _pkcs1imify(self, data)
turn a 20-byte SHA1 hash into a blob of data as large as the key's N, using PKCS1's "emsa-pkcs1-v1_5" encoding.
    Inherited from PKey
int __cmp__(self, other)
Compare this key to another.
PKey from_private_key_file(cl, filename, password)
Create a key object by reading a private key file. (Class method)
string get_base64(self)
Return a base64 string containing the public part of this key.
string get_fingerprint(self)
Return an MD5 fingerprint of the public part of this key.
string _read_private_key_file(self, tag, filename, password)
Read an SSH2-format private key file, looking for a string of the type "BEGIN xxx PRIVATE KEY" for some xxx, base64-decode the text we find, and return it as a string.
  _write_private_key_file(self, tag, filename, data, password)
Write an SSH2-format private key file in a form that can be read by paramiko or openssh.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Class Variable Summary
    Inherited from PKey
dict _CIPHER_TABLE = {'DES-EDE3-CBC': {'blocksize': 8, 'ciphe...

Instance Method Details

__init__(self, msg=None, data='')
(Constructor)

Create a new instance of this public key type. If msg is given, the key's public part(s) will be filled in from the message. If data is given, the key's public part(s) will be filled in from the string.
Parameters:
msg - an optional SSH Message containing a public key of this type.
           (type=Message)
data - an optional string containing a public key of this type
           (type=string)
Overrides:
paramiko.pkey.PKey.__init__ (inherited documentation)

__str__(self)
(Informal representation operator)

Return a string of an SSH Message made up of the public part(s) of this key. This string is suitable for passing to __init__ to re-create the key object later.
Returns:
string representation of an SSH key message.
           (type=string)
Overrides:
paramiko.pkey.PKey.__str__ (inherited documentation)

get_name(self)

Return the name of this private key implementation.
Returns:
name of this private key type, in SSH terminology (for example, "ssh-rsa").
           (type=string)
Overrides:
paramiko.pkey.PKey.get_name (inherited documentation)

read_private_key_file(self, filename, password=None)

Read private key contents from a file into this object. If the private key is encrypted and password is not None, the given password will be used to decrypt the key (otherwise PasswordRequiredException is thrown).
Parameters:
filename - name of the file to read.
           (type=string)
password - an optional password to use to decrypt the key file, if it's encrypted.
           (type=string)
Raises:
IOError - if there was an error reading the file.
PasswordRequiredException - if the private key file is encrypted, and password is None.
SSHException - if the key file is invalid.
Overrides:
paramiko.pkey.PKey.read_private_key_file (inherited documentation)

sign_ssh_data(self, randpool, data)

Sign a blob of data with this private key, and return a Message representing an SSH signature message.
Parameters:
randpool - a secure random number generator.
           (type=Crypto.Util.randpool.RandomPool)
data - the data to sign.
           (type=string)
Returns:
an SSH signature message.
           (type=Message)
Overrides:
paramiko.pkey.PKey.sign_ssh_data (inherited documentation)

verify_ssh_sig(self, data, msg)

Given a blob of data, and an SSH message representing a signature of that data, verify that it was signed with this key.
Parameters:
data - the data that was signed.
           (type=string)
msg - an SSH signature message
           (type=Message)
Returns:
True if the signature verifies correctly; False otherwise.
           (type=boolean)
Overrides:
paramiko.pkey.PKey.verify_ssh_sig (inherited documentation)

write_private_key_file(self, filename, password=None)

Write private key contents into a file. If the password is not None, the key is encrypted before writing.
Parameters:
filename - name of the file to write.
           (type=string)
password - an optional password to use to encrypt the key file.
           (type=string)
Raises:
IOError - if there was an error writing the file.
SSHException - if the key is invalid.
Overrides:
paramiko.pkey.PKey.write_private_key_file (inherited documentation)

Since: fearow

_pkcs1imify(self, data)

turn a 20-byte SHA1 hash into a blob of data as large as the key's N, using PKCS1's "emsa-pkcs1-v1_5" encoding. totally bizarre.

Static Method Details

generate(bits, progress_func=None)

Generate a new private RSA key. This factory function can be used to generate a new host key or authentication key.
Parameters:
bits - number of bits the generated key should be.
           (type=int)
progress_func - an optional function to call at key points in key generation (used by pyCrypto.PublicKey).
           (type=function)
Returns:
new private key
           (type=RSAKey)

Since: fearow


Generated by Epydoc 2.1 on Fri Apr 23 15:55:50 2004 http://epydoc.sf.net