jcs.org
jcs's openbsd hax
openbsd
1/* $OpenBSD: crypto.h,v 1.80 2025/09/28 07:52:53 tb Exp $ */
2/* ====================================================================
3 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 *
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * openssl-core@openssl.org.
26 *
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
30 *
31 * 6. Redistributions of any form whatsoever must retain the following
32 * acknowledgment:
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 *
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com). This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
53 *
54 */
55/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56 * All rights reserved.
57 *
58 * This package is an SSL implementation written
59 * by Eric Young (eay@cryptsoft.com).
60 * The implementation was written so as to conform with Netscapes SSL.
61 *
62 * This library is free for commercial and non-commercial use as long as
63 * the following conditions are aheared to. The following conditions
64 * apply to all code found in this distribution, be it the RC4, RSA,
65 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
66 * included with this distribution is covered by the same copyright terms
67 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
68 *
69 * Copyright remains Eric Young's, and as such any Copyright notices in
70 * the code are not to be removed.
71 * If this package is used in a product, Eric Young should be given attribution
72 * as the author of the parts of the library used.
73 * This can be in the form of a textual message at program startup or
74 * in documentation (online or textual) provided with the package.
75 *
76 * Redistribution and use in source and binary forms, with or without
77 * modification, are permitted provided that the following conditions
78 * are met:
79 * 1. Redistributions of source code must retain the copyright
80 * notice, this list of conditions and the following disclaimer.
81 * 2. Redistributions in binary form must reproduce the above copyright
82 * notice, this list of conditions and the following disclaimer in the
83 * documentation and/or other materials provided with the distribution.
84 * 3. All advertising materials mentioning features or use of this software
85 * must display the following acknowledgement:
86 * "This product includes cryptographic software written by
87 * Eric Young (eay@cryptsoft.com)"
88 * The word 'cryptographic' can be left out if the rouines from the library
89 * being used are not cryptographic related :-).
90 * 4. If you include any Windows specific code (or a derivative thereof) from
91 * the apps directory (application code) you must include an acknowledgement:
92 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
93 *
94 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
95 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
98 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104 * SUCH DAMAGE.
105 *
106 * The licence and distribution terms for any publically available version or
107 * derivative of this code cannot be changed. i.e. this code cannot simply be
108 * copied and put under another distribution licence
109 * [including the GNU Public Licence.]
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113 * ECDH support in OpenSSL originally developed by
114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116
117#include <stdint.h>
118#include <stdio.h>
119#include <stdlib.h>
120#include <time.h>
121
122#ifndef HEADER_CRYPTO_H
123#define HEADER_CRYPTO_H
124
125#include <openssl/opensslconf.h>
126
127#include <openssl/stack.h>
128#include <openssl/safestack.h>
129#include <openssl/opensslv.h>
130#include <openssl/ossl_typ.h>
131
132#ifdef __cplusplus
133extern "C" {
134#endif
135
136/* Backward compatibility to SSLeay */
137/* This is more to be used to check the correct DLL is being used
138 * in the MS world. */
139#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
140#define SSLEAY_VERSION 0
141/* #define SSLEAY_OPTIONS 1 no longer supported */
142#define SSLEAY_CFLAGS 2
143#define SSLEAY_BUILT_ON 3
144#define SSLEAY_PLATFORM 4
145#define SSLEAY_DIR 5
146
147/* When changing the CRYPTO_LOCK_* list, be sure to maintain the text lock
148 * names in cryptlib.c
149 */
150
151#define CRYPTO_LOCK_ERR 1
152#define CRYPTO_LOCK_EX_DATA 2
153#define CRYPTO_LOCK_X509 3
154#define CRYPTO_LOCK_X509_INFO 4
155#define CRYPTO_LOCK_X509_PKEY 5
156#define CRYPTO_LOCK_X509_CRL 6
157#define CRYPTO_LOCK_X509_REQ 7
158#define CRYPTO_LOCK_DSA 8
159#define CRYPTO_LOCK_RSA 9
160#define CRYPTO_LOCK_EVP_PKEY 10
161#define CRYPTO_LOCK_X509_STORE 11
162#define CRYPTO_LOCK_SSL_CTX 12
163#define CRYPTO_LOCK_SSL_CERT 13
164#define CRYPTO_LOCK_SSL_SESSION 14
165#define CRYPTO_LOCK_SSL_SESS_CERT 15
166#define CRYPTO_LOCK_SSL 16
167#define CRYPTO_LOCK_SSL_METHOD 17
168#define CRYPTO_LOCK_RAND 18
169#define CRYPTO_LOCK_RAND2 19
170#define CRYPTO_LOCK_MALLOC 20
171#define CRYPTO_LOCK_BIO 21
172#define CRYPTO_LOCK_GETHOSTBYNAME 22
173#define CRYPTO_LOCK_GETSERVBYNAME 23
174#define CRYPTO_LOCK_READDIR 24
175#define CRYPTO_LOCK_RSA_BLINDING 25
176#define CRYPTO_LOCK_DH 26
177#define CRYPTO_LOCK_MALLOC2 27
178#define CRYPTO_LOCK_DSO 28
179#define CRYPTO_LOCK_DYNLOCK 29
180#define CRYPTO_LOCK_ENGINE 30
181#define CRYPTO_LOCK_UI 31
182#define CRYPTO_LOCK_ECDSA 32
183#define CRYPTO_LOCK_EC 33
184#define CRYPTO_LOCK_ECDH 34
185#define CRYPTO_LOCK_BN 35
186#define CRYPTO_LOCK_EC_PRE_COMP 36
187#define CRYPTO_LOCK_STORE 37
188#define CRYPTO_LOCK_COMP 38
189#define CRYPTO_LOCK_FIPS 39
190#define CRYPTO_LOCK_FIPS2 40
191#define CRYPTO_NUM_LOCKS 41
192
193#define CRYPTO_LOCK 1
194#define CRYPTO_UNLOCK 2
195#define CRYPTO_READ 4
196#define CRYPTO_WRITE 8
197
198#ifndef CRYPTO_w_lock
199#define CRYPTO_w_lock(type) \
200 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,NULL,0)
201#define CRYPTO_w_unlock(type) \
202 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,NULL,0)
203#define CRYPTO_r_lock(type) \
204 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,NULL,0)
205#define CRYPTO_r_unlock(type) \
206 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,NULL,0)
207#define CRYPTO_add(addr,amount,type) \
208 CRYPTO_add_lock(addr,amount,type,NULL,0)
209#endif
210
211/* Some applications as well as some parts of OpenSSL need to allocate
212 and deallocate locks in a dynamic fashion. The following typedef
213 makes this possible in a type-safe manner. */
214/* struct CRYPTO_dynlock_value has to be defined by the application. */
215typedef struct {
216 int references;
217 struct CRYPTO_dynlock_value *data;
218} CRYPTO_dynlock;
219
220
221/* The following can be used to detect memory leaks in the SSLeay library.
222 * It used, it turns on malloc checking */
223
224#define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */
225#define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */
226#define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */
227#define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */
228
229/* The following are bit values to turn on or off options connected to the
230 * malloc checking functionality */
231
232/* Adds time to the memory checking information */
233#define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */
234/* Adds thread number to the memory checking information */
235#define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
236
237#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
238
239
240/* predec of the BIO type */
241typedef struct bio_st BIO_dummy;
242
243struct crypto_ex_data_st {
244 void *sk;
245};
246DECLARE_STACK_OF(void)
247
248#define CRYPTO_EX_INDEX_SSL 0
249#define CRYPTO_EX_INDEX_SSL_CTX 1
250#define CRYPTO_EX_INDEX_SSL_SESSION 2
251#define CRYPTO_EX_INDEX_APP 3
252#define CRYPTO_EX_INDEX_BIO 4
253#define CRYPTO_EX_INDEX_DH 5
254#define CRYPTO_EX_INDEX_DSA 6
255#define CRYPTO_EX_INDEX_EC_KEY 7
256#define CRYPTO_EX_INDEX_ENGINE 8
257#define CRYPTO_EX_INDEX_RSA 9
258#define CRYPTO_EX_INDEX_UI 10
259#define CRYPTO_EX_INDEX_UI_METHOD 11
260#define CRYPTO_EX_INDEX_X509 12
261#define CRYPTO_EX_INDEX_X509_STORE 13
262#define CRYPTO_EX_INDEX_X509_STORE_CTX 14
263#define CRYPTO_EX_INDEX__COUNT 15
264
265#ifndef LIBRESSL_INTERNAL
266#define CRYPTO_malloc_init() (0)
267#define CRYPTO_malloc_debug_init() (0)
268#endif /* LIBRESSL_INTERNAL */
269
270#if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
271# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
272# define CRYPTO_MDEBUG
273# endif
274#endif
275
276int CRYPTO_mem_ctrl(int mode);
277
278#define OPENSSL_malloc(num) CRYPTO_malloc((num),NULL,0)
279#define OPENSSL_strdup(str) CRYPTO_strdup((str),NULL,0)
280#define OPENSSL_free(addr) CRYPTO_free((addr),NULL,0)
281
282const char *OpenSSL_version(int type);
283#define OPENSSL_VERSION 0
284#define OPENSSL_CFLAGS 1
285#define OPENSSL_BUILT_ON 2
286#define OPENSSL_PLATFORM 3
287#define OPENSSL_DIR 4
288#define OPENSSL_ENGINES_DIR 5
289unsigned long OpenSSL_version_num(void);
290
291const char *SSLeay_version(int type);
292unsigned long SSLeay(void);
293
294/* Within a given class, get/register a new index */
295int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
296 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
297 CRYPTO_EX_free *free_func);
298/* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given
299 * class (invokes whatever per-class callbacks are applicable) */
300int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
301int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
302 CRYPTO_EX_DATA *from);
303void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
304/* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index
305 * (relative to the class type involved) */
306int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
307void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
308/* This function cleans up all "ex_data" state. It mustn't be called under
309 * potential race-conditions. */
310void CRYPTO_cleanup_all_ex_data(void);
311
312void CRYPTO_lock(int mode, int type, const char *file, int line);
313int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
314 int line);
315
316/* Don't use this structure directly. */
317typedef struct crypto_threadid_st CRYPTO_THREADID;
318
319/* These functions are deprecated no-op stubs */
320void CRYPTO_set_id_callback(unsigned long (*func)(void));
321unsigned long (*CRYPTO_get_id_callback(void))(void);
322unsigned long CRYPTO_thread_id(void);
323
324int CRYPTO_get_new_lockid(char *name);
325const char *CRYPTO_get_lock_name(int type);
326
327int CRYPTO_num_locks(void);
328void CRYPTO_set_locking_callback(void (*func)(int mode, int type,
329 const char *file, int line));
330void (*CRYPTO_get_locking_callback(void))(int mode, int type,
331 const char *file, int line);
332void CRYPTO_set_add_lock_callback(int (*func)(int *num, int mount, int type,
333 const char *file, int line));
334int (*CRYPTO_get_add_lock_callback(void))(int *num, int mount, int type,
335 const char *file, int line);
336
337void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
338void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
339int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *));
340void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *);
341
342int CRYPTO_get_new_dynlockid(void);
343void CRYPTO_destroy_dynlockid(int i);
344struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
345void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
346void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
347void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
348struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file, int line);
349void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line);
350void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file, int line);
351
352int CRYPTO_set_mem_functions(void *(*m)(size_t, const char *, int),
353 void *(*r)(void *, size_t, const char *, int),
354 void (*f)(void *, const char *, int));
355
356void *CRYPTO_malloc(size_t num, const char *file, int line);
357char *CRYPTO_strdup(const char *str, const char *file, int line);
358void CRYPTO_free(void *ptr, const char *file, int line);
359
360void OPENSSL_cleanse(void *ptr, size_t len);
361
362/*
363 * Because this is a public header, use a portable method of indicating the
364 * function does not return, rather than __dead.
365 */
366#ifdef _MSC_VER
367__declspec(noreturn)
368#else
369__attribute__((__noreturn__))
370#endif
371void OpenSSLDie(const char *file, int line, const char *assertion);
372#define OPENSSL_assert(e) (void)((e) ? 0 : (OpenSSLDie(OPENSSL_FILE, OPENSSL_LINE, #e),1))
373
374int FIPS_mode(void);
375int FIPS_mode_set(int r);
376
377void OPENSSL_init(void);
378
379/* CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal. It
380 * takes an amount of time dependent on |len|, but independent of the contents
381 * of |a| and |b|. Unlike memcmp, it cannot be used to put elements into a
382 * defined order as the return value when a != b is undefined, other than to be
383 * non-zero. */
384int CRYPTO_memcmp(const void *a, const void *b, size_t len);
385
386/*
387 * OpenSSL compatible OPENSSL_INIT options.
388 */
389
390#define OPENSSL_INIT_NO_LOAD_CONFIG 0x00000001L
391#define OPENSSL_INIT_LOAD_CONFIG 0x00000002L
392
393/* LibreSSL specific */
394#define _OPENSSL_INIT_FLAG_NOOP 0x80000000L
395
396/*
397 * These are provided for compatibility, but have no effect
398 * on how LibreSSL is initialized.
399 */
400#define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS _OPENSSL_INIT_FLAG_NOOP
401#define OPENSSL_INIT_LOAD_CRYPTO_STRINGS _OPENSSL_INIT_FLAG_NOOP
402#define OPENSSL_INIT_ADD_ALL_CIPHERS _OPENSSL_INIT_FLAG_NOOP
403#define OPENSSL_INIT_ADD_ALL_DIGESTS _OPENSSL_INIT_FLAG_NOOP
404#define OPENSSL_INIT_NO_ADD_ALL_CIPHERS _OPENSSL_INIT_FLAG_NOOP
405#define OPENSSL_INIT_NO_ADD_ALL_DIGESTS _OPENSSL_INIT_FLAG_NOOP
406#define OPENSSL_INIT_ASYNC _OPENSSL_INIT_FLAG_NOOP
407#define OPENSSL_INIT_ENGINE_RDRAND _OPENSSL_INIT_FLAG_NOOP
408#define OPENSSL_INIT_ENGINE_DYNAMIC _OPENSSL_INIT_FLAG_NOOP
409#define OPENSSL_INIT_ENGINE_OPENSSL _OPENSSL_INIT_FLAG_NOOP
410#define OPENSSL_INIT_ENGINE_CRYPTODEV _OPENSSL_INIT_FLAG_NOOP
411#define OPENSSL_INIT_ENGINE_CAPI _OPENSSL_INIT_FLAG_NOOP
412#define OPENSSL_INIT_ENGINE_PADLOCK _OPENSSL_INIT_FLAG_NOOP
413#define OPENSSL_INIT_ENGINE_AFALG _OPENSSL_INIT_FLAG_NOOP
414#define OPENSSL_INIT_reserved_internal _OPENSSL_INIT_FLAG_NOOP
415#define OPENSSL_INIT_ATFORK _OPENSSL_INIT_FLAG_NOOP
416#define OPENSSL_INIT_ENGINE_ALL_BUILTIN _OPENSSL_INIT_FLAG_NOOP
417#define OPENSSL_INIT_NO_ATEXIT _OPENSSL_INIT_FLAG_NOOP
418
419int OPENSSL_init_crypto(uint64_t opts, const void *settings);
420void OPENSSL_cleanup(void);
421
422/*
423 * CPU capabilities.
424 */
425#define CRYPTO_CPU_CAPS_ACCELERATED_AES 0x00000001ULL
426
427uint64_t OPENSSL_cpu_caps(void);
428
429/*
430 * OpenSSL helpfully put OPENSSL_gmtime() here because all other time related
431 * functions are in asn1.h.
432 */
433struct tm *OPENSSL_gmtime(const time_t *time, struct tm *out_tm);
434
435void ERR_load_CRYPTO_strings(void);
436
437/* Error codes for the CRYPTO functions. */
438
439/* Function codes. */
440#define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100
441#define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103
442#define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101
443#define CRYPTO_F_CRYPTO_SET_EX_DATA 102
444#define CRYPTO_F_DEF_ADD_INDEX 104
445#define CRYPTO_F_DEF_GET_CLASS 105
446#define CRYPTO_F_FIPS_MODE_SET 109
447#define CRYPTO_F_INT_DUP_EX_DATA 106
448#define CRYPTO_F_INT_FREE_EX_DATA 107
449#define CRYPTO_F_INT_NEW_EX_DATA 108
450
451/* Reason codes. */
452#define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED 101
453#define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100
454
455#ifdef __cplusplus
456}
457#endif
458#endif