Skip to content

Commit 4d97ffc

Browse files
committed
README: link to related sections and clarify decryptionCert docs
Before it wasn't clear whether `decryptionCert` referred to `decryptionPvk` or the public cert it is paired with. Adding the word "public" clarifies that.
1 parent 6d1215b commit 4d97ffc

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ Config parameter details:
4848
* `host`: host for callback; will be combined with path and protocol to construct callback url if `callbackUrl` is not specified (default: `localhost`)
4949
* `entryPoint`: identity provider entrypoint
5050
* `issuer`: issuer string to supply to identity provider
51-
* `cert`: see 'security and signatures'
52-
* `privateCert`: see 'security and signatures'
51+
* `cert`: see [Security and signatures](#security-and-signatures)
52+
* `privateCert`: see [Security and signatures](#security-and-signatures)
5353
* `decryptionPvk`: optional private key that will be used to attempt to decrypt any encrypted assertions that are received
5454
* `signatureAlgorithm`: optionally set the signature algorithm for signing requests, valid values are 'sha1' (default), 'sha256', or 'sha512'
5555
* Additional SAML behaviors
@@ -104,7 +104,7 @@ app.get('/login',
104104

105105
As a convenience, the strategy object exposes a `generateServiceProviderMetadata` method which will generate a service provider metadata document suitable for supplying to an identity provider. This method will only work on strategies which are configured with a `callbackUrl` (since the relative path for the callback is not sufficient information to generate a complete metadata document).
106106

107-
The `decryptionCert` argument should be a certificate matching the `decryptionPvk` and is required if the strategy is configured with a `decryptionPvk`.
107+
The `decryptionCert` argument should be a public certificate matching the `decryptionPvk` and is required if the strategy is configured with a `decryptionPvk`.
108108

109109

110110
## Security and signatures

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "passport-saml",
3-
"version": "0.15.0",
3+
"version": "0.16.1",
44
"licenses": [
55
{
66
"type": "MIT",

0 commit comments

Comments
 (0)