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