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

Set getCertFromKeyInfo to noop #445

Merged
merged 2 commits into from
Jan 26, 2024
Merged

Set getCertFromKeyInfo to noop #445

merged 2 commits into from
Jan 26, 2024

Conversation

cjbarth
Copy link
Contributor

@cjbarth cjbarth commented Jan 24, 2024

getKeyInfoContent was incorrectly set to noop instead of getCertFromKeyInfo

`getKeyInfoContent` was incorectly set to `noop` instead of `getCertFromKeyInfo`
Copy link

codecov bot commented Jan 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f8cbbb7) 73.17% compared to head (b12d68e) 73.05%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #445      +/-   ##
==========================================
- Coverage   73.17%   73.05%   -0.12%     
==========================================
  Files           9        9              
  Lines         902      902              
  Branches      239      239              
==========================================
- Hits          660      659       -1     
  Misses        143      143              
- Partials       99      100       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cjbarth
Copy link
Contributor Author

cjbarth commented Jan 24, 2024

This PR addresses the concerns correctly pointed out by @srd90 here.

Since it is fixing a mistake, and it seems few, if any are using it, should this be a semver-minor change or a semver-major change @LoneRifle ?

LoneRifle
LoneRifle previously approved these changes Jan 25, 2024
Copy link
Collaborator

@LoneRifle LoneRifle left a comment

Choose a reason for hiding this comment

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

lgtm, thanks for the catch @srd90 !

@cjbarth
Copy link
Contributor Author

cjbarth commented Jan 25, 2024

@LoneRifle , do you think I should release this as a semver-minor or semver-major release?

@LoneRifle
Copy link
Collaborator

Inclination is towards a major release, given that it's likely a breaking change. At the same time, you could consider deprecating v5 so that users are encouraged to skip it

@srd90
Copy link

srd90 commented Jan 25, 2024

Shouldn't you consider deprecating also v4 due to the fact that it has same default functionality that was now replaced with noop.

Thing that was about to happen at node-saml/node-saml#341 is a proof that people are quite likely going to disable signature verification accidentally during migration from earlier versions to v4 or v5 (more info from #399 for those who land this PR later) and its going to be undetected if they don't have tests to cover e.g. the case at PR mentioned earlier.

@cjbarth
Copy link
Contributor Author

cjbarth commented Jan 25, 2024

Honestly, I think we de-facto deprecate anything other than the current semver-major release. I suppose I can actively deprecate these on NPM though. I have no interest in trying to support anything other the HEAD or the latest release. If someone wants something on an older version, they can make the correct PR, but that is on them.

@LoneRifle what has been your tradition here?

@srd90
Copy link

srd90 commented Jan 25, 2024

Just one more comment: Maybe CVE for v4 and v5 so that those who have already migrated to those versions would possible become more aware of unsecure default implementation which overrides explicitly set certificate.

@LoneRifle
Copy link
Collaborator

@cjbarth - I've usually just left versions alone, but only because I previously saw no significant security issues. I'm happy to defer to you to set the norm going forward

@cjbarth cjbarth merged commit 2120172 into node-saml:master Jan 26, 2024
8 of 9 checks passed
@cjbarth cjbarth deleted the keyinfo branch January 26, 2024 18:11
dozgunyal added a commit to dozgunyal/xml-crypto that referenced this pull request May 6, 2024
Changes in node-saml#445 was not reflected in the documentation. This PR fixes it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants