~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.association-module.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="ascii"?>
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
2
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
          "DTD/xhtml1-transitional.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
5
<head>
6
6
  <title>openid.association</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8
 
  <script type="text/javascript" src="epydoc.js"></script>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
8
</head>
10
 
 
11
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
10
      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="openid-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
 
            ><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
38
 
          </tr></table></th>
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
24
      </p></th></tr></table>
 
25
    </th>
39
26
  </tr>
40
27
</table>
41
28
<table width="100%" cellpadding="0" cellspacing="0">
42
29
  <tr valign="top">
43
30
    <td width="100%">
44
 
      <span class="breadcrumbs">
 
31
      <font size="-1"><b class="breadcrumbs">
45
32
        <a href="openid-module.html">Package&nbsp;openid</a> ::
46
33
        Module&nbsp;association
47
 
      </span>
48
 
    </td>
49
 
    <td>
50
 
      <table cellpadding="0" cellspacing="0">
51
 
        <!-- hide/show private -->
52
 
        <tr><td align="right"><span class="options"
53
 
            >[<a href="frames.html" target="_top">frames</a
54
 
            >]&nbsp;|&nbsp;<a href="openid.association-module.html"
55
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
56
 
      </table>
57
 
    </td>
58
 
  </tr>
59
 
</table>
60
 
<!-- ==================== MODULE DESCRIPTION ==================== -->
61
 
<h1 class="epydoc">Module association</h1><span class="codelink"><a href="openid.association-pysrc.html">source&nbsp;code</a></span><br /><br />
62
 
This module contains code for dealing with associations between 
63
 
  consumers and servers.<br /><br />
64
 
 
65
 
<!-- ==================== CLASSES ==================== -->
66
 
<a name="section-Classes"></a>
67
 
<table class="summary" border="1" cellpadding="3"
68
 
       cellspacing="0" width="100%" bgcolor="white">
69
 
<tr bgcolor="#70b0f0" class="table-header">
70
 
  <td colspan="2" class="table-header">
71
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
72
 
      <tr valign="top">
73
 
        <td align="left"><span class="table-header">Classes</span></td>
74
 
        <td align="right" valign="top"
75
 
         ><span class="options">[<a href="#section-Classes"
76
 
         class="privatelink" onclick="toggle_private();"
77
 
         >hide private</a>]</span></td>
78
 
      </tr>
79
 
    </table>
80
 
  </td>
81
 
</tr>
82
 
<tr>
83
 
  <td width="15%" align="right" valign="top" class="summary">
84
 
    <span class="summary-type">&nbsp;</span>
85
 
  </td><td class="summary">
86
 
    <a href="openid.association.Association-class.html">Association</a><br />
87
 
      This class represents an association between a server and a 
88
 
        consumer.
89
 
  </td>
90
 
</tr>
91
 
</table>
92
 
 
 
34
      </b></font></br>
 
35
    </td>
 
36
    <td><table cellpadding="0" cellspacing="0">
 
37
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.association-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
38
    </table></td>
 
39
</tr></table>
 
40
 
 
41
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
42
<h2 class="module">Module openid.association</h2>
 
43
 
 
44
<p>This module contains code for dealing with associations between 
 
45
consumers and servers. Associations contain a shared secret that is used 
 
46
to sign <code>openid.mode=id_res</code> messages.</p>
 
47
Users of the library should not usually need to interact directly with 
 
48
associations. The <a href="openid.store-module.html" 
 
49
class="link"><code>store</code></a>, <a 
 
50
href="openid.server.server-module.html" 
 
51
class="link"><code>server</code></a> and <a 
 
52
href="openid.consumer.consumer-module.html" 
 
53
class="link"><code>consumer</code></a> objects will create and manage the 
 
54
associations. The consumer and server code will make use of a <code><a 
 
55
href="openid.association.SessionNegotiator-class.html" 
 
56
class="link"><code>SessionNegotiator</code></a></code> when managing 
 
57
associations, which enables users to express a preference for what kind 
 
58
of associations should be allowed, and what kind of exchange should be 
 
59
done to establish the association.
 
60
<hr/>
 
61
 
 
62
<!-- =========== START OF CLASSES =========== -->
 
63
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
64
<tr bgcolor="#70b0f0" class="summary">
 
65
  <th colspan="2">Classes</th></tr>
 
66
<tr><td width="15%">
 
67
  <b><a href="openid.association.Association-class.html"><code>Association</code></a></b></td>
 
68
  <td>This class represents an association between a server and a 
 
69
consumer.</td></tr>
 
70
<tr><td width="15%">
 
71
  <b><a href="openid.association.SessionNegotiator-class.html"><code>SessionNegotiator</code></a></b></td>
 
72
  <td>A session negotiator controls the allowed and preferred association 
 
73
types and association session types.</td></tr>
 
74
</table><br />
 
75
 
 
76
 
 
77
<!-- =========== START OF VARIABLE SUMMARY =========== -->
 
78
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
79
<tr bgcolor="#70b0f0" class="summary">
 
80
  <th colspan="2">Variable Summary</th></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SessionNegotiator</code></font></td>
 
82
<td><b><a href="openid.association-module.html#default_negotiator"><code>default_negotiator</code></a></b>: A <code><a href="openid.association.SessionNegotiator-class.html" 
 
83
class="link"><code>SessionNegotiator</code></a></code> that allows all 
 
84
association types that are specified by the OpenID specification.</td></tr>
 
85
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SessionNegotiator</code></font></td>
 
