-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Hive: Metadata integrity check for encrypted tables #14685
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
+287
−14
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
78 changes: 78 additions & 0 deletions
78
core/src/main/java/org/apache/iceberg/util/HashWriter.java
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,78 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.iceberg.util; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.Writer; | ||
| import java.nio.ByteBuffer; | ||
| import java.nio.CharBuffer; | ||
| import java.nio.charset.Charset; | ||
| import java.nio.charset.CharsetEncoder; | ||
| import java.security.MessageDigest; | ||
| import java.security.NoSuchAlgorithmException; | ||
|
|
||
| /** | ||
| * {@link java.io.Writer} implementation that uses a hashing function to produce a hash value based | ||
| * on the streamed bytes. The output of the writer is not preserved. | ||
| */ | ||
| public class HashWriter extends Writer { | ||
|
|
||
| private final MessageDigest digest; | ||
| private final CharsetEncoder encoder; | ||
| private boolean isClosed = false; | ||
|
|
||
| public HashWriter(String hashAlgorithm, Charset charset) throws NoSuchAlgorithmException { | ||
| this.digest = MessageDigest.getInstance(hashAlgorithm); | ||
| this.encoder = charset.newEncoder(); | ||
| } | ||
|
|
||
| @Override | ||
| public void write(char[] cbuf, int off, int len) throws IOException { | ||
| ensureNotClosed(); | ||
| CharBuffer chars = CharBuffer.wrap(cbuf, off, len); | ||
| ByteBuffer byteBuffer = encoder.encode(chars); | ||
| digest.update(byteBuffer); | ||
| } | ||
|
|
||
| @Override | ||
| public void flush() throws IOException {} | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
| isClosed = true; | ||
| } | ||
|
|
||
| /** | ||
| * Calculates the final hash value. The underlying digest will be reset thus subsequent getHash() | ||
| * calls are not permitted. | ||
| * | ||
| * @return bytes of final hash value | ||
| */ | ||
| public byte[] getHash() { | ||
| ensureNotClosed(); | ||
| isClosed = true; | ||
| return digest.digest(); | ||
| } | ||
|
|
||
| private void ensureNotClosed() { | ||
| if (isClosed) { | ||
| throw new IllegalStateException("HashWriter is closed."); | ||
| } | ||
| } | ||
| } | ||
75 changes: 75 additions & 0 deletions
75
core/src/test/java/org/apache/iceberg/util/TestHashWriter.java
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,75 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.iceberg.util; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.ArgumentMatchers.anyInt; | ||
| import static org.mockito.Mockito.spy; | ||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.Mockito.verify; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonGenerator; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.security.MessageDigest; | ||
| import java.util.Map; | ||
| import org.apache.iceberg.PartitionSpec; | ||
| import org.apache.iceberg.Schema; | ||
| import org.apache.iceberg.TableMetadata; | ||
| import org.apache.iceberg.TableMetadataParser; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Maps; | ||
| import org.apache.iceberg.types.Types; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class TestHashWriter { | ||
|
|
||
| @Test | ||
| public void testIncrementalHashCalculation() throws Exception { | ||
| HashWriter hashWriter = spy(new HashWriter("SHA-256", StandardCharsets.UTF_8)); | ||
|
|
||
| // Create large enough TableMetadata which will be serialized into JSON in multiple chunks by | ||
| // the JSON generator | ||
| Map<String, String> icebergTblProperties = Maps.newHashMap(); | ||
| for (int i = 0; i < 300; ++i) { | ||
| icebergTblProperties.put("Property Key " + i, "Property Value " + i); | ||
| } | ||
| Schema schema = new Schema(Types.NestedField.required(1, "col1", Types.StringType.get())); | ||
| TableMetadata tableMetadata = | ||
| TableMetadata.newTableMetadata( | ||
| schema, PartitionSpec.unpartitioned(), null, icebergTblProperties); | ||
|
|
||
| JsonGenerator generator = JsonUtil.factory().createGenerator(hashWriter); | ||
| TableMetadataParser.toJson(tableMetadata, generator); | ||
|
|
||
| // Expecting to see 3 write() invocations (and therefore incremental hash calculations) | ||
| verify(hashWriter, times(3)).write(any(char[].class), anyInt(), anyInt()); | ||
|
|
||
| // +1 after flushing | ||
| generator.flush(); | ||
| verify(hashWriter, times(4)).write(any(char[].class), anyInt(), anyInt()); | ||
|
|
||
| // Expected hash is calculated on the whole object i.e. without streaming | ||
| byte[] expectedHash = | ||
| MessageDigest.getInstance("SHA-256") | ||
| .digest(TableMetadataParser.toJson(tableMetadata).getBytes(StandardCharsets.UTF_8)); | ||
| assertThat(hashWriter.getHash()).isEqualTo(expectedHash); | ||
| assertThatThrownBy(() -> hashWriter.getHash()).hasMessageContaining("HashWriter is closed."); | ||
| } | ||
| } |
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.
nit: an exception if not closed?
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.
You're right, it's needed as calling
digest()will cause a reset inMessageDigestinternal state and further calls will produce a wrong value. I've added a closing logic now.