ENCODER / DECODER: Add functions to encode/decode to/from a buffer

[openssl.git] / doc / man3 / OSSL_ENCODER_to_bio.pod

diff --git a/doc/man3/OSSL_ENCODER_to_bio.pod b/doc/man3/OSSL_ENCODER_to_bio.pod
index 6f75f592e44301708685ba3a83a2293119654cfe..f28228bf10b24c4b08f58265e3b40c7735c0ec0c 100644 (file)
--- a/doc/man3/OSSL_ENCODER_to_bio.pod
+++ b/doc/man3/OSSL_ENCODER_to_bio.pod
@@ -2,6 +2,7 @@
 
 =head1 NAME
 
+OSSL_ENCODER_to_data,
 OSSL_ENCODER_to_bio,
 OSSL_ENCODER_to_fp
 - Routines to perform an encoding
@@ -10,6 +11,8 @@ OSSL_ENCODER_to_fp
 
  #include <openssl/encoder.h>
 
+ int OSSL_ENCODER_to_data(OSSL_ENCODER_CTX *ctx, unsigned char **pdata,
+                          size_t *pdata_len);
  int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out);
  int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp);
 
@@ -24,20 +27,33 @@ is undefined.
 
 =head1 DESCRIPTION
 
+OSSL_ENCODER_to_data() runs the encoding process for the context I<ctx>,
+with the output going to the I<*pdata> and I<*pdata_len>.
+If I<*pdata> is NULL when OSSL_ENCODER_to_data() is called, a buffer will be
+allocated using L<OPENSSL_zalloc(3)>, and I<*pdata> will be set to point at
+the start of that buffer, and I<*pdata_len> will be assigned its length when
+OSSL_ENCODER_to_data() returns.
+If I<*pdata> is non-NULL when OSSL_ENCODER_to_data() is called, I<*pdata_len>
+is assumed to have its size.  In this case, I<*pdata> will be set to point
+after the encoded bytes, and I<*pdata_len> will be assigned the number of
+remaining bytes.
+
 OSSL_ENCODER_to_bio() runs the encoding process for the context I<ctx>, with
-the output going to the B<BIO> I<out>.  The application is required to set
-up the B<BIO> properly, for example to have it in text or binary mode if
-that's appropriate.
+the output going to the B<BIO> I<out>.
+
+OSSL_ENCODER_to_fp() does the same thing as OSSL_ENCODER_to_bio(), except
+that the output is going to the B<FILE> I<fp>.
 
 =for comment Know your encoder!
 
-OSSL_ENCODER_to_fp() does the same thing as OSSL_ENCODER_to_bio(),
-except that the output is going to the B<FILE> I<fp>.
+For OSSL_ENCODER_to_bio() and OSSL_ENCODER_to_fp(), the application is
+required to set up the B<BIO> or B<FILE> properly, for example to have
+it in text or binary mode as is appropriate for the encoder output type.
 
 =head1 RETURN VALUES
 
-OSSL_ENCODER_to_bio() and OSSL_ENCODER_to_fp() return 1 on success, or 0 on
-failure.
+OSSL_ENCODER_to_bio(), OSSL_ENCODER_to_fp() and OSSL_ENCODER_to_data()
+return 1 on success, or 0 on failure.
 
 =begin comment TODO(3.0) Add examples!