BIO_NEW_CMS(3)

πŸ“¦ version 4.4.0, in alpine 3.24, arch rolling

πŸ’– BIO_new_CMS(3) πŸ’–

okay so bestie, welcome to the Library Functions Manual page for BIO_new_CMS(3) β€” it's giving CMS streaming filter BIO realness, and we're gonna understand it together 🫢✨

πŸŽ€ NAME πŸŽ€

BIO_new_CMS β€” CMS streaming filter BIO πŸ’…

✨ SYNOPSIS ✨

library β€œlibcrypto” #include <openssl/cms.h>

BIO *
BIO_new_CMS(BIO *out, CMS_ContentInfo *cms);

🌸 DESCRIPTION 🌸

okay so BIO_new_CMS() returns a streaming filter BIO chain based on cms. The output of the filter is written to out. Anything written to the chain gets automatically translated into a BER format CMS structure of the appropriate type β€” automatic, iconic, no cap ✨

The chain returned by this function behaves like a standard filter BIO. It supports non blocking I/O. Content is processed and streamed on the fly and not all held in memory at once, so it is possible to encode very large structures. After all content has been written through the chain, BIO_flush(3) must be called to finalise the structure 🫧

The CMS_STREAM flag must be included in the corresponding flags parameter of the cms creation function. Don't forget it, bestie β€” it's literally required πŸ”₯

If an application wishes to write additional data to out, BIOs should be removed from the chain using BIO_pop(3) and freed with BIO_free(3) until out is reached. If no additional data needs to be written, BIO_free_all(3) can be called to free up the whole chain πŸ’–

Any content written through the filter is used verbatim: no canonical translation is performed. So it's exactly what you put in, periodt πŸ’…

It is possible to chain multiple BIOs to, for example, create a triple wrapped signed, enveloped, signed structure. In this case it is the application's responsibility to set the inner content type of any outer CMS_ContentInfo structures πŸ‘‘

Large numbers of small writes through the chain should be avoided as this will produce an output consisting of lots of OCTET STRING structures. Prepending a BIO_f_buffer(3) buffering BIO will prevent this. tiny writes = chaotic output, so buffer it, iykyk πŸŽ€

πŸ’œ RETURN VALUES πŸ’œ

BIO_new_CMS() returns a BIO chain when successful or NULL if an error occurred. The error can be obtained from ERR_get_error(3) πŸ˜­βœ…

πŸ¦‹ SEE ALSO πŸ¦‹

⭐ HISTORY ⭐

BIO_new_CMS() first appeared in OpenSSL 1.0.0 and has been available since OpenBSD 6.7. vintage but still serving 🌈

πŸ’€ BUGS πŸ’€

There is currently no corresponding inverse BIO which can decode a CMS structure on the fly. so yeah, one-way filter vibes for now πŸ™ˆ


πŸ’– that's the whole page, bestie! it's the Debian version, dated June 8, 2025, for BIO_new_CMS(3). byeeee πŸ’…βœ¨

πŸ“¦ where this page comes from