• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* Copyright (c) 2020, Google Inc.
2  *
3  * Permission to use, copy, modify, and/or distribute this software for any
4  * purpose with or without fee is hereby granted, provided that the above
5  * copyright notice and this permission notice appear in all copies.
6  *
7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14 
15 #include <openssl/hpke.h>
16 
17 #include <assert.h>
18 #include <string.h>
19 
20 #include <openssl/aead.h>
21 #include <openssl/bytestring.h>
22 #include <openssl/curve25519.h>
23 #include <openssl/digest.h>
24 #include <openssl/err.h>
25 #include <openssl/evp_errors.h>
26 #include <openssl/hkdf.h>
27 #include <openssl/rand.h>
28 #include <openssl/sha.h>
29 
30 #include "../internal.h"
31 
32 
33 // This file implements RFC 9180.
34 
35 #define MAX_SEED_LEN X25519_PRIVATE_KEY_LEN
36 #define MAX_SHARED_SECRET_LEN SHA256_DIGEST_LENGTH
37 
38 struct evp_hpke_kem_st {
39   uint16_t id;
40   size_t public_key_len;
41   size_t private_key_len;
42   size_t seed_len;
43   size_t enc_len;
44   int (*init_key)(EVP_HPKE_KEY *key, const uint8_t *priv_key,
45                   size_t priv_key_len);
46   int (*generate_key)(EVP_HPKE_KEY *key);
47   int (*encap_with_seed)(const EVP_HPKE_KEM *kem, uint8_t *out_shared_secret,
48                          size_t *out_shared_secret_len, uint8_t *out_enc,
49                          size_t *out_enc_len, size_t max_enc,
50                          const uint8_t *peer_public_key,
51                          size_t peer_public_key_len, const uint8_t *seed,
52                          size_t seed_len);
53   int (*decap)(const EVP_HPKE_KEY *key, uint8_t *out_shared_secret,
54                size_t *out_shared_secret_len, const uint8_t *enc,
55                size_t enc_len);
56   int (*auth_encap_with_seed)(const EVP_HPKE_KEY *key,
57                               uint8_t *out_shared_secret,
58                               size_t *out_shared_secret_len, uint8_t *out_enc,
59                               size_t *out_enc_len, size_t max_enc,
60                               const uint8_t *peer_public_key,
61                               size_t peer_public_key_len, const uint8_t *seed,
62                               size_t seed_len);
63   int (*auth_decap)(const EVP_HPKE_KEY *key, uint8_t *out_shared_secret,
64                     size_t *out_shared_secret_len, const uint8_t *enc,
65                     size_t enc_len, const uint8_t *peer_public_key,
66                     size_t peer_public_key_len);
67 };
68 
69 struct evp_hpke_kdf_st {
70   uint16_t id;
71   // We only support HKDF-based KDFs.
72   const EVP_MD *(*hkdf_md_func)(void);
73 };
74 
75 struct evp_hpke_aead_st {
76   uint16_t id;
77   const EVP_AEAD *(*aead_func)(void);
78 };
79 
80 
81 // Low-level labeled KDF functions.
82 
83 static const char kHpkeVersionId[] = "HPKE-v1";
84 
add_label_string(CBB * cbb,const char * label)85 static int add_label_string(CBB *cbb, const char *label) {
86   return CBB_add_bytes(cbb, (const uint8_t *)label, strlen(label));
87 }
88 
hpke_labeled_extract(const EVP_MD * hkdf_md,uint8_t * out_key,size_t * out_len,const uint8_t * salt,size_t salt_len,const uint8_t * suite_id,size_t suite_id_len,const char * label,const uint8_t * ikm,size_t ikm_len)89 static int hpke_labeled_extract(const EVP_MD *hkdf_md, uint8_t *out_key,
90                                 size_t *out_len, const uint8_t *salt,
91                                 size_t salt_len, const uint8_t *suite_id,
92                                 size_t suite_id_len, const char *label,
93                                 const uint8_t *ikm, size_t ikm_len) {
94   // labeledIKM = concat("HPKE-v1", suite_id, label, IKM)
95   CBB labeled_ikm;
96   int ok = CBB_init(&labeled_ikm, 0) &&
97            add_label_string(&labeled_ikm, kHpkeVersionId) &&
98            CBB_add_bytes(&labeled_ikm, suite_id, suite_id_len) &&
99            add_label_string(&labeled_ikm, label) &&
100            CBB_add_bytes(&labeled_ikm, ikm, ikm_len) &&
101            HKDF_extract(out_key, out_len, hkdf_md, CBB_data(&labeled_ikm),
102                         CBB_len(&labeled_ikm), salt, salt_len);
103   CBB_cleanup(&labeled_ikm);
104   return ok;
105 }
106 
hpke_labeled_expand(const EVP_MD * hkdf_md,uint8_t * out_key,size_t out_len,const uint8_t * prk,size_t prk_len,const uint8_t * suite_id,size_t suite_id_len,const char * label,const uint8_t * info,size_t info_len)107 static int hpke_labeled_expand(const EVP_MD *hkdf_md, uint8_t *out_key,
108                                size_t out_len, const uint8_t *prk,
109                                size_t prk_len, const uint8_t *suite_id,
110                                size_t suite_id_len, const char *label,
111                                const uint8_t *info, size_t info_len) {
112   // labeledInfo = concat(I2OSP(L, 2), "HPKE-v1", suite_id, label, info)
113   CBB labeled_info;
114   int ok = CBB_init(&labeled_info, 0) &&
115            CBB_add_u16(&labeled_info, out_len) &&
116            add_label_string(&labeled_info, kHpkeVersionId) &&
117            CBB_add_bytes(&labeled_info, suite_id, suite_id_len) &&
118            add_label_string(&labeled_info, label) &&
119            CBB_add_bytes(&labeled_info, info, info_len) &&
120            HKDF_expand(out_key, out_len, hkdf_md, prk, prk_len,
121                        CBB_data(&labeled_info), CBB_len(&labeled_info));
122   CBB_cleanup(&labeled_info);
123   return ok;
124 }
125 
126 
127 // KEM implementations.
128 
129 // dhkem_extract_and_expand implements the ExtractAndExpand operation in the
130 // DHKEM construction. See section 4.1 of RFC 9180.
dhkem_extract_and_expand(uint16_t kem_id,const EVP_MD * hkdf_md,uint8_t * out_key,size_t out_len,const uint8_t * dh,size_t dh_len,const uint8_t * kem_context,size_t kem_context_len)131 static int dhkem_extract_and_expand(uint16_t kem_id, const EVP_MD *hkdf_md,
132                                     uint8_t *out_key, size_t out_len,
133                                     const uint8_t *dh, size_t dh_len,
134                                     const uint8_t *kem_context,
135                                     size_t kem_context_len) {
136   // concat("KEM", I2OSP(kem_id, 2))
137   uint8_t suite_id[5] = {'K', 'E', 'M', kem_id >> 8, kem_id & 0xff};
138   uint8_t prk[EVP_MAX_MD_SIZE];
139   size_t prk_len;
140   return hpke_labeled_extract(hkdf_md, prk, &prk_len, NULL, 0, suite_id,
141                               sizeof(suite_id), "eae_prk", dh, dh_len) &&
142          hpke_labeled_expand(hkdf_md, out_key, out_len, prk, prk_len, suite_id,
143                              sizeof(suite_id), "shared_secret", kem_context,
144                              kem_context_len);
145 }
146 
x25519_init_key(EVP_HPKE_KEY * key,const uint8_t * priv_key,size_t priv_key_len)147 static int x25519_init_key(EVP_HPKE_KEY *key, const uint8_t *priv_key,
148                            size_t priv_key_len) {
149   if (priv_key_len != X25519_PRIVATE_KEY_LEN) {
150     OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
151     return 0;
152   }
153 
154   OPENSSL_memcpy(key->private_key, priv_key, priv_key_len);
155   X25519_public_from_private(key->public_key, priv_key);
156   return 1;
157 }
158 
x25519_generate_key(EVP_HPKE_KEY * key)159 static int x25519_generate_key(EVP_HPKE_KEY *key) {
160   X25519_keypair(key->public_key, key->private_key);
161   return 1;
162 }
163 
x25519_encap_with_seed(const EVP_HPKE_KEM * kem,uint8_t * out_shared_secret,size_t * out_shared_secret_len,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * seed,size_t seed_len)164 static int x25519_encap_with_seed(
165     const EVP_HPKE_KEM *kem, uint8_t *out_shared_secret,
166     size_t *out_shared_secret_len, uint8_t *out_enc, size_t *out_enc_len,
167     size_t max_enc, const uint8_t *peer_public_key, size_t peer_public_key_len,
168     const uint8_t *seed, size_t seed_len) {
169   if (max_enc < X25519_PUBLIC_VALUE_LEN) {
170     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_BUFFER_SIZE);
171     return 0;
172   }
173   if (seed_len != X25519_PRIVATE_KEY_LEN) {
174     OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
175     return 0;
176   }
177   X25519_public_from_private(out_enc, seed);
178 
179   uint8_t dh[X25519_SHARED_KEY_LEN];
180   if (peer_public_key_len != X25519_PUBLIC_VALUE_LEN ||
181       !X25519(dh, seed, peer_public_key)) {
182     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_PEER_KEY);
183     return 0;
184   }
185 
186   uint8_t kem_context[2 * X25519_PUBLIC_VALUE_LEN];
187   OPENSSL_memcpy(kem_context, out_enc, X25519_PUBLIC_VALUE_LEN);
188   OPENSSL_memcpy(kem_context + X25519_PUBLIC_VALUE_LEN, peer_public_key,
189                  X25519_PUBLIC_VALUE_LEN);
190   if (!dhkem_extract_and_expand(kem->id, EVP_sha256(), out_shared_secret,
191                                 SHA256_DIGEST_LENGTH, dh, sizeof(dh),
192                                 kem_context, sizeof(kem_context))) {
193     return 0;
194   }
195 
196   *out_enc_len = X25519_PUBLIC_VALUE_LEN;
197   *out_shared_secret_len = SHA256_DIGEST_LENGTH;
198   return 1;
199 }
200 
x25519_decap(const EVP_HPKE_KEY * key,uint8_t * out_shared_secret,size_t * out_shared_secret_len,const uint8_t * enc,size_t enc_len)201 static int x25519_decap(const EVP_HPKE_KEY *key, uint8_t *out_shared_secret,
202                         size_t *out_shared_secret_len, const uint8_t *enc,
203                         size_t enc_len) {
204   uint8_t dh[X25519_SHARED_KEY_LEN];
205   if (enc_len != X25519_PUBLIC_VALUE_LEN ||
206       !X25519(dh, key->private_key, enc)) {
207     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_PEER_KEY);
208     return 0;
209   }
210 
211   uint8_t kem_context[2 * X25519_PUBLIC_VALUE_LEN];
212   OPENSSL_memcpy(kem_context, enc, X25519_PUBLIC_VALUE_LEN);
213   OPENSSL_memcpy(kem_context + X25519_PUBLIC_VALUE_LEN, key->public_key,
214                  X25519_PUBLIC_VALUE_LEN);
215   if (!dhkem_extract_and_expand(key->kem->id, EVP_sha256(), out_shared_secret,
216                                 SHA256_DIGEST_LENGTH, dh, sizeof(dh),
217                                 kem_context, sizeof(kem_context))) {
218     return 0;
219   }
220 
221   *out_shared_secret_len = SHA256_DIGEST_LENGTH;
222   return 1;
223 }
224 
x25519_auth_encap_with_seed(const EVP_HPKE_KEY * key,uint8_t * out_shared_secret,size_t * out_shared_secret_len,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * seed,size_t seed_len)225 static int x25519_auth_encap_with_seed(
226     const EVP_HPKE_KEY *key, uint8_t *out_shared_secret,
227     size_t *out_shared_secret_len, uint8_t *out_enc, size_t *out_enc_len,
228     size_t max_enc, const uint8_t *peer_public_key, size_t peer_public_key_len,
229     const uint8_t *seed, size_t seed_len) {
230   if (max_enc < X25519_PUBLIC_VALUE_LEN) {
231     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_BUFFER_SIZE);
232     return 0;
233   }
234   if (seed_len != X25519_PRIVATE_KEY_LEN) {
235     OPENSSL_PUT_ERROR(EVP, EVP_R_DECODE_ERROR);
236     return 0;
237   }
238   X25519_public_from_private(out_enc, seed);
239 
240   uint8_t dh[2 * X25519_SHARED_KEY_LEN];
241   if (peer_public_key_len != X25519_PUBLIC_VALUE_LEN ||
242       !X25519(dh, seed, peer_public_key) ||
243       !X25519(dh + X25519_SHARED_KEY_LEN, key->private_key, peer_public_key)) {
244     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_PEER_KEY);
245     return 0;
246   }
247 
248   uint8_t kem_context[3 * X25519_PUBLIC_VALUE_LEN];
249   OPENSSL_memcpy(kem_context, out_enc, X25519_PUBLIC_VALUE_LEN);
250   OPENSSL_memcpy(kem_context + X25519_PUBLIC_VALUE_LEN, peer_public_key,
251                  X25519_PUBLIC_VALUE_LEN);
252   OPENSSL_memcpy(kem_context + 2 * X25519_PUBLIC_VALUE_LEN, key->public_key,
253                  X25519_PUBLIC_VALUE_LEN);
254   if (!dhkem_extract_and_expand(key->kem->id, EVP_sha256(), out_shared_secret,
255                                 SHA256_DIGEST_LENGTH, dh, sizeof(dh),
256                                 kem_context, sizeof(kem_context))) {
257     return 0;
258   }
259 
260   *out_enc_len = X25519_PUBLIC_VALUE_LEN;
261   *out_shared_secret_len = SHA256_DIGEST_LENGTH;
262   return 1;
263 }
264 
x25519_auth_decap(const EVP_HPKE_KEY * key,uint8_t * out_shared_secret,size_t * out_shared_secret_len,const uint8_t * enc,size_t enc_len,const uint8_t * peer_public_key,size_t peer_public_key_len)265 static int x25519_auth_decap(const EVP_HPKE_KEY *key,
266                              uint8_t *out_shared_secret,
267                              size_t *out_shared_secret_len, const uint8_t *enc,
268                              size_t enc_len, const uint8_t *peer_public_key,
269                              size_t peer_public_key_len) {
270   uint8_t dh[2 * X25519_SHARED_KEY_LEN];
271   if (enc_len != X25519_PUBLIC_VALUE_LEN ||
272       peer_public_key_len != X25519_PUBLIC_VALUE_LEN ||
273       !X25519(dh, key->private_key, enc) ||
274       !X25519(dh + X25519_SHARED_KEY_LEN, key->private_key, peer_public_key)) {
275     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_PEER_KEY);
276     return 0;
277   }
278 
279   uint8_t kem_context[3 * X25519_PUBLIC_VALUE_LEN];
280   OPENSSL_memcpy(kem_context, enc, X25519_PUBLIC_VALUE_LEN);
281   OPENSSL_memcpy(kem_context + X25519_PUBLIC_VALUE_LEN, key->public_key,
282                  X25519_PUBLIC_VALUE_LEN);
283   OPENSSL_memcpy(kem_context + 2 * X25519_PUBLIC_VALUE_LEN, peer_public_key,
284                  X25519_PUBLIC_VALUE_LEN);
285   if (!dhkem_extract_and_expand(key->kem->id, EVP_sha256(), out_shared_secret,
286                                 SHA256_DIGEST_LENGTH, dh, sizeof(dh),
287                                 kem_context, sizeof(kem_context))) {
288     return 0;
289   }
290 
291   *out_shared_secret_len = SHA256_DIGEST_LENGTH;
292   return 1;
293 }
294 
EVP_hpke_x25519_hkdf_sha256(void)295 const EVP_HPKE_KEM *EVP_hpke_x25519_hkdf_sha256(void) {
296   static const EVP_HPKE_KEM kKEM = {
297       /*id=*/EVP_HPKE_DHKEM_X25519_HKDF_SHA256,
298       /*public_key_len=*/X25519_PUBLIC_VALUE_LEN,
299       /*private_key_len=*/X25519_PRIVATE_KEY_LEN,
300       /*seed_len=*/X25519_PRIVATE_KEY_LEN,
301       /*enc_len=*/X25519_PUBLIC_VALUE_LEN,
302       x25519_init_key,
303       x25519_generate_key,
304       x25519_encap_with_seed,
305       x25519_decap,
306       x25519_auth_encap_with_seed,
307       x25519_auth_decap,
308   };
309   return &kKEM;
310 }
311 
EVP_HPKE_KEM_id(const EVP_HPKE_KEM * kem)312 uint16_t EVP_HPKE_KEM_id(const EVP_HPKE_KEM *kem) { return kem->id; }
313 
EVP_HPKE_KEM_public_key_len(const EVP_HPKE_KEM * kem)314 size_t EVP_HPKE_KEM_public_key_len(const EVP_HPKE_KEM *kem) {
315   return kem->public_key_len;
316 }
317 
EVP_HPKE_KEM_private_key_len(const EVP_HPKE_KEM * kem)318 size_t EVP_HPKE_KEM_private_key_len(const EVP_HPKE_KEM *kem) {
319   return kem->private_key_len;
320 }
321 
EVP_HPKE_KEM_enc_len(const EVP_HPKE_KEM * kem)322 size_t EVP_HPKE_KEM_enc_len(const EVP_HPKE_KEM *kem) { return kem->enc_len; }
323 
EVP_HPKE_KEY_zero(EVP_HPKE_KEY * key)324 void EVP_HPKE_KEY_zero(EVP_HPKE_KEY *key) {
325   OPENSSL_memset(key, 0, sizeof(EVP_HPKE_KEY));
326 }
327 
EVP_HPKE_KEY_cleanup(EVP_HPKE_KEY * key)328 void EVP_HPKE_KEY_cleanup(EVP_HPKE_KEY *key) {
329   // Nothing to clean up for now, but we may introduce a cleanup process in the
330   // future.
331 }
332 
EVP_HPKE_KEY_new(void)333 EVP_HPKE_KEY *EVP_HPKE_KEY_new(void) {
334   EVP_HPKE_KEY *key = OPENSSL_malloc(sizeof(EVP_HPKE_KEY));
335   if (key == NULL) {
336     return NULL;
337   }
338   EVP_HPKE_KEY_zero(key);
339   return key;
340 }
341 
EVP_HPKE_KEY_free(EVP_HPKE_KEY * key)342 void EVP_HPKE_KEY_free(EVP_HPKE_KEY *key) {
343   if (key != NULL) {
344     EVP_HPKE_KEY_cleanup(key);
345     OPENSSL_free(key);
346   }
347 }
348 
EVP_HPKE_KEY_copy(EVP_HPKE_KEY * dst,const EVP_HPKE_KEY * src)349 int EVP_HPKE_KEY_copy(EVP_HPKE_KEY *dst, const EVP_HPKE_KEY *src) {
350   // For now, |EVP_HPKE_KEY| is trivially copyable.
351   OPENSSL_memcpy(dst, src, sizeof(EVP_HPKE_KEY));
352   return 1;
353 }
354 
EVP_HPKE_KEY_move(EVP_HPKE_KEY * out,EVP_HPKE_KEY * in)355 void EVP_HPKE_KEY_move(EVP_HPKE_KEY *out, EVP_HPKE_KEY *in) {
356   EVP_HPKE_KEY_cleanup(out);
357   // For now, |EVP_HPKE_KEY| is trivially movable.
358   OPENSSL_memcpy(out, in, sizeof(EVP_HPKE_KEY));
359   EVP_HPKE_KEY_zero(in);
360 }
361 
EVP_HPKE_KEY_init(EVP_HPKE_KEY * key,const EVP_HPKE_KEM * kem,const uint8_t * priv_key,size_t priv_key_len)362 int EVP_HPKE_KEY_init(EVP_HPKE_KEY *key, const EVP_HPKE_KEM *kem,
363                       const uint8_t *priv_key, size_t priv_key_len) {
364   EVP_HPKE_KEY_zero(key);
365   key->kem = kem;
366   if (!kem->init_key(key, priv_key, priv_key_len)) {
367     key->kem = NULL;
368     return 0;
369   }
370   return 1;
371 }
372 
EVP_HPKE_KEY_generate(EVP_HPKE_KEY * key,const EVP_HPKE_KEM * kem)373 int EVP_HPKE_KEY_generate(EVP_HPKE_KEY *key, const EVP_HPKE_KEM *kem) {
374   EVP_HPKE_KEY_zero(key);
375   key->kem = kem;
376   if (!kem->generate_key(key)) {
377     key->kem = NULL;
378     return 0;
379   }
380   return 1;
381 }
382 
EVP_HPKE_KEY_kem(const EVP_HPKE_KEY * key)383 const EVP_HPKE_KEM *EVP_HPKE_KEY_kem(const EVP_HPKE_KEY *key) {
384   return key->kem;
385 }
386 
EVP_HPKE_KEY_public_key(const EVP_HPKE_KEY * key,uint8_t * out,size_t * out_len,size_t max_out)387 int EVP_HPKE_KEY_public_key(const EVP_HPKE_KEY *key, uint8_t *out,
388                             size_t *out_len, size_t max_out) {
389   if (max_out < key->kem->public_key_len) {
390     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_BUFFER_SIZE);
391     return 0;
392   }
393   OPENSSL_memcpy(out, key->public_key, key->kem->public_key_len);
394   *out_len = key->kem->public_key_len;
395   return 1;
396 }
397 
EVP_HPKE_KEY_private_key(const EVP_HPKE_KEY * key,uint8_t * out,size_t * out_len,size_t max_out)398 int EVP_HPKE_KEY_private_key(const EVP_HPKE_KEY *key, uint8_t *out,
399                             size_t *out_len, size_t max_out) {
400   if (max_out < key->kem->private_key_len) {
401     OPENSSL_PUT_ERROR(EVP, EVP_R_INVALID_BUFFER_SIZE);
402     return 0;
403   }
404   OPENSSL_memcpy(out, key->private_key, key->kem->private_key_len);
405   *out_len = key->kem->private_key_len;
406   return 1;
407 }
408 
409 
410 // Supported KDFs and AEADs.
411 
EVP_hpke_hkdf_sha256(void)412 const EVP_HPKE_KDF *EVP_hpke_hkdf_sha256(void) {
413   static const EVP_HPKE_KDF kKDF = {EVP_HPKE_HKDF_SHA256, &EVP_sha256};
414   return &kKDF;
415 }
416 
EVP_HPKE_KDF_id(const EVP_HPKE_KDF * kdf)417 uint16_t EVP_HPKE_KDF_id(const EVP_HPKE_KDF *kdf) { return kdf->id; }
418 
EVP_HPKE_KDF_hkdf_md(const EVP_HPKE_KDF * kdf)419 const EVP_MD *EVP_HPKE_KDF_hkdf_md(const EVP_HPKE_KDF *kdf) {
420   return kdf->hkdf_md_func();
421 }
422 
EVP_hpke_aes_128_gcm(void)423 const EVP_HPKE_AEAD *EVP_hpke_aes_128_gcm(void) {
424   static const EVP_HPKE_AEAD kAEAD = {EVP_HPKE_AES_128_GCM,
425                                       &EVP_aead_aes_128_gcm};
426   return &kAEAD;
427 }
428 
EVP_hpke_aes_256_gcm(void)429 const EVP_HPKE_AEAD *EVP_hpke_aes_256_gcm(void) {
430   static const EVP_HPKE_AEAD kAEAD = {EVP_HPKE_AES_256_GCM,
431                                       &EVP_aead_aes_256_gcm};
432   return &kAEAD;
433 }
434 
EVP_hpke_chacha20_poly1305(void)435 const EVP_HPKE_AEAD *EVP_hpke_chacha20_poly1305(void) {
436   static const EVP_HPKE_AEAD kAEAD = {EVP_HPKE_CHACHA20_POLY1305,
437                                       &EVP_aead_chacha20_poly1305};
438   return &kAEAD;
439 }
440 
EVP_HPKE_AEAD_id(const EVP_HPKE_AEAD * aead)441 uint16_t EVP_HPKE_AEAD_id(const EVP_HPKE_AEAD *aead) { return aead->id; }
442 
EVP_HPKE_AEAD_aead(const EVP_HPKE_AEAD * aead)443 const EVP_AEAD *EVP_HPKE_AEAD_aead(const EVP_HPKE_AEAD *aead) {
444   return aead->aead_func();
445 }
446 
447 
448 // HPKE implementation.
449 
450 // This is strlen("HPKE") + 3 * sizeof(uint16_t).
451 #define HPKE_SUITE_ID_LEN 10
452 
453 // The suite_id for non-KEM pieces of HPKE is defined as concat("HPKE",
454 // I2OSP(kem_id, 2), I2OSP(kdf_id, 2), I2OSP(aead_id, 2)).
hpke_build_suite_id(const EVP_HPKE_CTX * ctx,uint8_t out[HPKE_SUITE_ID_LEN])455 static int hpke_build_suite_id(const EVP_HPKE_CTX *ctx,
456                                uint8_t out[HPKE_SUITE_ID_LEN]) {
457   CBB cbb;
458   CBB_init_fixed(&cbb, out, HPKE_SUITE_ID_LEN);
459   return add_label_string(&cbb, "HPKE") &&   //
460          CBB_add_u16(&cbb, ctx->kem->id) &&  //
461          CBB_add_u16(&cbb, ctx->kdf->id) &&  //
462          CBB_add_u16(&cbb, ctx->aead->id);
463 }
464 
465 #define HPKE_MODE_BASE 0
466 #define HPKE_MODE_AUTH 2
467 
hpke_key_schedule(EVP_HPKE_CTX * ctx,uint8_t mode,const uint8_t * shared_secret,size_t shared_secret_len,const uint8_t * info,size_t info_len)468 static int hpke_key_schedule(EVP_HPKE_CTX *ctx, uint8_t mode,
469                              const uint8_t *shared_secret,
470                              size_t shared_secret_len, const uint8_t *info,
471                              size_t info_len) {
472   uint8_t suite_id[HPKE_SUITE_ID_LEN];
473   if (!hpke_build_suite_id(ctx, suite_id)) {
474     return 0;
475   }
476 
477   // psk_id_hash = LabeledExtract("", "psk_id_hash", psk_id)
478   // TODO(davidben): Precompute this value and store it with the EVP_HPKE_KDF.
479   const EVP_MD *hkdf_md = ctx->kdf->hkdf_md_func();
480   uint8_t psk_id_hash[EVP_MAX_MD_SIZE];
481   size_t psk_id_hash_len;
482   if (!hpke_labeled_extract(hkdf_md, psk_id_hash, &psk_id_hash_len, NULL, 0,
483                             suite_id, sizeof(suite_id), "psk_id_hash", NULL,
484                             0)) {
485     return 0;
486   }
487 
488   // info_hash = LabeledExtract("", "info_hash", info)
489   uint8_t info_hash[EVP_MAX_MD_SIZE];
490   size_t info_hash_len;
491   if (!hpke_labeled_extract(hkdf_md, info_hash, &info_hash_len, NULL, 0,
492                             suite_id, sizeof(suite_id), "info_hash", info,
493                             info_len)) {
494     return 0;
495   }
496 
497   // key_schedule_context = concat(mode, psk_id_hash, info_hash)
498   uint8_t context[sizeof(uint8_t) + 2 * EVP_MAX_MD_SIZE];
499   size_t context_len;
500   CBB context_cbb;
501   CBB_init_fixed(&context_cbb, context, sizeof(context));
502   if (!CBB_add_u8(&context_cbb, mode) ||
503       !CBB_add_bytes(&context_cbb, psk_id_hash, psk_id_hash_len) ||
504       !CBB_add_bytes(&context_cbb, info_hash, info_hash_len) ||
505       !CBB_finish(&context_cbb, NULL, &context_len)) {
506     return 0;
507   }
508 
509   // secret = LabeledExtract(shared_secret, "secret", psk)
510   uint8_t secret[EVP_MAX_MD_SIZE];
511   size_t secret_len;
512   if (!hpke_labeled_extract(hkdf_md, secret, &secret_len, shared_secret,
513                             shared_secret_len, suite_id, sizeof(suite_id),
514                             "secret", NULL, 0)) {
515     return 0;
516   }
517 
518   // key = LabeledExpand(secret, "key", key_schedule_context, Nk)
519   const EVP_AEAD *aead = EVP_HPKE_AEAD_aead(ctx->aead);
520   uint8_t key[EVP_AEAD_MAX_KEY_LENGTH];
521   const size_t kKeyLen = EVP_AEAD_key_length(aead);
522   if (!hpke_labeled_expand(hkdf_md, key, kKeyLen, secret, secret_len, suite_id,
523                            sizeof(suite_id), "key", context, context_len) ||
524       !EVP_AEAD_CTX_init(&ctx->aead_ctx, aead, key, kKeyLen,
525                          EVP_AEAD_DEFAULT_TAG_LENGTH, NULL)) {
526     return 0;
527   }
528 
529   // base_nonce = LabeledExpand(secret, "base_nonce", key_schedule_context, Nn)
530   if (!hpke_labeled_expand(hkdf_md, ctx->base_nonce,
531                            EVP_AEAD_nonce_length(aead), secret, secret_len,
532                            suite_id, sizeof(suite_id), "base_nonce", context,
533                            context_len)) {
534     return 0;
535   }
536 
537   // exporter_secret = LabeledExpand(secret, "exp", key_schedule_context, Nh)
538   if (!hpke_labeled_expand(hkdf_md, ctx->exporter_secret, EVP_MD_size(hkdf_md),
539                            secret, secret_len, suite_id, sizeof(suite_id),
540                            "exp", context, context_len)) {
541     return 0;
542   }
543 
544   return 1;
545 }
546 
EVP_HPKE_CTX_zero(EVP_HPKE_CTX * ctx)547 void EVP_HPKE_CTX_zero(EVP_HPKE_CTX *ctx) {
548   OPENSSL_memset(ctx, 0, sizeof(EVP_HPKE_CTX));
549   EVP_AEAD_CTX_zero(&ctx->aead_ctx);
550 }
551 
EVP_HPKE_CTX_cleanup(EVP_HPKE_CTX * ctx)552 void EVP_HPKE_CTX_cleanup(EVP_HPKE_CTX *ctx) {
553   EVP_AEAD_CTX_cleanup(&ctx->aead_ctx);
554 }
555 
EVP_HPKE_CTX_new(void)556 EVP_HPKE_CTX *EVP_HPKE_CTX_new(void) {
557   EVP_HPKE_CTX *ctx = OPENSSL_malloc(sizeof(EVP_HPKE_CTX));
558   if (ctx == NULL) {
559     return NULL;
560   }
561   EVP_HPKE_CTX_zero(ctx);
562   return ctx;
563 }
564 
EVP_HPKE_CTX_free(EVP_HPKE_CTX * ctx)565 void EVP_HPKE_CTX_free(EVP_HPKE_CTX *ctx) {
566   if (ctx != NULL) {
567     EVP_HPKE_CTX_cleanup(ctx);
568     OPENSSL_free(ctx);
569   }
570 }
571 
EVP_HPKE_CTX_setup_sender(EVP_HPKE_CTX * ctx,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const EVP_HPKE_KEM * kem,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * info,size_t info_len)572 int EVP_HPKE_CTX_setup_sender(EVP_HPKE_CTX *ctx, uint8_t *out_enc,
573                               size_t *out_enc_len, size_t max_enc,
574                               const EVP_HPKE_KEM *kem, const EVP_HPKE_KDF *kdf,
575                               const EVP_HPKE_AEAD *aead,
576                               const uint8_t *peer_public_key,
577                               size_t peer_public_key_len, const uint8_t *info,
578                               size_t info_len) {
579   uint8_t seed[MAX_SEED_LEN];
580   RAND_bytes(seed, kem->seed_len);
581   return EVP_HPKE_CTX_setup_sender_with_seed_for_testing(
582       ctx, out_enc, out_enc_len, max_enc, kem, kdf, aead, peer_public_key,
583       peer_public_key_len, info, info_len, seed, kem->seed_len);
584 }
585 
EVP_HPKE_CTX_setup_sender_with_seed_for_testing(EVP_HPKE_CTX * ctx,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const EVP_HPKE_KEM * kem,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * info,size_t info_len,const uint8_t * seed,size_t seed_len)586 int EVP_HPKE_CTX_setup_sender_with_seed_for_testing(
587     EVP_HPKE_CTX *ctx, uint8_t *out_enc, size_t *out_enc_len, size_t max_enc,
588     const EVP_HPKE_KEM *kem, const EVP_HPKE_KDF *kdf, const EVP_HPKE_AEAD *aead,
589     const uint8_t *peer_public_key, size_t peer_public_key_len,
590     const uint8_t *info, size_t info_len, const uint8_t *seed,
591     size_t seed_len) {
592   EVP_HPKE_CTX_zero(ctx);
593   ctx->is_sender = 1;
594   ctx->kem = kem;
595   ctx->kdf = kdf;
596   ctx->aead = aead;
597   uint8_t shared_secret[MAX_SHARED_SECRET_LEN];
598   size_t shared_secret_len;
599   if (!kem->encap_with_seed(kem, shared_secret, &shared_secret_len, out_enc,
600                             out_enc_len, max_enc, peer_public_key,
601                             peer_public_key_len, seed, seed_len) ||
602       !hpke_key_schedule(ctx, HPKE_MODE_BASE, shared_secret, shared_secret_len,
603                          info, info_len)) {
604     EVP_HPKE_CTX_cleanup(ctx);
605     return 0;
606   }
607   return 1;
608 }
609 
EVP_HPKE_CTX_setup_recipient(EVP_HPKE_CTX * ctx,const EVP_HPKE_KEY * key,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * enc,size_t enc_len,const uint8_t * info,size_t info_len)610 int EVP_HPKE_CTX_setup_recipient(EVP_HPKE_CTX *ctx, const EVP_HPKE_KEY *key,
611                                  const EVP_HPKE_KDF *kdf,
612                                  const EVP_HPKE_AEAD *aead, const uint8_t *enc,
613                                  size_t enc_len, const uint8_t *info,
614                                  size_t info_len) {
615   EVP_HPKE_CTX_zero(ctx);
616   ctx->is_sender = 0;
617   ctx->kem = key->kem;
618   ctx->kdf = kdf;
619   ctx->aead = aead;
620   uint8_t shared_secret[MAX_SHARED_SECRET_LEN];
621   size_t shared_secret_len;
622   if (!key->kem->decap(key, shared_secret, &shared_secret_len, enc, enc_len) ||
623       !hpke_key_schedule(ctx, HPKE_MODE_BASE, shared_secret, shared_secret_len,
624                          info, info_len)) {
625     EVP_HPKE_CTX_cleanup(ctx);
626     return 0;
627   }
628   return 1;
629 }
630 
631 
EVP_HPKE_CTX_setup_auth_sender(EVP_HPKE_CTX * ctx,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const EVP_HPKE_KEY * key,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * info,size_t info_len)632 int EVP_HPKE_CTX_setup_auth_sender(
633     EVP_HPKE_CTX *ctx, uint8_t *out_enc, size_t *out_enc_len, size_t max_enc,
634     const EVP_HPKE_KEY *key, const EVP_HPKE_KDF *kdf, const EVP_HPKE_AEAD *aead,
635     const uint8_t *peer_public_key, size_t peer_public_key_len,
636     const uint8_t *info, size_t info_len) {
637   uint8_t seed[MAX_SEED_LEN];
638   RAND_bytes(seed, key->kem->seed_len);
639   return EVP_HPKE_CTX_setup_auth_sender_with_seed_for_testing(
640       ctx, out_enc, out_enc_len, max_enc, key, kdf, aead, peer_public_key,
641       peer_public_key_len, info, info_len, seed, key->kem->seed_len);
642 }
643 
EVP_HPKE_CTX_setup_auth_sender_with_seed_for_testing(EVP_HPKE_CTX * ctx,uint8_t * out_enc,size_t * out_enc_len,size_t max_enc,const EVP_HPKE_KEY * key,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * peer_public_key,size_t peer_public_key_len,const uint8_t * info,size_t info_len,const uint8_t * seed,size_t seed_len)644 int EVP_HPKE_CTX_setup_auth_sender_with_seed_for_testing(
645     EVP_HPKE_CTX *ctx, uint8_t *out_enc, size_t *out_enc_len, size_t max_enc,
646     const EVP_HPKE_KEY *key, const EVP_HPKE_KDF *kdf, const EVP_HPKE_AEAD *aead,
647     const uint8_t *peer_public_key, size_t peer_public_key_len,
648     const uint8_t *info, size_t info_len, const uint8_t *seed,
649     size_t seed_len) {
650   if (key->kem->auth_encap_with_seed == NULL) {
651     // Not all HPKE KEMs support AuthEncap.
652     OPENSSL_PUT_ERROR(EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
653     return 0;
654   }
655 
656   EVP_HPKE_CTX_zero(ctx);
657   ctx->is_sender = 1;
658   ctx->kem = key->kem;
659   ctx->kdf = kdf;
660   ctx->aead = aead;
661   uint8_t shared_secret[MAX_SHARED_SECRET_LEN];
662   size_t shared_secret_len;
663   if (!key->kem->auth_encap_with_seed(
664           key, shared_secret, &shared_secret_len, out_enc, out_enc_len, max_enc,
665           peer_public_key, peer_public_key_len, seed, seed_len) ||
666       !hpke_key_schedule(ctx, HPKE_MODE_AUTH, shared_secret, shared_secret_len,
667                          info, info_len)) {
668     EVP_HPKE_CTX_cleanup(ctx);
669     return 0;
670   }
671   return 1;
672 }
673 
EVP_HPKE_CTX_setup_auth_recipient(EVP_HPKE_CTX * ctx,const EVP_HPKE_KEY * key,const EVP_HPKE_KDF * kdf,const EVP_HPKE_AEAD * aead,const uint8_t * enc,size_t enc_len,const uint8_t * info,size_t info_len,const uint8_t * peer_public_key,size_t peer_public_key_len)674 int EVP_HPKE_CTX_setup_auth_recipient(
675     EVP_HPKE_CTX *ctx, const EVP_HPKE_KEY *key, const EVP_HPKE_KDF *kdf,
676     const EVP_HPKE_AEAD *aead, const uint8_t *enc, size_t enc_len,
677     const uint8_t *info, size_t info_len, const uint8_t *peer_public_key,
678     size_t peer_public_key_len) {
679   if (key->kem->auth_decap == NULL) {
680     // Not all HPKE KEMs support AuthDecap.
681     OPENSSL_PUT_ERROR(EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
682     return 0;
683   }
684 
685   EVP_HPKE_CTX_zero(ctx);
686   ctx->is_sender = 0;
687   ctx->kem = key->kem;
688   ctx->kdf = kdf;
689   ctx->aead = aead;
690   uint8_t shared_secret[MAX_SHARED_SECRET_LEN];
691   size_t shared_secret_len;
692   if (!key->kem->auth_decap(key, shared_secret, &shared_secret_len, enc,
693                             enc_len, peer_public_key, peer_public_key_len) ||
694       !hpke_key_schedule(ctx, HPKE_MODE_AUTH, shared_secret, shared_secret_len,
695                          info, info_len)) {
696     EVP_HPKE_CTX_cleanup(ctx);
697     return 0;
698   }
699   return 1;
700 }
701 
hpke_nonce(const EVP_HPKE_CTX * ctx,uint8_t * out_nonce,size_t nonce_len)702 static void hpke_nonce(const EVP_HPKE_CTX *ctx, uint8_t *out_nonce,
703                        size_t nonce_len) {
704   assert(nonce_len >= 8);
705 
706   // Write padded big-endian bytes of |ctx->seq| to |out_nonce|.
707   OPENSSL_memset(out_nonce, 0, nonce_len);
708   uint64_t seq_copy = ctx->seq;
709   for (size_t i = 0; i < 8; i++) {
710     out_nonce[nonce_len - i - 1] = seq_copy & 0xff;
711     seq_copy >>= 8;
712   }
713 
714   // XOR the encoded sequence with the |ctx->base_nonce|.
715   for (size_t i = 0; i < nonce_len; i++) {
716     out_nonce[i] ^= ctx->base_nonce[i];
717   }
718 }
719 
EVP_HPKE_CTX_open(EVP_HPKE_CTX * ctx,uint8_t * out,size_t * out_len,size_t max_out_len,const uint8_t * in,size_t in_len,const uint8_t * ad,size_t ad_len)720 int EVP_HPKE_CTX_open(EVP_HPKE_CTX *ctx, uint8_t *out, size_t *out_len,
721                       size_t max_out_len, const uint8_t *in, size_t in_len,
722                       const uint8_t *ad, size_t ad_len) {
723   if (ctx->is_sender) {
724     OPENSSL_PUT_ERROR(EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
725     return 0;
726   }
727   if (ctx->seq == UINT64_MAX) {
728     OPENSSL_PUT_ERROR(EVP, ERR_R_OVERFLOW);
729     return 0;
730   }
731 
732   uint8_t nonce[EVP_AEAD_MAX_NONCE_LENGTH];
733   const size_t nonce_len = EVP_AEAD_nonce_length(ctx->aead_ctx.aead);
734   hpke_nonce(ctx, nonce, nonce_len);
735 
736   if (!EVP_AEAD_CTX_open(&ctx->aead_ctx, out, out_len, max_out_len, nonce,
737                          nonce_len, in, in_len, ad, ad_len)) {
738     return 0;
739   }
740   ctx->seq++;
741   return 1;
742 }
743 
EVP_HPKE_CTX_seal(EVP_HPKE_CTX * ctx,uint8_t * out,size_t * out_len,size_t max_out_len,const uint8_t * in,size_t in_len,const uint8_t * ad,size_t ad_len)744 int EVP_HPKE_CTX_seal(EVP_HPKE_CTX *ctx, uint8_t *out, size_t *out_len,
745                       size_t max_out_len, const uint8_t *in, size_t in_len,
746                       const uint8_t *ad, size_t ad_len) {
747   if (!ctx->is_sender) {
748     OPENSSL_PUT_ERROR(EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
749     return 0;
750   }
751   if (ctx->seq == UINT64_MAX) {
752     OPENSSL_PUT_ERROR(EVP, ERR_R_OVERFLOW);
753     return 0;
754   }
755 
756   uint8_t nonce[EVP_AEAD_MAX_NONCE_LENGTH];
757   const size_t nonce_len = EVP_AEAD_nonce_length(ctx->aead_ctx.aead);
758   hpke_nonce(ctx, nonce, nonce_len);
759 
760   if (!EVP_AEAD_CTX_seal(&ctx->aead_ctx, out, out_len, max_out_len, nonce,
761                          nonce_len, in, in_len, ad, ad_len)) {
762     return 0;
763   }
764   ctx->seq++;
765   return 1;
766 }
767 
EVP_HPKE_CTX_export(const EVP_HPKE_CTX * ctx,uint8_t * out,size_t secret_len,const uint8_t * context,size_t context_len)768 int EVP_HPKE_CTX_export(const EVP_HPKE_CTX *ctx, uint8_t *out,
769                         size_t secret_len, const uint8_t *context,
770                         size_t context_len) {
771   uint8_t suite_id[HPKE_SUITE_ID_LEN];
772   if (!hpke_build_suite_id(ctx, suite_id)) {
773     return 0;
774   }
775   const EVP_MD *hkdf_md = ctx->kdf->hkdf_md_func();
776   if (!hpke_labeled_expand(hkdf_md, out, secret_len, ctx->exporter_secret,
777                            EVP_MD_size(hkdf_md), suite_id, sizeof(suite_id),
778                            "sec", context, context_len)) {
779     return 0;
780   }
781   return 1;
782 }
783 
EVP_HPKE_CTX_max_overhead(const EVP_HPKE_CTX * ctx)784 size_t EVP_HPKE_CTX_max_overhead(const EVP_HPKE_CTX *ctx) {
785   assert(ctx->is_sender);
786   return EVP_AEAD_max_overhead(EVP_AEAD_CTX_aead(&ctx->aead_ctx));
787 }
788 
EVP_HPKE_CTX_kem(const EVP_HPKE_CTX * ctx)789 const EVP_HPKE_KEM *EVP_HPKE_CTX_kem(const EVP_HPKE_CTX *ctx) {
790   return ctx->kem;
791 }
792 
EVP_HPKE_CTX_aead(const EVP_HPKE_CTX * ctx)793 const EVP_HPKE_AEAD *EVP_HPKE_CTX_aead(const EVP_HPKE_CTX *ctx) {
794   return ctx->aead;
795 }
796 
EVP_HPKE_CTX_kdf(const EVP_HPKE_CTX * ctx)797 const EVP_HPKE_KDF *EVP_HPKE_CTX_kdf(const EVP_HPKE_CTX *ctx) {
798   return ctx->kdf;
799 }
800