libcrypto/man/OCSP_cert_to_id.3

 $NetBSD: OCSP_cert_to_id.3,v 1.1.1.1 2023/04/18 14:19:14 christos Exp $

 Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

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

..
 Set up some character translations and predefined strings. \*(-- will
 give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 double quote, and \*(R" will give a right double quote. \*(C+ will
 give a nicer C++. Capital omega is used to do unbreakable dashes and
 therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
 nothing in troff, for use with C<>.
.tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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

 Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
 ========================================================================

 Title "OCSP_cert_to_id 3"  OCSP_cert_to_id 3 "2020-12-10" "1.1.1i" "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
 "LIBRARY"
libcrypto, -lcrypto
 "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 \s-1OCSP_CERTID\s0 structure using
message digest dgst for certificate subject with issuer issuer. If
\fBdgst is \s-1NULL\s0 then \s-1SHA1\s0 is used.

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

\fBOCSP_CERTID_free() frees up id.

\fBOCSP_id_cmp() compares \s-1OCSP_CERTID\s0 a and b.

\fBOCSP_id_issuer_cmp() compares only the issuer name of \s-1OCSP_CERTID\s0 a and b.

\fBOCSP_id_get0_info() returns the issuer name hash, hash \s-1OID,\s0 issuer key hash and
serial number contained in cid. If any of the values are not required the
corresponding parameter can be set to \s-1NULL\s0.
 "RETURN VALUES"
 Header "RETURN VALUES" \fBOCSP_cert_to_id() and OCSP_cert_id_new() return either a pointer to a valid
\fB\s-1OCSP_CERTID\s0 structure or \s-1NULL\s0 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" \s-1OCSP\s0 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 \s-1MUST
NOT\s0 be freed up by an application: they will be freed when the corresponding
\fB\s-1OCSP_CERTID\s0 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-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.