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_rrec(rl)               ((rl)->rrec)
  22 #define RECORD_LAYER_set_packet(rl, p)          ((rl)->packet = (p))
  23 #define RECORD_LAYER_reset_packet_length(rl)    ((rl)->packet_length = 0)
  24 #define RECORD_LAYER_get_rstate(rl)             ((rl)->rstate)
  25 #define RECORD_LAYER_set_rstate(rl, st)         ((rl)->rstate = (st))
  26 #define RECORD_LAYER_get_read_sequence(rl)      ((rl)->read_sequence)
  27 #define RECORD_LAYER_get_write_sequence(rl)     ((rl)->write_sequence)
  28 #define RECORD_LAYER_get_numrpipes(rl)          ((rl)->numrpipes)
  29 #define RECORD_LAYER_set_numrpipes(rl, n)       ((rl)->numrpipes = (n))
  30 #define RECORD_LAYER_inc_empty_record_count(rl) ((rl)->empty_record_count++)
  31 #define RECORD_LAYER_reset_empty_record_count(rl) \
  32                                                 ((rl)->empty_record_count = 0)
  33 #define RECORD_LAYER_get_empty_record_count(rl) ((rl)->empty_record_count)
  34 #define RECORD_LAYER_is_first_record(rl)        ((rl)->is_first_record)
  35 #define RECORD_LAYER_set_first_record(rl)       ((rl)->is_first_record = 1)
  36 #define RECORD_LAYER_clear_first_record(rl)     ((rl)->is_first_record = 0)
  37 #define DTLS_RECORD_LAYER_get_r_epoch(rl)       ((rl)->d->r_epoch)
  38
  39 __owur int ssl3_read_n(SSL *s, size_t n, size_t max, int extend, int clearold,
  40                        size_t *readbytes);
  41
  42 DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr,
  43                                unsigned int *is_next_epoch);
  44 int dtls1_process_buffered_records(SSL *s);
  45 int dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue);
  46 int dtls1_buffer_record(SSL *s, record_pqueue *q, unsigned char *priority);
  47 void ssl3_record_sequence_update(unsigned char *seq);
  48
  49 /* Functions provided by the DTLS1_BITMAP component */
  50
  51 int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
  52 void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
  53
  54 /* Macros/functions provided by the SSL3_BUFFER component */
  55
  56 #define SSL3_BUFFER_get_buf(b)              ((b)->buf)
  57 #define SSL3_BUFFER_set_buf(b, n)           ((b)->buf = (n))
  58 #define SSL3_BUFFER_get_len(b)              ((b)->len)
  59 #define SSL3_BUFFER_set_len(b, l)           ((b)->len = (l))
  60 #define SSL3_BUFFER_get_left(b)             ((b)->left)
  61 #define SSL3_BUFFER_set_left(b, l)          ((b)->left = (l))
  62 #define SSL3_BUFFER_sub_left(b, l)          ((b)->left -= (l))
  63 #define SSL3_BUFFER_get_offset(b)           ((b)->offset)
  64 #define SSL3_BUFFER_set_offset(b, o)        ((b)->offset = (o))
  65 #define SSL3_BUFFER_add_offset(b, o)        ((b)->offset += (o))
  66 #define SSL3_BUFFER_is_initialised(b)       ((b)->buf != NULL)
  67 #define SSL3_BUFFER_set_default_len(b, l)   ((b)->default_len = (l))
  68 #define SSL3_BUFFER_set_app_buffer(b, l)    ((b)->app_buffer = (l))
  69 #define SSL3_BUFFER_is_app_buffer(b)        ((b)->app_buffer)
  70
  71 void SSL3_BUFFER_clear(SSL3_BUFFER *b);
  72 void SSL3_BUFFER_set_data(SSL3_BUFFER *b, const unsigned char *d, size_t n);
  73 void SSL3_BUFFER_release(SSL3_BUFFER *b);
  74 __owur int ssl3_setup_read_buffer(SSL *s);
  75 __owur int ssl3_setup_write_buffer(SSL *s, size_t numwpipes, size_t len);
  76 int ssl3_release_read_buffer(SSL *s);
  77 int ssl3_release_write_buffer(SSL *s);
  78
  79 /* Macros/functions provided by the SSL3_RECORD component */
  80
  81 #define SSL3_RECORD_get_type(r)                 ((r)->type)
  82 #define SSL3_RECORD_set_type(r, t)              ((r)->type = (t))
  83 #define SSL3_RECORD_set_rec_version(r, v)       ((r)->rec_version = (v))
  84 #define SSL3_RECORD_get_length(r)               ((r)->length)
  85 #define SSL3_RECORD_set_length(r, l)            ((r)->length = (l))
  86 #define SSL3_RECORD_add_length(r, l)            ((r)->length += (l))
  87 #define SSL3_RECORD_sub_length(r, l)            ((r)->length -= (l))
  88 #define SSL3_RECORD_get_data(r)                 ((r)->data)
  89 #define SSL3_RECORD_set_data(r, d)              ((r)->data = (d))
  90 #define SSL3_RECORD_get_input(r)                ((r)->input)
  91 #define SSL3_RECORD_set_input(r, i)             ((r)->input = (i))
  92 #define SSL3_RECORD_reset_input(r)              ((r)->input = (r)->data)
  93 #define SSL3_RECORD_reset_data(r)               ((r)->data = (r)->input)
  94 #define SSL3_RECORD_get_seq_num(r)              ((r)->seq_num)
  95 #define SSL3_RECORD_get_off(r)                  ((r)->off)
  96 #define SSL3_RECORD_set_off(r, o)               ((r)->off = (o))
  97 #define SSL3_RECORD_add_off(r, o)               ((r)->off += (o))
  98 #define SSL3_RECORD_get_epoch(r)                ((r)->epoch)
  99 #define SSL3_RECORD_is_sslv2_record(r) \
 100             ((r)->rec_version == SSL2_VERSION)
 101 #define SSL3_RECORD_is_read(r)                  ((r)->read)
 102 #define SSL3_RECORD_set_read(r)                 ((r)->read = 1)
 103
 104 void SSL3_RECORD_clear(SSL3_RECORD *r, size_t);
 105 void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs);
 106 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num);
 107 int ssl3_get_record(SSL *s);
 108 __owur int ssl3_do_compress(SSL *ssl, SSL3_RECORD *wr);
 109 __owur int ssl3_do_uncompress(SSL *ssl, SSL3_RECORD *rr);
 110 int ssl3_cbc_copy_mac(unsigned char *out,
 111                        const SSL3_RECORD *rec, size_t md_size);
 112 __owur int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
 113                                    size_t block_size, size_t mac_size);
 114 __owur int tls1_cbc_remove_padding(const SSL *s,
 115                                    SSL3_RECORD *rec,
 116                                    size_t block_size, size_t mac_size);
 117 int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap);
 118 __owur int dtls1_get_record(SSL *s);
 119 int early_data_count_ok(SSL *s, size_t length, size_t overhead, int send);