From 69de63898b732925ee9dc4abf9e0342e4eeb7e08 Mon Sep 17 00:00:00 2001 From: Scott Cantor Date: Tue, 11 May 2004 00:27:24 +0000 Subject: [PATCH] Copying over latest docs. --- doc/DEPLOY-GUIDE-ORIGIN.html | 1868 ++++++++++++++++++------------- doc/DEPLOY-GUIDE-TARGET.html | 2503 ++++++++++++++++++++++++------------------ doc/Makefile.am | 1 - 3 files changed, 2522 insertions(+), 1850 deletions(-) diff --git a/doc/DEPLOY-GUIDE-ORIGIN.html b/doc/DEPLOY-GUIDE-ORIGIN.html index fbb966c..b0e71f7 100644 --- a/doc/DEPLOY-GUIDE-ORIGIN.html +++ b/doc/DEPLOY-GUIDE-ORIGIN.html @@ -25,6 +25,27 @@ a:active { color: #440000; } +a.fixedlink:visited +{ +font-family: monospace; +font-size: 90%; +color: #121212; +text-decoration: none; +} +a.fixedlink:link +{ +font-family: monospace; +font-size: 90%; +color: #121212; +text-decoration: none; +} +a.fixedlink:active +{ +font-family: monospace; +font-size: 90%; +color: #121212; +text-decoration: none; +} dl { border-width:2px; background-color: #DDDDDD; @@ -32,7 +53,6 @@ background-image: url('none'); margin: 5px; padding: 0px; border-style: solid; - } dt { @@ -74,31 +94,10 @@ border-top-width: none; border-left-width: 1px; border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid } -.attributeopt -{ -font-size: 115%; -font-color: #000000; -text-align: left; -background-color: #BCBCEE; -border: 1px inset black; -background-image: url('none'); -margin: 0px; -padding: 2px -} -.valueopt +.mandatory { font-color: #000000; -text-align: left; -background-color: #DDDDFF; -background-image: url('none'); -padding-top: 0em; -padding-bottom: 0.5em; -padding-right: 1em; -padding-left: 5em; -border-bottom-width: none; -border-top-width: none; -border-left-width: 1px; -border-right-width: 1px; border-left-style:solid; border-right-style:solid; border-top-style:solid; border-bottom-style:solid +background-color: #FFCCFF; } .attributelong { @@ -111,23 +110,12 @@ background-image: url('none'); margin: 0px; padding: 2px } -.attributeoptlong -{ -font-size: 85%; -font-color: #000000; -text-align: left; -background-color: #BCBCEE; -border: 1px inset black; -background-image: url('none'); -margin: 0px; -padding: 2px -} .demo { background-color: #EEEEEE; padding: 3px; } -.fixedwidth +.fixed { font-family: monospace; font-size: 90%; @@ -146,100 +134,28 @@ color: #00FF00

Shibboleth Origin Deployment Guide

Shibboleth Origin Deployment Guide
-Shibboleth Version 1.1
-December 3, 2003
-

-

This version of the deploy guide is for Shibboleth v1.1. For documentation +Shibboleth Version 1.2
+April 14, 2004
+

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.

-

Federations have been abstracted out from the Shibboleth documentation. For -further information on using Shibboleth in a federation, refer to the federation -guide.

-

Shibboleth v1.1 is stable and secure enough to deploy in production -scenarios. It is backward compatible with 1.0 in all respects, including -configuration, but some older commands have been deprecated or replaced.

-

Features and changes specific to 1.1 are marked with -[1.1]

-

Major New Features in 1.0 and 1.1

-

This new release contains several improvements and enhancements, including: -

-
Federation Support
-
    -
  1. Federation and trust support has been substantially extended. Federation - structures are now defined. The set of metadata collected and managed by - each Federation is more fully defined. The configuration values assigned by - a Federation are now identified.
    2. -
  2. There is some support for targets to be members of multiple federations; - this support will continue to evolve. When a browser user arrives, a target - will determine which federation their origin belongs to, and then use the - trust fabric associated with that Federation.
    3. -
  3. Better support for flexible and bilateral trust agreements. A key - specific to an origin site can be used to vallidate its signature.
    4. -
  4. This version contains a significantly more mature security - implementation, and should meet the security requirements of typical sites.
    5. -
-
Origin
-
    -
  1. The Attribute Authority has a powerful new attribute resolver. Simple - scenarios (using a string attribute stored in ldap) can be accomplished by - merely editing a configuration file. Java classes may still be written for - more complex evaluations (eg retrieving information from multiple disparate - repositories, and computing the SAML attribute using business rules). This - should greatly simplify the process of configuring the AA to support - additional general attributes.
    2. -
  2. A sample resolver file for using standard LDAP person and inetOrgPerson - attributes is included. [1.1]
    3. -
  3. Support for a runtime-derived per-requester persistent identifier - attribute to support anonymous personalization by targets has been added via - an attribute plugin. [1.1]
    4. -
  4. Specialized sites without privacy needs can configure identity-based - handles interoperable with other SAML deployments. - [1.1]
    5. -
-
Target
-
    -
  1. Significantly more flexibility in configuring targets is provided to - ensure robustness. Failover and redundant configurations are now supported.
    2. -
  2. The SHAR may now optionally store its session and attribute cache in a - back-end database in addition to the previously available in-memory option. - [1.1]
    3. -
  3. Federation supplied files (sites.xml and trust.xml) are now refreshed in - a much more robust manner.
    4. -
  4. The SHAR can be configured to request specific attributes from the - Origin.
    5. -
  5. The SHAR can use TCP sockets when responding to the Apache module, for - specialized deployment behind firewalls. [1.1] -
    6. -
  6. Attribute acceptance policies have been greatly enhanced, and are now - used to configure all aspects of attribute handling by the target, except - for requesting specific attributes by sitename. Adding attributes now takes - place in one configuration step. [1.1]
    7. -
  7. Support for Apache 1.3 on Windows NT/2000/XP/2003 has been added. - [1.1]
    8. -
  8. Microsoft IIS web server support has been added via an ISAPI filter and - extension. [1.1]
    9. -
-
Miscellaneous
-
    -
  1. Origin sites can configure a value to describe the type of - authentication mechanism used at the origin site (e.g. password, Kerberos, - PKI, etc.). This value is made available on the target side as Shib-Authentication-Method. -
    -
    2. -
  2. Various improvements to error handling. Origin sites are now able to - supply an "error URL" and contact information to a federation. When a target - encounters an error, it can include this information in the error page.
    -
    3. -
  3. Local time string values are now used in log files.
    -
    4. -
  4. Internationalization support has been extended.
    5. -
+

The default configuration of Shibboleth is not 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.

+ +

Insert features here.

+

Before starting, please sign up for all applicable mailing lists. Announcements pertinent to Shibboleth deployments and developments and resources for deployment assistance can be found here.

Please send any questions, concerns, or eventual confusion to -mace-shib-users@internet2.edu. +shibboleth-users@internet2.edu. 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 @@ -262,6 +178,9 @@ that arises. Please ensure that you have the

  • Target
  • WAYF
  • Federations
    • +
  • Relying Parties
    • +
  • Applications
    • +
  • Sessions
  • @@ -305,13 +224,14 @@ that arises. Please ensure that you have the
  • Establishing default ARP's for the origin community
    • +
  • metadatatool

  • Advanced Configuration

      -
    1. - origin.properties
      2. +
    2. + origin.xml
    3. ARP Overview
      1. ARP Processing
        2. @@ -323,7 +243,7 @@ that arises. Please ensure that you have the (optional)
      2. The Attribute Resolver
          -
        1. +
        2. resolvertest
        3. @@ -457,13 +377,88 @@ requesting attributes.

        information on local authentication and authorization practices for federation members.

        -


        -
        -
        -

        +

        1.e. Relying Parties

        +
        +

        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.

        +

        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.

        +
        +

        1.f. Applications

        +
        +

        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 + session 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.

        +

        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.

        +
        +

        1.g. Sessions

        +
        +

        Much of the target implementation is concerned with establishing, and + subsequently maintaining, sessions with the browser user on behalf of the + applications 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.

        +

        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.

        +

        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.

        +
        -


        -

        2. Planning

        There are several essential elements that must be present in the environment to ensure Shibboleth functions well, both political and technical. Shibboleth is @@ -480,8 +475,8 @@ requirements for a successful implementation of a Shibboleth origin.

        WebISO service is not explicitly necessary for Shibboleth; however, it is highly recommended. Implementation details of this are discussed in section 4.c. -
      3. Shibboleth is known to work on Linux and Solaris, but should function on - any platform that has a Tomcat implementation.
        4. +
      4. Shibboleth is known to work on Windows, Linux, and Solaris, but should + function on any platform that has a Tomcat implementation.
      5. 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.
        6. @@ -493,18 +488,13 @@ requirements for a successful implementation of a Shibboleth origin.

        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.

        -

        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.

        -

        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.

        +

        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. The default configuration that + ships with Shibboleth is intended for use in testing against a localhost target. In order to interoperate with other + relying parties, such as a federation, consult the steps provided by the + guidelines of that relying party.

        2.c. Security Considerations

        @@ -632,21 +622,21 @@ requirements for a successful implementation of a Shibboleth origin.

        3.a. Software Requirements

        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 Servlet API v2.3 -and JSP specification 1.2.

        +any servlet container supporting Servlet API v2.3 +and JSP specification 1.2.

        • Apache 1.3.26+ (<2.0)
        • Tomcat 4.1.18-24 LE Java - server
          • + server and above
        • Sun J2SE JDK v1.4.1_01 and above

          Other versions of the JRE are not supported and are known to cause errors when working with certificates.

          • -
        • mod_jk +
        • mod_jk or mod_jk2

          You may need to build mod_jk against Apache, which will generally require GCC or a platform-specific C compiler.

          @@ -675,11 +665,11 @@ and JSP specification 1.2.

          1. Ensure you have already obtained the proper .tarball.
            2. -
          2. The archive will expand into a - shibboleth-origin-1.1/ directory(/opt/ +
          3. The archive will expand into a + shibboleth-origin-1.2/ directory(/opt/ recommended).
          4. Run the following command to move the Java files into Tomcat's tree:
            -

            cp /opt/shibboleth-origin-1.1/dist/shibboleth.war +

            cp /opt/shibboleth-origin-1.2/dist/shibboleth.war /usr/local/tomcat/webapps/

            5. @@ -687,8 +677,8 @@ and JSP specification 1.2.

            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:
            -

            $ cp - /opt/shibboleth-origin-1.1/endorsed/*.jar /usr/local/tomcat/common/endorsed +

            $ cp + /opt/shibboleth-origin-1.2/endorsed/*.jar /usr/local/tomcat/common/endorsed

            Different versions of Tomcat or other Java servers may have other @@ -697,14 +687,14 @@ and JSP specification 1.2.

            endorse classes, if necessary.
          5. Restart Tomcat, which will automatically detect that there has been a new .war file added. This file will by default be expanded into - /usr/local/tomcat/webapps/shibboleth.
            6. + /usr/local/tomcat/webapps/shibboleth.
          6. 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 httpd.conf, or to place - Include conf/mod_jk.conf in - httpd.conf, and place the following - lines in /etc/httpd/conf/mod_jk.conf:
            -

            --------- begin ---------
            + directly in httpd.conf, or to place + Include conf/mod_jk.conf in + httpd.conf, and place the following + lines in /etc/httpd/conf/mod_jk.conf:

            +

            --------- begin ---------
            <IfModule !mod_jk.c>
             LoadModule jk_module libexec/mod_jk.so
            </IfModule>
            @@ -719,16 +709,16 @@ and JSP specification 1.2.

            --------- end ---------

            7. -
          7. Tomcat's /conf/server.xml ships by +
          8. Tomcat's /conf/server.xml ships by default with the Coyote/JK2 connector enabled, which fails with - Shibboleth due to the lack of support for + Shibboleth due to the lack of support for REMOTE_USER. This connector must be commented out. Then, uncomment and modify the traditional AJP 1.3 connector as follows:
              -
            1. Add address="127.0.0.1" inside - the <Ajp13Connector> configuration +
            2. Add address="127.0.0.1" inside + the <Ajp13Connector> configuration element to prevent off-host access.
              3. -
            3. Add tomcatAuthentication="false" - to the <Ajp13Connector> +
            4. Add tomcatAuthentication="false" + to the <Ajp13Connector> configuration element to ensure that the user's identity is passed from Apache to the servlet environment.
            5. 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.
              6. @@ -736,8 +726,8 @@ and JSP specification 1.2.

            6. It is strongly recommended that the AA be SSL-protected to protect attributes in transit. To do so, add an appropriate location - block to httpd.conf:
              -

              <Location /shibboleth/AA> + block to httpd.conf:

              +

              <Location /shibboleth/AA>
               SSLVerifyClient optional
               SSLOptions +StdEnvVars +ExportCertData
              </Location>

              @@ -753,85 +743,145 @@ and JSP specification 1.2.

              4. Getting Running

              4.a. Basic Configuration

              -

              This section of the deploy guide specifies only the essential changes - that need to be made to the configuration defaults for the origin to - function successfully in a federated environment. More complex configuration - will likely be required for many applications and federations; for a full - description of every field in origin.properties, - please refer to section 5.a.

              -

              The main configuration file for Shibboleth's origin side is located in - /webapps/shibboleth/WEB-INF/classes/conf/origin.properties.. - 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 HS' certificate and with - directory access bindings, etc., or access errors may occur.

              -

              All pathnames are relative, and have an effective root path of - $TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/. - To specify files outside of the webapp, specify a full URI, such as - file:///usr/local/shibboleth/.

              +

              This section of the deploy guide describes only the default origin.xml 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 origin.xml and definition of + every element and attribute that may be used, please refer to section 5.a.

              +

              The default configuration that ships with Shibboleth is intended for + use in testing against a localhost target. In + order to interoperate with other relying parties, such as a federation, + consult the steps provided by the guidelines of that relying party.

              +

              The main configuration file for Shibboleth's origin side is located + in /webapps/shibboleth/WEB-INF/classes/conf/origin.xml. + The configuration must be consistent with values elsewhere in the + deployment, such as the HS' certificate and with + directory access bindings, etc., or access errors may occur. All pathnames + are relative, and have an effective root path of $TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/. To + specify files outside of the webapp, specify a full URI, such as file:///usr/local/shibboleth/.

              +

              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.

              + +
              +<?xml version="1.0"encoding="UTF-8"?>
              +
              +<ShibbolethOriginConfig
              +   xmlns="urn:mace:shibboleth:origin:1.0"
              +   xmlns:cred="urn:mace:shibboleth:credentials:1.0"
              +   xmlns:name="urn:mace:shibboleth:namemapper:1.0"
              +   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              +   xsi:schemaLocation="urn:mace:shibboleth:origin:1.0 origin.xsd"
              +   AAUrl="http://therock.cc.columbia.edu:6666/shibboleth/AA"
              +   defaultRelyingParty="urn:mace:inqueue"
              +   providerId="urn:mace:inqueue:shibdev.edu">
              +
              +   <RelyingParty name="urn:mace:inqueue" signingCredential="foo">
               +      <HSNameFormat nameMapping="crypto"/>
              +   </RelyingParty>
              +
              +   <ReleasePolicyEngine>
               +      <ArpRepository implementation="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository">
              +         <Path>/conf/arps/</Path>
              +      </ArpRepository>
              +   </ReleasePolicyEngine>
              +
              +   <!--
              +   <Logging>
              +      <Log4JConfig location="file:///tmp/log4j.properties"/>
              +   </Logging>
              +   <Logging>
              +      <ErrorLog level="DEBUG" location="file:///tmp/shib-error.log"/>
              +      <TransactionLog location="file:///tmp/shib-access.log"/>
              +   </Logging>
              +   -->
              +
              +   <NameMapping
              +      xmlns="urn:mace:shibboleth:namemapper:1.0"
              +      id="crypto"
              +      format="urn:mace:shibboleth:1.0:nameIdentifier"
              +      type="SharedMemoryShibHandle"
              +      handleTTL="1800"/>
              +
              +   <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
              +      <FileResolver Id="foo">
              +         <Key format="DER">
              +            <Path>/conf/shib2.key</Path>
              +         </Key>
              +         <Certificate format="PEM">
              +            <Path>/conf/shib2.crt</Path>
              +         </Certificate>
              +      </FileResolver>
              +   </Credentials>
              +    <FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper" uri="/conf/sites.xml"/>
              +
              +</ShibbolethOriginConfig> +
              + +

              The following changes must be made to the default configuration before the +origin will interoperate in a federation.

                -
              1. - edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer = <domain - name> -
                -

                This will be, in most cases, the DNS name of the machine on which - the HS runs. It must match the CN of the certificate used below.

                -
                -
                2. -
              2. - edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName = <URI> -
                -

                Enter the value assigned to the site by the federation.

                -
                -
                3. -
              3. - edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl = <url> -
                -

                This will be the URL assigned the AA servlet in step - 3.b. Note that this must be an - https:// URL in order for the AA to - know which SHAR is requesting attributes.

                -
                -
                4. -
              4.  
                  -
                • - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath = - <pathname>
                  • -
                • - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword - = <password>
                  • -
                • - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias - = <alias>
                  • -
                • - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword - = <password>
                  • -
                • - edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias = - <alias>
                  • -
                -
                -

                Respectively, the location and password of the Java keystore - containing the x.509 certificate and matching private key to be used - by the HS, the alias and password of the private key, and the - optional certificate alias, if it differs from the key's alias.

                -
                +
              5. +

                Attributes within the ShibbolethOriginConfig element:

                +
                  +
                1. AAUrl=URL +
                  +

                  This will be the URL assigned the AA servlet in step + 3.b. Note that this must be an + https:// URL in order for the AA to + authenticate the requesting SHAR.

                  +
                  +
                  2. +
                2. providerID=URI +
                  +

                  This will be the URI assigned to this origin by the + federation.

                  +
                  +
                  3. +
                3. defaultRelyingParty=URI +
                  +

                  This is the URI of the primary federation that the origin + operates within.

                  +
                  +
                  4. +
                6. -
              6. - edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName = <domain - name> -
                -

                Specifies the name of the AA, which is typically the domain name - of the server running it.

                -
                +
              7. +

                Although not explicitly necessary, it's highly recommended for + initial installation and testing that logging be activated at the DEBUG level by uncommenting the second Logging element and + ensuring that the pathnames for TransactionLog and ErrorLog are + appropriate. However, in production, this will slow the operation of + the origin considerably.

                8. -
              8. - edu.internet2.middleware.shibboleth.audiences = <URI> -
                -

                This section must contain the URI of the federation under which - the origin will operate or test initially. This will be provided by - the federation.

                -
                +
              9. +

                The default configuration file informs Shibboleth to load its key and + certificate from flat files. The Key element specifies a key in DER format located at /conf/shib2.key, while the Certificate + element specifies the corresponding certificate in PEM format located at /conf/shib2.crt. 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 + section 5.a for appropriate structure and details on + population.

                +

                To create proper keys and certificates for production use, please + refer to section 4.b.

              @@ -847,7 +897,7 @@ configuration 5.d.

              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 /webapps/shibboleth/WEB-INF/classes/conf/resolver.xml. + can be found at /webapps/shibboleth/WEB-INF/classes/conf/resolver.xml. Two changes are necessary:

              1. The value of the smartScope attribute should be changed to the Domain Name value submitted to the Federation. It appears on two @@ -860,76 +910,61 @@ configuration

              4.b. Key Generation and Certificate Installation

              -

              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 - origin.properties.

              -

              A sample keystore is included in the distribution and can be found in - /usr/local/tomcat/webapps/shibboleth/WEB-INF/classes/conf/keystore - .jks with a password of shibhs. It is - intended to serve as an example and not as a production keystore.

              -

              The following commands will generate a new RSA keypair and store it in - the keystore.jks file, with a keyentry alias - of hs and new passwords of your choosing:

              -
              -

              $ cd /usr/local/tomcat/webapps/shibboleth/WEB-INF/classes/conf
              - $ keytool -storepasswd -keystore keystore.jks -new <newpassword>
              - $ keytool -genkey -keystore keystore.jks -alias hs -keyalg rsa -keysize - 2048
              -

              -
              -

              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 Common - Name(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.

              -

              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.

              -

              To generate a certificate signing request for a CA, use the following - command:

              -
              -

              $ keytool -certreq -keystore keystore.jks - -alias hs -file <csr-file>
              -

              -
              -

              The contents of <csr-file> 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:

              -
              -

              $ keytool -import -keystore keystore.jks - -alias hs -file <cert-file>

              -
              -

              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.

              -

              For information on sharing certificate/key pairs between Apache and Java - keystores see section 5.c..

              +

              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 5.c.. Sharing credentials is simplest when using flat-file + unencrypted PEM-format certs/keys as expected by Apache.

              + +

              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 KeyStoreResolver + element or flat-file keys and certificates may be specified using a FileResolver in origin.xml. The information in + that file must be consistent with the values that are established in this + process.

              + +

              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.

              + +

              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 mod_ssl-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 origin.xml file and protected appropriately.

              + +

              OpenSSL commands to generate a new keypair and a certificate request are + shown here, assuming 2048 bit RSA keys are to be used:

              + +
              $ openssl genrsa -des3 -out ssl.key + 2048
              $ openssl req -new -key ssl.key -out ssl.csr
              + +

              The signed certificate file returned by the CA should be usable directly, + or can be converted to PEM format using the openssl + x509 command.

              4.c. Linking the Authentication System to the HS

              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 REMOTE_USER. - Location blocks can be added to httpd.conf, + authentication that populates REMOTE_USER. + Location blocks can be added to httpd.conf, 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:

              -

              <Location /shibboleth/HS>
              +

              <Location /shibboleth/HS>
              AuthType Basic
              AuthName "Internet2 Handle Service"
              AuthUserFile /usr/local/apache/conf/user.db
              @@ -950,10 +985,10 @@ configuration 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 $SHIB_HOME/webAppConfig/origin-client-cert.xml. - To enable the filter, add the following to the deployment descriptor (web.xml):

              + distribution at $SHIB_HOME/webAppConfig/origin-client-cert.xml. + To enable the filter, add the following to the deployment descriptor (web.xml):

              -

                <filter>
              +

                <filter>
                  <filter-name>
                    Client Cert AuthN Filter
                  </filter-name>
              @@ -974,15 +1009,15 @@ configuration

              By default, the filter pulls the principal name out of the - CN of the cert's - Subject by using regular expression + CN of the cert's + Subject by using regular expression grouping. This may be done using patterns such as:

              -

              regex: '.*CN=([^,/]+).*' match group: 1 +

              regex: '.*CN=([^,/]+).*' match group: 1

              The servlet filter will accept two initialization parameters, - regex and + regex and matchGroup that can be used to extract the principal name differently.

              @@ -1015,264 +1050,581 @@ configuration information regarding how ARP's are processed or syntactically formed, please refer to section 5.b.i.

              +

              4.e. metadatatool

              +
              +

              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 sites.xml files. Shibboleth includes a simple utility called metadatatool which can be used to refresh a sites.xml file. These files are then pointed to by FederationProvider elements in shibboleth.xml.

              +

              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 crontab to ensure that the data is fresh.

              + +
              bin/metadatatool -i https://wayf.internet2.edu/InQueue/sites.xml -k conf/internet2.jks -p shib123 -a sitesigner -o /your_path_here/sites.xml
              + +

              This is a list of all the command-line parameters that may be specified:

              + +
              when signing:    -i <uri> -s -k <keystore> -a <alias> -p <pass> [-o +<outfile>]
              +when updating:  -i <uri> [-k <keystore> -a <alias> OR -N ] [-o <outfile>]
              + + + + + + + + + + + + +
              -i,--ininput file or url
              -k,--keystorepathname of Java keystore file
              -a,--aliasalias of signing or verification key
              -p,--passwordkeystore/key password
              -o,--outfilewrite signed copy to this file instead of stdout
              -s,--signsign the input file and write out a signed version
              -N,--noverifyallows update of file without signature check
              -h,--helpprint a list of configuration options
              -x,--nsXML namespace of root element
              -n,--namename of root element
              +
              +

              Shibboleth 1.2 still utilizes mod_ssl for verification of certificates presented by SHAR's when processing attribute requests. This requires an updated ca-bundle.crt to ensure that all appropriate certificate authorities used by relying parties are recognized.

              +



              5. Advanced Configuration

              -

              origin.properties

              +

              5.a. origin.xml

              -

              The main configuration file for Shibboleth's origin side is located in - /webapps/shibboleth/WEB-INF/classes/conf/origin.properties.. - 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 HS' certificate and with - directory access bindings, etc., or access errors may occur.

              -

              All pathnames are relative, and have an effective root path of - $TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/. - To specify files outside of the webapp, specify a full URI, such as - file:///usr/local/shibboleth/.

              -

              Fields that are purple are optional; grey fields are mandatory.

              -

              These are the variables that may be specified for each component of - origin.properties:

              -


              -

              -

              General Configuration:

              +

              Shibboleth 1.2 origins are configured using the origin.xml file located in /webapps/shibboleth/WEB-INF/classes/conf/origin.xml. + 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 section 4.a, below, and through the examples + in CVS. The following is an example origin.xml 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 section 4.a. This is useful + to demonstrate the structure that other types of configurations have. Few + deployments will need configuration files this complex.

              + +
              +<?xml version="1.0" encoding="UTF-8"?>
              +
              +<ShibbolethOriginConfig
              +    xmlns="urn:mace:shibboleth:origin:1.0"
              +    xmlns:cred="urn:mace:shibboleth:credentials:1.0"
              +    xmlns:name="urn:mace:shibboleth:namemapper:1.0"
              +    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              +    xsi:schemaLocation="urn:mace:shibboleth:origin:1.0 origin.xsd"
              +    AAUrl="http://therock.cc.columbia.edu:6666/shibboleth/AA"
              +    defaultRelyingParty="urn:mace:inqueue"
              +    providerId="urn:mace:inqueue:shibdev.edu">
              +
              +    <!-- Default relying party -->
              +    <RelyingParty name="urn:mace:inqueue" signingCredential="foo">
              +        <HSNameFormat nameMapping="crypto"/>
              +    </RelyingParty>
              +
              +    <!-- This site is in InQueue, but we want to send explicit errors to them -->
              +    <RelyingParty name="urn:mace:inqueue:example.edu" signingCredential="foo" passThruErrors="true">
              +        <HSNameFormat nameMapping="crypto"/>
              +    </RelyingParty>
              +
              +    <!-- This references domain local service providers -->
              +    <RelyingParty name="urn-x:localFed" signingCredential="bar" passThruErrors="true" providerId="urn-x:localSite">
              +        <HSNameFormat nameMapping="clear"/>
              +    </RelyingParty>
              +
              +    <ReleasePolicyEngine>
              +        <ArpRepository implementation="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository">
              +            <Path>/conf/arps/</Path>
              +        </ArpRepository>
              +    </ReleasePolicyEngine>
              +
              +    <Logging>
              +        <ErrorLog level="DEBUG" location="file:///var/log/shib-error.log" />
              +        <TransactionLog location="file:///var//log/shib-access.log" />
              +    </Logging>
              +
              +    <NameMapping
              +        xmlns="urn:mace:shibboleth:namemapper:1.0"
              +        id="crypto"
              +        format="urn:mace:shibboleth:1.0:nameIdentifier"
              +        type="SharedMemoryShibHandle"
              +        handleTTL="1800"/>
              +
              +    <NameMapping
              +        xmlns="urn:mace:shibboleth:namemapper:1.0"
              +        id="clear"
              +        format="urn-x:test:NameIdFormat1"
              +        type="Principal"/>
              +
              +    <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
              +        <FileResolver Id="foo">
              +            <Key format="DER">
              +                <Path>/conf/shib2.key</Path>
              +            </Key>
              +            <Certificate format="PEM">
              +                <Path>/conf/shib2.crt</Path>
              +            </Certificate>
              +        </FileResolver>
              +
              +        <KeyStoreResolver Id="bar" storeType="JKS">
              +            <Path>/conf/keystore.jks</Path>
              +            <KeyAlias>shibhs</KeyAlias>
              +            <CertAlias>shibhs</CertAlias>
              +            <StorePassword>shibhs</StorePassword>
              +            <KeyPassword>shibhs</KeyPassword>
              +        </KeyStoreResolver>
              +    </Credentials>
              +
              +  <FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper"
              +        uri="/conf/sites.xml"/>
              +  <FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper"
              +        uri="/conf/local-sites.xml"/>
              +
              +</ShibbolethOriginConfig> +
              + +

              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.

              + +

              All pathnames are relative, and have an effective root path of $TOMCAT_HOME/webapps/shibboleth/WEB-INF/classes/. To + specify files outside of the webapp, specify a full URI, such as file:///usr/local/shibboleth/.

              +

              All elements are optional unless otherwise specified. All attributes of + an element are optional unless designated mandatory by a purple background.

              +
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer = <domain - name>
              -
              Specifies the DNS name the HS should use for itself in - issuing assertions.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName = <URI> -
              -
              Specifies the the URI - 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.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl = <url> -
              -
              Specifies the URL at - which the HS' corresponding AA may be contacted. Note that this must - be an https:// URL in order for the AA - to know which SHAR is requesting attributes.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.username = <var> -
              -
              Specifies the HTTP request header that should be - used to acquire the user's principal name from the authentication - service. Defaults to REMOTE_USER.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.authMethod = <uri> +
              <ArpRepository implementation ="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository">
              +

              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 Path element pointing to the directory + containing ARP's to be used by this engine. For more information + regarding ARP's, consult section 4.d for basic + information and 5.b for advanced configuration and + syntax.

              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.

              + +
              <CAPath>pathname</CAPath>
              +
              Paired with a Path element and contained by a FileResolver + element, this element allows for the specification of additional + certificates in the chain up to the trust anchor. As many CAPath 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.
              + +
              <CertAlias>string</CertAlias>
              +
              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 KeyStoreResolver element.
              + +
              <Certificate format="type">
              +
              This specifies the certificate corresponding to this + set of credentials. The certificate itself must be referred to using a + Path 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 CAPath elements. Valid + encodings are PEM and DER. It resides within the FileResolver element + and must be paired with the corresponding private key using the Key element.
              + +
              <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
              +
              This element is the container for credentials used by + the credential mechanism specified by the ShibbolethOriginConfig element. It must + contain one FileResolver element for flat key and + certificate files or one KeyStoreResolver element for compound + keystores.
              + +
              <ErrorLog level="level" location="URL">
              +
              Paired with a TransactionLog element, this will log any + errors encountered by the origin above a certain logging threshold to a + flat file at the referenced URL. Valid + levels in order of decreasing sensitivity are DEBUG, INFO, WARN, ERROR, and FATAL. If no logging is desired, specify OFF; defaults to WARN. + Must be contained by a Logging element.
              + +
              <FederationProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadataLoadWrapper" uri="pathname"/>
              +
              Individual sets of targets in the form of an + XML file that this origin will trust to make + requests may be specified by adding FederationProvider elements to the main ShibbolethOriginConfig element for each. The + uri attribute points to an + XML file, generally signed and distributed by federations. + This file should be regularly refreshed using + metadatatool.
              + +
              <FileResolver Id="string">
              +
              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 Credentials element. RelyingParty + 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 Key element and should + contain one Certificate element.
              + +
              <HSNameFormat nameMapping="id"/>
              +
              Individual RelyingParty elements may contain this element + to specify the NameMapping element referenced by id to be used in generating subject names for this + relying party. If this element is not present, default Shibboleth + handles will be used.
              + +
              <Key format="type">
              +
              This specifies the file containing a private key to be + used by a set of credentials. Valid encodings are PEM and DER. Keys are + supported in a variety of formats: DER, PEM, encrypted PEM, PKCS8, and + encrypted PKCS8. It resides within the FileResolver + element, should be paired with a Certificate element, and contain a Path element.
              + +
              <KeyAlias>string</KeyAlias>
              +
              Specifies the alias used for accessing the private + key. Contained by the KeyStoreResolver element.
              + +
              <KeyPassword>string</KeyPassword>
              +
              Specifies the password used to retrieve the private + key. Contained by the KeyStoreResolver element.
              + +
              <KeyStoreKeyAlias>string</KeyStoreKeyAlias>
              +
              Specifies the alias used for accessing the private + key. Contained by the NameMapping element when a CryptoHandleGenerator type is specified.
              + +
              <KeyStoreKeyPassword>string</KeyStoreKeyPassword>
              +
              Specifies the password used to retrieve the private + key. Contained by the NameMapping element when a CryptoHandleGenerator type is specified.
              + +
              <KeyStorePassword>string</KeyStorePassword>
              +
              Specifies the password to access the keystore + containing the private key to be used for symmetric encryption. + Contained by the NameMapping element when a CryptoHandleGenerator type is specified.
              + +
              <KeyStorePath>string</KeyStorePath>
              +
              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 NameMapping element when a CryptoHandleGenerator type is specified.
              + +
              <KeyStoreResolver Id="string" storeType="type">
              +
              This element is contained by the Credentials + 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 JKS. RelyingParty elements will refer to the Id allowing multiple resolver elements to be used + to specify different credential storage for different federations or + target sites. It must contain one Path element, one KeyAlias element, and one StorePassword + element; it may optionally contain a KeyPassword element or a CertAlias + element.
              + +
              <Log4JConfig location="pathname"/>
              +
              This element informs Shibboleth to utilize Log4J as a + logging system and points to the relevant configuration file using the + location attribute. A basic configuration is + included with the distribution at /WEB-INF/classes/conf/log4j.properties. 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 + Logging element + and may not be paired with a TransactionLog or ErrorLog element.
              + +
              <Logging>
              +
              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 ErrorLog and TransactionLog + elements are present, more traditional logging flatfiles will be + generated at the locations specified. A Log4JConfig + element instructs the origin to use Log4J logging.
              + +
              <NameMapping xmlns="urn:mace:shibboleth:namemapper:1.0"
              +format="URN"
              +handleTTL="seconds"
              +id="string"
              +type="type"/>
              +
              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. +
                +
              • format should be populated with the URN urn:mace:shibboleth:1.0:nameIdentifier if traditional +Shibboleth handles are used.
                • +
              • handleTTL 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. format is +urn:mace:shibboleth:1.0:nameIdentifier. Consult your +federation guidelines for guidance on the population of this field.
                • +
              • id is used by HSNameFormat elements to refer to this element and must +be unique.
                • +
              • type dictates how handles are passed to the AA. +The valid types are:
                  +
                • CryptoHandleGenerator: Shibboleth handles will be +passed using symmetric encryption. If this is specified, keystore information +must be specified using one KeyStorePath element, one KeyStoreKeyAlias +element, one KeyStorePassword element, and optionally a KeyStoreKeyPassword element.
                  • +
                • Principal: Shibboleth will use the primary unique +identifier for the individual and not generate a handle.
                  • +
                • SharedMemoryShibHandle: Shibboleth will use a +shared in-memory repository.
                  • +
                • +
              + +
              <Path>pathname</Path>
              +
              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.
              + +
              <ReleasePolicyEngine>
              +
              The ReleasePolicyEngine + element is used to specify a class of release policy processing. This + should contain one ArpRepository element.
              + +
              <RelyingParty name="URI"
              +AAsigningCredential="string"
              +AAUrl="URL"
              +defaultAuthMethod="URN"
              +passThruErrors="true/false"
              +providerId="string"
              +signAttrAssertions="true/false"
              +signAttrResponses="true/false"
              +signAuthAssertions="true/false"
              +signAuthResponses="true/false"
              +signingCredential="string">
              +

              The RelyingParty 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 HSNameMapping + 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.

              +

              The proper RelyingParty 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.

              +
                +
              1. If the requesting provider is unauthenticated -- due to a lack of + SSL client authentication because the AA is not protected by an https:// URL -- the default relying party is + always used.
                2. +
              2. If the requesting provider is Shibboleth 1.1 or less, the default + relying party is used.
                3. +
              3. If a RelyingParty element's providerId attribute matches the name sent by the + target, then that element is used.
                4. +
              4. A metadata lookup is performed using the sites.xml files supplied by FederationProvider elements to determine + whether the target is a member of a common federation. If there is a + RelyingParty 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.
                5. +
              +
                +
              • name: Each RelyingParty element is differentiated by a URI + specified in the name attribute. A target + will send a value for this attribute with the attribute request; if + the URI sent matches the name, 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.
                • +
              • AAsigningCredential: This attribute + must equal the identifier of one of the FileResolver + 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 RelyingParty element, but a signingCredential 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.
                • +
              • AAUrl: 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 AAUrl attribute of the ShibbolethOriginConfig element.
                • +
              • defaultAuthMethod: The value of this + attribute represents the mechanism by which the user's authentication + was performed. It is used to populate authenticationMethod 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 ShibbolethOriginConfig element.
                • +
              • passThruErrors: 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.
                • +
              • providerId: If the origin must assert + under a different name to this relying party, specify a providerId attribute which will over-ride the one + specified in ShibbolethOriginConfig.
                • +
              • signAttrAssertions: If this boolean + attribute has a value of true, 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 false.
                • +
              • signAttrResponses: If this boolean + attribute has a value of true, 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 false; if true, an https:// AAUrl may be redundant.
                • +
              • signAuthAssertions: If this boolean + attribute has a value of true, 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 false.
                • +
              • signAuthResponses: If this boolean + attribute has a value of false, the + authentication response will not be signed. SAML responses contain + one or more assertions. Defaults to true.
                • +
              • signingCredential: This attribute must + equal the identifier of one of the FileResolver 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.
                • +
              -
              Specifes the URI used to populate - AuthenticationMethod in the SAML - attribute assertion. This corresponds to the method used to authenticate - users by the authentication service used by the HS. Some common + +
              <ShibbolethOriginConfig
              +xmlns="urn:mace:shibboleth:origin:1.0"
              +xmlns:cred="urn:mace:shibboleth:credentials:1.0"
              +xmlns:name="urn:mace:shibboleth:namemapper:1.0"
              +defaultRelyingParty="URI"
              +providerID="URI"
              +AAUrl="URL"
              +authHeaderName="string"
              +defaultAuthMethod="URN"
              +maxHSThreads="integer"
              +passThruErrors="true/false"
              +resolverConfig="pathname">
              +

              This is the primary element that defines an origin.xml file and is the container for every other element and must appear once and only once. For most deployments, all the xmlns attributes, which specify the handlers for different aspects of origin operation, should remain unchanged. The mandatory attributes must be changed before operating the origin.

              +
                +
              • defaultRelyingParty: This specifies the relying party to use for a request when no RelyingParty element's name attribute matches the policy URI of an incoming request. Typically, this will be populated with the URI of a federation.
                • +
              • providerID: The origin uses this unique name to identify assertions it issues. This will usually be assigned by a federation.
                • +
              • AAUrl specifies the URL where the AA for this HS resides, which must be consistent with how it is defined in Tomcat. Note that this must be an https:// URL in order for the AA to know which SHAR is requesting attributes for ARP purposes.
                • +
              • authHeaderName: If authentication methods are passed to the HS using an HTTP header variable other than the default, SAMLAuthenticationMethod, the name of the variable may be specified here.
                • +
              • defaultAuthMethod: This specifies the authentication method that will be assumed if none is passed through and there is no overriding defaultAuthMethod specified for this target using a RelyingParty element. If neither this element nor the matching RelyingParty element contains this attribute, a value of urn:oasis:names:tc:SAML:1.0:am:unspecified will be used for authenticationMethod. 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. + specifications or your federation's guidelines. +
                - - + - -
                + urn:oasis:names:tc:SAML:1.0:am:password The authentication was performed using a password.
                urn:ietf:rfc:1510urn:ietf:rfc:1510 The authentication was performed using Kerberos.
                + urn:oasis:names:tc:SAML:1.0:am:X509-PKI 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.
                -
              -
              -


              -

              -

              Assertion Signing:

              -
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath = - <pathname>
              -
              Specifies the location of the Java keystore containing - the x.509 certificate and matching private key to be used by the HS.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword = - <password>
              -
              Specifies the password to the referenced keystore.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias = - <alias>
              -
              Specifies the alias used for accessing the private - key.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword - = <password>
              -
              Specifies the password used to retrieve the private - key.
              -
              - edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias = <alias> -
              -
              Specifies the alias for the certificate - corresponding to the private key used by the HS. Defaults to the private - key's alias.
              -
              -


              -

              -

              General AA Configuration:

              -
              -
              - edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName = <domain - name>
              -
              Specifies the name of the AA, which is typically the - domain name of the server running it.
              -
              - edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors = - <true/false>
              -
              Specifies whether the AA should pass on internal - errors to the SHAR for debugging purposes. Defaults to - false.
              -
              -

              AA Attribute Resolution:

              -
              -
              - edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver.ResolverConfig - = <pathname>
              -
              Specifies the location of the configuration file for - the resolver the AA uses to build attributes. Defaults to - /conf/resolver.xml. For information on - how to configure and use the attribute resolver, consult section - 4.e.
              -
              -

              ARP Configuration:

              -
              -
              - edu.internet2.middleware.shibboleth.aa.arp.ArpRepository.implementation - = <string>
              -
              References the type of ARP repository implemented. - Shibboleth provides a built-in ARP repository specified by - edu.internet2.middleware.shibboleth.aa.arp. - provider.FileSystemArpRepository.

              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.

              -
              - edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path - = <pathname>
              -
              Specifies the relative or absolute path to the folder - containing the ARP files.
              -
              - edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.ArpTTL - = <seconds>
              -
              Specifies the duration in - seconds that ARP's may be cached by the AA. Defaults to - 0, or no caching.
              -
              -

              Handle Repository Configuration:

              -
              -
              - edu.internet2.middleware.shibboleth.hs.HandleRepository.implementation = - <string>
              -
              Specifies the method by which the HS and AA share - handles. These are by default passed by memory(which can be specified - explicitly using - edu.internet2.middleware.shibboleth.hs.provider. MemoryHandleRepository), - and may also be passed using symmetric encryption with - - edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.
              -
              -

              edu.internet2.middleware.shibboleth.hs.provider. MemoryHandleRepository - (specify if - edu.internet2.middleware.shibboleth.hs.HandleRepository. implementation - is MemoryHandleRepository)

              -
              -
              -
              - edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL - = <seconds>
              -
              Specifies the time in - seconds for which issued handles are valid. Defaults to - 1800, 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.
              -
              -
              -

              edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository - (specify if - edu.internet2.middleware.shibboleth.hs.HandleRepository. implementation - is CryptoHandleRepository)

              -

              In order to use the crypto repository implementation, you must have a - DESede secret key in a keystore of type - JCEKS. The origin distribution includes a - program that will automatically generate such a key. In order to invoke it, - run ./ant genSecret, which will create a - keystore in $SHIB_HOME/src/conf/handle.jks - that includes the key, with an alias of handleKey - and a password of shibhs. If - ./ant dist is run subsequently, this - keystore will be included in the webapp archive that is created.

              -
              -
              -
              - edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePath - = <pathname>
              -
              Specifies the path to the keystore containing the - key used to encrypt passed principal identifiers.
              -
              - edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePassword - = <password>
              -
              Specifies the password for the keystore.
              -
              - edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyAlias - = <password>
              -
              Specifies the alias for the appropriate encryption - key within the keystore.
              -
              - edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyPassword - = <password>
              -
              Specifies the password used to retrieve the - key.
              -
              - edu.internet2.middleware.shibboleth.hs.CryptoHandleRepository.handleTTL - = <seconds>
              -
              Specifies the time in - seconds for which issued handles are valid. Defaults to - 1800, 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.
              -
              -
              -

              Federation Configuration:

              -
              -
              - edu.internet2.middleware.shibboleth.audiences = <URI's>
              -
              Specifies a list of URI's - that will be used for the Audience 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.

              Note that the values of the URI's here - must match one of the policy URI's accepted by the receiving target - in the [policies] section of - shibboleth.ini or interoperation will - fail by design.

              +
              7. +
            7. maxHSThreads: 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.
              8. +
            8. passThruErrors: 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.
              9. +
            9. resolverConfig specifies the location of the configuration file for the resolver the AA uses to build attributes and if unspecified defaults to /conf/resolver.xml. For information on how to configure and use the attribute resolver, consult section 4.e.
              10. +
        + + +
        <StorePassword>string</StorePassword>
        +
        Specifies the password for the keystore. Contained by the KeyStoreResolver element.
        + +
        <TransactionLog location="URL">
        +
        Paired with an ErrorLog 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 Logging element.
        +


        @@ -1288,23 +1640,25 @@ configuration 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 - arp.site.xml and user ARP's are stored as - arp.user.$PRINCIPALNAME.xml. Up to two ARP's + arp.site.xml and user ARP's are stored as + arp.user.$PRINCIPALNAME.xml. Up to two ARP's will apply to a principal: the site ARP, and the user ARP for that principal.

        -

        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.

        +

        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 providerId. 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.

        When a query is received, the AA generates an effective ARP, which is the - fully evaluated set of ARP rules regarding that SHAR based on all ARP + fully evaluated set of ARP rules regarding that relying party based on all ARP containers applicable to the principal. This effective ARP is then applied to attribute values retrieved from the directory and the appropriate assertion is constructed. Default rules are always included in construction @@ -1313,14 +1667,13 @@ configuration

        5.b.i. ARP Processing

        -

        When a request arrives from a particular SHAR, the applicable set of +

        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:

        1. Identify all ARP's that should be applied to a particular principal. This is done by isolating the files in the folder - specified by - edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path + specified by the ArpRepository element that have the name either arp.site.xml or arp.user.$PRINCIPALNAME.xml.
        2. Find all ARP rules relevant to the query: @@ -1331,12 +1684,12 @@ configuration
        3. For each non-default rule in each identified ARP, the matching functions specified in the rule's target definition are performed. A separate matching function is performed for the - requesting SHAR and the resource on behalf of which the SHAR is + requesting SHAR and the providerId on behalf of which the SHAR is making the request.
          4. -
        4. Each matching function evaluates to +
        5. Each matching function evaluates to TRUE if the match is successful or - FALSE if it is unsuccessful. If - both functions evaluate to TRUE, + FALSE if it is unsuccessful. If + both functions evaluate to TRUE, the rule is included in the Effective ARP.
        @@ -1344,17 +1697,17 @@ configuration
        1. For each attribute, compile a temporary list of associated rules that includes all values with a release qualifier of - permit.
          2. + permit.
        2. Subtract from this list all attribute values with rules - specifying a release qualifier of deny. + specifying a release qualifier of deny. 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.
        3. If a statement specifies that all values should be - permitted, then specific deny + permitted, then specific deny qualifiers for specific values should still be enforced. If a statement specifies that all values should be denied, then - permit qualifiers for specific + permit qualifiers for specific values will be ignored.
        @@ -1367,23 +1720,23 @@ configuration

        Each ARP is described by an XML file based on a standard - .xsd schema. It consists of a standard - AttributeReleasePolicy element - referencing the appropriate xsi:schemaLocation - and a self-explanatory Description - element followed by any number of Rule - elements. Each Rule element must consist - of a Target element and one or more - Attribute elements. The - Target element specifies the rules by - which the target definition is formed. The + .xsd schema. It consists of a standard + AttributeReleasePolicy element + referencing the appropriate xsi:schemaLocation + and a self-explanatory Description + element followed by any number of Rule + elements. Each Rule element must consist + of a Target element and one or more + Attribute elements. The + Target element specifies the rules by + which the target definition is formed. The Attribute elements specifies the name and values of the attributes that may be released.

        The simplest possible ARP is as follows, which releases - eduPersonScopedAffiliation to any target + eduPersonScopedAffiliation to any target for the users the ARP applies to:

        -

        <?xml version="1.0"?>
        +

        <?xml version="1.0"?>
        <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">
        @@ -1408,61 +1761,69 @@ configuration

        All ARP's must take the same basic form. A detailed description of how - each element of the Rule element may be + each element of the Rule element may be sub-populated follows:

        -

        The Target element:

        +

        The Target element:

        -

        Target may contain either the - AnyTarget element, which will cause the - Target to always return - TRUE, or both the - Requester element, which provides for - matches to be performed against the SHAR name and the - Resource element, which provides for +

        Target may contain either the + AnyTarget element, which will cause the + Target to always return + TRUE, or both the + Requester element, which provides for + matches to be performed against the SHAR name for 1.1 targets or the providerId for 1.2 targets, and the + Resource element, which provides for matches to be performed against the requested URL.

        +

        When going against 1.1 targets, the Resource element will refer to individual URL trees + protected by a given SHAR. However, due to the nature of application + identifiers, the Resource element has no + meaning when releasing to 1.2 targets. These will always function as + though <AnyResource/> is specified, + making the entire Resource element necessary + only if this origin will be applying this ARP to 1.1 targets.

        There are three matches that may be performed by the AA in evaluating - ARP's by using the matchFunction - component of the Requester and - Resource elements. The following match + ARP's by using the matchFunction + component of the Requester and + Resource elements. The following match patterns may be specified directly following the - Requester or - Resource elements, such as <Requester + Requester or + Resource elements, such as <Requester matchFunction="urn:mace:shibboleth:arp:matchFunction:regexMatch">:

          -
        • +
        • urn:mace:shibboleth:arp:matchFunction:exactShar
          -

          May be used with the Requester +

          May be used with the Requester element.

          -

          Evaluates to TRUE when the - string content of the Requester - element matches exactly the name of the requesting SHAR. - Otherwise evaluates to FALSE. +

          Evaluates to TRUE when the + string content of the Requester + element matches exactly the providerId of the requesting application of 1.2 targets or the SHAR name of 1.1 targets. + Otherwise evaluates to FALSE. Serves as the default value associated with - Requester if none is specified.

          + Requester if none is specified.

          • -
        • +
        • urn:mace:shibboleth:arp:matchFunction:resourceTree
          -

          May be used with the Resource - element.

          -

          Evaluates to TRUE when the +

          May be used with the Resource + element. However, this has no meaning when releasing to 1.2 targets.

          +

          Evaluates to TRUE when the location of the resource either matches exactly or begins with - the string content of the Resource - element. Otherwise evaluates to FALSE.

          + the string content of the Resource + element. Otherwise evaluates to FALSE.

          • -
        • +
        • urn:mace:shibboleth:arp:matchFunction:regexMatch
          -

          May be used with both the Requester - and Resource elements.

          -

          Evaluates to TRUE when the - name of the requesting SHAR or the requested URL tree is a valid +

          May be used with both the Requester + and Resource elements.

          +

          Evaluates to TRUE 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 - FALSE. Regular expressions are + FALSE. Regular expressions are evaluated in accordance with the the Java 1.4 Pattern API.

          @@ -1470,109 +1831,72 @@ configuration
        -

        The Attribute element:

        +

        The Attribute element:

        -

        The Attribute element must always +

        The Attribute element must always specify the URN of the attribute whose release parameters it specifies. - Additionally, it must contain either the - AnyValue element or one or more Value + Additionally, it must contain either the + AnyValue element or one or more Value elements. These elements, in turn, must specify either - release = - permit or deny. The - Value element must then contain one + release = + permit or deny. The + Value element must then contain one value for which the rule applies. Examples:

        -

        <Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName">
        +

        <Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName">
          <AnyValue release="Permit">
        </Attribute>

        -

        Permits the release of +

        Permits the release of eduPersonPrincipalName with any value.

        -

        <Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation">
        +

        <Attribute name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation">
          <Value release="deny">member@example.edu</Value>
        </Attribute>

        -

        Denies the release of - eduPersonScopedAffiliation value +

        Denies the release of + eduPersonScopedAffiliation value member@example.edu. Other values of the attribute may still - be released if so specified by a permit + be released if so specified by a permit ARP.

        -

        5.c. Sharing certificate/key pairs between Apache and Java keystores (optional)

        -

        The JDK includes the command line program +

        The JDK includes the command line program keytool 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 extkeytool, - a program that can be used in conjunction with + Shibboleth distribution includes extkeytool, + a program that can be used in conjunction with keytool to perform these tasks. Select the appropriate step-by-step procedure for your situation from the following guides.

        -

        Before running extkeytool, the +

        Before running extkeytool, the variable SHIB_HOME must be set to the path to the directory where the - Shibboleth tarball was exploded(typically /opt/shibboleth-origin-1.1/).

        + Shibboleth tarball was exploded(typically /opt/shibboleth-origin-1.2/).

        If you have a pre-exiting RSA key/certificate combination in a keystore and you would like to use it with Apache:

        1. 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 yourstore, the + keystore is named yourstore, the following command should present a list of the entries in the keystore.
          -

          $ keytool -list -v -keystore +

          $ keytool -list -v -keystore yourstore

        2. Assuming that you identified the appropriate alias as - youralias and the password for the - keystore is yourpass, enter the + youralias and the password for the + keystore is yourpass, enter the following command to export the key in Base64-encoded pkcs8 format.
          -

          $ extkeytool -exportkey -keystore +

          $ extkeytool -exportkey -keystore yourstore -alias youralias -storepass yourpass -rfc -file yourkey.pkcs8

          @@ -1582,28 +1906,28 @@ Java keystores (optional) unencrypted or encrypted:
          1. To use the unencrypted format, enter the following command for the conversion:
            -

            $ openssl pkcs8 -in +

            $ openssl pkcs8 -in yourkey.pkcs8 -nocrypt|openssl rsa -out yourkey.key

          2. To use the encrypted format, enter the following command for the conversion:
            -

            $ openssl pkcs8 -in +

            $ openssl pkcs8 -in yourkey.pkcs8 -nocrypt|openssl rsa -des3 -out yourkey.enckey

        3. The following command will export the corresponding certificate.
          -

          $ keytool -export -keystore +

          $ keytool -export -keystore yourstore -alias youralias -rfc -file yourcert

          4. -
        4. Set the mod_ssl - SSLCertificateKeyFile and - SSLCertificateFile directives to +
        5. Set the mod_ssl + SSLCertificateKeyFile and + SSLCertificateFile directives to point to the two files you have just created. Take care to remove - any temporary files you created (i.e. + any temporary files you created (i.e. yourkey.pkcs8) and set appropriate file permissions, especially if you chose to store the key in an unencrypted format.
        @@ -1612,9 +1936,9 @@ Java keystores (optional)
        1. Convert the private key to unencrypted DER-encoded pkcs8 format. Assuming your PEM-encoded key is stored in a file named - yourkey.enckey, enter the following + yourkey.enckey, enter the following command.
          -

          $ openssl pkcs8 -in yourkey.enckey +

          $ openssl pkcs8 -in yourkey.enckey -topk8 -nocrypt -outform DER -out yourkey.der.pkcs8

          2. @@ -1622,23 +1946,23 @@ Java keystores (optional) 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 mycert and the CA signer - certificate is stored in a file named + named mycert and the CA signer + certificate is stored in a file named ca.cert, you might enter the following command to create the bundle.
          -

          $ cat mycert ca.cert > cert.bundle

          +

          $ cat mycert ca.cert > cert.bundle

          -

          Note: mod_ssl-enabled Apache +

          Note: mod_ssl-enabled Apache installations include a number of commonly recognized CA - certificates in the ca-bundle.crt - file under the $ServerRoot/conf/ssl.crt/ + certificates in the ca-bundle.crt + file under the $ServerRoot/conf/ssl.crt/ directory.

        2. Import the key and certificate into the keystore. Assuming you - have already created a keystore named - yourstore with a password of of + have already created a keystore named + yourstore with a password of of yourpass, enter the following command to store the data under - the alias youralias.
          -

          $ ./extkeytool -importkey -keystore + the alias youralias.

          +

          $ ./extkeytool -importkey -keystore yourstore -alias youralias -storepass yourpass -keyfile yourkey.der.pkcs8 -certfile cert.bundle -provider org.bouncycastle.jce.provider.BouncyCastleProvider

          @@ -1646,34 +1970,34 @@ Java keystores (optional)
        3. You can verify that the import was successful by listing entry. Use the command below.
          -

          $ keytool -list -v -keystore +

          $ keytool -list -v -keystore yourstore -alias youralias

          4. -
        4. Remember to delete yourkey.der.pkcs8, +
        5. Remember to delete yourkey.der.pkcs8, as it contains your unencrypted private key.

        If you are starting from scratch and do not yet have a certificate/key pair:

        1. Generate an RSA private key. Use the command below, substituting - yourkey with an appropriate name to + yourkey with an appropriate name to use to refer to the key.
          -

          $ openssl genrsa -des3 -out +

          $ openssl genrsa -des3 -out yourkey.enckey 1024

        2. The following command generates a Certificate Signing Request, which should be communicated to a Certificate Authority.
          -

          $ openssl req -new -key +

          $ openssl req -new -key yourkey.enckey

        3. The Certificate Authority should respond with a PEM-encoded X509 - certificate. Set the mod_ssl - SSLCertificateKeyFile directive to + certificate. Set the mod_ssl + SSLCertificateKeyFile directive to point to the key file you just created and the - SSLCertificateFile directive to + SSLCertificateFile 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.
          4. @@ -1687,10 +2011,10 @@ Java keystores (optional)

          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 + be pointed to with the edu.internet2.middleware.shibboleth.aa. attrresolv.AttributeResolver.ResolverConfig propety in - origin.properties as described in section + origin.xml as described in section 4.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.

          @@ -1701,64 +2025,64 @@ Java keystores (optional) 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.

          -

          The resolver.xml file that is pointed to - by origin.properties consists of zero or +

          The resolver.xml file that is pointed to + by origin.xml 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.

          -

          Shibboleth comes with two attribute definitions provided in version 1.1: - the SimpleAttributeDefinition, which acts as +

          Shibboleth comes with two attribute definitions provided in version 1.2: + the SimpleAttributeDefinition, which acts as a basic proxy for attributes supplied by data connectors with some name - conversion and attribute scoping added, and a + conversion and attribute scoping added, and a CustomAttributeDefinition, which can be used to configure - user-created attribute definition plugins. Similarly, Shibboleth 1.1 comes - with two data connectors: the + user-created attribute definition plugins. Similarly, Shibboleth 1.2 comes + with two data connectors: the JNDIDirectoryDataConnector, which pulls data from any source for which there is a JNDI Directory Context implementation, including LDAP, NDS, - etc., and the CustomDataConnector, which is + etc., and the CustomDataConnector, which is used to configure user-created data connector plugins.

          A detailed explanation of each configuration option for the provided connectors follows:

          -

          JNDIDirectoryDataConnector:

          +

          JNDIDirectoryDataConnector:

          -
          id = <string>
          +
          id = <string>
          Specifies a unique, textual name for the connector used by attribute definitions to refer to and use it to build - attributes. Contained within the + attributes. Contained within the JNDIDirectoryDataConnector element.
          -
          <Property name="<name>" +
          <Property name="<name>" value="<value>"/>
          -
          An element of the element +
          An element of the element JNDIDirectoryDataConnector. 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 resolver.xml. Refer to the + within resolver.xml. Refer to the Shibboleth CVS for an example of names and values used to connect to an LDAP directory.
          -
          <Search>
          -
          An element of the element +
          <Search>
          +
          An element of the element JNDIDirectoryDataConnector. This element defines the DN filter used to perform the LDAP search. The search string must return no more than one result.
          -
          <Controls>
          -
          An element of the element +
          <Controls>
          +
          An element of the element Search. This element grants some fine-grained control over the LDAP API calls.
          -
          <cacheTime +
          <cacheTime "<seconds>"/>
          -
          An element of the element +
          An element of the element JNDIDirectoryDataConnector. Specifies an optional duration in - seconds for which the attribute resolver + seconds for which the attribute resolver may cache information retrieved from this connector. The default is zero seconds (no caching)
          -

          A representation of a properly constructed +

          A representation of a properly constructed JNDIDirectoryDataConnector element would look like:

          -

          <JNDIDirectoryDataConnector id="directory">
          +

          <JNDIDirectoryDataConnector id="directory">
            <Search filter="cn=%PRINCIPAL%">
              <Controls searchScope="SUBTREE_SCOPE" returningObjects="false" />
            </Search>
          @@ -1767,75 +2091,75 @@ Java keystores (optional)   <cacheTime="2400"/>
          </JNDIDirectoryDataConnector>

          -

          If the ldap server must be accessed over SSL, and JDK 1.4.1 is being used, two changes must be made to the JNDIDirectoryDataConnector element:

          +

          If the ldap server must be accessed over SSL, and JDK 1.4.1 is being used, two changes must be made to the JNDIDirectoryDataConnector element:

          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),

          2. Add this Property element:

          -

          <Property name="java.naming.security.protocol" value="ssl" ">

          +

          <Property name="java.naming.security.protocol" value="ssl" ">

          -

          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 java.naming.provider.url Property.

          +

          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 java.naming.provider.url Property.

          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.

          -

          SimpleAttributeDefinition:

          +

          SimpleAttributeDefinition:

          -
          id = <string>
          +
          id = <string>
          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 + Shibboleth. Contained within the SimpleAttributeDefinition element.
          -
          <AttributeDependency / +
          <AttributeDependency / DataConnectorDependency requires="<id>"/>
          -
          An element of the element +
          An element of the element SimpleAttributeDefinition, which may contain 0 or more of either - AttributeDependency or - DataConnectorDependency. These specify + AttributeDependency or + DataConnectorDependency. These specify attributes and data connectors that can be utilized by this attribute definition. Each of these elements must contain a - requires statement which this attribute + requires statement which this attribute definition can then use to build its value.
          -
          smartScope = +
          smartScope = "<domain>"
          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 (bob@foo.edu), + connector includes a pre-existing scope (bob@foo.edu), that scope is used instead. Contained within the - SimpleAttributeDefinition element.
          -
          <lifeTime + SimpleAttributeDefinition element.
          +
          <lifeTime "<seconds>"/>
          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 - SimpleAttributeDefinition element.
          -
          sourceName = + SimpleAttributeDefinition element.
          +
          sourceName = "<string>"
          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 id. This would be useful + the specified id. This would be useful to send a local UniversityID attribute as eduPersonPrincipalName. If not - supplied, the connector tokenizes the id - field and uses the section following the # - to query data connectors. Contained within the + supplied, the connector tokenizes the id + field and uses the section following the # + to query data connectors. Contained within the SimpleAttributeDefinition element.
          -
          <cacheTime +
          <cacheTime "<seconds>"/>
          Specifies an optional duration in - seconds for which the attribute resolver + seconds for which the attribute resolver may cache this attribute for use in additional assertions. Contained within - the SimpleAttributeDefinition element.
          + the SimpleAttributeDefinition element.
          -

          A representation of a properly constructed +

          A representation of a properly constructed SimpleAttributeDefinition element would look like:

          -

          <SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName"
          +

          <SimpleAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonPrincipalName"
          smartScope="shibdev.edu" cacheTime="600" lifeTime="3600" sourceName="universityPerson">
            <DataConnectorDependency requires="dataConnector"/>
            <AttributeDependency requires="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"/>
          </SimpleAttributeDefinition>

          -

          A properly formed resolver.xml file to +

          A properly formed resolver.xml file to automatically generate a simple response for EPPN may take the form:

          -

          <AttributeResolver xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +

          <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">

          @@ -1849,34 +2173,34 @@ Java keystores (optional) />
          </AttributeResolver>

          -

          There are additional examples of resolver.xml +

          There are additional examples of resolver.xml files provided in the Shibboleth CVS.


        -

        5.d.i resolvertest

        +

        5.d.i resolvertest

        Shibboleth comes bundled with the command line utility - resolvertest for testing Attribute Resolver - configurations. This program takes as input + resolvertest for testing Attribute Resolver + configurations. This program takes as input resolver.xml, 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. resolvertest 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:

        + application. resolvertest 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:

          -
        1. Set the shell variable SHIB_HOME to +
        2. Set the shell variable SHIB_HOME to the directory path where the Shibboleth tarball was exploded (typically - /opt/shibboleth-origin-1.1/).
          3. + /opt/shibboleth-origin-1.2/).
        3. Move to $SHIB_HOME/bin
        -

        resolvertest may then be used by +

        resolvertest 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:

        -

        $ ./resolvertest --user=wassa +

        $ ./resolvertest --user=wassa --file=file:///$SHIB_HOME/src/conf/resolver.xml

        NOTE: This program does not filter the resulting attributes through the @@ -1920,7 +2244,7 @@ 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 -mace-shib-users@internet2.edu +shibboleth-users@internet2.edu with a thorough description of errors and configurations used.

        6.a. Basic Testing

        @@ -1941,21 +2265,21 @@ with a thorough description of errors and configurations used.

        Shibboleth's origin components log various operations which may prove useful for auditing, testing, and security purposes. This data is sent - through log4j's standard mechanism. The + through log4j'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 - /WEB-INF/classes/conf/log4j.properties. By + /WEB-INF/classes/conf/log4j.properties. By default, it is setup to log to the console of the servlet container, with a - level of WARN, but there is also a commented + level of WARN, but there is also a commented out example in the file to give a possible alternate configuration.

        6.c. Common Problems

        A knowledge base is being developed in the - + Shibboleth Deployer's FAQ. Please mail - mace-shib-users@ - internet2.edu with any additional questions or problems encountered that + shibboleth-users@nternet2.edu + with any additional questions or problems encountered that are not answered by this basic guide.

        diff --git a/doc/DEPLOY-GUIDE-TARGET.html b/doc/DEPLOY-GUIDE-TARGET.html index 91a74ce..1045a48 100644 --- a/doc/DEPLOY-GUIDE-TARGET.html +++ b/doc/DEPLOY-GUIDE-TARGET.html @@ -1,10 +1,7 @@ - + - - - Shibboleth Target Deployment Guide