diff options
Diffstat (limited to 'docs/public/paramiko.AgentKey-class.html')
| -rw-r--r-- | docs/public/paramiko.AgentKey-class.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/docs/public/paramiko.AgentKey-class.html b/docs/public/paramiko.AgentKey-class.html new file mode 100644 index 0000000..203e0f4 --- /dev/null +++ b/docs/public/paramiko.AgentKey-class.html @@ -0,0 +1,236 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!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"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> + +<!-- =========== START OF NAVBAR =========== --> +<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="center"> + <th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> + <th class="navbar"> <a class="navbar" 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%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class AgentKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.AgentKey-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.AgentKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type AgentKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>AgentKey</b> +</pre><br /> + +<hr/> + +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. +<hr/> + + +<!-- =========== START OF METHOD SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Method Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>agent</span>, + <span class=summary-sig-arg>blob</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#sign_ssh_data" class="summary-sig-name"><code>sign_ssh_data</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>randpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Sign a blob of data with this private key, and return a <a +href="paramiko.Message-class.html" class="link"><code>Message</code></a> +representing an SSH signature message.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance Method Details</th></tr> +</table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="sign_ssh_data"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>randpool</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Sign a blob of data with this private key, and return a <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> representing an SSH signature + message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>randpool</b></code> - + a secure random number generator. + <br /><i> + (type=<code>Crypto.Util.randpool.RandomPool</code>)</i> + <dd><code><b>data</b></code> - + the data to sign. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SSH signature message. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#sign_ssh_data"><code>paramiko.PKey.sign_ssh_data</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF NAVBAR =========== --> +<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="center"> + <th class="navbar"> <a class="navbar" href="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> + <th class="navbar"> <a class="navbar" 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"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</font></td> + <td align="right"><a href="http://epydoc.sourceforge.net" + ><font size="-2">http://epydoc.sf.net</font></a></td> + </tr> +</table> +</body> +</html> |