doc/DEPLOY-GUIDE-ORIGIN.html

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