providers/implementations/ciphers/cipher_null.c

   1 /*
   2  * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <string.h>
  11 #include <openssl/crypto.h>
  12 #include <openssl/core_dispatch.h>
  13 #include "prov/implementations.h"
  14 #include "prov/ciphercommon.h"
  15 #include "prov/providercommonerr.h"
  16
  17 typedef struct prov_cipher_null_ctx_st {
  18     int enc;
  19     size_t tlsmacsize;
  20     const unsigned char *tlsmac;
  21 } PROV_CIPHER_NULL_CTX;
  22
  23 static OSSL_FUNC_cipher_newctx_fn null_newctx;
  24 static void *null_newctx(void *provctx)
  25 {
  26     return OPENSSL_zalloc(sizeof(PROV_CIPHER_NULL_CTX));
  27 }
  28
  29 static OSSL_FUNC_cipher_freectx_fn null_freectx;
  30 static void null_freectx(void *vctx)
  31 {
  32     OPENSSL_free(vctx);
  33 }
  34
  35 static OSSL_FUNC_cipher_encrypt_init_fn null_einit;
  36 static int null_einit(void *vctx, const unsigned char *key, size_t keylen,
  37                       const unsigned char *iv, size_t ivlen)
  38 {
  39     PROV_CIPHER_NULL_CTX *ctx = (PROV_CIPHER_NULL_CTX *)vctx;
  40
  41     ctx->enc = 1;
  42     return 1;
  43 }
  44
  45 static OSSL_FUNC_cipher_decrypt_init_fn null_dinit;
  46 static int null_dinit(void *vctx, const unsigned char *key, size_t keylen,
  47                       const unsigned char *iv, size_t ivlen)
  48 {
  49     return 1;
  50 }
  51
  52 static OSSL_FUNC_cipher_cipher_fn null_cipher;
  53 static int null_cipher(void *vctx, unsigned char *out, size_t *outl,
  54                        size_t outsize, const unsigned char *in, size_t inl)
  55 {
  56     PROV_CIPHER_NULL_CTX *ctx = (PROV_CIPHER_NULL_CTX *)vctx;
  57
  58     if (!ctx->enc && ctx->tlsmacsize > 0) {
  59         /*
  60          * TLS NULL cipher as per:
  61          * https://tools.ietf.org/html/rfc5246#section-6.2.3.1
  62          */
  63         if (inl < ctx->tlsmacsize)
  64             return 0;
  65         ctx->tlsmac = in + inl - ctx->tlsmacsize;
  66         inl -= ctx->tlsmacsize;
  67     }
  68     if (outsize < inl)
  69         return 0;
  70     if (in != out)
  71         memcpy(out, in, inl);
  72     *outl = inl;
  73     return 1;
  74 }
  75
  76 static OSSL_FUNC_cipher_final_fn null_final;
  77 static int null_final(void *vctx, unsigned char *out, size_t *outl,
  78                       size_t outsize)
  79 {
  80     *outl = 0;
  81     return 1;
  82 }
  83
  84 static OSSL_FUNC_cipher_get_params_fn null_get_params;
  85 static int null_get_params(OSSL_PARAM params[])
  86 {
  87     return cipher_generic_get_params(params, 0, 0, 0, 8, 0);
  88 }
  89
  90 static const OSSL_PARAM null_known_gettable_ctx_params[] = {
  91     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  92     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
  93     { OSSL_CIPHER_PARAM_TLS_MAC, OSSL_PARAM_OCTET_PTR, NULL, 0, OSSL_PARAM_UNMODIFIED },
  94     OSSL_PARAM_END
  95 };
  96
  97 static OSSL_FUNC_cipher_gettable_ctx_params_fn null_gettable_ctx_params;
  98 static const OSSL_PARAM *null_gettable_ctx_params(void)
  99 {
 100     return null_known_gettable_ctx_params;
 101 }
 102
 103 static OSSL_FUNC_cipher_get_ctx_params_fn null_get_ctx_params;
 104 static int null_get_ctx_params(void *vctx, OSSL_PARAM params[])
 105 {
 106     PROV_CIPHER_NULL_CTX *ctx = (PROV_CIPHER_NULL_CTX *)vctx;
 107     OSSL_PARAM *p;
 108
 109     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
 110     if (p != NULL && !OSSL_PARAM_set_size_t(p, 0)) {
 111         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 112         return 0;
 113     }
 114     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
 115     if (p != NULL && !OSSL_PARAM_set_size_t(p, 0)) {
 116         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 117         return 0;
 118     }
 119     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_TLS_MAC);
 120     if (p != NULL
 121         && !OSSL_PARAM_set_octet_ptr(p, ctx->tlsmac, ctx->tlsmacsize)) {
 122         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 123         return 0;
 124     }
 125     return 1;
 126 }
 127
 128 static const OSSL_PARAM null_known_settable_ctx_params[] = {
 129     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_TLS_MAC_SIZE, NULL),
 130     OSSL_PARAM_END
 131 };
 132
 133 static OSSL_FUNC_cipher_settable_ctx_params_fn null_settable_ctx_params;
 134 static const OSSL_PARAM *null_settable_ctx_params(void)
 135 {
 136     return null_known_settable_ctx_params;
 137 }
 138
 139
 140 static OSSL_FUNC_cipher_set_ctx_params_fn null_set_ctx_params;
 141 static int null_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 142 {
 143     PROV_CIPHER_NULL_CTX *ctx = (PROV_CIPHER_NULL_CTX *)vctx;
 144     const OSSL_PARAM *p;
 145
 146     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_MAC_SIZE);
 147     if (p != NULL) {
 148         if (!OSSL_PARAM_get_size_t(p, &ctx->tlsmacsize)) {
 149             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 150             return 0;
 151         }
 152     }
 153
 154     return 1;
 155 }
 156
 157 const OSSL_DISPATCH null_functions[] = {
 158     { OSSL_FUNC_CIPHER_NEWCTX,
 159       (void (*)(void)) null_newctx },
 160     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) null_freectx },
 161     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) null_newctx },
 162     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))null_einit },
 163     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))null_dinit },
 164     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))null_cipher },
 165     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))null_final },
 166     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))null_cipher },
 167     { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void)) null_get_params },
 168     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
 169         (void (*)(void))cipher_generic_gettable_params },
 170     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))null_get_ctx_params },
 171     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
 172       (void (*)(void))null_gettable_ctx_params },
 173     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, (void (*)(void))null_set_ctx_params },
 174     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
 175       (void (*)(void))null_settable_ctx_params },
 176     { 0, NULL }
 177 };