1X509V3_GET_EXT_BY_NID(3ossl) OpenSSL X509V3_GET_EXT_BY_NID(3ossl)
2
6 X509v3_get_ext_count, X509v3_get_ext, X509v3_get_ext_by_NID,
7 X509v3_get_ext_by_OBJ, X509v3_get_ext_by_critical, X509v3_delete_ext,
8 X509v3_add_ext, X509_get_ext_count, X509_get_ext, X509_get_ext_by_NID,
9 X509_get_ext_by_OBJ, X509_get_ext_by_critical, X509_delete_ext,
10 X509_add_ext, X509_CRL_get_ext_count, X509_CRL_get_ext,
11 X509_CRL_get_ext_by_NID, X509_CRL_get_ext_by_OBJ,
12 X509_CRL_get_ext_by_critical, X509_CRL_delete_ext, X509_CRL_add_ext,
13 X509_REVOKED_get_ext_count, X509_REVOKED_get_ext,
14 X509_REVOKED_get_ext_by_NID, X509_REVOKED_get_ext_by_OBJ,
15 X509_REVOKED_get_ext_by_critical, X509_REVOKED_delete_ext,
16 X509_REVOKED_add_ext - extension stack utility functions
17
19 #include <openssl/x509.h>
20 int X509v3_get_ext_count(const STACK_OF(X509_EXTENSION) *x);
22 X509_EXTENSION *X509v3_get_ext(const STACK_OF(X509_EXTENSION) *x, int loc);
23 int X509v3_get_ext_by_NID(const STACK_OF(X509_EXTENSION) *x,
25 int nid, int lastpos);
26 int X509v3_get_ext_by_OBJ(const STACK_OF(X509_EXTENSION) *x,
27 const ASN1_OBJECT *obj, int lastpos);
28 int X509v3_get_ext_by_critical(const STACK_OF(X509_EXTENSION) *x,
29 int crit, int lastpos);
30 X509_EXTENSION *X509v3_delete_ext(STACK_OF(X509_EXTENSION) *x, int loc);
31 STACK_OF(X509_EXTENSION) *X509v3_add_ext(STACK_OF(X509_EXTENSION) **x,
32 X509_EXTENSION *ex, int loc);
33 int X509_get_ext_count(const X509 *x);
35 X509_EXTENSION *X509_get_ext(const X509 *x, int loc);
36 int X509_get_ext_by_NID(const X509 *x, int nid, int lastpos);
37 int X509_get_ext_by_OBJ(const X509 *x, const ASN1_OBJECT *obj, int lastpos);
38 int X509_get_ext_by_critical(const X509 *x, int crit, int lastpos);
39 X509_EXTENSION *X509_delete_ext(X509 *x, int loc);
40 int X509_add_ext(X509 *x, X509_EXTENSION *ex, int loc);
41 int X509_CRL_get_ext_count(const X509_CRL *x);
43 X509_EXTENSION *X509_CRL_get_ext(const X509_CRL *x, int loc);
44 int X509_CRL_get_ext_by_NID(const X509_CRL *x, int nid, int lastpos);
45 int X509_CRL_get_ext_by_OBJ(const X509_CRL *x, const ASN1_OBJECT *obj,
46 int lastpos);
47 int X509_CRL_get_ext_by_critical(const X509_CRL *x, int crit, int lastpos);
48 X509_EXTENSION *X509_CRL_delete_ext(X509_CRL *x, int loc);
49 int X509_CRL_add_ext(X509_CRL *x, X509_EXTENSION *ex, int loc);
50 int X509_REVOKED_get_ext_count(const X509_REVOKED *x);
52 X509_EXTENSION *X509_REVOKED_get_ext(const X509_REVOKED *x, int loc);
53 int X509_REVOKED_get_ext_by_NID(const X509_REVOKED *x, int nid, int lastpos);
54 int X509_REVOKED_get_ext_by_OBJ(const X509_REVOKED *x, const ASN1_OBJECT *obj,
55 int lastpos);
56 int X509_REVOKED_get_ext_by_critical(const X509_REVOKED *x, int crit, int lastpos);
57 X509_EXTENSION *X509_REVOKED_delete_ext(X509_REVOKED *x, int loc);
58 int X509_REVOKED_add_ext(X509_REVOKED *x, X509_EXTENSION *ex, int loc);
59
61 X509v3_get_ext_count() retrieves the number of extensions in x.
62 X509v3_get_ext() retrieves extension loc from x. The index loc can take
64 any value from 0 to X509_get_ext_count(x) - 1. The returned extension
65 is an internal pointer which MUST NOT be freed by the application.
66 X509v3_get_ext_by_NID() and X509v3_get_ext_by_OBJ() look for an
68 extension with nid or obj from extension STACK x. The search starts
69 from the extension after lastpos or from the beginning if lastpos is
70 -1. If the extension is found, its index is returned, otherwise -1 is
71 returned.
72 X509v3_get_ext_by_critical() is similar to X509v3_get_ext_by_NID()
74 except it looks for an extension of criticality crit. A zero value for
75 crit looks for a non-critical extension. A nonzero value looks for a
76 critical extension.
77 X509v3_delete_ext() deletes the extension with index loc from x. The
79 deleted extension is returned and must be freed by the caller. If loc
80 is an invalid index value, NULL is returned.
81 X509v3_add_ext() adds extension ex to STACK *x at position loc. If loc
83 is -1, the new extension is added to the end. If *x is NULL, a new
84 STACK will be allocated. The passed extension ex is duplicated
85 internally so it must be freed after use.
86 X509_get_ext_count(), X509_get_ext(), X509_get_ext_by_NID(),
88 X509_get_ext_by_OBJ(), X509_get_ext_by_critical(), X509_delete_ext()
89 and X509_add_ext() operate on the extensions of certificate x. They are
90 otherwise identical to the X509v3 functions.
91 X509_CRL_get_ext_count(), X509_CRL_get_ext(),
93 X509_CRL_get_ext_by_NID(), X509_CRL_get_ext_by_OBJ(),
94 X509_CRL_get_ext_by_critical(), X509_CRL_delete_ext() and
95 X509_CRL_add_ext() operate on the extensions of CRL x. They are
96 otherwise identical to the X509v3 functions.
97 X509_REVOKED_get_ext_count(), X509_REVOKED_get_ext(),
99 X509_REVOKED_get_ext_by_NID(), X509_REVOKED_get_ext_by_OBJ(),
100 X509_REVOKED_get_ext_by_critical(), X509_REVOKED_delete_ext() and
101 X509_REVOKED_add_ext() operate on the extensions of CRL entry x. They
102 are otherwise identical to the X509v3 functions.
103
105 These functions are used to examine stacks of extensions directly.
106 Applications that want to parse or encode and add an extension should
107 use the extension encode and decode functions instead, such as
108 X509_add1_ext_i2d() and X509_get_ext_d2i().
109 For X509v3_get_ext_by_NID(), X509v3_get_ext_by_OBJ(),
111 X509v3_get_ext_by_critical() and its variants, a zero index return
112 value is not an error since extension STACK x indices start from zero.
113 These search functions start from the extension after the lastpos
114 parameter so it should initially be set to -1. If it is set to zero,
115 the initial extension will not be checked.
116 X509v3_delete_ext() and its variants are a bit counter-intuitive
118 because these functions do not free the extension they delete. They
119 return an X509_EXTENSION object which must be explicitly freed using
120 X509_EXTENSION_free().
121
123 X509v3_get_ext_count() returns the extension count or 0 for failure.
124 X509v3_get_ext(), X509v3_delete_ext() and X509_delete_ext() return an
126 X509_EXTENSION structure or NULL if an error occurs.
127 X509v3_get_ext_by_OBJ() and X509v3_get_ext_by_critical() return the
129 extension index or -1 if an error occurs.
130 X509v3_get_ext_by_NID() returns the extension index or negative values
132 if an error occurs.
133 X509v3_add_ext() returns a STACK of extensions or NULL on error.
135 X509_add_ext() returns 1 on success and 0 on error.
137
139 X509V3_get_d2i(3)
140
142 Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
143 Licensed under the Apache License 2.0 (the "License"). You may not use
145 this file except in compliance with the License. You can obtain a copy
146 in the file LICENSE in the source distribution or at
147 <https://www.openssl.org/source/license.html>.
1483.1.1 2023-08-31 X509V3_GET_EXT_BY_NID(3ossl)