diff options
Diffstat (limited to 'src/lib/libcrypto/man')
| -rw-r--r-- | src/lib/libcrypto/man/OBJ_find_sigid_algs.3 | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/OBJ_find_sigid_algs.3 b/src/lib/libcrypto/man/OBJ_find_sigid_algs.3 new file mode 100644 index 0000000000..9aeb54c90b --- /dev/null +++ b/src/lib/libcrypto/man/OBJ_find_sigid_algs.3 | |||
| @@ -0,0 +1,90 @@ | |||
| 1 | .\" $OpenBSD: OBJ_find_sigid_algs.3,v 1.1 2023/07/22 06:35:26 tb Exp $ | ||
| 2 | .\" | ||
| 3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> | ||
| 4 | .\" | ||
| 5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 7 | .\" copyright notice and this permission notice appear in all copies. | ||
| 8 | .\" | ||
| 9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 16 | .\" | ||
| 17 | .Dd $Mdocdate: July 22 2023 $ | ||
| 18 | .Dt OBJ_FIND_SIGID_ALGS 3 | ||
| 19 | .Os | ||
| 20 | .Sh NAME | ||
| 21 | .Nm OBJ_find_sigid_algs , | ||
| 22 | .Nm OBJ_find_sigid_by_algs | ||
| 23 | .Nd signature algorithm mappings | ||
| 24 | .Sh SYNOPSIS | ||
| 25 | .In openssl/objects.h | ||
| 26 | .Ft int | ||
| 27 | .Fo OBJ_find_sigid_algs | ||
| 28 | .Fa "int signature" | ||
| 29 | .Fa "int *pdigest" | ||
| 30 | .Fa "int *pencryption" | ||
| 31 | .Fc | ||
| 32 | .Ft int | ||
| 33 | .Fo OBJ_find_sigid_by_algs | ||
| 34 | .Fa "int *psignature" | ||
| 35 | .Fa "int digest" | ||
| 36 | .Fa "int encryption" | ||
| 37 | .Fc | ||
| 38 | .Sh DESCRIPTION | ||
| 39 | .Fn OBJ_find_sigid_algs | ||
| 40 | looks up the | ||
| 41 | .Fa signature | ||
| 42 | algorithm. | ||
| 43 | If it is found, the associated digest algorithm is stored in | ||
| 44 | .Pf * Fa pdigest | ||
| 45 | unless | ||
| 46 | .Fa pdigest | ||
| 47 | is a | ||
| 48 | .Dv NULL | ||
| 49 | pointer, and the associated encryption algorithm is stored in | ||
| 50 | .Pf * Fa pencryption | ||
| 51 | unless | ||
| 52 | .Fa pencryption | ||
| 53 | is a | ||
| 54 | .Dv NULL | ||
| 55 | pointer. | ||
| 56 | .Pp | ||
| 57 | .Fn OBJ_find_sigid_by_algs | ||
| 58 | looks up the pair | ||
| 59 | .Pq Fa digest , encryption . | ||
| 60 | If it is found, the associated signature algorithm is stored in | ||
| 61 | .Pf * Fa psignature | ||
| 62 | unless | ||
| 63 | .Fa psignature | ||
| 64 | is a | ||
| 65 | .Dv NULL | ||
| 66 | pointer. | ||
| 67 | .Sh RETURN VALUES | ||
| 68 | .Fn OBJ_find_sigid_algs | ||
| 69 | returns 1 if a definition of the | ||
| 70 | .Fa signature | ||
| 71 | algorithm is found or 0 if a definition of the | ||
| 72 | .Fa signature | ||
| 73 | algorithm is not built into the library. | ||
| 74 | .Pp | ||
| 75 | .Fn OBJ_find_sigid_by_algs | ||
| 76 | returns 1 if a signature algorithm using the specified | ||
| 77 | .Fa digest | ||
| 78 | and | ||
| 79 | .Fa encryption | ||
| 80 | algorithms is defined or 0 if the definition of such an algorithm | ||
| 81 | is not built into the library. | ||
| 82 | .Sh SEE ALSO | ||
| 83 | .Xr EVP_cleanup 3 , | ||
| 84 | .Xr OBJ_create 3 , | ||
| 85 | .Xr OBJ_NAME_add 3 , | ||
| 86 | .Xr OBJ_nid2obj 3 | ||
| 87 | .Sh HISTORY | ||
| 88 | These functions first appeared in OpenSSL 1.0.0 | ||
| 89 | and have been available since | ||
| 90 | .Ox 4.9 . | ||