# What is SAML?
Security Assertion Markup Language (SAML, pronounced SAM-el) is an open standard for exchanging authentication and authorization data between parties, in particular, between an identity provider and a service provider. SAML is an XML-based markup language for security assertions (statements that service providers use to make access-control decisions). SAML is also:
- A set of XML-based protocol messages
- set of protocol message bindings
- set of profiles (utilizing all of the above)
- The single most important use case that SAML addresses is web browser single sign-on (SSO). Single sign-on is relatively easy to accomplish within a security domain (using cookies, for example) but extending SSO across security domains is more difficult and resulted in the proliferation of non-interoperable proprietary technologies. The SAML Web Browser SSO profile was specified and standardized to promote interoperability.
# SAML SP 101
This plugin is concerned with the Service Provider (SP) site. It's role is to receive authentication and authorization messages from the Identity Provider (IdP). Upon a successful IdP login, a message login status (success or not), session info, and user attributes are POSTed (usually POST, sometimes GET) to the Craft site and received and validated by the plugin. Then the user is synced, logged in, and redirected to where the user initially intended to go.
# What is the Entity ID?
An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IdP) or a Service Provider (SP). Recent plugin updates has made it so Entity ID is editable but be careful when doing so -- the other providers may still have that ID as their link to yours.
# Is there Multi-Site (opens new window) support?
Answer: Yes, as of 2.0.1, a multi-site configuration should work seamlessly.
Multi-Site When you create "My Provider", the Entity ID and endpoints default to the current site. This should not create any problems. If the appearance is a aesthetic issue for whatever reason, use the Primary site when creating "My Provider". You can also override the default Entity Id if desired.
# Does the plugin support a metadata URL?
Answer: Yes, as of version 2.1. If you use providers like ADFS who periodically renew their metadata and certificates, you can automate the syncing by running the following command:
php craft saml-sp/metadata/refresh-with-url <uid>
An example cronjob would look like this:
0 0 * * * php craft saml-sp/metadata/refresh-with-url <uid> || /opt/notify-admins-on-fail.sh
# Signature required but not found
Answer: By default for security reasons, the plugin requires signatures for both the Response and the Assertion. If these are not found
you'll see an error "Signature required but not found: Response" or "Signature required but not found: Assertion".
You can modify the settings of this require (at your own risk) by setting the
config/saml-sp.php config file with
(found in class
\flipbox\saml\sp\models\Settings) the following settings:
An example config file looks like the following:
return [ // assertion is required but not the response 'requireResponseToBeSigned' => false, ];
Recommended It is recommended to have both or at least one of the two (Response or Assertion) for security purposes. The signature helps validate the message is from the trusted Identity Provider.
# Error: Trying to get property 'keychain' of non-object
Answer: This usually means "My Provider", the sites metadata/provider can't be found, or possibly, hasn't
been created. Go to
https://<your domain>/admin/saml-sp/metadata/my-provider and create a new provider
for your site.