]>
Commit | Line | Data |
---|---|---|
7ffbd7ca | 1 | /* |
4333b89f | 2 | * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. |
7ffbd7ca P |
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 | ||
ae4186b0 DMSP |
11 | #ifndef OPENSSL_PARAMS_H |
12 | # define OPENSSL_PARAMS_H | |
d59068bd | 13 | # pragma once |
7ffbd7ca P |
14 | |
15 | # include <openssl/core.h> | |
16 | # include <openssl/bn.h> | |
17 | ||
18 | # ifdef __cplusplus | |
19 | extern "C" { | |
20 | # endif | |
21 | ||
8d5fb648 P |
22 | # define OSSL_PARAM_UNMODIFIED ((size_t)-1) |
23 | ||
7ffbd7ca | 24 | # define OSSL_PARAM_END \ |
4e7991b4 | 25 | { NULL, 0, NULL, 0, 0 } |
7ffbd7ca | 26 | |
4e7991b4 | 27 | # define OSSL_PARAM_DEFN(key, type, addr, sz) \ |
8d5fb648 | 28 | { (key), (type), (addr), (sz), OSSL_PARAM_UNMODIFIED } |
7ffbd7ca P |
29 | |
30 | /* Basic parameter types without return sizes */ | |
31 | # define OSSL_PARAM_int(key, addr) \ | |
4e7991b4 | 32 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int)) |
7ffbd7ca P |
33 | # define OSSL_PARAM_uint(key, addr) \ |
34 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 35 | sizeof(unsigned int)) |
7ffbd7ca | 36 | # define OSSL_PARAM_long(key, addr) \ |
4e7991b4 | 37 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(long int)) |
7ffbd7ca P |
38 | # define OSSL_PARAM_ulong(key, addr) \ |
39 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 40 | sizeof(unsigned long int)) |
7ffbd7ca | 41 | # define OSSL_PARAM_int32(key, addr) \ |
4e7991b4 | 42 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int32_t)) |
7ffbd7ca P |
43 | # define OSSL_PARAM_uint32(key, addr) \ |
44 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 45 | sizeof(uint32_t)) |
7ffbd7ca | 46 | # define OSSL_PARAM_int64(key, addr) \ |
4e7991b4 | 47 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int64_t)) |
7ffbd7ca P |
48 | # define OSSL_PARAM_uint64(key, addr) \ |
49 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 50 | sizeof(uint64_t)) |
7ffbd7ca | 51 | # define OSSL_PARAM_size_t(key, addr) \ |
4e7991b4 | 52 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), sizeof(size_t)) |
5fdaa38f P |
53 | # define OSSL_PARAM_time_t(key, addr) \ |
54 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(time_t)) | |
7ffbd7ca | 55 | # define OSSL_PARAM_double(key, addr) \ |
4e7991b4 | 56 | OSSL_PARAM_DEFN((key), OSSL_PARAM_REAL, (addr), sizeof(double)) |
7ffbd7ca | 57 | |
4e7991b4 P |
58 | # define OSSL_PARAM_BN(key, bn, sz) \ |
59 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (bn), (sz)) | |
7ffbd7ca | 60 | # define OSSL_PARAM_utf8_string(key, addr, sz) \ |
4e7991b4 | 61 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_STRING, (addr), sz) |
7ffbd7ca | 62 | # define OSSL_PARAM_octet_string(key, addr, sz) \ |
4e7991b4 | 63 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_STRING, (addr), sz) |
7ffbd7ca P |
64 | |
65 | # define OSSL_PARAM_utf8_ptr(key, addr, sz) \ | |
1395a84e | 66 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_PTR, (addr), sz) |
7ffbd7ca | 67 | # define OSSL_PARAM_octet_ptr(key, addr, sz) \ |
1395a84e | 68 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_PTR, (addr), sz) |
7ffbd7ca P |
69 | |
70 | /* Search an OSSL_PARAM array for a matching name */ | |
4e7991b4 P |
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); | |
7ffbd7ca P |
73 | |
74 | /* Basic parameter type run-time construction */ | |
4e7991b4 P |
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); | |
5fdaa38f | 84 | OSSL_PARAM OSSL_PARAM_construct_time_t(const char *key, time_t *buf); |
7ffbd7ca | 85 | OSSL_PARAM OSSL_PARAM_construct_BN(const char *key, unsigned char *buf, |
4e7991b4 P |
86 | size_t bsize); |
87 | OSSL_PARAM OSSL_PARAM_construct_double(const char *key, double *buf); | |
7ffbd7ca | 88 | OSSL_PARAM OSSL_PARAM_construct_utf8_string(const char *key, char *buf, |
4e7991b4 | 89 | size_t bsize); |
7ffbd7ca | 90 | OSSL_PARAM OSSL_PARAM_construct_utf8_ptr(const char *key, char **buf, |
4e7991b4 | 91 | size_t bsize); |
7ffbd7ca | 92 | OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf, |
4e7991b4 | 93 | size_t bsize); |
7ffbd7ca | 94 | OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf, |
4e7991b4 | 95 | size_t bsize); |
195852fe | 96 | OSSL_PARAM OSSL_PARAM_construct_end(void); |
7ffbd7ca | 97 | |
246a1f3d RL |
98 | int OSSL_PARAM_allocate_from_text(OSSL_PARAM *to, |
99 | const OSSL_PARAM *paramdefs, | |
100 | const char *key, const char *value, | |
2ee0dfa6 | 101 | size_t value_n, int *found); |
246a1f3d | 102 | |
7ffbd7ca P |
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); | |
5fdaa38f | 112 | int OSSL_PARAM_get_time_t(const OSSL_PARAM *p, time_t *val); |
7ffbd7ca | 113 | |
4e7991b4 P |
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); | |
5fdaa38f | 123 | int OSSL_PARAM_set_time_t(OSSL_PARAM *p, time_t val); |
7ffbd7ca P |
124 | |
125 | int OSSL_PARAM_get_double(const OSSL_PARAM *p, double *val); | |
4e7991b4 | 126 | int OSSL_PARAM_set_double(OSSL_PARAM *p, double val); |
7ffbd7ca P |
127 | |
128 | int OSSL_PARAM_get_BN(const OSSL_PARAM *p, BIGNUM **val); | |
4e7991b4 | 129 | int OSSL_PARAM_set_BN(OSSL_PARAM *p, const BIGNUM *val); |
7ffbd7ca P |
130 | |
131 | int OSSL_PARAM_get_utf8_string(const OSSL_PARAM *p, char **val, size_t max_len); | |
4e7991b4 | 132 | int OSSL_PARAM_set_utf8_string(OSSL_PARAM *p, const char *val); |
7ffbd7ca P |
133 | |
134 | int OSSL_PARAM_get_octet_string(const OSSL_PARAM *p, void **val, size_t max_len, | |
135 | size_t *used_len); | |
4e7991b4 | 136 | int OSSL_PARAM_set_octet_string(OSSL_PARAM *p, const void *val, size_t len); |
7ffbd7ca P |
137 | |
138 | int OSSL_PARAM_get_utf8_ptr(const OSSL_PARAM *p, const char **val); | |
4e7991b4 | 139 | int OSSL_PARAM_set_utf8_ptr(OSSL_PARAM *p, const char *val); |
7ffbd7ca P |
140 | |
141 | int OSSL_PARAM_get_octet_ptr(const OSSL_PARAM *p, const void **val, | |
142 | size_t *used_len); | |
4e7991b4 | 143 | int OSSL_PARAM_set_octet_ptr(OSSL_PARAM *p, const void *val, |
7ffbd7ca P |
144 | size_t used_len); |
145 | ||
ab00ddb5 RL |
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 | ||
8d5fb648 | 150 | int OSSL_PARAM_modified(const OSSL_PARAM *p); |
3873887e | 151 | void OSSL_PARAM_set_all_unmodified(OSSL_PARAM *p); |
8d5fb648 | 152 | |
7ffbd7ca P |
153 | # ifdef __cplusplus |
154 | } | |
155 | # endif | |
156 | #endif |