Ignore:
Timestamp:
29/09/08 16:05:29 (11 years ago)
Author:
pjkersha
Message:

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.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/documentation/epydoc/ndg.security.server.SessionMgr.UserSession-class.html

    r3153 r4245  
    6060</table> 
    6161<!-- ==================== CLASS DESCRIPTION ==================== --> 
    62 <h1 class="epydoc">Class UserSession</h1><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession">source&nbsp;code</a></span><br /><br /> 
     62<h1 class="epydoc">Class UserSession</h1><p class="nomargin-top"><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession">source&nbsp;code</a></span></p> 
    6363<center> 
    64 <center>  <map id="uml_class_diagram_for_ndg_secu_155" name="uml_class_diagram_for_ndg_secu_155"> 
    65 <area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html" title="Session details &#45; created when a user logs into NDG" alt="" coords="15,11,67,27"/> 
     64<center>  <map id="uml_class_diagram_for_ndg_secu_206" name="uml_class_diagram_for_ndg_secu_206"> 
     65<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#credWallet" title="ndg.security.server.SessionMgr.UserSession.credWallet" alt="" coords="17,28,580,47"/> 
     66<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#sessIDlist" title="ndg.security.server.SessionMgr.UserSession.sessIDlist" alt="" coords="17,47,580,65"/> 
     67<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#latestSessID" title="ndg.security.server.SessionMgr.UserSession.latestSessID" alt="" coords="17,65,580,84"/> 
     68<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#__init__" title="Initialise UserSession with args and keywords to CredWallet" alt="" coords="17,87,580,105"/> 
     69<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#addNewSessID" title="Add a new session ID to be associated with this UserSession instance" alt="" coords="17,105,580,124"/> 
     70<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#encodeSessionMgrURI" title="Encode Session Manager URI to allow inclusion in a web browser session &#160;cookie" alt="" coords="17,124,580,143"/> 
     71<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#decodeSessionMgrURI" title="Decode the URI from cookie set by another Session Manager." alt="" coords="17,143,580,161"/> 
     72<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html#createCookie" title="Create cookies for session ID Session Manager WSDL address" alt="" coords="17,161,580,180"/> 
     73<area shape="rect" href="ndg.security.server.SessionMgr.UserSession&#45;class.html" title="Session details &#45; created when a user logs into NDG" alt="" coords="16,11,581,181"/> 
    6674</map> 
    67   <img src="uml_class_diagram_for_ndg_secu_155.gif" alt='' usemap="#uml_class_diagram_for_ndg_secu_155" ismap="ismap" class="graph-without-title" /> 
    68 </center></center> 
     75  <img src="uml_class_diagram_for_ndg_secu_206.gif" alt='' usemap="#uml_class_diagram_for_ndg_secu_206" ismap="ismap" class="graph-without-title" /> 
     76</center> 
     77</center> 
    6978<hr /> 
    70 Session details - created when a user logs into NDG<br /><br /> 
     79<p>Session details - created when a user logs into NDG</p> 
    7180 
    7281<!-- ==================== INSTANCE METHODS ==================== --> 
     
    130139        <tr> 
    131140          <td><span class="summary-sig"><a name="__getSessIDlist"></a><span class="summary-sig-name">__getSessIDlist</span>(<span class="summary-sig-arg">self</span>)</span><br /> 
    132       Get Session ID list - last item is latest allocated for this  
    133       session</td> 
     141      Get Session ID list - last item is latest allocated for this session</td> 
    134142          <td align="right" valign="top"> 
    135143            <span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.__getSessIDlist">source&nbsp;code</a></span> 
     
    165173        <tr> 
    166174          <td><span class="summary-sig"><a name="addNewSessID"></a><span class="summary-sig-name">addNewSessID</span>(<span class="summary-sig-arg">self</span>)</span><br /> 
    167       Add a new session ID to be associated with this UserSession  
    168       instance</td> 
     175      Add a new session ID to be associated with this UserSession instance</td> 
    169176          <td align="right" valign="top"> 
    170177            <span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.addNewSessID">source&nbsp;code</a></span> 
     
    183190        <tr> 
    184191          <td><span class="summary-sig"><a name="__getExpiryStr"></a><span class="summary-sig-name">__getExpiryStr</span>(<span class="summary-sig-arg">self</span>)</span><br /> 
    185       Return session expiry date/time as would be formatted for a  
    186       cookie</td> 
     192      Return session expiry date/time as would be formatted for a cookie</td> 
    187193          <td align="right" valign="top"> 
    188194            <span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.__getExpiryStr">source&nbsp;code</a></span> 
     
    287293  </tr> 
    288294</table> 
     295<!-- ==================== CLASS VARIABLES ==================== --> 
     296<a name="section-ClassVariables"></a> 
     297<table class="summary" border="1" cellpadding="3" 
     298       cellspacing="0" width="100%" bgcolor="white"> 
     299<tr bgcolor="#70b0f0" class="table-header"> 
     300  <td colspan="2" class="table-header"> 
     301    <table border="0" cellpadding="0" cellspacing="0" width="100%"> 
     302      <tr valign="top"> 
     303        <td align="left"><span class="table-header">Class Variables</span></td> 
     304        <td align="right" valign="top" 
     305         ><span class="options">[<a href="#section-ClassVariables" 
     306         class="privatelink" onclick="toggle_private();" 
     307         >hide private</a>]</span></td> 
     308      </tr> 
     309    </table> 
     310  </td> 
     311</tr> 
     312<tr> 
     313    <td width="15%" align="right" valign="top" class="summary"> 
     314      <span class="summary-type">&nbsp;</span> 
     315    </td><td class="summary"> 
     316        <a href="ndg.security.server.SessionMgr.UserSession-class.html#credWallet" class="summary-name">credWallet</a> = <code title="property(fget= __getCredWallet, doc= &quot;Read-only access to CredWallet i\ 
     317nstance&quot;)">property(fget= __getCredWallet, doc= &quot;Read-only a<code class="variable-ellipsis">...</code></code> 
     318    </td> 
     319  </tr> 
     320<tr> 
     321    <td width="15%" align="right" valign="top" class="summary"> 
     322      <span class="summary-type">&nbsp;</span> 
     323    </td><td class="summary"> 
     324        <a href="ndg.security.server.SessionMgr.UserSession-class.html#sessIDlist" class="summary-name">sessIDlist</a> = <code title="property(fget= __getSessIDlist, doc= &quot;Read-only access to Session ID l\ 
     325ist&quot;)">property(fget= __getSessIDlist, doc= &quot;Read-only a<code class="variable-ellipsis">...</code></code> 
     326    </td> 
     327  </tr> 
     328<tr> 
     329    <td width="15%" align="right" valign="top" class="summary"> 
     330      <span class="summary-type">&nbsp;</span> 
     331    </td><td class="summary"> 
     332        <a href="ndg.security.server.SessionMgr.UserSession-class.html#latestSessID" class="summary-name">latestSessID</a> = <code title="property(fget= __latestSessID, doc= &quot;Latest Session ID allocated&quot;)">property(fget= __latestSessID, doc= &quot;Latest Ses<code class="variable-ellipsis">...</code></code> 
     333    </td> 
     334  </tr> 
     335</table> 
    289336<!-- ==================== PROPERTIES ==================== --> 
    290337<a name="section-Properties"></a> 
     
    304351  </td> 
    305352</tr> 
    306 <tr> 
    307     <td width="15%" align="right" valign="top" class="summary"> 
    308       <span class="summary-type">&nbsp;</span> 
    309     </td><td class="summary"> 
    310         <a href="ndg.security.server.SessionMgr.UserSession-class.html#credWallet" class="summary-name">credWallet</a><br /> 
    311       Read-only access to CredWallet instance 
    312     </td> 
    313   </tr> 
    314 <tr> 
    315     <td width="15%" align="right" valign="top" class="summary"> 
    316       <span class="summary-type">&nbsp;</span> 
    317     </td><td class="summary"> 
    318         <a href="ndg.security.server.SessionMgr.UserSession-class.html#sessIDlist" class="summary-name">sessIDlist</a><br /> 
    319       Read-only access to Session ID list 
    320     </td> 
    321   </tr> 
    322 <tr> 
    323     <td width="15%" align="right" valign="top" class="summary"> 
    324       <span class="summary-type">&nbsp;</span> 
    325     </td><td class="summary"> 
    326         <a href="ndg.security.server.SessionMgr.UserSession-class.html#latestSessID" class="summary-name">latestSessID</a><br /> 
    327       Latest Session ID allocated 
    328     </td> 
    329   </tr> 
    330353  <tr> 
    331354    <td colspan="2" class="summary"> 
     
    369392    ><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.__init__">source&nbsp;code</a></span>&nbsp; 
    370393    </td> 
    371   </table> 
     394  </tr></table> 
    372395   
    373   Initialise UserSession with args and keywords to CredWallet 
     396  <p>Initialise UserSession with args and keywords to CredWallet</p> 
    374397  <dl class="fields"> 
    375398    <dt>Overrides: 
    376       object.__init__ 
     399        object.__init__ 
    377400    </dt> 
    378401  </dl> 
     
    393416    ><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.encodeSessionMgrURI">source&nbsp;code</a></span>&nbsp; 
    394417    </td> 
    395   </table> 
     418  </tr></table> 
    396419   
    397420  <p>Encode Session Manager URI to allow inclusion in a web browser session 
    398421  cookie</p> 
    399   The address is optionally encrypted and then base 64 encoded use a URL 
    400   safe encoding 
     422  <p>The address is optionally encrypted and then base 64 encoded use a URL 
     423  safe encoding</p> 
    401424  <dl class="fields"> 
    402425    <dt>Parameters:</dt> 
    403426    <dd><ul class="nomargin-top"> 
    404         <li><strong class="pname"><code>encrKey</code></strong> (string) - 16 char encryption key used to encrypt the URI.  If omitted or 
     427        <li><strong class="pname"><code>encrKey</code></strong> (string) - 16 char encryption key used to encrypt the URI.  If omitted or  
    405428          set None, the URI is not encrypted but merely base 64 encoded</li> 
    406429    </ul></dd> 
     
    422445    ><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.decodeSessionMgrURI">source&nbsp;code</a></span>&nbsp; 
    423446    </td> 
    424   </table> 
     447  </tr></table> 
    425448   
    426   Decode the URI from cookie set by another Session Manager.  This is  
     449  <p>Decode the URI from cookie set by another Session Manager.  This is  
    427450  required when reading a session cookie to find out which Session Manager  
    428   holds the client's session 
     451  holds the client's session</p> 
    429452  <dl class="fields"> 
    430453    <dt>Parameters:</dt> 
    431454    <dd><ul class="nomargin-top"> 
    432455        <li><strong class="pname"><code>txt</code></strong> (string) - base 64 encoded encrypted text</li> 
    433         <li><strong class="pname"><code>encrKey</code></strong> (string) - 16 char encryption key used to encrypt the URI.  If omitted or 
     456        <li><strong class="pname"><code>encrKey</code></strong> (string) - 16 char encryption key used to encrypt the URI.  If omitted or  
    434457          set None, the URI is assumed to be unencrypted</li> 
    435458    </ul></dd> 
     
    454477    ><span class="codelink"><a href="ndg.security.server.SessionMgr-pysrc.html#UserSession.createCookie">source&nbsp;code</a></span>&nbsp; 
    455478    </td> 
    456   </table> 
     479  </tr></table> 
    457480   
    458   Create cookies for session ID Session Manager WSDL address 
     481  <p>Create cookies for session ID Session Manager WSDL address</p> 
    459482  <dl class="fields"> 
    460483    <dt>Parameters:</dt> 
     
    462485        <li><strong class="pname"><code>sessMgrURI</code></strong> (string) - address for Session Mananger</li> 
    463486        <li><strong class="pname"><code>encrKey</code></strong> (string) - encryption key used to encrypted above URIs</li> 
    464         <li><strong class="pname"><code>sessID</code></strong> (string) - if no session ID is provided, use the latest one to be  
    465           allocated.</li> 
     487        <li><strong class="pname"><code>sessID</code></strong> (string) - if no session ID is provided, use the latest one to be allocated.</li> 
    466488        <li><strong class="pname"><code>cookieDomain</code></strong> (string) - domain set for cookie, if non set, web server domain name is  
    467489          used.  Nb. Generalised domains which don't set a specific host  
    468490          can be a security risk.</li> 
    469         <li><strong class="pname"><code>asString</code></strong> (bool) - Set to True to return the cookie as string text. If False, it  
    470           is returned as a SessionCookie instance.</li> 
     491        <li><strong class="pname"><code>asString</code></strong> (bool) - Set to True to return the cookie as string text. If False, it is  
     492          returned as a SessionCookie instance.</li> 
    471493    </ul></dd> 
    472494    <dt>Returns: SessionCookie / string depending on asString keyword</dt> 
     
    476498</div> 
    477499<br /> 
    478 <!-- ==================== PROPERTY DETAILS ==================== --> 
    479 <a name="section-PropertyDetails"></a> 
     500<!-- ==================== CLASS VARIABLE DETAILS ==================== --> 
     501<a name="section-ClassVariableDetails"></a> 
    480502<table class="details" border="1" cellpadding="3" 
    481503       cellspacing="0" width="100%" bgcolor="white"> 
     
    484506    <table border="0" cellpadding="0" cellspacing="0" width="100%"> 
    485507      <tr valign="top"> 
    486         <td align="left"><span class="table-header">Property Details</span></td> 
     508        <td align="left"><span class="table-header">Class Variable Details</span></td> 
    487509        <td align="right" valign="top" 
    488          ><span class="options">[<a href="#section-PropertyDetails" 
     510         ><span class="options">[<a href="#section-ClassVariableDetails" 
    489511         class="privatelink" onclick="toggle_private();" 
    490512         >hide private</a>]</span></td> 
     
    500522<tr><td> 
    501523  <h3 class="epydoc">credWallet</h3> 
    502   Read-only access to CredWallet instance 
    503   <dl class="fields"> 
    504     <dt>Get Method:</dt> 
    505     <dd class="value"><span class="summary-sig"><a href="ndg.security.server.SessionMgr.UserSession-class.html#__getCredWallet" class="summary-sig-name">ndg.security.server.SessionMgr.UserSession.__getCredWallet</a>(<span class="summary-sig-arg">self</span>)</span> 
    506         - Get Credential Wallet instance 
    507     </dd> 
     524   
     525  <dl class="fields"> 
     526  </dl> 
     527  <dl class="fields"> 
     528    <dt>Value:</dt> 
     529      <dd><table><tr><td><pre class="variable"> 
     530property(fget= __getCredWallet, doc= &quot;Read-only access to CredWallet i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 
     531nstance&quot;) 
     532</pre></td></tr></table> 
     533</dd> 
    508534  </dl> 
    509535</td></tr></table> 
     
    515541<tr><td> 
    516542  <h3 class="epydoc">sessIDlist</h3> 
    517   Read-only access to Session ID list 
    518   <dl class="fields"> 
    519     <dt>Get Method:</dt> 
    520     <dd class="value"><span class="summary-sig"><a href="ndg.security.server.SessionMgr.UserSession-class.html#__getSessIDlist" class="summary-sig-name">ndg.security.server.SessionMgr.UserSession.__getSessIDlist</a>(<span class="summary-sig-arg">self</span>)</span> 
    521         - Get Session ID list - last item is latest allocated for this  
    522       session 
    523     </dd> 
     543   
     544  <dl class="fields"> 
     545  </dl> 
     546  <dl class="fields"> 
     547    <dt>Value:</dt> 
     548      <dd><table><tr><td><pre class="variable"> 
     549property(fget= __getSessIDlist, doc= &quot;Read-only access to Session ID l<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 
     550ist&quot;) 
     551</pre></td></tr></table> 
     552</dd> 
    524553  </dl> 
    525554</td></tr></table> 
     
    531560<tr><td> 
    532561  <h3 class="epydoc">latestSessID</h3> 
    533   Latest Session ID allocated 
    534   <dl class="fields"> 
    535     <dt>Get Method:</dt> 
    536     <dd class="value"><span class="summary-sig"><a href="ndg.security.server.SessionMgr.UserSession-class.html#__latestSessID" class="summary-sig-name">ndg.security.server.SessionMgr.UserSession.__latestSessID</a>(<span class="summary-sig-arg">self</span>)</span> 
    537         - Get the session ID most recently allocated 
    538     </dd> 
     562   
     563  <dl class="fields"> 
     564  </dl> 
     565  <dl class="fields"> 
     566    <dt>Value:</dt> 
     567      <dd><table><tr><td><pre class="variable"> 
     568property(fget= __latestSessID, doc= &quot;Latest Session ID allocated&quot;) 
     569</pre></td></tr></table> 
     570</dd> 
    539571  </dl> 
    540572</td></tr></table> 
     
    573605    <td align="left" class="footer"> 
    574606    <a href="epydoc-log.html">Generated by Epydoc 
    575     3.0beta1 on Mon Dec 17 09:22:47 2007</a> 
     607    3.0.1 on Thu Sep  4 09:37:50 2008</a> 
    576608    </td> 
    577609    <td align="right" class="footer"> 
    578       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> 
     610      <a target="mainFrame" href="http://epydoc.sourceforge.net" 
     611        >http://epydoc.sourceforge.net</a> 
    579612    </td> 
    580613  </tr> 
     
    587620  // visible); but by default, we want to hide them.  So hide 
    588621  // them unless we have a cookie that says to show them. 
    589   checkCookie() 
     622  checkCookie(); 
    590623  // --> 
    591624</script> 
    592    
    593625</body> 
    594626</html> 
Note: See TracChangeset for help on using the changeset viewer.