diff options
Diffstat (limited to 'src/lib/libcrypto/man/i2d_ASN1_bio_stream.3')
| -rw-r--r-- | src/lib/libcrypto/man/i2d_ASN1_bio_stream.3 | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/i2d_ASN1_bio_stream.3 b/src/lib/libcrypto/man/i2d_ASN1_bio_stream.3 new file mode 100644 index 0000000000..007d8eefd4 --- /dev/null +++ b/src/lib/libcrypto/man/i2d_ASN1_bio_stream.3 | |||
| @@ -0,0 +1,94 @@ | |||
| 1 | .\" $OpenBSD: i2d_ASN1_bio_stream.3,v 1.1 2021/12/13 13:46:09 schwarze Exp $ | ||
| 2 | .\" | ||
| 3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> | ||
| 4 | .\" | ||
| 5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 7 | .\" copyright notice and this permission notice appear in all copies. | ||
| 8 | .\" | ||
| 9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 16 | .\" | ||
| 17 | .Dd $Mdocdate: December 13 2021 $ | ||
| 18 | .Dt I2D_ASN1_BIO_STREAM 3 | ||
| 19 | .Os | ||
| 20 | .Sh NAME | ||
| 21 | .Nm i2d_ASN1_bio_stream | ||
| 22 | .Nd generic BER streamer | ||
| 23 | .Sh SYNOPSIS | ||
| 24 | .In openssl/asn1.h | ||
| 25 | .Ft int | ||
| 26 | .Fo i2d_ASN1_bio_stream | ||
| 27 | .Fa "BIO *out_bio" | ||
| 28 | .Fa "ASN1_VALUE *val_in" | ||
| 29 | .Fa "BIO *in_bio" | ||
| 30 | .Fa "int flags" | ||
| 31 | .Fa "const ASN1_ITEM *it" | ||
| 32 | .Fc | ||
| 33 | .Sh DESCRIPTION | ||
| 34 | If the bit | ||
| 35 | .Dv SMIME_STREAM | ||
| 36 | is not set in the | ||
| 37 | .Fa flags | ||
| 38 | argument, | ||
| 39 | .Fn i2d_ASN1_bio_stream | ||
| 40 | does the same as | ||
| 41 | .Xr ASN1_item_i2d_bio 3 , | ||
| 42 | ignoring the | ||
| 43 | .Fa in_bio | ||
| 44 | and | ||
| 45 | .Fa flags | ||
| 46 | arguments. | ||
| 47 | .Pp | ||
| 48 | If the bit | ||
| 49 | .Dv SMIME_STREAM | ||
| 50 | is set, it creates a streaming BIO with | ||
| 51 | .Xr BIO_new_NDEF 3 , | ||
| 52 | copies the data from | ||
| 53 | .Fa in_bio | ||
| 54 | to it using | ||
| 55 | .Xr SMIME_crlf_copy 3 , | ||
| 56 | finalizes the output with | ||
| 57 | .Xr BIO_flush 3 , | ||
| 58 | and frees the newly created BIOs up to but not including | ||
| 59 | .Fa out_bio . | ||
| 60 | .Pp | ||
| 61 | If | ||
| 62 | .Fa it | ||
| 63 | is | ||
| 64 | .Va PKCS7_it , | ||
| 65 | this function behaves exactly as | ||
| 66 | .Xr i2d_PKCS7_bio_stream 3 ; | ||
| 67 | for | ||
| 68 | .Va CMS_ContentInfo_it , | ||
| 69 | it behaves exactly as | ||
| 70 | .Xr i2d_CMS_bio_stream 3 . | ||
| 71 | For other values of | ||
| 72 | .Fa it , | ||
| 73 | the function fails. | ||
| 74 | .Sh RETURN VALUES | ||
| 75 | .Fn i2d_ASN1_bio_stream | ||
| 76 | is intended to return 1 on success or 0 on failure. | ||
| 77 | .Sh SEE ALSO | ||
| 78 | .Xr ASN1_item_i2d_bio 3 , | ||
| 79 | .Xr ASN1_item_ndef_i2d 3 , | ||
| 80 | .Xr BIO_flush 3 , | ||
| 81 | .Xr BIO_new 3 , | ||
| 82 | .Xr BIO_new_NDEF 3 , | ||
| 83 | .Xr BIO_push 3 , | ||
| 84 | .Xr i2d_CMS_bio_stream 3 , | ||
| 85 | .Xr i2d_PKCS7_bio_stream 3 , | ||
| 86 | .Xr SMIME_crlf_copy 3 | ||
| 87 | .Sh HISTORY | ||
| 88 | .Fn i2d_ASN1_bio_stream | ||
| 89 | first appeared in OpenSSL 1.0.0 and has been available since | ||
| 90 | .Ox 4.9 . | ||
| 91 | .Sh BUGS | ||
| 92 | Many kinds of errors are silently ignored. | ||
| 93 | This function may return 1 even if it only produced partial output | ||
| 94 | or no output at all. | ||
