From: cantor Date: Tue, 4 May 2004 05:52:56 +0000 (+0000) Subject: Revised commands again, updated later sections X-Git-Tag: v2.1.3~1586 X-Git-Url: https://repo.niif.hu/gitweb/gitweb.cgi?p=java-idp.git;a=commitdiff_plain;h=67e0872fad10c1cd6158bb688bad70b72c0ca62f Revised commands again, updated later sections git-svn-id: https://subversion.switch.ch/svn/shibboleth/java-idp/trunk@1050 ab3bd59b-922f-494d-bb5f-6f0a3c29deca --- diff --git a/doc/DEPLOY-GUIDE-TARGET.html b/doc/DEPLOY-GUIDE-TARGET.html index fbdc64a..1045a48 100644 --- a/doc/DEPLOY-GUIDE-TARGET.html +++ b/doc/DEPLOY-GUIDE-TARGET.html @@ -78,6 +78,17 @@ background-image: url('none'); margin: 0px; padding: 2px } +.attributeopt +{ +font-size: 115%; +font-color: #000000; +text-align: left; +background-color: #EEEEEE; +border: 1px inset black; +background-image: url('none'); +margin: 0px; +padding: 2px +} .value { font-color: #000000; @@ -124,7 +135,7 @@ color: #00FF00

Shibboleth Target Deployment Guide
Shibboleth Version 1.2
-April 4, 2004
+April 30, 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.

@@ -138,17 +149,8 @@ in conjunction with proper trust settings and policies.

The Shibboleth target implementation has been substantially redesigned for this release. Most of the configuration process has changed to accomodate more complex deployments but many of the defaults work -fine for testing and simpler applications. Among the new features:

- +fine for testing and simpler applications. For a list of new features, please refer to the NEWS.txt +file in the doc/ folder of the distribution.

