1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
10 background-color: #FFFFFF;
28 background-color: #DDDDDD;
29 background-image: none;
33 border-bottom-width: 2px;
34 border-top-width: 2px;
35 border-left-width: 2px;
36 border-right-width: 2px;
40 background-color: #DDDDDD;
41 background-image: none;
47 background-color: #DDDDDD;
48 background-image: none;
57 background-color: #DDDDDD;
58 border: 1px black inset;
59 background-image: none;
67 background-color: #EEEEEE;
68 background-image: none;
70 padding-bottom: 0.5em;
74 border-bottom-width: none;
75 border-top-width: none;
76 border-left-width: 1px;
77 border-right-width: 1px;
84 background-color: #BCBCEE;
85 border: 1px black inset;
86 background-image: none;
94 background-color: #DDDDFF;
95 background-image: none;
97 padding-bottom: 0.5em;
101 border-bottom-width: none;
102 border-top-width: none;
103 border-left-width: 1px;
104 border-right-width: 1px;
111 background-color: #DDDDDD;
112 border: 1px black inset;
113 background-image: none;
122 background-color: #BCBCEE;
123 border: 1px black inset;
124 background-image: none;
130 background-color: #EEEEEE;
135 font-family: monospace;
140 </style></head><body link="red" vlink="red" alink="black" bgcolor="white">
141 InQueue Federation Policy and Configuration Guidelines<br>
145 <h3>InQueue Federation Policy and Configuration Guidelines</h3>
147 <h4>1. Introduction to InQueue</h4>
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>
155 <li>maintenance and distribution of participating site description and
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>
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
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>
175 <h4>2. InQueue Policies</h4>
177 <h4>2.1 Participation</h4>
179 <blockquote><p>An organization may join InQueue as an origin, as a
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>
185 <p>InQueue is intended to serve as a primary federation
186 for an organization only during the period an
187 organization is learning about Shibboleth and federated
188 operations. Upon completion of this period, the
189 organization is expected to join a Federation (or some
190 other management solution) that meets its long-term
191 operational needs. </p>
193 <p>By joining InQueue, an organization agrees that the
194 Federation can list their name on the Federation web
195 site as a member of the Federation.</p>
197 <p>In joining InQueue, an organization will make a good
198 faith effort to maintain a web page describing their use
199 of Shibboleth. This page will be linked from the
200 Federation member list.</p>
204 <h4>2.2 Data management</h4>
207 By participating, origins agree that all attributes sent
208 to targets in the Federation to the best of their knowledge accurately
209 represent information about the authenticated individual accessing the
212 <p>Targets agree to dispose of all received
213 attributes properly by not mis-using them, aggregating them, or
214 sharing them with other organizations.</p></blockquote>
216 <h4>2.3 Security management</h4>
218 <blockquote><p>InQueue distributes a set of root certificates for
219 issuers from which server certificates may be obtained to identify
220 InQueue server components.
221 Additionally, sites with certificates not rooted
222 in one of these trusted roots may have these certificates added to the
223 appropriate trust file. Targets must have a certificate signed by an
224 acceptible CA. The list of certificate authorities used by
227 <li><a href="http://www.verisign.com/">Verisign/RSA Secure Server CA</a></li>
228 <li><a href="http://bossie.doit.wisc.edu/cert/i2server">Internet2
229 HEPKI Test CA</a></li>
230 <li><a href="http://www.cren.net/crenca/">CREN CA</a></li>
233 <p>For origins, OpenSSL must also be configured to use the
234 appropriate set of trusted roots for the issuance of SSL
235 certificates that Shibboleth trusts. For InQueue, this list may
236 be obtained from <span
237 class="fixedwidth">http://wayf.internet2.edu/InQueue/ca-bundle.
238 crt</span>. This list should then be copied for <span
239 class="fixedwidth">mod_ssl</span>, which will typically need to
241 class="fixedwidth">/conf/ssl.crt/ca-bundle.crt</span>. This
242 list of CA's is <b>not</b> rigorous nor secure and may contain
243 CA's which have no level of assurance or are questionable.</p>
246 <h4>2.4 Attributes</h4>
247 <blockquote><p>The InQueue
248 Federation specifies a set of attribute definitions to support basic
249 attribute-based authorization.</p>
251 <li>If a Federation member sends or receives an Attribute Assertion
252 containing the InQueue policy uri and referencing one of the listed
254 the syntax and semantics of the associated attribute value should
256 to the definitions specified in the <a href="http://www.educause.edu/eduperson/">EduPerson specification 2002/10</a>
259 <li>eduPersonPrincipalName</li>
260 <li>eduPersonEntitlement</li>
261 <li>eduPersonAffiliation (expressed in a slightly different form via
262 a new attribute called eduPersonScopedAffiliation)</li>
264 <li>If a Federation member sends or receives an Attribute Assertion
265 containing the InQueue policy uri and referencing one of the listed
267 the syntax and semantics of the associated attribute value should
269 to the definitions specified in the relevant <a href="http://www/ietf.org">IETF</a> RFCs.
283 <li>preferredLanguage
287 <li>facsimileTelephoneNumber
296 <li>physicalDeliveryOfficeName
298 <li>If a Federation member sends or receives an eduPersonEntitlement Attribute Assertion
299 containing the InQueue policy uri and containing one of the listed
301 the syntax and semantics of the associated attribute value should
306 <li>urn:mace:incommon:entitlement:common:1
307 <p>The person possesses an eduPersonAffiliation value of faculty, staff, or student, or qualifies as a "library walk-in".
313 <h4>3. Joining InQueue</h4>
315 <blockquote><p>To join InQueue, origins <a href="mailto:inqueue-support@internet2.edu?subject=Shib%20Origin%20Site%%0D%20%2020Application"> submit a request to
316 inqueue-support@internet2.edu</a> containing the following
317 information:</p></blockquote>
321 <li>Domain Name of the origin site (e.g., Ohio State's is
323 <li>Complete URL to access the Shibboleth Handle Service at the site.</li>
324 <li>The CN (usually the hostname) of the HS's certificate's subject.
325 This should also be the value of <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.
326 HandleServlet.issuer</span> in <span class="fixedwidth">origin.properties</span>.</li>
327 <li>Any shorthand aliases the WAYF should support for the origin
328 site (e.g., Ohio State, OSU, Buckeyes)</li>
329 <li>Contact names and addresses for technical and administrative
331 <li>The URL of an error page that users selecting this origin from
332 the WAYF may be referred to by targets if Shibboleth
333 malfunctions. (optional)</li>
334 <li>If the HS's certificate is not issueed by one of the root CAs
336 by InQueue, then it must be submitted in Base64-encoded DER (aka
338 <li>(optional) Briefly describe the organization's planned uses of Shibboleth.
341 <blockquote><p>To join InQueue, targets must <a href="mailto:inqueue-support@internet2.edu?subject=Shib%20Target%20Site%%0D%20%2020Application"> submit a basic application to
342 inqueue-support@internet2.edu</a> containing the following
343 information:</p></blockquote>
347 <li>The name of the organization</li>
348 <li>Contact names and addresses for both administrative and
349 technical purposes</li>
353 <h4>4. Configuration for Using InQueue</h4>
355 <blockquote><p>Once your site is accepted into and added to InQueue,
356 the following configuration parameters must be entered to ensure
357 interoperability and compliance with federation guidelines. Consult
358 the Shibboleth Deploy Guides for further information on these fields
359 and on <span class="fixedwidth">origin.properties</span> and <span class="fixedwidth">shibboleth.ini</span>.</p></blockquote>
361 <blockquote><h5>4.a. Origins:</h5>
363 <dl><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName</span>
364 </dd><dd class="value"><p>Must be populated with a URI that will
365 be assigned by InQueue when you are accepted into the
366 federation.</p></dd><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.audiences</span>
367 </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>
370 <blockquote><h5>4.b. Targets:</h5>
372 <dl><dd class="attribute"><span class="fixedwidth">wayfURL</span>
373 </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>
374 </dd><dd class="value"><p>This section must contain <span class="fixedwidth">InQueue = urn:mace:inqueue</span>, and may
375 contain other federation name/value pairs as well.</p></dd>
379 <blockquote><h5>4.b.i. Refreshing Federation Metadata:</h5>
380 <p>Once your target site is accepted into the InQueue federation, it is necessary that you periodically
381 update the target's federation metadata. This metadata includes information used to identify and authenticate
384 <p>InQueue's metadata is digitally signed, so the first step is to obtain the InQueue signing certificate.
385 It can be downloaded from <span class="fixedwidth">http://wayf.internet2.edu/InQueue/internet2.pem
386 </span> and has a fingerprint of:</p>
387 <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>
389 <p>The following commands can be used to obtain the federation's metadata:</p>
390 <p><span class="fixedwidth"> $ cd /opt/shibboleth/etc/shibboleth</span></p>
391 <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/sites.xml
392 --out sites.xml --cert internet2.pem</span></p>
393 <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/trust.xml
394 --out trust.xml --cert internet2.pem</span></p>
398 <blockquote><p>A <a href="https://wayf.internet2.edu/shibboleth/sample.jsp">sample shibboleth target</a>
399 is available for testing newly installed origin sites. New targets can make use of a sample origin,
400 which is listed as "Example State University" on the InQueue WAYF ( Username: demo / Password: demo ).</p></blockquote>