[v6] Refuse to use keys without key flags, add config.allowMissingKeyFlags
#1677
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
larabr
commented
Sep 11, 2023
twiss
reviewed
Sep 11, 2023
twiss
approved these changes
Oct 17, 2023
src/key/helper.js
Outdated
Comment on lines
365
to
372
| case enums.publicKey.ed25519: { | ||
| if (!signature.keyFlags && !config.allowMissingKeyFlags) { | ||
| throw new Error('None of the key flags is set: consider passing `config.allowMissingKeyFlags`'); | ||
| } | ||
|
|
||
| return !signature.keyFlags || | ||
| (signature.keyFlags[0] & enums.keyFlags.signData) !== 0; | ||
| } |
There was a problem hiding this comment.
Sorry for missing these last time (and being very nitpicky ^.^), but these brackets are also not necessary. They're only necessary if you need a block scope, e.g. if you're creating block-scoped variables.
Suggested change
| case enums.publicKey.ed25519: { | |
| if (!signature.keyFlags && !config.allowMissingKeyFlags) { | |
| throw new Error('None of the key flags is set: consider passing `config.allowMissingKeyFlags`'); | |
| } | |
| return !signature.keyFlags || | |
| (signature.keyFlags[0] & enums.keyFlags.signData) !== 0; | |
| } | |
| case enums.publicKey.ed25519: | |
| if (!signature.keyFlags && !config.allowMissingKeyFlags) { | |
| throw new Error('None of the key flags is set: consider passing `config.allowMissingKeyFlags`'); | |
| } | |
| return !signature.keyFlags || | |
| (signature.keyFlags[0] & enums.keyFlags.signData) !== 0; |
There was a problem hiding this comment.
I know they are not needed, but it's not a big deal to add them IMO -- I just find it confusing to have a lot of code without brackets.
There was a problem hiding this comment.
Er, OK, but I think it's more important to have a consistent code style. JS cases normally don't have brackets, and most other code in the library doesn't have them, so we should only add them when needed.
There was a problem hiding this comment.
Ok, but then I'll add a linting rule for this, so that it's automatically enforced
larabr
force-pushed
the
v6-reject-no-key-flags
branch
from
0c2a1be
to
91fa87b
Compare
larabr
force-pushed
the
v6-reject-no-key-flags
branch
2 times, most recently
from
3160172
to
a28ae91
Compare
Key flags are needed to restrict key usage to specific purposes: https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#section-5.2.3.29 . Some older keys (e.g. from OpenPGP.js v1) do not declare any key flags. In previous OpenPGP.js versions, we've allowed such keys to be used for any operation for which they were compatible. This behaviour has now changed, and these keys are not allowed to be used for any operation. The setting `config.allowMissingKeyFlags` has been added to selectively revert to the past behaviour.
Also fix some indent issues with armoring code detected after required ESLint update. s
larabr
force-pushed
the
v6-reject-no-key-flags
branch
from
a28ae91
to
e69b1db
Compare
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.
Key flags are needed to restrict key usage to specific purposes: https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#section-5.2.3.29 . Some older keys (e.g. from OpenPGP.js v0) do not declare any key flags. In previous OpenPGP.js versions, we've allowed such keys to be used for any operation for which they were compatible. This behaviour has now changed, and these keys are not allowed to be used for any operation.
The setting
config.allowMissingKeyFlagshas been added to selectively revert to the past behaviour.