-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-
+<!doctype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
- <head>
- <meta name="generator" content=
- "HTML Tidy for Mac OS X (vers 1st January 2002), see www.w3.org">
- <title>Shibboleth Origin Deployment Guide</title>
- <meta http-equiv="Content-Type" content=
- "text/html; charset=utf-8">
- <style type="text/css">
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<title>Shibboleth Origin Deployment Guide</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<style type="text/css">
html
{
{
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
{
-background-color: #DDDDDD;
-background-image: none;
+border-width:2px; background-color: #DDDDDD;
+background-image: url('none');
margin: 5px;
padding: 0px;
border-style: solid;
-border-bottom-width: 2px;
-border-top-width: 2px;
-border-left-width: 2px;
-border-right-width: 2px;
}
dt
{
background-color: #DDDDDD;
-background-image: none;
+background-image: url('none');
margin: 1px;
-padding: 1px;
+padding: 1px
}
dd
{
background-color: #DDDDDD;
-background-image: none;
+background-image: url('none');
margin: 0px;
-padding: 1px;
+padding: 1px
}
.attribute
{
font-color: #000000;
text-align: left;
background-color: #DDDDDD;
-border: 1px black inset;
-background-image: none;
+border: 1px inset black;
+background-image: url('none');
margin: 0px;
-padding: 2px;
+padding: 2px
}
.value
{
font-color: #000000;
text-align: left;
background-color: #EEEEEE;
-background-image: none;
+background-image: url('none');
padding-top: 0em;
padding-bottom: 0.5em;
padding-right: 1em;
padding-left: 5em;
-border-style: solid;
border-bottom-width: none;
border-top-width: none;
border-left-width: 1px;
-border-right-width: 1px;
-}
-.attributeopt
-{
-font-size: 115%;
-font-color: #000000;
-text-align: left;
-background-color: #BCBCEE;
-border: 1px black inset;
-background-image: none;
-margin: 0px;
-padding: 2px;
+border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid
}
-.valueopt
+.mandatory
{
font-color: #000000;
-text-align: left;
-background-color: #DDDDFF;
-background-image: none;
-padding-top: 0em;
-padding-bottom: 0.5em;
-padding-right: 1em;
-padding-left: 5em;
-border-style: solid;
-border-bottom-width: none;
-border-top-width: none;
-border-left-width: 1px;
-border-right-width: 1px;
+background-color: #FFCCFF;
}
.attributelong
{
font-color: #000000;
text-align: left;
background-color: #DDDDDD;
-border: 1px black inset;
-background-image: none;
-margin: 0px;
-padding: 2px;
-}
-.attributeoptlong
-{
-font-size: 85%;
-font-color: #000000;
-text-align: left;
-background-color: #BCBCEE;
-border: 1px black inset;
-background-image: none;
+border: 1px inset black;
+background-image: url('none');
margin: 0px;
-padding: 2px;
+padding: 2px
}
.demo
{
background-color: #EEEEEE;
padding: 3px;
}
-.fixedwidth
+.fixed
{
font-family: monospace;
font-size: 90%;
font-color: #121212;
}
-
- </style>
- </head>
-
- <body link="red" vlink="red" alink="black" bgcolor="white">
- <center>
- <h2>Shibboleth Origin Deployment Guide</h2>
- </center>
- Shibboleth Origin Deployment Guide<br>
- draft-internet2-mace-shibboleth-shib-origin-deploy-30.html<br>
- Nate Klingenstein<br>
- 12 June, 2003<br>
- Comments should be directed to <a href=
- "mailto:ndk@internet2.edu">ndk@internet2.edu</a>.<br>
-
- <h3>This version of the deploy guide is for Shibboleth v1.0. 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.0 is stable and secure enough to deploy in
- production scenarios. While attempts have been made to include all
- functionality that would represent a break of interoperability with
- previous versions in v1.0, be aware that future versions of
- Shibboleth are likely to be developed and may include further
- implementation of the architectural document, functional
- enhancements, and user interface improvements.</p>
-
- <p>Functionality which has been added since the previous
- version (v0.8) includes:</p>
-
- <ul>
- <li>
- <p>Various improvements to error handling. Origin sites are now
- able to supply a URL to a federation for users to be referred to
- when Shibboleth encounters a problem. Targets will be able to
- utilize this URL in error templates.</p>
- </li>
-
- <li>
- <p>The SHAR may now store its session and attribute cache in a
- back-end database in addition to the previously available
- in-memory option. The method by which <span
- class="fixedwidth">sites.xml</span> is refreshed has been
- modified to improve robustness.</p>
- </li>
-
- <li>
- <p>Attribute acceptance policies have been greatly enhanced,
- with filtering of attribute values by sites supported.</p>
- </li>
-
- <li>
- <p>OpenSAML now populates <span
- class="fixedwidth">AuthType</span> element in the SAML Subject
- element using a value specified by origin sites using a
- configuration directive. This value describes the type of
- authentication mechanism used at the origin site(e.g. Kerberos,
- PKI, etc.). This value is made available on the target side as
- another variable that may be used in authorization
- decisions.</p>
- </li>
-
- <li>
- <p>Origin sites whose HS certificate is not signed by one of a
- federation's trusted roots are able to provide that federation
- with the certificate; this cert can now be stored in the sites
- metadata, and targets will be able to use this certificate to
- validate the HS' signature.</p>
- </li>
-
- <li>
- <p>The AA implementation has been improved with a powerful
- attribute resolver. This should greatly simplify the process of
- configuring the AA to support additional general attributes,
- while Java classes may still be written for more complex
- evaluations.</p>
- </li>
-
- </ul>
-
- <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>.
- 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>
- <br>
- <hr>
- <br>
- <br>
-
-
- <h3><a name="TOC"></a>Shibboleth Origin -- Table of
- Contents</h3>
- <br>
-
-
- <ol type="1">
- <li>
- <h4><a href="#1."><font color="black">Shibboleth
- Overview</font></a></h4>
-
- <ol type="a">
- <li><a href="#1.a."><font color=
- "black">Origin</font></a></li>
-
- <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>
- </ol>
- </li>
-
- <li>
- <h4><a href="#2."><font color=
- "black">Planning</font></a></h4>
-
- <ol type="a">
- <li><a href="#2.a."><font color=
- "black">Requirements</font></a></li>
-
- <li><a href="#2.b."><font color="black">Join a
- Federation</font></a></li>
-
- <li><a href="#2.c."><font color="black">Security
- Considerations</font></a></li>
-
- <li><a href="#2.d."><font color="black">Server
- Certs</font></a></li>
-
- <li><a href="#2.e."><font color="black">Attribute Release
- Policies</font></a></li>
-
- <li><a href="#2.f."><font color="black">Designate
- Contacts</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>
- </ol>
- </li>
-
- <li>
- <h4><a href="#3."><font color=
- "black">Installation</font></a></h4>
-
- <ol type="a">
- <li><a href="#3.a."><font color="black">Software
- Requirements</font></a></li>
-
- <li><a href="#3.b."><font color="black">Deploy HS and
- AA</font></a></li>
-
+.feature
+{
+color: #00FF00
+}
+ </style>
+</head>
+
+<body link="red" vlink="red" alink="black" bgcolor="white">
+
+<center>
+<h2>Shibboleth Origin Deployment Guide</h2>
+</center>
+<p>Shibboleth Origin Deployment Guide<br>
+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>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: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>
+<p><br>
+</p>
+<hr>
+<p><br>
+<br>
+</p>
+<h3><a name="TOC"></a>Shibboleth Origin -- Table of Contents</h3>
+<p><br>
+</p>
+<ol type="1">
+ <li>
+ <h4><a href="#1."><font color="black">Shibboleth Overview</font></a></h4>
+ <ol type="a">
+ <li><a href="#1.a."><font color="black">Origin</font></a></li>
+ <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>
+ <h4><a href="#2."><font color="black">Planning</font></a></h4>
+ <ol type="a">
+ <li><a href="#2.a."><font color="black">Requirements</font></a></li>
+ <li><a href="#2.b."><font color="black">Join a Federation</font></a></li>
+ <li><a href="#2.c."><font color="black">Security Considerations</font></a></li>
+ <li><a href="#2.d."><font color="black">Server Certs</font></a></li>
+ <li><a href="#2.e."><font color="black">Attribute Release Policies</font></a></li>
+ <li><a href="#2.f."><font color="black">Designate Contacts</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>
+ </ol>
+ </li>
+ <li>
+ <h4><a href="#3."><font color="black">Installation</font></a></h4>
+ <ol type="a">
+ <li><a href="#3.a."><font color="black">Software Requirements</font></a></li>
+ <li><a href="#3.b."><font color="black">Deploy HS and AA</font></a></li>
+ </ol>
+ </li>
+ <li>
+ <h4><a href="#4."><font color="black">Getting Running</font></a></h4>
+ <ol type="a">
+ <li><a href="#4.a."><font color="black">Basic Configuration</font></a>
+ <ol type="i">
+ <li><a href="#4.a.i"><font color="black">Modifying the default
+ Attribute Resolver configuration</font></a></li>
</ol>
- </li>
-
- <li>
- <h4><a href="#4."><font color="black">Getting
- Running</font></a></h4>
-
- <ol type="a">
- <li><a href="#4.a."><font color="black">Basic
- Configuration</font></a></li>
-
- <li>
- <a href="#4.b."><font color="black">Key Generation and
- Certificate Installation</font></a>
-
- </li>
-
- <li><a href="#4.c."><font color="black">Linking the
- Authentication System to the HS</font></a>
-
- <ol type="i">
- <li><a href="#4.c.i."><font color="black">Enabling client
- certificate authentication</font> <font color="#5555EE">(optional)</font></a></li>
- </ol>
- </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">Modifying the
- default Attribute Resolver configuration</font></a></li>
-
+ </li>
+ <li><a href="#4.b."><font color="black">Key Generation and Certificate
+ Installation</font></a> </li>
+ <li><a href="#4.c."><font color="black">Linking the Authentication
+ System to the HS</font></a>
+ <ol type="i">
+ <li><a href="#4.c.i."><font color="black">Enabling client
+ certificate authentication</font> <font color="#5555EE">(optional)</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">ARP
- Overview</font></a>
-
- <ol type="i">
- <li><a href="#5.a.i."><font color="black">ARP
- Processing</font></a></li>
-
- <li><a href="#5.a.ii."><font color="black">ARP
- Syntax</font></a></li>
- </ol>
- <li><a href="#5.b."><font color="black">Sharing
- certificate/key pairs between Apache and Java
- keystores</font> <font color="#5555EE">(optional)</font></a></li>
- <li><a href="#5.c."><font color="black">The Attribute Resolver</font></a></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="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>
+ <li><a href="#5.b.ii."><font color="black">ARP Syntax</font></a></li>
</ol>
- </li>
-
- <li>
- <h4><a href="#6."><font color=
- "black">Troubleshooting</font></a></h4>
-
- <ol type="a">
- <li><a href="#6.a."><font color="black">Basic
- Testing</font></a></li>
-
- <li><a href="#6.b."><font color=
- "black">Logging</font></a></li>
-
- <li><a href="#6.c."><font color="black">Common
- Problems</font></a></li>
+ </li>
+ <li><a href="#5.c."><font color="black">Sharing certificate/key pairs
+ between Apache and Java keystores</font> <font color="#5555EE">
+ (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="fixed">
+ resolvertest</span></font></a></li>
</ol>
- </li>
+ </li>
+ <li><a href="#5.e."><font color="black">Local Error Page</font></a></li>
+
+ <li><a href="#5.f."><font color="black">Using a New Attribute</font></a></li>
+
</ol>
- <br>
- <hr>
- <br>
-
-
- <h3><a name="1."></a>1. Shibboleth Overview</h3>
-
- <p>Shibboleth is a system designed to exchange attributes
- across realms for the primary purpose of authorization. It
- provides a secure framework for one organization to transmit
- attributes about a web-browsing individual across security
- domains to another institution. In the primary usage case, when
- a user attempts to access a resource at a remote domain, the
- user's own home security domain can send certain information
- about that user to the target site in a trusted exchange. These
- attributes can then be used by the resource to help determine
- whether to grant the user access to the resource. The user may
- have the ability to decide whether to release specific
- attributes to certain sites by specifying personal Attribute
- Release Policies (ARP's), effectively preserving privacy while
- still granting access based on trusted information.</p>
-
- <p>When a user first tries to access a resource protected by
- Shibboleth, they are redirected to a service which asks the
- user to specify the organization from which they want to
- authenticate. If the user has not yet locally authenticated to
- a WebISO service, the user will then be redirected to their
- home institution's authentication system. After the user
- authenticates, the Shibboleth components at the local
- institution will generate a temporary reference to the user,
- known as a handle, for the individual and send this to the
- target site. The target site can then use the handle to ask for
- attributes about this individual. Based on these attributes,
- the target can decide whether or not to grant access to the
- resource. The user may then be allowed to access the requested
- materials.</p>
-
- <p>There are several controls on privacy in Shibboleth, and
- mechanisms are provided to allow users to determine exactly
- which information about them is released. A user's actual
- identity isn't necessary for many access control decisions, so
- privacy often is needlessly compromised. Instead, the resource
- often utilizes other attributes such as faculty member or member
- of a certain class. While these are commonly determined using
- the identity of the user, Shibboleth provides a way to mutually
- refer to the same principal without revealing that principal's
- identity. Because the user is initially known to the target site
- only by a randomly generated temporary handle, if sufficient,
- the target site might know no more about the user than that the
- user is a member of the origin organization. This handle should
- never be used to decide whether or not to grant access, and is
- intended only as a temporary reference for requesting
- attributes.</p>
-
- <h4><a name="1.a."></a>1.a. Origin</h4>
-
- <blockquote>
- <p>There are four primary components to the origin side in
- Shibboleth: the Attribute Authority (AA), the Handle Service
- (HS), the directory service, and the local sign-on system
- (SSO). The AA and HS are provided with Shibboleth, and an
- open-source WebISO solution Pubcookie can be obtained from
- www.pubcookie.org; the directory is provided by the origin
- site. Shibboleth is able to interface with a directory
- exporting an LDAP interface containing user attributes, and is
- designed such that programming interfaces to other
- repositories should be readily implemented. Shibboleth relies
- on standard web server mechanisms to trigger local
- authentication. A .htaccess file can be easily used to trigger
- either the local WebISO system or the web server's own Basic
- Auth mechanism, which will likely utilize an enterprise
- authentication system, such as Kerberos.</p>
-
- <p>From the origin site's point of view, the first contact
- will be the redirection of a user to the handle service,
- which will then consult the SSO system to determine whether
- the user has already been authenticated. If not, then the
- browser user will be asked to authenticate, and then sent
- back to the target URL with a handle bundled in an attribute
- assertion. Next, a request from the Shibboleth Attribute
- Requester (SHAR) will arrive at the AA which will include the
- previously mentioned handle. The AA then consults the ARP's
- for the directory entry corresponding to the handle, queries
- the directory for these attributes, and releases to the SHAR
- all attributes the SHAR is entitled to know about that
- user.</p>
- </blockquote>
-
- <h4><a name="1.b."></a>1.b. Target</h4>
-
- <blockquote>
- <p>There are three primary components to the target side in
- Shibboleth: the Shibboleth Indexical Reference Establisher
- (SHIRE), the Shibboleth Attribute Requester (SHAR), and the
- resource manager (RM). An implementation of each of these is
- included in the standard Shibboleth distribution. These
- components are intended to run on the same web server.</p>
-
- <p>From the target's point of view, a browser will hit the RM
- with a request for a Shibboleth-protected resource. The RM
- then allows the SHIRE to step in, which will use the WAYF to
- acquire the name of a handle service to ask about the user.
- The handle service (HS) will then reply with a SAML
- authentication assertion containing a handle, which the SHIRE
- then hands off to the SHAR. The SHAR uses the handle and the
- supplied address of the corresponding attribute authority
- (AA) to request all attributes it is allowed to know about
- the handle. The SHAR performs some basic validation and
- analysis based on attribute acceptance policies (AAP's).
- These attributes are then handed off to the RM, which is
- responsible for using these attributes to decide whether to
- grant access.</p>
- </blockquote>
-
- <h4><a name="1.c."></a>1.c. Where are you from? (WAYF)</h4>
-
- <blockquote>
- <p>The WAYF service can be either outsourced and operated by
- a federation or deployed as part of the SHIRE. It is responsible
- for allowing a user to associate themself with an institution
- of their specification, then redirecting the user to the
- known address for the handle service of that institution.</p>
- </blockquote>
-
- <h4><a name="1.d."></a>1.d. Federations</h4>
-
- <blockquote>
- <p>A Shibboleth federation provides part of the underlying trust
- required for function of the Shibboleth architecture. A federation
- is a group of organizations(universities, corporations,
- content providers, etc.) who agree to exchange attributes
- using the SAML/Shibboleth protocols and abide by a common set
- of policies and practices. In so doing, they must implicitly
- or explicitly agree to a common set of guidelines. Joining a
- federation is not explicitly necessary for operation of Shibboleth,
- but it dramatically expands the number of targets and origins
- that can interact without defining bilateral agreements
- between all these parties.</p>
-
- <p>A federation can be created in a variety of formats and trust
- models, but must provide a certain set of services to federation
- members. It needs to supply a registry to process
- applications to the federation and distribute membership
- information to the origin and target sites. This must include
- distribution of the PKI components necessary for trust
- between origins and targets. There also needs to be a set of
- agreements and best practices defined by the federation governing
- the exchange, use, and population of attributes before and
- after transit, and there should be a way to find information
- on local authentication and authorization practices for federation
- members.</p>
- </blockquote>
- <br>
- <br>
- <br>
- <hr>
- <br>
-
-
- <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 entirely written in
- Java on the origin side. These are the recommendations and
- requirements for a successful implementation of a Shibboleth
- origin.</p>
-
- <h4><a name="2.a."></a>2.a. Requirements</h4>
-
- <ul>
- <li>
- <p>A common institutional directory service should be
- operational; Shibboleth comes with LDAP capabilities
- built in, and the Attribute Authority has a Java API which
- will allow specification of interfaces with legacy
- directories. This is discussed further in <a href=
- "#4.d.">section 4.d</a>.</p>
- </li>
-
- <li>
- <p>A method to authenticate browser users must be in place,
- preferably in the form of an enterprise authentication
- service. Some form of an SSO or a 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>.</p>
- </li>
-
- <li>
- <p>Shibboleth is known to work on Linux and Solaris, but
- should function on any platform that has a Tomcat
- implementation.</p>
- </li>
-
- <li>
- <p>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.</p>
- </li>
+ </li>
+ <li>
+ <h4><a href="#6."><font color="black">Troubleshooting</font></a></h4>
+ <ol type="a">
+ <li><a href="#6.a."><font color="black">Basic Testing</font></a></li>
+ <li><a href="#6.b."><font color="black">Logging</font></a></li>
+ <li><a href="#6.c."><font color="black">Common Problems</font></a></li>
+ </ol>
+ </li>
+</ol>
+<p><br>
+</p>
+<hr>
+<p><br>
+</p>
+<h3><a name="1."></a>1. Shibboleth Overview</h3>
+<p>Shibboleth is a system designed to exchange attributes across realms for the
+primary purpose of authorization. It provides a secure framework for one
+organization to transmit attributes about a web-browsing individual across
+security domains to another institution. In the primary usage case, when a user
+attempts to access a resource at a remote domain, the user's own home security
+domain can send certain information about that user to the target site in a
+trusted exchange. These attributes can then be used by the resource to help
+determine whether to grant the user access to the resource. The user may have
+the ability to decide whether to release specific attributes to certain sites by
+specifying personal Attribute Release Policies (ARP's), effectively preserving
+privacy while still granting access based on trusted information.</p>
+<p>When a user first tries to access a resource protected by Shibboleth, they
+are redirected to a service which asks the user to specify the organization from
+which they want to authenticate. If the user has not yet locally authenticated
+to a WebISO service, the user will then be redirected to their home
+institution's authentication system. After the user authenticates, the
+Shibboleth components at the local institution will generate a temporary
+reference to the user, known as a handle, for the individual and send this to
+the target site. The target site can then use the handle to ask for attributes
+about this individual. Based on these attributes, the target can decide whether
+or not to grant access to the resource. The user may then be allowed to access
+the requested materials.</p>
+<p>There are several controls on privacy in Shibboleth, and mechanisms are
+provided to allow users to determine exactly which information about them is
+released. A user's actual identity isn't necessary for many access control
+decisions, so privacy often is needlessly compromised. Instead, the resource
+often utilizes other attributes such as faculty member or member of a certain
+class. While these are commonly determined using the identity of the user,
+Shibboleth provides a way to mutually refer to the same principal without
+revealing that principal's identity. Because the user is initially known to the
+target site only by a randomly generated temporary handle, if sufficient, the
+target site might know no more about the user than that the user is a member of
+the origin organization. This handle should never be used to decide whether or
+not to grant access, and is intended only as a temporary reference for
+requesting attributes.</p>
+<h4><a name="1.a."></a>1.a. Origin</h4>
+<blockquote>
+ <p>There are four primary components to the origin side in Shibboleth: the
+ Attribute Authority (AA), the Handle Service (HS), the directory service,
+ and the local sign-on system (SSO). The AA and HS are provided with
+ Shibboleth, and an open-source WebISO solution, Pubcookie, can be obtained
+ from www.pubcookie.org; the directory is provided by the origin site.
+ Shibboleth is able to interface with a directory exporting an LDAP interface
+ containing user attributes, and is designed such that programming interfaces
+ to other repositories should be readily implemented. Shibboleth relies on
+ standard web server mechanisms to trigger local authentication. A .htaccess
+ file can be easily used to trigger either the local WebISO system or the web
+ server's own Basic Auth mechanism, which will likely utilize an enterprise
+ authentication system, such as Kerberos.</p>
+ <p>From the origin site's point of view, the first contact will be the
+ redirection of a user to the handle service, which will then consult the SSO
+ system to determine whether the user has already been authenticated. If not,
+ then the browser user will be asked to authenticate, and then sent back to
+ the target URL with a handle bundled in an attribute assertion. Next, a
+ request from the Shibboleth Attribute Requester (SHAR) will arrive at the AA
+ which will include the previously mentioned handle. The AA then consults the
+ ARP's for the directory entry corresponding to the handle, queries the
+ directory for these attributes, and releases to the SHAR all attributes the
+ SHAR is entitled to know about that user.</p>
+</blockquote>
+<h4><a name="1.b."></a>1.b. Target</h4>
+<blockquote>
+ <p>There are three primary components to the target side in Shibboleth: the
+ Shibboleth Indexical Reference Establisher (SHIRE), the Shibboleth Attribute
+ Requester (SHAR), and the resource manager (RM). An implementation of each
+ of these is included in the standard Shibboleth distribution. These
+ components are intended to run on the same web server.</p>
+ <p>From the target's point of view, a browser will hit the RM with a request
+ for a Shibboleth-protected resource. The RM then allows the SHIRE to step
+ in, which will use the WAYF to acquire the name of a handle service to ask
+ about the user. The handle service (HS) will then reply with a SAML
+ authentication assertion containing a handle, which the SHIRE then hands off
+ to the SHAR. The SHAR uses the handle and the supplied address of the
+ corresponding attribute authority (AA) to request all attributes it is
+ allowed to know about the handle. The SHAR performs some basic validation
+ and analysis based on attribute acceptance policies (AAP's). These
+ attributes are then handed off to the RM, which is responsible for using
+ these attributes to decide whether to grant access.</p>
+</blockquote>
+<h4><a name="1.c."></a>1.c. Where are you from? (WAYF)</h4>
+<blockquote>
+ <p>The WAYF service can be either outsourced and operated by a federation or
+ deployed as part of the SHIRE. It is responsible for allowing a user to
+ associate themself with an institution of their specification, then
+ redirecting the user to the known address for the handle service of that
+ institution.</p>
+</blockquote>
+<h4><a name="1.d."></a>1.d. Federations</h4>
+<blockquote>
+ <p>A Shibboleth federation provides part of the underlying trust required
+ for function of the Shibboleth architecture. A federation is a group of
+ organizations(universities, corporations, content providers, etc.) who agree
+ to exchange attributes using the SAML/Shibboleth protocols and abide by a
+ common set of policies and practices. In so doing, they must implicitly or
+ explicitly agree to a common set of guidelines. Joining a federation is not
+ explicitly necessary for operation of Shibboleth, but it dramatically
+ expands the number of targets and origins that can interact without defining
+ bilateral agreements between all these parties.</p>
+ <p>A federation can be created in a variety of formats and trust models, but
+ must provide a certain set of services to federation members. It needs to
+ supply a registry to process applications to the federation and distribute
+ membership information to the origin and target sites. This must include
+ distribution of the PKI components necessary for trust between origins and
+ targets. There also needs to be a set of agreements and best practices
+ defined by the federation governing the exchange, use, and population of
+ attributes before and after transit, and 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
+to ensure Shibboleth functions well, both political and technical. Shibboleth is
+entirely written in Java on the origin side. These are the recommendations and
+requirements for a successful implementation of a Shibboleth origin.</p>
+<h4><a name="2.a."></a>2.a. Requirements</h4>
+<ul>
+ <li>A common institutional directory service should be operational;
+ Shibboleth comes with LDAP capabilities built in, and the Attribute
+ Authority has a Java API which will allow specification of interfaces with
+ legacy directories. This is discussed further in <a href="#4.d.">section 4.d</a>.</li>
+ <li>A method to authenticate browser users must be in place, preferably in
+ the form of an enterprise authentication service. Some form of an SSO or a
+ 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 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>
+</ul>
+<h4><a name="2.b."></a>2.b. Join a Federation</h4>
+<blockquote>
+ <p>While it is not necessary for a target or origin to join a federation,
+ doing so greatly facilitates the implementation of multilateral trust
+ 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>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>
+ <p>Shibboleth's protocols and software have been extensively engineered to
+ provide protection against many attacks. However, the most secure protocol
+ can be compromised if it is placed in an insecure environment. To ensure
+ Shibboleth is as secure as possible, there are several recommended security
+ precautions which should be in place at local sites.</p>
+ <ol type="i">
+ <li>SSL use is optional for origin sites. Federation guidelines should
+ be considered when determining whether to implement SSL, and, in
+ general, SSL should be used for interactions with client machines to
+ provide the necessary authentication and encryption to ensure protection
+ from man-in-the-middle attacks. It is strongly suggested that all
+ password traffic or similarly sensitive data should be SSL-protected.
+ Assessment of the risk tradeoff against possible performance degradation
+ should be performed for all applications.</li>
+ <li>Many other attacks can be made on the several redirection steps that
+ Shibboleth takes to complete attribute transfer. The best protection
+ 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
+ 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. 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 a campus' other security services, and
+ cookie stores on client machines should be well protected.</li>
+ </ol>
+</blockquote>
+<h4><a name="2.d."></a>2.d. Server Certs</h4>
+<blockquote>
+ <p>In the Shibboleth architecture, the SHIRE, SHAR, HS, and AA 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,
+ which may be stipulated by some Federation rules. Different federations may
+ require the use of different CA's.</p>
+</blockquote>
+<h4><a name="2.e."></a>2.e. Attribute Release Policies</h4>
+<blockquote>
+ <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 URL of the resource on behalf of which it is making the request. 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
+ attributes/values 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 target or set of targets. 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, URL trees for
+ which a rule is applicable.</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. Designate Contacts</h4>
+<blockquote>
+ <p>Since Shibboleth deals both with daily technical and operational issues
+ and also with contractual issues, a set of contacts should be set up to
+ support the user base and to facilitate interactions with other Shibboleth
+ sites and federation members. It is recommended that at least technical and
+ administrative contacts be designated.</p>
+</blockquote>
+<h4><a name="2.g."></a>2.g. Browser Requirements</h4>
+<blockquote>
+ <p>A primary Shibboleth design consideration was to require very little or
+ no modification to client machines. The only requirement is that a browser
+ is used which supports cookies, redirection and SSL. Browser users will have
+ to perform an additional click to submit the authentication assertion if
+ JavaScript is not functional.</p>
+</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
+ against replay attacks. Because of this, any significant degree of clock
+ skew can hinder the ability of users to access sites successfully.</p>
+</blockquote>
+<h4><a name="2.i."></a>2.i. Other Considerations</h4>
+<blockquote>
+ <p>Especially for higher education, there are a handful of laws enacted
+ which may have important ramifications on the disclosure of personal
+ information and attributes. Since Shibboleth does not necessarily need to
+ transmit identity, it is an ideal solution for many higher education
+ situations. Nevertheless, all parties within the United States of America
+ are strongly advised to consult the
+ <a href="http://www.ed.gov/offices/OM/fpco/ferpa/">Family Educational Rights
+ and Privacy Act of 1974(FERPA)</a>, and all other relevant state and federal
+ legislation before deploying Shibboleth.</p>
+</blockquote>
+<p><br>
+<br>
+</p>
+<hr>
+<p><br>
+</p>
+<h3><a name="3."></a>3. Installation</h3>
+<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="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 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 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>
+ </blockquote>
+ </li>
+ <li>An enterprise authentication mechanism
+ <blockquote>
+ <p>Ideally, this will be a WebISO or SSO system such as
+ <a href="http://pubcookie.org/">Pubcookie</a>. The minimal
+ requirement is for the web server to be able to authenticate browser
+ users and supply their identity to the Handle Server.</p>
+ </blockquote>
+ </li>
+ <li>An enterprise directory service
+ <blockquote>
+ <p>Shibboleth currently supports retrieving user attribute
+ information from an <a href="http://www.openldap.org">LDAP</a>
+ directory. For testing purposes, Shibboleth also supports a minimal
+ echo responder which will always return pre-defined attributes.</p>
+ </blockquote>
+ </li>
</ul>
-
- <h4><a name="2.b."></a>2.b. Join a Federation</h4>
-
- <blockquote>
- <p>While it is not necessary for a target or origin to join a
- federation, doing so greatly facilitates the implementation of
- multilateral trust 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>
- </blockquote>
-
- <h4><a name="2.c."></a>2.c. Security Considerations</h4>
-
- <blockquote>
- <p>Shibboleth's protocols and software have been extensively
- engineered to provide protection against many attacks.
- However, the most secure protocol can be compromised if it is
- placed in an insecure environment. To ensure Shibboleth is as
- secure as possible, there are several recommended security
- precautions which should be in place at local sites.</p>
-
- <ol type="i">
- <li>
- <p>SSL use is optional for origin sites. Federation guidelines
- should be considered when determining whether to
- implement SSL, and, in general, SSL should be used for
- interactions with client machines to provide the
- necessary authentication and encryption to ensure
- protection from man-in-the-middle attacks. It is strongly
- suggested that all password traffic or similarly
- sensitive data should be SSL-protected. Assessment of the
- risk tradeoff against possible performance degradation
- should be performed for all applications.</p>
+</blockquote>
+<h4><a name="3.b."></a>3.b. Deploy HS and AA</h4>
+<blockquote>
+ <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="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="fixed">cp /opt/shibboleth-origin-1.2/dist/shibboleth.war
+ /usr/local/tomcat/webapps/</span> </p>
+ </blockquote>
</li>
-
- <li>
- <p>Many other attacks can be made on the several
- redirection steps that Shibboleth takes to complete
- attribute transfer. The best protection 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
- should be considered.</p>
+ <li>Tomcat 4.1.x requires that several Java jarfiles used by Shibboleth
+ 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="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
+ locations in which to place these files or deal with this problem. Refer
+ to your application server's documentation to find out how to properly
+ 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="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="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>
+ <br>
+ JkWorkersFile "/usr/local/tomcat/conf/jk/workers.properties"<br>
+ JkLogFile "/usr/local/apache/logs/mod_jk.log"<br>
+ <br>
+ JkLogLevel emerg<br>
+ <br>
+ JkMount /shibboleth/* ajp13<br>
+ <br>
+ --------- end ---------</span> </p>
+ </blockquote>
</li>
-
- <li>
- <p>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. 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.</p>
+ <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="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="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="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>
+ </ol>
+ </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">httpd.conf</span>:<blockquote>
+ <p><span class="fixed"><Location /shibboleth/AA>
+ <br> SSLVerifyClient optional
+ <br> SSLOptions +StdEnvVars +ExportCertData
+ <br></Location> </span></p>
+ </blockquote>
+ </li>
+ </ol>
+</blockquote>
+<p><br>
+</p>
+<hr>
+<p><br>
+</p>
+<h3><a name="4."></a>4. Getting Running</h3>
+<h4><a name="4.a."></a>4.a. Basic Configuration</h4>
+<blockquote>
+ <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>
+ <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>
+ <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>
- <p>Server platforms should be properly secured,
- commensurate with the level that would be expected for a
- campus' other security services, and cookie stores on
- client machines should be well protected.</p>
+ <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>
-
- <h4><a name="2.d."></a>2.d. Server Certs</h4>
-
+ </ol>
+</blockquote>
+<p><br>
+</p>
+<h4><a name="4.a.i"></a>4.a.i Modifying the default Attribute Resolver
+configuration</h4>
+<blockquote>
+ <p>The resolver.xml file controls the retrieval of attributes from
+ enterprise repositories, and the process of mapping them to Shibboleth/SAML
+ attributes. For more precise information regarding how attributes are
+ processed or syntactically formed, please refer to section <a href="#5.d.">
+ 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="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
+ SimpleAttributeDefinition elements: eduPersonScopedAffiliation and
+ eduPersonPrincipalName.</p>
+ <p>2. The comment indicators should be removed from around the definitions
+ of those two elements ( <!-- and --> ).</p>
+</blockquote>
+<p><br>
+</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, 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="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>In the Shibboleth architecture, the SHIRE, SHAR, HS, and AA
- 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, which may be stipulated by some
- Federation rules. Different federations may require the use of
- different CA's.</p>
+ <p><span class="fixed"><Location /shibboleth/HS><br>
+ AuthType Basic<br>
+ AuthName "Internet2 Handle Service"<br>
+ AuthUserFile /usr/local/apache/conf/user.db<br>
+ require valid-user<br>
+ </Location><br>
+ </span></p>
</blockquote>
-
- <h4><a name="2.e."></a>2.e. Attribute Release Policies</h4>
-
+ <p>Note that .htaccess files cannot be used for this purpose because URL's
+ are "virtualized" by Tomcat.</p>
+ <p>It is recommended that the origin be tested at the end of this process
+ using the process described in section <a href="#6.a.">6.a</a>.</p>
+</blockquote>
+<h4><a name="4.c.i."></a>4.c.i. Enabling client certificate authentication
+<font color="#5555EE">(optional)</font></h4>
+<blockquote>
<blockquote>
- <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
- URL of the resource on behalf of which it is making the
- request. 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 attributes/values 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 target or set
- of targets. 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, URL trees for which a rule is
- applicable.</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.a.i.">5.a.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>
+ <p>Shibboleth supports client certificate authentication by utilization
+ 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="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="fixed"> <filter><br>
+ <filter-name><br>
+ Client Cert AuthN Filter<br>
+ </filter-name><br>
+ <filter-class><br>
+ edu.internet2.middleware.shibboleth.utils.ClientCertTrustFilter<br>
+ </filter-class><br>
+ </filter><br>
+ <br>
+ <br>
+ <filter-mapping><br>
+ <filter-name><br>
+ Client Cert AuthN Filter<br>
+ </filter-name><br>
+ <url-pattern><br>
+ /HS<br>
+ </url-pattern><br>
+ </filter-mapping><br>
+ </span></p>
+ </blockquote>
+ <p>By default, the filter pulls the principal name out of the
+ <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="fixed">regex: '.*CN=([^,/]+).*' match group: 1</span>
+ </p>
+ </blockquote>
+ <p>The servlet filter will accept two initialization parameters,
+ <span class="fixed">regex</span> and <span class="fixed">
+ matchGroup</span> that can be used to extract the principal name
+ differently.</p>
</blockquote>
+</blockquote>
+<h4><a name="4.d."></a>4.d. Establishing default ARP's for the origin community</h4>
+<p><b>For a more basic introduction to ARP's, please refer to section
+<a href="#2.e.">2.e</a>.</b></p>
+<blockquote>
+ <p>An ARP determines which attributes are released to a SHAR when a user
+ tries to access a resource. It acts as a sort of filter on user information
+ contained in the authoritative directory, deciding what can be released to
+ whom, but not modifying or creating information itself. ARP's are generally
+ administered by the site, but Shibboleth will provide for users to broker
+ control of their own information and privacy by allowing them to create
+ ARP's pertaining to themselves.</p>
+ <p>It is recommended that a set of policies be established between an origin
+ and frequently accessed targets to specify default releases of expected
+ attributes. Federation guidelines may provide more information on population
+ of ARP's.</p>
+ <p>Currently, there is no direct mechanism for users to create their own
+ ARP's besides direct XML writing. In future versions, a GUI will be provided
+ for simpler management of ARP's. Care should be given to balancing giving
+ sufficient control over information to users and avoiding access problems.
+ For example, users may decide to restrict the release of their personal
+ information to such a degree that access to a site for a class may become
+ impossible because Shibboleth cannot release enough information to grant
+ access.</p>
+ <p>The Shibboleth distribution contains an example site arp that releases
+ the eduPersonScopedAffiliation attribute to all targets. For more precise
+ 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>5.a. <span class="fixed">origin.xml</span></h4>
+<blockquote>
+ <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="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>
- <h4><a name="2.f."></a>2.f. Designate Contacts</h4>
-
+ <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">
+ <tr>
+ <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="fixed">urn:ietf:rfc:1510</span></td>
+ <td>The authentication was performed using Kerberos.</td>
+ </tr>
+ <tr>
+ <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></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>
+</p>
+<h4><a name="5.b."></a>5.b. ARP Overview</h4>
+<blockquote>
+ <h5>This section applies primarily to the syntactic and technical details of
+ ARP's. For basic information on and explanation of what an ARP is and how it
+ should be managed, please refer to sections <a href="#2.e.">2.e</a> and
+ <a href="#4.d.">4.d</a>.</h5>
+ <p>Every ARP file contains one ARP. ARP's may be specified either as the
+ site ARP or user ARP's. The site ARP pertains to every principal for whom
+ 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="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
+ 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 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
+ of the effective ARP.</p>
+</blockquote>
+<h4><a name="5.b.i."></a>5.b.i. ARP Processing</h4>
+<blockquote>
<blockquote>
- <p>Since Shibboleth deals both with daily technical and
- operational issues and also with contractual issues, a set of
- contacts should be set up to support the user base and to
- facilitate interactions with other Shibboleth sites and federation
- members. It is recommended that at least technical and
- administrative contacts be designated.</p>
+ <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 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:
+ <ol type="i">
+ <li>Any ARP rules within the identified ARP's designated as
+ defaults are automatically included in the effective ARP without
+ performing any matching functions.</li>
+ <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 providerId on behalf of which the SHAR is
+ making the request.</li>
+ <li>Each matching function evaluates to <span class="fixed">
+ TRUE</span> if the match is successful or
+ <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>
+ <li>Construct the Attribute Filter:
+ <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="fixed">permit</span>.</li>
+ <li>Subtract from this list all attribute values with rules
+ 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="fixed">deny</span>
+ qualifiers for specific values should still be enforced. If a
+ statement specifies that all values should be denied, then
+ <span class="fixed">permit</span> qualifiers for specific
+ values will be ignored.</li>
+ </ol>
+ </li>
+ <li>Using the mask and attributes returned from the Attribute
+ Resolver, an assertion is constructed.</li>
+ </ol>
</blockquote>
-
- <h4><a name="2.g."></a>2.g. Browser Requirements</h4>
-
+</blockquote>
+<h4><a name="5.b.ii."></a>5.b.ii. ARP Syntax</h4>
+<blockquote>
<blockquote>
- <p>A primary Shibboleth design consideration was to require
- very little or no modification to client machines. The only
- requirement is that a browser is used which supports cookies,
- redirection and SSL. Browser users will have to perform an
- additional click to submit the authentication assertion if
- JavaScript is not functional.</p>
+ <p>Each ARP is described by an XML file based on a standard
+ <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="fixed">eduPersonScopedAffiliation</span> to any target
+ for the users the ARP applies to:</p>
+ <blockquote>
+ <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>
+ <Description>Simplest possible
+ ARP.</Description><br>
+ <Rule><br>
+
+ <Target><br>
+
+ <AnyTarget/><br>
+
+ </Target><br>
+
+ <Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
+
+ <AnyValue release= "permit"/><br>
+
+ </Attribute ><br>
+ </Rule ><br>
+ </AttributeReleasePolicy><br>
+ </span></p>
+ </blockquote>
</blockquote>
-
- <h4><a name="2.h."></a>2.h. Clocks</h4>
-
+ <p>All ARP's must take the same basic form. A detailed description of how
+ each element of the <span class="fixed">Rule</span> element may be
+ sub-populated follows:</p>
+ <p>The <span class="fixed">Target</span> element:</p>
<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 against replay attacks. Because of
- this, any significant degree of clock skew can hinder the
- ability of users to access sites successfully.</p>
+ <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="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="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="fixed">
+ urn:mace:shibboleth:arp:matchFunction:exactShar </span>
+ <blockquote>
+ <p>May be used with the <span class="fixed">Requester</span>
+ element.</p>
+ <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="fixed">Requester</span> if none is specified.</p>
+ </blockquote>
+ </li>
+ <li><span class="fixed">
+ urn:mace:shibboleth:arp:matchFunction:resourceTree </span>
+ <blockquote>
+ <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="fixed">Resource</span>
+ element. Otherwise evaluates to <span class="fixed">FALSE</span>.</p>
+ </blockquote>
+ </li>
+ <li><span class="fixed">
+ urn:mace:shibboleth:arp:matchFunction:regexMatch </span>
+ <blockquote>
+ <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="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>
+ </blockquote>
+ </li>
+ </ul>
</blockquote>
-
- <h4><a name="2.i."></a>2.i. Other Considerations</h4>
-
+ <p>The <span class="fixed">Attribute</span> element:</p>
<blockquote>
- <p>Especially for higher education, there are a handful of
- laws enacted which may have important ramifications on the
- disclosure of personal information and attributes. Since
- Shibboleth does not necessarily need to transmit identity, it
- is an ideal solution for many higher education situations.
- Nevertheless, all parties within the United States of America
- are strongly advised to consult the <a href=
- "http://www.ed.gov/offices/OM/fpco/ferpa/">Family Educational
- Rights and Privacy Act of 1974(FERPA)</a>, and all other
- relevant state and federal legislation before deploying
- Shibboleth.</p>
+ <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="fixed">
+ AnyValue</span> element or one or more <span class="fixed">Value</span>
+ elements. These elements, in turn, must specify either
+ <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="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="fixed">
+ eduPersonPrincipalName</span> with any value.</p>
+ </blockquote>
+ <blockquote>
+ <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="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="fixed">permit</span>
+ ARP.</p>
+ </blockquote>
</blockquote>
- <br>
- <br>
- <hr>
- <br>
-
-
- <h3><a name="3."></a>3. Installation</h3>
-
- <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>
-
- <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>
-
- <li>
- <a href="http://java.sun.com/j2se/">Sun J2SE v 1.4.1_01 SDK</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
-
- <blockquote>
- <p>You may need to build mod_jk against Apache, which
- will generally require GCC or a platform-specific C
- compiler.</p>
- </blockquote>
- </li>
-
- <li>
- An enterprise authentication mechanism
-
- <blockquote>
- <p>Ideally, this will be a WebISO or SSO system such as
- <a href= "http://pubcookie.org/">Pubcookie</a>. The
- minimal requirement is for the web server to be able to
- authenticate browser users and supply their identity to
- the Handle Server.</p>
- </blockquote>
- </li>
-
- <li>
- An enterprise directory service
-
- <blockquote>
- <p>Shibboleth currently supports retrieving user
- attribute information from an <a href=
- "http://www.openldap.org">LDAP</a> directory. For
- testing purposes, Shibboleth also supports a minimal
- echo responder which will always return two pre-defined
- attributes.</p>
- </blockquote>
- </li>
- </ul>
- </blockquote>
-
- <h4><a name="3.b."></a>3.b. Deploy HS and AA</h4>
-
- <blockquote>
- <ol type="1">
- <li>
- <p>Ensure you have already obtained the proper <a href=
- "http://shibboleth.internet2.edu/release/shib-download.html">.tarball</a>.</p>
- </li>
-
- <li>
- <p>The archive will expand into a <span class="fixedwidth">shibboleth-origin-1.0/</span>
- directory(<span class="fixedwidth">/usr/local/</span> recommended).</p>
- </li>
-
- <li>
- <p>Run the following command to move the Java files into
- Tomcat's tree:</p>
-
- <blockquote>
- <span class="fixedwidth">cp /usr/local/shibboleth-origin-1.0/dist/shibboleth.war
- /usr/local/tomcat/webapps/</span>
- </blockquote>
- </li>
-
- <li>
- <p>Tomcat 4.1.x requires that several Java jarfiles used
- by Shibboleth 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:</p>
- <blockquote>
- <span class="fixedwidth">$ cp /usr/local/shibboleth-origin-1.0/endorsed/*.jar /usr/local/tomcat/common/endorsed</span>
- </blockquote>
- <p>Different versions of Tomcat or other Java servers may have
- other locations in which to place these files or deal with this
- problem. Refer to your application server's documentation to
- find out how to properly endorse classes, if necessary.</p>
- </li>
-
- <li>
- <p>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>.</p>
- </li>
-
- <li>
- <p>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="fixedwidth">/etc/httpd/conf/mod_jk.conf</span>:</p>
-
- <blockquote>
- <span class="fixedwidth">--------- begin ---------<br>
- <IfModule !mod_jk.c><br>
- LoadModule jk_module libexec/mod_jk.so<br>
- </IfModule><br>
- <br>
- JkWorkersFile
- "/usr/local/tomcat/conf/jk/workers.properties"<br>
- JkLogFile "/usr/local/apache/logs/mod_jk.log"<br>
- <br>
- JkLogLevel emerg<br>
- <br>
- JkMount /shibboleth/* ajp13<br>
- <br>
- --------- end ---------</span>
- </blockquote>
- </li>
-
- <li>
- <p>Tomcat's <span class="fixedwidth">/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">REMOTE_USER</span>. This connector must be
- commented out. Then, uncomment and modify the traditional AJP
- 1.3 connector as follows:</p>
-
- <ol type="A">
- <li>
- <p>Add <span class="fixedwidth">address="127.0.0.1"</span> inside the
- <span class="fixedwidth"><Ajp13Connector></span> configuration
- element to prevent off-host access.</p>
- </li>
-
- <li>
- <p>Add <span class="fixedwidth">tomcatAuthentication="false"</span> to the
- <span class="fixedwidth"><Ajp13Connector></span> configuration element
- to ensure that the user's identity is passed from
- Apache to the servlet environment.</p>
- </li>
- </ol>
- </li>
- </ol>
- </blockquote>
- <br>
- <hr>
- <br>
-
-
- <h3><a name="4."></a>4. Getting Running</h3>
-
- <h4><a name="4.a."></a>4.a. Basic Configuration</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>
-
- <br>
- <p>General Configuration:</p>
-
- <dl>
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer
- = <domain name></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the DNS name the HS should use for
- itself in issuing assertions.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName
- = <URI></span>
- </dd>
-
- <dd class="value">
- <p>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.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl
- = <url></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the <span class="fixedwidth">URL</span>
- at which the HS' corresponding AA may be
- contacted.</p>
- </dd>
-
- <dd class="attributeoptlong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.username
- = <var></span>
- </dd>
-
- <dd class="valueopt">
- <p>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>.</p>
- </dd>
-
- <dd class="attributeoptlong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.authMethod
- = <uri></span>
- </dd>
-
- <dd class="valueopt">
- <p>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 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.</p>
- <table border=2 cellpadding=0 cellspacing=0>
- <tr>
- <td><span class="fixedwidth">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>The authentication was performed using Kerberos.</td>
- </tr>
- <tr>
- <td><span class="fixedwidth">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>
-
- <br>
- <p>Assertion Signing:</p>
-
- <dl>
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath
- = <pathname></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the location of the Java keystore
- containing the x.509 certificate and matching private
- key to be used by the HS.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword
- = <password></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the password to the referenced
- keystore.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias
- = <alias></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the alias used for accessing the private
- key.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword
- = <password></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the password used to retrieve the private key.</p>
- </dd>
-
- <dd class="attributeoptlong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias
- = <alias></span>
- </dd>
-
- <dd class="valueopt">
- <p>Specifies the alias for the certificate
- corresponding to the private key used by the HS.
- Defaults to the private key's alias.</p>
- </dd>
- </dl>
- <br>
-
- <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">
- <p>Specifies the name of the AA, which is typically
- the domain name of the server running it.</p>
- </dd>
-
- <dd class="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors
- = <true/false></span>
- </dd>
-
- <dd class="value">
- <p>Specifies whether the AA should pass on internal errors
- to the SHAR for debugging purposes. Defaults to <span
- class="fixedwidth">false</span>.</p>
- </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">
- <p>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>.</p>
- </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">
- <p>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>
-
- <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="attributelong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path
- = <pathname></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the relative or absolute path to the
- folder containing the ARP files.</p>
- </dd>
-
- <dd class="attributeoptlong">
- <span class="fixedwidth">edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.ArpTTL
- = <seconds></span>
- </dd>
-
- <dd class="valueopt">
- <p>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.</p>
- </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">
- <p>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>.</p>
- </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">
- <p>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.</p>
- </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">
- <p>Specifies the path to the keystore containing the
- key used to encrypt passed principal identifiers.</p>
- </dd>
-
- <dd class="attributelong">
-<span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePassword
- = <password></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the password for the keystore.</p>
- </dd>
-
- <dd class="attributelong">
-<span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyAlias
- = <password></span>
- </dd>
-
- <dd class="value">
- <p>Specifies the alias for the appropriate encryption
- key within the keystore.</p>
- </dd>
-
- <dd class="attributelong">
-<span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyPassword
- = <password></span>
- </dd>
-
- <dd class="valueopt">
- <p>Specifies the password used to retrieve the key.</p>
- </dd>
-
- <dd class="attributeoptlong">
-<span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.CryptoHandleRepository.handleTTL
- = <seconds></span>
- </dd>
-
- <dd class="valueopt">
- <p>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.</p>
- </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">
- <p>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>
-
- <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>
- </dl>
-
- </blockquote>
- <br>
-
-
- <h4><a name="4.b."></a>4.b. Key Generation and Certificate
- Installation</h4>
-
+</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 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>
- <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>
- </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>
- <span class="fixedwidth">$ keytool -certreq -keystore keystore.jks -alias hs
- -file <csr-file><br>
- </span>
- </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>
- <span class="fixedwidth">$ keytool -import -keystore keystore.jks -alias hs
- -file <cert-file></span>
- </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.b.">5.b.</a>.</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>, 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>
- <span class="fixedwidth"><Location /shibboleth/HS><br>
- AuthType Basic<br>
- AuthName "Internet2 Handle Service"<br>
- AuthUserFile /usr/local/apache/conf/user.db<br>
- require valid-user<br>
- </Location><br>
- </span>
- </blockquote>
-
- <p>Note that .htaccess files cannot be used for this purpose
- because URL's are "virtualized" by Tomcat.</p>
-
- <p>It is recommended that the origin be tested at the end of
- this process using the process described in section <a href=
- "#6.a.">6.a</a>.</p>
- </blockquote>
-
- <h4><a name="4.c.i."></a>4.c.i. Enabling client certificate
- authentication <font color="#5555EE">(optional)</font></h4>
-
- <blockquote>
- <blockquote>
-
- <p>Shibboleth supports client certificate authentication by
- utilization 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>
-
- <blockquote>
- <span class="fixedwidth"> <filter><br>
- <filter-name><br>
- Client Cert AuthN Filter<br>
- </filter-name><br>
- <filter-class><br>
- edu.internet2.middleware.shibboleth.utils.ClientCertTrustFilter<br>
- </filter-class><br>
- </filter><br>
- <br>
- <br>
- <filter-mapping><br>
- <filter-name><br>
- Client Cert AuthN Filter<br>
- </filter-name><br>
- <url-pattern><br>
- /HS<br>
- </url-pattern><br>
- </filter-mapping><br></span>
- </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
- grouping. This may be done using patterns such as:</p>
-
- <blockquote>
- <span class="fixedwidth">regex: '.*CN=([^,/]+).*' match group: 1</span>
- </blockquote>
-
- <p>The servlet filter will accept two initialization parameters,
- <span class="fixedwidth">regex</span> and <span
- class="fixedwidth">matchGroup</span> that can be used to extract
- the principal name differently.</p>
-
- </blockquote>
- </blockquote>
-
- <h4><a name="4.d."></a>4.d. Establishing default ARP's for the
- origin community</h4>
-
- <p><b>For a more basic introduction to ARP's, please refer to
- section <a href="#2.e.">2.e</a>.</b></p>
-
- <blockquote>
- <p>An ARP determines which attributes are released to a SHAR
- when a user tries to access a resource. It acts as a sort of
- filter on user information contained in the authoritative
- directory, deciding what can be released to whom, but not
- modifying or creating information itself. ARP's are generally
- administered by the site, but Shibboleth will provide for users to
- broker control of their own information and privacy by
- allowing them to create ARP's pertaining to themselves.</p>
-
- <p>It is recommended that a set of policies be established
- between an origin and frequently accessed targets to specify
- default releases of expected attributes. Federation guidelines may
- provide more information on population of ARP's.</p>
-
- <p>Currently, there is no direct mechanism for users to create
- their own ARP's besides direct XML writing. In future
- versions, a GUI will be provided for simpler management of
- ARP's. Care should be given to balancing giving sufficient
- control over information to users and avoiding access
- problems. For example, users may decide to restrict the
- release of their personal information to such a degree that
- access to a site for a class may become impossible because
- Shibboleth cannot release enough information to grant
- access.</p>
-
- <p>The Shibboleth distribution contains an example site arp that
- releases the eduPersonScopedAffiliation attribute to all targets. For
- more precise information regarding how ARP's are processed or
- syntactically formed, please refer to section <a href="#5.a.i.">5.a.i</a>.</p>
- </blockquote>
-
- <h4><a name="4.e."></a>4.e. Modifying the default Attribute Resolver configuration</h4>
- <blockquote>
- <p>The resolver.xml file controls the retrieval of attributes from enterprise repositories, and the process of mapping them to Shibboleth/SAML attributes. For more precise information regarding how attributes are processed or syntactically formed, please refer to section <a href="#5.c.">5.c.</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> 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 SimpleAttributeDefinition elements: eduPersonScopedAffiliation and eduPersonPrincipalName.</p>
-
- <p>2. The comment indicators should be removed from around the definitions of those two elements ( <!-- and --> ).</p>
- </blockquote>
- <br>
- <hr>
- <br>
-
- <h3><a name="5."></a>5. Advanced Configuration</h3>
-
- <h4><a name="5.a."></a>5.a. ARP Overview</h4>
-
- <blockquote>
- <h5>This section applies primarily to the syntactic and
- technical details of ARP's. For basic information on and
- explanation of what an ARP is and how it should be managed,
- please refer to sections <a href="#2.e.">2.e</a> and <a href=
- "#4.d.">4.d</a>.</h5>
-
- <p>Every ARP file contains one ARP. ARP's may be specified either
- as the site ARP or user ARP's. The site ARP pertains to every
- principal for whom 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 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>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 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 of the effective ARP.</p>
-
- <!-- ##To be included in future releases of the deploy guide.
-
- <dl>
- <dd class="demo">
- <img src="arp.gif">
- </dd>
- <dd class="demo">
- <p>In this picture, meant to demonstrate the structure
- of ARP's, if all ARP's are taken to mean "Release this
- attribute," then attributes 1-4 will be released if that
- principal tries to access site A. ARP #1 could not
- restrict the release of attribute 4 to site A.</p>
- </dd>
- </dl>
-
- -->
-
- </blockquote>
-
- <h4><a name="5.a.i."></a>5.a.i. ARP Processing</h4>
-
- <blockquote>
- <blockquote>
- <p>When a request arrives from a particular SHAR, 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> that have the
- name either arp.site.xml or arp.user.$PRINCIPALNAME.xml.</li>
- <li>Find all ARP rules relevant to the query:
- <ol type=i>
- <li>Any ARP rules within the identified ARP's designated
- as defaults are automatically included in the effective
- ARP without performing any matching functions.</li>
- <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 making the request.</li>
- <li>Each matching function evaluates to <span class="fixedwidth">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>, the rule is included in the Effective
- ARP.</li>
- </ol></li>
- <li>Construct the Attribute Filter:
- <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>
- <li>Subtract from this list all attribute values with
- rules specifying a release qualifier of <span class="fixedwidth">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> 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 values will
- be ignored.</li>
- </ol></li>
- <li>Using the mask and attributes returned from the
- Attribute Resolver, an assertion is constructed.</li>
- </ol>
- </blockquote>
- </blockquote>
-
-
- <h4><a name="5.a.ii."></a>5.a.ii. ARP Syntax</h4>
-
- <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">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 for the
- users the ARP applies to:</p>
-
- <blockquote>
- <span class="fixedwidth">
- <?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>
-
-
- <Description>Simplest possible
- ARP.</Description><br>
-
-
- <Rule><br>
-
-
- <Target><br>
-
-
-
- <AnyTarget/><br>
-
-
- </Target><br>
-
-
- <Attribute
- name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
-
-
-
- <AnyValue release=
- "permit"/><br>
-
-
- </Attribute
- ><br>
-
- </Rule
- ><br>
-
- </AttributeReleasePolicy><br>
-
- </span>
- </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 sub-populated follows:</p>
-
- <p>The <span class="fixedwidth">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 matches to be performed against
- the requested URL.</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 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
- matchFunction="urn:mace:shibboleth:arp:matchFunction:regexMatch"></span>:</p>
-
- <ul type=disc>
- <li>
- <p><span class="fixedwidth">urn:mace:shibboleth:arp:matchFunction:exactShar
- </span></p>
- <blockquote>
- <p>May be used with the <span class="fixedwidth">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>. Serves as the default value
- associated with <span class="fixedwidth">Requester</span> if none is
- specified.</p>
- </blockquote>
- </li>
- <li>
- <p><span class="fixedwidth">urn:mace:shibboleth:arp:matchFunction:resourceTree
- </span></p>
- <blockquote>
- <p>May be used with the <span class="fixedwidth">Resource</span> element.</p>
-
- <p>Evaluates to <span class="fixedwidth">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>
- </blockquote>
- </li>
- <li>
- <p><span class="fixedwidth">urn:mace:shibboleth:arp:matchFunction:regexMatch
- </span></p>
- <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
- match of the regular expression represented as the
- content of the containing element. Otherwise evaluates
- to <span class="fixedwidth">FALSE</span>. Regular expressions are evaluated in
- accordance with the the <a
- href="http://java.sun.com/j2se/1.4/docs/api/java/util/
- regex/Pattern.html#sum">Java 1.4 Pattern API</a>.</p>
- </blockquote>
- </li>
- </ul>
-
- </blockquote>
-
- <p>The <span class="fixedwidth">Attribute</span> element:</p>
-
- <blockquote>
-
- <p>The <span class="fixedwidth">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> 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 value for which the rule
- applies. Examples:</p>
-
- <blockquote>
- <span class="fixedwidth">
- <Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName"><br>
- <AnyValue release="Permit"><br>
- </Attribute><br>
- </span><br>
- <p>Permits the release of <span class="fixedwidth">eduPersonPrincipalName</span>
- with any value.</p>
- </blockquote>
-
- <blockquote>
- <span class="fixedwidth">
- <Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"><br>
- <Value release="deny">member@example.edu</Value><br>
- </Attribute><br>
- </span><br>
- <p>Denies the release of
- <span class="fixedwidth">eduPersonScopedAffiliation</span> value
- <span class="fixedwidth">member@example.edu</span>. Other values of the
- attribute may still be released if so specified by a
- <span class="fixedwidth">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.b."></a>5.b. 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">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">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 variable
- SHIB_HOME must be set to the path to the directory where the
- Shibboleth tarball was exploded(typically
- /usr/local/shibboleth-origin-1.0/).</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>
-
+ <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="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="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.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>
- <p>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 following command should
- present a list of the entries in the keystore.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ keytool -list -v -keystore
- yourstore</span></p>
+ <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="fixed">yourstore</span>, the
+ following command should present a list of the entries in the
+ keystore.<blockquote>
+ <p><span class="fixed">$ keytool -list -v -keystore
+ yourstore</span></p>
</blockquote>
- </li>
-
- <li>
- <p>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 following command to
- export the key in Base64-encoded pkcs8 format.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ extkeytool -exportkey -keystore yourstore
- -alias youralias -storepass yourpass -rfc -file
- yourkey.pkcs8</span></p>
+ </li>
+ <li>Assuming that you identified the appropriate alias as
+ <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="fixed">$ extkeytool -exportkey -keystore
+ yourstore -alias youralias -storepass yourpass -rfc -file
+ yourkey.pkcs8</span></p>
</blockquote>
- </li>
-
- <li>
- <p>In order to use this key with Apache, you must
- convert it to PEM-encoded RSA native format. You have
- the option of storing the key unencrypted or
- encrypted:</p>
-
- <ol type="A">
- <li>
- <p>To use the unencrypted format, enter the
- following command for the conversion:</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in yourkey.pkcs8
- -nocrypt|openssl rsa -out yourkey.key</span></p>
+ </li>
+ <li>In order to use this key with Apache, you must convert it to PEM-encoded
+ RSA native format. You have the option of storing the key
+ unencrypted or encrypted:<ol type="A">
+ <li>To use the unencrypted format, enter the following command
+ for the conversion:<blockquote>
+ <p><span class="fixed">$ openssl pkcs8 -in
+ yourkey.pkcs8 -nocrypt|openssl rsa -out yourkey.key</span></p>
</blockquote>
- </li>
-
- <li>
- <p>To use the encrypted format, enter the following
- command for the conversion:</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in yourkey.pkcs8
- -nocrypt|openssl rsa -des3 -out
- yourkey.enckey</span></p>
+ </li>
+ <li>To use the encrypted format, enter the following command for
+ the conversion:<blockquote>
+ <p><span class="fixed">$ openssl pkcs8 -in
+ yourkey.pkcs8 -nocrypt|openssl rsa -des3 -out yourkey.enckey</span></p>
</blockquote>
- </li>
+ </li>
</ol>
- </li>
-
- <li>
- <p>The following command will export the corresponding
- certificate.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ keytool -export -keystore yourstore -alias
- youralias -rfc -file yourcert</span></p>
+ </li>
+ <li>The following command will export the corresponding certificate.<blockquote>
+ <p><span class="fixed">$ keytool -export -keystore
+ yourstore -alias youralias -rfc -file yourcert</span></p>
</blockquote>
- </li>
-
- <li>
- <p>Set the <span class="fixedwidth">mod_ssl</span>
- <span class="fixedwidth">SSLCertificateKeyFile</span> and
- <span class="fixedwidth">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">yourkey.pkcs8</span>) and set appropriate file
- permissions, especially if you chose to store the key
- in an unencrypted format.</p>
- </li>
+ </li>
+ <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="fixed">
+ yourkey.pkcs8</span>) and set appropriate file permissions,
+ especially if you chose to store the key in an unencrypted format.</li>
</ol>
-
- <p><b>If you have a pre-existing RSA key/certificate
- combination that you use with Apache and would like to
- import it into a java keystore:</b></p>
-
+ <p><b>If you have a pre-existing RSA key/certificate combination that
+ you use with Apache and would like to import it into a java keystore:</b></p>
<ol type="1">
- <li>
- <p>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 command.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ openssl pkcs8 -in yourkey.enckey -topk8
- -nocrypt -outform DER -out yourkey.der.pkcs8</span></p>
+ <li>Convert the private key to unencrypted DER-encoded pkcs8 format.
+ Assuming your PEM-encoded key is stored in a file named
+ <span class="fixed">yourkey.enckey</span>, enter the following
+ command.<blockquote>
+ <p><span class="fixed">$ openssl pkcs8 -in yourkey.enckey
+ -topk8 -nocrypt -outform DER -out yourkey.der.pkcs8</span></p>
</blockquote>
- </li>
-
- <li>
- <p>Create a certificate bundle file. This file should
- include a 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">ca.cert</span>, you might
- enter the following command to create the bundle.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ cat mycert ca.cert > cert.bundle</span></p>
+ </li>
+ <li>Create a certificate bundle file. This file should include a
+ 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="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="fixed">$ cat mycert ca.cert > cert.bundle</span></p>
</blockquote>
-
- <b>Note: <span class="fixedwidth">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>
- directory.</b>
- </li>
-
- <li>
- <p>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">yourpass</span>, enter the following command to store
- the data under the alias <span class="fixedwidth">youralias</span>.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ ./extkeytool -importkey -keystore yourstore
- -alias youralias -storepass yourpass -keyfile
- yourkey.der.pkcs8 -certfile cert.bundle -provider
- org.bouncycastle.jce.provider.BouncyCastleProvider</span></p>
+ <p><b>Note: <span class="fixed">mod_ssl</span>-enabled Apache
+ installations include a number of commonly recognized CA
+ 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="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">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>
</blockquote>
- </li>
-
- <li>
- <p>You can verify that the import was successful by
- listing entry. Use the command below.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ keytool -list -v -keystore yourstore -alias
- youralias</span></p>
+ </li>
+ <li>You can verify that the import was successful by listing entry.
+ Use the command below.<blockquote>
+ <p><span class="fixed">$ keytool -list -v -keystore
+ yourstore -alias youralias</span></p>
</blockquote>
- </li>
-
- <li>
- <p>Remember to delete <span class="fixedwidth">yourkey.der.pkcs8</span>, as it
- contains your unencrypted private key.</p>
- </li>
+ </li>
+ <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>
-
+ <p><b>If you are starting from scratch and do not yet have a
+ certificate/key pair:</b></p>
<ol type="1">
- <li>
- <p>Generate an RSA private key. Use the command below,
- substituting <span class="fixedwidth">yourkey</span> with an appropriate name
- to use to refer to the key.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ openssl genrsa -des3 -out yourkey.enckey
- 1024</span></p>
+ <li>Generate an RSA private key. Use the command below, substituting
+ <span class="fixed">yourkey</span> with an appropriate name to
+ use to refer to the key.<blockquote>
+ <p><span class="fixed">$ openssl genrsa -des3 -out
+ yourkey.enckey 1024</span></p>
</blockquote>
- </li>
-
- <li>
- <p>The following command generates a Certificate
- Signing Request, which should be communicated to a
- Certificate Authority.</p>
-
- <blockquote>
- <p><span class="fixedwidth">$ openssl req -new -key
- yourkey.enckey</span></p>
+ </li>
+ <li>The following command generates a Certificate Signing Request,
+ which should be communicated to a Certificate Authority.<blockquote>
+ <p><span class="fixed">$ openssl req -new -key
+ yourkey.enckey</span></p>
</blockquote>
- </li>
-
- <li>
- <p>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 point to
- the key file you just created and the
- <span class="fixedwidth">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.</p>
- </li>
+ </li>
+ <li>The Certificate Authority should respond with a PEM-encoded X509
+ 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="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>
</ol>
- </blockquote>
</blockquote>
-
- <br>
- <h4><a name="5.c."></a>5.c. The Attribute Resolver</h4>
-
+</blockquote>
+<p><br>
+</p>
+<h4><a name="5.d."></a>5.d. The Attribute Resolver</h4>
+<blockquote>
+ <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="fixed">
+ edu.internet2.middleware.shibboleth.aa.
+ attrresolv.AttributeResolver.ResolverConfig</span> propety in
+ <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>
+ <p>The resolver is essentially a directed graph from attribute definitions
+ to data connectors. The data connectors pull data, in the form of
+ attributes, from external data sources. The attribute definitions then
+ process this data into a from suitable for use by Shibboleth. This procedure
+ 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="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.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="fixed">
+ CustomAttributeDefinition</span>, which can be used to configure
+ 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="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="fixed">JNDIDirectoryDataConnector</span>:</p>
+ <dl>
+ <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="fixed">
+ JNDIDirectoryDataConnector</span> element.</dd>
+ <dd class="attribute"><span class="fixed"><Property name="<name>"
+ value="<value>"/></span> </dd>
+ <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="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="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="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="fixed"><cacheTime
+ "<seconds>"/></span> </dd>
+ <dd class="valueopt">An element of the element <span class="fixed">
+ JNDIDirectoryDataConnector</span>. Specifies an optional duration in
+ <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="fixed">
+ JNDIDirectoryDataConnector</span> element would look like:</p>
<blockquote>
- <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">edu.internet2.middleware.shibboleth.aa.
- attrresolv.AttributeResolver.ResolverConfig</span> propety in <span
- class="fixedwidth">origin.properties</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>
-
- <p>The resolver is essentially a directed graph from attribute
- definitions to data connectors. The data connectors pull data, in
- the form of attributes, from external data sources. The attribute
- definitions then process this data into a from suitable for use
- by Shibboleth. This procedure 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 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.0: the <span
- class="fixedwidth">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">CustomAttributeDefinition</span>, which can be
- used to configure user-created attribute definition plugins.
- Similarly, Shibboleth 1.0 comes with two data connectors: the
- <span class="fixedwidth">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 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>
-
- <dl>
- <dd class="attribute">
- <span class="fixedwidth">id = <string></span>
- </dd>
-
- <dd class="value">
- <p>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">JNDIDirectoryDataConnector</span>
- element.</p>
- </dd>
-
- <dd class="attribute">
- <span class="fixedwidth"><Property name="<name>" value="<value>"/></span>
- </dd>
-
- <dd class="value">
- <p>An element of the element <span
- class="fixedwidth">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 <a
- href="http://http://marsalis.internet2.edu/cgi-bin/viewcvs.cgi
- /shibboleth/java/src/conf/resolver.ldap.xml">Shibboleth
- CVS</a> for an example of names and values used to connect to
- an LDAP directory.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><Search></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">JNDIDirectoryDataConnector</span>. This
- element defines the DN filter used to perform the LDAP search.
- The search string must return no more than one result.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><Controls></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">Search</span>. This
- element grants some fine-grained control over the LDAP API
- calls.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><cacheTime "<seconds>"/></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">JNDIDirectoryDataConnector</span>.
- Specifies an optional duration in <span
- class="fixedwidth">seconds</span> for which the attribute
- resolver may cache information retrieved from this
- connector.</p>
- </dd>
- </dl>
-
- <p>A representation of a properly constructed <span
- class="fixedwidth">JNDIDirectoryDataConnector</span> element would
- look like:</p>
-
- <blockquote><span class="fixedwidth">
- <JNDIDirectoryDataConnector id="directory"><br>
- <Search filter="cn=%PRINCIPAL%"><br>
- <Controls searchScope="SUBTREE_SCOPE" returningObjects="false" /><br>
- </Search><br>
- <Property name="java.naming.factory.initial" value="com.sun.jndi.ldap.LdapCtxFactory" /><br>
- <cacheTime="2400"/><br>
- </JNDIDirectoryDataConnector>
- </span></blockquote>
-
- <p><span class="fixedwidth">SimpleAttributeDefinition</span>:</p>
-
- <dl>
- <dd class="attribute">
- <span class="fixedwidth">id = <string></span>
- </dd>
-
- <dd class="value">
- <p>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">SimpleAttributeDefinition</span>
- element.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><AttributeDependency / DataConnectorDependency requires="<id>"/></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">SimpleAttributeDefinition</span>, which may
- contain 0 or more of either <span
- class="fixedwidth">AttributeDependency</span> or <span
- class="fixedwidth">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 definition can then use to build its
- value.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth">smartScope = "<domain>"</span>
- </dd>
-
- <dd class="valueopt">
- <p>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>), that scope is used
- instead. Contained within the <span
- class="fixedwidth">SimpleAttributeDefinition</span>
- element.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth">sourceName = "<string>"</span>
- </dd>
-
- <dd class="valueopt">
- <p>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 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">SimpleAttributeDefinition</span>
- element.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><cacheTime "<seconds>"/></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">SimpleAttributeDefinition</span>.
- Specifies an optional duration in <span
- class="fixedwidth">seconds</span> for which the attribute
- resolver may cache this attribute for use in additional
- assertions.</p>
- </dd>
-
- <dd class="attributeopt">
- <span class="fixedwidth"><lifeTime "<seconds>"/></span>
- </dd>
-
- <dd class="valueopt">
- <p>An element of the element <span
- class="fixedwidth">SimpleAttributeDefinition</span>.
- 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.</p>
- </dd>
- </dl>
-
- <p>A representation of a properly constructed <span
- class="fixedwidth">SimpleAttributeDefinition</span> element would
- look like:</p>
-
- <blockquote><span class="fixedwidth">
- <SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName" smartScope="shibdev.edu" sourceName="universityPerson"><br>
- <DataConnectorDependency requires="dataConnector"/><br>
- <AttributeDependency requires="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"/><br>
- <cacheTime="600"/><br><br>
- <lifeTime="3600"/><br><br>
- </SimpleAttributeDefinition>
- </span></blockquote>
-
- <p>A properly formed <span class="fixedwidth">resolver.xml</span>
- file to automatically generate a simple response for EPPN may take
- the form:</p>
-
- <blockquote><span class="fixedwidth">
- <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>
- <SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName" smartScope="shibdev.edu"><br>
- <DataConnectorDependency requires="echo"/><br>
- </SimpleAttributeDefinition><br>
- <br>
- <CustomDataConnector id="echo"
- class="edu.internet2.middleware.shibboleth.aa.attrresolv.provider.SampleConnector" /><br>
- </AttributeResolver>
- </span></blockquote>
-
- <p>There are additional examples of <span class="fixedwidth">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>
-
+ <p><span class="fixed"><JNDIDirectoryDataConnector id="directory"><br>
+ <Search filter="cn=%PRINCIPAL%"><br>
+ <Controls searchScope="SUBTREE_SCOPE" returningObjects="false" /><br>
+ </Search><br>
+ <Property name="java.naming.factory.initial" value="com.sun.jndi.ldap.LdapCtxFactory"
+ /><br>
+ <cacheTime="2400"/><br>
+ </JNDIDirectoryDataConnector> </span></p>
</blockquote>
-
- <br>
- <br>
- <hr>
- <br>
-
-
- <h3><a name="6."></a>6. Troubleshooting</h3>
-
- <p>This section provides basic information about testing,
- logging, and error handling for Shibboleth origins. 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>
-
- <h4><a name="6.a."></a>6.a. Basic Testing</h4>
-
+ <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>Internet2 provides a basic target that can be used to test
- origin setup functionality. After your origin is recognized
- by InQueue, simply use any browser to access <a href=
- "https://wayf.internet2.edu/InQueue/sample.jsp">https://wayf.internet2.edu/InQueue/sample.jsp</a>.
- Select your origin's name and follow the login process as a
- user would. Note that SSL must be used, and both the HS and
- AA must be fully configured.</p>
-
- <p>The test target will then display a simple page which
- includes the basic information sent to it by your origin and
- the authentication rules it is using.</p>
-
- <p><b>For information regarding specific error messages that
- may be generated if the origin does not work successfully,
- please refer to section <a href="#6.c.">6.c</a>.</b></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="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="fixed">SimpleAttributeDefinition</span>:</p>
+ <dl>
+ <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="fixed">
+ SimpleAttributeDefinition</span> element.</dd>
+ <dd class="attributeopt"><span class="fixed"><AttributeDependency /
+ DataConnectorDependency requires="<id>"/></span> </dd>
+ <dd class="valueopt">An element of the element <span class="fixed">
+ SimpleAttributeDefinition</span>, which may contain 0 or more of either
+ <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="fixed">requires</span> statement which this attribute
+ definition can then use to build its value.</dd>
+ <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="fixed">bob@foo.edu</span>),
+ that scope is used instead. Contained within the
+ <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="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="fixed">id</span>. This would be useful
+ to send a local UniversityID attribute as eduPersonPrincipalName. If not
+ 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="fixed"><cacheTime
+ "<seconds>"/></span> </dd>
+ <dd class="valueopt">Specifies an optional duration in
+ <span class="fixed">seconds</span> for which the attribute resolver
+ may cache this attribute for use in additional assertions. Contained within
+ the <span class="fixed">SimpleAttributeDefinition</span> element.</dd>
+ </dl>
+ <p>A representation of a properly constructed <span class="fixed">
+ SimpleAttributeDefinition</span> element would look like:</p>
+ <blockquote>
+ <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>
-
- <h4><a name="6.b."></a>6.b. Logging</h4>
-
+ <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>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 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 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 out
- example in the file to give a possible alternate configuration.</p>
+ <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>
+ <SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName"
+ smartScope="shibdev.edu"><br>
+ <DataConnectorDependency requires="echo"/><br>
+ </SimpleAttributeDefinition><br>
+ <br>
+ <CustomDataConnector id="echo"
+ class="edu.internet2.middleware.shibboleth.aa.attrresolv.provider.SampleConnector"
+ /><br>
+ </AttributeResolver> </span></p>
</blockquote>
-
- <h4><a name="6.c."></a>6.c. Common Problems</h4>
-
+ <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="fixed">resolvertest</span></h4>
+<blockquote>
+ <p>Shibboleth comes bundled with the command line utility
+ <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="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="fixed">SHIB_HOME</span> to
+ the directory path where the Shibboleth tarball was exploded (typically
+ <span class="fixed">/opt/shibboleth-origin-1.2/</span>).</li>
+ <li>Move to $SHIB_HOME/bin</li>
+ </ol>
+ <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>A knowledge base is being developed in the <a
- href="http://www.columbia.edu/~wassa/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 are not answered by this basic guide.</p>
+ <p><span class="fixed">$ ./resolvertest --user=wassa
+ --file=file:///$SHIB_HOME/src/conf/resolver.xml</span></p>
</blockquote>
- </body>
-</html>
+ <h5>NOTE: This program does not filter the resulting attributes through the
+ applicable ARP's. Although it does show the attributes generated by the
+ resolver for a particular user or URL, it does not necessarily reflect what
+ will be released by the AA to a requesting SHAR.</h5>
+</blockquote>
+<p><br>
+</p>
+<h4><a name="5.e."></a>5.e. Local Error Page</h4>
+<blockquote>
+ <p>Origin sites are encouraged to provide federations with the URL of a
+ local Shibboleth error page. If a browser user from the origin site
+ encounters a problem at a shibbolized target, the target is likely to
+ display an error page that includes a link back to this origin provided
+ page.</p>
+ <p>The page should provide information on how to obtain local support for
+ using Shibbolized resources. It might also include suggestions on what
+ information should be recorded before beginning the problem resolution
+ process.</p>
+</blockquote>
+<p><br>
+<br>
+</p>
+<h4><a name="5.f."></a>5.f. Using a New Attribute</h4>
+<p>In order for an attribute to be sent to a target, two steps are required:</p>
+<p>1. The attribute has to be defined in resolver.xml. See section <a href="#5.d.">5.d</a>.</p>
+<p>2. The effective ARP for that target has to release this attribute value. See section <a href="#5.b.">5.b.</a>.</p>
+<p>Note: resolvertest is a useful tool for verifying the correctness of the definitions.</p>
+<p>Note: the AAP at the target must also define this attribute. See the Shibboleth Target Deploy Guide.</p>
+
+<p><br>
+<br>
+</p>
+<hr>
+<p><br>
+</p>
+<h3><a name="6."></a>6. Troubleshooting</h3>
+<p>This section provides basic information about testing, logging, and error
+handling for Shibboleth origins. 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: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>
+ <p>Internet2 provides a basic target that can be used to test origin setup
+ functionality. After your origin is recognized by InQueue, simply use any
+ browser to access <a href="https://wayf.internet2.edu/InQueue/sample.jsp">
+ https://wayf.internet2.edu/InQueue/sample.jsp</a>. Select your origin's name
+ and follow the login process as a user would. Note that SSL must be used,
+ and both the HS and AA must be fully configured.</p>
+ <p>The test target will then display a simple page which includes the basic
+ information sent to it by your origin and the authentication rules it is
+ using.</p>
+ <p><b>For information regarding specific error messages that may be
+ generated if the origin does not work successfully, please refer to section
+ <a href="#6.c.">6.c</a>.</b></p>
+</blockquote>
+<h4><a name="6.b."></a>6.b. Logging</h4>
+<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="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="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="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="https://umdrive.memphis.edu/wassa/public/shib.faq/shibboleth-faq.html">
+ Shibboleth Deployer's FAQ</a>. Please mail
+ <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>
+
+</body>
+</html>
projects / shibboleth / sp.git / blobdiff