summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EVP_PKEY_add1_attr.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/EVP_PKEY_add1_attr.3')
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_add1_attr.3188
1 files changed, 0 insertions, 188 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_add1_attr.3 b/src/lib/libcrypto/man/EVP_PKEY_add1_attr.3
deleted file mode 100644
index ae910b167a..0000000000
--- a/src/lib/libcrypto/man/EVP_PKEY_add1_attr.3
+++ /dev/null
@@ -1,188 +0,0 @@
1.\" $OpenBSD: EVP_PKEY_add1_attr.3,v 1.3 2021/10/26 18:50:38 jmc 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: October 26 2021 $
18.Dt EVP_PKEY_ADD1_ATTR 3
19.Os
20.Sh NAME
21.Nm EVP_PKEY_add1_attr ,
22.Nm EVP_PKEY_add1_attr_by_OBJ ,
23.Nm EVP_PKEY_add1_attr_by_NID ,
24.Nm EVP_PKEY_add1_attr_by_txt ,
25.Nm EVP_PKEY_delete_attr ,
26.Nm EVP_PKEY_get_attr ,
27.Nm EVP_PKEY_get_attr_count ,
28.Nm EVP_PKEY_get_attr_by_OBJ ,
29.Nm EVP_PKEY_get_attr_by_NID
30.Nd X.501 Attributes of private keys
31.Sh SYNOPSIS
32.In openssl/x509.h
33.Ft int
34.Fo EVP_PKEY_add1_attr
35.Fa "EVP_PKEY *key"
36.Fa "X509_ATTRIBUTE *attr"
37.Fc
38.Ft int
39.Fo EVP_PKEY_add1_attr_by_OBJ
40.Fa "EVP_PKEY *key"
41.Fa "const ASN1_OBJECT *obj"
42.Fa "int type"
43.Fa "const unsigned char *data"
44.Fa "int len"
45.Fc
46.Ft int
47.Fo EVP_PKEY_add1_attr_by_NID
48.Fa "EVP_PKEY *key"
49.Fa "int nid"
50.Fa "int type"
51.Fa "const unsigned char *data"
52.Fa "int len"
53.Fc
54.Ft int
55.Fo EVP_PKEY_add1_attr_by_txt
56.Fa "EVP_PKEY *key"
57.Fa "const char *name"
58.Fa "int type"
59.Fa "const unsigned char *data"
60.Fa "int len"
61.Fc
62.Ft X509_ATTRIBUTE *
63.Fo EVP_PKEY_delete_attr
64.Fa "EVP_PKEY *key"
65.Fa "int index"
66.Fc
67.Ft X509_ATTRIBUTE *
68.Fo EVP_PKEY_get_attr
69.Fa "const EVP_PKEY *key"
70.Fa "int index"
71.Fc
72.Ft int
73.Fo EVP_PKEY_get_attr_count
74.Fa "const EVP_PKEY *key"
75.Fc
76.Ft int
77.Fo EVP_PKEY_get_attr_by_OBJ
78.Fa "const EVP_PKEY *key"
79.Fa "const ASN1_OBJECT *obj"
80.Fa "int start_after"
81.Fc
82.Ft int
83.Fo EVP_PKEY_get_attr_by_NID
84.Fa "const EVP_PKEY *key"
85.Fa "int nid"
86.Fa "int start_after"
87.Fc
88.Sh DESCRIPTION
89These functions support associating an array of X.501 Attributes
90with a private key.
91Such attributes can for example be included in PKCS#12 structures.
92.Pp
93.Fn EVP_PKEY_add1_attr
94appends a deep copy of the
95.Fa attr
96using
97.Xr X509at_add1_attr 3 .
98.Pp
99.Fn EVP_PKEY_add1_attr_by_OBJ ,
100.Fn EVP_PKEY_add1_attr_by_NID ,
101and
102.Fn EVP_PKEY_add1_attr_by_txt
103create a new X.501 Attribute object using
104.Xr X509_ATTRIBUTE_create_by_OBJ 3 ,
105.Xr X509_ATTRIBUTE_create_by_NID 3 ,
106or
107.Xr X509_ATTRIBUTE_create_by_txt 3 ,
108respectively, and append it using
109.Xr X509at_add1_attr 3 .
110.Pp
111.Fn EVP_PKEY_delete_attr
112deletes the attribute with the zero-based
113.Fa index
114using
115.Xr X509at_delete_attr 3 .
116.Pp
117.Fn EVP_PKEY_get_attr
118returns the attribute with the zero-based
119.Fa index
120using
121.Xr X509at_get_attr 3 .
122.Pp
123.Fn EVP_PKEY_get_attr_count
124returns the number of attributes currently associated with the
125.Fa key
126using
127.Xr X509at_get_attr_count 3 .
128.Pp
129.Fn EVP_PKEY_get_attr_by_OBJ
130and
131.Fn EVP_PKEY_get_attr_by_NID
132search for an attribute of the type
133.Fa obj
134or
135.Fa nid
136using
137.Xr X509at_get_attr_by_OBJ 3
138or
139.Xr X509at_get_attr_by_NID 3 ,
140respectively.
141.Sh RETURN VALUES
142.Fn EVP_PKEY_add1_attr ,
143.Fn EVP_PKEY_add1_attr_by_OBJ ,
144.Fn EVP_PKEY_add1_attr_by_NID ,
145and
146.Fn EVP_PKEY_add1_attr_by_txt
147return 1 for success or 0 for failure.
148.Pp
149.Fn EVP_PKEY_delete_attr
150and
151.Fn EVP_PKEY_get_attr
152return the deleted or requested attribute or
153.Dv NULL
154if the requested index is negative or greater than or equal to
155the current number of attributes associated with the
156.Fa key .
157.Pp
158.Fn EVP_PKEY_get_attr_count
159returns the current number of attributes.
160.Pp
161.Fn EVP_PKEY_get_attr_by_OBJ
162and
163.Fn EVP_PKEY_get_attr_by_NID
164return the index of the first attribute that has an index greater than
165.Fa start_after
166and a type matching
167.Fa obj
168or
169.Fa nid ,
170respectively, or \-1 on failure.
171In addition,
172.Fn EVP_PKEY_get_attr_by_NID
173returns \-2 if
174.Xr OBJ_nid2obj 3
175fails on the requested
176.Fa nid .
177.Sh SEE ALSO
178.Xr EVP_PKEY_new 3 ,
179.Xr OBJ_nid2obj 3 ,
180.Xr PKCS12_create 3 ,
181.Xr X509_ATTRIBUTE_create_by_OBJ 3 ,
182.Xr X509_ATTRIBUTE_new 3 ,
183.Xr X509at_add1_attr 3 ,
184.Xr X509at_get_attr 3
185.Sh HISTORY
186These functions first appeared in OpenSSL 0.9.8
187and have been available since
188.Ox 4.5 .
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-12-09 15:08:47 +0000