Before starting, please sign up for all applicable mailing @@ -187,7 +189,7 @@ that arises.

  • Security Considerations
  • Server Certificates
  • Attribute Release Policies
    • -
  • Attribute Acceptance Policies
    • +
  • Attribute Acceptance Policies
  • Browser Requirements
  • Clocks
  • Other Considerations
    • @@ -427,43 +429,32 @@ requesting attributes.

    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 -entirely written in Java on the origin side. These are the recommendations and -requirements for a successful implementation of a Shibboleth origin.

    +to ensure Shibboleth functions well, both political and technical. Shibboleth +currently runs on a specific range of platforms and web server environments. The +SHAR and SHIRE are implemented entirely in C/C++. These are the recommendations +and requirements for a successful implementation of a Shibboleth target.

    2.a. Requirements

    - +
    +

    Shibboleth currently supports Windows NT/2000/XP/2003, Linux, and + Solaris. At present, Shibboleth consists of Apache (or IIS) plugins and a + separate SHAR process. The plugins use the Sun/ONC RPC mechanism to communicate + with the SHAR over Unix domain or TCP sockets. The target's web servers must + be running Apache + 1.3+, 2.0+, or Microsoft IIS 4.0+ More precise technical + details are discussed in 3.a.

    +

    2.b. Join a Federation

    While it is not necessary for a target or origin to join a federation, doing so greatly facilitates the implementation of multilateral trust - relationships. Each federation will have a different application process. - When an origin is accepted into a federation, its information is added to - the sites file used by the WAYF and target sites.

    -

    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.

    + relationships. Each federation will have a different application process.

    +

    For more information on federations, refer to 1.d or + the Shibboleth v1.0 architectural document.

    +

    For testing in a private environment, Shibboleth comes with a default + configuration that demonstrates how to implement a local peered agreement + and supports testing both origin and target on the same box using localhost + URLs. The sample key and certificate is for ease of testing only, and should + always be replaced for real world use.

    2.c. Security Considerations

    @@ -473,7 +464,9 @@ requirements for a successful implementation of a Shibboleth origin.

    Shibboleth is as secure as possible, there are several recommended security precautions which should be in place at local sites.

      -
    1. SSL use is optional for origin sites. Federation guidelines should +
    2. SSL use is optional for target sites, but should be used if at all + possible, at least in the processing of incoming sessions (called the + SHIRE URL or assertion consumer service). Federation guidelines should be considered when determining whether to implement SSL, and, in general, SSL should be used for interactions with client machines to provide the necessary authentication and encryption to ensure protection @@ -486,7 +479,7 @@ requirements for a successful implementation of a Shibboleth origin.

      against this is safeguarding the WAYF service and ensuring that rogue targets and origins are not used, generally by development of the trust model underneath Shibboleth. Shibboleth also leverages DNS for security, - which is not uncommon, but attacks concerning bad domain information + which is not uncommon, but attacks concerning domain name lookups should be considered.
    3. Information regarding origin users is generally provided by the authoritative enterprise directory, and the acceptance of requests from @@ -500,17 +493,18 @@ requirements for a successful implementation of a Shibboleth origin.

      recipe for more information). Use of plaintext passwords is strongly advised against.
    4. Server platforms should be properly secured, commensurate with the - level that would be expected for a campus' other security services, and - cookie stores on client machines should be well protected.
      5. + level that would be expected for an organization's other security + services, and cookie stores on client machines should be well protected.

    2.d. Server Certs

    -

    In the Shibboleth architecture, the origin and target must each have +

    In the Shibboleth architecture, the origin and target software must all have various client and/or server certificates for use in signing assertions and - creating SSL channels. These should be issued by a commonly accepted CA, - which may be stipulated by some Federation rules. Different federations may - require the use of different CA's.

    + creating SSL connections These should be issued by a commonly accepted CA, + which may be stipulated by your federation. After understanding the CA's + acceptible to your federations, consult chapter 4.c for + information on certificate and key generation.

    2.e. Attribute Release Policies

    @@ -547,15 +541,20 @@ requirements for a successful implementation of a Shibboleth origin.

    can be maintained either administratively or by the users themselves. All ARP's are specified using the same syntax and semantics.

    -

    2.f. Designate Contacts

    +

    2.f. Attribute Acceptance Policies

    -

    Since Shibboleth deals both with daily technical and operational issues - and also with contractual issues, a set of contacts should be set up to - support the user base and to facilitate interactions with other Shibboleth - sites and federation members. It is recommended that at least technical and - administrative contacts be designated. These contacts are then supplied to - the federation and optionally to relying parties individually to facilitate - communications and troubleshooting.

    +

    When a target receives a set of attributes, it must evaluate them in the + context of the Attribute Authority that is providing them, to assess their + "reasonableness". For example, if the value of an attribute is expected to + be from a small set of enumerated choices, the value should be compared + against that list. If a particular attribute or value is only trusted when + asserted by specific origins, that too should be checked.

    +

    Targets are configured to accept specific attributes that they understand + and care about, and are also configured with the rules to apply before + accepting the attributes for use by the RM or an application. Attributes and + values that don't meet the target's requirements are filtered out. The set + of configuration rules to make these decisions is called an Attribute + Acceptance Policy (AAP).

    2.g. Browser Requirements

    @@ -568,11 +567,11 @@ requirements for a successful implementation of a Shibboleth origin.

    2.h. Clocks

    NTP should be run on all - web servers. Shibboleth employs a short handle issuance time to protect + web servers. Shibboleth employs a short assertion acceptance window to protect against replay attacks. Because of this, any significant degree of clock skew can hinder the ability of users to access sites successfully.

    -

    2.i. Other Considerations

    +

    2.i. Other Considerations

    Especially for higher education, there are a handful of laws enacted which may have important ramifications on the disclosure of personal @@ -612,8 +611,8 @@ most minor "letter" updates should be usable.

    should include SSL support (preferably using mod_ssl), and EAPI support (which mod_ssl requires and provides).

    Portions of the libphp4 Apache - module are written in C++, as is Shibboleth. There is a known - conflict between the PHP extensions libpspell.so + module are written in C++, as is Shibboleth. There is a known conflict on Unix + platforms between the PHP extensions libpspell.so and libsablot.so which will manifest itself as segmentation faults when starting Apache. If a site wants to use libphp4.so and Shibboleth at the same time, @@ -664,7 +663,12 @@ most minor "letter" updates should be usable.

  • Any Apache modules used, and Apache itself, must be compiled with the Microsoft DLL-based runtime, selected by compiling with - the /MD switch.

    + the /MD switch. The binary distribution was built against Apache + versions 1.3.29 (with EAPI patches from mod_ssl 2.8.16) and 2.0.48. + Forward compatibility is likely, but errors will result if an + Apache implementation such as IBM's IHS product or any other + non-EAPI version of 1.3 is used. In such cases, you must build + the Shibboleth Apache modules from source.

  • The installer will prompt for an install path, change default @@ -685,8 +689,8 @@ most minor "letter" updates should be usable.

  • RedHat Linux 7.2,7.3:
    • -

      The most recent Red Hat RPM (1.3.27-2 as of this writing) is sufficient for - use with Shibboleth. You can use the older version of OpenSSL included, for this +

      The most recent Red Hat RPM for Apache (1.3.27-2 as of this writing) is sufficient for + use with Shibboleth. You can use the older version of OpenSSL included with the OS, for this release, but be advised this may change in the future.

    • @@ -701,14 +705,14 @@ most minor "letter" updates should be usable.

    • RedHat Linux 9 / Fedora
      • -

        Apache 2.0 is included as the default version in this release.

        +

        Apache 2.0 is included as the default Apache version in this release.

    • RedHat Enterprise Linux
      • -

        Apache 2.0 is included as the default version in this release.

        +

        Apache 2.0 is included as the default Apache version in this release.

      • @@ -733,7 +737,7 @@ most minor "letter" updates should be usable.

    • The shared library version of OpenSSL is required by Shibboleth. The static libraries may be installed as well if - necessary for other applications, but cannot be used within + necessary for other applications, but cannot be linked into mod_ssl or any other Apache modules. If mod_ssl's libssl.so module is linked against the static version, bus errors will result.

      @@ -752,9 +756,9 @@ most minor "letter" updates should be usable.

      from http://www.sunfreeware.com. If building your own, GCC must be configured to use Sun's linker. Note that you should use a consistent version of GCC across any other C++ libraries - in use within Apache, but other C++ code can freely use a different version - as long as the necessary libstdc++.so for a given - version is available

      + in use within Apache, but other C++ code on your server can freely use a + different version as long as the necessary libstdc++.so + for a given version is available

    • Use of GCC is recommended, but new releases of Sun's Forte compiler have @@ -776,7 +780,7 @@ most minor "letter" updates should be usable.

      On Windows, use of the installer is recommended. Visual Studio 6.0 project files are included with the OpenSAML and Shibboleth source distributions for source builds if maximum flexibility to deal with - security issues is desired.

      + security issues or Apache variants is desired.

    • 3.c. Configure Apache

    @@ -814,15 +818,18 @@ most minor "letter" updates should be usable.

    incoming sessions and lazy session startup for Shibboleth-protected resources. This works in concert with the shireURL settings in the XML configuration file. Any virtual locations that are to be - used for this purpose should be defined to Apache here.

    + used for this purpose should be defined to Apache here.

    +

    Another option for some sites is to configure Shibboleth globally in + "lazy" session mode for all content. This allows the module to + detect session requests and pass them to the handler without the need to + configure the handler itself.

    +
  • If the OpenSSL libraries are not in the system's search path, they should be added to the LD_LIBRARY_PATH used by - Apache. Generally libtool's linker options will insure that the modules - can locate the Shibboleth libraries, but if not, you may need to add - /opt/shibboleth/lib to - LD_LIBRARY_PATH as well.
    • + Apache. You will also usually need to add /opt/shibboleth/lib + to LD_LIBRARY_PATH as well.
  • The SHAR must be started along with Apache. Among other methods on Unix, this can be done either by creating a separate SHAR startup script or by modifying Apache's RC script to start/stop the @@ -856,11 +863,12 @@ most minor "letter" updates should be usable.

    1. The package includes an ISAPI filter and bundled extension for - session processing in a single library, libexec\isapi_shib.dll. + session startup in a single library, libexec\isapi_shib.dll. This filter is configured using commands in C:\opt\shibboleth\etc\shibboleth\shibboleth.xml (or wherever you've installed the software). Make sure you or the installer has added the lib directory to the path as directed in section 3.b. + You will generally need to restart the system after installation.

      Installing the extension into IIS is a two step process:

      1. First, add the filter using the Internet Services @@ -871,9 +879,9 @@ most minor "letter" updates should be usable.

        make sure it appears in the list below the "sspifilt" entry. Restart IIS and make sure the filter shows up with a green arrow. Check the Windows event log if it fails to load.
        2. -
      2. Secondly, map a special file extension, such as +
      3. Secondly, map a special, distinct file extension, such as .shire, to the ISAPI library so that - virtual URLs can be specified to invoke the SHIRE handler for each + virtual URLs can be specified to invoke the extension handler for each web site. Right click on the machine icon on the left, and edit the WWW Service master properties. On the "Home Directory" tab, add a script mapping using the "Configuration" button. The "Executable" @@ -881,7 +889,10 @@ most minor "letter" updates should be usable.

        "Extension" can be set to anything unlikely to conflict, but .shire is assumed (and the dot must be included). You should NOT select the option to limit verbs, and - you MUST uncheck the "Check that file exists" box.
        4. + you MUST uncheck the "Check that file exists" box. On newer + versions of IIS, checking the "Script Engine" box is suggested, + as it will permit the extension to handle requests in directories with only + script permissions assigned.
      4. (IIS 6 Only) A new Web Service Extension must be defined for Shibboleth; without this, the mapping from *.shire to
      5. All other aspects of configuration are handled via the shibboleth.xml file and associated XML files described in subsequent sections. Particular use is made of - the /SHIRE/Implementation/ISAPI element that allows the - IIS sites to be mapped to fully-qualified hostnames for proper request mapping.
        6. + the /SHIRE/Implementation/ISAPI element that allows + IIS sites to be mapped to scheme, hostname, and port for proper request + mapping and generation of redirects.
      6. Instance IDs are used in the IIS metabase to identify web sites. In older versions, they are applied starting with 1(one) and number the web sites in order in the Internet Services Manager from top to bottom. Newer versions appear to assign @@ -950,122 +962,161 @@ most minor "letter" updates should be usable.

        4. Getting Running

        4.a. Configuring shibboleth.xml

        -

        The configuration for the target is mostly contained within shibboleth.xml, located by default at \opt\shibboleth\etc\shibboleth\shibboleth.xml. The target comes pre-configured with certificates and settings that will work against a test origin running on the same server; however, there are several values that must later be changed to interoperate with other sites securely and effectively.

        The following is a hyperlinked version of a basic configuration file, followed by a list of elements and attributes that must be modified. The actual example shipped with Shibboleth includes many more options that are commented out and other elements necessary to support test functionality. Click on any attribute or element for more information on its population and definition.

        +

        The configuration for the target is mostly contained within shibboleth.xml, + located by default at \opt\shibboleth\etc\shibboleth\shibboleth.xml. + The target comes pre-configured with certificates and settings that will work against a test origin + running on the same server; however, there are several values that must later be changed to interoperate + with other sites securely and effectively.

        +

        The following is a hyperlinked version of a basic configuration file, followed by a list of elements + and attributes that must be modified. The actual example shipped with Shibboleth includes many more options + that are commented out and other elements necessary to support test functionality. + Click on any attribute or element for more information on its population and definition.

        -
        +
         <ShibbolethTargetConfig	xmlns="urn:mace:shibboleth:target:config:1.0"
-
                logger="/opt/shibboleth/etc/shibboleth/shibboleth.logger" clockSkew="180">        
-
        
-
            <Extensions>
-
                <Library path="/opt/shibboleth/libexec/xmlproviders.so" fatal="true"/>
-
            </Extensions>
-
        
-
            <SHAR logger="/opt/shibboleth/etc/shibboleth/shar.logger">
-
        
-
                <Extensions>
-
                    <Library path="/opt/shibboleth/libexec/shib-mysql-ccache.so" fatal="false"/>
-
                </Extensions>
-
            
-
                <UnixListener address="/tmp/shar-socket"/>
-
        
-
                <!-- Primarily for IIS Deployments:
-
                <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/>
-
                -->
-
                
-
                <MemorySessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
-
                    defaultLifetime="1800" retryInterval="300" strictValidity="true" propagateErrors="true"/>        
-
                     
-
            </SHAR>
-
            
-
            <SHIRE logger="/opt/shibboleth/etc/shibboleth/shire.logger">
-
        
-
                <RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap">
-
                    <RequestMap applicationId="default">
-
                        <Host name="localhost" scheme="https">
-
                            <Path name="secure" requireSession="true" exportAssertion="true"/>
-
                        </Host>
-
                        <Host name="localhost" scheme="http">
-
                            <Path name="secure" requireSession="true" exportAssertion="true"/>
-
                        </Host>
-
                    </RequestMap>
-
                </RequestMapProvider>
-
              <!-- IIS only:
-
                <Implementation>
-
                    <ISAPI normalizeRequest="true">
-
                        <Site id="1" host="localhost"/>
-
                    </ISAPI>
-
                </Implementation>
-
               -->
-
            </SHIRE>
-
        
-
            <Applications xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
-
                applicationId="default" providerId="https://localhost/shibboleth/target">        
-
                <Sessions lifetime="7200" timeout="3600" checkAddress="true"
-
                    shireURL="/Shibboleth.shire" shireSSL="false" cookieName="_shibsession_default" cookieProps="; path=/"
-
                    wayfURL="https://wayf.internet2.edu/InQueue/WAYF"/>        
-
        
-
                <Errors shire="/opt/shibboleth/etc/shibboleth/shireError.html"
-
                    rm="/opt/shibboleth/etc/shibboleth/rmError.html"
-
                    access="/opt/shibboleth/etc/shibboleth/accessError.html"
-
                    supportContact="root@localhost"
-
                    logoLocation="/shibtarget/logo.jpg"
-
                    styleSheet="/shibtarget/main.css"/>        
-
        
-
                <Policy signRequest="false" signedResponse="false" signedAssertions="false">
-
                    <!--
-
                    <AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"
-
                        AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>        
-
                    -->
-
        
-
                    <AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP" uri="/opt/shibboleth/etc/shibboleth/AAP.xml"/>
-
        
-
                    <FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata"
-
                        uri="/opt/shibboleth/etc/shibboleth/sites.xml"/>        
-
        
-
                    <TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust"
-
                        uri="/opt/shibboleth/etc/shibboleth/trust.xml"/>        
-
        
-
                    <!--
-
                    <RevocationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation"
-
                        uri="/opt/shibboleth/etc/shibboleth/trust.xml"/>        
-
                    -->
-
        
-
                    <saml:Audience>urn:mace:inqueue</saml:Audience>
-
                </Policy>
-
        
-
                <CredentialUse TLS="defcreds" Signing="defcreds">
-
                    <RelyingParty Name="urn:mace:inqueue" TLS="inqueuecreds" Signing="inqueuecreds"/>
-
                </CredentialUse>
-
        
-
            </Applications>
-
        
-
            <CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials">
-
                <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
-
                    <FileResolver Id="defcreds">
-
                        <Key format="PEM">
-
                            <Path>/opt/shibboleth/etc/shibboleth/shar.key</Path>
-
                        </Key>
-
                        <Certificate format="PEM">
-
                            <Path>/opt/shibboleth/etc/shibboleth/shar.crt</Path>
-
                        </Certificate>
-
                    </FileResolver>
-
                </Credentials>
-
            </CredentialsProvider>
-
        
-
        </ShibbolethTargetConfig>
-
        
-
        + logger="/opt/shibboleth/etc/shibboleth/shibboleth.logger" clockSkew="180"> + + <Extensions> + <Library path="/opt/shibboleth/libexec/xmlproviders.so" fatal="true"/> + </Extensions> + + <SHAR logger="/opt/shibboleth/etc/shibboleth/shar.logger"> + + <Extensions> + <Library path="/opt/shibboleth/libexec/shib-mysql-ccache.so" fatal="false"/> + </Extensions> + + <UnixListener address="/tmp/shar-socket"/> + + <!-- Primarily for Windows Deployments: + <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/> + --> + + <!-- + <MemorySessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15" + defaultLifetime="1800" retryInterval="300" strictValidity="true" propagateErrors="true"/> + --> + + <MySQLSessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15" + defaultLifetime="1800" retryInterval="300" strictValidity="true" propagateErrors="true" + mysqlTimeout="14400"> + <Argument>--language=/opt/shibboleth/share/english</Argument> + <Argument>datadir=/opt/shibboleth/data</Argument> + </MySQLSessionCache> + + </SHAR> + + <SHIRE logger="/opt/shibboleth/etc/shibboleth/shire.logger"> + + <RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap"> + <RequestMap applicationId="default"> + <Host name="localhost" scheme="https"> + <Path name="secure" requireSession="true" exportAssertion="true"> + <!-- Example shows a subfolder on the SSL port assigned to a separate <Application> --> + <Path name="admin" applicationId="foo-admin"/> + </Path> + </Host> + <Host name="localhost" scheme="http"> + <Path name="secure" requireSession="true" exportAssertion="true"/> + </Host> + </RequestMap> + </RequestMapProvider> + + <!-- IIS only: + <Implementation> + <ISAPI normalizeRequest="true"> + <Site id="1" scheme="https" host="localhost" port="443"/> + </ISAPI> + </Implementation> + --> + </SHIRE> + + <Applications xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion" + applicationId="default" providerId="https://example.org/shibboleth/target" + signRequest="false" signedResponse="false" signedAssertions="false"> + + <Sessions lifetime="7200" timeout="3600" checkAddress="true" + shireURL="/Shibboleth.shire" shireSSL="false" cookieName="_shibsession_default" cookieProps="; path=/" + wayfURL="https://wayf.internet2.edu/InQueue/WAYF"> + + <Errors shire="/opt/shibboleth/etc/shibboleth/shireError.html" + rm="/opt/shibboleth/etc/shibboleth/rmError.html" + access="/opt/shibboleth/etc/shibboleth/accessError.html" + supportContact="root@localhost" + logoLocation="/shibtarget/logo.jpg" + styleSheet="/shibtarget/main.css"/> + + <CredentialUse TLS="defcreds" Signing="defcreds"> + <RelyingParty Name="urn:mace:inqueue" TLS="inqueuecreds" Signing="inqueuecreds"/> + </CredentialUse> + + <!-- + <AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonScopedAffiliation" + AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/> + --> + + <AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP" + uri="/opt/shibboleth/etc/shibboleth/AAP.xml"/> + + <FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata" + uri="/opt/shibboleth/etc/shibboleth/sites.xml"/> + + <TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust" + uri="/opt/shibboleth/etc/shibboleth/trust.xml"/> + + <!-- + <RevocationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation" + uri="/opt/shibboleth/etc/shibboleth/trust.xml"/> + --> + + <saml:Audience>urn:mace:inqueue</saml:Audience> + + <!-- Override settings for this application. + <Application id="foo-admin"> + <Sessions lifetime="7200" timeout="3600" checkAddress="true" + shireURL="/secure/admin/Shibboleth.shire" shireSSL="true" cookieProps="; path=/secure/admin; secure" + wayfURL="https://wayf.internet2.edu/InQueue/WAYF"/> + <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonPrincipalName" + AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/> + </Application> + --> + + </Applications> + + <CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials"> + <Credentials xmlns="urn:mace:shibboleth:credentials:1.0"> + <FileResolver Id="defcreds"> + <Key format="PEM" password="secret"> + <Path>/opt/shibboleth/etc/shibboleth/shar.key</Path> + </Key> + <Certificate format="PEM"> + <Path>/opt/shibboleth/etc/shibboleth/shar.crt</Path> + <CAPath>/opt/shibboleth/etc/shibboleth/ca.crt</CAPath> + </Certificate> + </FileResolver> + </Credentials> + </CredentialsProvider> + +</ShibbolethTargetConfig> +

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

        1. -

          The main Applications element's providerId attribute must be changed to reflect the URI this target will use to identify itself to origins by default. This will often be approved or supplied by a federation.

          +

          The main Applications element's + providerId attribute must be changed to reflect the URI this target will + use to identify itself to origins by default. This will often be approved or supplied by a federation.

        2. -

          The supportContact and error templates for the target found in the Errors element should be changed to ensure that users have a proper support mechanism.

          +

          The supportContact and error templates for the target found in the + Errors element should be changed to ensure that + users have a proper support mechanism.

        3. -

          Proper credentials for this target signed by an authority that the federation recognizes must be referenced by the Credentials element. The default configuration points at flat files with widely-available, insecure keys and certificates. Note that keys are supported in a variety of formats: DER, PEM, encrypted PEM, PKCS8, and encrypted PKCS8.

          +

          Proper credentials for this target signed by an authority that the federation recognizes must be + referenced by the Credentials element. + The default configuration points at files containing widely-available, insecure keys and certificates. + Note that keys are supported in a variety of formats: DER, PEM, encrypted PEM, PKCS8, and encrypted PKCS8.

        4. FederationProvider and @@ -1085,154 +1136,377 @@ most minor "letter" updates should be usable.

          It is recommended that after initial installation is completed, the log level in both files be left at either INFO or WARN.

          -

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

          +

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

          <AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP" uri="pathname"/>
          -
          This element is used to specify individual attribute acceptance policies that will apply to this application and may appear zero or more times within the Policy element. For information about these policies and their format, refer to section 4.e. -

          The default set of AAP providers can be overridden within individual Application elements.

          +
          +

          This element is used to specify individual attribute acceptance policies that will apply to an application + and may appear zero or more times within the Applications + or Application element. For information about these + policies and their format, refer to section 4.e.

          +

          The default set of AAP providers in the Applications + element can be replaced within individual Application elements.

          +
          -
          <Application id="identifier" providerId="identifier">
          -
          Individual applications that require different attributes, session settings, policies, etc. can be differentiated from the default configuration as specified in the Applications element, which contains this element. It must contain a Sessions element, but overriding the default Errors, Policy, and CredentialUse elements is optional. -
            -
          • id: This attribute defines an internal identifier allowing individual applicationId attributes as part of Host and Path elements to point to this Application to handle requests.
            • -
          • providerId: Distinct from the internal identifier, the providerId is the unique identifier that will be used when communicating with origin sites to request authentication or attributes. This value is referenced by origins when creating rules for the release of attributes to targets and will often provided to federations to facilitate transactions. If none is specified, the default Applications element's providerId applies.
            • -
          +
          <Application id="identifier" providerId="identifier" signRequest="true/false" signedResponse="true/false" signedAssertions="true/false">
          +
          +

          Individual applications that require different attributes, session settings, metadata, etc. can be differentiated + from the default configuration as specified in the Applications + element. It must contain a Sessions element, but overriding other + elements is optional.

          +
            +
          • id: This attribute defines an internal identifier allowing + individual applicationId attributes as part of + Host and Path + elements to point to this Application to handle requests.
            • +
          • providerId: Distinct from the internal identifier, this is the unique identifier + that will be used when communicating with origin sites to request authentication or attributes. + This value is referenced by origins when creating rules for the release of attributes to targets and will + often be provided to federations to facilitate origin configuration. If none is specified, the default + Applications element's + providerId applies.
            • +
          • signRequest: If true, the target will sign attribute + requests that it sends to origins on behalf of this application. This is usually unnecessary, as the + TLS/SSL transport can provide authentication more efficiently.
            • +
          • signedResponse: If true, the target will require that + all SAML attribute responses it receives for this application be signed.
            • +
          • signedAssertions: If true, the target will require that + individual SAML assertions it receives for this application be signed. This may be particularly useful if the + application is forwarding the assertion, but requires a liberal (or no) AAP to avoid corrupting the signature.
            • +
          +
          -
          <Applications id="default" providerId="identifier">
          -
          The Applications element must appear once and contains default settings for requests handled by the target whose applicable request mapping using matching Host and Path elements has no declared applicationId attribute. These values are also used as defaults if individual Application elements do not specify some settings. It must contain at least one each of the Sessions, Errors, Policy, and CredentialUse elements, and may contain individual Application elements. Contained by the main ShibbolethTargetConfig element. -
            -
          • id: This attribute has a fixed value of "default" and should not be changed.
            • -
          • providerId: Distinct from the internal identifier, the providerId is the unique identifier that will be used when communicating with origin sites to request authentication or attributes. This value is referenced by origins when creating rules for the release of attributes to targets and will often provided to federations to facilitate transactions.
            • -
          +
          <Applications id="default" providerId="identifier" signRequest="true/false" signedResponse="true/false" signedAssertions="true/false">
          +
          +

          The Applications element must appear once and contains default settings for requests + handled by the target. It must contain at least one each of the Sessions, + and Errors elements, and may contain + CredentialUse, + saml:AttributeDesignator, + saml:Audience, + FederationProvider, + TrustProvider, + RevocationProvider, + and Application elements.

          +
            +
          • id: This attribute has a fixed value of "default" and should not be changed.
            • +
          • providerId: Distinct from the internal identifier, the + providerId is the unique identifier that will be used when communicating + with origin sites to request authentication or attributes. This value is referenced by origins when + creating rules for the release of attributes to targets and will often be provided to federations to + facilitate origin configuration.
            • +
          • signRequest: If true, the target will sign attribute + requests that it sends to origins by default. This is usually unnecessary, as the TLS/SSL transport can provide + authentication more efficiently.
            • +
          • signedResponse: If true, the target will require that + all SAML attribute responses it receives are signed by default.
            • +
          • signedAssertions: If true, the target will require that + individual SAML assertions it receives are signed by default. This may be particularly useful if the + application is forwarding the assertion, but requires a liberal (or no) AAP to avoid corrupting the signature.
            • +
          +

          Default settings can be overridden by using the RequestMap to + assign a non-default applicationId to particular content in + Host and Path + elements. An Application element is then inserted containing + a matching id attribute, and finally specific elements that override the defaults are + placed within it. A fully specified Sessions element is + always required for any new application created, because each application needs a distinct + shireURL so that new sessions can be unambiguously mapped to a particular application.

          +
          <Argument>value</Argument>
          -
          The Argument element is used in the MySQLSessionCache element to specify one or more arguments to pass to the MySQL database engine.
          +
          +

          The Argument element is used in the + MySQLSessionCache element to specify one or more + arguments to pass to the MySQL database engine.

          +
          <saml:AttributeDesignator AttributeName="name" AttributeNamespace="namespace">
          -
          The AttributeDesignator element is used in the Policy element to name an attribute to specifically request from origins on behalf of an application. If none are specified, the application will be given anything the origin allows it to see. -
            -
          • AttributeName: Specifies the name of a SAML attribute, generally a URI.
            • -
          • AttributeNamespace: Specifies the attribute's SAML namespace, which Shibboleth by convention sets to "urn:mace:shibboleth:1.0:attributeNamespace:uri".
            • -
          -

          The default set of designators can be overridden within individual Application elements, but if defaults are specified, it isn't possible to "remove" them and revert to none.

          -
          +
          +

          The AttributeDesignator element is used in the + Applications and + Application elements to name an attribute to specifically + request from origins on behalf of an application. If none are specified, the application will be given anything + the origin allows it to receive.

          +
            +
          • AttributeName: Specifies the name of a SAML attribute, generally a URI.
            • +
          • AttributeNamespace: Specifies the attribute's SAML namespace, + which Shibboleth by convention sets to "urn:mace:shibboleth:1.0:attributeNamespace:uri".
            • +
          +

          The default set of designators can be overridden within individual + Application elements, but if default elements are specified, + it isn't possible to "remove" them and revert to none within a particular application.

          +
          <saml:Audience>value</saml:Audience>
          -
          The Audience element is used in the Policy element to specify one or more SAML audience URIs to treat as valid while processing assertions. A target application always includes its own providerId as an audience value. -

          Within an Application element, this setting is not inherited from the Applications element. All values desired must be specified.

          +
          +

          The Audience element is used in the + Applications and + Application elements element to specify one or more + SAML audience URIs to designate while processing assertions. Audience values are used by origins to constrain the + parties they issue assertions for. A target application always includes its own providerId + as an audience value.

          +

          Within an Application element, this setting is not + inherited from the Applications element. Any values + desired must be specified. In most cases, this element can be omitted.

          +
          <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. May be needed if the relying party does not possess the entire CA chain already.
          +
          +

          Paired with a Path element within a + FileResolver element, it allows for the specification + of additional certificates in a chain up to a trust anchor. As many CAPath elements as + necessary to complete the chain may be specified. May be needed if the relying party does not possess the entire CA + chain already.

          +
          <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 relying party, the files of certificates in the path to the root may be specified using one or more CAPath elements. Valid encodings are PEM, DER, and PKCS12. It resides within the FileResolver element and must be paired with the corresponding private key using the Key element.
          +
          +

          This specifies the certificate corresponding to this set of credentials. The certificate itself must be specified + by a Path element contained by this element. If the certificate + isn't self-signed or signed by an authority familiar to the relying party, the files of certificates in the path to + the root authority may be specified using one or more CAPath elements. + Valid formats are PEM, DER, and PKCS12.

          +

          It's placed 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 XML-based credentials provider with type "edu.internet2.middleware.shibboleth.common.Credentials". These credentials are used by the target to authenticate itself in SSL sessions or sign attribute requests, depending on configuration. It must contain one or more FileResolver elements.
          +
          +

          This element is the container for credentials used by the XML-based credentials provider with type + "edu.internet2.middleware.shibboleth.common.Credentials". These credentials are used by the target to + authenticate itself in SSL sessions or sign attribute requests, depending on application configuration. It must contain + one or more FileResolver elements.

          +
          <CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials">
          -
          This element is the container for providers of credentials used by the target and is contained by the ShibbolethTargetConfig element. The supplied provider of type "edu.internet2.middleware.shibboleth.common.Credentials" must contain one Credentials element detailing the individual credentials to be used by the target. Other provider types might require different content.
          +
          +

          This element is the container for providers of credentials used by the target and is placed inside the + ShibbolethTargetConfig element. The supplied + provider of type "edu.internet2.middleware.shibboleth.common.Credentials" must contain one + Credentials element detailing the credentials + to be used by the target. Other provider types might require different content.

          +
          <CredentialUse TLS="string" Signing="string">
          -
          Required in the Applications element or used in Application elements to override the defaults, this specifies the credentials used by the target for signing and TLS/SSL. The TLS and Signing attribute values reference the identifiers of credential resolvers defined in CredentialsProvider elements. May also contain RelyingParty elements that specify the credentials to use for specific origins or federations.
          +
          +

          Used in the Applications or + Application elements to specify the credentials used by + applications for signing and TLS/SSL. The TLS and Signing + attribute values reference the identifiers of credential resolvers defined in the + CredentialsProvider element. May also contain + RelyingParty elements that specify the credentials + to use for specific origins or federations.

          +
          <Errors shire="pathname" rm="pathname" access="pathname" supportContact="e-mail" logoLocation="URL"/>
          -
          Shibboleth is capable of displaying customized error pages based on templates and special resources provided by additional attributes in this element. These should all be customized to fit the requirements of the target application. For more information on configuration of error page generation, please see section 4.b. -
            -
          • shire: Specifies the location of the template for the error page generated when there is an error re-directing the user to the WAYF or processing a new session sign-on.
            • -
          • rm: Specifies the location of the template for the error page generated if internal errors occur when supplying attributes to the application.
            • -
          • accessError: Specifies the location of the template for the page displayed to users when access to a protected resource is denied based on access control. This is distinct from when errors occur during the evaluation process itself, and indicates a denial of authorization.
            • -
          • supportContact: Specifies a support e-mail address for the user to contact.
            • -
          • logoLocation: Specifies the location of the logo used in the generation of error pages. This logo can be in any format that the web browser will understand, and should be a URL (absolute or relative) that will return a valid logo.
            • -
          -The last two attributes are examples of tags that can be inserted at runtime into the templates. Arbitrary attributes may be specified in this element simply by adding them; no additional configuration is necessary. If there is a matching ShibMLP tag in the error page template as designed in 4.b, Shibboleth will insert the value of that attribute. -
          +
          +

          Shibboleth is capable of displaying customized error pages based on templates and information provided by + additional attributes in this element. These should all be customized to fit the requirements of the target application. + For more information on configuration of error page generation, please see section 4.b.

          +
            +
          • shire: Specifies the location of the template for the error page + generated when there is an error re-directing the user to the WAYF or processing a new session sign-on.
            • +
          • rm: Specifies the location of the template for the error page + generated if internal errors occur when supplying attributes to the application.
            • +
          • accessError: Specifies the location of the template for the page + displayed to users when access to a protected resource is denied based on access control. This is distinct + from when errors occur during the evaluation process itself, and indicates a denial of authorization.
            • +
          • supportContact: Specifies a support e-mail address for the user to contact.
            • +
          • logoLocation: Specifies the location of the logo used in the generation of error pages. + This logo can be in any format that the web browser will understand, and should be a URL (absolute or relative) that + will return a valid logo.
            • +
          +

          The last two attributes are examples of tags that can be inserted at runtime into the templates. Arbitrary + attributes may be specified in this element simply by adding them; no additional configuration is necessary. + If there is a matching ShibMLP tag in the error page template as designed in 4.b, Shibboleth + will insert the value of that attribute.

          +
          <Extensions>
          -
          Extension libraries for one of the Shibboleth components or the entire target can be specified using this element depending on where it's present. It may be contained by any of the SHAR, SHIRE, or ShibbolethTargetConfig elements. It should always contain one or more Library elements.
          +
          + Extension libraries for one of the Shibboleth components or the entire target can be specified using this element + depending on where it's present. It may be contained by any of the + SHAR, SHIRE, + or ShibbolethTargetConfig elements. + It must contain one or more Library elements. +
          <FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata" uri="pathname">
          -
          This element, when specified within a Policy element, points to operational metadata either inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download periodically. This should be refreshed regularly; see section 4.g for further details. -

          If an Application does not include any FederationProvider elements, the default set is used.

          +
          +

          This element, when specified within an Applications + or Application element, points to operational metadata either + inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download + periodically. This should be refreshed regularly; see section 4.g for further details.

          +

          The default set of federation providers in the Applications + element can be replaced within individual Application elements.

          <FileResolver Id="string">
          -
          This element defines the files used to store a private key, certificate, and certificate authorities and associates the set with an identifier. Contained by the Credentials element. CredentialUse and RelyingParty elements will refer to these identifiers in their TLS and Signing attributes, allowing different credentials to be used for different applications and relying parties. It must contain one Key element and should contain one Certificate element.
          +
          +

          This element defines files used to store a private key, certificate, and certificate authorities and associates + the set with an identifier. Placed inside the Credentials + element. CredentialUse and + RelyingParty elements will refer to these identifiers in + their TLS and Signing attributes, allowing different credentials + to be used for different applications and relying parties.

          +

          Must contain one Key element and should contain one + Certificate element.

          +
          <Host scheme="protocol" name="fqdn" port="integer" applicationId="id" requireSession="true/false" exportAssertion="true/false">
          -
          Individual (real or virtual) hosts that this target protects are enumerated by Host elements in the RequestMap element. If a request is processed by Shibboleth for a URL on this host, these parameters will be applied to it. If there are Path elements within this element that match the URL and contain the applicationId, requireSession, or exportAssertion attributes, they will override those in this element; similarly, the ones within this element will override those in the containing RequestMap element. -
            -
          • scheme: This specifies the protocol on which this host responds. Valid choices are http, https, ftp, ldap, and ldaps.
            • -
          • name: This is the fully-qualified domain name of the host. This appended to the scheme must match what is contained in the URL for the element's settings to apply to the request.
            • -
          • port: This is the port the host is listening on, if not the standard port for the scheme.
            • -
          • requireSession: This attribute controls whether Shibboleth will forcibly establish an authenticated session with the user before handing off the request to the web server or application. If true, Shibboleth will force session establishment. If false (the default), applications are responsible for ensuring that a session exists if necessary, so-called lazy session establishment. Most deployments should not specify false for protected content without a full understanding of the implications.
            • -
          • exportAssertion: When true, the entire SAML attribute assertion received from the origin is exported to a CGI request header called Shib-Attributes, encoded in base64. This requires an application to be able to parse the raw XML. Defaults to false, which most deployments should use.
            • -
          +
          +

          Individual (real or virtual) hosts that this target protects are enumerated by Host elements + inside the RequestMap element. If a request is processed by + Shibboleth for a URL on this host, these parameters will be applied to it. If there are + Path elements within this element that match the URL and contain + the applicationId, requireSession, or + exportAssertion attributes, they will override values in this element; similarly, values + within this element will override those in the containing + RequestMap element.

          +
            +
          • scheme: This specifies the protocol on which this host responds. + Valid choices are http, https, ftp, + ldap, and ldaps.
            • +
          • name: This is the fully-qualified domain name of the host. + This appended to the scheme must match what is contained in the URL for the element's + settings to apply to the request.
            • +
          • port: This is the port the host is listening on, if not the standard port for the scheme.
            • +
          • requireSession: This attribute controls whether Shibboleth will forcibly establish + an authenticated session with the user before handing off the request to the web server or application. + If true, Shibboleth will force session establishment. If false + (the default), applications are responsible for ensuring that a session exists if necessary, so-called + lazy session establishment. Most deployments should not specify false + for protected content without a full understanding of the implications.
            • +
          • exportAssertion: When true, the entire SAML attribute + assertion received from the origin is exported to a CGI request header called + Shib-Attributes, encoded in base64. This requires an + application to be able to parse the raw XML. Defaults to false, which most deployments + should use.
            • +
          +
          <Implementation>
          -
          A container element placed inside the SHIRE element, the contents of this element will vary depending on the web server or environment that this Shibboleth deployment serves. Multiple configurations may be specified, but only one per implementation type. This element may contain the ISAPI element. .
          +
          +

          A container element placed inside the SHIRE element, + the contents of this element will vary depending on the web server or environment that this Shibboleth deployment serves. + Multiple configurations may be specified, but only one per implementation type. This element may contain the + ISAPI element.

          +
          <ISAPI normalizeRequest="true/false">
          -
          The configuration information for Shibboleth targets deployed on Microsoft IIS is stored inside this container element. This element must contain one or more Site elements, each of which maps an INSTANCE ID value to a hostname. If normalizeRequest is true (the default), all redirects and computed request URLs generated by Shibboleth will be created using the hostname assigned to the site instance handling the request. If false, the browser's supplied URL is sometimes used to compute the information. Contained by the Implementation element.
          +
          +

          The configuration information for Shibboleth targets deployed on Microsoft IIS is stored inside this container element. + This element must contain one or more Site elements, each of which + maps an INSTANCE ID value to a hostname. If normalizeRequest is + true (the default), all redirects and computed request URLs generated by Shibboleth will + be created using the hostname assigned to the site instance handling the request. If false, + the browser's supplied URL is sometimes used to compute the information. Placed inside the + Implementation element.

          +
          <Key format="type">
          -
          This specifies the file containing a private key to be used by a set of credentials. Valid encodings are PEM (the default), DER, and PKCS12. Keys are supported in a variety of formats: DER, PEM, encrypted PEM, and encrypted PKCS12. It resides within the FileResolver element, should be paired with a Certificate element, and contain a Path element.
          +
          +

          Specifies a file containing a private key to be used within a set of credentials. Valid formats are + PEM (the default), DER, and PKCS12. + Placed within a FileResolver element, it should be paired + with a Certificate element, and contain a + Path element.

          +
          <Library path="pathname" fatal="true/false"/>
          -
          This element defines an extension library for one of Shibboleth's components when specified within an Extensions element. -
          • path: This designates the complete pathname to where the library is.
            • -
          • fatal: If set to true and the library is not located or fails to load properly, the target will not start. The default is false.
            • -
          +
          +

          This element defines an extension library for one of Shibboleth's components and is placed within an + Extensions element.

          +
            +
          • path: This designates the complete pathname of the library.
            • +
          • fatal: If true and the library is not located or fails + to load properly, the target will not successfully initialize. The default is false.
            • +
          +
          <Listener type="string">
          -
          Specifies a pluggable implementation of a mechanism for communication between the web server and SHAR, specified in the type attribute. This element must be contained by the SHAR element and is mutually exclusive with the TCPListener and UnixListener elements.
          +
          +

          Specifies a pluggable implementation of a mechanism for communication between the web server and SHAR, + specified in the type attribute. This element is placed within the + SHAR element and is mutually exclusive with the + TCPListener and + UnixListener elements.

          +
          <MemorySessionCache AAConnectTimeout="seconds" AATimeout="seconds" cacheTimeout="seconds" cleanupInterval="seconds" defaultLifetime="seconds" propagateErrors="true/false" retryInterval="seconds" strictValidity="true/false"/>
          -
          Shibboleth will cache sessions and received attributes in memory if this element is placed in the SHAR element. This element is mutually exclusive with the MySQLSessionCache and SessionCache elements. -
            -
          • AAConnectTimeout: Time in seconds the target will wait before timing out on the initial connection to an origin to request attributes. Defaults to 15.
            • -
          • AATimeout: Time in seconds the target will wait before timing out while waiting for attributes from an origin once the initial connection is established. Defaults to 30.
            • -
          • cacheTimeout: Time in seconds to permit a session to stay in the cache before being purged. Defaults to 28800.
            • -
          • cleanupInterval: Seconds between runs of the background thread that purges expired sessions. Defaults to 300.
            • -
          • defaultLifetime: If the attribute assertion doesn't carry an explicit expiration time, the assertion will expire after this time in seconds has elapsed. Defaults to 1800.
            • -
          • propagateErrors: If true, then any errors that occur during the attribute query stage are fatal and will be presented to the user as an error, terminating their session. If false, any errors that occur during the query are non-fatal, and the -application will be given older, expired attributes based on the strictValidity setting.

            -

            This should generally only be left to false (the default) by deployments that are using real principal names as subjects because attribute retrieval is treated as an optional process.

            • -
          • retryInterval: Time in seconds between attempts to obtain fresh attributes. If a query fails, a timer is set, and once the interval elapses, the next user request causes another query. This prevents pointless repeated attempts to query a failed origin. Defaults to 300.
            • -
          • strictValidity: If true, expired attributes will never be made available to the Shibboleth application; if no valid attributes can be obtained, then an empty set is provided. When false, if a fresh set of attributes cannot be retrieved due to failures, any cached, expired attributes are made available. Defaults to true.
            • -
          +
          +

          Shibboleth will cache sessions and received attributes in memory if this element is found in the + SHAR element. This element is mutually exclusive with the + MySQLSessionCache and + SessionCache elements.

          +
            +
          • AAConnectTimeout: Time in seconds the target will wait before timing out on the + initial connection to an origin to request attributes. Defaults to 15.
            • +
          • AATimeout: Time in seconds the target will wait before timing out while waiting + for attributes from an origin once the initial connection is established. Defaults to 30.
            • +
          • cacheTimeout: Time in seconds to permit a session to stay in the cache before + being purged. Defaults to 28800.
            • +
          • cleanupInterval: Seconds between runs of the background thread that purges + expired sessions. Defaults to 300.
            • +
          • defaultLifetime: If the attribute assertion doesn't carry an explicit + expiration time, the assertion will expire after this time in seconds has elapsed. + Defaults to 1800.
            • +
          • propagateErrors: If true, then any errors that occur during the attribute + query stage are fatal and will be presented to the user as an error, terminating their session. If false, + any errors that occur during the query are non-fatal, and the application will be given older, expired + attributes based on the strictValidity setting. +

            This should generally only be left to false (the default) by deployments that are using real principal + names as subjects because attribute retrieval is treated as an optional process.

            • +
          • retryInterval: Time in seconds between attempts to obtain fresh attributes. If a query fails, a timer is set, and once the interval elapses, the next user request causes another query. This prevents pointless repeated attempts to query a failed origin. Defaults to 300.
            • +
          • strictValidity: If true, expired attributes will never be made available to the Shibboleth application; if no valid attributes can be obtained, then an empty set is provided. When false, if a fresh set of attributes cannot be retrieved due to failures, any cached, expired attributes are made available. Defaults to true.
            • +
          +
          <MySQLSessionCache mysqlTimeout="seconds"/>
          -
          Shibboleth will back the memory cache of sessions using an embedded MySQL database if this element is placed in the SHAR element. Arguments may be passed directly to MySQL by populating this element with Argument elements. The element may also specify any of the attributes defined for the MemorySessionCache element. Mutually exclusive with the MemorySessionCache and SessionCache elements. -
            -
          • mysqlTimeout: Time in seconds to permit a session to stay in the persistent cache before being purged. Defaults to 28800.
            • -
          +
          +

          Shibboleth will back the memory cache of sessions using an embedded MySQL database if this element is found + in the SHAR element. Arguments may be passed directly to + MySQL by populating this element with Argument elements. + The element may also specify any of the attributes defined for the MemorySessionCache + element. Mutually exclusive with the MemorySessionCache + and SessionCache elements.

          +
            +
          • mysqlTimeout: Time in seconds to permit a session to stay in the persistent + cache before being purged. Defaults to 28800.
            • +
          +
          -
          <Path name="pathname" applicationId="id" requireSession="true/false" exportAssertion="true/false">
          -
          This element allows for different application identifiers and session handling to be defined iteratively for subdirectories or documents within a host. Requests are processed on a best-match basis, with the innermost element taking precedence. Path elements may be contained by Host elements or other Path elements. -
            -
          • name: This is the name of the path component or filename to match against the request.
            • -
          • requireSession: This attribute controls whether Shibboleth will forcibly establish an authenticated session with the user before handing off the request to the web server or application. If true, Shibboleth will force session establishment. If false (the default), applications are responsible for ensuring that a session exists if necessary, so-called lazy session establishment. Most deployments should not specify false for protected content without a full understanding of the implications.
            • -
          • exportAssertion: When true, the entire SAML attribute assertion received from the origin is exported to a CGI request header called Shib-Attributes, encoded in base64. This requires an application to be able to parse the raw XML. Defaults to false, which most deployments should use.
            • -
          +
          (RequestMap) <Path name="pathname" applicationId="id" requireSession="true/false" exportAssertion="true/false">
          +
          +

          This element allows for different application identifiers and session handling to be defined iteratively for + subdirectories or documents within a host. Requests are processed on a best-match basis, with the innermost + element taking precedence. Path elements may be contained by Host + elements or other Path elements.

          +
            +
          • name: This is the name of the path component or filename to match + against the request. Only exact matching is supported by the supplied request mapping provider.
            • +
          • requireSession: This attribute controls whether Shibboleth will forcibly establish + an authenticated session with the user before handing off the request to the web server or application. + If true, Shibboleth will force session establishment. If false + (the default), applications are responsible for ensuring that a session exists if necessary, so-called + lazy session establishment. Most deployments should not specify false + for protected content without a full understanding of the implications.
            • +
          • exportAssertion: When true, the entire SAML attribute + assertion received from the origin is exported to a CGI request header called + Shib-Attributes, encoded in base64. This requires an + application to be able to parse the raw XML. Defaults to false, which most deployments + should use.
            • +
          +
          -
          <Policy signRequest="true/false" signedResponse="true/false" signedAssertions="true/false">
          -
          This element is the main container for specifying policies for attributes, trust, and operational metadata by an application. It must be contained by the Applications element and, if contained by an Application element, may override portions of the policies which would have been inherited by default. The configuration for policy is defined by these elements, each of which is optional: Attributes, FederationProvider, TrustProvider, RevocationProvider, and saml:Audiences. -
            -
          • signRequest: If true, the target will sign attribute requests that it sends to origins from this application. This is usually unnecessary, as the TLS/SSL transport can provide authentication more efficiently.
            • -
          • signedResponse: If true, the target will require that all SAML attribute responses it receives for this application be signed.
            • -
          • signedAssertions: If true, the target will require that individual SAML assertions it receives for this application be signed. This may be particularly useful if the application is forwarding the assertion, but requires a liberal (or no) AAP to avoid corrupting the signature.
            • -
          - -
          <RequestMap applicationId="default" requireSession="true/false" exportAssertion="true/false" -uri="URI">
          -

          For a general description of how the target handles incoming requests, please refer to section 1.f.

          The RequestMap element is a container holding Host and Path elements. The requested URL is parsed and matched against this set of elements in order to determine how to process the request. Attributes on the RequestMap, Host, and Path elements specify whether to require a Shibboleth session, and how to locate the associated Application element. If session requirement or assertion handling conditions varies across that granularity, additional RequestMap elements may be specified for them. Alternatively, these conditions may be specified on Path and Host elements within this element which will override these settings.

          -
            -
          • applicationId: Contains a fixed value of "default" to reference the default Applications element.
            • -
          • requireSession: This attribute controls whether Shibboleth will forcibly establish an authenticated session with the user before handing off the request to the web server or application. If true, Shibboleth will force session establishment. If false (the default), applications are responsible for ensuring that a session exists if necessary, so-called lazy session establishment. Most deployments should not specify false for protected content without a full understanding of the implications.
            • -
          • exportAssertion: When true, the entire SAML attribute assertion received from the origin is exported to a CGI request header called Shib-Attributes, encoded in base64. This requires an application to be able to parse the raw XML. Defaults to false, which most deployments should use.
            • -
          • uri: If the request mapping configuration information is stored in a separate XML file that is referred by this file, it may be pointed to using this attribute.
            • -
          +
          (Credential) <Path>pathname</Path>
          +
          +

          Placed inside the Key and + Certificate elements to specify the pathname of the file + containing the credential.

          +
          <RelyingParty name="string" TLS="string" Signing="string">

          One or more RelyingParty elements may be contained by a CredentialUse element to enumerate relying parties for which a distinct set of credentials should be used. The TLS and Signing attribute values reference the identifiers of credential resolvers defined in CredentialsProvider elements.

          @@ -1241,93 +1515,210 @@ uri="URI">
          +
          <RequestMap applicationId="default" requireSession="true/false" exportAssertion="true/false">
          +
          +

          The RequestMap element is a container holding + Host and Path + elements. Request URLs processed by Shibboleth are parsed and matched against this set of elements in order to + determine how to process the request. Attributes on the RequestMap, Host, and Path elements specify whether to + require an authenticated session, and how to locate the associated Application element and settings.

          +
            +
          • applicationId: Contains a fixed value of "default" to reference the default + Applications element.
            • +
          • requireSession: This attribute controls whether Shibboleth will forcibly establish + an authenticated session with the user before handing off the request to the web server or application. + If true, Shibboleth will force session establishment. If false + (the default), web applications are responsible for ensuring that a session exists if necessary, so-called + lazy session establishment. Most deployments should not specify false + for protected content without a full understanding of the implications.
            • +
          • exportAssertion: When true, the entire SAML attribute + assertion received from the origin is exported to a CGI request header called + Shib-Attributes, encoded in base64. This requires an + application to be able to parse the raw XML. Defaults to false, which most deployments + should use.
            • +
          +
          +
          <RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap" uri="pathname">
          -

          This element specifies a request mapper that defines how Shibboleth will handle sessions and access control for a given request. For the built-in type "edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap", there must be a RequestMap element within this element, or the uri attribute must contain the local pathname of an XML file containing one.

          +
          +

          This element specifies a request mapper that defines how Shibboleth will handle sessions and other behavior + for a given request. For the built-in type "edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap", + there must be a RequestMap element within this element, or + the uri attribute must contain the local pathname of an XML file containing one.

          +
          <RevocationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation" uri="pathname">
          -
          This element, when specified within a Policy element, points to revocation metadata either inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download periodically. This should be updated regularly; see section 4.g for further details. -

          If an Application does not include any RevocationProvider elements, the default set is used.

          - +
          +

          This element, when specified within an Applications + or Application element, points to revocation information either + inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download + periodically. This should be refreshed regularly; see section 4.g for further details.

          +

          The default set of revocation providers in the Applications + element can be replaced within individual Application elements.

          +
          +
          <SessionCache type="string">
          -
          Use this element to specify a pluggable session cache implementation of the specified type This element must be contained by the SHAR element and is mutually exclusive with the MemorySessionCache and MySQLSessionCache elements. -

          Any plugin should support the basic attributes defined by the MemorySessionCache element.

          +
          +

          Specifies a pluggable session cache implementation of the specified type. This element + is placed within the SHAR element and is mutually exclusive with + the MemorySessionCache and + MySQLSessionCache elements.

          +

          Any plugin should support the basic attributes defined by the + MemorySessionCache element.

          +
          <Sessions wayfURL="URL" shireURL="URL" shireSSL="true/false" -cookieName="URL" -cookieProps="URL" lifetime="seconds" timeout="seconds" -checkAddress="true/false">
          -
          Configuration parameters that affect the way Shibboleth handles sessions for an individual application are bundled in this element, which must be included in each Application and Applications element. Note that these parameters only apply to Shibboleth sessions, and not any sessions applications manage on their own behalf. -
            -
          • wayfURL: The URL of the WAYF service responsible for redirecting users accessing this application to their identity provider (origin).
            • -

          • shireURL: Specifies the SHIRE URL, or assertion consumer service, at which new sessions are initiated or lazy sessions are triggered. This can be an absolute URL, or a relative path to be prefixed by the base URL of the virtual host. Using an absolute URL allows a virtual server to funnel requests to a fixed location, to force use of SSL, for example.

            -

            Note that this URL issues the session cookie set on behalf of the application, and this cookie must be returned in subsequent requests, so the virtual host's domain name and port must be consistent with this domain name and port for some browsers to properly return the cookie. If default ports are used (and thus left unspecified), browsers will generally return cookies set via SSL to a non-SSL port. If non-default ports are used, it is recommended that this be a relative URL so that each virtual host handles its own cookie operations.

            -

            For Shibboleth to function properly in IIS, the file extension at the end of this URL must match the value configured into IIS and mapped to the ISAPI extension. This causes the request to be serviced properly, even though no file by that name actually exists.

            • -
          • shireSSL: If true (the default), the application will only accept new session requests over SSL, as is strongly recommended; see section 2.c for more details.
            • -
          • cookieName: Optionally specifies the name given to in-memory session cookies that are associated with this application. If omitted, Shibboleth will generate a cookie name for you of the form _shibsession_<Application ID>
            • -
          • cookieProps: A string of additional Set-Cookie properties can be specified using this element which give the browser further instructions about cookie processing and use. Always begin with a semicolon to delineate from the session ID value.
            • -
          • lifetime: Duration in seconds of the Shibboleth session; this does not affect the lifetime of application sessions initiated independently of Shibboleth. Defaults to 3600. If 0 is specified, sessions are infinite, subject to purging by the cache.
            • -
          • timeout: If the duration in seconds elapses following the last request in a session, the session will be expired for inactivity and a new session must be initiated upon the next request. Defaults to 1800. If 0 is specified, there is no inactivity timeout
            • -
          • checkAddress: If true (the default), Shibboleth will check the browser's client address to insure that session cookies are issued and used by a consistent client address. In most circumstances, this should be enabled to help prevent attacks using stolen cookies, but this can cause problems for users behind proxies or NAT devices.
            • -
          +checkAddress="true/false" +cookieName="URL" +cookieProps="URL"> +
          +

          Configuration parameters that affect the way Shibboleth handles sessions for an individual application are bundled + in this element, which must be included in each Application + and the default Applications element. Note that these + parameters only apply to Shibboleth sessions, and not any sessions applications manage on their own behalf.

          +
            +
          • wayfURL: The URL of the WAYF service + responsible for redirecting users accessing this application to their identity provider (origin).
            • +
          • +

            shireURL: Specifies the SHIRE URL, or assertion consumer service, at which + new sessions are initiated or lazy sessions are triggered. This can be an absolute URL, or a relative path + to be prefixed by the base URL of the virtual host. Using an absolute URL allows a virtual server to funnel + requests to a fixed location, to force use of SSL, for example.

            +

            Note that this URL issues the session cookie set on behalf of the application, and this cookie must be + returned in subsequent requests, so the virtual host's domain name and port must be consistent with this + domain name and port for some browsers to properly return the cookie. If default ports are used (and thus + left unspecified), browsers will generally return cookies set via SSL to a non-SSL port. If non-default + ports are used, it is recommended that this be a relative URL so that each virtual host handles its own + cookie operations.

            +

            For Shibboleth to function properly in IIS, the file extension at the end of this URL must match the + value configured into IIS and mapped to the ISAPI extension. This causes the request to be serviced properly, + even though no file by that name actually exists.

            +
            • +
          • shireSSL: If true (the default), the application will + only accept new session requests over SSL, as is strongly recommended; see section 2.c + for more details.
            • +
          • cookieName: Optionally specifies the name given to in-memory session cookies that + are associated with this application. If omitted, Shibboleth will generate a cookie name for you of the form + _shibsession_<Application ID>
            • +
          • cookieProps: A string of additional Set-Cookie properties can be specified using + this element which give the browser further instructions about cookie processing and use. Always begin with a + semicolon to delineate from the session ID value.
            • +
          • lifetime: Duration in seconds of the Shibboleth session; this does not affect + the lifetime of application sessions initiated independently of Shibboleth. Defaults to 3600. If 0 is specified, + sessions are infinite, subject to purging by the cache.
            • +
          • timeout: If the value in seconds elapses following the last request in a + session, the session will be expired for inactivity and a new session must be initiated upon the next request. + Defaults to 1800. If 0 is specified, there is no inactivity timeout
            • +
          • checkAddress: If true (the default), Shibboleth will + check the browser's client address to insure that session cookies are issued and used by a consistent client address. + In most circumstances, this should be enabled to help prevent attacks using stolen cookies, but this can cause + problems for users behind proxies or NAT devices.
            • +
          +
          <SHAR logger="pathname">
          -
          This is the container element for configuration information pertaining to the SHAR, the target component responsible for most attribute and session processing. Its single attribute, logger, points to a Log4J-format property configuration file that controls SHAR logging behavior. It is contained by the ShibbolethTargetConfig element and may contain an Extensions element specifying additional libraries.

          -

          It must contain either a UnixListener element to listen to the Apache module on a UNIX domain socket or a TCPListener element to listen on a TCP port. Session caching must also be specified using a MemorySessionCache element to use in-memory session caching or a MySQLSessionCache element to backup session information in a MySQL database.

          +
          +

          This is the container element for configuration information pertaining to the SHAR, the target component responsible + for most attribute and session processing. Its single attribute, logger, points to a + Log4J-format property configuration file that controls SHAR logging behavior. It is placed within the + ShibbolethTargetConfig element and may contain an + Extensions element specifying additional libraries.

          +

          It must contain either a UnixListener element to listen + to the server module on a UNIX domain socket or a TCPListener + element to listen on a TCP port. Session caching must also be specified using a + MemorySessionCache element to use in-memory session + caching or a MySQLSessionCache element to backup session + information into a MySQL database.

          +
          <ShibbolethTargetConfig clockSkew="integer">
          -
          This is the root element for target configuration and must be present once and only once. It must always contain a SHAR element, a SHIRE element, an Applications element, one or more CredentialsProvider elements, and optionally an Extensions element. -
          • clockSkew: Controls allowed clock skew in seconds between target and origin servers when evaluating times sent in messages. Defaults to 180, and should be as small as practical.
            • -
          +
          +

          This is the root element for target configuration and must be present once and only once. It must always contain a + SHAR element, a + SHIRE element, an + Applications element, one or more + CredentialsProvider elements, and optionally an + Extensions element.

          +
            +
          • clockSkew: Controls allowed clock skew in seconds between target and origin servers + when evaluating times sent in messages. Defaults to 180, and should be as small as practical.
            • +
          +
          <SHIRE logger="pathname">
          -
          This is the container element for configuration information pertaining to the SHIRE, the part of the target that integrates into the web server environment. Its single attribute, logger, points to a Log4J-format property configuration file that controls SHIRE logging behavior. It is contained by the ShibbolethTargetConfig element and may contain an Extensions element specifying additional libraries.

          -

          It may contain an Implementation element, within which configuration for the SHIRE which varies by platform will be specified.

          -

          It may contain a RequestMapProvider element, which provides fine-grained control over aspects of target behavior at a host, path, or document level.

          +
          +

          This is the container element for configuration information pertaining to the SHIRE, the part of the target that + integrates into the web server environment. Its single attribute, logger, points to a + Log4J-format property configuration file that controls SHIRE logging behavior. It is placed within the + ShibbolethTargetConfig element and may contain an + Extensions element specifying additional libraries.

          +

          It may contain an Implementation element, within which + configuration for the SHIRE which varies by platform will be specified.

          +

          It may contain a RequestMapProvider element, + which provides fine-grained control over aspects of target behavior at a host, path, or document level.

          +
          -
          <Site id="INSTANCE_ID" host="fqdn"/>
          -
          This element is placed in the ISAPI element to specify a mapping from individual instance ID's to respective vhost domain names.
          +
          <Site id="INSTANCE_ID" host="fqdn" scheme="http/https" port="integer">
          +
          +

          This element is placed in the ISAPI element to specify a + mapping from individual instance ID's to the corresponding host, port, and scheme.

          +
          <TCPListener address="pathname" port="integer" acl="ip">
          -
          This element must be contained by the SHAR element and is mutually exclusive with the UnixListener and Listener elements. It allows the SHAR to communicate with the web-server component using TCP. -
          • address: Specifies the IP address of the listener.
            • -
          • port: Specifies the TCP port on which the SHAR will listen.
            • -
          • acl: By default, the SHAR will only listen to requests from 127.0.0.1 (localhost). This should generally not be specified except in test environments.
            • -
          +
          +

          This element is placed within the SHAR element and is mutually + exclusive with the UnixListener and + Listener elements. It allows the SHAR to communicate with the + web server component using TCP.

          +
            +
          • address: Specifies the IP address of the listener.
            • +
          • port: Specifies the TCP port on which the SHAR will listen.
            • +
          • acl: By default, the SHAR will only listen to requests from 127.0.0.1 (localhost). + This should generally not be specified except in test environments.
            • +
          +
          <TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust" uri="pathname">
          -
          This element, when specified within a Policy element, points to trust metadata either inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download periodically. This should be refreshed regularly; see section 4.g for further details. -

          If an Application does not include any TrustProvider elements, the default set is used.

          +
          +

          This element, when specified within an Applications + or Application element, points to trust metadata either + inline within the element or in a local XML file. Federations will often publish signed XML files for targets to download + periodically. This should be refreshed regularly; see section 4.g for further details.

          +

          The default set of trust providers in the Applications + element can be replaced within individual Application elements.

          +
          <UnixListener address="pathname">
          -
          Use this element to specify a UNIX domain socket located at the pathname specified in the address attribute at which the SHAR should listen for requests. This element must be contained by the SHAR element and is mutually exclusive with the TCPListener and Listener elements. UnixListener cannot be specified for Windows-based installations.
          +
          +

          Use this element to specify a UNIX domain socket located at the pathname specified in + the address attribute at which the SHAR should listen for requests. This element must be + contained by the SHAR element and is mutually exclusive with the + TCPListener and + Listener elements. + UnixListener cannot be specified for Windows-based installations.

          +

        4.b. Dynamic Error Page Generation

        Shibboleth supports the dynamic generation of information in error pages - referenced by shibboleth.xml. The Shib Target - employs a special Markup Language Processor to insert special tags into the - generated HTML. The parser will read the error file looking for any tag that + referenced by the Errors element + in shibboleth.xml. The target implementation + employs a simply template language to insert special tags into the + generated HTML. The parser will read the error template looking for any tag that looks like:

        <shibmlp tag-name />

        Shibboleth will replace tag-name with the - appropriate markup tag from the table below:

        + appropriate markup tag either from the table below or by looking for a matching XML attribute + in the Errors element:

        -
        supportContact
        -
        The value of the supportContact - for this web site.
        -
        logoLocation
        -
        This attribute provides a means to specify a dynamic - logoLocation in order to fill in the template - error page only; if a custom error page is created, then the image may - be linked to statically by the page itself.
        requestURL
        The user's requested URL.
        errorType
        @@ -1347,13 +1738,25 @@ checkAddress="true/false">
        The URL of an error handling page for the origin site provided by that site's metadata.
        -

        This configuration is only for Apache servers, and is only used by - resources protected by Shibboleth. See section 4.d.

        +

        To improve the appearance of error messages, a simple, limited form of + conditional checking is supported so that the presence of absence of data + to substitute into a particular tag-name can trigger the inclusion or + exclusion of markup. Conditionals look like:

        +
        +

        <shibmlpif tag-name> arbitrary markup </shibmlpif>
        + <shibmlpifnot tag-name> arbitrary markup </shibmlpifnot>

        +
        +

        Respectively, these special tags include or skip the markup between the tags if the + specified tag-name has an associated value available to be substituted for it. Note that + you cannot nest these conditionals; a shibmlpif tag cannot + appear inside another shibmlpif tag, due to the simplicity + of the substitution engine.

        Sample error templates for different kinds of errors are included in the Shibboleth distribution, and can be triggered by anything that will cause - Shibboleth to be unable to make an authorization decision, including a bad - sites file, certificate verification failures, or a skewed clock between - sites.

        + Shibboleth to be unable to accept an incoming session, obtain attributes, + make an authorization decision, etc., including bad configuration settings, + signature verification or certificate validation failures, or a skewed clock + between sites.

        You should edit these templates, provide or remove style sheets and images, and otherwise customize these templates to suit the user experience you want your users to have when errors occur. The defaults are not likely @@ -1370,38 +1773,43 @@ checkAddress="true/false"> accepted by the origin sites that will be queried for attributes.

        On Unix, we require that OpenSSL be installed to use Shibboleth. On Windows, OpenSSL libraries and the command line tool are included in the - package and can be used directly, if not otherwise available.

        + package and can be used directly, if not otherwise available. Certain + commands require the openssl.cnf configuration + file, an example of which is included with the Windows installation in + C:\opt\shibboleth\etc\shibboleth\openssl.cnf. + To locate this file for a command that requires it, add the + -config C:\opt\shibboleth\etc\shibboleth\openssl.cnf + parameter to the command.

        The certificate and key file location should be based on whether they - will also be used for Apache. If they will be used as a server certificate + will also be used for Apache. If they will be used as a server key pair as well, they should probably be in the Apache tree in the usual mod_ssl-defined locations inside the Apache - configuration folder., and the SHAR can read them from there. If the SHAR is + configuration folder, and the SHAR can read them from there. If the SHAR is not running as root, permissions might need to be changed to allow this access. If the certificate and key will only be used for the SHAR, they can be put in the same folder with the shibboleth.xml file and protected appropriately.

        -

        Other web servers like IIS do not use the raw PEM format that Apache and +

        Other web servers like IIS do not use the file formats that Apache and Shibboleth can share, and therefore the components must generally use separate copies of the key and certificate if they are to be shared. Most - other servers can export and/or import keys to and from PEM format or other - formats that OpenSSL can convert. Refer to your server's documentation or - ask for assistance from others who use it.

        + other servers can export and/or import keys to and from PEM or DER format. + Refer to your server's documentation or ask for assistance from others + who use it.

        The SHAR is assigned a key and a certificate using shibboleth.xml's - certFile, keyFile and - keyPass settings, described in - section 4.a. These files must currently be in PEM format. OpenSSL - commands to generate a new keypair and a certificate request are shown here, - assuming 2048 bit RSA keys are to be used:

        + FileResolver element + described in section 4.a. Various formats are supported and + OpenSSL can generate and convert among them. OpenSSL commands to generate a new + keypair and a certificate request are shown here, assuming 2048 bit RSA keys are + to be used:

        -

        $ openssl genrsa -des3 -out ssl.key 2048
        +

        $ openssl genrsa -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.

        +

        The signed certificate file returned by the CA should be usable directly.

        If the key is to be shared with Apache, the web server's child processes, - often running as nobody, must be able to read - them while the server is running, which may require permission changes.

        + often running as nobody or a similar uid, must be + able to read them while the server is running, which may require permission + changes.

        This particularly applies when sharing the key and certificate used by mod_ssl, which are only readable by root by default. The password, if any, must be placed in the shibboleth.xml file, since @@ -1409,74 +1817,95 @@ checkAddress="true/false"> can. The issues surrounding how to securely obtain a key while running as nobody may be addressed in a later release. Since the password will be stored in clear text in a frequently examined file, it - is suggested to use a password not used elsewhere.

        + is suggested to use a password not used elsewhere, or preferably not to use + a password at all.

        4.d. Protecting Web Pages

        Protection of web pages is primarily achieved through "mapping" attributes provided by an AA to a localized vocabulary for authorization - rules. This was formerly accomplished in Apache using features in the AAP - syntax, described in section 4.e. This applies to both - Apache and IIS.

        + rules. This is accomplished using features in the AAP syntax, described in + section 4.e. This applies to both Apache and IIS.

        IIS

        -

        The IIS RM module supports the mapping of attributes via AAP files, but - it does not support rule-based policies and therefore cannot protect static - content at this time. In addition, all of the configuration settings are - managed globally or per-site and are pulled from the - shibboleth.xml file, so there are no additional commands to document - at this time.
        +

        The IIS filter module supports the mapping of attributes into HTTP headers + via AAP files, but it does not yet support rule-based access control and + therefore cannot protect static content at this time. In addition, all of + the configuration settings, such as control over whether to prompt for new + sessions automatically, are managed via the + RequestMap element, + so there are no additional commands to document at this time.

        Apache

        -

        The Apache RM module provided can interpret AAP settings to map +

        The Apache module provided can also interpret AAP settings to map attributes to HTTP request headers and to Require rules, permitting protection of both static and dynamic content. Any of the typical ways of protecting content may be used (.htaccess, Directory, Location, Files, etc.). They define what content is to be protected and static access control rules.

        -

        There are two ways to trigger Shibboleth authentication: specifying an - AuthType of shibboleth - to use Shibboleth directly, or using ShibBasicHijack to process existing .htaccess files - using Shibboleth instead. Support for authorization consists of - mod_auth-style require directives, as well as support for mod_auth group - files.

        -

        A complete list of the directives and their values is below:

        +

        There are two ways to require Shibboleth authentication, but both also require + enabling the module to activate by specifying an AuthType + of shibboleth and supplying at least one + Require rule in httpd.conf + or .htaccess files. The Require + rule can enforce a specific access control policy based on attributes, can specify + valid-user to require any authenticated session, or it can + support so-called lazy sessions by using the place-holder rule name of + Shibboleth. In such cases, the module is activated, but + in a passive mode that does not automatically force a session, but will process + and validate a session if one exists, leaving the authorization decision to the + application. Using a static access control rule that will fail in the absence of + a session is only sensible if one of the two approaches below that force a session + are used.

        +

        To require a session, either the Apache command, ShibRequireSession On, + or the requireSession boolean XML attribute on the + RequestMap, + Host, or + Path elements in + shibboleth.xml can be used. Both approaches are equivalent, and + using either one to require a session will supersede a false or absent setting of the other type.

        +

        As an example, the following commands will require Shibboleth authentication for a resource:

        +
        + AuthType shibboleth
        + ShibRequireSession On
        + Require valid-user         +
        +

        A complete list of Apache directives and their values is below:

        +
        ShibURLScheme <http/https>
        +
        Used in advanced virtual hosting environments which need to generate + SSL redirects from virtual servers that use only HTTP. Supplements the + Apache ServerName and Port + commands with this missing option. Defaults to a null value in which the scheme + for redirects is based on the physical connection to the server. This is a server-level + command, while the rest of the commands listed are content commands that can appear + anywhere.
        AuthType <string>
        Use shibboleth for direct invocation, or Basic plus the ShibBasicHijack option described below.
        -
        ShibSSLOnly <on/off>
        -
        Controls whether Shibboleth will reject non-SSL - requests for resources from clients. Defaults to off.
        ShibBasicHijack <on/off>
        Controls whether Shibboleth should or should not ignore requests with AuthType Basic. Defaults to off.
        +
        ShibRequireSession <on/off>
        +
        Controls whether to require an authenticated session before passing + control to the authorization phase or the actual resource. Defaults to + off.
        ShibExportAssertion <on/off>
        Controls whether the SAML attribute assertion provided by the AA is exported in a base64-encoded HTTP header, - Shib-Attributes. Defaults to - off. While this does require parsing the raw - XML, it also permits an application to see attributes that may have been - filtered by an AAP, or to forward the SAML assertion to a third party.
        -
        ShibAuthLifetime <seconds>
        -
        If set, sessions are always terminated after the - specified number of seconds, resulting in a new redirect and request for - authentication, just as if a new request without a session is received. - Defaults to infinite.
        -
        ShibAuthTimeout <seconds>
        -
        If set, sessions are always terminated after the - specified number of seconds of inactivity (defined as no requests - received in that session), resulting in a new redirect and request for - authentication, just as if a new request without a session is received. - Defaults to infinite.
        + HTTP_SHIB_ATTRIBUTES. Defaults to off. +
        ShibRequireAll <on/off>
        +
        Controls whether all Require rules + specified must be satisfied before access to the resource is granted. Defaults to + off, which means any single rule can be satisfied, the + usual Apache behavior.
        AuthGroupFile <pathname>
        Same as mod_auth; collects values found in REMOTE_USER into a named group for access control. An attribute must be mapped to REMOTE_USER for this to work. Note that mod_auth will not support group - files when mod_shibrm is loaded, since they share the same command. + files when the Shibboleth module is loaded, since they share the same command.

        This is implemented by placing a .htaccess file that references a group file stored at /pathname:

        @@ -1490,8 +1919,8 @@ checkAddress="true/false">
        workgroup: joe@example.edu, jane@demo.edu, jim@sample.edu
        Require <string>
        -
        Enforce authorization using one of the following - methods.
          +
          Enforce authorization using one of the following methods. +
          • valid-user

            Any Shibboleth user from a trusted origin site is accepted, even if no actual attributes are received. This is a very @@ -1502,8 +1931,7 @@ checkAddress="true/false">

          user

          A space-delimited list of values, such as from the - - urn:mace:dir:attribute-def:eduPersonPrincipalName + urn:mace:dir:attribute-def:eduPersonPrincipalName attribute. Actually, any attribute can be mapped to REMOTE_USER, even if this doesn't always make sense.

          @@ -1514,13 +1942,21 @@ checkAddress="true/false">
        that a mapping to REMOTE_USER exists.

        7. -
      7. <alias>
        +
      8. alias

        An arbitrary rule name that matches an Alias defined in an AAP file. The rule value is a space-delimited list of attribute values, whose format depends on the attribute in question (e.g. an affiliation rule might look like:

        -

        require affiliation staff@osu.edu - faculty@mit.edu

        +

        require affiliation staff@osu.edu faculty@mit.edu

        +
        +
        9. +
      9. shibboleth
        +

        If a session cookie of the expected name exists, the corresponding + session will be validated and any cached attributes exported as otherwise + specified. Authorization will be controlled by the resource, unless + additional rules are specified. If however a session does not already + exist, or if the current session expires or times out, no session will + be requested and control will pass to the resource.

        10. @@ -1551,16 +1987,18 @@ checkAddress="true/false"> about its users.

        Attribute acceptance is the process of defining acceptable attributes and filtering attribute values before passing them on to a resource manager, - such as the mod_shibrm module. Data blocked by + such as the Shibboleth module or a web application. Data blocked by AAP filters will not be passed to the CGI environment or used when enforcing - .htaccess rules. Note that the attribute - assertion exported to the Shib-Attributes header - is unfiltered.

        + .htaccess rules in Apache. Note that the attribute + assertion exported to the HTTP_SHIB_ATTRIBUTES header + is now also filtered. This is a change from previous versions. To compensate, + either no AAP can be specified, or a rule can be applied to permit all + attributes to pass through while also exporting specific attributes.

        The Shibboleth implementation supports Scoped and Simple attributes and filtering policies for different kinds of attributes, and is potentially extensible to more complex attributes in the future. An attribute is considered Scoped if the XML representation of its values contains a "Scope" - attribute. As of 1.1, this is detected at runtime and requires no + attribute. As of 1.1+, this is detected at runtime and requires no configuration in advance.

        An essential part of the Shibboleth trust fabric is ensuring that sites only assert attributes for domains for which they are considered @@ -1568,7 +2006,7 @@ checkAddress="true/false"> will be trusted to assert attributes only scoped to brown.edu. Unless there are very specific circumstances requiring this restriction be removed, it is strongly encouraged that such policies be - in place.

        + left in place.

        Scoped:

        Scoped attributes are a special kind of attribute whose values are a @@ -1579,18 +2017,16 @@ checkAddress="true/false"> of eduPersonAffiliation values, such as student, member, or faculty. Scopes are expressed as DNS - domains and subdomains.

        + domains and subdomains as a convention.

        Any scoped attribute can be scoped only to the origin site's permitted domains. These domains are listed in the - site metadata that provides policy information to the system. Domains - can be explicit or regular expressions, and can be changed by a target - to meet its needs. Targets can also override the rules specified for the - site in their own AAPs, choosing to accept additional scopes or deny - scopes that would ordinarily be accepted based on metadata provided by a - federation. Thus, attribute acceptance processing for - scoped attributes is based on site metadata - and target-specified overrides in addition to the mechanism described - below for simple attributes.

        + operational metadata that provides policy information to the system and + can be overridden or supplemented using the AAP. Domains can be explicit + or regular expressions, and can be changed by a target to meet its needs. + Thus, attribute acceptance processing for scoped + attributes is based on site metadata and target-specified overrides in + addition to the mechanism described below for simple + attributes.

        Scope rules specified in an AAP are additive with any domains permitted by site metadata, and the rules are applied by first looking for an applicable denial rule, and then looking at site metadata and any @@ -1603,17 +2039,16 @@ checkAddress="true/false"> permitted. eduPersonEntitlement, in which the values are URIs, is one example of a simple attribute.

        Both Simple and Scoped attribute acceptance is controlled with an - external policy file written in XML. The schema for the file is - described by the shibboleth.xsd schema, and - an example file is included, AAP.xml. It is - mandatory to supply such a file, because attributes are recognized based - on their presence in this file, and not by separate configuration - processes. Only by listing an attribute in the file will it be accepted - and processed by the RM.

        + external (or in 1.2, optionally inline) policy file written in XML. + The schema for the file is described by the shibboleth.xsd + schema, and an example file is included, AAP.xml. + It is now optional to supply such a policy, but in the absence of one, no + attributes will be exported into request headers, and the option to export + the assertion as a whole must be used instead.

        The policy is a default-deny algorithm that requires permissible - attributes and values be listed explicitly. That is, an empty file - permits nothing. Each attribute to be supported must be listed in the - file by name in an <AttributeRule>. Each such + attributes and values be listed explicitly. That is, an empty (as opposed to no) + policy permits nothing. Each attribute to be supported must be listed in the + policy by name in an <AttributeRule>. Each such rule is a collection of <SiteRule> elements along with an optional <AnySite> default rule. In turn each site rule is a set of <Value> @@ -1621,14 +2056,23 @@ checkAddress="true/false"> expressions, or a wildcarded <AnyValue> default rule, which is equivalent to a single regular expression rule allowing anything.

        +

        With 1.2, a new <AnyAttribute> element + can be used before or in place of the <AttributeRule> + elements to allow all attributes and values to pass muster. The purpose of this + is to then supply rules to specify the export of particular attributes, without + using those rules to control acceptance.

        A syntax summary follows:

        -

        <AttributeAcceptancePolicy

        +

        <AttributeAcceptancePolicy>

        The top level element in the file.

        -

        <AttributeRule
        +

        <AnyAttribute>

        +
        +

        Disables acceptance filtering and leaves the assertion intact.

        +
        +

        <AttributeRule>
            Name="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"
            Header="Shib-EP-Affiliation" Alias="affiliation">

        @@ -1648,24 +2092,24 @@ checkAddress="true/false"> Header The HTTP request header to map the attribute's values - to. + into. Alias A short name for the attribute, determines the name of - the Apache Requires rule. + the Apache Require rule.

        <AnySite>

        Specifies a rule that always applies to the attribute, regardless - of the asserting AA.

        + of the asserting origin site.

        -

        <SiteRule Name="host.domain.com">

        +

        <SiteRule Name="providerId">

        -

        A rule that applies to the origin site AA corresponding to the - hostname.

        +

        A rule that applies to the origin site corresponding to the supplied + identifier

        <Scope Accept="true|false" Type="type">

        @@ -1696,16 +2140,16 @@ checkAddress="true/false"> ^ and $ to avoid unintentional matches midstring.

        -

        4.f. Using Attributes in Applications

        +

        4.f. Using Attributes and Session Data in Applications

        Apart from the simple RM functionality provided, attribute information may be made available directly to applications via the standard practice of creating custom HTTP request headers before passing control to the - application. Applications should make no assumption about the presence of + resource. Web applications should make no assumption about the presence of specific attributes for their use unless they have intimate knowledge of the attribute release policies in place.

        -

        The AAP metadata controls this interface, and maps a Shibboleth attribute - to a header name, such as Shib-EP-Affiliation. +

        The AAP rules control this interface, and map Shibboleth attributes + to header names, such as Shib-EP-Affiliation. Using that example, any values of the mapped attribute will be placed in that header, delimited by semicolons. An application that uses a CGI-like syntax to access the header will find the values in the @@ -1724,58 +2168,112 @@ checkAddress="true/false"> mapped to REMOTE_USER. Even so, EPPN may not be provided by the AA, and REMOTE_USER might still be empty.

        -

        The Shib-Origin-Site variable will contain the - unique name/identifier of the origin site of the user. Some applications may - use this to lookup additional policy or application data. It normally takes - the form of a URI but could be any string in some deployments.

        -

        Finally, configuration may instruct the web server to place the entire - XML message containing the SAML attribute information from the AA into a - base64-encoded header called Shib-Attributes. - This is a raw interface that provides an application with the entire AA - response, and is not a filtered view based on any attribute acceptance rules - or even based on what attributes are recognized by the target. What was sent - is what you see.

        +

        In addition to general attribute information, the following special + HTTP headers are created for any authenticated request:

        +
        +
        HTTP_SHIB_ORIGIN_SITE
        +
        Contains the unique identifier (providerId) of the + origin site of the user. Some applications may use this to lookup + additional policy or application data. It normally takes the form of a + URI but could be any string in some deployments.
        +
        HTTP_SHIB-AUTHENTICATION-METHOD
        +
        Contains the SAML AuthenticationMethod URI that + documents some aspect of the user's authentication to the origin site's + web authentication service.
        +
        HTTP_SHIB_APPLICATION_ID
        +
        Contains the XML applicationId + attribute in shibboleth.xml that corresponds to + the request based on the RequestMap + and associated elements.
        +
        HTTP_SHIB_ATTRIBUTES
        +
        Contains the assertion in XML containing the + SAML attribute information from the AA in base64-encoded format. + This is a raw interface that provides an application with the entire + assertion in, but is still a filtered view based on any attribute acceptance + rules.
        +
        +

        Finally, special support exists to obtain the value of the SAML + <NameIdentifier> element, which identifies the + subject of the session, the user. Many Shibboleth deployments use opaque handles + that have no application value, however newer deployments may choose to support + alternative identifiers, including formats defined by SAML. Targets can use + these origins and obtain the primary subject name by using a special AAP + <AttributeRule> with a + Name corresponding to the SAML + Format identifier that describes the kind of + identifier used to represent the subject. The rule specifies in what header + to export the identifier value (such as REMOTE_USER), + while the Format identifier will be placed in the + HTTP_SHIB_NAMEIDENTIFIER_FORMAT header. +

        4.g. siterefresh

        Shibboleth provides a simple tool called siterefresh in the /opt/shibboleth/bin folder of the distribution to maintain metadata files referenced by - shibboleth.xml. It will return 0 on success and a negative number on + shibboleth.xml. It will return 0 only on success and a negative number on failure and log errors to stderr. If the data in - the new metadata file is bad or the signature is invalid, the existing copy - is kept. The SHAR and SHIRE stat all metadata files each time the data is - used, allowing them to detect and utilize updates in real-time operation.

        + the new metadata file is unusable or schema invalid, or the signature is invalid, + the existing copy is kept and not overwritten. The SHAR and SHIRE stat all + metadata files each time the data is used, allowing them to detect and utilize + updates in real-time during system operation.

        siterefresh takes the following command-line parameters:

        -
        --url <URL>
        +
        --url <URL>
        Specifies the URL of the - remote metadata file with which to update the local file.
        -
        --out <pathname>
        + remote metadata file with which to update the local file. HTTPS is not + supported at this time. +
        --out <pathname>
        Specifies the local file to which to write the new metadata.
        -
        --cert <pathname> -
        -
        Specifies the location of a certificate stored in +
        --noverify
        +
        Explicitly disables the requirement for the file to be signed + and allows the certificate parameter to be ommitted. If the file is signed, + the signature will be verified using whatever key is supplied inside it, + and an invalid signature will still result in an error, but if the file is + unsigned or has a valid signature, only a warning will be logged, and the + result will be success.
        +
        --cert <pathname>
        +
        Specifies the location of a certificate stored in PEM format used to validate the signature of the metadata file. Since much of Shibboleth's security flows from metadata files, this option is highly recommended, and the certificate - used should be verified independently.
        -
        --schema <pathname> -
        -
        Optionally defines a base path for schemas to use - when validating the file. Defaults to - /opt/shibboleth/etc/shibboleth/.
        + used should be verified independently in some out of band fashion. +
        --schema <pathname>
        +
        Optionally defines a base path for schemas to use + when validating the file. Defaults to a location based on the installation + path on Unix, or \opt\shibboleth\etc\shibboleth + on Windows.
        +
        --rootns <XML namespace>
        +
        Optionally defines the XML namespace of the root element + expected in the new file. Normally unused, provided to support alternative + metadata formats that may be backported to older releases.
        +
        --rootname <XML element name>
        +
        Optionally defines the name of the root element + expected in the new file. Normally unused, provided to support alternative + metadata formats that may be backported to older releases.
        +

        If a zero is returned, the command will copy the retrieved file to the output + location. Otherwise one of the following error values will be returned:

        + + + + + + + + + +
        -100an invalid combination of parameters was specified
        -10the OpenSAML library failed to initialize
        -1the file's XML digital signature was invalid
        -2a SAML exception was trapped
        -3an XML library exception was trapped
        -4a general XML security library exception was trapped
        -5an XML security library crypto exception was trapped
        -6an unknown exception was trapped

        A complete command issued to siterefresh might take the form:

        -

        /opt/shibboleth/bin/siterefresh --out sites.xml - --cert internet2.pem \
        - --url http://wayf.internet2.edu/InQueue/sites.xml

        +

        /opt/shibboleth/bin/siterefresh --out IQ-sites.xml --cert internet2.pem \
        + --url http://wayf.internet2.edu/InQueue/IQ-sites.xml

        -

        It is recommended that similar commands be added to a +

        It is recommended that such commands be added to a crontab to keep the site and trust files refreshed. AAP files tend to be site-specific, but could be maintained and distributed centrally. If the command is invoked in a script that writes the file to a new location and @@ -1787,38 +2285,21 @@ checkAddress="true/false">

        Shibboleth includes a useful plugin that extends the default memory cache for storing session data in the SHAR with a backing cache using an embedded - MySQL database. In most distributions, it is enabled by default. The plugin - can be found in the /opt/shibboleth/libexec - folder, and is loaded as an extension library using the - [extensions:saml] section of shibboleth.xml. - The following configuration options are available:

        -
        -
        mysql-cache-timeout = - <seconds>    (in [shar] section)
        -
        Specifies the duration in - seconds that must elapse between user accesses before that user's - session is purged from the persistent cache. Defaults to - 28800 seconds, or 8 hours. This should - generally be longer than the associated server's settings for session - lifetime and timeout, and the memory cache's timeout.
        -
        <MySQL Arguments>    - (one per line in [mysql] section)
        -
        To pass arguments to the MySQL engine, create - argument lines in the [mysql] section in the - form: -
        -

        arg1=<argument>
        - arg2=<argument>
        - etc...

        -
        -

        Important arguments you'll find by default include:

        + MySQL database. It is now disabled by default. The plugin can be found in the + /opt/shibboleth/libexec folder, and is loaded as an + extension library using the Extensions + element of shibboleth.xml. The extension and the + MySQLSessionCache + element are commented out by default.

        +

        Important Argument + elements you'll find by default include:

        -

        arg1 = --language=/opt/shibboleth/share/english
        - arg2 = --datadir=/opt/shibboleth/data

        +

        --language=/opt/shibboleth/share/english
        + --datadir=/opt/shibboleth/data

        -

        which set the message file path and the location of the cache's +

        which set the message file path and the location of the cache's database files respectively. Make sure the data directory exists before - starting the SHAR if you change this path.

        + starting the SHAR if you change this path.


        @@ -1842,22 +2323,15 @@ with a thorough description of errors and configurations used.

        # Configure a test directory
        <Location /secure>
          AuthType shibboleth
        +   ShibRequireSession On
          require valid-user
        -
        -   # Per-directory SHIRE Configuration
        -   #ShibBasicHijack On
        -
        -   # RM Configuration
        -   #AuthGroupFile /foo
        -   #ShibRequireSession On
        -   #ShibExportAssertion On
        </Location>

        For information regarding specific error messages that may be generated if the target does not work successfully, please refer to section 5.b., or write - mace-shib-users@internet2.edu.

        + shibboleth-users@internet2.edu.

        5.b. Common Problems