diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2008-04-09 20:55:55 +0000 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2008-04-09 20:55:55 +0000 |
commit | fb777e1f79b595fe210cd8930633a675a3ac0a84 (patch) | |
tree | 2bab8f83875bbf8c546c2954f09e8b0fea765db7 | |
parent | 360bb61d860f9ce7e48b2bb85d3ef9f521f95ab9 (diff) |
Add CMS_uncompress manual page.
-rw-r--r-- | doc/crypto/CMS_decrypt.pod | 2 | ||||
-rw-r--r-- | doc/crypto/CMS_uncompress.pod | 54 |
2 files changed, 55 insertions, 1 deletions
diff --git a/doc/crypto/CMS_decrypt.pod b/doc/crypto/CMS_decrypt.pod index 239069bd78..02df55e36f 100644 --- a/doc/crypto/CMS_decrypt.pod +++ b/doc/crypto/CMS_decrypt.pod @@ -50,7 +50,7 @@ The error can be obtained from ERR_get_error(3) =head1 BUGS -The lack of single pass processing and need to hold all data in memory as +The lack of single pass processing and the need to hold all data in memory as mentioned in CMS_verify() also applies to CMS_decrypt(). =head1 SEE ALSO diff --git a/doc/crypto/CMS_uncompress.pod b/doc/crypto/CMS_uncompress.pod new file mode 100644 index 0000000000..56d6de5158 --- /dev/null +++ b/doc/crypto/CMS_uncompress.pod @@ -0,0 +1,54 @@ +=pod + +=head1 NAME + +CMS_uncompress - uncompress a CMS CompressedData structure + +=head1 SYNOPSIS + + #include <openssl/cms.h> + + int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out, unsigned int flags); + +=head1 DESCRIPTION + +CMS_uncompress() extracts and uncompresses the content from a CMS +CompressedData structure B<cms>. B<data> is a BIO to write the content to and +B<flags> is an optional set of flags. + +The B<dcont> parameter is used in the rare case where the compressed content +is detached. It will normally be set to NULL. + +=head1 NOTES + +The only currently supported compression algorithm is zlib if the structure +indicates the use of any other algorithm and error is returned. + +If zlib support is not compiled into OpenSSL then CMS_uncompress() will always +return an error. + +The following flags can be passed in the B<flags> parameter. + +If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are deleted +from the content. If the content is not of type B<text/plain> then an error is +returned. + +=head1 RETURN VALUES + +CMS_uncompress() returns either 1 for success or 0 for failure. The error can +be obtained from ERR_get_error(3) + +=head1 BUGS + +The lack of single pass processing and the need to hold all data in memory as +mentioned in CMS_verify() also applies to CMS_decompress(). + +=head1 SEE ALSO + +L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_compress(3)|CMS_compress(3)> + +=head1 HISTORY + +CMS_uncompress() was added to OpenSSL 0.9.8 + +=cut |