Blame - docs/oauth2client.crypt.html - platform/external/python/google-api-python-client

><a href=".">index</a> <a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/crypt.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/crypt.py</a></td></tr></table>

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

12

<tt># -*- coding: utf-8 -*-

13

#

14

# Copyright (C) 2011 Google Inc.

15

#

16

# Licensed under the Apache License, Version 2.0 (the "License");

17

# you may not use this file except in compliance with the License.

18

# You may obtain a copy of the License at

19

#

20

#      <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>

21

#

22

# Unless required by applicable law or agreed to in writing, software

23

# distributed under the License is distributed on an "AS IS" BASIS,

24

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

25

# See the License for the specific language governing permissions and

26

# limitations under the License.</tt>

<big>Modules</big></td></tr>

<a href="OpenSSL.crypto.html">OpenSSL.crypto</a>

36

</td><td width="25%" valign=top><a href="hashlib.html">hashlib</a>

37

<a href="logging.html">logging</a>

Joe Gregorio

3d55ac5

2012-02-21 10:11:19 -0500

[diff] [blame^]

38

</td><td width="25%" valign=top><a href="json.html">json</a>

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

39

40

</td><td width="25%" valign=top></td></tr></table></td></tr></table>

<big>Classes</big></td></tr>

<dt><a href="__builtin__.html#object">__builtin__.object</a>

49

</dt><dd>

50

<dl>

51

<dt><a href="oauth2client.crypt.html#Signer">Signer</a>

52

</dt><dt><a href="oauth2client.crypt.html#Verifier">Verifier</a>

53

</dt></dl>

54

</dd>

55

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

56

</dt><dd>

57

<dl>

58

<dt><a href="oauth2client.crypt.html#AppIdentityError">AppIdentityError</a>

</dt></dl>

</dd>

</dl>

<a name="AppIdentityError">class AppIdentityError</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

67

68

69

<td width="100%"><dl><dt>Method resolution order:</dt>

70

<dd><a href="oauth2client.crypt.html#AppIdentityError">AppIdentityError</a></dd>

71

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

72

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

73

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

74

</dl>

75

<hr>

76

Data descriptors defined here:

77

<dl><dt>__weakref__</dt>

78

<dd><tt>list of weak references to the object (if defined)</tt></dd>

79

</dl>

80

<hr>

81

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

82

<dl><dt><a name="AppIdentityError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

83

84

<hr>

85

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

86

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#AppIdentityError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

87

88

<hr>

89

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

90

<dl><dt><a name="AppIdentityError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

91

92

<dl><dt><a name="AppIdentityError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

93

94

<dl><dt><a name="AppIdentityError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

95

96

<dl><dt><a name="AppIdentityError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

97

98

Use of negative indices is not supported.</tt></dd></dl>

99

100

<dl><dt><a name="AppIdentityError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="AppIdentityError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#AppIdentityError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

105

106

<dl><dt><a name="AppIdentityError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="AppIdentityError-__unicode__">__unicode__</a>(...)</dt></dl>

111

112

<hr>

113

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="Signer">class Signer</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

125

126

127

<td colspan=2><tt>Signs messages with a private key.  </tt></td></tr>

128

129

<td width="100%">Methods defined here:

130

<dl><dt><a name="Signer-__init__">__init__</a>(self, pkey)</dt><dd><tt>Constructor.

131

132

Args:

133

pkey, OpenSSL.crypto.PKey, The private key to sign with.</tt></dd></dl>

134

135

<dl><dt><a name="Signer-sign">sign</a>(self, message)</dt><dd><tt>Signs a message.

136

137

Args:

138

message: string, Message to be signed.

139

140

Returns:

141

string, The signature of the message for the given key.</tt></dd></dl>

142

143

<hr>

144

Static methods defined here:

145

<dl><dt><a name="Signer-from_string">from_string</a>(key, password='notasecret')</dt><dd><tt>Construct a <a href="#Signer">Signer</a> instance from a string.

