Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to clarify that saml.cert requires a PEM-encoded x509 c… #133

Merged
merged 3 commits into from
Oct 9, 2017

Conversation

markstos
Copy link
Contributor

…ertificate.

README.md Outdated
@@ -117,12 +117,18 @@ Authentication requests sent by Passport-SAML can be signed using RSA-SHA1. To s
privateCert: fs.readFileSync('./cert.pem', 'utf-8')
```

It is a good idea to validate the incoming SAML Responses. For this, you can provide the Identity Provider's certificate using the `cert` confguration key:
It is a good idea to validate the incoming SAML Responses. For this, you can provide the Identity Provider's PEM-encoded X.509 certificate using the `cert` confguration key. The "BEGIN CERTIFICATE" and "END CERTIFICATE" lines should be stripped out and the certificate should be provided on a single line.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this info. This is very useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are welcome. Hopefully the contribution will get merged so it will be easier for other people to find.

@lordgraysith
Copy link

👍

@tilleps tilleps mentioned this pull request Jan 26, 2017
@pdspicer pdspicer self-assigned this Mar 29, 2017
@pdspicer
Copy link
Contributor

@markstos I was considering a fix for this that would, instead of constraining format, fix the cert-to-PEM conversion so that any provided format containing the body of the certificate (with or without newlines and the BEGIN/END lines) would work correctly. Thoughts?

@markstos
Copy link
Contributor Author

@pdspicer supporting the BEGIN/END lines and linebreaks would we a welcome addition.

@pdspicer
Copy link
Contributor

In that case I will close this PR once that change is made available, sound good?

@markstos
Copy link
Contributor Author

markstos commented Mar 30, 2017 via email

@markstos markstos merged commit ff41c29 into node-saml:master Oct 9, 2017
@markstos markstos deleted the patch-1 branch October 9, 2017 19:10
@markstos
Copy link
Contributor Author

markstos commented Oct 9, 2017

I went ahead and merged this. When @pdspicer follows through to make the code more flexible about the cert format, we can update the README to match.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants