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, int lastpos);
46 int X509_CRL_get_ext_by_critical(const X509_CRL *x, int crit, int lastpos);
47 X509_EXTENSION *X509_CRL_delete_ext(X509_CRL *x, int loc);
48 int X509_CRL_add_ext(X509_CRL *x, X509_EXTENSION *ex, int loc);
49 int X509_REVOKED_get_ext_count(const X509_REVOKED *x);
51 X509_EXTENSION *X509_REVOKED_get_ext(const X509_REVOKED *x, int loc);
52 int X509_REVOKED_get_ext_by_NID(const X509_REVOKED *x, int nid, int lastpos);
53 int X509_REVOKED_get_ext_by_OBJ(const X509_REVOKED *x, const ASN1_OBJECT *obj,
54 int lastpos);
55 int X509_REVOKED_get_ext_by_critical(const X509_REVOKED *x, int crit, int lastpos);
56 X509_EXTENSION *X509_REVOKED_delete_ext(X509_REVOKED *x, int loc);
57 int X509_REVOKED_add_ext(X509_REVOKED *x, X509_EXTENSION *ex, int loc);
58
60 X509v3_get_ext_count() retrieves the number of extensions in x.
61 X509v3_get_ext() retrieves extension loc from x. The index loc can take
63 any value from 0 to X509_get_ext_count(x) - 1. The returned extension
64 is an internal pointer which must not be freed up by the application.
65 X509v3_get_ext_by_NID() and X509v3_get_ext_by_OBJ() look for an
67 extension with nid or obj from extension stack x. The search starts
68 from the extension after lastpos or from the beginning if <lastpos> is
69 -1. If the extension is found its index is returned otherwise -1 is
70 returned.
71 X509v3_get_ext_by_critical() is similar to X509v3_get_ext_by_NID()
73 except it looks for an extension of criticality crit. A zero value for
74 crit looks for a non-critical extension a nonzero value looks for a
75 critical extension.
76 X509v3_delete_ext() deletes the extension with index loc from x. The
78 deleted extension is returned and must be freed by the caller. If loc
79 is in invalid index value NULL is returned.
80 X509v3_add_ext() adds extension ex to stack *x at position loc. If loc
82 is -1 the new extension is added to the end. If *x is NULL a new stack
83 will be allocated. The passed extension ex is duplicated internally so
84 it must be freed after use.
85 X509_get_ext_count(), X509_get_ext(), X509_get_ext_by_NID(),
87 X509_get_ext_by_OBJ(), X509_get_ext_by_critical(), X509_delete_ext()
88 and X509_add_ext() operate on the extensions of certificate x they are
89 otherwise identical to the X509v3 functions.
90 X509_CRL_get_ext_count(), X509_CRL_get_ext(),
92 X509_CRL_get_ext_by_NID(), X509_CRL_get_ext_by_OBJ(),
93 X509_CRL_get_ext_by_critical(), X509_CRL_delete_ext() and
94 X509_CRL_add_ext() operate on the extensions of CRL x they are
95 otherwise identical to the X509v3 functions.
96 X509_REVOKED_get_ext_count(), X509_REVOKED_get_ext(),
98 X509_REVOKED_get_ext_by_NID(), X509_REVOKED_get_ext_by_OBJ(),
99 X509_REVOKED_get_ext_by_critical(), X509_REVOKED_delete_ext() and
100 X509_REVOKED_add_ext() operate on the extensions of CRL entry x they
101 are otherwise identical to the X509v3 functions.
102
104 These functions are used to examine stacks of extensions directly. Many
105 applications will want to parse or encode and add an extension: they
106 should use the extension encode and decode functions instead such as
107 X509_add1_ext_i2d() and X509_get_ext_d2i().
108 Extension indices start from zero, so a zero index return value is not
110 an error. These search functions start from the extension after the
111 lastpos parameter so it should initially be set to -1, if it is set to
112 zero the initial extension will not be checked.
113
115 X509v3_delete_ext() and its variants are a bit counter-intuitive
116 because these functions do not free the extension they delete.
117
119 X509v3_get_ext_count() returns the extension count.
120 X509v3_get_ext(), X509v3_delete_ext() and X509_delete_ext() return an
122 X509_EXTENSION pointer or NULL if an error occurs.
123 X509v3_get_ext_by_NID() X509v3_get_ext_by_OBJ() and
125 X509v3_get_ext_by_critical() return the an extension index or -1 if an
126 error occurs.
127 X509v3_add_ext() returns a stack of extensions or NULL on error.
129 X509_add_ext() returns 1 on success and 0 on error.
131
133 X509V3_get_d2i(3)
134
136 Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
137 Licensed under the Apache License 2.0 (the "License"). You may not use
139 this file except in compliance with the License. You can obtain a copy
140 in the file LICENSE in the source distribution or at
141 <https://www.openssl.org/source/license.html>.
1423.0.5 2022-11-01 X509V3_GET_EXT_BY_NID(3ossl)