← Back to branch summary

~jelmer/ubuntu/natty/paramiko/randompool+addressfamilies

« back to all changes in this revision

Viewing changes to docs/paramiko.AgentKey-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy T. Bouse
  • Date: 2008-05-04 11:41:27 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080504114127-rzkweoe8bzxoj7te
Tags: 1.7.3-1
http://bugs.debian.org/475505
http://bugs.debian.org/455547
http://bugs.debian.org/405552
* New upstream version
  Closes: #475505.
* Acknowledge NMU changes
* Missing examples included
  Closes: #455547.
* Confirmed new upstream version corrected FutureWarning
  Closes: #405552.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/paramiko.AgentKey-class.html
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
 
1
<?xml version="1.0" encoding="ascii"?>
2
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
          "DTD/xhtml1-transitional.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
<head>
6
6
  <title>paramiko.AgentKey</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
8
9
</head>
 
10
 
9
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
12
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" width="100%"></th>
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
      <th class="navbar" width="100%"></th>
20
34
  </tr>
21
35
</table>
22
36
<table width="100%" cellpadding="0" cellspacing="0">
23
37
  <tr valign="top">
24
38
    <td width="100%">
25
 
      <font size="-1"><b class="breadcrumbs">
 
39
      <span class="breadcrumbs">
26
40
        <a href="paramiko-module.html">Package&nbsp;paramiko</a> ::
27
41
        Class&nbsp;AgentKey
28
 
      </b></font></br>
29
 
    </td>
30
 
    <td><table cellpadding="0" cellspacing="0">
31
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="paramiko.AgentKey-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
32
 
    </table></td>
33
 
</tr></table>
34
 
 
35
 
<!-- =========== START OF CLASS DESCRIPTION =========== -->
36
 
<h2 class="class">Type AgentKey</h2>
37
 
 
 
42
      </span>
 
43
    </td>
 
44
    <td>
 
45
      <table cellpadding="0" cellspacing="0">
 
46
        <!-- hide/show private -->
 
47
        <tr><td align="right"><span class="options"
 
48
            >[<a href="frames.html" target="_top">frames</a
 
49
            >]&nbsp;|&nbsp;<a href="paramiko.AgentKey-class.html"
 
50
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
51
      </table>
 
52
    </td>
 
53
  </tr>
 
54
</table>
 
55
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
56
<h1 class="epydoc">Class AgentKey</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#AgentKey">source&nbsp;code</a></span></p>
38
57
<pre class="base-tree">
39
 
<a href="__builtin__.object-class.html"><code>object</code></a> --+    
 
58
object --+    
40
59
         |    
41
 
      <a href="paramiko.PKey-class.html"><code>PKey</code></a> --+
 
60
      <a href="paramiko.PKey-class.html">PKey</a> --+
42
61
             |
43
 
            <b>AgentKey</b>
44
 
</pre><br />
45
 
 
46
 
<hr/>
47
 
 
48
 
Private key held in a local SSH agent. This type of key can be used 
49
 
for authenticating to a remote server (signing). Most other key 
50
 
operations work as expected.
51
 
<hr/>
52
 
 
53
 
 
54
 
<!-- =========== START OF METHOD SUMMARY =========== -->
55
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
56
 
<tr bgcolor="#70b0f0" class="summary">
57
 
  <th colspan="2">Method Summary</th></tr>
58
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
59
 
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
60
 
          <span class=summary-sig-arg>agent</span>,
61
 
          <span class=summary-sig-arg>blob</span>)</span></code>
62
 
</td></tr>
63
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        str
64
 
</font></td>
65
 
  <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>
66
 
<br />
67
 
Return a string of an SSH <a href="paramiko.Message-class.html" 
68
 
class="link"><code>Message</code></a> made up of the public part(s) of 
69
 
this key.</td></tr>
70
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        str
71
 
</font></td>
72
 
  <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>
73
 
<br />
74
 
Return the name of this private key implementation.</td></tr>
75
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.Message-class.html" 
76
 
        class="link"><code>Message</code></a>
77
 
</font></td>
78
 
  <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>,
79
 
          <span class=summary-sig-arg>randpool</span>,
80
 
          <span class=summary-sig-arg>data</span>)</span></code>
81
 
<br />
82
 
Sign a blob of data with this private key, and return a <a 
83
 
href="paramiko.Message-class.html" class="link"><code>Message</code></a> 
84
 
representing an SSH signature message.</td></tr>
85
 
