265 lines
11 KiB
Groff
265 lines
11 KiB
Groff
|
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
||
|
.\"
|
||
|
.\" 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
|
||
|
..
|
||
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||
|
.ie n \{\
|
||
|
. 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\}
|
||
|
.el\{\
|
||
|
. ds -- \|\(em\|
|
||
|
. ds PI \(*p
|
||
|
. ds L" ``
|
||
|
. ds R" ''
|
||
|
'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 turned on, 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.
|
||
|
.ie \nF \{\
|
||
|
. de IX
|
||
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
..
|
||
|
. nr % 0
|
||
|
. rr F
|
||
|
.\}
|
||
|
.el \{\
|
||
|
. de IX
|
||
|
..
|
||
|
.\}
|
||
|
.\"
|
||
|
.\" 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
|
||
|
.if n \{\
|
||
|
. ds #H 0
|
||
|
. ds #V .8m
|
||
|
. ds #F .3m
|
||
|
. ds #[ \f1
|
||
|
. ds #] \fP
|
||
|
.\}
|
||
|
.if t \{\
|
||
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
. ds #V .6m
|
||
|
. ds #F 0
|
||
|
. ds #[ \&
|
||
|
. ds #] \&
|
||
|
.\}
|
||
|
. \" simple accents for nroff and troff
|
||
|
.if n \{\
|
||
|
. ds ' \&
|
||
|
. ds ` \&
|
||
|
. ds ^ \&
|
||
|
. ds , \&
|
||
|
. ds ~ ~
|
||
|
. ds /
|
||
|
.\}
|
||
|
.if t \{\
|
||
|
. 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
|
||
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
. \" corrections for vroff
|
||
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
. \" for low resolution devices (crt and lpr)
|
||
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
\{\
|
||
|
. 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
|
||
|
.\}
|
||
|
.rm #[ #] #H #V #F C
|
||
|
.\" ========================================================================
|
||
|
.\"
|
||
|
.IX Title "X509V3_GET_EXT_BY_NID 3"
|
||
|
.TH X509V3_GET_EXT_BY_NID 3 "2020-03-02" "3.0.0-dev" "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"
|
||
|
X509v3_get_ext_count, X509v3_get_ext, X509v3_get_ext_by_NID,
|
||
|
X509v3_get_ext_by_OBJ, X509v3_get_ext_by_critical, X509v3_delete_ext,
|
||
|
X509v3_add_ext, X509_get_ext_count, X509_get_ext,
|
||
|
X509_get_ext_by_NID, X509_get_ext_by_OBJ, X509_get_ext_by_critical,
|
||
|
X509_delete_ext, X509_add_ext, X509_CRL_get_ext_count, X509_CRL_get_ext,
|
||
|
X509_CRL_get_ext_by_NID, X509_CRL_get_ext_by_OBJ, X509_CRL_get_ext_by_critical,
|
||
|
X509_CRL_delete_ext, X509_CRL_add_ext, X509_REVOKED_get_ext_count,
|
||
|
X509_REVOKED_get_ext, X509_REVOKED_get_ext_by_NID, X509_REVOKED_get_ext_by_OBJ,
|
||
|
X509_REVOKED_get_ext_by_critical, X509_REVOKED_delete_ext,
|
||
|
X509_REVOKED_add_ext \- extension stack utility functions
|
||
|
.SH "SYNOPSIS"
|
||
|
.IX Header "SYNOPSIS"
|
||
|
.Vb 1
|
||
|
\& #include <openssl/x509.h>
|
||
|
\&
|
||
|
\& int X509v3_get_ext_count(const STACK_OF(X509_EXTENSION) *x);
|
||
|
\& X509_EXTENSION *X509v3_get_ext(const STACK_OF(X509_EXTENSION) *x, int loc);
|
||
|
\&
|
||
|
\& int X509v3_get_ext_by_NID(const STACK_OF(X509_EXTENSION) *x,
|
||
|
\& int nid, int lastpos);
|
||
|
\& int X509v3_get_ext_by_OBJ(const STACK_OF(X509_EXTENSION) *x,
|
||
|
\& const ASN1_OBJECT *obj, int lastpos);
|
||
|
\& int X509v3_get_ext_by_critical(const STACK_OF(X509_EXTENSION) *x,
|
||
|
\& int crit, int lastpos);
|
||
|
\& X509_EXTENSION *X509v3_delete_ext(STACK_OF(X509_EXTENSION) *x, int loc);
|
||
|
\& STACK_OF(X509_EXTENSION) *X509v3_add_ext(STACK_OF(X509_EXTENSION) **x,
|
||
|
\& X509_EXTENSION *ex, int loc);
|
||
|
\&
|
||
|
\& int X509_get_ext_count(const X509 *x);
|
||
|
\& X509_EXTENSION *X509_get_ext(const X509 *x, int loc);
|
||
|
\& int X509_get_ext_by_NID(const X509 *x, int nid, int lastpos);
|
||
|
\& int X509_get_ext_by_OBJ(const X509 *x, const ASN1_OBJECT *obj, int lastpos);
|
||
|
\& int X509_get_ext_by_critical(const X509 *x, int crit, int lastpos);
|
||
|
\& X509_EXTENSION *X509_delete_ext(X509 *x, int loc);
|
||
|
\& int X509_add_ext(X509 *x, X509_EXTENSION *ex, int loc);
|
||
|
\&
|
||
|
\& int X509_CRL_get_ext_count(const X509_CRL *x);
|
||
|
\& X509_EXTENSION *X509_CRL_get_ext(const X509_CRL *x, int loc);
|
||
|
\& int X509_CRL_get_ext_by_NID(const X509_CRL *x, int nid, int lastpos);
|
||
|
\& int X509_CRL_get_ext_by_OBJ(const X509_CRL *x, const ASN1_OBJECT *obj, int lastpos);
|
||
|
\& int X509_CRL_get_ext_by_critical(const X509_CRL *x, int crit, int lastpos);
|
||
|
\& X509_EXTENSION *X509_CRL_delete_ext(X509_CRL *x, int loc);
|
||
|
\& int X509_CRL_add_ext(X509_CRL *x, X509_EXTENSION *ex, int loc);
|
||
|
\&
|
||
|
\& int X509_REVOKED_get_ext_count(const X509_REVOKED *x);
|
||
|
\& X509_EXTENSION *X509_REVOKED_get_ext(const X509_REVOKED *x, int loc);
|
||
|
\& int X509_REVOKED_get_ext_by_NID(const X509_REVOKED *x, int nid, int lastpos);
|
||
|
\& int X509_REVOKED_get_ext_by_OBJ(const X509_REVOKED *x, const ASN1_OBJECT *obj,
|
||
|
\& int lastpos);
|
||
|
\& int X509_REVOKED_get_ext_by_critical(const X509_REVOKED *x, int crit, int lastpos);
|
||
|
\& X509_EXTENSION *X509_REVOKED_delete_ext(X509_REVOKED *x, int loc);
|
||
|
\& int X509_REVOKED_add_ext(X509_REVOKED *x, X509_EXTENSION *ex, int loc);
|
||
|
.Ve
|
||
|
.SH "DESCRIPTION"
|
||
|
.IX Header "DESCRIPTION"
|
||
|
\&\fIX509v3_get_ext_count()\fR retrieves the number of extensions in \fBx\fR.
|
||
|
.PP
|
||
|
\&\fIX509v3_get_ext()\fR retrieves extension \fBloc\fR from \fBx\fR. The index \fBloc\fR
|
||
|
can take any value from \fB0\fR to X509_get_ext_count(x) \- 1. The returned
|
||
|
extension is an internal pointer which \fBmust not\fR be freed up by the
|
||
|
application.
|
||
|
.PP
|
||
|
\&\fIX509v3_get_ext_by_NID()\fR and \fIX509v3_get_ext_by_OBJ()\fR look for an extension
|
||
|
with \fBnid\fR or \fBobj\fR from extension stack \fBx\fR. The search starts from the
|
||
|
extension after \fBlastpos\fR or from the beginning if <lastpos> is \fB\-1\fR. If
|
||
|
the extension is found its index is returned otherwise \fB\-1\fR is returned.
|
||
|
.PP
|
||
|
\&\fIX509v3_get_ext_by_critical()\fR is similar to \fIX509v3_get_ext_by_NID()\fR except it
|
||
|
looks for an extension of criticality \fBcrit\fR. A zero value for \fBcrit\fR
|
||
|
looks for a non-critical extension a nonzero value looks for a critical
|
||
|
extension.
|
||
|
.PP
|
||
|
\&\fIX509v3_delete_ext()\fR deletes the extension with index \fBloc\fR from \fBx\fR. The
|
||
|
deleted extension is returned and must be freed by the caller. If \fBloc\fR
|
||
|
is in invalid index value \fB\s-1NULL\s0\fR is returned.
|
||
|
.PP
|
||
|
\&\fIX509v3_add_ext()\fR adds extension \fBex\fR to stack \fB*x\fR at position \fBloc\fR. If
|
||
|
\&\fBloc\fR is \fB\-1\fR the new extension is added to the end. If \fB*x\fR is \fB\s-1NULL\s0\fR
|
||
|
a new stack will be allocated. The passed extension \fBex\fR is duplicated
|
||
|
internally so it must be freed after use.
|
||
|
.PP
|
||
|
\&\fIX509_get_ext_count()\fR, \fIX509_get_ext()\fR, \fIX509_get_ext_by_NID()\fR,
|
||
|
\&\fIX509_get_ext_by_OBJ()\fR, \fIX509_get_ext_by_critical()\fR, \fIX509_delete_ext()\fR
|
||
|
and \fIX509_add_ext()\fR operate on the extensions of certificate \fBx\fR they are
|
||
|
otherwise identical to the X509v3 functions.
|
||
|
.PP
|
||
|
\&\fIX509_CRL_get_ext_count()\fR, \fIX509_CRL_get_ext()\fR, \fIX509_CRL_get_ext_by_NID()\fR,
|
||
|
\&\fIX509_CRL_get_ext_by_OBJ()\fR, \fIX509_CRL_get_ext_by_critical()\fR,
|
||
|
\&\fIX509_CRL_delete_ext()\fR and \fIX509_CRL_add_ext()\fR operate on the extensions of
|
||
|
\&\s-1CRL\s0 \fBx\fR they are otherwise identical to the X509v3 functions.
|
||
|
.PP
|
||
|
\&\fIX509_REVOKED_get_ext_count()\fR, \fIX509_REVOKED_get_ext()\fR,
|
||
|
\&\fIX509_REVOKED_get_ext_by_NID()\fR, \fIX509_REVOKED_get_ext_by_OBJ()\fR,
|
||
|
\&\fIX509_REVOKED_get_ext_by_critical()\fR, \fIX509_REVOKED_delete_ext()\fR and
|
||
|
\&\fIX509_REVOKED_add_ext()\fR operate on the extensions of \s-1CRL\s0 entry \fBx\fR
|
||
|
they are otherwise identical to the X509v3 functions.
|
||
|
.SH "NOTES"
|
||
|
.IX Header "NOTES"
|
||
|
These functions are used to examine stacks of extensions directly. Many
|
||
|
applications will want to parse or encode and add an extension: they should
|
||
|
use the extension encode and decode functions instead such as
|
||
|
\&\fIX509_add1_ext_i2d()\fR and \fIX509_get_ext_d2i()\fR.
|
||
|
.PP
|
||
|
Extension indices start from zero, so a zero index return value is \fBnot\fR an
|
||
|
error. These search functions start from the extension \fBafter\fR the \fBlastpos\fR
|
||
|
parameter so it should initially be set to \fB\-1\fR, if it is set to zero the
|
||
|
initial extension will not be checked.
|
||
|
.SH "RETURN VALUES"
|
||
|
.IX Header "RETURN VALUES"
|
||
|
\&\fIX509v3_get_ext_count()\fR returns the extension count.
|
||
|
.PP
|
||
|
\&\fIX509v3_get_ext()\fR, \fIX509v3_delete_ext()\fR and \fIX509_delete_ext()\fR return an
|
||
|
\&\fBX509_EXTENSION\fR pointer or \fB\s-1NULL\s0\fR if an error occurs.
|
||
|
.PP
|
||
|
\&\fIX509v3_get_ext_by_NID()\fR \fIX509v3_get_ext_by_OBJ()\fR and
|
||
|
\&\fIX509v3_get_ext_by_critical()\fR return the an extension index or \fB\-1\fR if an
|
||
|
error occurs.
|
||
|
.PP
|
||
|
\&\fIX509v3_add_ext()\fR returns a stack of extensions or \fB\s-1NULL\s0\fR on error.
|
||
|
.PP
|
||
|
\&\fIX509_add_ext()\fR returns 1 on success and 0 on error.
|
||
|
.SH "SEE ALSO"
|
||
|
.IX Header "SEE ALSO"
|
||
|
\&\fIX509V3_get_d2i\fR\|(3)
|
||
|
.SH "COPYRIGHT"
|
||
|
.IX Header "COPYRIGHT"
|
||
|
Copyright 2015\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
.PP
|
||
|
Licensed under the Apache License 2.0 (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>.
|