Configuration
- Scott Cantor
Note that a lot of advanced use cases will require you to make use of the Java API documentation, which can be found for all of our Java software under https://shibboleth.net/api/
You can directly access the most “recent” versions of some of the major project Javadocs via:
When you see a syntax like this:
name 4.2
That signifies a feature, setting, property, etc. that is only available in the corresponding minor version or later of the software. You will encounter features that are marked with unreleased versions of the software, which is necessary in order for us to avoid having to document all the new features at the end of a release cycle.
Configuration Overviews and References
Topics exist for each general configuration area to go into detail on how to do various things and to provide a definitive reference on configuration settings, beans, properties, etc. Before digging into details, you should take a look at the layout summary below to get a general idea of where things live and what not to change.
Each of the detailed pages makes note of the files involved in that topic.
If you're coming into this cold, you really need to review these topics first, just to get the lay of the land, and because the core "language" for many of the configuration files is Spring, and because debugging your changes will usually require some logging familiarity.
If you don't know Spring XML configuration syntax, that's not unusual, but doing a little bit of reading on it will be essential, if not right away then almost immediately after you try and actually configure something.
To configure a new IdP from scratch, you will need to address these areas first:
Attribute Registry (optionally)
A Hello World module is available that will allow you test the system at this stage without diving into actual SSO protocol considerations.
The core requirements to proceed with SAML support are:
If you need to dig into more advanced SAML configuration needs, or need to interoperate with commercial cloud services, you will usually need to tackle these areas:
CAS support is discussed in:
OIDC support is discussed in:
Advanced configuration topics:
Finally, configuration related to "productionalizing" an IdP:
Installation Layout
The following summary will guide you in understanding the installed software layout and how to locate important files.
Older versions of the software included a mix of user-editable and system configuration files. With V4+, there are files installed that aren’t meant to be editable, and any content in the system directory, if it exists, are for compatibilty and should never be modified.
There are a number of interdependencies between the Spring configuration files in various locations and inside the software that are a contract between the user-modifiable configuration and the system. In most cases, these dependencies can be identified via the use of Spring bean names that contain the prefix "shibboleth." When in doubt, don't remove a bean name that contains such a prefix, or comment it out (unless it starts out commented).
Directory | Explanation |
|---|---|
bin | Contains command line tools, and any Java libraries needed during installation. During upgrades files from the distribution will be overwritten, but additional files that you add will be preserved, so you can store your own command line scripts here. |
conf | The main configuration tree. During any installation (first time or upgrades), files are never replaced in this directory. New files required by the IdP version being installed will be populated if and only if they do not exist. |
credentials | Contains your keys, certificates, and keystores, as well as credentials on which you rely such as for metadata signature validation. Files in this directory should generally be readable only by the user account the IdP will run under (certificates aren't secret, but it's easiest to just lock down everything). During any installation (first time or upgrades), files are never replaced in this directory. In unusual cases, new files may be created if they do not exist. |
dist | Formerly just a copy of all the user-modifiable files from the distribution, this directory now also holds the state of installed plugins, and is used to recreate the war file properly when it is rebuilt. While you are free to look at anything in this folder, do NOT remove or alter it in any way. In the event of an accident, you can recreate this directory by repeating the installation process (i.e., as a same-version upgrade) and then reinstalling any plugins. |
edit-webapp | This directory is created on initial install and thereafter files may (rarely) be added during upgrades but not overwritten. You may place any local configuration you wish to include in your packed warfile. During warfile creation, the contents of this tree are copied over top of the webapp directory, from which the war file is then built. Thus, it is an overlay tool for your local modifications and extensions. |
flows | Contains any user-editable Spring Web Flow definitions. During any installation (first time or upgrades), files are never replaced in this directory. New files required by the IdP version being installed will be populated if and only if they do not exist. |
logs | Contains the IdP diagnostic and audit logs by default. |
messages | Contains internationalized message properties used in various UI templates. This contains only new or overriden message properties or post-install translations; all of the default messages and translations are in the system tree. During any installation (first time or upgrades), files are never replaced in this directory. New files required by the IdP version being installed will be populated if and only if they do not exist. |
metadata | A storage location for SAML metadata used by the IdP (see MetadataConfiguration). During initial installation, some representative SAML metadata for the IdP is generated based on the installation inputs and placed in this directory in a file named idp-metadata.xml. Note that the IdP does not need to load its own metadata. Also note that the metadata is generated as a one-time operation during installation. It does not result from an in-depth analysis of the IdP configuration and does not change when the configuration changes. It's a starter example, not a real metadata source. |
views | Contains Velocity page templates displayed to users of the IdP. While JSP views (and the older taglibs) are generally supported, most of the default webflow views provided are now Velocity templates that can be maintained outside the warfile and changed at runtime. During any installation (first time or upgrades), files are never replaced in this directory. New files required by the IdP version being installed will be populated if and only if they do not exist. |
war | Contains the packed IdP warfile for container deployment. The warfile can be rebuilt at any time by running the build.sh or build.bat script in the bin directory. It wll prompt you to verify the installation directory (which in theory allows for multiple installations). |
Backup Files
When upgrading, the installer uses the Module system to re-enable all active modules, resulting in new files being added to the system and old files usually left alone, with the distributed versions of those files added with an “.idpnew-<version>” extension for easy comparison. On rare occasions, files may require overwrite, in which case the original file will be preserved with an “.idpsave” extension.
Windows-Only
On Windows, if Jetty has been installed there will be extra directories created.
Directory | Explanation |
|---|---|
jetty-base | Contains the Jetty configuration. The only file which may be edited and which is guaranteed to survive upgrades is start.d\idp.ini If you need to edit anything else in this directory, you should deploy your own container. |
static | Contains and data you want to serve statically from the Jetty installation ( |
C:\Program Files\Shibboleth\Jetty | Contains the Jetty installation. None of its contents should be edited; it is always deleted and recreated during an upgrade. The file JETTY_VERSION.TXT contains the precise Jetty version. The log files for the jetty instance are locate in this directory. The can be of interest to debug IdP initialization issues. |
C:\Program Files\Shibboleth\ProcRun -------------------------------------------------------------- | Contains the executables that allow the IdP to run as a user mode system service. None of its contents should be edited; it is always deleted and recreated during an upgrade. The executable shibd_idpw.exe can control the configuration of the user mode system service, but any configuration is not guaranteed to survive an upgrade. The log file for the procrun service are located in this directory. This records any output from the process until such time as the jetty logging occurs. It is unusual that this has any data of interest. |
Configuration Changes (and Non-Changes) from Earlier Versions
Please refer to the ReleaseNotes for the relevant changes to be aware of when upgrading.