]>
Commit | Line | Data |
---|---|---|
3c93fbac P |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
20c98cd4 P |
5 | OSSL_PARAM_BLD, OSSL_PARAM_BLD_new, OSSL_PARAM_BLD_to_param, |
6 | OSSL_PARAM_BLD_free_params, OSSL_PARAM_BLD_free, OSSL_PARAM_BLD_push_int, | |
7 | OSSL_PARAM_BLD_push_uint, OSSL_PARAM_BLD_push_long, | |
8 | OSSL_PARAM_BLD_push_ulong, OSSL_PARAM_BLD_push_int32, | |
9 | OSSL_PARAM_BLD_push_uint32, OSSL_PARAM_BLD_push_int64, | |
10 | OSSL_PARAM_BLD_push_uint64, OSSL_PARAM_BLD_push_size_t, | |
dc4e74ef P |
11 | OSSL_PARAM_BLD_push_time_t, OSSL_PARAM_BLD_push_double, |
12 | OSSL_PARAM_BLD_push_BN, OSSL_PARAM_BLD_push_BN_pad, | |
13 | OSSL_PARAM_BLD_push_utf8_string, OSSL_PARAM_BLD_push_utf8_ptr, | |
14 | OSSL_PARAM_BLD_push_octet_string, OSSL_PARAM_BLD_push_octet_ptr | |
3c93fbac P |
15 | - functions to assist in the creation of OSSL_PARAM arrays |
16 | ||
17 | =head1 SYNOPSIS | |
18 | ||
bb82531f | 19 | =for openssl generic |
3c93fbac | 20 | |
879365e6 | 21 | #include <openssl/param_build.h> |
3c93fbac | 22 | |
6d4e6009 | 23 | typedef struct OSSL_PARAM_BLD; |
3c93fbac | 24 | |
6d4e6009 | 25 | OSSL_PARAM_BLD *OSSL_PARAM_BLD_new(void); |
110bff61 | 26 | OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld); |
be19d3ca P |
27 | void OSSL_PARAM_BLD_free_params(OSSL_PARAM *params); |
28 | void OSSL_PARAM_BLD_free(OSSL_PARAM_BLD *bld); | |
3c93fbac | 29 | |
110bff61 | 30 | int OSSL_PARAM_BLD_push_TYPE(OSSL_PARAM_BLD *bld, const char *key, TYPE val); |
3c93fbac | 31 | |
110bff61 | 32 | int OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD *bld, const char *key, |
3c93fbac | 33 | const BIGNUM *bn); |
110bff61 | 34 | int OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD *bld, const char *key, |
ac23078b | 35 | const BIGNUM *bn, size_t sz); |
3c93fbac | 36 | |
110bff61 | 37 | int OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key, |
5fa7789f | 38 | const char *buf, size_t bsize); |
110bff61 | 39 | int OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key, |
3c93fbac | 40 | char *buf, size_t bsize); |
110bff61 | 41 | int OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD *bld, const char *key, |
5fa7789f | 42 | const void *buf, size_t bsize); |
110bff61 | 43 | int OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key, |
3c93fbac P |
44 | void *buf, size_t bsize); |
45 | ||
46 | ||
47 | =head1 DESCRIPTION | |
48 | ||
49 | A collection of utility functions that simplify the creation of OSSL_PARAM | |
bbecf04e | 50 | arrays. The B<I<TYPE>> names are as per L<OSSL_PARAM_int(3)>. |
3c93fbac | 51 | |
6d4e6009 P |
52 | OSSL_PARAM_BLD_new() allocates and initialises a new OSSL_PARAM_BLD structure |
53 | so that values can be added. | |
3c93fbac P |
54 | Any existing values are cleared. |
55 | ||
be19d3ca P |
56 | OSSL_PARAM_BLD_free() deallocates the memory allocates by OSSL_PARAM_BLD_new(). |
57 | ||
110bff61 | 58 | OSSL_PARAM_BLD_to_param() converts a built up OSSL_PARAM_BLD structure |
dfabee82 | 59 | I<bld> into an allocated OSSL_PARAM array. |
7312ef3f | 60 | The OSSL_PARAM array and all associated storage must be freed by calling |
be19d3ca P |
61 | OSSL_PARAM_BLD_free_params() with the functions return value. |
62 | OSSL_PARAM_BLD_free() can safely be called any time after this function is. | |
7312ef3f | 63 | |
be19d3ca | 64 | OSSL_PARAM_BLD_free_params() deallocates the memory allocated by |
110bff61 | 65 | OSSL_PARAM_BLD_to_param(). |
3c93fbac | 66 | |
c18d2d94 RL |
67 | =begin comment |
68 | ||
69 | POD is pretty good at recognising function names and making them appropriately | |
70 | bold... however, when part of the function name is variable, we have to help | |
71 | the processor along | |
72 | ||
73 | =end comment | |
74 | ||
110bff61 | 75 | B<OSSL_PARAM_BLD_push_I<TYPE>>() are a series of functions which will create |
dfabee82 | 76 | OSSL_PARAM objects of the specified size and correct type for the I<val> |
3c93fbac | 77 | argument. |
dfabee82 | 78 | I<val> is stored by value and an expression or auto variable can be used. |
3c93fbac | 79 | |
110bff61 | 80 | OSSL_PARAM_BLD_push_BN() is a function that will create an OSSL_PARAM object |
dfabee82 | 81 | that holds the specified BIGNUM I<bn>. |
af61cbca | 82 | If I<bn> is marked as being securely allocated, its OSSL_PARAM representation |
7312ef3f | 83 | will also be securely allocated. |
dfabee82 | 84 | The I<bn> argument is stored by reference and the underlying BIGNUM object |
110bff61 | 85 | must exist until after OSSL_PARAM_BLD_to_param() has been called. |
3c93fbac | 86 | |
110bff61 | 87 | OSSL_PARAM_BLD_push_BN_pad() is a function that will create an OSSL_PARAM object |
ac23078b P |
88 | that holds the specified BIGNUM I<bn>. |
89 | The object will be padded to occupy exactly I<sz> bytes, if insufficient space | |
90 | is specified an error results. | |
af61cbca | 91 | If I<bn> is marked as being securely allocated, its OSSL_PARAM representation |
ac23078b P |
92 | will also be securely allocated. |
93 | The I<bn> argument is stored by reference and the underlying BIGNUM object | |
110bff61 | 94 | must exist until after OSSL_PARAM_BLD_to_param() has been called. |
ac23078b | 95 | |
110bff61 | 96 | OSSL_PARAM_BLD_push_utf8_string() is a function that will create an OSSL_PARAM |
dfabee82 RL |
97 | object that references the UTF8 string specified by I<buf>. |
98 | If the length of the string, I<bsize>, is zero then it will be calculated. | |
99 | The string that I<buf> points to is stored by reference and must remain in | |
110bff61 | 100 | scope until after OSSL_PARAM_BLD_to_param() has been called. |
3c93fbac | 101 | |
110bff61 | 102 | OSSL_PARAM_BLD_push_octet_string() is a function that will create an OSSL_PARAM |
dfabee82 RL |
103 | object that references the octet string specified by I<buf> and <bsize>. |
104 | The memory that I<buf> points to is stored by reference and must remain in | |
110bff61 | 105 | scope until after OSSL_PARAM_BLD_to_param() has been called. |
3c93fbac | 106 | |
110bff61 | 107 | OSSL_PARAM_BLD_push_utf8_ptr() is a function that will create an OSSL_PARAM |
dfabee82 RL |
108 | object that references the UTF8 string specified by I<buf>. |
109 | If the length of the string, I<bsize>, is zero then it will be calculated. | |
110 | The string I<buf> points to is stored by reference and must remain in | |
3c93fbac P |
111 | scope until the OSSL_PARAM array is freed. |
112 | ||
110bff61 | 113 | OSSL_PARAM_BLD_push_octet_ptr() is a function that will create an OSSL_PARAM |
dfabee82 RL |
114 | object that references the octet string specified by I<buf>. |
115 | The memory I<buf> points to is stored by reference and must remain in | |
3c93fbac P |
116 | scope until the OSSL_PARAM array is freed. |
117 | ||
118 | =head1 RETURN VALUES | |
119 | ||
6d4e6009 P |
120 | OSSL_PARAM_BLD_new() returns the allocated OSSL_PARAM_BLD structure, or NULL |
121 | on error. | |
122 | ||
110bff61 | 123 | OSSL_PARAM_BLD_to_param() returns the allocated OSSL_PARAM array, or NULL |
903f5820 | 124 | on error. |
3c93fbac | 125 | |
110bff61 | 126 | All of the OSSL_PARAM_BLD_push_TYPE functions return 1 on success and 0 |
3c93fbac P |
127 | on error. |
128 | ||
3c93fbac P |
129 | =head1 EXAMPLES |
130 | ||
131 | Both examples creating an OSSL_PARAM array that contains an RSA key. | |
132 | For both, the predefined key variables are: | |
133 | ||
134 | BIGNUM *p, *q; /* both prime */ | |
135 | BIGNUM *n; /* = p * q */ | |
136 | unsigned int e; /* exponent, usually 65537 */ | |
137 | BIGNUM *d; /* e^-1 */ | |
138 | ||
139 | =head2 Example 1 | |
140 | ||
141 | This example shows how to create an OSSL_PARAM array that contains an RSA | |
142 | private key. | |
143 | ||
6d4e6009 | 144 | OSSL_PARAM_BLD *bld = OSSL_PARAM_BLD_new(); |
3c93fbac | 145 | OSSL_PARAM *params; |
3c93fbac | 146 | |
6d4e6009 P |
147 | if (bld == NULL |
148 | || !OSSL_PARAM_BLD_push_BN(&bld, "p", p) | |
110bff61 P |
149 | || !OSSL_PARAM_BLD_push_BN(&bld, "q", q) |
150 | || !OSSL_PARAM_BLD_push_uint(&bld, "e", e) | |
151 | || !OSSL_PARAM_BLD_push_BN(&bld, "n", n) | |
152 | || !OSSL_PARAM_BLD_push_BN(&bld, "d", d) | |
153 | || (params = OSSL_PARAM_BLD_to_param(&bld)) == NULL) | |
3c93fbac | 154 | goto err; |
be19d3ca | 155 | OSSL_PARAM_BLD_free(bld); |
3c93fbac P |
156 | /* Use params */ |
157 | ... | |
be19d3ca | 158 | OSSL_PARAM_BLD_free_params(params); |
3c93fbac P |
159 | |
160 | =head2 Example 2 | |
161 | ||
162 | This example shows how to create an OSSL_PARAM array that contains an RSA | |
163 | public key. | |
164 | ||
6d4e6009 | 165 | OSSL_PARAM_BLD *bld = OSSL_PARAM_BLD_new(); |
3c93fbac | 166 | OSSL_PARAM *params; |
3c93fbac | 167 | |
6d4e6009 P |
168 | if (nld == NULL |
169 | || !OSSL_PARAM_BLD_push_BN(bld, "n", n) | |
170 | || !OSSL_PARAM_BLD_push_BN(bld, "d", d) | |
171 | || (params = OSSL_PARAM_BLD_to_param(bld)) == NULL) | |
3c93fbac | 172 | goto err; |
be19d3ca | 173 | OSSL_PARAM_BLD_free(bld); |
3c93fbac P |
174 | /* Use params */ |
175 | ... | |
be19d3ca | 176 | OSSL_PARAM_BLD_free_params(params); |
3c93fbac P |
177 | |
178 | =head1 SEE ALSO | |
179 | ||
6e4618a0 | 180 | L<OSSL_PARAM_int(3)>, L<OSSL_PARAM(3)> |
3c93fbac P |
181 | |
182 | =head1 HISTORY | |
183 | ||
184 | The functions described here were all added in OpenSSL 3.0. | |
185 | ||
186 | =head1 COPYRIGHT | |
187 | ||
4333b89f | 188 | Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. |
3c93fbac P |
189 | |
190 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
191 | this file except in compliance with the License. You can obtain a copy | |
192 | in the file LICENSE in the source distribution or at | |
193 | L<https://www.openssl.org/source/license.html>. | |
194 | ||
195 | =cut |