crypto/openssl/doc/crypto/EVP_EncodeInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_EncodeInit, EVP_EncodeUpdate, EVP_EncodeFinal, EVP_EncodeBlock,
   6 EVP_DecodeInit, EVP_DecodeUpdate, EVP_DecodeFinal, EVP_DecodeBlock - EVP base 64
   7 encode/decode routines
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/evp.h>
  12
  13  void EVP_EncodeInit(EVP_ENCODE_CTX *ctx);
  14  void EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
  15                        const unsigned char *in, int inl);
  16  void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl);
  17  int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, int n);
  18
  19  void EVP_DecodeInit(EVP_ENCODE_CTX *ctx);
  20  int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
  21                       const unsigned char *in, int inl);
  22  int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned
  23                      char *out, int *outl);
  24  int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, int n);
  25
  26 =head1 DESCRIPTION
  27
  28 The EVP encode routines provide a high level interface to base 64 encoding and
  29 decoding. Base 64 encoding converts binary data into a printable form that uses
  30 the characters A-Z, a-z, 0-9, "+" and "/" to represent the data. For every 3
  31 bytes of binary data provided 4 bytes of base 64 encoded data will be produced
  32 plus some occasional newlines (see below). If the input data length is not a
  33 multiple of 3 then the output data will be padded at the end using the "="
  34 character.
  35
  36 Encoding of binary data is performed in blocks of 48 input bytes (or less for
  37 the final block). For each 48 byte input block encoded 64 bytes of base 64 data
  38 is output plus an additional newline character (i.e. 65 bytes in total). The
  39 final block (which may be less than 48 bytes) will output 4 bytes for every 3
  40 bytes of input. If the data length is not divisible by 3 then a full 4 bytes is
  41 still output for the final 1 or 2 bytes of input. Similarly a newline character
  42 will also be output.
  43
  44 EVP_EncodeInit() initialises B<ctx> for the start of a new encoding operation.
  45
  46 EVP_EncodeUpdate() encode B<inl> bytes of data found in the buffer pointed to by
  47 B<in>. The output is stored in the buffer B<out> and the number of bytes output
  48 is stored in B<*outl>. It is the caller's responsibility to ensure that the
  49 buffer at B<out> is sufficiently large to accommodate the output data. Only full
  50 blocks of data (48 bytes) will be immediately processed and output by this
  51 function. Any remainder is held in the B<ctx> object and will be processed by a
  52 subsequent call to EVP_EncodeUpdate() or EVP_EncodeFinal(). To calculate the
  53 required size of the output buffer add together the value of B<inl> with the
  54 amount of unprocessed data held in B<ctx> and divide the result by 48 (ignore
  55 any remainder). This gives the number of blocks of data that will be processed.
  56 Ensure the output buffer contains 65 bytes of storage for each block, plus an
  57 additional byte for a NUL terminator. EVP_EncodeUpdate() may be called
  58 repeatedly to process large amounts of input data. In the event of an error
  59 EVP_EncodeUpdate() will set B<*outl> to 0.
  60
  61 EVP_EncodeFinal() must be called at the end of an encoding operation. It will
  62 process any partial block of data remaining in the B<ctx> object. The output
  63 data will be stored in B<out> and the length of the data written will be stored
  64 in B<*outl>. It is the caller's responsibility to ensure that B<out> is
  65 sufficiently large to accommodate the output data which will never be more than
  66 65 bytes plus an additional NUL terminator (i.e. 66 bytes in total).
  67
  68 EVP_EncodeBlock() encodes a full block of input data in B<f> and of length
  69 B<dlen> and stores it in B<t>. For every 3 bytes of input provided 4 bytes of
  70 output data will be produced. If B<dlen> is not divisible by 3 then the block is
  71 encoded as a final block of data and the output is padded such that it is always
  72 divisible by 4. Additionally a NUL terminator character will be added. For
  73 example if 16 bytes of input data is provided then 24 bytes of encoded data is
  74 created plus 1 byte for a NUL terminator (i.e. 25 bytes in total). The length of
  75 the data generated I<without> the NUL terminator is returned from the function.
  76
  77 EVP_DecodeInit() initialises B<ctx> for the start of a new decoding operation.
  78
  79 EVP_DecodeUpdate() decodes B<inl> characters of data found in the buffer pointed
  80 to by B<in>. The output is stored in the buffer B<out> and the number of bytes
  81 output is stored in B<*outl>. It is the caller's responsibility to ensure that
  82 the buffer at B<out> is sufficiently large to accommodate the output data. This
  83 function will attempt to decode as much data as possible in 4 byte chunks. Any
  84 whitespace, newline or carriage return characters are ignored. Any partial chunk
  85 of unprocessed data (1, 2 or 3 bytes) that remains at the end will be held in
  86 the B<ctx> object and processed by a subsequent call to EVP_DecodeUpdate(). If
  87 any illegal base 64 characters are encountered or if the base 64 padding
  88 character "=" is encountered in the middle of the data then the function returns
  89 -1 to indicate an error. A return value of 0 or 1 indicates successful
  90 processing of the data. A return value of 0 additionally indicates that the last
  91 input data characters processed included the base 64 padding character "=" and
  92 therefore no more non-padding character data is expected to be processed. For
  93 every 4 valid base 64 bytes processed (ignoring whitespace, carriage returns and
  94 line feeds), 3 bytes of binary output data will be produced (or less at the end
  95 of the data where the padding character "=" has been used).
  96
  97 EVP_DecodeFinal() must be called at the end of a decoding operation. If there
  98 is any unprocessed data still in B<ctx> then the input data must not have been
  99 a multiple of 4 and therefore an error has occurred. The function will return -1
 100 in this case. Otherwise the function returns 1 on success.
 101
 102 EVP_DecodeBlock() will decode the block of B<n> characters of base 64 data
 103 contained in B<f> and store the result in B<t>. Any leading whitespace will be
 104 trimmed as will any trailing whitespace, newlines, carriage returns or EOF
 105 characters. After such trimming the length of the data in B<f> must be divisbile
 106 by 4. For every 4 input bytes exactly 3 output bytes will be produced. The
 107 output will be padded with 0 bits if necessary to ensure that the output is
 108 always 3 bytes for every 4 input bytes. This function will return the length of
 109 the data decoded or -1 on error.
 110
 111 =head1 RETURN VALUES
 112
 113 EVP_EncodeBlock() returns the number of bytes encoded excluding the NUL
 114 terminator.
 115
 116 EVP_DecodeUpdate() returns -1 on error and 0 or 1 on success. If 0 is returned
 117 then no more non-padding base 64 characters are expected.
 118
 119 EVP_DecodeFinal() returns -1 on error or 1 on success.
 120
 121 EVP_DecodeBlock() returns the length of the data decoded or -1 on error.
 122
 123 =head1 SEE ALSO
 124
 125 L<evp(3)>
 126
 127 =cut