add support for PEM Parameters without ASN1 hooks#1831
Merged
samuel40791765 merged 2 commits intoaws:mainfrom Sep 12, 2024
Merged
add support for PEM Parameters without ASN1 hooks#1831samuel40791765 merged 2 commits intoaws:mainfrom
samuel40791765 merged 2 commits intoaws:mainfrom
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1831 +/- ##
==========================================
+ Coverage 78.47% 78.52% +0.04%
==========================================
Files 583 583
Lines 98480 98601 +121
Branches 14125 14137 +12
==========================================
+ Hits 77287 77425 +138
+ Misses 20564 20549 -15
+ Partials 629 627 -2 ☔ View full report in Codecov by Sentry. |
justsmth
reviewed
Sep 6, 2024
justsmth
reviewed
Sep 6, 2024
b11cf54 to
fb39681
Compare
435cb6d to
e5ab72d
Compare
e5ab72d to
2618c46
Compare
samuel40791765
commented
Sep 9, 2024
Contributor
Author
samuel40791765
left a comment
There was a problem hiding this comment.
Not sure if the original comments still apply when this was in "Draft" and unfinished. The logic has changed considerably since then.
I think we can get away with not implementing the EVP_PKEY_DH ASN1 hooks with this method going forward, feel free to leave any comments again if the original ones still apply.
justsmth
reviewed
Sep 10, 2024
Comment on lines
+156
to
158
|
|
||
| // Permit older strings | ||
|
|
Contributor
There was a problem hiding this comment.
NP: The remainder of this function does not have any test coverage.
Contributor
Author
There was a problem hiding this comment.
I'm not sure if the remainder are related to PEM functions we're implementing for this PR. This function is a generic function for parsing the first line of PEM files and the rest below apply to other supported formats.
| char *nm = NULL; | ||
| unsigned char *data = NULL; | ||
| long len; | ||
| if (!PEM_bytes_read_bio(&data, &len, &nm, PEM_STRING_PARAMETERS, bio, 0, |
Contributor
There was a problem hiding this comment.
NP: We have zero documentation for PEM_bytes_read_bio.
Contributor
Author
There was a problem hiding this comment.
Added documentation
include/openssl/pem.h
Outdated
Comment on lines
+479
to
+480
| // |EVP_PKEY|. If |*pkey| is non-null, the original |*pkey| is freed and the | ||
| // returned |EVP_PKEY| is also written to |*pkey|. This is only supported with |
Contributor
There was a problem hiding this comment.
I know it's implied from this statement, but it would be good to explicitly say that *pkey must be initialized (either to NULL or to an allocated value) prior to being passed in. (Passing in an uninitialized pointer would be UB.)
Contributor
Author
There was a problem hiding this comment.
Added clarification
crypto/pem/pem_pkey.c
Outdated
Comment on lines
+215
to
+216
| int PEM_write_bio_Parameters(BIO *bio, EVP_PKEY *pkey) { | ||
| if (bio == NULL || pkey == NULL || pkey->ameth == NULL) { |
Contributor
There was a problem hiding this comment.
Why the check for pkey->ameth? Should this be a check for pkey->type?
Contributor
Author
There was a problem hiding this comment.
Good point, this is a remnant of the original way OpenSSL had implemented these. I tried checking for pkey->type, but it's an int and not a pointer.
The switch statement below should help take care of that.
skmcgrail
approved these changes
Sep 12, 2024
justsmth
approved these changes
Sep 12, 2024
smittals2
added a commit
that referenced
this pull request
Sep 17, 2024
## What's Changed * Use OPENSSL_STATIC_ASSERT which handles all the platform/compiler/C s… by @andrewhop in #1791 * ML-KEM refactor by @dkostic in #1763 * ML-KEM-IPD to ML-KEM as defined in FIPS 203 by @dkostic in #1796 * Add KDA OneStep testing to ACVP by @skmcgrail in #1792 * Updating erroneous documentation for BIO_get_mem_data and subsequent usage by @smittals2 in #1752 * No-op impls for several EVP_PKEY_CTX functions by @justsmth in #1759 * Drop "ipd" suffix from ML-KEM related code by @dkostic in #1797 * Upstream merge 2024 08 19 by @skmcgrail in #1781 * ML-KEM move to the FIPS module by @dkostic in #1802 * Reduce collision probability for variable names by @torben-hansen in #1804 * Refactor ENGINE API and memory around METHOD structs by @smittals2 in #1776 * bn: Move x86-64 argument-based dispatching of bn_mul_mont to C. by @justsmth in #1795 * Check at runtime that the tool is loading the same libcrypto it was built with by @andrewhop in #1716 * Avoid matching prefixes of a symbol as arm registers by @torben-hansen in #1807 * Add CI for FreeBSD by @justsmth in #1787 * Move curve25519 implementations to fips module except spake25519 by @torben-hansen in #1809 * Add CAST for SP 800-56Cr2 One-Step function by @skmcgrail in #1803 * Remove custom PKCS7 ASN1 functions, add new structs by @WillChilds-Klein in #1726 * NASM use default debug format by @justsmth in #1747 * Add KDF in counter mode ACVP Testing by @skmcgrail in #1810 * add support for OCSP_request_verify by @samuel40791765 in #1778 * Fix GitHub/CodeBuild Purge Lambda by @justsmth in #1808 * KBKDF_ctr_hmac FIPS Service Indicator by @skmcgrail in #1798 * Update x509 tool to write all output to common BIO which is a file or stdout by @andrewhop in #1800 * Add ML-KEM to speed.cc, bump AWSLC_API_VERSION to 30 by @andrewhop in #1817 * Add EVP_PKEY_asn1_* functions by @justsmth in #1751 * Improve portability of CI integration script by @torben-hansen in #1815 * Upstream merge 2024 08 23 by @justsmth in #1799 * Replace ECDSA_METHOD with EC_KEY_METHOD and add the associated API by @smittals2 in #1785 * Cherrypick "Add some barebones support for DH in EVP" by @samuel40791765 in #1813 * Add KDA OneStep (SSKDF_digest and SSKDF_hmac) to FIPS indicator by @skmcgrail in #1793 * Add EVP_Digest one-shot test XOFs by @WillChilds-Klein in #1820 * Wire-up ACVP Testing for SHA3 Signatures with RSA by @skmcgrail in #1805 * Make SHA3 (not SHAKE) Approved for EVP_DigestSign/Verify, RSA and ECDSA. by @nebeid in #1821 * Begin tracking RelWithDebInfo library statistics by @andrewhop in #1822 * Move EVP ed25519 function table under FIPS module by @torben-hansen in #1826 * Avoid C11 Atomics on Windows by @justsmth in #1824 * Improve pre-sandbox setup by @torben-hansen in #1825 * Add OCSP round trip integration test with minor fixes by @samuel40791765 in #1811 * Add various PKCS7 getters and setters by @WillChilds-Klein in #1780 * Run clang-format on pkcs7 code by @WillChilds-Klein in #1830 * Move KEM API and ML-KEM definitions to FIPS module by @torben-hansen in #1828 * fix socat integration CI by @samuel40791765 in #1833 * Retire out-of-module KEM folder by @torben-hansen in #1832 * Refactor RSA_METHOD and expand API by @smittals2 in #1790 * Update benchmark documentation in tool/readme.md by @andrewhop in #1812 * Pre jail unit test by @torben-hansen in #1835 * Move EVP KEM implementation to in-module and correct OID by @torben-hansen in #1838 * More minor symbols Ruby depends on by @samuel40791765 in #1837 * ED25519 Power-on Self Test / CAST / KAT by @skmcgrail in #1834 * ACVP ML-KEM testing by @skmcgrail in #1840 * ACVP ECDSA SHA3 Digest Testing by @skmcgrail in #1819 * ML-KEM Service Indicator for EVP_PKEY_keygen, EVP_PKEY_encapsulate, EVP_PKEY_decapsulate by @skmcgrail in #1844 * Add ML-KEM CAST for KeyGen, Encaps, and Decaps by @skmcgrail in #1846 * ED25519 Service Indicator by @skmcgrail in #1829 * Update Allowed RSA KeySize Generation to FIPS 186-5 specification by @skmcgrail in #1823 * Add ED25519 ACVP Testing by @skmcgrail in #1818 * Make EDDSA/Ed25519 POST lazy initalized by @skmcgrail in #1848 * add support for PEM Parameters without ASN1 hooks by @samuel40791765 in #1831 * Add OpenVPN tip of main to CI by @smittals2 in #1843 * Ensure SSE2 is enabled when using optimized assembly for 32-bit x86 by @graebm in #1841 * Add support for `EVP_PKEY_CTX_ctrl_str` - Step #1 by @justsmth in #1842 * Added SHA3/SHAKE XOF functionality by @jakemas in #1839 * Migrated ML-KEM SHA3/SHAKE usage to fipsmodule by @jakemas in #1851 * AVX-512 support for RSA Signing by @pittma in #1273
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
This reverts part of commit 32fdc51.
Issues:
Addresses
CryptoAlg-2546Description of changes:
commit 32fdc51 removed the function pointers for
param_decodeandparam_encodeand removedPEM_read_bio_ParametersandPEM_write_bio_Parametersalong with it (which was the only API consuming these hooks). This reverts part of the commit to add these back.Call-outs:
1. This is in draft for the time being until we have proper support forEVP_PKEY_DHASN1 serialization.2. Do we even need function pointers if only 3 types of
EVP_PKEYs consume these? Considering if we can just pull the logic into the API instead of adding a function pointer for eachEVP_PKEY.Ultimately decided to leave the ASN1 logic in
PEM_read/write_bio_Parameterswhich allows us to continue decoupling the pem logic from |EVP_PKEY|. These correspond to the historicalparam_decodeandparam_encodeEVP_PKEY_ASN1_METHODhooks in OpenSSL.Testing:
EVP_PKEYtypeBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.