Renamed targetedId
[java-idp.git] / doc / DEPLOY-GUIDE-ORIGIN.html
1 <!doctype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3
4 <head>
5 <meta http-equiv="Content-Language" content="en-us">
6 <title>Shibboleth Origin Deployment Guide</title>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8 <style type="text/css">
9
10 html
11 {       
12 background-color: #FFFFFF;
13 color: #000000;
14 margin: .5em;
15 }
16 a:visited
17 {
18 color: #999999;
19 }
20 a:link
21 {
22 color: #990000;
23 }
24 a:active
25 {
26 color: #440000;
27 }
28 a.fixedlink:visited
29 {
30 font-family: monospace;
31 font-size: 90%;
32 color: #121212;
33 text-decoration: none;
34 }
35 a.fixedlink:link
36 {
37 font-family: monospace;
38 font-size: 90%;
39 color: #121212;
40 text-decoration: none;
41 }
42 a.fixedlink:active
43 {
44 font-family: monospace;
45 font-size: 90%;
46 color: #121212;
47 text-decoration: none;
48 }
49 dl
50 {
51 border-width:2px; background-color: #DDDDDD;
52 background-image: url('none');
53 margin: 5px;
54 padding: 0px;
55 border-style: solid;
56 }
57 dt
58 {
59 background-color: #DDDDDD;
60 background-image: url('none');
61 margin: 1px;
62 padding: 1px
63 }
64 dd
65 {
66 background-color: #DDDDDD;
67 background-image: url('none');
68 margin: 0px;
69 padding: 1px
70 }
71 .attribute
72 {
73 font-size: 115%;
74 font-color: #000000;
75 text-align: left;
76 background-color: #DDDDDD;
77 border: 1px inset black;
78 background-image: url('none');
79 margin: 0px;
80 padding: 2px
81 }
82 .value
83 {
84 font-color: #000000;
85 text-align: left;
86 background-color: #EEEEEE;
87 background-image: url('none');
88 padding-top: 0em;
89 padding-bottom: 0.5em;
90 padding-right: 1em;
91 padding-left: 5em;
92 border-bottom-width: none;
93 border-top-width: none;
94 border-left-width: 1px;
95 border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
96 }
97 .mandatory
98 {
99 font-color: #000000;
100 background-color: #FFCCFF;
101 }
102 .attributelong
103 {
104 font-size: 85%;
105 font-color: #000000;
106 text-align: left;
107 background-color: #DDDDDD;
108 border: 1px inset black;
109 background-image: url('none');
110 margin: 0px;
111 padding: 2px
112 }
113 .demo
114 {
115 background-color: #EEEEEE;
116 padding: 3px;
117 }
118 .fixed
119 {
120 font-family: monospace;
121 font-size: 90%;
122 font-color: #121212;
123 }
124 .feature
125 {
126 color: #00FF00
127 }
128  </style>
129 </head>
130
131 <body link="red" vlink="red" alink="black" bgcolor="white">
132
133 <center>
134 <h2>Shibboleth Origin Deployment Guide</h2>
135 </center>
136 <p>Shibboleth Origin Deployment Guide<br>
137 Shibboleth Version 1.2<br>
138 April 14, 2004<br>
139 <h3>This version of the deploy guide is for Shibboleth v1.2. For documentation 
140 related to prior versions of Shibboleth, please consult the appropriate branch 
141 in the Shibboleth CVS.</h3>
142 <h3>The default configuration of Shibboleth is <b>not</b> secure and should not
143 be used for protection of production content.  The example private key bundled
144 with the distribution is publically available, widely circulated, and
145 well-known; also, the default federation and trust metadata is for testing
146 purposes only.  For information about securing a Shibboleth deployment, please
147 refer to the production guide.  Shibboleth should only be used to protect
148 sensitive content when deployed carefully in conjunction with proper trust
149 settings and policies.</h3>
150
151 <p>Insert features here.</p>
152
153 <p>Before starting, please sign up for all applicable
154 <a href="http://shibboleth.internet2.edu/shib-misc.html#mailinglist">mailing 
155 lists</a>. Announcements pertinent to Shibboleth deployments and developments 
156 and resources for deployment assistance can be found here.</p>
157 <p>Please send any questions, concerns, or eventual confusion to
158 <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>. 
159 This should include, but not be limited to, questions about the documentation, 
160 undocumented problems, installation or operational issues, and anything else 
161 that arises. Please ensure that you have the
162 <a href="http://shibboleth.internet2.edu/release/shib-download.html">appropriate 
163 .tarball</a> for your operating system.</p>
164 <p><br>
165 </p>
166 <hr>
167 <p><br>
168 <br>
169 </p>
170 <h3><a name="TOC"></a>Shibboleth Origin -- Table of Contents</h3>
171 <p><br>
172 </p>
173 <ol type="1">
174     <li>
175     <h4><a href="#1."><font color="black">Shibboleth Overview</font></a></h4>
176     <ol type="a">
177         <li><a href="#1.a."><font color="black">Origin</font></a></li>
178         <li><a href="#1.b."><font color="black">Target</font></a></li>
179         <li><a href="#1.c."><font color="black">WAYF</font></a></li>
180         <li><a href="#1.d."><font color="black">Federations</font></a></li>
181         <li><a href="#1.e."><font color="black">Relying Parties and Applications</font></a></li>
182         <li><a href="#1.f."><font color="black">Sessions</font></a></li>
183     </ol>
184     </li>
185     <li>
186     <h4><a href="#2."><font color="black">Planning</font></a></h4>
187     <ol type="a">
188         <li><a href="#2.a."><font color="black">Requirements</font></a></li>
189         <li><a href="#2.b."><font color="black">Join a Federation</font></a></li>
190         <li><a href="#2.c."><font color="black">Security Considerations</font></a></li>
191         <li><a href="#2.d."><font color="black">Server Certs</font></a></li>
192         <li><a href="#2.e."><font color="black">Attribute Release Policies</font></a></li>
193         <li><a href="#2.f."><font color="black">Designate Contacts</font></a></li>
194         <li><a href="#2.g."><font color="black">Browser Requirements</font></a></li>
195         <li><a href="#2.h."><font color="black">Clocks</font></a></li>
196         <li><a href="#2.i."><font color="black">Other Considerations</font></a></li>
197     </ol>
198     </li>
199     <li>
200     <h4><a href="#3."><font color="black">Installation</font></a></h4>
201     <ol type="a">
202         <li><a href="#3.a."><font color="black">Software Requirements</font></a></li>
203         <li><a href="#3.b."><font color="black">Deploy HS and AA</font></a></li>
204     </ol>
205     </li>
206     <li>
207     <h4><a href="#4."><font color="black">Getting Running</font></a></h4>
208     <ol type="a">
209         <li><a href="#4.a."><font color="black">Basic Configuration</font></a>
210         <ol type="i">
211             <li><a href="#4.a.i"><font color="black">Modifying the default 
212             Attribute Resolver configuration</font></a></li>
213         </ol>
214         </li>
215         <li><a href="#4.b."><font color="black">Key Generation and Certificate 
216         Installation</font></a> </li>
217         <li><a href="#4.c."><font color="black">Linking the Authentication 
218         System to the HS</font></a>
219         <ol type="i">
220             <li><a href="#4.c.i."><font color="black">Enabling client 
221             certificate authentication</font> <font color="#5555EE">(optional)</font></a></li>
222         </ol>
223         </li>
224         <li><a href="#4.d."><font color="black">Establishing default ARP&#39;s for 
225         the origin community</font></a></li>
226     </ol>
227     </li>
228     <li>
229     <h4><a href="#5."><font color="black">Advanced Configuration</font></a></h4>
230     <ol type="a">
231         <li><a href="#5.a."><font color="black"><span class="fixed">
232         origin.xml</span></font></a></li>
233         <li><a href="#5.b."><font color="black">ARP Overview</font></a>
234         <ol type="i">
235             <li><a href="#5.b.i."><font color="black">ARP Processing</font></a></li>
236             <li><a href="#5.b.ii."><font color="black">ARP Syntax</font></a></li>
237         </ol>
238         </li>
239         <li><a href="#5.c."><font color="black">Sharing certificate/key pairs 
240         between Apache and Java keystores</font> <font color="#5555EE">
241         (optional)</font></a></li>
242         <li><a href="#5.d."><font color="black">The Attribute Resolver</font></a>
243         <ol type="i">
244             <li><a href="#5.d.i."><font color="black"><span class="fixed">
245             resolvertest</span></font></a></li>
246         </ol>
247         </li>
248         <li><a href="#5.e."><font color="black">Local Error Page</font></a></li>
249         
250         <li><a href="#5.f."><font color="black">Using a New Attribute</font></a></li>
251         
252     </ol>
253     </li>
254     <li>
255     <h4><a href="#6."><font color="black">Troubleshooting</font></a></h4>
256     <ol type="a">
257         <li><a href="#6.a."><font color="black">Basic Testing</font></a></li>
258         <li><a href="#6.b."><font color="black">Logging</font></a></li>
259         <li><a href="#6.c."><font color="black">Common Problems</font></a></li>
260     </ol>
261     </li>
262 </ol>
263 <p><br>
264 </p>
265 <hr>
266 <p><br>
267 </p>
268 <h3><a name="1."></a>1. Shibboleth Overview</h3>
269 <p>Shibboleth is a system designed to exchange attributes across realms for the 
270 primary purpose of authorization. It provides a secure framework for one 
271 organization to transmit attributes about a web-browsing individual across 
272 security domains to another institution. In the primary usage case, when a user 
273 attempts to access a resource at a remote domain, the user&#39;s own home security 
274 domain can send certain information about that user to the target site in a 
275 trusted exchange. These attributes can then be used by the resource to help 
276 determine whether to grant the user access to the resource. The user may have 
277 the ability to decide whether to release specific attributes to certain sites by 
278 specifying personal Attribute Release Policies (ARP&#39;s), effectively preserving 
279 privacy while still granting access based on trusted information.</p>
280 <p>When a user first tries to access a resource protected by Shibboleth, they 
281 are redirected to a service which asks the user to specify the organization from 
282 which they want to authenticate. If the user has not yet locally authenticated 
283 to a WebISO service, the user will then be redirected to their home 
284 institution&#39;s authentication system. After the user authenticates, the 
285 Shibboleth components at the local institution will generate a temporary 
286 reference to the user, known as a handle, for the individual and send this to 
287 the target site. The target site can then use the handle to ask for attributes 
288 about this individual. Based on these attributes, the target can decide whether 
289 or not to grant access to the resource. The user may then be allowed to access 
290 the requested materials.</p>
291 <p>There are several controls on privacy in Shibboleth, and mechanisms are 
292 provided to allow users to determine exactly which information about them is 
293 released. A user&#39;s actual identity isn&#39;t necessary for many access control 
294 decisions, so privacy often is needlessly compromised. Instead, the resource 
295 often utilizes other attributes such as faculty member or member of a certain 
296 class. While these are commonly determined using the identity of the user, 
297 Shibboleth provides a way to mutually refer to the same principal without 
298 revealing that principal&#39;s identity. Because the user is initially known to the 
299 target site only by a randomly generated temporary handle, if sufficient, the 
300 target site might know no more about the user than that the user is a member of 
301 the origin organization. This handle should never be used to decide whether or 
302 not to grant access, and is intended only as a temporary reference for 
303 requesting attributes.</p>
304 <h4><a name="1.a."></a>1.a. Origin</h4>
305 <blockquote>
306     <p>There are four primary components to the origin side in Shibboleth: the 
307     Attribute Authority (AA), the Handle Service (HS), the directory service, 
308     and the local sign-on system (SSO). The AA and HS are provided with 
309     Shibboleth, and an open-source WebISO solution, Pubcookie, can be obtained 
310     from www.pubcookie.org; the directory is provided by the origin site. 
311     Shibboleth is able to interface with a directory exporting an LDAP interface 
312     containing user attributes, and is designed such that programming interfaces 
313     to other repositories should be readily implemented. Shibboleth relies on 
314     standard web server mechanisms to trigger local authentication. A .htaccess 
315     file can be easily used to trigger either the local WebISO system or the web 
316     server&#39;s own Basic Auth mechanism, which will likely utilize an enterprise 
317     authentication system, such as Kerberos.</p>
318     <p>From the origin site&#39;s point of view, the first contact will be the 
319     redirection of a user to the handle service, which will then consult the SSO 
320     system to determine whether the user has already been authenticated. If not, 
321     then the browser user will be asked to authenticate, and then sent back to 
322     the target URL with a handle bundled in an attribute assertion. Next, a 
323     request from the Shibboleth Attribute Requester (SHAR) will arrive at the AA 
324     which will include the previously mentioned handle. The AA then consults the 
325     ARP&#39;s for the directory entry corresponding to the handle, queries the 
326     directory for these attributes, and releases to the SHAR all attributes the 
327     SHAR is entitled to know about that user.</p>
328 </blockquote>
329 <h4><a name="1.b."></a>1.b. Target</h4>
330 <blockquote>
331     <p>There are three primary components to the target side in Shibboleth: the 
332     Shibboleth Indexical Reference Establisher (SHIRE), the Shibboleth Attribute 
333     Requester (SHAR), and the resource manager (RM). An implementation of each 
334     of these is included in the standard Shibboleth distribution. These 
335     components are intended to run on the same web server.</p>
336     <p>From the target&#39;s point of view, a browser will hit the RM with a request 
337     for a Shibboleth-protected resource. The RM then allows the SHIRE to step 
338     in, which will use the WAYF to acquire the name of a handle service to ask 
339     about the user. The handle service (HS) will then reply with a SAML 
340     authentication assertion containing a handle, which the SHIRE then hands off 
341     to the SHAR. The SHAR uses the handle and the supplied address of the 
342     corresponding attribute authority (AA) to request all attributes it is 
343     allowed to know about the handle. The SHAR performs some basic validation 
344     and analysis based on attribute acceptance policies (AAP&#39;s). These 
345     attributes are then handed off to the RM, which is responsible for using 
346     these attributes to decide whether to grant access.</p>
347 </blockquote>
348 <h4><a name="1.c."></a>1.c. Where are you from? (WAYF)</h4>
349 <blockquote>
350     <p>The WAYF service can be either outsourced and operated by a federation or 
351     deployed as part of the SHIRE. It is responsible for allowing a user to 
352     associate themself with an institution of their specification, then 
353     redirecting the user to the known address for the handle service of that 
354     institution.</p>
355 </blockquote>
356 <h4><a name="1.d."></a>1.d. Federations</h4>
357 <blockquote>
358     <p>A Shibboleth federation provides part of the underlying trust required 
359     for function of the Shibboleth architecture. A federation is a group of 
360     organizations(universities, corporations, content providers, etc.) who agree 
361     to exchange attributes using the SAML/Shibboleth protocols and abide by a 
362     common set of policies and practices. In so doing, they must implicitly or 
363     explicitly agree to a common set of guidelines. Joining a federation is not 
364     explicitly necessary for operation of Shibboleth, but it dramatically 
365     expands the number of targets and origins that can interact without defining 
366     bilateral agreements between all these parties.</p>
367     <p>A federation can be created in a variety of formats and trust models, but 
368     must provide a certain set of services to federation members. It needs to 
369     supply a registry to process applications to the federation and distribute 
370     membership information to the origin and target sites. This must include 
371     distribution of the PKI components necessary for trust between origins and 
372     targets. There also needs to be a set of agreements and best practices 
373     defined by the federation governing the exchange, use, and population of 
374     attributes before and after transit, and there should be a way to find 
375     information on local authentication and authorization practices for 
376     federation members.</p>
377 </blockquote>
378 <h4><a name="1.e."></a>1.e. Relying Parties and Applications</h4>
379 <blockquote>
380     <p>A Shibboleth relying party represents a target or set of targets that
381     operate under one trust agreement and share common key, certificate, and
382     certificate authority guidelines.  This could include any number of
383     individual SHAR's and applications.  Frequently, an entire federation will
384     be viewed by an origin or target as a single relying party; however, there
385     is no necessary binding between these.  An individual site with which an
386     origin or target exchanges information may sometimes be part of multiple
387     relying parties if there are multiple trust agreements under which these
388     transactions are performed.</p>
389     <p>Applications as viewed from Shibboleth are not necessarily defined by the
390     same metrics as in other contexts.  An individual application represents a
391     service or set of services that operates using the same attribute and trust
392     features and shares common <a href="#1.f.">Shibboleth sessions</a>. 
393     Attributes are released to targets on the basis of individual applications
394     within the context of its containing relying party.  An application may span
395     multiple URL trees, servers, or SHAR's, depending on the architecture of the
396     service.  However, every application must be contained within a single
397     relying party; applications cannot span relying parties.  Each application
398     is assigned an individual application identifier URN which must be
399     recognized by both the origin and the target.</p>
400 </blockquote>
401 <h4><a name="1.f."></a>1.f. Sessions</h4>
402 <blockquote>
403     <p>There are many different types of sessions that can be established within
404     the context of the access of a Shibboleth-protected resource.  It is
405     important to note that these are all independent and distinct: any session
406     can exist with or without any other session, and the expiration of any one
407     session does not imply the expiration of any other session.  Shibboleth does
408     not support any logout functionality.</p>
409     <p>The successful access of a Shibboleth-protected resource by a browser
410     user may have two outcomes.  The standard session establishment mechanism in
411     which Shibboleth protects the resource in all circumstances results in the
412     establishment of two sessions. Shibboleth 1.2 also supports so-called lazy
413     session establishment, in which the resource may be accessed without first
414     providing a home institution or obtaining attributes.  This means the
415     application must be intelligent enough to determine whether an attribute
416     request or any other aspect of Shibboleth functionality is necessary, and
417     then construct proper URL's to initiate these flows; if the application
418     determines none is necessary or uses other authorization mechanisms, then an
419     attribute request does not need to be triggered.  This complex functionality
420     is mostly useful to protect a single URL with different access mechanisms,
421     or to require attribute requests only in the instance where the application
422     deems it necessary.</p>
423     <p>In either situation, before the resource is presented, a Shibboleth
424     session is established between the browser and the Shibboleth module,
425     represented by a cookie.  A separate session for the attribute release
426     interaction with the origin results in the caching of a set of attributes
427     pertaining to that browser user.  The expiration of either session implies
428     the need to re-initiate only that session and does not imply the
429     re-initiation of the other; for example, although a browser user's
430     Shibboleth session has expired, if there is a valid set of cached
431     attributes, there need not be another attribute query when they next access
432     this resource.</p>
433     <p>Independently of this, a web-based application protected by Shibboleth
434     may have a need to establish its own session with the user.  This session
435     may persist well beyond either Shibboleth session, and logouts from this
436     session, if supported, will not terminate Shibboleth sessions initiated to
437     access the resource.  Application administrators should carefully evaluate
438     the expiration of all sessions to limit vulnerability to attacks or user
439     negligence.</p>
440 </blockquote>
441 <hr>
442 <h3><a name="2."></a>2. Planning</h3>
443 <p>There are several essential elements that must be present in the environment 
444 to ensure Shibboleth functions well, both political and technical. Shibboleth is 
445 entirely written in Java on the origin side. These are the recommendations and 
446 requirements for a successful implementation of a Shibboleth origin.</p>
447 <h4><a name="2.a."></a>2.a. Requirements</h4>
448 <ul>
449     <li>A common institutional directory service should be operational; 
450     Shibboleth comes with LDAP capabilities built in, and the Attribute 
451     Authority has a Java API which will allow specification of interfaces with 
452     legacy directories. This is discussed further in <a href="#4.d.">section 4.d</a>.</li>
453     <li>A method to authenticate browser users must be in place, preferably in 
454     the form of an enterprise authentication service. Some form of an SSO or a 
455     WebISO service is not explicitly necessary for Shibboleth; however, it is 
456     highly recommended. Implementation details of this are discussed in
457     <a href="#4.c.">section 4.c</a>.</li>
458     <li>Shibboleth is known to work on Linux and Solaris, but should function on 
459     any platform that has a Tomcat implementation.</li>
460     <li>It is recommended that a web server must be deployed that can host Java 
461     servlets and Tomcat, although not explicitly necessary, as Tomcat can still 
462     host an origin without it.</li>
463 </ul>
464 <h4><a name="2.b."></a>2.b. Join a Federation</h4>
465 <blockquote>
466     <p>While it is not necessary for a target or origin to join a federation, 
467     doing so greatly facilitates the implementation of multilateral trust 
468     relationships. Each federation will have a different application process. 
469     When an origin is accepted into a federation, its information is added to 
470     the sites file used by the WAYF and target sites.</p>
471     <p><b>It may be necessary to join multiple federations depending on the 
472     sites with whom you wish to exchange attributes and the terms under which 
473     these interactions will take place. An origin site exists within the context 
474     of a single federation, while a single target may accept assertions issued 
475     by multiple federations if they are all recognized by the SHAR.</b></p>
476     <p>Attribute release and acceptance policies, the use and caching of 
477     attributes, and definition of commonly traded attributes are examples of 
478     specifications a federation may make. For more information on federations, 
479     please refer to the Deployer&#39;s Guide to Federations and the Shibboleth v1.0 
480     architectural document.</p>
481 </blockquote>
482 <h4><a name="2.c."></a>2.c. Security Considerations</h4>
483 <blockquote>
484     <p>Shibboleth&#39;s protocols and software have been extensively engineered to 
485     provide protection against many attacks. However, the most secure protocol 
486     can be compromised if it is placed in an insecure environment. To ensure 
487     Shibboleth is as secure as possible, there are several recommended security 
488     precautions which should be in place at local sites.</p>
489     <ol type="i">
490         <li>SSL use is optional for origin sites. Federation guidelines should 
491         be considered when determining whether to implement SSL, and, in 
492         general, SSL should be used for interactions with client machines to 
493         provide the necessary authentication and encryption to ensure protection 
494         from man-in-the-middle attacks. It is strongly suggested that all 
495         password traffic or similarly sensitive data should be SSL-protected. 
496         Assessment of the risk tradeoff against possible performance degradation 
497         should be performed for all applications.</li>
498         <li>Many other attacks can be made on the several redirection steps that 
499         Shibboleth takes to complete attribute transfer. The best protection 
500         against this is safeguarding the WAYF service and ensuring that rogue 
501         targets and origins are not used, generally by development of the trust 
502         model underneath Shibboleth. Shibboleth also leverages DNS for security, 
503         which is not uncommon, but attacks concerning bad domain information 
504         should be considered.</li>
505         <li>Information regarding origin users is generally provided by the 
506         authoritative enterprise directory, and the acceptance of requests from 
507         target applications can be carefully restricted to ensure that all 
508         requests the SHAR performs are authorized and all information the origin 
509         provides is accurate. Proper security measures should also be in place 
510         on directory access and population(see
511         <a href="http://www.georgetown.edu/giia/internet2/ldap-recipe/#AccessControl">
512         Access Control</a> in the
513         <a href="http://www.georgetown.edu/giia/internet2/ldap-recipe/">LDAP 
514         recipe</a> for more information). Use of plaintext passwords is strongly 
515         advised against.</li>
516         <li>Server platforms should be properly secured, commensurate with the 
517         level that would be expected for a campus&#39; other security services, and 
518         cookie stores on client machines should be well protected.</li>
519     </ol>
520 </blockquote>
521 <h4><a name="2.d."></a>2.d. Server Certs</h4>
522 <blockquote>
523     <p>In the Shibboleth architecture, the SHIRE, SHAR, HS, and AA must all have 
524     various client and/or server certificates for use in signing assertions and 
525     creating SSL channels. These should be issued by a commonly accepted CA, 
526     which may be stipulated by some Federation rules. Different federations may 
527     require the use of different CA&#39;s.</p>
528 </blockquote>
529 <h4><a name="2.e."></a>2.e. Attribute Release Policies</h4>
530 <blockquote>
531     <p>The Attribute Authority maintains a set of policies called Attribute 
532     Release Policies (or ARP&#39;s) that govern the sharing of user attributes with 
533     Shibboleth target sites. When a user attempts to access a 
534     Shibboleth-protected resource, that resource&#39;s SHAR queries the user&#39;s AA 
535     for all attributes to which it is entitled. The SHAR provides its own name 
536     and the URL of the resource on behalf of which it is making the request. The 
537     AA finds the attributes associated with the browser user, determines an 
538     &quot;Effective ARP&quot; for this user, and then sends to the SHAR only the 
539     attributes/values allowed in this policy.</p>
540     <p>An ARP may be thought of as a sort of filter for outbound attributes; it 
541     cannot create attributes or data that aren&#39;t originally present, but it can 
542     limit the attributes released and the values those attributes may have when 
543     released. It does not change the information in the data sources in any way.</p>
544     <p>Each ARP is comprised of one or more rules that specify which attributes 
545     and values may be released to a target or set of targets. The assignment of 
546     rules to various targets is quite flexible and includes mechanisms for 
547     specifying: that a rule should affect all targets (default rule), exact SHAR 
548     names for which a rule is applicable, regular expressions against which SHAR 
549     names should be matched to determine if a rule is applicable, URL trees for 
550     which a rule is applicable.</p>
551     <p>For each request, an Effective ARP is determined by locating all ARP&#39;s 
552     applicable to the designated user and extracting each rule that matches the 
553     querying SHAR and resource. Attributes and values that are specified for 
554     release are included in the effective ARP, while those specified for denial 
555     are blocked from release. See section <a href="#5.b.i.">5.b.i</a> for 
556     details on how ARP&#39;s are processed.</p>
557     <p>Various ARP&#39;s may be combined in forming the Effective ARP. For instance, 
558     the Site ARP is administratively maintained and applies to all users for 
559     which the AA is answerable. User ARP&#39;s apply to a specific user only, and 
560     can be maintained either administratively or by the users themselves. All 
561     ARP&#39;s are specified using the same syntax and semantics.</p>
562 </blockquote>
563 <h4><a name="2.f."></a>2.f. Designate Contacts</h4>
564 <blockquote>
565     <p>Since Shibboleth deals both with daily technical and operational issues 
566     and also with contractual issues, a set of contacts should be set up to 
567     support the user base and to facilitate interactions with other Shibboleth 
568     sites and federation members. It is recommended that at least technical and 
569     administrative contacts be designated.</p>
570 </blockquote>
571 <h4><a name="2.g."></a>2.g. Browser Requirements</h4>
572 <blockquote>
573     <p>A primary Shibboleth design consideration was to require very little or 
574     no modification to client machines. The only requirement is that a browser 
575     is used which supports cookies, redirection and SSL. Browser users will have 
576     to perform an additional click to submit the authentication assertion if 
577     JavaScript is not functional.</p>
578 </blockquote>
579 <h4><a name="2.h."></a>2.h. Clocks</h4>
580 <blockquote>
581     <p><a href="http://www.eecis.udel.edu/~ntp/">NTP</a> should be run on all 
582     web servers. Shibboleth employs a short handle issuance time to protect 
583     against replay attacks. Because of this, any significant degree of clock 
584     skew can hinder the ability of users to access sites successfully.</p>
585 </blockquote>
586 <h4><a name="2.i."></a>2.i. Other Considerations</h4>
587 <blockquote>
588     <p>Especially for higher education, there are a handful of laws enacted 
589     which may have important ramifications on the disclosure of personal 
590     information and attributes. Since Shibboleth does not necessarily need to 
591     transmit identity, it is an ideal solution for many higher education 
592     situations. Nevertheless, all parties within the United States of America 
593     are strongly advised to consult the
594     <a href="http://www.ed.gov/offices/OM/fpco/ferpa/">Family Educational Rights 
595     and Privacy Act of 1974(FERPA)</a>, and all other relevant state and federal 
596     legislation before deploying Shibboleth.</p>
597 </blockquote>
598 <p><br>
599 <br>
600 </p>
601 <hr>
602 <p><br>
603 </p>
604 <h3><a name="3."></a>3. Installation</h3>
605 <h4><a name="3.a."></a>3.a. Software Requirements</h4>
606 <p><b>The following requirements are primarily recommendations based on the most 
607 common ways to run Shibboleth. However, the origin should be able to run under 
608 any servlet container supporting <span class="fixed">Servlet API v2.3</span> 
609 and <span class="fixed">JSP specification 1.2</span>.</b></p>
610 <blockquote>
611     <ul type="circle">
612         <li><a href="http://http://www.apache.org/dist/httpd/">Apache 1.3.26+ 
613         (&lt;2.0)</a></li>
614         <li><a href="http://jakarta.apache.org/tomcat/">Tomcat 4.1.18-24 LE Java 
615         server and above</a></li>
616         <li><a href="http://java.sun.com/j2se/">Sun J2SE JDK v1.4.1_01 and above</a>
617         <blockquote>
618             <p>Other versions of the JRE are not supported and are known to 
619             cause errors when working with certificates.</p>
620         </blockquote>
621         </li>
622         <li>mod_jk or mod_jk2
623         <blockquote>
624             <p>You may need to build mod_jk against Apache, which will generally 
625             require GCC or a platform-specific C compiler.</p>
626         </blockquote>
627         </li>
628         <li>An enterprise authentication mechanism
629         <blockquote>
630             <p>Ideally, this will be a WebISO or SSO system such as
631             <a href="http://pubcookie.org/">Pubcookie</a>. The minimal 
632             requirement is for the web server to be able to authenticate browser 
633             users and supply their identity to the Handle Server.</p>
634         </blockquote>
635         </li>
636         <li>An enterprise directory service
637         <blockquote>
638             <p>Shibboleth currently supports retrieving user attribute 
639             information from an <a href="http://www.openldap.org">LDAP</a> 
640             directory. For testing purposes, Shibboleth also supports a minimal 
641             echo responder which will always return pre-defined attributes.</p>
642         </blockquote>
643         </li>
644     </ul>
645 </blockquote>
646 <h4><a name="3.b."></a>3.b. Deploy HS and AA</h4>
647 <blockquote>
648     <ol type="1">
649         <li>Ensure you have already obtained the proper
650         <a href="http://shibboleth.internet2.edu/release/shib-download.html">.tarball</a>.</li>
651         <li>The archive will expand into a <span class="fixed">
652         shibboleth-origin-1.2/</span> directory(<span class="fixed">/opt/</span> 
653         recommended).</li>
654         <li>Run the following command to move the Java files into Tomcat&#39;s tree:<blockquote>
655             <p><span class="fixed">cp /opt/shibboleth-origin-1.2/dist/shibboleth.war 
656             /usr/local/tomcat/webapps/</span> </p>
657         </blockquote>
658         </li>
659         <li>Tomcat 4.1.x requires that several Java jarfiles used by Shibboleth 
660         be located in a special &quot;endorsed&quot; folder to override obsolete classes 
661         that Sun includes with their JVM. To deal with this problem use the 
662         following command, adjusting paths as needed:<blockquote>
663             <p><span class="fixed">$ cp 
664             /opt/shibboleth-origin-1.2/endorsed/*.jar /usr/local/tomcat/common/endorsed</span>
665             </p>
666         </blockquote>
667         <p>Different versions of Tomcat or other Java servers may have other 
668         locations in which to place these files or deal with this problem. Refer 
669         to your application server&#39;s documentation to find out how to properly 
670         endorse classes, if necessary.</li>
671         <li>Restart Tomcat, which will automatically detect that there has been 
672         a new .war file added. This file will by default be expanded into
673         <span class="fixed">/usr/local/tomcat/webapps/shibboleth</span>.</li>
674         <li>Apache must be told to map the URL&#39;s for the Shibboleth HS and AA to 
675         Tomcat. Two popular ways of doing this are to include the following text 
676         directly in <span class="fixed">httpd.conf</span>, or to place
677         <span class="fixed">Include conf/mod_jk.conf</span> in
678         <span class="fixed">httpd.conf</span>, and place the following 
679         lines in <span class="fixed">/etc/httpd/conf/mod_jk.conf</span>:<blockquote>
680             <p><span class="fixed">--------- begin ---------<br>
681             &lt;IfModule !mod_jk.c&gt;<br>
682             &nbsp;LoadModule jk_module libexec/mod_jk.so<br>
683             &lt;/IfModule&gt;<br>
684             <br>
685             JkWorkersFile &quot;/usr/local/tomcat/conf/jk/workers.properties&quot;<br>
686             JkLogFile &quot;/usr/local/apache/logs/mod_jk.log&quot;<br>
687             <br>
688             JkLogLevel emerg<br>
689             <br>
690             JkMount /shibboleth/* ajp13<br>
691             <br>
692             --------- end ---------</span> </p>
693         </blockquote>
694         </li>
695         <li>Tomcat&#39;s <span class="fixed">/conf/server.xml</span> ships by 
696         default with the Coyote/JK2 connector enabled, which fails with 
697         Shibboleth due to the lack of support for <span class="fixed">
698         REMOTE_USER</span>. This connector must be commented out. Then, 
699         uncomment and modify the traditional AJP 1.3 connector as follows:<ol type="A">
700             <li>Add <span class="fixed">address=&quot;127.0.0.1&quot;</span> inside 
701             the <span class="fixed">&lt;Ajp13Connector&gt;</span> configuration 
702             element to prevent off-host access.</li>
703             <li>Add <span class="fixed">tomcatAuthentication=&quot;false&quot;</span> 
704             to the <span class="fixed">&lt;Ajp13Connector&gt;</span> 
705             configuration element to ensure that the user&#39;s identity is passed 
706             from Apache to the servlet environment.</li>
707             <li>The AJP13Connector for tomcat is not compatible with the new JMX support.  To remove some warnings that will  appear in the tomcat log every time tomcat is restarted, comment out all of the JMX stuff (anything that says "mbeans") from server.xml.</li>
708         </ol>
709         </li>
710         <li>It is <b>strongly</b> recommended that the AA be SSL-protected to 
711         protect attributes in transit. To do so, add an appropriate location 
712         block to <span class="fixed">httpd.conf</span>:<blockquote>
713             <p><span class="fixed">&lt;Location /shibboleth/AA&gt; 
714             <br>&nbsp;SSLVerifyClient optional 
715             <br>&nbsp;SSLOptions +StdEnvVars +ExportCertData 
716                         <br>&lt;/Location&gt; </span></p>
717         </blockquote>
718         </li>
719     </ol>
720 </blockquote>
721 <p><br>
722 </p>
723 <hr>
724 <p><br>
725 </p>
726 <h3><a name="4."></a>4. Getting Running</h3>
727 <h4><a name="4.a."></a>4.a. Basic Configuration</h4>
728 <blockquote>
729     <p><b>This section of the deploy guide describes only the default <span
730     class="fixed">origin.xml</span> file and enumerates the essential
731     changes that need to be made to the configuration defaults for the origin to
732     function successfully in a federated environment. More complex configuration
733     will likely be required for many applications and federations; for a fully
734     defined example <span class="fixed">origin.xml</span> and definition of
735     every element and attribute that may be used, please refer to <a
736     href="#5.a.">section 5.a</a>.</b></p>
737     <p>The main configuration file for Shibboleth&#39;s origin side is located in
738     <span class="fixed">/webapps/shibboleth/WEB-INF/classes/conf/origin.xml</span>.
739     The configuration must be consistent with values elsewhere in the 
740     deployment, such as the <a href="#4.c.">HS&#39; certificate</a> and with 
741     directory access bindings, etc., or access errors may occur.</p>
742     <p>All pathnames are relative, and have an effective root path of
743     <span class="fixed">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>. 
744     To specify files outside of the webapp, specify a full URI, such as
745     <span class="fixed">file:///usr/local/shibboleth/</span>.</p>
746     <p>The following is a hyperlinked version of the basic configuration file,
747     followed by a list of elements and attributes that must be modified.  Click
748     on any attribute or element for more information on its population and
749     definition.</p>
750
751 <blockquote><span class="fixed">
752 &lt;?xml version=&quot;1.0&quot;encoding=&quot;UTF-8&quot;?&gt;<br>
753 <br>
754 <a href="#confShibbolethOriginConfig" class="fixedlink">&lt;ShibbolethOriginConfig <br>
755 &nbsp;&nbsp;&nbsp;xmlns=&quot;urn:mace:shibboleth:origin:1.0&quot;<br>
756 &nbsp;&nbsp;&nbsp;xmlns:cred=&quot;urn:mace:shibboleth:credentials:1.0&quot;<br>
757 &nbsp;&nbsp;&nbsp;xmlns:name=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
758 &nbsp;&nbsp;&nbsp;xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;<br>
759 &nbsp;&nbsp;&nbsp;xsi:schemaLocation=&quot;urn:mace:shibboleth:origin:1.0 origin.xsd&quot;<br>
760 &nbsp;&nbsp;&nbsp;AAUrl=&quot;http://therock.cc.columbia.edu:6666/shibboleth/AA&quot;<br>
761 &nbsp;&nbsp;&nbsp;defaultRelyingParty=&quot;urn:mace:inqueue&quot;<br>
762 &nbsp;&nbsp;&nbsp;providerId=&quot;urn:mace:inqueue:shibdev.edu&quot;&gt;</a><br>
763 <br>
764 <a href="#confRelyingParty" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;RelyingParty name=&quot;urn:mace:inqueue&quot; signingCredential=&quot;foo&quot;&gt;<br></a>
765 <a href="#confHSNameFormat" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;HSNameFormat nameMapping=&quot;crypto&quot;/&gt;</a><br>
766 <a href="#confRelyingParty" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;/RelyingParty&gt;</a><br>
767 <br>
768 <a href="#confReleasePolicyEngine" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;ReleasePolicyEngine&gt;<br></a>
769 <a href="#confArpRepository" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;ArpRepository implementation=&quot;edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository&quot;&gt;</a><br>
770 <a href="#confPath" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Path&gt;/conf/arps/&lt;/Path&gt;</a><br>
771 <a href="#confArpRepository" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/ArpRepository&gt;</a><br>
772 <a href="#confReleasePolicyEngine" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;/ReleasePolicyEngine&gt;</a><br>
773 <br>
774 &nbsp;&nbsp;&nbsp;&lt;!--<br>
775 <a href="#confLogging" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;Logging&gt;</a><br>
776 <a href="#confLog4JConfig" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Log4JConfig location=&quot;file:///tmp/log4j.properties&quot;/&gt;</a><br>
777 <a href="#confLogging" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;/Logging&gt;</a><br>
778 <a href="#confLogging" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;Logging&gt;</a><br>
779 <a href="#confErrorLog" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;ErrorLog level=&quot;DEBUG&quot; location=&quot;file:///tmp/shib-error.log&quot;/&gt;</a><br>
780 <a href="#confTransactionLog" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;TransactionLog location=&quot;file:///tmp/shib-access.log&quot;/&gt;</a><br>
781 <a href="#confLogging" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;/Logging&gt;</a><br>
782 &nbsp;&nbsp;&nbsp;--&gt;<br>
783 <br>
784 <a href="#confNameMapping" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;NameMapping <br>
785 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlns=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
786 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id=&quot;crypto&quot;<br>
787 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;format=&quot;urn:mace:shibboleth:1.0:nameIdentifier&quot;<br>
788 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;type=&quot;SharedMemoryShibHandle&quot;<br>
789 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;handleTTL=&quot;1800&quot;/&gt;</a><br>
790 <br>
791 <a href="#confCredentials" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;Credentials xmlns=&quot;urn:mace:shibboleth:credentials:1.0&quot;&gt;</a><br>
792 <a href="#confFileResolver" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;FileResolver Id=&quot;foo&quot;&gt;</a><br>
793 <a href="#confKey" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Key format=&quot;DER&quot;&gt;</a><br>
794 <a href="#confPath" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Path&gt;/conf/shib2.key&lt;/Path&gt;</a><br>
795 <a href="#confKey" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Key&gt;</a><br>
796 <a href="#confCertificate" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Certificate format=&quot;PEM&quot;&gt;</a><br>
797 <a href="#confPath" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Path&gt;/conf/shib2.crt&lt;/Path&gt;</a><br>
798 <a href="#confCertificate" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Certificate&gt;</a><br>
799 <a href="#confFileResolver" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/FileResolver&gt;</a><br>
800 <a href="#confCredentials" class="fixedlink">&nbsp;&nbsp;&nbsp;&lt;/Credentials&gt;</a><br>
801 <a href="#confFederationProvider" class="fixedlink">&nbsp;&nbsp;&nbsp;&nbsp;&lt;FederationProvider type=&quot;edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper&quot; uri=&quot;/conf/sites.xml&quot;/&gt;</a><br>
802 <br>
803 <a href="#confShibbolethOriginConfig" class="fixedlink">&lt;/ShibbolethOriginConfig&gt;</a>
804 </span></blockquote>
805
806 <p>The following changes must be made to the default configuration before the
807 origin will interoperate in a federation.</p>
808     <ol type="1">
809         <li> 
810         <p>Attributes within the <a href="#confShibbolethOriginConfig"><span
811         class="fixed">ShibbolethOriginConfig</span></a> element:</p>
812             <ol type="a">
813             <li><a href="#confShibbolethOriginConfig"><span class="fixed">AAUrl=<i>URL</i></span></a>
814             <blockquote>
815                 <p>This will be the URL assigned the AA servlet in step
816                 <a href="#3.b.">3.b</a>. Note that this <b>must</b> be an
817                 <span class="fixed">https://</span> URL in order for the AA to 
818                 authenticate the requesting SHAR.</p>
819             </blockquote>
820             </li>
821             <li><a href="#confShibbolethOriginConfig"><span class="fixed">providerID=<i>URN</i></span></a>
822             <blockquote>
823                 <p>This will be the URN assigned to this origin by the
824                 federation.</p>
825             </blockquote>
826             </li>
827             <li><a href="#confShibbolethOriginConfig"><span class="fixed">defaultRelyingParty=<i>URN</i></span></a>
828             <blockquote>
829                 <p>This is the URN of the primary federation that the origin
830                 operates within.</p>
831             </blockquote>
832             </li>
833             </ol>
834         </li>
835         <li> 
836         <p>Although not explicitly necessary, it's highly recommended for
837         initial installation and testing that logging be activated at the <span
838         class="fixed">DEBUG</span> level by uncommenting the second <a
839         href="#confLogging"><span class="fixed">Logging</span></a> element and
840         ensuring that the pathnames for <a href="#confTransactionLog"><span
841         class="fixed">TransactionLog</span></a> and <a
842         href="#confErrorLog"><span class="fixed">ErrorLog</span></a> are
843         appropriate.  However, in production, this will slow the operation of
844         the origin considerably.</p>
845         </li>
846         <li>
847         <p>The default configuration file informs Shibboleth to load its key and
848         certificate from flat files.  The <a href="#confKey"><span
849         class="fixed">Key</span></a> element specifies a key in <span
850         class="fixed">DER</span> format located at <span
851         class="fixed">/conf/shib2.key</span>, while the <a
852         href="#confCertificate"><span class="fixed">Certificate</span></a>
853         element specifies the corresponding certificate in <span
854         class="fixed">PEM</span> format located at <span
855         class="fixed">/conf/shib2.crt</span>.  If any of these values is
856         inconsistent with your deployment, change it accordingly.  Note that
857         keys are supported in a variety of formats: DER, PEM, encrypted PEM,
858         PKCS8, and encrypted PKCS8.  If a keystore must be used instead, consult
859         <a href="#5.a.">section 5.a</a> for appropriate structure and details on
860         population.</p>
861         <p>To create proper keys and certificates for production use, please
862         refer to <a href="#4.b.">section 4.b</a>.</p>
863         </li>
864     </ol>
865 </blockquote>
866 <p><br>
867 </p>
868 <h4><a name="4.a.i"></a>4.a.i Modifying the default Attribute Resolver 
869 configuration</h4>
870 <blockquote>
871     <p>The resolver.xml file controls the retrieval of attributes from 
872     enterprise repositories, and the process of mapping them to Shibboleth/SAML 
873     attributes. For more precise information regarding how attributes are 
874     processed or syntactically formed, please refer to section <a href="#5.d.">
875     5.d.</a></p>
876     <p>In order to make the Shibboleth software operational, however, minor 
877     edits must be made to the example version of the resolver.xml file. The file 
878     can be found at <span class="fixed">/webapps/shibboleth/WEB-INF/classes/conf/resolver.xml.</span> 
879     Two changes are necessary:</p>
880     <p>1. The value of the smartScope attribute should be changed to the Domain 
881     Name value submitted to the Federation. It appears on two 
882     SimpleAttributeDefinition elements: eduPersonScopedAffiliation and 
883     eduPersonPrincipalName.</p>
884     <p>2. The comment indicators should be removed from around the definitions 
885     of those two elements ( &lt;!-- and --&gt; ).</p>
886 </blockquote>
887 <p><br>
888 </p>
889 <h4><a name="4.b."></a>4.b. Key Generation and Certificate Installation</h4>
890 <blockquote>
891     <p>The SAML messages generated by the HS must be digitally signed, which
892     requires the HS be issued a private key and corresponding certificate.  In
893     most instances, the web server will be configured to use SSL, which will
894     also require a cert/key pair.  In many cases, these certs/keys can be shared
895     between Apache/IIS and the HS; for information on sharing certificate/key
896     pairs between Apache and Java keystores see section <a
897     href="#5.c.">5.c.</a>.  Sharing credentials is simplest when using flat-file
898     unencrypted PEM-format certs/keys as expected by Apache.</p>
899
900     <p>The 1.2 origin accommodates keys and certificates in a very wide variety
901     of formats and storage mechanisms.  Java keystores may be specified in a <a
902     href="#confKeyStoreResolver"><span class="fixed">KeyStoreResolver</span></a>
903     element or flat-file keys and certificates may be specified using a <a
904     href="#confFileResolver"><span class="fixed">FileResolver</span></a> in <a
905     href="#5.a."><span class="fixed">origin.xml</span></a>.  The information in
906     that file must be consistent with the values that are established in this
907     process.</p>
908
909     <p>The following text suggests a way to generate a key and certificate in
910     flat-file PEM format, which will be simplest for most deployments.  Once the
911     key pair is generated, the public key must be sent to a certificate
912     authority recognized by relying parties with which this origin will interact
913     to be signed into a certificate. OpenSSL must be installed to perform this
914     process.</p>
915
916     <p>The certificate and key file location should be based on whether they
917     will also be used for Apache.  If they will be used as a server certificate
918     as well, they should probably be in the Apache tree in the usual <span
919     class="fixed">mod_ssl</span>-defined locations inside the Apache
920     configuration folder.  If the certificate and key will only be used by
921     Shibboleth, they can be put in the same folder with the <span
922     class="fixed">origin.xml</span> file and protected appropriately.</p>
923
924     <p>OpenSSL commands to generate a new keypair and a certificate request are
925     shown here, assuming 2048 bit RSA keys are to be used:</p>
926
927     <blockquote><span class="fixed"> $ openssl genrsa -des3 -out ssl.key
928     2048<br> $ openssl req -new -key ssl.key -out ssl.csr </span></blockquote>
929
930     <p>The signed certificate file returned by the CA should be usable directly,
931     or can be converted to PEM format using the <span class="fixed">openssl
932     x509</span> command.</p>
933 </blockquote>
934 <h4><a name="4.c."></a>4.c. Linking the Authentication System to the HS</h4>
935 <blockquote>
936     <p>The interaction between the HS and the local authentication system is 
937     implemented by supplying the HS with the identity of the browser user. Most 
938     often, this will mean protecting the HS servlet with some form of local 
939     authentication that populates <span class="fixed">REMOTE_USER</span>. 
940     Location blocks can be added to <span class="fixed">httpd.conf</span>, 
941     associating the appropriate authentication mechanism with the URL of the HS 
942     servlet. The following example demonstrates association of a very basic 
943     authentication method with the HS:</p>
944     <blockquote>
945         <p><span class="fixed">&lt;Location /shibboleth/HS&gt;<br>
946         AuthType Basic<br>
947         AuthName &quot;Internet2 Handle Service&quot;<br>
948         AuthUserFile /usr/local/apache/conf/user.db<br>
949         require valid-user<br>
950         &lt;/Location&gt;<br>
951         </span></p>
952     </blockquote>
953     <p>Note that .htaccess files cannot be used for this purpose because URL&#39;s 
954     are &quot;virtualized&quot; by Tomcat.</p>
955     <p>It is recommended that the origin be tested at the end of this process 
956     using the process described in section <a href="#6.a.">6.a</a>.</p>
957 </blockquote>
958 <h4><a name="4.c.i."></a>4.c.i. Enabling client certificate authentication
959 <font color="#5555EE">(optional)</font></h4>
960 <blockquote>
961     <blockquote>
962         <p>Shibboleth supports client certificate authentication by utilization 
963         of a filter that relies on the web server to do all processing to ensure 
964         that the certificate is both valid and appropriate for the application. 
965         An example deployment descriptor is included with the Shibboleth 
966         distribution at <span class="fixed">$SHIB_HOME/webAppConfig/origin-client-cert.xml</span>. 
967         To enable the filter, add the following to the deployment descriptor (<span class="fixed">web.xml</span>):</p>
968         <blockquote>
969             <p><span class="fixed">&nbsp;&nbsp;&lt;filter&gt;<br>
970             &nbsp;&nbsp;&nbsp;&nbsp;&lt;filter-name&gt;<br>
971             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Client Cert AuthN Filter<br>
972             &nbsp;&nbsp;&nbsp;&nbsp;&lt;/filter-name&gt;<br>
973             &nbsp;&nbsp;&nbsp;&nbsp;&lt;filter-class&gt;<br>
974             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;edu.internet2.middleware.shibboleth.utils.ClientCertTrustFilter<br>
975             &nbsp;&nbsp;&nbsp;&nbsp;&lt;/filter-class&gt;<br>
976             &nbsp;&nbsp;&lt;/filter&gt;<br>
977             <br>
978             <br>
979             &nbsp;&nbsp;&lt;filter-mapping&gt;<br>
980             &nbsp;&nbsp;&nbsp;&nbsp;&lt;filter-name&gt;<br>
981             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Client Cert AuthN Filter<br>
982             &nbsp;&nbsp;&nbsp;&nbsp;&lt;/filter-name&gt;<br>
983             &nbsp;&nbsp;&nbsp;&nbsp;&lt;url-pattern&gt;<br>
984             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/HS<br>
985             &nbsp;&nbsp;&nbsp;&nbsp;&lt;/url-pattern&gt;<br>
986             &nbsp;&nbsp;&lt;/filter-mapping&gt;<br>
987             </span></p>
988         </blockquote>
989         <p>By default, the filter pulls the principal name out of the
990         <span class="fixed">CN</span> of the cert&#39;s
991         <span class="fixed">Subject</span> by using regular expression 
992         grouping. This may be done using patterns such as:</p>
993         <blockquote>
994             <p><span class="fixed">regex: &#39;.*CN=([^,/]+).*&#39; match group: 1</span>
995             </p>
996         </blockquote>
997         <p>The servlet filter will accept two initialization parameters,
998         <span class="fixed">regex</span> and <span class="fixed">
999         matchGroup</span> that can be used to extract the principal name 
1000         differently.</p>
1001     </blockquote>
1002 </blockquote>
1003 <h4><a name="4.d."></a>4.d. Establishing default ARP&#39;s for the origin community</h4>
1004 <p><b>For a more basic introduction to ARP&#39;s, please refer to section
1005 <a href="#2.e.">2.e</a>.</b></p>
1006 <blockquote>
1007     <p>An ARP determines which attributes are released to a SHAR when a user 
1008     tries to access a resource. It acts as a sort of filter on user information 
1009     contained in the authoritative directory, deciding what can be released to 
1010     whom, but not modifying or creating information itself. ARP&#39;s are generally 
1011     administered by the site, but Shibboleth will provide for users to broker 
1012     control of their own information and privacy by allowing them to create 
1013     ARP&#39;s pertaining to themselves.</p>
1014     <p>It is recommended that a set of policies be established between an origin 
1015     and frequently accessed targets to specify default releases of expected 
1016     attributes. Federation guidelines may provide more information on population 
1017     of ARP&#39;s.</p>
1018     <p>Currently, there is no direct mechanism for users to create their own 
1019     ARP&#39;s besides direct XML writing. In future versions, a GUI will be provided 
1020     for simpler management of ARP&#39;s. Care should be given to balancing giving 
1021     sufficient control over information to users and avoiding access problems. 
1022     For example, users may decide to restrict the release of their personal 
1023     information to such a degree that access to a site for a class may become 
1024     impossible because Shibboleth cannot release enough information to grant 
1025     access.</p>
1026     <p>The Shibboleth distribution contains an example site arp that releases 
1027     the eduPersonScopedAffiliation attribute to all targets. For more precise 
1028     information regarding how ARP&#39;s are processed or syntactically formed, 
1029     please refer to section <a href="#5.b.i.">5.b.i</a>.</p>
1030 </blockquote>
1031 <p><br>
1032 </p>
1033 <hr>
1034 <p><br>
1035 </p>
1036 <h3><a name="5."></a>5. Advanced Configuration</h3>
1037 <h4><a name="5.a."></a>5.a. <span class="fixed">origin.xml</span></h4>
1038 <blockquote>
1039     <p>Shibboleth 1.2 origins are configured using the <span
1040     class="fixed">origin.xml</span> file located in <span
1041     class="fixed">/webapps/shibboleth/WEB-INF/classes/conf/origin.xml</span>. 
1042     The XML consists of a set of individual elements that describe how the
1043     origin should operate, which may each have their own attributes or appear
1044     within other elements.  This structure is represented through
1045     cross-references in the definitions and the examples presented in <a
1046     href="#4.a.">section 4.a</a>, below, and through the <a
1047     href="http://marsalis.internet2.edu/cgi-bin/viewcvs.cgi/shibboleth/java/data/">examples
1048     in CVS</a>.  The following is an example <span
1049     class="fixed">origin.xml</span> file which contains all possible
1050     configuration parameters and values. The configuration must be consistent
1051     with values elsewhere in the deployment or access errors may occur.  For a
1052     more basic example, consult <a href="#4.a.">section 4.a</a>.  This is useful
1053     to demonstrate the structure that other types of configurations have.  Few
1054     deployments will need configuration files this complex.</p>
1055
1056 <blockquote><span class="fixed">
1057 &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>
1058 <br>
1059 <a href="#confShibbolethOriginConfig" class="fixedlink">&lt;ShibbolethOriginConfig<br>
1060 &nbsp;&nbsp;&nbsp;&nbsp;xmlns=&quot;urn:mace:shibboleth:origin:1.0&quot;<br>
1061 &nbsp;&nbsp;&nbsp;&nbsp;xmlns:cred=&quot;urn:mace:shibboleth:credentials:1.0&quot;<br>
1062 &nbsp;&nbsp;&nbsp;&nbsp;xmlns:name=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
1063 &nbsp;&nbsp;&nbsp;&nbsp;xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;<br>
1064 &nbsp;&nbsp;&nbsp;&nbsp;xsi:schemaLocation=&quot;urn:mace:shibboleth:origin:1.0 origin.xsd&quot;<br>
1065 &nbsp;&nbsp;&nbsp;&nbsp;AAUrl=&quot;http://therock.cc.columbia.edu:6666/shibboleth/AA&quot;<br>
1066 &nbsp;&nbsp;&nbsp;&nbsp;defaultRelyingParty=&quot;urn:mace:inqueue&quot;<br>
1067 &nbsp;&nbsp;&nbsp;&nbsp;providerId=&quot;urn:mace:inqueue:shibdev.edu&quot;&gt;</a><br>
1068 <br>
1069 &nbsp;&nbsp;&nbsp;&nbsp;&lt;!-- Default relying party --&gt;<br>
1070 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;RelyingParty name=&quot;urn:mace:inqueue&quot; signingCredential=&quot;foo&quot;&gt;</a><br>
1071 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confHSNameFormat" class="fixedlink">&lt;HSNameFormat nameMapping=&quot;crypto&quot;/&gt;</a><br>
1072 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;/RelyingParty&gt;</a><br>
1073 <br>
1074 &nbsp;&nbsp;&nbsp;&nbsp;&lt;!-- This site is in InQueue, but we want to send explicit errors to them --&gt;<br>
1075 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;RelyingParty name=&quot;urn:mace:inqueue:example.edu&quot; signingCredential=&quot;foo&quot; passThruErrors=&quot;true&quot;&gt;</a><br>
1076 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confHSNameFormat" class="fixedlink">&lt;HSNameFormat nameMapping=&quot;crypto&quot;/&gt;</a><br>
1077 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;/RelyingParty&gt;</a><br>
1078 <br>
1079 &nbsp;&nbsp;&nbsp;&nbsp;&lt;!-- This references domain local service providers --&gt;<br>
1080 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;RelyingParty name=&quot;urn-x:localFed&quot; signingCredential=&quot;bar&quot; passThruErrors=&quot;true&quot; providerId=&quot;urn-x:localSite&quot;&gt;</a><br>
1081 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confHSNameFormat" class="fixedlink">&lt;HSNameFormat nameMapping=&quot;clear&quot;/&gt;</a><br>
1082 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confRelyingParty" class="fixedlink">&lt;/RelyingParty&gt;</a><br>
1083 <br>
1084 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confReleasePolicyEngine" class="fixedlink">&lt;ReleasePolicyEngine&gt;</a><br>
1085 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confArpRepository" class="fixedlink">&lt;ArpRepository implementation=&quot;edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository&quot;&gt;</a><br>
1086 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confPath" class="fixedlink">&lt;Path&gt;/conf/arps/&lt;/Path&gt;</a><br>
1087 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confArpRepository" class="fixedlink">&lt;/ArpRepository&gt;</a><br>
1088 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confReleasePolicyEngine" class="fixedlink">&lt;/ReleasePolicyEngine&gt;</a><br>
1089 <br>
1090 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confLogging" class="fixedlink">&lt;Logging&gt;</a><br>
1091 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confErrorLog" class="fixedlink">&lt;ErrorLog level=&quot;DEBUG&quot; location=&quot;file:///var/log/shib-error.log&quot; /&gt;</a><br>
1092 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confTransactionLog" class="fixedlink">&lt;TransactionLog location=&quot;file:///var//log/shib-access.log&quot; /&gt;</a><br>
1093 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confLogging" class="fixedlink">&lt;/Logging&gt;</a><br>
1094 <br>
1095 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confNameMapping" class="fixedlink">&lt;NameMapping<br>
1096 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlns=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
1097 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id=&quot;crypto&quot;<br>
1098 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;format=&quot;urn:mace:shibboleth:1.0:nameIdentifier&quot;<br>
1099 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;type=&quot;SharedMemoryShibHandle&quot;<br>
1100 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;handleTTL=&quot;1800&quot;/&gt;</a><br>
1101 <br>
1102 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confNameMapping" class="fixedlink">&lt;NameMapping<br>
1103 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlns=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
1104 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id=&quot;clear&quot;<br>
1105 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;format=&quot;urn-x:test:NameIdFormat1&quot;<br>
1106 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;type=&quot;Principal&quot;/&gt;</a><br>
1107 <br>
1108 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confCredentials" class="fixedlink">&lt;Credentials xmlns=&quot;urn:mace:shibboleth:credentials:1.0&quot;&gt;</a><br>
1109 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confFileResolver" class="fixedlink">&lt;FileResolver Id=&quot;foo&quot;&gt;</a><br>
1110 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKey" class="fixedlink">&lt;Key format=&quot;DER&quot;&gt;</a><br>
1111 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confPath" class="fixedlink">&lt;Path&gt;/conf/shib2.key&lt;/Path&gt;</a><br>
1112 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKey" class="fixedlink">&lt;/Key&gt;</a><br>
1113 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confCertificate" class="fixedlink">&lt;Certificate format=&quot;PEM&quot;&gt;</a><br>
1114 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confPath" class="fixedlink">&lt;Path&gt;/conf/shib2.crt&lt;/Path&gt;</a><br>
1115 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confCertificate" class="fixedlink">&lt;/Certificate&gt;</a><br>
1116 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confFileResolver" class="fixedlink">&lt;/FileResolver&gt;</a><br>
1117 <br>
1118 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKeyStoreResolver" class="fixedlink">&lt;KeyStoreResolver Id=&quot;bar&quot; storeType=&quot;JKS&quot;&gt;</a><br>
1119 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confPath" class="fixedlink">&lt;Path&gt;/conf/keystore.jks&lt;/Path&gt;</a><br>
1120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKeyAlias" class="fixedlink">&lt;KeyAlias&gt;shibhs&lt;/KeyAlias&gt;</a><br>
1121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confCertAlias" class="fixedlink">&lt;CertAlias&gt;shibhs&lt;/CertAlias&gt;</a><br>
1122 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confStorePassword" class="fixedlink">&lt;StorePassword&gt;shibhs&lt;/StorePassword&gt;</a><br>
1123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKeyPassword" class="fixedlink">&lt;KeyPassword&gt;shibhs&lt;/KeyPassword&gt;</a><br>
1124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#confKeyStoreResolver" class="fixedlink">&lt;/KeyStoreResolver&gt;</a><br>
1125 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#confCredentials" class="fixedlink">&lt;/Credentials&gt;</a><br>
1126 <br>
1127 &nbsp;&nbsp;<a href="#confFederationProvider" class="fixedlink">&lt;FederationProvider type=&quot;edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper&quot;<br>
1128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uri=&quot;/conf/sites.xml&quot;/&gt;</a><br>
1129 &nbsp;&nbsp;<a href="#confFederationProvider" class="fixedlink">&lt;FederationProvider type=&quot;edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper&quot;<br>
1130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uri=&quot;/conf/local-sites.xml&quot;/&gt;</a><br>
1131 <br>
1132 <a href="#confShibbolethOriginConfig" class="fixedlink">&lt;/ShibbolethOriginConfig&gt;</a>
1133 </span></blockquote>
1134
1135     <p>The following is a complete, alphabetical list of all configuration
1136     elements and their valid attributes and population.  Each element also has a
1137     description of the elements it may contain and the elements that may contain
1138     it.</p>
1139
1140     <p>All pathnames are relative, and have an effective root path of <span
1141     class="fixed">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>. To
1142     specify files outside of the webapp, specify a full URI, such as <span
1143     class="fixed">file:///usr/local/shibboleth/</span>.</p>
1144     <p>All elements are optional unless otherwise specified.  All attributes of
1145     an element are optional unless designated <span
1146     class="mandatory">mandatory</span> by a purple background.</p>
1147
1148     <dl>
1149         <dd class="attribute"><a name="confArpRepository"><span class="fixed">&lt;ArpRepository implementation =&quot;edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository&quot;&gt;</span></dd>
1150         <dd class="value"><p>This element specifies an individual implementation
1151         of a release policy engine, with the given value specifying Shibboleth's
1152         file-based ARP repository implementation, which is currently the only
1153         available.  This must contain a <a href="#confPath"><span
1154         class="fixed">Path</span></a> element pointing to the directory
1155         containing ARP's to be used by this engine.  For more information
1156         regarding ARP's, consult section <a href="#4.d.">4.d</a> for basic
1157         information and <a href="#5.b.">5.b</a> for advanced configuration and
1158         syntax.</p><p>Note that the set of principals that an ARP applies to is
1159         not expressed by the ARP itself, but rather the implementation of the
1160         ARP repository. For example, if the ARP repository were implemented in
1161         LDAP, the ARP&#39;s that apply to a user would be attributes of that
1162         user&#39;s personal LDAP entry, and the site ARP would be an attribute
1163         of an entry representing the site. While not performed by the built-in
1164         ARP repository, a repository implementation might also implement group
1165         ARP&#39;s; for example, in an LDAP directory, the user entry might have
1166         some group membership attributes that refer to group entries, and those
1167         group entries would have ARP attributes, and all those ARP&#39;s would
1168         be applicable.</p></dd>
1169
1170         <dd class="attribute"><a name="confCAPath"><span class="fixed">&lt;CAPath&gt;<i>pathname</i>&lt;/CAPath&gt;</span></dd>
1171         <dd class="value">Paired with a <a href="#confPath"><span
1172         class="fixed">Path</span></a> element and contained by a <a
1173         href="#confFileResolver"><span class="fixed">FileResolver</span></a>
1174         element, this element allows for the specification of additional
1175         certificates in the chain up to the trust anchor.  As many <span
1176         class="fixed">CAPath</span> elements as necessary to complete the chain
1177         may be specified.  The expectations of the target and the federation may
1178         determine the necessity for the use of this field.</dd>
1179
1180         <dd class="attribute"><a name="confCertAlias"><span class="fixed">&lt;CertAlias&gt;<i>string</i>&lt;/CertAlias&gt;</span></dd>
1181         <dd class="value">Specifies the alias for the certificate corresponding
1182         to the private key used by the HS.  If no alias is specified, defaults
1183         to the private key's alias.  Contained by the <a
1184         href="#confKeyStoreResolver"><span
1185         class="fixed">KeyStoreResolver</span></a> element.</dd>
1186
1187         <dd class="attribute"><a name="confCertificate"><span class="fixed">&lt;Certificate format=&quot;<i>type</i>&quot;&gt;</span></dd>
1188         <dd class="value">This specifies the certificate corresponding to this
1189         set of credentials.  The certificate itself must be referred to using a
1190         <a href="#confPath"><span class="fixed">Path</span></a> element
1191         contained by this element.  If this certificate isn't self-signed or
1192         signed by a root familiar to the target, the files of certificates in
1193         the path to the root may be specified using one or more <a
1194         href="#confPath"><span class="fixed">CAPath</span></a> elements.  Valid
1195         encodings are <span class="fixed">PEM</span> and <span
1196         class="fixed">DER</span>.  It resides within the <a
1197         href="#confFileResolver"><span class="fixed">FileResolver</span> element
1198         and must be paired with the corresponding private key using the <a
1199         href="#confKey"><span class="fixed">Key</span></a> element.</dd>
1200
1201         <dd class="attribute"><a name="confCredentials"><span class="fixed">&lt;Credentials xmlns=&quot;urn:mace:shibboleth:credentials:1.0&quot;&gt;</span></dd>
1202         <dd class="value">This element is the container for credentials used by
1203         the credential mechanism specified by the <a
1204         href="#confShibbolethOriginConfig"><span
1205         class="fixed">ShibbolethOriginConfig</span></a> element.  For most
1206         deployments, the URN should be <span class="fixed"></span>.  It must
1207         contain one <a href="#confFileResolver"><span
1208         class="fixed">FileResolver</span></a> element for flat key and
1209         certificate files or one <a href="#confKeyStoreResolver"><span
1210         class="fixed">KeyStoreResolver</span></a> element for compound
1211         keystores.</dd>
1212
1213         <dd class="attribute"><a name="confErrorLog"><span class="fixed">&lt;ErrorLog level=&quot;<i>level</i>&quot; location=&quot;<i>URL</i>&quot;&gt;</span></dd>
1214         <dd class="value">Paired with a <a href="#confTransactionLog"><span
1215         class="fixed">TransactionLog</span></a> element, this will log any
1216         errors encountered by the origin above a certain logging threshold to a
1217         flat file at the referenced <span class="fixed">URL</span>.  Valid
1218         levels in order of decreasing sensitivity are <span
1219         class="fixed">DEBUG</span>, <span class="fixed">INFO</span>, <span
1220         class="fixed">WARN</span>, <span class="fixed">ERROR</span>, and <span
1221         class="fixed">FATAL</span>.  If no logging is desired, specify <span
1222         class="fixed">OFF</span>; defaults to <span class="fixed">WARN</span>. 
1223         Must be contained by a <a href="#confLogging"><span
1224         class="fixed">Logging</span></a> element.</dd>
1225
1226         <dd class="attribute"><a name="confFederationProvider"><span class="fixed">&lt;confFederationProvider <span class="mandatory">type=&quot;edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper&quot; uri=&quot;<i>pathname</i>&quot;/&gt;</span></dd>
1227         <dd class="value">Individual sets of targets in the form of a <span
1228         class="fixed">sites.xml</span> file that this origin will trust to make
1229         requests may be specified by adding <span
1230         class="fixed">FederationProvider</span> elements to the main <a
1231         href="#confShibbolethOriginConfig"><span
1232         class="fixed">ShibbolethOriginConfig</span></a> element for each.  The
1233         <span class="fixed">URI</span> points to a <span
1234         class="fixed">sites.xml</span> file, which is generally distributed by
1235         federations.</dd>
1236
1237         <dd class="attribute"><a name="confFileResolver"><span class="fixed">&lt;FileResolver Id=&quot;<i>string</i>&quot;&gt;</span></dd>
1238         <dd class="value">This element defines a pair of files used to store a
1239         private key and certificate associated with a given identifier and is
1240         contained by the <a href="#confCredentials"><span
1241         class="fixed">Credentials</span></a> element.  <a
1242         href="#confRelyingParty"><span class="fixed">RelyingParty</span></a>
1243         elements will refer to these identifiers allowing multiple resolver
1244         elements to be used to specify different credential storage for
1245         different federations or target sites.  It must contain one <a
1246         href="#confKey"><span class="fixed">Key</span></a> element and should
1247         contain one <a href="#confCertificate"><span
1248         class="fixed">Certificate</span></a> element.</dd>
1249
1250         <dd class="attribute"><a name="confHSNameFormat"><span class="fixed">&lt;HSNameFormat <span class="mandatory">nameMapping=&quot;<i>id</i>&quot;</span>/&gt;</span></dd>
1251         <dd class="value">Individual <a href="#confRelyingParty"><span
1252         class="fixed">RelyingParty</span></a> elements may contain this element
1253         to specify the <a href="#confNameMapping"><span
1254         class="fixed">NameMapping</span></a> element referenced by <span
1255         class="fixed">id</span> to be used in generating subject names for this
1256         relying party.  If this element is not present, default Shibboleth
1257         handles will be used.</dd>
1258
1259         <dd class="attribute"><a name="confKey"><span class="fixed">&lt;Key format=&quot;<i>type</i>&quot;&gt;</span></dd>
1260         <dd class="value">This specifies the file containing a private key to be
1261         used by a set of credentials.  Valid encodings are <span
1262         class="fixed">PEM</span> and <span class="fixed">DER</span>.  Keys are
1263         supported in a variety of formats: DER, PEM, encrypted PEM, PKCS8, and
1264         encrypted PKCS8.  It resides within the <a
1265         href="#confFileResolver"><span class="fixed">FileResolver</span>
1266         element, should be paired with a <a href="#confCertificate"><span
1267         class="fixed">Certificate</span></a> element, and contain a <a
1268         href="#confPath"><span class="fixed">Path</span></a> element.</dd>
1269
1270         <dd class="attribute"><a name="confKeyAlias"><span class="fixed">&lt;KeyAlias&gt;<i>string</i>&lt;/KeyAlias&gt;</span></dd>
1271         <dd class="value">Specifies the alias used for accessing the private
1272         key.  Contained by the <a href="#confKeyStoreResolver"><span
1273         class="fixed">KeyStoreResolver</span></a> element.</dd>
1274
1275         <dd class="attribute"><a name="confKeyPassword"><span class="fixed">&lt;KeyPassword&gt;<i>string</i>&lt;/KeyPassword&gt;</span></dd>
1276         <dd class="value">Specifies the password used to retrieve the private
1277         key.  Contained by the <a href="#confKeyStoreResolver"><span
1278         class="fixed">KeyStoreResolver</span></a> element.</dd>
1279
1280         <dd class="attribute"><a name="confKeyStoreKeyAlias"><span class="fixed">&lt;KeyStoreKeyAlias&gt;<i>string</i>&lt;/KeyStoreKeyAlias&gt;</span></dd>
1281         <dd class="value">Specifies the alias used for accessing the private
1282         key.  Contained by the <a href="#confNameMapping"><span
1283         class="fixed">NameMapping</span></a> element when a <span
1284         class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
1285
1286         <dd class="attribute"><a name="confKeyStoreKeyPassword"><span class="fixed">&lt;KeyStoreKeyPassword&gt;<i>string</i>&lt;/KeyStoreKeyPassword&gt;</span></dd>
1287         <dd class="value">Specifies the password used to retrieve the private
1288         key.  Contained by the <a href="#confNameMapping"><span
1289         class="fixed">NameMapping</span></a> element when a <span
1290         class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
1291
1292         <dd class="attribute"><a name="confKeyStorePassword"><span class="fixed">&lt;KeyStorePassword&gt;<i>string</i>&lt;/KeyStorePassword&gt;</span></dd>
1293         <dd class="value">Specifies the password to access the keystore
1294         containing the private key to be used for symmetric encryption. 
1295         Contained by the <a href="#confNameMapping"><span
1296         class="fixed">NameMapping</span></a> element when a <span
1297         class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
1298
1299         <dd class="attribute"><a name="confKeyStorePath"><span class="fixed">&lt;KeyStorePath&gt;<i>string</i>&lt;/KeyStorePath&gt;</span></dd>
1300         <dd class="value">Specifies the location of the keystore containing the
1301         private key to be used for symmetric encryption to pass handles between
1302         the HS and AA.  Contained by the <a href="#confNameMapping"><span
1303         class="fixed">NameMapping</span></a> element when a <span
1304         class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
1305
1306         <dd class="attribute"><a name="confKeyStoreResolver"><span class="fixed">&lt;KeyStoreResolver Id=&quot;<i>string</i>&quot; storeType=&quot;<i>type</i>&quot;&gt;</span></dd>
1307         <dd class="value">This element is contained by the <a
1308         href="#confCredentials"><span class="fixed">Credentials</span></a>
1309         element and to specify a keystore that contains both the certificate and
1310         private key for a given set of credentials.  Typically, this will be a
1311         Java keystore, with a corresponding type of <span
1312         class="fixed">JKS</span>.  <a href="#confRelyingParty"><span
1313         class="fixed">RelyingParty</span></a> elements will refer to the <span
1314         class="fixed">Id</span> allowing multiple resolver elements to be used
1315         to specify different credential storage for different federations or
1316         target sites.  It must contain one <a href="#confPath"><span
1317         class="fixed">Path</span></a> element, one <a href="#confKeyAlias"><span
1318         class="fixed">KeyAlias</span></a> element, and one <a
1319         href="#confStorePassword"><span class="fixed">StorePassword</span></a>
1320         element; it may optionally contain a <a href="#confKeyPassword"><span
1321         class="fixed">KeyPassword</span></a> element or a <a
1322         href="#confCertAlias"><span class="fixed">CertAlias</span></a>
1323         element.</dd>
1324
1325         <dd class="attribute"><a name="confLog4JConfig"><span class="fixed">&lt;Log4JConfig location=&quot;<i>pathname</i>&quot;/&gt;</span></dd>
1326         <dd class="value">This element informs Shibboleth to utilize Log4J as a
1327         logging system and points to the relevant configuration file using the
1328         <span class="fixed">location</span> attribute.  A basic configuration is
1329         included with the distribution at <span
1330         class="fixed">/WEB-INF/classes/conf/log4j.properties</span>.  This is
1331         set up to log to the console of the servlet container with a level of
1332         WARN, but there is also a commented-out example in the file to give a
1333         possible alternate configuration.  This element must be contained by a
1334         <a href="#confLogging"><span class="fixed">Logging</span></a> element
1335         and may not be paired with a <a href="#confTransactionLog"><span
1336         class="fixed">TransactionLog</span></a> or <a href="#confErrorLog"><span
1337         class="fixed">ErrorLog</span></a> element.</dd>
1338
1339         <dd class="attribute"><a name="confLogging"><span class="fixed">&lt;Logging&gt;</span></dd>
1340         <dd class="value">This container element identifies a logging method for
1341         both the HS and AA to use and may not occur more than once.  Three
1342         different logging methods may be specified depending on what is placed
1343         inside this element.  If nothing is specified, then all logs go to the
1344         container console.  If <a href="#confErrorLog"><span
1345         class="fixed">ErrorLog</span></a> and <a
1346         href="#confTransactionLog"><span class="fixed">TransactionLog</span></a>
1347         elements are present, more traditional logging flatfiles will be
1348         generated at the locations specified.  A <a
1349         href="#confLog4JConfig"><span class="fixed">Log4JConfig</span></a>
1350         element instructs the origin to use Log4J logging.</dd>
1351
1352         <dd class="attribute"><a name="confNameMapping"><span class="fixed">&lt;NameMapping xmlns=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
1353 format=&quot;<i>URN</i>&quot;<br>
1354 handleTTL=&quot;<i>seconds</i>&quot;<br>
1355 id=&quot;<i>string</i>&quot;<br>
1356 type=&quot;<i>type</i>&quot;/&gt;</span></dd>
1357         <dd class="value">This element defines a name mapping system to create
1358         SAML assertion subject names for users; in standard Shibboleth, this
1359         will be the creation of a handle to be given to the SHAR and shared with
1360         the AA.
1361 <ul>
1362 <li><span class="fixed">format</span> should be populated with the URN <span
1363 class="fixed">urn:mace:shibboleth:1.0:nameIdentifier</span> if traditional
1364 Shibboleth handles are used.</li>
1365 <li><span class="fixed">handleTTL</span> specifies in seconds how long a given
1366 handle will be considered valid; an expired handle will require the user to
1367 obtain a new handle and possibly re-authenticate.  This field is only valid if
1368 Shibboleth handles are being used, e.g. <span class="fixed">format</span> is
1369 <span class="fixed">urn:mace:shibboleth:1.0:nameIdentifier</span>.  Consult your
1370 federation guidelines for guidance on the population of this field.</li>
1371 <li><span class="fixed">id</span> is used by <a href="#confHSNameFormat"><span
1372 class="fixed">HSNameFormat</span></a> elements to refer to this element and must
1373 be unique.</li>
1374 <li><span class="fixed">type</span> dictates how handles are passed to the AA. 
1375 The valid types are:<ul type="circle">
1376 <li><span class="fixed">CryptoHandleGenerator</span>: Shibboleth handles will be
1377 passed using symmetric encryption.  If this is specified, keystore information
1378 must be specified using one <a href="#confKeyStorePath"><span
1379 class="fixed">KeyStorePath</span></a> element, one <a
1380 href="#confKeyStoreKeyAlias"><span class="fixed">KeyStoreKeyAlias</span></a>
1381 element, one <a href="#confKeyStorePassword"><span
1382 class="fixed">KeyStorePassword</span></a> element, and optionally a <a
1383 href="#confKeyStoreKeyPassword"><span
1384 class="fixed">KeyStoreKeyPassword</span></a> element.</li>
1385 <li><span class="fixed">Principal</span>: Shibboleth will use the primary unique
1386 identifier for the individual and not generate a handle.</li>
1387 <li><span class="fixed">SharedMemoryShibHandle</span>: Shibboleth will use a
1388 shared in-memory repository.</li>
1389 </ul></li>
1390 </ul></dd>
1391
1392         <dd class="attribute"><a name="confPath"><span class="fixed">&lt;Path&gt;<i>pathname</i>&lt;/Path&gt;</span></dd>
1393         <dd class="value">This mandatory element specifies the path to a file or
1394         directory utilized by other elements of the configuration.  It may be
1395         contained by various elements to point to different types of files
1396         required by the origin.</dd>
1397
1398         <dd class="attribute"><a name="confReleasePolicyEngine"><span class="fixed">&lt;ReleasePolicyEngine&gt;</span></dd>
1399         <dd class="value">The <span class="fixed">ReleasePolicyEngine</span>
1400         element is used to specify a class of release policy processing.  This
1401         should contain one <a href="#confArpRepository"><span
1402         class="fixed">ArpRepository</span></a> element.</dd>
1403
1404         <dd class="attribute"><a name="confRelyingParty"><span class="fixed">&lt;RelyingParty <span class="mandatory">name=&quot;<i>URN</i>&quot;</span><br>
1405 AAsigningCredential=&quot;<i>string</i>&quot;<br>
1406 AAUrl=&quot;<i>URL</i>&quot;<br>
1407 defaultAuthMethod=&quot;<i>URN</i>&quot;<br>
1408 passThruErrors=&quot;<i>true/false</i>&quot;<br>
1409 providerId=&quot;<i>string</i>&quot;<br>
1410 signAttrAssertions=&quot;<i>true/false</i>&quot;<br>
1411 signAttrResponses=&quot;<i>true/false</i>&quot;<br>
1412 signAuthAssertions=&quot;<i>true/false</i>&quot;<br>
1413 signAuthResponses=&quot;<i>true/false</i>&quot;<br>
1414 signingCredential=&quot;<i>string</i>&quot;&gt;</span></dd>
1415         <dd class="value"><p>The <span class="fixed">RelyingParty</span> element
1416         is used to specify one or more relying parties that this origin must
1417         recognize.  This includes any federations the origin is a member of, any
1418         targets that have established bilateral agreements with the origin, or
1419         any other trust structure that origin must be aware of.  In addition to
1420         its attributes, this element may contain a <a
1421         href="#confHSNameMapping"><span class="fixed">HSNameMapping</span></a>
1422         element to specify a naming mechanism for assertions sent to this
1423         relying party.  The HS and AA both perform validation against federation
1424         metadata to ensure that targets cannot construct requests that cause
1425         another target's relying party information to be used.</p>
1426         <p>The proper <span class="fixed">RelyingParty</span> element to handle
1427         a given attribute request is selected by the following algorithm.  If at
1428         any point a match is found, processing is complete; only one relying
1429         party will be used for any given request.</p>
1430         <ol type="1">
1431           <li>If the requesting provider is unauthenticated -- due to a lack of
1432           SSL client authentication because the AA is not protected by an <span
1433           class="fixed">https://</span> URL -- the default relying party is
1434           always used.</li>
1435           <li>If the requesting provider is Shibboleth 1.1 or less, the default
1436           relying party is used.</li>
1437           <li>If a <span class="fixed">RelyingParty</span> element's <span
1438           class="fixed">providerId</span> attribute matches the name sent by the
1439           target, then that element is used.</li>
1440           <li>A metadata lookup is performed using the <span
1441           class="fixed">sites.xml</span> files supplied by <a
1442           href="#confFederationProvider"><span
1443           class="fixed">FederationProvider</span></a> elements to determine
1444           whether the target is a member of a common federation.  If there is a
1445           <span class="fixed">RelyingParty</span> element that has the same
1446           providerId as the URN of the the federation, it is used.  If not, the
1447           default relying party handles the request.</li>
1448         </ol>
1449         <ul>
1450           <li class="mandatory"><span class="fixed">name</span>: Each <span
1451           class="fixed">RelyingParty</span> element is differentiated by a URN
1452           specified in the <span class="fixed">name</span> attribute.  A target
1453           will send a value for this attribute with the attribute request; if
1454           the URN sent matches the <span class="fixed">name</span>, this element
1455           will be used in the transaction.  If there is no direct match, the
1456           origin uses metadata to try to find a federation that the service
1457           provider is a member of.</li>
1458           <li><span class="fixed">AAsigningCredential</span>: This attribute
1459           must equal the identifier of one of the <a
1460           href="#confFileResolver><span class="fixed">FileResolver</span></a>
1461           Id's.  A separate set of credentials may be specified for the AA's
1462           signing of assertions/SSL session identification using this attribute,
1463           as opposed to the HS' signing of assertions.  If this is not specified
1464           for this <span class="fixed">RelyingParty</span> element, but a <span
1465           class="fixed">signingCredential</span> attribute is, that set of
1466           credentials will be used instead.  Ensure that the appropriate signing
1467           key is selected for each; an incorrect signing key will lead to trust
1468           failures.</li>
1469           <li><span class="fixed">AAUrl</span>: Different AA's may be specified
1470           for different relying parties using this attribute.  It over-rides, is
1471           populated, and operates in the same manner as the <span
1472           class="fixed">AAUrl</span> attribute of the <a
1473           href="#confShibbolethOriginConfig"><span
1474           class="fixed">ShibbolethOriginConfig</span></a> element.</li>
1475           <li><span class="fixed">defaultAuthMethod</span>: The value of this
1476           attribute represents the mechanism by which the user's authentication
1477           was performed.  It is used to populate <span
1478           class="fixed">authenticationMethod</span> in SAML assertions passed to
1479           this relying party if no other authentication method is passed to the
1480           HS.  For a brief list of authentication methods, consult the same
1481           attribute as part of the <a href="#confShibbolethOriginConfig"><span
1482           class="fixed">ShibbolethOriginConfig</span></a> element.</li>
1483           <li><span class="fixed">passThruErrors</span>: This boolean attribute
1484           determines whether the origin will relay errors in flows to this
1485           target for use in displaying these errors to the browser in the case
1486           of an unsuccessful transaction.</li>
1487           <li><span class="fixed">providerId</span>: If the origin must assert
1488           under a different name to this relying party, specify a <span
1489           class="fixed">providerId</span> attribute which will over-ride the one
1490           specified in <a href="#confShibbolethOriginConfig"><span
1491           class="fixed">ShibbolethOriginConfig</span></a>.</li>
1492           <li><span class="fixed">signAttrAssertions</span>: If this boolean
1493           attribute has a value of <span class="fixed">true</span>, the
1494           attribute assertion within the SAML response will be signed.  This is
1495           mostly useful for using the attribute assertion in contexts outside of
1496           the response and defaults to <span class="fixed">false</span>.</li>
1497           <li><span class="fixed">signAttrResponses</span>: If this boolean
1498           attribute has a value of <span class="fixed">true</span>, the
1499           attribute response itself will be signed in addition to the security
1500           and authentication provided by the SSL session.  SAML responses
1501           contain one or more assertions.  Defaults to <span
1502           class="fixed">false</span>; if true, an <span
1503           class="fixed">https://</span> AAUrl may be redundant.</li>
1504           <li><span class="fixed">signAuthAssertions</span>: If this boolean
1505           attribute has a value of <span class="fixed">true</span>, the
1506           authentication assertion within the SAML response will be signed. 
1507           This is mostly useful for using the authentication assertion in
1508           contexts outside of the response and defaults to <span
1509           class="fixed">false</span>.</li>
1510           <li><span class="fixed">signAuthResponses</span>: If this boolean
1511           attribute has a value of <span class="fixed">false</span>, the
1512           authentication response will not be signed.  SAML responses contain
1513           one or more assertions.  Defaults to <span
1514           class="fixed">true</span>.</li>
1515           <li><span class="fixed">signingCredential</span>: This attribute must
1516           equal the identifier of one of the <a href="#confFileResolver><span
1517           class="fixed">FileResolver</span></a> Id's.  This allows the origin to
1518           use different signing keys and certificates for exchanges with
1519           different federations or targets.  Ensure that the appropriate signing
1520           key is selected for each; an incorrect signing key will lead to trust
1521           failures.</li>
1522         </ul>
1523         </dd>
1524
1525         <dd class="attribute"><a name="confShibbolethOriginConfig"><span class="fixed">&lt;ShibbolethOriginConfig<br>
1526 <span class="mandatory">xmlns=&quot;urn:mace:shibboleth:origin:1.0&quot;<br>
1527 xmlns:cred=&quot;urn:mace:shibboleth:credentials:1.0&quot;<br>
1528 xmlns:name=&quot;urn:mace:shibboleth:namemapper:1.0&quot;<br>
1529 xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;<br>
1530 xsi:schemaLocation=&quot;urn:mace:shibboleth:origin:1.0 origin.xml&quot;</span><br>
1531 <span class="mandatory">defaultRelyingParty=&quot;<i>URI</i>&quot;<br>
1532 providerID=&quot;<i>URN</i>&quot;</span><br>
1533 AAUrl=&quot;<i>URL</i>&quot;<br>
1534 authHeaderName=&quot;<i>string</i>&quot;<br>
1535 defaultAuthMethod=&quot;<i>URN</i>&quot;<br>
1536 maxHSThreads=&quot;<i>integer</i>&quot;<br>
1537 passThruErrors=&quot;<i>true/false</i>&quot;<br>
1538 resolverConfig=&quot;<i>pathname</i>&quot;&gt;</span></dd>
1539         <dd class="value"><p>This is the primary element that defines an <span class="fixed">origin.xml</span> file and is the container for every other element and must appear once and only once.  For most deployments, all the <span class="fixed">xmlns</span> attributes, which specify the handlers for different aspects of origin operation, should remain unchanged.  The mandatory attributes must be changed before operating the origin.</p>
1540 <ul>
1541 <li class="mandatory"><span class="fixed">defaultRelyingParty</span>: This specifies the relying party to use for a request when no <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element's <span class="fixed">name</span> attribute matches the policy URN of an incoming request.  Typically, this will be populated with the URN of a federation.</li>
1542 <li class="mandatory"><span class="fixed">providerID</span>: The origin uses this unique name to identify assertions it issues.  This will usually be assigned by a federation.</li>
1543 <li><span class="fixed">AAUrl</span> specifies the URL where the AA for this HS resides, which must be consistent with how it is defined in Tomcat.  Note that this <b>must</b> be an <span class="fixed">https://</span> URL in order for the AA to know which SHAR is requesting attributes for ARP purposes.</li>
1544 <li><span class="fixed">authHeaderName</span>: If authentication methods are passed to the HS using an HTTP header variable other than the default, <span class="fixed">SAMLAuthenticationMethod</span>, the name of the variable may be specified here.</li>
1545 <li><span class="fixed">defaultAuthMethod</span>: This specifies the authentication method that will be assumed if none is passed through and there is no overriding <span class="fixed">defaultAuthMethod</span> specified for this target using a <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element.  If neither this element nor the matching <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element contains this attribute, a value of <span class="fixed">urn:oasis:names:tc:SAML:1.0:am:unspecified</span> will be used for <span class="fixed">authenticationMethod</span>.  Some common 
1546         authentication methods and corresponding URI&#39;s are listed below; for a 
1547         complete list, please consult section 7.1 of the SAML 1.1 core 
1548         specifications or your federation&#39;s guidelines.
1549         <table border="2" cellpadding="0" cellspacing="0">
1550             <tr>
1551                 <td><span class="fixed">
1552                 urn:oasis:names:tc:SAML:1.0:am:password</span></td>
1553                 <td>The authentication was performed using a password.</td>
1554             </tr>
1555             <tr>
1556                 <td><span class="fixed">urn:ietf:rfc:1510</span></td>
1557                 <td>The authentication was performed using Kerberos.</td>
1558             </tr>
1559             <tr>
1560                 <td><span class="fixed">
1561                 urn:oasis:names:tc:SAML:1.0:am:X509-PKI</span></td>
1562                 <td>The authentication was performed using a certificate and key 
1563                 issued to the end user. More specific forms of PKI 
1564                 authentication such as SPKI and XKMS are also assigned URN&#39;s in 
1565                 the SAML specs.</td>
1566             </tr>
1567         </table></li>
1568 <li><span class="fixed">maxHSThreads</span>: This attribute places a limit on the number of threads the handle service will spawn and may be useful for limiting the load of signing and other operations and improving performance.</li>
1569 <li><span class="fixed">passThruErrors</span>: This boolean attribute determines whether the origin will relay errors in flows to the target for use in displaying these errors to the browser in the case of an unsuccessful transaction.</li>
1570 <li><span class="fixed">resolverConfig</span> specifies the location of the configuration file for the resolver the AA uses to build attributes and if unspecified defaults to <span class="fixed">/conf/resolver.xml</span>. For information on how to configure and use the attribute resolver, consult section <a href="4.e.">4.e</a>.</li>
1571 </ul>
1572 </dd>
1573
1574         <dd class="attribute"><a name="confStorePassword"><span class="fixed">&lt;StorePassword&gt;<i>string</i>&lt;/StorePassword&gt;</span></dd>
1575         <dd class="value">Specifies the password for the keystore.  Contained by the <a href="#confKeyStoreResolver"><span class="fixed">KeyStoreResolver</span></a> element.</dd>
1576
1577         <dd class="attribute"><a name="confTransactionLog"><span class="fixed">&lt;TransactionLog location=&quot;<i>URL</i>&quot;&gt;</span></dd>
1578         <dd class="value">Paired with an <a href="#confErrorLog"><span class="fixed">ErrorLog</span></a> element, this will log all transactions that the origin is involved in.  The information in this file is sensitive and may be useful for auditing and security purposes.  Must be contained by a <a href="#confLogging"><span class="fixed">Logging</span></a> element.</dd>
1579
1580     </dl>
1581 </blockquote>
1582 <p><br>
1583 </p>
1584 <h4><a name="5.b."></a>5.b. ARP Overview</h4>
1585 <blockquote>
1586     <h5>This section applies primarily to the syntactic and technical details of 
1587     ARP&#39;s. For basic information on and explanation of what an ARP is and how it 
1588     should be managed, please refer to sections <a href="#2.e.">2.e</a> and
1589     <a href="#4.d.">4.d</a>.</h5>
1590     <p>Every ARP file contains one ARP. ARP&#39;s may be specified either as the 
1591     site ARP or user ARP&#39;s. The site ARP pertains to every principal for whom 
1592     the AA retrieves information; a user ARP applies only to the individual user 
1593     for whom it is defined. The set of principals to whom the ARP applies is 
1594     defined by the name of the ARP file: the site ARP is stored in
1595     <span class="fixed">arp.site.xml</span> and user ARP&#39;s are stored as
1596     <span class="fixed">arp.user.$PRINCIPALNAME.xml</span>. Up to two ARP&#39;s 
1597     will apply to a principal: the site ARP, and the user ARP for that 
1598     principal.</p>
1599     <p>Each ARP acts as a container that holds a set of ARP rules that are
1600     applicable to the principals that ARP is effective for. Each ARP rule
1601     specifies a single release policy within the ARP container pertaining to a
1602     particular target application.  For 1.2 targets, this is a single URI
1603     matching a <span class="fixed">providerId</span>.  Prior to 1.2, URI's for
1604     targets were not registered; this means that the SHAR name must be used in
1605     release policies for 1.1 targets accessed by users from this origin.  Each
1606     ARP rule may contain specifications regarding the release of any number of
1607     attribute values to requests matching that ARP rule for that user. ARP rules
1608     may be flagged as default, implying that they are always applied to any user
1609     matched by the ARP container. Note that ARP&#39;s may also be used to
1610     restrict specific attribute/value pairs in addition to restricting or
1611     releasing individual attributes.</p>
1612     <p>When a query is received, the AA generates an effective ARP, which is the 
1613     fully evaluated set of ARP rules regarding that relying party based on all ARP 
1614     containers applicable to the principal. This effective ARP is then applied 
1615     to attribute values retrieved from the directory and the appropriate 
1616     assertion is constructed. Default rules are always included in construction 
1617     of the effective ARP.</p>
1618 </blockquote>
1619 <h4><a name="5.b.i."></a>5.b.i. ARP Processing</h4>
1620 <blockquote>
1621     <blockquote>
1622         <p>When a request arrives from a particular relying party, the applicable set of 
1623         ARP rules are parsed into an effective ARP. This parsing is done as 
1624         follows:</p>
1625         <ol type="1">
1626             <li>Identify all ARP&#39;s that should be applied to a particular 
1627             principal. This is done by isolating the files in the folder 
1628             specified by the <a href="#confArpRepository"><span class="fixed">ArpRepository</span></a> element 
1629             that have the name either arp.site.xml or 
1630             arp.user.$PRINCIPALNAME.xml.</li>
1631             <li>Find all ARP rules relevant to the query:
1632             <ol type="i">
1633                 <li>Any ARP rules within the identified ARP&#39;s designated as 
1634                 defaults are automatically included in the effective ARP without 
1635                 performing any matching functions.</li>
1636                 <li>For each non-default rule in each identified ARP, the 
1637                 matching functions specified in the rule&#39;s target definition are 
1638                 performed. A separate matching function is performed for the 
1639                 requesting SHAR and the providerId on behalf of which the SHAR is 
1640                 making the request.</li>
1641                 <li>Each matching function evaluates to <span class="fixed">
1642                 TRUE</span> if the match is successful or
1643                 <span class="fixed">FALSE</span> if it is unsuccessful. If 
1644                 both functions evaluate to <span class="fixed">TRUE</span>, 
1645                 the rule is included in the Effective ARP.</li>
1646             </ol>
1647             </li>
1648             <li>Construct the Attribute Filter:
1649             <ol type="i">
1650                 <li>For each attribute, compile a temporary list of associated 
1651                 rules that includes all values with a release qualifier of
1652                 <span class="fixed">permit</span>.</li>
1653                 <li>Subtract from this list all attribute values with rules 
1654                 specifying a release qualifier of <span class="fixed">deny</span>. 
1655                 The resulting list represents the allowable release values for 
1656                 the attribute and is used as a mask for the values which are 
1657                 returned from the Attribute Resolver.</li>
1658                 <li>If a statement specifies that all values should be 
1659                 permitted, then specific <span class="fixed">deny</span> 
1660                 qualifiers for specific values should still be enforced. If a 
1661                 statement specifies that all values should be denied, then
1662                 <span class="fixed">permit</span> qualifiers for specific 
1663                 values will be ignored.</li>
1664             </ol>
1665             </li>
1666             <li>Using the mask and attributes returned from the Attribute 
1667             Resolver, an assertion is constructed.</li>
1668         </ol>
1669     </blockquote>
1670 </blockquote>
1671 <h4><a name="5.b.ii."></a>5.b.ii. ARP Syntax</h4>
1672 <blockquote>
1673     <blockquote>
1674         <p>Each ARP is described by an XML file based on a standard
1675         <span class="fixed">.xsd</span> schema. It consists of a standard
1676         <span class="fixed">AttributeReleasePolicy</span> element 
1677         referencing the appropriate <span class="fixed">xsi:schemaLocation</span> 
1678         and a self-explanatory <span class="fixed">Description</span> 
1679         element followed by any number of <span class="fixed">Rule</span> 
1680         elements. Each <span class="fixed">Rule</span> element must consist 
1681         of a <span class="fixed">Target</span> element and one or more
1682         <span class="fixed">Attribute</span> elements. The
1683         <span class="fixed">Target</span> element specifies the rules by 
1684         which the target definition is formed. The <span class="fixed">
1685         Attribute</span> elements specifies the name and values of the 
1686         attributes that may be released.</p>
1687         <p>The simplest possible ARP is as follows, which releases
1688         <span class="fixed">eduPersonScopedAffiliation</span> to any target 
1689         for the users the ARP applies to:</p>
1690         <blockquote>
1691             <p><span class="fixed">&lt;?xml version=&quot;1.0&quot;?&gt;<br>
1692             &lt;AttributeReleasePolicy xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; 
1693             xmlns=&quot;urn:mace:shibboleth:arp:1.0&quot; xsi:schemaLocation=&quot;urn:mace:shibboleth:arp:1.0 
1694             shibboleth-arp-1.0.xsd&quot;&gt;<br>
1695 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Description&gt;Simplest possible 
1696             ARP.&lt;/Description&gt;<br>
1697 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Rule&gt;<br>
1698 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1699             &lt;Target&gt;<br>
1700 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1701             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;AnyTarget/&gt;<br>
1702 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1703             &lt;/Target&gt;<br>
1704 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1705             &lt;Attribute name=&quot;urn:mace:dir:attribute-def:eduPersonScopedAffiliation&quot;&gt;<br>
1706 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1707             &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;AnyValue release= &quot;permit&quot;/&gt;<br>
1708 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
1709             &lt;/Attribute &gt;<br>
1710 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/Rule &gt;<br>
1711             &lt;/AttributeReleasePolicy&gt;<br>
1712             </span></p>
1713         </blockquote>
1714     </blockquote>
1715     <p>All ARP&#39;s must take the same basic form. A detailed description of how 
1716     each element of the <span class="fixed">Rule</span> element may be 
1717     sub-populated follows:</p>
1718     <p>The <span class="fixed">Target</span> element:</p>
1719     <blockquote>
1720         <p><span class="fixed">Target</span> may contain either the
1721         <span class="fixed">AnyTarget</span> element, which will cause the
1722         <span class="fixed">Target</span> to always return
1723         <span class="fixed">TRUE</span>, or both the
1724         <span class="fixed">Requester</span> element, which provides for 
1725         matches to be performed against the SHAR name for 1.1 targets or the <span class="fixed">providerId</span> for 1.2 targets, and the
1726         <span class="fixed">Resource</span> element, which provides for 
1727         matches to be performed against the requested URL.</p>
1728         <p>When going against 1.1 targets, the <span class="fixed">Resource</span> element will refer to individual URL trees protected by a given SHAR.  However, due to the nature of application identifiers, the <span class="fixed">Resource</span> element has no meaning when releasing to 1.2 targets.  These will always function as though <span class="fixed">&lt;AnyResource/&gt;</span> is specified.</p>
1729         <p>There are three matches that may be performed by the AA in evaluating 
1730         ARP&#39;s by using the <span class="fixed">matchFunction</span> 
1731         component of the <span class="fixed">Requester</span> and
1732         <span class="fixed">Resource</span> elements. The following match 
1733         patterns may be specified directly following the
1734         <span class="fixed">Requester</span> or <span class="fixed">
1735         Resource</span> elements, such as <span class="fixed">&lt;Requester 
1736         matchFunction=&quot;urn:mace:shibboleth:arp:matchFunction:regexMatch&quot;&gt;</span>:</p>
1737         <ul type="disc">
1738             <li><span class="fixed">
1739             urn:mace:shibboleth:arp:matchFunction:exactShar </span>
1740             <blockquote>
1741                 <p>May be used with the <span class="fixed">Requester</span> 
1742                 element.</p>
1743                 <p>Evaluates to <span class="fixed">TRUE</span> when the 
1744                 string content of the <span class="fixed">Requester</span> 
1745                 element matches exactly the providerId of the requesting application of 1.2 targets or the SHAR name of 1.1 targets. 
1746                 Otherwise evaluates to <span class="fixed">FALSE</span>. 
1747                 Serves as the default value associated with
1748                 <span class="fixed">Requester</span> if none is specified.</p>
1749             </blockquote>
1750             </li>
1751             <li><span class="fixed">
1752             urn:mace:shibboleth:arp:matchFunction:resourceTree </span>
1753             <blockquote>
1754                 <p>May be used with the <span class="fixed">Resource</span> 
1755                 element. However, this has no meaning when releasing to 1.2 targets.</p>
1756                 <p>Evaluates to <span class="fixed">TRUE</span> when the 
1757                 location of the resource either matches exactly or begins with 
1758                 the string content of the <span class="fixed">Resource</span> 
1759                 element. Otherwise evaluates to <span class="fixed">FALSE</span>.</p>
1760             </blockquote>
1761             </li>
1762             <li><span class="fixed">
1763             urn:mace:shibboleth:arp:matchFunction:regexMatch </span>
1764             <blockquote>
1765                 <p>May be used with both the <span class="fixed">Requester</span> 
1766                 and <span class="fixed">Resource</span> elements.</p>
1767                 <p>Evaluates to <span class="fixed">TRUE</span> when the providerId of a request for 1.2 targets or the
1768                 name of the requesting SHAR for or the requested URL tree for 1.1 targets is a valid 
1769                 match of the regular expression represented as the content of 
1770                 the containing element. Otherwise evaluates to
1771                 <span class="fixed">FALSE</span>. Regular expressions are 
1772                 evaluated in accordance with the the
1773                 <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/package-summary.html">
1774                 Java 1.4 Pattern API</a>.</p>
1775             </blockquote>
1776             </li>
1777         </ul>
1778     </blockquote>
1779     <p>The <span class="fixed">Attribute</span> element:</p>
1780     <blockquote>
1781         <p>The <span class="fixed">Attribute</span> element must always 
1782         specify the URN of the attribute whose release parameters it specifies. 
1783         Additionally, it must contain either the <span class="fixed">
1784         AnyValue</span> element or one or more <span class="fixed">Value</span> 
1785         elements. These elements, in turn, must specify either
1786         <span class="fixed">release</span> = <span class="fixed">
1787         permit</span> or <span class="fixed">deny</span>. The
1788         <span class="fixed">Value</span> element must then contain one 
1789         value for which the rule applies. Examples:</p>
1790         <blockquote>
1791             <p><span class="fixed">&lt;Attribute name=&quot;urn:mace:dir:attribute-def:eduPersonPrincipalName&quot;&gt;<br>
1792             &nbsp;&nbsp;&lt;AnyValue release=&quot;Permit&quot;&gt;<br>
1793             &lt;/Attribute&gt;<br>
1794             </span><br>
1795             </p>
1796             <p>Permits the release of <span class="fixed">
1797             eduPersonPrincipalName</span> with any value.</p>
1798         </blockquote>
1799         <blockquote>
1800             <p><span class="fixed">&lt;Attribute name=&quot;urn:mace:dir:attribute-def:eduPersonScopedAffiliation&quot;&gt;<br>
1801             &nbsp;&nbsp;&lt;Value release=&quot;deny&quot;&gt;member@example.edu&lt;/Value&gt;<br>
1802             &lt;/Attribute&gt;<br>
1803             </span><br>
1804             </p>
1805             <p>Denies the release of <span class="fixed">
1806             eduPersonScopedAffiliation</span> value <span class="fixed">
1807             member@example.edu</span>. Other values of the attribute may still 
1808             be released if so specified by a <span class="fixed">permit</span> 
1809             ARP.</p>
1810         </blockquote>
1811     </blockquote>
1812 </blockquote>
1813 <h4><a name="5.c."></a>5.c. Sharing certificate/key pairs between Apache and 
1814 Java keystores <font color="#5555EE">(optional)</font></h4>
1815 <blockquote>
1816     <blockquote>
1817         <p>The JDK includes the command line program <span class="fixed">
1818         keytool</span> for managing Java keystores. This utility cannot import 
1819         or export private key information, making it difficult to use the same 
1820         private key and certificate for Apache and Java-based applications. The 
1821         Shibboleth distribution includes <span class="fixed">extkeytool</span>, 
1822         a program that can be used in conjunction with <span class="fixed">
1823         keytool</span> to perform these tasks. Select the appropriate 
1824         step-by-step procedure for your situation from the following guides.</p>
1825         <p>Before running <span class="fixed">extkeytool</span>, the 
1826         variable SHIB_HOME must be set to the path to the directory where the 
1827         Shibboleth tarball was exploded(typically /opt/shibboleth-origin-1.2/).</p>
1828         <p><b>If you have a pre-exiting RSA key/certificate combination in a 
1829         keystore and you would like to use it with Apache:</b></p>
1830         <ol type="1">
1831             <li>Determine the alias of the keystore keyEntry containing the key 
1832             you would like to use in your Apache setup. Assuming that your 
1833             keystore is named <span class="fixed">yourstore</span>, the 
1834             following command should present a list of the entries in the 
1835             keystore.<blockquote>
1836                 <p><span class="fixed">$ keytool -list -v -keystore 
1837                 yourstore</span></p>
1838             </blockquote>
1839             </li>
1840             <li>Assuming that you identified the appropriate alias as
1841             <span class="fixed">youralias</span> and the password for the 
1842             keystore is <span class="fixed">yourpass</span>, enter the 
1843             following command to export the key in Base64-encoded pkcs8 format.<blockquote>
1844                 <p><span class="fixed">$ extkeytool -exportkey -keystore 
1845                 yourstore -alias youralias -storepass yourpass -rfc -file 
1846                 yourkey.pkcs8</span></p>
1847             </blockquote>
1848             </li>
1849             <li>In order to use this key with Apache, you must convert it to PEM-encoded 
1850             RSA native format. You have the option of storing the key 
1851             unencrypted or encrypted:<ol type="A">
1852                 <li>To use the unencrypted format, enter the following command 
1853                 for the conversion:<blockquote>
1854                     <p><span class="fixed">$ openssl pkcs8 -in 
1855                     yourkey.pkcs8 -nocrypt|openssl rsa -out yourkey.key</span></p>
1856                 </blockquote>
1857                 </li>
1858                 <li>To use the encrypted format, enter the following command for 
1859                 the conversion:<blockquote>
1860                     <p><span class="fixed">$ openssl pkcs8 -in 
1861                     yourkey.pkcs8 -nocrypt|openssl rsa -des3 -out yourkey.enckey</span></p>
1862                 </blockquote>
1863                 </li>
1864             </ol>
1865             </li>
1866             <li>The following command will export the corresponding certificate.<blockquote>
1867                 <p><span class="fixed">$ keytool -export -keystore 
1868                 yourstore -alias youralias -rfc -file yourcert</span></p>
1869             </blockquote>
1870             </li>
1871             <li>Set the <span class="fixed">mod_ssl</span>
1872             <span class="fixed">SSLCertificateKeyFile</span> and
1873             <span class="fixed">SSLCertificateFile</span> directives to 
1874             point to the two files you have just created. Take care to remove 
1875             any temporary files you created (i.e. <span class="fixed">
1876             yourkey.pkcs8</span>) and set appropriate file permissions, 
1877             especially if you chose to store the key in an unencrypted format.</li>
1878         </ol>
1879         <p><b>If you have a pre-existing RSA key/certificate combination that 
1880         you use with Apache and would like to import it into a java keystore:</b></p>
1881         <ol type="1">
1882             <li>Convert the private key to unencrypted DER-encoded pkcs8 format. 
1883             Assuming your PEM-encoded key is stored in a file named
1884             <span class="fixed">yourkey.enckey</span>, enter the following 
1885             command.<blockquote>
1886                 <p><span class="fixed">$ openssl pkcs8 -in yourkey.enckey 
1887                 -topk8 -nocrypt -outform DER -out yourkey.der.pkcs8</span></p>
1888             </blockquote>
1889             </li>
1890             <li>Create a certificate bundle file. This file should include a 
1891             series of PEM-encoded X509 certificates representing a complete 
1892             trust chain, from the root CA certificate to the certificate that 
1893             matches your private key. If your certificate is stored in a file 
1894             named <span class="fixed">mycert</span> and the CA signer 
1895             certificate is stored in a file named <span class="fixed">
1896             ca.cert</span>, you might enter the following command to create the 
1897             bundle.<blockquote>
1898                 <p><span class="fixed">$ cat mycert ca.cert &gt; cert.bundle</span></p>
1899             </blockquote>
1900             <p><b>Note: <span class="fixed">mod_ssl</span>-enabled Apache 
1901             installations include a number of commonly recognized CA 
1902             certificates in the <span class="fixed">ca-bundle.crt</span> 
1903             file under the <span class="fixed">$ServerRoot/conf/ssl.crt/</span> 
1904             directory.</b> </li>
1905             <li>Import the key and certificate into the keystore. Assuming you 
1906             have already created a keystore named <span class="fixed">
1907             yourstore</span> with a password of of <span class="fixed">
1908             yourpass</span>, enter the following command to store the data under 
1909             the alias <span class="fixed">youralias</span>.<blockquote>
1910                 <p><span class="fixed">$ ./extkeytool -importkey -keystore 
1911                 yourstore -alias youralias -storepass yourpass -keyfile 
1912                 yourkey.der.pkcs8 -certfile cert.bundle -provider 
1913                 org.bouncycastle.jce.provider.BouncyCastleProvider</span></p>
1914             </blockquote>
1915             </li>
1916             <li>You can verify that the import was successful by listing entry. 
1917             Use the command below.<blockquote>
1918                 <p><span class="fixed">$ keytool -list -v -keystore 
1919                 yourstore -alias youralias</span></p>
1920             </blockquote>
1921             </li>
1922             <li>Remember to delete <span class="fixed">yourkey.der.pkcs8</span>, 
1923             as it contains your unencrypted private key.</li>
1924         </ol>
1925         <p><b>If you are starting from scratch and do not yet have a 
1926         certificate/key pair:</b></p>
1927         <ol type="1">
1928             <li>Generate an RSA private key. Use the command below, substituting
1929             <span class="fixed">yourkey</span> with an appropriate name to 
1930             use to refer to the key.<blockquote>
1931                 <p><span class="fixed">$ openssl genrsa -des3 -out 
1932                 yourkey.enckey 1024</span></p>
1933             </blockquote>
1934             </li>
1935             <li>The following command generates a Certificate Signing Request, 
1936             which should be communicated to a Certificate Authority.<blockquote>
1937                 <p><span class="fixed">$ openssl req -new -key 
1938                 yourkey.enckey</span></p>
1939             </blockquote>
1940             </li>
1941             <li>The Certificate Authority should respond with a PEM-encoded X509 
1942             certificate. Set the <span class="fixed">mod_ssl</span>
1943             <span class="fixed">SSLCertificateKeyFile</span> directive to 
1944             point to the key file you just created and the
1945             <span class="fixed">SSLCertificateFile</span> directive to 
1946             point to file containing the certificate issued by the Certificate 
1947             Authority. Previous sections explaion how to share the 
1948             key/certificate pair with a Java keystore.</li>
1949         </ol>
1950     </blockquote>
1951 </blockquote>
1952 <p><br>
1953 </p>
1954 <h4><a name="5.d."></a>5.d. The Attribute Resolver</h4>
1955 <blockquote>
1956     <p>Shibboleth provides a powerful attribute resolver that allows origins to 
1957     quickly configure the retrieval of simple attributes from standard types of 
1958     attribute stores. The resolver is configured using an xml file wich should 
1959     be pointed to with the <span class="fixed">
1960     edu.internet2.middleware.shibboleth.aa. 
1961     attrresolv.AttributeResolver.ResolverConfig</span> propety in
1962     <span class="fixed">origin.xml</span> as described in section
1963     <a href="#4.a.">4.a</a>. For more complex attributes or those that require 
1964     processing before release, customized Java classes will need to be written. 
1965     For more information, consult the programmer&#39;s guide.</p>
1966     <p>The resolver is essentially a directed graph from attribute definitions 
1967     to data connectors. The data connectors pull data, in the form of 
1968     attributes, from external data sources. The attribute definitions then 
1969     process this data into a from suitable for use by Shibboleth. This procedure 
1970     can be as simple as taking an unmodified string value from a data connector 
1971     and tagging it with a name or can include arbitrarily complex business 
1972     rules.</p>
1973     <p>The <span class="fixed">resolver.xml</span> file that is pointed to 
1974     by <span class="fixed">origin.xml</span> consists of zero or 
1975     more attribute definitions followed by zero or more data connectors. Each 
1976     attribute definition consists of an identifier corresponding to the URN of 
1977     the attribute, and optional references to data connectors on which it 
1978     depends. Each data connector consists of a string identifier which is used 
1979     by attribute definitions that refer to it, and one or more elements specific 
1980     to the configuration of that data connector.</p>
1981     <p>Shibboleth comes with two attribute definitions provided in version 1.2: 
1982     the <span class="fixed">SimpleAttributeDefinition</span>, which acts as 
1983     a basic proxy for attributes supplied by data connectors with some name 
1984     conversion and attribute scoping added, and a <span class="fixed">
1985     CustomAttributeDefinition</span>, which can be used to configure 
1986     user-created attribute definition plugins. Similarly, Shibboleth 1.2 comes 
1987     with two data connectors: the <span class="fixed">
1988     JNDIDirectoryDataConnector</span>, which pulls data from any source for 
1989     which there is a JNDI Directory Context implementation, including LDAP, NDS, 
1990     etc., and the <span class="fixed">CustomDataConnector</span>, which is 
1991     used to configure user-created data connector plugins.</p>
1992     <p>A detailed explanation of each configuration option for the provided 
1993     connectors follows:</p>
1994     <p><span class="fixed">JNDIDirectoryDataConnector</span>:</p>
1995     <dl>
1996         <dd class="attribute"><span class="fixed">id = &lt;string&gt;</span> </dd>
1997         <dd class="value">Specifies a unique, textual name for the connector 
1998         used by attribute definitions to refer to and use it to build 
1999         attributes. Contained within the <span class="fixed">
2000         JNDIDirectoryDataConnector</span> element.</dd>
2001         <dd class="attribute"><span class="fixed">&lt;Property name=&quot;&lt;name&gt;&quot; 
2002         value=&quot;&lt;value&gt;&quot;/&gt;</span> </dd>
2003         <dd class="value">An element of the element <span class="fixed">
2004         JNDIDirectoryDataConnector</span>. Specifies a set of name/value pairs 
2005         that are used to configure the JNDI Directory Context. This list of 
2006         name/value pairs is defined by the context itself, but is specified 
2007         within <span class="fixed">resolver.xml</span>. Refer to the
2008         <a href="http://http://marsalis.internet2.edu/cgi-bin/viewcvs.cgi%20%20%20%20%20%20%20%20%20%20/shibboleth/java/src/conf/resolver.ldap.xml">
2009         Shibboleth CVS</a> for an example of names and values used to connect to 
2010         an LDAP directory.</dd>
2011         <dd class="attributeopt"><span class="fixed">&lt;Search&gt;</span> </dd>
2012         <dd class="valueopt">An element of the element <span class="fixed">
2013         JNDIDirectoryDataConnector</span>. This element defines the DN filter 
2014         used to perform the LDAP search. The search string must return no more 
2015         than one result.</dd>
2016         <dd class="attributeopt"><span class="fixed">&lt;Controls&gt;</span> </dd>
2017         <dd class="valueopt">An element of the element <span class="fixed">
2018         Search</span>. This element grants some fine-grained control over the 
2019         LDAP API calls.</dd>
2020         <dd class="attributeopt"><span class="fixed">&lt;cacheTime 
2021         &quot;&lt;seconds&gt;&quot;/&gt;</span> </dd>
2022         <dd class="valueopt">An element of the element <span class="fixed">
2023         JNDIDirectoryDataConnector</span>. Specifies an optional duration in
2024         <span class="fixed">seconds</span> for which the attribute resolver 
2025         may cache information retrieved from this connector. The default is zero seconds (no caching)</dd>
2026     </dl>
2027     <p>A representation of a properly constructed <span class="fixed">
2028     JNDIDirectoryDataConnector</span> element would look like:</p>
2029     <blockquote>
2030         <p><span class="fixed">&lt;JNDIDirectoryDataConnector id=&quot;directory&quot;&gt;<br>
2031         &nbsp;&nbsp;&lt;Search filter=&quot;cn=%PRINCIPAL%&quot;&gt;<br>
2032         &nbsp;&nbsp;&nbsp;&nbsp;&lt;Controls searchScope=&quot;SUBTREE_SCOPE&quot; returningObjects=&quot;false&quot; /&gt;<br>
2033         &nbsp;&nbsp;&lt;/Search&gt;<br>
2034         &nbsp;&nbsp;&lt;Property name=&quot;java.naming.factory.initial&quot; value=&quot;com.sun.jndi.ldap.LdapCtxFactory&quot; 
2035         /&gt;<br>
2036         &nbsp;&nbsp;&lt;cacheTime=&quot;2400&quot;/&gt;<br>
2037         &lt;/JNDIDirectoryDataConnector&gt; </span></p>
2038     </blockquote>
2039     <p>If the ldap server must be accessed over SSL, and JDK 1.4.1 is being used, two changes must be made to the <span class="fixed">JNDIDirectoryDataConnector</span> element:</p>
2040         <p>1. On the java.naming.provider.url Property, add &lt;port number&gt; after the hostname in the ldap url (the default port for ldap over SSL is 636),</p>
2041         <p>2. Add this Property element:</p>
2042     <blockquote>
2043                 <p><span class="fixed">&lt;Property name="java.naming.security.protocol" value="ssl" &quot;&gt;</span></p>
2044         </blockquote>
2045         <p>If the ldap server must be accessed over SSL, and JDK 1.4.2 is being used, then change ldap:// to ldaps:// in the value of the <span class="fixed">java.naming.provider.url</span> Property.</p>
2046         <p>NOTE: This assumes that the ldap server's cert is rooted with a CA that is in the JVM's default keystore (ie: a commercial CA).  If not, the CA cert must be added.</p>
2047     <p><span class="fixed">SimpleAttributeDefinition</span>:</p>
2048     <dl>
2049         <dd class="attribute"><span class="fixed">id = &lt;string&gt;</span> </dd>
2050         <dd class="value">Specifies a unique, textual name for the attribute 
2051         which is used as the attribute&#39;s name when it is sent over the wire by 
2052         Shibboleth. Contained within the <span class="fixed">
2053         SimpleAttributeDefinition</span> element.</dd>
2054         <dd class="attributeopt"><span class="fixed">&lt;AttributeDependency / 
2055         DataConnectorDependency requires=&quot;&lt;id&gt;&quot;/&gt;</span> </dd>
2056         <dd class="valueopt">An element of the element <span class="fixed">
2057         SimpleAttributeDefinition</span>, which may contain 0 or more of either
2058         <span class="fixed">AttributeDependency</span> or
2059         <span class="fixed">DataConnectorDependency</span>. These specify 
2060         attributes and data connectors that can be utilized by this attribute 
2061         definition. Each of these elements must contain a
2062         <span class="fixed">requires</span> statement which this attribute 
2063         definition can then use to build its value.</dd>
2064         <dd class="attributeopt"><span class="fixed">smartScope = 
2065         &quot;&lt;domain&gt;&quot;</span> </dd>
2066         <dd class="valueopt">Specifes a domain scope to be attached to the 
2067         attribute. If the value of the attribute as retrieved from the data 
2068         connector includes a pre-existing scope (<span class="fixed">bob@foo.edu</span>), 
2069         that scope is used instead. Contained within the
2070         <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
2071         <dd class="attributeopt"><span class="fixed">&lt;lifeTime 
2072         &quot;&lt;seconds&gt;&quot;/&gt;</span> </dd>
2073         <dd class="valueopt">Specifies in the attribute assertion 
2074         how long the attribute should be cached and retained by the target upon 
2075         receipt. Federations and trust agreements may have some bearing on the 
2076         population and use of this field. Contained within the
2077         <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
2078         <dd class="attributeopt"><span class="fixed">sourceName = 
2079         &quot;&lt;string&gt;&quot;</span> </dd>
2080         <dd class="valueopt">Specifies a different source attribute name to be 
2081         used in calls to the data connector, while the name on the wire will be 
2082         the specified <span class="fixed">id</span>. This would be useful 
2083         to send a local UniversityID attribute as eduPersonPrincipalName. If not 
2084         supplied, the connector tokenizes the <span class="fixed">id</span> 
2085         field and uses the section following the <span class="fixed">#</span> 
2086         to query data connectors. Contained within the <span class="fixed">
2087         SimpleAttributeDefinition</span> element.</dd>
2088         <dd class="attributeopt"><span class="fixed">&lt;cacheTime 
2089         &quot;&lt;seconds&gt;&quot;/&gt;</span> </dd>
2090         <dd class="valueopt">Specifies an optional duration in
2091         <span class="fixed">seconds</span> for which the attribute resolver 
2092         may cache this attribute for use in additional assertions.  Contained within
2093         the <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
2094     </dl>
2095     <p>A representation of a properly constructed <span class="fixed">
2096     SimpleAttributeDefinition</span> element would look like:</p>
2097     <blockquote>
2098         <p><span class="fixed">&lt;SimpleAttributeDefinition id=&quot;urn:mace:dir:attribute-def:eduPersonPrincipalName&quot;<br> 
2099         smartScope=&quot;shibdev.edu&quot; cacheTime=&quot;600&quot; lifeTime=&quot;3600&quot;  sourceName=&quot;universityPerson&quot;&gt;<br>
2100         &nbsp;&nbsp;&lt;DataConnectorDependency requires=&quot;dataConnector&quot;/&gt;<br>
2101         &nbsp;&nbsp;&lt;AttributeDependency requires=&quot;urn:mace:dir:attribute-def:eduPersonScopedAffiliation&quot;/&gt;<br>
2102         &lt;/SimpleAttributeDefinition&gt; </span></p>
2103     </blockquote>
2104     <p>A properly formed <span class="fixed">resolver.xml</span> file to 
2105     automatically generate a simple response for EPPN may take the form:</p>
2106     <blockquote>
2107         <p><span class="fixed">&lt;AttributeResolver xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; 
2108         xmlns=&quot;urn:mace:shibboleth:resolver:1.0&quot; xsi:schemaLocation=&quot;urn:mace:shibboleth:resolver:1.0 
2109         shibboleth-resolver-1.0.xsd&quot;&gt;<br>
2110         <br>
2111         &nbsp;&nbsp;&lt;SimpleAttributeDefinition id=&quot;urn:mace:dir:attribute-def:eduPersonPrincipalName&quot; 
2112         smartScope=&quot;shibdev.edu&quot;&gt;<br>
2113         &nbsp;&nbsp;&nbsp;&nbsp;&lt;DataConnectorDependency requires=&quot;echo&quot;/&gt;<br>
2114         &nbsp;&nbsp;&lt;/SimpleAttributeDefinition&gt;<br>
2115         <br>
2116         &nbsp;&nbsp;&lt;CustomDataConnector id=&quot;echo&quot; 
2117         class=&quot;edu.internet2.middleware.shibboleth.aa.attrresolv.provider.SampleConnector&quot; 
2118         /&gt;<br>
2119         &lt;/AttributeResolver&gt; </span></p>
2120     </blockquote>
2121     <p>There are additional examples of <span class="fixed">resolver.xml</span> 
2122     files provided in the
2123     <a href="http://marsalis.internet2.edu/cgi-bin/viewcvs.cgi/shibboleth/java/src/conf/">
2124     Shibboleth CVS</a>.</p>
2125 </blockquote>
2126 <p><br>
2127 </p>
2128 <h4><a name="5.d.i."></a>5.d.i <span class="fixed">resolvertest</span></h4>
2129 <blockquote>
2130     <p>Shibboleth comes bundled with the command line utility
2131     <span class="fixed">resolvertest</span> for testing Attribute Resolver 
2132     configurations. This program takes as input <span class="fixed">
2133     resolver.xml</span>, the name of a user, and optionally the name of a 
2134     requesting SHAR. It outputs the resulting SAML &lt;Attribute /&gt; elements. This 
2135     allows administrators to view the results of tweaking the resolver 
2136     configuration without having to continually reload the origin web 
2137     application. <span class="fixed">resolvertest</span> is also useful for testing when the AA  is first configured to use an attribute repository (ldap or sql). Initially, the following two steps must be performed:</p>
2138     <ol>
2139         <li>Set the shell variable <span class="fixed">SHIB_HOME</span> to 
2140         the directory path where the Shibboleth tarball was exploded (typically
2141         <span class="fixed">/opt/shibboleth-origin-1.2/</span>).</li>
2142         <li>Move to $SHIB_HOME/bin</li>
2143     </ol>
2144     <p><span class="fixed">resolvertest</span> may then be used by 
2145     executing the shell script, passing the name of a user and a URL to the 
2146     Attribute Resolver configuration file as parameters. For example:</p>
2147     <blockquote>
2148         <p><span class="fixed">$ ./resolvertest --user=wassa 
2149         --file=file:///$SHIB_HOME/src/conf/resolver.xml</span></p>
2150     </blockquote>
2151     <h5>NOTE: This program does not filter the resulting attributes through the 
2152     applicable ARP&#39;s. Although it does show the attributes generated by the 
2153     resolver for a particular user or URL, it does not necessarily reflect what 
2154     will be released by the AA to a requesting SHAR.</h5>
2155 </blockquote>
2156 <p><br>
2157 </p>
2158 <h4><a name="5.e."></a>5.e. Local Error Page</h4>
2159 <blockquote>
2160     <p>Origin sites are encouraged to provide federations with the URL of a 
2161     local Shibboleth error page. If a browser user from the origin site 
2162     encounters a problem at a shibbolized target, the target is likely to 
2163     display an error page that includes a link back to this origin provided 
2164     page.</p>
2165     <p>The page should provide information on how to obtain local support for 
2166     using Shibbolized resources. It might also include suggestions on what 
2167     information should be recorded before beginning the problem resolution 
2168     process.</p>
2169 </blockquote>
2170 <p><br>
2171 <br>
2172 </p>
2173 <h4><a name="5.f."></a>5.f. Using a New Attribute</h4>
2174 <p>In order for an attribute to be sent to a target, two steps are required:</p>
2175 <p>1. The attribute has to be defined in resolver.xml. See section <a href="#5.d.">5.d</a>.</p>
2176 <p>2. The effective ARP for that target has to release this attribute value. See section <a href="#5.b.">5.b.</a>.</p>
2177 <p>Note: resolvertest is a useful tool for verifying the correctness of the definitions.</p>
2178 <p>Note: the AAP at the target must also define this attribute. See the Shibboleth Target Deploy Guide.</p>
2179
2180 <p><br>
2181 <br>
2182 </p>
2183 <hr>
2184 <p><br>
2185 </p>
2186 <h3><a name="6."></a>6. Troubleshooting</h3>
2187 <p>This section provides basic information about testing, logging, and error 
2188 handling for Shibboleth origins. This information is not intended to be 
2189 comprehensive, but instead rudimentary guidelines for basic configuration tests 
2190 and problems. For more detailed information or answers to specific problems not 
2191 addressed in this section, please mail
2192 <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a> 
2193 with a thorough description of errors and configurations used.</p>
2194 <h4><a name="6.a."></a>6.a. Basic Testing</h4>
2195 <blockquote>
2196     <p>Internet2 provides a basic target that can be used to test origin setup 
2197     functionality. After your origin is recognized by InQueue, simply use any 
2198     browser to access <a href="https://wayf.internet2.edu/InQueue/sample.jsp">
2199     https://wayf.internet2.edu/InQueue/sample.jsp</a>. Select your origin&#39;s name 
2200     and follow the login process as a user would. Note that SSL must be used, 
2201     and both the HS and AA must be fully configured.</p>
2202     <p>The test target will then display a simple page which includes the basic 
2203     information sent to it by your origin and the authentication rules it is 
2204     using.</p>
2205     <p><b>For information regarding specific error messages that may be 
2206     generated if the origin does not work successfully, please refer to section
2207     <a href="#6.c.">6.c</a>.</b></p>
2208 </blockquote>
2209 <h4><a name="6.b."></a>6.b. Logging</h4>
2210 <blockquote>
2211     <p>Shibboleth&#39;s origin components log various operations which may prove 
2212     useful for auditing, testing, and security purposes. This data is sent 
2213     through <span class="fixed">log4j</span>&#39;s standard mechanism. The 
2214     location of the log file, the level at which the log is output, the 
2215     formatting of the logs, and many more options may be configured by editing
2216     <span class="fixed">/WEB-INF/classes/conf/log4j.properties</span>. By 
2217     default, it is setup to log to the console of the servlet container, with a 
2218     level of <span class="fixed">WARN</span>, but there is also a commented 
2219     out example in the file to give a possible alternate configuration.</p>
2220 </blockquote>
2221 <h4><a name="6.c."></a>6.c. Common Problems</h4>
2222 <blockquote>
2223     <p>A knowledge base is being developed in the
2224     <a href="http://www.columbia.edu/~wassa/shib.faq/shibboleth-faq.html">
2225     Shibboleth Deployer&#39;s FAQ</a>. Please mail
2226     <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@ 
2227     internet2.edu</a> with any additional questions or problems encountered that 
2228     are not answered by this basic guide.</p>
2229 </blockquote>
2230
2231 </body>
2232
2233 </html>