diff options
Diffstat (limited to 'src/lib/libcrypto/man/CMS_final.3')
| -rw-r--r-- | src/lib/libcrypto/man/CMS_final.3 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/CMS_final.3 b/src/lib/libcrypto/man/CMS_final.3 new file mode 100644 index 0000000000..8404005c74 --- /dev/null +++ b/src/lib/libcrypto/man/CMS_final.3 | |||
| @@ -0,0 +1,98 @@ | |||
| 1 | .\" $OpenBSD: CMS_final.3,v 1.3 2019/08/10 23:41:22 schwarze Exp $ | ||
| 2 | .\" full merge up to: OpenSSL 25ccb589 Jul 1 02:02:06 2019 +0800 | ||
| 3 | .\" | ||
| 4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
| 5 | .\" Copyright (c) 2008 The OpenSSL Project. All rights reserved. | ||
| 6 | .\" | ||
| 7 | .\" Redistribution and use in source and binary forms, with or without | ||
| 8 | .\" modification, are permitted provided that the following conditions | ||
| 9 | .\" are met: | ||
| 10 | .\" | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" | ||
| 14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 15 | .\" notice, this list of conditions and the following disclaimer in | ||
| 16 | .\" the documentation and/or other materials provided with the | ||
| 17 | .\" distribution. | ||
| 18 | .\" | ||
| 19 | .\" 3. All advertising materials mentioning features or use of this | ||
| 20 | .\" software must display the following acknowledgment: | ||
| 21 | .\" "This product includes software developed by the OpenSSL Project | ||
| 22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 23 | .\" | ||
| 24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 25 | .\" endorse or promote products derived from this software without | ||
| 26 | .\" prior written permission. For written permission, please contact | ||
| 27 | .\" openssl-core@openssl.org. | ||
| 28 | .\" | ||
| 29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 31 | .\" permission of the OpenSSL Project. | ||
| 32 | .\" | ||
| 33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 34 | .\" acknowledgment: | ||
| 35 | .\" "This product includes software developed by the OpenSSL Project | ||
| 36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 37 | .\" | ||
| 38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 50 | .\" | ||
| 51 | .Dd $Mdocdate: August 10 2019 $ | ||
| 52 | .Dt CMS_FINAL 3 | ||
| 53 | .Os | ||
| 54 | .Sh NAME | ||
| 55 | .Nm CMS_final | ||
| 56 | .Nd finalise a CMS_ContentInfo structure | ||
| 57 | .Sh SYNOPSIS | ||
| 58 | .In openssl/cms.h | ||
| 59 | .Ft int | ||
| 60 | .Fo CMS_final | ||
| 61 | .Fa "CMS_ContentInfo *cms" | ||
| 62 | .Fa "BIO *data" | ||
| 63 | .Fa "BIO *dcont" | ||
| 64 | .Fa "unsigned int flags" | ||
| 65 | .Fc | ||
| 66 | .Sh DESCRIPTION | ||
| 67 | .Fn CMS_final | ||
| 68 | finalises the structure | ||
| 69 | .Fa cms . | ||
| 70 | Its purpose is to perform any operations necessary on | ||
| 71 | .Fa cms | ||
| 72 | (digest computation for example) and set the appropriate fields. | ||
| 73 | The parameter | ||
| 74 | .Fa data | ||
| 75 | contains the content to be processed. | ||
| 76 | The | ||
| 77 | .Fa dcont | ||
| 78 | parameter contains a | ||
| 79 | .Vt BIO | ||
| 80 | to write content to after processing: this is | ||
| 81 | only used with detached data and will usually be set to | ||
| 82 | .Dv NULL . | ||
| 83 | .Pp | ||
| 84 | This function will normally be called when the | ||
| 85 | .Dv CMS_PARTIAL | ||
| 86 | flag is used. | ||
| 87 | It should only be used when streaming is not performed because the | ||
| 88 | streaming I/O functions perform finalisation operations internally. | ||
| 89 | .Sh RETURN VALUES | ||
| 90 | .Fn CMS_final | ||
| 91 | returns 1 for success or 0 for failure. | ||
| 92 | .Sh SEE ALSO | ||
| 93 | .Xr CMS_encrypt 3 , | ||
| 94 | .Xr CMS_sign 3 , | ||
| 95 | .Xr ERR_get_error 3 | ||
| 96 | .Sh HISTORY | ||
| 97 | .Fn CMS_final | ||
| 98 | was added to OpenSSL 0.9.8. | ||