summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO_new_CMS.3
diff options
context:
space:
mode:
authorschwarze <>2016-09-05 10:43:42 +0000
committerschwarze <>2016-09-05 10:43:42 +0000
commit8bc3352bee3f743c2b8f9fd9c743fca60706336c (patch)
tree8ddbb216e39c4571145c2d202a95596f977cdfe0 /src/lib/libcrypto/man/BIO_new_CMS.3
parentde12fbc1ebd942810e5ca1e55d7a6e213023f318 (diff)
downloadopenbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.gz
openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.bz2
openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.zip
remove CMS manuals; beck@ agress with the general idea
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/BIO_new_CMS.383
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
16returns a streaming filter BIO chain based on
17.Fa cms .
18The output of the filter is written to
19.Fa out .
20Any data written to the chain is automatically translated
21to a BER format CMS structure of the appropriate type.
22.Sh RETURN VALUES
23.Fn BIO_new_CMS
24returns a BIO chain when successful or
25.Dv NULL
26if an error occurred.
27The error can be obtained from
28.Xr ERR_get_error 3 .
29.Sh NOTES
30The chain returned by this function behaves like a standard filter BIO.
31It supports non blocking I/O.
32Content is processed and streamed on the fly and not all held in memory
33at once: so it is possible to encode very large structures.
34After all content has been written through the chain
35.Xr BIO_flush 3
36must be called to finalise the structure.
37.Pp
38The
39.Dv CMS_STREAM
40flag must be included in the corresponding
41.Fa flags
42parameter of the
43.Fa cms
44creation function.
45.Pp
46If an application wishes to write additional data to
47.Fa out ,
48BIOs should be removed from the chain using
49.Xr BIO_pop 3
50and freed with
51.Xr BIO_free 3
52until
53.Fa out
54is reached.
55If no additional data needs to be written,
56.Xr BIO_free_all 3
57can be called to free up the whole chain.
58.Pp
59Any content written through the filter is used verbatim:
60no canonical translation is performed.
61.Pp
62It is possible to chain multiple BIOs to, for example,
63create a triple wrapped signed, enveloped, signed structure.
64In this case it is the application's responsibility
65to set the inner content type of any outer
66.Vt CMS_ContentInfo
67structures.
68.Pp
69Large numbers of small writes through the chain should be avoided as this
70will produce an output consisting of lots of OCTET STRING structures.
71Prepending a
72.Xr BIO_f_buffer 3
73buffering 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
80was added to OpenSSL 1.0.0.
81.Sh BUGS
82There is currently no corresponding inverse BIO
83which can decode a CMS structure on the fly.