146

147

Args:

148

key: string, private key in P12 format.

149

password: string, password for the private key file.

150

151

Returns:

152

<a href="#Signer">Signer</a> instance.

153

154

Raises:

155

OpenSSL.crypto.Error if the key can't be parsed.</tt></dd></dl>

156

157

<hr>

158

Data descriptors defined here:

159

160

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

161

</dl>

162

<dl><dt>__weakref__</dt>

163

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

<a name="Verifier">class Verifier</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

170

171

172

<td colspan=2><tt>Verifies the signature on a message.  </tt></td></tr>

173

174

<td width="100%">Methods defined here:

175

<dl><dt><a name="Verifier-__init__">__init__</a>(self, pubkey)</dt><dd><tt>Constructor.

176

177

Args:

178

pubkey, OpenSSL.crypto.PKey, The public key to verify with.</tt></dd></dl>

179

180

<dl><dt><a name="Verifier-verify">verify</a>(self, message, signature)</dt><dd><tt>Verifies a message against a signature.

181

182

Args:

183

message: string, The message to verify.

184

signature: string, The signature on the message.

185

186

Returns:

187

True if message was singed by the private key associated with the public

188

key that this <a href="__builtin__.html#object">object</a> was constructed with.</tt></dd></dl>

189

190

<hr>

191

Static methods defined here:

192

<dl><dt><a name="Verifier-from_string">from_string</a>(key_pem, is_x509_cert)</dt><dd><tt>Construct a Verified instance from a string.

193

194

Args:

195

key_pem: string, public key in PEM format.

196

is_x509_cert: bool, True if key_pem is an X509 cert, otherwise it is

197

expected to be an RSA key in PEM format.

198

199

Returns:

200

<a href="#Verifier">Verifier</a> instance.

201

202

Raises:

203

OpenSSL.crypto.Error if the key_pem can't be parsed.</tt></dd></dl>

204

205

<hr>

206

Data descriptors defined here:

207

208

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

209

</dl>

210

<dl><dt>__weakref__</dt>

211

<dd><tt>list of weak references to the object (if defined)</tt></dd>

212

</dl>

213

</td></tr></table></td></tr></table>

<big>Functions</big></td></tr>

218

219

220

<td width="100%"><dl><dt><a name="-make_signed_jwt">make_signed_jwt</a>(signer, payload)</dt><dd><tt>Make a signed JWT.

221

222

See <a href="http://self-issued.info/docs/draft-jones-json-web-token.html">http://self-issued.info/docs/draft-jones-json-web-token.html</a>.

223

224

Args:

225

signer: crypt.<a href="#Signer">Signer</a>, Cryptographic signer.

226

payload: dict, Dictionary of data to convert to JSON and then sign.

227

228

Returns:

229

string, The JWT for the payload.</tt></dd></dl>

230

<dl><dt><a name="-verify_signed_jwt_with_certs">verify_signed_jwt_with_certs</a>(jwt, certs, audience)</dt><dd><tt>Verify a JWT against public certs.

231

232

See <a href="http://self-issued.info/docs/draft-jones-json-web-token.html">http://self-issued.info/docs/draft-jones-json-web-token.html</a>.

Args:

jwt: string, A JWT.

certs: dict, Dictionary where values of public keys in PEM format.

237

audience: string, The audience, 'aud', that this JWT should contain. If

238

None then the JWT's 'aud' parameter is not verified.

239

240

Returns:

241

dict, The deserialized JSON payload in the JWT.

242

243

Raises:

244

<a href="#AppIdentityError">AppIdentityError</a> if any checks are failed.</tt></dd></dl>

</td></tr></table>

<td width="100%">AUTH_TOKEN_LIFETIME_SECS = 300

253

CLOCK_SKEW_SECS = 300

254

MAX_TOKEN_LIFETIME_SECS = 86400</td></tr></table>

255

</body></html>