diff options
Diffstat (limited to 'docs/paramiko.AgentKey-class.html')
| -rw-r--r-- | docs/paramiko.AgentKey-class.html | 399 |
1 files changed, 0 insertions, 399 deletions
diff --git a/docs/paramiko.AgentKey-class.html b/docs/paramiko.AgentKey-class.html deleted file mode 100644 index 3034e6c..0000000 --- a/docs/paramiko.AgentKey-class.html +++ /dev/null @@ -1,399 +0,0 @@ -<?xml version="1.0" encoding="ascii"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> - <title>paramiko.AgentKey</title> - <link rel="stylesheet" href="epydoc.css" type="text/css" /> - <script type="text/javascript" src="epydoc.js"></script> -</head> - -<body bgcolor="white" text="black" link="blue" vlink="#204080" - alink="#204080"> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th> <a - href="paramiko-module.html">Home</a> </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table width="100%" cellpadding="0" cellspacing="0"> - <tr valign="top"> - <td width="100%"> - <span class="breadcrumbs"> - <a href="paramiko-module.html">Package paramiko</a> :: - Class AgentKey - </span> - </td> - <td> - <table cellpadding="0" cellspacing="0"> - <!-- hide/show private --> - <tr><td align="right"><span class="options" - >[<a href="frames.html" target="_top">frames</a - >] | <a href="paramiko.AgentKey-class.html" - target="_top">no frames</a>]</span></td></tr> - </table> - </td> - </tr> -</table> -<!-- ==================== CLASS DESCRIPTION ==================== --> -<h1 class="epydoc">Class AgentKey</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#AgentKey">source code</a></span></p> -<pre class="base-tree"> -object --+ - | - <a href="paramiko.PKey-class.html">PKey</a> --+ - | - <strong class="uidshort">AgentKey</strong> -</pre> - -<hr /> -<p>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.</p> - -<!-- ==================== INSTANCE METHODS ==================== --> -<a name="section-InstanceMethods"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Instance Methods</span></td> -</tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.AgentKey-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">agent</span>, - <span class="summary-sig-arg">blob</span>)</span><br /> - Create a new instance of this public key type.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">str</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.AgentKey-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Return a string of an SSH <a href="paramiko.Message-class.html" - class="link">Message</a> made up of the public part(s) of this key.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type">str</span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.AgentKey-class.html#get_name" class="summary-sig-name">get_name</a>(<span class="summary-sig-arg">self</span>)</span><br /> - Return the name of this private key implementation.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"><a href="paramiko.Message-class.html" class="link">Message</a></span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="paramiko.AgentKey-class.html#sign_ssh_data" class="summary-sig-name">sign_ssh_data</a>(<span class="summary-sig-arg">self</span>, - <span class="summary-sig-arg">rng</span>, - <span class="summary-sig-arg">data</span>)</span><br /> - Sign a blob of data with this private key, and return a <a - href="paramiko.Message-class.html" class="link">Message</a> - representing an SSH signature message.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> - <tr> - <td colspan="2" class="summary"> - <p class="indent-wrapped-lines"><b>Inherited from <code><a href="paramiko.PKey-class.html">PKey</a></code></b>: - <code><a href="paramiko.PKey-class.html#__cmp__">__cmp__</a></code>, - <code><a href="paramiko.PKey-class.html#can_sign">can_sign</a></code>, - <code><a href="paramiko.PKey-class.html#get_base64">get_base64</a></code>, - <code><a href="paramiko.PKey-class.html#get_bits">get_bits</a></code>, - <code><a href="paramiko.PKey-class.html#get_fingerprint">get_fingerprint</a></code>, - <code><a href="paramiko.PKey-class.html#verify_ssh_sig">verify_ssh_sig</a></code>, - <code><a href="paramiko.PKey-class.html#write_private_key">write_private_key</a></code>, - <code><a href="paramiko.PKey-class.html#write_private_key_file">write_private_key_file</a></code> - </p> - <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: - <code>__delattr__</code>, - <code>__format__</code>, - <code>__getattribute__</code>, - <code>__hash__</code>, - <code>__new__</code>, - <code>__reduce__</code>, - <code>__reduce_ex__</code>, - <code>__repr__</code>, - <code>__setattr__</code>, - <code>__sizeof__</code>, - <code>__subclasshook__</code> - </p> - </td> - </tr> -</table> -<!-- ==================== CLASS METHODS ==================== --> -<a name="section-ClassMethods"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Class Methods</span></td> -</tr> - <tr> - <td colspan="2" class="summary"> - <p class="indent-wrapped-lines"><b>Inherited from <code><a href="paramiko.PKey-class.html">PKey</a></code></b>: - <code><a href="paramiko.PKey-class.html#from_private_key">from_private_key</a></code>, - <code><a href="paramiko.PKey-class.html#from_private_key_file">from_private_key_file</a></code> - </p> - </td> - </tr> -</table> -<!-- ==================== PROPERTIES ==================== --> -<a name="section-Properties"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Properties</span></td> -</tr> - <tr> - <td colspan="2" class="summary"> - <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: - <code>__class__</code> - </p> - </td> - </tr> -</table> -<!-- ==================== METHOD DETAILS ==================== --> -<a name="section-MethodDetails"></a> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td align="left" colspan="2" class="table-header"> - <span class="table-header">Method Details</span></td> -</tr> -</table> -<a name="__init__"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">agent</span>, - <span class="sig-arg">blob</span>)</span> - <br /><em class="fname">(Constructor)</em> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Create a new instance of this public key type. If <code>msg</code> is - given, the key's public part(s) will be filled in from the message. If - <code>data</code> is given, the key's public part(s) will be filled in - from the string.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>msg</code></strong> - an optional SSH <a href="paramiko.Message-class.html" - class="link">Message</a> containing a public key of this type.</li> - <li><strong class="pname"><code>data</code></strong> - an optional string containing a public key of this type</li> - </ul></dd> - <dt>Raises:</dt> - <dd><ul class="nomargin-top"> - <li><code><strong class='fraise'><a href="paramiko.SSHException-class.html">SSHException</a></strong></code> - if a key cannot be created from the <code>data</code> or - <code>msg</code> given, or no key was passed in.</li> - </ul></dd> - <dt>Overrides: - object.__init__ - <dd><em class="note">(inherited documentation)</em></dd> - </dt> - </dl> -</td></tr></table> -</div> -<a name="__str__"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span> - <br /><em class="fname">(Informal representation operator)</em> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Return a string of an SSH <a href="paramiko.Message-class.html" - class="link">Message</a> made up of the public part(s) of this key. This - string is suitable for passing to <a - href="paramiko.AgentKey-class.html#__init__" class="link">__init__</a> to - re-create the key object later.</p> - <dl class="fields"> - <dt>Returns: str</dt> - <dd>string representation of an SSH key message.</dd> - <dt>Overrides: - object.__str__ - <dd><em class="note">(inherited documentation)</em></dd> - </dt> - </dl> -</td></tr></table> -</div> -<a name="get_name"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">get_name</span>(<span class="sig-arg">self</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Return the name of this private key implementation.</p> - <dl class="fields"> - <dt>Returns: str</dt> - <dd>name of this private key type, in SSH terminology (for example, - <code>"ssh-rsa"</code>).</dd> - <dt>Overrides: - <a href="paramiko.PKey-class.html#get_name">PKey.get_name</a> - <dd><em class="note">(inherited documentation)</em></dd> - </dt> - </dl> -</td></tr></table> -</div> -<a name="sign_ssh_data"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class="sig-arg">self</span>, - <span class="sig-arg">rng</span>, - <span class="sig-arg">data</span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="paramiko.agent-pysrc.html">source code</a></span> - </td> - </tr></table> - - <p>Sign a blob of data with this private key, and return a <a - href="paramiko.Message-class.html" class="link">Message</a> representing - an SSH signature message.</p> - <dl class="fields"> - <dt>Parameters:</dt> - <dd><ul class="nomargin-top"> - <li><strong class="pname"><code>rng</code></strong> - a secure random number generator.</li> - <li><strong class="pname"><code>data</code></strong> - the data to sign.</li> - </ul></dd> - <dt>Returns: <a href="paramiko.Message-class.html" class="link">Message</a></dt> - <dd>an SSH signature message.</dd> - <dt>Overrides: - <a href="paramiko.PKey-class.html#sign_ssh_data">PKey.sign_ssh_data</a> - <dd><em class="note">(inherited documentation)</em></dd> - </dt> - </dl> -</td></tr></table> -</div> -<br /> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th> <a - href="paramiko-module.html">Home</a> </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table border="0" cellpadding="0" cellspacing="0" width="100%%"> - <tr> - <td align="left" class="footer"> - Generated by Epydoc 3.0.1 on Mon May 23 13:50:03 2011 - </td> - <td align="right" class="footer"> - <a target="mainFrame" href="http://epydoc.sourceforge.net" - >http://epydoc.sourceforge.net</a> - </td> - </tr> -</table> - -<script type="text/javascript"> - <!-- - // Private objects are initially displayed (because if - // javascript is turned off then we want them to be - // visible); but by default, we want to hide them. So hide - // them unless we have a cookie that says to show them. - checkCookie(); - // --> -</script> -</body> -</html> |