Skip to content

Commit

Permalink
docs: Improve docs for privateKey format. Ref #230
Browse files Browse the repository at this point in the history
  • Loading branch information
markstos committed Oct 10, 2017
1 parent 0d46479 commit a780d07
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,10 @@ The `decryptionCert` argument should be a public certificate matching the `decry

Passport-SAML uses the HTTP Redirect Binding for its `AuthnRequest`s (unless overridden with the `authnRequestBinding` parameter), and expects to receive the messages back via the HTTP POST binding.

Authentication requests sent by Passport-SAML can be signed using RSA-SHA1. To sign them you need to provide a private key in the PEM format via the `privateCert` configuration key. For example:
Authentication requests sent by Passport-SAML can be signed using RSA-SHA1. To sign them you need to provide a private key in the PEM format via the `privateCert` configuration key. The certificate
should start with `-----BEGIN PRIVATE KEY-----` on its own line and end with `-----END PRIVATE KEY-----` on its own line.

For example:

```javascript
privateCert: fs.readFileSync('./cert.pem', 'utf-8')
Expand Down

0 comments on commit a780d07

Please sign in to comment.