xref: /aosp_15_r20/external/tink/cc/hybrid/internal/hpke_util.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang // Copyright 2022 Google LLC
2*e7b1675dSTing-Kang Chang //
3*e7b1675dSTing-Kang Chang // Licensed under the Apache License, Version 2.0 (the "License");
4*e7b1675dSTing-Kang Chang // you may not use this file except in compliance with the License.
5*e7b1675dSTing-Kang Chang // You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang //
7*e7b1675dSTing-Kang Chang //     http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang //
9*e7b1675dSTing-Kang Chang // Unless required by applicable law or agreed to in writing, software
10*e7b1675dSTing-Kang Chang // distributed under the License is distributed on an "AS IS" BASIS,
11*e7b1675dSTing-Kang Chang // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*e7b1675dSTing-Kang Chang // See the License for the specific language governing permissions and
13*e7b1675dSTing-Kang Chang // limitations under the License.
14*e7b1675dSTing-Kang Chang //
15*e7b1675dSTing-Kang Chang ///////////////////////////////////////////////////////////////////////////////
16*e7b1675dSTing-Kang Chang 
17*e7b1675dSTing-Kang Chang #ifndef TINK_HYBRID_INTERNAL_HPKE_UTIL_H_
18*e7b1675dSTing-Kang Chang #define TINK_HYBRID_INTERNAL_HPKE_UTIL_H_
19*e7b1675dSTing-Kang Chang 
20*e7b1675dSTing-Kang Chang #include "tink/util/statusor.h"
21*e7b1675dSTing-Kang Chang #include "proto/hpke.pb.h"
22*e7b1675dSTing-Kang Chang 
23*e7b1675dSTing-Kang Chang namespace crypto {
24*e7b1675dSTing-Kang Chang namespace tink {
25*e7b1675dSTing-Kang Chang namespace internal {
26*e7b1675dSTing-Kang Chang 
27*e7b1675dSTing-Kang Chang // Values from https://www.rfc-editor.org/rfc/rfc9180.html#section-7.1.
28*e7b1675dSTing-Kang Chang enum class HpkeKem {
29*e7b1675dSTing-Kang Chang   kUnknownKem = 0x0,
30*e7b1675dSTing-Kang Chang   kX25519HkdfSha256 = 0x20,
31*e7b1675dSTing-Kang Chang };
32*e7b1675dSTing-Kang Chang 
33*e7b1675dSTing-Kang Chang // Values from https://www.rfc-editor.org/rfc/rfc9180.html#section-7.2.
34*e7b1675dSTing-Kang Chang enum class HpkeKdf {
35*e7b1675dSTing-Kang Chang   kUnknownKdf = 0x0,
36*e7b1675dSTing-Kang Chang   kHkdfSha256 = 0x1,
37*e7b1675dSTing-Kang Chang };
38*e7b1675dSTing-Kang Chang 
39*e7b1675dSTing-Kang Chang // Values from https://www.rfc-editor.org/rfc/rfc9180.html#section-7.3.
40*e7b1675dSTing-Kang Chang enum class HpkeAead {
41*e7b1675dSTing-Kang Chang   kUnknownAead = 0x0,
42*e7b1675dSTing-Kang Chang   kAes128Gcm = 0x1,
43*e7b1675dSTing-Kang Chang   kAes256Gcm = 0x2,
44*e7b1675dSTing-Kang Chang   kChaCha20Poly1305 = 0x3,
45*e7b1675dSTing-Kang Chang };
46*e7b1675dSTing-Kang Chang 
47*e7b1675dSTing-Kang Chang struct HpkeParams {
48*e7b1675dSTing-Kang Chang   HpkeKem kem;
49*e7b1675dSTing-Kang Chang   HpkeKdf kdf;
50*e7b1675dSTing-Kang Chang   HpkeAead aead;
51*e7b1675dSTing-Kang Chang };
52*e7b1675dSTing-Kang Chang 
53*e7b1675dSTing-Kang Chang // Converts a google::crypto::tink::HpkeParams proto to an HpkeParams struct.
54*e7b1675dSTing-Kang Chang util::StatusOr<HpkeParams> HpkeParamsProtoToStruct(
55*e7b1675dSTing-Kang Chang     google::crypto::tink::HpkeParams params);
56*e7b1675dSTing-Kang Chang 
57*e7b1675dSTing-Kang Chang // Returns the encapsulated key length (in bytes) for the specified `kem`.
58*e7b1675dSTing-Kang Chang util::StatusOr<int32_t> HpkeEncapsulatedKeyLength(
59*e7b1675dSTing-Kang Chang     google::crypto::tink::HpkeKem kem);
60*e7b1675dSTing-Kang Chang 
61*e7b1675dSTing-Kang Chang }  // namespace internal
62*e7b1675dSTing-Kang Chang }  // namespace tink
63*e7b1675dSTing-Kang Chang }  // namespace crypto
64*e7b1675dSTing-Kang Chang 
65*e7b1675dSTing-Kang Chang #endif  // TINK_HYBRID_INTERNAL_HPKE_UTIL_H_
66