| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "X509_ACERT_GET0_HOLDER_BASECERTID 3SSL" |
| 58 |
.TH X509_ACERT_GET0_HOLDER_BASECERTID 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
X509_ACERT_get0_holder_baseCertId, |
| 65 |
X509_ACERT_get0_holder_digest, |
| 66 |
X509_ACERT_get0_holder_entityName, |
| 67 |
X509_ACERT_set0_holder_baseCertId, |
| 68 |
X509_ACERT_set0_holder_digest, |
| 69 |
X509_ACERT_set0_holder_entityName, |
| 70 |
OSSL_ISSUER_SERIAL_get0_issuer, |
| 71 |
OSSL_ISSUER_SERIAL_get0_issuerUID, |
| 72 |
OSSL_ISSUER_SERIAL_get0_serial, |
| 73 |
OSSL_ISSUER_SERIAL_set1_issuer, |
| 74 |
OSSL_ISSUER_SERIAL_set1_issuerUID, |
| 75 |
OSSL_ISSUER_SERIAL_set1_serial, |
| 76 |
OSSL_OBJECT_DIGEST_INFO_get0_digest, |
| 77 |
OSSL_OBJECT_DIGEST_INFO_set1_digest \- get and set Attribute Certificate holder fields |
| 78 |
.SH SYNOPSIS |
| 79 |
.IX Header "SYNOPSIS" |
| 80 |
.Vb 1 |
| 81 |
\& #include <openssl/x509_acert.h> |
| 82 |
\& |
| 83 |
\& const GENERAL_NAMES *X509_ACERT_get0_holder_entityName(const X509_ACERT *x); |
| 84 |
\& OSSL_ISSUER_SERIAL *X509_ACERT_get0_holder_baseCertId(const X509_ACERT *x); |
| 85 |
\& OSSL_OBJECT_DIGEST_INFO * X509_ACERT_get0_holder_digest(const X509_ACERT *x); |
| 86 |
\& void X509_ACERT_set0_holder_entityName(X509_ACERT *x, GENERAL_NAMES *name); |
| 87 |
\& void X509_ACERT_set0_holder_baseCertId(X509_ACERT *x, OSSL_ISSUER_SERIAL *isss); |
| 88 |
\& void X509_ACERT_set0_holder_digest(X509_ACERT *x, |
| 89 |
\& OSSL_OBJECT_DIGEST_INFO *dinfo); |
| 90 |
\& |
| 91 |
\& X509_NAME *OSSL_ISSUER_SERIAL_get0_issuer(OSSL_ISSUER_SERIAL *isss); |
| 92 |
\& ASN1_INTEGER *OSSL_ISSUER_SERIAL_get0_serial(OSSL_ISSUER_SERIAL *isss); |
| 93 |
\& ASN1_BIT_STRING *OSSL_ISSUER_SERIAL_get0_issuerUID(OSSL_ISSUER_SERIAL *isss); |
| 94 |
\& int OSSL_ISSUER_SERIAL_set1_issuer(OSSL_ISSUER_SERIAL *isss, X509_NAME *issuer); |
| 95 |
\& int OSSL_ISSUER_SERIAL_set1_serial(OSSL_ISSUER_SERIAL *isss, ASN1_INTEGER *serial); |
| 96 |
\& int OSSL_ISSUER_SERIAL_set1_issuerUID(OSSL_ISSUER_SERIAL *isss, ASN1_BIT_STRING *uid); |
| 97 |
\& |
| 98 |
\& void OSSL_OBJECT_DIGEST_INFO_get0_digest(OSSL_OBJECT_DIGEST_INFO *o, |
| 99 |
\& ASN1_ENUMERATED **digestedObjectType, |
| 100 |
\& X509_ALGOR **digestAlgorithm, |
| 101 |
\& ASN1_BIT_STRING **digest); |
| 102 |
\& void OSSL_OBJECT_DIGEST_INFO_set1_digest(OSSL_OBJECT_DIGEST_INFO *o, |
| 103 |
\& ASN1_ENUMERATED *digestedObjectType, |
| 104 |
\& X509_ALGOR *digestAlgorithm, |
| 105 |
\& ASN1_BIT_STRING *digest); |
| 106 |
.Ve |
| 107 |
.SH DESCRIPTION |
| 108 |
.IX Header "DESCRIPTION" |
| 109 |
These routines set and get the holder identity of an X509 attribute certificate. |
| 110 |
.PP |
| 111 |
\&\fBX509_ACERT_set0_holder_entityName()\fR sets the identity as a \fBGENERAL_NAME\fR |
| 112 |
\&\fIname\fR, \fBX509_ACERT_set0_holder_baseCertId()\fR sets the identity based on the |
| 113 |
issuer and serial number of a certificate detailed in \fIisss\fR and |
| 114 |
\&\fBX509_ACERT_set0_holder_digest()\fR sets the holder entity based on digest |
| 115 |
information \fIdinfo\fR. Although RFC 5755 section 4.2.2 recommends that only |
| 116 |
one of the above methods be used to set the holder identity for a given |
| 117 |
attribute certificate \fIx\fR, setting multiple methods at the same time is |
| 118 |
possible. It is up to the application to handle cases when conflicting |
| 119 |
identity information is specified using different methods. |
| 120 |
.PP |
| 121 |
Pointers to the internal structures describing the holder identity of |
| 122 |
attribute certificate \fIx\fR can be retrieved with |
| 123 |
\&\fBX509_ACERT_get0_holder_entityName()\fR, \fBX509_ACERT_get0_holder_baseCertId()\fR, and |
| 124 |
\&\fBX509_ACERT_get0_holder_digest()\fR. |
| 125 |
.PP |
| 126 |
A \fBOSSL_ISSUER_SERIAL\fR object holds the subject name and UID of a certificate |
| 127 |
issuer and a certificate's serial number. \fBOSSL_ISSUER_SERIAL_set1_issuer()\fR, |
| 128 |
\&\fBOSSL_ISSUER_SERIAL_set1_issuerUID()\fR, and \fBOSSL_ISSUER_SERIAL_set1_serial()\fR |
| 129 |
respectively copy these values into the \fBOSSL_ISSUER_SERIAL\fR structure. |
| 130 |
The application is responsible for freeing its own copy of these values after |
| 131 |
use. \fBOSSL_ISSUER_SERIAL_get0_issuer()\fR, \fBOSSL_ISSUER_SERIAL_get0_issuerUID()\fR, |
| 132 |
and \fBOSSL_ISSUER_SERIAL_get0_serial()\fR return pointers to these values in the object. |
| 133 |
.PP |
| 134 |
An \fBOSSL_OBJECT_DIGEST_INFO\fR object holds a digest of data to identify the |
| 135 |
attribute certificate holder. \fBOSSL_OBJECT_DIGEST_INFO_set1_digest()\fR sets the |
| 136 |
digest information of the object. The type of \fIdigest\fR information is given |
| 137 |
by \fIdigestedObjectType\fR and can be one of: |
| 138 |
.IP OSSL_OBJECT_DIGEST_INFO_PUBLIC_KEY 4 |
| 139 |
.IX Item "OSSL_OBJECT_DIGEST_INFO_PUBLIC_KEY" |
| 140 |
Hash of a public key |
| 141 |
.IP OSSL_OBJECT_DIGEST_INFO_PUBLIC_KEY_CERT 4 |
| 142 |
.IX Item "OSSL_OBJECT_DIGEST_INFO_PUBLIC_KEY_CERT" |
| 143 |
Hash of a public key certificate |
| 144 |
.IP OSSL_OBJECT_DIGEST_INFO_OTHER 4 |
| 145 |
.IX Item "OSSL_OBJECT_DIGEST_INFO_OTHER" |
| 146 |
Hash of another object. See NOTES below. |
| 147 |
.PP |
| 148 |
\&\fIdigestAlgorithm\fR indicates the algorithm used to compute \fIdigest\fR. |
| 149 |
.SH "RETURN VALUES" |
| 150 |
.IX Header "RETURN VALUES" |
| 151 |
All \fIset0\fR/\fIset1\fR routines return 1 for success and 0 for failure. |
| 152 |
All \fIget0\fR functions return a pointer to the object's inner structure. These |
| 153 |
pointers must not be freed after use. |
| 154 |
.SH NOTES |
| 155 |
.IX Header "NOTES" |
| 156 |
Although the value of \fBOSSL_OBJECT_DIGEST_INFO_OTHER\fR is defined in RFC 5755, |
| 157 |
its use is prohibited for conformant attribute certificates. |
| 158 |
.SH HISTORY |
| 159 |
.IX Header "HISTORY" |
| 160 |
These functions were added in OpenSSL 3.4. |
| 161 |
.SH COPYRIGHT |
| 162 |
.IX Header "COPYRIGHT" |
| 163 |
Copyright 2023\-2024 The OpenSSL Project Authors. All Rights Reserved. |
| 164 |
.PP |
| 165 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 166 |
this file except in compliance with the License. You can obtain a copy |
| 167 |
in the file LICENSE in the source distribution or at |
| 168 |
<https://www.openssl.org/source/license.html>. |