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