forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Adding the new encryptor and decryptor interfaces #59
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "parquet/platform.h" | ||
|
|
||
| namespace parquet::encryption { | ||
|
|
||
| class PARQUET_EXPORT DecryptorInterface { | ||
| public: | ||
| virtual ~DecryptorInterface() = default; | ||
|
|
||
| /// Calculate the size of the plaintext for a given ciphertext length. | ||
| [[nodiscard]] virtual int32_t PlaintextLength(int32_t ciphertext_len) const = 0; | ||
|
|
||
| /// Calculate the size of the ciphertext for a given plaintext length. | ||
| [[nodiscard]] virtual int32_t CiphertextLength(int32_t plaintext_len) const = 0; | ||
|
|
||
| /// Decrypt the ciphertext and leave the results in the plaintext buffer. | ||
| virtual int32_t Decrypt(::arrow::util::span<const uint8_t> ciphertext, | ||
| ::arrow::util::span<uint8_t> plaintext) = 0; | ||
| }; | ||
|
|
||
| } // namespace parquet::encryption | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "parquet/platform.h" | ||
|
|
||
| namespace parquet::encryption { | ||
|
|
||
| class PARQUET_EXPORT EncryptorInterface { | ||
| public: | ||
| virtual ~EncryptorInterface() = default; | ||
|
|
||
| /// Calculate the size of the ciphertext for a given plaintext length. | ||
| [[nodiscard]]virtual int32_t CiphertextLength(int64_t plaintext_len) const = 0; | ||
|
|
||
| /// Encrypt the plaintext and leave the results in the ciphertext buffer. | ||
| virtual int32_t Encrypt(::arrow::util::span<const uint8_t> plaintext, | ||
| ::arrow::util::span<uint8_t> ciphertext) = 0; | ||
|
|
||
| /// Encrypt footer metadata for signature verification purposes only. | ||
| /// This method is used specifically for footer signature verification in encrypted | ||
| /// Parquet files with plaintext footers. It encrypts the footer metadata using | ||
| /// the provided key, AAD, and nonce to generate an authentication tag that can | ||
| /// be compared against a stored signature. | ||
| virtual int32_t SignedFooterEncrypt(::arrow::util::span<const uint8_t> footer, | ||
| ::arrow::util::span<const uint8_t> key, | ||
| ::arrow::util::span<const uint8_t> aad, | ||
| ::arrow::util::span<const uint8_t> nonce, | ||
| ::arrow::util::span<uint8_t> encrypted_footer) = 0; | ||
|
Comment on lines
+35
to
+44
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we removed some of these (i.e. |
||
| }; | ||
|
|
||
| } // namespace parquet::encryption | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd be careful with the licensing header. I guess this is not Protegrity specific, but only add it if others at the same level of detail include them already
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, these are the licensing details for header files in this directory. Also, this is the Arrow encryption interface, so it must share the licensing.