forked from SAML-Toolkits/python3-saml
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathresponse.html
More file actions
532 lines (456 loc) · 63.5 KB
/
Copy pathresponse.html
File metadata and controls
532 lines (456 loc) · 63.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>saml2.response — OneLogin SAML Python library classes and methods</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="OneLogin SAML Python library classes and methods" href="../../index.html" />
<link rel="up" title="Class code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Class Index"
>modules</a> |</li>
<li><a href="../../index.html">OneLogin SAML Python library classes and methods</a> »</li>
<li><a href="../index.html" accesskey="U">Class code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for saml2.response</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="c"># Copyright (c) 2010-2018 OneLogin, Inc.</span>
<span class="c"># MIT License</span>
<span class="kn">from</span> <span class="nn">base64</span> <span class="kn">import</span> <span class="n">b64decode</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>
<span class="kn">from</span> <span class="nn">lxml</span> <span class="kn">import</span> <span class="n">etree</span>
<span class="kn">from</span> <span class="nn">os.path</span> <span class="kn">import</span> <span class="n">basename</span>
<span class="kn">from</span> <span class="nn">time</span> <span class="kn">import</span> <span class="n">time</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">xml.dom.minidom</span> <span class="kn">import</span> <span class="n">Document</span>
<span class="kn">import</span> <span class="nn">dm.xmlsec.binding</span> <span class="kn">as</span> <span class="nn">xmlsec</span>
<span class="kn">from</span> <span class="nn">saml2.constants</span> <span class="kn">import</span> <span class="n">OneLogin_Saml2_Constants</span>
<span class="kn">from</span> <span class="nn">saml2.utils</span> <span class="kn">import</span> <span class="n">OneLogin_Saml2_Utils</span>
<div class="viewcode-block" id="OneLogin_Saml2_Response"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response">[docs]</a><span class="k">class</span> <span class="nc">OneLogin_Saml2_Response</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructs the response object.</span>
<span class="sd"> :param settings: The setting info</span>
<span class="sd"> :type settings: OneLogin_Saml2_Setting object</span>
<span class="sd"> :param response: The base64 encoded, XML string containing the samlp:Response</span>
<span class="sd"> :type response: string</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__settings</span> <span class="o">=</span> <span class="n">settings</span>
<span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">b64decode</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">document</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">decrypted_document</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span> <span class="o">=</span> <span class="bp">None</span>
<span class="c"># Quick check for the presence of EncryptedAssertion</span>
<span class="n">encrypted_assertion_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'//saml:EncryptedAssertion'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">encrypted_assertion_nodes</span><span class="p">:</span>
<span class="n">decrypted_document</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span> <span class="o">=</span> <span class="bp">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">decrypted_document</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__decrypt_assertion</span><span class="p">(</span><span class="n">decrypted_document</span><span class="p">)</span>
<div class="viewcode-block" id="OneLogin_Saml2_Response.is_valid"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.is_valid">[docs]</a> <span class="k">def</span> <span class="nf">is_valid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_data</span><span class="p">,</span> <span class="n">request_id</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructs the response object.</span>
<span class="sd"> :param request_id: Optional argument. The ID of the AuthNRequest sent by this SP to the IdP</span>
<span class="sd"> :type request_id: string</span>
<span class="sd"> :returns: True if the SAML Response is valid, False if not</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># Checks SAML version</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Version'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> <span class="o">!=</span> <span class="s">'2.0'</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Unsupported SAML version'</span><span class="p">)</span>
<span class="c"># Checks that ID exists</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'ID'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Missing ID attribute on SAML Response'</span><span class="p">)</span>
<span class="c"># Checks that the response only has one assertion</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_num_assertions</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Multiple assertions are not supported'</span><span class="p">)</span>
<span class="c"># Checks that the response has the SUCCESS status</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_status</span><span class="p">()</span>
<span class="n">idp_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_idp_data</span><span class="p">()</span>
<span class="n">idp_entityid</span> <span class="o">=</span> <span class="n">idp_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'entityId'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<span class="n">sp_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_sp_data</span><span class="p">()</span>
<span class="n">sp_entityid</span> <span class="o">=</span> <span class="n">sp_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'entityId'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<span class="n">sign_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'//ds:Signature'</span><span class="p">)</span>
<span class="n">signed_elements</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">sign_node</span> <span class="ow">in</span> <span class="n">sign_nodes</span><span class="p">:</span>
<span class="n">signed_elements</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sign_node</span><span class="o">.</span><span class="n">getparent</span><span class="p">()</span><span class="o">.</span><span class="n">tag</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">is_strict</span><span class="p">():</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">validate_xml</span><span class="p">(</span><span class="n">etree</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="p">),</span> <span class="s">'saml-schema-protocol-2.0.xsd'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">is_debug_active</span><span class="p">())</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">Document</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Invalid SAML Response. Not match the saml-schema-protocol-2.0.xsd'</span><span class="p">)</span>
<span class="n">security</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_security_data</span><span class="p">()</span>
<span class="n">current_url</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">get_self_url_no_query</span><span class="p">(</span><span class="n">request_data</span><span class="p">)</span>
<span class="c"># Check if the InResponseTo of the Response matchs the ID of the AuthNRequest (requestId) if provided</span>
<span class="n">in_response_to</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'InResponseTo'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">in_response_to</span> <span class="ow">and</span> <span class="n">request_id</span><span class="p">:</span>
<span class="k">if</span> <span class="n">in_response_to</span> <span class="o">!=</span> <span class="n">request_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The InResponseTo of the Response: </span><span class="si">%s</span><span class="s">, does not match the ID of the AuthNRequest sent by the SP: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">in_response_to</span><span class="p">,</span> <span class="n">request_id</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span> <span class="ow">and</span> <span class="n">security</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'wantAssertionsEncrypted'</span><span class="p">,</span> <span class="bp">False</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The assertion of the Response is not encrypted and the SP require it'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">security</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'wantNameIdEncrypted'</span><span class="p">,</span> <span class="bp">False</span><span class="p">):</span>
<span class="n">encrypted_nameid_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Subject/saml:EncryptedID/xenc:EncryptedData'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">encrypted_nameid_nodes</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The NameID of the Response is not encrypted and the SP require it'</span><span class="p">)</span>
<span class="c"># Checks that there is at least one AttributeStatement</span>
<span class="n">attribute_statement_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:AttributeStatement'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">attribute_statement_nodes</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'There is no AttributeStatement on the Response'</span><span class="p">)</span>
<span class="c"># Validates Asserion timestamps</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_timestamps</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Timing issues (please check your clock settings)'</span><span class="p">)</span>
<span class="n">encrypted_attributes_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:AttributeStatement/saml:EncryptedAttribute'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">encrypted_attributes_nodes</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'There is an EncryptedAttribute in the Response and this SP not support them'</span><span class="p">)</span>
<span class="c"># Checks destination</span>
<span class="n">destination</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Destination'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">destination</span><span class="p">:</span>
<span class="k">if</span> <span class="n">destination</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current_url</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The response was received at </span><span class="si">%s</span><span class="s"> instead of </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">current_url</span><span class="p">,</span> <span class="n">destination</span><span class="p">))</span>
<span class="c"># Checks audience</span>
<span class="n">valid_audiences</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_audiences</span><span class="p">()</span>
<span class="k">if</span> <span class="n">valid_audiences</span> <span class="ow">and</span> <span class="n">sp_entityid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">valid_audiences</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> is not a valid audience for this Response'</span> <span class="o">%</span> <span class="n">sp_entityid</span><span class="p">)</span>
<span class="c"># Checks the issuers</span>
<span class="n">issuers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_issuers</span><span class="p">()</span>
<span class="k">for</span> <span class="n">issuer</span> <span class="ow">in</span> <span class="n">issuers</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">issuer</span> <span class="ow">or</span> <span class="n">issuer</span> <span class="o">!=</span> <span class="n">idp_entityid</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Invalid issuer in the Assertion/Response'</span><span class="p">)</span>
<span class="c"># Checks the session Expiration</span>
<span class="n">session_expiration</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_session_not_on_or_after</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">session_expiration</span> <span class="ow">and</span> <span class="n">session_expiration</span> <span class="o"><=</span> <span class="n">time</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The attributes have expired, based on the SessionNotOnOrAfter of the AttributeStatement of this Response'</span><span class="p">)</span>
<span class="c"># Checks the SubjectConfirmation, at least one SubjectConfirmation must be valid</span>
<span class="n">any_subject_confirmation</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">subject_confirmation_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Subject/saml:SubjectConfirmation'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">scn</span> <span class="ow">in</span> <span class="n">subject_confirmation_nodes</span><span class="p">:</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">scn</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Method'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">method</span> <span class="ow">and</span> <span class="n">method</span> <span class="o">!=</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">CM_BEARER</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">scData</span> <span class="o">=</span> <span class="n">scn</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'saml:SubjectConfirmationData'</span><span class="p">,</span> <span class="n">namespaces</span><span class="o">=</span><span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">NSMAP</span><span class="p">)</span>
<span class="k">if</span> <span class="n">scData</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">irt</span> <span class="o">=</span> <span class="n">scData</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'InResponseTo'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">irt</span> <span class="o">!=</span> <span class="n">in_response_to</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">recipient</span> <span class="o">=</span> <span class="n">scData</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Recipient'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">recipient</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">current_url</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">nooa</span> <span class="o">=</span> <span class="n">scData</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'NotOnOrAfter'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">nooa</span><span class="p">:</span>
<span class="n">parsed_nooa</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_SAML_to_time</span><span class="p">(</span><span class="n">nooa</span><span class="p">)</span>
<span class="k">if</span> <span class="n">parsed_nooa</span> <span class="o"><=</span> <span class="n">time</span><span class="p">():</span>
<span class="k">continue</span>
<span class="n">nb</span> <span class="o">=</span> <span class="n">scData</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'NotBefore'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">nb</span><span class="p">:</span>
<span class="n">parsed_nb</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_SAML_to_time</span><span class="p">(</span><span class="n">nb</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">parsed_nb</span> <span class="o">></span> <span class="n">time</span><span class="p">()):</span>
<span class="k">continue</span>
<span class="n">any_subject_confirmation</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">break</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">any_subject_confirmation</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'A valid SubjectConfirmation was not found on this Response'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">security</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'wantAssertionsSigned'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> <span class="ow">and</span> <span class="s">'saml:Assertion'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">signed_elements</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The Assertion of the Response is not signed and the SP require it'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">security</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'wantMessagesSigned'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span> <span class="ow">and</span> <span class="s">'samlp:Response'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">signed_elements</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'The Message of the Response is not signed and the SP require it'</span><span class="p">)</span>
<span class="n">document_to_validate</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">signed_elements</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">cert</span> <span class="o">=</span> <span class="n">idp_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'x509cert'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">fingerprint</span> <span class="o">=</span> <span class="n">idp_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'certFingerprint'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="c"># Only validates the first sign found</span>
<span class="k">if</span> <span class="s">'samlp:Response'</span> <span class="ow">in</span> <span class="n">signed_elements</span><span class="p">:</span>
<span class="n">document_to_validate</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span><span class="p">:</span>
<span class="n">document_to_validate</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decrypted_document</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">document_to_validate</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span>
<span class="k">if</span> <span class="n">document_to_validate</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">validate_sign</span><span class="p">(</span><span class="n">document_to_validate</span><span class="p">,</span> <span class="n">cert</span><span class="p">,</span> <span class="n">fingerprint</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Signature validation failed. SAML Response rejected'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">debug</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">is_debug_active</span><span class="p">()</span>
<span class="k">if</span> <span class="n">debug</span><span class="p">:</span>
<span class="k">print</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">False</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.check_status"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.check_status">[docs]</a> <span class="k">def</span> <span class="nf">check_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Check if the status of the response is success or not</span>
<span class="sd"> :raises: Exception. If the status is not success</span>
<span class="sd"> """</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">get_status</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">document</span><span class="p">)</span>
<span class="n">code</span> <span class="o">=</span> <span class="n">status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'code'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">code</span> <span class="ow">and</span> <span class="n">code</span> <span class="o">!=</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">STATUS_SUCCESS</span><span class="p">:</span>
<span class="n">splited_code</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)</span>
<span class="n">printable_code</span> <span class="o">=</span> <span class="n">splited_code</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="n">status_exception_msg</span> <span class="o">=</span> <span class="s">'The status code of the Response was not Success, was </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">printable_code</span>
<span class="n">status_msg</span> <span class="o">=</span> <span class="n">status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'msg'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">status_msg</span><span class="p">:</span>
<span class="n">status_exception_msg</span> <span class="o">+=</span> <span class="s">' -> '</span> <span class="o">+</span> <span class="n">status_msg</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">status_exception_msg</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_audiences"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_audiences">[docs]</a> <span class="k">def</span> <span class="nf">get_audiences</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the audiences</span>
<span class="sd"> :returns: The valid audiences for the SAML Response</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="n">audiences</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">audience_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Conditions/saml:AudienceRestriction/saml:Audience'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">audience_node</span> <span class="ow">in</span> <span class="n">audience_nodes</span><span class="p">:</span>
<span class="n">audiences</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">audience_node</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_issuers"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_issuers">[docs]</a> <span class="k">def</span> <span class="nf">get_issuers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the issuers (from message and from assertion)</span>
<span class="sd"> :returns: The issuers</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="n">issuers</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">message_issuer_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'/samlp:Response/saml:Issuer'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">message_issuer_nodes</span><span class="p">:</span>
<span class="n">issuers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">message_issuer_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
<span class="n">assertion_issuer_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Issuer'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">assertion_issuer_nodes</span><span class="p">:</span>
<span class="n">issuers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">assertion_issuer_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">issuers</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_nameid_data"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_nameid_data">[docs]</a> <span class="k">def</span> <span class="nf">get_nameid_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the NameID Data provided by the SAML Response from the IdP</span>
<span class="sd"> :returns: Name ID Data (Value, Format, NameQualifier, SPNameQualifier)</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> """</span>
<span class="n">nameid</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">encrypted_id_data_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Subject/saml:EncryptedID/xenc:EncryptedData'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">encrypted_id_data_nodes</span><span class="p">:</span>
<span class="n">encrypted_data</span> <span class="o">=</span> <span class="n">encrypted_id_data_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">xmlsec</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="c"># Load the key into the xmlsec context</span>
<span class="n">key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_sp_key</span><span class="p">()</span>
<span class="n">file_key</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">write_temp_file</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="c"># FIXME avoid writing a file</span>
<span class="n">enc_key</span> <span class="o">=</span> <span class="n">xmlsec</span><span class="o">.</span><span class="n">Key</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">file_key</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">xmlsec</span><span class="o">.</span><span class="n">KeyDataFormatPem</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">enc_key</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">basename</span><span class="p">(</span><span class="n">file_key</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">file_key</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">enc_ctx</span> <span class="o">=</span> <span class="n">xmlsec</span><span class="o">.</span><span class="n">EncCtx</span><span class="p">()</span>
<span class="n">enc_ctx</span><span class="o">.</span><span class="n">encKey</span> <span class="o">=</span> <span class="n">enc_key</span>
<span class="n">nameid</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">decrypt_element</span><span class="p">(</span><span class="n">encrypted_data</span><span class="p">,</span> <span class="n">enc_ctx</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">nameid_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:Subject/saml:NameID'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">nameid_nodes</span><span class="p">:</span>
<span class="n">nameid</span> <span class="o">=</span> <span class="n">nameid_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">nameid</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'Not NameID found in the assertion of the Response'</span><span class="p">)</span>
<span class="n">nameid_data</span> <span class="o">=</span> <span class="p">{</span><span class="s">'Value'</span><span class="p">:</span> <span class="n">nameid</span><span class="o">.</span><span class="n">text</span><span class="p">}</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'Format'</span><span class="p">,</span> <span class="s">'SPNameQualifier'</span><span class="p">,</span> <span class="s">'NameQualifier'</span><span class="p">]:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">nameid</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="n">nameid_data</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="n">nameid_data</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_nameid"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_nameid">[docs]</a> <span class="k">def</span> <span class="nf">get_nameid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the NameID provided by the SAML Response from the IdP</span>
<span class="sd"> :returns: NameID (value)</span>
<span class="sd"> :rtype: string</span>
<span class="sd"> """</span>
<span class="n">nameid_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_nameid_data</span><span class="p">()</span>
<span class="k">return</span> <span class="n">nameid_data</span><span class="p">[</span><span class="s">'Value'</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_session_not_on_or_after"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_session_not_on_or_after">[docs]</a> <span class="k">def</span> <span class="nf">get_session_not_on_or_after</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the SessionNotOnOrAfter from the AuthnStatement</span>
<span class="sd"> Could be used to set the local session expiration</span>
<span class="sd"> :returns: The SessionNotOnOrAfter value</span>
<span class="sd"> :rtype: time|None</span>
<span class="sd"> """</span>
<span class="n">not_on_or_after</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">authn_statement_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:AuthnStatement[@SessionNotOnOrAfter]'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">authn_statement_nodes</span><span class="p">:</span>
<span class="n">not_on_or_after</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_SAML_to_time</span><span class="p">(</span><span class="n">authn_statement_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'SessionNotOnOrAfter'</span><span class="p">))</span>
<span class="k">return</span> <span class="n">not_on_or_after</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_session_index"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_session_index">[docs]</a> <span class="k">def</span> <span class="nf">get_session_index</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the SessionIndex from the AuthnStatement</span>
<span class="sd"> Could be used to be stored in the local session in order</span>
<span class="sd"> to be used in a future Logout Request that the SP could</span>
<span class="sd"> send to the SP, to set what specific session must be deleted</span>
<span class="sd"> :returns: The SessionIndex value</span>
<span class="sd"> :rtype: string|None</span>
<span class="sd"> """</span>
<span class="n">session_index</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">authn_statement_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:AuthnStatement[@SessionIndex]'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">authn_statement_nodes</span><span class="p">:</span>
<span class="n">session_index</span> <span class="o">=</span> <span class="n">authn_statement_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'SessionIndex'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">session_index</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.get_attributes"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.get_attributes">[docs]</a> <span class="k">def</span> <span class="nf">get_attributes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Gets the Attributes from the AttributeStatement element.</span>
<span class="sd"> EncryptedAttributes are not supported</span>
<span class="sd"> """</span>
<span class="n">attributes</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">attribute_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query_assertion</span><span class="p">(</span><span class="s">'/saml:AttributeStatement/saml:Attribute'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">attribute_node</span> <span class="ow">in</span> <span class="n">attribute_nodes</span><span class="p">:</span>
<span class="n">attr_name</span> <span class="o">=</span> <span class="n">attribute_node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Name'</span><span class="p">)</span>
<span class="n">values</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">attribute_node</span><span class="o">.</span><span class="n">iterchildren</span><span class="p">(</span><span class="s">'{</span><span class="si">%s</span><span class="s">}AttributeValue'</span> <span class="o">%</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">NSMAP</span><span class="p">[</span><span class="s">'saml'</span><span class="p">]):</span>
<span class="n">values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">attr</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
<span class="n">attributes</span><span class="p">[</span><span class="n">attr_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">values</span>
<span class="k">return</span> <span class="n">attributes</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.validate_num_assertions"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.validate_num_assertions">[docs]</a> <span class="k">def</span> <span class="nf">validate_num_assertions</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Verifies that the document only contains a single Assertion (encrypted or not)</span>
<span class="sd"> :returns: True if only 1 assertion encrypted or not</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="n">encrypted_assertion_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'//saml:EncryptedAssertion'</span><span class="p">)</span>
<span class="n">assertion_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'//saml:Assertion'</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">encrypted_assertion_nodes</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">assertion_nodes</span><span class="p">))</span> <span class="o">==</span> <span class="mi">1</span>
</div>
<div class="viewcode-block" id="OneLogin_Saml2_Response.validate_timestamps"><a class="viewcode-back" href="../../saml2.html#saml2.response.OneLogin_Saml2_Response.validate_timestamps">[docs]</a> <span class="k">def</span> <span class="nf">validate_timestamps</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Verifies that the document is valid according to Conditions Element</span>
<span class="sd"> :returns: True if the condition is valid, False otherwise</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="n">conditions_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="s">'//saml:Conditions'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">conditions_node</span> <span class="ow">in</span> <span class="n">conditions_nodes</span><span class="p">:</span>
<span class="n">nb_attr</span> <span class="o">=</span> <span class="n">conditions_node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'NotBefore'</span><span class="p">)</span>
<span class="n">nooa_attr</span> <span class="o">=</span> <span class="n">conditions_node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'NotOnOrAfter'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">nb_attr</span> <span class="ow">and</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_SAML_to_time</span><span class="p">(</span><span class="n">nb_attr</span><span class="p">)</span> <span class="o">></span> <span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">ALOWED_CLOCK_DRIFT</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">if</span> <span class="n">nooa_attr</span> <span class="ow">and</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_SAML_to_time</span><span class="p">(</span><span class="n">nooa_attr</span><span class="p">)</span> <span class="o">+</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">ALOWED_CLOCK_DRIFT</span> <span class="o"><=</span> <span class="n">time</span><span class="p">():</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<span class="k">def</span> <span class="nf">__query_assertion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xpath_expr</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extracts nodes that match the query from the Assertion</span>
<span class="sd"> :param query: Xpath Expresion</span>
<span class="sd"> :type query: String</span>
<span class="sd"> :returns: The queried nodes</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span><span class="p">:</span>
<span class="n">assertion_expr</span> <span class="o">=</span> <span class="s">'/saml:EncryptedAssertion/saml:Assertion'</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">assertion_expr</span> <span class="o">=</span> <span class="s">'/saml:Assertion'</span>
<span class="n">signature_expr</span> <span class="o">=</span> <span class="s">'/ds:Signature/ds:SignedInfo/ds:Reference'</span>
<span class="n">signed_assertion_query</span> <span class="o">=</span> <span class="s">'/samlp:Response'</span> <span class="o">+</span> <span class="n">assertion_expr</span> <span class="o">+</span> <span class="n">signature_expr</span>
<span class="n">assertion_reference_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="n">signed_assertion_query</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">assertion_reference_nodes</span><span class="p">:</span>
<span class="c"># Check if the message is signed</span>
<span class="n">signed_message_query</span> <span class="o">=</span> <span class="s">'/samlp:Response'</span> <span class="o">+</span> <span class="n">signature_expr</span>
<span class="n">message_reference_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="n">signed_message_query</span><span class="p">)</span>
<span class="k">if</span> <span class="n">message_reference_nodes</span><span class="p">:</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">message_reference_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'URI'</span><span class="p">)</span>
<span class="n">final_query</span> <span class="o">=</span> <span class="s">"/samlp:Response[@ID='</span><span class="si">%s</span><span class="s">']/"</span> <span class="o">%</span> <span class="nb">id</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">final_query</span> <span class="o">=</span> <span class="s">"/samlp:Response/"</span>
<span class="n">final_query</span> <span class="o">+=</span> <span class="n">assertion_expr</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">assertion_reference_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'URI'</span><span class="p">)</span>
<span class="n">final_query</span> <span class="o">=</span> <span class="s">'/samlp:Response'</span> <span class="o">+</span> <span class="n">assertion_expr</span> <span class="o">+</span> <span class="s">"[@ID='</span><span class="si">%s</span><span class="s">']"</span> <span class="o">%</span> <span class="nb">id</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">final_query</span> <span class="o">+=</span> <span class="n">xpath_expr</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__query</span><span class="p">(</span><span class="n">final_query</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extracts nodes that match the query from the Response</span>
<span class="sd"> :param query: Xpath Expresion</span>
<span class="sd"> :type query: String</span>
<span class="sd"> :returns: The queried nodes</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">encrypted</span><span class="p">:</span>
<span class="n">document</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decrypted_document</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">document</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">document</span>
<span class="k">return</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">document</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__decrypt_assertion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dom</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Decrypts the Assertion</span>
<span class="sd"> :raises: Exception if no private key available</span>
<span class="sd"> :param dom: Encrypted Assertion</span>
<span class="sd"> :type dom: Element</span>
<span class="sd"> :returns: Decrypted Assertion</span>
<span class="sd"> :rtype: Element</span>
<span class="sd"> """</span>
<span class="n">key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_sp_key</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'No private key available, check settings'</span><span class="p">)</span>
<span class="c"># TODO Study how decrypt assertion</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Class Index"
>modules</a> |</li>
<li><a href="../../index.html">OneLogin SAML Python library classes and methods</a> »</li>
<li><a href="../index.html" >Class code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, OneLogin Inc..
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>