summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorschwarze <>2023-09-05 14:54:21 +0000
committerschwarze <>2023-09-05 14:54:21 +0000
commit19bc61edd255de4fdb63f93e51a2fc4806d43588 (patch)
treecb2e14c06ef0f051c65980ec6826f43bf983e804 /src
parent4c11e38761af7323ecdd8ac0bcc32d49072b2e55 (diff)
downloadopenbsd-19bc61edd255de4fdb63f93e51a2fc4806d43588.tar.gz
openbsd-19bc61edd255de4fdb63f93e51a2fc4806d43588.tar.bz2
openbsd-19bc61edd255de4fdb63f93e51a2fc4806d43588.zip
document EVP_CIPHER_name(3)
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/EVP_CIPHER_nid.334
1 files changed, 32 insertions, 2 deletions
diff --git a/src/lib/libcrypto/man/EVP_CIPHER_nid.3 b/src/lib/libcrypto/man/EVP_CIPHER_nid.3
index 1c0683980b..1feff4f34e 100644
--- a/src/lib/libcrypto/man/EVP_CIPHER_nid.3
+++ b/src/lib/libcrypto/man/EVP_CIPHER_nid.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_CIPHER_nid.3,v 1.2 2023/09/01 17:28:21 schwarze Exp $ 1.\" $OpenBSD: EVP_CIPHER_nid.3,v 1.3 2023/09/05 14:54:21 schwarze Exp $
2.\" full merge up to: OpenSSL man3/EVP_EncryptInit.pod 2.\" full merge up to: OpenSSL man3/EVP_EncryptInit.pod
3.\" 0874d7f2 Oct 11 13:13:47 2022 +0100 3.\" 0874d7f2 Oct 11 13:13:47 2022 +0100
4.\" 4.\"
@@ -66,12 +66,13 @@
66.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 66.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
67.\" OF THE POSSIBILITY OF SUCH DAMAGE. 67.\" OF THE POSSIBILITY OF SUCH DAMAGE.
68.\" 68.\"
69.Dd $Mdocdate: September 1 2023 $ 69.Dd $Mdocdate: September 5 2023 $
70.Dt EVP_CIPHER_NID 3 70.Dt EVP_CIPHER_NID 3
71.Os 71.Os
72.Sh NAME 72.Sh NAME
73.Nm EVP_CIPHER_nid , 73.Nm EVP_CIPHER_nid ,
74.Nm EVP_CIPHER_CTX_nid , 74.Nm EVP_CIPHER_CTX_nid ,
75.Nm EVP_CIPHER_name ,
75.Nm EVP_CIPHER_type , 76.Nm EVP_CIPHER_type ,
76.Nm EVP_CIPHER_CTX_type , 77.Nm EVP_CIPHER_CTX_type ,
77.Nm EVP_CIPHER_block_size , 78.Nm EVP_CIPHER_block_size ,
@@ -91,6 +92,10 @@
91.Fo EVP_CIPHER_CTX_nid 92.Fo EVP_CIPHER_CTX_nid
92.Fa "const EVP_CIPHER_CTX *ctx" 93.Fa "const EVP_CIPHER_CTX *ctx"
93.Fc 94.Fc
95.Ft const char *
96.Fo EVP_CIPHER_name
97.Fa "const EVP_CIPHER *cipher"
98.Fc
94.Ft int 99.Ft int
95.Fo EVP_CIPHER_type 100.Fo EVP_CIPHER_type
96.Fa "const EVP_CIPHER *ctx" 101.Fa "const EVP_CIPHER *ctx"
@@ -137,6 +142,12 @@ returns the NID of the cipher that
137.Fa ctx 142.Fa ctx
138is configured to use. 143is configured to use.
139.Pp 144.Pp
145.Fn EVP_CIPHER_name
146converts the NID of the
147.Fa cipher
148to its short name with
149.Xr OBJ_nid2sn 3 .
150.Pp
140.Fn EVP_CIPHER_type 151.Fn EVP_CIPHER_type
141returns the NID associated with the ASN.1 OBJECT IDENTIFIER of the 152returns the NID associated with the ASN.1 OBJECT IDENTIFIER of the
142.Fa cipher , 153.Fa cipher ,
@@ -196,12 +207,27 @@ and the return value of
196returns the cipher mode of the cipher that 207returns the cipher mode of the cipher that
197.Fa ctx 208.Fa ctx
198is configured to use. 209is configured to use.
210.Pp
211.Fn EVP_CIPHER_name ,
212.Fn EVP_CIPHER_CTX_type ,
213.Fn EVP_CIPHER_mode ,
214and
215.Fn EVP_CIPHER_CTX_mode
216are implemented as macros.
199.Sh RETURN VALUES 217.Sh RETURN VALUES
200.Fn EVP_CIPHER_nid 218.Fn EVP_CIPHER_nid
201and 219and
202.Fn EVP_CIPHER_CTX_nid 220.Fn EVP_CIPHER_CTX_nid
203return an NID. 221return an NID.
204.Pp 222.Pp
223.Fn EVP_CIPHER_name
224returns a pointer to a string that is owned by an internal library object or
225.Dv NULL
226if the NID is neither built into the library nor added to the global
227object table by one of the functions documented in the manual page
228.Xr OBJ_create 3 ,
229of if the object does not contain a short name.
230.Pp
205.Fn EVP_CIPHER_type 231.Fn EVP_CIPHER_type
206and 232and
207.Fn EVP_CIPHER_CTX_type 233.Fn EVP_CIPHER_CTX_type
@@ -264,6 +290,10 @@ and
264.Fn EVP_CIPHER_CTX_mode 290.Fn EVP_CIPHER_CTX_mode
265first appeared in OpenSSL 0.9.6 and have been available since 291first appeared in OpenSSL 0.9.6 and have been available since
266.Ox 2.9 . 292.Ox 2.9 .
293.Pp
294.Fn EVP_CIPHER_name
295first appeared in OpenSSL 0.9.7 and has been available since
296.Ox 3.2 .
267.Sh CAVEATS 297.Sh CAVEATS
268The behaviour of the functions taking an 298The behaviour of the functions taking an
269.Vt EVP_CIPHER_CTX 299.Vt EVP_CIPHER_CTX