ssl/record/record_local.h

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*****************************************************************************
  11  *                                                                           *
  12  * The following macros/functions are PRIVATE to the record layer. They      *
  13  * should NOT be used outside of the record layer.                           *
  14  *                                                                           *
  15  *****************************************************************************/
  16
  17 #define MAX_WARN_ALERT_COUNT    5
  18
  19 /* Functions/macros provided by the RECORD_LAYER component */
  20
  21 #define RECORD_LAYER_get_write_sequence(rl)     ((rl)->write_sequence)
  22 #define RECORD_LAYER_inc_empty_record_count(rl) ((rl)->empty_record_count++)
  23 #define RECORD_LAYER_reset_empty_record_count(rl) \
  24                                                 ((rl)->empty_record_count = 0)
  25 #define RECORD_LAYER_get_empty_record_count(rl) ((rl)->empty_record_count)
  26 #define DTLS_RECORD_LAYER_get_r_epoch(rl)       ((rl)->d->r_epoch)
  27
  28 int dtls_buffer_record(SSL_CONNECTION *s, TLS_RECORD *rec);
  29 void ssl3_record_sequence_update(unsigned char *seq);
  30
  31 /* Macros/functions provided by the SSL3_BUFFER component */
  32
  33 #define SSL3_BUFFER_get_buf(b)              ((b)->buf)
  34 #define SSL3_BUFFER_set_buf(b, n)           ((b)->buf = (n))
  35 #define SSL3_BUFFER_get_len(b)              ((b)->len)
  36 #define SSL3_BUFFER_set_len(b, l)           ((b)->len = (l))
  37 #define SSL3_BUFFER_get_left(b)             ((b)->left)
  38 #define SSL3_BUFFER_set_left(b, l)          ((b)->left = (l))
  39 #define SSL3_BUFFER_sub_left(b, l)          ((b)->left -= (l))
  40 #define SSL3_BUFFER_get_offset(b)           ((b)->offset)
  41 #define SSL3_BUFFER_set_offset(b, o)        ((b)->offset = (o))
  42 #define SSL3_BUFFER_add_offset(b, o)        ((b)->offset += (o))
  43 #define SSL3_BUFFER_is_initialised(b)       ((b)->buf != NULL)
  44 #define SSL3_BUFFER_set_default_len(b, l)   ((b)->default_len = (l))
  45 #define SSL3_BUFFER_set_app_buffer(b, l)    ((b)->app_buffer = (l))
  46 #define SSL3_BUFFER_is_app_buffer(b)        ((b)->app_buffer)
  47
  48 void SSL3_BUFFER_clear(SSL3_BUFFER *b);
  49 void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, size_t n);
  50 void SSL3_BUFFER_release(SSL3_BUFFER *b);
  51 __owur int ssl3_setup_write_buffer(SSL_CONNECTION *s, size_t numwpipes,
  52                                    size_t len);
  53 int ssl3_release_write_buffer(SSL_CONNECTION *s);
  54
  55 /* Macros/functions provided by the SSL3_RECORD component */
  56
  57 #define SSL3_RECORD_get_type(r)                 ((r)->type)
  58 #define SSL3_RECORD_set_type(r, t)              ((r)->type = (t))
  59 #define SSL3_RECORD_set_rec_version(r, v)       ((r)->rec_version = (v))
  60 #define SSL3_RECORD_get_length(r)               ((r)->length)
  61 #define SSL3_RECORD_set_length(r, l)            ((r)->length = (l))
  62 #define SSL3_RECORD_add_length(r, l)            ((r)->length += (l))
  63 #define SSL3_RECORD_sub_length(r, l)            ((r)->length -= (l))
  64 #define SSL3_RECORD_get_data(r)                 ((r)->data)
  65 #define SSL3_RECORD_set_data(r, d)              ((r)->data = (d))
  66 #define SSL3_RECORD_get_input(r)                ((r)->input)
  67 #define SSL3_RECORD_set_input(r, i)             ((r)->input = (i))
  68 #define SSL3_RECORD_reset_input(r)              ((r)->input = (r)->data)
  69 #define SSL3_RECORD_reset_data(r)               ((r)->data = (r)->input)
  70 #define SSL3_RECORD_get_seq_num(r)              ((r)->seq_num)
  71 #define SSL3_RECORD_get_off(r)                  ((r)->off)
  72 #define SSL3_RECORD_set_off(r, o)               ((r)->off = (o))
  73 #define SSL3_RECORD_add_off(r, o)               ((r)->off += (o))
  74 #define SSL3_RECORD_get_epoch(r)                ((r)->epoch)
  75
  76 void SSL3_RECORD_clear(SSL3_RECORD *r, size_t);
  77 void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs);
  78 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num);
  79 __owur int ssl3_do_compress(SSL_CONNECTION *ssl, SSL3_RECORD *wr);
  80 __owur int ssl3_do_uncompress(SSL_CONNECTION *ssl, SSL3_RECORD *rr);
  81 __owur int ssl3_cbc_remove_padding_and_mac(size_t *reclen,
  82                                            size_t origreclen,
  83                                            unsigned char *recdata,
  84                                            unsigned char **mac,
  85                                            int *alloced,
  86                                            size_t block_size, size_t mac_size,
  87                                            OSSL_LIB_CTX *libctx);
  88 __owur int tls1_cbc_remove_padding_and_mac(size_t *reclen,
  89                                            size_t origreclen,
  90                                            unsigned char *recdata,
  91                                            unsigned char **mac,
  92                                            int *alloced,
  93                                            size_t block_size, size_t mac_size,
  94                                            int aead,
  95                                            OSSL_LIB_CTX *libctx);
  96 uint32_t ossl_get_max_early_data(SSL_CONNECTION *s);
  97 int ossl_early_data_count_ok(SSL_CONNECTION *s, size_t length, size_t overhead,
  98                              int send);