X509v3_get_ext_by_NID.pod 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. =pod
  2. =head1 NAME
  3. X509v3_get_ext_count, X509v3_get_ext, X509v3_get_ext_by_NID,
  4. X509v3_get_ext_by_OBJ, X509v3_get_ext_by_critical, X509v3_delete_ext,
  5. X509v3_add_ext, X509_get_ext_count, X509_get_ext,
  6. X509_get_ext_by_NID, X509_get_ext_by_OBJ, X509_get_ext_by_critical,
  7. X509_delete_ext, X509_add_ext, X509_CRL_get_ext_count, X509_CRL_get_ext,
  8. X509_CRL_get_ext_by_NID, X509_CRL_get_ext_by_OBJ, X509_CRL_get_ext_by_critical,
  9. X509_CRL_delete_ext, X509_CRL_add_ext, X509_REVOKED_get_ext_count,
  10. X509_REVOKED_get_ext, X509_REVOKED_get_ext_by_NID, X509_REVOKED_get_ext_by_OBJ,
  11. X509_REVOKED_get_ext_by_critical, X509_REVOKED_delete_ext,
  12. X509_REVOKED_add_ext - extension stack utility functions
  13. =head1 SYNOPSIS
  14. #include <openssl/x509.h>
  15. int X509v3_get_ext_count(const STACK_OF(X509_EXTENSION) *x);
  16. X509_EXTENSION *X509v3_get_ext(const STACK_OF(X509_EXTENSION) *x, int loc);
  17. int X509v3_get_ext_by_NID(const STACK_OF(X509_EXTENSION) *x,
  18. int nid, int lastpos);
  19. int X509v3_get_ext_by_OBJ(const STACK_OF(X509_EXTENSION) *x,
  20. const ASN1_OBJECT *obj, int lastpos);
  21. int X509v3_get_ext_by_critical(const STACK_OF(X509_EXTENSION) *x,
  22. int crit, int lastpos);
  23. X509_EXTENSION *X509v3_delete_ext(STACK_OF(X509_EXTENSION) *x, int loc);
  24. STACK_OF(X509_EXTENSION) *X509v3_add_ext(STACK_OF(X509_EXTENSION) **x,
  25. X509_EXTENSION *ex, int loc);
  26. int X509_get_ext_count(const X509 *x);
  27. X509_EXTENSION *X509_get_ext(const X509 *x, int loc);
  28. int X509_get_ext_by_NID(const X509 *x, int nid, int lastpos);
  29. int X509_get_ext_by_OBJ(const X509 *x, const ASN1_OBJECT *obj, int lastpos);
  30. int X509_get_ext_by_critical(const X509 *x, int crit, int lastpos);
  31. X509_EXTENSION *X509_delete_ext(X509 *x, int loc);
  32. int X509_add_ext(X509 *x, X509_EXTENSION *ex, int loc);
  33. int X509_CRL_get_ext_count(const X509_CRL *x);
  34. X509_EXTENSION *X509_CRL_get_ext(const X509_CRL *x, int loc);
  35. int X509_CRL_get_ext_by_NID(const X509_CRL *x, int nid, int lastpos);
  36. int X509_CRL_get_ext_by_OBJ(const X509_CRL *x, const ASN1_OBJECT *obj, int lastpos);
  37. int X509_CRL_get_ext_by_critical(const X509_CRL *x, int crit, int lastpos);
  38. X509_EXTENSION *X509_CRL_delete_ext(X509_CRL *x, int loc);
  39. int X509_CRL_add_ext(X509_CRL *x, X509_EXTENSION *ex, int loc);
  40. int X509_REVOKED_get_ext_count(const X509_REVOKED *x);
  41. X509_EXTENSION *X509_REVOKED_get_ext(const X509_REVOKED *x, int loc);
  42. int X509_REVOKED_get_ext_by_NID(const X509_REVOKED *x, int nid, int lastpos);
  43. int X509_REVOKED_get_ext_by_OBJ(const X509_REVOKED *x, const ASN1_OBJECT *obj,
  44. int lastpos);
  45. int X509_REVOKED_get_ext_by_critical(const X509_REVOKED *x, int crit, int lastpos);
  46. X509_EXTENSION *X509_REVOKED_delete_ext(X509_REVOKED *x, int loc);
  47. int X509_REVOKED_add_ext(X509_REVOKED *x, X509_EXTENSION *ex, int loc);
  48. =head1 DESCRIPTION
  49. X509v3_get_ext_count() retrieves the number of extensions in B<x>.
  50. X509v3_get_ext() retrieves extension B<loc> from B<x>. The index B<loc>
  51. can take any value from B<0> to X509_get_ext_count(x) - 1. The returned
  52. extension is an internal pointer which B<must not> be freed up by the
  53. application.
  54. X509v3_get_ext_by_NID() and X509v3_get_ext_by_OBJ() look for an extension
  55. with B<nid> or B<obj> from extension stack B<x>. The search starts from the
  56. extension after B<lastpos> or from the beginning if <lastpos> is B<-1>. If
  57. the extension is found its index is returned otherwise B<-1> is returned.
  58. X509v3_get_ext_by_critical() is similar to X509v3_get_ext_by_NID() except it
  59. looks for an extension of criticality B<crit>. A zero value for B<crit>
  60. looks for a non-critical extension a nonzero value looks for a critical
  61. extension.
  62. X509v3_delete_ext() deletes the extension with index B<loc> from B<x>.
  63. The deleted extension is returned and must be freed by the caller.
  64. If B<loc> is in invalid index value B<NULL> is returned.
  65. X509v3_add_ext() adds extension B<ex> to stack B<*x> at position B<loc>. If
  66. B<loc> is B<-1> the new extension is added to the end. If B<*x> is B<NULL>
  67. a new stack will be allocated. The passed extension B<ex> is duplicated
  68. internally so it must be freed after use.
  69. X509_get_ext_count(), X509_get_ext(), X509_get_ext_by_NID(),
  70. X509_get_ext_by_OBJ(), X509_get_ext_by_critical(), X509_delete_ext()
  71. and X509_add_ext() operate on the extensions of certificate B<x> they are
  72. otherwise identical to the X509v3 functions.
  73. X509_CRL_get_ext_count(), X509_CRL_get_ext(), X509_CRL_get_ext_by_NID(),
  74. X509_CRL_get_ext_by_OBJ(), X509_CRL_get_ext_by_critical(),
  75. X509_CRL_delete_ext() and X509_CRL_add_ext() operate on the extensions of
  76. CRL B<x> they are otherwise identical to the X509v3 functions.
  77. X509_REVOKED_get_ext_count(), X509_REVOKED_get_ext(),
  78. X509_REVOKED_get_ext_by_NID(), X509_REVOKED_get_ext_by_OBJ(),
  79. X509_REVOKED_get_ext_by_critical(), X509_REVOKED_delete_ext() and
  80. X509_REVOKED_add_ext() operate on the extensions of CRL entry B<x>
  81. they are otherwise identical to the X509v3 functions.
  82. =head1 NOTES
  83. These functions are used to examine stacks of extensions directly. Many
  84. applications will want to parse or encode and add an extension: they should
  85. use the extension encode and decode functions instead such as
  86. X509_add1_ext_i2d() and X509_get_ext_d2i().
  87. Extension indices start from zero, so a zero index return value is B<not> an
  88. error. These search functions start from the extension B<after> the B<lastpos>
  89. parameter so it should initially be set to B<-1>, if it is set to zero the
  90. initial extension will not be checked.
  91. =head1 BUGS
  92. X509v3_delete_ext() and its variants are a bit counter-intuitive
  93. because these functions do not free the extension they delete.
  94. =head1 RETURN VALUES
  95. X509v3_get_ext_count() returns the extension count.
  96. X509v3_get_ext(), X509v3_delete_ext() and X509_delete_ext() return an
  97. B<X509_EXTENSION> pointer or B<NULL> if an error occurs.
  98. X509v3_get_ext_by_NID() X509v3_get_ext_by_OBJ() and
  99. X509v3_get_ext_by_critical() return the an extension index or B<-1> if an
  100. error occurs.
  101. X509v3_add_ext() returns a stack of extensions or B<NULL> on error.
  102. X509_add_ext() returns 1 on success and 0 on error.
  103. =head1 SEE ALSO
  104. L<X509V3_get_d2i(3)>
  105. =head1 COPYRIGHT
  106. Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
  107. Licensed under the Apache License 2.0 (the "License"). You may not use
  108. this file except in compliance with the License. You can obtain a copy
  109. in the file LICENSE in the source distribution or at
  110. L<https://www.openssl.org/source/license.html>.
  111. =cut