Allow for use of privateKey instead of privateCert #488
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Minimize mentions of `privateCert` to minimize confusion.
markstos
approved these changes
Nov 2, 2020
There was a problem hiding this comment.
This has code/docs/tests and is backward compatible. It looks good to me. I updated the docs to further simplify them and focus on the clearer privateKey name instead of the less clear "private cert".
Assigning to @cjbarth for a second look.
markstos
added
needs-review
cjbarth
approved these changes
Nov 2, 2020
| @@ -15,15 +16,15 @@ interface SignSamlPostOptions { | |||
| export function signSamlPost(samlMessage: string, xpath: string, options: SignSamlPostOptions) { | |||
| if (!samlMessage) throw new Error('samlMessage is required'); | |||
| if (!xpath) throw new Error('xpath is required'); | |||
| if (!options || !options.privateCert) throw new Error('options.privateCert is required'); | |||
| if (!options || (!options.privateCert && !options.privateKey)) throw new Error('options.privateCert or options.privateKey is required'); | |||
There was a problem hiding this comment.
What do you think of issuing a deprecation warning if someone is using privateCert? This way, we can remove this extra code with a future semver-major release.
There was a problem hiding this comment.
@cjbarth That's OK if you want to add the warning.
RyanCopley
approved these changes
Nov 2, 2020
|
I'm going to go ahead and merge this. We can add a deprecation warning in a future release. It will clean up the code to eventually not support both names. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An updated PR to address the conversation here: #387