secure/lib/libcrypto/man/man3/EVP_EncodeInit.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EVP_ENCODEINIT 3"
 136 .TH EVP_ENCODEINIT 3 "2019-09-10" "1.1.1d" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 EVP_ENCODE_CTX_new, EVP_ENCODE_CTX_free, EVP_ENCODE_CTX_copy, EVP_ENCODE_CTX_num, EVP_EncodeInit, EVP_EncodeUpdate, EVP_EncodeFinal, EVP_EncodeBlock, EVP_DecodeInit, EVP_DecodeUpdate, EVP_DecodeFinal, EVP_DecodeBlock \- EVP base 64 encode/decode routines
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& EVP_ENCODE_CTX *EVP_ENCODE_CTX_new(void);
 149 \& void EVP_ENCODE_CTX_free(EVP_ENCODE_CTX *ctx);
 150 \& int EVP_ENCODE_CTX_copy(EVP_ENCODE_CTX *dctx, EVP_ENCODE_CTX *sctx);
 151 \& int EVP_ENCODE_CTX_num(EVP_ENCODE_CTX *ctx);
 152 \& void EVP_EncodeInit(EVP_ENCODE_CTX *ctx);
 153 \& int EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 154 \&                      const unsigned char *in, int inl);
 155 \& void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl);
 156 \& int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, int n);
 157 \&
 158 \& void EVP_DecodeInit(EVP_ENCODE_CTX *ctx);
 159 \& int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 160 \&                      const unsigned char *in, int inl);
 161 \& int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl);
 162 \& int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, int n);
 163 .Ve
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \s-1EVP\s0 encode routines provide a high level interface to base 64 encoding and
 167 decoding. Base 64 encoding converts binary data into a printable form that uses
 168 the characters A\-Z, a\-z, 0\-9, \*(L"+\*(R" and \*(L"/\*(R" to represent the data. For every 3
 169 bytes of binary data provided 4 bytes of base 64 encoded data will be produced
 170 plus some occasional newlines (see below). If the input data length is not a
 171 multiple of 3 then the output data will be padded at the end using the \*(L"=\*(R"
 172 character.
 173 .PP
 174 \&\fBEVP_ENCODE_CTX_new()\fR allocates, initializes and returns a context to be used for
 175 the encode/decode functions.
 176 .PP
 177 \&\fBEVP_ENCODE_CTX_free()\fR cleans up an encode/decode context \fBctx\fR and frees up the
 178 space allocated to it.
 179 .PP
 180 Encoding of binary data is performed in blocks of 48 input bytes (or less for
 181 the final block). For each 48 byte input block encoded 64 bytes of base 64 data
 182 is output plus an additional newline character (i.e. 65 bytes in total). The
 183 final block (which may be less than 48 bytes) will output 4 bytes for every 3
 184 bytes of input. If the data length is not divisible by 3 then a full 4 bytes is
 185 still output for the final 1 or 2 bytes of input. Similarly a newline character
 186 will also be output.
 187 .PP
 188 \&\fBEVP_EncodeInit()\fR initialises \fBctx\fR for the start of a new encoding operation.
 189 .PP
 190 \&\fBEVP_EncodeUpdate()\fR encode \fBinl\fR bytes of data found in the buffer pointed to by
 191 \&\fBin\fR. The output is stored in the buffer \fBout\fR and the number of bytes output
 192 is stored in \fB*outl\fR. It is the caller's responsibility to ensure that the
 193 buffer at \fBout\fR is sufficiently large to accommodate the output data. Only full
 194 blocks of data (48 bytes) will be immediately processed and output by this
 195 function. Any remainder is held in the \fBctx\fR object and will be processed by a
 196 subsequent call to \fBEVP_EncodeUpdate()\fR or \fBEVP_EncodeFinal()\fR. To calculate the
 197 required size of the output buffer add together the value of \fBinl\fR with the
 198 amount of unprocessed data held in \fBctx\fR and divide the result by 48 (ignore
 199 any remainder). This gives the number of blocks of data that will be processed.
 200 Ensure the output buffer contains 65 bytes of storage for each block, plus an
 201 additional byte for a \s-1NUL\s0 terminator. \fBEVP_EncodeUpdate()\fR may be called
 202 repeatedly to process large amounts of input data. In the event of an error
 203 \&\fBEVP_EncodeUpdate()\fR will set \fB*outl\fR to 0 and return 0. On success 1 will be
 204 returned.
 205 .PP
 206 \&\fBEVP_EncodeFinal()\fR must be called at the end of an encoding operation. It will
 207 process any partial block of data remaining in the \fBctx\fR object. The output
 208 data will be stored in \fBout\fR and the length of the data written will be stored
 209 in \fB*outl\fR. It is the caller's responsibility to ensure that \fBout\fR is
 210 sufficiently large to accommodate the output data which will never be more than
 211 65 bytes plus an additional \s-1NUL\s0 terminator (i.e. 66 bytes in total).
 212 .PP
 213 \&\fBEVP_ENCODE_CTX_copy()\fR can be used to copy a context \fBsctx\fR to a context
 214 \&\fBdctx\fR. \fBdctx\fR must be initialized before calling this function.
 215 .PP
 216 \&\fBEVP_ENCODE_CTX_num()\fR will return the number of as yet unprocessed bytes still to
 217 be encoded or decoded that are pending in the \fBctx\fR object.
 218 .PP
 219 \&\fBEVP_EncodeBlock()\fR encodes a full block of input data in \fBf\fR and of length
 220 \&\fBdlen\fR and stores it in \fBt\fR. For every 3 bytes of input provided 4 bytes of
 221 output data will be produced. If \fBdlen\fR is not divisible by 3 then the block is
 222 encoded as a final block of data and the output is padded such that it is always
 223 divisible by 4. Additionally a \s-1NUL\s0 terminator character will be added. For
 224 example if 16 bytes of input data is provided then 24 bytes of encoded data is
 225 created plus 1 byte for a \s-1NUL\s0 terminator (i.e. 25 bytes in total). The length of
 226 the data generated \fIwithout\fR the \s-1NUL\s0 terminator is returned from the function.
 227 .PP
 228 \&\fBEVP_DecodeInit()\fR initialises \fBctx\fR for the start of a new decoding operation.
 229 .PP
 230 \&\fBEVP_DecodeUpdate()\fR decodes \fBinl\fR characters of data found in the buffer pointed
 231 to by \fBin\fR. The output is stored in the buffer \fBout\fR and the number of bytes
 232 output is stored in \fB*outl\fR. It is the caller's responsibility to ensure that
 233 the buffer at \fBout\fR is sufficiently large to accommodate the output data. This
 234 function will attempt to decode as much data as possible in 4 byte chunks. Any
 235 whitespace, newline or carriage return characters are ignored. Any partial chunk
 236 of unprocessed data (1, 2 or 3 bytes) that remains at the end will be held in
 237 the \fBctx\fR object and processed by a subsequent call to \fBEVP_DecodeUpdate()\fR. If
 238 any illegal base 64 characters are encountered or if the base 64 padding
 239 character \*(L"=\*(R" is encountered in the middle of the data then the function returns
 240 \&\-1 to indicate an error. A return value of 0 or 1 indicates successful
 241 processing of the data. A return value of 0 additionally indicates that the last
 242 input data characters processed included the base 64 padding character \*(L"=\*(R" and
 243 therefore no more non-padding character data is expected to be processed. For
 244 every 4 valid base 64 bytes processed (ignoring whitespace, carriage returns and
 245 line feeds), 3 bytes of binary output data will be produced (or less at the end
 246 of the data where the padding character \*(L"=\*(R" has been used).
 247 .PP
 248 \&\fBEVP_DecodeFinal()\fR must be called at the end of a decoding operation. If there
 249 is any unprocessed data still in \fBctx\fR then the input data must not have been
 250 a multiple of 4 and therefore an error has occurred. The function will return \-1
 251 in this case. Otherwise the function returns 1 on success.
 252 .PP
 253 \&\fBEVP_DecodeBlock()\fR will decode the block of \fBn\fR characters of base 64 data
 254 contained in \fBf\fR and store the result in \fBt\fR. Any leading whitespace will be
 255 trimmed as will any trailing whitespace, newlines, carriage returns or \s-1EOF\s0
 256 characters. After such trimming the length of the data in \fBf\fR must be divisible
 257 by 4. For every 4 input bytes exactly 3 output bytes will be produced. The
 258 output will be padded with 0 bits if necessary to ensure that the output is
 259 always 3 bytes for every 4 input bytes. This function will return the length of
 260 the data decoded or \-1 on error.
 261 .SH "RETURN VALUES"
 262 .IX Header "RETURN VALUES"
 263 \&\fBEVP_ENCODE_CTX_new()\fR returns a pointer to the newly allocated \s-1EVP_ENCODE_CTX\s0
 264 object or \s-1NULL\s0 on error.
 265 .PP
 266 \&\fBEVP_ENCODE_CTX_num()\fR returns the number of bytes pending encoding or decoding in
 267 \&\fBctx\fR.
 268 .PP
 269 \&\fBEVP_EncodeUpdate()\fR returns 0 on error or 1 on success.
 270 .PP
 271 \&\fBEVP_EncodeBlock()\fR returns the number of bytes encoded excluding the \s-1NUL\s0
 272 terminator.
 273 .PP
 274 \&\fBEVP_DecodeUpdate()\fR returns \-1 on error and 0 or 1 on success. If 0 is returned
 275 then no more non-padding base 64 characters are expected.
 276 .PP
 277 \&\fBEVP_DecodeFinal()\fR returns \-1 on error or 1 on success.
 278 .PP
 279 \&\fBEVP_DecodeBlock()\fR returns the length of the data decoded or \-1 on error.
 280 .SH "SEE ALSO"
 281 .IX Header "SEE ALSO"
 282 \&\fBevp\fR\|(7)
 283 .SH "COPYRIGHT"
 284 .IX Header "COPYRIGHT"
 285 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 286 .PP
 287 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 288 this file except in compliance with the License.  You can obtain a copy
 289 in the file \s-1LICENSE\s0 in the source distribution or at
 290 <https://www.openssl.org/source/license.html>.