<tr bgcolor="#e8f0f8" class="group">
86
 
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from PKey</th></tr>
87
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        int
88
 
</font></td>
89
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>,
90
 
          <span class=summary-sig-arg>other</span>)</span></code>
91
 
<br />
92
 
Compare this key to another.</td></tr>
93
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        bool
94
 
</font></td>
95
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
96
 
<br />
97
 
Return <code>True</code> if this key has the private part necessary 
98
 
for signing data.</td></tr>
99
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.PKey-class.html" 
100
 
        class="link"><code>PKey</code></a>
101
 
</font></td>
102
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#from_private_key" class="summary-sig-name"><code>from_private_key</code></a>(<span class=summary-sig-arg>cls</span>,
103
 
          <span class=summary-sig-arg>file_obj</span>,
104
 
          <span class=summary-sig-arg>password</span>)</span></code>
105
 
<br />
106
 
Create a key object by reading a private key from a file (or 
107
 
file-like) object.    <i>(Class method)</i>
108
 
</td></tr>
109
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="paramiko.PKey-class.html" 
110
 
        class="link"><code>PKey</code></a>
111
 
</font></td>
112
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#from_private_key_file" class="summary-sig-name"><code>from_private_key_file</code></a>(<span class=summary-sig-arg>cls</span>,
113
 
          <span class=summary-sig-arg>filename</span>,
114
 
          <span class=summary-sig-arg>password</span>)</span></code>
115
 
<br />
116
 
Create a key object by reading a private key file.    <i>(Class method)</i>
117
 
</td></tr>
118
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        str
119
 
</font></td>
120
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#get_base64" class="summary-sig-name"><code>get_base64</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
121
 
<br />
122
 
Return a base64 string containing the public part of this key.</td></tr>
123
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        int
124
 
</font></td>
125
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
126
 
<br />
127
 
Return the number of significant bits in this key.</td></tr>
128
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        str
129
 
</font></td>
130
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#get_fingerprint" class="summary-sig-name"><code>get_fingerprint</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
131
 
<br />
132
 
Return an MD5 fingerprint of the public part of this key.</td></tr>
133
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        boolean
134
 
</font></td>
135
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>,
136
 
          <span class=summary-sig-arg>data</span>,
137
 
          <span class=summary-sig-arg>msg</span>)</span></code>
138
 
<br />
139
 
Given a blob of data, and an SSH message representing a signature of 
140
 
that data, verify that it was signed with this key.</td></tr>
141
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
142
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#write_private_key" class="summary-sig-name"><code>write_private_key</code></a>(<span class=summary-sig-arg>self</span>,
143
 
          <span class=summary-sig-arg>file_obj</span>,
144
 
          <span class=summary-sig-arg>password</span>)</span></code>
145
 
<br />
146
 
Write private key contents into a file (or file-like) object.</td></tr>
147
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
148
 
  <td><code><span class="summary-sig"><a href="paramiko.PKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>,
149
 
          <span class=summary-sig-arg>filename</span>,
150
 
          <span class=summary-sig-arg>password</span>)</span></code>
151
 
<br />
152
 
Write private key contents into a file.</td></tr>
153
 
<tr bgcolor="#e8f0f8" class="group">
154
 
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
155
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
156
 
  <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>
157
 
<br />
158
 
x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
159
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
160
 
  <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>
161
 
<br />
162
 
x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
163
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
164
 
  <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>
165
 
<br />
166
 
x.__hash__() &lt;==&gt; hash(x)</td></tr>
167
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
168
 
  <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>,
169
 
          <span class=summary-sig-arg>S</span>,
170
 
          <span class="summary-sig-vararg">...</span>)</span></code>
171
 
<br />
172
 
T.__new__(S, ...) -&gt; a new object with type S, a subtype of T</td></tr>
173
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
174
 
  <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>
175
 
<br />
176
 
helper for pickle</td></tr>
177
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
178
 
  <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>
179
 
<br />
180
 
helper for pickle</td></tr>
181
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
182
 
  <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>
183
 
<br />
184
 
x.__repr__() &lt;==&gt; repr(x)</td></tr>
185
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
186
 
  <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>
187
 
<br />
188
 
x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
189
 
</table><br />
190
 
 
191
 
 
192
 
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
193
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
194
 
<tr bgcolor="#70b0f0" class="details">
195
 
  <th colspan="2">Instance Method Details</th></tr>
196
 
</table>
197
 
 
 
62
            <strong class="uidshort">AgentKey</strong>
 
63
</pre>
 
64
 
 
65
<hr />
 
