sweisdb commented on code in PR #46515: URL: https://github.com/apache/spark/pull/46515#discussion_r1617904905
########## common/network-common/src/main/java/org/apache/spark/network/crypto/GcmTransportCipher.java: ########## @@ -0,0 +1,356 @@ +/* + * 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.spark.network.crypto; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import com.google.crypto.tink.subtle.AesGcmHkdfStreaming; +import com.google.crypto.tink.subtle.StreamSegmentDecrypter; +import com.google.crypto.tink.subtle.StreamSegmentEncrypter; +import io.netty.buffer.Unpooled; +import io.netty.channel.*; +import io.netty.util.ReferenceCounted; +import org.apache.spark.network.util.AbstractFileRegion; +import io.netty.buffer.ByteBuf; + +import javax.crypto.spec.SecretKeySpec; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.channels.ClosedChannelException; +import java.nio.channels.WritableByteChannel; +import java.security.GeneralSecurityException; + +public class GcmTransportCipher implements TransportCipher { + private static final byte[] DEFAULT_AAD = new byte[0]; + private static final int LENGTH_HEADER_BYTES = 8; + @VisibleForTesting + static final int CIPHERTEXT_BUFFER_SIZE = 1024; + private final SecretKeySpec aesKey; + + public GcmTransportCipher(SecretKeySpec aesKey) { + this.aesKey = aesKey; + } + + @VisibleForTesting + EncryptionHandler getEncryptionHandler() throws GeneralSecurityException { + return new EncryptionHandler(); + } + + @VisibleForTesting + DecryptionHandler getDecryptionHandler() throws GeneralSecurityException { + return new DecryptionHandler(); + } + + public void addToChannel(Channel ch) throws GeneralSecurityException { + ch.pipeline() + .addFirst("GcmTransportEncryption", getEncryptionHandler()) + .addFirst("GcmTransportDecryption", getDecryptionHandler()); + } + + @VisibleForTesting + class EncryptionHandler extends ChannelOutboundHandlerAdapter { + private final ByteBuffer plaintextBuffer; + private final ByteBuffer ciphertextBuffer; + private final AesGcmHkdfStreaming aesGcmHkdfStreaming; + + EncryptionHandler() throws GeneralSecurityException { + aesGcmHkdfStreaming = new AesGcmHkdfStreaming( + aesKey.getEncoded(), + "HmacSha256", + aesKey.getEncoded().length, + CIPHERTEXT_BUFFER_SIZE, + 0); + plaintextBuffer = ByteBuffer.allocate(aesGcmHkdfStreaming.getPlaintextSegmentSize()); + ciphertextBuffer = ByteBuffer.allocate(aesGcmHkdfStreaming.getCiphertextSegmentSize()); + } + + @Override + public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) + throws Exception { + GcmEncryptedMessage encryptedMessage = new GcmEncryptedMessage( + aesGcmHkdfStreaming, + msg, + plaintextBuffer, + ciphertextBuffer); + ctx.write(encryptedMessage, promise); + } + } + + static class GcmEncryptedMessage extends AbstractFileRegion { + private final Object plaintextMessage; + private final ByteBuffer plaintextBuffer; + private final ByteBuffer ciphertextBuffer; + private final long bytesToRead; + private long bytesRead = 0; + private final StreamSegmentEncrypter encrypter; + private boolean headerWritten = false; + private long transferred = 0; + private final long encryptedCount; + + GcmEncryptedMessage(AesGcmHkdfStreaming aesGcmHkdfStreaming, + Object plaintextMessage, + ByteBuffer plaintextBuffer, + ByteBuffer ciphertextBuffer) throws GeneralSecurityException { + Preconditions.checkArgument( + plaintextMessage instanceof ByteBuf || plaintextMessage instanceof FileRegion, + "Unrecognized message type: %s", plaintextMessage.getClass().getName()); + this.plaintextMessage = plaintextMessage; + this.bytesToRead = getReadableBytes(); + this.plaintextBuffer = plaintextBuffer; + this.plaintextBuffer.clear(); + this.ciphertextBuffer = ciphertextBuffer; + this.ciphertextBuffer.clear(); + this.encrypter = aesGcmHkdfStreaming.newStreamSegmentEncrypter(DEFAULT_AAD); + this.encryptedCount = + LENGTH_HEADER_BYTES + aesGcmHkdfStreaming.expectedCiphertextSize(bytesToRead); + } + + @Override + public long position() { + return 0; + } + + @Override + public long transferred() { + return transferred; + } + + @Override + public long count() { + return encryptedCount; + } + + @Override + public long transferTo(WritableByteChannel target, long position) throws IOException { + Preconditions.checkArgument(position == transferred(), + "Invalid position."); + int transferredThisCall = 0; + // The format of the output is: + // [8 byte length][Internal IV and header][Ciphertext][Auth Tag] + if (!headerWritten) { + ByteBuffer expectedLength = ByteBuffer + .allocate(LENGTH_HEADER_BYTES) + .putLong(encryptedCount) + .flip(); + target.write(expectedLength); + int headerWritten = LENGTH_HEADER_BYTES + target.write(encrypter.getHeader()); + transferredThisCall += headerWritten; + this.transferred += headerWritten; + this.headerWritten = true; + } + + while (bytesRead < bytesToRead) { + long readableBytes = getReadableBytes(); + boolean lastSegment = readableBytes <= plaintextBuffer.capacity(); + plaintextBuffer.clear(); + int readLimit = + (int) Math.min(readableBytes, plaintextBuffer.capacity()); + plaintextBuffer.limit(readLimit); + if (plaintextMessage instanceof ByteBuf byteBuf) { + byteBuf.readBytes(plaintextBuffer); + long inputBytesRead = readableBytes - byteBuf.readableBytes(); + bytesRead += inputBytesRead; + } else if (plaintextMessage instanceof AbstractFileRegion fileRegion) { + ByteBufferWriteableChannel plaintextChannel = + new ByteBufferWriteableChannel(plaintextBuffer); + long transferred = + fileRegion.transferTo(plaintextChannel, fileRegion.transferred()); + bytesRead += transferred; + if (transferred == 0) { + // File regions may return 0 if they are not ready to transfer + // more data. In that case, we'll return with the expectation + // that this transferTo() is called again. + return transferredThisCall; + } + } + plaintextBuffer.flip(); + ciphertextBuffer.clear(); + try { + encrypter.encryptSegment(plaintextBuffer, lastSegment, ciphertextBuffer); + } catch (GeneralSecurityException e) { + throw new RuntimeException(e); + } + ciphertextBuffer.flip(); + int outputRemaining = ciphertextBuffer.remaining(); + while (ciphertextBuffer.hasRemaining()) { + target.write(ciphertextBuffer); + } + transferredThisCall += outputRemaining; + transferred += outputRemaining; + } + return transferredThisCall; + } + + private long getReadableBytes() { + if (plaintextMessage instanceof ByteBuf byteBuf) { + return byteBuf.readableBytes(); + } else if (plaintextMessage instanceof AbstractFileRegion fileRegion) { + return fileRegion.count() - fileRegion.transferred(); + } else { + throw new IllegalArgumentException("Unsupported message type: " + + plaintextMessage.getClass().getName()); + } + } + + @Override + protected void deallocate() { + if (plaintextMessage instanceof ReferenceCounted referenceCounted) { + referenceCounted.release(); + } + plaintextBuffer.clear(); + ciphertextBuffer.clear(); + } + } + + @VisibleForTesting + class DecryptionHandler extends ChannelInboundHandlerAdapter { + private final ByteBuffer ciphertextBuffer; + private final ByteBuffer plaintextBuffer; + private final AesGcmHkdfStreaming aesGcmHkdfStreaming; + private final StreamSegmentDecrypter decrypter; + private boolean decrypterInit = false; + private int segmentNumber = 0; + private long expectedLength = -1; + private long ciphertextRead = 0; + + DecryptionHandler() throws GeneralSecurityException { + aesGcmHkdfStreaming = new AesGcmHkdfStreaming( + aesKey.getEncoded(), + "HmacSha256", + aesKey.getEncoded().length, + CIPHERTEXT_BUFFER_SIZE, + 0); + plaintextBuffer = + ByteBuffer.allocate(aesGcmHkdfStreaming.getPlaintextSegmentSize()); + ciphertextBuffer = + ByteBuffer.allocate(aesGcmHkdfStreaming.getCiphertextSegmentSize()); + decrypter = aesGcmHkdfStreaming.newStreamSegmentDecrypter(); + } + + @Override + public void channelRead(ChannelHandlerContext ctx, Object ciphertextMessage) + throws GeneralSecurityException { + Preconditions.checkArgument(ciphertextMessage instanceof ByteBuf, + "Unrecognized message type: %s", + ciphertextMessage.getClass().getName()); + ByteBuf ciphertextNettyBuf = (ByteBuf) ciphertextMessage; + // The format of the output is: + // [8 byte length][Internal IV and header][Ciphertext][Auth Tag] + try { Review Comment: The `CtrTransportCipher` implementation also relies on the input buffer's `readableBytes` being accurate: ``` byte[] decryptedData = new byte[buffer.readableBytes()]; byteChannel.feedData(buffer); ``` -- 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: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
