You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

529 lines
21 KiB

  1. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  2. * All rights reserved.
  3. *
  4. * This package is an SSL implementation written
  5. * by Eric Young (eay@cryptsoft.com).
  6. * The implementation was written so as to conform with Netscapes SSL.
  7. *
  8. * This library is free for commercial and non-commercial use as long as
  9. * the following conditions are aheared to. The following conditions
  10. * apply to all code found in this distribution, be it the RC4, RSA,
  11. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  12. * included with this distribution is covered by the same copyright terms
  13. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14. *
  15. * Copyright remains Eric Young's, and as such any Copyright notices in
  16. * the code are not to be removed.
  17. * If this package is used in a product, Eric Young should be given attribution
  18. * as the author of the parts of the library used.
  19. * This can be in the form of a textual message at program startup or
  20. * in documentation (online or textual) provided with the package.
  21. *
  22. * Redistribution and use in source and binary forms, with or without
  23. * modification, are permitted provided that the following conditions
  24. * are met:
  25. * 1. Redistributions of source code must retain the copyright
  26. * notice, this list of conditions and the following disclaimer.
  27. * 2. Redistributions in binary form must reproduce the above copyright
  28. * notice, this list of conditions and the following disclaimer in the
  29. * documentation and/or other materials provided with the distribution.
  30. * 3. All advertising materials mentioning features or use of this software
  31. * must display the following acknowledgement:
  32. * "This product includes cryptographic software written by
  33. * Eric Young (eay@cryptsoft.com)"
  34. * The word 'cryptographic' can be left out if the rouines from the library
  35. * being used are not cryptographic related :-).
  36. * 4. If you include any Windows specific code (or a derivative thereof) from
  37. * the apps directory (application code) you must include an acknowledgement:
  38. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39. *
  40. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50. * SUCH DAMAGE.
  51. *
  52. * The licence and distribution terms for any publically available version or
  53. * derivative of this code cannot be changed. i.e. this code cannot simply be
  54. * copied and put under another distribution licence
  55. * [including the GNU Public Licence.]
  56. */
  57. /* ====================================================================
  58. * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
  59. *
  60. * Redistribution and use in source and binary forms, with or without
  61. * modification, are permitted provided that the following conditions
  62. * are met:
  63. *
  64. * 1. Redistributions of source code must retain the above copyright
  65. * notice, this list of conditions and the following disclaimer.
  66. *
  67. * 2. Redistributions in binary form must reproduce the above copyright
  68. * notice, this list of conditions and the following disclaimer in
  69. * the documentation and/or other materials provided with the
  70. * distribution.
  71. *
  72. * 3. All advertising materials mentioning features or use of this
  73. * software must display the following acknowledgment:
  74. * "This product includes software developed by the OpenSSL Project
  75. * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76. *
  77. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78. * endorse or promote products derived from this software without
  79. * prior written permission. For written permission, please contact
  80. * openssl-core@openssl.org.
  81. *
  82. * 5. Products derived from this software may not be called "OpenSSL"
  83. * nor may "OpenSSL" appear in their names without prior written
  84. * permission of the OpenSSL Project.
  85. *
  86. * 6. Redistributions of any form whatsoever must retain the following
  87. * acknowledgment:
  88. * "This product includes software developed by the OpenSSL Project
  89. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90. *
  91. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  100. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  101. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  102. * OF THE POSSIBILITY OF SUCH DAMAGE.
  103. * ====================================================================
  104. *
  105. * This product includes cryptographic software written by Eric Young
  106. * (eay@cryptsoft.com). This product includes software written by Tim
  107. * Hudson (tjh@cryptsoft.com). */
  108. #ifndef OPENSSL_HEADER_CRYPTO_INTERNAL_H
  109. #define OPENSSL_HEADER_CRYPTO_INTERNAL_H
  110. #include <openssl/ex_data.h>
  111. #include <openssl/thread.h>
  112. #if defined(_MSC_VER)
  113. #if !defined(__cplusplus) || _MSC_VER < 1900
  114. #define alignas(x) __declspec(align(x))
  115. #define alignof __alignof
  116. #endif
  117. #else
  118. #include <stdalign.h>
  119. #endif
  120. #if defined(OPENSSL_NO_THREADS)
  121. #elif defined(OPENSSL_WINDOWS)
  122. OPENSSL_MSVC_PRAGMA(warning(push, 3))
  123. #include <windows.h>
  124. OPENSSL_MSVC_PRAGMA(warning(pop))
  125. #else
  126. #include <pthread.h>
  127. #endif
  128. #if defined(__cplusplus)
  129. extern "C" {
  130. #endif
  131. #if defined(OPENSSL_X86) || defined(OPENSSL_X86_64) || defined(OPENSSL_ARM) || \
  132. defined(OPENSSL_AARCH64)
  133. /* OPENSSL_cpuid_setup initializes OPENSSL_ia32cap_P. */
  134. void OPENSSL_cpuid_setup(void);
  135. #endif
  136. #if !defined(_MSC_VER) && defined(OPENSSL_64_BIT)
  137. typedef __int128_t int128_t;
  138. typedef __uint128_t uint128_t;
  139. #endif
  140. #define OPENSSL_ARRAY_SIZE(array) (sizeof(array) / sizeof((array)[0]))
  141. /* buffers_alias returns one if |a| and |b| alias and zero otherwise. */
  142. static inline int buffers_alias(const uint8_t *a, size_t a_len,
  143. const uint8_t *b, size_t b_len) {
  144. /* Cast |a| and |b| to integers. In C, pointer comparisons between unrelated
  145. * objects are undefined whereas pointer to integer conversions are merely
  146. * implementation-defined. We assume the implementation defined it in a sane
  147. * way. */
  148. uintptr_t a_u = (uintptr_t)a;
  149. uintptr_t b_u = (uintptr_t)b;
  150. return a_u + a_len > b_u && b_u + b_len > a_u;
  151. }
  152. /* Constant-time utility functions.
  153. *
  154. * The following methods return a bitmask of all ones (0xff...f) for true and 0
  155. * for false. This is useful for choosing a value based on the result of a
  156. * conditional in constant time. For example,
  157. *
  158. * if (a < b) {
  159. * c = a;
  160. * } else {
  161. * c = b;
  162. * }
  163. *
  164. * can be written as
  165. *
  166. * unsigned int lt = constant_time_lt(a, b);
  167. * c = constant_time_select(lt, a, b); */
  168. /* constant_time_msb returns the given value with the MSB copied to all the
  169. * other bits. */
  170. static inline unsigned int constant_time_msb(unsigned int a) {
  171. return (unsigned int)((int)(a) >> (sizeof(int) * 8 - 1));
  172. }
  173. /* constant_time_lt returns 0xff..f if a < b and 0 otherwise. */
  174. static inline unsigned int constant_time_lt(unsigned int a, unsigned int b) {
  175. /* Consider the two cases of the problem:
  176. * msb(a) == msb(b): a < b iff the MSB of a - b is set.
  177. * msb(a) != msb(b): a < b iff the MSB of b is set.
  178. *
  179. * If msb(a) == msb(b) then the following evaluates as:
  180. * msb(a^((a^b)|((a-b)^a))) ==
  181. * msb(a^((a-b) ^ a)) == (because msb(a^b) == 0)
  182. * msb(a^a^(a-b)) == (rearranging)
  183. * msb(a-b) (because ∀x. x^x == 0)
  184. *
  185. * Else, if msb(a) != msb(b) then the following evaluates as:
  186. * msb(a^((a^b)|((a-b)^a))) ==
  187. * msb(a^(𝟙 | ((a-b)^a))) == (because msb(a^b) == 1 and 𝟙
  188. * represents a value s.t. msb(𝟙) = 1)
  189. * msb(a^𝟙) == (because ORing with 1 results in 1)
  190. * msb(b)
  191. *
  192. *
  193. * Here is an SMT-LIB verification of this formula:
  194. *
  195. * (define-fun lt ((a (_ BitVec 32)) (b (_ BitVec 32))) (_ BitVec 32)
  196. * (bvxor a (bvor (bvxor a b) (bvxor (bvsub a b) a)))
  197. * )
  198. *
  199. * (declare-fun a () (_ BitVec 32))
  200. * (declare-fun b () (_ BitVec 32))
  201. *
  202. * (assert (not (= (= #x00000001 (bvlshr (lt a b) #x0000001f)) (bvult a b))))
  203. * (check-sat)
  204. * (get-model)
  205. */
  206. return constant_time_msb(a^((a^b)|((a-b)^a)));
  207. }
  208. /* constant_time_lt_8 acts like |constant_time_lt| but returns an 8-bit mask. */
  209. static inline uint8_t constant_time_lt_8(unsigned int a, unsigned int b) {
  210. return (uint8_t)(constant_time_lt(a, b));
  211. }
  212. /* constant_time_gt returns 0xff..f if a >= b and 0 otherwise. */
  213. static inline unsigned int constant_time_ge(unsigned int a, unsigned int b) {
  214. return ~constant_time_lt(a, b);
  215. }
  216. /* constant_time_ge_8 acts like |constant_time_ge| but returns an 8-bit mask. */
  217. static inline uint8_t constant_time_ge_8(unsigned int a, unsigned int b) {
  218. return (uint8_t)(constant_time_ge(a, b));
  219. }
  220. /* constant_time_is_zero returns 0xff..f if a == 0 and 0 otherwise. */
  221. static inline unsigned int constant_time_is_zero(unsigned int a) {
  222. /* Here is an SMT-LIB verification of this formula:
  223. *
  224. * (define-fun is_zero ((a (_ BitVec 32))) (_ BitVec 32)
  225. * (bvand (bvnot a) (bvsub a #x00000001))
  226. * )
  227. *
  228. * (declare-fun a () (_ BitVec 32))
  229. *
  230. * (assert (not (= (= #x00000001 (bvlshr (is_zero a) #x0000001f)) (= a #x00000000))))
  231. * (check-sat)
  232. * (get-model)
  233. */
  234. return constant_time_msb(~a & (a - 1));
  235. }
  236. /* constant_time_is_zero_8 acts like constant_time_is_zero but returns an 8-bit
  237. * mask. */
  238. static inline uint8_t constant_time_is_zero_8(unsigned int a) {
  239. return (uint8_t)(constant_time_is_zero(a));
  240. }
  241. /* constant_time_eq returns 0xff..f if a == b and 0 otherwise. */
  242. static inline unsigned int constant_time_eq(unsigned int a, unsigned int b) {
  243. return constant_time_is_zero(a ^ b);
  244. }
  245. /* constant_time_eq_8 acts like |constant_time_eq| but returns an 8-bit mask. */
  246. static inline uint8_t constant_time_eq_8(unsigned int a, unsigned int b) {
  247. return (uint8_t)(constant_time_eq(a, b));
  248. }
  249. /* constant_time_eq_int acts like |constant_time_eq| but works on int values. */
  250. static inline unsigned int constant_time_eq_int(int a, int b) {
  251. return constant_time_eq((unsigned)(a), (unsigned)(b));
  252. }
  253. /* constant_time_eq_int_8 acts like |constant_time_eq_int| but returns an 8-bit
  254. * mask. */
  255. static inline uint8_t constant_time_eq_int_8(int a, int b) {
  256. return constant_time_eq_8((unsigned)(a), (unsigned)(b));
  257. }
  258. /* constant_time_select returns (mask & a) | (~mask & b). When |mask| is all 1s
  259. * or all 0s (as returned by the methods above), the select methods return
  260. * either |a| (if |mask| is nonzero) or |b| (if |mask| is zero). */
  261. static inline unsigned int constant_time_select(unsigned int mask,
  262. unsigned int a, unsigned int b) {
  263. return (mask & a) | (~mask & b);
  264. }
  265. /* constant_time_select_8 acts like |constant_time_select| but operates on
  266. * 8-bit values. */
  267. static inline uint8_t constant_time_select_8(uint8_t mask, uint8_t a,
  268. uint8_t b) {
  269. return (uint8_t)(constant_time_select(mask, a, b));
  270. }
  271. /* constant_time_select_int acts like |constant_time_select| but operates on
  272. * ints. */
  273. static inline int constant_time_select_int(unsigned int mask, int a, int b) {
  274. return (int)(constant_time_select(mask, (unsigned)(a), (unsigned)(b)));
  275. }
  276. /* Thread-safe initialisation. */
  277. /* Android's mingw-w64 has some prototypes for INIT_ONCE, but is missing
  278. * others. Work around the missing ones.
  279. *
  280. * TODO(davidben): Remove this once Android's mingw-w64 is upgraded. See
  281. * b/26523949. */
  282. #if defined(__MINGW32__) && !defined(INIT_ONCE_STATIC_INIT)
  283. typedef RTL_RUN_ONCE INIT_ONCE;
  284. #define INIT_ONCE_STATIC_INIT RTL_RUN_ONCE_INIT
  285. #endif
  286. #if defined(OPENSSL_NO_THREADS)
  287. typedef uint32_t CRYPTO_once_t;
  288. #define CRYPTO_ONCE_INIT 0
  289. #elif defined(OPENSSL_WINDOWS)
  290. typedef INIT_ONCE CRYPTO_once_t;
  291. #define CRYPTO_ONCE_INIT INIT_ONCE_STATIC_INIT
  292. #else
  293. typedef pthread_once_t CRYPTO_once_t;
  294. #define CRYPTO_ONCE_INIT PTHREAD_ONCE_INIT
  295. #endif
  296. /* CRYPTO_once calls |init| exactly once per process. This is thread-safe: if
  297. * concurrent threads call |CRYPTO_once| with the same |CRYPTO_once_t| argument
  298. * then they will block until |init| completes, but |init| will have only been
  299. * called once.
  300. *
  301. * The |once| argument must be a |CRYPTO_once_t| that has been initialised with
  302. * the value |CRYPTO_ONCE_INIT|. */
  303. OPENSSL_EXPORT void CRYPTO_once(CRYPTO_once_t *once, void (*init)(void));
  304. /* Reference counting. */
  305. /* CRYPTO_REFCOUNT_MAX is the value at which the reference count saturates. */
  306. #define CRYPTO_REFCOUNT_MAX 0xffffffff
  307. /* CRYPTO_refcount_inc atomically increments the value at |*count| unless the
  308. * value would overflow. It's safe for multiple threads to concurrently call
  309. * this or |CRYPTO_refcount_dec_and_test_zero| on the same
  310. * |CRYPTO_refcount_t|. */
  311. OPENSSL_EXPORT void CRYPTO_refcount_inc(CRYPTO_refcount_t *count);
  312. /* CRYPTO_refcount_dec_and_test_zero tests the value at |*count|:
  313. * if it's zero, it crashes the address space.
  314. * if it's the maximum value, it returns zero.
  315. * otherwise, it atomically decrements it and returns one iff the resulting
  316. * value is zero.
  317. *
  318. * It's safe for multiple threads to concurrently call this or
  319. * |CRYPTO_refcount_inc| on the same |CRYPTO_refcount_t|. */
  320. OPENSSL_EXPORT int CRYPTO_refcount_dec_and_test_zero(CRYPTO_refcount_t *count);
  321. /* Locks.
  322. *
  323. * Two types of locks are defined: |CRYPTO_MUTEX|, which can be used in
  324. * structures as normal, and |struct CRYPTO_STATIC_MUTEX|, which can be used as
  325. * a global lock. A global lock must be initialised to the value
  326. * |CRYPTO_STATIC_MUTEX_INIT|.
  327. *
  328. * |CRYPTO_MUTEX| can appear in public structures and so is defined in
  329. * thread.h as a structure large enough to fit the real type. The global lock is
  330. * a different type so it may be initialized with platform initializer macros.*/
  331. #if defined(OPENSSL_NO_THREADS)
  332. struct CRYPTO_STATIC_MUTEX {
  333. char padding; /* Empty structs have different sizes in C and C++. */
  334. };
  335. #define CRYPTO_STATIC_MUTEX_INIT { 0 }
  336. #elif defined(OPENSSL_WINDOWS)
  337. struct CRYPTO_STATIC_MUTEX {
  338. SRWLOCK lock;
  339. };
  340. #define CRYPTO_STATIC_MUTEX_INIT { SRWLOCK_INIT }
  341. #else
  342. struct CRYPTO_STATIC_MUTEX {
  343. pthread_rwlock_t lock;
  344. };
  345. #define CRYPTO_STATIC_MUTEX_INIT { PTHREAD_RWLOCK_INITIALIZER }
  346. #endif
  347. /* CRYPTO_MUTEX_init initialises |lock|. If |lock| is a static variable, use a
  348. * |CRYPTO_STATIC_MUTEX|. */
  349. OPENSSL_EXPORT void CRYPTO_MUTEX_init(CRYPTO_MUTEX *lock);
  350. /* CRYPTO_MUTEX_lock_read locks |lock| such that other threads may also have a
  351. * read lock, but none may have a write lock. */
  352. OPENSSL_EXPORT void CRYPTO_MUTEX_lock_read(CRYPTO_MUTEX *lock);
  353. /* CRYPTO_MUTEX_lock_write locks |lock| such that no other thread has any type
  354. * of lock on it. */
  355. OPENSSL_EXPORT void CRYPTO_MUTEX_lock_write(CRYPTO_MUTEX *lock);
  356. /* CRYPTO_MUTEX_unlock_read unlocks |lock| for reading. */
  357. OPENSSL_EXPORT void CRYPTO_MUTEX_unlock_read(CRYPTO_MUTEX *lock);
  358. /* CRYPTO_MUTEX_unlock_write unlocks |lock| for writing. */
  359. OPENSSL_EXPORT void CRYPTO_MUTEX_unlock_write(CRYPTO_MUTEX *lock);
  360. /* CRYPTO_MUTEX_cleanup releases all resources held by |lock|. */
  361. OPENSSL_EXPORT void CRYPTO_MUTEX_cleanup(CRYPTO_MUTEX *lock);
  362. /* CRYPTO_STATIC_MUTEX_lock_read locks |lock| such that other threads may also
  363. * have a read lock, but none may have a write lock. The |lock| variable does
  364. * not need to be initialised by any function, but must have been statically
  365. * initialised with |CRYPTO_STATIC_MUTEX_INIT|. */
  366. OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_lock_read(
  367. struct CRYPTO_STATIC_MUTEX *lock);
  368. /* CRYPTO_STATIC_MUTEX_lock_write locks |lock| such that no other thread has
  369. * any type of lock on it. The |lock| variable does not need to be initialised
  370. * by any function, but must have been statically initialised with
  371. * |CRYPTO_STATIC_MUTEX_INIT|. */
  372. OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_lock_write(
  373. struct CRYPTO_STATIC_MUTEX *lock);
  374. /* CRYPTO_STATIC_MUTEX_unlock_read unlocks |lock| for reading. */
  375. OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_unlock_read(
  376. struct CRYPTO_STATIC_MUTEX *lock);
  377. /* CRYPTO_STATIC_MUTEX_unlock_write unlocks |lock| for writing. */
  378. OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_unlock_write(
  379. struct CRYPTO_STATIC_MUTEX *lock);
  380. /* Thread local storage. */
  381. /* thread_local_data_t enumerates the types of thread-local data that can be
  382. * stored. */
  383. typedef enum {
  384. OPENSSL_THREAD_LOCAL_ERR = 0,
  385. OPENSSL_THREAD_LOCAL_RAND,
  386. OPENSSL_THREAD_LOCAL_URANDOM_BUF,
  387. OPENSSL_THREAD_LOCAL_TEST,
  388. NUM_OPENSSL_THREAD_LOCALS,
  389. } thread_local_data_t;
  390. /* thread_local_destructor_t is the type of a destructor function that will be
  391. * called when a thread exits and its thread-local storage needs to be freed. */
  392. typedef void (*thread_local_destructor_t)(void *);
  393. /* CRYPTO_get_thread_local gets the pointer value that is stored for the
  394. * current thread for the given index, or NULL if none has been set. */
  395. OPENSSL_EXPORT void *CRYPTO_get_thread_local(thread_local_data_t value);
  396. /* CRYPTO_set_thread_local sets a pointer value for the current thread at the
  397. * given index. This function should only be called once per thread for a given
  398. * |index|: rather than update the pointer value itself, update the data that
  399. * is pointed to.
  400. *
  401. * The destructor function will be called when a thread exits to free this
  402. * thread-local data. All calls to |CRYPTO_set_thread_local| with the same
  403. * |index| should have the same |destructor| argument. The destructor may be
  404. * called with a NULL argument if a thread that never set a thread-local
  405. * pointer for |index|, exits. The destructor may be called concurrently with
  406. * different arguments.
  407. *
  408. * This function returns one on success or zero on error. If it returns zero
  409. * then |destructor| has been called with |value| already. */
  410. OPENSSL_EXPORT int CRYPTO_set_thread_local(
  411. thread_local_data_t index, void *value,
  412. thread_local_destructor_t destructor);
  413. /* ex_data */
  414. typedef struct crypto_ex_data_func_st CRYPTO_EX_DATA_FUNCS;
  415. /* CRYPTO_EX_DATA_CLASS tracks the ex_indices registered for a type which
  416. * supports ex_data. It should defined as a static global within the module
  417. * which defines that type. */
  418. typedef struct {
  419. struct CRYPTO_STATIC_MUTEX lock;
  420. STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth;
  421. /* num_reserved is one if the ex_data index zero is reserved for legacy
  422. * |TYPE_get_app_data| functions. */
  423. uint8_t num_reserved;
  424. } CRYPTO_EX_DATA_CLASS;
  425. #define CRYPTO_EX_DATA_CLASS_INIT {CRYPTO_STATIC_MUTEX_INIT, NULL, 0}
  426. #define CRYPTO_EX_DATA_CLASS_INIT_WITH_APP_DATA \
  427. {CRYPTO_STATIC_MUTEX_INIT, NULL, 1}
  428. /* CRYPTO_get_ex_new_index allocates a new index for |ex_data_class| and writes
  429. * it to |*out_index|. Each class of object should provide a wrapper function
  430. * that uses the correct |CRYPTO_EX_DATA_CLASS|. It returns one on success and
  431. * zero otherwise. */
  432. OPENSSL_EXPORT int CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS *ex_data_class,
  433. int *out_index, long argl,
  434. void *argp, CRYPTO_EX_dup *dup_func,
  435. CRYPTO_EX_free *free_func);
  436. /* CRYPTO_set_ex_data sets an extra data pointer on a given object. Each class
  437. * of object should provide a wrapper function. */
  438. OPENSSL_EXPORT int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int index, void *val);
  439. /* CRYPTO_get_ex_data returns an extra data pointer for a given object, or NULL
  440. * if no such index exists. Each class of object should provide a wrapper
  441. * function. */
  442. OPENSSL_EXPORT void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int index);
  443. /* CRYPTO_new_ex_data initialises a newly allocated |CRYPTO_EX_DATA|. */
  444. OPENSSL_EXPORT void CRYPTO_new_ex_data(CRYPTO_EX_DATA *ad);
  445. /* CRYPTO_dup_ex_data duplicates |from| into a freshly allocated
  446. * |CRYPTO_EX_DATA|, |to|. Both of which are inside objects of the given
  447. * class. It returns one on success and zero otherwise. */
  448. OPENSSL_EXPORT int CRYPTO_dup_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class,
  449. CRYPTO_EX_DATA *to,
  450. const CRYPTO_EX_DATA *from);
  451. /* CRYPTO_free_ex_data frees |ad|, which is embedded inside |obj|, which is an
  452. * object of the given class. */
  453. OPENSSL_EXPORT void CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class,
  454. void *obj, CRYPTO_EX_DATA *ad);
  455. #if defined(__cplusplus)
  456. } /* extern C */
  457. #endif
  458. #endif /* OPENSSL_HEADER_CRYPTO_INTERNAL_H */