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