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

Add PKCS7-internal BIO_f_cipher #1836

Merged
merged 22 commits into from
Oct 29, 2024

Conversation

WillChilds-Klein
Copy link
Contributor

@WillChilds-Klein WillChilds-Klein commented Sep 6, 2024

Issues:

Addresses CryptoAlg-2494

Description of changes:

This change introduces a new filter BIO, BIO_f_cipher for use in PR 1816.

The cipher BIO sits in front of a backing BIO, encrypting incoming writes before writing to the backing BIO and decrypting data read from the backing BIO. This implementation is almost an exact copy of OpenSSL's with some functionality removed. We try to change as little of the underlying logic as possible, but rename variables and add comments for clarity.

Call-outs:

  • n/a

Testing:

  • new unit tests. test considerations and flow are documented in-line.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.

@codecov-commenter
Copy link

codecov-commenter commented Sep 6, 2024

Codecov Report

Attention: Patch coverage is 94.26523% with 16 lines in your changes missing coverage. Please review.

Project coverage is 78.73%. Comparing base (8431e44) to head (b59448a).

Files with missing lines Patch % Lines
crypto/pkcs7/bio/cipher.c 92.22% 14 Missing ⚠️
crypto/pkcs7/bio/bio_cipher_test.cc 97.97% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1836      +/-   ##
==========================================
+ Coverage   78.67%   78.73%   +0.06%     
==========================================
  Files         585      587       +2     
  Lines      100854   101133     +279     
  Branches    14299    14339      +40     
==========================================
+ Hits        79342    79623     +281     
+ Misses      20877    20874       -3     
- Partials      635      636       +1     

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

@WillChilds-Klein WillChilds-Klein force-pushed the pkcs7-bio-cipher branch 6 times, most recently from f4627f0 to 4f69b78 Compare September 11, 2024 23:44
@WillChilds-Klein WillChilds-Klein changed the title Add PKCS7-internal cipher BIO Add cipher BIO Sep 13, 2024
@WillChilds-Klein WillChilds-Klein force-pushed the pkcs7-bio-cipher branch 3 times, most recently from 6e5c58d to 94c275e Compare September 13, 2024 15:11
@WillChilds-Klein WillChilds-Klein marked this pull request as ready for review September 13, 2024 15:32
@WillChilds-Klein WillChilds-Klein requested a review from a team as a code owner September 13, 2024 15:32
Copy link
Contributor

@samuel40791765 samuel40791765 left a comment

Choose a reason for hiding this comment

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

Just some preliminary comments, haven't gone through everything yet.

crypto/bio/bio_deprecated_test.cc Outdated Show resolved Hide resolved
include/openssl/bio.h Outdated Show resolved Hide resolved
@WillChilds-Klein WillChilds-Klein force-pushed the pkcs7-bio-cipher branch 2 times, most recently from 6fe97e9 to ea1f09d Compare September 14, 2024 23:49
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/bio/cipher.c Outdated Show resolved Hide resolved
crypto/pkcs7/bio/cipher.c Outdated Show resolved Hide resolved
crypto/pkcs7/bio/cipher.c Outdated Show resolved Hide resolved
crypto/pkcs7/bio/cipher.c Outdated Show resolved Hide resolved
@WillChilds-Klein WillChilds-Klein changed the title Add cipher BIO Add PKCS7-internal BIO_f_cipher Sep 29, 2024
crypto/pkcs7/bio/cipher.c Outdated Show resolved Hide resolved
@WillChilds-Klein WillChilds-Klein force-pushed the pkcs7-bio-cipher branch 2 times, most recently from 290631b to 4a55a5a Compare October 28, 2024 19:51
GUARD_PTR(b);
GUARD_PTR(next);
GUARD_PTR(ctx);
while (ctx->ok > 0 && (ctx->buf_len > 0 || !ctx->done)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Since we're using ctx->ok as a boolean, the logic may be clearer if we use it as one.

Suggested change
while (ctx->ok > 0 && (ctx->buf_len > 0 || !ctx->done)) {
while (ctx->ok && (ctx->buf_len > 0 || !ctx->done)) {


BIO_ENC_CTX *ctx = BIO_get_data(b);
BIO *next = BIO_next(b);
if (ctx == NULL) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit:

Suggested change
if (ctx == NULL) {
if (ctx == NULL || next == NULL) {

@WillChilds-Klein WillChilds-Klein merged commit 318c34c into aws:main Oct 29, 2024
115 of 116 checks passed
skmcgrail added a commit that referenced this pull request Nov 7, 2024
## What's Changed
* 800-131Ar1: length of the key-derivation key shall be at least 112
bits. by @skmcgrail in #1924
* Marshalling/Unmarshalling DH public keys by @justsmth in
#1916
* Also prune SSM documents from ec2-test-framework by @samuel40791765 in
#1925
* Use illegal_parameter instead of decode_error for invalid key shares
by @justsmth in #1923
* Add null check in dh testing by @torben-hansen in
#1937
* DH paramgen callback by @justsmth in
#1928
* Upstream merge 2024 10 17 by @torben-hansen in
#1934
* Remove old Intel CPU types by @justsmth in
#1942
* Remove retries on PCT failure in EC and RSA key generation. by @nebeid
in #1938
* Add p4p, bump up time by @justsmth in
#1943
* PQ README by @jakemas in #1932
* bump mysql CI to 9.1.0 by @justsmth in
#1939
* HKDF, HKDF_expand, and PBKDF Truncated SHA2-512 by @skmcgrail in
#1946
* Missing functionality + Adding Nmap to our CI by @smittals2 in
#1915
* Fix FIPS.md typo by @justsmth in
#1950
* Support encode or decode ∞ like OpenSSL by @samuel40791765 in
#1930
* Expand support for EVP_PKEY_HMAC by @justsmth in
#1933
* Add PKCS7-internal BIO_f_cipher by @WillChilds-Klein in
#1836
* Add PKCS7-internal BIO_f_md by @WillChilds-Klein in
#1886
* Ruby Support - DSA custom md by @justsmth in
#1953
* Add support for POINT_CONVERSION_HYBRID by @samuel40791765 in
#1936
* Fixes for Coverity Alerts by @smittals2 in
#1960
* Also test w/ gcc 4.8 by @justsmth in
#1962
* Actually add support for SSL_get_server/peer_tmp_key by
@samuel40791765 in #1945
* Coverity Fix Null Check by @smittals2 in
#1965
* ML-KEM keygen Pairwise Consistency Test by @dkostic in
#1964
* EDDSA PCT by @torben-hansen in #1968
* Expose AES_cfb1_encrypt and AES_cfb8_encrypt by @skmcgrail in
#1967

**Full Changelog**:
v1.37.0...v1.38.0

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license and the ISC license.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants