Skip to content
Snippets Groups Projects
Commit b8479c6f authored by Thijs Kinkhorst's avatar Thijs Kinkhorst
Browse files

Boolean values are preferred lowercase

parent 6097f7c7
No related branches found
No related tags found
No related merge requests found
...@@ -46,7 +46,7 @@ Array of arrays ...@@ -46,7 +46,7 @@ Array of arrays
'AssertionConsumerService' => [ 'AssertionConsumerService' => [
[ [
'index' => 1, 'index' => 1,
'isDefault' => TRUE, 'isDefault' => true,
'Location' => 'https://sp.example.org/ACS', 'Location' => 'https://sp.example.org/ACS',
'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', 'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
], ],
......
...@@ -10,18 +10,18 @@ Common options ...@@ -10,18 +10,18 @@ Common options
`NameQualifier` `NameQualifier`
: The NameQualifier attribute for the generated NameID. : The NameQualifier attribute for the generated NameID.
This can be a string that is used as the value directly. This can be a string that is used as the value directly.
It can also be `TRUE`, in which case we use the IdP entity ID as the NameQualifier. It can also be `true`, in which case we use the IdP entity ID as the NameQualifier.
If it is `FALSE`, no NameQualifier will be included. If it is `false`, no NameQualifier will be included.
: The default is `FALSE`, which means that we will not include a NameQualifier by default. : The default is `false`, which means that we will not include a NameQualifier by default.
`SPNameQualifier` `SPNameQualifier`
: The SPNameQualifier attribute for the generated NameID. : The SPNameQualifier attribute for the generated NameID.
This can be a string that is used as the value directly. This can be a string that is used as the value directly.
It can also be `TRUE`, in which case we use the SP entity ID as the SPNameQualifier. It can also be `true`, in which case we use the SP entity ID as the SPNameQualifier.
If it is `FALSE`, no SPNameQualifier will be included. If it is `false`, no SPNameQualifier will be included.
: The default is `TRUE`, which means that we will use the SP entity ID. : The default is `true`, which means that we will use the SP entity ID.
`saml:AttributeNameID` `saml:AttributeNameID`
...@@ -77,21 +77,21 @@ See the `store.type` configuration option in `config.php`. ...@@ -77,21 +77,21 @@ See the `store.type` configuration option in `config.php`.
`allowUnspecified` `allowUnspecified`
: Whether a persistent NameID should be created if the SP does not specify any NameID format in the request. : Whether a persistent NameID should be created if the SP does not specify any NameID format in the request.
The default is `FALSE`. The default is `false`.
`allowDifferent` `allowDifferent`
: Whether a persistent NameID should be created if there are only other NameID formats specified in the request or the SP's metadata. : Whether a persistent NameID should be created if there are only other NameID formats specified in the request or the SP's metadata.
The default is `FALSE`. The default is `false`.
`alwaysCreate` `alwaysCreate`
: Whether to ignore an explicit `AllowCreate="false"` in the authentication request's NameIDPolicy. : Whether to ignore an explicit `AllowCreate="false"` in the authentication request's NameIDPolicy.
The default is `FALSE`, which will only create new NameIDs when the SP specifies `AllowCreate="true"` in the authentication request. The default is `false`, which will only create new NameIDs when the SP specifies `AllowCreate="true"` in the authentication request.
`store` `store`
: An array of database options passed to `\SimpleSAML\Database`, keys prefixed with `database.`. : An array of database options passed to `\SimpleSAML\Database`, keys prefixed with `database.`.
The default is `[]`, which uses the global SQL datastore. The default is `[]`, which uses the global SQL datastore.
Setting both `allowUnspecified` and `alwaysCreate` to `TRUE` causes `saml:SQLPersistentNameID` to behave like `saml:PersistentNameID` (and other NameID generation filters), at the expense of creating unnecessary entries in the SQL datastore. Setting both `allowUnspecified` and `alwaysCreate` to `true` causes `saml:SQLPersistentNameID` to behave like `saml:PersistentNameID` (and other NameID generation filters), at the expense of creating unnecessary entries in the SQL datastore.
`saml:PersistentNameID2TargetedID` `saml:PersistentNameID2TargetedID`
...@@ -111,7 +111,7 @@ This can be used to set the `eduPersonTargetedID`-attribute to the same value as ...@@ -111,7 +111,7 @@ This can be used to set the `eduPersonTargetedID`-attribute to the same value as
`nameId` `nameId`
: Whether the generated attribute should be an saml:NameID element. : Whether the generated attribute should be an saml:NameID element.
The default is `TRUE`. The default is `true`.
...@@ -159,7 +159,7 @@ Generating Persistent NameID and eduPersonTargetedID. ...@@ -159,7 +159,7 @@ Generating Persistent NameID and eduPersonTargetedID.
60 => [ 60 => [
'class' => 'saml:PersistentNameID2TargetedID', 'class' => 'saml:PersistentNameID2TargetedID',
'attribute' => 'eduPersonTargetedID', // The default 'attribute' => 'eduPersonTargetedID', // The default
'nameId' => TRUE, // The default 'nameId' => true, // The default
], ],
// Use OID attribute names. // Use OID attribute names.
90 => [ 90 => [
......
...@@ -60,7 +60,7 @@ All these parameters override the equivalent option from the configuration. ...@@ -60,7 +60,7 @@ All these parameters override the equivalent option from the configuration.
`saml:NameIDPolicy` `saml:NameIDPolicy`
: The format of the NameID we request from the IdP: an array in the form of : The format of the NameID we request from the IdP: an array in the form of
`[ 'Format' => the format, 'allowcreate' => true or false ]`. `[ 'Format' => the format, 'AllowCreate' => true or false ]`.
Set to `false` instead of an array to omit sending any specific NameIDPolicy Set to `false` instead of an array to omit sending any specific NameIDPolicy
in the AuthnRequest. in the AuthnRequest.
...@@ -104,8 +104,8 @@ Options ...@@ -104,8 +104,8 @@ Options
* `urn:oasis:names:tc:SAML:2.0:profiles:holder-of-key:SSO:browser` * `urn:oasis:names:tc:SAML:2.0:profiles:holder-of-key:SSO:browser`
`assertion.encryption` `assertion.encryption`
: Whether assertions received by this SP must be encrypted. The default value is `FALSE`. : Whether assertions received by this SP must be encrypted. The default value is `false`.
If this option is set to `TRUE`, unencrypted assertions will be rejected. If this option is set to `true`, unencrypted assertions will be rejected.
: Note that this option can be overridden for a specific IdP in saml20-idp-remote. : Note that this option can be overridden for a specific IdP in saml20-idp-remote.
...@@ -207,8 +207,8 @@ Options ...@@ -207,8 +207,8 @@ Options
: *Note*: For this to be added to the metadata, you must also specify the `attributes` and `name` options. : *Note*: For this to be added to the metadata, you must also specify the `attributes` and `name` options.
`disable_scoping` `disable_scoping`
: Whether sending of samlp:Scoping elements in authentication requests should be suppressed. The default value is `FALSE`. : Whether sending of samlp:Scoping elements in authentication requests should be suppressed. The default value is `false`.
When set to `TRUE`, no scoping elements will be sent. This does not comply with the SAML2 specification, but allows When set to `true`, no scoping elements will be sent. This does not comply with the SAML2 specification, but allows
interoperability with ADFS which [does not support Scoping elements](https://docs.microsoft.com/en-za/azure/active-directory/develop/active-directory-single-sign-on-protocol-reference#scoping). interoperability with ADFS which [does not support Scoping elements](https://docs.microsoft.com/en-za/azure/active-directory/develop/active-directory-single-sign-on-protocol-reference#scoping).
: Note that this option also exists in the IdP remote configuration. An entry : Note that this option also exists in the IdP remote configuration. An entry
...@@ -260,7 +260,7 @@ Options ...@@ -260,7 +260,7 @@ Options
`nameid.encryption` `nameid.encryption`
: Whether NameIDs sent from this SP should be encrypted. The default : Whether NameIDs sent from this SP should be encrypted. The default
value is `FALSE`. value is `false`.
: Note that this option can be set for each IdP in the [IdP-remote metadata](./simplesamlphp-reference-idp-remote). : Note that this option can be set for each IdP in the [IdP-remote metadata](./simplesamlphp-reference-idp-remote).
...@@ -315,13 +315,13 @@ Options ...@@ -315,13 +315,13 @@ Options
`redirect.sign` `redirect.sign`
: Whether authentication requests, logout requests and logout responses sent from this SP should be signed. The default is `FALSE`. : Whether authentication requests, logout requests and logout responses sent from this SP should be signed. The default is `false`.
If set, the `AuthnRequestsSigned` attribute of the `SPSSODescriptor` element in SAML 2.0 metadata will contain its value. This If set, the `AuthnRequestsSigned` attribute of the `SPSSODescriptor` element in SAML 2.0 metadata will contain its value. This
option takes precedence over the `sign.authnrequest` option in any metadata generated for this SP. option takes precedence over the `sign.authnrequest` option in any metadata generated for this SP.
`redirect.validate` `redirect.validate`
: Whether logout requests and logout responses received by this SP should be validated. The default is `FALSE`. : Whether logout requests and logout responses received by this SP should be validated. The default is `false`.
`RegistrationInfo` `RegistrationInfo`
...@@ -336,7 +336,7 @@ Options ...@@ -336,7 +336,7 @@ Options
: A file with a certificate _and_ private key that should be used when issuing SOAP requests from this SP. : A file with a certificate _and_ private key that should be used when issuing SOAP requests from this SP.
If this option isn't specified, the SP private key and certificate will be used. If this option isn't specified, the SP private key and certificate will be used.
: This option can also be set to `FALSE`, in which case no client certificate will be used. : This option can also be set to `false`, in which case no client certificate will be used.
`saml.SOAPClient.privatekey_pass` `saml.SOAPClient.privatekey_pass`
: The passphrase of the privatekey in `saml.SOAPClient.certificate`. : The passphrase of the privatekey in `saml.SOAPClient.certificate`.
...@@ -393,7 +393,7 @@ Options ...@@ -393,7 +393,7 @@ Options
`WantAssertionsSigned` `WantAssertionsSigned`
: Whether assertions received by this SP must be signed. The default value is `FALSE`. : Whether assertions received by this SP must be signed. The default value is `false`.
The value set for this option will be used to set the `WantAssertionsSigned` attribute of the `SPSSODescriptor` element in The value set for this option will be used to set the `WantAssertionsSigned` attribute of the `SPSSODescriptor` element in
the exported SAML 2.0 metadata. the exported SAML 2.0 metadata.
...@@ -433,8 +433,8 @@ Here we will list some examples for this authentication source. ...@@ -433,8 +433,8 @@ Here we will list some examples for this authentication source.
'certificate' => 'example.crt', 'certificate' => 'example.crt',
'privatekey' => 'example.key', 'privatekey' => 'example.key',
'privatekey_pass' => 'secretpassword', 'privatekey_pass' => 'secretpassword',
'redirect.sign' => TRUE, 'redirect.sign' => true,
'redirect.validate' => TRUE, 'redirect.validate' => true,
], ],
......
...@@ -727,7 +727,7 @@ class SPTest extends ClearStateTestCase ...@@ -727,7 +727,7 @@ class SPTest extends ClearStateTestCase
'AssertionConsumerService' => [ 'AssertionConsumerService' => [
[ [
'index' => 1, 'index' => 1,
'isDefault' => TRUE, 'isDefault' => true,
'Location' => 'https://sp.example.org/ACS', 'Location' => 'https://sp.example.org/ACS',
'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', 'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
], ],
...@@ -1227,7 +1227,7 @@ class SPTest extends ClearStateTestCase ...@@ -1227,7 +1227,7 @@ class SPTest extends ClearStateTestCase
'AssertionConsumerService' => [ 'AssertionConsumerService' => [
[ [
'index' => 1, 'index' => 1,
'isDefault' => TRUE, 'isDefault' => true,
'Location' => 'https://sp.example.org/ACS', 'Location' => 'https://sp.example.org/ACS',
'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', 'Binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
], ],
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment