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.

Sign up for GitHub

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

Jump to bottom

Aes openssl #18010

Closed
wants to merge 5 commits into from
Closed

Aes openssl #18010

wants to merge 5 commits into from

Conversation

richardkchapman
Copy link
Member

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@richardkchapman
Refactor compressToBuffer to support different compression methods
797a119 
Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
@richardkchapman
Add AESLZ4 and AESLZ4HC modes
8f3e079 
Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
@richardkchapman
Added hc level options for AES front end
9bd7efd 
Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
@richardkchapman
WIP
53e916e 
Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
@richardkchapman
WIP
d557560 
Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
ghalliday
ghalliday reviewed Nov 9, 2023
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

Looks promising. Please split the 1st commit out as a separate PR - I would like something like that merged into 8.12.x.
The other commits looks promising, but need some cleaning up, and should probably target 9.4.x - provided we are happy they are safe.

system/jlib/jlzw.cpp
// Alternative would be a separate enum for compressToBuffer formats, but that seems more likely to cause confusion
out.append((byte) (method == COMPRESS_METHOD_LZW ? COMPRESS_METHOD_LZWLEGACY : method));
out.append((size32_t)0);
if (len >= 32)
Copy link
Member

Choose a reason for hiding this comment

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

minor: Could be moved to the outer if ()

system/jlib/jlzw.cpp
{
compressor->close();
size32_t compressedLen = compressor->buflen();
out.setWritePos(originalLength + sizeof(bool));
Copy link
Member

Choose a reason for hiding this comment

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

picky: Should now be sizeof(byte)(!) and line 784

Copy link
Member

Choose a reason for hiding this comment

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

could be sizeof(CompressMethod), if the enum was defined with type:

enum CompressionMethod : byte

.. would also remove need for some typecasts elsewhere.

system/jlib/jencrypt.cpp
{
case 32:
if(1 != EVP_EncryptInit_ex(ctx, EVP_aes_256_cbc(), NULL, (const unsigned char *) key, iv))
throw makeStringException(0, "Crap");
Copy link
Member

Choose a reason for hiding this comment

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

Not the most informative error message....

@ghalliday
Copy link
Member

Running your branch in release and comparing open ssl v preexisting it seems to be about 3-4x faster.
Strangely aes decrypt seems to be twice as fast as aes encrypt. I suspect that may be a data caching issue.

P.S. The efficiency of the CAESCompressor could be improved - it clones the data once more than is necessary.

@ghalliday ghalliday requested a review from jakesmith November 9, 2023 10:47
@ghalliday
Copy link
Member

@jakesmith please can you review the 1st commit (you're welcome to review the others).
@richardkchapman HPCC-30214 is for SSL aes change HPCC-29917 is related to compressToBuffer change.

jakesmith
jakesmith reviewed Nov 15, 2023
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@richardkchapman - added some trivial comments.

system/jlib/jlzw.cpp
size32_t compressedLen = compressor->buflen();
out.setWritePos(originalLength + sizeof(bool));
out.append(compressedLen);
out.setWritePos(originalLength + sizeof(bool) + sizeof(size32_t) + compressedLen);
Copy link
Member

Choose a reason for hiding this comment

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

not new, but would be more readable, if these were in order they were appended to buffer.

system/jlib/jlzw.cpp
{
compressor->close();
size32_t compressedLen = compressor->buflen();
out.setWritePos(originalLength + sizeof(bool));
Copy link
Member

Choose a reason for hiding this comment

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

could be sizeof(CompressMethod), if the enum was defined with type:

enum CompressionMethod : byte

.. would also remove need for some typecasts elsewhere.

system/jlib/jlzw.cpp
if (compressed)
decompressToBuffer(out, in.readDirect(srcLen));
else
unsigned char _method;
Copy link
Member

Choose a reason for hiding this comment

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

byte method (or byte ComressMethod _method if enum is : byte) ?

testing/unittests/unittests.cpp
void testRun()
{
MemoryBuffer x;
compressToBuffer(x, 251,
Copy link
Member

Choose a reason for hiding this comment

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

So it's clear length is correct (if ever changed etc), would be clearer if string was declared separately, and strlen instead of constant 251 was used here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakesmith jakesmith jakesmith left review comments

@ghalliday ghalliday ghalliday left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@richardkchapman @ghalliday @jakesmith