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