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