lsquic_handshake.h revision 83287402
150aadb33SDmitri Tikhonov/* Copyright (c) 2017 LiteSpeed Technologies Inc.  See LICENSE. */
283287402SDmitri Tikhonov#ifndef LSQUIC_HANDSHAKE_SERVER_H
383287402SDmitri Tikhonov#define LSQUIC_HANDSHAKE_SERVER_H
450aadb33SDmitri Tikhonov
550aadb33SDmitri Tikhonovstruct lsquic_engine_public;
683287402SDmitri Tikhonovstruct lsquic_enc_session;
750aadb33SDmitri Tikhonov
883287402SDmitri Tikhonovtypedef struct lsquic_enc_session lsquic_enc_session_t;
950aadb33SDmitri Tikhonov
1050aadb33SDmitri Tikhonov#define STK_LENGTH   60
1150aadb33SDmitri Tikhonov#define SNO_LENGTH   56
1250aadb33SDmitri Tikhonov#define SCID_LENGTH  16
1350aadb33SDmitri Tikhonov#define DNONC_LENGTH 32
1450aadb33SDmitri Tikhonov#define aes128_key_len 16
1550aadb33SDmitri Tikhonov#define aes128_iv_len 4
1650aadb33SDmitri Tikhonov
1750aadb33SDmitri Tikhonovenum handshake_error            /* TODO: rename this enum */
1850aadb33SDmitri Tikhonov{
1950aadb33SDmitri Tikhonov    DATA_NOT_ENOUGH = -2,
2050aadb33SDmitri Tikhonov    DATA_FORMAT_ERROR = -1,
2150aadb33SDmitri Tikhonov    HS_ERROR = -1,
2250aadb33SDmitri Tikhonov    DATA_NO_ERROR = 0,
2350aadb33SDmitri Tikhonov    HS_SHLO = 0,
2450aadb33SDmitri Tikhonov    HS_1RTT = 1,
2550aadb33SDmitri Tikhonov    HS_2RTT = 2,
2650aadb33SDmitri Tikhonov};
2750aadb33SDmitri Tikhonov
2850aadb33SDmitri Tikhonov/* client side need to store 0rtt info per STK */
2950aadb33SDmitri Tikhonovtypedef struct lsquic_session_cache_info_st
3050aadb33SDmitri Tikhonov{
3150aadb33SDmitri Tikhonov    unsigned char   sscid[SCID_LENGTH];
3250aadb33SDmitri Tikhonov    unsigned char   spubs[32];  /* server pub key for next time 0rtt */
3350aadb33SDmitri Tikhonov    uint32_t    ver;  /* one VERSION */
3450aadb33SDmitri Tikhonov    uint32_t    aead;
3550aadb33SDmitri Tikhonov    uint32_t    kexs;
3650aadb33SDmitri Tikhonov    uint32_t    pdmd;
3750aadb33SDmitri Tikhonov    uint64_t    orbt;
3850aadb33SDmitri Tikhonov    uint64_t    expy;
3950aadb33SDmitri Tikhonov    int         scfg_flag; /* 0, no-init, 1, no parse, 2, parsed */
4050aadb33SDmitri Tikhonov    struct lsquic_str    sstk;
4150aadb33SDmitri Tikhonov    struct lsquic_str    scfg;
4250aadb33SDmitri Tikhonov    struct lsquic_str    sni_key;   /* This is only used as key */
4350aadb33SDmitri Tikhonov
4450aadb33SDmitri Tikhonov} lsquic_session_cache_info_t;
4550aadb33SDmitri Tikhonov
4650aadb33SDmitri Tikhonov#ifndef LSQUIC_KEEP_ENC_SESS_HISTORY
4750aadb33SDmitri Tikhonov#   ifndef NDEBUG
4850aadb33SDmitri Tikhonov#       define LSQUIC_KEEP_ENC_SESS_HISTORY 1
4950aadb33SDmitri Tikhonov#   else
5050aadb33SDmitri Tikhonov#       define LSQUIC_KEEP_ENC_SESS_HISTORY 0
5150aadb33SDmitri Tikhonov#   endif
5250aadb33SDmitri Tikhonov#endif
5350aadb33SDmitri Tikhonov
5450aadb33SDmitri Tikhonov#if LSQUIC_KEEP_ENC_SESS_HISTORY
5550aadb33SDmitri Tikhonov#define ESHIST_BITS 7
5650aadb33SDmitri Tikhonov#define ESHIST_MASK ((1 << ESHIST_BITS) - 1)
5750aadb33SDmitri Tikhonov#define ESHIST_STR_SIZE ((1 << ESHIST_BITS) + 1)
5850aadb33SDmitri Tikhonov#endif
5950aadb33SDmitri Tikhonov
6083287402SDmitri Tikhonovstruct enc_session_funcs
6150aadb33SDmitri Tikhonov{
6283287402SDmitri Tikhonov    /* Global initialization: call once per implementation */
6383287402SDmitri Tikhonov    int (*esf_global_init)(int flags);
6450aadb33SDmitri Tikhonov
6583287402SDmitri Tikhonov    /* Global cleanup: call once per implementation */
6683287402SDmitri Tikhonov    void (*esf_global_cleanup) (void);
6750aadb33SDmitri Tikhonov
6850aadb33SDmitri Tikhonov#if LSQUIC_KEEP_ENC_SESS_HISTORY
6983287402SDmitri Tikhonov    /* Grab encryption session history */
7083287402SDmitri Tikhonov    void (*esf_get_hist) (const lsquic_enc_session_t *,
7183287402SDmitri Tikhonov                                            char buf[ESHIST_STR_SIZE]);
7250aadb33SDmitri Tikhonov#endif
7350aadb33SDmitri Tikhonov
7483287402SDmitri Tikhonov    /* Destroy enc session */
7583287402SDmitri Tikhonov    void (*esf_destroy)(lsquic_enc_session_t *enc_session);
7650aadb33SDmitri Tikhonov
7783287402SDmitri Tikhonov    /* Return true if handshake has been completed */
7883287402SDmitri Tikhonov    int (*esf_is_hsk_done)(lsquic_enc_session_t *enc_session);
7950aadb33SDmitri Tikhonov
8083287402SDmitri Tikhonov    /* Encrypt buffer */
8183287402SDmitri Tikhonov    int (*esf_encrypt)(lsquic_enc_session_t *enc_session, enum lsquic_version,
8250aadb33SDmitri Tikhonov               uint8_t path_id, uint64_t pack_num,
8350aadb33SDmitri Tikhonov               const unsigned char *header, size_t header_len,
8450aadb33SDmitri Tikhonov               const unsigned char *data, size_t data_len,
8550aadb33SDmitri Tikhonov               unsigned char *buf_out, size_t max_out_len, size_t *out_len,
8650aadb33SDmitri Tikhonov               int is_hello);
8750aadb33SDmitri Tikhonov
8883287402SDmitri Tikhonov    /* Decrypt buffer */
8983287402SDmitri Tikhonov    int (*esf_decrypt)(lsquic_enc_session_t *enc_session, enum lsquic_version,
9083287402SDmitri Tikhonov                   uint8_t path_id, uint64_t pack_num,
9183287402SDmitri Tikhonov                   unsigned char *buf, size_t *header_len, size_t data_len,
9283287402SDmitri Tikhonov                   unsigned char *diversification_nonce,
9383287402SDmitri Tikhonov                   unsigned char *buf_out, size_t max_out_len, size_t *out_len);
9483287402SDmitri Tikhonov
9583287402SDmitri Tikhonov    /* Get value of setting specified by `tag' */
9683287402SDmitri Tikhonov    int (*esf_get_peer_setting) (const lsquic_enc_session_t *, uint32_t tag,
9783287402SDmitri Tikhonov                                                                uint32_t *val);
9883287402SDmitri Tikhonov
9983287402SDmitri Tikhonov    /* Get value of peer option (that from COPT array) */
10083287402SDmitri Tikhonov    int (*esf_get_peer_option) (const lsquic_enc_session_t *enc_session,
10183287402SDmitri Tikhonov                                                                uint32_t tag);
10283287402SDmitri Tikhonov
10383287402SDmitri Tikhonov    /* Create client session */
10483287402SDmitri Tikhonov    lsquic_enc_session_t *
10583287402SDmitri Tikhonov    (*esf_create_client) (const char *domain, lsquic_cid_t cid,
10683287402SDmitri Tikhonov                                    const struct lsquic_engine_public *);
10750aadb33SDmitri Tikhonov
10883287402SDmitri Tikhonov    /* Generate connection ID */
10983287402SDmitri Tikhonov    lsquic_cid_t (*esf_generate_cid) (void);
11050aadb33SDmitri Tikhonov
11183287402SDmitri Tikhonov    /* -1 error, 0, OK, response in `buf' */
11283287402SDmitri Tikhonov    int
11383287402SDmitri Tikhonov    (*esf_gen_chlo) (lsquic_enc_session_t *, enum lsquic_version,
11483287402SDmitri Tikhonov                                                uint8_t *buf, size_t *len);
11583287402SDmitri Tikhonov
11683287402SDmitri Tikhonov    int
11783287402SDmitri Tikhonov    (*esf_handle_chlo_reply) (lsquic_enc_session_t *,
11883287402SDmitri Tikhonov                                                const uint8_t *data, int len);
11983287402SDmitri Tikhonov};
12050aadb33SDmitri Tikhonov
12183287402SDmitri Tikhonovextern
12250aadb33SDmitri Tikhonov#ifdef NDEBUG
12383287402SDmitri Tikhonovconst
12450aadb33SDmitri Tikhonov#endif
12583287402SDmitri Tikhonovstruct enc_session_funcs lsquic_enc_session_gquic_1;
12683287402SDmitri Tikhonov
12783287402SDmitri Tikhonov#define select_esf_by_ver(ver) \
12883287402SDmitri Tikhonov    (ver ? &lsquic_enc_session_gquic_1 : &lsquic_enc_session_gquic_1)
12983287402SDmitri Tikhonov
13083287402SDmitri Tikhonov/* client side, certs and hashs
13183287402SDmitri Tikhonov */
13283287402SDmitri Tikhonovtypedef struct cert_hash_item_st
13383287402SDmitri Tikhonov{
13483287402SDmitri Tikhonov    struct lsquic_str*   domain; /*with port, such as "xyz.com:8088" as the key */
13583287402SDmitri Tikhonov    struct lsquic_str*   crts;
13683287402SDmitri Tikhonov    struct lsquic_str*   hashs;
13783287402SDmitri Tikhonov    int         count;
13883287402SDmitri Tikhonov} cert_hash_item_t;
13950aadb33SDmitri Tikhonov
14050aadb33SDmitri Tikhonov#endif
141