66
<p>Private key held in a local SSH agent.  This type of key can be used 
 
67
  for authenticating to a remote server (signing).  Most other key 
 
68
  operations work as expected.</p>
 
69
 
 
70
<!-- ==================== INSTANCE METHODS ==================== -->
 
71
<a name="section-InstanceMethods"></a>
 
72
<table class="summary" border="1" cellpadding="3"
 
73
       cellspacing="0" width="100%" bgcolor="white">
 
74
<tr bgcolor="#70b0f0" class="table-header">
 
75
  <td align="left" colspan="2" class="table-header">
 
76
    <span class="table-header">Instance Methods</span></td>
 
77
</tr>
 
78
<tr>
 
79
    <td width="15%" align="right" valign="top" class="summary">
 
80
      <span class="summary-type">&nbsp;</span>
 
81
    </td><td class="summary">
 
82
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
83
        <tr>
 
84
          <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>,
 
85
        <span class="summary-sig-arg">agent</span>,
 
86
        <span class="summary-sig-arg">blob</span>)</span><br />
 
87
      Create a new instance of this public key type.</td>
 
88
          <td align="right" valign="top">
 
89
            <span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>
 
90
            
 
91
          </td>
 
92
        </tr>
 
93
      </table>
 
94
      
 
95
    </td>
 
96
  </tr>
 
97
<tr>
 
98
    <td width="15%" align="right" valign="top" class="summary">
 
99
      <span class="summary-type">str</span>
 
100
    </td><td class="summary">
 
101
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
102
        <tr>
 
103
          <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 />
 
104
      Return a string of an SSH <a href="paramiko.Message-class.html" 
 
105
      class="link">Message</a> made up of the public part(s) of this key.</td>
 
106
          <td align="right" valign="top">
 
107
            <span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>
 
108
            
 
109
          </td>
 
110
        </tr>
 
111
      </table>
 
112
      
 
113
    </td>
 
114
  </tr>
 
115
<tr>
 
116
    <td width="15%" align="right" valign="top" class="summary">
 
117
      <span class="summary-type">str</span>
 
118
    </td><td class="summary">
 
119
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
120
        <tr>
 
121
          <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 />
 
122
      Return the name of this private key implementation.</td>
 
123
          <td align="right" valign="top">
 
124
            <span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>
 
125
            
 
126
          </td>
 
127
        </tr>
 
128
      </table>
 
129
      
 
130
    </td>
 
131
  </tr>
 
132
<tr>
 
133
    <td width="15%" align="right" valign="top" class="summary">
 
134
      <span class="summary-type"><a href="paramiko.Message-class.html" class="link">Message</a></span>
 
135
    </td><td class="summary">
 
136
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
137
        <tr>
 
138
          <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>,
 
139
        <span class="summary-sig-arg">randpool</span>,
 
140
        <span class="summary-sig-arg">data</span>)</span><br />
 
141
      Sign a blob of data with this private key, and return a <a 
 
142
      href="paramiko.Message-class.html" class="link">Message</a> 
 
143
      representing an SSH signature message.</td>
 
144
          <td align="right" valign="top">
 
145
            <span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>
 
146
            
 
147
          </td>
 
148
        </tr>
 
149
      </table>
 
150
      
 
151
    </td>
 
152
  </tr>
 
153
  <tr>
 
154
    <td colspan="2" class="summary">
 
155
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="paramiko.PKey-class.html">PKey</a></code></b>:
 
156
      <code><a href="paramiko.PKey-class.html#__cmp__">__cmp__</a></code>,
 
157
      <code><a href="paramiko.PKey-class.html#can_sign">can_sign</a></code>,
 
158
      <code><a href="paramiko.PKey-class.html#get_base64">get_base64</a></code>,
 
159
      <code><a href="paramiko.PKey-class.html#get_bits">get_bits</a></code>,
 
160
      <code><a href="paramiko.PKey-class.html#get_fingerprint">get_fingerprint</a></code>,
 
161
      <code><a href="paramiko.PKey-class.html#verify_ssh_sig">verify_ssh_sig</a></code>,
 
162
      <code><a href="paramiko.PKey-class.html#write_private_key">write_private_key</a></code>,
 
163
      <code><a href="paramiko.PKey-class.html#write_private_key_file">write_private_key_file</a></code>
 
164
      </p>
 
165
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
166
      <code>__delattr__</code>,
 
167
      <code>__getattribute__</code>,
 
168
      <code>__hash__</code>,
 
169
      <code>__new__</code>,
 
