diff options
Diffstat (limited to 'src/lib/libcrypto/man/BIO_new_CMS.3')
| -rw-r--r-- | src/lib/libcrypto/man/BIO_new_CMS.3 | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/src/lib/libcrypto/man/BIO_new_CMS.3 b/src/lib/libcrypto/man/BIO_new_CMS.3 deleted file mode 100644 index 312c39ad1c..0000000000 --- a/src/lib/libcrypto/man/BIO_new_CMS.3 +++ /dev/null | |||
| @@ -1,83 +0,0 @@ | |||
| 1 | .Dd $Mdocdate: September 9 2015 $ | ||
| 2 | .Dt BIO_NEW_CMS 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm BIO_new_CMS | ||
| 6 | .Nd CMS streaming filter BIO | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .In openssl/cms.h | ||
| 9 | .Ft BIO * | ||
| 10 | .Fo BIO_new_CMS | ||
| 11 | .Fa "BIO *out" | ||
| 12 | .Fa "CMS_ContentInfo *cms" | ||
| 13 | .Fc | ||
| 14 | .Sh DESCRIPTION | ||
| 15 | .Fn BIO_new_CMS | ||
| 16 | returns a streaming filter BIO chain based on | ||
| 17 | .Fa cms . | ||
| 18 | The output of the filter is written to | ||
| 19 | .Fa out . | ||
| 20 | Any data written to the chain is automatically translated | ||
| 21 | to a BER format CMS structure of the appropriate type. | ||
| 22 | .Sh RETURN VALUES | ||
| 23 | .Fn BIO_new_CMS | ||
| 24 | returns a BIO chain when successful or | ||
| 25 | .Dv NULL | ||
| 26 | if an error occurred. | ||
| 27 | The error can be obtained from | ||
| 28 | .Xr ERR_get_error 3 . | ||
| 29 | .Sh NOTES | ||
| 30 | The chain returned by this function behaves like a standard filter BIO. | ||
| 31 | It supports non blocking I/O. | ||
| 32 | Content is processed and streamed on the fly and not all held in memory | ||
| 33 | at once: so it is possible to encode very large structures. | ||
| 34 | After all content has been written through the chain | ||
| 35 | .Xr BIO_flush 3 | ||
| 36 | must be called to finalise the structure. | ||
| 37 | .Pp | ||
| 38 | The | ||
| 39 | .Dv CMS_STREAM | ||
| 40 | flag must be included in the corresponding | ||
| 41 | .Fa flags | ||
| 42 | parameter of the | ||
| 43 | .Fa cms | ||
| 44 | creation function. | ||
| 45 | .Pp | ||
| 46 | If an application wishes to write additional data to | ||
| 47 | .Fa out , | ||
| 48 | BIOs should be removed from the chain using | ||
| 49 | .Xr BIO_pop 3 | ||
| 50 | and freed with | ||
| 51 | .Xr BIO_free 3 | ||
| 52 | until | ||
| 53 | .Fa out | ||
| 54 | is reached. | ||
| 55 | If no additional data needs to be written, | ||
| 56 | .Xr BIO_free_all 3 | ||
| 57 | can be called to free up the whole chain. | ||
| 58 | .Pp | ||
| 59 | Any content written through the filter is used verbatim: | ||
| 60 | no canonical translation is performed. | ||
| 61 | .Pp | ||
| 62 | It is possible to chain multiple BIOs to, for example, | ||
| 63 | create a triple wrapped signed, enveloped, signed structure. | ||
| 64 | In this case it is the application's responsibility | ||
| 65 | to set the inner content type of any outer | ||
| 66 | .Vt CMS_ContentInfo | ||
| 67 | structures. | ||
| 68 | .Pp | ||
| 69 | Large numbers of small writes through the chain should be avoided as this | ||
| 70 | will produce an output consisting of lots of OCTET STRING structures. | ||
| 71 | Prepending a | ||
| 72 | .Xr BIO_f_buffer 3 | ||
| 73 | buffering BIO will prevent this. | ||
| 74 | .Sh SEE ALSO | ||
| 75 | .Xr CMS_encrypt 3 , | ||
| 76 | .Xr CMS_sign 3 , | ||
| 77 | .Xr ERR_get_error 3 | ||
| 78 | .Sh HISTORY | ||
| 79 | .Fn BIO_new_CMS | ||
| 80 | was added to OpenSSL 1.0.0. | ||
| 81 | .Sh BUGS | ||
| 82 | There is currently no corresponding inverse BIO | ||
| 83 | which can decode a CMS structure on the fly. | ||
