[thirdparty/openssl.git] / include / internal / cryptlib.h

/*
 * Copyright 1995-2025 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_INTERNAL_CRYPTLIB_H
# define OSSL_INTERNAL_CRYPTLIB_H
# pragma once

# ifdef OPENSSL_USE_APPLINK
#  define BIO_FLAGS_UPLINK_INTERNAL 0x8000
#  include "ms/uplink.h"
# else
#  define BIO_FLAGS_UPLINK_INTERNAL 0
# endif

# include "internal/common.h"

# include <openssl/crypto.h>
# include <openssl/buffer.h>
# include <openssl/bio.h>
# include <openssl/asn1.h>
# include <openssl/err.h>

typedef struct ex_callback_st EX_CALLBACK;
DEFINE_STACK_OF(EX_CALLBACK)

typedef struct mem_st MEM;
DEFINE_LHASH_OF_EX(MEM);

void OPENSSL_cpuid_setup(void);
#if defined(__i386)   || defined(__i386__)   || defined(_M_IX86) || \
    defined(__x86_64) || defined(__x86_64__) || \
    defined(_M_AMD64) || defined(_M_X64)
#  define OPENSSL_IA32CAP_P_MAX_INDEXES 10
extern unsigned int OPENSSL_ia32cap_P[];
#endif

void OPENSSL_showfatal(const char *fmta, ...);
int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
int openssl_init_fork_handlers(void);
int openssl_get_fork_id(void);

char *ossl_safe_getenv(const char *name);

extern CRYPTO_RWLOCK *memdbg_lock;
int openssl_strerror_r(int errnum, char *buf, size_t buflen);
# if !defined(OPENSSL_NO_STDIO)
FILE *openssl_fopen(const char *filename, const char *mode);
# else
void *openssl_fopen(const char *filename, const char *mode);
# endif

uint32_t OPENSSL_rdtsc(void);
size_t OPENSSL_instrument_bus(unsigned int *, size_t);
size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);

/* ex_data structures */

/*
 * Each structure type (sometimes called a class), that supports
 * exdata has a stack of callbacks for each instance.
 */
struct ex_callback_st {
    long argl;                  /* Arbitrary long */
    void *argp;                 /* Arbitrary void * */
    int priority;               /* Priority ordering for freeing */
    CRYPTO_EX_new *new_func;
    CRYPTO_EX_free *free_func;
    CRYPTO_EX_dup *dup_func;
};

/*
 * The state for each class.  This could just be a typedef, but
 * a structure allows future changes.
 */
typedef struct ex_callbacks_st {
    STACK_OF(EX_CALLBACK) *meth;
} EX_CALLBACKS;

typedef struct ossl_ex_data_global_st {
    CRYPTO_RWLOCK *ex_data_lock;
    EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
} OSSL_EX_DATA_GLOBAL;

/* OSSL_LIB_CTX */

# define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX          0
# define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX    1
# define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX            2
# define OSSL_LIB_CTX_MAX_RUN_ONCE                           3

# define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX         0
# define OSSL_LIB_CTX_PROVIDER_STORE_INDEX           1
# define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX            2
# define OSSL_LIB_CTX_PROPERTY_STRING_INDEX          3
# define OSSL_LIB_CTX_NAMEMAP_INDEX                  4
# define OSSL_LIB_CTX_DRBG_INDEX                     5
# define OSSL_LIB_CTX_DRBG_NONCE_INDEX               6
/* slot 7 unused, was CRNG test data and can be reused */
/*
 * slot 8 unused, was OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX
 */
# define OSSL_LIB_CTX_FIPS_PROV_INDEX                9
# define OSSL_LIB_CTX_ENCODER_STORE_INDEX           10
# define OSSL_LIB_CTX_DECODER_STORE_INDEX           11
# define OSSL_LIB_CTX_SELF_TEST_CB_INDEX            12
# define OSSL_LIB_CTX_BIO_PROV_INDEX                13
# define OSSL_LIB_CTX_GLOBAL_PROPERTIES             14
# define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX      15
# define OSSL_LIB_CTX_PROVIDER_CONF_INDEX           16
# define OSSL_LIB_CTX_BIO_CORE_INDEX                17
# define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX          18
# define OSSL_LIB_CTX_THREAD_INDEX                  19
# define OSSL_LIB_CTX_DECODER_CACHE_INDEX           20
# define OSSL_LIB_CTX_COMP_METHODS                  21
# define OSSL_LIB_CTX_INDICATOR_CB_INDEX            22
# define OSSL_LIB_CTX_MAX_INDEXES                   22

OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);

/* Functions to retrieve pointers to data by index */
void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */);

void ossl_lib_ctx_default_deinit(void);
OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);

const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);

OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
                               CRYPTO_EX_DATA *ad);
int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
                                    long argl, void *argp,
                                    CRYPTO_EX_new *new_func,
                                    CRYPTO_EX_dup *dup_func,
                                    CRYPTO_EX_free *free_func,
                                    int priority);
int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);

/* Function for simple binary search */

/* Flags */
# define OSSL_BSEARCH_VALUE_ON_NOMATCH            0x01
# define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH        0x02

const void *ossl_bsearch(const void *key, const void *base, int num,
                         int size, int (*cmp) (const void *, const void *),
                         int flags);

char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
                                   const char *sep, size_t max_len);
char *ossl_ipaddr_to_asc(unsigned char *p, int len);

char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
                                   const char sep);

/**
 *  Writes |n| value in hex format into |buf|,
 *  and returns the number of bytes written
 */
size_t ossl_to_hex(char *buf, uint8_t n);

STACK_OF(SSL_COMP) *ossl_load_builtin_compressions(void);
void ossl_free_compression_methods_int(STACK_OF(SSL_COMP) *methods);

#endif
Commit	Line	Data
	1	/*
	2	* Copyright 1995-2025 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_INTERNAL_CRYPTLIB_H
	11	# define OSSL_INTERNAL_CRYPTLIB_H
	12	# pragma once
	13
	14	# ifdef OPENSSL_USE_APPLINK
	15	# define BIO_FLAGS_UPLINK_INTERNAL 0x8000
	16	# include "ms/uplink.h"
	17	# else
	18	# define BIO_FLAGS_UPLINK_INTERNAL 0
	19	# endif
	20
	21	# include "internal/common.h"
	22
	23	# include <openssl/crypto.h>
	24	# include <openssl/buffer.h>
	25	# include <openssl/bio.h>
	26	# include <openssl/asn1.h>
	27	# include <openssl/err.h>
	28
	29	typedef struct ex_callback_st EX_CALLBACK;
	30	DEFINE_STACK_OF(EX_CALLBACK)
	31
	32	typedef struct mem_st MEM;
	33	DEFINE_LHASH_OF_EX(MEM);
	34
	35	void OPENSSL_cpuid_setup(void);
	36	#if defined(__i386) \|\| defined(__i386__) \|\| defined(_M_IX86) \|\| \
	37	defined(__x86_64) \|\| defined(__x86_64__) \|\| \
	38	defined(_M_AMD64) \|\| defined(_M_X64)
	39	# define OPENSSL_IA32CAP_P_MAX_INDEXES 10
	40	extern unsigned int OPENSSL_ia32cap_P[];
	41	#endif
	42
	43	void OPENSSL_showfatal(const char *fmta, ...);
	44	int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
	45	void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
	46	int openssl_init_fork_handlers(void);
	47	int openssl_get_fork_id(void);
	48
	49	char ossl_safe_getenv(const char name);
	50
	51	extern CRYPTO_RWLOCK *memdbg_lock;
	52	int openssl_strerror_r(int errnum, char *buf, size_t buflen);
	53	# if !defined(OPENSSL_NO_STDIO)
	54	FILE openssl_fopen(const char filename, const char *mode);
	55	# else
	56	void openssl_fopen(const char filename, const char *mode);
	57	# endif
	58
	59	uint32_t OPENSSL_rdtsc(void);
	60	size_t OPENSSL_instrument_bus(unsigned int *, size_t);
	61	size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
	62
	63	/* ex_data structures */
	64
	65	/*
	66	* Each structure type (sometimes called a class), that supports
	67	* exdata has a stack of callbacks for each instance.
	68	*/
	69	struct ex_callback_st {
	70	long argl; /* Arbitrary long */
	71	void argp; / Arbitrary void * */
	72	int priority; /* Priority ordering for freeing */
	73	CRYPTO_EX_new *new_func;
	74	CRYPTO_EX_free *free_func;
	75	CRYPTO_EX_dup *dup_func;
	76	};
	77
	78	/*
	79	* The state for each class. This could just be a typedef, but
	80	* a structure allows future changes.
	81	*/
	82	typedef struct ex_callbacks_st {
	83	STACK_OF(EX_CALLBACK) *meth;
	84	} EX_CALLBACKS;
	85
	86	typedef struct ossl_ex_data_global_st {
	87	CRYPTO_RWLOCK *ex_data_lock;
	88	EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
	89	} OSSL_EX_DATA_GLOBAL;
	90
	91	/* OSSL_LIB_CTX */
	92
	93	# define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0
	94	# define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1
	95	# define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX 2
	96	# define OSSL_LIB_CTX_MAX_RUN_ONCE 3
	97
	98	# define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX 0
	99	# define OSSL_LIB_CTX_PROVIDER_STORE_INDEX 1
	100	# define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX 2
	101	# define OSSL_LIB_CTX_PROPERTY_STRING_INDEX 3
	102	# define OSSL_LIB_CTX_NAMEMAP_INDEX 4
	103	# define OSSL_LIB_CTX_DRBG_INDEX 5
	104	# define OSSL_LIB_CTX_DRBG_NONCE_INDEX 6
	105	/* slot 7 unused, was CRNG test data and can be reused */
	106	/*
	107	* slot 8 unused, was OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX
	108	*/
	109	# define OSSL_LIB_CTX_FIPS_PROV_INDEX 9
	110	# define OSSL_LIB_CTX_ENCODER_STORE_INDEX 10
	111	# define OSSL_LIB_CTX_DECODER_STORE_INDEX 11
	112	# define OSSL_LIB_CTX_SELF_TEST_CB_INDEX 12
	113	# define OSSL_LIB_CTX_BIO_PROV_INDEX 13
	114	# define OSSL_LIB_CTX_GLOBAL_PROPERTIES 14
	115	# define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX 15
	116	# define OSSL_LIB_CTX_PROVIDER_CONF_INDEX 16
	117	# define OSSL_LIB_CTX_BIO_CORE_INDEX 17
	118	# define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX 18
	119	# define OSSL_LIB_CTX_THREAD_INDEX 19
	120	# define OSSL_LIB_CTX_DECODER_CACHE_INDEX 20
	121	# define OSSL_LIB_CTX_COMP_METHODS 21
	122	# define OSSL_LIB_CTX_INDICATOR_CB_INDEX 22
	123	# define OSSL_LIB_CTX_MAX_INDEXES 22
	124
	125	OSSL_LIB_CTX ossl_lib_ctx_get_concrete(OSSL_LIB_CTX ctx);
	126	int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
	127	int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
	128
	129	/* Functions to retrieve pointers to data by index */
	130	void ossl_lib_ctx_get_data(OSSL_LIB_CTX , int /* index */);
	131
	132	void ossl_lib_ctx_default_deinit(void);
	133	OSSL_EX_DATA_GLOBAL ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX ctx);
	134
	135	const char ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX libctx);
	136
	137	OSSL_LIB_CTX ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA ad);
	138	int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX ctx, int class_index, void obj,
	139	CRYPTO_EX_DATA *ad);
	140	int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
	141	long argl, void *argp,
	142	CRYPTO_EX_new *new_func,
	143	CRYPTO_EX_dup *dup_func,
	144	CRYPTO_EX_free *free_func,
	145	int priority);
	146	int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
	147
	148	/* Function for simple binary search */
	149
	150	/* Flags */
	151	# define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01
	152	# define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02
	153
	154	const void ossl_bsearch(const void key, const void *base, int num,
	155	int size, int (cmp) (const void , const void *),
	156	int flags);
	157
	158	char ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) text,
	159	const char *sep, size_t max_len);
	160	char ossl_ipaddr_to_asc(unsigned char p, int len);
	161
	162	char ossl_buf2hexstr_sep(const unsigned char buf, long buflen, char sep);
	163	unsigned char ossl_hexstr2buf_sep(const char str, long *buflen,
	164	const char sep);
	165
	166	/**
	167	* Writes \|n\| value in hex format into \|buf\|,
	168	* and returns the number of bytes written
	169	*/
	170	size_t ossl_to_hex(char *buf, uint8_t n);
	171
	172	STACK_OF(SSL_COMP) *ossl_load_builtin_compressions(void);
	173	void ossl_free_compression_methods_int(STACK_OF(SSL_COMP) *methods);
	174
	175	#endif