Skip to content

Commit

Permalink
Merge pull request #615 from johnnyshields/improve-readme
Browse files Browse the repository at this point in the history
One more README.md cleanup
  • Loading branch information
pitbulk authored Aug 18, 2021
2 parents 6b85084 + fe1eb50 commit 83d559b
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,13 +316,17 @@ of using the fingerprint method. The fingerprint, is a hash, so at the end is op
attack that can end on a signature validation bypass. Other SAML toolkits deprecated that mechanism,
we maintain it for compatibility and also to be used on test environment.
In some scenarios the IdP uses different certificates for signing/encryption, or is under key
rollover phase and more than one certificate is published on IdP metadata.
## Handling Multiple IdP Certificates
In order to handle that Ruby SAML offers the `idp_cert_multi` parameter.
When used, `idp_cert` and `idp_cert_fingerprint` values are ignored.
If the IdP metadata XML includes multiple certificates, you may specify the `idp_cert_multi`
parameter. When used, the `idp_cert` and `idp_cert_fingerprint` parameters are ignored.
This is useful in the following scenarios:
The `idp_cert_multi` must be a Hash as follows:
* The IdP uses different certificates for signing versus encryption.
* The IdP is undergoing a key rollover and is publishing the old and new certificates in parallel.
The `idp_cert_multi` must be a `Hash` as follows. The `:signing` and `:encryption` arrays below,
add the IdP X.509 public certificates which were published in the IdP metadata.
```ruby
{
Expand All @@ -331,9 +335,6 @@ The `idp_cert_multi` must be a Hash as follows:
}
```
And on `:signing` and `:encryption` arrays, add the different IdP X.509 public certificates
published on the IdP metadata.
## Metadata Based Configuration
The method above requires a little extra work to manually specify attributes about both the IdP and your SP application.
Expand Down Expand Up @@ -558,7 +559,7 @@ You can add `ValidUntil` and `CacheDuration` to the SP Metadata XML using instea
## Signing and Decryption
Ruby SAML supports the following signing and decryption functionality:
Ruby SAML supports the following functionality:
1. Signing your SP Metadata XML
2. Signing your SP SAML messages
Expand Down

0 comments on commit 83d559b

Please sign in to comment.