providers/implementations/include/prov/digestcommon.h

   1 /*
   2  * Copyright 2019-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 #ifndef OSSL_PROVIDERS_DIGESTCOMMON_H
  11 # define OSSL_PROVIDERS_DIGESTCOMMON_H
  12
  13 # include <openssl/core_dispatch.h>
  14 # include <openssl/core_names.h>
  15 # include <openssl/params.h>
  16 # include "prov/providercommon.h"
  17
  18 # ifdef __cplusplus
  19 extern "C" {
  20 # endif
  21
  22 #define PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)             \
  23 static OSSL_FUNC_digest_get_params_fn name##_get_params;                         \
  24 static int name##_get_params(OSSL_PARAM params[])                              \
  25 {                                                                              \
  26     return digest_default_get_params(params, blksize, dgstsize, flags);        \
  27 }
  28
  29 #define PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)                             \
  30 { OSSL_FUNC_DIGEST_GET_PARAMS, (void (*)(void))name##_get_params },            \
  31 { OSSL_FUNC_DIGEST_GETTABLE_PARAMS,                                            \
  32   (void (*)(void))digest_default_gettable_params }
  33
  34 # define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(                            \
  35     name, CTX, blksize, dgstsize, flags, init, upd, fin)                       \
  36 static OSSL_FUNC_digest_newctx_fn name##_newctx;                                 \
  37 static OSSL_FUNC_digest_freectx_fn name##_freectx;                               \
  38 static OSSL_FUNC_digest_dupctx_fn name##_dupctx;                                 \
  39 static void *name##_newctx(void *prov_ctx)                                     \
  40 {                                                                              \
  41     CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) : NULL;    \
  42     return ctx;                                                                \
  43 }                                                                              \
  44 static void name##_freectx(void *vctx)                                         \
  45 {                                                                              \
  46     CTX *ctx = (CTX *)vctx;                                                    \
  47     OPENSSL_clear_free(ctx,  sizeof(*ctx));                                    \
  48 }                                                                              \
  49 static void *name##_dupctx(void *ctx)                                          \
  50 {                                                                              \
  51     CTX *in = (CTX *)ctx;                                                      \
  52     CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret)) : NULL;    \
  53     if (ret != NULL)                                                           \
  54         *ret = *in;                                                            \
  55     return ret;                                                                \
  56 }                                                                              \
  57 static OSSL_FUNC_digest_init_fn name##_internal_init;                          \
  58 static int name##_internal_init(void *ctx)                                     \
  59 {                                                                              \
  60     return ossl_prov_is_running() ? init(ctx) : 0;                              \
  61 }                                                                              \
  62 static OSSL_FUNC_digest_final_fn name##_internal_final;                        \
  63 static int name##_internal_final(void *ctx, unsigned char *out, size_t *outl,  \
  64                                  size_t outsz)                                 \
  65 {                                                                              \
  66     if (ossl_prov_is_running() && outsz >= dgstsize && fin(out, ctx)) {         \
  67         *outl = dgstsize;                                                      \
  68         return 1;                                                              \
  69     }                                                                          \
  70     return 0;                                                                  \
  71 }                                                                              \
  72 PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)                     \
  73 const OSSL_DISPATCH ossl_##name##_functions[] = {                              \
  74     { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx },                \
  75     { OSSL_FUNC_DIGEST_INIT, (void (*)(void))name##_internal_init },           \
  76     { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))upd },                          \
  77     { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))name##_internal_final },         \
  78     { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))name##_freectx },              \
  79     { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))name##_dupctx },                \
  80     PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
  81
  82 # define PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END                               \
  83     { 0, NULL }                                                                \
  84 };
  85
  86 # define IMPLEMENT_digest_functions(                                           \
  87     name, CTX, blksize, dgstsize, flags, init, upd, fin)                       \
  88 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
  89                                           init, upd, fin),                     \
  90 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
  91
  92 # define IMPLEMENT_digest_functions_with_settable_ctx(                         \
  93     name, CTX, blksize, dgstsize, flags, init, upd, fin,                       \
  94     settable_ctx_params, set_ctx_params)                                       \
  95 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_START(name, CTX, blksize, dgstsize, flags, \
  96                                           init, upd, fin),                     \
  97 { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, (void (*)(void))settable_ctx_params }, \
  98 { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))set_ctx_params },           \
  99 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
 100
 101
 102 const OSSL_PARAM *digest_default_gettable_params(void *provctx);
 103 int digest_default_get_params(OSSL_PARAM params[], size_t blksz, size_t paramsz,
 104                               unsigned long flags);
 105
 106 # ifdef __cplusplus
 107 }
 108 # endif
 109
 110 #endif /* OSSL_PROVIDERS_DIGESTCOMMON_H */