Remove schema checks in securesystemslib.gpg #775
Merged
Conversation
This file contains hidden or 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
In preparation for the removal of schema.py (secure-systems-lab#183), this patch removes schema checks in the following modules of the `securesystemslib.gpg` subpackage: * internal modules `rsa`, `dsa`, `eddsa`, `common`. These checks are redundant with schema checks that are already performed in the calling functions of the `functions` module. * in previously public `functions` module: * keyid in `create_signature` and `export_pubkey` functions * public key and signature dict in `verify_signature` function This is okay for two reasons: 1. the preferred way of interacting with `securesystemslib.gpg.functions` is via `GPGSigner`, which controls the format of the passed arguments to some extent 2. securesystemslib.gpg still raises meaningful and even more consistent errors for invalid arguments anyway, than it did before. E.g. a keyid passed to `export_pubkey` that doesn't conform to the previously checked hex schema, now raises a `KeyNotFoundError`. Other changes include: * move string literal `GPG_HASH_ALGORITHM_STRING` from `securesystemslib.schema` to the better suited `secureystemslib.gpg.constants` module. * remove mentions of schema definitions in docstrings * adopt changes in tests Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
lukpueh
force-pushed
the
rm-gpg-schema-check
branch
from
d5585d1 to
7d4c336
Compare
jku
approved these changes
Apr 16, 2024
Collaborator
jku
left a comment
jku
left a comment
There was a problem hiding this comment.
this is not a part of the code I'm familiar with but seems correct...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
blocks on #772 (commits are included in this PR)In preparation for the removal of schema.py (#183), this patch removes schema checks in the following modules of the
securesystemslib.gpgsubpackage:internal modules
rsa,dsa,eddsa,common. These checks are redundant with schema checks that are already performed in the calling functions of thefunctionsmodule.in previously public
functionsmodule:create_signatureandexport_pubkeyfunctionsverify_signaturefunctionThis is okay for two reasons:
the preferred way of interacting with
securesystemslib.gpg.functionsis viaGPGSigner, which controls the format of the passed arguments to some extentsecuresystemslib.gpg still raises meaningful and even more consistent errors for invalid arguments anyway, than it did before. E.g. a keyid passed to
export_pubkeythat doesn't conform to the previously checked hex schema, now raises aKeyNotFoundError.Other changes include:
GPG_HASH_ALGORITHM_STRINGfromsecuresystemslib.schemato the better suitedsecureystemslib.gpg.constantsmodule.