diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/lib/libcrypto/man/CMS_ContentInfo_new.3 | 131 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/d2i_CMS_ContentInfo.3 | 126 |
2 files changed, 257 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/CMS_ContentInfo_new.3 b/src/lib/libcrypto/man/CMS_ContentInfo_new.3 new file mode 100644 index 0000000000..71597e3467 --- /dev/null +++ b/src/lib/libcrypto/man/CMS_ContentInfo_new.3 | |||
| @@ -0,0 +1,131 @@ | |||
| 1 | .\" $OpenBSD: CMS_ContentInfo_new.3,v 1.1 2019/08/12 14:24:38 schwarze Exp $ | ||
| 2 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> | ||
| 3 | .\" | ||
| 4 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 5 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 6 | .\" copyright notice and this permission notice appear in all copies. | ||
| 7 | .\" | ||
| 8 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 9 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 10 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 11 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 12 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 15 | .\" | ||
| 16 | .Dd $Mdocdate: August 12 2019 $ | ||
| 17 | .Dt CMS_CONTENTINFO_NEW 3 | ||
| 18 | .Os | ||
| 19 | .Sh NAME | ||
| 20 | .Nm CMS_ContentInfo_new , | ||
| 21 | .Nm CMS_ContentInfo_free , | ||
| 22 | .Nm CMS_ContentInfo_print_ctx , | ||
| 23 | .Nm CMS_ReceiptRequest_new , | ||
| 24 | .Nm CMS_ReceiptRequest_free | ||
| 25 | .Nd Cryptographic Message Syntax data structures | ||
| 26 | .Sh SYNOPSIS | ||
| 27 | .In openssl/cms.h | ||
| 28 | .Ft CMS_ContentInfo * | ||
| 29 | .Fn CMS_ContentInfo_new void | ||
| 30 | .Ft void | ||
| 31 | .Fn CMS_ContentInfo_free "CMS_ContentInfo *cms" | ||
| 32 | .Ft int | ||
| 33 | .Fo CMS_ContentInfo_print_ctx | ||
| 34 | .Fa "BIO *out" | ||
| 35 | .Fa "CMS_ContentInfo *cms" | ||
| 36 | .Fa "int indent" | ||
| 37 | .Fa "const ASN1_PCTX *pctx" | ||
| 38 | .Fc | ||
| 39 | .Ft CMS_ReceiptRequest * | ||
| 40 | .Fn CMS_ReceiptRequest_new void | ||
| 41 | .Ft void | ||
| 42 | .Fn CMS_ReceiptRequest_free "CMS_ReceiptRequest *rr" | ||
| 43 | .Sh DESCRIPTION | ||
| 44 | .Fn CMS_ContentInfo_new | ||
| 45 | allocates and initializes an empty | ||
| 46 | .Vt CMS_ContentInfo | ||
| 47 | object, representing an ASN.1 | ||
| 48 | .Vt ContentInfo | ||
| 49 | structure defined in RFC 5652 section 3. | ||
| 50 | It can hold a pointer to an ASN.1 OBJECT IDENTIFIER | ||
| 51 | and a pointer to either a | ||
| 52 | .Vt SignedData , | ||
| 53 | .Vt EnvelopedData , | ||
| 54 | .Vt DigestedData , | ||
| 55 | .Vt EncryptedData , | ||
| 56 | .Vt AuthenticatedData , | ||
| 57 | or | ||
| 58 | .Vt CompressedData | ||
| 59 | object or to an arbitrary ASN.1 object. | ||
| 60 | .Fn CMS_ContentInfo_free | ||
| 61 | frees | ||
| 62 | .Fa cms . | ||
| 63 | .Pp | ||
| 64 | .Fn CMS_ContentInfo_print_ctx | ||
| 65 | prints a human readable representation of | ||
| 66 | .Fa cms | ||
| 67 | to | ||
| 68 | .Fa out . | ||
| 69 | .Pp | ||
| 70 | .Fn CMS_ReceiptRequest_new | ||
| 71 | allocates and initializes an empty | ||
| 72 | .Vt CMS_ReceiptRequest | ||
| 73 | object, representing an ASN.1 | ||
| 74 | .Vt ReceiptRequest | ||
| 75 | structure defined in RFC 2634 section 2.7. | ||
| 76 | It can contain a content identifier, a list of recipients requested | ||
| 77 | to return a signed receipt, and a list of users to send the receipt to. | ||
| 78 | .Fn CMS_ReceiptRequest_free | ||
| 79 | frees | ||
| 80 | .Fa rr . | ||
| 81 | .Sh RETURN VALUES | ||
| 82 | .Fn CMS_ContentInfo_new | ||
| 83 | and | ||
| 84 | .Fn CMS_ReceiptRequest_new | ||
| 85 | return the new | ||
| 86 | .Vt CMS_ContentInfo | ||
| 87 | or | ||
| 88 | .Vt CMS_ReceiptRequest | ||
| 89 | object, respectively, or | ||
| 90 | .Dv NULL | ||
| 91 | if an error occurs. | ||
| 92 | .Sh SEE ALSO | ||
| 93 | .Xr BIO_new_CMS 3 , | ||
| 94 | .Xr CMS_add0_cert 3 , | ||
| 95 | .Xr CMS_add1_recipient_cert 3 , | ||
| 96 | .Xr CMS_add1_signer 3 , | ||
| 97 | .Xr CMS_compress 3 , | ||
| 98 | .Xr CMS_decrypt 3 , | ||
| 99 | .Xr CMS_encrypt 3 , | ||
| 100 | .Xr CMS_final 3 , | ||
| 101 | .Xr CMS_get0_RecipientInfos 3 , | ||
| 102 | .Xr CMS_get0_SignerInfos 3 , | ||
| 103 | .Xr CMS_get0_type 3 , | ||
| 104 | .Xr CMS_get1_ReceiptRequest 3 , | ||
| 105 | .Xr CMS_sign 3 , | ||
| 106 | .Xr CMS_sign_receipt 3 , | ||
| 107 | .Xr CMS_uncompress 3 , | ||
| 108 | .Xr CMS_verify 3 , | ||
| 109 | .Xr CMS_verify_receipt 3 , | ||
| 110 | .Xr d2i_CMS_ContentInfo 3 , | ||
| 111 | .Xr i2d_CMS_bio_stream 3 , | ||
| 112 | .Xr PEM_read_bio_PrivateKey 3 , | ||
| 113 | .Xr PEM_write_bio_CMS_stream 3 , | ||
| 114 | .Xr SMIME_read_CMS 3 , | ||
| 115 | .Xr SMIME_write_CMS 3 | ||
| 116 | .Sh STANDARDS | ||
| 117 | RFC 5652: Cryptographic Message Syntax, section 3: General Syntax | ||
| 118 | .Pp | ||
| 119 | RFC 2634: Enhanced Security Services for S/MIME, | ||
| 120 | section 2.7: Receipt Request Syntax | ||
| 121 | .Sh HISTORY | ||
| 122 | .Fn CMS_ContentInfo_new , | ||
| 123 | .Fn CMS_ContentInfo_free , | ||
| 124 | .Fn CMS_ReceiptRequest_new , | ||
| 125 | and | ||
| 126 | .Fn CMS_ReceiptRequest_free | ||
| 127 | first appeared in OpenSSL 0.9.8h and | ||
| 128 | .Fn CMS_ContentInfo_print_ctx | ||
| 129 | in OpenSSL 1.0.0. | ||
| 130 | This functions have been available since | ||
| 131 | .Ox 6.6 . | ||
diff --git a/src/lib/libcrypto/man/d2i_CMS_ContentInfo.3 b/src/lib/libcrypto/man/d2i_CMS_ContentInfo.3 new file mode 100644 index 0000000000..2805672998 --- /dev/null +++ b/src/lib/libcrypto/man/d2i_CMS_ContentInfo.3 | |||
| @@ -0,0 +1,126 @@ | |||
| 1 | .\" $OpenBSD: d2i_CMS_ContentInfo.3,v 1.1 2019/08/12 14:24:38 schwarze Exp $ | ||
| 2 | .\" Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org> | ||
| 3 | .\" | ||
| 4 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 5 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 6 | .\" copyright notice and this permission notice appear in all copies. | ||
| 7 | .\" | ||
| 8 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 9 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 10 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 11 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 12 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 15 | .\" | ||
| 16 | .Dd $Mdocdate: August 12 2019 $ | ||
| 17 | .Dt D2I_CMS_CONTENTINFO 3 | ||
| 18 | .Os | ||
| 19 | .Sh NAME | ||
| 20 | .Nm d2i_CMS_ContentInfo , | ||
| 21 | .Nm i2d_CMS_ContentInfo , | ||
| 22 | .Nm d2i_CMS_bio , | ||
| 23 | .Nm i2d_CMS_bio , | ||
| 24 | .Nm d2i_CMS_ReceiptRequest , | ||
| 25 | .Nm i2d_CMS_ReceiptRequest | ||
| 26 | .Nd decode and encode Cryptographic Message Syntax data | ||
| 27 | .Sh SYNOPSIS | ||
| 28 | .In openssl/cms.h | ||
| 29 | .Ft CMS_ContentInfo * | ||
| 30 | .Fo d2i_CMS_ContentInfo | ||
| 31 | .Fa "CMS_ContentInfo **val_out" | ||
| 32 | .Fa "const unsigned char **der_in" | ||
| 33 | .Fa "long length" | ||
| 34 | .Fc | ||
| 35 | .Ft int | ||
| 36 | .Fo i2d_CMS_ContentInfo | ||
| 37 | .Fa "CMS_ContentInfo *val_in" | ||
| 38 | .Fa "unsigned char **out" | ||
| 39 | .Fc | ||
| 40 | .Ft CMS_ContentInfo * | ||
| 41 | .Fo d2i_CMS_bio | ||
| 42 | .Fa "BIO *in_bio" | ||
| 43 | .Fa "CMS_ContentInfo **val_out" | ||
| 44 | .Fc | ||
| 45 | .Ft int | ||
| 46 | .Fo i2d_CMS_bio | ||
| 47 | .Fa "BIO *out_bio" | ||
| 48 | .Fa "CMS_ContentInfo *val_in" | ||
| 49 | .Fc | ||
| 50 | .Ft CMS_ReceiptRequest * | ||
| 51 | .Fo d2i_CMS_ReceiptRequest | ||
| 52 | .Fa "CMS_ReceiptRequest **val_out" | ||
| 53 | .Fa "const unsigned char **der_in" | ||
| 54 | .Fa "long length" | ||
| 55 | .Fc | ||
| 56 | .Ft int | ||
| 57 | .Fo i2d_CMS_ReceiptRequest | ||
| 58 | .Fa "CMS_ReceiptRequest *val_in" | ||
| 59 | .Fa "unsigned char **out" | ||
| 60 | .Fc | ||
| 61 | .Sh DESCRIPTION | ||
| 62 | These functions decode and encode Cryptographic Message Syntax | ||
| 63 | data structures. | ||
| 64 | For details about the semantics, examples, caveats, and bugs, see | ||
| 65 | .Xr ASN1_item_d2i 3 . | ||
| 66 | .Pp | ||
| 67 | .Fn d2i_CMS_ContentInfo | ||
| 68 | and | ||
| 69 | .Fn i2d_CMS_ContentInfo | ||
| 70 | decode and encode a | ||
| 71 | .Vt CMS_ContentInfo | ||
| 72 | structure defined in RFC 5652 section 3. | ||
| 73 | .Fn d2i_CMS_bio | ||
| 74 | and | ||
| 75 | .Fn i2d_CMS_bio | ||
| 76 | are similar except that they decode or encode using a | ||
| 77 | .Vt BIO | ||
| 78 | pointer. | ||
| 79 | .Pp | ||
| 80 | .Fn d2i_CMS_ReceiptRequest | ||
| 81 | and | ||
| 82 | .Fn i2d_CMS_ReceiptRequest | ||
| 83 | decode and encode a | ||
| 84 | .Vt CMS_ReceiptRequest | ||
| 85 | structure defined in RFC 2634 section 2.7. | ||
| 86 | .Sh RETURN VALUES | ||
| 87 | .Fn d2i_CMS_ContentInfo | ||
| 88 | and | ||
| 89 | .Fn d2i_CMS_bio | ||
| 90 | return a valid | ||
| 91 | .Vt CMS_ContentInfo | ||
| 92 | structure or | ||
| 93 | .Dv NULL | ||
| 94 | if an error occurs. | ||
| 95 | .Pp | ||
| 96 | .Fn d2i_CMS_ReceiptRequest | ||
| 97 | returns a valid | ||
| 98 | .Vt CMS_ReceiptRequest | ||
| 99 | structure or | ||
| 100 | .Dv NULL | ||
| 101 | if an error occurs. | ||
| 102 | .Pp | ||
| 103 | .Fn i2d_CMS_ContentInfo | ||
| 104 | and | ||
| 105 | .Fn i2d_CMS_ReceiptRequest | ||
| 106 | return the number of bytes successfully encoded | ||
| 107 | or a negative value if an error occurs. | ||
| 108 | .Pp | ||
| 109 | .Fn i2d_CMS_bio | ||
| 110 | returns 1 for success or 0 if an error occurs. | ||
| 111 | .Pp | ||
| 112 | For all functions, the error code can be obtained by | ||
| 113 | .Xr ERR_get_error 3 . | ||
| 114 | .Sh SEE ALSO | ||
| 115 | .Xr ASN1_item_d2i 3 , | ||
| 116 | .Xr CMS_ContentInfo_new 3 , | ||
| 117 | .Xr i2d_CMS_bio_stream 3 | ||
| 118 | .Sh STANDARDS | ||
| 119 | RFC 5652: Cryptographic Message Syntax, section 3: General Syntax | ||
| 120 | .Pp | ||
| 121 | RFC 2634: Enhanced Security Services for S/MIME, | ||
| 122 | section 2.7: Receipt Request Syntax | ||
| 123 | .Sh HISTORY | ||
| 124 | These functions first appeared in OpenSSL 0.9.8h | ||
| 125 | and have been available since | ||
| 126 | .Ox 6.6 . | ||
