diff options
author | tb <> | 2023-08-25 10:54:44 +0000 |
---|---|---|
committer | tb <> | 2023-08-25 10:54:44 +0000 |
commit | 16ba7aada65a53c0e44ca38eafecb306bc85c74c (patch) | |
tree | 39da09857c558f3d64c607ac924a4e36b8fc43a8 /src/lib | |
parent | dd18094a872b6a9c45bf5e604985a955f279bf6b (diff) | |
download | openbsd-16ba7aada65a53c0e44ca38eafecb306bc85c74c.tar.gz openbsd-16ba7aada65a53c0e44ca38eafecb306bc85c74c.tar.bz2 openbsd-16ba7aada65a53c0e44ca38eafecb306bc85c74c.zip |
Improve EVP_add_cipher.3 a bit
Fix some copy-paste errors in the prototypes, tweak the explanatory text
and add some more details.
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/libcrypto/man/EVP_add_cipher.3 | 35 |
1 files changed, 26 insertions, 9 deletions
diff --git a/src/lib/libcrypto/man/EVP_add_cipher.3 b/src/lib/libcrypto/man/EVP_add_cipher.3 index 0c71295efe..57e4f839c2 100644 --- a/src/lib/libcrypto/man/EVP_add_cipher.3 +++ b/src/lib/libcrypto/man/EVP_add_cipher.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: EVP_add_cipher.3,v 1.2 2023/08/25 05:38:52 tb Exp $ | 1 | .\" $OpenBSD: EVP_add_cipher.3,v 1.3 2023/08/25 10:54:44 tb Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 2023 Theo Buehler <tb@openbsd.org> | 3 | .\" Copyright (c) 2023 Theo Buehler <tb@openbsd.org> |
4 | .\" | 4 | .\" |
@@ -38,7 +38,6 @@ | |||
38 | .Fc | 38 | .Fc |
39 | .Ft int | 39 | .Ft int |
40 | .Fo EVP_remove_cipher_alias | 40 | .Fo EVP_remove_cipher_alias |
41 | .Fa "const char *name" | ||
42 | .Fa "const char *alias" | 41 | .Fa "const char *alias" |
43 | .Fc | 42 | .Fc |
44 | .Ft int | 43 | .Ft int |
@@ -52,7 +51,6 @@ | |||
52 | .Fc | 51 | .Fc |
53 | .Ft int | 52 | .Ft int |
54 | .Fo EVP_remove_digest_alias | 53 | .Fo EVP_remove_digest_alias |
55 | .Fa "const char *name" | ||
56 | .Fa "const char *alias" | 54 | .Fa "const char *alias" |
57 | .Fc | 55 | .Fc |
58 | .Sh DESCRIPTION | 56 | .Sh DESCRIPTION |
@@ -86,7 +84,16 @@ add and remove the | |||
86 | .Fa alias | 84 | .Fa alias |
87 | for the cipher | 85 | for the cipher |
88 | .Fa name . | 86 | .Fa name . |
89 | They are implemented as macros. | 87 | They are implemented as macros wrapping |
88 | .Xr OBJ_NAME_add 3 | ||
89 | and | ||
90 | .Xr OBJ_NAME_remove 3 | ||
91 | with | ||
92 | .Fa type | ||
93 | set to the bitwise or of | ||
94 | .Dv OBJ_NAME_TYPE_CIPHER_METH | ||
95 | and | ||
96 | .Dv OBJ_NAME_ALIAS . | ||
90 | .Pp | 97 | .Pp |
91 | .Fn EVP_add_digest | 98 | .Fn EVP_add_digest |
92 | adds | 99 | adds |
@@ -105,11 +112,11 @@ If the | |||
105 | has an associated public key signing algorithm (see | 112 | has an associated public key signing algorithm (see |
106 | .Xr EVP_MD_pkey_type 3 ) | 113 | .Xr EVP_MD_pkey_type 3 ) |
107 | distinct from the | 114 | distinct from the |
108 | .Fa md Ns 's | 115 | .Fa md , |
109 | NID, the signing algorithm's short and long names are added as aliases for | 116 | the signing algorithm's short and long names are added as aliases for |
110 | the short name of | 117 | the short name of |
111 | .Fa md . | 118 | .Fa md . |
112 | It is the caller's responsibility to ensure that the long | 119 | It is the caller's responsibility to ensure that all long |
113 | and short names are not | 120 | and short names are not |
114 | .Dv NULL . | 121 | .Dv NULL . |
115 | Internally, the lookup table is the global associative array and | 122 | Internally, the lookup table is the global associative array and |
@@ -129,7 +136,16 @@ add and remove the | |||
129 | .Fa alias | 136 | .Fa alias |
130 | for the digest | 137 | for the digest |
131 | .Fa name . | 138 | .Fa name . |
132 | They are implemented as macros. | 139 | They are implemented as macros wrapping |
140 | .Xr OBJ_NAME_add 3 | ||
141 | and | ||
142 | .Xr OBJ_NAME_remove 3 | ||
143 | with | ||
144 | .Fa type | ||
145 | set to the bitwise or of | ||
146 | .Dv OBJ_NAME_TYPE_MD_METH | ||
147 | and | ||
148 | .Dv OBJ_NAME_ALIAS . | ||
133 | .Sh RETURN VALUES | 149 | .Sh RETURN VALUES |
134 | These functions return 1 on success and 0 on failure. | 150 | These functions return 1 on success and 0 on failure. |
135 | .Sh SEE ALSO | 151 | .Sh SEE ALSO |
@@ -157,4 +173,5 @@ first appeared in OpenSSL 0.9.4 and have been available since | |||
157 | .Ox 2.6 . | 173 | .Ox 2.6 . |
158 | .Sh BUGS | 174 | .Sh BUGS |
159 | Key-value pairs already added before an error occurred | 175 | Key-value pairs already added before an error occurred |
160 | remain in the global associative array. | 176 | remain in the global associative array, |
177 | leaving it in an unknown state. | ||