170
      <code>__reduce__</code>,
 
171
      <code>__reduce_ex__</code>,
 
172
      <code>__repr__</code>,
 
173
      <code>__setattr__</code>
 
174
      </p>
 
175
    </td>
 
176
  </tr>
 
177
</table>
 
178
<!-- ==================== CLASS METHODS ==================== -->
 
179
<a name="section-ClassMethods"></a>
 
180
<table class="summary" border="1" cellpadding="3"
 
181
       cellspacing="0" width="100%" bgcolor="white">
 
182
<tr bgcolor="#70b0f0" class="table-header">
 
183
  <td align="left" colspan="2" class="table-header">
 
184
    <span class="table-header">Class Methods</span></td>
 
185
</tr>
 
186
  <tr>
 
187
    <td colspan="2" class="summary">
 
188
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="paramiko.PKey-class.html">PKey</a></code></b>:
 
189
      <code><a href="paramiko.PKey-class.html#from_private_key">from_private_key</a></code>,
 
190
      <code><a href="paramiko.PKey-class.html#from_private_key_file">from_private_key_file</a></code>
 
191
      </p>
 
192
    </td>
 
193
  </tr>
 
194
</table>
 
195
<!-- ==================== PROPERTIES ==================== -->
 
196
<a name="section-Properties"></a>
 
197
<table class="summary" border="1" cellpadding="3"
 
198
       cellspacing="0" width="100%" bgcolor="white">
 
199
<tr bgcolor="#70b0f0" class="table-header">
 
200
  <td align="left" colspan="2" class="table-header">
 
201
    <span class="table-header">Properties</span></td>
 
202
</tr>
 
203
  <tr>
 
204
    <td colspan="2" class="summary">
 
205
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
206
      <code>__class__</code>
 
207
      </p>
 
208
    </td>
 
209
  </tr>
 
210
</table>
 
211
<!-- ==================== METHOD DETAILS ==================== -->
 
212
<a name="section-MethodDetails"></a>
 
213
<table class="details" border="1" cellpadding="3"
 
214
       cellspacing="0" width="100%" bgcolor="white">
 
215
<tr bgcolor="#70b0f0" class="table-header">
 
216
  <td align="left" colspan="2" class="table-header">
 
217
    <span class="table-header">Method Details</span></td>
 
218
</tr>
 
219
</table>
 
220
<a name="__init__"></a>
 
221
<div>
 
222
<table class="details" border="1" cellpadding="3"
 
223
       cellspacing="0" width="100%" bgcolor="white">
 
224
<tr><td>
 
225
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
226
  <tr valign="top"><td>
 
227
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
228
        <span class="sig-arg">agent</span>,
 
229
        <span class="sig-arg">blob</span>)</span>
 
230
    <br /><em class="fname">(Constructor)</em>
 
231
  </h3>
 
232
  </td><td align="right" valign="top"
 
233
    ><span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>&nbsp;
 
234
    </td>
 
235
  </tr></table>
 
236
  
 
237
  <p>Create a new instance of this public key type.  If <code>msg</code> is
 
238
  given, the key's public part(s) will be filled in from the message.  If 
 
239
  <code>data</code> is given, the key's public part(s) will be filled in 
 
240
  from the string.</p>
 
241
  <dl class="fields">
 
242
    <dt>Parameters:</dt>
 
243
    <dd><ul class="nomargin-top">
 
244
        <li><strong class="pname"><code>msg</code></strong> - an optional SSH <a href="paramiko.Message-class.html" 
 
245
          class="link">Message</a> containing a public key of this type.</li>
 
246
        <li><strong class="pname"><code>data</code></strong> - an optional string containing a public key of this type</li>
 
247
    </ul></dd>
 
248
    <dt>Raises:</dt>
 
249
    <dd><ul class="nomargin-top">
 
250
        <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 
 
251
        <code>msg</code> given, or no key was passed in.</li>
 
252
    </ul></dd>
 
253
    <dt>Overrides:
 
254
        object.__init__
 
255
        <dd><em class="note">(inherited documentation)</em></dd>
 
256
    </dt>
 
257
  </dl>
 
258
</td></tr></table>
 
259
</div>
198
260
<a name="__str__"></a>
199
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
200
 
  <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span>
201
 
    <br /><i>(Informal representation operator)</i>
 
261
<div>
 
262
<table class="details" border="1" cellpadding="3"
 
263
       cellspacing="0" width="100%" bgcolor="white">
 
264
<tr><td>
 
