Updated revision number and date.
[java-idp.git] / doc / InQueue.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3         <head>
4                 <title>InQueue Federation Policy and Configuration Guidelines</title>
5                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6                 <style type="text/css">
7
8                         html
9                         {       
10                                 background-color: #FFFFFF;
11                                 color: #000000;
12                                 margin: .5em;
13                         }
14                         a:visited
15                         {
16                                 color: #999999;
17                         }
18                         a:link
19                         {
20                                 color: #990000;
21                         }
22                         a:active
23                         {
24                                 color: #440000;
25                         }
26                         dl
27                         {
28                                 background-color: #DDDDDD;
29                                 background-image: none;
30                                 margin: 5px;
31                                 padding: 0px;
32                                 border-style: solid;
33                                 border-bottom-width: 2px;
34                                 border-top-width: 2px;
35                                 border-left-width: 2px;
36                                 border-right-width: 2px;
37                         }
38                         dt
39                         {
40                                 background-color: #DDDDDD;
41                                 background-image: none;
42                                 margin: 1px;
43                                 padding: 1px;
44                         }
45                         dd
46                         {
47                                 background-color: #DDDDDD;
48                                 background-image: none;
49                                 margin: 0px;
50                                 padding: 1px;
51                         }
52                         .attribute
53                         {
54                                 font-size: 115%;
55                                 font-color: #000000;
56                                 text-align: left;
57                                 background-color: #DDDDDD;
58                                 border: 1px black inset;
59                                 background-image: none;
60                                 margin: 0px;
61                                 padding: 2px;
62                         }
63                         .value
64                         {
65                                 font-color: #000000;
66                                 text-align: left;
67                                 background-color: #EEEEEE;
68                                 background-image: none;
69                                 padding-top: 0em;
70                                 padding-bottom: 0.5em;
71                                 padding-right: 1em;
72                                 padding-left: 5em;
73                                 border-style: solid;
74                                 border-bottom-width: none;
75                                 border-top-width: none;
76                                 border-left-width: 1px;
77                                 border-right-width: 1px;
78                         }
79                         .attributeopt
80                         {
81                                 font-size: 115%;
82                                 font-color: #000000;
83                                 text-align: left;
84                                 background-color: #BCBCEE;
85                                 border: 1px black inset;
86                                 background-image: none;
87                                 margin: 0px;
88                                 padding: 2px;
89                         }
90                         .valueopt
91                         {
92                                 font-color: #000000;
93                                 text-align: left;
94                                 background-color: #DDDDFF;
95                                 background-image: none;
96                                 padding-top: 0em;
97                                 padding-bottom: 0.5em;
98                                 padding-right: 1em;
99                                 padding-left: 5em;
100                                 border-style: solid;
101                                 border-bottom-width: none;
102                                 border-top-width: none;
103                                 border-left-width: 1px;
104                                 border-right-width: 1px;
105                         }
106                         .attributelong
107                         {
108                                 font-size: 85%;
109                                 font-color: #000000;
110                                 text-align: left;
111                                 background-color: #DDDDDD;
112                                 border: 1px black inset;
113                                 background-image: none;
114                                 margin: 0px;
115                                 padding: 2px;
116                         }
117                         .attributeoptlong
118                         {
119                                 font-size: 85%;
120                                 font-color: #000000;
121                                 text-align: left;
122                                 background-color: #BCBCEE;
123                                 border: 1px black inset;
124                                 background-image: none;
125                                 margin: 0px;
126                                 padding: 2px;
127                         }
128                         .demo
129                         {
130                                 background-color: #EEEEEE;
131                                 padding: 3px;
132                         }
133                         .fixedwidth
134                         {
135                                 font-family: monospace;
136                                 font-size: 90%;
137                                 font-color: #121212;
138                         }
139
140                 </style></head><body link="red" vlink="red" alink="black" bgcolor="white">
141                 InQueue Federation Policy and Configuration Guidelines<br>
142                 Version 1.1<br />
143                 August 4, 2003<br />
144
145                 <h3>InQueue Federation Policy and Configuration Guidelines</h3>
146
147                 <h4>1.  Introduction to InQueue</h4>
148                 <blockquote><p>
149                         The InQueue Federation, operated by Internet2, is designed for
150                         organizations that are becoming familiar with the Shibboleth software
151                         package and the federated trust model.  InQueue provides the basic
152                         services needed for a federation using Shibboleth:</p>
153
154                         <ul>
155                                 <li>maintenance and distribution of participating site description and
156                                 security files;</li>
157                                 <li>a central WAYF ("where are you from") web site;</li>
158                                 <li>specification of operational procedures and policies, including
159                                 user data (attribute) definitions; and</li>
160                                 <li>example target and origin sites with which to test
161                                 interoperability.</li>
162                         </ul>
163
164                         <p>Participating in InQueue permits an organization to learn about the
165                         Shibboleth software via the experience of multi-party federated access,
166                         while integrating its services into the organization's procedures and
167                         policies.</p>
168
169                         <p>The InQueue federation is specifically <b>not</b> intended to support
170                         production-level end-user access to protected resources.  Organizations
171                         operating target sites are strongly discouraged from making sensitive or
172                         valuable resources available via the Federation.</p>
173                 </blockquote>
174
175                 <h4>2.  InQueue Policies</h4>
176
177                 <h4>2.1  Participation</h4>
178
179                 <blockquote><p>An organization may join InQueue as an origin, as a
180                         target, or both.
181                         Participants are expected to be authorized representatives of
182                         their organization.  Internet2 reserves the right to make final
183                         decisions about participation in the Federation.</p>
184
185                         <p>Participation in the Federation is limited to the period during which
186                         an organization is learning about Shibboleth and federated operations.  Upon
187                         completion of this period, the organization is expected to join a
188                         Federation (or some other management solution) that meets its long-term
189                         operational needs.
190                         </p>
191                         <p>By joining InQueue, an organization agrees that the Federation can list their name on the Federation web site as a member of the Federation.</p>
192                         
193                         <p>In joining InQueue, an organization will make a good faith effort to maintain a web page describing their use of Shibboleth. This page will be linked from the Federation member list.</p>
194                         </blockquote>
195
196                         <h4>2.2  Data management</h4>
197
198                         <blockquote><p>
199                                 By participating, origins agree that all attributes sent
200                                 to targets in the Federation to the best of their knowledge accurately
201                                 represent information about the authenticated individual accessing the
202                                 target resource.</p>
203
204                                 <p>Targets agree to dispose of all received
205                                 attributes properly by not mis-using them, aggregating them, or
206                                 sharing them with other organizations.</p></blockquote>
207
208                         <h4>2.3  Security management</h4>
209
210                         <blockquote><p>InQueue distributes a set of root certificates for
211                                 issuers from which server certificates may be obtained to identify
212                                 InQueue server components.
213                                 Additionally, sites with certificates not rooted
214                                 in one of these trusted roots may have these certificates added to the
215                                 appropriate trust file.  Targets must have a certificate signed by an
216                                 acceptible CA.  The list of certificate authorities used by
217                                 InQueue is:</p>
218                                 <ul type="circle">
219                                         <li><a href="http://www.verisign.com/">Verisign/RSA Secure Server CA</a></li>
220                                         <li><a href="http://bossie.doit.wisc.edu/cert/i2server">Internet2
221                                                 HEPKI Test CA</a></li>
222                                         <li><a href="http://www.cren.net/crenca/">CREN CA</a></li>
223                                 </ul>
224                         </blockquote>
225
226                         <h4>2.4  Attributes</h4>
227                         <blockquote><p>The InQueue 
228                                 Federation specifies a set of attribute definitions to support basic
229                                 attribute-based authorization.</p>
230                                 <ol>
231                                 <li>If a Federation member sends or receives an Attribute Assertion 
232                                 containing the InQueue policy uri and referencing one of the listed
233                                 attributes, 
234                                 the syntax and semantics of the associated attribute value should
235                                 conform 
236                                 to the definitions specified in the <a href="http://www.educause.edu/eduperson/">EduPerson specification 2002/10</a>
237
238                                 <ul type="circle">
239                                         <li>eduPersonPrincipalName</li>
240                                         <li>eduPersonEntitlement</li>
241                                         <li>eduPersonAffiliation (expressed in a slightly different form via
242                                         a new attribute called eduPersonScopedAffiliation)</li>
243                                 </ul>
244                                 <li>If a Federation member sends or receives an Attribute Assertion 
245                                 containing the InQueue policy uri and referencing one of the listed
246                                 attributes, 
247                                 the syntax and semantics of the associated attribute value should
248                                 conform 
249                                 to the definitions specified in the relevant <a href="http://www/ietf.org">IETF</a> RFCs.
250
251                                 <ul type="circle">
252                                         <li>cn
253                                         <li>sn
254                                         <li>telephoneNumber
255                                         <li>title
256                                         <li>initials
257                                         <li>description
258                                         <li>carLicense
259                                         <li>departmentNumber
260                                         <li>displayName
261                                         <li>employeeNumber
262                                         <li>employeeType
263                                         <li>preferredLanguage
264                                         <li>manager
265                                         <li>roomNumber
266                                         <li>seeAlso
267                                         <li>facsimileTelephoneNumber
268                                         <li>street
269                                         <li>postOfficeBox
270                                         <li>postalCode
271                                         <li>st
272                                         <li>givenName
273                                         <li>l
274                                         <li>businessCategory
275                                         <li>ou
276                                         <li>physicalDeliveryOfficeName
277                                 </ul>
278                                 <li>If a Federation member sends or receives an eduPersonEntitlement Attribute Assertion 
279                                 containing the InQueue policy uri and containing one of the listed
280                                 values, 
281                                 the syntax and semantics of the associated attribute value should
282                                 conform 
283                                 to these definitions
284
285                                 <ul type="circle">
286                                         <li>urn:mace:incommon:entitlement:common:1
287                                         <p>The person possesses an eduPersonAffiliation value of faculty, staff,  or student, or qualifies as a "library walk-in".
288                                         
289                                 </ul>                           
290                                 </ol>
291                         </blockquote>
292
293                         <h4>3.  Joining InQueue</h4>
294
295                         <blockquote><p>To join InQueue, origins <a href="mailto:shib-support@internet2.edu?subject=Shib%20Origin%20Site%%0D%20%2020Application"> submit a request to
296                                         shib-support@internet2.edu</a> containing the following
297                                 information:</p></blockquote>
298
299                         <blockquote>
300                                 <ul type="circle">
301                                         <li>Domain Name of the origin site (e.g., Ohio State's is
302                                         "osu.edu").</li>
303                                         <li>Complete URL to access the Shibboleth Handle Service at the site.</li>
304                                         <li>The CN (usually the hostname) of the HS's certificate's subject.
305                                         This should also be the value of <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.
306                                                 HandleServlet.issuer</span> in <span class="fixedwidth">origin.properties</span>.</li>
307                                         <li>Any shorthand aliases the WAYF should support for the origin
308                                         site (e.g., Ohio State, OSU, Buckeyes)</li>
309                                         <li>Contact names and addresses for technical and administrative
310                                         issues.</li>
311                                         <li>The URL of an error page that users selecting this origin from
312                                         the WAYF may be referred to by targets if Shibboleth
313                                         malfunctions. (optional)</li>
314                                         <li>If the HS's certificate is not issueed by one of the root CAs
315                                         used
316                                         by InQueue, then it must be submitted in Base64-encoded DER (aka
317                                         "PEM") format.</li>
318                                         <li>(optional) Briefly describe the organization's planned uses of Shibboleth.
319                         </ul></blockquote>
320
321                         <blockquote><p>To join InQueue, targets must <a href="mailto:shib-support@internet2.edu?subject=Shib%20Target%20Site%%0D%20%2020Application"> submit a basic application to
322                                         shib-support@internet2.edu</a> containing the following
323                                 information:</p></blockquote>
324
325                         <blockquote>
326                                 <ul type="circle">
327                                         <li>The name of the organization</li>
328                                         <li>Contact names and addresses for both administrative and
329                                         technical purposes</li>
330                                 </ul>
331                         </blockquote>
332
333                         <h4>4.  Configuration for Using InQueue</h4>
334
335                         <blockquote><p>Once your site is accepted into and added to InQueue,
336                                 the following configuration parameters must be entered to ensure
337                                 interoperability and compliance with federation guidelines.  Consult
338                                 the Shibboleth Deploy Guides for further information on these fields
339                                 and on <span class="fixedwidth">origin.properties</span> and <span class="fixedwidth">shibboleth.ini</span>.</p></blockquote>
340
341                         <blockquote><h5>4.a. Origins:</h5>
342
343                                 <dl><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName</span>
344                                         </dd><dd class="value"><p>Must be populated with a URI that will
345                                         be assigned by InQueue when you are accepted into the
346                                         federation.</p></dd><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.audiences</span>
347                                         </dd><dd class="value"><p>This field must contain InQueue's <span class="fixedwidth">urn:mace:inqueue</span> URI, and may contain other federation URIs as well.</p></dd></dl>
348                                 </blockquote>
349
350                                 <blockquote><h5>4.b. Targets:</h5>
351
352                                         <dl><dd class="attribute"><span class="fixedwidth">wayfURL</span>
353                                                 </dd><dd class="value"><p>This field must be set to InQueue's simple WAYF at <span class="fixedwidth">https://wayf.internet2.edu/InQueue/WAYF</span>.</p></dd><dd class="attribute"><span class="fixedwidth">[policies]</span>
354                                                 </dd><dd class="value"><p>This section must contain <span class="fixedwidth">InQueue = urn:mace:inqueue</span>, and may
355                                                 contain other federation name/value pairs as well.</p></dd>
356                                         </dl>
357                                 </blockquote>
358
359                                 <blockquote><h5>4.b.i. Refreshing Federation Metadata:</h5>
360                                         <p>Once your target site is accepted into the InQueue federation, it is necessary that you periodically
361                                         update the target's federation metadata.  This metadata includes information used to identify and authenticate
362                                         InQueue sites.</p>
363                                         
364                                         <p>InQueue's metadata is digitally signed, so the first step is to obtain the InQueue signing certificate.  
365                                         It can be downloaded from <span class="fixedwidth">http://wayf.internet2.edu/InQueue/internet2.pem
366                                         </span> and has a fingerprint of:</p>
367                                         <p><span class="fixedwidth">b4 42 6c 1e 8b 7d 8e b3 68 03 00 e4 c4 57 dd 74 89 f8 9a 80</span>.</p>
368
369                                         <p>The following commands can be used to obtain the federation's metadata:</p>
370                                         <p><span class="fixedwidth"> $ cd /opt/shibboleth/etc/shibboleth</span></p>
371                                         <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/sites.xml
372                                                 --out sites.xml --cert internet2.pem</span></p>
373                                                 <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/trust.xml 
374                                                         --out trust.xml --cert internet2.pem</span></p>
375                                 </blockquote>
376
377                                 <h4>5.  Testing</h4>
378                                 <blockquote><p>A <a href="https://wayf.internet2.edu/shibboleth/sample.jsp">sample shibboleth target</a>
379                                         is available for testing newly installed origin sites.  New targets can make use of a sample origin, 
380                                         which is listed as "Example State University" on the InQueue WAYF ( Username: demo / Password: demo ).</p></blockquote>
381
382                 </body></html>
383