diff options
Diffstat (limited to 'docs/private/paramiko.Agent-class.html')
| -rw-r--r-- | docs/private/paramiko.Agent-class.html | 155 |
1 files changed, 0 insertions, 155 deletions
diff --git a/docs/private/paramiko.Agent-class.html b/docs/private/paramiko.Agent-class.html deleted file mode 100644 index 1f4e20b..0000000 --- a/docs/private/paramiko.Agent-class.html +++ /dev/null @@ -1,155 +0,0 @@ -<?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.Agent</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 Agent - </b></font></br> - </td> - <td><table cellpadding="0" cellspacing="0"> - <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Agent-class.html">hide private</a>]</font></td></tr> - <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Agent-class.html" target="_top">no frames</a>]</font></td></tr> - </table></td> -</tr></table> - -<!-- =========== START OF CLASS DESCRIPTION =========== --> -<h2 class="class">Class Agent</h2> - -<hr/> - -<p>Client interface for using private keys from an SSH agent running on -the local machine. If an SSH agent is running, this class can be used to -connect to it and retreive <a href="../private/paramiko.PKey-class.html" -class="link"><code>PKey</code></a> objects which can be used when -attempting to authenticate to remote SSH servers.</p> -Because the SSH agent protocol uses environment variables and -unix-domain sockets, this probably doesn't work on Windows. It does work -on most posix platforms though (Linux and MacOS X, for example). -<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><span class="summary-sig"><a href="paramiko.Agent-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Open a session with the local machine's SSH agent, if one is -running.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Close the SSH agent connection.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> tuple of <a href="paramiko.AgentKey-class.html" - class="link"><code>AgentKey</code></a> -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#get_keys" class="summary-sig-name"><code>get_keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Return the list of keys available through the SSH agent, if any.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><a name="_read_all"></a><span class="summary-sig"><span class="summary-sig-name">_read_all</span>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>wanted</span>)</span></code> -</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><a name="_send_message"></a><span class="summary-sig"><span class="summary-sig-name">_send_message</span>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>msg</span>)</span></code> -</td></tr> -</table><br /> - - -<!-- =========== START OF METHOD DETAILS =========== --> -<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="details"> - <th colspan="2">Method Details</th></tr> -</table> - -<a name="__init__"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>)</span> - <br /><i>(Constructor)</i> - </h3> - Open a session with the local machine's SSH agent, if one is - running. If no agent is running, initialization will succeed, but <a - href="paramiko.Agent-class.html#get_keys" - class="link"><code>get_keys</code></a> will return an empty tuple. - <dl><dt></dt><dd> - <dl><dt><b>Raises:</b></dt> - <dd><code><b>SSHException</b></code> - - if an SSH agent is found, but speaks an incompatible - protocol - </dl> - </dd></dl> -</td></tr></table> - -<a name="close"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> - </h3> - Close the SSH agent connection. - <dl><dt></dt><dd> - </dd></dl> -</td></tr></table> - -<a name="get_keys"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_keys</span>(<span class=sig-arg>self</span>)</span> - </h3> - Return the list of keys available through the SSH agent, if any. If - no SSH agent was running (or it couldn't be contacted), an empty list - will be returned. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a list of keys available on the SSH agent - <br /><i> - (type=tuple of <a href="paramiko.AgentKey-class.html" - class="link"><code>AgentKey</code></a>)</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:48 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> |