]>
Commit | Line | Data |
---|---|---|
7ffbd7ca P |
1 | /* |
2 | * Copyright 2019 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 | ||
ae4186b0 DMSP |
11 | #ifndef OPENSSL_PARAMS_H |
12 | # define OPENSSL_PARAMS_H | |
7ffbd7ca P |
13 | |
14 | # include <openssl/core.h> | |
15 | # include <openssl/bn.h> | |
16 | ||
17 | # ifdef __cplusplus | |
18 | extern "C" { | |
19 | # endif | |
20 | ||
8d5fb648 P |
21 | # define OSSL_PARAM_UNMODIFIED ((size_t)-1) |
22 | ||
7ffbd7ca | 23 | # define OSSL_PARAM_END \ |
4e7991b4 | 24 | { NULL, 0, NULL, 0, 0 } |
7ffbd7ca | 25 | |
4e7991b4 | 26 | # define OSSL_PARAM_DEFN(key, type, addr, sz) \ |
8d5fb648 | 27 | { (key), (type), (addr), (sz), OSSL_PARAM_UNMODIFIED } |
7ffbd7ca P |
28 | |
29 | /* Basic parameter types without return sizes */ | |
30 | # define OSSL_PARAM_int(key, addr) \ | |
4e7991b4 | 31 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int)) |
7ffbd7ca P |
32 | # define OSSL_PARAM_uint(key, addr) \ |
33 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 34 | sizeof(unsigned int)) |
7ffbd7ca | 35 | # define OSSL_PARAM_long(key, addr) \ |
4e7991b4 | 36 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(long int)) |
7ffbd7ca P |
37 | # define OSSL_PARAM_ulong(key, addr) \ |
38 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 39 | sizeof(unsigned long int)) |
7ffbd7ca | 40 | # define OSSL_PARAM_int32(key, addr) \ |
4e7991b4 | 41 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int32_t)) |
7ffbd7ca P |
42 | # define OSSL_PARAM_uint32(key, addr) \ |
43 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 44 | sizeof(uint32_t)) |
7ffbd7ca | 45 | # define OSSL_PARAM_int64(key, addr) \ |
4e7991b4 | 46 | OSSL_PARAM_DEFN((key), OSSL_PARAM_INTEGER, (addr), sizeof(int64_t)) |
7ffbd7ca P |
47 | # define OSSL_PARAM_uint64(key, addr) \ |
48 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), \ | |
4e7991b4 | 49 | sizeof(uint64_t)) |
7ffbd7ca | 50 | # define OSSL_PARAM_size_t(key, addr) \ |
4e7991b4 | 51 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (addr), sizeof(size_t)) |
7ffbd7ca | 52 | # define OSSL_PARAM_double(key, addr) \ |
4e7991b4 | 53 | OSSL_PARAM_DEFN((key), OSSL_PARAM_REAL, (addr), sizeof(double)) |
7ffbd7ca | 54 | |
4e7991b4 P |
55 | # define OSSL_PARAM_BN(key, bn, sz) \ |
56 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UNSIGNED_INTEGER, (bn), (sz)) | |
7ffbd7ca | 57 | # define OSSL_PARAM_utf8_string(key, addr, sz) \ |
4e7991b4 | 58 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_STRING, (addr), sz) |
7ffbd7ca | 59 | # define OSSL_PARAM_octet_string(key, addr, sz) \ |
4e7991b4 | 60 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_STRING, (addr), sz) |
7ffbd7ca P |
61 | |
62 | # define OSSL_PARAM_utf8_ptr(key, addr, sz) \ | |
4e7991b4 | 63 | OSSL_PARAM_DEFN((key), OSSL_PARAM_UTF8_PTR, &(addr), sz) |
7ffbd7ca | 64 | # define OSSL_PARAM_octet_ptr(key, addr, sz) \ |
4e7991b4 | 65 | OSSL_PARAM_DEFN((key), OSSL_PARAM_OCTET_PTR, &(addr), sz) |
7ffbd7ca P |
66 | |
67 | /* Search an OSSL_PARAM array for a matching name */ | |
4e7991b4 P |
68 | OSSL_PARAM *OSSL_PARAM_locate(OSSL_PARAM *p, const char *key); |
69 | const OSSL_PARAM *OSSL_PARAM_locate_const(const OSSL_PARAM *p, const char *key); | |
7ffbd7ca P |
70 | |
71 | /* Basic parameter type run-time construction */ | |
4e7991b4 P |
72 | OSSL_PARAM OSSL_PARAM_construct_int(const char *key, int *buf); |
73 | OSSL_PARAM OSSL_PARAM_construct_uint(const char *key, unsigned int *buf); | |
74 | OSSL_PARAM OSSL_PARAM_construct_long(const char *key, long int *buf); | |
75 | OSSL_PARAM OSSL_PARAM_construct_ulong(const char *key, unsigned long int *buf); | |
76 | OSSL_PARAM OSSL_PARAM_construct_int32(const char *key, int32_t *buf); | |
77 | OSSL_PARAM OSSL_PARAM_construct_uint32(const char *key, uint32_t *buf); | |
78 | OSSL_PARAM OSSL_PARAM_construct_int64(const char *key, int64_t *buf); | |
79 | OSSL_PARAM OSSL_PARAM_construct_uint64(const char *key, uint64_t *buf); | |
80 | OSSL_PARAM OSSL_PARAM_construct_size_t(const char *key, size_t *buf); | |
7ffbd7ca | 81 | OSSL_PARAM OSSL_PARAM_construct_BN(const char *key, unsigned char *buf, |
4e7991b4 P |
82 | size_t bsize); |
83 | OSSL_PARAM OSSL_PARAM_construct_double(const char *key, double *buf); | |
7ffbd7ca | 84 | OSSL_PARAM OSSL_PARAM_construct_utf8_string(const char *key, char *buf, |
4e7991b4 | 85 | size_t bsize); |
7ffbd7ca | 86 | OSSL_PARAM OSSL_PARAM_construct_utf8_ptr(const char *key, char **buf, |
4e7991b4 | 87 | size_t bsize); |
7ffbd7ca | 88 | OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf, |
4e7991b4 | 89 | size_t bsize); |
7ffbd7ca | 90 | OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf, |
4e7991b4 | 91 | size_t bsize); |
195852fe | 92 | OSSL_PARAM OSSL_PARAM_construct_end(void); |
7ffbd7ca | 93 | |
246a1f3d RL |
94 | int OSSL_PARAM_allocate_from_text(OSSL_PARAM *to, |
95 | const OSSL_PARAM *paramdefs, | |
96 | const char *key, const char *value, | |
2ee0dfa6 | 97 | size_t value_n, int *found); |
246a1f3d | 98 | |
7ffbd7ca P |
99 | int OSSL_PARAM_get_int(const OSSL_PARAM *p, int *val); |
100 | int OSSL_PARAM_get_uint(const OSSL_PARAM *p, unsigned int *val); | |
101 | int OSSL_PARAM_get_long(const OSSL_PARAM *p, long int *val); | |
102 | int OSSL_PARAM_get_ulong(const OSSL_PARAM *p, unsigned long int *val); | |
103 | int OSSL_PARAM_get_int32(const OSSL_PARAM *p, int32_t *val); | |
104 | int OSSL_PARAM_get_uint32(const OSSL_PARAM *p, uint32_t *val); | |
105 | int OSSL_PARAM_get_int64(const OSSL_PARAM *p, int64_t *val); | |
106 | int OSSL_PARAM_get_uint64(const OSSL_PARAM *p, uint64_t *val); | |
107 | int OSSL_PARAM_get_size_t(const OSSL_PARAM *p, size_t *val); | |
108 | ||
4e7991b4 P |
109 | int OSSL_PARAM_set_int(OSSL_PARAM *p, int val); |
110 | int OSSL_PARAM_set_uint(OSSL_PARAM *p, unsigned int val); | |
111 | int OSSL_PARAM_set_long(OSSL_PARAM *p, long int val); | |
112 | int OSSL_PARAM_set_ulong(OSSL_PARAM *p, unsigned long int val); | |
113 | int OSSL_PARAM_set_int32(OSSL_PARAM *p, int32_t val); | |
114 | int OSSL_PARAM_set_uint32(OSSL_PARAM *p, uint32_t val); | |
115 | int OSSL_PARAM_set_int64(OSSL_PARAM *p, int64_t val); | |
116 | int OSSL_PARAM_set_uint64(OSSL_PARAM *p, uint64_t val); | |
117 | int OSSL_PARAM_set_size_t(OSSL_PARAM *p, size_t val); | |
7ffbd7ca P |
118 | |
119 | int OSSL_PARAM_get_double(const OSSL_PARAM *p, double *val); | |
4e7991b4 | 120 | int OSSL_PARAM_set_double(OSSL_PARAM *p, double val); |
7ffbd7ca P |
121 | |
122 | int OSSL_PARAM_get_BN(const OSSL_PARAM *p, BIGNUM **val); | |
4e7991b4 | 123 | int OSSL_PARAM_set_BN(OSSL_PARAM *p, const BIGNUM *val); |
7ffbd7ca P |
124 | |
125 | int OSSL_PARAM_get_utf8_string(const OSSL_PARAM *p, char **val, size_t max_len); | |
4e7991b4 | 126 | int OSSL_PARAM_set_utf8_string(OSSL_PARAM *p, const char *val); |
7ffbd7ca P |
127 | |
128 | int OSSL_PARAM_get_octet_string(const OSSL_PARAM *p, void **val, size_t max_len, | |
129 | size_t *used_len); | |
4e7991b4 | 130 | int OSSL_PARAM_set_octet_string(OSSL_PARAM *p, const void *val, size_t len); |
7ffbd7ca P |
131 | |
132 | int OSSL_PARAM_get_utf8_ptr(const OSSL_PARAM *p, const char **val); | |
4e7991b4 | 133 | int OSSL_PARAM_set_utf8_ptr(OSSL_PARAM *p, const char *val); |
7ffbd7ca P |
134 | |
135 | int OSSL_PARAM_get_octet_ptr(const OSSL_PARAM *p, const void **val, | |
136 | size_t *used_len); | |
4e7991b4 | 137 | int OSSL_PARAM_set_octet_ptr(OSSL_PARAM *p, const void *val, |
7ffbd7ca P |
138 | size_t used_len); |
139 | ||
8d5fb648 P |
140 | int OSSL_PARAM_modified(const OSSL_PARAM *p); |
141 | void OSSL_PARAM_set_unmodified(OSSL_PARAM *p); | |
142 | ||
7ffbd7ca P |
143 | # ifdef __cplusplus |
144 | } | |
145 | # endif | |
146 | #endif |