/* * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. * * Licensed under the Apache License 2.0 (the "License"). You may not use * this file except in compliance with the License. You can obtain a copy * in the file LICENSE in the source distribution or at * https://www.openssl.org/source/license.html */ #ifndef OSSL_CORE_NUMBERS_H # define OSSL_CORE_NUMBERS_H # include # include # ifdef __cplusplus extern "C" { # endif /*- * Identities * ---------- * * All series start with 1, to allow 0 to be an array terminator. * For any FUNC identity, we also provide a function signature typedef * and a static inline function to extract a function pointer from a * OSSL_DISPATCH element in a type safe manner. * * Names: * for any function base name 'foo' (uppercase form 'FOO'), we will have * the following: * - a macro for the identity with the name OSSL_FUNC_'FOO' or derivates * thereof (to be specified further down) * - a function signature typedef with the name OSSL_'foo'_fn * - a function pointer extractor function with the name OSSL_'foo' */ /* * Helper macro to create the function signature typedef and the extractor * |type| is the return-type of the function, |name| is the name of the * function to fetch, and |args| is a parenthesized list of parameters * for the function (that is, it is |name|'s function signature). */ #define OSSL_CORE_MAKE_FUNC(type,name,args) \ typedef type (OSSL_##name##_fn)args; \ static ossl_inline \ OSSL_##name##_fn *OSSL_get_##name(const OSSL_DISPATCH *opf) \ { \ return (OSSL_##name##_fn *)opf->function; \ } /* * Core function identities, for the two OSSL_DISPATCH tables being passed * in the OSSL_provider_init call. * * 0 serves as a marker for the end of the OSSL_DISPATCH array, and must * therefore NEVER be used as a function identity. */ /* Functions provided by the Core to the provider, reserved numbers 1-1023 */ # define OSSL_FUNC_CORE_GET_PARAM_TYPES 1 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, core_get_param_types,(const OSSL_PROVIDER *prov)) # define OSSL_FUNC_CORE_GET_PARAMS 2 OSSL_CORE_MAKE_FUNC(int,core_get_params,(const OSSL_PROVIDER *prov, OSSL_PARAM params[])) # define OSSL_FUNC_CORE_THREAD_START 3 OSSL_CORE_MAKE_FUNC(int,core_thread_start,(const OSSL_PROVIDER *prov, OSSL_thread_stop_handler_fn handfn)) # define OSSL_FUNC_CORE_PUT_ERROR 4 OSSL_CORE_MAKE_FUNC(void,core_put_error, (const OSSL_PROVIDER *prov, uint32_t reason, const char *file, int line)) # define OSSL_FUNC_CORE_ADD_ERROR_VDATA 5 OSSL_CORE_MAKE_FUNC(void,core_add_error_vdata,(const OSSL_PROVIDER *prov, int num, va_list args)) # define OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT 6 OSSL_CORE_MAKE_FUNC(OPENSSL_CTX *,core_get_library_context, (const OSSL_PROVIDER *prov)) /* Memory allocation, freeing, clearing. */ #define OSSL_FUNC_CRYPTO_MALLOC 10 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_malloc, (size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_ZALLOC 11 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_zalloc, (size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_MEMDUP 12 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_memdup, (const void *str, size_t siz, const char *file, int line)) #define OSSL_FUNC_CRYPTO_STRDUP 13 OSSL_CORE_MAKE_FUNC(char *, CRYPTO_strdup, (const char *str, const char *file, int line)) #define OSSL_FUNC_CRYPTO_STRNDUP 14 OSSL_CORE_MAKE_FUNC(char *, CRYPTO_strndup, (const char *str, size_t s, const char *file, int line)) #define OSSL_FUNC_CRYPTO_FREE 15 OSSL_CORE_MAKE_FUNC(void, CRYPTO_free, (void *ptr, const char *file, int line)) #define OSSL_FUNC_CRYPTO_CLEAR_FREE 16 OSSL_CORE_MAKE_FUNC(void, CRYPTO_clear_free, (void *ptr, size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_REALLOC 17 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_realloc, (void *addr, size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_CLEAR_REALLOC 18 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_clear_realloc, (void *addr, size_t old_num, size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_SECURE_MALLOC 19 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_secure_malloc, (size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_SECURE_ZALLOC 20 OSSL_CORE_MAKE_FUNC(void *, CRYPTO_secure_zalloc, (size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_SECURE_FREE 21 OSSL_CORE_MAKE_FUNC(void, CRYPTO_secure_free, (void *ptr, const char *file, int line)) #define OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE 22 OSSL_CORE_MAKE_FUNC(void, CRYPTO_secure_clear_free, (void *ptr, size_t num, const char *file, int line)) #define OSSL_FUNC_CRYPTO_SECURE_ALLOCATED 23 OSSL_CORE_MAKE_FUNC(int, CRYPTO_secure_allocated, (const void *ptr)) #define OSSL_FUNC_OPENSSL_CLEANSE 24 OSSL_CORE_MAKE_FUNC(void, OPENSSL_cleanse, (void *ptr, size_t len)) # define OSSL_FUNC_OPENSSL_HEXSTR2BUF 25 OSSL_CORE_MAKE_FUNC(unsigned char *, OPENSSL_hexstr2buf, (const char *str, long *len)) /* Functions provided by the provider to the Core, reserved numbers 1024-1535 */ # define OSSL_FUNC_PROVIDER_TEARDOWN 1024 OSSL_CORE_MAKE_FUNC(void,provider_teardown,(void *provctx)) # define OSSL_FUNC_PROVIDER_GET_PARAM_TYPES 1025 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *, provider_get_param_types,(void *provctx)) # define OSSL_FUNC_PROVIDER_GET_PARAMS 1026 OSSL_CORE_MAKE_FUNC(int,provider_get_params,(void *provctx, OSSL_PARAM params[])) # define OSSL_FUNC_PROVIDER_QUERY_OPERATION 1027 OSSL_CORE_MAKE_FUNC(const OSSL_ALGORITHM *,provider_query_operation, (void *provctx, int operation_id, const int *no_store)) # define OSSL_FUNC_PROVIDER_GET_REASON_STRINGS 1028 OSSL_CORE_MAKE_FUNC(const OSSL_ITEM *,provider_get_reason_strings, (void *provctx)) /* Digests */ # define OSSL_OP_DIGEST 1 # define OSSL_FUNC_DIGEST_NEWCTX 1 # define OSSL_FUNC_DIGEST_INIT 2 # define OSSL_FUNC_DIGEST_UPDATE 3 # define OSSL_FUNC_DIGEST_FINAL 4 # define OSSL_FUNC_DIGEST_DIGEST 5 # define OSSL_FUNC_DIGEST_FREECTX 6 # define OSSL_FUNC_DIGEST_DUPCTX 7 # define OSSL_FUNC_DIGEST_SIZE 8 # define OSSL_FUNC_DIGEST_BLOCK_SIZE 9 # define OSSL_FUNC_DIGEST_SET_PARAMS 10 # define OSSL_FUNC_DIGEST_GET_PARAMS 11 OSSL_CORE_MAKE_FUNC(void *, OP_digest_newctx, (void *provctx)) OSSL_CORE_MAKE_FUNC(int, OP_digest_init, (void *dctx)) OSSL_CORE_MAKE_FUNC(int, OP_digest_update, (void *dctx, const unsigned char *in, size_t inl)) OSSL_CORE_MAKE_FUNC(int, OP_digest_final, (void *dctx, unsigned char *out, size_t *outl, size_t outsz)) OSSL_CORE_MAKE_FUNC(int, OP_digest_digest, (void *provctx, const unsigned char *in, size_t inl, unsigned char *out, size_t *out_l, size_t outsz)) OSSL_CORE_MAKE_FUNC(void, OP_digest_cleanctx, (void *dctx)) OSSL_CORE_MAKE_FUNC(void, OP_digest_freectx, (void *dctx)) OSSL_CORE_MAKE_FUNC(void *, OP_digest_dupctx, (void *dctx)) OSSL_CORE_MAKE_FUNC(size_t, OP_digest_size, (void)) OSSL_CORE_MAKE_FUNC(size_t, OP_digest_block_size, (void)) OSSL_CORE_MAKE_FUNC(int, OP_digest_set_params, (void *vctx, const OSSL_PARAM params[])) OSSL_CORE_MAKE_FUNC(int, OP_digest_get_params, (void *vctx, OSSL_PARAM params[])) /* Symmetric Ciphers */ # define OSSL_OP_CIPHER 2 # define OSSL_FUNC_CIPHER_NEWCTX 1 # define OSSL_FUNC_CIPHER_ENCRYPT_INIT 2 # define OSSL_FUNC_CIPHER_DECRYPT_INIT 3 # define OSSL_FUNC_CIPHER_UPDATE 4 # define OSSL_FUNC_CIPHER_FINAL 5 # define OSSL_FUNC_CIPHER_CIPHER 6 # define OSSL_FUNC_CIPHER_FREECTX 7 # define OSSL_FUNC_CIPHER_DUPCTX 8 # define OSSL_FUNC_CIPHER_GET_PARAMS 9 # define OSSL_FUNC_CIPHER_CTX_GET_PARAMS 10 # define OSSL_FUNC_CIPHER_CTX_SET_PARAMS 11 OSSL_CORE_MAKE_FUNC(void *, OP_cipher_newctx, (void *provctx)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_encrypt_init, (void *cctx, const unsigned char *key, size_t keylen, const unsigned char *iv, size_t ivlen)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_decrypt_init, (void *cctx, const unsigned char *key, size_t keylen, const unsigned char *iv, size_t ivlen)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_update, (void *cctx, unsigned char *out, size_t *outl, size_t outsize, const unsigned char *in, size_t inl)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_final, (void *cctx, unsigned char *out, size_t *outl, size_t outsize)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_cipher, (void *cctx, unsigned char *out, size_t *outl, size_t outsize, const unsigned char *in, size_t inl)) OSSL_CORE_MAKE_FUNC(void, OP_cipher_freectx, (void *cctx)) OSSL_CORE_MAKE_FUNC(void *, OP_cipher_dupctx, (void *cctx)) OSSL_CORE_MAKE_FUNC(int, OP_cipher_get_params, (OSSL_PARAM params[])) OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_get_params, (void *cctx, OSSL_PARAM params[])) OSSL_CORE_MAKE_FUNC(int, OP_cipher_ctx_set_params, (void *cctx, const OSSL_PARAM params[])) # ifdef __cplusplus } # endif #endif