Debian Codegraph @

external/boringssl/include/openssl/bio.h

raw
1 /* Copyright (C) 1995-1998 Eric Young ([email protected])
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young ([email protected]).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson ([email protected]).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young ([email protected])"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson ([email protected])"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.] */
56
57 #ifndef OPENSSL_HEADER_BIO_H
58 #define OPENSSL_HEADER_BIO_H
59
60 #include <openssl/base.h>
61
62 #include <stdio.h> /* For FILE */
63
64 #include <openssl/buffer.h>
65 #include <openssl/err.h> /* for ERR_print_errors_fp */
66 #include <openssl/ex_data.h>
67 #include <openssl/stack.h>
68 #include <openssl/thread.h>
69
70 #if defined(__cplusplus)
71 extern "C" {
72 #endif
73
74
75 /* BIO abstracts over a file-descriptor like interface. */
76
77
78 /* Allocation and freeing. */
79
80 /* BIO_new creates a new BIO with the given type and a reference count of one.
81 * It returns the fresh |BIO|, or NULL on error. */
82 OPENSSL_EXPORT BIO *BIO_new(const BIO_METHOD *type);
83
84 /* BIO_free decrements the reference count of |bio|. If the reference count
85 * drops to zero, it (optionally) calls the BIO's callback with |BIO_CB_FREE|,
86 * frees the ex_data and then, if the BIO has a destroy callback for the
87 * method, calls it. Finally it frees |bio| itself. It then repeats that for
88 * the next BIO in the chain, if any.
89 *
90 * It returns one on success or zero otherwise. */
91 OPENSSL_EXPORT int BIO_free(BIO *bio);
92
93 /* BIO_vfree performs the same actions as |BIO_free|, but has a void return
94 * value. This is provided for API-compat.
95 *
96 * TODO(fork): remove. */
97 OPENSSL_EXPORT void BIO_vfree(BIO *bio);
98
99 /* BIO_up_ref increments the reference count of |bio| and returns it. */
100 OPENSSL_EXPORT BIO *BIO_up_ref(BIO *bio);
101
102
103 /* Basic I/O. */
104
105 /* BIO_read attempts to read |len| bytes into |data|. It returns the number of
106 * bytes read, zero on EOF, or a negative number on error. */
107 OPENSSL_EXPORT int BIO_read(BIO *bio, void *data, int len);
108
109 /* BIO_gets "reads a line" from |bio| and puts at most |size| bytes into |buf|.
110 * It returns the number of bytes read or a negative number on error. The
111 * phrase "reads a line" is in quotes in the previous sentence because the
112 * exact operation depends on the BIO's method. For example, a digest BIO will
113 * return the digest in response to a |BIO_gets| call.
114 *
115 * TODO(fork): audit the set of BIOs that we end up needing. If all actually
116 * return a line for this call, remove the warning above. */
117 OPENSSL_EXPORT int BIO_gets(BIO *bio, char *buf, int size);
118
119 /* BIO_write writes |len| bytes from |data| to BIO. It returns the number of
120 * bytes written or a negative number on error. */
121 OPENSSL_EXPORT int BIO_write(BIO *bio, const void *data, int len);
122
123 /* BIO_puts writes a NUL terminated string from |buf| to |bio|. It returns the
124 * number of bytes written or a negative number on error. */
125 OPENSSL_EXPORT int BIO_puts(BIO *bio, const char *buf);
126
127 /* BIO_flush flushes any buffered output. It returns one on success and zero
128 * otherwise. */
129 OPENSSL_EXPORT int BIO_flush(BIO *bio);
130
131
132 /* Low-level control functions.
133 *
134 * These are generic functions for sending control requests to a BIO. In
135 * general one should use the wrapper functions like |BIO_get_close|. */
136
137 /* BIO_ctrl sends the control request |cmd| to |bio|. The |cmd| argument should
138 * be one of the |BIO_C_*| values. */
139 OPENSSL_EXPORT long BIO_ctrl(BIO *bio, int cmd, long larg, void *parg);
140
141 /* BIO_ptr_ctrl acts like |BIO_ctrl| but passes the address of a |void*|
142 * pointer as |parg| and returns the value that is written to it, or NULL if
143 * the control request returns <= 0. */
144 OPENSSL_EXPORT char *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
145
146 /* BIO_int_ctrl acts like |BIO_ctrl| but passes the address of a copy of |iarg|
147 * as |parg|. */
148 OPENSSL_EXPORT long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
149
150 /* BIO_reset resets |bio| to its initial state, the precise meaning of which
151 * depends on the concrete type of |bio|. It returns one on success and zero
152 * otherwise. */
153 OPENSSL_EXPORT int BIO_reset(BIO *bio);
154
155 /* BIO_set_flags ORs |flags| with |bio->flags|. */
156 OPENSSL_EXPORT void BIO_set_flags(BIO *bio, int flags);
157
158 /* BIO_test_flags returns |bio->flags| AND |flags|. */
159 OPENSSL_EXPORT int BIO_test_flags(const BIO *bio, int flags);
160
161 /* BIO_should_read returns non-zero if |bio| encountered a temporary error
162 * while reading (i.e. EAGAIN), indicating that the caller should retry the
163 * read. */
164 OPENSSL_EXPORT int BIO_should_read(const BIO *bio);
165
166 /* BIO_should_write returns non-zero if |bio| encountered a temporary error
167 * while writing (i.e. EAGAIN), indicating that the caller should retry the
168 * write. */
169 OPENSSL_EXPORT int BIO_should_write(const BIO *bio);
170
171 /* BIO_should_retry returns non-zero if the reason that caused a failed I/O
172 * operation is temporary and thus the operation should be retried. Otherwise,
173 * it was a permanent error and it returns zero. */
174 OPENSSL_EXPORT int BIO_should_retry(const BIO *bio);
175
176 /* BIO_should_io_special returns non-zero if |bio| encountered a temporary
177 * error while performing a special I/O operation, indicating that the caller
178 * should retry. The operation that caused the error is returned by
179 * |BIO_get_retry_reason|. */
180 OPENSSL_EXPORT int BIO_should_io_special(const BIO *bio);
181
182 /* BIO_RR_SSL_X509_LOOKUP indicates that an SSL BIO blocked because the SSL
183 * library returned with SSL_ERROR_WANT_X509_LOOKUP.
184 *
185 * TODO(fork): remove. */
186 #define BIO_RR_SSL_X509_LOOKUP 0x01
187
188 /* BIO_RR_CONNECT indicates that a connect would have blocked */
189 #define BIO_RR_CONNECT 0x02
190
191 /* BIO_RR_ACCEPT indicates that an accept would have blocked */
192 #define BIO_RR_ACCEPT 0x03
193
194 /* BIO_RR_SSL_CHANNEL_ID_LOOKUP indicates that the ChannelID code cannot find
195 * a private key for a TLS connection. */
196 #define BIO_RR_SSL_CHANNEL_ID_LOOKUP 0x04
197
198 /* BIO_get_retry_reason returns the special I/O operation that needs to be
199 * retried. The return value is one of the |BIO_RR_*| values. */
200 OPENSSL_EXPORT int BIO_get_retry_reason(const BIO *bio);
201
202 /* BIO_clear_flags ANDs |bio->flags| with the bitwise-complement of |flags|. */
203 OPENSSL_EXPORT void BIO_clear_flags(BIO *bio, int flags);
204
205 /* BIO_set_retry_read sets the |BIO_FLAGS_READ| and |BIO_FLAGS_SHOULD_RETRY|
206 * flags on |bio|. */
207 OPENSSL_EXPORT void BIO_set_retry_read(BIO *bio);
208
209 /* BIO_set_retry_write sets the |BIO_FLAGS_WRITE| and |BIO_FLAGS_SHOULD_RETRY|
210 * flags on |bio|. */
211 OPENSSL_EXPORT void BIO_set_retry_write(BIO *bio);
212
213 /* BIO_get_retry_flags gets the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|,
214 * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */
215 OPENSSL_EXPORT int BIO_get_retry_flags(BIO *bio);
216
217 /* BIO_clear_retry_flags clears the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|,
218 * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */
219 OPENSSL_EXPORT void BIO_clear_retry_flags(BIO *bio);
220
221 /* BIO_method_type returns the type of |bio|, which is one of the |BIO_TYPE_*|
222 * values. */
223 OPENSSL_EXPORT int BIO_method_type(const BIO *bio);
224
225 /* bio_info_cb is the type of a callback function that can be called for most
226 * BIO operations. The |event| argument is one of |BIO_CB_*| and can be ORed
227 * with |BIO_CB_RETURN| if the callback is being made after the operation in
228 * question. In that case, |return_value| will contain the return value from
229 * the operation. */
230 typedef long (*bio_info_cb)(BIO *bio, int event, const char *parg, int cmd,
231 long larg, long return_value);
232
233 /* BIO_callback_ctrl allows the callback function to be manipulated. The |cmd|
234 * arg will generally be |BIO_CTRL_SET_CALLBACK| but arbitary command values
235 * can be interpreted by the |BIO|. */
236 OPENSSL_EXPORT long BIO_callback_ctrl(BIO *bio, int cmd, bio_info_cb fp);
237
238 /* BIO_pending returns the number of bytes pending to be read. */
239 OPENSSL_EXPORT size_t BIO_pending(const BIO *bio);
240
241 /* BIO_ctrl_pending calls |BIO_pending| and exists only for compatibility with
242 * OpenSSL. */
243 OPENSSL_EXPORT size_t BIO_ctrl_pending(const BIO *bio);
244
245 /* BIO_wpending returns the number of bytes pending to be written. */
246 OPENSSL_EXPORT size_t BIO_wpending(const BIO *bio);
247
248 /* BIO_set_close sets the close flag for |bio|. The meaning of which depends on
249 * the type of |bio| but, for example, a memory BIO interprets the close flag
250 * as meaning that it owns its buffer. It returns one on success and zero
251 * otherwise. */
252 OPENSSL_EXPORT int BIO_set_close(BIO *bio, int close_flag);
253
254 /* BIO_set_callback sets a callback function that will be called before and
255 * after most operations. See the comment above |bio_info_cb|. */
256 OPENSSL_EXPORT void BIO_set_callback(BIO *bio, bio_info_cb callback_func);
257
258 /* BIO_set_callback_arg sets the opaque pointer value that can be read within a
259 * callback with |BIO_get_callback_arg|. */
260 OPENSSL_EXPORT void BIO_set_callback_arg(BIO *bio, char *arg);
261
262 /* BIO_get_callback_arg returns the last value of the opaque callback pointer
263 * set by |BIO_set_callback_arg|. */
264 OPENSSL_EXPORT char *BIO_get_callback_arg(const BIO *bio);
265
266 /* BIO_number_read returns the number of bytes that have been read from
267 * |bio|. */
268 OPENSSL_EXPORT size_t BIO_number_read(const BIO *bio);
269
270 /* BIO_number_written returns the number of bytes that have been written to
271 * |bio|. */
272 OPENSSL_EXPORT size_t BIO_number_written(const BIO *bio);
273
274
275 /* Managing chains of BIOs.
276 *
277 * BIOs can be put into chains where the output of one is used as the input of
278 * the next etc. The most common case is a buffering BIO, which accepts and
279 * buffers writes until flushed into the next BIO in the chain. */
280
281 /* BIO_push adds |appended_bio| to the end of the chain with |bio| at the head.
282 * It returns |bio|. Note that |appended_bio| may be the head of a chain itself
283 * and thus this function can be used to join two chains.
284 *
285 * BIO_push takes ownership of the caller's reference to |appended_bio|. */
286 OPENSSL_EXPORT BIO *BIO_push(BIO *bio, BIO *appended_bio);
287
288 /* BIO_pop removes |bio| from the head of a chain and returns the next BIO in
289 * the chain, or NULL if there is no next BIO.
290 *
291 * The caller takes ownership of the chain's reference to |bio|. */
292 OPENSSL_EXPORT BIO *BIO_pop(BIO *bio);
293
294 /* BIO_next returns the next BIO in the chain after |bio|, or NULL if there is
295 * no such BIO. */
296 OPENSSL_EXPORT BIO *BIO_next(BIO *bio);
297
298 /* BIO_free_all calls |BIO_free|.
299 *
300 * TODO(fork): update callers and remove. */
301 OPENSSL_EXPORT void BIO_free_all(BIO *bio);
302
303 /* BIO_find_type walks a chain of BIOs and returns the first that matches
304 * |type|, which is one of the |BIO_TYPE_*| values. */
305 OPENSSL_EXPORT BIO *BIO_find_type(BIO *bio, int type);
306
307 /* BIO_copy_next_retry sets the retry flags and |retry_reason| of |bio| from
308 * the next BIO in the chain. */
309 OPENSSL_EXPORT void BIO_copy_next_retry(BIO *bio);
310
311
312 /* Printf functions. */
313
314 /* BIO_printf behaves like |printf| but outputs to |bio| rather than a |FILE|.
315 * It returns the number of bytes written or a negative number on error. */
316 OPENSSL_EXPORT int BIO_printf(BIO *bio, const char *format, ...)
317 OPENSSL_PRINTF_FORMAT_FUNC(2, 3);
318
319
320 /* Utility functions. */
321
322 /* BIO_indent prints min(|indent|, |max_indent|) spaces. It returns one on
323 * success and zero otherwise. */
324 OPENSSL_EXPORT int BIO_indent(BIO *bio, unsigned indent, unsigned max_indent);
325
326 /* BIO_hexdump writes a hex dump of |data| to |bio|. Each line will be indented
327 * by |indent| spaces. */
328 OPENSSL_EXPORT int BIO_hexdump(BIO *bio, const uint8_t *data, size_t len,
329 unsigned indent);
330
331 /* BIO_print_errors prints the current contents of the error stack to |bio|
332 * using human readable strings where possible. */
333 OPENSSL_EXPORT void BIO_print_errors(BIO *bio);
334
335 /* BIO_read_asn1 reads a single ASN.1 object from |bio|. If successful it sets
336 * |*out| to be an allocated buffer (that should be freed with |OPENSSL_free|),
337 * |*out_size| to the length, in bytes, of that buffer and returns one.
338 * Otherwise it returns zero.
339 *
340 * If the length of the object is greater than |max_len| or 2^32 then the
341 * function will fail. Long-form tags are not supported. If the length of the
342 * object is indefinite the full contents of |bio| are read, unless it would be
343 * greater than |max_len|, in which case the function fails.
344 *
345 * If the function fails then some unknown amount of data may have been read
346 * from |bio|. */
347 OPENSSL_EXPORT int BIO_read_asn1(BIO *bio, uint8_t **out, size_t *out_len,
348 size_t max_len);
349
350
351 /* Memory BIOs.
352 *
353 * Memory BIOs can be used as a read-only source (with |BIO_new_mem_buf|) or a
354 * writable sink (with |BIO_new|, |BIO_s_mem| and |BIO_get_mem_buf|). Data
355 * written to a writable, memory BIO can be recalled by reading from it.
356 *
357 * Calling |BIO_reset| on a read-only BIO resets it to the original contents.
358 * On a writable BIO, it clears any data.
359 *
360 * If the close flag is set to |BIO_NOCLOSE| (not the default) then the
361 * underlying |BUF_MEM| will not be freed when the |BIO| is freed.
362 *
363 * Memory BIOs support |BIO_gets| and |BIO_puts|.
364 *
365 * |BIO_ctrl_pending| returns the number of bytes currently stored. */
366
367 /* BIO_s_mem returns a |BIO_METHOD| that uses a in-memory buffer. */
368 OPENSSL_EXPORT const BIO_METHOD *BIO_s_mem(void);
369
370 /* BIO_new_mem_buf creates read-only BIO that reads from |len| bytes at |buf|.
371 * It does not take ownership of |buf|. It returns the BIO or NULL on error.
372 *
373 * If |len| is negative, then |buf| is treated as a NUL-terminated string, but
374 * don't depend on this in new code. */
375 OPENSSL_EXPORT BIO *BIO_new_mem_buf(const void *buf, int len);
376
377 /* BIO_mem_contents sets |*out_contents| to point to the current contents of
378 * |bio| and |*out_len| to contain the length of that data. It returns one on
379 * success and zero otherwise. */
380 OPENSSL_EXPORT int BIO_mem_contents(const BIO *bio,
381 const uint8_t **out_contents,
382 size_t *out_len);
383
384 /* BIO_get_mem_data sets |*contents| to point to the current contents of |bio|
385 * and returns the length of the data.
386 *
387 * WARNING: don't use this, use |BIO_mem_contents|. A return value of zero from
388 * this function can mean either that it failed or that the memory buffer is
389 * empty. */
390 OPENSSL_EXPORT long BIO_get_mem_data(BIO *bio, char **contents);
391
392 /* BIO_get_mem_ptr sets |*out| to a BUF_MEM containing the current contents of
393 * |bio|. It returns one on success or zero on error. */
394 OPENSSL_EXPORT int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out);
395
396 /* BIO_set_mem_buf sets |b| as the contents of |bio|. If |take_ownership| is
397 * non-zero, then |b| will be freed when |bio| is closed. Returns one on
398 * success or zero otherwise. */
399 OPENSSL_EXPORT int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership);
400
401 /* BIO_set_mem_eof_return sets the value that will be returned from reading
402 * |bio| when empty. If |eof_value| is zero then an empty memory BIO will
403 * return EOF (that is it will return zero and |BIO_should_retry| will be
404 * false). If |eof_value| is non zero then it will return |eof_value| when it
405 * is empty and it will set the read retry flag (that is |BIO_read_retry| is
406 * true). To avoid ambiguity with a normal positive return value, |eof_value|
407 * should be set to a negative value, typically -1.
408 *
409 * For a read-only BIO, the default is zero (EOF). For a writable BIO, the
410 * default is -1 so that additional data can be written once exhausted. */
411 OPENSSL_EXPORT int BIO_set_mem_eof_return(BIO *bio, int eof_value);
412
413
414 /* File descriptor BIOs.
415 *
416 * File descriptor BIOs are wrappers around the system's |read| and |write|
417 * functions. If the close flag is set then then |close| is called on the
418 * underlying file descriptor when the BIO is freed.
419 *
420 * |BIO_reset| attempts to seek the file pointer to the start of file using
421 * |lseek|. */
422
423 /* BIO_s_fd returns a |BIO_METHOD| for file descriptor fds. */
424 OPENSSL_EXPORT const BIO_METHOD *BIO_s_fd(void);
425
426 /* BIO_new_fd creates a new file descriptor BIO wrapping |fd|. If |close_flag|
427 * is non-zero, then |fd| will be closed when the BIO is. */
428 OPENSSL_EXPORT BIO *BIO_new_fd(int fd, int close_flag);
429
430 /* BIO_set_fd sets the file descriptor of |bio| to |fd|. If |close_flag| is
431 * non-zero then |fd| will be closed when |bio| is. It returns one on success
432 * or zero on error.
433 *
434 * This function may also be used with socket BIOs (see |BIO_s_socket| and
435 * |BIO_new_socket|). */
436 OPENSSL_EXPORT int BIO_set_fd(BIO *bio, int fd, int close_flag);
437
438 /* BIO_get_fd returns the file descriptor currently in use by |bio| or -1 if
439 * |bio| does not wrap a file descriptor. If there is a file descriptor and
440 * |out_fd| is not NULL, it also sets |*out_fd| to the file descriptor.
441 *
442 * This function may also be used with socket BIOs (see |BIO_s_socket| and
443 * |BIO_new_socket|). */
444 OPENSSL_EXPORT int BIO_get_fd(BIO *bio, int *out_fd);
445
446
447 /* File BIOs.
448 *
449 * File BIOs are wrappers around a C |FILE| object.
450 *
451 * |BIO_flush| on a file BIO calls |fflush| on the wrapped stream.
452 *
453 * |BIO_reset| attempts to seek the file pointer to the start of file using
454 * |fseek|.
455 *
456 * Setting the close flag causes |fclose| to be called on the stream when the
457 * BIO is freed. */
458
459 /* BIO_s_file returns a BIO_METHOD that wraps a |FILE|. */
460 OPENSSL_EXPORT const BIO_METHOD *BIO_s_file(void);
461
462 /* BIO_new_file creates a file BIO by opening |filename| with the given mode.
463 * See the |fopen| manual page for details of the mode argument. */
464 OPENSSL_EXPORT BIO *BIO_new_file(const char *filename, const char *mode);
465
466 /* BIO_new_fp creates a new file BIO that wraps the given |FILE|. If
467 * |close_flag| is |BIO_CLOSE|, then |fclose| will be called on |stream| when
468 * the BIO is closed. */
469 OPENSSL_EXPORT BIO *BIO_new_fp(FILE *stream, int close_flag);
470
471 /* BIO_get_fp sets |*out_file| to the current |FILE| for |bio|. It returns one
472 * on success and zero otherwise. */
473 OPENSSL_EXPORT int BIO_get_fp(BIO *bio, FILE **out_file);
474
475 /* BIO_set_fp sets the |FILE| for |bio|. If |close_flag| is |BIO_CLOSE| then
476 * |fclose| will be called on |file| when |bio| is closed. It returns one on
477 * sucess and zero otherwise. */
478 OPENSSL_EXPORT int BIO_set_fp(BIO *bio, FILE *file, int close_flag);
479
480 /* BIO_read_filename opens |filename| for reading and sets the result as the
481 * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE|
482 * will be closed when |bio| is freed. */
483 OPENSSL_EXPORT int BIO_read_filename(BIO *bio, const char *filename);
484
485 /* BIO_write_filename opens |filename| for writing and sets the result as the
486 * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE|
487 * will be closed when |bio| is freed. */
488 OPENSSL_EXPORT int BIO_write_filename(BIO *bio, const char *filename);
489
490 /* BIO_append_filename opens |filename| for appending and sets the result as
491 * the |FILE| for |bio|. It returns one on success and zero otherwise. The
492 * |FILE| will be closed when |bio| is freed. */
493 OPENSSL_EXPORT int BIO_append_filename(BIO *bio, const char *filename);
494
495 /* BIO_rw_filename opens |filename| for reading and writing and sets the result
496 * as the |FILE| for |bio|. It returns one on success and zero otherwise. The
497 * |FILE| will be closed when |bio| is freed. */
498 OPENSSL_EXPORT int BIO_rw_filename(BIO *bio, const char *filename);
499
500
501 /* Buffer BIOs.
502 *
503 * Buffer BIOs are a filter-type BIO, i.e. they are designed to be used in a
504 * chain of BIOs. They provide buffering to reduce the number of operations on
505 * the underlying BIOs. */
506
507 OPENSSL_EXPORT const BIO_METHOD *BIO_f_buffer(void);
508
509 /* BIO_set_read_buffer_size sets the size, in bytes, of the read buffer and
510 * clears it. It returns one on success and zero on failure. */
511 OPENSSL_EXPORT int BIO_set_read_buffer_size(BIO *bio, int buffer_size);
512
513 /* BIO_set_write_buffer_size sets the size, in bytes, of the write buffer and
514 * clears it. It returns one on success and zero on failure. */
515 OPENSSL_EXPORT int BIO_set_write_buffer_size(BIO *bio, int buffer_size);
516
517
518 /* Socket BIOs.
519 *
520 * Socket BIOs behave like file descriptor BIOs but, on Windows systems, wrap
521 * the system's |recv| and |send| functions instead of |read| and |write|. On
522 * Windows, file descriptors are provided by C runtime and are not
523 * interchangeable with sockets.
524 *
525 * Socket BIOs may be used with |BIO_set_fd| and |BIO_get_fd|.
526 *
527 * TODO(davidben): Add separate APIs and fix the internals to use |SOCKET|s
528 * around rather than rely on int casts. */
529
530 OPENSSL_EXPORT const BIO_METHOD *BIO_s_socket(void);
531
532 /* BIO_new_socket allocates and initialises a fresh BIO which will read and
533 * write to the socket |fd|. If |close_flag| is |BIO_CLOSE| then closing the
534 * BIO will close |fd|. It returns the fresh |BIO| or NULL on error. */
535 OPENSSL_EXPORT BIO *BIO_new_socket(int fd, int close_flag);
536
537
538 /* Connect BIOs.
539 *
540 * A connection BIO creates a network connection and transfers data over the
541 * resulting socket. */
542
543 OPENSSL_EXPORT const BIO_METHOD *BIO_s_connect(void);
544
545 /* BIO_new_connect returns a BIO that connects to the given hostname and port.
546 * The |host_and_optional_port| argument should be of the form
547 * "www.example.com" or "www.example.com:443". If the port is omitted, it must
548 * be provided with |BIO_set_conn_port|.
549 *
550 * It returns the new BIO on success, or NULL on error. */
551 OPENSSL_EXPORT BIO *BIO_new_connect(const char *host_and_optional_port);
552
553 /* BIO_set_conn_hostname sets |host_and_optional_port| as the hostname and
554 * optional port that |bio| will connect to. If the port is omitted, it must be
555 * provided with |BIO_set_conn_port|.
556 *
557 * It returns one on success and zero otherwise. */
558 OPENSSL_EXPORT int BIO_set_conn_hostname(BIO *bio,
559 const char *host_and_optional_port);
560
561 /* BIO_set_conn_port sets |port_str| as the port or service name that |bio|
562 * will connect to. It returns one on success and zero otherwise. */
563 OPENSSL_EXPORT int BIO_set_conn_port(BIO *bio, const char *port_str);
564
565 /* BIO_set_conn_int_port sets |*port| as the port that |bio| will connect to.
566 * It returns one on success and zero otherwise. */
567 OPENSSL_EXPORT int BIO_set_conn_int_port(BIO *bio, const int *port);
568
569 /* BIO_set_nbio sets whether |bio| will use non-blocking I/O operations. It
570 * returns one on success and zero otherwise. */
571 OPENSSL_EXPORT int BIO_set_nbio(BIO *bio, int on);
572
573 /* BIO_do_connect connects |bio| if it has not been connected yet. It returns
574 * one on success and <= 0 otherwise. */
575 OPENSSL_EXPORT int BIO_do_connect(BIO *bio);
576
577
578 /* Datagram BIOs.
579 *
580 * TODO(fork): not implemented. */
581
582 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */
583
584 #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for MTU. want to use
585 this if asking the kernel fails */
586
587 #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU was exceed in
588 the previous write operation. */
589
590 /* BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT sets a read deadline to drive
591 * retransmits. The |parg| argument to |BIO_ctrl| will be a pointer to a
592 * |timeval| struct. If the structure is all zeros, it clears the read
593 * deadline. Otherwise, |BIO_read| must fail with a temporary error
594 * (e.g. |EAGAIN|) after the deadline. */
595 #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45
596
597 #define BIO_CTRL_DGRAM_GET_PEER 46
598
599 #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
600
601
602 /* BIO Pairs.
603 *
604 * BIO pairs provide a "loopback" like system: a pair of BIOs where data
605 * written to one can be read from the other and vice versa. */
606
607 /* BIO_new_bio_pair sets |*out1| and |*out2| to two freshly created BIOs where
608 * data written to one can be read from the other and vice versa. The
609 * |writebuf1| argument gives the size of the buffer used in |*out1| and
610 * |writebuf2| for |*out2|. It returns one on success and zero on error. */
611 OPENSSL_EXPORT int BIO_new_bio_pair(BIO **out1, size_t writebuf1, BIO **out2,
612 size_t writebuf2);
613
614 /* BIO_new_bio_pair_external_buf is the same as |BIO_new_bio_pair| with the
615 * difference that the caller keeps ownership of the write buffers
616 * |ext_writebuf1_len| and |ext_writebuf2_len|. This is useful when using zero
617 * copy API for read and write operations, in cases where the buffers need to
618 * outlive the BIO pairs. It returns one on success and zero on error. */
619 OPENSSL_EXPORT int BIO_new_bio_pair_external_buf(BIO** bio1_p,
620 size_t writebuf1_len,
621 uint8_t* ext_writebuf1,
622 BIO** bio2_p,
623 size_t writebuf2_len,
624 uint8_t* ext_writebuf2);
625
626 /* BIO_ctrl_get_read_request returns the number of bytes that the other side of
627 * |bio| tried (unsuccessfully) to read. */
628 OPENSSL_EXPORT size_t BIO_ctrl_get_read_request(BIO *bio);
629
630 /* BIO_ctrl_get_write_guarantee returns the number of bytes that |bio| (which
631 * must have been returned by |BIO_new_bio_pair|) will accept on the next
632 * |BIO_write| call. */
633 OPENSSL_EXPORT size_t BIO_ctrl_get_write_guarantee(BIO *bio);
634
635 /* BIO_shutdown_wr marks |bio| as closed, from the point of view of the other
636 * side of the pair. Future |BIO_write| calls on |bio| will fail. It returns
637 * one on success and zero otherwise. */
638 OPENSSL_EXPORT int BIO_shutdown_wr(BIO *bio);
639
640
641 /* Zero copy versions of BIO_read and BIO_write for BIO pairs. */
642
643 /* BIO_zero_copy_get_read_buf initiates a zero copy read operation.
644 * |out_read_buf| is set to the internal read buffer, and |out_buf_offset| is
645 * set to the current read position of |out_read_buf|. The number of bytes
646 * available for read from |out_read_buf| + |out_buf_offset| is returned in
647 * |out_available_bytes|. Note that this function might report fewer bytes
648 * available than |BIO_pending|, if the internal ring buffer is wrapped. It
649 * returns one on success. In case of error it returns zero and pushes to the
650 * error stack.
651 *
652 * The zero copy read operation is completed by calling
653 * |BIO_zero_copy_get_read_buf_done|. Neither |BIO_zero_copy_get_read_buf| nor
654 * any other I/O read operation may be called while a zero copy read operation
655 * is active. */
656 OPENSSL_EXPORT int BIO_zero_copy_get_read_buf(BIO* bio,
657 uint8_t** out_read_buf,
658 size_t* out_buf_offset,
659 size_t* out_available_bytes);
660
661 /* BIO_zero_copy_get_read_buf_done must be called after reading from a BIO using
662 * |BIO_zero_copy_get_read_buf| to finish the read operation. The |bytes_read|
663 * argument is the number of bytes read.
664 *
665 * It returns one on success. In case of error it returns zero and pushes to the
666 * error stack. */
667 OPENSSL_EXPORT int BIO_zero_copy_get_read_buf_done(BIO* bio, size_t bytes_read);
668
669 /* BIO_zero_copy_get_write_buf initiates a zero copy write operation.
670 * |out_write_buf| is set to to the internal write buffer, and |out_buf_offset|
671 * is set to the current write position of |out_write_buf|.
672 * The number of bytes available for write from |out_write_buf| +
673 * |out_buf_offset| is returned in |out_available_bytes|. Note that this
674 * function might report fewer bytes available than
675 * |BIO_ctrl_get_write_guarantee|, if the internal buffer is wrapped. It returns
676 * one on success. In case of error it returns zero and pushes to the error
677 * stack.
678 *
679 * The zero copy write operation is completed by calling
680 * |BIO_zero_copy_get_write_buf_done|. Neither |BIO_zero_copy_get_write_buf|
681 * nor any other I/O write operation may be called while a zero copy write
682 * operation is active. */
683 OPENSSL_EXPORT int BIO_zero_copy_get_write_buf(BIO* bio,
684 uint8_t** out_write_buf,
685 size_t* out_buf_offset,
686 size_t* out_available_bytes);
687
688 /* BIO_zero_copy_get_write_buf_done must be called after writing to a BIO using
689 * |BIO_zero_copy_get_write_buf| to finish the write operation. The
690 * |bytes_written| argument gives the number of bytes written.
691 *
692 * It returns one on success. In case of error it returns zero and pushes to the
693 * error stack. */
694 OPENSSL_EXPORT int BIO_zero_copy_get_write_buf_done(BIO* bio,
695 size_t bytes_written);
696
697
698 /* BIO_NOCLOSE and |BIO_CLOSE| can be used as symbolic arguments when a "close
699 * flag" is passed to a BIO function. */
700 #define BIO_NOCLOSE 0
701 #define BIO_CLOSE 1
702
703 /* These are passed to the BIO callback */
704 #define BIO_CB_FREE 0x01
705 #define BIO_CB_READ 0x02
706 #define BIO_CB_WRITE 0x03
707 #define BIO_CB_PUTS 0x04
708 #define BIO_CB_GETS 0x05
709 #define BIO_CB_CTRL 0x06
710
711 /* The callback is called before and after the underling operation,
712 * The BIO_CB_RETURN flag indicates if it is after the call */
713 #define BIO_CB_RETURN 0x80
714
715 /* These are values of the |cmd| argument to |BIO_ctrl|. */
716 #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */
717 #define BIO_CTRL_EOF 2 /* opt - are we at the eof */
718 #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */
719 #define BIO_CTRL_SET 4 /* man - set the 'IO' type */
720 #define BIO_CTRL_GET 5 /* man - get the 'IO' type */
721 #define BIO_CTRL_PUSH 6
722 #define BIO_CTRL_POP 7
723 #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */
724 #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */
725 #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */
726 #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */
727 #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */
728 /* callback is int cb(BIO *bio,state,ret); */
729 #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */
730 #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */
731 #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */
732
733 /* BIO_CTRL_DUP is never used, but exists to allow code to compile more easily. */
734 #define BIO_CTRL_DUP 12
735
736
737 /* Android compatibility section.
738 *
739 * A previous version of BoringSSL used in Android renamed ERR_print_errors_fp
740 * to BIO_print_errors_fp. It has subsequently been renamed back to
741 * ERR_print_errors_fp. */
742 #define BIO_print_errors_fp ERR_print_errors_fp
743
744
745 /* Deprecated functions. */
746
747 /* BIO_f_base64 returns a filter |BIO| that base64-encodes data written into
748 * it, and decodes data read from it. |BIO_gets| is not supported. Call
749 * |BIO_flush| when done writing, to signal that no more data are to be
750 * encoded. The flag |BIO_FLAGS_BASE64_NO_NL| may be set to encode all the data
751 * on one line. */
752 OPENSSL_EXPORT const BIO_METHOD *BIO_f_base64(void);
753
754 /* ERR_print_errors is an alias for |BIO_print_errors|. */
755 OPENSSL_EXPORT void ERR_print_errors(BIO *bio);
756
757
758 /* Private functions */
759
760 #define BIO_FLAGS_READ 0x01
761 #define BIO_FLAGS_WRITE 0x02
762 #define BIO_FLAGS_IO_SPECIAL 0x04
763 #define BIO_FLAGS_RWS (BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL)
764 #define BIO_FLAGS_SHOULD_RETRY 0x08
765 #define BIO_FLAGS_BASE64_NO_NL 0x100
766 /* This is used with memory BIOs: it means we shouldn't free up or change the
767 * data in any way. */
768 #define BIO_FLAGS_MEM_RDONLY 0x200
769
770 /* These are the 'types' of BIOs */
771 #define BIO_TYPE_NONE 0
772 #define BIO_TYPE_MEM (1 | 0x0400)
773 #define BIO_TYPE_FILE (2 | 0x0400)
774 #define BIO_TYPE_FD (4 | 0x0400 | 0x0100)
775 #define BIO_TYPE_SOCKET (5 | 0x0400 | 0x0100)
776 #define BIO_TYPE_NULL (6 | 0x0400)
777 #define BIO_TYPE_SSL (7 | 0x0200)
778 #define BIO_TYPE_MD (8 | 0x0200) /* passive filter */
779 #define BIO_TYPE_BUFFER (9 | 0x0200) /* filter */
780 #define BIO_TYPE_CIPHER (10 | 0x0200) /* filter */
781 #define BIO_TYPE_BASE64 (11 | 0x0200) /* filter */
782 #define BIO_TYPE_CONNECT (12 | 0x0400 | 0x0100) /* socket - connect */
783 #define BIO_TYPE_ACCEPT (13 | 0x0400 | 0x0100) /* socket for accept */
784 #define BIO_TYPE_PROXY_CLIENT (14 | 0x0200) /* client proxy BIO */
785 #define BIO_TYPE_PROXY_SERVER (15 | 0x0200) /* server proxy BIO */
786 #define BIO_TYPE_NBIO_TEST (16 | 0x0200) /* server proxy BIO */
787 #define BIO_TYPE_NULL_FILTER (17 | 0x0200)
788 #define BIO_TYPE_BER (18 | 0x0200) /* BER -> bin filter */
789 #define BIO_TYPE_BIO (19 | 0x0400) /* (half a) BIO pair */
790 #define BIO_TYPE_LINEBUFFER (20 | 0x0200) /* filter */
791 #define BIO_TYPE_DGRAM (21 | 0x0400 | 0x0100)
792 #define BIO_TYPE_ASN1 (22 | 0x0200) /* filter */
793 #define BIO_TYPE_COMP (23 | 0x0200) /* filter */
794
795 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
796 #define BIO_TYPE_FILTER 0x0200
797 #define BIO_TYPE_SOURCE_SINK 0x0400
798
799 struct bio_method_st {
800 int type;
801 const char *name;
802 int (*bwrite)(BIO *, const char *, int);
803 int (*bread)(BIO *, char *, int);
804 /* TODO(fork): remove bputs. */
805 int (*bputs)(BIO *, const char *);
806 int (*bgets)(BIO *, char *, int);
807 long (*ctrl)(BIO *, int, long, void *);
808 int (*create)(BIO *);
809 int (*destroy)(BIO *);
810 long (*callback_ctrl)(BIO *, int, bio_info_cb);
811 };
812
813 struct bio_st {
814 const BIO_METHOD *method;
815 /* bio, mode, argp, argi, argl, ret */
816 long (*callback)(BIO *, int, const char *, int, long, long);
817 char *cb_arg; /* first argument for the callback */
818
819 /* init is non-zero if this |BIO| has been initialised. */
820 int init;
821 /* shutdown is often used by specific |BIO_METHOD|s to determine whether
822 * they own some underlying resource. This flag can often by controlled by
823 * |BIO_set_close|. For example, whether an fd BIO closes the underlying fd
824 * when it, itself, is closed. */
825 int shutdown;
826 int flags;
827 int retry_reason;
828 /* num is a BIO-specific value. For example, in fd BIOs it's used to store a
829 * file descriptor. */
830 int num;
831 CRYPTO_refcount_t references;
832 void *ptr;
833 /* next_bio points to the next |BIO| in a chain. This |BIO| owns a reference
834 * to |next_bio|. */
835 BIO *next_bio; /* used by filter BIOs */
836 size_t num_read, num_write;
837 };
838
839 #define BIO_C_SET_CONNECT 100
840 #define BIO_C_DO_STATE_MACHINE 101
841 #define BIO_C_SET_NBIO 102
842 #define BIO_C_SET_PROXY_PARAM 103
843 #define BIO_C_SET_FD 104
844 #define BIO_C_GET_FD 105
845 #define BIO_C_SET_FILE_PTR 106
846 #define BIO_C_GET_FILE_PTR 107
847 #define BIO_C_SET_FILENAME 108
848 #define BIO_C_SET_SSL 109
849 #define BIO_C_GET_SSL 110
850 #define BIO_C_SET_MD 111
851 #define BIO_C_GET_MD 112
852 #define BIO_C_GET_CIPHER_STATUS 113
853 #define BIO_C_SET_BUF_MEM 114
854 #define BIO_C_GET_BUF_MEM_PTR 115
855 #define BIO_C_GET_BUFF_NUM_LINES 116
856 #define BIO_C_SET_BUFF_SIZE 117
857 #define BIO_C_SET_ACCEPT 118
858 #define BIO_C_SSL_MODE 119
859 #define BIO_C_GET_MD_CTX 120
860 #define BIO_C_GET_PROXY_PARAM 121
861 #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */
862 #define BIO_C_GET_ACCEPT 124
863 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
864 #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
865 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
866 #define BIO_C_FILE_SEEK 128
867 #define BIO_C_GET_CIPHER_CTX 129
868 #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/
869 #define BIO_C_SET_BIND_MODE 131
870 #define BIO_C_GET_BIND_MODE 132
871 #define BIO_C_FILE_TELL 133
872 #define BIO_C_GET_SOCKS 134
873 #define BIO_C_SET_SOCKS 135
874
875 #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
876 #define BIO_C_GET_WRITE_BUF_SIZE 137
877 #define BIO_C_GET_WRITE_GUARANTEE 140
878 #define BIO_C_GET_READ_REQUEST 141
879 #define BIO_C_SHUTDOWN_WR 142
880 #define BIO_C_NREAD0 143
881 #define BIO_C_NREAD 144
882 #define BIO_C_NWRITE0 145
883 #define BIO_C_NWRITE 146
884 #define BIO_C_RESET_READ_REQUEST 147
885 #define BIO_C_SET_MD_CTX 148
886
887 #define BIO_C_SET_PREFIX 149
888 #define BIO_C_GET_PREFIX 150
889 #define BIO_C_SET_SUFFIX 151
890 #define BIO_C_GET_SUFFIX 152
891
892 #define BIO_C_SET_EX_ARG 153
893 #define BIO_C_GET_EX_ARG 154
894
895
896 #if defined(__cplusplus)
897 } /* extern C */
898 #endif
899
900 #define BIO_R_BAD_FOPEN_MODE 100
901 #define BIO_R_BROKEN_PIPE 101
902 #define BIO_R_CONNECT_ERROR 102
903 #define BIO_R_ERROR_SETTING_NBIO 103
904 #define BIO_R_INVALID_ARGUMENT 104
905 #define BIO_R_IN_USE 105
906 #define BIO_R_KEEPALIVE 106
907 #define BIO_R_NBIO_CONNECT_ERROR 107
908 #define BIO_R_NO_HOSTNAME_SPECIFIED 108
909 #define BIO_R_NO_PORT_SPECIFIED 109
910 #define BIO_R_NO_SUCH_FILE 110
911 #define BIO_R_NULL_PARAMETER 111
912 #define BIO_R_SYS_LIB 112
913 #define BIO_R_UNABLE_TO_CREATE_SOCKET 113
914 #define BIO_R_UNINITIALIZED 114
915 #define BIO_R_UNSUPPORTED_METHOD 115
916 #define BIO_R_WRITE_TO_READ_ONLY_BIO 116
917
918 #endif /* OPENSSL_HEADER_BIO_H */