265
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
266
  <tr valign="top"><td>
 
267
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
 
268
    <br /><em class="fname">(Informal representation operator)</em>
202
269
  </h3>
203
 
  Return a string of an SSH <a href="paramiko.Message-class.html" 
204
 
  class="link"><code>Message</code></a> made up of the public part(s) of 
205
 
  this key. This string is suitable for passing to <a 
206
 
  href="paramiko.PKey-class.html#__init__" 
207
 
  class="link"><code>__init__</code></a> to re-create the key object 
208
 
  later.
209
 
  <dl><dt></dt><dd>
210
 
    <dl><dt><b>Returns:</b></dt>
211
 
      <dd>
212
 
        string representation of an SSH key message.
213
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214
 
        (type=str)</i>
215
 
      </dd>
216
 
    </dl>
217
 
    <dl><dt><b>Overrides:</b></dt>
218
 
      <dd><a href="paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i>
219
 
</dd>
220
 
    </dl>
221
 
  </dd></dl>
 
270
  </td><td align="right" valign="top"
 
271
    ><span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>&nbsp;
 
272
    </td>
 
273
  </tr></table>
 
274
  
 
275
  <p>Return a string of an SSH <a href="paramiko.Message-class.html" 
 
276
  class="link">Message</a> made up of the public part(s) of this key.  This
 
277
  string is suitable for passing to <a 
 
278
  href="paramiko.AgentKey-class.html#__init__" class="link">__init__</a> to
 
279
  re-create the key object later.</p>
 
280
  <dl class="fields">
 
281
    <dt>Returns: str</dt>
 
282
        <dd>string representation of an SSH key message.</dd>
 
283
    <dt>Overrides:
 
284
        object.__str__
 
285
        <dd><em class="note">(inherited documentation)</em></dd>
 
286
    </dt>
 
287
  </dl>
222
288
</td></tr></table>
223
 
 
 
289
</div>
224
290
<a name="get_name"></a>
225
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
226
 
  <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span>
 
291
<div>
 
292
<table class="details" border="1" cellpadding="3"
 
293
       cellspacing="0" width="100%" bgcolor="white">
 
294
<tr><td>
 
295
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
296
  <tr valign="top"><td>
 
297
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_name</span>(<span class="sig-arg">self</span>)</span>
227
298
  </h3>
228
 
  Return the name of this private key implementation.
229
 
  <dl><dt></dt><dd>
230
 
    <dl><dt><b>Returns:</b></dt>
231
 
      <dd>
232
 
        name of this private key type, in SSH terminology (for 
233
 
        example, <code>&quot;ssh-rsa&quot;</code>).
234
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235
 
        (type=str)</i>
236
 
      </dd>
237
 
    </dl>
238
 
    <dl><dt><b>Overrides:</b></dt>
239
 
      <dd><a href="paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i>
240
 
</dd>
241
 
    </dl>
242
 
  </dd></dl>
 
299
  </td><td align="right" valign="top"
 
300
    ><span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>&nbsp;
 
301
    </td>
 
302
  </tr></table>
 
303
  
 
304
  <p>Return the name of this private key implementation.</p>
 
305
  <dl class="fields">
 
306
    <dt>Returns: str</dt>
 
307
        <dd>name of this private key type, in SSH terminology (for example, 
 
308
          <code>&quot;ssh-rsa&quot;</code>).</dd>
 
309
    <dt>Overrides:
 
310
        <a href="paramiko.PKey-class.html#get_name">PKey.get_name</a>
 
311
        <dd><em class="note">(inherited documentation)</em></dd>
 
312
    </dt>
 
313
  </dl>
243
314
</td></tr></table>
244
 
 
 
315
</div>
245
316
<a name="sign_ssh_data"></a>
246
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
247
 
  <h3><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class=sig-arg>self</span>,
248
 
          <span class=sig-arg>randpool</span>,
249
 
          <span class=sig-arg>data</span>)</span>
 
317
<div>
 
318
<table class="details" border="1" cellpadding="3"
 
319
       cellspacing="0" width="100%" bgcolor="white">
 
320
<tr><td>
 
321
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
322
  <tr valign="top"><td>
 
323
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class="sig-arg">self</span>,
 
324
        <span class="sig-arg">randpool</span>,
 
325
        <span class="sig-arg">data</span>)</span>
250
326
  </h3>
251
 
  Sign a blob of data with this private key, and return a <a 
252
 
  href="paramiko.Message-class.html" 
253
 
  class="link"><code>Message</code></a> representing an SSH signature 
