1 /* 2 * Copyright (C) 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.adservices.ohttp; 18 19 import android.annotation.Nullable; 20 21 import com.google.auto.value.AutoValue; 22 23 /** 24 * Class to hold the responses returned by {@link 25 * IOhttpJniWrapper#hpkeCtxSetupSenderWithSeed(HpkeContextNativeRef, KemNativeRef, KdfNativeRef, 26 * AeadNativeRef, byte[], byte[], byte[])} and the HPKE seal operation 27 */ 28 @AutoValue 29 abstract class HpkeEncryptResponse { create( EncapsulatedSharedSecret encapsulatedSharedSecret, @Nullable byte[] cipherText)30 static HpkeEncryptResponse create( 31 EncapsulatedSharedSecret encapsulatedSharedSecret, @Nullable byte[] cipherText) { 32 return new AutoValue_HpkeEncryptResponse(encapsulatedSharedSecret, cipherText); 33 } 34 35 /** 36 * The encapsulated shared secret generated using the server's public key by the {@link 37 * OhttpJniWrapper#hpkeCtxSetupSenderWithSeed(HpkeContextNativeRef, KemNativeRef, KdfNativeRef, 38 * AeadNativeRef, byte[], byte[], byte[])} operation. This shared secret will be required for 39 * decrypting Server's response. 40 * 41 * <p>See https://www.rfc-editor.org/rfc/rfc9180#name-encryption-to-a-public-key 42 * https://www.ietf.org/archive/id/draft-ietf-ohai-ohttp-03.html#name-encapsulation-of-requests 43 */ encapsulatedSharedSecret()44 abstract EncapsulatedSharedSecret encapsulatedSharedSecret(); 45 46 /** The encrypted data generated by the HPKE seal method. */ 47 @SuppressWarnings("mutable") 48 @Nullable cipherText()49 abstract byte[] cipherText(); 50 } 51