libcrypto/man/OCSP_cert_to_id.3

 $NetBSD: OCSP_cert_to_id.3,v 1.5 2026/04/08 17:06:45 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)

 Standard preamble:
 ========================================================================
..
..

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF

 Required to disable full justification in groff 1.23.0.
 ========================================================================

 Title "OCSP_cert_to_id 3"  OCSP_cert_to_id 3 2026-04-07 3.5.6 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh
 NAME
OCSP_cert_to_id, OCSP_cert_id_new, OCSP_CERTID_free, OCSP_id_issuer_cmp,
OCSP_id_cmp, OCSP_id_get0_info - OCSP certificate ID utility functions
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/ocsp.h>
\&
 OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst,
  X509 *subject, X509 *issuer);
\&
 OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
  X509_NAME *issuerName,
  ASN1_BIT_STRING *issuerKey,
  ASN1_INTEGER *serialNumber);
\&
 void OCSP_CERTID_free(OCSP_CERTID *id);
\&
 int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
 int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
\&
 int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
  ASN1_OCTET_STRING **pikeyHash,
  ASN1_INTEGER **pserial, OCSP_CERTID *cid);
.Ve
 DESCRIPTION
 Header "DESCRIPTION" \fBOCSP_cert_to_id() creates and returns a new OCSP_CERTID structure using
message digest dgst for certificate subject with issuer issuer. If
\fBdgst is NULL then SHA1 is used.

\fBOCSP_cert_id_new() creates and returns a new OCSP_CERTID using dgst and
issuer name issuerName, issuer key hash issuerKey and serial number
\fBserialNumber.

\fBOCSP_CERTID_free() frees up id.
If the argument is NULL, nothing is done.

\fBOCSP_id_cmp() compares OCSP_CERTID a and b.

\fBOCSP_id_issuer_cmp() compares only the issuer name of OCSP_CERTID a and b.

\fBOCSP_id_get0_info() returns the issuer name hash, hash OID, issuer key hash and
serial number contained in cid. If any of the values are not required the
corresponding parameter can be set to NULL.
 "RETURN VALUES"
 Header "RETURN VALUES" \fBOCSP_cert_to_id() and OCSP_cert_id_new() return either a pointer to a valid
\fBOCSP_CERTID structure or NULL if an error occurred.

\fBOCSP_id_cmp() and OCSP_id_issuer_cmp() returns zero for a match and nonzero
otherwise.

\fBOCSP_CERTID_free() does not return a value.

\fBOCSP_id_get0_info() returns 1 for success and 0 for failure.
 NOTES
 Header "NOTES" OCSP clients will typically only use OCSP_cert_to_id() or OCSP_cert_id_new():
the other functions are used by responder applications.

The values returned by OCSP_id_get0_info() are internal pointers and MUST
NOT be freed up by an application: they will be freed when the corresponding
\fBOCSP_CERTID structure is freed.
 "SEE ALSO"
 Header "SEE ALSO" \fBcrypto\|(7),
\fBOCSP_request_add1_nonce\|(3),
\fBOCSP_REQUEST_new\|(3),
\fBOCSP_resp_find_status\|(3),
\fBOCSP_response_status\|(3),
\fBOCSP_sendreq_new\|(3)
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2015-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.