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