diff options
| author | cvs2svn <admin@example.com> | 2021-08-18 16:06:57 +0000 |
|---|---|---|
| committer | cvs2svn <admin@example.com> | 2021-08-18 16:06:57 +0000 |
| commit | d56c8fa8260d226f98b26f017b45b9c2b135f38d (patch) | |
| tree | 348178b41617813cc93787187984a734ef8379ca /src/lib/libcrypto/man/ENGINE_set_default.3 | |
| parent | 18b9c1bcab7c37d8c5bd05b8e0d14d0c59d96650 (diff) | |
| download | openbsd-tb_20210818.tar.gz openbsd-tb_20210818.tar.bz2 openbsd-tb_20210818.zip | |
This commit was manufactured by cvs2git to create tag 'tb_20210818'.tb_20210818
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libcrypto/man/ENGINE_set_default.3 | 186 |
1 files changed, 0 insertions, 186 deletions
diff --git a/src/lib/libcrypto/man/ENGINE_set_default.3 b/src/lib/libcrypto/man/ENGINE_set_default.3 deleted file mode 100644 index c2655f2b9b..0000000000 --- a/src/lib/libcrypto/man/ENGINE_set_default.3 +++ /dev/null | |||
| @@ -1,186 +0,0 @@ | |||
| 1 | .\" $OpenBSD: ENGINE_set_default.3,v 1.4 2019/06/03 14:43:15 schwarze Exp $ | ||
| 2 | .\" content checked up to: | ||
| 3 | .\" OpenSSL ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800 | ||
| 4 | .\" | ||
| 5 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | ||
| 6 | .\" | ||
| 7 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 8 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 9 | .\" copyright notice and this permission notice appear in all copies. | ||
| 10 | .\" | ||
| 11 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 12 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 13 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 14 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 15 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 16 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 17 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 18 | .\" | ||
| 19 | .Dd $Mdocdate: June 3 2019 $ | ||
| 20 | .Dt ENGINE 3 | ||
| 21 | .Os | ||
| 22 | .Sh NAME | ||
| 23 | .Nm ENGINE_set_default , | ||
| 24 | .Nm ENGINE_set_default_string , | ||
| 25 | .Nm ENGINE_set_default_RSA , | ||
| 26 | .Nm ENGINE_set_default_DSA , | ||
| 27 | .Nm ENGINE_set_default_ECDH , | ||
| 28 | .Nm ENGINE_set_default_ECDSA , | ||
| 29 | .Nm ENGINE_set_default_DH , | ||
| 30 | .Nm ENGINE_set_default_RAND , | ||
| 31 | .Nm ENGINE_set_default_ciphers , | ||
| 32 | .Nm ENGINE_set_default_digests | ||
| 33 | .Nd register an ENGINE as the default for an algorithm | ||
| 34 | .Sh SYNOPSIS | ||
| 35 | .In openssl/engine.h | ||
| 36 | .Ft int | ||
| 37 | .Fo ENGINE_set_default_RSA | ||
| 38 | .Fa "ENGINE *e" | ||
| 39 | .Fc | ||
| 40 | .Ft int | ||
| 41 | .Fo ENGINE_set_default_DSA | ||
| 42 | .Fa "ENGINE *e" | ||
| 43 | .Fc | ||
| 44 | .Ft int | ||
| 45 | .Fo ENGINE_set_default_ECDH | ||
| 46 | .Fa "ENGINE *e" | ||
| 47 | .Fc | ||
| 48 | .Ft int | ||
| 49 | .Fo ENGINE_set_default_ECDSA | ||
| 50 | .Fa "ENGINE *e" | ||
| 51 | .Fc | ||
| 52 | .Ft int | ||
| 53 | .Fo ENGINE_set_default_DH | ||
| 54 | .Fa "ENGINE *e" | ||
| 55 | .Fc | ||
| 56 | .Ft int | ||
| 57 | .Fo ENGINE_set_default_RAND | ||
| 58 | .Fa "ENGINE *e" | ||
| 59 | .Fc | ||
| 60 | .Ft int | ||
| 61 | .Fo ENGINE_set_default_ciphers | ||
| 62 | .Fa "ENGINE *e" | ||
| 63 | .Fc | ||
| 64 | .Ft int | ||
| 65 | .Fo ENGINE_set_default_digests | ||
| 66 | .Fa "ENGINE *e" | ||
| 67 | .Fc | ||
| 68 | .Ft int | ||
| 69 | .Fo ENGINE_set_default | ||
| 70 | .Fa "ENGINE *e" | ||
| 71 | .Fa "unsigned int flags" | ||
| 72 | .Fc | ||
| 73 | .Ft int | ||
| 74 | .Fo ENGINE_set_default_string | ||
| 75 | .Fa "ENGINE *e" | ||
| 76 | .Fa "const char *list" | ||
| 77 | .Fc | ||
| 78 | .Sh DESCRIPTION | ||
| 79 | These functions register | ||
| 80 | .Fa e | ||
| 81 | as implementing the respective algorithm | ||
| 82 | like the functions described in the | ||
| 83 | .Xr ENGINE_register_RSA 3 | ||
| 84 | manual page do it. | ||
| 85 | In addition, they call | ||
| 86 | .Xr ENGINE_init 3 | ||
| 87 | on | ||
| 88 | .Fa e | ||
| 89 | and select | ||
| 90 | .Fa e | ||
| 91 | as the default implementation of the respective algorithm to be | ||
| 92 | returned by the functions described in | ||
| 93 | .Xr ENGINE_get_default_RSA 3 | ||
| 94 | in the future. | ||
| 95 | If another engine was previously selected | ||
| 96 | as the default implementation of the respective algorithm, | ||
| 97 | .Xr ENGINE_finish 3 | ||
| 98 | is called on that previous engine. | ||
| 99 | .Pp | ||
| 100 | If | ||
| 101 | .Fa e | ||
| 102 | implements more than one cipher or digest, | ||
| 103 | .Fn ENGINE_set_default_ciphers | ||
| 104 | and | ||
| 105 | .Fn ENGINE_set_default_digests | ||
| 106 | register and select it for all these ciphers and digests, respectively. | ||
| 107 | .Pp | ||
| 108 | .Fn ENGINE_set_default | ||
| 109 | registers | ||
| 110 | .Fa e | ||
| 111 | as the default implementation of all algorithms specified by the | ||
| 112 | .Fa flags | ||
| 113 | by calling the appropriate ones among the other functions. | ||
| 114 | Algorithms can be selected by combining any number of the | ||
| 115 | following constants with bitwise OR: | ||
| 116 | .Dv ENGINE_METHOD_ALL , | ||
| 117 | .Dv ENGINE_METHOD_RSA , | ||
| 118 | .Dv ENGINE_METHOD_DSA , | ||
| 119 | .Dv ENGINE_METHOD_ECDH , | ||
| 120 | .Dv ENGINE_METHOD_ECDSA , | ||
| 121 | .Dv ENGINE_METHOD_DH , | ||
| 122 | .Dv ENGINE_METHOD_RAND , | ||
| 123 | .Dv ENGINE_METHOD_CIPHERS , | ||
| 124 | .Dv ENGINE_METHOD_DIGESTS , | ||
| 125 | .Dv ENGINE_METHOD_PKEY_METHS , | ||
| 126 | and | ||
| 127 | .Dv ENGINE_METHOD_PKEY_ASN1_METHS . | ||
| 128 | .Pp | ||
| 129 | .Fn ENGINE_set_default_string | ||
| 130 | is similar except that it selects the algorithms according to the string | ||
| 131 | .Fa def_list , | ||
| 132 | which contains an arbitrary number of comma-separated keywords from | ||
| 133 | the following list: ALL, RSA, DSA, ECDH, ECDSA, DH, RAND, CIPHERS, | ||
| 134 | DIGESTS, PKEY_CRYPTO, PKEY_ASN1, and PKEY. | ||
| 135 | PKEY_CRYPTO corresponds to | ||
| 136 | .Dv ENGINE_METHOD_PKEY_METHS , | ||
| 137 | PKEY_ASN1 to | ||
| 138 | .Dv ENGINE_METHOD_PKEY_ASN1_METHS , | ||
| 139 | and PKEY selects both. | ||
| 140 | .Sh RETURN VALUES | ||
| 141 | These functions return 1 on success or 0 on error. | ||
| 142 | They fail if | ||
| 143 | .Xr ENGINE_init 3 | ||
| 144 | fails or if insufficient memory is available. | ||
| 145 | .Sh SEE ALSO | ||
| 146 | .Xr ENGINE_get_default_RSA 3 , | ||
| 147 | .Xr ENGINE_init 3 , | ||
| 148 | .Xr ENGINE_new 3 , | ||
| 149 | .Xr ENGINE_register_RSA 3 , | ||
| 150 | .Xr ENGINE_set_RSA 3 , | ||
| 151 | .Xr ENGINE_unregister_RSA 3 | ||
| 152 | .Sh HISTORY | ||
| 153 | .Fn ENGINE_set_default , | ||
| 154 | .Fn ENGINE_set_default_RSA , | ||
| 155 | .Fn ENGINE_set_default_DSA , | ||
| 156 | .Fn ENGINE_set_default_DH , | ||
| 157 | and | ||
| 158 | .Fn ENGINE_set_default_RAND | ||
| 159 | first appeared in OpenSSL 0.9.7 and have been available since | ||
| 160 | .Ox 2.9 . | ||
| 161 | .Pp | ||
| 162 | .Fn ENGINE_set_default_string , | ||
| 163 | .Fn ENGINE_set_default_ciphers , | ||
| 164 | and | ||
| 165 | .Fn ENGINE_set_default_digests | ||
| 166 | first appeared in OpenSSL 0.9.7 and have been available since | ||
| 167 | .Ox 3.2 . | ||
| 168 | .Pp | ||
| 169 | .Fn ENGINE_set_default_ECDH | ||
| 170 | and | ||
| 171 | .Fn ENGINE_set_default_ECDSA | ||
| 172 | first appeared in OpenSSL 0.9.8 and have been available since | ||
| 173 | .Ox 4.5 . | ||
| 174 | .Sh CAVEATS | ||
| 175 | Failure of | ||
| 176 | .Xr ENGINE_finish 3 | ||
| 177 | is ignored. | ||
| 178 | .Sh BUGS | ||
| 179 | Even when | ||
| 180 | .Fn ENGINE_set_default | ||
| 181 | or | ||
| 182 | .Fn ENGINE_set_default_string | ||
| 183 | fail, they typically still register | ||
| 184 | .Fa e | ||
| 185 | for some algorithms, but usually not for all it could be registered | ||
| 186 | for by calling the individual functions. | ||
