1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
|
/*
* ngtcp2
*
* Copyright (c) 2019 ngtcp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef NGTCP2_SHARED_H
#define NGTCP2_SHARED_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
#include <ngtcp2/ngtcp2_crypto.h>
/**
* @macro
*
* :macro:`NGTCP2_INITIAL_SALT_DRAFT` is a salt value which is used to
* derive initial secret. It is used for QUIC draft versions.
*/
#define NGTCP2_INITIAL_SALT_DRAFT \
"\xaf\xbf\xec\x28\x99\x93\xd2\x4c\x9e\x97\x86\xf1\x9c\x61\x11\xe0\x43\x90" \
"\xa8\x99"
/**
* @macro
*
* :macro:`NGTCP2_INITIAL_SALT_V1` is a salt value which is used to
* derive initial secret. It is used for QUIC v1.
*/
#define NGTCP2_INITIAL_SALT_V1 \
"\x38\x76\x2c\xf7\xf5\x59\x34\xb3\x4d\x17\x9a\xe6\xa4\xc8\x0c\xad\xcc\xbb" \
"\x7f\x0a"
/**
* @macro
*
* :macro:`NGTCP2_INITIAL_SALT_V2_DRAFT` is a salt value which is used to
* derive initial secret. It is used for QUIC v2 draft.
*/
#define NGTCP2_INITIAL_SALT_V2_DRAFT \
"\xa7\x07\xc2\x03\xa5\x9b\x47\x18\x4a\x1d\x62\xca\x57\x04\x06\xea\x7a\xe3" \
"\xe5\xd3"
/* Maximum key usage (encryption) limits */
#define NGTCP2_CRYPTO_MAX_ENCRYPTION_AES_GCM (1ULL << 23)
#define NGTCP2_CRYPTO_MAX_ENCRYPTION_CHACHA20_POLY1305 (1ULL << 62)
#define NGTCP2_CRYPTO_MAX_ENCRYPTION_AES_CCM (2965820ULL)
/* Maximum authentication failure (decryption) limits during the
lifetime of a connection. */
#define NGTCP2_CRYPTO_MAX_DECRYPTION_FAILURE_AES_GCM (1ULL << 52)
#define NGTCP2_CRYPTO_MAX_DECRYPTION_FAILURE_CHACHA20_POLY1305 (1ULL << 36)
#define NGTCP2_CRYPTO_MAX_DECRYPTION_FAILURE_AES_CCM (2965820ULL)
/**
* @function
*
* `ngtcp2_crypto_ctx_initial` initializes |ctx| for Initial packet
* encryption and decryption.
*/
ngtcp2_crypto_ctx *ngtcp2_crypto_ctx_initial(ngtcp2_crypto_ctx *ctx);
/**
* @function
*
* `ngtcp2_crypto_aead_init` initializes |aead| with the provided
* |aead_native_handle| which is an underlying AEAD object.
*
* If libngtcp2_crypto_openssl is linked, |aead_native_handle| must be
* a pointer to EVP_CIPHER.
*
* If libngtcp2_crypto_gnutls is linked, |aead_native_handle| must be
* gnutls_cipher_algorithm_t casted to ``void *``.
*
* If libngtcp2_crypto_boringssl is linked, |aead_native_handle| must
* be a pointer to EVP_AEAD.
*/
ngtcp2_crypto_aead *ngtcp2_crypto_aead_init(ngtcp2_crypto_aead *aead,
void *aead_native_handle);
/**
* @function
*
* `ngtcp2_crypto_aead_retry` initializes |aead| with the AEAD cipher
* AEAD_AES_128_GCM for Retry packet integrity protection.
*/
ngtcp2_crypto_aead *ngtcp2_crypto_aead_retry(ngtcp2_crypto_aead *aead);
/**
* @function
*
* `ngtcp2_crypto_derive_initial_secrets` derives initial secrets.
* |rx_secret| and |tx_secret| must point to the buffer of at least 32
* bytes capacity. rx for read and tx for write. This function
* writes rx and tx secrets into |rx_secret| and |tx_secret|
* respectively. The length of secret is 32 bytes long.
* |client_dcid| is the destination connection ID in first Initial
* packet of client. If |initial_secret| is not NULL, the initial
* secret is written to it. It must point to the buffer which has at
* least 32 bytes capacity. The initial secret is 32 bytes long.
* |side| specifies the side of application.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_derive_initial_secrets(uint32_t version, uint8_t *rx_secret,
uint8_t *tx_secret,
uint8_t *initial_secret,
const ngtcp2_cid *client_dcid,
ngtcp2_crypto_side side);
/**
* @function
*
* `ngtcp2_crypto_derive_packet_protection_key` derives packet
* protection key. This function writes packet protection key into
* the buffer pointed by |key|. The length of derived key is
* `ngtcp2_crypto_aead_keylen(aead) <ngtcp2_crypto_aead_keylen>`
* bytes. |key| must have enough capacity to store the key. This
* function writes packet protection IV into |iv|. The length of
* derived IV is `ngtcp2_crypto_packet_protection_ivlen(aead)
* <ngtcp2_crypto_packet_protection_ivlen>` bytes. |iv| must have
* enough capacity to store the IV.
*
* If |hp| is not NULL, this function also derives packet header
* protection key and writes the key into the buffer pointed by |hp|.
* The length of derived key is `ngtcp2_crypto_aead_keylen(aead)
* <ngtcp2_crypto_aead_keylen>` bytes. |hp|, if not NULL, must have
* enough capacity to store the key.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_derive_packet_protection_key(uint8_t *key, uint8_t *iv,
uint8_t *hp, uint32_t version,
const ngtcp2_crypto_aead *aead,
const ngtcp2_crypto_md *md,
const uint8_t *secret,
size_t secretlen);
/**
* @function
*
* `ngtcp2_crypto_update_traffic_secret` derives the next generation
* of the traffic secret. |secret| specifies the current secret and
* its length is given in |secretlen|. The length of new key is the
* same as the current key. This function writes new key into the
* buffer pointed by |dest|. |dest| must have the enough capacity to
* store the new key.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_update_traffic_secret(uint8_t *dest,
const ngtcp2_crypto_md *md,
const uint8_t *secret,
size_t secretlen);
/**
* @function
*
* `ngtcp2_crypto_set_local_transport_params` sets QUIC transport
* parameter, which is encoded in wire format and stored in the buffer
* pointed by |buf| of length |len|, to the native handle |tls|.
*
* |tls| points to a implementation dependent TLS session object. If
* libngtcp2_crypto_openssl is linked, |tls| must be a pointer to SSL
* object.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_set_local_transport_params(void *tls, const uint8_t *buf,
size_t len);
/**
* @function
*
* `ngtcp2_crypto_set_remote_transport_params` retrieves a remote QUIC
* transport parameters from |tls| and sets it to |conn| using
* `ngtcp2_conn_set_remote_transport_params`.
*
* |tls| points to a implementation dependent TLS session object. If
* libngtcp2_crypto_openssl is linked, |tls| must be a pointer to SSL
* object.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_set_remote_transport_params(ngtcp2_conn *conn, void *tls);
/**
* @function
*
* `ngtcp2_crypto_derive_and_install_initial_key` derives initial
* keying materials and installs keys to |conn|.
*
* If |rx_secret| is not NULL, the secret for decryption is written to
* the buffer pointed by |rx_secret|. The length of secret is 32
* bytes, and |rx_secret| must point to the buffer which has enough
* capacity.
*
* If |tx_secret| is not NULL, the secret for encryption is written to
* the buffer pointed by |tx_secret|. The length of secret is 32
* bytes, and |tx_secret| must point to the buffer which has enough
* capacity.
*
* If |initial_secret| is not NULL, the initial secret is written to
* the buffer pointed by |initial_secret|. The length of secret is 32
* bytes, and |initial_secret| must point to the buffer which has
* enough capacity.
*
* |client_dcid| is the destination connection ID in first Initial
* packet of client.
*
* If |rx_key| is not NULL, the derived packet protection key for
* decryption is written to the buffer pointed by |rx_key|. If
* |rx_iv| is not NULL, the derived packet protection IV for
* decryption is written to the buffer pointed by |rx_iv|. If |rx_hp|
* is not NULL, the derived header protection key for decryption is
* written to the buffer pointed by |rx_hp|.
*
* If |tx_key| is not NULL, the derived packet protection key for
* encryption is written to the buffer pointed by |tx_key|. If
* |tx_iv| is not NULL, the derived packet protection IV for
* encryption is written to the buffer pointed by |tx_iv|. If |tx_hp|
* is not NULL, the derived header protection key for encryption is
* written to the buffer pointed by |tx_hp|.
*
* The length of packet protection key and header protection key is 16
* bytes long. The length of packet protection IV is 12 bytes long.
*
* This function calls `ngtcp2_conn_set_initial_crypto_ctx` to set
* initial AEAD and message digest algorithm. After the successful
* call of this function, application can use
* `ngtcp2_conn_get_initial_crypto_ctx` to get the object.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_derive_and_install_initial_key(
ngtcp2_conn *conn, uint8_t *rx_secret, uint8_t *tx_secret,
uint8_t *initial_secret, uint8_t *rx_key, uint8_t *rx_iv, uint8_t *rx_hp,
uint8_t *tx_key, uint8_t *tx_iv, uint8_t *tx_hp, uint32_t version,
const ngtcp2_cid *client_dcid);
/**
* @function
*
* `ngtcp2_crypto_derive_and_install_vneg_initial_key` derives initial
* keying materials and installs keys to |conn|. This function is
* dedicated to install keys for |version| which is negotiated, or
* being negotiated.
*
* If |rx_secret| is not NULL, the secret for decryption is written to
* the buffer pointed by |rx_secret|. The length of secret is 32
* bytes, and |rx_secret| must point to the buffer which has enough
* capacity.
*
* If |tx_secret| is not NULL, the secret for encryption is written to
* the buffer pointed by |tx_secret|. The length of secret is 32
* bytes, and |tx_secret| must point to the buffer which has enough
* capacity.
*
* If |initial_secret| is not NULL, the initial secret is written to
* the buffer pointed by |initial_secret|. The length of secret is 32
* bytes, and |initial_secret| must point to the buffer which has
* enough capacity.
*
* |client_dcid| is the destination connection ID in first Initial
* packet of client.
*
* If |rx_key| is not NULL, the derived packet protection key for
* decryption is written to the buffer pointed by |rx_key|. If
* |rx_iv| is not NULL, the derived packet protection IV for
* decryption is written to the buffer pointed by |rx_iv|. If |rx_hp|
* is not NULL, the derived header protection key for decryption is
* written to the buffer pointed by |rx_hp|.
*
* If |tx_key| is not NULL, the derived packet protection key for
* encryption is written to the buffer pointed by |tx_key|. If
* |tx_iv| is not NULL, the derived packet protection IV for
* encryption is written to the buffer pointed by |tx_iv|. If |tx_hp|
* is not NULL, the derived header protection key for encryption is
* written to the buffer pointed by |tx_hp|.
*
* The length of packet protection key and header protection key is 16
* bytes long. The length of packet protection IV is 12 bytes long.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_derive_and_install_vneg_initial_key(
ngtcp2_conn *conn, uint8_t *rx_secret, uint8_t *tx_secret,
uint8_t *initial_secret, uint8_t *rx_key, uint8_t *rx_iv, uint8_t *rx_hp,
uint8_t *tx_key, uint8_t *tx_iv, uint8_t *tx_hp, uint32_t version,
const ngtcp2_cid *client_dcid);
/**
* @function
*
* `ngtcp2_crypto_cipher_ctx_encrypt_init` initializes |cipher_ctx|
* with new cipher context object for encryption which is constructed
* to use |key| as encryption key. |cipher| specifies cipher to use.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_cipher_ctx_encrypt_init(ngtcp2_crypto_cipher_ctx *cipher_ctx,
const ngtcp2_crypto_cipher *cipher,
const uint8_t *key);
/**
* @function
*
* `ngtcp2_crypto_cipher_ctx_free` frees up resources used by
* |cipher_ctx|. This function does not free the memory pointed by
* |cipher_ctx| itself.
*/
void ngtcp2_crypto_cipher_ctx_free(ngtcp2_crypto_cipher_ctx *cipher_ctx);
/*
* `ngtcp2_crypto_md_sha256` initializes |md| with SHA256 message
* digest algorithm and returns |md|.
*/
ngtcp2_crypto_md *ngtcp2_crypto_md_sha256(ngtcp2_crypto_md *md);
ngtcp2_crypto_aead *ngtcp2_crypto_aead_aes_128_gcm(ngtcp2_crypto_aead *aead);
/*
* `ngtcp2_crypto_random` writes cryptographically-secure random
* |datalen| bytes into the buffer pointed by |data|.
*
* This function returns 0 if it succeeds, or -1.
*/
int ngtcp2_crypto_random(uint8_t *data, size_t datalen);
#endif /* NGTCP2_SHARED_H */
|