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