ARROW-11188: [Rust] Support crypto functions from PostgreSQL dialect #9139
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
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
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
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
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,106 @@ | ||
| // 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. | ||
|
|
||
| //! Crypto expressions | ||
|
|
||
| use md5::Md5; | ||
| use sha2::{ | ||
| digest::Output as SHA2DigestOutput, Digest as SHA2Digest, Sha224, Sha256, Sha384, | ||
| Sha512, | ||
| }; | ||
|
|
||
| use crate::error::{DataFusionError, Result}; | ||
| use arrow::array::{ | ||
| ArrayRef, GenericBinaryArray, GenericStringArray, StringOffsetSizeTrait, | ||
| }; | ||
|
|
||
| fn md5_process(input: &str) -> String { | ||
| let mut digest = Md5::default(); | ||
| digest.update(&input); | ||
|
|
||
| let mut result = String::new(); | ||
|
|
||
| for byte in &digest.finalize() { | ||
| result.push_str(&format!("{:02x}", byte)); | ||
| } | ||
|
|
||
| result | ||
| } | ||
|
|
||
| // It's not possible to return &[u8], because trait in trait without short lifetime | ||
| fn sha_process<D: SHA2Digest + Default>(input: &str) -> SHA2DigestOutput<D> { | ||
| let mut digest = D::default(); | ||
| digest.update(&input); | ||
|
|
||
| digest.finalize() | ||
| } | ||
|
|
||
| macro_rules! crypto_unary_string_function { | ||
| ($NAME:ident, $FUNC:expr) => { | ||
| /// crypto function that accepts Utf8 or LargeUtf8 and returns Utf8 string | ||
| pub fn $NAME<T: StringOffsetSizeTrait>( | ||
| args: &[ArrayRef], | ||
| ) -> Result<GenericStringArray<i32>> { | ||
| if args.len() != 1 { | ||
| return Err(DataFusionError::Internal(format!( | ||
| "{:?} args were supplied but {} takes exactly one argument", | ||
| args.len(), | ||
| String::from(stringify!($NAME)), | ||
| ))); | ||
| } | ||
|
|
||
| let array = args[0] | ||
| .as_any() | ||
| .downcast_ref::<GenericStringArray<T>>() | ||
| .unwrap(); | ||
|
|
||
| // first map is the iterator, second is for the `Option<_>` | ||
| Ok(array.iter().map(|x| x.map(|x| $FUNC(x))).collect()) | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| macro_rules! crypto_unary_binary_function { | ||
| ($NAME:ident, $FUNC:expr) => { | ||
| /// crypto function that accepts Utf8 or LargeUtf8 and returns Binary | ||
| pub fn $NAME<T: StringOffsetSizeTrait>( | ||
| args: &[ArrayRef], | ||
| ) -> Result<GenericBinaryArray<i32>> { | ||
| if args.len() != 1 { | ||
| return Err(DataFusionError::Internal(format!( | ||
| "{:?} args were supplied but {} takes exactly one argument", | ||
| args.len(), | ||
| String::from(stringify!($NAME)), | ||
| ))); | ||
| } | ||
|
|
||
| let array = args[0] | ||
| .as_any() | ||
| .downcast_ref::<GenericStringArray<T>>() | ||
| .unwrap(); | ||
|
|
||
| // first map is the iterator, second is for the `Option<_>` | ||
| Ok(array.iter().map(|x| x.map(|x| $FUNC(x))).collect()) | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| crypto_unary_string_function!(md5, md5_process); | ||
| crypto_unary_binary_function!(sha224, sha_process::<Sha224>); | ||
| crypto_unary_binary_function!(sha256, sha_process::<Sha256>); | ||
| crypto_unary_binary_function!(sha384, sha_process::<Sha384>); | ||
| crypto_unary_binary_function!(sha512, sha_process::<Sha512>); | ||
|
||
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
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
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
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.
It seems to me like we might want to start offering a way to keep the number of required dependencies of DataFusion down. For example, in this case we could potentially put the use of crypto functions behind a feature flag.
I am not proposing to add the feature flag as part of this PR, but more like trying to set the general direction of allowing users to pick features that they need and not have to pay compilation time (or binary size) cost for those they don't
What do you think @jorgecarleitao and @andygrove
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 generally agree with you, @alamb. In this case, we want to support posgres dialect, so it makes sense to support these functions (and not implement these ourselves, as they are even security related).
In general, as long as the crates are small, I do not see a major issue. Our expensive dependencies are Tokio, crossbeam, etc, specially because they really increase the compile time (e.g. compared to the arrow crate).
We already offer a scalar UDF that has the same performance as our own expressions. So, I think that this is the most we can do here.