Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 746096f91ae4fb9de9126bc013d3375306fb6854 / . / docs / epy / oauth2client.crypt.Verifier-class.html
blob: f44603f1ab42831b82fb7bdc8a3674b14f0f005f [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.Verifier</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;Verifier
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.Verifier-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 Verifier</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier">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_verifier" name="class_hierarchy_for_verifier">
59<area shape="rect" href="oauth2client.crypt.Verifier-class.html" title="Verifier" alt="" coords="5,5,67,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_verifier.gif" alt='' usemap="#class_hierarchy_for_verifier" 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">
66Verifies the signature on a message.
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.Verifier-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">pubkey</span>)</span><br />
95 Constructor.</td>
96 <td align="right" valign="top">
97 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.__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.Verifier-class.html#verify" class="summary-sig-name">verify</a>(<span class="summary-sig-arg">self</span>,
112 <span class="summary-sig-arg">message</span>,
113 <span class="summary-sig-arg">signature</span>)</span><br />
114 Verifies a message against a signature.</td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.verify">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124 <tr>
125 <td colspan="2" class="summary">
126 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
127 <code>__delattr__</code>,
128 <code>__format__</code>,
129 <code>__getattribute__</code>,
130 <code>__hash__</code>,
131 <code>__new__</code>,
132 <code>__reduce__</code>,
133 <code>__reduce_ex__</code>,
134 <code>__repr__</code>,
135 <code>__setattr__</code>,
136 <code>__sizeof__</code>,
137 <code>__str__</code>,
138 <code>__subclasshook__</code>
139 </p>
140 </td>
141 </tr>
142</table>
143<!-- ==================== STATIC METHODS ==================== -->
144<a name="section-StaticMethods"></a>
145<table class="summary" border="1" cellpadding="3"
146 cellspacing="0" width="100%" bgcolor="white">
147<tr bgcolor="#70b0f0" class="table-header">
148 <td colspan="2" class="table-header">
149 <table border="0" cellpadding="0" cellspacing="0" width="100%">
150 <tr valign="top">
151 <td align="left"><span class="table-header">Static Methods</span></td>
152 <td align="right" valign="top"
153 ><span class="options">[<a href="#section-StaticMethods"
154 class="privatelink" onclick="toggle_private();"
155 >hide private</a>]</span></td>
156 </tr>
157 </table>
158 </td>
159</tr>
160<tr>
161 <td width="15%" align="right" valign="top" class="summary">
162 <span class="summary-type">&nbsp;</span>
163 </td><td class="summary">
164 <table width="100%" cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <td><span class="summary-sig"><a href="oauth2client.crypt.Verifier-class.html#from_string" class="summary-sig-name">from_string</a>(<span class="summary-sig-arg">key_pem</span>,
167 <span class="summary-sig-arg">is_x509_cert</span>)</span><br />
168 Construct a Verified instance from a string.</td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.from_string">source&nbsp;code</a></span>
171
172 </td>
173 </tr>
174 </table>
175
176 </td>
177 </tr>
178</table>
179<!-- ==================== PROPERTIES ==================== -->
180<a name="section-Properties"></a>
181<table class="summary" border="1" cellpadding="3"
182 cellspacing="0" width="100%" bgcolor="white">
183<tr bgcolor="#70b0f0" class="table-header">
184 <td colspan="2" class="table-header">
185 <table border="0" cellpadding="0" cellspacing="0" width="100%">
186 <tr valign="top">
187 <td align="left"><span class="table-header">Properties</span></td>
188 <td align="right" valign="top"
189 ><span class="options">[<a href="#section-Properties"
190 class="privatelink" onclick="toggle_private();"
191 >hide private</a>]</span></td>
192 </tr>
193 </table>
194 </td>
195</tr>
196 <tr>
197 <td colspan="2" class="summary">
198 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
199 <code>__class__</code>
200 </p>
201 </td>
202 </tr>
203</table>
204<!-- ==================== METHOD DETAILS ==================== -->
205<a name="section-MethodDetails"></a>
206<table class="details" border="1" cellpadding="3"
207 cellspacing="0" width="100%" bgcolor="white">
208<tr bgcolor="#70b0f0" class="table-header">
209 <td colspan="2" class="table-header">
210 <table border="0" cellpadding="0" cellspacing="0" width="100%">
211 <tr valign="top">
212 <td align="left"><span class="table-header">Method Details</span></td>
213 <td align="right" valign="top"
214 ><span class="options">[<a href="#section-MethodDetails"
215 class="privatelink" onclick="toggle_private();"
216 >hide private</a>]</span></td>
217 </tr>
218 </table>
219 </td>
220</tr>
221</table>
222<a name="__init__"></a>
223<div>
224<table class="details" border="1" cellpadding="3"
225 cellspacing="0" width="100%" bgcolor="white">
226<tr><td>
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr valign="top"><td>
229 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
230 <span class="sig-arg">pubkey</span>)</span>
231 <br /><em class="fname">(Constructor)</em>
232 </h3>
233 </td><td align="right" valign="top"
234 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.__init__">source&nbsp;code</a></span>&nbsp;
235 </td>
236 </tr></table>
237
238 <pre class="literalblock">
239Constructor.
240
241Args:
242 pubkey, OpenSSL.crypto.PKey, The public key to verify with.
243
244</pre>
245 <dl class="fields">
246 <dt>Overrides:
247 object.__init__
248 </dt>
249 </dl>
250</td></tr></table>
251</div>
252<a name="verify"></a>
253<div>
254<table class="details" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256<tr><td>
257 <table width="100%" cellpadding="0" cellspacing="0" border="0">
258 <tr valign="top"><td>
259 <h3 class="epydoc"><span class="sig"><span class="sig-name">verify</span>(<span class="sig-arg">self</span>,
260 <span class="sig-arg">message</span>,
261 <span class="sig-arg">signature</span>)</span>
262 </h3>
263 </td><td align="right" valign="top"
264 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.verify">source&nbsp;code</a></span>&nbsp;
265 </td>
266 </tr></table>
267
268 <pre class="literalblock">
269Verifies a message against a signature.
270
271Args:
272 message: string, The message to verify.
273 signature: string, The signature on the message.
274
275Returns:
276 True if message was singed by the private key associated with the public
277 key that this object was constructed with.
278
279</pre>
280 <dl class="fields">
281 </dl>
282</td></tr></table>
283</div>
284<a name="from_string"></a>
285<div>
286<table class="details" border="1" cellpadding="3"
287 cellspacing="0" width="100%" bgcolor="white">
288<tr><td>
289 <table width="100%" cellpadding="0" cellspacing="0" border="0">
290 <tr valign="top"><td>
291 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_string</span>(<span class="sig-arg">key_pem</span>,
292 <span class="sig-arg">is_x509_cert</span>)</span>
293 <br /><em class="fname">Static Method</em>
294 </h3>
295 </td><td align="right" valign="top"
296 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#Verifier.from_string">source&nbsp;code</a></span>&nbsp;
297 </td>
298 </tr></table>
299
300 <pre class="literalblock">
301Construct a Verified instance from a string.
302
303Args:
304 key_pem: string, public key in PEM format.
305 is_x509_cert: bool, True if key_pem is an X509 cert, otherwise it is
306 expected to be an RSA key in PEM format.
307
308Returns:
309 Verifier instance.
310
311Raises:
312 OpenSSL.crypto.Error if the key_pem can't be parsed.
313
314</pre>
315 <dl class="fields">
316 </dl>
317</td></tr></table>
318</div>
319<br />
320<!-- ==================== NAVIGATION BAR ==================== -->
321<table class="navbar" border="0" width="100%" cellpadding="0"
322 bgcolor="#a0c0ff" cellspacing="0">
323 <tr valign="middle">
324
325 <!-- Tree link -->
326 <th>&nbsp;&nbsp;&nbsp;<a
327 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
328
329 <!-- Index link -->
330 <th>&nbsp;&nbsp;&nbsp;<a
331 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
332
333 <!-- Help link -->
334 <th>&nbsp;&nbsp;&nbsp;<a
335 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
336
337 <th class="navbar" width="100%"></th>
338 </tr>
339</table>
340<table border="0" cellpadding="0" cellspacing="0" width="100%%">
341 <tr>
342 <td align="left" class="footer">
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame^]343 Generated by Epydoc 3.0.1 on Fri Jun 15 09:51:51 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]344 </td>
345 <td align="right" class="footer">
346 <a target="mainFrame" href="http://epydoc.sourceforge.net"
347 >http://epydoc.sourceforge.net</a>
348 </td>
349 </tr>
350</table>
351
352<script type="text/javascript">
353 <!--
354 // Private objects are initially displayed (because if
355 // javascript is turned off then we want them to be
356 // visible); but by default, we want to hide them. So hide
357 // them unless we have a cookie that says to show them.
358 checkCookie();
359 // -->
360</script>
361</body>
362</html>