From ed280d5ac360e2af796e9bd973d7b4df89f0c449 Mon Sep 17 00:00:00 2001 From: "Jeremy T. Bouse" Date: Fri, 27 Nov 2009 16:20:12 -0500 Subject: Imported Upstream version 1.7.4 --- docs/private/paramiko.RSAKey-class.html | 504 -------------------------------- 1 file changed, 504 deletions(-) delete mode 100644 docs/private/paramiko.RSAKey-class.html (limited to 'docs/private/paramiko.RSAKey-class.html') diff --git a/docs/private/paramiko.RSAKey-class.html b/docs/private/paramiko.RSAKey-class.html deleted file mode 100644 index 0550d72..0000000 --- a/docs/private/paramiko.RSAKey-class.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - paramiko.RSAKey - - - - - - - - - - - - - - - - - - -
- - Package paramiko :: - 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) -
str -__str__(self) -
-Return a string of an SSH Message made up of the public part(s) of -this key.
bool -can_sign(self) -
-Return True if this key has the private part necessary -for signing data.
RSAKey -generate(bits, - progress_func) -
-Generate a new private RSA key. (Static method) -
int -get_bits(self) -
-Return the number of significant bits in this key.
str -get_name(self) -
-Return the name of this private key implementation.
 sign_ssh_data(self, - rpool, - data) -
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.
 _from_private_key_file(self, - filename, - password) -
 _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.
str -_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.
PKey -from_private_key_file(cl, - filename, - password) -
-Create a key object by reading a private key file. (Class method) -
str -get_base64(self) -
-Return a base64 string containing the public part of this key.
str -get_fingerprint(self) -
-Return an MD5 fingerprint of the public part of this key.
    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=None, - filename=None, - password=None, - vals=None) -
(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=str) -
-
-
Raises:
-
SSHException - - if a key cannot be created from the data or - msg given, or no key was passed in. -
-
Overrides:
-
paramiko.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=str) -
-
-
Overrides:
-
paramiko.PKey.__str__ (inherited documentation) -
-
-
-
- - -
-

can_sign(self) -

- Return True if this key has the private part necessary - for signing data. -
-
Returns:
-
- True if this is a private key. -
           - (type=bool) -
-
-
Overrides:
-
paramiko.PKey.can_sign (inherited documentation) -
-
-
-
- - -
-

get_bits(self) -

- Return the number of significant bits in this key. This is useful - for judging the relative security of a key. -
-
Returns:
-
- bits in the key. -
           - (type=int) -
-
-
Overrides:
-
paramiko.PKey.get_bits (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=str) -
-
-
Overrides:
-
paramiko.PKey.get_name (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=str) -
msg - - an SSH signature message -
           - (type=Message) -
-
-
Returns:
-
- True if the signature verifies correctly; - False otherwise. -
           - (type=boolean) -
-
-
Overrides:
-
paramiko.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=str) -
password - - an optional password to use to encrypt the key file. -
           - (type=str) -
-
-
Raises:
-
IOError - - if there was an error writing the file. -
SSHException - - if the key is invalid. -
-
Overrides:
-
paramiko.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 Sun Dec 4 11:16:47 2005http://epydoc.sf.net
- - -- cgit v1.2.3