| Note |
|---|
The plugin feature is available only in V4.1 and later of the software. |
| Table of Contents |
|---|
Overview
V4.1 introduces a new Plugins are a mechanism to install non-default functionality into the IdP called Plugins. from signed release distribution packages.
Plugins:
Are distinguished from each other by a unique identifier in the style of a Java package name.
Are revised on a different schedule to the IdP itself, so upgrading the IdP does not upgrade a plugin and equally upgrading a plugin does not affect the IdP. Often, significant IdP upgrades may require plugin upgrades, but the operations are distinct.
Must be GPG signed.
May be installed and updated directly from a web-hosted file or from a local file (with associated signature).
Generally has have no configuration that it directly installs, leaving this to the Module layer to manage.
May require one or more Modules to be enabled before they can be installed, this being controlled indicated by the plugin developer.
May automatically enable a Module on install and/or disable a Module on uninstall, this being controlled indicated by the plugin developer.
It is usual that a plugin contains one or more Modules, so the usual way to add functionality via a plugin is to install the plugin, then enable the module (if not already done for you) and then complete any per-module configuration.
...
At any time the Plugin developer can change the status of any released plugin from Supported (current) to
OutOfDate meaning: Still working but a new version is availableUnsupported: Out of Support
Secadv: Security alerts exist against this plugin
Withdrawn
There are no semantics associated with these beyond that only Current Supported versions are candidates for automatically selected update. The other states are there as (dynamic) guidance from the developer to the deployer of the state of the pluginthe deployer of the state of the plugin.
It should be emphasised that the versioning is purely a statement of API compatibility, not support. The fact that a plugin version is “Current” is purely a statement that “This is the best version to run with this version of the IdP”.
The only plugin versions supported by the Shibboleth Project are those which are marked current for a support version of the IdP.
GPG Trust
In order for a plugin to be installed, the distribution must be accompanied by a GPG signature. The installation process checks the correctness of this signature before it does any installation or other potentially dangerous operations. Before it can do this check, the public key needs to be available to the plugin command in a trust store. By default each plugin has its own trust store. This means that the trust surrounding one plugin cannot be subverted to allow another plugin to be installed. Alternatively the --truststore qualifier to the plugin command can be used to point to a central store (which you are expected to maintain).
...
All plugin manipulation (except trust store maintenance) is done via the plugin command. Operations fall into 2 broad categories.
Plugin Discovery and
...
Automated Installation
Information about plugins is always kept separate from the plugin itself. This same information can be used to discover which plugins are available at a given URL. The -L will list them. This defaults to using the URL which is shared by all plugins developed by the Shibboleth Team (and documented here). The --updateURL allows other locations to be used.
...
These define which operation to perform.
Short | Long | Parameter | Description |
|---|---|---|---|
-i | --install | File Or URL | Install the provided qualifier |
-u | --update | PluginId | Update installed plugin |
-r | --remove | PluginId | Remove the installed plugin |
-l | --list | Enumerate all installed plugins | |
-fl | --full-list | Give full version details for all installed plugins | |
-cl | --contents-list | PluginId | List all files installed by the specified plugin |
-L |
--list-available | List available plugins (i.e discover plugins which can be downloaded and installed) | ||
-I |
--install-ID | PluginId | Install plugin from its ID. The plugin should be available at the default endpoint (or that specified by --updateURL) | |
--noCheck | Do not check for compatibility with the current IdP Version | ||
--updateURL | Specify the update URL (for -L, -I or to override the plugin provided value) | ||
--license | PluginId | Output the license information for the specified plugin |
Other Qualifiers
These provide extra/advanced options for the command:
Short | Long | Parameter | Description |
|---|---|---|---|
--verbose | Verbose logging | ||
--quiet | Quiet logging | ||
--logConfig | a logback file | Specify a file to use to control the logging of the plugin command | |
--version | Output the version of the plugin command | ||
--propertyFiles | file list | Any property files that are to be included when parsing a Spring file input (see below) | |
--noPrompt | Use for unattended installs. |
If specified the install will fail rather than require input. | |||
--truststore | Path to the (non default) trust store file used during installs and updates. |
See above. | |
--noRebuild |
If set then the war file is not |
rebuilt after the installation. | |||
-fu | --force-update | Version | Used with the -u qualifier to force the update (or downgrade) to a specific version |
-hc | --http-client |
Bean ID | Allows specification of an HTTP client bean used to download updates (or perform any related Module operation). For details on wiring up a client bean, refer to the HttpClientConfiguration topic. |
-hs | --http-security |
bean name
Bean ID | Allows security customization of the HTTP operation(s). |
Optional Parameter
Finally the plugin command can take one additional bare parameter - the path to a file which contains any native Spring bean definitions that may be needed. This is typically only required for the -hc and -hs qualifiers to perform advanced customization of HTTP operations, and should be rare.
...