doc/man7/provider-cipher.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 provider-cipher - The cipher library E<lt>-E<gt> provider functions
   6
   7 =head1 SYNOPSIS
   8
   9 =for openssl multiple includes
  10
  11  #include <openssl/core_dispatch.h>
  12  #include <openssl/core_names.h>
  13
  14  /*
  15   * None of these are actual functions, but are displayed like this for
  16   * the function signatures for functions that are offered as function
  17   * pointers in OSSL_DISPATCH arrays.
  18   */
  19
  20  /* Context management */
  21  void *OSSL_FUNC_cipher_newctx(void *provctx);
  22  void OSSL_FUNC_cipher_freectx(void *cctx);
  23  void *OSSL_FUNC_cipher_dupctx(void *cctx);
  24
  25  /* Encryption/decryption */
  26  int OSSL_FUNC_cipher_encrypt_init(void *cctx, const unsigned char *key,
  27                                    size_t keylen, const unsigned char *iv,
  28                                    size_t ivlen, const OSSL_PARAM params[]);
  29  int OSSL_FUNC_cipher_decrypt_init(void *cctx, const unsigned char *key,
  30                                    size_t keylen, const unsigned char *iv,
  31                                    size_t ivlen, const OSSL_PARAM params[]);
  32  int OSSL_FUNC_cipher_update(void *cctx, unsigned char *out, size_t *outl,
  33                              size_t outsize, const unsigned char *in, size_t inl);
  34  int OSSL_FUNC_cipher_final(void *cctx, unsigned char *out, size_t *outl,
  35                             size_t outsize);
  36  int OSSL_FUNC_cipher_cipher(void *cctx, unsigned char *out, size_t *outl,
  37                              size_t outsize, const unsigned char *in, size_t inl);
  38
  39  /* Cipher parameter descriptors */
  40  const OSSL_PARAM *OSSL_FUNC_cipher_gettable_params(void *provctx);
  41
  42  /* Cipher operation parameter descriptors */
  43  const OSSL_PARAM *OSSL_FUNC_cipher_gettable_ctx_params(void *cctx,
  44                                                         void *provctx);
  45  const OSSL_PARAM *OSSL_FUNC_cipher_settable_ctx_params(void *cctx,
  46                                                         void *provctx);
  47
  48  /* Cipher parameters */
  49  int OSSL_FUNC_cipher_get_params(OSSL_PARAM params[]);
  50
  51  /* Cipher operation parameters */
  52  int OSSL_FUNC_cipher_get_ctx_params(void *cctx, OSSL_PARAM params[]);
  53  int OSSL_FUNC_cipher_set_ctx_params(void *cctx, const OSSL_PARAM params[]);
  54
  55 =head1 DESCRIPTION
  56
  57 This documentation is primarily aimed at provider authors. See L<provider(7)>
  58 for further information.
  59
  60 The CIPHER operation enables providers to implement cipher algorithms and make
  61 them available to applications via the API functions L<EVP_EncryptInit_ex(3)>,
  62 L<EVP_EncryptUpdate(3)> and L<EVP_EncryptFinal(3)> (as well as the decrypt
  63 equivalents and other related functions).
  64
  65 All "functions" mentioned here are passed as function pointers between
  66 F<libcrypto> and the provider in B<OSSL_DISPATCH> arrays via
  67 B<OSSL_ALGORITHM> arrays that are returned by the provider's
  68 provider_query_operation() function
  69 (see L<provider-base(7)/Provider Functions>).
  70
  71 All these "functions" have a corresponding function type definition
  72 named B<OSSL_FUNC_{name}_fn>, and a helper function to retrieve the
  73 function pointer from an B<OSSL_DISPATCH> element named
  74 B<OSSL_FUNC_{name}>.
  75 For example, the "function" OSSL_FUNC_cipher_newctx() has these:
  76
  77  typedef void *(OSSL_OSSL_FUNC_cipher_newctx_fn)(void *provctx);
  78  static ossl_inline OSSL_OSSL_FUNC_cipher_newctx_fn
  79      OSSL_FUNC_cipher_newctx(const OSSL_DISPATCH *opf);
  80
  81 B<OSSL_DISPATCH> arrays are indexed by numbers that are provided as
  82 macros in L<openssl-core_dispatch.h(7)>, as follows:
  83
  84  OSSL_FUNC_cipher_newctx               OSSL_FUNC_CIPHER_NEWCTX
  85  OSSL_FUNC_cipher_freectx              OSSL_FUNC_CIPHER_FREECTX
  86  OSSL_FUNC_cipher_dupctx               OSSL_FUNC_CIPHER_DUPCTX
  87
  88  OSSL_FUNC_cipher_encrypt_init         OSSL_FUNC_CIPHER_ENCRYPT_INIT
  89  OSSL_FUNC_cipher_decrypt_init         OSSL_FUNC_CIPHER_DECRYPT_INIT
  90  OSSL_FUNC_cipher_update               OSSL_FUNC_CIPHER_UPDATE
  91  OSSL_FUNC_cipher_final                OSSL_FUNC_CIPHER_FINAL
  92  OSSL_FUNC_cipher_cipher               OSSL_FUNC_CIPHER_CIPHER
  93
  94  OSSL_FUNC_cipher_get_params           OSSL_FUNC_CIPHER_GET_PARAMS
  95  OSSL_FUNC_cipher_get_ctx_params       OSSL_FUNC_CIPHER_GET_CTX_PARAMS
  96  OSSL_FUNC_cipher_set_ctx_params       OSSL_FUNC_CIPHER_SET_CTX_PARAMS
  97
  98  OSSL_FUNC_cipher_gettable_params      OSSL_FUNC_CIPHER_GETTABLE_PARAMS
  99  OSSL_FUNC_cipher_gettable_ctx_params  OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS
 100  OSSL_FUNC_cipher_settable_ctx_params  OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS
 101
 102 A cipher algorithm implementation may not implement all of these functions.
 103 In order to be a consistent set of functions there must at least be a complete
 104 set of "encrypt" functions, or a complete set of "decrypt" functions, or a
 105 single "cipher" function.
 106 In all cases both the OSSL_FUNC_cipher_newctx and OSSL_FUNC_cipher_freectx functions must be
 107 present.
 108 All other functions are optional.
 109
 110 =head2 Context Management Functions
 111
 112 OSSL_FUNC_cipher_newctx() should create and return a pointer to a provider side
 113 structure for holding context information during a cipher operation.
 114 A pointer to this context will be passed back in a number of the other cipher
 115 operation function calls.
 116 The parameter I<provctx> is the provider context generated during provider
 117 initialisation (see L<provider(7)>).
 118
 119 OSSL_FUNC_cipher_freectx() is passed a pointer to the provider side cipher context in
 120 the I<cctx> parameter.
 121 This function should free any resources associated with that context.
 122
 123 OSSL_FUNC_cipher_dupctx() should duplicate the provider side cipher context in the
 124 I<cctx> parameter and return the duplicate copy.
 125
 126 =head2 Encryption/Decryption Functions
 127
 128 OSSL_FUNC_cipher_encrypt_init() initialises a cipher operation for encryption given a
 129 newly created provider side cipher context in the I<cctx> parameter.
 130 The key to be used is given in I<key> which is I<keylen> bytes long.
 131 The IV to be used is given in I<iv> which is I<ivlen> bytes long.
 132 The I<params>, if not NULL, should be set on the context in a manner similar to
 133 using OSSL_FUNC_cipher_set_ctx_params().
 134
 135 OSSL_FUNC_cipher_decrypt_init() is the same as OSSL_FUNC_cipher_encrypt_init() except that it
 136 initialises the context for a decryption operation.
 137
 138 OSSL_FUNC_cipher_update() is called to supply data to be encrypted/decrypted as part of
 139 a previously initialised cipher operation.
 140 The I<cctx> parameter contains a pointer to a previously initialised provider
 141 side context.
 142 OSSL_FUNC_cipher_update() should encrypt/decrypt I<inl> bytes of data at the location
 143 pointed to by I<in>.
 144 The encrypted data should be stored in I<out> and the amount of data written to
 145 I<*outl> which should not exceed I<outsize> bytes.
 146 OSSL_FUNC_cipher_update() may be called multiple times for a single cipher operation.
 147 It is the responsibility of the cipher implementation to handle input lengths
 148 that are not multiples of the block length.
 149 In such cases a cipher implementation will typically cache partial blocks of
 150 input data until a complete block is obtained.
 151 I<out> may be the same location as I<in> but it should not partially overlap.
 152 The same expectations apply to I<outsize> as documented for
 153 L<EVP_EncryptUpdate(3)> and L<EVP_DecryptUpdate(3)>.
 154
 155 OSSL_FUNC_cipher_final() completes an encryption or decryption started through previous
 156 OSSL_FUNC_cipher_encrypt_init() or OSSL_FUNC_cipher_decrypt_init(), and OSSL_FUNC_cipher_update()
 157 calls.
 158 The I<cctx> parameter contains a pointer to the provider side context.
 159 Any final encryption/decryption output should be written to I<out> and the
 160 amount of data written to I<*outl> which should not exceed I<outsize> bytes.
 161 The same expectations apply to I<outsize> as documented for
 162 L<EVP_EncryptFinal(3)> and L<EVP_DecryptFinal(3)>.
 163
 164 OSSL_FUNC_cipher_cipher() performs encryption/decryption using the provider side cipher
 165 context in the I<cctx> parameter that should have been previously initialised via
 166 a call to OSSL_FUNC_cipher_encrypt_init() or OSSL_FUNC_cipher_decrypt_init().
 167 This should call the raw underlying cipher function without any padding.
 168 This will be invoked in the provider as a result of the application calling
 169 L<EVP_Cipher(3)>.
 170 The application is responsible for ensuring that the input is a multiple of the
 171 block length.
 172 The data to be encrypted/decrypted will be in I<in>, and it will be I<inl> bytes
 173 in length.
 174 The output from the encryption/decryption should be stored in I<out> and the
 175 amount of data stored should be put in I<*outl> which should be no more than
 176 I<outsize> bytes.
 177
 178 =head2 Cipher Parameters
 179
 180 See L<OSSL_PARAM(3)> for further details on the parameters structure used by
 181 these functions.
 182
 183 OSSL_FUNC_cipher_get_params() gets details of the algorithm implementation
 184 and stores them in I<params>.
 185
 186 OSSL_FUNC_cipher_set_ctx_params() sets cipher operation parameters for the
 187 provider side cipher context I<cctx> to I<params>.
 188 Any parameter settings are additional to any that were previously set.
 189 Passing NULL for I<params> should return true.
 190
 191 OSSL_FUNC_cipher_get_ctx_params() gets cipher operation details details from
 192 the given provider side cipher context I<cctx> and stores them in I<params>.
 193 Passing NULL for I<params> should return true.
 194
 195 OSSL_FUNC_cipher_gettable_params(), OSSL_FUNC_cipher_gettable_ctx_params(),
 196 and OSSL_FUNC_cipher_settable_ctx_params() all return constant B<OSSL_PARAM>
 197 arrays as descriptors of the parameters that OSSL_FUNC_cipher_get_params(),
 198 OSSL_FUNC_cipher_get_ctx_params(), and OSSL_FUNC_cipher_set_ctx_params()
 199 can handle, respectively.  OSSL_FUNC_cipher_gettable_ctx_params() and
 200 OSSL_FUNC_cipher_settable_ctx_params() will return the parameters associated
 201 with the provider side context I<cctx> in its current state if it is
 202 not NULL.  Otherwise, they return the parameters associated with the
 203 provider side algorithm I<provctx>.
 204
 205 Parameters currently recognised by built-in ciphers are listed in
 206 L<EVP_EncryptInit(3)/PARAMETERS>.
 207 Not all parameters are relevant to, or are understood by all ciphers.
 208
 209 =head1 RETURN VALUES
 210
 211 OSSL_FUNC_cipher_newctx() and OSSL_FUNC_cipher_dupctx() should return the newly created
 212 provider side cipher context, or NULL on failure.
 213
 214 OSSL_FUNC_cipher_encrypt_init(), OSSL_FUNC_cipher_decrypt_init(), OSSL_FUNC_cipher_update(),
 215 OSSL_FUNC_cipher_final(), OSSL_FUNC_cipher_cipher(), OSSL_FUNC_cipher_get_params(),
 216 OSSL_FUNC_cipher_get_ctx_params() and OSSL_FUNC_cipher_set_ctx_params() should return 1 for
 217 success or 0 on error.
 218
 219 OSSL_FUNC_cipher_gettable_params(), OSSL_FUNC_cipher_gettable_ctx_params() and
 220 OSSL_FUNC_cipher_settable_ctx_params() should return a constant B<OSSL_PARAM>
 221 array, or NULL if none is offered.
 222
 223 =head1 SEE ALSO
 224
 225 L<provider(7)>, L<OSSL_PROVIDER-FIPS(7)>, L<OSSL_PROVIDER-default(7)>,
 226 L<OSSL_PROVIDER-legacy(7)>,
 227 L<EVP_CIPHER-AES(7)>, L<EVP_CIPHER-ARIA(7)>, L<EVP_CIPHER-BLOWFISH(7)>,
 228 L<EVP_CIPHER-CAMELLIA(7)>, L<EVP_CIPHER-CAST(7)>, L<EVP_CIPHER-CHACHA(7)>,
 229 L<EVP_CIPHER-DES(7)>, L<EVP_CIPHER-IDEA(7)>, L<EVP_CIPHER-RC2(7)>,
 230 L<EVP_CIPHER-RC4(7)>, L<EVP_CIPHER-RC5(7)>, L<EVP_CIPHER-SEED(7)>,
 231 L<EVP_CIPHER-SM4(7)>,
 232 L<life_cycle-cipher(7)>, L<EVP_EncryptInit(3)>
 233
 234 =head1 HISTORY
 235
 236 The provider CIPHER interface was introduced in OpenSSL 3.0.
 237
 238 =head1 COPYRIGHT
 239
 240 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 241
 242 Licensed under the Apache License 2.0 (the "License").  You may not use
 243 this file except in compliance with the License.  You can obtain a copy
 244 in the file LICENSE in the source distribution or at
 245 L<https://www.openssl.org/source/license.html>.
 246
 247 =cut