Sanity check provider up-calls
[openssl.git] / include / internal / bio.h
1 /*
2  * Copyright 2016-2021 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 #ifndef OSSL_INTERNAL_BIO_H
11 # define OSSL_INTERNAL_BIO_H
12 # pragma once
13
14 # include <openssl/core.h>
15 # include <openssl/bio.h>
16
17 struct bio_method_st {
18     int type;
19     char *name;
20     int (*bwrite) (BIO *, const char *, size_t, size_t *);
21     int (*bwrite_old) (BIO *, const char *, int);
22     int (*bread) (BIO *, char *, size_t, size_t *);
23     int (*bread_old) (BIO *, char *, int);
24     int (*bputs) (BIO *, const char *);
25     int (*bgets) (BIO *, char *, int);
26     long (*ctrl) (BIO *, int, long, void *);
27     int (*create) (BIO *);
28     int (*destroy) (BIO *);
29     long (*callback_ctrl) (BIO *, int, BIO_info_cb *);
30 };
31
32 void bio_free_ex_data(BIO *bio);
33 void bio_cleanup(void);
34
35
36 /* Old style to new style BIO_METHOD conversion functions */
37 int bwrite_conv(BIO *bio, const char *data, size_t datal, size_t *written);
38 int bread_conv(BIO *bio, char *data, size_t datal, size_t *read);
39
40 /* Changes to these internal BIOs must also update include/openssl/bio.h */
41 # define BIO_CTRL_SET_KTLS                      72
42 # define BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG     74
43 # define BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG        75
44
45 /*
46  * This is used with socket BIOs:
47  * BIO_FLAGS_KTLS_TX means we are using ktls with this BIO for sending.
48  * BIO_FLAGS_KTLS_TX_CTRL_MSG means we are about to send a ctrl message next.
49  * BIO_FLAGS_KTLS_RX means we are using ktls with this BIO for receiving.
50  */
51 # define BIO_FLAGS_KTLS_TX          0x800
52 # define BIO_FLAGS_KTLS_TX_CTRL_MSG 0x1000
53 # define BIO_FLAGS_KTLS_RX          0x2000
54
55 /* KTLS related controls and flags */
56 # define BIO_set_ktls_flag(b, is_tx) \
57     BIO_set_flags(b, (is_tx) ? BIO_FLAGS_KTLS_TX : BIO_FLAGS_KTLS_RX)
58 # define BIO_should_ktls_flag(b, is_tx) \
59     BIO_test_flags(b, (is_tx) ? BIO_FLAGS_KTLS_TX : BIO_FLAGS_KTLS_RX)
60 # define BIO_set_ktls_ctrl_msg_flag(b) \
61     BIO_set_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
62 # define BIO_should_ktls_ctrl_msg_flag(b) \
63     BIO_test_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
64 # define BIO_clear_ktls_ctrl_msg_flag(b) \
65     BIO_clear_flags(b, BIO_FLAGS_KTLS_TX_CTRL_MSG)
66
67 # define BIO_set_ktls(b, keyblob, is_tx)   \
68      BIO_ctrl(b, BIO_CTRL_SET_KTLS, is_tx, keyblob)
69 # define BIO_set_ktls_ctrl_msg(b, record_type)   \
70      BIO_ctrl(b, BIO_CTRL_SET_KTLS_TX_SEND_CTRL_MSG, record_type, NULL)
71 # define BIO_clear_ktls_ctrl_msg(b) \
72      BIO_ctrl(b, BIO_CTRL_CLEAR_KTLS_TX_CTRL_MSG, 0, NULL)
73
74 /* Functions to allow the core to offer the CORE_BIO type to providers */
75 OSSL_CORE_BIO *ossl_core_bio_new_from_bio(BIO *bio);
76 OSSL_CORE_BIO *ossl_core_bio_new_file(const char *filename, const char *mode);
77 OSSL_CORE_BIO *ossl_core_bio_new_mem_buf(const void *buf, int len);
78 int ossl_core_bio_read_ex(OSSL_CORE_BIO *cb, void *data, size_t dlen,
79                           size_t *readbytes);
80 int ossl_core_bio_write_ex(OSSL_CORE_BIO *cb, const void *data, size_t dlen,
81                            size_t *written);
82 int ossl_core_bio_gets(OSSL_CORE_BIO *cb, char *buf, int size);
83 int ossl_core_bio_puts(OSSL_CORE_BIO *cb, const char *buf);
84 long ossl_core_bio_ctrl(OSSL_CORE_BIO *cb, int cmd, long larg, void *parg);
85 int ossl_core_bio_up_ref(OSSL_CORE_BIO *cb);
86 int ossl_core_bio_free(OSSL_CORE_BIO *cb);
87 int ossl_core_bio_vprintf(OSSL_CORE_BIO *cb, const char *format, va_list args);
88
89 #endif