Android_verify/lib/openssl/share/man/man3/X509_ACERT_print_ex.3ossl

.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" 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'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "X509_ACERT_PRINT_EX 3ossl"
.TH X509_ACERT_PRINT_EX 3ossl 2025-01-17 3.4.0 OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
X509_ACERT_print_ex, X509_ACERT_print
\&\- X509_ACERT printing routines
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/x509_acert.h>
\&
\& int X509_ACERT_print(BIO *bp, X509_ACERT *acert);
\& int X509_ACERT_print_ex(BIO *bp, X509_ACERT *acert, unsigned long nmflags,
\&                         unsigned long cflag);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBX509_ACERT_print_ex()\fR prints a human readable version of the attribute
certificate \fIacert\fR to BIO \fIbp\fR.
.PP
The following data contained in the attribute certificate is printed
in order:
.IP \(bu 4
The header text "Attribute certificate:" and "Data:" (X509_FLAG_NO_HEADER)
.Sp
= item *
.Sp
The attribute certificate version number as defined by the standard,
followed in parentheses by the value contained in the version field in
hexadecimal notation.  If the version number is not a valid value according
to the specification, only the raw value is printed.
See \fBX509_ACERT_get_version\fR\|(3) for details. (X509_FLAG_NO_VERSION)
.Sp
= item *
.Sp
The serial number of the attribute certificate (X509_FLAG_NO_SERIAL)
.Sp
= item *
.Sp
The identity of the holder of the attribute certificate. If the
holder issuer name is present, the first GENERAL_NAME
returned by \fBX509_ACERT_get0_holder_entityName()\fR is printed.
If the holder baseCertificateId is present, the issuer name
(printed with X509_NAME_print_ex) and serial number of the
holder's certificate are displayed. (X509_FLAG_NO_SUBJECT)
.Sp
= item *
.Sp
The name of the attribute certificate issuer as returned from
\&\fBX509_ACERT_get0_issuerName()\fR and printed using \fBX509_NAME_print_ex()\fR.
(X509_FLAG_NO_ISSUER)
.Sp
= item *
.Sp
The period of validity between the times returned from \fBX509_ACERT_get0_notBefore()\fR
and  \fBX509_ACERT_get0_notAfter()\fR.  The values are printed as a generalized times
using \fBASN1_GENERALIZEDTIME_print()\fR. (X509_FLAG_NO_VALIDITY)
.Sp
= item *
.Sp
The list of attributes contained in the attribute certificate.
The attribute type is printed with \fBi2a_ASN1_OBJECT()\fR.  String valued
attributes are printed as raw string data. ASN1 encoded values are
printed with \fBASN1_parse_dump()\fR.  (X509_FLAG_NO_ATTRIBUTES)
.Sp
= item *
.Sp
All X.509 extensions contained in the attribute certificate. (X509_FLAG_NO_EXTENSIONS)
.Sp
= item *
.Sp
The signature is printed with \fBX509_signature_print()\fR. (X509_FLAG_NO_SIGDUMP)
.Sp
If \fIcflag\fR is specifies as X509_FLAG_COMPAT, all of the above data in the
attribute certificate will be printed.
.Sp
The \fInmflags\fR flag determines the format used to output all fields printed using
\&\fBX509_NAME_print_ex()\fR. See \fBX509_NAME_print_ex\fR\|(3) for details.
.Sp
\&\fBX509_ACERT_print()\fR is equivalent to calling \fBX509_ACERT_print_ex()\fR with the
\&\fInmflags\fR and \fIcflags\fR set to XN_FLAG_COMPAT and X509_FLAG_COMPAT
respectively.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBX509_ACERT_print_ex()\fR \fBX509_ACERT_print()\fR return 1 for
success and 0 for failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBX509_NAME_print_ex\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
\&\fBX509_ACERT_print()\fR and \fBX509_ACERT_print_ex()\fR were added in OpenSSL 3.4.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2023\-2024 The OpenSSL Project Authors. All Rights Reserved.
.PP
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>.