diff options
Diffstat (limited to 'src/lib/libcrypto/man/CMS_final.3')
| -rw-r--r-- | src/lib/libcrypto/man/CMS_final.3 | 48 |
1 files changed, 48 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..4e7912a4e0 --- /dev/null +++ b/src/lib/libcrypto/man/CMS_final.3 | |||
| @@ -0,0 +1,48 @@ | |||
| 1 | .Dd $Mdocdate: November 11 2015 $ | ||
| 2 | .Dt CMS_FINAL 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm CMS_final | ||
| 6 | .Nd finalise a CMS_ContentInfo structure | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .In openssl/cms.h | ||
| 9 | .Ft int | ||
| 10 | .Fo CMS_final | ||
| 11 | .Fa "CMS_ContentInfo *cms" | ||
| 12 | .Fa "BIO *data" | ||
| 13 | .Fa "BIO *dcont" | ||
| 14 | .Fa "unsigned int flags" | ||
| 15 | .Fc | ||
| 16 | .Sh DESCRIPTION | ||
| 17 | .Fn CMS_final | ||
| 18 | finalises the structure | ||
| 19 | .Fa cms . | ||
| 20 | Its purpose is to perform any operations necessary on | ||
| 21 | .Fa cms | ||
| 22 | (digest computation for example) and set the appropriate fields. | ||
| 23 | The parameter | ||
| 24 | .Fa data | ||
| 25 | contains the content to be processed. | ||
| 26 | The | ||
| 27 | .Fa dcont | ||
| 28 | parameter contains a | ||
| 29 | .Vt BIO | ||
| 30 | to write content to after processing: this is | ||
| 31 | only used with detached data and will usually be set to | ||
| 32 | .Dv NULL . | ||
| 33 | .Sh NOTES | ||
| 34 | This function will normally be called when the | ||
| 35 | .Dv CMS_PARTIAL | ||
| 36 | flag is used. | ||
| 37 | It should only be used when streaming is not performed because the | ||
| 38 | streaming I/O functions perform finalisation operations internally. | ||
| 39 | .Sh RETURN VALUES | ||
| 40 | .Fn CMS_final | ||
| 41 | returns 1 for success or 0 for failure. | ||
| 42 | .Sh SEE ALSO | ||
| 43 | .Xr CMS_encrypt 3 , | ||
| 44 | .Xr CMS_sign 3 , | ||
| 45 | .Xr ERR_get_error 3 | ||
| 46 | .Sh HISTORY | ||
| 47 | .Fn CMS_final | ||
| 48 | was added to OpenSSL 0.9.8. | ||