86
<td><b><a href="openid.association-module.html#encrypted_negotiator"><code>encrypted_negotiator</code></a></b>: A <code><a href="openid.association.SessionNegotiator-class.html" 
 
87
class="link"><code>SessionNegotiator</code></a></code> that does not 
 
88
support <code>'no-encryption'</code> associations.</td></tr>
 
89
</table><br />
 
90
 
 
91
 
 
92
<!-- =========== START OF VARIABLE DETAILS =========== -->
 
93
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
94
<tr bgcolor="#70b0f0" class="details">
 
95
  <th colspan="2">Variable Details</th></tr>
 
96
</table>
 
97
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
98
<a name="default_negotiator"></a>
 
99
<h3>default_negotiator</h3>
 
100
A <code><a href="openid.association.SessionNegotiator-class.html" 
 
101
class="link"><code>SessionNegotiator</code></a></code> that allows all 
 
102
association types that are specified by the OpenID specification. It 
 
103
prefers to use HMAC-SHA1/DH-SHA1, if it's available. If HMAC-SHA256 is 
 
104
not supported by your Python runtime, HMAC-SHA256 and DH-SHA256 will not 
 
105
be available.
 
106
<dl>
 
107
  <dt></dt>
 
108
  <dd>
 
109
    <dl>
 
110
      <dt><b>Type:</b></dt>
 
111
      <dd>
 
112
          <code>SessionNegotiator</code>
 
113
 
 
114
      </dd>
 
115
<span title="&lt;openid.association.SessionNegotiator object at 0x82d068c&gt;">      <dt><b>Value:</b></dt>
 
116
      <dd><table><tr><td>
 
117
<pre class="variable">
 
118
&lt;openid.association.SessionNegotiator object at 0x82d068c&gt;             </pre>
 
119
        </td></tr></table></dd>
 
120
</span>    </dl>
 
121
  </dd>
 
122
</dl></td></tr></table>
 
123
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
124
<a name="encrypted_negotiator"></a>
 
125
<h3>encrypted_negotiator</h3>
 
126
A <code><a href="openid.association.SessionNegotiator-class.html" 
 
127
class="link"><code>SessionNegotiator</code></a></code> that does not 
 
128
support <code>'no-encryption'</code> associations. It prefers 
 
129
HMAC-SHA1/DH-SHA1 association types if available.
 
130
<dl>
 
131
  <dt></dt>
 
132
  <dd>
 
133
    <dl>
 
134
      <dt><b>Type:</b></dt>
 
135
      <dd>
 
136
          <code>SessionNegotiator</code>
 
137
 
 
138
      </dd>
 
139
<span title="&lt;openid.association.SessionNegotiator object at 0x82d06cc&gt;">      <dt><b>Value:</b></dt>
 
140
      <dd><table><tr><td>
 
141
<pre class="variable">
 
142
&lt;openid.association.SessionNegotiator object at 0x82d06cc&gt;             </pre>
 
143
        </td></tr></table></dd>
 
144
</span>    </dl>
 
145
  </dd>
 
146
</dl></td></tr></table>
93
147
<br />
94
 
<!-- ==================== NAVIGATION BAR ==================== -->
95
 
<table class="navbar" border="0" width="100%" cellpadding="0"
96
 
       bgcolor="#a0c0ff" cellspacing="0">
97
 
  <tr valign="middle">
98
 
  <!-- Home link -->
99
 
      <th>&nbsp;&nbsp;&nbsp;<a
100
 
        href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
101
 
 
102
 
  <!-- Tree link -->
103
 
      <th>&nbsp;&nbsp;&nbsp;<a
104
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
105
 
 
106
 
  <!-- Index link -->
107
 
      <th>&nbsp;&nbsp;&nbsp;<a
108
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
109
 
 
110
 
  <!-- Help link -->
111
 
      <th>&nbsp;&nbsp;&nbsp;<a
112
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
113
 
 
114
 
  <!-- Project homepage -->
115
 
      <th class="navbar" align="right" width="100%">
116
 
        <table border="0" cellpadding="0" cellspacing="0">
117
 
          <tr><th class="navbar" align="center"
118
 
            ><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
119
 
          </tr></table></th>
 
148
 
 
149
 
 
150
<!-- =========== START OF NAVBAR =========== -->
 
151
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
152
  <tr valign="center">
 
153
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
154
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
155
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
156
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
157
    <th class="navbar" align="right" width="100%">
 
158
      <table border="0" cellpadding="0" cellspacing="0">
 
159
      <tr><th class="navbar" align="center">
 
160
        <p class="nomargin">
 
161
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
162
      </p></th></tr></table>
 
163
    </th>
120
164
  </tr>
121
165
</table>
122
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
166
 
 
167
<table border="0" cellpadding="0" cellspacing="0" width="100%">
123
168
  <tr>
124
 
    <td align="left" class="footer">Generated by Epydoc
125
 
        3.0alpha3 on Fri Dec  8 13:26:20 2006</td>
126
 
    <td align="right" class="footer">
127
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
128
 
    </td>
 
169
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
 
170
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
171
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
129
172
  </tr>
130
173
</table>
131
 
 
132
 
<script type="text/javascript">
133
 
  <!--
134
 
  // Private objects are initially displayed (because if
135
 
  // javascript is turned off then we want them to be
136
 
  // visible); but by default, we want to hide them.  So hide
137
 
  // them unless we have a cookie that says to show them.
138
 
  checkCookie()
139
 
  // -->
140
 
</script>
141
 
  
142
174
</body>
143
175
</html>