xref: /openbsd/lib/libcrypto/bio/bio_local.h (revision 8bb5c4c3)
1 /* $OpenBSD: bio_local.h,v 1.6 2024/03/02 09:18:28 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #ifndef HEADER_BIO_LOCAL_H
60 #define HEADER_BIO_LOCAL_H
61 
62 #include <stdarg.h>
63 
64 __BEGIN_HIDDEN_DECLS
65 
66 struct bio_method_st {
67 	int type;
68 	const char *name;
69 	int (*bwrite)(BIO *, const char *, int);
70 	int (*bread)(BIO *, char *, int);
71 	int (*bputs)(BIO *, const char *);
72 	int (*bgets)(BIO *, char *, int);
73 	long (*ctrl)(BIO *, int, long, void *);
74 	int (*create)(BIO *);
75 	int (*destroy)(BIO *);
76 	long (*callback_ctrl)(BIO *, int, BIO_info_cb *);
77 } /* BIO_METHOD */;
78 
79 struct bio_st {
80 	const BIO_METHOD *method;
81 	BIO_callback_fn callback;
82 	BIO_callback_fn_ex callback_ex;
83 	char *cb_arg; /* first argument for the callback */
84 
85 	int init;
86 	int shutdown;
87 	int flags;	/* extra storage */
88 	int retry_reason;
89 	int num;
90 	void *ptr;
91 	struct bio_st *next_bio;	/* used by filter BIOs */
92 	struct bio_st *prev_bio;	/* used by filter BIOs */
93 	int references;
94 	unsigned long num_read;
95 	unsigned long num_write;
96 
97 	CRYPTO_EX_DATA ex_data;
98 } /* BIO */;
99 
100 typedef struct bio_f_buffer_ctx_struct {
101 	/* Buffers are setup like this:
102 	 *
103 	 * <---------------------- size ----------------------->
104 	 * +---------------------------------------------------+
105 	 * | consumed | remaining          | free space        |
106 	 * +---------------------------------------------------+
107 	 * <-- off --><------- len ------->
108 	 */
109 
110 	/* BIO *bio; */ /* this is now in the BIO struct */
111 	int ibuf_size;	/* how big is the input buffer */
112 	int obuf_size;	/* how big is the output buffer */
113 
114 	char *ibuf;	/* the char array */
115 	int ibuf_len;	/* how many bytes are in it */
116 	int ibuf_off;	/* write/read offset */
117 
118 	char *obuf;	/* the char array */
119 	int obuf_len;	/* how many bytes are in it */
120 	int obuf_off;	/* write/read offset */
121 } BIO_F_BUFFER_CTX;
122 
123 int BIO_vprintf(BIO *bio, const char *format, va_list args);
124 
125 __END_HIDDEN_DECLS
126 
127 #endif /* !HEADER_BIO_LOCAL_H */
128