{
color: #440000;
}
+a.fixedlink:visited
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
+a.fixedlink:link
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
+a.fixedlink:active
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
dl
{
border-width:2px; background-color: #DDDDDD;
margin: 5px;
padding: 0px;
border-style: solid;
-
}
dt
{
border-left-width: 1px;
border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
}
-.attributeopt
-{
-font-size: 115%;
-font-color: #000000;
-text-align: left;
-background-color: #BCBCEE;
-border: 1px inset black;
-background-image: url('none');
-margin: 0px;
-padding: 2px
-}
-.valueopt
+.mandatory
{
font-color: #000000;
-text-align: left;
-background-color: #DDDDFF;
-background-image: url('none');
-padding-top: 0em;
-padding-bottom: 0.5em;
-padding-right: 1em;
-padding-left: 5em;
-border-bottom-width: none;
-border-top-width: none;
-border-left-width: 1px;
-border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
+background-color: #FFCCFF;
}
.attributelong
{
margin: 0px;
padding: 2px
}
-.attributeoptlong
-{
-font-size: 85%;
-font-color: #000000;
-text-align: left;
-background-color: #BCBCEE;
-border: 1px inset black;
-background-image: url('none');
-margin: 0px;
-padding: 2px
-}
.demo
{
background-color: #EEEEEE;
padding: 3px;
}
-.fixedwidth
+.fixed
{
font-family: monospace;
font-size: 90%;
<h2>Shibboleth Origin Deployment Guide</h2>
</center>
<p>Shibboleth Origin Deployment Guide<br>
-Shibboleth Version 1.1<br>
-December 3, 2003<br>
-</p>
-<h3>This version of the deploy guide is for Shibboleth v1.1. For documentation
+Shibboleth Version 1.2<br>
+April 14, 2004<br>
+<h3>This version of the deploy guide is for Shibboleth v1.2. For documentation
related to prior versions of Shibboleth, please consult the appropriate branch
in the Shibboleth CVS.</h3>
-<h3>Federations have been abstracted out from the Shibboleth documentation. For
-further information on using Shibboleth in a federation, refer to the federation
-guide.</h3>
-<p>Shibboleth v1.1 is stable and secure enough to deploy in production
-scenarios. It is backward compatible with 1.0 in all respects, including
-configuration, but some older commands have been deprecated or replaced.</p>
-<p>Features and changes specific to 1.1 are marked with <span class="feature">
-[1.1]</span></p>
-<h4>Major New Features in 1.0 and 1.1</h4>
-<p>This new release contains several improvements and enhancements, including:
-</p>
-<h5>Federation Support</h5>
-<ol>
- <li>Federation and trust support has been substantially extended. Federation
- structures are now defined. The set of metadata collected and managed by
- each Federation is more fully defined. The configuration values assigned by
- a Federation are now identified. </li>
- <li>There is some support for targets to be members of multiple federations;
- this support will continue to evolve. When a browser user arrives, a target
- will determine which federation their origin belongs to, and then use the
- trust fabric associated with that Federation.</li>
- <li>Better support for flexible and bilateral trust agreements. A key
- specific to an origin site can be used to vallidate its signature.</li>
- <li>This version contains a significantly more mature security
- implementation, and should meet the security requirements of typical sites.</li>
-</ol>
-<h5>Origin</h5>
-<ol>
- <li>The Attribute Authority has a powerful new attribute resolver. Simple
- scenarios (using a string attribute stored in ldap) can be accomplished by
- merely editing a configuration file. Java classes may still be written for
- more complex evaluations (eg retrieving information from multiple disparate
- repositories, and computing the SAML attribute using business rules). This
- should greatly simplify the process of configuring the AA to support
- additional general attributes.</li>
- <li>A sample resolver file for using standard LDAP person and inetOrgPerson
- attributes is included. <span class="feature">[1.1]</span></li>
- <li>Support for a runtime-derived per-requester persistent identifier
- attribute to support anonymous personalization by targets has been added via
- an attribute plugin. <span class="feature">[1.1]</span></li>
- <li>Specialized sites without privacy needs can configure identity-based
- handles interoperable with other SAML deployments. <span class="feature">
- [1.1]</span></li>
-</ol>
-<h5>Target</h5>
-<ol>
- <li>Significantly more flexibility in configuring targets is provided to
- ensure robustness. Failover and redundant configurations are now supported.</li>
- <li>The SHAR may now optionally store its session and attribute cache in a
- back-end database in addition to the previously available in-memory option.
- <span class="feature">[1.1]</span> </li>
- <li>Federation supplied files (sites.xml and trust.xml) are now refreshed in
- a much more robust manner. </li>
- <li>The SHAR can be configured to request specific attributes from the
- Origin. </li>
- <li>The SHAR can use TCP sockets when responding to the Apache module, for
- specialized deployment behind firewalls. <span class="feature">[1.1]</span>
- </li>
- <li>Attribute acceptance policies have been greatly enhanced, and are now
- used to configure all aspects of attribute handling by the target, except
- for requesting specific attributes by sitename. Adding attributes now takes
- place in one configuration step. <span class="feature">[1.1]</span> </li>
- <li>Support for Apache 1.3 on Windows NT/2000/XP/2003 has been added.
- <span class="feature">[1.1]</span> </li>
- <li>Microsoft IIS web server support has been added via an ISAPI filter and
- extension. <span class="feature">[1.1]</span> </li>
-</ol>
-<h5>Miscellaneous</h5>
-<ol>
- <li>Origin sites can configure a value to describe the type of
- authentication mechanism used at the origin site (e.g. password, Kerberos,
- PKI, etc.). This value is made available on the target side as Shib-Authentication-Method.
- <br>
- </li>
- <li>Various improvements to error handling. Origin sites are now able to
- supply an "error URL" and contact information to a federation. When a target
- encounters an error, it can include this information in the error page. <br>
- </li>
- <li>Local time string values are now used in log files. <br>
- </li>
- <li>Internationalization support has been extended.</li>
-</ol>
+<h3>The default configuration of Shibboleth is <b>not</b> secure and should not
+be used for protection of production content. The example private key bundled
+with the distribution is publically available, widely circulated, and
+well-known; also, the default federation and trust metadata is for testing
+purposes only. For information about securing a Shibboleth deployment, please
+refer to the production guide. Shibboleth should only be used to protect
+sensitive content when deployed carefully in conjunction with proper trust
+settings and policies.</h3>
+
+<p>Insert features here.</p>
+
<p>Before starting, please sign up for all applicable
<a href="http://shibboleth.internet2.edu/shib-misc.html#mailinglist">mailing
lists</a>. Announcements pertinent to Shibboleth deployments and developments
and resources for deployment assistance can be found here.</p>
<p>Please send any questions, concerns, or eventual confusion to
-<a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>.
+<a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>.
This should include, but not be limited to, questions about the documentation,
undocumented problems, installation or operational issues, and anything else
that arises. Please ensure that you have the
<li><a href="#1.b."><font color="black">Target</font></a></li>
<li><a href="#1.c."><font color="black">WAYF</font></a></li>
<li><a href="#1.d."><font color="black">Federations</font></a></li>
+ <li><a href="#1.e."><font color="black">Relying Parties</font></a></li>
+ <li><a href="#1.f."><font color="black">Applications</font></a></li>
+ <li><a href="#1.g."><font color="black">Sessions</font></a></li>
</ol>
</li>
<li>
</li>
<li><a href="#4.d."><font color="black">Establishing default ARP's for
the origin community</font></a></li>
+ <li><a href="#4.e."><font color="black"><span class="fixed">metadatatool</span></font></a></li>
</ol>
</li>
<li>
<h4><a href="#5."><font color="black">Advanced Configuration</font></a></h4>
<ol type="a">
- <li><a href="#5.a."><font color="black"><span class="fixedwidth">
- origin.properties</span></font></a></li>
+ <li><a href="#5.a."><font color="black"><span class="fixed">
+ origin.xml</span></font></a></li>
<li><a href="#5.b."><font color="black">ARP Overview</font></a>
<ol type="i">
<li><a href="#5.b.i."><font color="black">ARP Processing</font></a></li>
(optional)</font></a></li>
<li><a href="#5.d."><font color="black">The Attribute Resolver</font></a>
<ol type="i">
- <li><a href="#5.d.i."><font color="black"><span class="fixedwidth">
+ <li><a href="#5.d.i."><font color="black"><span class="fixed">
resolvertest</span></font></a></li>
</ol>
</li>
information on local authentication and authorization practices for
federation members.</p>
</blockquote>
-<p><br>
-<br>
-<br>
-</p>
+<h4><a name="1.e."></a>1.e. Relying Parties</h4>
+<blockquote>
+ <p>Some aspects of both origin and target configuration can vary and be
+ expressed in terms of the "relying party". To an origin, a target
+ is a relying party, while targets consider origins to be relying
+ parties (it's a matter of perspective). Certificates, policies, and
+ other aspects of an interaction are specified on the basis of the relying
+ party, and may or may not vary between relying parties depending on the
+ deployment's needs.</p>
+ <p>Each origin and target is assigned a URI, a unique identifier to enable
+ control over configuration down to the level of an individual partner (a single
+ relying party). By convention, this is termed a "providerId". More
+ frequently, an entire federation will be viewed by an origin or target as a
+ single relying party to simplify management. An individual origin or target
+ with which this deployment exchanges information may sometimes be part of
+ multiple relying parties if there are multiple trust agreements
+ under which these transactions are performed. Care should be taken to avoid
+ conflicting or inconsistent configuration in such cases.</p>
+</blockquote>
+<h4><a name="1.f."></a>1.f. Applications</h4>
+<blockquote>
+ <p>Shibboleth "applications" are the primary unit of target
+ configuration. Applications as viewed by the target implementation
+ are not necessarily defined by the same metrics as in other contexts. An
+ individual application represents a set of web resources that operates
+ using the same attribute handling and trust configuration and shares a common
+ <a href="#1.g.">session</a> with the browser user. As a user navigates between
+ resources on a server that cross an application boundary, a new session is
+ established, though user interaction may not be required. As a consequence of
+ the relationship between applications and sessions (which are tracked with
+ a cookie), an application usually does not span more than one virtual host.
+ Apart from cookie-based constraints, web resources can be aggregated into
+ applications in arbitrary ways.</p>
+ <p>A single target deployment may support a large number of applications,
+ but it need not register or publish information about each one with the
+ origins it accepts information from. Instead it can communicate using a
+ more limited set of distinct "providerId" values (often just a
+ single one). This allows targets with a complex internal configuration
+ to be treated as a single entity by origins for the purposes of attribute
+ release.</p>
+</blockquote>
+<h4><a name="1.g."></a>1.g. Sessions</h4>
+<blockquote>
+ <p>Much of the target implementation is concerned with establishing, and
+ subsequently maintaining, sessions with the browser user on behalf of the
+ <a href="#1.f.">applications</a> at the target. A session consists of a
+ cookie passed between the browser and web server, associated with a
+ security context. The context contains the user's authentication information,
+ and generally a set of attributes that make up the user's identity. Each
+ application maintains distinct sessions with the browser by means of separate
+ cookies. It is important to note that all such sessions are independent and
+ distinct: any session can exist with or without any other session, and the
+ expiration of any one session does not imply the expiration of any other
+ session. Shibboleth also does not support any logout functionality beyond the
+ termination of individual application sessions by deletion of respective
+ cookies; also, there is no way for the target to cause origin-side sessions,
+ such as a user's SSO login, to expire.</p>
+ <p>A browser user accessing a Shibboleth-protected resource may have two
+ outcomes: standard session establishment, and lazy session
+ establishment. The standard session establishment mechanism in which
+ Shibboleth protects the resource in all circumstances results in the
+ establishment of a cookie-based browser session and a set of attributes
+ cached for that application. Shibboleth 1.2 also supports so-called lazy
+ session establishment, in which the resource may be accessed without prior
+ authentication. This means the application must be intelligent enough to
+ determine whether authentication is necessary, and then construct the proper URL
+ to initiate a browser redirect to request authentication; if the
+ application determines none is necessary or uses other authorization
+ mechanisms, then the request for authentication may not need to be triggered.
+ This complex functionality is mostly useful to protect a single URL with
+ different access mechanisms, or to require authenticated access only in
+ instances where the application deems it necessary.</p>
+ <p>Independently of this, a web-based application protected by Shibboleth
+ may have a need to establish its own session with the user. This session
+ may persist well beyond the Shibboleth session, and logouts from this
+ session, if supported, will not terminate a Shibboleth session initiated to
+ access the resource. Application administrators should carefully evaluate
+ the expiration of all sessions to limit vulnerability to attacks or user
+ negligence. Logging out of the entire desktop session is usually the
+ only (relatively) foolproof logout mechanism on the web.</p>
+</blockquote>
<hr>
-<p><br>
-</p>
<h3><a name="2."></a>2. Planning</h3>
<p>There are several essential elements that must be present in the environment
to ensure Shibboleth functions well, both political and technical. Shibboleth is
WebISO service is not explicitly necessary for Shibboleth; however, it is
highly recommended. Implementation details of this are discussed in
<a href="#4.c.">section 4.c</a>.</li>
- <li>Shibboleth is known to work on Linux and Solaris, but should function on
- any platform that has a Tomcat implementation.</li>
+ <li>Shibboleth is known to work on Windows, Linux, and Solaris, but should
+ function on any platform that has a Tomcat implementation.</li>
<li>It is recommended that a web server must be deployed that can host Java
servlets and Tomcat, although not explicitly necessary, as Tomcat can still
host an origin without it.</li>
relationships. Each federation will have a different application process.
When an origin is accepted into a federation, its information is added to
the sites file used by the WAYF and target sites.</p>
- <p><b>It may be necessary to join multiple federations depending on the
- sites with whom you wish to exchange attributes and the terms under which
- these interactions will take place. An origin site exists within the context
- of a single federation, while a single target may accept assertions issued
- by multiple federations if they are all recognized by the SHAR. If an
- organization wishes to be a member of multiple federations, it must run a
- separate origin site for each federation, including a separate AA and HS.</b></p>
- <p>Attribute release and acceptance policies, the use and caching of
- attributes, and definition of commonly traded attributes are examples of
- specifications a federation may make. For more information on federations,
- please refer to the Deployer's Guide to Federations and the Shibboleth v1.0
- architectural document.</p>
+ <p>Attribute release and acceptance policies, the use and caching of
+ attributes, and definition of commonly traded attributes are examples of
+ specifications a federation may make. <b>The default configuration that
+ ships with Shibboleth is intended for use in testing against a <span
+ class="fixed">localhost</span> target. In order to interoperate with other
+ relying parties, such as a federation, consult the steps provided by the
+ guidelines of that relying party.</b></p>
</blockquote>
<h4><a name="2.c."></a>2.c. Security Considerations</h4>
<blockquote>
<h4><a name="3.a."></a>3.a. Software Requirements</h4>
<p><b>The following requirements are primarily recommendations based on the most
common ways to run Shibboleth. However, the origin should be able to run under
-any servlet container supporting <span class="fixedwidth">Servlet API v2.3</span>
-and <span class="fixedwidth">JSP specification 1.2</span>.</b></p>
+any servlet container supporting <span class="fixed">Servlet API v2.3</span>
+and <span class="fixed">JSP specification 1.2</span>.</b></p>
<blockquote>
<ul type="circle">
<li><a href="http://http://www.apache.org/dist/httpd/">Apache 1.3.26+
(<2.0)</a></li>
<li><a href="http://jakarta.apache.org/tomcat/">Tomcat 4.1.18-24 LE Java
- server</a></li>
+ server and above</a></li>
<li><a href="http://java.sun.com/j2se/">Sun J2SE JDK v1.4.1_01 and above</a>
<blockquote>
<p>Other versions of the JRE are not supported and are known to
cause errors when working with certificates.</p>
</blockquote>
</li>
- <li>mod_jk
+ <li>mod_jk or mod_jk2
<blockquote>
<p>You may need to build mod_jk against Apache, which will generally
require GCC or a platform-specific C compiler.</p>
<ol type="1">
<li>Ensure you have already obtained the proper
<a href="http://shibboleth.internet2.edu/release/shib-download.html">.tarball</a>.</li>
- <li>The archive will expand into a <span class="fixedwidth">
- shibboleth-origin-1.1/</span> directory(<span class="fixedwidth">/opt/</span>
+ <li>The archive will expand into a <span class="fixed">
+ shibboleth-origin-1.2/</span> directory(<span class="fixed">/opt/</span>
recommended).</li>
<li>Run the following command to move the Java files into Tomcat's tree:<blockquote>
- <p><span class="fixedwidth">cp /opt/shibboleth-origin-1.1/dist/shibboleth.war
+ <p><span class="fixed">cp /opt/shibboleth-origin-1.2/dist/shibboleth.war
/usr/local/tomcat/webapps/</span> </p>
</blockquote>
</li>
be located in a special "endorsed" folder to override obsolete classes
that Sun includes with their JVM. To deal with this problem use the
following command, adjusting paths as needed:<blockquote>
- <p><span class="fixedwidth">$ cp
- /opt/shibboleth-origin-1.1/endorsed/*.jar /usr/local/tomcat/common/endorsed</span>
+ <p><span class="fixed">$ cp
+ /opt/shibboleth-origin-1.2/endorsed/*.jar /usr/local/tomcat/common/endorsed</span>
</p>
</blockquote>
<p>Different versions of Tomcat or other Java servers may have other
endorse classes, if necessary.</li>
<li>Restart Tomcat, which will automatically detect that there has been
a new .war file added. This file will by default be expanded into
- <span class="fixedwidth">/usr/local/tomcat/webapps/shibboleth</span>.</li>
+ <span class="fixed">/usr/local/tomcat/webapps/shibboleth</span>.</li>
<li>Apache must be told to map the URL's for the Shibboleth HS and AA to
Tomcat. Two popular ways of doing this are to include the following text
- directly in <span class="fixedwidth">httpd.conf</span>, or to place
- <span class="fixedwidth">Include conf/mod_jk.conf</span> in
- <span class="fixedwidth">httpd.conf</span>, and place the following
- lines in <span class="fixed
width">/etc/httpd/conf/mod_jk.conf</span>:<blockquote>
- <p><span class="fixedwidth">--------- begin ---------<br>
+ directly in <span class="fixed">httpd.conf</span>, or to place
+ <span class="fixed">Include conf/mod_jk.conf</span> in
+ <span class="fixed">httpd.conf</span>, and place the following
+ lines in <span class="fixed">/etc/httpd/conf/mod_jk.conf</span>:<blockquote>
+ <p><span class="fixed">--------- begin ---------<br>
<IfModule !mod_jk.c><br>
LoadModule jk_module libexec/mod_jk.so<br>
</IfModule><br>
--------- end ---------</span> </p>
</blockquote>
</li>
- <li>Tomcat's <span class="fixedwidth">/conf/server.xml</span> ships by
+ <li>Tomcat's <span class="fixed">/conf/server.xml</span> ships by
default with the Coyote/JK2 connector enabled, which fails with
- Shibboleth due to the lack of support for <span class="fixedwidth">
+ Shibboleth due to the lack of support for <span class="fixed">
REMOTE_USER</span>. This connector must be commented out. Then,
uncomment and modify the traditional AJP 1.3 connector as follows:<ol type="A">
- <li>Add <span class="fixedwidth">address="127.0.0.1"</span> inside
- the <span class="fixedwidth"><Ajp13Connector></span> configuration
+ <li>Add <span class="fixed">address="127.0.0.1"</span> inside
+ the <span class="fixed"><Ajp13Connector></span> configuration
element to prevent off-host access.</li>
- <li>Add <span class="fixedwidth">tomcatAuthentication="false"</span>
- to the <span class="fixedwidth"><Ajp13Connector></span>
+ <li>Add <span class="fixed">tomcatAuthentication="false"</span>
+ to the <span class="fixed"><Ajp13Connector></span>
configuration element to ensure that the user's identity is passed
from Apache to the servlet environment.</li>
<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>
</li>
<li>It is <b>strongly</b> recommended that the AA be SSL-protected to
protect attributes in transit. To do so, add an appropriate location
- block to <span class="fixed
width">httpd.conf</span>:<blockquote>
- <p><span class="fixedwidth"><Location /shibboleth/AA>
+ block to <span class="fixed">httpd.conf</span>:<blockquote>
+ <p><span class="fixed"><Location /shibboleth/AA>
<br> SSLVerifyClient optional
<br> SSLOptions +StdEnvVars +ExportCertData
<br></Location> </span></p>
<h3><a name="4."></a>4. Getting Running</h3>
<h4><a name="4.a."></a>4.a. Basic Configuration</h4>
<blockquote>
- <p><b>This section of the deploy guide specifies only the essential changes
- that need to be made to the configuration defaults for the origin to
- function successfully in a federated environment. More complex configuration
- will likely be required for many applications and federations; for a full
- description of every field in <span class="fixedwidth">origin.properties</span>,
- please refer to <a href="#5.a.">section 5.a</a>.</b></p>
- <p>The main configuration file for Shibboleth's origin side is located in
- <span class="fixedwidth">/webapps/shibboleth/WEB-INF/classes/conf/origin.properties.</span>.
- This file contains configuration information for the origin side in several
- sections. The configuration must be consistent with values elsewhere in the
- deployment, such as the <a href="#4.c.">HS' certificate</a> and with
- directory access bindings, etc., or access errors may occur.</p>
- <p>All pathnames are relative, and have an effective root path of
- <span class="fixedwidth">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>.
- To specify files outside of the webapp, specify a full URI, such as
- <span class="fixedwidth">file:///usr/local/shibboleth/</span>.</p>
+ <p>This section of the deploy guide describes only the default <span
+ class="fixed">origin.xml</span> file and enumerates the essential
+ changes that need to be made to the configuration defaults for the origin to
+ function successfully in a federated environment. More complex configuration
+ will likely be required for many applications and federations; for a fully
+ defined example <span class="fixed">origin.xml</span> and definition of
+ every element and attribute that may be used, please refer to <a
+ href="#5.a.">section 5.a</a>.</p>
+ <p><b>The default configuration that ships with Shibboleth is intended for
+ use in testing against a <span class="fixed">localhost</span> target. In
+ order to interoperate with other relying parties, such as a federation,
+ consult the steps provided by the guidelines of that relying party.</b></p>
+ <p>The main configuration file for Shibboleth's origin side is located
+ in <span
+ class="fixed">/webapps/shibboleth/WEB-INF/classes/conf/origin.xml</span>.
+ The configuration must be consistent with values elsewhere in the
+ deployment, such as the <a href="#4.c.">HS' certificate</a> and with
+ directory access bindings, etc., or access errors may occur. All pathnames
+ are relative, and have an effective root path of <span
+ class="fixed">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>. To
+ specify files outside of the webapp, specify a full URI, such as <span
+ class="fixed">file:///usr/local/shibboleth/</span>.</p>
+ <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>
+
+<blockquote><span class="fixed">
+<?xml version="1.0"encoding="UTF-8"?><br>
+<br>
+<a href="#confShibbolethOriginConfig" class="fixedlink"><ShibbolethOriginConfig <br>
+ xmlns="urn:mace:shibboleth:origin:1.0"<br>
+ xmlns:cred="urn:mace:shibboleth:credentials:1.0"<br>
+ xmlns:name="urn:mace:shibboleth:namemapper:1.0"<br>
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br>
+ xsi:schemaLocation="urn:mace:shibboleth:origin:1.0 origin.xsd"<br>
+ AAUrl="http://therock.cc.columbia.edu:6666/shibboleth/AA"<br>
+ defaultRelyingParty="urn:mace:inqueue"<br>
+ providerId="urn:mace:inqueue:shibdev.edu"></a><br>
+<br>
+<a href="#confRelyingParty" class="fixedlink"> <RelyingParty name="urn:mace:inqueue" signingCredential="foo"><br></a>
+<a href="#confHSNameFormat" class="fixedlink"> <HSNameFormat nameMapping="crypto"/></a><br>
+<a href="#confRelyingParty" class="fixedlink"> </RelyingParty></a><br>
+<br>
+<a href="#confReleasePolicyEngine" class="fixedlink"> <ReleasePolicyEngine><br></a>
+<a href="#confArpRepository" class="fixedlink"> <ArpRepository implementation="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository"></a><br>
+<a href="#confPath" class="fixedlink"> <Path>/conf/arps/</Path></a><br>
+<a href="#confArpRepository" class="fixedlink"> </ArpRepository></a><br>
+<a href="#confReleasePolicyEngine" class="fixedlink"> </ReleasePolicyEngine></a><br>
+<br>
+ <!--<br>
+<a href="#confLogging" class="fixedlink"> <Logging></a><br>
+<a href="#confLog4JConfig" class="fixedlink"> <Log4JConfig location="file:///tmp/log4j.properties"/></a><br>
+<a href="#confLogging" class="fixedlink"> </Logging></a><br>
+<a href="#confLogging" class="fixedlink"> <Logging></a><br>
+<a href="#confErrorLog" class="fixedlink"> <ErrorLog level="DEBUG" location="file:///tmp/shib-error.log"/></a><br>
+<a href="#confTransactionLog" class="fixedlink"> <TransactionLog location="file:///tmp/shib-access.log"/></a><br>
+<a href="#confLogging" class="fixedlink"> </Logging></a><br>
+ --><br>
+<br>
+<a href="#confNameMapping" class="fixedlink"> <NameMapping <br>
+ xmlns="urn:mace:shibboleth:namemapper:1.0"<br>
+ id="crypto"<br>
+ format="urn:mace:shibboleth:1.0:nameIdentifier"<br>
+ type="SharedMemoryShibHandle"<br>
+ handleTTL="1800"/></a><br>
+<br>
+<a href="#confCredentials" class="fixedlink"> <Credentials xmlns="urn:mace:shibboleth:credentials:1.0"></a><br>
+<a href="#confFileResolver" class="fixedlink"> <FileResolver Id="foo"></a><br>
+<a href="#confKey" class="fixedlink"> <Key format="DER"></a><br>
+<a href="#confPath" class="fixedlink"> <Path>/conf/shib2.key</Path></a><br>
+<a href="#confKey" class="fixedlink"> </Key></a><br>
+<a href="#confCertificate" class="fixedlink"> <Certificate format="PEM"></a><br>
+<a href="#confPath" class="fixedlink"> <Path>/conf/shib2.crt</Path></a><br>
+<a href="#confCertificate" class="fixedlink"> </Certificate></a><br>
+<a href="#confFileResolver" class="fixedlink"> </FileResolver></a><br>
+<a href="#confCredentials" class="fixedlink"> </Credentials></a><br>
+<a href="#confFederationProvider" class="fixedlink"> <FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper" uri="/conf/sites.xml"/></a><br>
+<br>
+<a href="#confShibbolethOriginConfig" class="fixedlink"></ShibbolethOriginConfig></a>
+</span></blockquote>
+
+<p>The following changes must be made to the default configuration before the
+origin will interoperate in a federation.</p>
<ol type="1">
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer = <domain
- name></span>
- <blockquote>
- <p>This will be, in most cases, the DNS name of the machine on which
- the HS runs. It must match the CN of the certificate used below.</p>
- </blockquote>
- </li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName = <URI></span>
- <blockquote>
- <p>Enter the value assigned to the site by the federation.</p>
- </blockquote>
- </li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl = <url></span>
- <blockquote>
- <p>This will be the URL assigned the AA servlet in step
- <a href="#3.b.">3.b</a>. 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.</p>
- </blockquote>
- </li>
- <li> <ul type="circle">
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath =
- <pathname></span></li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword
- = <password></span></li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias
- = <alias></span></li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword
- = <password></span></li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias =
- <alias></span></li>
- </ul>
- <blockquote>
- <p>Respectively, the location and password of the Java keystore
- containing the x.509 certificate and matching private key to be used
- by the HS, the alias and password of the private key, and the
- optional certificate alias, if it differs from the key's alias.</p>
- </blockquote>
+ <li>
+ <p>Attributes within the <a href="#confShibbolethOriginConfig"><span
+ class="fixed">ShibbolethOriginConfig</span></a> element:</p>
+ <ol type="a">
+ <li><a href="#confShibbolethOriginConfig"><span class="fixed">AAUrl=<i>URL</i></span></a>
+ <blockquote>
+ <p>This will be the URL assigned the AA servlet in step
+ <a href="#3.b.">3.b</a>. Note that this <b>must</b> be an
+ <span class="fixed">https://</span> URL in order for the AA to
+ authenticate the requesting SHAR.</p>
+ </blockquote>
+ </li>
+ <li><a href="#confShibbolethOriginConfig"><span class="fixed">providerID=<i>URI</i></span></a>
+ <blockquote>
+ <p>This will be the URI assigned to this origin by the
+ federation.</p>
+ </blockquote>
+ </li>
+ <li><a href="#confShibbolethOriginConfig"><span class="fixed">defaultRelyingParty=<i>URI</i></span></a>
+ <blockquote>
+ <p>This is the URI of the primary federation that the origin
+ operates within.</p>
+ </blockquote>
+ </li>
+ </ol>
</li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName = <domain
- name></span>
- <blockquote>
- <p>Specifies the name of the AA, which is typically the domain name
- of the server running it.</p>
- </blockquote>
+ <li>
+ <p>Although not explicitly necessary, it's highly recommended for
+ initial installation and testing that logging be activated at the <span
+ class="fixed">DEBUG</span> level by uncommenting the second <a
+ href="#confLogging"><span class="fixed">Logging</span></a> element and
+ ensuring that the pathnames for <a href="#confTransactionLog"><span
+ class="fixed">TransactionLog</span></a> and <a
+ href="#confErrorLog"><span class="fixed">ErrorLog</span></a> are
+ appropriate. However, in production, this will slow the operation of
+ the origin considerably.</p>
</li>
- <li><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.audiences = <URI></span>
- <blockquote>
- <p>This section must contain the URI of the federation under which
- the origin will operate or test initially. This will be provided by
- the federation.</p>
- </blockquote>
+ <li>
+ <p>The default configuration file informs Shibboleth to load its key and
+ certificate from flat files. The <a href="#confKey"><span
+ class="fixed">Key</span></a> element specifies a key in <span
+ class="fixed">DER</span> format located at <span
+ class="fixed">/conf/shib2.key</span>, while the <a
+ href="#confCertificate"><span class="fixed">Certificate</span></a>
+ element specifies the corresponding certificate in <span
+ class="fixed">PEM</span> format located at <span
+ class="fixed">/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>
+ <p>To create proper keys and certificates for production use, please
+ refer to <a href="#4.b.">section 4.b</a>.</p>
</li>
</ol>
</blockquote>
5.d.</a></p>
<p>In order to make the Shibboleth software operational, however, minor
edits must be made to the example version of the resolver.xml file. The file
- can be found at <span class="fixedwidth">/webapps/shibboleth/WEB-INF/classes/conf/resolver.xml.</span>
+ can be found at <span class="fixed">/webapps/shibboleth/WEB-INF/classes/conf/resolver.xml.</span>
Two changes are necessary:</p>
<p>1. The value of the smartScope attribute should be changed to the Domain
Name value submitted to the Federation. It appears on two
</p>
<h4><a name="4.b."></a>4.b. Key Generation and Certificate Installation</h4>
<blockquote>
- <p>The SAML messages generated by the HS must be digitally signed. Each HS
- must be issued a private and public keypair, which is stored in a Java
- keystore. The current implementation of Shibboleth requires the use of an
- ordinary file-based keystore. The keytool program is included with the Java
- development and runtime kits. Access parameters to the keystore will need to
- be consistent with those specified in <span class="fixedwidth">
- origin.properties</span>.</p>
- <p>A sample keystore is included in the distribution and can be found in
- <span class="fixedwidth">/usr/local/tomcat/webapps/shibboleth/WEB-INF/classes/conf/keystore
- .jks</span> with a password of <span class="fixedwidth">shibhs</span>. It is
- intended to serve as an example and not as a production keystore.</p>
- <p>The following commands will generate a new RSA keypair and store it in
- the <span class="fixedwidth">keystore.jks</span> file, with a keyentry alias
- of <span class="fixedwidth">hs</span> and new passwords of your choosing:</p>
- <blockquote>
- <p><span class="fixedwidth">$ cd /usr/local/tomcat/webapps/shibboleth/WEB-INF/classes/conf<br>
- $ keytool -storepasswd -keystore keystore.jks -new <newpassword><br>
- $ keytool -genkey -keystore keystore.jks -alias hs -keyalg rsa -keysize
- 2048<br>
- </span></p>
- </blockquote>
- <p>You will be prompted for passwords during key generation as needed, to
- access the keystore and assign the key itself its own password. You will
- also be prompted for the distinguished name components to associate with the
- key. This DN will be placed in a self-signed certificate and will be the
- name that is associated with your HS by Shibboleth. In particular, the first
- component you enter for Name will be the <span class="fixedwidth">Common
- Name</span>(when keytool asks for first and last name, common name is
- intended), which in most cases should be the hostname of the HS system. Note
- that a specific federation of sites may dictate what type of key algorithm,
- key size, or validity period is appropriate.</p>
- <p>Once you have a keypair generated, the self-signed certificate must be
- replaced with a certificate signed by a CA acceptable to the federation you
- will be joining. Shibboleth is generally able to climb trust chains to reach
- an intermediate CA's root CA. Note that the intermediate CA's signing
- certificate must still be signed by a root CA recognized by the federation.</p>
- <p>To generate a certificate signing request for a CA, use the following
- command:</p>
- <blockquote>
- <p><span class="fixedwidth">$ keytool -certreq -keystore keystore.jks
- -alias hs -file <csr-file><br>
- </span></p>
- </blockquote>
- <p>The contents of <span class="fixedwidth"><csr-file></span> can then be
- sent to a CA for signing. You will receive a signed certificate in return in
- a file. To install the new certificate into your keystore, use the following
- command:</p>
- <blockquote>
- <p><span class="fixedwidth">$ keytool -import -keystore keystore.jks
- -alias hs -file <cert-file></span> </p>
- </blockquote>
- <p>Note that if the signing CA's certificate is not already installed in
- your keystore as a trusted signer, you may need to download the CA's root
- certificate and import it into the keystore file under a different alias,
- using a command similar to the above.</p>
- <p>For information on sharing certificate/key pairs between Apache and Java
- keystores see section <a href="#5.c.">5.c.</a>.</p>
+ <p>The SAML messages generated by the HS must be digitally signed, which
+ requires the HS be issued a private key and corresponding certificate. In
+ most instances, the web server will be configured to use SSL, which will
+ also require a cert/key pair. In many cases, these certs/keys can be shared
+ between Apache/IIS and the HS; for information on sharing certificate/key
+ pairs between Apache and Java keystores see section <a
+ href="#5.c.">5.c.</a>. Sharing credentials is simplest when using flat-file
+ unencrypted PEM-format certs/keys as expected by Apache.</p>
+
+ <p>The 1.2 origin accommodates keys and certificates in a very wide variety
+ of formats and storage mechanisms. Java keystores may be specified in a <a
+ href="#confKeyStoreResolver"><span class="fixed">KeyStoreResolver</span></a>
+ element or flat-file keys and certificates may be specified using a <a
+ href="#confFileResolver"><span class="fixed">FileResolver</span></a> in <a
+ href="#5.a."><span class="fixed">origin.xml</span></a>. The information in
+ that file must be consistent with the values that are established in this
+ process.</p>
+
+ <p>The following text suggests a way to generate a key and certificate in
+ flat-file PEM format, which will be simplest for most deployments. Once the
+ key pair is generated, the public key must be sent to a certificate
+ authority recognized by relying parties with which this origin will interact
+ to be signed into a certificate. OpenSSL must be installed to perform this
+ process.</p>
+
+ <p>The certificate and key file location should be based on whether they
+ will also be used for Apache. If they will be used as a server certificate
+ as well, they should probably be in the Apache tree in the usual <span
+ class="fixed">mod_ssl</span>-defined locations inside the Apache
+ configuration folder. If the certificate and key will only be used by
+ Shibboleth, they can be put in the same folder with the <span
+ class="fixed">origin.xml</span> file and protected appropriately.</p>
+
+ <p>OpenSSL commands to generate a new keypair and a certificate request are
+ shown here, assuming 2048 bit RSA keys are to be used:</p>
+
+ <blockquote><span class="fixed"> $ openssl genrsa -des3 -out ssl.key
+ 2048<br> $ openssl req -new -key ssl.key -out ssl.csr </span></blockquote>
+
+ <p>The signed certificate file returned by the CA should be usable directly,
+ or can be converted to PEM format using the <span class="fixed">openssl
+ x509</span> command.</p>
</blockquote>
<h4><a name="4.c."></a>4.c. Linking the Authentication System to the HS</h4>
<blockquote>
<p>The interaction between the HS and the local authentication system is
implemented by supplying the HS with the identity of the browser user. Most
often, this will mean protecting the HS servlet with some form of local
- authentication that populates <span class="fixedwidth">REMOTE_USER</span>.
- Location blocks can be added to <span class="fixedwidth">httpd.conf</span>,
+ authentication that populates <span class="fixed">REMOTE_USER</span>.
+ Location blocks can be added to <span class="fixed">httpd.conf</span>,
associating the appropriate authentication mechanism with the URL of the HS
servlet. The following example demonstrates association of a very basic
authentication method with the HS:</p>
<blockquote>
- <p><span class="fixedwidth"><Location /shibboleth/HS><br>
+ <p><span class="fixed"><Location /shibboleth/HS><br>
AuthType Basic<br>
AuthName "Internet2 Handle Service"<br>
AuthUserFile /usr/local/apache/conf/user.db<br>
of a filter that relies on the web server to do all processing to ensure
that the certificate is both valid and appropriate for the application.
An example deployment descriptor is included with the Shibboleth
- distribution at <span class="fixedwidth">$SHIB_HOME/webAppConfig/origin-client-cert.xml</span>.
- To enable the filter, add the following to the deployment descriptor (<span class="fixedwidth">web.xml</span>):</p>
+ distribution at <span class="fixed">$SHIB_HOME/webAppConfig/origin-client-cert.xml</span>.
+ To enable the filter, add the following to the deployment descriptor (<span class="fixed">web.xml</span>):</p>
<blockquote>
- <p><span class="fixedwidth"> <filter><br>
+ <p><span class="fixed"> <filter><br>
<filter-name><br>
Client Cert AuthN Filter<br>
</filter-name><br>
</span></p>
</blockquote>
<p>By default, the filter pulls the principal name out of the
- <span class="fixedwidth">CN</span> of the cert's
- <span class="fixedwidth">Subject</span> by using regular expression
+ <span class="fixed">CN</span> of the cert's
+ <span class="fixed">Subject</span> by using regular expression
grouping. This may be done using patterns such as:</p>
<blockquote>
- <p><span class="fixedwidth">regex: '.*CN=([^,/]+).*' match group: 1</span>
+ <p><span class="fixed">regex: '.*CN=([^,/]+).*' match group: 1</span>
</p>
</blockquote>
<p>The servlet filter will accept two initialization parameters,
- <span class="fixedwidth">regex</span> and <span class="fixedwidth">
+ <span class="fixed">regex</span> and <span class="fixed">
matchGroup</span> that can be used to extract the principal name
differently.</p>
</blockquote>
information regarding how ARP's are processed or syntactically formed,
please refer to section <a href="#5.b.i.">5.b.i</a>.</p>
</blockquote>
+<h4><a name="4.e."></a>4.e. <span class="fixed">metadatatool</span></h4>
+<blockquote>
+ <p>The Shibboleth origin leverages metadata distributed by relying parties and federations to validate the identity of requesters and the resource providers on whose behalf the request is being made. This metadata is cached locally in the form of <span class="fixed">sites.xml</span> files. Shibboleth includes a simple utility called <span class="fixed">metadatatool</span> which can be used to refresh a <span class="fixed">sites.xml</span> file. These files are then pointed to by <a href="#confFederationProvider"><span class="fixed">FederationProvider</span></a> elements in <a href="#5.a."><span class="fixed">shibboleth.xml</span></a>.</p>
+<p>The following command is appropriate for most deployments and is run from the $SHIB_HOME directory. This should be frequently run by adding it to a <span class="fixed">crontab</span> to ensure that the data is fresh.</p>
+
+<blockquote><span class="fixed">bin/metadatatool -i https://wayf.internet2.edu/InQueue/sites.xml -k conf/internet2.jks -p shib123 -a sitesigner -o /your_path_here/sites.xml</span></blockquote>
+
+<p>This is a list of all the command-line parameters that may be specified:</p>
+
+<blockquote><span class="fixed">when signing: -i <uri> -s -k <keystore> -a <alias> -p <pass> [-o
+<outfile>]<br>
+when updating: -i <uri> [-k <keystore> -a <alias> OR -N ] [-o <outfile>]<br>
+
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td width="150">-i,--in</td><td>input file or url</td></tr>
+<tr><td width="150">-k,--keystore</td><td>pathname of Java keystore file</td></tr>
+<tr><td width="150">-a,--alias</td><td>alias of signing or verification key</td></tr>
+<tr><td width="150">-p,--password</td><td>keystore/key password</td></tr>
+<tr><td width="150">-o,--outfile</td><td>write signed copy to this file instead of stdout</td></tr>
+<tr><td width="150">-s,--sign</td><td>sign the input file and write out a signed version</td></tr>
+<tr><td width="150">-N,--noverify</td><td>allows update of file without signature check</td></tr>
+<tr><td width="150">-h,--help</td><td>print a list of configuration options</td></tr>
+<tr><td width="150">-x,--ns</td><td>XML namespace of root element</td></tr>
+<tr><td width="150">-n,--name</td><td>name of root element</td></tr>
+</table>
+</span></blockquote>
+ <p>Shibboleth 1.2 still utilizes <span class="fixed">mod_ssl</span> for verification of certificates presented by SHAR's when processing attribute requests. This requires an updated <span class="fixed">ca-bundle.crt</span> to ensure that all appropriate certificate authorities used by relying parties are recognized.</p>
+</blockquote>
<p><br>
</p>
<hr>
<p><br>
</p>
<h3><a name="5."></a>5. Advanced Configuration</h3>
-<h4><a name="5.a."></a><span class="fixedwidth">origin.properties</span></h4>
+<h4><a name="5.a."></a>5.a. <span class="fixed">origin.xml</span></h4>
<blockquote>
- <p>The main configuration file for Shibboleth's origin side is located in
- <span class="fixedwidth">/webapps/shibboleth/WEB-INF/classes/conf/origin.properties.</span>.
- This file contains configuration information for the origin side in several
- sections. The configuration must be consistent with values elsewhere in the
- deployment, such as the <a href="#4.c.">HS' certificate</a> and with
- directory access bindings, etc., or access errors may occur.</p>
- <p>All pathnames are relative, and have an effective root path of
- <span class="fixedwidth">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>.
- To specify files outside of the webapp, specify a full URI, such as
- <span class="fixedwidth">file:///usr/local/shibboleth/</span>.</p>
- <p>Fields that are purple are optional; grey fields are mandatory.</p>
- <p>These are the variables that may be specified for each component of
- <span class="fixedwidth">origin.properties</span>:</p>
- <p><br>
- </p>
- <p>General Configuration:</p>
+ <p>Shibboleth 1.2 origins are configured using the <span
+ class="fixed">origin.xml</span> file located in <span
+ class="fixed">/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>. The following is an example <span
+ class="fixed">origin.xml</span> file which contains all possible
+ configuration parameters and values. The configuration must be consistent
+ with values elsewhere in the deployment or access errors may occur. For a
+ more basic example, consult <a href="#4.a.">section 4.a</a>. This is useful
+ to demonstrate the structure that other types of configurations have. Few
+ deployments will need configuration files this complex.</p>
+
+<blockquote><span class="fixed">
+<?xml version="1.0" encoding="UTF-8"?><br>
+<br>
+<a href="#confShibbolethOriginConfig" class="fixedlink"><ShibbolethOriginConfig<br>
+ xmlns="urn:mace:shibboleth:origin:1.0"<br>
+ xmlns:cred="urn:mace:shibboleth:credentials:1.0"<br>
+ xmlns:name="urn:mace:shibboleth:namemapper:1.0"<br>
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br>
+ xsi:schemaLocation="urn:mace:shibboleth:origin:1.0 origin.xsd"<br>
+ AAUrl="http://therock.cc.columbia.edu:6666/shibboleth/AA"<br>
+ defaultRelyingParty="urn:mace:inqueue"<br>
+ providerId="urn:mace:inqueue:shibdev.edu"></a><br>
+<br>
+ <!-- Default relying party --><br>
+ <a href="#confRelyingParty" class="fixedlink"><RelyingParty name="urn:mace:inqueue" signingCredential="foo"></a><br>
+ <a href="#confHSNameFormat" class="fixedlink"><HSNameFormat nameMapping="crypto"/></a><br>
+ <a href="#confRelyingParty" class="fixedlink"></RelyingParty></a><br>
+<br>
+ <!-- This site is in InQueue, but we want to send explicit errors to them --><br>
+ <a href="#confRelyingParty" class="fixedlink"><RelyingParty name="urn:mace:inqueue:example.edu" signingCredential="foo" passThruErrors="true"></a><br>
+ <a href="#confHSNameFormat" class="fixedlink"><HSNameFormat nameMapping="crypto"/></a><br>
+ <a href="#confRelyingParty" class="fixedlink"></RelyingParty></a><br>
+<br>
+ <!-- This references domain local service providers --><br>
+ <a href="#confRelyingParty" class="fixedlink"><RelyingParty name="urn-x:localFed" signingCredential="bar" passThruErrors="true" providerId="urn-x:localSite"></a><br>
+ <a href="#confHSNameFormat" class="fixedlink"><HSNameFormat nameMapping="clear"/></a><br>
+ <a href="#confRelyingParty" class="fixedlink"></RelyingParty></a><br>
+<br>
+ <a href="#confReleasePolicyEngine" class="fixedlink"><ReleasePolicyEngine></a><br>
+ <a href="#confArpRepository" class="fixedlink"><ArpRepository implementation="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository"></a><br>
+ <a href="#confPath" class="fixedlink"><Path>/conf/arps/</Path></a><br>
+ <a href="#confArpRepository" class="fixedlink"></ArpRepository></a><br>
+ <a href="#confReleasePolicyEngine" class="fixedlink"></ReleasePolicyEngine></a><br>
+<br>
+ <a href="#confLogging" class="fixedlink"><Logging></a><br>
+ <a href="#confErrorLog" class="fixedlink"><ErrorLog level="DEBUG" location="file:///var/log/shib-error.log" /></a><br>
+ <a href="#confTransactionLog" class="fixedlink"><TransactionLog location="file:///var//log/shib-access.log" /></a><br>
+ <a href="#confLogging" class="fixedlink"></Logging></a><br>
+<br>
+ <a href="#confNameMapping" class="fixedlink"><NameMapping<br>
+ xmlns="urn:mace:shibboleth:namemapper:1.0"<br>
+ id="crypto"<br>
+ format="urn:mace:shibboleth:1.0:nameIdentifier"<br>
+ type="SharedMemoryShibHandle"<br>
+ handleTTL="1800"/></a><br>
+<br>
+ <a href="#confNameMapping" class="fixedlink"><NameMapping<br>
+ xmlns="urn:mace:shibboleth:namemapper:1.0"<br>
+ id="clear"<br>
+ format="urn-x:test:NameIdFormat1"<br>
+ type="Principal"/></a><br>
+<br>
+ <a href="#confCredentials" class="fixedlink"><Credentials xmlns="urn:mace:shibboleth:credentials:1.0"></a><br>
+ <a href="#confFileResolver" class="fixedlink"><FileResolver Id="foo"></a><br>
+ <a href="#confKey" class="fixedlink"><Key format="DER"></a><br>
+ <a href="#confPath" class="fixedlink"><Path>/conf/shib2.key</Path></a><br>
+ <a href="#confKey" class="fixedlink"></Key></a><br>
+ <a href="#confCertificate" class="fixedlink"><Certificate format="PEM"></a><br>
+ <a href="#confPath" class="fixedlink"><Path>/conf/shib2.crt</Path></a><br>
+ <a href="#confCertificate" class="fixedlink"></Certificate></a><br>
+ <a href="#confFileResolver" class="fixedlink"></FileResolver></a><br>
+<br>
+ <a href="#confKeyStoreResolver" class="fixedlink"><KeyStoreResolver Id="bar" storeType="JKS"></a><br>
+ <a href="#confPath" class="fixedlink"><Path>/conf/keystore.jks</Path></a><br>
+ <a href="#confKeyAlias" class="fixedlink"><KeyAlias>shibhs</KeyAlias></a><br>
+ <a href="#confCertAlias" class="fixedlink"><CertAlias>shibhs</CertAlias></a><br>
+ <a href="#confStorePassword" class="fixedlink"><StorePassword>shibhs</StorePassword></a><br>
+ <a href="#confKeyPassword" class="fixedlink"><KeyPassword>shibhs</KeyPassword></a><br>
+ <a href="#confKeyStoreResolver" class="fixedlink"></KeyStoreResolver></a><br>
+ <a href="#confCredentials" class="fixedlink"></Credentials></a><br>
+<br>
+ <a href="#confFederationProvider" class="fixedlink"><FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper"<br>
+ uri="/conf/sites.xml"/></a><br>
+ <a href="#confFederationProvider" class="fixedlink"><FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper"<br>
+ uri="/conf/local-sites.xml"/></a><br>
+<br>
+<a href="#confShibbolethOriginConfig" class="fixedlink"></ShibbolethOriginConfig></a>
+</span></blockquote>
+
+ <p>The following is a complete, alphabetical list of all configuration
+ elements and their valid attributes and population. Each element also has a
+ description of the elements it may contain and the elements that may contain
+ it.</p>
+
+ <p>All pathnames are relative, and have an effective root path of <span
+ class="fixed">$TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/</span>. To
+ specify files outside of the webapp, specify a full URI, such as <span
+ class="fixed">file:///usr/local/shibboleth/</span>.</p>
+ <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>
+
<dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer = <domain
- name></span> </dd>
- <dd class="value">Specifies the DNS name the HS should use for itself in
- issuing assertions.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName = <URI></span>
- </dd>
- <dd class="value">Specifies the the <span class="fixedwidth">URI</span>
- to use as the name of the origin site as a whole. This field is
- primarily meant to be populated in the context of the federation in
- which the origin site resides, is intended to be globally unique, and
- will typically be assigned by the federation.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl = <url></span>
- </dd>
- <dd class="value">Specifies the <span class="fixedwidth">URL</span> at
- which the HS' corresponding AA may be contacted. 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.</dd>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.username = <var></span>
- </dd>
- <dd class="valueopt">Specifies the HTTP request header that should be
- used to acquire the user's principal name from the authentication
- service. Defaults to <span class="fixedwidth">REMOTE_USER</span>.</dd>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.authMethod = <uri></span>
+ <dd class="attribute"><a name="confArpRepository"><span class="fixed"><ArpRepository implementation ="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository"></span></a></dd>
+ <dd class="value"><p>This element specifies an individual implementation
+ of a release policy engine, with the given value specifying Shibboleth's
+ file-based ARP repository implementation, which is currently the only
+ available. This must contain a <a href="#confPath"><span
+ class="fixed">Path</span></a> element pointing to the directory
+ containing ARP's to be used by this engine. For more information
+ regarding ARP's, consult section <a href="#4.d.">4.d</a> for basic
+ information and <a href="#5.b.">5.b</a> for advanced configuration and
+ syntax.</p><p>Note that the set of principals that an ARP applies to is
+ not expressed by the ARP itself, but rather the implementation of the
+ ARP repository. For example, if the ARP repository were implemented in
+ LDAP, the ARP's that apply to a user would be attributes of that
+ user's personal LDAP entry, and the site ARP would be an attribute
+ of an entry representing the site. While not performed by the built-in
+ ARP repository, a repository implementation might also implement group
+ ARP's; for example, in an LDAP directory, the user entry might have
+ some group membership attributes that refer to group entries, and those
+ group entries would have ARP attributes, and all those ARP's would
+ be applicable.</p></dd>
+
+ <dd class="attribute"><a name="confCAPath"><span class="fixed"><CAPath><i>pathname</i></CAPath></span></a></dd>
+ <dd class="value">Paired with a <a href="#confPath"><span
+ class="fixed">Path</span></a> element and contained by a <a
+ href="#confFileResolver"><span class="fixed">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="fixed">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>
+
+ <dd class="attribute"><a name="confCertAlias"><span class="fixed"><CertAlias><i>string</i></CertAlias></span></a></dd>
+ <dd class="value">Specifies the alias for the certificate 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="fixed">KeyStoreResolver</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confCertificate"><span class="fixed"><Certificate format="<i>type</i>"></span></a></dd>
+ <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="fixed">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="fixed">CAPath</span></a> elements. Valid
+ encodings are <span class="fixed">PEM</span> and <span
+ class="fixed">DER</span>. It resides within the <a
+ href="#confFileResolver"><span class="fixed">FileResolver</span></a> element
+ and must be paired with the corresponding private key using the <a
+ href="#confKey"><span class="fixed">Key</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confCredentials"><span class="fixed"><Credentials xmlns="urn:mace:shibboleth:credentials:1.0"></span></a></dd>
+ <dd class="value">This element is the container for credentials used by
+ the credential mechanism specified by the <a
+ href="#confShibbolethOriginConfig"><span
+ class="fixed">ShibbolethOriginConfig</span></a> element. It must
+ contain one <a href="#confFileResolver"><span
+ class="fixed">FileResolver</span></a> element for flat key and
+ certificate files or one <a href="#confKeyStoreResolver"><span
+ class="fixed">KeyStoreResolver</span></a> element for compound
+ keystores.</dd>
+
+ <dd class="attribute"><a name="confErrorLog"><span class="fixed"><ErrorLog level="<i>level</i>" location="<i>URL</i>"></span></a></dd>
+ <dd class="value">Paired with a <a href="#confTransactionLog"><span
+ class="fixed">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="fixed">URL</span>. Valid
+ levels in order of decreasing sensitivity are <span
+ class="fixed">DEBUG</span>, <span class="fixed">INFO</span>, <span
+ class="fixed">WARN</span>, <span class="fixed">ERROR</span>, and <span
+ class="fixed">FATAL</span>. If no logging is desired, specify <span
+ class="fixed">OFF</span>; defaults to <span class="fixed">WARN</span>.
+ Must be contained by a <a href="#confLogging"><span
+ class="fixed">Logging</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confFederationProvider"><span class="fixed"><FederationProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper"</span> uri="<i>pathname</i>"/></span></a></dd>
+ <dd class="value">Individual sets of targets in the form of an
+ XML file that this origin will trust to make
+ requests may be specified by adding <span
+ class="fixed">FederationProvider</span> elements to the main <a
+ href="#confShibbolethOriginConfig"><span
+ class="fixed">ShibbolethOriginConfig</span></a> element for each. The
+ <span class="fixed">uri</span> attribute points to an
+ XML file, generally signed and distributed by federations.
+ This file should be regularly refreshed using
+ <a href="#4.e."><span class="fixedwidth">metadatatool</span></a>.</dd>
+
+ <dd class="attribute"><a name="confFileResolver"><span class="fixed"><FileResolver Id="<i>string</i>"></span></a></dd>
+ <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="fixed">Credentials</span></a> element. <a
+ href="#confRelyingParty"><span class="fixed">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="fixed">Key</span></a> element and should
+ contain one <a href="#confCertificate"><span
+ class="fixed">Certificate</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confHSNameFormat"><span class="fixed"><HSNameFormat <span class="mandatory">nameMapping="<i>id</i>"</span>/></span></a></dd>
+ <dd class="value">Individual <a href="#confRelyingParty"><span
+ class="fixed">RelyingParty</span></a> elements may contain this element
+ to specify the <a href="#confNameMapping"><span
+ class="fixed">NameMapping</span></a> element referenced by <span
+ class="fixed">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>
+
+ <dd class="attribute"><a name="confKey"><span class="fixed"><Key format="<i>type</i>"></span></a></dd>
+ <dd class="value">This specifies the file containing a private key to be
+ used by a set of credentials. Valid encodings are <span
+ class="fixed">PEM</span> and <span class="fixed">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="fixed">FileResolver</span></a>
+ element, should be paired with a <a href="#confCertificate"><span
+ class="fixed">Certificate</span></a> element, and contain a <a
+ href="#confPath"><span class="fixed">Path</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confKeyAlias"><span class="fixed"><KeyAlias><i>string</i></KeyAlias></span></a></dd>
+ <dd class="value">Specifies the alias used for accessing the private
+ key. Contained by the <a href="#confKeyStoreResolver"><span
+ class="fixed">KeyStoreResolver</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confKeyPassword"><span class="fixed"><KeyPassword><i>string</i></KeyPassword></span></a></dd>
+ <dd class="value">Specifies the password used to retrieve the private
+ key. Contained by the <a href="#confKeyStoreResolver"><span
+ class="fixed">KeyStoreResolver</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confKeyStoreKeyAlias"><span class="fixed"><KeyStoreKeyAlias><i>string</i></KeyStoreKeyAlias></span></a></dd>
+ <dd class="value">Specifies the alias used for accessing the private
+ key. Contained by the <a href="#confNameMapping"><span
+ class="fixed">NameMapping</span></a> element when a <span
+ class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
+
+ <dd class="attribute"><a name="confKeyStoreKeyPassword"><span class="fixed"><KeyStoreKeyPassword><i>string</i></KeyStoreKeyPassword></span></a></dd>
+ <dd class="value">Specifies the password used to retrieve the private
+ key. Contained by the <a href="#confNameMapping"><span
+ class="fixed">NameMapping</span></a> element when a <span
+ class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
+
+ <dd class="attribute"><a name="confKeyStorePassword"><span class="fixed"><KeyStorePassword><i>string</i></KeyStorePassword></span></a></dd>
+ <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="fixed">NameMapping</span></a> element when a <span
+ class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
+
+ <dd class="attribute"><a name="confKeyStorePath"><span class="fixed"><KeyStorePath><i>string</i></KeyStorePath></span></a></dd>
+ <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="fixed">NameMapping</span></a> element when a <span
+ class="fixed">CryptoHandleGenerator</span> type is specified.</dd>
+
+ <dd class="attribute"><a name="confKeyStoreResolver"><span class="fixed"><KeyStoreResolver Id="<i>string</i>" storeType="<i>type</i>"></span></a></dd>
+ <dd class="value">This element is contained by the <a
+ href="#confCredentials"><span class="fixed">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="fixed">JKS</span>. <a href="#confRelyingParty"><span
+ class="fixed">RelyingParty</span></a> elements will refer to the <span
+ class="fixed">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="fixed">Path</span></a> element, one <a href="#confKeyAlias"><span
+ class="fixed">KeyAlias</span></a> element, and one <a
+ href="#confStorePassword"><span class="fixed">StorePassword</span></a>
+ element; it may optionally contain a <a href="#confKeyPassword"><span
+ class="fixed">KeyPassword</span></a> element or a <a
+ href="#confCertAlias"><span class="fixed">CertAlias</span></a>
+ element.</dd>
+
+ <dd class="attribute"><a name="confLog4JConfig"><span class="fixed"><Log4JConfig location="<i>pathname</i>"/></span></a></dd>
+ <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="fixed">location</span> attribute. A basic configuration is
+ included with the distribution at <span
+ class="fixed">/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="fixed">Logging</span></a> element
+ and may not be paired with a <a href="#confTransactionLog"><span
+ class="fixed">TransactionLog</span></a> or <a href="#confErrorLog"><span
+ class="fixed">ErrorLog</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confLogging"><span class="fixed"><Logging></span></a></dd>
+ <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="fixed">ErrorLog</span></a> and <a
+ href="#confTransactionLog"><span class="fixed">TransactionLog</span></a>
+ elements are present, more traditional logging flatfiles will be
+ generated at the locations specified. A <a
+ href="#confLog4JConfig"><span class="fixed">Log4JConfig</span></a>
+ element instructs the origin to use Log4J logging.</dd>
+
+ <dd class="attribute"><a name="confNameMapping"><span class="fixed"><NameMapping xmlns="urn:mace:shibboleth:namemapper:1.0"<br>
+format="<i>URN</i>"<br>
+handleTTL="<i>seconds</i>"<br>
+id="<i>string</i>"<br>
+type="<i>type</i>"/></span></a></dd>
+ <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.
+<ul>
+<li><span class="fixed">format</span> should be populated with the URN <span
+class="fixed">urn:mace:shibboleth:1.0:nameIdentifier</span> if traditional
+Shibboleth handles are used.</li>
+<li><span class="fixed">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="fixed">format</span> is
+<span class="fixed">urn:mace:shibboleth:1.0:nameIdentifier</span>. Consult your
+federation guidelines for guidance on the population of this field.</li>
+<li><span class="fixed">id</span> is used by <a href="#confHSNameFormat"><span
+class="fixed">HSNameFormat</span></a> elements to refer to this element and must
+be unique.</li>
+<li><span class="fixed">type</span> dictates how handles are passed to the AA.
+The valid types are:<ul type="circle">
+<li><span class="fixed">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="fixed">KeyStorePath</span></a> element, one <a
+href="#confKeyStoreKeyAlias"><span class="fixed">KeyStoreKeyAlias</span></a>
+element, one <a href="#confKeyStorePassword"><span
+class="fixed">KeyStorePassword</span></a> element, and optionally a <a
+href="#confKeyStoreKeyPassword"><span
+class="fixed">KeyStoreKeyPassword</span></a> element.</li>
+<li><span class="fixed">Principal</span>: Shibboleth will use the primary unique
+identifier for the individual and not generate a handle.</li>
+<li><span class="fixed">SharedMemoryShibHandle</span>: Shibboleth will use a
+shared in-memory repository.</li>
+</ul></li>
+</ul></dd>
+
+ <dd class="attribute"><a name="confPath"><span class="fixed"><Path><i>pathname</i></Path></span></a></dd>
+ <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>
+
+ <dd class="attribute"><a name="confReleasePolicyEngine"><span class="fixed"><ReleasePolicyEngine></span></a></dd>
+ <dd class="value">The <span class="fixed">ReleasePolicyEngine</span>
+ element is used to specify a class of release policy processing. This
+ should contain one <a href="#confArpRepository"><span
+ class="fixed">ArpRepository</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confRelyingParty"><span class="fixed"><RelyingParty <span class="mandatory">name="<i>URI</i>"</span><br>
+AAsigningCredential="<i>string</i>"<br>
+AAUrl="<i>URL</i>"<br>
+defaultAuthMethod="<i>URN</i>"<br>
+passThruErrors="<i>true/false</i>"<br>
+providerId="<i>string</i>"<br>
+signAttrAssertions="<i>true/false</i>"<br>
+signAttrResponses="<i>true/false</i>"<br>
+signAuthAssertions="<i>true/false</i>"<br>
+signAuthResponses="<i>true/false</i>"<br>
+signingCredential="<i>string</i>"></span></a></dd>
+ <dd class="value"><p>The <span class="fixed">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="fixed">HSNameMapping</span></a>
+ element to specify a naming mechanism for assertions sent to this
+ relying party. The HS and AA both perform validation against federation
+ metadata to ensure that targets cannot construct requests that cause
+ another target's relying party information to be used.</p>
+ <p>The proper <span class="fixed">RelyingParty</span> element to handle
+ a given attribute request is selected by the following algorithm. If at
+ any point a match is found, processing is complete; only one relying
+ party will be used for any given request.</p>
+ <ol type="1">
+ <li>If the requesting provider is unauthenticated -- due to a lack of
+ SSL client authentication because the AA is not protected by an <span
+ class="fixed">https://</span> URL -- the default relying party is
+ always used.</li>
+ <li>If the requesting provider is Shibboleth 1.1 or less, the default
+ relying party is used.</li>
+ <li>If a <span class="fixed">RelyingParty</span> element's <span
+ class="fixed">providerId</span> attribute matches the name sent by the
+ target, then that element is used.</li>
+ <li>A metadata lookup is performed using the <span
+ class="fixed">sites.xml</span> files supplied by <a
+ href="#confFederationProvider"><span
+ class="fixed">FederationProvider</span></a> elements to determine
+ whether the target is a member of a common federation. If there is a
+ <span class="fixed">RelyingParty</span> element that has the same
+ providerId as the URI of the the federation, it is used. If not, the
+ default relying party handles the request.</li>
+ </ol>
+ <ul>
+ <li class="mandatory"><span class="fixed">name</span>: Each <span
+ class="fixed">RelyingParty</span> element is differentiated by a URI
+ specified in the <span class="fixed">name</span> attribute. A target
+ will send a value for this attribute with the attribute request; if
+ the URI sent matches the <span class="fixed">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>
+ <li><span class="fixed">AAsigningCredential</span>: This attribute
+ must equal the identifier of one of the <a
+ href="#confFileResolver"><span class="fixed">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="fixed">RelyingParty</span> element, but a <span
+ class="fixed">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>
+ <li><span class="fixed">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="fixed">AAUrl</span> attribute of the <a
+ href="#confShibbolethOriginConfig"><span
+ class="fixed">ShibbolethOriginConfig</span></a> element.</li>
+ <li><span class="fixed">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="fixed">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="fixed">ShibbolethOriginConfig</span></a> element.</li>
+ <li><span class="fixed">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>
+ <li><span class="fixed">providerId</span>: If the origin must assert
+ under a different name to this relying party, specify a <span
+ class="fixed">providerId</span> attribute which will over-ride the one
+ specified in <a href="#confShibbolethOriginConfig"><span
+ class="fixed">ShibbolethOriginConfig</span></a>.</li>
+ <li><span class="fixed">signAttrAssertions</span>: If this boolean
+ attribute has a value of <span class="fixed">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="fixed">false</span>.</li>
+ <li><span class="fixed">signAttrResponses</span>: If this boolean
+ attribute has a value of <span class="fixed">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="fixed">false</span>; if true, an <span
+ class="fixed">https://</span> AAUrl may be redundant.</li>
+ <li><span class="fixed">signAuthAssertions</span>: If this boolean
+ attribute has a value of <span class="fixed">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="fixed">false</span>.</li>
+ <li><span class="fixed">signAuthResponses</span>: If this boolean
+ attribute has a value of <span class="fixed">false</span>, the
+ authentication response will not be signed. SAML responses contain
+ one or more assertions. Defaults to <span
+ class="fixed">true</span>.</li>
+ <li><span class="fixed">signingCredential</span>: This attribute must
+ equal the identifier of one of the <a href="#confFileResolver"><span
+ class="fixed">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>
+ </ul>
</dd>
- <dd class="valueopt">Specifes the URI used to populate
- <span class="fixedwidth">AuthenticationMethod</span> in the SAML
- attribute assertion. This corresponds to the method used to authenticate
- users by the authentication service used by the HS. Some common
+
+ <dd class="attribute"><a name="confShibbolethOriginConfig"><span class="fixed"><ShibbolethOriginConfig<br>
+xmlns="urn:mace:shibboleth:origin:1.0"<br>
+xmlns:cred="urn:mace:shibboleth:credentials:1.0"<br>
+xmlns:name="urn:mace:shibboleth:namemapper:1.0"<br>
+<span class="mandatory">defaultRelyingParty="<i>URI</i>"<br>
+providerID="<i>URI</i>"</span><br>
+AAUrl="<i>URL</i>"<br>
+authHeaderName="<i>string</i>"<br>
+defaultAuthMethod="<i>URN</i>"<br>
+maxHSThreads="<i>integer</i>"<br>
+passThruErrors="<i>true/false</i>"<br>
+resolverConfig="<i>pathname</i>"></span></a></dd>
+ <dd class="value"><p>This is the primary element that defines an <span class="fixed">origin.xml</span> file and is the container for every other element and must appear once and only once. For most deployments, all the <span class="fixed">xmlns</span> attributes, which specify the handlers for different aspects of origin operation, should remain unchanged. The mandatory attributes must be changed before operating the origin.</p>
+<ul>
+<li class="mandatory"><span class="fixed">defaultRelyingParty</span>: This specifies the relying party to use for a request when no <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element's <span class="fixed">name</span> attribute matches the policy URI of an incoming request. Typically, this will be populated with the URI of a federation.</li>
+<li class="mandatory"><span class="fixed">providerID</span>: The origin uses this unique name to identify assertions it issues. This will usually be assigned by a federation.</li>
+<li><span class="fixed">AAUrl</span> specifies the URL where the AA for this HS resides, which must be consistent with how it is defined in Tomcat. Note that this <b>must</b> be an <span class="fixed">https://</span> URL in order for the AA to know which SHAR is requesting attributes for ARP purposes.</li>
+<li><span class="fixed">authHeaderName</span>: If authentication methods are passed to the HS using an HTTP header variable other than the default, <span class="fixed">SAMLAuthenticationMethod</span>, the name of the variable may be specified here.</li>
+<li><span class="fixed">defaultAuthMethod</span>: This specifies the authentication method that will be assumed if none is passed through and there is no overriding <span class="fixed">defaultAuthMethod</span> specified for this target using a <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element. If neither this element nor the matching <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> element contains this attribute, a value of <span class="fixed">urn:oasis:names:tc:SAML:1.0:am:unspecified</span> will be used for <span class="fixed">authenticationMethod</span>. Some common
authentication methods and corresponding URI's are listed below; for a
complete list, please consult section 7.1 of the SAML 1.1 core
- specifications or your federation's guidelines.<table border="2" cellpadding="0" cellspacing="0">
+ specifications or your federation's guidelines.
+ <table border="2" cellpadding="0" cellspacing="0">
<tr>
- <td><span class="fixedwidth">
+ <td><span class="fixed">
urn:oasis:names:tc:SAML:1.0:am:password</span></td>
<td>The authentication was performed using a password.</td>
</tr>
<tr>
- <td><span class="fixedwidth">urn:ietf:rfc:1510</span></td>
+ <td><span class="fixed">urn:ietf:rfc:1510</span></td>
<td>The authentication was performed using Kerberos.</td>
</tr>
<tr>
- <td><span class="fixedwidth">
+ <td><span class="fixed">
urn:oasis:names:tc:SAML:1.0:am:X509-PKI</span></td>
<td>The authentication was performed using a certificate and key
issued to the end user. More specific forms of PKI
authentication such as SPKI and XKMS are also assigned URN's in
the SAML specs.</td>
</tr>
- </table>
- </dd>
- </dl>
- <p><br>
- </p>
- <p>Assertion Signing:</p>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath =
- <pathname></span> </dd>
- <dd class="value">Specifies the location of the Java keystore containing
- the x.509 certificate and matching private key to be used by the HS.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword =
- <password></span> </dd>
- <dd class="value">Specifies the password to the referenced keystore.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias =
- <alias></span> </dd>
- <dd class="value">Specifies the alias used for accessing the private
- key.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword
- = <password></span> </dd>
- <dd class="value">Specifies the password used to retrieve the private
- key.</dd>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias = <alias></span>
- </dd>
- <dd class="valueopt">Specifies the alias for the certificate
- corresponding to the private key used by the HS. Defaults to the private
- key's alias.</dd>
- </dl>
- <p><br>
- </p>
- <p>General AA Configuration:</p>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName = <domain
- name></span> </dd>
- <dd class="value">Specifies the name of the AA, which is typically the
- domain name of the server running it.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors =
- <true/false></span> </dd>
- <dd class="value">Specifies whether the AA should pass on internal
- errors to the SHAR for debugging purposes. Defaults to
- <span class="fixedwidth">false</span>.</dd>
- </dl>
- <p>AA Attribute Resolution:</p>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver.ResolverConfig
- = <pathname></span> </dd>
- <dd class="value">Specifies the location of the configuration file for
- the resolver the AA uses to build attributes. 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>.</dd>
- </dl>
- <p>ARP Configuration:</p>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.arp.ArpRepository.implementation
- = <string></span> </dd>
- <dd class="value">References the type of ARP repository implemented.
- Shibboleth provides a built-in ARP repository specified by
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.aa.arp.
- provider.FileSystemArpRepository</span>.<p>Note that the set of
- principals that an ARP applies to is not expressed by the ARP itself,
- but rather the implementation of the ARP repository. For example, if the
- ARP repository were implemented in LDAP, the ARP's that apply to a user
- would be attributes of that user's personal LDAP entry, and the site ARP
- would be an attribute of an entry representing the site. While not
- performed by the built-in ARP repository, a repository implementation
- might also implement group ARP's; for example, in an LDAP directory, the
- user entry might have some group membership attributes that refer to
- group entries, and those group entries would have ARP attributes, and
- all those ARP's would be applicable.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path
- = <pathname></span> </dd>
- <dd class="value">Specifies the relative or absolute path to the folder
- containing the ARP files.</dd>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.ArpTTL
- = <seconds></span> </dd>
- <dd class="valueopt">Specifies the duration in <span class="fixedwidth">
- seconds</span> that ARP's may be cached by the AA. Defaults to
- <span class="fixedwidth">0</span>, or no caching.</dd>
- </dl>
- <p>Handle Repository Configuration:</p>
- <dl>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleRepository.implementation =
- <string></span> </dd>
- <dd class="valueopt">Specifies the method by which the HS and AA share
- handles. These are by default passed by memory(which can be specified
- explicitly using <span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider. MemoryHandleRepository</span>),
- and may also be passed using symmetric encryption with
- <span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository</span>.</dd>
- </dl>
- <p>edu.internet2.middleware.shibboleth.hs.provider. MemoryHandleRepository
- <font color="#5555EE">(specify if <span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleRepository. implementation</span>
- is <span class="fixedwidth">MemoryHandleRepository</span>)</font></p>
- <blockquote>
- <dl>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL
- = <seconds></span> </dd>
- <dd class="valueopt">Specifies the time in <span class="fixedwidth">
- seconds</span> for which issued handles are valid. Defaults to
- <span class="fixedwidth">1800</span>, or 30 minutes. The time should
- be long enough to allow for clock skew and short enough to protect
- against various attacks. Consult your federation guidelines for
- further advice.</dd>
- </dl>
- </blockquote>
- <p>edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository
- <font color="#5555EE">(specify if <span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.HandleRepository. implementation</span>
- is <span class="fixedwidth">CryptoHandleRepository</span>)</font></p>
- <p>In order to use the crypto repository implementation, you must have a
- <span class="fixedwidth">DESede</span> secret key in a keystore of type
- <span class="fixedwidth">JCEKS</span>. The origin distribution includes a
- program that will automatically generate such a key. In order to invoke it,
- run <span class="fixedwidth">./ant genSecret</span>, which will create a
- keystore in <span class="fixedwidth">$SHIB_HOME/src/conf/handle.jks</span>
- that includes the key, with an alias of <span class="fixedwidth">handleKey</span>
- and a password of <span class="fixedwidth">shibhs</span>. If
- <span class="fixedwidth">./ant dist</span> is run subsequently, this
- keystore will be included in the webapp archive that is created.</p>
- <blockquote>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePath
- = <pathname></span> </dd>
- <dd class="value">Specifies the path to the keystore containing the
- key used to encrypt passed principal identifiers.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePassword
- = <password></span> </dd>
- <dd class="value">Specifies the password for the keystore.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyAlias
- = <password></span> </dd>
- <dd class="value">Specifies the alias for the appropriate encryption
- key within the keystore.</dd>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyPassword
- = <password></span> </dd>
- <dd class="valueopt">Specifies the password used to retrieve the
- key.</dd>
- <dd class="attributeoptlong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.hs.CryptoHandleRepository.handleTTL
- = <seconds></span> </dd>
- <dd class="valueopt">Specifies the time in <span class="fixedwidth">
- seconds</span> for which issued handles are valid. Defaults to
- <span class="fixedwidth">1800</span>, or 30 minutes. The time should
- be long enough to allow for clock skew and short enough to protect
- against various attacks. Consult your federation guidelines for
- further advice.</dd>
- </dl>
- </blockquote>
- <p>Federation Configuration:</p>
- <dl>
- <dd class="attributelong"><span class="fixedwidth">
- edu.internet2.middleware.shibboleth.audiences = <URI's></span> </dd>
- <dd class="value">Specifies a list of <span class="fixedwidth">URI</span>'s
- that will be used for the <span class="fixedwidth">Audience</span> field
- of the SAML attribute assertion. All URI's listed will be sent with any
- assertion issued by the AA. These URI's are defined and provided by and
- correspond to federations.<p>Note that the values of the URI's here <b>
- must</b> match one of the policy URI's accepted by the receiving target
- in the <span class="fixedwidth">[policies]</span> section of
- <span class="fixedwidth">shibboleth.ini</span> or interoperation will
- fail by design. </dd>
+ </table></li>
+<li><span class="fixed">maxHSThreads</span>: This attribute places a limit on the number of threads the handle service will spawn and may be useful for limiting the load of signing and other operations and improving performance.</li>
+<li><span class="fixed">passThruErrors</span>: This boolean attribute determines whether the origin will relay errors in flows to the target for use in displaying these errors to the browser in the case of an unsuccessful transaction.</li>
+<li><span class="fixed">resolverConfig</span> specifies the location of the configuration file for the resolver the AA uses to build attributes and if unspecified defaults to <span class="fixed">/conf/resolver.xml</span>. For information on how to configure and use the attribute resolver, consult section <a href="4.e.">4.e</a>.</li>
+</ul>
+</dd>
+
+ <dd class="attribute"><a name="confStorePassword"><span class="fixed"><StorePassword><i>string</i></StorePassword></span></a></dd>
+ <dd class="value">Specifies the password for the keystore. Contained by the <a href="#confKeyStoreResolver"><span class="fixed">KeyStoreResolver</span></a> element.</dd>
+
+ <dd class="attribute"><a name="confTransactionLog"><span class="fixed"><TransactionLog location="<i>URL</i>"></span></a></dd>
+ <dd class="value">Paired with an <a href="#confErrorLog"><span class="fixed">ErrorLog</span></a> element, this will log all transactions that the origin is involved in. The information in this file is sensitive and may be useful for auditing and security purposes. Must be contained by a <a href="#confLogging"><span class="fixed">Logging</span></a> element.</dd>
+
</dl>
</blockquote>
<p><br>
the AA retrieves information; a user ARP applies only to the individual user
for whom it is defined. The set of principals to whom the ARP applies is
defined by the name of the ARP file: the site ARP is stored in
- <span class="fixedwidth">arp.site.xml</span> and user ARP's are stored as
- <span class="fixedwidth">arp.user.$PRINCIPALNAME.xml</span>. Up to two ARP's
+ <span class="fixed">arp.site.xml</span> and user ARP's are stored as
+ <span class="fixed">arp.user.$PRINCIPALNAME.xml</span>. Up to two ARP's
will apply to a principal: the site ARP, and the user ARP for that
principal.</p>
- <p>Each ARP acts as a container that holds a set of ARP rules that are
- applicable to the principals that ARP is effective for. Each ARP rule
- specifies a single release policy within the ARP container pertaining to a
- specific set of targets. This set of targets may be specified as a specific
- SHAR, a SHAR tree, or a regular expression, and becomes the ARP rule's
- target definition. Each ARP rule may contain specifications regarding the
- release of any number of attribute values to requests matching that ARP rule
- for that user. ARP rules may be flagged as default, implying that they are
- always applied to any user matched by the ARP container. Note that ARP's may
- also be used to restrict specific attribute/value pairs in addition to
- restricting or releasing individual attributes.</p>
+ <p>Each ARP acts as a container that holds a set of ARP rules that are
+ applicable to the principals that ARP is effective for. Each ARP rule
+ specifies a single release policy within the ARP container pertaining to a
+ particular target application. For 1.2 targets, this is a single URI
+ matching a <span class="fixed">providerId</span>. Prior to 1.2, URI's for
+ targets were not registered; this means that the SHAR name must be used in
+ release policies for 1.1 targets accessed by users from this origin. Each
+ ARP rule may contain specifications regarding the release of any number of
+ attribute values to requests matching that ARP rule for that user. ARP rules
+ may be flagged as default, implying that they are always applied to any user
+ matched by the ARP container. Note that ARP's may also be used to
+ restrict specific attribute/value pairs in addition to restricting or
+ releasing individual attributes.</p>
<p>When a query is received, the AA generates an effective ARP, which is the
- fully evaluated set of ARP rules regarding that SHAR based on all ARP
+ fully evaluated set of ARP rules regarding that relying party based on all ARP
containers applicable to the principal. This effective ARP is then applied
to attribute values retrieved from the directory and the appropriate
assertion is constructed. Default rules are always included in construction
<h4><a name="5.b.i."></a>5.b.i. ARP Processing</h4>
<blockquote>
<blockquote>
- <p>When a request arrives from a particular SHAR, the applicable set of
+ <p>When a request arrives from a particular relying party, the applicable set of
ARP rules are parsed into an effective ARP. This parsing is done as
follows:</p>
<ol type="1">
<li>Identify all ARP's that should be applied to a particular
principal. This is done by isolating the files in the folder
- specified by <span class="fixedwidth">
- edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path</span>
+ specified by the <a href="#confArpRepository"><span class="fixed">ArpRepository</span></a> element
that have the name either arp.site.xml or
arp.user.$PRINCIPALNAME.xml.</li>
<li>Find all ARP rules relevant to the query:
<li>For each non-default rule in each identified ARP, the
matching functions specified in the rule's target definition are
performed. A separate matching function is performed for the
- requesting SHAR and the resource on behalf of which the SHAR is
+ requesting SHAR and the providerId on behalf of which the SHAR is
making the request.</li>
- <li>Each matching function evaluates to <span class="fixedwidth">
+ <li>Each matching function evaluates to <span class="fixed">
TRUE</span> if the match is successful or
- <span class="fixedwidth">FALSE</span> if it is unsuccessful. If
- both functions evaluate to <span class="fixedwidth">TRUE</span>,
+ <span class="fixed">FALSE</span> if it is unsuccessful. If
+ both functions evaluate to <span class="fixed">TRUE</span>,
the rule is included in the Effective ARP.</li>
</ol>
</li>
<ol type="i">
<li>For each attribute, compile a temporary list of associated
rules that includes all values with a release qualifier of
- <span class="fixedwidth">permit</span>.</li>
+ <span class="fixed">permit</span>.</li>
<li>Subtract from this list all attribute values with rules
- specifying a release qualifier of <span class="fixedwidth">deny</span>.
+ specifying a release qualifier of <span class="fixed">deny</span>.
The resulting list represents the allowable release values for
the attribute and is used as a mask for the values which are
returned from the Attribute Resolver.</li>
<li>If a statement specifies that all values should be
- permitted, then specific <span class="fixedwidth">deny</span>
+ permitted, then specific <span class="fixed">deny</span>
qualifiers for specific values should still be enforced. If a
statement specifies that all values should be denied, then
- <span class="fixedwidth">permit</span> qualifiers for specific
+ <span class="fixed">permit</span> qualifiers for specific
values will be ignored.</li>
</ol>
</li>
<blockquote>
<blockquote>
<p>Each ARP is described by an XML file based on a standard
- <span class="fixedwidth">.xsd</span> schema. It consists of a standard
- <span class="fixedwidth">AttributeReleasePolicy</span> element
- referencing the appropriate <span class="fixedwidth">xsi:schemaLocation</span>
- and a self-explanatory <span class="fixedwidth">Description</span>
- element followed by any number of <span class="fixedwidth">Rule</span>
- elements. Each <span class="fixedwidth">Rule</span> element must consist
- of a <span class="fixedwidth">Target</span> element and one or more
- <span class="fixedwidth">Attribute</span> elements. The
- <span class="fixedwidth">Target</span> element specifies the rules by
- which the target definition is formed. The <span class="fixedwidth">
+ <span class="fixed">.xsd</span> schema. It consists of a standard
+ <span class="fixed">AttributeReleasePolicy</span> element
+ referencing the appropriate <span class="fixed">xsi:schemaLocation</span>
+ and a self-explanatory <span class="fixed">Description</span>
+ element followed by any number of <span class="fixed">Rule</span>
+ elements. Each <span class="fixed">Rule</span> element must consist
+ of a <span class="fixed">Target</span> element and one or more
+ <span class="fixed">Attribute</span> elements. The
+ <span class="fixed">Target</span> element specifies the rules by
+ which the target definition is formed. The <span class="fixed">
Attribute</span> elements specifies the name and values of the
attributes that may be released.</p>
<p>The simplest possible ARP is as follows, which releases
- <span class="fixedwidth">eduPersonScopedAffiliation</span> to any target
+ <span class="fixed">eduPersonScopedAffiliation</span> to any target
for the users the ARP applies to:</p>
<blockquote>
- <p><span class="fixedwidth"><?xml version="1.0"?><br>
+ <p><span class="fixed"><?xml version="1.0"?><br>
<AttributeReleasePolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:mace:shibboleth:arp:1.0" xsi:schemaLocation="urn:mace:shibboleth:arp:1.0
shibboleth-arp-1.0.xsd"><br>
</blockquote>
</blockquote>
<p>All ARP's must take the same basic form. A detailed description of how
- each element of the <span class="fixedwidth">Rule</span> element may be
+ each element of the <span class="fixed">Rule</span> element may be
sub-populated follows:</p>
- <p>The <span class="fixedwidth">Target</span> element:</p>
+ <p>The <span class="fixed">Target</span> element:</p>
<blockquote>
- <p><span class="fixedwidth">Target</span> may contain either the
- <span class="fixedwidth">AnyTarget</span> element, which will cause the
- <span class="fixedwidth">Target</span> to always return
- <span class="fixedwidth">TRUE</span>, or both the
- <span class="fixedwidth">Requester</span> element, which provides for
- matches to be performed against the SHAR name and the
- <span class="fixedwidth">Resource</span> element, which provides for
+ <p><span class="fixed">Target</span> may contain either the
+ <span class="fixed">AnyTarget</span> element, which will cause the
+ <span class="fixed">Target</span> to always return
+ <span class="fixed">TRUE</span>, or both the
+ <span class="fixed">Requester</span> element, which provides for
+ matches to be performed against the SHAR name for 1.1 targets or the <span class="fixed">providerId</span> for 1.2 targets, and the
+ <span class="fixed">Resource</span> element, which provides for
matches to be performed against the requested URL.</p>
+ <p>When going against 1.1 targets, the <span
+ class="fixed">Resource</span> element will refer to individual URL trees
+ protected by a given SHAR. However, due to the nature of application
+ identifiers, the <span class="fixed">Resource</span> element has no
+ meaning when releasing to 1.2 targets. These will always function as
+ though <span class="fixed"><AnyResource/></span> is specified,
+ making the entire <span class="fixed">Resource</span> element necessary
+ only if this origin will be applying this ARP to 1.1 targets.</p>
<p>There are three matches that may be performed by the AA in evaluating
- ARP's by using the <span class="fixedwidth">matchFunction</span>
- component of the <span class="fixedwidth">Requester</span> and
- <span class="fixedwidth">Resource</span> elements. The following match
+ ARP's by using the <span class="fixed">matchFunction</span>
+ component of the <span class="fixed">Requester</span> and
+ <span class="fixed">Resource</span> elements. The following match
patterns may be specified directly following the
- <span class="fixedwidth">Requester</span> or <span class="fixedwidth">
- Resource</span> elements, such as <span class="fixedwidth"><Requester
+ <span class="fixed">Requester</span> or <span class="fixed">
+ Resource</span> elements, such as <span class="fixed"><Requester
matchFunction="urn:mace:shibboleth:arp:matchFunction:regexMatch"></span>:</p>
<ul type="disc">
- <li><span class="fixedwidth">
+ <li><span class="fixed">
urn:mace:shibboleth:arp:matchFunction:exactShar </span>
<blockquote>
- <p>May be used with the <span class="fixedwidth">Requester</span>
+ <p>May be used with the <span class="fixed">Requester</span>
element.</p>
- <p>Evaluates to <span class="fixedwidth">TRUE</span> when the
- string content of the <span class="fixedwidth">Requester</span>
- element matches exactly the name of the requesting SHAR.
- Otherwise evaluates to <span class="fixedwidth">FALSE</span>.
+ <p>Evaluates to <span class="fixed">TRUE</span> when the
+ string content of the <span class="fixed">Requester</span>
+ element matches exactly the providerId of the requesting application of 1.2 targets or the SHAR name of 1.1 targets.
+ Otherwise evaluates to <span class="fixed">FALSE</span>.
Serves as the default value associated with
- <span class="fixedwidth">Requester</span> if none is specified.</p>
+ <span class="fixed">Requester</span> if none is specified.</p>
</blockquote>
</li>
- <li><span class="fixedwidth">
+ <li><span class="fixed">
urn:mace:shibboleth:arp:matchFunction:resourceTree </span>
<blockquote>
- <p>May be used with the <span class="fixedwidth">Resource</span>
- element.</p>
- <p>Evaluates to <span class="fixedwidth">TRUE</span> when the
+ <p>May be used with the <span class="fixed">Resource</span>
+ element. However, this has no meaning when releasing to 1.2 targets.</p>
+ <p>Evaluates to <span class="fixed">TRUE</span> when the
location of the resource either matches exactly or begins with
- the string content of the <span class="fixedwidth">Resource</span>
- element. Otherwise evaluates to <span class="fixedwidth">FALSE</span>.</p>
+ the string content of the <span class="fixed">Resource</span>
+ element. Otherwise evaluates to <span class="fixed">FALSE</span>.</p>
</blockquote>
</li>
- <li><span class="fixedwidth">
+ <li><span class="fixed">
urn:mace:shibboleth:arp:matchFunction:regexMatch </span>
<blockquote>
- <p>May be used with both the <span class="fixedwidth">Requester</span>
- and <span class="fixedwidth">Resource</span> elements.</p>
- <p>Evaluates to <span class="fixedwidth">TRUE</span> when the
- name of the requesting SHAR or the requested URL tree is a valid
+ <p>May be used with both the <span class="fixed">Requester</span>
+ and <span class="fixed">Resource</span> elements.</p>
+ <p>Evaluates to <span class="fixed">TRUE</span> when the providerId of a request for 1.2 targets or the
+ name of the requesting SHAR for or the requested URL tree for 1.1 targets is a valid
match of the regular expression represented as the content of
the containing element. Otherwise evaluates to
- <span class="fixedwidth">FALSE</span>. Regular expressions are
+ <span class="fixed">FALSE</span>. Regular expressions are
evaluated in accordance with the the
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/package-summary.html">
Java 1.4 Pattern API</a>.</p>
</li>
</ul>
</blockquote>
- <p>The <span class="fixedwidth">Attribute</span> element:</p>
+ <p>The <span class="fixed">Attribute</span> element:</p>
<blockquote>
- <p>The <span class="fixedwidth">Attribute</span> element must always
+ <p>The <span class="fixed">Attribute</span> element must always
specify the URN of the attribute whose release parameters it specifies.
- Additionally, it must contain either the <span class="fixedwidth">
- AnyValue</span> element or one or more <span class="fixedwidth">Value</span>
+ Additionally, it must contain either the <span class="fixed">
+ AnyValue</span> element or one or more <span class="fixed">Value</span>
elements. These elements, in turn, must specify either
- <span class="fixedwidth">release</span> = <span class="fixedwidth">
- permit</span> or <span class="fixedwidth">deny</span>. The
- <span class="fixedwidth">Value</span> element must then contain one
+ <span class="fixed">release</span> = <span class="fixed">
+ permit</span> or <span class="fixed">deny</span>. The
+ <span class="fixed">Value</span> element must then contain one
value for which the rule applies. Examples:</p>
<blockquote>
- <p><span class="fixedwidth"><Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName"><br>
+ <p><span class="fixed"><Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName"><br>
<AnyValue release="Permit"><br>
</Attribute><br>
</span><br>
</p>
- <p>Permits the release of <span class="fixedwidth">
+ <p>Permits the release of <span class="fixed">
eduPersonPrincipalName</span> with any value.</p>
</blockquote>
<blockquote>
- <p><span class="fixedwidth"><Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
+ <p><span class="fixed"><Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
<Value release="deny">member@example.edu</Value><br>
</Attribute><br>
</span><br>
</p>
- <p>Denies the release of <span class="fixedwidth">
- eduPersonScopedAffiliation</span> value <span class="fixedwidth">
+ <p>Denies the release of <span class="fixed">
+ eduPersonScopedAffiliation</span> value <span class="fixed">
member@example.edu</span>. Other values of the attribute may still
- be released if so specified by a <span class="fixedwidth">permit</span>
+ be released if so specified by a <span class="fixed">permit</span>
ARP.</p>
</blockquote>
</blockquote>
- <!-- ##To be included in future releases. Not yet implemented.
-
- <p>There is also a special <span class="fixedwidth">AttributeIdentifier</span>
- element that allows internal references to an attribute
- within an ARP. This is useful for quickly applying multiple
- rules to the same target. It is used as follows:</p>
-
- <blockquote>
- <span class="fixedwidth">
- <Rule><br>
-
- <Target><br>
-
- <AnyTarget/><br>
-
- </Target><br>
-
- <Attribute
- name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
-
- <Value
- release="permit">member@example.edu</Value
- ><br>
-
- </Attribute><br>
-
- </Rule><br>
-
- <AttributeReference identifier="http://www.example.edu/attributes/attribute1"><br>
-
- <Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation" identifier="http://www.example.edu/attributes/attribute1"><br>
-
- <Value release="permit">student@example.edu<Value><br>
-
- </Attribute><br>
- </span>
- -->
</blockquote>
<h4><a name="5.c."></a>5.c. Sharing certificate/key pairs between Apache and
Java keystores <font color="#5555EE">(optional)</font></h4>
<blockquote>
<blockquote>
- <p>The JDK includes the command line program <span class="fixedwidth">
+ <p>The JDK includes the command line program <span class="fixed">
keytool</span> for managing Java keystores. This utility cannot import
or export private key information, making it difficult to use the same
private key and certificate for Apache and Java-based applications. The
- Shibboleth distribution includes <span class="fixedwidth">extkeytool</span>,
- a program that can be used in conjunction with <span class="fixedwidth">
+ Shibboleth distribution includes <span class="fixed">extkeytool</span>,
+ a program that can be used in conjunction with <span class="fixed">
keytool</span> to perform these tasks. Select the appropriate
step-by-step procedure for your situation from the following guides.</p>
- <p>Before running <span class="fixedwidth">extkeytool</span>, the
+ <p>Before running <span class="fixed">extkeytool</span>, the
variable SHIB_HOME must be set to the path to the directory where the
- Shibboleth tarball was exploded(typically /opt/shibboleth-origin-1.1/).</p>
+ Shibboleth tarball was exploded(typically /opt/shibboleth-origin-1.2/).</p>
<p><b>If you have a pre-exiting RSA key/certificate combination in a
keystore and you would like to use it with Apache:</b></p>
<ol type="1">
<li>Determine the alias of the keystore keyEntry containing the key
you would like to use in your Apache setup. Assuming that your
- keystore is named <span class="fixedwidth">yourstore</span>, the
+ keystore is named <span class="fixed">yourstore</span>, the
following command should present a list of the entries in the
keystore.<blockquote>
- <p><span class="fixedwidth">$ keytool -list -v -keystore
+ <p><span class="fixed">$ keytool -list -v -keystore
yourstore</span></p>
</blockquote>
</li>
<li>Assuming that you identified the appropriate alias as
- <span class="fixedwidth">youralias</span> and the password for the
- keystore is <span class="fixedwidth">yourpass</span>, enter the
+ <span class="fixed">youralias</span> and the password for the
+ keystore is <span class="fixed">yourpass</span>, enter the
following command to export the key in Base64-encoded pkcs8 format.<blockquote>
- <p><span class="fixedwidth">$ extkeytool -exportkey -keystore
+ <p><span class="fixed">$ extkeytool -exportkey -keystore
yourstore -alias youralias -storepass yourpass -rfc -file
yourkey.pkcs8</span></p>
</blockquote>
unencrypted or encrypted:<ol type="A">
<li>To use the unencrypted format, enter the following command
for the conversion:<blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in
+ <p><span class="fixed">$ openssl pkcs8 -in
yourkey.pkcs8 -nocrypt|openssl rsa -out yourkey.key</span></p>
</blockquote>
</li>
<li>To use the encrypted format, enter the following command for
the conversion:<blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in
+ <p><span class="fixed">$ openssl pkcs8 -in
yourkey.pkcs8 -nocrypt|openssl rsa -des3 -out yourkey.enckey</span></p>
</blockquote>
</li>
</ol>
</li>
<li>The following command will export the corresponding certificate.<blockquote>
- <p><span class="fixedwidth">$ keytool -export -keystore
+ <p><span class="fixed">$ keytool -export -keystore
yourstore -alias youralias -rfc -file yourcert</span></p>
</blockquote>
</li>
- <li>Set the <span class="fixedwidth">mod_ssl</span>
- <span class="fixedwidth">SSLCertificateKeyFile</span> and
- <span class="fixedwidth">SSLCertificateFile</span> directives to
+ <li>Set the <span class="fixed">mod_ssl</span>
+ <span class="fixed">SSLCertificateKeyFile</span> and
+ <span class="fixed">SSLCertificateFile</span> directives to
point to the two files you have just created. Take care to remove
- any temporary files you created (i.e. <span class="fixedwidth">
+ any temporary files you created (i.e. <span class="fixed">
yourkey.pkcs8</span>) and set appropriate file permissions,
especially if you chose to store the key in an unencrypted format.</li>
</ol>
<ol type="1">
<li>Convert the private key to unencrypted DER-encoded pkcs8 format.
Assuming your PEM-encoded key is stored in a file named
- <span class="fixedwidth">yourkey.enckey</span>, enter the following
+ <span class="fixed">yourkey.enckey</span>, enter the following
command.<blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in yourkey.enckey
+ <p><span class="fixed">$ openssl pkcs8 -in yourkey.enckey
-topk8 -nocrypt -outform DER -out yourkey.der.pkcs8</span></p>
</blockquote>
</li>
series of PEM-encoded X509 certificates representing a complete
trust chain, from the root CA certificate to the certificate that
matches your private key. If your certificate is stored in a file
- named <span class="fixedwidth">mycert</span> and the CA signer
- certificate is stored in a file named <span class="fixedwidth">
+ named <span class="fixed">mycert</span> and the CA signer
+ certificate is stored in a file named <span class="fixed">
ca.cert</span>, you might enter the following command to create the
bundle.<blockquote>
- <p><span class="fixedwidth">$ cat mycert ca.cert > cert.bundle</span></p>
+ <p><span class="fixed">$ cat mycert ca.cert > cert.bundle</span></p>
</blockquote>
- <p><b>Note: <span class="fixedwidth">mod_ssl</span>-enabled Apache
+ <p><b>Note: <span class="fixed">mod_ssl</span>-enabled Apache
installations include a number of commonly recognized CA
- certificates in the <span class="fixedwidth">ca-bundle.crt</span>
- file under the <span class="fixedwidth">$ServerRoot/conf/ssl.crt/</span>
+ certificates in the <span class="fixed">ca-bundle.crt</span>
+ file under the <span class="fixed">$ServerRoot/conf/ssl.crt/</span>
directory.</b> </li>
<li>Import the key and certificate into the keystore. Assuming you
- have already created a keystore named <span class="fixedwidth">
- yourstore</span> with a password of of <span class="fixedwidth">
+ have already created a keystore named <span class="fixed">
+ yourstore</span> with a password of of <span class="fixed">
yourpass</span>, enter the following command to store the data under
- the alias <span class="fixed
width">youralias</span>.<blockquote>
- <p><span class="fixedwidth">$ ./extkeytool -importkey -keystore
+ the alias <span class="fixed">youralias</span>.<blockquote>
+ <p><span class="fixed">$ ./extkeytool -importkey -keystore
yourstore -alias youralias -storepass yourpass -keyfile
yourkey.der.pkcs8 -certfile cert.bundle -provider
org.bouncycastle.jce.provider.BouncyCastleProvider</span></p>
</li>
<li>You can verify that the import was successful by listing entry.
Use the command below.<blockquote>
- <p><span class="fixedwidth">$ keytool -list -v -keystore
+ <p><span class="fixed">$ keytool -list -v -keystore
yourstore -alias youralias</span></p>
</blockquote>
</li>
- <li>Remember to delete <span class="fixedwidth">yourkey.der.pkcs8</span>,
+ <li>Remember to delete <span class="fixed">yourkey.der.pkcs8</span>,
as it contains your unencrypted private key.</li>
</ol>
<p><b>If you are starting from scratch and do not yet have a
certificate/key pair:</b></p>
<ol type="1">
<li>Generate an RSA private key. Use the command below, substituting
- <span class="fixedwidth">yourkey</span> with an appropriate name to
+ <span class="fixed">yourkey</span> with an appropriate name to
use to refer to the key.<blockquote>
- <p><span class="fixedwidth">$ openssl genrsa -des3 -out
+ <p><span class="fixed">$ openssl genrsa -des3 -out
yourkey.enckey 1024</span></p>
</blockquote>
</li>
<li>The following command generates a Certificate Signing Request,
which should be communicated to a Certificate Authority.<blockquote>
- <p><span class="fixedwidth">$ openssl req -new -key
+ <p><span class="fixed">$ openssl req -new -key
yourkey.enckey</span></p>
</blockquote>
</li>
<li>The Certificate Authority should respond with a PEM-encoded X509
- certificate. Set the <span class="fixedwidth">mod_ssl</span>
- <span class="fixedwidth">SSLCertificateKeyFile</span> directive to
+ certificate. Set the <span class="fixed">mod_ssl</span>
+ <span class="fixed">SSLCertificateKeyFile</span> directive to
point to the key file you just created and the
- <span class="fixedwidth">SSLCertificateFile</span> directive to
+ <span class="fixed">SSLCertificateFile</span> directive to
point to file containing the certificate issued by the Certificate
Authority. Previous sections explaion how to share the
key/certificate pair with a Java keystore.</li>
<p>Shibboleth provides a powerful attribute resolver that allows origins to
quickly configure the retrieval of simple attributes from standard types of
attribute stores. The resolver is configured using an xml file wich should
- be pointed to with the <span class="fixedwidth">
+ be pointed to with the <span class="fixed">
edu.internet2.middleware.shibboleth.aa.
attrresolv.AttributeResolver.ResolverConfig</span> propety in
- <span class="fixedwidth">origin.properties</span> as described in section
+ <span class="fixed">origin.xml</span> as described in section
<a href="#4.a.">4.a</a>. For more complex attributes or those that require
processing before release, customized Java classes will need to be written.
For more information, consult the programmer's guide.</p>
can be as simple as taking an unmodified string value from a data connector
and tagging it with a name or can include arbitrarily complex business
rules.</p>
- <p>The <span class="fixedwidth">resolver.xml</span> file that is pointed to
- by <span class="fixedwidth">origin.properties</span> consists of zero or
+ <p>The <span class="fixed">resolver.xml</span> file that is pointed to
+ by <span class="fixed">origin.xml</span> consists of zero or
more attribute definitions followed by zero or more data connectors. Each
attribute definition consists of an identifier corresponding to the URN of
the attribute, and optional references to data connectors on which it
depends. Each data connector consists of a string identifier which is used
by attribute definitions that refer to it, and one or more elements specific
to the configuration of that data connector.</p>
- <p>Shibboleth comes with two attribute definitions provided in version 1.1:
- the <span class="fixedwidth">SimpleAttributeDefinition</span>, which acts as
+ <p>Shibboleth comes with two attribute definitions provided in version 1.2:
+ the <span class="fixed">SimpleAttributeDefinition</span>, which acts as
a basic proxy for attributes supplied by data connectors with some name
- conversion and attribute scoping added, and a <span class="fixedwidth">
+ conversion and attribute scoping added, and a <span class="fixed">
CustomAttributeDefinition</span>, which can be used to configure
- user-created attribute definition plugins. Similarly, Shibboleth 1.1 comes
- with two data connectors: the <span class="fixedwidth">
+ user-created attribute definition plugins. Similarly, Shibboleth 1.2 comes
+ with two data connectors: the <span class="fixed">
JNDIDirectoryDataConnector</span>, which pulls data from any source for
which there is a JNDI Directory Context implementation, including LDAP, NDS,
- etc., and the <span class="fixedwidth">CustomDataConnector</span>, which is
+ etc., and the <span class="fixed">CustomDataConnector</span>, which is
used to configure user-created data connector plugins.</p>
<p>A detailed explanation of each configuration option for the provided
connectors follows:</p>
- <p><span class="fixedwidth">JNDIDirectoryDataConnector</span>:</p>
+ <p><span class="fixed">JNDIDirectoryDataConnector</span>:</p>
<dl>
- <dd class="attribute"><span class="fixedwidth">id = <string></span> </dd>
+ <dd class="attribute"><span class="fixed">id = <string></span> </dd>
<dd class="value">Specifies a unique, textual name for the connector
used by attribute definitions to refer to and use it to build
- attributes. Contained within the <span class="fixedwidth">
+ attributes. Contained within the <span class="fixed">
JNDIDirectoryDataConnector</span> element.</dd>
- <dd class="attribute"><span class="fixedwidth"><Property name="<name>"
+ <dd class="attribute"><span class="fixed"><Property name="<name>"
value="<value>"/></span> </dd>
- <dd class="value">An element of the element <span class="fixedwidth">
+ <dd class="value">An element of the element <span class="fixed">
JNDIDirectoryDataConnector</span>. Specifies a set of name/value pairs
that are used to configure the JNDI Directory Context. This list of
name/value pairs is defined by the context itself, but is specified
- within <span class="fixedwidth">resolver.xml</span>. Refer to the
+ within <span class="fixed">resolver.xml</span>. Refer to the
<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">
Shibboleth CVS</a> for an example of names and values used to connect to
an LDAP directory.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><Search></span> </dd>
- <dd class="valueopt">An element of the element <span class="fixedwidth">
+ <dd class="attributeopt"><span class="fixed"><Search></span> </dd>
+ <dd class="valueopt">An element of the element <span class="fixed">
JNDIDirectoryDataConnector</span>. This element defines the DN filter
used to perform the LDAP search. The search string must return no more
than one result.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><Controls></span> </dd>
- <dd class="valueopt">An element of the element <span class="fixedwidth">
+ <dd class="attributeopt"><span class="fixed"><Controls></span> </dd>
+ <dd class="valueopt">An element of the element <span class="fixed">
Search</span>. This element grants some fine-grained control over the
LDAP API calls.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><cacheTime
+ <dd class="attributeopt"><span class="fixed"><cacheTime
"<seconds>"/></span> </dd>
- <dd class="valueopt">An element of the element <span class="fixedwidth">
+ <dd class="valueopt">An element of the element <span class="fixed">
JNDIDirectoryDataConnector</span>. Specifies an optional duration in
- <span class="fixedwidth">seconds</span> for which the attribute resolver
+ <span class="fixed">seconds</span> for which the attribute resolver
may cache information retrieved from this connector. The default is zero seconds (no caching)</dd>
</dl>
- <p>A representation of a properly constructed <span class="fixedwidth">
+ <p>A representation of a properly constructed <span class="fixed">
JNDIDirectoryDataConnector</span> element would look like:</p>
<blockquote>
- <p><span class="fixedwidth"><JNDIDirectoryDataConnector id="directory"><br>
+ <p><span class="fixed"><JNDIDirectoryDataConnector id="directory"><br>
<Search filter="cn=%PRINCIPAL%"><br>
<Controls searchScope="SUBTREE_SCOPE" returningObjects="false" /><br>
</Search><br>
<cacheTime="2400"/><br>
</JNDIDirectoryDataConnector> </span></p>
</blockquote>
- <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>
+ <p>If the ldap server must be accessed over SSL, and JDK 1.4.1 is being used, two changes must be made to the <span class="fixed">JNDIDirectoryDataConnector</span> element:</p>
<p>1. On the java.naming.provider.url Property, add <port number> after the hostname in the ldap url (the default port for ldap over SSL is 636),</p>
<p>2. Add this Property element:</p>
<blockquote>
- <p><span class="fixedwidth"><Property name="java.naming.security.protocol" value="ssl" "></span></p>
+ <p><span class="fixed"><Property name="java.naming.security.protocol" value="ssl" "></span></p>
</blockquote>
- <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>
+ <p>If the ldap server must be accessed over SSL, and JDK 1.4.2 is being used, then change ldap:// to ldaps:// in the value of the <span class="fixed">java.naming.provider.url</span> Property.</p>
<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>
- <p><span class="fixedwidth">SimpleAttributeDefinition</span>:</p>
+ <p><span class="fixed">SimpleAttributeDefinition</span>:</p>
<dl>
- <dd class="attribute"><span class="fixedwidth">id = <string></span> </dd>
+ <dd class="attribute"><span class="fixed">id = <string></span> </dd>
<dd class="value">Specifies a unique, textual name for the attribute
which is used as the attribute's name when it is sent over the wire by
- Shibboleth. Contained within the <span class="fixedwidth">
+ Shibboleth. Contained within the <span class="fixed">
SimpleAttributeDefinition</span> element.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><AttributeDependency /
+ <dd class="attributeopt"><span class="fixed"><AttributeDependency /
DataConnectorDependency requires="<id>"/></span> </dd>
- <dd class="valueopt">An element of the element <span class="fixedwidth">
+ <dd class="valueopt">An element of the element <span class="fixed">
SimpleAttributeDefinition</span>, which may contain 0 or more of either
- <span class="fixedwidth">AttributeDependency</span> or
- <span class="fixedwidth">DataConnectorDependency</span>. These specify
+ <span class="fixed">AttributeDependency</span> or
+ <span class="fixed">DataConnectorDependency</span>. These specify
attributes and data connectors that can be utilized by this attribute
definition. Each of these elements must contain a
- <span class="fixedwidth">requires</span> statement which this attribute
+ <span class="fixed">requires</span> statement which this attribute
definition can then use to build its value.</dd>
- <dd class="attributeopt"><span class="fixedwidth">smartScope =
+ <dd class="attributeopt"><span class="fixed">smartScope =
"<domain>"</span> </dd>
<dd class="valueopt">Specifes a domain scope to be attached to the
attribute. If the value of the attribute as retrieved from the data
- connector includes a pre-existing scope (<span class="fixedwidth">bob@foo.edu</span>),
+ connector includes a pre-existing scope (<span class="fixed">bob@foo.edu</span>),
that scope is used instead. Contained within the
- <span class="fixedwidth">SimpleAttributeDefinition</span> element.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><lifeTime
+ <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
+ <dd class="attributeopt"><span class="fixed"><lifeTime
"<seconds>"/></span> </dd>
<dd class="valueopt">Specifies in the attribute assertion
how long the attribute should be cached and retained by the target upon
receipt. Federations and trust agreements may have some bearing on the
population and use of this field. Contained within the
- <span class="fixedwidth">SimpleAttributeDefinition</span> element.</dd>
- <dd class="attributeopt"><span class="fixedwidth">sourceName =
+ <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
+ <dd class="attributeopt"><span class="fixed">sourceName =
"<string>"</span> </dd>
<dd class="valueopt">Specifies a different source attribute name to be
used in calls to the data connector, while the name on the wire will be
- the specified <span class="fixedwidth">id</span>. This would be useful
+ the specified <span class="fixed">id</span>. This would be useful
to send a local UniversityID attribute as eduPersonPrincipalName. If not
- supplied, the connector tokenizes the <span class="fixedwidth">id</span>
- field and uses the section following the <span class="fixedwidth">#</span>
- to query data connectors. Contained within the <span class="fixedwidth">
+ supplied, the connector tokenizes the <span class="fixed">id</span>
+ field and uses the section following the <span class="fixed">#</span>
+ to query data connectors. Contained within the <span class="fixed">
SimpleAttributeDefinition</span> element.</dd>
- <dd class="attributeopt"><span class="fixedwidth"><cacheTime
+ <dd class="attributeopt"><span class="fixed"><cacheTime
"<seconds>"/></span> </dd>
<dd class="valueopt">Specifies an optional duration in
- <span class="fixedwidth">seconds</span> for which the attribute resolver
+ <span class="fixed">seconds</span> for which the attribute resolver
may cache this attribute for use in additional assertions. Contained within
- the <span class="fixedwidth">SimpleAttributeDefinition</span> element.</dd>
+ the <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
</dl>
- <p>A representation of a properly constructed <span class="fixedwidth">
+ <p>A representation of a properly constructed <span class="fixed">
SimpleAttributeDefinition</span> element would look like:</p>
<blockquote>
- <p><span class="fixedwidth"><SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName"<br>
+ <p><span class="fixed"><SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName"<br>
smartScope="shibdev.edu" cacheTime="600" lifeTime="3600" sourceName="universityPerson"><br>
<DataConnectorDependency requires="dataConnector"/><br>
<AttributeDependency requires="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"/><br>
</SimpleAttributeDefinition> </span></p>
</blockquote>
- <p>A properly formed <span class="fixedwidth">resolver.xml</span> file to
+ <p>A properly formed <span class="fixed">resolver.xml</span> file to
automatically generate a simple response for EPPN may take the form:</p>
<blockquote>
- <p><span class="fixedwidth"><AttributeResolver xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ <p><span class="fixed"><AttributeResolver xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:mace:shibboleth:resolver:1.0" xsi:schemaLocation="urn:mace:shibboleth:resolver:1.0
shibboleth-resolver-1.0.xsd"><br>
<br>
/><br>
</AttributeResolver> </span></p>
</blockquote>
- <p>There are additional examples of <span class="fixedwidth">resolver.xml</span>
+ <p>There are additional examples of <span class="fixed">resolver.xml</span>
files provided in the
<a href="http://marsalis.internet2.edu/cgi-bin/viewcvs.cgi/shibboleth/java/src/conf/">
Shibboleth CVS</a>.</p>
</blockquote>
<p><br>
</p>
-<h4><a name="5.d.i."></a>5.d.i <span class="fixedwidth">resolvertest</span></h4>
+<h4><a name="5.d.i."></a>5.d.i <span class="fixed">resolvertest</span></h4>
<blockquote>
<p>Shibboleth comes bundled with the command line utility
- <span class="fixedwidth">resolvertest</span> for testing Attribute Resolver
- configurations. This program takes as input <span class="fixedwidth">
+ <span class="fixed">resolvertest</span> for testing Attribute Resolver
+ configurations. This program takes as input <span class="fixed">
resolver.xml</span>, the name of a user, and optionally the name of a
requesting SHAR. It outputs the resulting SAML <Attribute /> elements. This
allows administrators to view the results of tweaking the resolver
configuration without having to continually reload the origin web
- 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>
+ application. <span class="fixed">resolvertest</span> is also useful for testing when the AA is first configured to use an attribute repository (ldap or sql). Initially, the following two steps must be performed:</p>
<ol>
- <li>Set the shell variable <span class="fixedwidth">SHIB_HOME</span> to
+ <li>Set the shell variable <span class="fixed">SHIB_HOME</span> to
the directory path where the Shibboleth tarball was exploded (typically
- <span class="fixedwidth">/opt/shibboleth-origin-1.1/</span>).</li>
+ <span class="fixed">/opt/shibboleth-origin-1.2/</span>).</li>
<li>Move to $SHIB_HOME/bin</li>
</ol>
- <p><span class="fixedwidth">resolvertest</span> may then be used by
+ <p><span class="fixed">resolvertest</span> may then be used by
executing the shell script, passing the name of a user and a URL to the
Attribute Resolver configuration file as parameters. For example:</p>
<blockquote>
- <p><span class="fixedwidth">$ ./resolvertest --user=wassa
+ <p><span class="fixed">$ ./resolvertest --user=wassa
--file=file:///$SHIB_HOME/src/conf/resolver.xml</span></p>
</blockquote>
<h5>NOTE: This program does not filter the resulting attributes through the
comprehensive, but instead rudimentary guidelines for basic configuration tests
and problems. For more detailed information or answers to specific problems not
addressed in this section, please mail
-<a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>
+<a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>
with a thorough description of errors and configurations used.</p>
<h4><a name="6.a."></a>6.a. Basic Testing</h4>
<blockquote>
<blockquote>
<p>Shibboleth's origin components log various operations which may prove
useful for auditing, testing, and security purposes. This data is sent
- through <span class="fixedwidth">log4j</span>'s standard mechanism. The
+ through <span class="fixed">log4j</span>'s standard mechanism. The
location of the log file, the level at which the log is output, the
formatting of the logs, and many more options may be configured by editing
- <span class="fixedwidth">/WEB-INF/classes/conf/log4j.properties</span>. By
+ <span class="fixed">/WEB-INF/classes/conf/log4j.properties</span>. By
default, it is setup to log to the console of the servlet container, with a
- level of <span class="fixedwidth">WARN</span>, but there is also a commented
+ level of <span class="fixed">WARN</span>, but there is also a commented
out example in the file to give a possible alternate configuration.</p>
</blockquote>
<h4><a name="6.c."></a>6.c. Common Problems</h4>
<blockquote>
<p>A knowledge base is being developed in the
- <a href="http://www.columbia.edu/~wassa/shib.faq/shibboleth-faq.html">
+ <a href="https://umdrive.memphis.edu/wassa/public/shib.faq/shibboleth-faq.html">
Shibboleth Deployer's FAQ</a>. Please mail
- <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@
- internet2.edu</a> with any additional questions or problems encountered that
+ <a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@nternet2.edu</a>
+ with any additional questions or problems encountered that
are not answered by this basic guide.</p>
</blockquote>
-<!doctype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
<title>Shibboleth Target Deployment Guide</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
}
a:visited
{
-color: #999999;
+color: #990000;
}
a:link
{
{
color: #440000;
}
+a.fixedlink:visited
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
+a.fixedlink:link
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
+a.fixedlink:active
+{
+font-family: monospace;
+font-size: 90%;
+color: #121212;
+text-decoration: none;
+}
dl
{
border-width:2px; background-color: #DDDDDD;
margin: 5px;
padding: 0px;
border-style: solid;
-
}
dt
{
.attribute
{
font-size: 115%;
-color: #000000;
+font-color: #000000;
text-align: left;
background-color: #DDDDDD;
border: 1px inset black;
margin: 0px;
padding: 2px
}
-.value
-{
-color: #000000;
-text-align: left;
-background-color: #EEEEEE;
-background-image: url('none');
-padding-top: 0em;
-padding-bottom: 0.5em;
-padding-right: 1em;
-padding-left: 5em;
-border-bottom-width: none;
-border-top-width: none;
-border-left-width: 1px;
-border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
-}
.attributeopt
{
font-size: 115%;
-color: #000000;
+font-color: #000000;
text-align: left;
-background-color: #BCBCEE;
+background-color: #EEEEEE;
border: 1px inset black;
background-image: url('none');
margin: 0px;
padding: 2px
}
-.valueopt
+.value
{
-color: #000000;
+font-color: #000000;
text-align: left;
-background-color: #DDDDFF;
+background-color: #EEEEEE;
background-image: url('none');
padding-top: 0em;
padding-bottom: 0.5em;
border-left-width: 1px;
border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
}
-.attributelong
-{
-font-size: 85%;
-color: #000000;
-text-align: left;
-background-color: #DDDDDD;
-border: 1px inset black;
-background-image: url('none');
-margin: 0px;
-padding: 2px
-}
-.attributeoptlong
+.mandatory
{
-font-size: 85%;
-color: #000000;
-text-align: left;
-background-color: #BCBCEE;
-border: 1px inset black;
-background-image: url('none');
-margin: 0px;
-padding: 2px
+font-color: #000000;
+background-color: #FFCCFF;
}
.demo
{
{
font-family: monospace;
font-size: 90%;
-color: #121212;
+font-color: #121212;
}
.feature
{
<h2>Shibboleth Target Deployment Guide</h2>
</center>
<p>Shibboleth Target Deployment Guide<br>
-Shibboleth Version 1.1<br />
-December 3, 2003<br />
-</p>
-<h3>This version of the deploy guide is for Shibboleth v1.1. For documentation
+Shibboleth Version 1.2<br />
+April 30, 2004<br />
+<h3>This version of the deploy guide is for Shibboleth v1.2. For documentation
related to prior versions of Shibboleth, please consult the appropriate branch
in the Shibboleth CVS.</h3>
-<h3>Federations have been abstracted out from the Shibboleth documentation. For
-further information on using Shibboleth in a federation, refer to the federation
-guide.</h3>
-<p>Shibboleth v1.1 is stable and secure enough to deploy in production
-scenarios. It is backward compatible with 1.0 in all respects, including
-configuration, but some older commands have been deprecated or replaced.</p>
-<p>Features and changes specific to 1.1 are marked with <span class="feature">
-[1.1]</span></p>
-<h4>Major New Features in 1.0 and 1.1</h4>
-<p>This new release contains several improvements and enhancements, including:
-</p>
-<h5>Federation Support</h5>
-<ol>
- <li>Federation and trust support has been substantially extended. Federation
- structures are now defined. The set of metadata collected and managed by
- each Federation is more fully defined. The configuration values assigned by
- a Federation are now identified. </li>
- <li>There is some support for targets to be members of multiple federations;
- this support will continue to evolve. When a browser user arrives, a target
- will determine which federation their origin belongs to, and then use the
- trust fabric associated with that Federation.</li>
- <li>Better support for flexible and bilateral trust agreements. A key
- specific to an origin site can be used to vallidate its signature.</li>
- <li>This version contains a significantly more mature security
- implementation, and should meet the security requirements of typical sites.</li>
-</ol>
-<h5>Origin</h5>
-<ol>
- <li>The Attribute Authority has a powerful new attribute resolver. Simple
- scenarios (using a string attribute stored in ldap) can be accomplished by
- merely editing a configuration file. Java classes may still be written for
- more complex evaluations (eg retrieving information from multiple disparate
- repositories, and computing the SAML attribute using business rules). This
- should greatly simplify the process of configuring the AA to support
- additional general attributes.</li>
- <li>A sample resolver file for using standard LDAP person and inetOrgPerson
- attributes is included. <span class="feature">[1.1]</span></li>
- <li>Support for a runtime-derived per-requester persistent identifier
- attribute to support anonymous personalization by targets has been added via
- an attribute plugin. <span class="feature">[1.1]</span></li>
- <li>Specialized sites without privacy needs can configure identity-based
- handles interoperable with other SAML deployments. <span class="feature">
- [1.1]</span></li>
-</ol>
-<h5>Target</h5>
-<ol>
- <li>Significantly more flexibility in configuring targets is provided to
- ensure robustness. Failover and redundant configurations are now supported.</li>
- <li>The SHAR may now optionally store its session and attribute cache in a
- back-end database in addition to the previously available in-memory option.
- </li>
- <span class="feature">[1.1]</span> </li>
- <li>Federation supplied files (sites.xml and trust.xml) are now refreshed in
- a much more robust manner. </li>
- </li>
- <li>The SHAR can be configured to request specific attributes from the
- Origin. </li>
- <li>The SHAR can use TCP sockets when responding to the Apache module, for
- specialized deployment behind firewalls. <span class="feature">[1.1]</span>
- </li>
- <li>Attribute acceptance policies have been greatly enhanced, and are now
- used to configure all aspects of attribute handling by the target, except
- for requesting specific attributes by sitename. Adding attributes now takes
- place in one configuration step. <span class="feature">[1.1]</span> </li>
- <li>Support for Apache 1.3 on Windows NT/2000/XP/2003 has been added.
- <span class="feature">[1.1]</span> </li>
- <li>Microsoft IIS web server support has been added via an ISAPI filter and
- extension. <span class="feature">[1.1]</span> </li>
-</ol>
-<h5>Miscellaneous</h5>
-<ol>
- <li>Origin sites can configure a value to describe the type of
- authentication mechanism used at the origin site (e.g. password, Kerberos,
- PKI, etc.). This value is made available on the target side as Shib-Authentication-Method.
- <br>
- </li>
- <li>Various improvements to error handling. Origin sites are now able to
- supply an "error URL" and contact information to a federation. When a target
- encounters an error, it can include this information in the error page. <br>
- </li>
- <li>Local time string values are now used in log files. <br>
- </li>
- <li>Internationalization support has been extended.</li>
-</ol>
+<h3>The default configuration of Shibboleth is <b>not</b> secure and should not be
+used for protection of production content. The example private key bundled with the
+distribution is publically available, widely circulated, and well-known; also, the
+default federation and trust metadata is for testing purposes only. For information
+about securing a Shibboleth deployment, please refer to the production guide.
+Shibboleth should only be used to protect sensitive content when deployed carefully
+in conjunction with proper trust settings and policies.</h3>
+
+<p>The Shibboleth target implementation has been substantially redesigned for this release. Most of the
+configuration process has changed to accomodate more complex deployments but many of the defaults work
+fine for testing and simpler applications. For a list of new features, please refer to the NEWS.txt
+file in the doc/ folder of the distribution.</p>
+
<p>Before starting, please sign up for all applicable
<a href="http://shibboleth.internet2.edu/shib-misc.html#mailinglist">mailing
lists</a>. Announcements pertinent to Shibboleth deployments and developments
and resources for deployment assistance can be found here.</p>
<p>Please send any questions, concerns, or eventual confusion to
-<a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>.
+<a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>.
This should include, but not be limited to, questions about the documentation,
undocumented problems, installation or operational issues, and anything else
-that arises. Please ensure that you have the
-<a href="http://shibboleth.internet2.edu/release/shib-download.html">appropriate
-tarball</a> for your operating system.</p>
+that arises.</p>
<p><br>
</p>
<hr>
<li><a href="#1.b."><font color="black">Target</font></a></li>
<li><a href="#1.c."><font color="black">WAYF</font></a></li>
<li><a href="#1.d."><font color="black">Federations</font></a></li>
+ <li><a href="#1.e."><font color="black">Relying Parties</font></a></li>
+ <li><a href="#1.f."><font color="black">Applications</font></a></li>
+ <li><a href="#1.g."><font color="black">Sessions</font></a></li>
</ol>
</li>
<li>
<li><a href="#2.c."><font color="black">Security Considerations</font></a></li>
<li><a href="#2.d."><font color="black">Server Certificates</font></a></li>
<li><a href="#2.e."><font color="black">Attribute Release Policies</font></a></li>
- <li><a href="#2.f."><font color="#000000">Attribute Acceptance Policies</font></a></li>
+ <li><a href="#2.f."><font color="black">Attribute Acceptance Policies</font></a></li>
<li><a href="#2.g."><font color="black">Browser Requirements</font></a></li>
<li><a href="#2.h."><font color="black">Clocks</font></a></li>
<li><a href="#2.i."><font color="black">Other Considerations</font></a></li>
<h4><a href="#4."><font color="black">Getting Running</font></a></h4>
<ol type="a">
<li><a href="#4.a."><font color="black">Configuring <span class="fixed">
- shibboleth.ini</span></font></a></li>
+ shibboleth.xml</span></font></a></li>
<li><a href="#4.b."><font color="black">Dynamic Error Page Generation</font></a></li>
<li><a href="#4.c."><font color="black">Key Generation and Certificate
Installation</font></a></li>
there should be a way to find information on local authentication and
authorization practices for federation members.</p>
</blockquote>
+<h4><a name="1.e."></a>1.e. Relying Parties</h4>
+<blockquote>
+ <p>Some aspects of both origin and target configuration can vary and be
+ expressed in terms of the "relying party". To an origin, a target
+ is a relying party, while targets consider origins to be relying
+ parties (it's a matter of perspective). Certificates, policies, and
+ other aspects of an interaction are specified on the basis of the relying
+ party, and may or may not vary between relying parties depending on the
+ deployment's needs.</p>
+ <p>Each origin and target is assigned a URI, a unique identifier to enable
+ control over configuration down to the level of an individual partner (a single
+ relying party). By convention, this is termed a "providerId". More
+ frequently, an entire federation will be viewed by an origin or target as a
+ single relying party to simplify management. An individual origin or target
+ with which this deployment exchanges information may sometimes be part of
+ multiple relying parties if there are multiple trust agreements
+ under which these transactions are performed. Care should be taken to avoid
+ conflicting or inconsistent configuration in such cases.</p>
+</blockquote>
+<h4><a name="1.f."></a>1.f. Applications</h4>
+<blockquote>
+ <p>Shibboleth "applications" are the primary unit of target
+ configuration. Applications as viewed by the target implementation
+ are not necessarily defined by the same metrics as in other contexts. An
+ individual application represents a set of web resources that operates
+ using the same attribute handling and trust configuration and shares a common
+ <a href="#1.g.">session</a> with the browser user. As a user navigates between
+ resources on a server that cross an application boundary, a new session is
+ established, though user interaction may not be required. As a consequence of
+ the relationship between applications and sessions (which are tracked with
+ a cookie), an application usually does not span more than one virtual host.
+ Apart from cookie-based constraints, web resources can be aggregated into
+ applications in arbitrary ways.</p>
+ <p>A single target deployment may support a large number of applications,
+ but it need not register or publish information about each one with the
+ origins it accepts information from. Instead it can communicate using a
+ more limited set of distinct "providerId" values (often just a
+ single one). This allows targets with a complex internal configuration
+ to be treated as a single entity by origins for the purposes of attribute
+ release.</p>
+</blockquote>
+<h4><a name="1.g."></a>1.g. Sessions</h4>
+<blockquote>
+ <p>Much of the target implementation is concerned with establishing, and
+ subsequently maintaining, sessions with the browser user on behalf of the
+ <a href="#1.f.">applications</a> at the target. A session consists of a
+ cookie passed between the browser and web server, associated with a
+ security context. The context contains the user's authentication information,
+ and generally a set of attributes that make up the user's identity. Each
+ application maintains distinct sessions with the browser by means of separate
+ cookies. It is important to note that all such sessions are independent and
+ distinct: any session can exist with or without any other session, and the
+ expiration of any one session does not imply the expiration of any other
+ session. Shibboleth also does not support any logout functionality beyond the
+ termination of individual application sessions by deletion of respective
+ cookies; also, there is no way for the target to cause origin-side sessions,
+ such as a user's SSO login, to expire.</p>
+ <p>A browser user accessing a Shibboleth-protected resource may have two
+ outcomes: standard session establishment, and lazy session
+ establishment. The standard session establishment mechanism in which
+ Shibboleth protects the resource in all circumstances results in the
+ establishment of a cookie-based browser session and a set of attributes
+ cached for that application. Shibboleth 1.2 also supports so-called lazy
+ session establishment, in which the resource may be accessed without prior
+ authentication. This means the application must be intelligent enough to
+ determine whether authentication is necessary, and then construct the proper URL
+ to initiate a browser redirect to request authentication; if the
+ application determines none is necessary or uses other authorization
+ mechanisms, then the request for authentication may not need to be triggered.
+ This complex functionality is mostly useful to protect a single URL with
+ different access mechanisms, or to require authenticated access only in
+ instances where the application deems it necessary.</p>
+ <p>Independently of this, a web-based application protected by Shibboleth
+ may have a need to establish its own session with the user. This session
+ may persist well beyond the Shibboleth session, and logouts from this
+ session, if supported, will not terminate a Shibboleth session initiated to
+ access the resource. Application administrators should carefully evaluate
+ the expiration of all sessions to limit vulnerability to attacks or user
+ negligence. Logging out of the entire desktop session is usually the
+ only (relatively) foolproof logout mechanism on the web.</p>
+</blockquote>
<hr>
<h3><a name="2."></a>2. Planning</h3>
<p>There are several essential elements that must be present in the environment
<blockquote>
<p>Shibboleth currently supports Windows NT/2000/XP/2003, Linux, and
Solaris. At present, Shibboleth consists of Apache (or IIS) plugins and a
- separate SHAR process. The plugins use the ONC RPC mechanism to communicate
+ separate SHAR process. The plugins use the Sun/ONC RPC mechanism to communicate
with the SHAR over Unix domain or TCP sockets. The target's web servers must
be running <a href="http://http://www.apache.org/dist/httpd/">Apache</a>
- 1.3.26+, or Microsoft IIS 4.0+, but not Apache 2. More precise technical
+ 1.3+, 2.0+, or Microsoft IIS 4.0+ More precise technical
details are discussed in <a href="#3.a.">3.a</a>.</p>
</blockquote>
<h4><a name="2.b."></a>2.b. Join a Federation</h4>
relationships. Each federation will have a different application process.</p>
<p>For more information on federations, refer to <a href="#1.d.">1.d</a> or
the Shibboleth v1.0 architectural document.</p>
- <p>To use Shibboleth without a federation, manual configuration of target
- and origin trust and site information will be needed to insure that sites
- interoperate. Most identifiers, such as site names, should be URI-based, and
- should be chosen in accordance with DNS domains under the control of the
- parties involved, much as Java package naming is coordinated. In other
- words, don't use a URI containing a DNS domain or hostname that you do not
- control.</p>
+ <p>For testing in a private environment, Shibboleth comes with a default
+ configuration that demonstrates how to implement a local peered agreement
+ and supports testing both origin and target on the same box using localhost
+ URLs. The sample key and certificate is for ease of testing only, and should
+ always be replaced for real world use.</p>
</blockquote>
<h4><a name="2.c."></a>2.c. Security Considerations</h4>
<blockquote>
against this is safeguarding the WAYF service and ensuring that rogue
targets and origins are not used, generally by development of the trust
model underneath Shibboleth. Shibboleth also leverages DNS for security,
- which is not uncommon, but attacks concerning bad domain information
+ which is not uncommon, but attacks concerning domain name lookups
should be considered.</li>
<li>Information regarding origin users is generally provided by the
authoritative enterprise directory, and the acceptance of requests from
target applications can be carefully restricted to ensure that all
requests the SHAR performs are authorized and all information the origin
- provides is accurate. Use of plaintext passwords is strongly advised
- against.</li>
+ provides is accurate. Proper security measures should also be in place
+ on directory access and population(see
+ <a href="http://www.georgetown.edu/giia/internet2/ldap-recipe/#AccessControl">
+ Access Control</a> in the
+ <a href="http://www.georgetown.edu/giia/internet2/ldap-recipe/">LDAP
+ recipe</a> for more information). Use of plaintext passwords is strongly
+ advised against.</li>
<li>Server platforms should be properly secured, commensurate with the
level that would be expected for an organization's other security
services, and cookie stores on client machines should be well protected.</li>
</blockquote>
<h4><a name="2.d."></a>2.d. Server Certs</h4>
<blockquote>
- <p>In the Shibboleth architecture, the SHAR, HS, and AA must all have
+ <p>In the Shibboleth architecture, the origin and target software must all have
various client and/or server certificates for use in signing assertions and
- creating SSL channels. These should be issued by a commonly accepted CA,
+ creating SSL connections These should be issued by a commonly accepted CA,
which may be stipulated by your federation. After understanding the CA's
acceptible to your federations, consult chapter <a href="#4.c.">4.c</a> for
information on certificate and key generation.</p>
</blockquote>
<h4><a name="2.e."></a>2.e. Attribute Release Policies</h4>
<blockquote>
- <p>The Attribute Authority maintains a set of rules called Attribute Release
- Policies (ARP's) that define which attributes are released to which targets.
- When a browser user tries to access a resource, the SHAR asks the origin
- site AA to release all the attributes it is allowed to know, possibly
- restricted to specifically desired subset. The SHAR provides its own name
- and an optional URL on behalf of which the attribute request is made which
- can further refine the information the SHAR is allowed to know. The AA
- processes this request using all applicable ARP's, determines which
- attributes and values it will release, and then obtains the values actually
- associated with the browser user. The AA sends these attributes and values
- back to the SHAR.</p>
- <p>Targets should work together with expected origin sites to ensure that
- the sets of attributes that both sites expect to correspond using are
- congruent.</p>
+ <p>The Attribute Authority maintains a set of policies called Attribute
+ Release Policies (or ARP's) that govern the sharing of user attributes with
+ Shibboleth target sites. When a user attempts to access a
+ Shibboleth-protected resource, that resource's SHAR queries the user's AA
+ for all attributes to which it is entitled. The SHAR provides its own name
+ and the URI of the requesting application. The
+ AA finds the attributes associated with the browser user, determines an
+ "Effective ARP" for this user, and then sends to the SHAR only the
+ attribute-value pairs allowed in this policy.</p>
+ <p>An ARP may be thought of as a sort of filter for outbound attributes; it
+ cannot create attributes or data that aren't originally present, but it can
+ limit the attributes released and the values those attributes may have when
+ released. It does not change the information in the data sources in any way.</p>
+ <p>Each ARP is comprised of one or more rules that specify which attributes
+ and values may be released to a given application and that SHAR. The
+ assignment of rules to various targets is quite flexible and includes
+ mechanisms for specifying: that a rule should affect all targets (default
+ rule), exact SHAR names for which a rule is applicable, regular expressions
+ against which SHAR names should be matched to determine if a rule is
+ applicable, and individual applications that may span hosts and URL's as
+ necessary.</p>
+ <p>For each request, an Effective ARP is determined by locating all ARP's
+ applicable to the designated user and extracting each rule that matches the
+ querying SHAR and resource. Attributes and values that are specified for
+ release are included in the effective ARP, while those specified for denial
+ are blocked from release. See section <a href="#5.b.i.">5.b.i</a> for
+ details on how ARP's are processed.</p>
+ <p>Various ARP's may be combined in forming the Effective ARP. For instance,
+ the Site ARP is administratively maintained and applies to all users for
+ which the AA is answerable. User ARP's apply to a specific user only, and
+ can be maintained either administratively or by the users themselves. All
+ ARP's are specified using the same syntax and semantics.</p>
</blockquote>
<h4><a name="2.f."></a>2.f. Attribute Acceptance Policies</h4>
<blockquote>
</blockquote>
<h4><a name="2.h."></a>2.h. Clocks</h4>
<blockquote>
- <p><a href="http://www.eecis.udel.edu/~ntp/">NTP</a> should be run on all
- web servers. Shibboleth employs a short handle issuance time to protect
+ <p><a href="http://www.ntp.org/">NTP</a> should be run on all
+ web servers. Shibboleth employs a short assertion acceptance window to protect
against replay attacks. Because of this, any significant degree of clock
skew can hinder the ability of users to access sites successfully.</p>
</blockquote>
and Privacy Act of 1974(FERPA)</a>, and all other relevant state and federal
legislation before deploying Shibboleth.</p>
</blockquote>
-<p><br>
-</p>
<hr>
<h3><a name="3."></a>3. Installation</h3>
<h4><a name="3.a."></a>3.a. Software Requirements</h4>
-<p>The Shibboleth project makes binary packages available for Solaris and Linux
+<p>The Shibboleth project makes binary packages available only for Windows,
that are precompiled against recent releases of various required libraries such
-as OpenSSL. It is highly advisable to build from source when using Shibboleth in
+as OpenSSL. Binaries for other platforms may be available on a limited or ad hoc
+basis. It is highly advisable to build from source when using Shibboleth in
a production environment in order to permit patching or updating of packages as
security holes and bugs are fixed. Building from source is necessary to give you
complete control over your deployment platform. The binary packages represent a
snapshot in time only. To build from source, see the <span class="fixed">
INSTALL.txt</span> files in the doc folder of the OpenSAML and Shibboleth source
distributions.</p>
-<p>The software requirements listed correspond to the binary distributions. In
+<p>The software requirements listed correspond to the binary distribution. In
general, source builds should work against all recent versions of the operating
systems and software dependencies listed below. For specific questions, inquire
to the support mailing list, or give it a try. Note that OpenSSL releases
frequent security updates; the version listed may not be the most current, but
most minor "letter" updates should be usable.</p>
<blockquote>
- <p><b>Operating System:</b> </p>
+ <p><b>General Requirements and Notes:</b></p>
<ul type="circle">
- <li>Windows NT/2000/XP/2003<ul type="disc">
- <li><a href="http://www.apache.org/dist/httpd/">Apache 1.3.27</a> or
- IIS 4.0+<blockquote>
- <p>Apache must be compiled with mod_so for DSO module support,
- and must include SSL support (preferably using
- <span class="fixed">mod_ssl</span>), and EAPI support (which
- <span class="fixed">mod_ssl</span> requires and provides).
- Shibboleth can coexist with <span class="fixed">mod_auth</span>,
- which may be compiled or loaded into the server for use
- elsewhere, but Shibboleth does not need or use it.</p>
+ <li><a href="http://www.apache.org/dist/httpd/">Apache 1.3.x</a>
+ <blockquote>
+ <p>Apache 1.3.x must be compiled with mod_so for DSO module support, and
+ should include SSL support (preferably using <span class="fixed">mod_ssl</span>),
+ and EAPI support (which <span class="fixed">mod_ssl</span> requires and provides).</p>
+ <p><b>Portions of the <span class="fixed">libphp4</span> Apache
+ module are written in C++, as is Shibboleth. There is a known conflict on Unix
+ platforms between the PHP extensions <span class="fixed">libpspell.so</span>
+ and <span class="fixed">libsablot.so</span> which will manifest
+ itself as segmentation faults when starting Apache. If a site wants
+ to use <span class="fixed">libphp4.so</span> and Shibboleth at the same time,
+ then one of the following may be done:</b>
+ <ol>
+ <li>Remove the options <span class="fixed">--with-pspell</span>
+ and <span class="fixed">--with-xslt-sablot</span> from PHP's
+ configuration.</li>
+ <li>Rebuild these two modules using the same version of GCC that
+ was used to compile Shibboleth.</li>
+ </ol>
+ </p>
+ </li>
+ <li><a href="http://www.apache.org/dist/httpd/">Apache 2.0.x</a>
+ <blockquote>
+ <p>Apache 2.0.x must be compiled with mod_so for DSO module support, and
+ should include SSL support which is available but not included by default.
+ See also the note about PHP above.</p>
+ </blockquote>
+ </li>
+ <li>IIS 4.0+
+ <blockquote>
+ <p>When installing under Windows 2003, if the server is not in a
+ domain before installing IIS 6, there may be issues surrounding
+ permissions on directories because of new restrictions on IIS
+ extensions accessing files.</p>
+ </blockquote>
+ </li>
+ <li><a href="http://www.openssl.org">OpenSSL</a>
+ <blockquote>
+ <p>Verions 0.9.6 and 0.9.7 are both supported, but 0.9.7 should be used
+ if possible, as support for 0.9.6 may be dropped in a future release.
+ Support for threads and shared libraries <b>must</b> be included during
+ configuration using the <i>threads</i> and <i>shared</i> options.</p>
+ </blockquote>
+ </li>
+ <p>Most other required libraries are either easy to update or not found
+ on typical systems. See the <span class="fixed">INSTALL.txt</span> files
+ in the OpenSAML and Shibboleth source distributions for specific requirements
+ of a given release. The important requirements are for pthreads support and
+ shared libraries on Unix platforms. Without both, building will be hard and
+ stability unlikely.</p>
+ </ul>
+ <p><b>Operating System Specific Notes:</b></p>
+ <ul type="circle">
+ <li>Windows NT/2000/XP/2003
+ <ul type="disc">
+ <li>
<p>Any Apache modules used, and Apache itself, must be compiled
with the Microsoft DLL-based runtime, selected by compiling with
- the /MD switch.</p>
- </blockquote>
- </li>
- <li>
- <a href="http://shibboleth.internet2.edu/release/shib-download.html">
- Shibboleth v1.1 Target for Windows</a><blockquote>
- <p>Available in both self-installer and ZIP format, the
- installer will prompt for an install path, change default
+ the /MD switch. The binary distribution was built against Apache
+ versions 1.3.29 (with EAPI patches from mod_ssl 2.8.16) and 2.0.48.
+ Forward compatibility is likely, but errors will result if an
+ Apache implementation such as IBM's IHS product or any other
+ non-EAPI version of 1.3 is used. In such cases, you must build
+ the Shibboleth Apache modules from source.</p>
+ </li>
+ <li>
+ <p>The installer will prompt for an install path, change default
configuration files as appropriate for Windows, and set various
environment variables for you. A default SHAR service can also
- be installed for you, or you can install it manually using the
+ be installed, or you can install it manually using the
instructions in this guide.</p>
<p>Note that debug/symbol versions of the libraries and software
are included, and may be used by appending "debug" to the
must also be compiled with Microsoft's debug runtime (via the /MDd
compiler option). In most cases, you can safely ignore or even
delete the debug versions.</p>
- </blockquote>
+ </li>
+ </ul>
+ </li>
+ <li>RedHat Linux 7.2,7.3:
+ <ul type="disc">
+ <li>
+ <p>The most recent Red Hat RPM for Apache (1.3.27-2 as of this writing) is sufficient for
+ use with Shibboleth. You can use the older version of OpenSSL included with the OS, for this
+ release, but be advised this may change in the future.</p>
</li>
- </ul>
+ <li>
+ <p>The version of GCC that comes with this system is too old to build Shibboleth.
+ Special update RPMs are available for GCC 3.04 that will work provided you
+ configure packages with CC and CXX set to gcc3 and g++3 respectively. Newer
+ GCC versions also work but may require a glibc upgrade and necessitate a lot
+ of unrelated package updates.</p>
+ </li>
+ </ul>
</li>
- <p> </li>
- <li>RedHat 7.2-7.3:<ul type="disc">
- <li><a href="http://www.apache.org/dist/httpd/">Apache 1.3.27</a><blockquote>
- <p>Apache must be compiled with mod_so for DSO module support,
- and must include SSL support (preferably using
- <span class="fixed">mod_ssl</span>), and EAPI support (which
- <span class="fixed">mod_ssl</span> requires and provides).
- Shibboleth can coexist with <span class="fixed">mod_auth</span>,
- which may be compiled or loaded into the server for use
- elsewhere, but Shibboleth does not need or use it. The most
- recent Red Hat RPM (1.3.27-2 as of this writing) is sufficient.</p>
- </blockquote>
- <blockquote>
- <p>On Linux, Shibboleth requires that Apache and Apache-SSL be
- built with <span class="fixed">libpthread</span>, or loading the
- <span class="fixed">mod_shibrm</span> or <span class="fixed">
- mod_shire</span> modules will cause Apache to stop. While
- RedHat's Apache is compatible, Debian's Apache must be rebuilt
- with <span class="fixed">libpthread</span>:</p>
+ <li>RedHat Linux 9 / Fedora
+ <ul type="disc">
+ <li>
+ <p>Apache 2.0 is included as the default Apache version in this release.</p>
+ </li>
+ </ul>
+ </li>
+ <li>RedHat Enterprise Linux
+ <ul type="disc">
+ <li>
+ <p>Apache 2.0 is included as the default Apache version in this release.</p>
+ </li>
+ </ul>
+ </li>
+ <li>Debian Linux
+ <ul type="disc">
+ <li>
+ <p>Shibboleth requires that Apache and Apache-SSL be built with
+ <span class="fixed">libpthread</span>, or loading the
+ <span class="fixed">mod_shib_13</span> or <span class="fixed">mod_shib_20</span>
+ modules will cause Apache to fail. While RedHat's Apache is compatible,
+ Debian's Apache must be rebuilt with <span class="fixed">libpthread</span>:</p>
<blockquote>
<p><span class="fixed">$ export LDFLAGS=-lpthread<br>
$ apt-build --rebuild --reinstall install \<br>
apache-common apache apache-ssl</span></p>
</blockquote>
- </blockquote>
</li>
- <li>
- <a href="http://shibboleth.internet2.edu/release/shib-download.html">
- Shibboleth v1.1 Target for RedHat</a></li>
- <li><a href="http://www.openssl.org/source/">openssl-0.9.6, revision
- <span class="fixed">i</span> or newer</a></li>
- <li>libstdc++3-3.0.4-1.i386.rpm and libgcc-3.0.4-1.i386.rpm<blockquote>
- <p>Shibboleth binaries are currently built with
- <a href="http://www.gnu.org/software/gcc/gcc.html">GCC 3.04</a>,
- and require these specific library versions. They are available
- as RPMs and are available in the RedHat 7.2 updates directory on
- any
- <a href="ftp://rufus.w3.org/linux/redhat/updates/7.2/en/os/i386/">
- RedHat mirror</a>. They can be installed alongside earlier and
- later GCC libraries.</p>
- </blockquote>
- </li>
- <li><b>Portions of the <span class="fixed">libphp4</span> Apache
- plugin are written in C++, as is Shibboleth. There is a known
- conflict between the PHP extensions <span class="fixed">libpspell.so</span>
- and <span class="fixed">libsablot.so</span> which will manifest
- itself as segmentation faults when starting Apache. If a site wants
- to use <span class="fixed">libphp4.so</span> and Shibboleth at once,
- then one of the following may be done:</b><ol>
- <li>Remove the options <span class="fixed">--with-pspell</span>
- and <span class="fixed">--with-xslt-sablot</span> from PHP's
- configuration.</li>
- <li>Rebuild these two modules using the same version of GCC that
- was used to compile Shibboleth.</li>
- </ol>
- </li>
- </ul>
- </li>
- <p><br>
+ </ul>
</li>
- <li>Solaris 2.8:<ul type="disc">
- <li><a HREF="ftp://ftp.openssl.org/source/openssl-0.9.7b.tar.gz">
- openssl-0.9.7</a>
- <blockquote>
+ <li>Solaris 2.6+:
+ <ul type="disc">
+ <li>
<p>The shared library version of OpenSSL is required by
Shibboleth. The static libraries may be installed as well if
- necessary for other applications, but cannot be used within
- mod_ssl or any other Apache modules. openssl-0.9.7b, the latest
- security fix release, has been tested, but any 0.9.7 version
- should work.</p>
- </blockquote>
- </li>
- <li><a href="http://www.apache.org/dist/httpd/">Apache 1.3.27</a><blockquote>
- <p>Apache must be compiled with mod_so for DSO module support,
- and must include SSL support (preferably using
- <span class="fixed">mod_ssl</span>) and EAPI support (which
- <span class="fixed">mod_ssl</span> requires and provides).
- Shibboleth can coexist with <span class="fixed">mod_auth</span>,
- which may be compiled or loaded into the server for use
- elsewhere, but Shibboleth does not need or use it.</p>
- <p><span class="fixed">mod_ssl</span>'s loadable module,
- <span class="fixed">libssl.so</span>, must be compiled against
- <span class="fixed">OpenSSL 0.9.7b</span>'s shared libraries.
- Other versions or a statically linked build of
- <span class="fixed">libssl.so</span> will cause failures such as
- bus errors when used with Shibboleth.</p>
- <p>To check how OpenSSL was built, run the <span class="fixed">
+ necessary for other applications, but cannot be linked into
+ mod_ssl or any other Apache modules. If mod_ssl's libssl.so
+ module is linked against the static version, bus errors will
+ result.</p>
+ <p>To check how mod_ssl was built, run the <span class="fixed">
ldd</span> command against <span class="fixed">libssl.so</span>
- in the Apache <span class="fixed">/libexec/</span> folder and
+ in the Apache <span class="fixed">libexec/</span> folder and
check the output for references to <span class="fixed">
- libssl.so.0.9.7b</span>. If you see an earlier version
- mentioned, or no mention of it at all, then <span class="fixed">
- OpenSSL 0.9.7b</span> must be built with shared libraries from
- source, and the Apache module rebuilt with it.</p>
- </blockquote>
+ libssl.so.0.9.7</span>. If you see an earlier version
+ mentioned, or no mention of it at all, then OpenSSL 0.9.7 must be
+ built with shared libraries from source, and the Apache module rebuilt with it.</p>
+ <p>openssl-0.9.7d, the latest security fix release, has been tested,
+ but any 0.9.7 version should work.</p>
</li>
<li>
- <a href="ftp://ftp.sunfreeware.com/pub/freeware/sparc/8/libgcc-3.2.2-sol8-sparc-local.gz">
- libgcc v3.2.2+ and libstdc++ v3.2.2+</a><blockquote>
- <p>Shibboleth binaries are currently built with
- <a HREF="http://www.gnu.org/software/gcc/gcc.html">GCC 3.2.2</a>,
- and require these specific library versions or newer. They are
- available as Sun freeware packages and can be installed
- alongside earlier and later GCC libraries.</p>
- </blockquote>
+ <p>Solaris does not come with GCC 3, but various versions can be obtained
+ from <a href="http://www.sunfreeware.com">http://www.sunfreeware.com</a>.
+ If building your own, GCC must be configured to use Sun's linker. Note that
+ you should use a consistent version of GCC across any other C++ libraries
+ in use within Apache, but other C++ code on your server can freely use a
+ different version as long as the necessary <span class="fixed">libstdc++.so</span>
+ for a given version is available</p>
</li>
<li>
- <a href="http://shibboleth.internet2.edu/release/shib-download.html">
- Shibboleth v1.1 Target for Solaris</a></li>
- <li><b>Portions of the <span class="fixed">libphp4</span> Apache
- plugin are written in C++, as is Shibboleth. There is a known
- conflict with the PHP extensions <span class="fixed">libpspell.so</span>
- and <span class="fixed">libsablot.so</span> which will manifest
- itself as segmentation faults when starting Apache. If a site wants
- to use <span class="fixed">libphp4.so</span> and Shibboleth at once,
- then one of the following may be done:</b><ol>
- <li>Remove the options <span class="fixed">--with-pspell</span>
- and <span class="fixed">--with-xslt-sablot</span> from PHP's
- configuration.</li>
- <li>Rebuild these two modules using the same version of GCC that
- was used to compile Shibboleth.</li>
- </ol>
- </li>
- </ul>
- </li>
- <p><br>
- </li>
- <li>RedHat 8 and 9:<blockquote>
- <p>RedHat 8 and 9 ship with Apache 2, which is not yet supported by
- Shibboleth. To run Shibboleth under this OS,
- <a href="http://www.apache.org/dist/httpd/">Apache 1.3.27</a> must
- be installed.</p>
- </blockquote>
- <blockquote>
- <p>Apache must be compiled with mod_so for DSO module support, and
- must include SSL support (preferably using <span class="fixed">
- mod_ssl</span>), and EAPI support (which <span class="fixed">mod_ssl</span>
- requires and provides). Shibboleth can coexist with
- <span class="fixed">mod_auth</span>, which may be compiled or loaded
- into the server for use elsewhere, but Shibboleth does not need or
- use it. The most recent Red Hat RPM (1.3.23-14 as of this writing)
- is sufficient.</p>
- </blockquote>
- <blockquote>
- <p>On Linux, Shibboleth requires that Apache and Apache-SSL be built
- with <span class="fixed">libpthread</span>, or loading the
- <span class="fixed">mod_shibrm</span> or <span class="fixed">
- mod_shire</span> modules will cause Apache to stop. While RedHat's
- Apache is compatible, Debian's Apache must be rebuilt with
- <span class="fixed">libpthread</span>:</p>
- <blockquote>
- <p><span class="fixed">$ export LDFLAGS=-lpthread<br>
- $ apt-build --rebuild --reinstall install apache-common \<br>
- apache apache-ssl</span></p>
- </blockquote>
- </blockquote>
- <ul type="disc">
- <li>
- <a href="http://shibboleth.internet2.edu/release/shib-download.html">
- Shibboleth 1.1 Target for RedHat</a></li>
- <li><a href="http://www.openssl.org/source/">openssl-0.9.6, revision
- <span class="fixed">i</span> or newer</a></li>
- <li>libstdc++3-3.0.4-1.i386.rpm and libgcc-3.0.4-1.i386.rpm
- <blockquote>
- <p>Shibboleth binaries are currently built with
- <a href="http://www.gnu.org/software/gcc/gcc.html">GCC 3.04</a>,
- and require these specific library versions. They are available
- as RPMs and are available in the RedHat 7.2 updates directory on
- any
- <a href="ftp://rufus.w3.org/linux/redhat/updates/7.2/en/os/i386/">
- RedHat mirror</a>. They can be installed alongside earlier and
- later GCC libraries.</p>
- </blockquote>
- </li>
- <li><b>Portions of the <span class="fixed">libphp4</span> Apache
- plugin are written in C++, as is Shibboleth. There is a known
- conflict with the PHP extensions <span class="fixed">libpspell.so</span>
- and <span class="fixed">libsablot.so</span> which will manifest
- itself as segmentation faults when starting Apache. If a site wants
- to use <span class="fixed">libphp4.so</span> and Shibboleth at once,
- then one of the following may be done:</b>
- <ol>
- <li>Remove the options <span class="fixed">--with-pspell</span>
- and <span class="fixed">--with-xslt-sablot</span> from PHP's
- configuration. </li>
- <li>Rebuild these two modules using the same version of GCC that
- was used to compile Shibboleth. </li>
- </ol>
+ <p>Use of GCC is recommended, but new releases of Sun's Forte compiler have
+ been used successfully with some tinkering with configuration scripts.</p>
</li>
</ul>
</li>
<p>For the sake of clarity, this deployment guide assumes that standard
directories are used for all installations. These directories may be changed
for local implementations, but must be done so consistently.</p>
- <ol type="1">
- <li>Ensure that you have obtained the proper
- <a href="http://shibboleth.internet2.edu/release/shib-download.html">
- tarball</a> or installer for your operating system.</li>
- <li>On Unix, the tarballs expand into <span class="fixed">
- /opt/shibboleth</span>, and should be expanded as <span class="fixed">
- root</span> from <span class="fixed">/</span>. If you use a different
- layout or location, you will need to adjust your configuration files.
- You should see the following directory structure (date and size details
- notwithstanding):<blockquote>
- <p><span class="fixed">$ ls -l<br>
- drwxr-xr-x 2 root root 4096 Oct 24 03:54 bin<br>
- drwxr-xr-x 2 root root 4096 Oct 24 03:54 data<br>
- drwxr-xr-x 2 root root 4096 Oct 24 03:54 doc<br>
- drwxr-xr-x 4 root root 4096 Oct 24 03:54 etc<br>
- drwxr-xr-x 9 root root 4096 Oct 24 03:54 include<br>
- drwxr-xr-x 4 root root 4096 Oct 24 03:55 lib<br>
- drwxr-xr-x 2 root root 4096 Oct 24 03:55 libexec<br>
- drwxr-xr-x 4 root root 4096 Oct 24 02:02 share</span></p>
- </blockquote>
- <p>On Windows, if the installer is not used, the zip file should be
- unpacked beneath the root of the system drive, where it will create an
- <span class="fixed">\opt\shibboleth</span> tree that resembles the Unix
- layout above. This will allow the standard configuration options to
- work. <b>The <span class="fixed">C:\opt\shibboleth\lib</span> directory
- MUST be added to the system path to enable proper operation.</b> If you
- use a different location, changes to various configuration files must be
- made by hand. The installer can do this for you, and is recommended in
- such cases.</li>
- </ol>
+ <p>On Unix, the build documentation suggests building into
+ <span class="fixed">/opt/shibboleth</span>. If you use a different layout or
+ location, most of the essential configuration files will be tweaked for you,
+ but watch for any exceptions.</p>
+ <p>On Windows, use of the installer is recommended. Visual Studio 6.0
+ project files are included with the OpenSAML and Shibboleth source
+ distributions for source builds if maximum flexibility to deal with
+ security issues or Apache variants is desired.</p>
</blockquote>
-<h4><a name="3.c."></a>3.c. Configure Apache 1.3.x</h4>
+<h4><a name="3.c."></a>3.c. Configure Apache</h4>
<blockquote>
<ol type="1">
- <li>Shibboleth includes configuration directives in the file
+ <li>Shibboleth includes configuration directives in the files
<span class="fixed">/opt/shibboleth/etc/shibboleth/apache.config</span>
- which must be added to the httpd.conf file used locally. It is
- recommended that these directives simply be added to the end of the
+ and <span class="fixed">/opt/shibboleth/etc/shibboleth/apache2.config</span>
+ which must be added to the <span class="fixed">httpd.conf</span> file used
+ locally. It is recommended that these directives simply be added to the end of the
existing <span class="fixed">httpd.conf</span> file rather than trying
to merge it in-line; <a href="#3.c.2.">step 2</a> describes the
necessary modifications to the Apache startup script. The default
configuration will often work, but if customization is necessary, these
options may be modified:<dl>
- <dd class="attribute"><span class="fixed">LoadModule <module>
- <pathname></span> </dd>
- <dd class="value">Specifies the title and location of the
- <span class="fixed">shibrm_module</span> resource manager and
- <span class="fixed">shire_module</span> SHIRE modules. These are
- installed by default at <span class="fixed">/opt/shibboleth/libexec/mod_shibrm.so</span>
- and <span class="fixed">/opt/shibboleth/libexec/mod_shire.so</span></dd>
- <dd class="attribute"><span class="fixed">SHIREConfig <pathname></span>
- </dd>
+ <dd class="attribute"><span class="fixed">LoadModule <module> <pathname></span></dd>
+ <dd class="value">Specifies the name and location of the module,
+ installed by default at <span class="fixed">/opt/shibboleth/libexec/mod_shib_13.so</span>
+ or <span class="fixed">/opt/shibboleth/libexec/mod_shib_20.so</span></dd>
+
+ <dd class="attribute"><span class="fixed">ShibConfig <pathname></span></dd>
<dd class="value">Specifies the <span class="fixed">pathname</span>
- of the SHIRE's configuration file. Defaults to <span class="fixed">
- /opt/shibboleth/etc/shibboleth/shibboleth.ini</span>.</dd>
- <dd class="attribute"><span class="fixed">SHIREURL <url><br>
- <Location <url>><br>
+ of the Shibboleth configuration file. Defaults to <span class="fixed">
+ /opt/shibboleth/etc/shibboleth/shibboleth.xml</span>.</dd>
+
+ <dd class="attribute"><span class="fixed">ShibSchemaDir <path></span></dd>
+ <dd class="value">Specifies the <span class="fixed">path</span>
+ of the Shibboleth schema folder. Defaults to <span class="fixed">
+ /opt/shibboleth/etc/shibboleth</span>.</dd>
+
+ <dd class="attribute"><span class="fixed"><Location <i>url</i>><br>
SetHandler <method><br>
</Location></span></dd>
- <dd class="value">Specifies the <span class="fixed">URL</span> and
- the <span class="fixed">method</span> the target uses to handle
- requests for Shibboleth-protected resources. Currently,
- <span class="fixed">shib-shire-post</span> is the only available
- handler <span class="fixed">method</span>. <span class="fixed">
- SHIREURL</span> is used by Shibboleth when re-directing the user to
- the WAYF and <span class="fixed"><Location></span> by Apache; for
- this reason, both <span class="fixed">URL</span> specifications must
- match. Note that the configuration file itself contains <>'s, and
- <span class="fixed">Location</span> should not be replaced.<p>The
- referenced <span class="fixed">URL</span> can be either a partial
- path or an absolute URL. The partial path allows each virtual server
- to use its own hostname and port in the SHIRE for session cookie
- purposes, while the absolute URL forces HTTP virtual servers to use
- HTTPS for the SHIRE. Use of a full <span class="fixed">https://</span>
- URL is advised.</dd>
- <dd class="attribute"><span class="fixed">ShibMapAttribute
- <attribute-uri> <HTTP-header> [alias]</span> </dd>
- <dd class="value"><b>This command has been deprecated in favor of
- the configuration support available in the Attribute Acceptance
- Policy file. See <a href="#4.e.">section 4.e.</a> It may be removed
- in a future release.</b></dd>
+ <dd class="value"><p>(Apache 1.3 only) Specifies the relative <span class="fixed">path</span>
+ and the <span class="fixed">handler</span> the target uses to process
+ incoming sessions and lazy session startup for Shibboleth-protected
+ resources. This works in concert with the <span class="fixed">shireURL</span>
+ settings in the XML configuration file. Any virtual locations that are to be
+ used for this purpose should be defined to Apache here.</p>
+ <p>Another option for some sites is to configure Shibboleth globally in
+ "lazy" session mode for all content. This allows the module to
+ detect session requests and pass them to the handler without the need to
+ configure the handler itself.</p>
+ </dd>
</dl>
</li>
- <li><a name="3.c.2."></a>These modifications must be made to the Apache
- startup script on Unix:<p>Add the following environment variable:</p>
- <blockquote>
- <p><span class="fixed">SHIBCONFIG=/opt/shibboleth/etc/shibboleth/shibboleth.ini<br>
- export SHIBCONFIG</span></p>
- </blockquote>
- <p>If the SHIBCONFIG environment variable is not specified, Shibboleth
- will use <span class="fixed">/opt/shibboleth/etc/shibboleth/shibboleth.ini</span>
- by default.</p>
- <p>On Windows, the installer will set the path and SHIBCONFIG variable
- for you in the system path, enabling Apache or IIS to be used.</li>
<li>If the OpenSSL libraries are not in the system's search path, they
- should be added to <span class="fixed">LD_LIBRARY_PATH</span>. Generally
- libtool's linker options will insure that the modules can locate the
- Shibboleth libraries, but if not, you may need to add
- <span class="fixed">/opt/shibboleth/lib</span> to <span class="fixed">
- LD_LIBRARY_PATH</span> as well.</li>
+ should be added to the <span class="fixed">LD_LIBRARY_PATH</span> used by
+ Apache. You will also usually need to add <span class="fixed">/opt/shibboleth/lib</span>
+ to <span class="fixed">LD_LIBRARY_PATH</span> as well.</li>
<li>The SHAR must be started along with Apache. Among other methods on
Unix, this can be done either by creating a separate SHAR startup script
or by modifying Apache's RC script to start/stop the <span class="fixed">
suggested that Apache's script be modified by adding:<blockquote>
<p><span class="fixed">/opt/shibboleth/bin/shar -f &</span> </p>
</blockquote>
- <p>Sample <span class="fixed">init.d</span> scripts may be included with
- future releases. Ensure that the environment variable referenced in
- <a href="#3.c.2">3.c.2</a> are in place.</p>
+ <p>In most cases, the build process insures that the SHAR can locate
+ the configuration file and schemas, but the SHIBCONFIG and SHIBSCHEMAS
+ environment variables may be used as well. Command line options can also
+ be used to specify them.</p>
<p>On Windows, the SHAR is a service and is managed separately.</li>
- <li>By default, the Shibboleth modules are configured to log information
+ <li>By default, the Shibboleth modules are configured to log information
on behalf of Apache to the file <span class="fixed">
- /opt/shibboleth/etc/shibboleth/shire.log</span>, though this can be
- changed. For this log to be created, Apache must have permission to
- write to this file, which may require that the file be manually created
- and permissions assigned to whatever user Apache is configured to run
- under. If the file does not appear when Apache runs with the modules
- loaded, check for permission problems. </li>
- <li>The options in <span class="fixed">shibboleth.ini</span> must be
- configured as documented in <a href="#4.a.">4.a</a>. Apache content will
+ /opt/shibboleth/var/log/shibboleth/shire.log</span>, though this can be
+ changed by modifying the <span class="fixed">.logger</span> files
+ pointed to by <a href="#4.a.">configuration elements</a>. For this log
+ to be created, Apache must have permission to write to this file, which
+ may require that the file be manually created and permissions assigned
+ to whatever user Apache is configured to run under. If the file does not
+ appear when Apache runs with the modules loaded, check for permission
+ problems.</li>
+ <li>The options in <span class="fixed">shibboleth.xml</span> must be
+ configured as documented in <a href="#4.a.">4.a</a>. Apache content may
then need to be modified for Shibboleth authentication. This is
discussed in <a href="#4.d.">4.d</a>. It is recommended that the target
then be tested as detailed in section <a href="#5.a.">5.a</a>.</li>
<h4><a name="3.d."></a>3.d. Configure Microsoft IIS</h4>
<blockquote>
<ol type="1">
- <li>The package includes an ISAPI filter and bundled extension for SHIRE
- POST processing in a single library, <span class="fixed">libexec\isapi_shib.dll</span>.
+ <li>The package includes an ISAPI filter and bundled extension for
+ session startup in a single library, <span class="fixed">libexec\isapi_shib.dll</span>.
This filter is configured using commands in <span class="fixed">
- C:\opt\shibboleth\etc\shibboleth\shibboleth.ini</span>. Make sure you've
- added the library directory to the path as directed in <a href="#3.b.">
- section 3.b.</a><p>Installing the extension into IIS is a two step
- process:<ol type="1">
+ C:\opt\shibboleth\etc\shibboleth\shibboleth.xml</span> (or wherever you've
+ installed the software). Make sure you or the installer has added the lib
+ directory to the path as directed in <a href="#3.b.">section 3.b.</a>
+ You will generally need to restart the system after installation.
+ <p>Installing the extension into IIS is a two step process:
+ <ol type="1">
<li type="a">First, add the filter using the Internet Services
Manager MMC console. Right click on the machine icon on the left,
and edit the WWW Service master properties. On the "ISAPI Filters"
above. The priority should be High, and once the filter is loaded,
make sure it appears in the list <b>below</b> the "sspifilt" entry.
Restart IIS and make sure the filter shows up with a green arrow.
- Check the Windows event log if it fails to load. The default
- configuration options are sparse, but they should allow the filter
- to at least initialize.</li>
- <li type="a">Secondly, map a special file extension, such as
+ Check the Windows event log if it fails to load.</li>
+ <li type="a">Secondly, map a special, distinct file extension, such as
<span class="fixed">.shire</span>, to the ISAPI library so that
- virtual URLs can be specified to invoke the SHIRE handler for each
+ virtual URLs can be specified to invoke the extension handler for each
web site. Right click on the machine icon on the left, and edit the
WWW Service master properties. On the "Home Directory" tab, add a
script mapping using the "Configuration" button. The "Executable"
box should point to <span class="fixed">isapi_shib.dll</span>, and the
"Extension" can be set to anything unlikely to conflict, but
<span class="fixed">.shire</span> is assumed (and the dot must be
- included). You should select the option to limit verbs to POST, and
- you must uncheck the "Check that file exists" box.</li>
+ included). You should NOT select the option to limit verbs, and
+ you MUST uncheck the "Check that file exists" box. On newer
+ versions of IIS, checking the "Script Engine" box is suggested,
+ as it will permit the extension to handle requests in directories with only
+ script permissions assigned.</li>
<li type="a"><font color=#444499>(IIS 6 Only)</font> A new Web
Service Extension must be defined for Shibboleth; without this, the
mapping from <span class="fixed">*.shire</span> to <span
class="fixed">isapi_shib.dll</span> won't occur and a file error
- will show. Add this extension with an arbitrary name and associate
+ will appear Add this extension with an arbitrary name and associate
it with <span class="fixed">isapi_shib.dll</span>.</li>
</ol>
</li>
<li>All other aspects of configuration are handled via the
- <span class="fixed">shibboleth.ini</span> file and associated XML-based
- policy files described in subsequent sections. Particular use is made of
- the per-hostname section feature that allows global settings to be
- overridden per-site, and this permits different IIS instances to be
- separately configured.</li>
- <li>A special section must be added/uncommented in the
- <span class="fixed">shibboleth.ini</span> file to support IIS usage. The
- <span class="fixed">[isapi]</span> section must be used to map IIS
- Instance ID numbers to fully-qualified hostnames that correspond to
- named sections later in the file. Instance IDs are used in the IIS
- metabase to identify web sites. They are applied starting with the
- number 1 and number the web sites in order in the Internet Services
- Manager from top to bottom. In the <span class="fixed">[isapi]</span>
- section, add lines in the following form:
- <blockquote class="fixed">
- <p>1=hostname.domain.com<br>
- 2=hostname2.domain.com<br>
- (etc...)</p>
- </blockquote>
- <p>At least an empty configuration section named <span class="fixed">
- hostname.domain.com</span> should then be added to the end of the file.
- Any options specific to that web site can be added as documented in
- later sections.</li>
+ <span class="fixed">shibboleth.xml</span> file and associated XML
+ files described in subsequent sections. Particular use is made of
+ the <span class="fixed">/SHIRE/Implementation/ISAPI</span> element that allows
+ IIS sites to be mapped to scheme, hostname, and port for proper request
+ mapping and generation of redirects.</li>
+ <li>Instance IDs are used in the IIS metabase to identify web sites. In older versions,
+ they are applied starting with 1(one) and number the web sites in order in the
+ Internet Services Manager from top to bottom. Newer versions appear to assign
+ some IID values with strange ASCII formulas applied to the site name. A simple
+ ASP or CGI script can be run within a site to dump the INSTANCE_ID header.</li>
<li>See the following section for information on running the SHAR
service on Windows.</li>
- <li>The options in <span class="fixed">shibboleth.ini</span> must be
+ <li>The options in <span class="fixed">shibboleth.xml</span> must be
configured as documented in <a href="#4.a.">4.a</a>. It is recommended
- that the target then be tested as detailed in section <a href="#5.a.">
- 5.a</a>.</li>
+ that the target then be tested as detailed in section <a href="#5.a.">5.a</a>.</li>
</ol>
</blockquote>
<h4><a name="3.e."></a>3.e. Running the SHAR on Windows</h4>
<blockquote>
<p>The SHAR is a console application that is primarily designed to be
installed as a Windows service. To run the process in console mode for
- testing, the <span class="fixed">-console</span> parameter is used.
- Otherwise, parameters are used to install (or remove) the SHAR from the
+ testing or to diagnose major problems, the <span class="fixed">-console</span>
+ parameter is used. Otherwise, parameters are used to install (or remove) the SHAR from the
service database and subsequent control is via the Service Control Manager
applet. The following command line parameters can be used:</p>
<dl>
<dd class="value">Allows the process to be started from a command
prompt. Since the console will exit if the desktop user logs out, this
is not suitable for production use, but may be useful for testing.</dd>
+ <dd class="attribute"><span class="fixed">-check</span></dd>
+ <dd class="value">Validates the general correctness of the configuration.
+ Not all problems can be detected this way, but the chance of successful startup
+ is high if the checking process does not log any errors.</dd>
<dd class="attribute"><span class="fixed">-config <pathname></span> </dd>
<dd class="value">Specifies the pathname of the SHAR's configuration
- file. Defaults to <span class="fixed">\opt\shibboleth\etc\shibboleth\shibboleth.ini</span>
+ file. Defaults to <span class="fixed">\opt\shibboleth\etc\shibboleth\shibboleth.xml</span>
or the value of the <span class="fixed">SHIBCONFIG</span> environment
variable, if it is set.</dd>
+ <dd class="attribute"><span class="fixed">-schemadir <path></span> </dd>
+ <dd class="value">Specifies the path to the XML schema files. Defaults to
+ <span class="fixed">\opt\shibboleth\etc\shibboleth</span> or the value of the
+ <span class="fixed">SHIBSCHEMAS</span> environment variable, if it is set.</dd>
<dd class="attribute"><span class="fixed">-install <servicename></span></dd>
<dd class="value">Installs the SHAR as a named service in the Windows
service database. A name should be provided if multiple instances of the
</blockquote>
<hr>
<h3><a name="4."></a>4. Getting Running</h3>
-<h4><a name="4.a."></a>4.a. Configuring <span class="fixed">shibboleth.ini</span></h4>
+<h4><a name="4.a."></a>4.a. Configuring <span class="fixed">shibboleth.xml</span></h4>
<blockquote>
- <p>Most of the configuration for the SHAR, SHIRE, and RM is stored in the
- file <span class="fixed">shibboleth.ini</span>. This file is split into
- several pre-defined sections. The first sections, <span class="fixed">
- [general]</span>, <span class="fixed">[shire]</span>, and
- <span class="fixed">[shar]</span>, define the operational parameters for the
- <span class="fixed">SHIRE</span> and <span class="fixed">SHAR</span>. While
- not precisely accurate, the <span class="fixed">[shire]</span> section is
- generally associated with the web server modules and libraries that
- applications interface with, while the <span class="fixed">[shar]</span>
- section is associated with the separate SHAR process. The
- <span class="fixed">[general]</span> section holds global settings, used by
- all components. The <span class="fixed">[shire]</span> and
- <span class="fixed">[shar]</span> sections can override the
- <span class="fixed">[general]</span> tags with SHIRE- or SHAR-specific
- configuration. For example, if the SHAR is looking for a tag, it will look
- first in the <span class="fixed">shar</span> section; if it does not find
- the tag there, it will proceed to look in the <span class="fixed">general</span>
- section.</p>
- <p>The following sections, <span class="fixed">[metadata_shire]</span>,
- <span class="fixed">[metadata_shar]</span>, and <span class="fixed">
- [policies]</span>, define the trust framework within which the entire system
- operates. Example configuration files are bundled with the Shibboleth
- distribution, currently derived from the InQueue staging federation managed
- by Internet2</p>
+ <p>The configuration for the target is mostly contained within <span class="fixed">shibboleth.xml</span>,
+ located by default at <span class="fixed">\opt\shibboleth\etc\shibboleth\shibboleth.xml</span>.
+ The target comes pre-configured with certificates and settings that will work against a test origin
+ running on the same server; however, there are several values that must later be changed to interoperate
+ with other sites securely and effectively.</p>
+ <p>The following is a hyperlinked version of a basic configuration file, followed by a list of elements
+ and attributes that must be modified. The actual example shipped with Shibboleth includes many more options
+ that are commented out and other elements necessary to support test functionality.
+ Click on any attribute or element for more information on its population and definition.</p>
+
+<pre>
+<a class="fixedlink" href="#confShibbolethTargetConfig"><ShibbolethTargetConfig xmlns="urn:mace:shibboleth:target:config:1.0"
+ logger="/opt/shibboleth/etc/shibboleth/shibboleth.logger" clockSkew="180"></a>
+
+ <a class="fixedlink" href="#confExtensions"><Extensions></a>
+ <a class="fixedlink" href="#confLibrary"><Library path="/opt/shibboleth/libexec/xmlproviders.so" fatal="true"/></a>
+ <a class="fixedlink" href="#confExtensions"></Extensions></a>
+
+ <a class="fixedlink" href="#confSHAR"><SHAR logger="/opt/shibboleth/etc/shibboleth/shar.logger"></a>
+
+ <a class="fixedlink" href="#confExtensions"><Extensions></a>
+ <a class="fixedlink" href="#confLibrary"><Library path="/opt/shibboleth/libexec/shib-mysql-ccache.so" fatal="false"/></a>
+ <a class="fixedlink" href="#confExtensions"></Extensions></a>
+
+ <a class="fixedlink" href="#confUnixListener"><UnixListener address="/tmp/shar-socket"/></a>
+
+ <!-- Primarily for Windows Deployments:
+ <a class="fixedlink" href="#confTCPListener"><TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/></a>
+ -->
+
+ <!--
+ <a class="fixedlink" href="#confMemorySessionCache"><MemorySessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
+ defaultLifetime="1800" retryInterval="300" strictValidity="true" propagateErrors="true"/></a>
+ -->
+
+ <a class="fixedlink" href="#confMySQLSessionCache"><MySQLSessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
+ defaultLifetime="1800" retryInterval="300" strictValidity="true" propagateErrors="true"
+ mysqlTimeout="14400"></a>
+ <a class="fixedlink" href="#confArgument"><Argument>--language=/opt/shibboleth/share/english</Argument></a>
+ <a class="fixedlink" href="#confArgument"><Argument>datadir=/opt/shibboleth/data</Argument></a>
+ </MySQLSessionCache>
+
+ <a class="fixedlink" href="#confSHAR"></SHAR></a>
+
+ <a class="fixedlink" href="#confSHIRE"><SHIRE logger="/opt/shibboleth/etc/shibboleth/shire.logger"></a>
+
+ <a class="fixedlink" href="#confRequestMapProvider"><RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap"></a>
+ <a class="fixedlink" href="#confRequestMap"><RequestMap applicationId="default"></a>
+ <a class="fixedlink" href="#confHost"><Host name="localhost" scheme="https"></a>
+ <a class="fixedlink" href="#confPath"><Path name="secure" requireSession="true" exportAssertion="true">
+ <!-- Example shows a subfolder on the SSL port assigned to a separate <Application> -->
+ <Path name="admin" applicationId="foo-admin"/>
+ </Path></a>
+ <a class="fixedlink" href="#confHost"></Host></a>
+ <a class="fixedlink" href="#confHost"><Host name="localhost" scheme="http"></a>
+ <a class="fixedlink" href="#confPath"><Path name="secure" requireSession="true" exportAssertion="true"/></a>
+ <a class="fixedlink" href="#confHost"></Host></a>
+ <a class="fixedlink" href="#confRequestMap"></RequestMap></a>
+ <a class="fixedlink" href="#confRequestMapProvider"></RequestMapProvider></a>
+
+ <!-- IIS only:
+ <a class="fixedlink" href="#confImplementation"><Implementation></a>
+ <a class="fixedlink" href="#confISAPI"><ISAPI normalizeRequest="true"></a>
+ <a class="fixedlink" href="#confSite"><Site id="1" scheme="https" host="localhost" port="443"/></a>
+ <a class="fixedlink" href="#confISAPI"></ISAPI></a>
+ <a class="fixedlink" href="#confImplementation"></Implementation></a>
+ -->
+ <a class="fixedlink" href="#confSHIRE"></SHIRE></a>
+
+ <a class="fixedlink" href="#confApplications"><Applications xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
+ applicationId="default" providerId="https://example.org/shibboleth/target"
+ signRequest="false" signedResponse="false" signedAssertions="false"></a>
+
+ <a class="fixedlink" href="#confSessions"><Sessions lifetime="7200" timeout="3600" checkAddress="true"
+ shireURL="/Shibboleth.shire" shireSSL="false" cookieName="_shibsession_default" cookieProps="; path=/"
+ wayfURL="https://wayf.internet2.edu/InQueue/WAYF"></a>
+
+ <a class="fixedlink" href="#confErrors"><Errors shire="/opt/shibboleth/etc/shibboleth/shireError.html"
+ rm="/opt/shibboleth/etc/shibboleth/rmError.html"
+ access="/opt/shibboleth/etc/shibboleth/accessError.html"
+ supportContact="root@localhost"
+ logoLocation="/shibtarget/logo.jpg"
+ styleSheet="/shibtarget/main.css"/></a>
+
+ <a class="fixedlink" href="#confCredentialUse"><CredentialUse TLS="defcreds" Signing="defcreds"></a>
+ <a class="fixedlink" href="#confRelyingParty"><RelyingParty Name="urn:mace:inqueue" TLS="inqueuecreds" Signing="inqueuecreds"/></a>
+ <a class="fixedlink" href="#confCredentialUse"></CredentialUse></a>
+
+ <!--
+ <a class="fixedlink" href="#confAttributeDesignator"><AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"
+ AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/></a>
+ -->
+
+ <a class="fixedlink" href="#confAAPProvider"><AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP"
+ uri="/opt/shibboleth/etc/shibboleth/AAP.xml"/></a>
+
+ <a class="fixedlink" href="#confFederationProvider"><FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata"
+ uri="/opt/shibboleth/etc/shibboleth/sites.xml"/></a>
+
+ <a class="fixedlink" href="#confTrustProvider"><TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust"
+ uri="/opt/shibboleth/etc/shibboleth/trust.xml"/></a>
+
+ <!--
+ <a class="fixedlink" href="#confRevocationProvider"><RevocationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation"
+ uri="/opt/shibboleth/etc/shibboleth/trust.xml"/></a>
+ -->
+
+ <a class="fixedlink" href="confAudience"><saml:Audience>urn:mace:inqueue</saml:Audience></a>
+
+ <!-- Override settings for this application.
+ <a class="fixedlink" href="confApplication"><Application id="foo-admin"></a>
+ <a class="fixedlink" href="#confSessions"><Sessions lifetime="7200" timeout="3600" checkAddress="true"
+ shireURL="/secure/admin/Shibboleth.shire" shireSSL="true" cookieProps="; path=/secure/admin; secure"
+ wayfURL="https://wayf.internet2.edu/InQueue/WAYF"/></a>
+ <a class="fixedlink" href="#confAttributeDesignator"><saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonPrincipalName"
+ AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/></a>
+ <a class="fixedlink" href="confApplication"></Application></a>
+ -->
+
+ <a class="fixedlink" href="#confApplications"></Applications></a>
+
+ <a class="fixedlink" href="#confCredentialsProvider"><CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials"></a>
+ <a class="fixedlink" href="#confCredentials"><Credentials xmlns="urn:mace:shibboleth:credentials:1.0"></a>
+ <a class="fixedlink" href="#confFileResolver"><FileResolver Id="defcreds"></a>
+ <a class="fixedlink" href="#confKey"><Key format="PEM" password="secret"></a>
+ <a class="fixedlink" href="#confCredPath"><Path>/opt/shibboleth/etc/shibboleth/shar.key</Path></a>
+ <a class="fixedlink" href="#confKey"></Key></a>
+ <a class="fixedlink" href="#confCertificate"><Certificate format="PEM"></a>
+ <a class="fixedlink" href="#confCredPath"><Path>/opt/shibboleth/etc/shibboleth/shar.crt</Path></a>
+ <a class="fixedlink" href="#confCAPath"><CAPath>/opt/shibboleth/etc/shibboleth/ca.crt</CAPath></a>
+ <a class="fixedlink" href="#confCertificate"></Certificate></a>
+ <a class="fixedlink" href="#confFileResolver"></FileResolver></a>
+ <a class="fixedlink" href="#confCredentials"></Credentials></a>
+ <a class="fixedlink" href="#confCredentialsProvider"></CredentialsProvider></a>
+
+<a class="fixedlink" href="#confShibbolethTargetConfig"></ShibbolethTargetConfig></a>
+</pre>
+
+<p>The following changes must be made to the default configuration before the target will interoperate in a federation.</p>
+ <ol type="1">
+ <li>
+ <p>The main <a href="#confApplications"><span class="fixed">Applications</span></a> element's
+ <span class="fixed">providerId</span> attribute must be changed to reflect the URI this target will
+ use to identify itself to origins by default. This will often be approved or supplied by a federation.</p>
+ </li>
+ <li>
+ <p>The <span class="fixed">supportContact</span> and error templates for the target found in the
+ <a href="#confErrors"><span class="fixed">Errors</span></a> element should be changed to ensure that
+ users have a proper support mechanism.</p>
+ </li>
+ <li>
+ <p>Proper credentials for this target signed by an authority that the federation recognizes must be
+ referenced by the <a href="#confCredentials"><span class="fixed">Credentials</span></a> element.
+ The default configuration points at files containing widely-available, insecure keys and certificates.
+ Note that keys are supported in a variety of formats: DER, PEM, encrypted PEM, PKCS8, and encrypted PKCS8.</p>
+ </li>
+ <li>
+ <p><a href="#confFederationProvider"><span class="fixed">FederationProvider</span></a> and
+ <a href="#confTrustProvider"><span class="fixed">TrustProvider</span></a> elements must be added or
+ changed as needed to reflect the arrangements required. This information is often provided by
+ federations to their members.</p>
+ </li>
+ </ol>
+
<p>For Apache (but not IIS), there is also information that must be
configured in <span class="fixed">/usr/local/apache/conf/httpd.conf</span>
(or equivalent); for more information, refer to <a href="#3.c.2.">3.c</a>.</p>
<p>Information in the logging configuration files referenced by
- <span class="fixed">shibboleth.ini</span> may require additional changes to
+ <span class="fixed">shibboleth.xml</span> may require additional changes to
meet local needs. The logging level can be raised to <span class="fixed">
- INFO</span> or <span class="fixed">DEBUG</span> if additional detail is
- needed for testing. It is recommended that after initial installation is
+ DEBUG</span> if extremely detailed information is needed for testing.
+ It is recommended that after initial installation is
completed, the log level in both files be left at either <span class="fixed">
INFO</span> or <span class="fixed">WARN</span>.</p>
- <p>Fields that are purple are optional; grey fields are mandatory. If the
- option only applies to a specific environment, such as IIS/ISAPI only, then
- this is indicated.</p>
- <p><span class="fixed">[general]</span>:</p>
+ <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>
<dl>
- <dd class="attribute"><span class="fixed">logger = <pathname></span></dd>
- <dd class="value">Specifies the location of the <span class="fixed">
- log4cpp</span> configuration file for most Shibboleth events. This
- element may also be optionally specified for each of the components
- individually (which is the default provided, so this setting is often
- unused). Default logging settings (using local log files) should
- suffice. If using a remote syslogd instead, the <span class="fixed">
- syslog</span> daemon must accept <span class="fixed">UDP:514</span>
- messages, and on Linux, <span class="fixed">SYSLOGD_OPTIONS</span> must
- include <span class="fixed">-r</span> to enable logging from remote
- machines. The logging level is also defined in the logger configuration
- file. The configuration format and log levels are similar to that of the
- <a href="http://jakarta.apache.org/log4j/docs/documentation.html">Log4j</a>
- package's property format.</dd>
- <dd class="attribute"><span class="fixed">schemadir = <pathname></span></dd>
- <dd class="value">Specifies the directory in which the XML schema files
- are located; defaults to <span class="fixed">
- /opt/shibboleth/etc/shibboleth/</span>. This should generally be left
- alone, unless a non-default installation path is used.</dd>
- <dd class="attribute"><span class="fixed">sharsocket = <pathname> | [IP
- interface:]port</span></dd>
- <dd class="value">Specifies the location of the socket the SHAR uses to
- form connections. Note that if you change this, the SHAR and Apache
- should both be restarted immediately, since new Apache child processes
- will use the changed value as soon as they start up.
- <p>On Unix, this is usually set to a domain socket path, often something
- in <span class="fixed">/tmp</span>. On Windows, this must be either a
- TCP port number, or a combination of an IP address and port, with a
- colon in between. Using an address specifies an IP interface to bind to
- on multi-homed servers. Using just a port number generally suffices. If
- this syntax is used on Unix, then the process will use a TCP socket
- instead of a domain socket. </p>
- <p><b>Security Note:</b> Using TCP, which is mandatory on Windows, can
- be insecure if used in certain non-default configurations. If you allow
- access to the service from other hosts, be sure a firewall is in place
- to prevent unauthorized access. The <span class="fixed">sharacl</span>
- setting, described later, provides some minimal filtering, but TCP is
- still an insecure protocol.</dd>
- </dl>
- <p>The rest of the <span class="fixed">[general]</span> configuration
- section defines global settings that can be overridden by server-specific
- tags in sections defined by the server name. This is especially applicable
- for non-Apache configurations. For example, if you have a web server named
- www.example.edu, you can define a section <span class="fixed">[www.example.edu]</span>
- and override global tags with tags for that server only.</p>
- <p>The following table lists the server-specific tags. It is broken into
- mandatory tags, and optional tags. Tags in the <span class="fixed">[general]</span>
- section correspond to all servers; to override specific tags on a per-server
- basis, use <span class="fixed">[<FQDN>]</span> as the header for a section (FQDN
- means fully-qualified domain name, and corresponds to the name you assign to
- a virtual host using the Apache ServerName directive, or that you map IIS
- instance IDs to using the <span class="fixed">[isapi]</span> section.</p>
- <p><span class="fixed">[<general>]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed">wayfURL = <absolute url></span></dd>
- <dd class="value">Specifies the URL of the WAYF service the user is
- redirected to. Federations will often provide this URL in order to
- control the way in which sites are presented to users, but a target may
- provide this function, or it may be set directly to a specific site's
- Handle Service, effectively rendering the system internal to a single
- origin site.</dd>
- <dd class="attribute"><span class="fixed">shireURL = <absolute or
- relative url></span> ISAPI</dd>
- <dd class="value">Specifies the URL of the SHIRE POST URL, or assertion
- consumer service, at which new sessions are initiated. This can be an
- absolute URL, or a relative path to be prefixed by the base URL of the
- web site. Using an absolute URL allows a virtual server to funnel SHIRE
- requests to a fixed location, such as in the case where a non-SSL site
- wants to handle SHIRE requests over SSL (on a different port).
- <p>Note that this URL will result in a cookie being set, and this cookie
- must be returned in subsequent requests, so the virtual server's domain
- name and port must be consistent with the SHIRE's domain name and port
- for some browsers to properly return the cookie. If default ports are
- used (and thus left unspecified), browsers will generally return cookies
- set via SSL to a non-SSL server. If non-default ports are used, it is
- recommended that this be a relative URL so that each virtual host
- handles its own cookie operations.</p>
- <p>For Shibboleth to function in IIS, the file extension at the end of
- this URL must match the value configured into IIS and mapped to the
- ISAPI extension. This causes the request to be serviced properly, even
- though no file by that name actually exists.</dd>
- <dd class="attribute"><span class="fixed">cookieName = <string></span></dd>
- <dd class="value">Defines the name to be assigned to in-memory session
- cookies.</dd>
- <dd class="attribute"><span class="fixed">shireError = <pathname></span></dd>
- <dd class="value">Specifies the location of the template for the error
- page generated when there is an error re-directing the user to the WAYF
- or processing a new session sign-on.</dd>
- <dd class="attribute"><span class="fixed">rmError = <pathname></span></dd>
- <dd class="value">Specifies the location of the template for the error
- page generated if internal errors occur in the RM.</dd>
- <dd class="attribute"><span class="fixed">accessError = <pathname></span></dd>
- <dd class="value">Specifies the location of the template for the page
- displayed to users when access to a protected resource is denied by the
- RM. This is distinct from when errors occur during the evaluation
- process itself, and indicates a denial of authorization.</dd>
- <dd class="attributeopt"><span class="fixed">normalizeRequest = <true|false></span></dd>
- <dd class="valueopt">If true, all redirects and computed request URLs
- generated by Shibboleth will be created using the virtual server name
- assigned to the server. If <span class="fixed">false</span>, the
- browser's supplied URL is sometimes used to compute the information.
- This sometimes has no effect, depending on the capabilities of the web
- server, since the correct behavior is almost always to rely on the
- server's API to report the hostname and ignore the browser.</dd>
- <dd class="attributeopt"><span class="fixed">checkIPAddress = <true|false></span></dd>
- <dd class="valueopt">If <span class="fixed">true</span>, Shibboleth will
- check client addresses for impersonation protection. In most
- circumstances, this should be enabled to prevent certain attacks
- concerning stolen cookies, but this can cause problems for users behind
- proxies or NAT devices. Defaults to <span class="fixed">false</span>.</dd>
- <dd class="attributeopt"><span class="fixed">shireSSLOnly = <true/false></span></dd>
- <dd class="valueopt">If <span class="fixed">true</span>, the SHIRE will
- reject HTTP connections for new session sign-on that are not SSL-protected.
- This guards the initial session sign-on from the browser, but does not
- preclude non-SSL content. Use of SSL is strongly recommended; see
- section <a href="#2.c.">2.c</a> for more information.</dd>
- <dd class="attributeopt"><span class="fixed">mustContain =
- <string1>;<string2></span> ISAPI</dd>
- <dd class="valueopt">Controls what content in IIS to protect with
- Shibboleth. Multiple values should be separated with a semicolon. Each
- string is matched directly against the requested URL, and if the URL
- contains the string, a match is made and Shibboleth applies. No regular
- expressions are supported, only literal matches. Slashes are matched
- like other characters, so path components can be surrounded with slashes
- to match any requests with a particular component in the path. Defaults
- to protecting everything on a server or site.</dd>
- <dd class="attributeopt"><span class="fixed">contentSSLOnly = <true|false></span>
- ISAPI</dd>
- <dd class="valueopt">If <span class="fixed">true</span>, Shibboleth will
- insist that any request for protected content is over an SSL connection.
- Defaults to <span class="fixed">false</span>.</dd>
- <dd class="attributeopt"><span class="fixed">authLifetime = <seconds></span>
- ISAPI</dd>
- <dd class="valueopt">If set, sessions are always terminated after the
- specified number of seconds, resulting in a new redirect and request for
- authentication, just as if a new request without a session is received.
- Defaults to infinite.</dd>
- <dd class="attributeopt"><span class="fixed">authTimeout = <seconds></span>
- ISAPI</dd>
- <dd class="valueopt">If set, sessions are always terminated after the
- specified number of seconds of inactivity (defined as no requests
- received in that session), resulting in a new redirect and request for
- authentication, just as if a new request without a session is received.
- Defaults to infinite.</dd>
- <dd class="attributeopt"><span class="fixed">requestAttributes = <attr1>
- <attr2> <attr3>...</span> </dd>
- <dd class="valueopt">Specifies a space-delimited list of attributes
- (named by a designated URI) that the SHAR will request when querying for
- attributes. By default, the SHAR will ask for and receive all attributes
- the AA is willing to release to it.</dd>
- <dd class="attributeopt"><span class="fixed">exportAssertion = <true|false></span>
- ISAPI</dd>
- <dd class="valueopt">If set, the SAML attribute assertion received by
- the SHAR is exported to a CGI request header called Shib-Attributes,
- encoded in base64. Defaults to <span class="fixed">false</span>. While
- this does require parsing the raw XML, it also permits an application to
- see attributes that may have been filtered by an AAP, or to forward the
- SAML assertion to a third party.</dd>
- <dd class="attributeopt"><span class="fixed">supportContact = <e-mail></span></dd>
- <dd class="valueopt">Specifies the local site's support e-mail address,
- and is used in the generation of error pages.</dd>
- <dd class="attributeopt"><span class="fixed">logoLocation = <pathname></span></dd>
- <dd class="valueopt">Specifies the location of the logo used in the
- generation of error pages. This logo can be in any format that the web
- browser will understand, and should be a URL (absolute or relative) that
- will return a valid logo.</dd>
- </dl>
- <p><span class="fixed">[shire]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed">metadata = <section tag></span></dd>
- <dd class="value">Specifies the tag that defines the section of
- <span class="fixed">shibboleth.ini</span> the SHIRE should use to
- acquire its metadata. The SHIRE does not need trust metadata, and so
- generally it will only need site metadata and attribute acceptance
- policy to define attributes and enforce policies like scope
- limitations(e.g. MIT not asserting attributes @brown.edu.)</dd>
- <dd class="attributeopt"><span class="fixed">logger = <pathname></span></dd>
- <dd class="valueopt">Specifies the location of the <span class="fixed">
- log4cpp</span> configuration file for Shibboleth events produced by the
- web server modules and libraries. Refer to the global setting for more
- information.</dd>
- <dd class="attributeopt"><span class="fixed">aap-uri = <uri></span>
- DEPRECATED</dd>
- <dd class="valueopt">Specifies the URI of an attribute acceptance policy
- XML file. This command has been replaced with a new metadata provider
- type for attribute policy that should be provided to both the SHIRE and
- SHAR components. To replace this command, add lines to both metadata
- sections of this form:
- <blockquote class="fixed">
- <p>edu.internet2.middleware.shibboleth.target.AAP.XML=<uri></p>
- </blockquote>
- <p>For more information, refer to section <a href="#4.e.">4.e</a>. This
- command will be removed in future releases.</dd>
- </dl>
- <p><span class="fixed">[shar]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed">metadata = <tag></span></dd>
- <dd class="value">Specifies the tag that defines the section of
- <span class="fixed">shibboleth.ini</span> the SHAR should use to acquire
- its site, trust, and attribute metadata.</dd>
- <dd class="attribute"><span class="fixed">cacheType = <method></span></dd>
- <dd class="value">Specifies the method used by the SHAR to cache
- sessions and attributes. The default is <span class="fixed">memory</span>,
- which indicates that the SHAR should store received attributes in
- memory. Another option is <span class="fixed">mysql</span>, which will
- use the MySQL Credential Cache, if it is available.</dd>
- <dd class="attribute"><span class="fixed">cacheClean = <seconds></span></dd>
- <dd class="value">Specifies the duration in seconds between cleanups of
- the SHAR's cached but expired sessions and attributes. Defaults to
- <span class="fixed">300</span>, or 5 minutes.</dd>
- <dd class="attribute"><span class="fixed">cacheTimeout = <seconds></span></dd>
- <dd class="value">Specifies the duration in <span class="fixed">seconds</span>
- that must elapse between user accesses before that user's session is
- destroyed, including the associated handle and all cached attributes.
- Defaults to <span class="fixed">28800</span> seconds, or 8 hours. This
- should generally be longer than the associated server's settings for
- session lifetime and timeout.</dd>
- <dd class="attributeopt"><span class="fixed">logger = <pathname></span></dd>
- <dd class="valueopt">Specifies the location of the <span class="fixed">
- log4cpp</span> configuration file for Shibboleth events produced by the
- SHAR service. Refer to the global setting for more information.</dd>
- <dd class="attributeopt"><span class="fixed">sharacl = <IP Address></span></dd>
- <dd class="valueopt">Specifies one or more space-delimited IP addresses
- from which a TCP-based SHAR service will accept connections. Defaults to
- 127.0.0.1 (localhost). Should only be changed if proper precautions have
- been taken to protect connections from off-host.</dd>
- <dd class="attributeopt"><span class="fixed">certFile = <pathname></span>
+ <dd class="attribute"><a name="confAAPProvider"><span class="fixed"><AAPProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP"</span> uri="<i>pathname</i>"/></span></dd>
+ <dd class="value">
+ <p>This element is used to specify individual attribute acceptance policies that will apply to an application
+ and may appear zero or more times within the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ or <a href="#confApplication"><span class="fixed">Application</span></a> element. For information about these
+ policies and their format, refer to <a href="#4.e.">section 4.e</a>.</p>
+ <p>The default set of AAP providers in the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ element can be replaced within individual <a href="#confApplication"><span class="fixed">Application</span></a> elements.</p>
</dd>
- <dd class="valueopt">Specifies the location of the PEM-format
- certificate used by the SHAR to communicate in authenticated fashion
- with origin site Attribute Authorities.</dd>
- <dd class="attributeopt"><span class="fixed">keyFile = <pathname></span>
+
+ <dd class="attribute"><a name="confApplication"><span class="fixed"><Application <span class="mandatory">id="<i>identifier</i>"</span> providerId="<i>identifier</i>" signRequest="<i>true/false</i>" signedResponse="<i>true/false</i>" signedAssertions="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>Individual applications that require different attributes, session settings, metadata, etc. can be differentiated
+ from the default configuration as specified in the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ element. It must contain a <a href="#confSessions"><span class="fixed">Sessions</span></a> element, but overriding other
+ elements is optional.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">id</span>: This attribute defines an internal identifier allowing
+ individual <span class="fixed">applicationId</span> attributes as part of
+ <a href="#confHost"><span class="fixed">Host</span></a> and <a href="#confPath"><span class="fixed">Path</span></a>
+ elements to point to this <span class="fixed">Application</span> to handle requests.</li>
+ <li><span class="fixed">providerId</span>: Distinct from the internal identifier, this is the unique identifier
+ that will be used when communicating with origin sites to request authentication or attributes.
+ This value is referenced by origins when creating rules for the release of attributes to targets and will
+ often be provided to federations to facilitate origin configuration. If none is specified, the default
+ <a href="#confApplications><span class="fixed">Applications</span></a> element's
+ <span class="fixed">providerId</span> applies.</li>
+ <li><span class="fixed">signRequest</span>: If <span class="fixed">true</span>, the target will sign attribute
+ requests that it sends to origins on behalf of this application. This is usually unnecessary, as the
+ TLS/SSL transport can provide authentication more efficiently.</li>
+ <li><span class="fixed">signedResponse</span>: If <span class="fixed">true</span>, the target will require that
+ all SAML attribute responses it receives for this application be signed.</li>
+ <li><span class="fixed">signedAssertions</span>: If <span class="fixed">true</span>, the target will require that
+ individual SAML assertions it receives for this application be signed. This may be particularly useful if the
+ application is forwarding the assertion, but requires a liberal (or no) AAP to avoid corrupting the signature.</li>
+ </ul>
</dd>
- <dd class="valueopt">Specifies the location of the PEM-format private
- key used by the SHAR to communicate in authenticated fashion with origin
- site Attribute Authorities.</dd>
- <dd class="attributeopt"><span class="fixed">keyPass = <password></span>
+
+ <dd class="attribute"><a name="confApplications"><span class="fixed"><Applications <span class="mandatory">id="<i>default</i>" providerId="<i>identifier</i>"</span> signRequest="<i>true/false</i>" signedResponse="<i>true/false</i>" signedAssertions="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>The <span class="fixed">Applications</span> element must appear once and contains default settings for requests
+ handled by the target. It must contain at least one each of the <a href="#confSessions"><span class="fixed">Sessions</span></a>,
+ and <a href="#confErrors"><span class="fixed">Errors</span></a> elements, and may contain
+ <a href="#confCredentialUse"><span class="fixed">CredentialUse</span></a>,
+ <a href="#confAttributeDesignator"><span class="fixed">saml:AttributeDesignator</span></a>,
+ <a href="#confAudience"><span class="fixed">saml:Audience</span></a>,
+ <a href="#confFederationProvider"><span class="fixed">FederationProvider</span></a>,
+ <a href="#confTrustProvider"><span class="fixed">TrustProvider</span></a>,
+ <a href="#confRevocationProvider"><span class="fixed">RevocationProvider</span></a>,
+ and <a href="#confApplication"><span class="fixed">Application</span></a> elements.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">id</span>: This attribute has a fixed value of "default" and should not be changed.</li>
+ <li class="mandatory"><span class="fixed">providerId</span>: Distinct from the internal identifier, the
+ <span class="fixed">providerId</span> is the unique identifier that will be used when communicating
+ with origin sites to request authentication or attributes. This value is referenced by origins when
+ creating rules for the release of attributes to targets and will often be provided to federations to
+ facilitate origin configuration.</li>
+ <li><span class="fixed">signRequest</span>: If <span class="fixed">true</span>, the target will sign attribute
+ requests that it sends to origins by default. This is usually unnecessary, as the TLS/SSL transport can provide
+ authentication more efficiently.</li>
+ <li><span class="fixed">signedResponse</span>: If <span class="fixed">true</span>, the target will require that
+ all SAML attribute responses it receives are signed by default.</li>
+ <li><span class="fixed">signedAssertions</span>: If <span class="fixed">true</span>, the target will require that
+ individual SAML assertions it receives are signed by default. This may be particularly useful if the
+ application is forwarding the assertion, but requires a liberal (or no) AAP to avoid corrupting the signature.</li>
+ </ul>
+ <p>Default settings can be overridden by using the <a href="#confRequestMap"><span class="fixed">RequestMap</span></a> to
+ assign a non-default <span class="fixed">applicationId</span> to particular content in
+ <a href="#confHost"><span class="fixed">Host</span></a> and <a href="#confPath"><span class="fixed">Path</span></a>
+ elements. An <a href="#confApplication"><span class="fixed">Application</span></a> element is then inserted containing
+ a matching <span class="fixed">id</span> attribute, and finally specific elements that override the defaults are
+ placed within it. A fully specified <a href="#confSessions"><span class="fixed">Sessions</span></a> element is
+ always required for any new application created, because each application needs a distinct
+ <span class="fixed">shireURL</span> so that new sessions can be unambiguously mapped to a particular application.</p>
</dd>
- <dd class="valueopt">Specifies the <span class="fixed">password</span>
- used to access the <span class="fixed">keyFile</span>, if any.</dd>
- <dd class="attributeopt"><span class="fixed">calist = <pathname></span>
+
+ <dd class="attribute"><a name="confArgument"><span class="fixed"><Argument><i>value</i></Argument></span></dd>
+ <dd class="value">
+ <p>The <span class="fixed">Argument</span> element is used in the
+ <a href="#confMySQLSessionCache"><span class="fixed">MySQLSessionCache</span></a> element to specify one or more
+ arguments to pass to the MySQL database engine.</p>
</dd>
- <dd class="valueopt">Specifies a single file of PEM-format certificates
- containing the root CAs the SHAR will consider to be valid signers of AA
- server certificates. Currently applies globally to all communication
- with AAs.</dd>
- <dd class="attributeopt"><span class="fixed">AATimeout = <seconds></span>
+
+ <dd class="attribute"><a name="confAttributeDesignator"><span class="fixed"><saml:AttributeDesignator <span class="mandatory">AttributeName="<i>name</i>" AttributeNamespace="<i>namespace</i>"</span>></span></dd>
+ <dd class="value">
+ <p>The <span class="fixed">AttributeDesignator</span> element is used in the
+ <a href="#confApplications"><span class="fixed">Applications</span></a> and
+ <a href="#confApplication"><span class="fixed">Application</span></a> elements to name an attribute to specifically
+ request from origins on behalf of an application. If none are specified, the application will be given anything
+ the origin allows it to receive.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">AttributeName</span>: Specifies the name of a SAML attribute, generally a URI.</li>
+ <li class="mandatory"><span class="fixed">AttributeNamespace</span>: Specifies the attribute's SAML namespace,
+ which Shibboleth by convention sets to "urn:mace:shibboleth:1.0:attributeNamespace:uri".</li>
+ </ul>
+ <p>The default set of designators can be overridden within individual
+ <a href="#confApplication"><span class="fixed">Application</span></a> elements, but if default elements are specified,
+ it isn't possible to "remove" them and revert to none within a particular application.</p>
</dd>
- <dd class="valueopt">Specifies the number of seconds that the SHAR will
- wait for attributes to be sent from an AA. Defaults to
- <span class="fixed">60</span>.</dd>
- <dd class="attributeopt"><span class="fixed">AAConnectTimeout =
- <seconds></span> </dd>
- <dd class="valueopt">Specifies the number of seconds that the SHAR will
- wait for a connection to be established with an AA. Defaults to
- <span class="fixed">30</span>.</dd>
- </dl>
- <p><span class="fixed">[metadata]</span> sections must be created and named
- in accordance with the value of the <span class="fixed">metadata</span>
- parameter in the <span class="fixed">[shire]</span> and <span class="fixed">
- [shar]</span> sections. Metadata sections may be shared or defined for each
- component. Three XML-based providers are supported by Shibboleth, but future
- providers may be specified with name/value pairs consisting of
- <span class="fixed"><metadata provider type>=<source></span>.</p>
- <p>Note that any number of files of the three types may be loaded into the
- system, which supports aggregating policy from across federations.</p>
- <p>Shibboleth provides a simple utility called <span class="fixed">
- siterefresh</span> for updating metadata files from a central location and
- verifying a digital signature over them, as described in section
- <a href="#4.g.">4.g</a>.</p>
- <p><span class="fixed">[<metadata>]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed">
- edu.internet2.middleware.shibboleth.metadata.XML = <pathname></span></dd>
- <dd class="value">Specifies the location of the file to load site
- metadata from. This information controls what origin sites are trusted
- by the target and provides contact information. This should be a file
- stored locally, and may be used by both the SHIRE and SHAR.</dd>
- <dd class="attribute"><span class="fixed">
- edu.internet2.middleware.shibboleth.trust.XML = <pathname></span></dd>
- <dd class="value">Specifies the location of the trust database of
- certificates and/or CA roots used by the SHAR during session initiation
- (but currently is not used during attribute exchange). The SHIRE
- component generally does not need trust data.</dd>
- <dd class="attribute"><span class="fixed">
- edu.internet2.middleware.shibboleth.target.AAP.XML = <pathname></span></dd>
- <dd class="value">Specifies the location of the Attribute Acceptance
- Policy file that defines what attributes will be visible to
- applications, how to filter their values based on the source, and how to
- make them available to applications and the RM. See <a href="#4.e.">
- section 4.e.</a> for detailed information on this file.<p><b>This
- provider has been added as of version 1.1, and supersedes the old
- <span class="fixed">aap-uri</span> and <span class="fixed">attributes</span>
- settings, as well as the Apache <span class="fixed">ShibMapAttribute</span>
- command.</b></dd>
- </dl>
- <p>The <span class="fixed">[extensions:saml]</span> section specifies a set
- of extension libraries to load that add additional functionality to the
- system. Examples include session cache implementations, such as the MySQL
- cache, or advanced metadata providers.</p>
- <p><span class="fixed">[extensions:saml]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed"><name> = <library pathname></span>
+
+ <dd class="attribute"><a name="confAudience"><span class="fixed"><saml:Audience><i>value</i></saml:Audience></span></dd>
+ <dd class="value">
+ <p>The <span class="fixed">Audience</span> element is used in the
+ <a href="#confApplications"><span class="fixed">Applications</span></a> and
+ <a href="#confApplication"><span class="fixed">Application</span></a> elements element to specify one or more
+ SAML audience URIs to designate while processing assertions. Audience values are used by origins to constrain the
+ parties they issue assertions for. A target application always includes its own <span class="fixed">providerId</span>
+ as an audience value.</p>
+ <p>Within an <a href="#confApplication"><span class="fixed">Application</span></a> element, this setting is not
+ inherited from the <a href="#confApplications"><span class="fixed">Applications</span></a> element. Any values
+ desired must be specified. In most cases, this element can be omitted.</p>
</dd>
- <dd class="value">The name of the extension is simply a unique key and
- is not important. The path to the library to load must be absolute and
- complete.</dd>
- </dl>
- <p>The <span class="fixed">[policies]</span> section contains the policy URI
- values that control acceptance of assertions from origin sites. This may
- eventually have multiple elements associated it for targets that are members
- of multiple federations.</p>
- <p><span class="fixed">[policies]</span>:</p>
- <dl>
- <dd class="attribute"><span class="fixed"><federation> = <URI></span>
+
+ <dd class="attribute"><a name="confCAPath"><span class="fixed"><CAPath><i>pathname</i></CAPath></span></dd>
+ <dd class="value">
+ <p>Paired with a <a href="#confCredPath"><span class="fixed">Path</span></a> element within a
+ <a href="#confFileResolver"><span class="fixed">FileResolver</span></a> element, it allows for the specification
+ of additional certificates in a chain up to a trust anchor. As many <span class="fixed">CAPath</span> elements as
+ necessary to complete the chain may be specified. May be needed if the relying party does not possess the entire CA
+ chain already.</p>
</dd>
- <dd class="value">The name of the <span class="fixed">federation</span>
- and its associated policy <span class="fixed">URI</span>. This
- information should be provided by federations and is designed to support
- future work in federation deployment. For the time being, it simply
- insures that deployments not meant to interoperate will not do so.<p>
- This set of URI values is matched against the SAML <span class="fixed">
- Audience</span> fields of assertions received from HS's and AA's. One of
- the URI's specified by the origin in the <span class="fixed">
- edu.internet2.middleware.shibboleth.audiences</span> property must match
- one of these URIs or the assertion will not be accepted by design.</dd>
- </dl>
-</blockquote>
+
+ <dd class="attribute"><a name="confCertificate"><span class="fixed"><Certificate format="<i>type</i>"></span></dd>
+ <dd class="value">
+ <p>This specifies the certificate corresponding to this set of credentials. The certificate itself must be specified
+ by a <a href="#confCredPath"><span class="fixed">Path</span></a> element contained by this element. If the certificate
+ isn't self-signed or signed by an authority familiar to the relying party, the files of certificates in the path to
+ the root authority may be specified using one or more <a href="#confCAPath"><span class="fixed">CAPath</span></a> elements.
+ Valid formats are <span class="fixed">PEM</span>, <span class="fixed">DER</span>, and <span class="fixed">PKCS12</span>.</p>
+ <p>It's placed within the <a href="#confFileResolver"><span class="fixed">FileResolver</span></a> element and must be
+ paired with the corresponding private key using the <a href="#confKey"><span class="fixed">Key</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confCredentials"><span class="fixed"><Credentials xmlns="urn:mace:shibboleth:credentials:1.0"></span></dd>
+ <dd class="value">
+ <p>This element is the container for credentials used by the XML-based credentials provider with type
+ "edu.internet2.middleware.shibboleth.common.Credentials". These credentials are used by the target to
+ authenticate itself in SSL sessions or sign attribute requests, depending on application configuration. It must contain
+ one or more <a href="#confFileResolver"><span class="fixed">FileResolver</span></a> elements.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confCredentialsProvider"><span class="fixed"><CredentialsProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.common.Credentials"</span>></span></dd>
+ <dd class="value">
+ <p>This element is the container for providers of credentials used by the target and is placed inside the
+ <a href="#confShibbolethTargetConfig"><span class="fixed">ShibbolethTargetConfig</span></a> element. The supplied
+ provider of type "edu.internet2.middleware.shibboleth.common.Credentials" must contain one
+ <a href="#confCredentials"><span class="fixed">Credentials</span></a> element detailing the credentials
+ to be used by the target. Other provider types might require different content.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confCredentialUse"><span class="fixed"><CredentialUse <span class="mandatory">TLS="<i>string</i>" Signing="<i>string</i>"</span>></span></dd>
+ <dd class="value">
+ <p>Used in the <a href="#confApplications"><span class="fixed">Applications</span></a> or
+ <a href="#confApplication"><span class="fixed">Application</span></a> elements to specify the credentials used by
+ applications for signing and TLS/SSL. The <span class="fixed">TLS</span> and <span class="fixed">Signing</span>
+ attribute values reference the identifiers of credential resolvers defined in the
+ <a href="#confCredentialsProvider"><span class="fixed">CredentialsProvider</span></a> element. May also contain
+ <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> elements that specify the credentials
+ to use for specific origins or federations.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confErrors"><span class="fixed"><Errors <span class="mandatory">shire="<i>pathname</i>" rm="<i>pathname</i>" access="<i>pathname</i>"</span> supportContact="<i>e-mail</i>" logoLocation="<i>URL</i>"/></span></dd>
+ <dd class="value">
+ <p>Shibboleth is capable of displaying customized error pages based on templates and information provided by
+ additional attributes in this element. These should all be customized to fit the requirements of the target application.
+ For more information on configuration of error page generation, please see <a href="#4.b.">section 4.b</a>.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">shire</span>: Specifies the location of the template for the error page
+ generated when there is an error re-directing the user to the WAYF or processing a new session sign-on.</li>
+ <li class="mandatory"><span class="fixed">rm</span>: Specifies the location of the template for the error page
+ generated if internal errors occur when supplying attributes to the application.</li>
+ <li class="mandatory"><span class="fixed">accessError</span>: Specifies the location of the template for the page
+ displayed to users when access to a protected resource is denied based on access control. This is distinct
+ from when errors occur during the evaluation process itself, and indicates a denial of authorization.</li>
+ <li><span class="fixed">supportContact</span>: Specifies a support e-mail address for the user to contact.</li>
+ <li><span class="fixed">logoLocation</span>: Specifies the location of the logo used in the generation of error pages.
+ This logo can be in any format that the web browser will understand, and should be a URL (absolute or relative) that
+ will return a valid logo.</li>
+ </ul>
+ <p>The last two attributes are examples of tags that can be inserted at runtime into the templates. Arbitrary
+ attributes may be specified in this element simply by adding them; no additional configuration is necessary.
+ If there is a matching ShibMLP tag in the error page template as designed in <a href="#4.b.">4.b</a>, Shibboleth
+ will insert the value of that attribute.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confExtensions"><span class="fixed"><Extensions></span></dd>
+ <dd class="value">
+ Extension libraries for one of the Shibboleth components or the entire target can be specified using this element
+ depending on where it's present. It may be contained by any of the
+ <a href="#confSHAR"><span class="fixed">SHAR</span></a>, <a href="#confSHIRE"><span class="fixed">SHIRE</span></a>,
+ or <a href="#confShibbolethTargetConfig"><span class="fixed">ShibbolethTargetConfig</span></a> elements.
+ It must contain one or more <a href="#confLibrary"><span class="fixed">Library</span></a> elements.
+ </dd>
+
+ <dd class="attribute"><a name="confFederationProvider"><span class="fixed"><FederationProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata"</span> uri="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This element, when specified within an <a href="#confApplications"><span class="fixed">Applications</span></a>
+ or <a href="#confApplication"><span class="fixed">Application</span></a> element, points to operational metadata either
+ inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download
+ periodically. This should be refreshed regularly; see <a href="#4.g.">section 4.g</a> for further details.</p>
+ <p>The default set of federation providers in the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ element can be replaced within individual <a href="#confApplication"><span class="fixed">Application</span></a> elements.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confFileResolver"><span class="fixed"><FileResolver <span class="mandatory">Id="<i>string</i>"</span>></span></dd>
+ <dd class="value">
+ <p>This element defines files used to store a private key, certificate, and certificate authorities and associates
+ the set with an identifier. Placed inside the <a href="#confCredentials"><span class="fixed">Credentials</span></a>
+ element. <a href="#confCredentialUse"><span class="fixed">CredentialUse</span></a> and
+ <a href="#confRelyingParty"><span class="fixed">RelyingParty</span></a> elements will refer to these identifiers in
+ their <span class="fixed">TLS</span> and <span class="fixed">Signing</span> attributes, allowing different credentials
+ to be used for different applications and relying parties.</p>
+ <p>Must contain one <a href="#confKey"><span class="fixed">Key</span></a> element and should contain one
+ <a href="#confCertificate"><span class="fixed">Certificate</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confHost"><span class="fixed"><Host scheme="<i>protocol</i>" <span class="mandatory">name="<i>fqdn</i>"</span> port="<i>integer</i>" applicationId="<i>id</i>" requireSession="<i>true/false</i>" exportAssertion="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>Individual (real or virtual) hosts that this target protects are enumerated by <span class="fixed">Host</span> elements
+ inside the <a href="#confRequestMap"><span class="fixed">RequestMap</span></a> element. If a request is processed by
+ Shibboleth for a URL on this host, these parameters will be applied to it. If there are
+ <a href="#confPath"><span class="fixed">Path</span></a> elements within this element that match the URL and contain
+ the <span class="fixed">applicationId</span>, <span class="fixed">requireSession</span>, or
+ <span class="fixed">exportAssertion</span> attributes, they will override values in this element; similarly, values
+ within this element will override those in the containing
+ <a href="#confRequestMap"><span class="fixed">RequestMap</span></a> element.</p>
+ <ul>
+ <li><span class="fixed">scheme</span>: This specifies the protocol on which this host responds.
+ Valid choices are <span class="fixed">http</span>, <span class="fixed">https</span>, <span class="fixed">ftp</span>,
+ <span class="fixed">ldap</span>, and <span class="fixed">ldaps</span>.</li>
+ <li class="mandatory"><span class="fixed">name</span>: This is the fully-qualified domain name of the host.
+ This appended to the <span class="fixed">scheme</span> must match what is contained in the URL for the element's
+ settings to apply to the request.</li>
+ <li><span class="fixed">port</span>: This is the port the host is listening on, if not the standard port for the scheme.</li>
+ <li><span class="fixed">requireSession</span>: This attribute controls whether Shibboleth will forcibly establish
+ an authenticated session with the user before handing off the request to the web server or application.
+ If <span class="fixed">true</span>, Shibboleth will force session establishment. If <span class="fixed">false</span>
+ (the default), applications are responsible for ensuring that a session exists if necessary, so-called
+ <a href="#1.g.">lazy session establishment</a>. Most deployments should not specify <span class="fixed">false</span>
+ for protected content without a full understanding of the implications.</li>
+ <li><span class="fixed">exportAssertion</span>: When <span class="fixed">true</span>, the entire SAML attribute
+ assertion received from the origin is exported to a CGI request header called
+ <span class="fixed">Shib-Attributes</span>, encoded in <span class="fixed">base64</span>. This requires an
+ application to be able to parse the raw XML. Defaults to <span class="fixed">false</span>, which most deployments
+ should use.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confImplementation"><span class="fixed"><Implementation></span></dd>
+ <dd class="value">
+ <p>A container element placed inside the <a href="#confSHIRE"><span class="fixed">SHIRE</span></a> element,
+ the contents of this element will vary depending on the web server or environment that this Shibboleth deployment serves.
+ Multiple configurations may be specified, but only one per implementation type. This element may contain the
+ <a href="#confISAPI"><span class="fixed">ISAPI</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confISAPI"><span class="fixed"><ISAPI normalizeRequest="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>The configuration information for Shibboleth targets deployed on Microsoft IIS is stored inside this container element.
+ This element must contain one or more <a href="#confSite"><span class="fixed">Site</span></a> elements, each of which
+ maps an INSTANCE ID value to a hostname. If <span class="fixed">normalizeRequest</span> is
+ <span class="fixed">true</span> (the default), all redirects and computed request URLs generated by Shibboleth will
+ be created using the hostname assigned to the site instance handling the request. If <span class="fixed">false</span>,
+ the browser's supplied URL is sometimes used to compute the information. Placed inside the
+ <a href="#confImplementation"><span class="fixed">Implementation</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confKey"><span class="fixed"><Key format="<i>type</i>"></span></dd>
+ <dd class="value">
+ <p>Specifies a file containing a private key to be used within a set of credentials. Valid formats are
+ <span class="fixed">PEM</span> (the default), <span class="fixed">DER</span>, and <span class="fixed">PKCS12</span>.
+ Placed within a <a href="#confFileResolver"><span class="fixed">FileResolver</span></a> element, it should be paired
+ with a <a href="#confCertificate"><span class="fixed">Certificate</span></a> element, and contain a
+ <a href="#confCredPath"><span class="fixed">Path</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confLibrary"><span class="fixed"><Library <span class="mandatory">path="<i>pathname</i>"</span> fatal="<i>true/false</i>"/></span></dd>
+ <dd class="value">
+ <p>This element defines an extension library for one of Shibboleth's components and is placed within an
+ <a href="#confExtensions"><span class="fixed">Extensions</span></a> element.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">path</span>: This designates the complete pathname of the library.</li>
+ <li><span class="fixed">fatal</span>: If <span class="fixed">true</span> and the library is not located or fails
+ to load properly, the target will not successfully initialize. The default is false.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confListener"><span class="fixed"><Listener <span class="mandatory">type="<i>string</i>"</span>></span></dd>
+ <dd class="value">
+ <p>Specifies a pluggable implementation of a mechanism for communication between the web server and SHAR,
+ specified in the <span class="fixed">type</span> attribute. This element is placed within the
+ <a href="#confSHAR"><span class="fixed">SHAR</span></a> element and is mutually exclusive with the
+ <a href="#confTCPListener"><span class="fixed">TCPListener</span></a> and
+ <a href="#confUnixListener"><span class="fixed">UnixListener</span></a> elements.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confMemorySessionCache"><span class="fixed"><MemorySessionCache AAConnectTimeout="<i>seconds</i>" AATimeout="<i>seconds</i>" cacheTimeout="<i>seconds</i>" cleanupInterval="<i>seconds</i>" defaultLifetime="<i>seconds</i>" propagateErrors="<i>true/false</i>" retryInterval="<i>seconds</i>" strictValidity="<i>true/false</i>"/></span></dd>
+ <dd class="value">
+ <p>Shibboleth will cache sessions and received attributes in memory if this element is found in the
+ <a href="#confSHAR"><span class="fixed">SHAR</span></a> element. This element is mutually exclusive with the
+ <a href="#confMySQLSessionCache"><span class="fixed">MySQLSessionCache</span></a> and
+ <a href="#confSessionCache"><span class="fixed">SessionCache</span></a> elements.</p>
+ <ul>
+ <li><span class="fixed">AAConnectTimeout</span>: Time in seconds the target will wait before timing out on the
+ initial connection to an origin to request attributes. Defaults to <span class="fixed">15</span>.</li>
+ <li><span class="fixed">AATimeout</span>: Time in seconds the target will wait before timing out while waiting
+ for attributes from an origin once the initial connection is established. Defaults to <span class="fixed">30</span>.</li>
+ <li><span class="fixed">cacheTimeout</span>: Time in seconds to permit a session to stay in the cache before
+ being purged. Defaults to <span class="fixed">28800</span>.</li>
+ <li><span class="fixed">cleanupInterval</span>: Seconds between runs of the background thread that purges
+ expired sessions. Defaults to <span class="fixed">300</span>.</li>
+ <li><span class="fixed">defaultLifetime</span>: If the attribute assertion doesn't carry an explicit
+ expiration time, the assertion will expire after this time in <span class="fixed">seconds</span> has elapsed.
+ Defaults to <span class="fixed">1800</span>.</li>
+ <li><span class="fixed">propagateErrors</span>: If true, then any errors that occur during the attribute
+ query stage are fatal and will be presented to the user as an error, terminating their session. If false,
+ any errors that occur during the query are non-fatal, and the application will be given older, expired
+ attributes based on the <span class="fixed">strictValidity</span> setting.
+ <p>This should generally only be left to false (the default) by deployments that are using real principal
+ names as subjects because attribute retrieval is treated as an optional process.</p></li>
+ <li><span class="fixed">retryInterval</span>: Time in seconds between attempts to obtain fresh attributes. If a query fails, a timer is set, and once the interval elapses, the next user request causes another query. This prevents pointless repeated attempts to query a failed origin. Defaults to <span class="fixed">300</span>.</li>
+ <li><span class="fixed">strictValidity</span>: If true, expired attributes will never be made available to the Shibboleth application; if no valid attributes can be obtained, then an empty set is provided. When false, if a fresh set of attributes cannot be retrieved due to failures, any cached, expired attributes are made available. Defaults to <span class="fixed">true</span>.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confMySQLSessionCache"><span class="fixed"><MySQLSessionCache mysqlTimeout="<i>seconds</i>"/></span></dd>
+ <dd class="value">
+ <p>Shibboleth will back the memory cache of sessions using an embedded MySQL database if this element is found
+ in the <a href="#confSHAR"><span class="fixed">SHAR</span></a> element. Arguments may be passed directly to
+ MySQL by populating this element with <span class="fixed"><a href="#confArgument">Argument</a></span> elements.
+ The element may also specify any of the attributes defined for the <a href="#confMemorySessionCache">MemorySessionCache</a>
+ element. Mutually exclusive with the <a href="#confMemorySessionCache"><span class="fixed">MemorySessionCache</span></a>
+ and <a href="#confSessionCache"><span class="fixed">SessionCache</span></a> elements.</p>
+ <ul>
+ <li><span class="fixed">mysqlTimeout</span>: Time in seconds to permit a session to stay in the persistent
+ cache before being purged. Defaults to <span class="fixed">28800</span>.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute">(RequestMap) <a name="confPath"><span class="fixed"><Path <span class="mandatory">name="<i>pathname</i>"</span> applicationId="<i>id</i>" requireSession="<i>true/false</i>" exportAssertion="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>This element allows for different application identifiers and session handling to be defined iteratively for
+ subdirectories or documents within a host. Requests are processed on a best-match basis, with the innermost
+ element taking precedence. Path elements may be contained by <a href="#confHost"><span class="fixed">Host</span></a>
+ elements or other <a href="#confPath"><span class="fixed">Path</span></a> elements.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">name</span>: This is the name of the path component or filename to match
+ against the request. Only exact matching is supported by the supplied request mapping provider.</li>
+ <li><span class="fixed">requireSession</span>: This attribute controls whether Shibboleth will forcibly establish
+ an authenticated session with the user before handing off the request to the web server or application.
+ If <span class="fixed">true</span>, Shibboleth will force session establishment. If <span class="fixed">false</span>
+ (the default), applications are responsible for ensuring that a session exists if necessary, so-called
+ <a href="#1.g.">lazy session establishment</a>. Most deployments should not specify <span class="fixed">false</span>
+ for protected content without a full understanding of the implications.</li>
+ <li><span class="fixed">exportAssertion</span>: When <span class="fixed">true</span>, the entire SAML attribute
+ assertion received from the origin is exported to a CGI request header called
+ <span class="fixed">Shib-Attributes</span>, encoded in <span class="fixed">base64</span>. This requires an
+ application to be able to parse the raw XML. Defaults to <span class="fixed">false</span>, which most deployments
+ should use.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute">(Credential) <a name="confCredPath"><span class="fixed"><Path><i>pathname</i></Path></span></dd>
+ <dd class="value">
+ <p>Placed inside the <a href="#confKey"><span class="fixed">Key</span></a> and
+ <a href="#confCertificate"><span class="fixed">Certificate</span></a> elements to specify the pathname of the file
+ containing the credential.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confRelyingParty"><span class="fixed"><RelyingParty <span class="mandatory">name="<i>string</i>" TLS="<i>string</i>" Signing="<i>string</i>"</span></span>></dd>
+ <dd class="value"><p>One or more <span class="fixed">RelyingParty</span> elements may be contained by a <a href="#confCredentialUse"><span class="fixed">CredentialUse</span></a> element to enumerate relying parties for which a distinct set of credentials should be used. The <span class="fixed">TLS</span> and <span class="fixed">Signing</span> attribute values reference the identifiers of credential resolvers defined in <a href="#confCredentialsProvider"><span class="fixed">CredentialsProvider</span></a> elements.</p>
+<ul>
+<li class="mandatory"><span class="fixed">name</span>: Identifies the origin site or group of sites to which the credentials specified in the element apply. This is used to match the providerId sent within attribute assertions from origin sites against a set of "groups" based on metadata.</li>
+</ul>
+</dd>
+
+ <dd class="attribute"><a name="confRequestMap"><span class="fixed"><RequestMap <span class="mandatory">applicationId="<i>default</i>"</span> requireSession="<i>true/false</i>" exportAssertion="<i>true/false</i>"></span></dd>
+ <dd class="value">
+ <p>The <span class="fixed">RequestMap</span> element is a container holding
+ <a href="#confHost"><span class="fixed">Host</span></a> and <a href="#confPath"><span class="fixed">Path</span></a>
+ elements. Request URLs processed by Shibboleth are parsed and matched against this set of elements in order to
+ determine how to process the request. Attributes on the RequestMap, Host, and Path elements specify whether to
+ require an authenticated session, and how to locate the associated Application element and settings.</p>
+ <ul>
+ <li><span class="fixed">applicationId</span>: Contains a fixed value of "default" to reference the default
+ <a href="#confApplications"><span class="fixed">Applications</span></a> element.</li>
+ <li><span class="fixed">requireSession</span>: This attribute controls whether Shibboleth will forcibly establish
+ an authenticated session with the user before handing off the request to the web server or application.
+ If <span class="fixed">true</span>, Shibboleth will force session establishment. If <span class="fixed">false</span>
+ (the default), web applications are responsible for ensuring that a session exists if necessary, so-called
+ <a href="#1.g.">lazy session establishment</a>. Most deployments should not specify <span class="fixed">false</span>
+ for protected content without a full understanding of the implications.</li>
+ <li><span class="fixed">exportAssertion</span>: When <span class="fixed">true</span>, the entire SAML attribute
+ assertion received from the origin is exported to a CGI request header called
+ <span class="fixed">Shib-Attributes</span>, encoded in <span class="fixed">base64</span>. This requires an
+ application to be able to parse the raw XML. Defaults to <span class="fixed">false</span>, which most deployments
+ should use.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confRequestMapProvider"><span class="fixed"><RequestMapProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap"</span> uri="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This element specifies a request mapper that defines how Shibboleth will handle sessions and other behavior
+ for a given request. For the built-in type "edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap",
+ there must be a <a href="#confRequestMap"><span class="fixed">RequestMap</span></a> element within this element, or
+ the <span class="fixed">uri</span> attribute must contain the local pathname of an XML file containing one.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confRevocationProvider"><span class="fixed"><RevocationProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation"</span> uri="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This element, when specified within an <a href="#confApplications"><span class="fixed">Applications</span></a>
+ or <a href="#confApplication"><span class="fixed">Application</span></a> element, points to revocation information either
+ inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download
+ periodically. This should be refreshed regularly; see <a href="#4.g.">section 4.g</a> for further details.</p>
+ <p>The default set of revocation providers in the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ element can be replaced within individual <a href="#confApplication"><span class="fixed">Application</span></a> elements.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confSessionCache"><span class="fixed"><SessionCache <span class="mandatory">type="<i>string</i>"</span>></span></dd>
+ <dd class="value">
+ <p>Specifies a pluggable session cache implementation of the specified <span class="fixed">type</span>. This element
+ is placed within the <a href="#confSHAR"><span class="fixed">SHAR</span></a> element and is mutually exclusive with
+ the <a href="#confMemorySessionCache"><span class="fixed">MemorySessionCache</span></a> and
+ <a href="#confMySQLSessionCache"><span class="fixed">MySQLSessionCache</span></a> elements.</p>
+ <p>Any plugin should support the basic attributes defined by the
+ <a href="#confMemorySessionCache"><span class="fixed">MemorySessionCache</span></a> element.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confSessions"><span class="fixed"><Sessions
+<span class="mandatory">wayfURL="<i>URL</i>"
+shireURL="<i>URL</i>"</span>
+shireSSL="<i>true/false</i>"
+lifetime="<i>seconds</i>"
+timeout="<i>seconds</i>"
+checkAddress="<i>true/false</i>"
+cookieName="<i>URL</i>"
+cookieProps="<i>URL</i>"></span></dd>
+ <dd class="value">
+ <p>Configuration parameters that affect the way Shibboleth handles sessions for an individual application are bundled
+ in this element, which must be included in each <a href="#confApplication"><span class="fixed">Application</span></a>
+ and the default <a href="#confApplications"><span class="fixed">Applications</span></a> element. Note that these
+ parameters only apply to Shibboleth sessions, and not any sessions applications manage on their own behalf.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">wayfURL</span>: The URL of the <a href="#1.c.">WAYF service</a>
+ responsible for redirecting users accessing this application to their identity provider (origin).</li>
+ <li class="mandatory">
+ <p><span class="fixed">shireURL</span>: Specifies the SHIRE URL, or assertion consumer service, at which
+ new sessions are initiated or lazy sessions are triggered. This can be an absolute URL, or a relative path
+ to be prefixed by the base URL of the virtual host. Using an absolute URL allows a virtual server to funnel
+ requests to a fixed location, to force use of SSL, for example.</p>
+ <p>Note that this URL issues the session cookie set on behalf of the application, and this cookie must be
+ returned in subsequent requests, so the virtual host's domain name and port must be consistent with this
+ domain name and port for some browsers to properly return the cookie. If default ports are used (and thus
+ left unspecified), browsers will generally return cookies set via SSL to a non-SSL port. If non-default
+ ports are used, it is recommended that this be a relative URL so that each virtual host handles its own
+ cookie operations.</p>
+ <p>For Shibboleth to function properly in IIS, the file extension at the end of this URL must match the
+ value configured into IIS and mapped to the ISAPI extension. This causes the request to be serviced properly,
+ even though no file by that name actually exists.</p>
+ </li>
+ <li><span class="fixed">shireSSL</span>: If <span class="fixed">true</span> (the default), the application will
+ <b>only</b> accept new session requests over SSL, as is strongly recommended; see <a href="#2.c.">section 2.c</a>
+ for more details.</li>
+ <li><span class="fixed">cookieName</span>: Optionally specifies the name given to in-memory session cookies that
+ are associated with this application. If omitted, Shibboleth will generate a cookie name for you of the form
+ _shibsession_<Application ID></li>
+ <li><span class="fixed">cookieProps</span>: A string of additional Set-Cookie properties can be specified using
+ this element which give the browser further instructions about cookie processing and use. Always begin with a
+ semicolon to delineate from the session ID value.</li>
+ <li><span class="fixed">lifetime</span>: Duration in seconds of the Shibboleth session; this does not affect
+ the lifetime of application sessions initiated independently of Shibboleth. Defaults to 3600. If 0 is specified,
+ sessions are infinite, subject to purging by the cache.</li>
+ <li><span class="fixed">timeout</span>: If the value in seconds elapses following the last request in a
+ session, the session will be expired for inactivity and a new session must be initiated upon the next request.
+ Defaults to 1800. If 0 is specified, there is no inactivity timeout</li>
+ <li><span class="fixed">checkAddress</span>: If <span class="fixed">true</span> (the default), Shibboleth will
+ check the browser's client address to insure that session cookies are issued and used by a consistent client address.
+ In most circumstances, this should be enabled to help prevent attacks using stolen cookies, but this can cause
+ problems for users behind proxies or NAT devices.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confSHAR"><span class="fixed"><SHAR logger="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This is the container element for configuration information pertaining to the SHAR, the target component responsible
+ for most attribute and session processing. Its single attribute, <span class="fixed">logger</span>, points to a
+ Log4J-format property configuration file that controls SHAR logging behavior. It is placed within the
+ <a href="#confShibbolethTargetConfig"><span class="fixed">ShibbolethTargetConfig</span></a> element and may contain an
+ <a href="#confExtensions"><span class="fixed">Extensions</span></a> element specifying additional libraries.</p>
+ <p>It must contain either a <a href="#confUnixListener"><span class="fixed">UnixListener</span></a> element to listen
+ to the server module on a UNIX domain socket or a <a href="#confTCPListener"><span class="fixed">TCPListener</span></a>
+ element to listen on a TCP port. Session caching must also be specified using a
+ <a href="#confMemorySessionCache"><span class="fixed">MemorySessionCache</span></a> element to use in-memory session
+ caching or a <a href="#confMySQLSessionCache"><span class="fixed">MySQLSessionCache</span></a> element to backup session
+ information into a MySQL database.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confShibbolethTargetConfig"><span class="fixed"><ShibbolethTargetConfig clockSkew="integer"></span></dd>
+ <dd class="value">
+ <p>This is the root element for target configuration and must be present once and only once. It must always contain a
+ <a href="#confSHAR"><span class="fixed">SHAR</span></a> element, a
+ <a href="#confSHIRE"><span class="fixed">SHIRE</span></a> element, an
+ <a href="#confApplications"><span class="fixed">Applications</span></a> element, one or more
+ <a href="#confCredentialsProvider"><span class="fixed">CredentialsProvider</span></a> elements, and optionally an
+ <a href="#confExtensions"><span class="fixed">Extensions</span></a> element.</p>
+ <ul>
+ <li><span class="fixed">clockSkew</span>: Controls allowed clock skew in seconds between target and origin servers
+ when evaluating times sent in messages. Defaults to 180, and should be as small as practical.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confSHIRE"><span class="fixed"><SHIRE logger="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This is the container element for configuration information pertaining to the SHIRE, the part of the target that
+ integrates into the web server environment. Its single attribute, <span class="fixed">logger</span>, points to a
+ Log4J-format property configuration file that controls SHIRE logging behavior. It is placed within the
+ <a href="#confShibbolethTargetConfig"><span class="fixed">ShibbolethTargetConfig</span></a> element and may contain an
+ <a href="#confExtensions"><span class="fixed">Extensions</span></a> element specifying additional libraries.</p>
+ <p>It may contain an <a href="#confImplementation"><span class="fixed">Implementation</span></a> element, within which
+ configuration for the SHIRE which varies by platform will be specified.</p>
+ <p>It may contain a <a href="#confRequestMapProvider"><span class="fixed">RequestMapProvider</span></a> element,
+ which provides fine-grained control over aspects of target behavior at a host, path, or document level.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confSite"><span class="fixed"><Site <span class="mandatory">id="<i>INSTANCE_ID</i>" host="<i>fqdn</i>"</span> scheme="<i>http/https</i>" port="<i>integer</i>"></span></dd>
+ <dd class="value">
+ <p>This element is placed in the <a href="#confISAPI"><span class="fixed">ISAPI</span></a> element to specify a
+ mapping from individual instance ID's to the corresponding host, port, and scheme.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confTCPListener"><span class="fixed"><TCPListener <span class="mandatory">address="<i>pathname</i>" port="<i>integer</i>"</span> acl="<i>ip</i>"></span></dd>
+ <dd class="value">
+ <p>This element is placed within the <a href="#confSHAR"><span class="fixed">SHAR</span></a> element and is mutually
+ exclusive with the <a href="#confUnixListener"><span class="fixed">UnixListener</span></a> and
+ <a href="#confListener"><span class="fixed">Listener</span></a> elements. It allows the SHAR to communicate with the
+ web server component using TCP.</p>
+ <ul>
+ <li class="mandatory"><span class="fixed">address</span>: Specifies the IP address of the listener.</li>
+ <li class="mandatory"><span class="fixed">port</span>: Specifies the TCP port on which the SHAR will listen.</li>
+ <li><span class="fixed">acl</span>: By default, the SHAR will only listen to requests from 127.0.0.1 (localhost).
+ This should generally not be specified except in test environments.</li>
+ </ul>
+ </dd>
+
+ <dd class="attribute"><a name="confTrustProvider"><span class="fixed"><TrustProvider <span class="mandatory">type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust"</span> uri="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>This element, when specified within an <a href="#confApplications"><span class="fixed">Applications</span></a>
+ or <a href="#confApplication"><span class="fixed">Application</span></a> element, points to trust metadata either
+ inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download
+ periodically. This should be refreshed regularly; see <a href="#4.g.">section 4.g</a> for further details.</p>
+ <p>The default set of trust providers in the <a href="#confApplications"><span class="fixed">Applications</span></a>
+ element can be replaced within individual <a href="#confApplication"><span class="fixed">Application</span></a> elements.</p>
+ </dd>
+
+ <dd class="attribute"><a name="confUnixListener"><span class="fixed"><UnixListener address="<i>pathname</i>"></span></dd>
+ <dd class="value">
+ <p>Use this element to specify a UNIX domain socket located at the <span class="fixed">pathname</span> specified in
+ the <span class="fixed">address</span> attribute at which the SHAR should listen for requests. This element must be
+ contained by the <a href="#confSHAR"><span class="fixed">SHAR</span></a> element and is mutually exclusive with the
+ <a href="#confTCPListener"><span class="fixed">TCPListener</span></a> and
+ <a href="#confListener"><span class="fixed">Listener</span></a> elements.
+ <span class="fixed">UnixListener</span> cannot be specified for Windows-based installations.</p>
+ </dd>
+
+</dl></blockquote>
<h4><a name="4.b."></a>4.b. Dynamic Error Page Generation</h4>
<blockquote>
<p>Shibboleth supports the dynamic generation of information in error pages
- referenced by <span class="fixed">shibboleth.ini</span>. The Shib Target
- employs a special Markup Language Processor to insert special tags into the
- generated HTML. The parser will read the error file looking for any tag that
+ referenced by the <a href="#confErrors"><span class="fixed">Errors</span></a> element
+ in <span class="fixed">shibboleth.xml</span>. The target implementation
+ employs a simply template language to insert special tags into the
+ generated HTML. The parser will read the error template looking for any tag that
looks like:</p>
<blockquote>
<p><span class="fixed"><shibmlp tag-name /></span> </p>
</blockquote>
<p>Shibboleth will replace <span class="fixed">tag-name</span> with the
- appropriate markup tag from the table below:</p>
+ appropriate markup tag either from the table below or by looking for a matching XML attribute
+ in the <a href="#confErrors"><span class="fixed">Errors</span></a> element:</p>
<dl>
- <dd class="attribute"><span class="fixed">supportContact</span></dd>
- <dd class="value">The value of the <span class="fixed">supportContact</span>
- for this web site.</dd>
- <dd class="attribute"><span class="fixed">logoLocation</span></dd>
- <dd class="value">The value of the <span class="fixed">logoLocation</span>
- for this web site. This is used to fill in the template error page only;
- if a custom error page is created, then the image may be linked to
- statically by the page itself.</dd>
<dd class="attribute"><span class="fixed">requestURL</span></dd>
<dd class="value">The user's requested URL.</dd>
<dd class="attribute"><span class="fixed">errorType</span></dd>
<dd class="value">The URL of an error handling page for the origin site
provided by that site's metadata.</dd>
</dl>
- <p>This configuration is only for Apache servers, and is only used by
- resources protected by Shibboleth. See <a href="#4.d.">section 4.d.</a></p>
+ <p>To improve the appearance of error messages, a simple, limited form of
+ conditional checking is supported so that the presence of absence of data
+ to substitute into a particular tag-name can trigger the inclusion or
+ exclusion of markup. Conditionals look like:</p>
+ <blockquote>
+ <p><span class="fixed"><shibmlpif tag-name> arbitrary markup </shibmlpif></span><br>
+ <span class="fixed"><shibmlpifnot tag-name> arbitrary markup </shibmlpifnot></span></p>
+ </blockquote>
+ <p>Respectively, these special tags include or skip the markup between the tags if the
+ specified tag-name has an associated value available to be substituted for it. Note that
+ you cannot nest these conditionals; a <span class="fixed">shibmlpif</span> tag cannot
+ appear inside another <span class="fixed">shibmlpif</span> tag, due to the simplicity
+ of the substitution engine.</p>
<p>Sample error templates for different kinds of errors are included in the
Shibboleth distribution, and can be triggered by anything that will cause
- Shibboleth to be unable to make an authorization decision, including a bad
- sites file, certificate verification failures, or a skewed clock between
- sites.</p>
+ Shibboleth to be unable to accept an incoming session, obtain attributes,
+ make an authorization decision, etc., including bad configuration settings,
+ signature verification or certificate validation failures, or a skewed clock
+ between sites.</p>
<p><b>You should edit these templates, provide or remove style sheets and
images, and otherwise customize these templates to suit the user experience
you want your users to have when errors occur. The defaults are not likely
accepted by the origin sites that will be queried for attributes.</p>
<p>On Unix, we require that OpenSSL be installed to use Shibboleth. On
Windows, OpenSSL libraries and the command line tool are included in the
- package and can be used directly, if not otherwise available.</p>
+ package and can be used directly, if not otherwise available. Certain
+ commands require the <span class="fixed">openssl.cnf</span> configuration
+ file, an example of which is included with the Windows installation in
+ <span class="fixed">C:\opt\shibboleth\etc\shibboleth\openssl.cnf</span>.
+ To locate this file for a command that requires it, add the
+ <span class="fixed">-config C:\opt\shibboleth\etc\shibboleth\openssl.cnf</span>
+ parameter to the command.</p>
<p>The certificate and key file location should be based on whether they
- will also be used for Apache. If they will be used as a server certificate
+ will also be used for Apache. If they will be used as a server key pair
as well, they should probably be in the Apache tree in the usual
<span class="fixed">mod_ssl</span>-defined locations inside the Apache
- configuration folder., and the SHAR can read them from there. If the SHAR is
+ configuration folder, and the SHAR can read them from there. If the SHAR is
not running as <span class="fixed">root</span>, permissions might need to be
changed to allow this access. If the certificate and key will only be used
for the SHAR, they can be put in the same folder with the
- <span class="fixed">shibboleth.ini</span> file and protected appropriately.</p>
- <p>Other web servers like IIS do not use the raw PEM format that Apache and
+ <span class="fixed">shibboleth.xml</span> file and protected appropriately.</p>
+ <p>Other web servers like IIS do not use the file formats that Apache and
Shibboleth can share, and therefore the components must generally use
separate copies of the key and certificate if they are to be shared. Most
- other servers can export and/or import keys to and from PEM format or other
- formats that OpenSSL can convert. Refer to your server's documentation or
- ask for assistance from others who use it.</p>
- <p>The SHAR is assigned a key and a certificate using shibboleth.ini's
- <span class="fixed">certFile</span>, <span class="fixed">keyFile</span> and
- <span class="fixed">keyPass</span> settings, described in <a href="#4.a.">
- section 4.a.</a> These files must currently be in PEM format. OpenSSL
- commands to generate a new keypair and a certificate request are shown here,
- assuming 2048 bit RSA keys are to be used:</p>
+ other servers can export and/or import keys to and from PEM or DER format.
+ Refer to your server's documentation or ask for assistance from others
+ who use it.</p>
+ <p>The SHAR is assigned a key and a certificate using shibboleth.xml's
+ <a href="#confFileResolver"><span class="fixed">FileResolver</span></a> element
+ described in <a href="#4.a.">section 4.a.</a> Various formats are supported and
+ OpenSSL can generate and convert among them. OpenSSL commands to generate a new
+ keypair and a certificate request are shown here, assuming 2048 bit RSA keys are
+ to be used:</p>
<blockquote>
- <p><span class="fixed">$ openssl genrsa -des3 -out ssl.key 2048<br>
+ <p><span class="fixed">$ openssl genrsa -out ssl.key 2048<br>
$ openssl req -new -key ssl.key -out ssl.csr</span> </p>
</blockquote>
- <p>The signed certificate file returned by the CA should be usable directly,
- or can be converted to PEM format using the <span class="fixed">openssl x509</span>
- command.</p>
+ <p>The signed certificate file returned by the CA should be usable directly.</p>
<p>If the key is to be shared with Apache, the web server's child processes,
- often running as <span class="fixed">nobody</span>, must be able to read
- them while the server is running, which may require permission changes.</p>
+ often running as <span class="fixed">nobody</span> or a similar uid, must be
+ able to read them while the server is running, which may require permission
+ changes.</p>
<p>This particularly applies when sharing the key and certificate used by
mod_ssl, which are only readable by root by default. The password, if any,
- must be placed in the <span class="fixed">shibboleth.ini</span> file, since
+ must be placed in the <span class="fixed">shibboleth.xml</span> file, since
the Apache module cannot prompt for it during initial startup as mod_ssl
can. The issues surrounding how to securely obtain a key while running as
<span class="fixed">nobody</span> may be addressed in a later release. Since
the password will be stored in clear text in a frequently examined file, it
- is suggested to use a password not used elsewhere.</p>
- <p>Finally, the <span class="fixed">calist</span> command provides the SHAR
- with a set of CA roots to trust when validating AA server certificates. In
- all cases, the SHAR verifies that the certificate's Subject CN equals the
- AA's hostname, but the CA list restricts the accepted signers to those
- permitted by the SHAR. The parameter can be omitted to skip such validation,
- but this is not secure.</p>
+ is suggested to use a password not used elsewhere, or preferably not to use
+ a password at all.</p>
+
</blockquote>
<h4><a name="4.d."></a>4.d. Protecting Web Pages</h4>
<blockquote>
- <p>Protection of web pages is primarily achieved through "mapping"
- attributes provided by an AA to a localized vocabulary for authorization
- rules. This was formerly accomplished in Apache with the <span class="fixed">
- ShibMapAttribute</span> command, but this has been replaced with additional
- features in the AAP syntax, described in <a href="#4.e.">section 4.e.</a>
- This applies to both Apache and IIS.</p>
+ <p>Protection of web pages is primarily achieved through "mapping"
+ attributes provided by an AA to a localized vocabulary for authorization
+ rules. This is accomplished using features in the AAP syntax, described in
+ <a href="#4.e.">section 4.e.</a> This applies to both Apache and IIS.</p>
<p><b><u>IIS</u></b></p>
- <p>The IIS RM module supports the mapping of attributes via AAP files, but
- it does not support rule-based policies and therefore cannot protect static
- content at this time. In addition, all of the configuration settings are
- managed globally or per-site and are pulled from the <span class="fixed">
- shibboleth.ini</span> file, so there are no additional commands to document
- at this time.<br>
+ <p>The IIS filter module supports the mapping of attributes into HTTP headers
+ via AAP files, but it does not yet support rule-based access control and
+ therefore cannot protect static content at this time. In addition, all of
+ the configuration settings, such as control over whether to prompt for new
+ sessions automatically, are managed via the
+ <a href="#confRequestMap"><span class="fixed">RequestMap</span></a> element,
+ so there are no additional commands to document at this time.<br>
</p>
<p><b><u>Apache</u></b></p>
- <p>The Apache RM module provided can interpret AAP settings to map
- attributes to HTTP request headers and to <span class="fixed">Require</span>
- rules, permitting protecting of both static and dynamic content. The
- commands described here can appear in content-specific configuration blocks
- or <span class="fixed">.htaccess</span> files. They determine what content
- is to be protected, session policies, and static access control rules.</p>
- <p>Any of the typical ways of protecting content may be used (.htaccess,
- Directory, Location, Files, etc.). There are two ways to trigger Shibboleth
- authentication: specifying an <span class="fixed">AuthType</span> of
- <span class="fixed">shibboleth</span> to use Shibboleth directly, or using
- <span class="fixed">ShibBasicHijack</span> to process existing .htaccess
- files using Shibboleth instead. Support for authorization consists of
- mod_auth-style require directives, as well as support for mod_auth group
- files.</p>
- <p>A complete list of the directives and their values is below:</p>
+ <p>The Apache module provided can also interpret AAP settings to map
+ attributes to HTTP request headers and to <span class="fixed">Require</span>
+ rules, permitting protection of both static and dynamic content. Any of the
+ typical ways of protecting content may be used (.htaccess, Directory,
+ Location, Files, etc.). They define what content is to be protected and
+ static access control rules.</p>
+ <p>There are two ways to require Shibboleth authentication, but both also require
+ enabling the module to activate by specifying an <span class="fixed">AuthType</span>
+ of <span class="fixed">shibboleth</span> and supplying at least one
+ <span class="fixed">Require</span> rule in <span class="fixed">httpd.conf</span>
+ or <span class="fixed">.htaccess</span> files. The <span class="fixed">Require</span>
+ rule can enforce a specific access control policy based on attributes, can specify
+ <span class="fixed">valid-user</span> to require any authenticated session, or it can
+ support so-called lazy sessions by using the place-holder rule name of
+ <span class="fixed">Shibboleth</span>. In such cases, the module is activated, but
+ in a passive mode that does not automatically force a session, but will process
+ and validate a session if one exists, leaving the authorization decision to the
+ application. Using a static access control rule that will fail in the absence of
+ a session is only sensible if one of the two approaches below that force a session
+ are used.</p>
+ <p>To require a session, either the Apache command, <span class="fixed">ShibRequireSession On</span>,
+ or the <span class="fixed">requireSession</span> boolean XML attribute on the
+ <a href="#confRequestMap><span class="fixed">RequestMap</span></a>,
+ <a href="#confHost><span class="fixed">Host</span></a>, or
+ <a href="#confPath><span class="fixed">Path</span></a> elements in
+ <span class="fixed">shibboleth.xml</span> can be used. Both approaches are equivalent, and
+ using either one to require a session will supersede a false or absent setting of the other type.</p>
+ <p>As an example, the following commands will require Shibboleth authentication for a resource:</p>
+ <blockquote>
+ <span class="fixed">AuthType shibboleth<br>
+ ShibRequireSession On<br>
+ Require valid-user</span>
+ </blockquote>
+ <p>A complete list of Apache directives and their values is below:</p>
<dl>
+ <dd class="attribute"><span class="fixed">ShibURLScheme <http/https></span></dd>
+ <dd class="value">Used in advanced virtual hosting environments which need to generate
+ SSL redirects from virtual servers that use only HTTP. Supplements the
+ Apache <span class="fixed">ServerName</span> and <span class="fixed">Port</span>
+ commands with this missing option. Defaults to a null value in which the scheme
+ for redirects is based on the physical connection to the server. This is a server-level
+ command, while the rest of the commands listed are content commands that can appear
+ anywhere.</dd>
<dd class="attribute"><span class="fixed">AuthType <string></span></dd>
<dd class="value">Use <span class="fixed">shibboleth</span> for direct
invocation, or <span class="fixed">Basic</span> plus the
<span class="fixed">ShibBasicHijack</span> option described below.</dd>
- <dd class="attribute"><span class="fixed">ShibSSLOnly <on/off></span></dd>
- <dd class="value">Controls whether Shibboleth will reject non-SSL
- requests for resources from clients. Defaults to <span class="fixed">off</span>.</dd>
<dd class="attribute"><span class="fixed">ShibBasicHijack <on/off></span></dd>
<dd class="value">Controls whether Shibboleth should or should not
ignore requests with <span class="fixed">AuthType Basic</span>. Defaults
to <span class="fixed">off</span>.</dd>
+ <dd class="attribute"><span class="fixed">ShibRequireSession <on/off></span></dd>
+ <dd class="value">Controls whether to require an authenticated session before passing
+ control to the authorization phase or the actual resource. Defaults to
+ <span class="fixed">off</span>.</dd>
<dd class="attribute"><span class="fixed">ShibExportAssertion <on/off></span></dd>
<dd class="value">Controls whether the SAML attribute assertion provided
by the AA is exported in a base64-encoded HTTP header,
- <span class="fixed">Shib-Attributes</span>. Defaults to
- <span class="fixed">off</span>. While this does require parsing the raw
- XML, it also permits an application to see attributes that may have been
- filtered by an AAP, or to forward the SAML assertion to a third party.</dd>
- <dd class="attribute"><span class="fixed">ShibAuthLifetime <seconds></span></dd>
- <dd class="value">If set, sessions are always terminated after the
- specified number of seconds, resulting in a new redirect and request for
- authentication, just as if a new request without a session is received.
- Defaults to infinite.</dd>
- <dd class="attribute"><span class="fixed">ShibAuthTimeout <seconds></span></dd>
- <dd class="value">If set, sessions are always terminated after the
- specified number of seconds of inactivity (defined as no requests
- received in that session), resulting in a new redirect and request for
- authentication, just as if a new request without a session is received.
- Defaults to infinite.</dd>
+ <span class="fixed">HTTP_SHIB_ATTRIBUTES</span>. Defaults to <span class="fixed">off</span>.</dd>
+ <dd class="attribute"><span class="fixed">ShibRequireAll <on/off></span></dd>
+ <dd class="value">Controls whether all <span class="fixed">Require</span> rules
+ specified must be satisfied before access to the resource is granted. Defaults to
+ <span class="fixed">off</span>, which means any single rule can be satisfied, the
+ usual Apache behavior.</dd>
<dd class="attribute"><span class="fixed">AuthGroupFile <pathname></span></dd>
<dd class="value">Same as mod_auth; collects values found in REMOTE_USER
into a named group for access control. An attribute must be mapped to
REMOTE_USER for this to work. Note that mod_auth will not support group
- files when mod_shibrm is loaded, since they share the same command.
+ files when the Shibboleth module is loaded, since they share the same command.
<p><a href="http://httpd.apache.org/docs/mod/core.html#require">This is
implemented</a> by placing a <span class="fixed">.htaccess</span> file
that references a group file stored at <span class="fixed">/pathname</span>:</p>
<span class="fixed">workgroup: joe@example.edu, jane@demo.edu, jim@sample.edu</span>
</dd>
<dd class="attribute"><span class="fixed">Require <string></span></dd>
- <dd class="value">Enforce authorization using one of the following
-
methods.<ul type="circle">
+ <dd class="value">Enforce authorization using one of the following methods.
+ <ul type="circle">
<li><span class="fixed">valid-user</span><blockquote>
<p>Any Shibboleth user from a trusted origin site is accepted,
even if no actual attributes are received. This is a very
<p><span class="fixed">user</span></p>
<blockquote>
<p>A space-delimited list of values, such as from the
- <span class="fixed">
- urn:mace:dir:attribute-def:eduPersonPrincipalName</span>
+ <span class="fixed">urn:mace:dir:attribute-def:eduPersonPrincipalName</span>
attribute. Actually, any attribute can be mapped to REMOTE_USER,
even if this doesn't always make sense.</p>
</blockquote>
that a mapping to <span class="fixed">REMOTE_USER</span> exists.</p>
</blockquote>
</li>
- <li><span class="fixed">
<alias></span><blockquote>
+ <li><span class="fixed">
<i>alias</i></span><blockquote>
<p>An arbitrary rule name that matches an Alias defined in an
AAP file. The rule value is a space-delimited list of attribute
values, whose format depends on the attribute in question (e.g.
an affiliation rule might look like:</p>
- <p><span class="fixed">require affiliation staff@osu.edu
- faculty@mit.edu</span></p>
+ <p><span class="fixed">require affiliation staff@osu.edu faculty@mit.edu</span></p>
+ </blockquote>
+ </li>
+ <li><span class="fixed">shibboleth</span><blockquote>
+ <p>If a session cookie of the expected name exists, the corresponding
+ session will be validated and any cached attributes exported as otherwise
+ specified. Authorization will be controlled by the resource, unless
+ additional rules are specified. If however a session does not already
+ exist, or if the current session expires or times out, no session will
+ be requested and control will pass to the resource.</p>
</blockquote>
</li>
</ul>
about its users.</p>
<p>Attribute acceptance is the process of defining acceptable attributes and
filtering attribute values before passing them on to a resource manager,
- such as the <span class="fixed">mod_shibrm</span> module. Data blocked by
+ such as the Shibboleth module or a web application. Data blocked by
AAP filters will not be passed to the CGI environment or used when enforcing
- <span class="fixed">.htaccess</span> rules. Note that the attribute
- assertion exported to the <span class="fixed">Shib-Attributes</span> header
- is unfiltered.</p>
+ <span class="fixed">.htaccess</span> rules in Apache. Note that the attribute
+ assertion exported to the <span class="fixed">HTTP_SHIB_ATTRIBUTES</span> header
+ is now also filtered. This is a change from previous versions. To compensate,
+ either no AAP can be specified, or a rule can be applied to permit all
+ attributes to pass through while also exporting specific attributes.</p>
<p>The Shibboleth implementation supports Scoped and Simple attributes and
filtering policies for different kinds of attributes, and is potentially
extensible to more complex attributes in the future. An attribute is
considered Scoped if the XML representation of its values contains a "Scope"
- attribute. As of 1.1, this is detected at runtime and requires no
+ attribute. As of 1.1+, this is detected at runtime and requires no
configuration in advance.</p>
<p><b>An essential part of the Shibboleth trust fabric is ensuring that
sites only assert attributes for domains for which they are considered
will be trusted to assert attributes only scoped to <span class="fixed">
brown.edu</span>. Unless there are very specific circumstances requiring
this restriction be removed, it is strongly encouraged that such policies be
- in place.</b></p>
+ left in place.</b></p>
<h4>Scoped:</h4>
<blockquote>
<p>Scoped attributes are a special kind of attribute whose values are a
of <span class="fixed">eduPersonAffiliation</span> values, such as
<span class="fixed">student</span>, <span class="fixed">member</span>,
or <span class="fixed">faculty</span>. Scopes are expressed as DNS
- domains and subdomains.</p>
+ domains and subdomains as a convention.</p>
<p>Any <span class="fixed">scoped</span> attribute can be scoped only to
the origin site's permitted domains. These domains are listed in the
- site metadata that provides policy information to the system. Domains
- can be explicit or regular expressions, and can be changed by a target
- to meet its needs. Targets can also override the rules specified for the
- site in their own AAPs, choosing to accept additional scopes or deny
- scopes that would ordinarily be accepted based on metadata provided by a
- federation. Thus, attribute acceptance processing for
- <span class="fixed">scoped</span> attributes is based on site metadata
- and target-specified overrides in addition to the mechanism described
- below for <span class="fixed">simple</span> attributes.</p>
+ operational metadata that provides policy information to the system and
+ can be overridden or supplemented using the AAP. Domains can be explicit
+ or regular expressions, and can be changed by a target to meet its needs.
+ Thus, attribute acceptance processing for <span class="fixed">scoped</span>
+ attributes is based on site metadata and target-specified overrides in
+ addition to the mechanism described below for <span class="fixed">simple</span>
+ attributes.</p>
<p>Scope rules specified in an AAP are additive with any domains
permitted by site metadata, and the rules are applied by first looking
for an applicable denial rule, and then looking at site metadata and any
permitted. <span class="fixed">eduPersonEntitlement</span>, in which the
values are URIs, is one example of a simple attribute.</p>
<p>Both Simple and Scoped attribute acceptance is controlled with an
- external policy file written in XML. The schema for the file is
- described by the <span class="fixed">shibboleth.xsd</span> schema, and
- an example file is included, <span class="fixed">AAP.xml</span>. It is
- mandatory to supply such a file, because attributes are recognized based
- on their presence in this file, and not by separate configuration
- processes. Only by listing an attribute in the file will it be accepted
- and processed by the RM.</p>
+ external (or in 1.2, optionally inline) policy file written in XML.
+ The schema for the file is described by the <span class="fixed">shibboleth.xsd</span>
+ schema, and an example file is included, <span class="fixed">AAP.xml</span>.
+ It is now optional to supply such a policy, but in the absence of one, no
+ attributes will be exported into request headers, and the option to export
+ the assertion as a whole must be used instead.</p>
<p>The policy is a default-deny algorithm that requires permissible
- attributes and values be listed explicitly. That is, an empty file
- permits nothing. Each attribute to be supported must be listed in the
- file by name in an <span class="fixed"><AttributeRule></span>. Each such
+ attributes and values be listed explicitly. That is, an empty (as opposed to no)
+ policy permits nothing. Each attribute to be supported must be listed in the
+ policy by name in an <span class="fixed"><AttributeRule></span>. Each such
rule is a collection of <span class="fixed"><SiteRule></span> elements
along with an optional <span class="fixed"><AnySite></span> default
rule. In turn each site rule is a set of <span class="fixed"><Value></span>
expressions, or a wildcarded <span class="fixed"><AnyValue></span>
default rule, which is equivalent to a single regular expression rule
allowing anything.</p>
+ <p>With 1.2, a new <span class="fixed"><AnyAttribute></span> element
+ can be used before or in place of the <span class="fixed"><AttributeRule></span>
+ elements to allow all attributes and values to pass muster. The purpose of this
+ is to then supply rules to specify the export of particular attributes, without
+ using those rules to control acceptance.</p>
</blockquote>
<p>A syntax summary follows:</p>
<blockquote>
- <p><span class="fixed"><AttributeAcceptancePolicy</span></p>
+ <p><span class="fixed"><AttributeAcceptancePolicy></span></p>
<blockquote>
<p>The top level element in the file.</p>
</blockquote>
- <p><span class="fixed"><AttributeRule<br>
+ <p><span class="fixed"><AnyAttribute></span></p>
+ <blockquote>
+ <p>Disables acceptance filtering and leaves the assertion intact.</p>
+ </blockquote>
+ <p><span class="fixed"><AttributeRule><br>
Name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"<br>
Header="Shib-EP-Affiliation" Alias="affiliation"></span></p>
<blockquote>
<tr>
<td><span class="fixed">Header</span></td>
<td>The HTTP request header to map the attribute's values
- to.</td>
+ into.</td>
</tr>
<tr>
<td><span class="fixed">Alias</span></td>
<td>A short name for the attribute, determines the name of
- the Apache <span class="fixed">Requires</span> rule.</td>
+ the Apache <span class="fixed">Require</span> rule.</td>
</tr>
</table>
</blockquote>
<p><span class="fixed"><AnySite></span></p>
<blockquote>
<p>Specifies a rule that always applies to the attribute, regardless
- of the asserting AA.</p>
+ of the asserting origin site.</p>
</blockquote>
- <p><span class="fixed"><SiteRule Name="host.domain.com"></span></p>
+ <p><span class="fixed"><SiteRule Name="providerId"></span></p>
<blockquote>
- <p>A rule that applies to the origin site AA corresponding to the
- hostname.</p>
+ <p>A rule that applies to the origin site corresponding to the supplied
+ identifier</p>
</blockquote>
<p><span class="fixed"><Scope Accept="true|false" Type="type"></span></p>
<blockquote>
<span class="fixed">^</span> and <span class="fixed">$</span> to avoid
unintentional matches midstring.</p>
</blockquote>
-<h4><a name="4.f."></a>4.f. Using Attributes in Applications</h4>
+<h4><a name="4.f."></a>4.f. Using Attributes and Session Data in Applications</h4>
<blockquote>
<p>Apart from the simple RM functionality provided, attribute information
may be made available directly to applications via the standard practice of
creating custom HTTP request headers before passing control to the
- application. Applications should make no assumption about the presence of
+ resource. Web applications should make no assumption about the presence of
specific attributes for their use unless they have intimate knowledge of the
attribute release policies in place.</p>
- <p>The AAP metadata controls this interface, and maps a Shibboleth attribute
- to a header name, such as <span class="fixed">Shib-EP-Affiliation</span>.
+ <p>The AAP rules control this interface, and map Shibboleth attributes
+ to header names, such as <span class="fixed">Shib-EP-Affiliation</span>.
Using that example, any values of the mapped attribute will be placed in
that header, delimited by semicolons. An application that uses a CGI-like
syntax to access the header will find the values in the <span class="fixed">
mapped to <span class="fixed">REMOTE_USER</span>. Even so, EPPN may not be
provided by the AA, and <span class="fixed">REMOTE_USER</span> might still
be empty.</p>
- <p>The <span class="fixed">Shib-Origin-Site</span> variable will contain the
- unique name/identifier of the origin site of the user. Some applications may
- use this to lookup additional policy or application data. It normally takes
- the form of a URI but could be any string in some deployments.</p>
- <p>Finally, configuration may instruct the web server to place the entire
- XML message containing the SAML attribute information from the AA into a
- base64-encoded header called <span class="fixed">Shib-Attributes</span>.
- This is a raw interface that provides an application with the entire AA
- response, and is not a filtered view based on any attribute acceptance rules
- or even based on what attributes are recognized by the target. What was sent
- is what you see.</p>
+ <p>In addition to general attribute information, the following special
+ HTTP headers are created for any authenticated request:</p>
+ <dl>
+ <dd class="attribute"><span class="fixed">HTTP_SHIB_ORIGIN_SITE</span></dd>
+ <dd class="value">Contains the unique identifier (providerId) of the
+ origin site of the user. Some applications may use this to lookup
+ additional policy or application data. It normally takes the form of a
+ URI but could be any string in some deployments.</dd>
+ <dd class="attribute"><span class="fixed">HTTP_SHIB-AUTHENTICATION-METHOD</span></dd>
+ <dd class="value">Contains the SAML AuthenticationMethod URI that
+ documents some aspect of the user's authentication to the origin site's
+ web authentication service.</dd>
+ <dd class="attribute"><span class="fixed">HTTP_SHIB_APPLICATION_ID</span></dd>
+ <dd class="value">Contains the XML <span class="fixed">applicationId</span>
+ attribute in <span class="fixed">shibboleth.xml</span> that corresponds to
+ the request based on the <a href="#confRequestMap"><span class="fixed">RequestMap</span></a>
+ and associated elements.</dd>
+ <dd class="attribute"><span class="fixed">HTTP_SHIB_ATTRIBUTES</span></dd>
+ <dd class="value">Contains the assertion in XML containing the
+ SAML attribute information from the AA in base64-encoded format.
+ This is a raw interface that provides an application with the entire
+ assertion in, but is still a filtered view based on any attribute acceptance
+ rules.</dd>
+ </dl>
+ <p>Finally, special support exists to obtain the value of the SAML
+ <span class="fixed"><NameIdentifier></span> element, which identifies the
+ subject of the session, the user. Many Shibboleth deployments use opaque handles
+ that have no application value, however newer deployments may choose to support
+ alternative identifiers, including formats defined by SAML. Targets can use
+ these origins and obtain the primary subject name by using a special AAP
+ <span class="fixed"><AttributeRule></span> with a
+ <span class="fixed">Name</span> corresponding to the SAML
+ <span class="fixed">Format</span> identifier that describes the kind of
+ identifier used to represent the subject. The rule specifies in what header
+ to export the identifier value (such as <span class="fixed">REMOTE_USER</span>),
+ while the <span class="fixed">Format</span> identifier will be placed in the
+ <span class="fixed">HTTP_SHIB_NAMEIDENTIFIER_FORMAT</span> header.
+ </p>
</blockquote>
<h4><a name="4.g."></a>4.g. <span class="fixed">siterefresh</span></h4>
<blockquote>
<p>Shibboleth provides a simple tool called <span class="fixed">siterefresh</span>
in the <span class="fixed">/opt/shibboleth/bin</span> folder of the
distribution to maintain metadata files referenced by <span class="fixed">
- shibboleth.ini</span>. It will return 0 on success and a negative number on
+ shibboleth.xml</span>. It will return 0 only on success and a negative number on
failure and log errors to <span class="fixed">stderr</span>. If the data in
- the new metadata file is bad or the signature is invalid, the existing copy
- is kept. The SHAR and SHIRE stat all metadata files each time the data is
- used, allowing them to detect and utilize updates in real-time operation.</p>
+ the new metadata file is unusable or schema invalid, or the signature is invalid,
+ the existing copy is kept and not overwritten. The SHAR and SHIRE stat all
+ metadata files each time the data is used, allowing them to detect and utilize
+ updates in real-time during system operation.</p>
<p><span class="fixed">siterefresh</span> takes the following command-line
parameters:</p>
<dl>
- <dd class="attribute"><span class="fixed">--url <URL></span> </dd>
+ <dd class="attribute"><span class="fixed">--url <URL></span></dd>
<dd class="value">Specifies the <span class="fixed">URL</span> of the
- remote metadata file with which to update the local file.</dd>
- <dd class="attribute"><span class="fixed">--out <pathname></span> </dd>
+ remote metadata file with which to update the local file. HTTPS is not
+ supported at this time.</dd>
+ <dd class="attribute"><span class="fixed">--out <pathname></span></dd>
<dd class="value">Specifies the local file to which to write the new
metadata.</dd>
- <dd class="attributeopt"><span class="fixed">--cert <pathname></span>
- </dd>
- <dd class="valueopt">Specifies the location of a certificate stored in
+ <dd class="attributeopt"><span class="fixed">--noverify</span></dd>
+ <dd class="value">Explicitly disables the requirement for the file to be signed
+ and allows the certificate parameter to be ommitted. If the file is signed,
+ the signature will be verified using whatever key is supplied inside it,
+ and an invalid signature will still result in an error, but if the file is
+ unsigned or has a valid signature, only a warning will be logged, and the
+ result will be success.</dd>
+ <dd class="attributeopt"><span class="fixed">--cert <pathname></span></dd>
+ <dd class="value">Specifies the location of a certificate stored in
<span class="fixed">PEM</span> format used to validate the signature of
the metadata file. Since much of Shibboleth's security flows from
metadata files, this option is highly recommended, and the certificate
- used should be verified independently.</dd>
- <dd class="attributeopt"><span class="fixed">--schema <pathname></span>
- </dd>
- <dd class="valueopt">Optionally defines a base path for schemas to use
- when validating the file. Defaults to <span class="fixed">
- /opt/shibboleth/etc/shibboleth/</span>.</dd>
+ used should be verified independently in some out of band fashion.</dd>
+ <dd class="attributeopt"><span class="fixed">--schema <pathname></span></dd>
+ <dd class="value">Optionally defines a base path for schemas to use
+ when validating the file. Defaults to a location based on the installation
+ path on Unix, or <span class="fixed">\opt\shibboleth\etc\shibboleth</span>
+ on Windows.</dd>
+ <dd class="attributeopt"><span class="fixed">--rootns <XML namespace></span></dd>
+ <dd class="value">Optionally defines the XML namespace of the root element
+ expected in the new file. Normally unused, provided to support alternative
+ metadata formats that may be backported to older releases.</dd>
+ <dd class="attributeopt"><span class="fixed">--rootname <XML element name></span></dd>
+ <dd class="value">Optionally defines the name of the root element
+ expected in the new file. Normally unused, provided to support alternative
+ metadata formats that may be backported to older releases.</dd>
</dl>
+ <p>If a zero is returned, the command will copy the retrieved file to the output
+ location. Otherwise one of the following error values will be returned:</p>
+ <table align="center" cellspacing="5">
+ <tr><td>-100</td><td>an invalid combination of parameters was specified</td></tr>
+ <tr><td>-10</td><td>the OpenSAML library failed to initialize</td></tr>
+ <tr><td>-1</td><td>the file's XML digital signature was invalid</td></tr>
+ <tr><td>-2</td><td>a SAML exception was trapped</td></tr>
+ <tr><td>-3</td><td>an XML library exception was trapped</td></tr>
+ <tr><td>-4</td><td>a general XML security library exception was trapped</td></tr>
+ <tr><td>-5</td><td>an XML security library crypto exception was trapped</td></tr>
+ <tr><td>-6</td><td>an unknown exception was trapped</td></tr>
+ </table>
<p>A complete command issued to <span class="fixed">siterefresh</span> might
take the form:</p>
<blockquote>
- <p><span class="fixed">/opt/shibboleth/bin/siterefresh --out sites.xml
- --cert internet2.pem \<br>
- --url http://wayf.internet2.edu/InQueue/sites.xml </span></p>
+ <p><span class="fixed">/opt/shibboleth/bin/siterefresh --out IQ-sites.xml --cert internet2.pem \<br>
+ --url http://wayf.internet2.edu/InQueue/IQ-sites.xml </span></p>
</blockquote>
- <p>It is recommended that similar commands be added to a <span class="fixed">
+ <p>It is recommended that such commands be added to a <span class="fixed">
crontab</span> to keep the site and trust files refreshed. AAP files tend to
be site-specific, but could be maintained and distributed centrally. If the
command is invoked in a script that writes the file to a new location and
<blockquote>
<p>Shibboleth includes a useful plugin that extends the default memory cache
for storing session data in the SHAR with a backing cache using an embedded
- MySQL database. In most distributions, it is enabled by default. The plugin
- can be found in the <span class="fixed">/opt/shibboleth/libexec</span>
- folder, and is loaded as an extension library using the <span class="fixed">
- [extensions:saml]</span> section of <span class="fixed">shibboleth.ini</span>.
- The following configuration options are available:</p>
- <dl>
- <dd class="attributeopt"><span class="fixed">mysql-cache-timeout =
- <seconds> (in [shar] section)</span></dd>
- <dd class="valueopt">Specifies the duration in <span class="fixed">
- seconds</span> that must elapse between user accesses before that user's
- session is purged from the persistent cache. Defaults to
- <span class="fixed">28800</span> seconds, or 8 hours. This should
- generally be longer than the associated server's settings for session
- lifetime and timeout, and the memory cache's timeout.</dd>
- <dd class="attributeopt"><span class="fixed"><MySQL Arguments>
- (one per line in [mysql] section)</span></dd>
- <dd class="valueopt">To pass arguments to the MySQL engine, create
- argument lines in the <span class="fixed">[mysql]</span> section in the
- form:
- <blockquote class="fixed">
- <p>arg1=<argument><br>
- arg2=<argument><br>
- etc... </p>
- </blockquote>
- <p>Important arguments you'll find by default include: </p>
+ MySQL database. It is now disabled by default. The plugin can be found in the
+ <span class="fixed">/opt/shibboleth/libexec</span> folder, and is loaded as an
+ extension library using the <a href="#confExtensions"><span class="fixed">Extensions</span></a>
+ element of <span class="fixed">shibboleth.xml</span>. The extension and the
+ <a href="#confMySQLSessionCache"><span class="fixed">MySQLSessionCache</span></a>
+ element are commented out by default.</p>
+ <p>Important <a href="#confArgument"><span class="fixed">Argument</span></a>
+ elements you'll find by default include:</p>
<blockquote class="fixed">
- <p>arg1 = --language=/opt/shibboleth/share/english<br>
- arg2 = --datadir=/opt/shibboleth/data</p>
+ <p>--language=/opt/shibboleth/share/english<br>
+ --datadir=/opt/shibboleth/data</p>
</blockquote>
- <p>which set the message file path and the location of the cache's
+ <p>which set the message file path and the location of the cache's
database files respectively. Make sure the data directory exists before
- starting the SHAR if you change this path.</dd>
+ starting the SHAR if you change this path.
</dl>
</blockquote>
<p><br>
This information is not intended to be comprehensive, but instead rudimentary
guidelines for basic configuration tests and problems. For more detailed
information or answers to specific problems not addressed in this section,
-please mail <a href="mailto:mace-shib-users@internet2.edu">
-mace-shib-users@internet2.edu</a> with a thorough description of errors and
-configurations used.</p>
+please mail <a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>
+with a thorough description of errors and configurations used.</p>
<h4><a name="5.a."></a>5.a. Basic Testing</h4>
<blockquote>
<p>The target may be tested by generating a folder with very basic access
<p><span class="fixed"># Configure a test directory<br>
<Location /secure><br>
AuthType shibboleth<br>
+ ShibRequireSession On<br>
require valid-user<br>
- <br>
- # Per-directory SHIRE Configuration<br>
- #ShibBasicHijack On<br>
- #ShibSSLOnly On<br>
- #ShibAuthLifetime 60<br>
- #ShibAuthTimeout 600<br>
- <br>
- # RM Configuration<br>
- #AuthGroupFile /foo<br>
- #ShibExportAssertion On<br>
</Location><br>
</span></p>
</blockquote>
<p><b>For information regarding specific error messages that may be
generated if the target does not work successfully, please refer to section
<a href="#5.b.">5.b.</a>, or write
- <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>.</b></p>
+ <a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>.</b></p>
</blockquote>
<h4><a name="5.b."></a>5.b. Common Problems</h4>
<blockquote>
<p>A knowledge base is being developed in the
- <a href="http://www.columbia.edu/~wassa/shib.faq/shibboleth-faq.html">
+ <a href="https://umdrive.memphis.edu/wassa/public/shib.faq/shibboleth-faq.html">
Shibboleth Deployer's FAQ</a>. Please mail
- <a href="mailto:mace-shib-users@internet2.edu">mace-shib-users@internet2.edu</a>
+ <a href="mailto:shibboleth-users@internet2.edu">shibboleth-users@internet2.edu</a>
with any additional questions or problems encountered that are not answered
by this basic guide.</p>
</blockquote>
projects / shibboleth / sp.git / commitdiff