summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/OCSP_cert_to_id.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/OCSP_cert_to_id.3')
-rw-r--r--src/lib/libcrypto/man/OCSP_cert_to_id.3239
1 files changed, 0 insertions, 239 deletions
diff --git a/src/lib/libcrypto/man/OCSP_cert_to_id.3 b/src/lib/libcrypto/man/OCSP_cert_to_id.3
deleted file mode 100644
index e014a1d262..0000000000
--- a/src/lib/libcrypto/man/OCSP_cert_to_id.3
+++ /dev/null
@@ -1,239 +0,0 @@
1.\" $OpenBSD: OCSP_cert_to_id.3,v 1.13 2024/08/24 19:31:09 tb Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3.\"
4.\" This file is a derived work.
5.\" The changes are covered by the following Copyright and license:
6.\"
7.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
8.\"
9.\" Permission to use, copy, modify, and distribute this software for any
10.\" purpose with or without fee is hereby granted, provided that the above
11.\" copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20.\"
21.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>.
22.\" Copyright (c) 2014, 2016 The OpenSSL Project. All rights reserved.
23.\"
24.\" Redistribution and use in source and binary forms, with or without
25.\" modification, are permitted provided that the following conditions
26.\" are met:
27.\"
28.\" 1. Redistributions of source code must retain the above copyright
29.\" notice, this list of conditions and the following disclaimer.
30.\"
31.\" 2. Redistributions in binary form must reproduce the above copyright
32.\" notice, this list of conditions and the following disclaimer in
33.\" the documentation and/or other materials provided with the
34.\" distribution.
35.\"
36.\" 3. All advertising materials mentioning features or use of this
37.\" software must display the following acknowledgment:
38.\" "This product includes software developed by the OpenSSL Project
39.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
40.\"
41.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
42.\" endorse or promote products derived from this software without
43.\" prior written permission. For written permission, please contact
44.\" openssl-core@openssl.org.
45.\"
46.\" 5. Products derived from this software may not be called "OpenSSL"
47.\" nor may "OpenSSL" appear in their names without prior written
48.\" permission of the OpenSSL Project.
49.\"
50.\" 6. Redistributions of any form whatsoever must retain the following
51.\" acknowledgment:
52.\" "This product includes software developed by the OpenSSL Project
53.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
54.\"
55.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
56.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
58.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
59.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
60.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
61.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
62.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
64.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
66.\" OF THE POSSIBILITY OF SUCH DAMAGE.
67.\"
68.Dd $Mdocdate: August 24 2024 $
69.Dt OCSP_CERT_TO_ID 3
70.Os
71.Sh NAME
72.Nm OCSP_CERTID_new ,
73.Nm OCSP_CERTID_free ,
74.Nm OCSP_cert_to_id ,
75.Nm OCSP_cert_id_new ,
76.Nm OCSP_id_issuer_cmp ,
77.Nm OCSP_id_cmp ,
78.Nm OCSP_id_get0_info
79.Nd OCSP certificate ID utility functions
80.Sh SYNOPSIS
81.In openssl/ocsp.h
82.Ft OCSP_CERTID *
83.Fn OCSP_CERTID_new void
84.Ft void
85.Fn OCSP_CERTID_free "OCSP_CERTID *id"
86.Ft OCSP_CERTID *
87.Fo OCSP_cert_to_id
88.Fa "const EVP_MD *dgst"
89.Fa "const X509 *subject"
90.Fa "const X509 *issuer"
91.Fc
92.Ft OCSP_CERTID *
93.Fo OCSP_cert_id_new
94.Fa "const EVP_MD *dgst"
95.Fa "const X509_NAME *issuerName"
96.Fa "const ASN1_BIT_STRING *issuerKey"
97.Fa "const ASN1_INTEGER *serialNumber"
98.Fc
99.Ft int
100.Fo OCSP_id_issuer_cmp
101.Fa "OCSP_CERTID *a"
102.Fa "OCSP_CERTID *b"
103.Fc
104.Ft int
105.Fo OCSP_id_cmp
106.Fa "OCSP_CERTID *a"
107.Fa "OCSP_CERTID *b"
108.Fc
109.Ft int
110.Fo OCSP_id_get0_info
111.Fa "ASN1_OCTET_STRING **piNameHash"
112.Fa "ASN1_OBJECT **pmd"
113.Fa "ASN1_OCTET_STRING **pikeyHash"
114.Fa "ASN1_INTEGER **pserial"
115.Fa "OCSP_CERTID *cid"
116.Fc
117.Sh DESCRIPTION
118.Fn OCSP_CERTID_new
119allocates and initializes an empty
120.Vt OCSP_CERTID
121object, representing an ASN.1
122.Vt CertID
123structure defined in RFC 6960.
124It can store hashes of an issuer's distinguished name and public
125key together with a serial number of a certificate.
126It is used by the
127.Vt OCSP_ONEREQ
128object described in
129.Xr OCSP_ONEREQ_new 3
130and by the
131.Vt OCSP_SINGLERESP
132object described in
133.Xr OCSP_SINGLERESP_new 3 .
134.Fn OCSP_CERTID_free
135frees
136.Fa id .
137.Pp
138.Fn OCSP_cert_to_id
139creates and returns a new
140.Vt OCSP_CERTID
141object using message digest
142.Fa dgst
143for certificate
144.Fa subject
145with issuer
146.Fa issuer .
147If
148.Fa dgst
149is
150.Dv NULL
151then SHA1 is used.
152.Pp
153.Fn OCSP_cert_id_new
154creates and returns a new
155.Vt OCSP_CERTID
156using
157.Fa dgst
158and issuer name
159.Fa issuerName ,
160issuer key hash
161.Fa issuerKey
162and serial number
163.Fa serialNumber .
164.Pp
165.Fn OCSP_id_issuer_cmp
166compares the hash algorithms,
167the hashed issuer distinguished names and
168the hashed public keys of
169.Vt OCSP_CERTID
170.Fa a
171and
172.Fa b .
173.Pp
174.Fn OCSP_id_cmp
175compares
176.Vt OCSP_CERTID
177.Fa a
178and
179.Fa b
180using
181.Fn OCSP_id_issuer_cmp
182followed by a comparison of the certificate serial numbers with
183.Xr ASN1_INTEGER_cmp 3 .
184.Pp
185.Fn OCSP_id_get0_info
186returns the issuer name hash, hash OID, issuer key hash and serial
187number contained in
188.Fa cid .
189If any of the values are not required, the corresponding parameter can be
190set to
191.Dv NULL .
192The values returned by
193.Fn OCSP_id_get0_info
194are internal pointers and must not be freed up by an application:
195they will be freed when the corresponding
196.Vt OCSP_CERTID
197object is freed.
198.Pp
199OCSP clients will typically only use
200.Fn OCSP_cert_to_id
201or
202.Fn OCSP_cert_id_new :
203the other functions are used by responder applications.
204.Sh RETURN VALUES
205.Fn OCSP_CERTID_new ,
206.Fn OCSP_cert_to_id ,
207and
208.Fn OCSP_cert_id_new
209return either a pointer to a valid
210.Vt OCSP_CERTID
211object or
212.Dv NULL
213if an error occurred.
214.Pp
215.Fn OCSP_id_cmp
216and
217.Fn OCSP_id_issuer_cmp
218return 0 for a match or non-zero otherwise.
219.Pp
220.Fn OCSP_id_get0_info
221returns 1 for success or 0 for failure.
222.Sh SEE ALSO
223.Xr ASN1_INTEGER_cmp 3 ,
224.Xr EVP_DigestInit 3 ,
225.Xr OCSP_request_add1_nonce 3 ,
226.Xr OCSP_REQUEST_new 3 ,
227.Xr OCSP_resp_find_status 3 ,
228.Xr OCSP_response_status 3 ,
229.Xr OCSP_sendreq_new 3 ,
230.Xr X509_get_issuer_name 3 ,
231.Xr X509_NAME_new 3 ,
232.Xr X509_ocspid_print 3
233.Sh STANDARDS
234RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate
235Status Protocol, section 4: Details of the Protocol
236.Sh HISTORY
237These functions first appeared in OpenSSL 0.9.7
238and have been available since
239.Ox 3.2 .