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

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/documentation/epydoc/ndg.security.common.CredWallet.CredWallet-class.html@4245
Revision 4245, 74.8 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.CredWallet.CredWallet</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.CredWallet-module.html">Module&nbsp;CredWallet</a> ::
49        Class&nbsp;CredWallet
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 CredWallet</h1><p class="nomargin-top"><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet">source&nbsp;code</a></span></p>
63<center>
64<center>  <map id="uml_class_diagram_for_ndg_secu_41" name="uml_class_diagram_for_ndg_secu_41">
65<area shape="rect" href="ndg.security.common.CredWallet._MetaCredWallet&#45;class.html" title="Enable CredWallet to have read only class variables e.g." alt="" coords="17,28,1500,47"/>
66<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#userCert" title="ndg.security.common.CredWallet.CredWallet.userCert" alt="" coords="17,47,1500,65"/>
67<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#issuingCert" title="ndg.security.common.CredWallet.CredWallet.issuingCert" alt="" coords="17,65,1500,84"/>
68<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#userPriKey" title="ndg.security.common.CredWallet.CredWallet.userPriKey" alt="" coords="17,84,1500,103"/>
69<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#credentials" title="ndg.security.common.CredWallet.CredWallet.credentials" alt="" coords="17,103,1500,121"/>
70<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#caCertFilePathList" title="ndg.security.common.CredWallet.CredWallet.caCertFilePathList" alt="" coords="17,121,1500,140"/>
71<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#aaURI" title="ndg.security.common.CredWallet.CredWallet.aaURI" alt="" coords="17,140,1500,159"/>
72<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#aaClnt" title="ndg.security.common.CredWallet.CredWallet.aaClnt" alt="" coords="17,159,1500,177"/>
73<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#aaPropFilePath" title="ndg.security.common.CredWallet.CredWallet.aaPropFilePath" alt="" coords="17,177,1500,196"/>
74<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#aa" title="ndg.security.common.CredWallet.CredWallet.aa" alt="" coords="17,196,1500,215"/>
75<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#__init__" title="Create store of user credentials for their current session" alt="" coords="17,217,1500,236"/>
76<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#isValid" title="Check wallet&#39;s user cert." alt="" coords="17,236,1500,255"/>
77<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#addCredential" title="Add a new attribute certificate to the list of credentials held." alt="" coords="17,255,1500,273"/>
78<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#audit" title="Check the credentials held in the wallet removing any that have expired or &#160;are otherwise invalid." alt="" coords="17,273,1500,292"/>
79<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#updateCredRepos" title="Copy over non&#45;persistent credentials held by wallet into the perminent &#160;repository." alt="" coords="17,292,1500,311"/>
80<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#getAATrustedHostInfo" title="Wrapper to Attribute Authority getTrustedHostInfo" alt="" coords="17,311,1500,329"/>
81<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html#getAttCert" title="For a given role, get an Attribute Certificate from an Attribute &#160;Authority using a user&#39;s X.509 certificate." alt="" coords="17,329,1500,348"/>
82<area shape="rect" href="ndg.security.common.CredWallet.CredWallet&#45;class.html" title="Volatile store of user credentials associated with a user session" alt="" coords="16,11,1501,349"/>
83</map>
84  <img src="uml_class_diagram_for_ndg_secu_41.gif" alt='' usemap="#uml_class_diagram_for_ndg_secu_41" ismap="ismap" class="graph-without-title" />
85</center>
86</center>
87<hr />
88<p>Volatile store of user credentials associated with a user session</p>
89
90<!-- ==================== NESTED CLASSES ==================== -->
91<a name="section-NestedClasses"></a>
92<table class="summary" border="1" cellpadding="3"
93       cellspacing="0" width="100%" bgcolor="white">
94<tr bgcolor="#70b0f0" class="table-header">
95  <td colspan="2" class="table-header">
96    <table border="0" cellpadding="0" cellspacing="0" width="100%">
97      <tr valign="top">
98        <td align="left"><span class="table-header">Nested Classes</span></td>
99        <td align="right" valign="top"
100         ><span class="options">[<a href="#section-NestedClasses"
101         class="privatelink" onclick="toggle_private();"
102         >hide private</a>]</span></td>
103      </tr>
104    </table>
105  </td>
106</tr>
107<tr>
108    <td width="15%" align="right" valign="top" class="summary">
109      <span class="summary-type">&nbsp;</span>
110    </td><td class="summary">
111        <a href="ndg.security.common.CredWallet._MetaCredWallet-class.html" class="summary-name">__metaclass__</a><br />
112      Enable CredWallet to have read only class variables e.g.
113    </td>
114  </tr>
115</table>
116<!-- ==================== INSTANCE METHODS ==================== -->
117<a name="section-InstanceMethods"></a>
118<table class="summary" border="1" cellpadding="3"
119       cellspacing="0" width="100%" bgcolor="white">
120<tr bgcolor="#70b0f0" class="table-header">
121  <td colspan="2" class="table-header">
122    <table border="0" cellpadding="0" cellspacing="0" width="100%">
123      <tr valign="top">
124        <td align="left"><span class="table-header">Instance Methods</span></td>
125        <td align="right" valign="top"
126         ><span class="options">[<a href="#section-InstanceMethods"
127         class="privatelink" onclick="toggle_private();"
128         >hide private</a>]</span></td>
129      </tr>
130    </table>
131  </td>
132</tr>
133<tr>
134    <td width="15%" align="right" valign="top" class="summary">
135      <span class="summary-type">&nbsp;</span>
136    </td><td class="summary">
137      <table width="100%" cellpadding="0" cellspacing="0" border="0">
138        <tr>
139          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
140        <span class="summary-sig-arg">userCert</span>,
141        <span class="summary-sig-arg">userPriKey</span>,
142        <span class="summary-sig-arg">issuingCert</span>=<span class="summary-sig-default">None</span>,
143        <span class="summary-sig-arg">caCertFilePathList</span>=<span class="summary-sig-default">None</span>,
144        <span class="summary-sig-arg">aaURI</span>=<span class="summary-sig-default">None</span>,
145        <span class="summary-sig-arg">aaPropFilePath</span>=<span class="summary-sig-default">None</span>,
146        <span class="summary-sig-arg">credRepos</span>=<span class="summary-sig-default">None</span>,
147        <span class="summary-sig-arg">mapFromTrustedHosts</span>=<span class="summary-sig-default">False</span>,
148        <span class="summary-sig-arg">rtnExtAttCertList</span>=<span class="summary-sig-default">True</span>,
149        <span class="summary-sig-arg">attCertRefreshElapse</span>=<span class="summary-sig-default">7200</span>,
150        <span class="summary-sig-arg">wssSignatureHandlerKw</span>=<span class="summary-sig-default">{}</span>)</span><br />
151      Create store of user credentials for their current session</td>
152          <td align="right" valign="top">
153            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__init__">source&nbsp;code</a></span>
154           
155          </td>
156        </tr>
157      </table>
158     
159    </td>
160  </tr>
161<tr class="private">
162    <td width="15%" align="right" valign="top" class="summary">
163      <span class="summary-type">&nbsp;</span>
164    </td><td class="summary">
165      <table width="100%" cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__setCert" class="summary-sig-name" onclick="show_private();">__setCert</a>(<span class="summary-sig-arg">self</span>,
168        <span class="summary-sig-arg">cert</span>)</span><br />
169      filter and convert input cert to signing verifying cert set property
170      methods.</td>
171          <td align="right" valign="top">
172            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setCert">source&nbsp;code</a></span>
173           
174          </td>
175        </tr>
176      </table>
177     
178    </td>
179  </tr>
180<tr class="private">
181    <td width="15%" align="right" valign="top" class="summary">
182      <span class="summary-type">&nbsp;</span>
183    </td><td class="summary">
184      <table width="100%" cellpadding="0" cellspacing="0" border="0">
185        <tr>
186          <td><span class="summary-sig"><a name="__setUserCert"></a><span class="summary-sig-name">__setUserCert</span>(<span class="summary-sig-arg">self</span>,
187        <span class="summary-sig-arg">userCert</span>)</span><br />
188      Set property method for X.509 user cert.</td>
189          <td align="right" valign="top">
190            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setUserCert">source&nbsp;code</a></span>
191           
192          </td>
193        </tr>
194      </table>
195     
196    </td>
197  </tr>
198<tr class="private">
199    <td width="15%" align="right" valign="top" class="summary">
200      <span class="summary-type">&nbsp;</span>
201    </td><td class="summary">
202      <table width="100%" cellpadding="0" cellspacing="0" border="0">
203        <tr>
204          <td><span class="summary-sig"><a name="__getUserCert"></a><span class="summary-sig-name">__getUserCert</span>(<span class="summary-sig-arg">self</span>)</span><br />
205      Get user cert X509Cert instance</td>
206          <td align="right" valign="top">
207            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getUserCert">source&nbsp;code</a></span>
208           
209          </td>
210        </tr>
211      </table>
212     
213    </td>
214  </tr>
215<tr class="private">
216    <td width="15%" align="right" valign="top" class="summary">
217      <span class="summary-type">&nbsp;</span>
218    </td><td class="summary">
219      <table width="100%" cellpadding="0" cellspacing="0" border="0">
220        <tr>
221          <td><span class="summary-sig"><a name="__setIssuingCert"></a><span class="summary-sig-name">__setIssuingCert</span>(<span class="summary-sig-arg">self</span>,
222        <span class="summary-sig-arg">issuingCert</span>)</span><br />
223      Set property method for X.509 user cert.</td>
224          <td align="right" valign="top">
225            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setIssuingCert">source&nbsp;code</a></span>
226           
227          </td>
228        </tr>
229      </table>
230     
231    </td>
232  </tr>
233<tr class="private">
234    <td width="15%" align="right" valign="top" class="summary">
235      <span class="summary-type">&nbsp;</span>
236    </td><td class="summary">
237      <table width="100%" cellpadding="0" cellspacing="0" border="0">
238        <tr>
239          <td><span class="summary-sig"><a name="__getIssuingCert"></a><span class="summary-sig-name">__getIssuingCert</span>(<span class="summary-sig-arg">self</span>)</span><br />
240      Get user cert X509Cert instance</td>
241          <td align="right" valign="top">
242            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getIssuingCert">source&nbsp;code</a></span>
243           
244          </td>
245        </tr>
246      </table>
247     
248    </td>
249  </tr>
250<tr class="private">
251    <td width="15%" align="right" valign="top" class="summary">
252      <span class="summary-type">&nbsp;</span>
253    </td><td class="summary">
254      <table width="100%" cellpadding="0" cellspacing="0" border="0">
255        <tr>
256          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__setUserPriKey" class="summary-sig-name" onclick="show_private();">__setUserPriKey</a>(<span class="summary-sig-arg">self</span>,
257        <span class="summary-sig-arg">userPriKey</span>)</span><br />
258      Set method for client private key</td>
259          <td align="right" valign="top">
260            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setUserPriKey">source&nbsp;code</a></span>
261           
262          </td>
263        </tr>
264      </table>
265     
266    </td>
267  </tr>
268<tr class="private">
269    <td width="15%" align="right" valign="top" class="summary">
270      <span class="summary-type">dict</span>
271    </td><td class="summary">
272      <table width="100%" cellpadding="0" cellspacing="0" border="0">
273        <tr>
274          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__getCredentials" class="summary-sig-name" onclick="show_private();">__getCredentials</a>(<span class="summary-sig-arg">self</span>)</span><br />
275      Get Property method.</td>
276          <td align="right" valign="top">
277            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getCredentials">source&nbsp;code</a></span>
278           
279          </td>
280        </tr>
281      </table>
282     
283    </td>
284  </tr>
285<tr class="private">
286    <td width="15%" align="right" valign="top" class="summary">
287      <span class="summary-type">&nbsp;</span>
288    </td><td class="summary">
289      <table width="100%" cellpadding="0" cellspacing="0" border="0">
290        <tr>
291          <td><span class="summary-sig"><a name="__getCAcertFilePathList"></a><span class="summary-sig-name">__getCAcertFilePathList</span>(<span class="summary-sig-arg">self</span>)</span><br />
292      Get CA cert or certs used to validate AC signatures and signatures of
293      peer SOAP messages.</td>
294          <td align="right" valign="top">
295            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getCAcertFilePathList">source&nbsp;code</a></span>
296           
297          </td>
298        </tr>
299      </table>
300     
301    </td>
302  </tr>
303<tr class="private">
304    <td width="15%" align="right" valign="top" class="summary">
305      <span class="summary-type">&nbsp;</span>
306    </td><td class="summary">
307      <table width="100%" cellpadding="0" cellspacing="0" border="0">
308        <tr>
309          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__setCAcertFilePathList" class="summary-sig-name" onclick="show_private();">__setCAcertFilePathList</a>(<span class="summary-sig-arg">self</span>,
310        <span class="summary-sig-arg">caCertFilePathList</span>)</span><br />
311      Set CA cert or certs to validate AC signatures, signatures of
312      Attribute Authority SOAP responses and SSL connections where AA SOAP
313      service is run over SSL.</td>
314          <td align="right" valign="top">
315            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setCAcertFilePathList">source&nbsp;code</a></span>
316           
317          </td>
318        </tr>
319      </table>
320     
321    </td>
322  </tr>
323<tr class="private">
324    <td width="15%" align="right" valign="top" class="summary">
325      <span class="summary-type">ndg.security.common.AttAuthorityClient</span>
326    </td><td class="summary">
327      <table width="100%" cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__createAAClnt" class="summary-sig-name" onclick="show_private();">__createAAClnt</a>(<span class="summary-sig-arg">self</span>,
330        <span class="summary-sig-arg">aaURI</span>)</span><br />
331      Set up a client to an Attribute Authority with the given URI</td>
332          <td align="right" valign="top">
333            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__createAAClnt">source&nbsp;code</a></span>
334           
335          </td>
336        </tr>
337      </table>
338     
339    </td>
340  </tr>
341<tr class="private">
342    <td width="15%" align="right" valign="top" class="summary">
343      <span class="summary-type">&nbsp;</span>
344    </td><td class="summary">
345      <table width="100%" cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__setAAuri" class="summary-sig-name" onclick="show_private();">__setAAuri</a>(<span class="summary-sig-arg">self</span>,
348        <span class="summary-sig-arg">aaURI</span>)</span><br />
349      Set property method for Attribute Authority Web Service URI to
350      connect to.</td>
351          <td align="right" valign="top">
352            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setAAuri">source&nbsp;code</a></span>
353           
354          </td>
355        </tr>
356      </table>
357     
358    </td>
359  </tr>
360<tr class="private">
361    <td width="15%" align="right" valign="top" class="summary">
362      <span class="summary-type">&nbsp;</span>
363    </td><td class="summary">
364      <table width="100%" cellpadding="0" cellspacing="0" border="0">
365        <tr>
366          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__getAAclnt" class="summary-sig-name" onclick="show_private();">__getAAclnt</a>(<span class="summary-sig-arg">self</span>)</span><br />
367      Get property method for Attribute Authority Web Service client
368      instance.</td>
369          <td align="right" valign="top">
370            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAAclnt">source&nbsp;code</a></span>
371           
372          </td>
373        </tr>
374      </table>
375     
376    </td>
377  </tr>
378<tr class="private">
379    <td width="15%" align="right" valign="top" class="summary">
380      <span class="summary-type">&nbsp;</span>
381    </td><td class="summary">
382      <table width="100%" cellpadding="0" cellspacing="0" border="0">
383        <tr>
384          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__setAApropFilePath" class="summary-sig-name" onclick="show_private();">__setAApropFilePath</a>(<span class="summary-sig-arg">self</span>,
385        <span class="summary-sig-arg">aaPropFilePath</span>)</span><br />
386      Set property method for the properties file of a local Attribute
387      Authority.</td>
388          <td align="right" valign="top">
389            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setAApropFilePath">source&nbsp;code</a></span>
390           
391          </td>
392        </tr>
393      </table>
394     
395    </td>
396  </tr>
397<tr class="private">
398    <td width="15%" align="right" valign="top" class="summary">
399      <span class="summary-type">&nbsp;</span>
400    </td><td class="summary">
401      <table width="100%" cellpadding="0" cellspacing="0" border="0">
402        <tr>
403          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__getAA" class="summary-sig-name" onclick="show_private();">__getAA</a>(<span class="summary-sig-arg">self</span>)</span><br />
404      Get property method for Attribute Authority Web Service client
405      instance.</td>
406          <td align="right" valign="top">
407            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAA">source&nbsp;code</a></span>
408           
409          </td>
410        </tr>
411      </table>
412     
413    </td>
414  </tr>
415<tr>
416    <td width="15%" align="right" valign="top" class="summary">
417      <span class="summary-type">&nbsp;</span>
418    </td><td class="summary">
419      <table width="100%" cellpadding="0" cellspacing="0" border="0">
420        <tr>
421          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#isValid" class="summary-sig-name">isValid</a>(<span class="summary-sig-arg">self</span>,
422        <span class="summary-sig-arg">**x509CertKeys</span>)</span><br />
423      Check wallet's user cert.</td>
424          <td align="right" valign="top">
425            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.isValid">source&nbsp;code</a></span>
426           
427          </td>
428        </tr>
429      </table>
430     
431    </td>
432  </tr>
433<tr>
434    <td width="15%" align="right" valign="top" class="summary">
435      <span class="summary-type">bool</span>
436    </td><td class="summary">
437      <table width="100%" cellpadding="0" cellspacing="0" border="0">
438        <tr>
439          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#addCredential" class="summary-sig-name">addCredential</a>(<span class="summary-sig-arg">self</span>,
440        <span class="summary-sig-arg">attCert</span>,
441        <span class="summary-sig-arg">bUpdateCredRepos</span>=<span class="summary-sig-default">True</span>)</span><br />
442      Add a new attribute certificate to the list of credentials held.</td>
443          <td align="right" valign="top">
444            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.addCredential">source&nbsp;code</a></span>
445           
446          </td>
447        </tr>
448      </table>
449     
450    </td>
451  </tr>
452<tr>
453    <td width="15%" align="right" valign="top" class="summary">
454      <span class="summary-type">&nbsp;</span>
455    </td><td class="summary">
456      <table width="100%" cellpadding="0" cellspacing="0" border="0">
457        <tr>
458          <td><span class="summary-sig"><a name="audit"></a><span class="summary-sig-name">audit</span>(<span class="summary-sig-arg">self</span>)</span><br />
459      Check the credentials held in the wallet removing any that have
460      expired or are otherwise invalid.</td>
461          <td align="right" valign="top">
462            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.audit">source&nbsp;code</a></span>
463           
464          </td>
465        </tr>
466      </table>
467     
468    </td>
469  </tr>
470<tr>
471    <td width="15%" align="right" valign="top" class="summary">
472      <span class="summary-type">&nbsp;</span>
473    </td><td class="summary">
474      <table width="100%" cellpadding="0" cellspacing="0" border="0">
475        <tr>
476          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#updateCredRepos" class="summary-sig-name">updateCredRepos</a>(<span class="summary-sig-arg">self</span>,
477        <span class="summary-sig-arg">auditCred</span>=<span class="summary-sig-default">True</span>)</span><br />
478      Copy over non-persistent credentials held by wallet into the
479      perminent repository.</td>
480          <td align="right" valign="top">
481            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.updateCredRepos">source&nbsp;code</a></span>
482           
483          </td>
484        </tr>
485      </table>
486     
487    </td>
488  </tr>
489<tr class="private">
490    <td width="15%" align="right" valign="top" class="summary">
491      <span class="summary-type">&nbsp;</span>
492    </td><td class="summary">
493      <table width="100%" cellpadding="0" cellspacing="0" border="0">
494        <tr>
495          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#__getAttCert" class="summary-sig-name" onclick="show_private();">__getAttCert</a>(<span class="summary-sig-arg">self</span>,
496        <span class="summary-sig-arg">aaClnt</span>=<span class="summary-sig-default">None</span>,
497        <span class="summary-sig-arg">extAttCert</span>=<span class="summary-sig-default">None</span>)</span><br />
498      Wrapper to Attribute Authority attribute certificate request.</td>
499          <td align="right" valign="top">
500            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAttCert">source&nbsp;code</a></span>
501           
502          </td>
503        </tr>
504      </table>
505     
506    </td>
507  </tr>
508<tr>
509    <td width="15%" align="right" valign="top" class="summary">
510      <span class="summary-type">&nbsp;</span>
511    </td><td class="summary">
512      <table width="100%" cellpadding="0" cellspacing="0" border="0">
513        <tr>
514          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#getAATrustedHostInfo" class="summary-sig-name">getAATrustedHostInfo</a>(<span class="summary-sig-arg">self</span>,
515        <span class="summary-sig-arg">userRole</span>=<span class="summary-sig-default">None</span>,
516        <span class="summary-sig-arg">aaPropFilePath</span>=<span class="summary-sig-default">None</span>,
517        <span class="summary-sig-arg">aaURI</span>=<span class="summary-sig-default">None</span>)</span><br />
518      Wrapper to Attribute Authority getTrustedHostInfo</td>
519          <td align="right" valign="top">
520            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.getAATrustedHostInfo">source&nbsp;code</a></span>
521           
522          </td>
523        </tr>
524      </table>
525     
526    </td>
527  </tr>
528<tr>
529    <td width="15%" align="right" valign="top" class="summary">
530      <span class="summary-type">&nbsp;</span>
531    </td><td class="summary">
532      <table width="100%" cellpadding="0" cellspacing="0" border="0">
533        <tr>
534          <td><span class="summary-sig"><a href="ndg.security.common.CredWallet.CredWallet-class.html#getAttCert" class="summary-sig-name">getAttCert</a>(<span class="summary-sig-arg">self</span>,
535        <span class="summary-sig-arg">reqRole</span>=<span class="summary-sig-default">None</span>,
536        <span class="summary-sig-arg">aaPropFilePath</span>=<span class="summary-sig-default">None</span>,
537        <span class="summary-sig-arg">aaURI</span>=<span class="summary-sig-default">None</span>,
538        <span class="summary-sig-arg">mapFromTrustedHosts</span>=<span class="summary-sig-default">None</span>,
539        <span class="summary-sig-arg">rtnExtAttCertList</span>=<span class="summary-sig-default">None</span>,
540        <span class="summary-sig-arg">extAttCertList</span>=<span class="summary-sig-default">None</span>,
541        <span class="summary-sig-arg">extTrustedHostList</span>=<span class="summary-sig-default">None</span>,
542        <span class="summary-sig-arg">refreshAttCert</span>=<span class="summary-sig-default">False</span>,
543        <span class="summary-sig-arg">attCertRefreshElapse</span>=<span class="summary-sig-default">None</span>)</span><br />
544      For a given role, get an Attribute Certificate from an Attribute
545Authority using a user's X.509 certificate.</td>
546          <td align="right" valign="top">
547            <span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.getAttCert">source&nbsp;code</a></span>
548           
549          </td>
550        </tr>
551      </table>
552     
553    </td>
554  </tr>
555  <tr>
556    <td colspan="2" class="summary">
557    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
558      <code>__delattr__</code>,
559      <code>__getattribute__</code>,
560      <code>__hash__</code>,
561      <code>__new__</code>,
562      <code>__reduce__</code>,
563      <code>__reduce_ex__</code>,
564      <code>__repr__</code>,
565      <code>__setattr__</code>,
566      <code>__str__</code>
567      </p>
568    </td>
569  </tr>
570</table>
571<!-- ==================== CLASS VARIABLES ==================== -->
572<a name="section-ClassVariables"></a>
573<table class="summary" border="1" cellpadding="3"
574       cellspacing="0" width="100%" bgcolor="white">
575<tr bgcolor="#70b0f0" class="table-header">
576  <td colspan="2" class="table-header">
577    <table border="0" cellpadding="0" cellspacing="0" width="100%">
578      <tr valign="top">
579        <td align="left"><span class="table-header">Class Variables</span></td>
580        <td align="right" valign="top"
581         ><span class="options">[<a href="#section-ClassVariables"
582         class="privatelink" onclick="toggle_private();"
583         >hide private</a>]</span></td>
584      </tr>
585    </table>
586  </td>
587</tr>
588<tr>
589    <td width="15%" align="right" valign="top" class="summary">
590      <span class="summary-type">&nbsp;</span>
591    </td><td class="summary">
592        <a href="ndg.security.common.CredWallet.CredWallet-class.html#userCert" class="summary-name">userCert</a> = <code title="property(fget= __getUserCert, fset= __setUserCert, doc= &quot;X.509 user ce\
593rtificate instance&quot;)">property(fget= __getUserCert, fset= __setUserCert, <code class="variable-ellipsis">...</code></code>
594    </td>
595  </tr>
596<tr>
597    <td width="15%" align="right" valign="top" class="summary">
598      <span class="summary-type">&nbsp;</span>
599    </td><td class="summary">
600        <a href="ndg.security.common.CredWallet.CredWallet-class.html#issuingCert" class="summary-name">issuingCert</a> = <code title="property(fget= __getIssuingCert, fset= __setIssuingCert, doc= &quot;X.509 u\
601ser certificate instance&quot;)">property(fget= __getIssuingCert, fset= __setIssu<code class="variable-ellipsis">...</code></code>
602    </td>
603  </tr>
604<tr>
605    <td width="15%" align="right" valign="top" class="summary">
606      <span class="summary-type">&nbsp;</span>
607    </td><td class="summary">
608        <a href="ndg.security.common.CredWallet.CredWallet-class.html#userPriKey" class="summary-name">userPriKey</a> = <code title="property(fset= __setUserPriKey, doc= &quot;Private key used to sign outboun\
609d message&quot;)">property(fset= __setUserPriKey, doc= &quot;Private key<code class="variable-ellipsis">...</code></code>
610    </td>
611  </tr>
612<tr>
613    <td width="15%" align="right" valign="top" class="summary">
614      <span class="summary-type">&nbsp;</span>
615    </td><td class="summary">
616        <a href="ndg.security.common.CredWallet.CredWallet-class.html#credentials" class="summary-name">credentials</a> = <code title="property(fget= __getCredentials, doc= &quot;List of Attribute Certificates&quot;\
617)">property(fget= __getCredentials, doc= &quot;List of A<code class="variable-ellipsis">...</code></code>
618    </td>
619  </tr>
620<tr>
621    <td width="15%" align="right" valign="top" class="summary">
622      <span class="summary-type">&nbsp;</span>
623    </td><td class="summary">
624        <a href="ndg.security.common.CredWallet.CredWallet-class.html#caCertFilePathList" class="summary-name">caCertFilePathList</a> = <code title="property(fget= __getCAcertFilePathList, fset= __setCAcertFilePathList,\
625 doc= &quot;CA Certificates - used for &quot;+ &quot;verification of AC and SOAP &quot;+ &quot;\
626message signatures and SSL &quot;+ &quot;connections&quot;)">property(fget= __getCAcertFilePathList, f<code class="variable-ellipsis">...</code></code>
627    </td>
628  </tr>
629<tr>
630    <td width="15%" align="right" valign="top" class="summary">
631      <span class="summary-type">&nbsp;</span>
632    </td><td class="summary">
633        <a href="ndg.security.common.CredWallet.CredWallet-class.html#aaURI" class="summary-name">aaURI</a> = <code title="property(fset= __setAAuri, doc= &quot;AA URI - setting also sets up AttAuth\
634orityClient instance!&quot;)">property(fset= __setAAuri, doc= &quot;AA URI - setting also<code class="variable-ellipsis">...</code></code>
635    </td>
636  </tr>
637<tr>
638    <td width="15%" align="right" valign="top" class="summary">
639      <span class="summary-type">&nbsp;</span>
640    </td><td class="summary">
641        <a href="ndg.security.common.CredWallet.CredWallet-class.html#aaClnt" class="summary-name">aaClnt</a> = <code title="property(fget= __getAAclnt, doc= &quot;AA web service client instance&quot;)">property(fget= __getAAclnt, doc= &quot;AA web service clie<code class="variable-ellipsis">...</code></code>
642    </td>
643  </tr>
644<tr>
645    <td width="15%" align="right" valign="top" class="summary">
646      <span class="summary-type">&nbsp;</span>
647    </td><td class="summary">
648        <a href="ndg.security.common.CredWallet.CredWallet-class.html#aaPropFilePath" class="summary-name">aaPropFilePath</a> = <code title="property(fset= __setAApropFilePath, doc= &quot;AA properties file path - se\
649tting this also sets up an AA locally!&quot;)">property(fset= __setAApropFilePath, doc= &quot;AA <code class="variable-ellipsis">...</code></code>
650    </td>
651  </tr>
652<tr>
653    <td width="15%" align="right" valign="top" class="summary">
654      <span class="summary-type">&nbsp;</span>
655    </td><td class="summary">
656        <a name="aa"></a><span class="summary-name">aa</span> = <code title="property(fget= __getAA, doc= &quot;Attribute Authority instance&quot;)">property(fget= __getAA, doc= &quot;Attribute Authority instance&quot;)</code>
657    </td>
658  </tr>
659</table>
660<!-- ==================== INSTANCE VARIABLES ==================== -->
661<a name="section-InstanceVariables"></a>
662<table class="summary" border="1" cellpadding="3"
663       cellspacing="0" width="100%" bgcolor="white">
664<tr bgcolor="#70b0f0" class="table-header">
665  <td colspan="2" class="table-header">
666    <table border="0" cellpadding="0" cellspacing="0" width="100%">
667      <tr valign="top">
668        <td align="left"><span class="table-header">Instance Variables</span></td>
669        <td align="right" valign="top"
670         ><span class="options">[<a href="#section-InstanceVariables"
671         class="privatelink" onclick="toggle_private();"
672         >hide private</a>]</span></td>
673      </tr>
674    </table>
675  </td>
676</tr>
677<tr class="private">
678    <td width="15%" align="right" valign="top" class="summary">
679      <span class="summary-type">basestring, list, tuple or None</span>
680    </td><td class="summary">
681        <a href="ndg.security.common.CredWallet.CredWallet-class.html#__caCertFilePathList" class="summary-name" onclick="show_private();">__caCertFilePathList</a><br />
682      file path(s) to CA certificates.
683    </td>
684  </tr>
685<tr class="private">
686    <td width="15%" align="right" valign="top" class="summary">
687      <span class="summary-type">ndg.security.common.CredRepos or derivative</span>
688    </td><td class="summary">
689        <a href="ndg.security.common.CredWallet.CredWallet-class.html#__credRepos" class="summary-name" onclick="show_private();">__credRepos</a><br />
690      reference to Credential Repository object.
691    </td>
692  </tr>
693<tr class="private">
694    <td width="15%" align="right" valign="top" class="summary">
695      <span class="summary-type">dict</span>
696    </td><td class="summary">
697        <a name="__credentials"></a><span class="summary-name">__credentials</span><br />
698      Credentials are stored as a dictionary one element per attribute
699      certicate held and indexed by certificate issuer name
700    </td>
701  </tr>
702<tr class="private">
703    <td width="15%" align="right" valign="top" class="summary">
704      <span class="summary-type">ndg.security.common.X509.X500DN</span>
705    </td><td class="summary">
706        <a name="__dn"></a><span class="summary-name">__dn</span><br />
707      distinguished name from user certificate
708    </td>
709  </tr>
710<tr class="private">
711    <td width="15%" align="right" valign="top" class="summary">
712      <span class="summary-type">ndg.security.common.X509.X509Cert</span>
713    </td><td class="summary">
714        <a name="__issuingCert"></a><span class="summary-name">__issuingCert</span><br />
715      X.509 user certificate instance
716    </td>
717  </tr>
718<tr class="private">
719    <td width="15%" align="right" valign="top" class="summary">
720      <span class="summary-type">bool</span>
721    </td><td class="summary">
722        <a href="ndg.security.common.CredWallet.CredWallet-class.html#__mapFromTrustedHosts" class="summary-name" onclick="show_private();">__mapFromTrustedHosts</a><br />
723      if true, allow a mapped attribute certificate to obtained in a
724      getAttCert call.
725    </td>
726  </tr>
727<tr class="private">
728    <td width="15%" align="right" valign="top" class="summary">
729      <span class="summary-type">bool</span>
730    </td><td class="summary">
731        <a name="__rtnExtAttCertList"></a><span class="summary-name">__rtnExtAttCertList</span><br />
732      if true, return a list of external attribute certificates from
733      getAttCert call
734    </td>
735  </tr>
736<tr class="private">
737    <td width="15%" align="right" valign="top" class="summary">
738      <span class="summary-type">ndg.security.common.X509.X509Cert</span>
739    </td><td class="summary">
740        <a name="__userCert"></a><span class="summary-name">__userCert</span><br />
741      X.509 user certificate instance
742    </td>
743  </tr>
744<tr class="private">
745    <td width="15%" align="right" valign="top" class="summary">
746      <span class="summary-type">M2Crypto.RSA.RSA</span>
747    </td><td class="summary">
748        <a name="__userPriKey"></a><span class="summary-name">__userPriKey</span><br />
749      Private key used to sign outbound message
750    </td>
751  </tr>
752</table>
753<!-- ==================== PROPERTIES ==================== -->
754<a name="section-Properties"></a>
755<table class="summary" border="1" cellpadding="3"
756       cellspacing="0" width="100%" bgcolor="white">
757<tr bgcolor="#70b0f0" class="table-header">
758  <td colspan="2" class="table-header">
759    <table border="0" cellpadding="0" cellspacing="0" width="100%">
760      <tr valign="top">
761        <td align="left"><span class="table-header">Properties</span></td>
762        <td align="right" valign="top"
763         ><span class="options">[<a href="#section-Properties"
764         class="privatelink" onclick="toggle_private();"
765         >hide private</a>]</span></td>
766      </tr>
767    </table>
768  </td>
769</tr>
770  <tr>
771    <td colspan="2" class="summary">
772    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
773      <code>__class__</code>
774      </p>
775    </td>
776  </tr>
777</table>
778<!-- ==================== METHOD DETAILS ==================== -->
779<a name="section-MethodDetails"></a>
780<table class="details" border="1" cellpadding="3"
781       cellspacing="0" width="100%" bgcolor="white">
782<tr bgcolor="#70b0f0" class="table-header">
783  <td colspan="2" class="table-header">
784    <table border="0" cellpadding="0" cellspacing="0" width="100%">
785      <tr valign="top">
786        <td align="left"><span class="table-header">Method Details</span></td>
787        <td align="right" valign="top"
788         ><span class="options">[<a href="#section-MethodDetails"
789         class="privatelink" onclick="toggle_private();"
790         >hide private</a>]</span></td>
791      </tr>
792    </table>
793  </td>
794</tr>
795</table>
796<a name="__init__"></a>
797<div>
798<table class="details" border="1" cellpadding="3"
799       cellspacing="0" width="100%" bgcolor="white">
800<tr><td>
801  <table width="100%" cellpadding="0" cellspacing="0" border="0">
802  <tr valign="top"><td>
803  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
804        <span class="sig-arg">userCert</span>,
805        <span class="sig-arg">userPriKey</span>,
806        <span class="sig-arg">issuingCert</span>=<span class="sig-default">None</span>,
807        <span class="sig-arg">caCertFilePathList</span>=<span class="sig-default">None</span>,
808        <span class="sig-arg">aaURI</span>=<span class="sig-default">None</span>,
809        <span class="sig-arg">aaPropFilePath</span>=<span class="sig-default">None</span>,
810        <span class="sig-arg">credRepos</span>=<span class="sig-default">None</span>,
811        <span class="sig-arg">mapFromTrustedHosts</span>=<span class="sig-default">False</span>,
812        <span class="sig-arg">rtnExtAttCertList</span>=<span class="sig-default">True</span>,
813        <span class="sig-arg">attCertRefreshElapse</span>=<span class="sig-default">7200</span>,
814        <span class="sig-arg">wssSignatureHandlerKw</span>=<span class="sig-default">{}</span>)</span>
815    <br /><em class="fname">(Constructor)</em>
816  </h3>
817  </td><td align="right" valign="top"
818    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__init__">source&nbsp;code</a></span>&nbsp;
819    </td>
820  </tr></table>
821 
822  <p>Create store of user credentials for their current session</p>
823  <dl class="fields">
824    <dt>Parameters:</dt>
825    <dd><ul class="nomargin-top">
826        <li><strong class="pname"><code>userCert</code></strong> (string / M2Crypto.X509.X509 / ndg.security.common.X509.X509Cert) - X.509 certificate for user</li>
827        <li><strong class="pname"><code>userPriKey</code></strong> (string / M2Crypto.RSA.RSA) - private key for user cert</li>
828        <li><strong class="pname"><code>issuingCert</code></strong> (string / ndg.security.common.X509.X509Cert) - X.509 cert for issuer of user cert</li>
829        <li><strong class="pname"><code>aaURI</code></strong> (string) - URI of Attribute Authority to make requests to. Setting this ALSO
830          creates an AttAuthorityClient instance self.__aaClnt.  - See
831          aaURI property for details.</li>
832        <li><strong class="pname"><code>aaPropFilePath</code></strong> (string) - properties file path for an Attribute Authority to make requests
833          to.  Setting this ALSO creates an AttAuthority instance self.__aa
834          running locally.   - See aa property for details.  aaURI takes
835          precedence over this keyword i.e. if an aaURI has been set, then
836          calls are made to the AA web service at this location rather to
837          any self.__aa running locally.</li>
838        <li><strong class="pname"><code>caCertFilePathList</code></strong> (string (for single file), list or tuple) - Certificate Authority's certificates - used in validation of
839          signed Attribute Certificates and WS-Security signatures of
840          incoming messages.  If not set here, it must be input in call to
841          getAttCert.</li>
842        <li><strong class="pname"><code>credRepos</code></strong> (instance of CredRepos derived class) - Credential Repository instance.  If not set, defaults to
843          NullCredRepos type - see class below...</li>
844        <li><strong class="pname"><code>rtnExtAttCertList</code></strong> (bool) - behaviour for getAttCert().  If True, and authorisation fails
845          with the given Attribute Authority, return a list of Attribute
846          Certificates from other trusted AAs which could be used to obtain
847          a mapped Attribute Certificate on a subsequent authorisation
848          attempt</li>
849        <li><strong class="pname"><code>attCertRefreshElapse</code></strong> (float / int) - used by getAttCert to determine whether to replace an existing AC
850          in the cache with a fresh one.  If the existing one has less than
851          attCertRefreshElapse time in seconds left before expiry then
852          replace it.</li>
853        <li><strong class="pname"><code>wssSignatureHandlerKw</code></strong> (dict) - keywords to WS-Security SignatureHandler used for Credential
854          Wallet's SOAP interface to Attribute Authorities</li>
855        <li><strong class="pname"><code>mapFromTrustedHosts</code></strong> (bool @param mapFromTrustedHosts sets behaviour for getAttCert().
856          If set True and authorisation fails with the given Attribute
857          Authority, attempt to get authorisation using Attribute
858          Certificates issued by other trusted AAs.)</li>
859    </ul></dd>
860    <dt>Overrides:
861        object.__init__
862    </dt>
863  </dl>
864</td></tr></table>
865</div>
866<a name="__setCert"></a>
867<div class="private">
868<table class="details" border="1" cellpadding="3"
869       cellspacing="0" width="100%" bgcolor="white">
870<tr><td>
871  <table width="100%" cellpadding="0" cellspacing="0" border="0">
872  <tr valign="top"><td>
873  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setCert</span>(<span class="sig-arg">self</span>,
874        <span class="sig-arg">cert</span>)</span>
875  </h3>
876  </td><td align="right" valign="top"
877    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setCert">source&nbsp;code</a></span>&nbsp;
878    </td>
879  </tr></table>
880 
881  <p>filter and convert input cert to signing verifying cert set property
882  methods.  For signingCert, set to None if it is not to be included in the
883  SOAP header.  For verifyingCert, set to None if this cert can be expected
884  to be retrieved from the SOAP header of the message to be verified</p>
885  <dl class="fields">
886    <dt>Parameters:</dt>
887    <dd><ul class="nomargin-top">
888        <li><strong class="pname"><code>cert</code></strong> - X.509 certificate.
889          <p>@rtype ndg.security.common.X509.X509Cert @return X.509
890          certificate object</p></li>
891    </ul></dd>
892  </dl>
893</td></tr></table>
894</div>
895<a name="__setUserPriKey"></a>
896<div class="private">
897<table class="details" border="1" cellpadding="3"
898       cellspacing="0" width="100%" bgcolor="white">
899<tr><td>
900  <table width="100%" cellpadding="0" cellspacing="0" border="0">
901  <tr valign="top"><td>
902  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setUserPriKey</span>(<span class="sig-arg">self</span>,
903        <span class="sig-arg">userPriKey</span>)</span>
904  </h3>
905  </td><td align="right" valign="top"
906    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setUserPriKey">source&nbsp;code</a></span>&nbsp;
907    </td>
908  </tr></table>
909 
910  <p>Set method for client private key</p>
911  <p>Nb. if input is a string, userPriKeyPwd will need to be set if the key
912  is password protected.</p>
913  <dl class="fields">
914    <dt>Parameters:</dt>
915    <dd><ul class="nomargin-top">
916        <li><strong class="pname"><code>userPriKey</code></strong> (M2Crypto.RSA.RSA / string) - private key used to sign message</li>
917    </ul></dd>
918  </dl>
919</td></tr></table>
920</div>
921<a name="__getCredentials"></a>
922<div class="private">
923<table class="details" border="1" cellpadding="3"
924       cellspacing="0" width="100%" bgcolor="white">
925<tr><td>
926  <table width="100%" cellpadding="0" cellspacing="0" border="0">
927  <tr valign="top"><td>
928  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getCredentials</span>(<span class="sig-arg">self</span>)</span>
929  </h3>
930  </td><td align="right" valign="top"
931    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getCredentials">source&nbsp;code</a></span>&nbsp;
932    </td>
933  </tr></table>
934 
935  <p>Get Property method.  Credentials are read-only</p>
936  <dl class="fields">
937    <dt>Returns: dict</dt>
938        <dd>cached ACs indesed by issuing organisation name</dd>
939  </dl>
940</td></tr></table>
941</div>
942<a name="__setCAcertFilePathList"></a>
943<div class="private">
944<table class="details" border="1" cellpadding="3"
945       cellspacing="0" width="100%" bgcolor="white">
946<tr><td>
947  <table width="100%" cellpadding="0" cellspacing="0" border="0">
948  <tr valign="top"><td>
949  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setCAcertFilePathList</span>(<span class="sig-arg">self</span>,
950        <span class="sig-arg">caCertFilePathList</span>)</span>
951  </h3>
952  </td><td align="right" valign="top"
953    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setCAcertFilePathList">source&nbsp;code</a></span>&nbsp;
954    </td>
955  </tr></table>
956 
957  <p>Set CA cert or certs to validate AC signatures, signatures of
958  Attribute Authority SOAP responses and SSL connections where AA SOAP
959  service is run over SSL.</p>
960  <dl class="fields">
961    <dt>Parameters:</dt>
962    <dd><ul class="nomargin-top">
963        <li><strong class="pname"><code>caCertFilePathList</code></strong> (basestring, list, tuple or None) - file path(s) to CA certificates.  If None then the input is
964          quietly ignored.</li>
965    </ul></dd>
966  </dl>
967</td></tr></table>
968</div>
969<a name="__createAAClnt"></a>
970<div class="private">
971<table class="details" border="1" cellpadding="3"
972       cellspacing="0" width="100%" bgcolor="white">
973<tr><td>
974  <table width="100%" cellpadding="0" cellspacing="0" border="0">
975  <tr valign="top"><td>
976  <h3 class="epydoc"><span class="sig"><span class="sig-name">__createAAClnt</span>(<span class="sig-arg">self</span>,
977        <span class="sig-arg">aaURI</span>)</span>
978  </h3>
979  </td><td align="right" valign="top"
980    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__createAAClnt">source&nbsp;code</a></span>&nbsp;
981    </td>
982  </tr></table>
983 
984  <p>Set up a client to an Attribute Authority with the given URI</p>
985  <dl class="fields">
986    <dt>Parameters:</dt>
987    <dd><ul class="nomargin-top">
988        <li><strong class="pname"><code>aaURI</code></strong> (string) - Attribute Authority Web Service URI.</li>
989    </ul></dd>
990    <dt>Returns: ndg.security.common.AttAuthorityClient</dt>
991        <dd>new Attribute Authority client instance</dd>
992  </dl>
993</td></tr></table>
994</div>
995<a name="__setAAuri"></a>
996<div class="private">
997<table class="details" border="1" cellpadding="3"
998       cellspacing="0" width="100%" bgcolor="white">
999<tr><td>
1000  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1001  <tr valign="top"><td>
1002  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setAAuri</span>(<span class="sig-arg">self</span>,
1003        <span class="sig-arg">aaURI</span>)</span>
1004  </h3>
1005  </td><td align="right" valign="top"
1006    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setAAuri">source&nbsp;code</a></span>&nbsp;
1007    </td>
1008  </tr></table>
1009 
1010  <p>Set property method for Attribute Authority Web Service URI to connect
1011  to.  This method ALSO SETS UP THE CLIENT INTERFACE</p>
1012  <dl class="fields">
1013    <dt>Parameters:</dt>
1014    <dd><ul class="nomargin-top">
1015        <li><strong class="pname"><code>aaURI</code></strong> (string) - Attribute Authority Web Service URI.  Set to None to initialise.
1016          Set to a URI to instantiate a new AA client</li>
1017    </ul></dd>
1018  </dl>
1019</td></tr></table>
1020</div>
1021<a name="__getAAclnt"></a>
1022<div class="private">
1023<table class="details" border="1" cellpadding="3"
1024       cellspacing="0" width="100%" bgcolor="white">
1025<tr><td>
1026  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1027  <tr valign="top"><td>
1028  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getAAclnt</span>(<span class="sig-arg">self</span>)</span>
1029  </h3>
1030  </td><td align="right" valign="top"
1031    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAAclnt">source&nbsp;code</a></span>&nbsp;
1032    </td>
1033  </tr></table>
1034 
1035  <p>Get property method for Attribute Authority Web Service client
1036  instance.  Use aaURI propert to set up aaClnt</p>
1037  <dl class="fields">
1038    <dt>Parameters:</dt>
1039    <dd><ul class="nomargin-top">
1040        <li><strong class="pname"><code>aaClnt</code></strong> (AttAuthorityClient) - Attribute Authority Web Service client instance</li>
1041    </ul></dd>
1042  </dl>
1043</td></tr></table>
1044</div>
1045<a name="__setAApropFilePath"></a>
1046<div class="private">
1047<table class="details" border="1" cellpadding="3"
1048       cellspacing="0" width="100%" bgcolor="white">
1049<tr><td>
1050  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1051  <tr valign="top"><td>
1052  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setAApropFilePath</span>(<span class="sig-arg">self</span>,
1053        <span class="sig-arg">aaPropFilePath</span>)</span>
1054  </h3>
1055  </td><td align="right" valign="top"
1056    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__setAApropFilePath">source&nbsp;code</a></span>&nbsp;
1057    </td>
1058  </tr></table>
1059 
1060  <p>Set property method for the properties file of a local Attribute
1061  Authority.  This method ALSO SETS UP THE LOCAL Attribute Authority object
1062  to retrieve ACs from.  the property aaURI takes precedence: if an aaURI
1063  is set then it assumed that an Attribute Authority will be connected to
1064  via a web service call</p>
1065  <dl class="fields">
1066    <dt>Parameters:</dt>
1067    <dd><ul class="nomargin-top">
1068        <li><strong class="pname"><code>aaPropFilePath</code></strong> (string) - Attribute Authority properties file.  Setting this instantiates a
1069          new AA locally</li>
1070    </ul></dd>
1071  </dl>
1072</td></tr></table>
1073</div>
1074<a name="__getAA"></a>
1075<div class="private">
1076<table class="details" border="1" cellpadding="3"
1077       cellspacing="0" width="100%" bgcolor="white">
1078<tr><td>
1079  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1080  <tr valign="top"><td>
1081  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getAA</span>(<span class="sig-arg">self</span>)</span>
1082  </h3>
1083  </td><td align="right" valign="top"
1084    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAA">source&nbsp;code</a></span>&nbsp;
1085    </td>
1086  </tr></table>
1087 
1088  <p>Get property method for Attribute Authority Web Service client
1089  instance.  Use aaURI propert to set up aaClnt</p>
1090  <dl class="fields">
1091    <dt>Parameters:</dt>
1092    <dd><ul class="nomargin-top">
1093        <li><strong class="pname"><code>aaClnt</code></strong> (AttAuthorityClient) - Attribute Authority Web Service client instance</li>
1094    </ul></dd>
1095  </dl>
1096</td></tr></table>
1097</div>
1098<a name="isValid"></a>
1099<div>
1100<table class="details" border="1" cellpadding="3"
1101       cellspacing="0" width="100%" bgcolor="white">
1102<tr><td>
1103  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1104  <tr valign="top"><td>
1105  <h3 class="epydoc"><span class="sig"><span class="sig-name">isValid</span>(<span class="sig-arg">self</span>,
1106        <span class="sig-arg">**x509CertKeys</span>)</span>
1107  </h3>
1108  </td><td align="right" valign="top"
1109    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.isValid">source&nbsp;code</a></span>&nbsp;
1110    </td>
1111  </tr></table>
1112 
1113  <p>Check wallet's user cert.  If expired return False</p>
1114  <dl class="fields">
1115    <dt>Parameters:</dt>
1116    <dd><ul class="nomargin-top">
1117        <li><strong class="pname"><code>**x509CertKeys</code></strong> (dict) - keywords applying to
1118          ndg.security.common.X509.X509Cert.isValidTime method</li>
1119    </ul></dd>
1120  </dl>
1121</td></tr></table>
1122</div>
1123<a name="addCredential"></a>
1124<div>
1125<table class="details" border="1" cellpadding="3"
1126       cellspacing="0" width="100%" bgcolor="white">
1127<tr><td>
1128  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1129  <tr valign="top"><td>
1130  <h3 class="epydoc"><span class="sig"><span class="sig-name">addCredential</span>(<span class="sig-arg">self</span>,
1131        <span class="sig-arg">attCert</span>,
1132        <span class="sig-arg">bUpdateCredRepos</span>=<span class="sig-default">True</span>)</span>
1133  </h3>
1134  </td><td align="right" valign="top"
1135    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.addCredential">source&nbsp;code</a></span>&nbsp;
1136    </td>
1137  </tr></table>
1138 
1139  <p>Add a new attribute certificate to the list of credentials held.</p>
1140  <dl class="fields">
1141    <dt>Parameters:</dt>
1142    <dd><ul class="nomargin-top">
1143        <li><strong class="pname"><code>attCert</code></strong> () - new attribute Certificate to be added</li>
1144        <li><strong class="pname"><code>bUpdateCredRepos</code></strong> (bool) - if set to True, and a repository exists it will be updated with
1145          the new credentials also</li>
1146    </ul></dd>
1147    <dt>Returns: bool</dt>
1148        <dd>True if certificate was added otherwise False.  - If an existing
1149          certificate from the same issuer has a later expiry it will take
1150          precence and the new input certificate is ignored.</dd>
1151  </dl>
1152</td></tr></table>
1153</div>
1154<a name="updateCredRepos"></a>
1155<div>
1156<table class="details" border="1" cellpadding="3"
1157       cellspacing="0" width="100%" bgcolor="white">
1158<tr><td>
1159  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1160  <tr valign="top"><td>
1161  <h3 class="epydoc"><span class="sig"><span class="sig-name">updateCredRepos</span>(<span class="sig-arg">self</span>,
1162        <span class="sig-arg">auditCred</span>=<span class="sig-default">True</span>)</span>
1163  </h3>
1164  </td><td align="right" valign="top"
1165    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.updateCredRepos">source&nbsp;code</a></span>&nbsp;
1166    </td>
1167  </tr></table>
1168 
1169  <p>Copy over non-persistent credentials held by wallet into the perminent
1170  repository.</p>
1171  <dl class="fields">
1172    <dt>Parameters:</dt>
1173    <dd><ul class="nomargin-top">
1174        <li><strong class="pname"><code>auditCred</code></strong> (bool) - filter existing credentials in the repository removing invalid
1175          ones</li>
1176    </ul></dd>
1177  </dl>
1178</td></tr></table>
1179</div>
1180<a name="__getAttCert"></a>
1181<div class="private">
1182<table class="details" border="1" cellpadding="3"
1183       cellspacing="0" width="100%" bgcolor="white">
1184<tr><td>
1185  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1186  <tr valign="top"><td>
1187  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getAttCert</span>(<span class="sig-arg">self</span>,
1188        <span class="sig-arg">aaClnt</span>=<span class="sig-default">None</span>,
1189        <span class="sig-arg">extAttCert</span>=<span class="sig-default">None</span>)</span>
1190  </h3>
1191  </td><td align="right" valign="top"
1192    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.__getAttCert">source&nbsp;code</a></span>&nbsp;
1193    </td>
1194  </tr></table>
1195 
1196  <p>Wrapper to Attribute Authority attribute certificate request.  See
1197  getAttCert for the classes' public interface.</p>
1198  <p>To call the Attribute Authority as a Web Service, specify a URI
1199  otherwise set the properties file path.</p>
1200  <p>If successful, a new attribute certificate is issued to the user and
1201  added into the wallet</p>
1202  <dl class="fields">
1203    <dt>Parameters:</dt>
1204    <dd><ul class="nomargin-top">
1205        <li><strong class="pname"><code>aaClnt</code></strong> (ndg.security.common.AttAuthorityClient) - client object to Attribute Authority to make a request to.  If
1206          omitted, it is set to self.__aaClnt.  This attribute may itself
1207          be None.   In this case, a local AA client will be expected set
1208          from a properties file.</li>
1209        <li><strong class="pname"><code>extAttCert</code></strong> (ndg.security.common.AttCert.AttCert) - an existing Attribute Certificate which can be used to making a
1210          mapping should the user not be registered with the Attribute
1211          Authority</li>
1212    </ul></dd>
1213  </dl>
1214</td></tr></table>
1215</div>
1216<a name="getAATrustedHostInfo"></a>
1217<div>
1218<table class="details" border="1" cellpadding="3"
1219       cellspacing="0" width="100%" bgcolor="white">
1220<tr><td>
1221  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1222  <tr valign="top"><td>
1223  <h3 class="epydoc"><span class="sig"><span class="sig-name">getAATrustedHostInfo</span>(<span class="sig-arg">self</span>,
1224        <span class="sig-arg">userRole</span>=<span class="sig-default">None</span>,
1225        <span class="sig-arg">aaPropFilePath</span>=<span class="sig-default">None</span>,
1226        <span class="sig-arg">aaURI</span>=<span class="sig-default">None</span>)</span>
1227  </h3>
1228  </td><td align="right" valign="top"
1229    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.getAATrustedHostInfo">source&nbsp;code</a></span>&nbsp;
1230    </td>
1231  </tr></table>
1232 
1233  <p>Wrapper to Attribute Authority getTrustedHostInfo</p>
1234  <p>getAATrustedHostInfo([userRole=r, ][aaPropFilePath=f|aaURI=u])</p>
1235  <dl class="fields">
1236    <dt>Parameters:</dt>
1237    <dd><ul class="nomargin-top">
1238        <li><strong class="pname"><code>userRole</code></strong> (string) - get hosts which have a mapping to this role</li>
1239        <li><strong class="pname"><code>aaURI</code></strong> (string) - to call as a web service, specify the URI for the Attribute
1240          Authority.</li>
1241        <li><strong class="pname"><code>aaPropFilePath</code></strong> (string) - Altenrative to aaURI - to run on the local machine, specify the
1242          local Attribute Authority configuration file.</li>
1243    </ul></dd>
1244  </dl>
1245</td></tr></table>
1246</div>
1247<a name="getAttCert"></a>
1248<div>
1249<table class="details" border="1" cellpadding="3"
1250       cellspacing="0" width="100%" bgcolor="white">
1251<tr><td>
1252  <table width="100%" cellpadding="0" cellspacing="0" border="0">
1253  <tr valign="top"><td>
1254  <h3 class="epydoc"><span class="sig"><span class="sig-name">getAttCert</span>(<span class="sig-arg">self</span>,
1255        <span class="sig-arg">reqRole</span>=<span class="sig-default">None</span>,
1256        <span class="sig-arg">aaPropFilePath</span>=<span class="sig-default">None</span>,
1257        <span class="sig-arg">aaURI</span>=<span class="sig-default">None</span>,
1258        <span class="sig-arg">mapFromTrustedHosts</span>=<span class="sig-default">None</span>,
1259        <span class="sig-arg">rtnExtAttCertList</span>=<span class="sig-default">None</span>,
1260        <span class="sig-arg">extAttCertList</span>=<span class="sig-default">None</span>,
1261        <span class="sig-arg">extTrustedHostList</span>=<span class="sig-default">None</span>,
1262        <span class="sig-arg">refreshAttCert</span>=<span class="sig-default">False</span>,
1263        <span class="sig-arg">attCertRefreshElapse</span>=<span class="sig-default">None</span>)</span>
1264  </h3>
1265  </td><td align="right" valign="top"
1266    ><span class="codelink"><a href="ndg.security.common.CredWallet-pysrc.html#CredWallet.getAttCert">source&nbsp;code</a></span>&nbsp;
1267    </td>
1268  </tr></table>
1269 
1270  <pre class="literalblock">
1271For a given role, get an Attribute Certificate from an Attribute
1272Authority using a user's X.509 certificate.  If this fails try to make
1273a mapped Attribute Certificate by using a certificate from another
1274host which has a trust relationship to the Attribute Authority in
1275question.
1276
1277getAttCert([reqRole=r, ][aaPropFilePath=f|aaURI=u,]
1278           [mapFromTrustedHosts=m, ]
1279           [rtnExtAttCertList=e, ][extAttCertList=el, ]
1280           [extTrustedHostList=et, ][refreshAttCert=ra])
1281         
1282The procedure is:
1283
12841) Try attribute request using user certificate
12852) If the Attribute Authority (AA) doesn't recognise the certificate,
1286find out any other hosts which have a trust relationship to the AA.
12873) Look for Attribute Certificates held in the wallet corresponding
1288to these hosts.
12894) If no Attribute Certificates are available, call the relevant
1290hosts' AAs to get certificates
12915) Finally, use these new certificates to try to obtain a mapped
1292certificate from the original AA
12936) If this fails access is denied     
1294           
1295@type reqRole: string
1296@param reqRole: the required role to get access for
1297
1298@type aaURI: string
1299@param aaURI: to call as a web service, specify the URI for the
1300Attribute Authority.
1301
1302@type aaPropFilePath: string
1303@param aaPropFilePath: Altenrative to aaURI - to run on the local
1304machine, specify the local Attribute Authority configuration file.
1305                       
1306@type mapFromTrustedHosts: bool / None     
1307@param mapFromTrustedHosts: if request fails via the user's cert
1308ID, then it is possible to get a mapped certificate by using
1309certificates from other AA's.  Set this flag to True, to allow this
1310second stage of generating a mapped certificate from the certificate
1311stored in the wallet credentials.
1312
1313If set to False, it is possible to return the list of certificates
1314available for mapping and then choose which one or ones to use for
1315mapping by re-calling getAttCert with extAttCertList set to these
1316certificates.
1317
1318Defaults to None in which case self.__mapFromTrustedHosts is not
1319altered
1320
1321The list is returned via CredWalletAttributeRequestDenied exception
1322If no value is set, the default value held in
1323self.__mapFromTrustedHosts is used
1324
1325@type rtnExtAttCertList: bool / None
1326@param rtnExtAttCertList: If request fails, make a list of
1327candidate certificates from other Attribute Authorities which the user
1328could use to retry and get a mapped certificate.
1329                       
1330If mapFromTrustedHosts is set True this flags value is overriden and
1331effectively set to True.
1332
1333If no value is set, the default value held in self.__rtnExtAttCertList
1334is used.
1335                       
1336The list is returned via a CredWalletAttributeRequestDenied exception
1337object.
1338                       
1339@type extAttCertList: list
1340@param extAttCertList: Attribute Certificate or list of certificates
1341from other Attribute Authorities.  These can be used to get a mapped
1342certificate if access fails based on the user's certificate
1343credentials.  They are tried out in turn until access is granted so
1344the order of the list decides the order in which they will be tried
1345
1346@type extTrustedHostList:
1347@param extTrustedHostList: same as extAttCertList keyword, but
1348instead of providing Attribute Certificates, give a list of Attribute
1349Authority hosts.  These will be matched up to Attribute Certificates
1350held in the wallet.  Matching certificates will then be used to try to
1351get a mapped Attribute Certificate.
1352
1353@type refreshAttCert: bool
1354@param refreshAttCert: if set to True, the attribute request
1355will go ahead even if the wallet already contains an Attribute
1356Certificate from the target Attribute Authority.  The existing AC in
1357the wallet will be replaced by the new one obtained from this call.
1358                       
1359If set to False, this method will check to see if an AC issued by the
1360target AA already exists in the wallet.  If so, it will return this AC
1361to the caller without proceeding to make a call to the AA.
1362
1363@type attCertRefreshElapse: float / int
1364@param attCertRefreshElapse: determine whether to replace an
1365existing AC in the cache with a fresh one.  If the existing one has
1366less than attCertRefreshElapse time in seconds left before expiry then
1367replace it.
1368
1369</pre>
1370  <dl class="fields">
1371  </dl>
1372</td></tr></table>
1373</div>
1374<br />
1375<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
1376<a name="section-ClassVariableDetails"></a>
1377<table class="details" border="1" cellpadding="3"
1378       cellspacing="0" width="100%" bgcolor="white">
1379<tr bgcolor="#70b0f0" class="table-header">
1380  <td colspan="2" class="table-header">
1381    <table border="0" cellpadding="0" cellspacing="0" width="100%">
1382      <tr valign="top">
1383        <td align="left"><span class="table-header">Class Variable Details</span></td>
1384        <td align="right" valign="top"
1385         ><span class="options">[<a href="#section-ClassVariableDetails"
1386         class="privatelink" onclick="toggle_private();"
1387         >hide private</a>]</span></td>
1388      </tr>
1389    </table>
1390  </td>
1391</tr>
1392</table>
1393<a name="userCert"></a>
1394<div>
1395<table class="details" border="1" cellpadding="3"
1396       cellspacing="0" width="100%" bgcolor="white">
1397<tr><td>
1398  <h3 class="epydoc">userCert</h3>
1399 
1400  <dl class="fields">
1401  </dl>
1402  <dl class="fields">
1403    <dt>Value:</dt>
1404      <dd><table><tr><td><pre class="variable">
1405property(fget= __getUserCert, fset= __setUserCert, doc= &quot;X.509 user ce<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1406rtificate instance&quot;)
1407</pre></td></tr></table>
1408</dd>
1409  </dl>
1410</td></tr></table>
1411</div>
1412<a name="issuingCert"></a>
1413<div>
1414<table class="details" border="1" cellpadding="3"
1415       cellspacing="0" width="100%" bgcolor="white">
1416<tr><td>
1417  <h3 class="epydoc">issuingCert</h3>
1418 
1419  <dl class="fields">
1420  </dl>
1421  <dl class="fields">
1422    <dt>Value:</dt>
1423      <dd><table><tr><td><pre class="variable">
1424property(fget= __getIssuingCert, fset= __setIssuingCert, doc= &quot;X.509 u<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1425ser certificate instance&quot;)
1426</pre></td></tr></table>
1427</dd>
1428  </dl>
1429</td></tr></table>
1430</div>
1431<a name="userPriKey"></a>
1432<div>
1433<table class="details" border="1" cellpadding="3"
1434       cellspacing="0" width="100%" bgcolor="white">
1435<tr><td>
1436  <h3 class="epydoc">userPriKey</h3>
1437 
1438  <dl class="fields">
1439  </dl>
1440  <dl class="fields">
1441    <dt>Value:</dt>
1442      <dd><table><tr><td><pre class="variable">
1443property(fset= __setUserPriKey, doc= &quot;Private key used to sign outboun<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1444d message&quot;)
1445</pre></td></tr></table>
1446</dd>
1447  </dl>
1448</td></tr></table>
1449</div>
1450<a name="credentials"></a>
1451<div>
1452<table class="details" border="1" cellpadding="3"
1453       cellspacing="0" width="100%" bgcolor="white">
1454<tr><td>
1455  <h3 class="epydoc">credentials</h3>
1456 
1457  <dl class="fields">
1458  </dl>
1459  <dl class="fields">
1460    <dt>Value:</dt>
1461      <dd><table><tr><td><pre class="variable">
1462property(fget= __getCredentials, doc= &quot;List of Attribute Certificates&quot;<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1463)
1464</pre></td></tr></table>
1465</dd>
1466  </dl>
1467</td></tr></table>
1468</div>
1469<a name="caCertFilePathList"></a>
1470<div>
1471<table class="details" border="1" cellpadding="3"
1472       cellspacing="0" width="100%" bgcolor="white">
1473<tr><td>
1474  <h3 class="epydoc">caCertFilePathList</h3>
1475 
1476  <dl class="fields">
1477  </dl>
1478  <dl class="fields">
1479    <dt>Value:</dt>
1480      <dd><table><tr><td><pre class="variable">
1481property(fget= __getCAcertFilePathList, fset= __setCAcertFilePathList,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1482 doc= &quot;CA Certificates - used for &quot;+ &quot;verification of AC and SOAP &quot;+ &quot;<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1483message signatures and SSL &quot;+ &quot;connections&quot;)
1484</pre></td></tr></table>
1485</dd>
1486  </dl>
1487</td></tr></table>
1488</div>
1489<a name="aaURI"></a>
1490<div>
1491<table class="details" border="1" cellpadding="3"
1492       cellspacing="0" width="100%" bgcolor="white">
1493<tr><td>
1494  <h3 class="epydoc">aaURI</h3>
1495 
1496  <dl class="fields">
1497  </dl>
1498  <dl class="fields">
1499    <dt>Value:</dt>
1500      <dd><table><tr><td><pre class="variable">
1501property(fset= __setAAuri, doc= &quot;AA URI - setting also sets up AttAuth<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1502orityClient instance!&quot;)
1503</pre></td></tr></table>
1504</dd>
1505  </dl>
1506</td></tr></table>
1507</div>
1508<a name="aaClnt"></a>
1509<div>
1510<table class="details" border="1" cellpadding="3"
1511       cellspacing="0" width="100%" bgcolor="white">
1512<tr><td>
1513  <h3 class="epydoc">aaClnt</h3>
1514 
1515  <dl class="fields">
1516  </dl>
1517  <dl class="fields">
1518    <dt>Value:</dt>
1519      <dd><table><tr><td><pre class="variable">
1520property(fget= __getAAclnt, doc= &quot;AA web service client instance&quot;)
1521</pre></td></tr></table>
1522</dd>
1523  </dl>
1524</td></tr></table>
1525</div>
1526<a name="aaPropFilePath"></a>
1527<div>
1528<table class="details" border="1" cellpadding="3"
1529       cellspacing="0" width="100%" bgcolor="white">
1530<tr><td>
1531  <h3 class="epydoc">aaPropFilePath</h3>
1532 
1533  <dl class="fields">
1534  </dl>
1535  <dl class="fields">
1536    <dt>Value:</dt>
1537      <dd><table><tr><td><pre class="variable">
1538property(fset= __setAApropFilePath, doc= &quot;AA properties file path - se<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1539tting this also sets up an AA locally!&quot;)
1540</pre></td></tr></table>
1541</dd>
1542  </dl>
1543</td></tr></table>
1544</div>
1545<br />
1546<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
1547<a name="section-InstanceVariableDetails"></a>
1548<table class="details" border="1" cellpadding="3"
1549       cellspacing="0" width="100%" bgcolor="white">
1550<tr bgcolor="#70b0f0" class="table-header">
1551  <td colspan="2" class="table-header">
1552    <table border="0" cellpadding="0" cellspacing="0" width="100%">
1553      <tr valign="top">
1554        <td align="left"><span class="table-header">Instance Variable Details</span></td>
1555        <td align="right" valign="top"
1556         ><span class="options">[<a href="#section-InstanceVariableDetails"
1557         class="privatelink" onclick="toggle_private();"
1558         >hide private</a>]</span></td>
1559      </tr>
1560    </table>
1561  </td>
1562</tr>
1563</table>
1564<a name="__caCertFilePathList"></a>
1565<div class="private">
1566<table class="details" border="1" cellpadding="3"
1567       cellspacing="0" width="100%" bgcolor="white">
1568<tr><td>
1569  <h3 class="epydoc">__caCertFilePathList</h3>
1570  file path(s) to CA certificates.  If None then the input is quietly
1571  ignored.  See caCertFilePathList property
1572  <dl class="fields">
1573    <dt>Type:</dt>
1574      <dd>basestring, list, tuple or None</dd>
1575  </dl>
1576</td></tr></table>
1577</div>
1578<a name="__credRepos"></a>
1579<div class="private">
1580<table class="details" border="1" cellpadding="3"
1581       cellspacing="0" width="100%" bgcolor="white">
1582<tr><td>
1583  <h3 class="epydoc">__credRepos</h3>
1584  reference to Credential Repository object.  An optional non-volatile
1585  cache for storage of wallet info when
1586  <dl class="fields">
1587    <dt>Type:</dt>
1588      <dd>ndg.security.common.CredRepos or derivative</dd>
1589  </dl>
1590</td></tr></table>
1591</div>
1592<a name="__mapFromTrustedHosts"></a>
1593<div class="private">
1594<table class="details" border="1" cellpadding="3"
1595       cellspacing="0" width="100%" bgcolor="white">
1596<tr><td>
1597  <h3 class="epydoc">__mapFromTrustedHosts</h3>
1598  if true, allow a mapped attribute certificate to obtained in a getAttCert
1599  call.  Set false to prevent mappings.
1600  <dl class="fields">
1601    <dt>Type:</dt>
1602      <dd>bool</dd>
1603  </dl>
1604</td></tr></table>
1605</div>
1606<br />
1607<!-- ==================== NAVIGATION BAR ==================== -->
1608<table class="navbar" border="0" width="100%" cellpadding="0"
1609       bgcolor="#a0c0ff" cellspacing="0">
1610  <tr valign="middle">
1611  <!-- Home link -->
1612      <th>&nbsp;&nbsp;&nbsp;<a
1613        href="ndg-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1614
1615  <!-- Tree link -->
1616      <th>&nbsp;&nbsp;&nbsp;<a
1617        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1618
1619  <!-- Index link -->
1620      <th>&nbsp;&nbsp;&nbsp;<a
1621        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1622
1623  <!-- Help link -->
1624      <th>&nbsp;&nbsp;&nbsp;<a
1625        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1626
1627  <!-- Project homepage -->
1628      <th class="navbar" align="right" width="100%">
1629        <table border="0" cellpadding="0" cellspacing="0">
1630          <tr><th class="navbar" align="center"
1631            >NDG Security</th>
1632          </tr></table></th>
1633  </tr>
1634</table>
1635<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1636  <tr>
1637    <td align="left" class="footer">
1638    <a href="epydoc-log.html">Generated by Epydoc
1639    3.0.1 on Thu Sep  4 09:37:43 2008</a>
1640    </td>
1641    <td align="right" class="footer">
1642      <a target="mainFrame" href="http://epydoc.sourceforge.net"
1643        >http://epydoc.sourceforge.net</a>
1644    </td>
1645  </tr>
1646</table>
1647
1648<script type="text/javascript">
1649  <!--
1650  // Private objects are initially displayed (because if
1651  // javascript is turned off then we want them to be
1652  // visible); but by default, we want to hide them.  So hide
1653  // them unless we have a cookie that says to show them.
1654  checkCookie();
1655  // -->
1656</script>
1657</body>
1658</html>
Note: See TracBrowser for help on using the repository browser.