1 | /* |
2 | * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. |
3 | * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved. |
4 | * |
5 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
6 | * this file except in compliance with the License. You can obtain a copy |
7 | * in the file LICENSE in the source distribution or at |
8 | * https://www.openssl.org/source/license.html |
9 | */ |
10 | |
11 | #ifndef OPENSSL_PARAMS_H |
12 | # define OPENSSL_PARAMS_H |
13 | # pragma once |
14 | |
15 | # include <openssl/core.h> |
16 | # include <openssl/bn.h> |
17 | |
18 | # ifdef __cplusplus |
19 | extern "C" { |
20 | # endif |
21 | |
22 | # define OSSL_PARAM_UNMODIFIED ((size_t)-1) |
23 | |
24 | # define OSSL_PARAM_END \ |
25 | { NULL, 0, NULL, 0, 0 } |
26 | |
27 | # define OSSL_PARAM_DEFN(key, type, addr, sz) \ |
28 | { (key), (type), (addr), (sz), OSSL_PARAM_UNMODIFIED } |
29 | |
30 | /* Basic parameter types without return sizes */ |
31 | # define OSSL_PARAM_int(key, addr) \ |
32 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int)) |
33 | # define OSSL_PARAM_uint(key, addr) \ |
34 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ |
35 | sizeof(unsigned int)) |
36 | # define OSSL_PARAM_long(key, addr) \ |
37 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(long int)) |
38 | # define OSSL_PARAM_ulong(key, addr) \ |
39 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ |
40 | sizeof(unsigned long int)) |
41 | # define OSSL_PARAM_int32(key, addr) \ |
42 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int32_t)) |
43 | # define OSSL_PARAM_uint32(key, addr) \ |
44 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ |
45 | sizeof(uint32_t)) |
46 | # define OSSL_PARAM_int64(key, addr) \ |
47 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int64_t)) |
48 | # define OSSL_PARAM_uint64(key, addr) \ |
49 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ |
50 | sizeof(uint64_t)) |
51 | # define OSSL_PARAM_size_t(key, addr) \ |
52 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), sizeof(size_t)) |
53 | # define OSSL_PARAM_time_t(key, addr) \ |
54 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(time_t)) |
55 | # define OSSL_PARAM_double(key, addr) \ |
56 | OSSL_PARAM_DEFN((key), OSSL_PARAM_REAL, (addr), sizeof(double)) |
57 | |
58 | # define OSSL_PARAM_BN(key, bn, sz) \ |
59 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (bn), (sz)) |
60 | # define OSSL_PARAM_utf8_string(key, addr, sz) \ |
61 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_STRING, (addr), sz) |
62 | # define OSSL_PARAM_octet_string(key, addr, sz) \ |
63 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_STRING, (addr), sz) |
64 | |
65 | # define OSSL_PARAM_utf8_ptr(key, addr, sz) \ |
66 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_PTR, (addr), sz) |
67 | # define OSSL_PARAM_octet_ptr(key, addr, sz) \ |
68 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_PTR, (addr), sz) |
69 | |
70 | /* Search an OSSL_PARAM array for a matching name */ |
71 | OSSL_PARAM *OSSL_PARAM_locate(OSSL_PARAM *p, const char *key); |
72 | const OSSL_PARAM *OSSL_PARAM_locate_const(const OSSL_PARAM *p, const char *key); |
73 | |
74 | /* Basic parameter type run-time construction */ |
75 | OSSL_PARAM OSSL_PARAM_construct_int(const char *key, int *buf); |
76 | OSSL_PARAM OSSL_PARAM_construct_uint(const char *key, unsigned int *buf); |
77 | OSSL_PARAM OSSL_PARAM_construct_long(const char *key, long int *buf); |
78 | OSSL_PARAM OSSL_PARAM_construct_ulong(const char *key, unsigned long int *buf); |
79 | OSSL_PARAM OSSL_PARAM_construct_int32(const char *key, int32_t *buf); |
80 | OSSL_PARAM OSSL_PARAM_construct_uint32(const char *key, uint32_t *buf); |
81 | OSSL_PARAM OSSL_PARAM_construct_int64(const char *key, int64_t *buf); |
82 | OSSL_PARAM OSSL_PARAM_construct_uint64(const char *key, uint64_t *buf); |
83 | OSSL_PARAM OSSL_PARAM_construct_size_t(const char *key, size_t *buf); |
84 | OSSL_PARAM OSSL_PARAM_construct_time_t(const char *key, time_t *buf); |
85 | OSSL_PARAM OSSL_PARAM_construct_BN(const char *key, unsigned char *buf, |
86 | size_t bsize); |
87 | OSSL_PARAM OSSL_PARAM_construct_double(const char *key, double *buf); |
88 | OSSL_PARAM OSSL_PARAM_construct_utf8_string(const char *key, char *buf, |
89 | size_t bsize); |
90 | OSSL_PARAM OSSL_PARAM_construct_utf8_ptr(const char *key, char **buf, |
91 | size_t bsize); |
92 | OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf, |
93 | size_t bsize); |
94 | OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf, |
95 | size_t bsize); |
96 | OSSL_PARAM OSSL_PARAM_construct_end(void); |
97 | |
98 | int OSSL_PARAM_allocate_from_text(OSSL_PARAM *to, |
99 | const OSSL_PARAM *paramdefs, |
100 | const char *key, const char *value, |
101 | size_t value_n, int *found); |
102 | |
103 | int OSSL_PARAM_get_int(const OSSL_PARAM *p, int *val); |
104 | int OSSL_PARAM_get_uint(const OSSL_PARAM *p, unsigned int *val); |
105 | int OSSL_PARAM_get_long(const OSSL_PARAM *p, long int *val); |
106 | int OSSL_PARAM_get_ulong(const OSSL_PARAM *p, unsigned long int *val); |
107 | int OSSL_PARAM_get_int32(const OSSL_PARAM *p, int32_t *val); |
108 | int OSSL_PARAM_get_uint32(const OSSL_PARAM *p, uint32_t *val); |
109 | int OSSL_PARAM_get_int64(const OSSL_PARAM *p, int64_t *val); |
110 | int OSSL_PARAM_get_uint64(const OSSL_PARAM *p, uint64_t *val); |
111 | int OSSL_PARAM_get_size_t(const OSSL_PARAM *p, size_t *val); |
112 | int OSSL_PARAM_get_time_t(const OSSL_PARAM *p, time_t *val); |
113 | |
114 | int OSSL_PARAM_set_int(OSSL_PARAM *p, int val); |
115 | int OSSL_PARAM_set_uint(OSSL_PARAM *p, unsigned int val); |
116 | int OSSL_PARAM_set_long(OSSL_PARAM *p, long int val); |
117 | int OSSL_PARAM_set_ulong(OSSL_PARAM *p, unsigned long int val); |
118 | int OSSL_PARAM_set_int32(OSSL_PARAM *p, int32_t val); |
119 | int OSSL_PARAM_set_uint32(OSSL_PARAM *p, uint32_t val); |
120 | int OSSL_PARAM_set_int64(OSSL_PARAM *p, int64_t val); |
121 | int OSSL_PARAM_set_uint64(OSSL_PARAM *p, uint64_t val); |
122 | int OSSL_PARAM_set_size_t(OSSL_PARAM *p, size_t val); |
123 | int OSSL_PARAM_set_time_t(OSSL_PARAM *p, time_t val); |
124 | |
125 | int OSSL_PARAM_get_double(const OSSL_PARAM *p, double *val); |
126 | int OSSL_PARAM_set_double(OSSL_PARAM *p, double val); |
127 | |
128 | int OSSL_PARAM_get_BN(const OSSL_PARAM *p, BIGNUM **val); |
129 | int OSSL_PARAM_set_BN(OSSL_PARAM *p, const BIGNUM *val); |
130 | |
131 | int OSSL_PARAM_get_utf8_string(const OSSL_PARAM *p, char **val, size_t max_len); |
132 | int OSSL_PARAM_set_utf8_string(OSSL_PARAM *p, const char *val); |
133 | |
134 | int OSSL_PARAM_get_octet_string(const OSSL_PARAM *p, void **val, size_t max_len, |
135 | size_t *used_len); |
136 | int OSSL_PARAM_set_octet_string(OSSL_PARAM *p, const void *val, size_t len); |
137 | |
138 | int OSSL_PARAM_get_utf8_ptr(const OSSL_PARAM *p, const char **val); |
139 | int OSSL_PARAM_set_utf8_ptr(OSSL_PARAM *p, const char *val); |
140 | |
141 | int OSSL_PARAM_get_octet_ptr(const OSSL_PARAM *p, const void **val, |
142 | size_t *used_len); |
143 | int OSSL_PARAM_set_octet_ptr(OSSL_PARAM *p, const void *val, |
144 | size_t used_len); |
145 | |
146 | int OSSL_PARAM_get_utf8_string_ptr(const OSSL_PARAM *p, const char **val); |
147 | int OSSL_PARAM_get_octet_string_ptr(const OSSL_PARAM *p, const void **val, |
148 | size_t *used_len); |
149 | |
150 | int OSSL_PARAM_modified(const OSSL_PARAM *p); |
151 | void OSSL_PARAM_set_all_unmodified(OSSL_PARAM *p); |
152 | |
153 | OSSL_PARAM *OSSL_PARAM_dup(const OSSL_PARAM *p); |
154 | OSSL_PARAM *OSSL_PARAM_merge(const OSSL_PARAM *p1, const OSSL_PARAM *p2); |
155 | void OSSL_PARAM_free(OSSL_PARAM *p); |
156 | |
157 | # ifdef __cplusplus |
158 | } |
159 | # endif |
160 | #endif |
161 | |