paramiko.AgentKey

Package paramiko :: Class AgentKey |
[show private | hide private]
[frames | no frames]

## Type AgentKey

    object --+
             |
          PKey --+
                 |
                AgentKey

Private key held in a local SSH agent. This type of key can be used for authenticating to a remote server (signing). Most other key operations work as expected.

Method Summary
| `__init__(self, agent, blob)`
str | ``__str__`(self)` Return a string of an SSH `Message` made up of the public part(s) of this key.
str | ``get_name`(self)` Return the name of this private key implementation.
`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.
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.
bool | ``can_sign`(self)` Return `True` if this key has the private part necessary for signing data.
`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.
int | ``get_bits`(self)` Return the number of significant bits in this key.
str | ``get_fingerprint`(self)` Return an MD5 fingerprint of the public part of this key.
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.
Inherited from object
| ``__delattr__`(...)` x.__delattr__('name') <==> del x.name
| ``__getattribute__`(...)` x.__getattribute__('name') <==> x.name
| ``__hash__`(x)` x.__hash__() <==> hash(x)
| ``__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

### __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)

### 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)

### 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=str) Returns: an SSH signature message. (type=`Message`) Overrides: `paramiko.PKey.sign_ssh_data` (inherited documentation)

Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005 | http://epydoc.sf.net