diff options
Diffstat (limited to 'static/freebsd/man3/X509v3_get_ext_by_NID.3')
| -rw-r--r-- | static/freebsd/man3/X509v3_get_ext_by_NID.3 | 223 |
1 files changed, 223 insertions, 0 deletions
diff --git a/static/freebsd/man3/X509v3_get_ext_by_NID.3 b/static/freebsd/man3/X509v3_get_ext_by_NID.3 new file mode 100644 index 00000000..21b8d992 --- /dev/null +++ b/static/freebsd/man3/X509v3_get_ext_by_NID.3 @@ -0,0 +1,223 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" 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 +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "X509V3_GET_EXT_BY_NID 3ossl" +.TH X509V3_GET_EXT_BY_NID 3ossl 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. +.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, X509v3_add_extensions, 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); +\& STACK_OF(X509_EXTENSION) +\& *X509v3_add_extensions(STACK_OF(X509_EXTENSION) **target, +\& const STACK_OF(X509_EXTENSION) *exts); +\& +\& 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" +\&\fBX509v3_get_ext_count()\fR retrieves the number of extensions in \fIx\fR. +.PP +\&\fBX509v3_get_ext()\fR retrieves extension \fIloc\fR from \fIx\fR. The index \fIloc\fR +can take any value from 0 to X509_get_ext_count(\fIx\fR) \- 1. The returned +extension is an internal pointer which \fBMUST NOT\fR be freed by the +application. +.PP +\&\fBX509v3_get_ext_by_NID()\fR and \fBX509v3_get_ext_by_OBJ()\fR look for an extension +with \fInid\fR or \fIobj\fR from extension STACK \fIx\fR. The search starts from the +extension after \fIlastpos\fR or from the beginning if \fIlastpos\fR is \-1. If +the extension is found, its index is returned, otherwise \-1 is returned. +.PP +\&\fBX509v3_get_ext_by_critical()\fR is similar to \fBX509v3_get_ext_by_NID()\fR except it +looks for an extension of criticality \fIcrit\fR. A zero value for \fIcrit\fR +looks for a non\-critical extension. A nonzero value looks for a critical +extension. +.PP +\&\fBX509v3_delete_ext()\fR deletes the extension with index \fIloc\fR from \fIx\fR. +The deleted extension is returned and must be freed by the caller. +If \fIloc\fR is an invalid index value, NULL is returned. +.PP +\&\fBX509v3_add_ext()\fR inserts extension \fIex\fR to STACK \fI*x\fR at position \fIloc\fR. +If \fIloc\fR is \-1, the new extension is added to the end. +A new STACK is allocated if \fI*x\fR is NULL. +The passed extension \fIex\fR is duplicated so it must be freed after use. +.PP +\&\fBX509v3_add_extensions()\fR adds the list of extensions \fIexts\fR to STACK \fI*target\fR. +The STACK \fI*target\fR is returned unchanged if \fIexts\fR is NULL or an empty list. +Otherwise a new stack is allocated if \fI*target\fR is NULL. +An extension to be added +that has the same OID as a pre\-existing one replaces this earlier one. +.PP +\&\fBX509_get_ext_count()\fR, \fBX509_get_ext()\fR, \fBX509_get_ext_by_NID()\fR, +\&\fBX509_get_ext_by_OBJ()\fR, \fBX509_get_ext_by_critical()\fR, \fBX509_delete_ext()\fR +and \fBX509_add_ext()\fR operate on the extensions of certificate \fIx\fR. They are +otherwise identical to the X509v3 functions. +.PP +\&\fBX509_CRL_get_ext_count()\fR, \fBX509_CRL_get_ext()\fR, \fBX509_CRL_get_ext_by_NID()\fR, +\&\fBX509_CRL_get_ext_by_OBJ()\fR, \fBX509_CRL_get_ext_by_critical()\fR, +\&\fBX509_CRL_delete_ext()\fR and \fBX509_CRL_add_ext()\fR operate on the extensions of +CRL \fIx\fR. They are otherwise identical to the X509v3 functions. +.PP +\&\fBX509_REVOKED_get_ext_count()\fR, \fBX509_REVOKED_get_ext()\fR, +\&\fBX509_REVOKED_get_ext_by_NID()\fR, \fBX509_REVOKED_get_ext_by_OBJ()\fR, +\&\fBX509_REVOKED_get_ext_by_critical()\fR, \fBX509_REVOKED_delete_ext()\fR and +\&\fBX509_REVOKED_add_ext()\fR operate on the extensions of CRL entry \fIx\fR. +They are otherwise identical to the X509v3 functions. +.SH NOTES +.IX Header "NOTES" +These functions are used to examine stacks of extensions directly. +Applications that want to parse or encode and add an extension should +use the extension encode and decode functions instead, such as +\&\fBX509_add1_ext_i2d()\fR and \fBX509_get_ext_d2i()\fR. +.PP +For \fBX509v3_get_ext_by_NID()\fR, \fBX509v3_get_ext_by_OBJ()\fR, +\&\fBX509v3_get_ext_by_critical()\fR and its variants, a zero index return value +is not an error since extension STACK \fIx\fR indices start from zero. +These search functions start from the extension \fBafter\fR the \fIlastpos\fR parameter +so it should initially be set to \-1. If it is set to zero, the initial extension +will not be checked. +.PP +\&\fBX509v3_delete_ext()\fR and its variants are a bit counter\-intuitive +because these functions do not free the extension they delete. +They return an \fBX509_EXTENSION\fR object which must be explicitly freed +using \fBX509_EXTENSION_free()\fR. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBX509v3_get_ext_count()\fR returns the extension count or 0 for failure. +.PP +\&\fBX509v3_get_ext()\fR, \fBX509v3_delete_ext()\fR and \fBX509_delete_ext()\fR return an +\&\fBX509_EXTENSION\fR structure or NULL if an error occurs. +.PP +\&\fBX509v3_get_ext_by_OBJ()\fR and \fBX509v3_get_ext_by_critical()\fR return +the extension index or \-1 if an error occurs. +.PP +\&\fBX509v3_get_ext_by_NID()\fR returns the extension index or negative values if an +error occurs. +.PP +\&\fBX509v3_add_ext()\fR returns a STACK of extensions or NULL on error. +.PP +\&\fBX509v3_add_extensions()\fR returns a STACK of extensions +or NULL on error or if \fI*target\fR is NULL and \fIexts\fR is NULL or an empty list. +.PP +\&\fBX509_add_ext()\fR returns 1 on success and 0 on error. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBX509V3_get_d2i\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +\&\fBX509v3_add_extensions()\fR was added in OpenSSL 3.4. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2015\-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>. |