source: TI12-security/trunk/documentation/epydoc/ndg.security.common.SecurityCGI._SecurityCGI-class.html @ 4245

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/documentation/epydoc/ndg.security.common.SecurityCGI._SecurityCGI-class.html@4245
Revision 4245, 32.1 KB checked in by pjkersha, 11 years ago (diff)

Working unit tests for WSGI based Attribute Authority.

  • Altered so that all Attribute Config is picked up from the Paste ini file. Separate cfg or xml based config file is still supported.

TODO:

  • Simplify unit test config for client.
Line 
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>ndg.security.common.SecurityCGI._SecurityCGI</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  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="ndg-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33  <!-- Project homepage -->
34      <th class="navbar" align="right" width="100%">
35        <table border="0" cellpadding="0" cellspacing="0">
36          <tr><th class="navbar" align="center"
37            >NDG Security</th>
38          </tr></table></th>
39  </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42  <tr valign="top">
43    <td width="100%">
44      <span class="breadcrumbs">
45        <a href="ndg-module.html">Package&nbsp;ndg</a> ::
46        <a href="ndg.security-module.html">Package&nbsp;security</a> ::
47        <a href="ndg.security.common-module.html">Package&nbsp;common</a> ::
48        <a href="ndg.security.common.SecurityCGI-module.html">Module&nbsp;SecurityCGI</a> ::
49        Class&nbsp;_SecurityCGI
50      </span>
51    </td>
52    <td>
53      <table cellpadding="0" cellspacing="0">
54        <!-- hide/show private -->
55        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57      </table>
58    </td>
59  </tr>
60</table>
61<!-- ==================== CLASS DESCRIPTION ==================== -->
62<h1 class="epydoc">Class _SecurityCGI</h1><p class="nomargin-top"><span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI">source&nbsp;code</a></span></p>
63<center>
64<center>  <map id="uml_class_diagram_for_ndg_secu_53" name="uml_class_diagram_for_ndg_secu_53">
65<area shape="rect" href="javascript:void(0);" title="cgi.FieldStorage.FieldStorageClass" alt="" coords="263,28,620,47"/>
66<area shape="rect" href="javascript:void(0);" title="cgi.FieldStorage.bufsize" alt="" coords="263,47,620,65"/>
67<area shape="rect" href="javascript:void(0);" title="cgi.FieldStorage.__iter__" alt="" coords="263,68,620,87"/>
68<area shape="rect" href="javascript:void(0);" title="cgi.FieldStorage.__getattr__" alt="" coords="263,87,620,105"/>
69<area shape="rect" href="javascript:void(0);" title="Dictionary style indexing." alt="" coords="263,105,620,124"/>
70<area shape="rect" href="javascript:void(0);" title="Dictionary style get() method, including &#39;value&#39; lookup." alt="" coords="263,124,620,143"/>
71<area shape="rect" href="javascript:void(0);" title="Return the first value received." alt="" coords="263,143,620,161"/>
72<area shape="rect" href="javascript:void(0);" title="Return list of received values." alt="" coords="263,161,620,180"/>
73<area shape="rect" href="javascript:void(0);" title="Dictionary style keys() method." alt="" coords="263,180,620,199"/>
74<area shape="rect" href="javascript:void(0);" title="Dictionary style has_key() method." alt="" coords="263,199,620,217"/>
75<area shape="rect" href="javascript:void(0);" title="Dictionary style __contains__ method." alt="" coords="263,217,620,236"/>
76<area shape="rect" href="javascript:void(0);" title="Dictionary style len(x) support." alt="" coords="263,236,620,255"/>
77<area shape="rect" href="javascript:void(0);" title="Internal: read data in query string format." alt="" coords="263,255,620,273"/>
78<area shape="rect" href="javascript:void(0);" title="Internal: read a part that is itself multipart." alt="" coords="263,273,620,292"/>
79<area shape="rect" href="javascript:void(0);" title="Internal: read an atomic part." alt="" coords="263,292,620,311"/>
80<area shape="rect" href="javascript:void(0);" title="Overridable: return a readable &amp; writable file." alt="" coords="263,329,620,348"/>
81<area shape="rect" href="javascript:void(0);" title="Store a sequence of fields, reading multipart/form&#45;data." alt="" coords="261,11,621,349"/>
82<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#returnURItag" title="ndg.security.common.SecurityCGI._SecurityCGI.returnURItag" alt="" coords="17,396,865,415"/>
83<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#acAllowMapping" title="ndg.security.common.SecurityCGI._SecurityCGI.acAllowMapping" alt="" coords="17,415,865,433"/>
84<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#acAllowMappingWithPrompt" title="ndg.security.common.SecurityCGI._SecurityCGI.acAllowMappingWithPrompt" alt="" coords="17,433,865,452"/>
85<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#acNoMapping" title="ndg.security.common.SecurityCGI._SecurityCGI.acNoMapping" alt="" coords="17,452,865,471"/>
86<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#acMappingFlags" title="ndg.security.common.SecurityCGI._SecurityCGI.acMappingFlags" alt="" coords="17,471,865,489"/>
87<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#acMappingFlag" title="ndg.security.common.SecurityCGI._SecurityCGI.acMappingFlag" alt="" coords="17,489,865,508"/>
88<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#__init__" title="scriptName: &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;Name of IdP script specified as the action &#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;for HTML forms clntCertFilePath: &#160;&#160;&#160;file path to client public key." alt="" coords="17,511,865,529"/>
89<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#processFields" title="Call appropriate actions according to the fields set" alt="" coords="17,529,865,548"/>
90<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#__call__" title="Alias to processFields method" alt="" coords="17,548,865,567"/>
91<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#onAttCertGranted" title="Callback invoked by getAttCert &#45; handle case where an Attribute Authority &#160;has granted a new attribute certificate to the user." alt="" coords="17,567,865,585"/>
92<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html#onAttCertDenied" title="Callback invoked by getAttCert &#45; handle case where an Attribute Authority has denied an attribute certificate to the user." alt="" coords="17,585,865,604"/>
93<area shape="rect" href="ndg.security.common.SecurityCGI._SecurityCGI&#45;class.html" title="CGI Service Provider &#45; Identity Provider interface base class for NDG Security" alt="" coords="16,379,867,605"/>
94</map>
95  <img src="uml_class_diagram_for_ndg_secu_53.gif" alt='' usemap="#uml_class_diagram_for_ndg_secu_53" ismap="ismap" class="graph-without-title" />
96</center>
97</center>
98<hr />
99<pre class="literalblock">
100CGI Service Provider - Identity Provider interface base class for NDG
101Security
102
103Service Provider (SP)    - serves NDG resources over http/https
104Identity Provider (IdP)  - holds NDG user accounts and supports
105                           authentication over https
106
107</pre>
108
109<!-- ==================== INSTANCE METHODS ==================== -->
110<a name="section-InstanceMethods"></a>
111<table class="summary" border="1" cellpadding="3"
112       cellspacing="0" width="100%" bgcolor="white">
113<tr bgcolor="#70b0f0" class="table-header">
114  <td colspan="2" class="table-header">
115    <table border="0" cellpadding="0" cellspacing="0" width="100%">
116      <tr valign="top">
117        <td align="left"><span class="table-header">Instance Methods</span></td>
118        <td align="right" valign="top"
119         ><span class="options">[<a href="#section-InstanceMethods"
120         class="privatelink" onclick="toggle_private();"
121         >hide private</a>]</span></td>
122      </tr>
123    </table>
124  </td>
125</tr>
126<tr>
127    <td width="15%" align="right" valign="top" class="summary">
128      <span class="summary-type">&nbsp;</span>
129    </td><td class="summary">
130      <table width="100%" cellpadding="0" cellspacing="0" border="0">
131        <tr>
132          <td><span class="summary-sig"><a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
133        <span class="summary-sig-arg">scriptName</span>,
134        <span class="summary-sig-arg">clntCertFilePath</span>=<span class="summary-sig-default">None</span>,
135        <span class="summary-sig-arg">clntPriKeyFilePath</span>=<span class="summary-sig-default">None</span>,
136        <span class="summary-sig-arg">clntPriKeyPwd</span>=<span class="summary-sig-default">None</span>,
137        <span class="summary-sig-arg">wsDebug</span>=<span class="summary-sig-default">False</span>,
138        <span class="summary-sig-arg">**cgiFieldStorageKwArgs</span>)</span><br />
139      scriptName:            Name of IdP script specified as the action
140                          for HTML forms
141clntCertFilePath:    file path to client public key.</td>
142          <td align="right" valign="top">
143            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__init__">source&nbsp;code</a></span>
144           
145          </td>
146        </tr>
147      </table>
148     
149    </td>
150  </tr>
151<tr>
152    <td width="15%" align="right" valign="top" class="summary">
153      <span class="summary-type">&nbsp;</span>
154    </td><td class="summary">
155      <table width="100%" cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td><span class="summary-sig"><a name="processFields"></a><span class="summary-sig-name">processFields</span>(<span class="summary-sig-arg">self</span>,
158        <span class="summary-sig-arg">**kwargs</span>)</span><br />
159      Call appropriate actions according to the fields set</td>
160          <td align="right" valign="top">
161            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.processFields">source&nbsp;code</a></span>
162           
163          </td>
164        </tr>
165      </table>
166     
167    </td>
168  </tr>
169<tr>
170    <td width="15%" align="right" valign="top" class="summary">
171      <span class="summary-type">&nbsp;</span>
172    </td><td class="summary">
173      <table width="100%" cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
176        <span class="summary-sig-arg">**kwargs</span>)</span><br />
177      Alias to processFields method</td>
178          <td align="right" valign="top">
179            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__call__">source&nbsp;code</a></span>
180           
181          </td>
182        </tr>
183      </table>
184     
185    </td>
186  </tr>
187<tr class="private">
188    <td width="15%" align="right" valign="top" class="summary">
189      <span class="summary-type">&nbsp;</span>
190    </td><td class="summary">
191      <table width="100%" cellpadding="0" cellspacing="0" border="0">
192        <tr>
193          <td><span class="summary-sig"><a name="__getACmappingFlag"></a><span class="summary-sig-name">__getACmappingFlag</span>(<span class="summary-sig-arg">self</span>)</span><br />
194      Flag determines whether mapping is permitted when contacting an
195      Attribute Authority to get an Attribute Certificate</td>
196          <td align="right" valign="top">
197            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__getACmappingFlag">source&nbsp;code</a></span>
198           
199          </td>
200        </tr>
201      </table>
202     
203    </td>
204  </tr>
205<tr class="private">
206    <td width="15%" align="right" valign="top" class="summary">
207      <span class="summary-type">&nbsp;</span>
208    </td><td class="summary">
209      <table width="100%" cellpadding="0" cellspacing="0" border="0">
210        <tr>
211          <td><span class="summary-sig"><a name="__setACmappingFlag"></a><span class="summary-sig-name">__setACmappingFlag</span>(<span class="summary-sig-arg">self</span>,
212        <span class="summary-sig-arg">acMappingFlag</span>)</span><br />
213      Flag determines whether mapping is permitted when contacting an
214      Attribute Authority to get an Attribute Certificate</td>
215          <td align="right" valign="top">
216            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__setACmappingFlag">source&nbsp;code</a></span>
217           
218          </td>
219        </tr>
220      </table>
221     
222    </td>
223  </tr>
224<tr class="private">
225    <td width="15%" align="right" valign="top" class="summary">
226      <span class="summary-type">&nbsp;</span>
227    </td><td class="summary">
228      <table width="100%" cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td><span class="summary-sig"><a name="__delACmappingFlag"></a><span class="summary-sig-name">__delACmappingFlag</span>(<span class="summary-sig-arg">self</span>)</span><br />
231      Prevent certificate mapping flag from being deleted.</td>
232          <td align="right" valign="top">
233            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__delACmappingFlag">source&nbsp;code</a></span>
234           
235          </td>
236        </tr>
237      </table>
238     
239    </td>
240  </tr>
241<tr class="private">
242    <td width="15%" align="right" valign="top" class="summary">
243      <span class="summary-type">&nbsp;</span>
244    </td><td class="summary">
245      <table width="100%" cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <td><span class="summary-sig"><a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#_getAttCert" class="summary-sig-name" onclick="show_private();">_getAttCert</a>(<span class="summary-sig-arg">self</span>,
248        <span class="summary-sig-arg">sessCookie</span>=<span class="summary-sig-default">None</span>,
249        <span class="summary-sig-arg">reqRole</span>=<span class="summary-sig-default">None</span>)</span><br />
250      Contact Attribute Authority to get Attribute Certificate for data
251access</td>
252          <td align="right" valign="top">
253            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI._getAttCert">source&nbsp;code</a></span>
254           
255          </td>
256        </tr>
257      </table>
258     
259    </td>
260  </tr>
261<tr>
262    <td width="15%" align="right" valign="top" class="summary">
263      <span class="summary-type">&nbsp;</span>
264    </td><td class="summary">
265      <table width="100%" cellpadding="0" cellspacing="0" border="0">
266        <tr>
267          <td><span class="summary-sig"><a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#onAttCertGranted" class="summary-sig-name">onAttCertGranted</a>(<span class="summary-sig-arg">self</span>,
268        <span class="summary-sig-arg">attCert</span>)</span><br />
269      Callback invoked by getAttCert - handle case where an Attribute
270      Authority has granted a new attribute certificate to the user.</td>
271          <td align="right" valign="top">
272            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.onAttCertGranted">source&nbsp;code</a></span>
273           
274          </td>
275        </tr>
276      </table>
277     
278    </td>
279  </tr>
280<tr>
281    <td width="15%" align="right" valign="top" class="summary">
282      <span class="summary-type">&nbsp;</span>
283    </td><td class="summary">
284      <table width="100%" cellpadding="0" cellspacing="0" border="0">
285        <tr>
286          <td><span class="summary-sig"><a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#onAttCertDenied" class="summary-sig-name">onAttCertDenied</a>(<span class="summary-sig-arg">self</span>,
287        <span class="summary-sig-arg">extAttCertList</span>,
288        <span class="summary-sig-arg">errMsg</span>)</span><br />
289      Callback invoked by getAttCert - handle case where an Attribute
290Authority has denied an attribute certificate to the user.</td>
291          <td align="right" valign="top">
292            <span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.onAttCertDenied">source&nbsp;code</a></span>
293           
294          </td>
295        </tr>
296      </table>
297     
298    </td>
299  </tr>
300  <tr>
301    <td colspan="2" class="summary">
302    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
303      <code>__delattr__</code>,
304      <code>__getattribute__</code>,
305      <code>__hash__</code>,
306      <code>__new__</code>,
307      <code>__reduce__</code>,
308      <code>__reduce_ex__</code>,
309      <code>__repr__</code>,
310      <code>__setattr__</code>,
311      <code>__str__</code>
312      </p>
313    <p class="indent-wrapped-lines"><b>Inherited from <code>cgi.FieldStorage</code></b>:
314      <code>__contains__</code>,
315      <code>__getattr__</code>,
316      <code>__getitem__</code>,
317      <code>__iter__</code>,
318      <code>__len__</code>,
319      <code>getfirst</code>,
320      <code>getlist</code>,
321      <code>getvalue</code>,
322      <code>has_key</code>,
323      <code>keys</code>,
324      <code>make_file</code>,
325      <code>read_binary</code>,
326      <code>read_lines</code>,
327      <code>read_lines_to_eof</code>,
328      <code>read_lines_to_outerboundary</code>,
329      <code>read_multi</code>,
330      <code>read_single</code>,
331      <code>read_urlencoded</code>,
332      <code>skip_lines</code>
333      </p>
334    </td>
335  </tr>
336</table>
337<!-- ==================== CLASS VARIABLES ==================== -->
338<a name="section-ClassVariables"></a>
339<table class="summary" border="1" cellpadding="3"
340       cellspacing="0" width="100%" bgcolor="white">
341<tr bgcolor="#70b0f0" class="table-header">
342  <td colspan="2" class="table-header">
343    <table border="0" cellpadding="0" cellspacing="0" width="100%">
344      <tr valign="top">
345        <td align="left"><span class="table-header">Class Variables</span></td>
346        <td align="right" valign="top"
347         ><span class="options">[<a href="#section-ClassVariables"
348         class="privatelink" onclick="toggle_private();"
349         >hide private</a>]</span></td>
350      </tr>
351    </table>
352  </td>
353</tr>
354<tr>
355    <td width="15%" align="right" valign="top" class="summary">
356      <span class="summary-type">&nbsp;</span>
357    </td><td class="summary">
358        <a name="returnURItag"></a><span class="summary-name">returnURItag</span> = <code title="&quot;returnURI&quot;">&quot;returnURI&quot;</code>
359    </td>
360  </tr>
361<tr>
362    <td width="15%" align="right" valign="top" class="summary">
363      <span class="summary-type">&nbsp;</span>
364    </td><td class="summary">
365        <a name="acAllowMapping"></a><span class="summary-name">acAllowMapping</span> = <code title="&quot;allowMapping&quot;">&quot;allowMapping&quot;</code>
366    </td>
367  </tr>
368<tr>
369    <td width="15%" align="right" valign="top" class="summary">
370      <span class="summary-type">&nbsp;</span>
371    </td><td class="summary">
372        <a name="acAllowMappingWithPrompt"></a><span class="summary-name">acAllowMappingWithPrompt</span> = <code title="&quot;allowMappingWithPrompt&quot;">&quot;allowMappingWithPrompt&quot;</code>
373    </td>
374  </tr>
375<tr>
376    <td width="15%" align="right" valign="top" class="summary">
377      <span class="summary-type">&nbsp;</span>
378    </td><td class="summary">
379        <a name="acNoMapping"></a><span class="summary-name">acNoMapping</span> = <code title="&quot;noMapping&quot;">&quot;noMapping&quot;</code>
380    </td>
381  </tr>
382<tr>
383    <td width="15%" align="right" valign="top" class="summary">
384      <span class="summary-type">&nbsp;</span>
385    </td><td class="summary">
386        <a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#acMappingFlags" class="summary-name">acMappingFlags</a> = <code title="[acAllowMapping, acAllowMappingWithPrompt, acNoMapping]">[acAllowMapping, acAllowMappingWithPrompt, ac<code class="variable-ellipsis">...</code></code>
387    </td>
388  </tr>
389<tr class="private">
390    <td width="15%" align="right" valign="top" class="summary">
391      <span class="summary-type">&nbsp;</span>
392    </td><td class="summary">
393        <a name="_httpsSpecifier"></a><span class="summary-name">_httpsSpecifier</span> = <code title="&quot;https:&quot;">&quot;https:&quot;</code>
394    </td>
395  </tr>
396<tr class="private">
397    <td width="15%" align="right" valign="top" class="summary">
398      <span class="summary-type">&nbsp;</span>
399    </td><td class="summary">
400        <a name="_httpSpecifier"></a><span class="summary-name">_httpSpecifier</span> = <code title="&quot;http:&quot;">&quot;http:&quot;</code>
401    </td>
402  </tr>
403<tr>
404    <td width="15%" align="right" valign="top" class="summary">
405      <span class="summary-type">&nbsp;</span>
406    </td><td class="summary">
407        <a href="ndg.security.common.SecurityCGI._SecurityCGI-class.html#acMappingFlag" class="summary-name">acMappingFlag</a> = <code title="property(fget= __getACmappingFlag, fset= __setACmappingFlag, fdel= __d\
408elACmappingFlag, doc= &quot;mapping flag for AttCert requests to an AA&quot;)">property(fget= __getACmappingFlag, fset= __set<code class="variable-ellipsis">...</code></code>
409    </td>
410  </tr>
411  <tr>
412    <td colspan="2" class="summary">
413    <p class="indent-wrapped-lines"><b>Inherited from <code>cgi.FieldStorage</code></b>:
414      <code>FieldStorageClass</code>,
415      <code>bufsize</code>
416      </p>
417    </td>
418  </tr>
419</table>
420<!-- ==================== PROPERTIES ==================== -->
421<a name="section-Properties"></a>
422<table class="summary" border="1" cellpadding="3"
423       cellspacing="0" width="100%" bgcolor="white">
424<tr bgcolor="#70b0f0" class="table-header">
425  <td colspan="2" class="table-header">
426    <table border="0" cellpadding="0" cellspacing="0" width="100%">
427      <tr valign="top">
428        <td align="left"><span class="table-header">Properties</span></td>
429        <td align="right" valign="top"
430         ><span class="options">[<a href="#section-Properties"
431         class="privatelink" onclick="toggle_private();"
432         >hide private</a>]</span></td>
433      </tr>
434    </table>
435  </td>
436</tr>
437  <tr>
438    <td colspan="2" class="summary">
439    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
440      <code>__class__</code>
441      </p>
442    </td>
443  </tr>
444</table>
445<!-- ==================== METHOD DETAILS ==================== -->
446<a name="section-MethodDetails"></a>
447<table class="details" border="1" cellpadding="3"
448       cellspacing="0" width="100%" bgcolor="white">
449<tr bgcolor="#70b0f0" class="table-header">
450  <td colspan="2" class="table-header">
451    <table border="0" cellpadding="0" cellspacing="0" width="100%">
452      <tr valign="top">
453        <td align="left"><span class="table-header">Method Details</span></td>
454        <td align="right" valign="top"
455         ><span class="options">[<a href="#section-MethodDetails"
456         class="privatelink" onclick="toggle_private();"
457         >hide private</a>]</span></td>
458      </tr>
459    </table>
460  </td>
461</tr>
462</table>
463<a name="__init__"></a>
464<div>
465<table class="details" border="1" cellpadding="3"
466       cellspacing="0" width="100%" bgcolor="white">
467<tr><td>
468  <table width="100%" cellpadding="0" cellspacing="0" border="0">
469  <tr valign="top"><td>
470  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
471        <span class="sig-arg">scriptName</span>,
472        <span class="sig-arg">clntCertFilePath</span>=<span class="sig-default">None</span>,
473        <span class="sig-arg">clntPriKeyFilePath</span>=<span class="sig-default">None</span>,
474        <span class="sig-arg">clntPriKeyPwd</span>=<span class="sig-default">None</span>,
475        <span class="sig-arg">wsDebug</span>=<span class="sig-default">False</span>,
476        <span class="sig-arg">**cgiFieldStorageKwArgs</span>)</span>
477    <br /><em class="fname">(Constructor)</em>
478  </h3>
479  </td><td align="right" valign="top"
480    ><span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.__init__">source&nbsp;code</a></span>&nbsp;
481    </td>
482  </tr></table>
483 
484  <pre class="literalblock">
485scriptName:            Name of IdP script specified as the action
486                          for HTML forms
487clntCertFilePath:    file path to client public key.  The CGI
488                          script must have access to a public/private
489                          key to enable encryption of return traffic
490                          from NDG security WSs.  IF THIS KEYWORD IS
491                          NOT SET, RETURN TRAFFIC IS NOT ENCRYPTED.
492clntPriKeyFilePath:       file path to client private key.
493clntPriKeyPwd:            password protecting the private key.  If no
494                          password is set, omit this keyword.
495wsDebug:                  print output from WS transactions to stderr
496                          for debu purposes.
497
498</pre>
499  <dl class="fields">
500    <dt>Overrides:
501        cgi.FieldStorage.__init__
502    </dt>
503  </dl>
504</td></tr></table>
505</div>
506<a name="_getAttCert"></a>
507<div class="private">
508<table class="details" border="1" cellpadding="3"
509       cellspacing="0" width="100%" bgcolor="white">
510<tr><td>
511  <table width="100%" cellpadding="0" cellspacing="0" border="0">
512  <tr valign="top"><td>
513  <h3 class="epydoc"><span class="sig"><span class="sig-name">_getAttCert</span>(<span class="sig-arg">self</span>,
514        <span class="sig-arg">sessCookie</span>=<span class="sig-default">None</span>,
515        <span class="sig-arg">reqRole</span>=<span class="sig-default">None</span>)</span>
516  </h3>
517  </td><td align="right" valign="top"
518    ><span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI._getAttCert">source&nbsp;code</a></span>&nbsp;
519    </td>
520  </tr></table>
521 
522  <pre class="literalblock">
523Contact Attribute Authority to get Attribute Certificate for data
524access
525
526sessCookie:     NDG security session cookie
527reqRole:        specify the required role to get authorisation.  Set
528                this to optimise the process for getting the required
529                AC from a trusted host in order to perform mapping
530
531</pre>
532  <dl class="fields">
533  </dl>
534</td></tr></table>
535</div>
536<a name="onAttCertGranted"></a>
537<div>
538<table class="details" border="1" cellpadding="3"
539       cellspacing="0" width="100%" bgcolor="white">
540<tr><td>
541  <table width="100%" cellpadding="0" cellspacing="0" border="0">
542  <tr valign="top"><td>
543  <h3 class="epydoc"><span class="sig"><span class="sig-name">onAttCertGranted</span>(<span class="sig-arg">self</span>,
544        <span class="sig-arg">attCert</span>)</span>
545  </h3>
546  </td><td align="right" valign="top"
547    ><span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.onAttCertGranted">source&nbsp;code</a></span>&nbsp;
548    </td>
549  </tr></table>
550 
551  <p>Callback invoked by getAttCert - handle case where an Attribute
552  Authority has granted a new attribute certificate to the user.  Derive
553  from this class and override this method as required.</p>
554  <dl class="fields">
555  </dl>
556</td></tr></table>
557</div>
558<a name="onAttCertDenied"></a>
559<div>
560<table class="details" border="1" cellpadding="3"
561       cellspacing="0" width="100%" bgcolor="white">
562<tr><td>
563  <table width="100%" cellpadding="0" cellspacing="0" border="0">
564  <tr valign="top"><td>
565  <h3 class="epydoc"><span class="sig"><span class="sig-name">onAttCertDenied</span>(<span class="sig-arg">self</span>,
566        <span class="sig-arg">extAttCertList</span>,
567        <span class="sig-arg">errMsg</span>)</span>
568  </h3>
569  </td><td align="right" valign="top"
570    ><span class="codelink"><a href="ndg.security.common.SecurityCGI-pysrc.html#_SecurityCGI.onAttCertDenied">source&nbsp;code</a></span>&nbsp;
571    </td>
572  </tr></table>
573 
574  <pre class="literalblock">
575Callback invoked by getAttCert - handle case where an Attribute
576Authority has denied an attribute certificate to the user.  Derive
577from this class and override this method as required.
578
579extAttCertList:    a list of attribute certificates from trusted
580                   hosts.  Any of these could be selected and
581                   presented back to the target AA in order to get
582                   a mapped certificate.  This list may be None if
583                   no ACs could be obtained or if the
584                   mapFromTrustedHosts flag in the call to the Session
585                   Manager WS reqAuthorisation method was set to
586                   False.
587                   
588errMsg:            the error message returned from the call to the
589                   AA to get an AC.
590
591</pre>
592  <dl class="fields">
593  </dl>
594</td></tr></table>
595</div>
596<br />
597<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
598<a name="section-ClassVariableDetails"></a>
599<table class="details" border="1" cellpadding="3"
600       cellspacing="0" width="100%" bgcolor="white">
601<tr bgcolor="#70b0f0" class="table-header">
602  <td colspan="2" class="table-header">
603    <table border="0" cellpadding="0" cellspacing="0" width="100%">
604      <tr valign="top">
605        <td align="left"><span class="table-header">Class Variable Details</span></td>
606        <td align="right" valign="top"
607         ><span class="options">[<a href="#section-ClassVariableDetails"
608         class="privatelink" onclick="toggle_private();"
609         >hide private</a>]</span></td>
610      </tr>
611    </table>
612  </td>
613</tr>
614</table>
615<a name="acMappingFlags"></a>
616<div>
617<table class="details" border="1" cellpadding="3"
618       cellspacing="0" width="100%" bgcolor="white">
619<tr><td>
620  <h3 class="epydoc">acMappingFlags</h3>
621 
622  <dl class="fields">
623  </dl>
624  <dl class="fields">
625    <dt>Value:</dt>
626      <dd><table><tr><td><pre class="variable">
627[acAllowMapping, acAllowMappingWithPrompt, acNoMapping]
628</pre></td></tr></table>
629</dd>
630  </dl>
631</td></tr></table>
632</div>
633<a name="acMappingFlag"></a>
634<div>
635<table class="details" border="1" cellpadding="3"
636       cellspacing="0" width="100%" bgcolor="white">
637<tr><td>
638  <h3 class="epydoc">acMappingFlag</h3>
639 
640  <dl class="fields">
641  </dl>
642  <dl class="fields">
643    <dt>Value:</dt>
644      <dd><table><tr><td><pre class="variable">
645property(fget= __getACmappingFlag, fset= __setACmappingFlag, fdel= __d<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
646elACmappingFlag, doc= &quot;mapping flag for AttCert requests to an AA&quot;)
647</pre></td></tr></table>
648</dd>
649  </dl>
650</td></tr></table>
651</div>
652<br />
653<!-- ==================== NAVIGATION BAR ==================== -->
654<table class="navbar" border="0" width="100%" cellpadding="0"
655       bgcolor="#a0c0ff" cellspacing="0">
656  <tr valign="middle">
657  <!-- Home link -->
658      <th>&nbsp;&nbsp;&nbsp;<a
659        href="ndg-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
660
661  <!-- Tree link -->
662      <th>&nbsp;&nbsp;&nbsp;<a
663        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
664
665  <!-- Index link -->
666      <th>&nbsp;&nbsp;&nbsp;<a
667        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
668
669  <!-- Help link -->
670      <th>&nbsp;&nbsp;&nbsp;<a
671        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
672
673  <!-- Project homepage -->
674      <th class="navbar" align="right" width="100%">
675        <table border="0" cellpadding="0" cellspacing="0">
676          <tr><th class="navbar" align="center"
677            >NDG Security</th>
678          </tr></table></th>
679  </tr>
680</table>
681<table border="0" cellpadding="0" cellspacing="0" width="100%%">
682  <tr>
683    <td align="left" class="footer">
684    <a href="epydoc-log.html">Generated by Epydoc
685    3.0.1 on Thu Sep  4 09:37:43 2008</a>
686    </td>
687    <td align="right" class="footer">
688      <a target="mainFrame" href="http://epydoc.sourceforge.net"
689        >http://epydoc.sourceforge.net</a>
690    </td>
691  </tr>
692</table>
693
694<script type="text/javascript">
695  <!--
696  // Private objects are initially displayed (because if
697  // javascript is turned off then we want them to be
698  // visible); but by default, we want to hide them.  So hide
699  // them unless we have a cookie that says to show them.
700  checkCookie();
701  // -->
702</script>
703</body>
704</html>
Note: See TracBrowser for help on using the repository browser.