Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 66212035140c8f3abfb6ed14a40db27dbef4d220 / . / docs / epy / oauth2client.crypt.Signer-class.html
blob: bff426a82019ed8bae5b2955504373aa43cfa25c [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.crypt.Signer</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.crypt-module.html">Module&nbsp;crypt</a> ::
39 Class&nbsp;Signer
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.crypt.Signer-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 Signer</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_oauth2cl_29" name="uml_class_diagram_for_oauth2cl_29">
59<area shape="rect" href="oauth2client.crypt.Signer-class.html#__init__" title="Constructor." alt="" coords="17,36,252,55"/>
60<area shape="rect" href="oauth2client.crypt.Signer-class.html#sign" title="Signs a message." alt="" coords="17,55,252,73"/>
61<area shape="rect" href="oauth2client.crypt.Signer-class.html#from_string" title="Construct a Signer instance from a string." alt="" coords="17,73,252,92"/>
62<area shape="rect" href="oauth2client.crypt.Signer-class.html" title="Signs messages with a private key." alt="" coords="16,11,253,93"/>
63</map>
64 <img src="uml_class_diagram_for_oauth2cl_29.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_29" ismap="ismap" class="graph-without-title" />
65</center>
66</center>
67<hr />
68<pre class="literalblock">
69Signs messages with a private key.
70
71</pre>
72
73<!-- ==================== INSTANCE METHODS ==================== -->
74<a name="section-InstanceMethods"></a>
75<table class="summary" border="1" cellpadding="3"
76 cellspacing="0" width="100%" bgcolor="white">
77<tr bgcolor="#70b0f0" class="table-header">
78 <td colspan="2" class="table-header">
79 <table border="0" cellpadding="0" cellspacing="0" width="100%">
80 <tr valign="top">
81 <td align="left"><span class="table-header">Instance Methods</span></td>
82 <td align="right" valign="top"
83 ><span class="options">[<a href="#section-InstanceMethods"
84 class="privatelink" onclick="toggle_private();"
85 >hide private</a>]</span></td>
86 </tr>
87 </table>
88 </td>
89</tr>
90<tr>
91 <td width="15%" align="right" valign="top" class="summary">
92 <span class="summary-type">&nbsp;</span>
93 </td><td class="summary">
94 <table width="100%" cellpadding="0" cellspacing="0" border="0">
95 <tr>
96 <td><span class="summary-sig"><a href="oauth2client.crypt.Signer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
97 <span class="summary-sig-arg">pkey</span>)</span><br />
98 Constructor.</td>
99 <td align="right" valign="top">
100 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.__init__">source&nbsp;code</a></span>
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <td><span class="summary-sig"><a href="oauth2client.crypt.Signer-class.html#sign" class="summary-sig-name">sign</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">message</span>)</span><br />
116 Signs a message.</td>
117 <td align="right" valign="top">
118 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.sign">source&nbsp;code</a></span>
119
120 </td>
121 </tr>
122 </table>
123
124 </td>
125 </tr>
126 <tr>
127 <td colspan="2" class="summary">
128 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
129 <code>__delattr__</code>,
130 <code>__format__</code>,
131 <code>__getattribute__</code>,
132 <code>__hash__</code>,
133 <code>__new__</code>,
134 <code>__reduce__</code>,
135 <code>__reduce_ex__</code>,
136 <code>__repr__</code>,
137 <code>__setattr__</code>,
138 <code>__sizeof__</code>,
139 <code>__str__</code>,
140 <code>__subclasshook__</code>
141 </p>
142 </td>
143 </tr>
144</table>
145<!-- ==================== STATIC METHODS ==================== -->
146<a name="section-StaticMethods"></a>
147<table class="summary" border="1" cellpadding="3"
148 cellspacing="0" width="100%" bgcolor="white">
149<tr bgcolor="#70b0f0" class="table-header">
150 <td colspan="2" class="table-header">
151 <table border="0" cellpadding="0" cellspacing="0" width="100%">
152 <tr valign="top">
153 <td align="left"><span class="table-header">Static Methods</span></td>
154 <td align="right" valign="top"
155 ><span class="options">[<a href="#section-StaticMethods"
156 class="privatelink" onclick="toggle_private();"
157 >hide private</a>]</span></td>
158 </tr>
159 </table>
160 </td>
161</tr>
162<tr>
163 <td width="15%" align="right" valign="top" class="summary">
164 <span class="summary-type">&nbsp;</span>
165 </td><td class="summary">
166 <table width="100%" cellpadding="0" cellspacing="0" border="0">
167 <tr>
168 <td><span class="summary-sig"><a href="oauth2client.crypt.Signer-class.html#from_string" class="summary-sig-name">from_string</a>(<span class="summary-sig-arg">key</span>,
169 <span class="summary-sig-arg">password</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">notasecret</code><code class="variable-quote">'</code></span>)</span><br />
170 Construct a Signer instance from a string.</td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.from_string">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180</table>
181<!-- ==================== PROPERTIES ==================== -->
182<a name="section-Properties"></a>
183<table class="summary" border="1" cellpadding="3"
184 cellspacing="0" width="100%" bgcolor="white">
185<tr bgcolor="#70b0f0" class="table-header">
186 <td colspan="2" class="table-header">
187 <table border="0" cellpadding="0" cellspacing="0" width="100%">
188 <tr valign="top">
189 <td align="left"><span class="table-header">Properties</span></td>
190 <td align="right" valign="top"
191 ><span class="options">[<a href="#section-Properties"
192 class="privatelink" onclick="toggle_private();"
193 >hide private</a>]</span></td>
194 </tr>
195 </table>
196 </td>
197</tr>
198 <tr>
199 <td colspan="2" class="summary">
200 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
201 <code>__class__</code>
202 </p>
203 </td>
204 </tr>
205</table>
206<!-- ==================== METHOD DETAILS ==================== -->
207<a name="section-MethodDetails"></a>
208<table class="details" border="1" cellpadding="3"
209 cellspacing="0" width="100%" bgcolor="white">
210<tr bgcolor="#70b0f0" class="table-header">
211 <td colspan="2" class="table-header">
212 <table border="0" cellpadding="0" cellspacing="0" width="100%">
213 <tr valign="top">
214 <td align="left"><span class="table-header">Method Details</span></td>
215 <td align="right" valign="top"
216 ><span class="options">[<a href="#section-MethodDetails"
217 class="privatelink" onclick="toggle_private();"
218 >hide private</a>]</span></td>
219 </tr>
220 </table>
221 </td>
222</tr>
223</table>
224<a name="__init__"></a>
225<div>
226<table class="details" border="1" cellpadding="3"
227 cellspacing="0" width="100%" bgcolor="white">
228<tr><td>
229 <table width="100%" cellpadding="0" cellspacing="0" border="0">
230 <tr valign="top"><td>
231 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
232 <span class="sig-arg">pkey</span>)</span>
233 <br /><em class="fname">(Constructor)</em>
234 </h3>
235 </td><td align="right" valign="top"
236 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.__init__">source&nbsp;code</a></span>&nbsp;
237 </td>
238 </tr></table>
239
240 <pre class="literalblock">
241Constructor.
242
243Args:
244 pkey, OpenSSL.crypto.PKey, The private key to sign with.
245
246</pre>
247 <dl class="fields">
248 <dt>Overrides:
249 object.__init__
250 </dt>
251 </dl>
252</td></tr></table>
253</div>
254<a name="sign"></a>
255<div>
256<table class="details" border="1" cellpadding="3"
257 cellspacing="0" width="100%" bgcolor="white">
258<tr><td>
259 <table width="100%" cellpadding="0" cellspacing="0" border="0">
260 <tr valign="top"><td>
261 <h3 class="epydoc"><span class="sig"><span class="sig-name">sign</span>(<span class="sig-arg">self</span>,
262 <span class="sig-arg">message</span>)</span>
263 </h3>
264 </td><td align="right" valign="top"
265 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.sign">source&nbsp;code</a></span>&nbsp;
266 </td>
267 </tr></table>
268
269 <pre class="literalblock">
270Signs a message.
271
272Args:
273 message: string, Message to be signed.
274
275Returns:
276 string, The signature of the message for the given key.
277
278</pre>
279 <dl class="fields">
280 </dl>
281</td></tr></table>
282</div>
283<a name="from_string"></a>
284<div>
285<table class="details" border="1" cellpadding="3"
286 cellspacing="0" width="100%" bgcolor="white">
287<tr><td>
288 <table width="100%" cellpadding="0" cellspacing="0" border="0">
289 <tr valign="top"><td>
290 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_string</span>(<span class="sig-arg">key</span>,
291 <span class="sig-arg">password</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">notasecret</code><code class="variable-quote">'</code></span>)</span>
292 <br /><em class="fname">Static Method</em>
293 </h3>
294 </td><td align="right" valign="top"
295 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Signer.from_string">source&nbsp;code</a></span>&nbsp;
296 </td>
297 </tr></table>
298
299 <pre class="literalblock">
300Construct a Signer instance from a string.
301
302Args:
303 key: string, private key in P12 format.
304 password: string, password for the private key file.
305
306Returns:
307 Signer instance.
308
309Raises:
310 OpenSSL.crypto.Error if the key can't be parsed.
311
312</pre>
313 <dl class="fields">
314 </dl>
315</td></tr></table>
316</div>
317<br />
318<!-- ==================== NAVIGATION BAR ==================== -->
319<table class="navbar" border="0" width="100%" cellpadding="0"
320 bgcolor="#a0c0ff" cellspacing="0">
321 <tr valign="middle">
322
323 <!-- Tree link -->
324 <th>&nbsp;&nbsp;&nbsp;<a
325 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
326
327 <!-- Index link -->
328 <th>&nbsp;&nbsp;&nbsp;<a
329 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
330
331 <!-- Help link -->
332 <th>&nbsp;&nbsp;&nbsp;<a
333 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
334
335 <th class="navbar" width="100%"></th>
336 </tr>
337</table>
338<table border="0" cellpadding="0" cellspacing="0" width="100%%">
339 <tr>
340 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]341 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]342 </td>
343 <td align="right" class="footer">
344 <a target="mainFrame" href="http://epydoc.sourceforge.net"
345 >http://epydoc.sourceforge.net</a>
346 </td>
347 </tr>
348</table>
349
350<script type="text/javascript">
351 <!--
352 // Private objects are initially displayed (because if
353 // javascript is turned off then we want them to be
354 // visible); but by default, we want to hide them. So hide
355 // them unless we have a cookie that says to show them.
356 checkCookie();
357 // -->
358</script>
359</body>
360</html>