254
 
  message.
255
 
  <dl><dt></dt><dd>
256
 
    <dl><dt><b>Parameters:</b></dt>
257
 
      <dd><code><b>randpool</b></code> -
258
 
         a secure random number generator.
259
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
260
 
        (type=<code>Crypto.Util.randpool.RandomPool</code>)</i>
261
 
      <dd><code><b>data</b></code> -
262
 
         the data to sign.
263
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
264
 
        (type=str)</i>
265
 
      </dd>
266
 
    </dl>
267
 
    <dl><dt><b>Returns:</b></dt>
268
 
      <dd>
269
 
        an SSH signature message.
270
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271
 
        (type=<a href="paramiko.Message-class.html" 
272
 
        class="link"><code>Message</code></a>)</i>
273
 
      </dd>
274
 
    </dl>
275
 
    <dl><dt><b>Overrides:</b></dt>
276
 
      <dd><a href="paramiko.PKey-class.html#sign_ssh_data"><code>paramiko.PKey.sign_ssh_data</code></a> <i>(inherited documentation)</i>
277
 
</dd>
278
 
    </dl>
279
 
  </dd></dl>
 
327
  </td><td align="right" valign="top"
 
328
    ><span class="codelink"><a href="paramiko.agent-pysrc.html">source&nbsp;code</a></span>&nbsp;
 
329
    </td>
 
330
  </tr></table>
 
331
  
 
332
  <p>Sign a blob of data with this private key, and return a <a 
 
333
  href="paramiko.Message-class.html" class="link">Message</a> representing 
 
334
  an SSH signature message.</p>
 
335
  <dl class="fields">
 
336
    <dt>Parameters:</dt>
 
337
    <dd><ul class="nomargin-top">
 
338
        <li><strong class="pname"><code>randpool</code></strong> - a secure random number generator.</li>
 
339
        <li><strong class="pname"><code>data</code></strong> - the data to sign.</li>
 
340
    </ul></dd>
 
341
    <dt>Returns: <a href="paramiko.Message-class.html" class="link">Message</a></dt>
 
342
        <dd>an SSH signature message.</dd>
 
343
    <dt>Overrides:
 
344
        <a href="paramiko.PKey-class.html#sign_ssh_data">PKey.sign_ssh_data</a>
 
345
        <dd><em class="note">(inherited documentation)</em></dd>
 
346
    </dt>
 
347
  </dl>
280
348
</td></tr></table>
 
349
</div>
281
350
<br />
282
 
 
283
 
 
284
 
<!-- =========== START OF NAVBAR =========== -->
285
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
286
 
  <tr valign="center">
287
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
288
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
289
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
290
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
291
 
    <th class="navbar" width="100%"></th>
 
351
<!-- ==================== NAVIGATION BAR ==================== -->
 
352
<table class="navbar" border="0" width="100%" cellpadding="0"
 
353
       bgcolor="#a0c0ff" cellspacing="0">
 
354
  <tr valign="middle">
 
355
  <!-- Home link -->
 
356
      <th>&nbsp;&nbsp;&nbsp;<a
 
357
        href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
358
 
 
359
  <!-- Tree link -->
 
360
      <th>&nbsp;&nbsp;&nbsp;<a
 
361
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
362
 
 
363
  <!-- Index link -->
 
364
      <th>&nbsp;&nbsp;&nbsp;<a
 
365
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
366
 
 
367
  <!-- Help link -->
 
368
      <th>&nbsp;&nbsp;&nbsp;<a
 
369
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
370
 
 
371
      <th class="navbar" width="100%"></th>
292
372
  </tr>
293
373
</table>
294
 
 
295
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
374
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
296
375
  <tr>
297
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Jan 21 19:06:09 2008</font></td>
298
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
299
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
376
    <td align="left" class="footer">
 
377
    Generated by Epydoc 3.0.1 on Sun Mar 23 23:59:02 2008
 
378
    </td>
 
379
    <td align="right" class="footer">
 
380
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
381
        >http://epydoc.sourceforge.net</a>
 
382
    </td>
300
383
  </tr>
301
384
</table>
 
385
 
 
386
<script type="text/javascript">
 
387
  <!--
 
388
  // Private objects are initially displayed (because if
 
389
  // javascript is turned off then we want them to be
 
390
  // visible); but by default, we want to hide them.  So hide
 
391
  // them unless we have a cookie that says to show them.
 
392
  checkCookie();
 
393
  // -->
 
394
</script>
302
395
</body>
303
396
</html>