You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@orc.apache.org by GitBox <gi...@apache.org> on 2021/09/11 03:41:44 UTC

[GitHub] [orc] guiyanakuang opened a new pull request #905: ORC-991: Fix the bug of encrypted column read crash

guiyanakuang opened a new pull request #905:
URL: https://github.com/apache/orc/pull/905


   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. File a JIRA issue first and use it as a prefix of your PR title, e.g., `ORC-001: Fix ABC`.
     2. Use your PR title to summarize what this PR proposes instead of describing the problem.
     3. Make PR title and description complete because these will be the permanent commit log.
     4. If possible, provide a concise and reproducible example to reproduce the issue for a faster review.
     5. If the PR is unfinished, use GitHub PR Draft feature.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If there is a discussion in the mailing list, please add the link.
   -->
   1. RowIndex is never marked as encrypted.  The StreamName constructor adds encryption to make rowIndex encrypted when needed.
   
   TreeWriterBase.java
   ```java
     public void writeStripe(int requiredIndexEntries) throws IOException {
         .....
   -    context.writeIndex(new StreamName(id, OrcProto.Stream.Kind.ROW_INDEX), rowIndex);
   +    context.writeIndex(new StreamName(id, OrcProto.Stream.Kind.ROW_INDEX, encryption), rowIndex);
         .....
     }
   ```
   
   2.  findStreams in StripePlanner.java total offset order and write inconsistency.
   finalizeStripe In PhysicalFsWriter.java
   > 1. write the unencrypted index streams 
   > 2. write the encrypted index streams 
   > 3. write the unencrypted data streams
   > 4. write the unencrypted data streams
   ```java
     @Override
     public void finalizeStripe(OrcProto.StripeFooter.Builder footerBuilder,
                                OrcProto.StripeInformation.Builder dirEntry
                                ) throws IOException {
       .....
       // write the unencrypted index streams
       unencrypted.writeStreams(StreamName.Area.INDEX, rawWriter);
       // write the encrypted index streams
       for (VariantTracker variant: variants.values()) {
         variant.writeStreams(StreamName.Area.INDEX, rawWriter);
       }
   
       // write the unencrypted data streams
       unencrypted.writeStreams(StreamName.Area.DATA, rawWriter);
       // write out the unencrypted data streams
       for (VariantTracker variant: variants.values()) {
         variant.writeStreams(StreamName.Area.DATA, rawWriter);
       }
       .....
     }
   ```
   
   findStreams in StripePlanner.java  
   > 1. total offset the unencrypted index/data streams 
   > 2. total offset encrypted index/data streams 
   Causes misalignment of data reading.
   
   This pr ensures that the read offset is consistent with the write.
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   Fix the bug of encrypted column read crash.
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   -->
   Added unit test for reading encrypted columns.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] dongjoon-hyun commented on a change in pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
dongjoon-hyun commented on a change in pull request #905:
URL: https://github.com/apache/orc/pull/905#discussion_r706709957



##########
File path: java/core/src/java/org/apache/orc/impl/reader/StripePlanner.java
##########
@@ -279,12 +280,13 @@ private void buildEncodings(OrcProto.StripeFooter footer,
   private long handleStream(long offset,
                             boolean[] columnInclude,
                             OrcProto.Stream stream,
+                            StreamName.Area area,

Review comment:
       Could you add `area` into the function description, too?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] dongjoon-hyun merged pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
dongjoon-hyun merged pull request #905:
URL: https://github.com/apache/orc/pull/905


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] dongjoon-hyun commented on a change in pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
dongjoon-hyun commented on a change in pull request #905:
URL: https://github.com/apache/orc/pull/905#discussion_r706710071



##########
File path: java/core/src/test/org/apache/orc/impl/TestEncryption.java
##########
@@ -0,0 +1,143 @@
+/*
+ * 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.orc.impl;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.hive.ql.exec.vector.BytesColumnVector;
+import org.apache.hadoop.hive.ql.exec.vector.LongColumnVector;
+import org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch;
+import org.apache.hadoop.hive.ql.io.sarg.PredicateLeaf;
+import org.apache.hadoop.hive.ql.io.sarg.SearchArgument;
+import org.apache.hadoop.hive.ql.io.sarg.SearchArgumentFactory;
+import org.apache.orc.EncryptionAlgorithm;
+import org.apache.orc.InMemoryKeystore;
+import org.apache.orc.OrcConf;
+import org.apache.orc.OrcFile;
+import org.apache.orc.Reader;
+import org.apache.orc.RecordReader;
+import org.apache.orc.TypeDescription;
+import org.apache.orc.Writer;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class TestEncryption {

Review comment:
       Thank you for adding this.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] guiyanakuang commented on pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
guiyanakuang commented on pull request #905:
URL: https://github.com/apache/orc/pull/905#issuecomment-917517312


   @dongjoon-hyun Thanks for the review.
   
   I added an additional fix: Decimal64TreeWriter data stream are not bound to encryption


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] dongjoon-hyun commented on pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
dongjoon-hyun commented on pull request #905:
URL: https://github.com/apache/orc/pull/905#issuecomment-917687218


   For branch-1.6, I changed the test suite into old JUnit style during backporting.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [orc] guiyanakuang commented on a change in pull request #905: ORC-991: Fix the bug of encrypted column read crash

Posted by GitBox <gi...@apache.org>.
guiyanakuang commented on a change in pull request #905:
URL: https://github.com/apache/orc/pull/905#discussion_r706713015



##########
File path: java/core/src/java/org/apache/orc/impl/reader/StripePlanner.java
##########
@@ -279,12 +280,13 @@ private void buildEncodings(OrcProto.StripeFooter footer,
   private long handleStream(long offset,
                             boolean[] columnInclude,
                             OrcProto.Stream stream,
+                            StreamName.Area area,

Review comment:
       Added in cb829a1.  But the javadoc generation failed. It seems to be caused by network instability.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@orc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org