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