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