[331] | 1 | /*
|
---|
| 2 | * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
|
---|
| 3 | *
|
---|
| 4 | * Licensed under the OpenSSL license (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 HEADER_SAFESTACK_H
|
---|
| 11 | # define HEADER_SAFESTACK_H
|
---|
| 12 |
|
---|
| 13 | # include <openssl/stack.h>
|
---|
| 14 | # include <openssl/e_os2.h>
|
---|
| 15 |
|
---|
| 16 | #ifdef __cplusplus
|
---|
| 17 | extern "C" {
|
---|
| 18 | #endif
|
---|
| 19 |
|
---|
| 20 | # define STACK_OF(type) struct stack_st_##type
|
---|
| 21 |
|
---|
| 22 | # define SKM_DEFINE_STACK_OF(t1, t2, t3) \
|
---|
| 23 | STACK_OF(t1); \
|
---|
| 24 | typedef int (*sk_##t1##_compfunc)(const t3 * const *a, const t3 *const *b); \
|
---|
| 25 | typedef void (*sk_##t1##_freefunc)(t3 *a); \
|
---|
| 26 | typedef t3 * (*sk_##t1##_copyfunc)(const t3 *a); \
|
---|
| 27 | static ossl_inline int sk_##t1##_num(const STACK_OF(t1) *sk) \
|
---|
| 28 | { \
|
---|
| 29 | return OPENSSL_sk_num((const OPENSSL_STACK *)sk); \
|
---|
| 30 | } \
|
---|
| 31 | static ossl_inline t2 *sk_##t1##_value(const STACK_OF(t1) *sk, int idx) \
|
---|
| 32 | { \
|
---|
| 33 | return (t2 *)OPENSSL_sk_value((const OPENSSL_STACK *)sk, idx); \
|
---|
| 34 | } \
|
---|
| 35 | static ossl_inline STACK_OF(t1) *sk_##t1##_new(sk_##t1##_compfunc compare) \
|
---|
| 36 | { \
|
---|
| 37 | return (STACK_OF(t1) *)OPENSSL_sk_new((OPENSSL_sk_compfunc)compare); \
|
---|
| 38 | } \
|
---|
| 39 | static ossl_inline STACK_OF(t1) *sk_##t1##_new_null(void) \
|
---|
| 40 | { \
|
---|
| 41 | return (STACK_OF(t1) *)OPENSSL_sk_new_null(); \
|
---|
| 42 | } \
|
---|
| 43 | static ossl_inline void sk_##t1##_free(STACK_OF(t1) *sk) \
|
---|
| 44 | { \
|
---|
| 45 | OPENSSL_sk_free((OPENSSL_STACK *)sk); \
|
---|
| 46 | } \
|
---|
| 47 | static ossl_inline void sk_##t1##_zero(STACK_OF(t1) *sk) \
|
---|
| 48 | { \
|
---|
| 49 | OPENSSL_sk_zero((OPENSSL_STACK *)sk); \
|
---|
| 50 | } \
|
---|
| 51 | static ossl_inline t2 *sk_##t1##_delete(STACK_OF(t1) *sk, int i) \
|
---|
| 52 | { \
|
---|
| 53 | return (t2 *)OPENSSL_sk_delete((OPENSSL_STACK *)sk, i); \
|
---|
| 54 | } \
|
---|
| 55 | static ossl_inline t2 *sk_##t1##_delete_ptr(STACK_OF(t1) *sk, t2 *ptr) \
|
---|
| 56 | { \
|
---|
| 57 | return (t2 *)OPENSSL_sk_delete_ptr((OPENSSL_STACK *)sk, \
|
---|
| 58 | (const void *)ptr); \
|
---|
| 59 | } \
|
---|
| 60 | static ossl_inline int sk_##t1##_push(STACK_OF(t1) *sk, t2 *ptr) \
|
---|
| 61 | { \
|
---|
| 62 | return OPENSSL_sk_push((OPENSSL_STACK *)sk, (const void *)ptr); \
|
---|
| 63 | } \
|
---|
| 64 | static ossl_inline int sk_##t1##_unshift(STACK_OF(t1) *sk, t2 *ptr) \
|
---|
| 65 | { \
|
---|
| 66 | return OPENSSL_sk_unshift((OPENSSL_STACK *)sk, (const void *)ptr); \
|
---|
| 67 | } \
|
---|
| 68 | static ossl_inline t2 *sk_##t1##_pop(STACK_OF(t1) *sk) \
|
---|
| 69 | { \
|
---|
| 70 | return (t2 *)OPENSSL_sk_pop((OPENSSL_STACK *)sk); \
|
---|
| 71 | } \
|
---|
| 72 | static ossl_inline t2 *sk_##t1##_shift(STACK_OF(t1) *sk) \
|
---|
| 73 | { \
|
---|
| 74 | return (t2 *)OPENSSL_sk_shift((OPENSSL_STACK *)sk); \
|
---|
| 75 | } \
|
---|
| 76 | static ossl_inline void sk_##t1##_pop_free(STACK_OF(t1) *sk, sk_##t1##_freefunc freefunc) \
|
---|
| 77 | { \
|
---|
| 78 | OPENSSL_sk_pop_free((OPENSSL_STACK *)sk, (OPENSSL_sk_freefunc)freefunc); \
|
---|
| 79 | } \
|
---|
| 80 | static ossl_inline int sk_##t1##_insert(STACK_OF(t1) *sk, t2 *ptr, int idx) \
|
---|
| 81 | { \
|
---|
| 82 | return OPENSSL_sk_insert((OPENSSL_STACK *)sk, (const void *)ptr, idx); \
|
---|
| 83 | } \
|
---|
| 84 | static ossl_inline t2 *sk_##t1##_set(STACK_OF(t1) *sk, int idx, t2 *ptr) \
|
---|
| 85 | { \
|
---|
| 86 | return (t2 *)OPENSSL_sk_set((OPENSSL_STACK *)sk, idx, (const void *)ptr); \
|
---|
| 87 | } \
|
---|
| 88 | static ossl_inline int sk_##t1##_find(STACK_OF(t1) *sk, t2 *ptr) \
|
---|
| 89 | { \
|
---|
| 90 | return OPENSSL_sk_find((OPENSSL_STACK *)sk, (const void *)ptr); \
|
---|
| 91 | } \
|
---|
| 92 | static ossl_inline int sk_##t1##_find_ex(STACK_OF(t1) *sk, t2 *ptr) \
|
---|
| 93 | { \
|
---|
| 94 | return OPENSSL_sk_find_ex((OPENSSL_STACK *)sk, (const void *)ptr); \
|
---|
| 95 | } \
|
---|
| 96 | static ossl_inline void sk_##t1##_sort(STACK_OF(t1) *sk) \
|
---|
| 97 | { \
|
---|
| 98 | OPENSSL_sk_sort((OPENSSL_STACK *)sk); \
|
---|
| 99 | } \
|
---|
| 100 | static ossl_inline int sk_##t1##_is_sorted(const STACK_OF(t1) *sk) \
|
---|
| 101 | { \
|
---|
| 102 | return OPENSSL_sk_is_sorted((const OPENSSL_STACK *)sk); \
|
---|
| 103 | } \
|
---|
| 104 | static ossl_inline STACK_OF(t1) * sk_##t1##_dup(const STACK_OF(t1) *sk) \
|
---|
| 105 | { \
|
---|
| 106 | return (STACK_OF(t1) *)OPENSSL_sk_dup((const OPENSSL_STACK *)sk); \
|
---|
| 107 | } \
|
---|
| 108 | static ossl_inline STACK_OF(t1) *sk_##t1##_deep_copy(const STACK_OF(t1) *sk, \
|
---|
| 109 | sk_##t1##_copyfunc copyfunc, \
|
---|
| 110 | sk_##t1##_freefunc freefunc) \
|
---|
| 111 | { \
|
---|
| 112 | return (STACK_OF(t1) *)OPENSSL_sk_deep_copy((const OPENSSL_STACK *)sk, \
|
---|
| 113 | (OPENSSL_sk_copyfunc)copyfunc, \
|
---|
| 114 | (OPENSSL_sk_freefunc)freefunc); \
|
---|
| 115 | } \
|
---|
| 116 | static ossl_inline sk_##t1##_compfunc sk_##t1##_set_cmp_func(STACK_OF(t1) *sk, sk_##t1##_compfunc compare) \
|
---|
| 117 | { \
|
---|
| 118 | return (sk_##t1##_compfunc)OPENSSL_sk_set_cmp_func((OPENSSL_STACK *)sk, (OPENSSL_sk_compfunc)compare); \
|
---|
| 119 | }
|
---|
| 120 |
|
---|
| 121 | # define DEFINE_SPECIAL_STACK_OF(t1, t2) SKM_DEFINE_STACK_OF(t1, t2, t2)
|
---|
| 122 | # define DEFINE_STACK_OF(t) SKM_DEFINE_STACK_OF(t, t, t)
|
---|
| 123 | # define DEFINE_SPECIAL_STACK_OF_CONST(t1, t2) \
|
---|
| 124 | SKM_DEFINE_STACK_OF(t1, const t2, t2)
|
---|
| 125 | # define DEFINE_STACK_OF_CONST(t) SKM_DEFINE_STACK_OF(t, const t, t)
|
---|
| 126 |
|
---|
| 127 | /*-
|
---|
| 128 | * Strings are special: normally an lhash entry will point to a single
|
---|
| 129 | * (somewhat) mutable object. In the case of strings:
|
---|
| 130 | *
|
---|
| 131 | * a) Instead of a single char, there is an array of chars, NUL-terminated.
|
---|
| 132 | * b) The string may have be immutable.
|
---|
| 133 | *
|
---|
| 134 | * So, they need their own declarations. Especially important for
|
---|
| 135 | * type-checking tools, such as Deputy.
|
---|
| 136 | *
|
---|
| 137 | * In practice, however, it appears to be hard to have a const
|
---|
| 138 | * string. For now, I'm settling for dealing with the fact it is a
|
---|
| 139 | * string at all.
|
---|
| 140 | */
|
---|
| 141 | typedef char *OPENSSL_STRING;
|
---|
| 142 | typedef const char *OPENSSL_CSTRING;
|
---|
| 143 |
|
---|
| 144 | /*-
|
---|
| 145 | * Confusingly, LHASH_OF(STRING) deals with char ** throughout, but
|
---|
| 146 | * STACK_OF(STRING) is really more like STACK_OF(char), only, as mentioned
|
---|
| 147 | * above, instead of a single char each entry is a NUL-terminated array of
|
---|
| 148 | * chars. So, we have to implement STRING specially for STACK_OF. This is
|
---|
| 149 | * dealt with in the autogenerated macros below.
|
---|
| 150 | */
|
---|
| 151 | DEFINE_SPECIAL_STACK_OF(OPENSSL_STRING, char)
|
---|
| 152 | DEFINE_SPECIAL_STACK_OF_CONST(OPENSSL_CSTRING, char)
|
---|
| 153 |
|
---|
| 154 | /*
|
---|
| 155 | * Similarly, we sometimes use a block of characters, NOT nul-terminated.
|
---|
| 156 | * These should also be distinguished from "normal" stacks.
|
---|
| 157 | */
|
---|
| 158 | typedef void *OPENSSL_BLOCK;
|
---|
| 159 | DEFINE_SPECIAL_STACK_OF(OPENSSL_BLOCK, void)
|
---|
| 160 |
|
---|
| 161 | # ifdef __cplusplus
|
---|
| 162 | }
|
---|
| 163 | # endif
|
---|
| 164 | #endif
|
---|