A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

196 lines
8.8 KiB

  1. =pod
  2. =head1 NAME
  3. X509_LOOKUP_METHOD,
  4. X509_LOOKUP_meth_new, X509_LOOKUP_meth_free, X509_LOOKUP_meth_set_new_item,
  5. X509_LOOKUP_meth_get_new_item, X509_LOOKUP_meth_set_free,
  6. X509_LOOKUP_meth_get_free, X509_LOOKUP_meth_set_init,
  7. X509_LOOKUP_meth_get_init, X509_LOOKUP_meth_set_shutdown,
  8. X509_LOOKUP_meth_get_shutdown,
  9. X509_LOOKUP_ctrl_fn, X509_LOOKUP_meth_set_ctrl, X509_LOOKUP_meth_get_ctrl,
  10. X509_LOOKUP_get_by_subject_fn, X509_LOOKUP_meth_set_get_by_subject,
  11. X509_LOOKUP_meth_get_get_by_subject,
  12. X509_LOOKUP_get_by_issuer_serial_fn, X509_LOOKUP_meth_set_get_by_issuer_serial,
  13. X509_LOOKUP_meth_get_get_by_issuer_serial,
  14. X509_LOOKUP_get_by_fingerprint_fn, X509_LOOKUP_meth_set_get_by_fingerprint,
  15. X509_LOOKUP_meth_get_get_by_fingerprint,
  16. X509_LOOKUP_get_by_alias_fn, X509_LOOKUP_meth_set_get_by_alias,
  17. X509_LOOKUP_meth_get_get_by_alias,
  18. X509_OBJECT_set1_X509, X509_OBJECT_set1_X509_CRL
  19. - Routines to build up X509_LOOKUP methods
  20. =head1 SYNOPSIS
  21. #include <openssl/x509_vfy.h>
  22. typedef x509_lookup_method_st X509_LOOKUP_METHOD;
  23. X509_LOOKUP_METHOD *X509_LOOKUP_meth_new(const char *name);
  24. void X509_LOOKUP_meth_free(X509_LOOKUP_METHOD *method);
  25. int X509_LOOKUP_meth_set_new_item(X509_LOOKUP_METHOD *method,
  26. int (*new_item) (X509_LOOKUP *ctx));
  27. int (*X509_LOOKUP_meth_get_new_item(const X509_LOOKUP_METHOD* method))
  28. (X509_LOOKUP *ctx);
  29. int X509_LOOKUP_meth_set_free(X509_LOOKUP_METHOD *method,
  30. void (*free) (X509_LOOKUP *ctx));
  31. void (*X509_LOOKUP_meth_get_free(const X509_LOOKUP_METHOD* method))
  32. (X509_LOOKUP *ctx);
  33. int X509_LOOKUP_meth_set_init(X509_LOOKUP_METHOD *method,
  34. int (*init) (X509_LOOKUP *ctx));
  35. int (*X509_LOOKUP_meth_get_init(const X509_LOOKUP_METHOD* method))
  36. (X509_LOOKUP *ctx);
  37. int X509_LOOKUP_meth_set_shutdown(X509_LOOKUP_METHOD *method,
  38. int (*shutdown) (X509_LOOKUP *ctx));
  39. int (*X509_LOOKUP_meth_get_shutdown(const X509_LOOKUP_METHOD* method))
  40. (X509_LOOKUP *ctx);
  41. typedef int (*X509_LOOKUP_ctrl_fn)(X509_LOOKUP *ctx, int cmd, const char *argc,
  42. long argl, char **ret);
  43. int X509_LOOKUP_meth_set_ctrl(X509_LOOKUP_METHOD *method,
  44. X509_LOOKUP_ctrl_fn ctrl_fn);
  45. X509_LOOKUP_ctrl_fn X509_LOOKUP_meth_get_ctrl(const X509_LOOKUP_METHOD *method);
  46. typedef int (*X509_LOOKUP_get_by_subject_fn)(X509_LOOKUP *ctx,
  47. X509_LOOKUP_TYPE type,
  48. X509_NAME *name,
  49. X509_OBJECT *ret);
  50. int X509_LOOKUP_meth_set_get_by_subject(X509_LOOKUP_METHOD *method,
  51. X509_LOOKUP_get_by_subject_fn fn);
  52. X509_LOOKUP_get_by_subject_fn X509_LOOKUP_meth_get_get_by_subject(
  53. const X509_LOOKUP_METHOD *method);
  54. typedef int (*X509_LOOKUP_get_by_issuer_serial_fn)(X509_LOOKUP *ctx,
  55. X509_LOOKUP_TYPE type,
  56. X509_NAME *name,
  57. ASN1_INTEGER *serial,
  58. X509_OBJECT *ret);
  59. int X509_LOOKUP_meth_set_get_by_issuer_serial(
  60. X509_LOOKUP_METHOD *method, X509_LOOKUP_get_by_issuer_serial_fn fn);
  61. X509_LOOKUP_get_by_issuer_serial_fn X509_LOOKUP_meth_get_get_by_issuer_serial(
  62. const X509_LOOKUP_METHOD *method);
  63. typedef int (*X509_LOOKUP_get_by_fingerprint_fn)(X509_LOOKUP *ctx,
  64. X509_LOOKUP_TYPE type,
  65. const unsigned char* bytes,
  66. int len,
  67. X509_OBJECT *ret);
  68. int X509_LOOKUP_meth_set_get_by_fingerprint(X509_LOOKUP_METHOD *method,
  69. X509_LOOKUP_get_by_fingerprint_fn fn);
  70. X509_LOOKUP_get_by_fingerprint_fn X509_LOOKUP_meth_get_get_by_fingerprint(
  71. const X509_LOOKUP_METHOD *method);
  72. typedef int (*X509_LOOKUP_get_by_alias_fn)(X509_LOOKUP *ctx,
  73. X509_LOOKUP_TYPE type,
  74. const char *str,
  75. int len,
  76. X509_OBJECT *ret);
  77. int X509_LOOKUP_meth_set_get_by_alias(X509_LOOKUP_METHOD *method,
  78. X509_LOOKUP_get_by_alias_fn fn);
  79. X509_LOOKUP_get_by_alias_fn X509_LOOKUP_meth_get_get_by_alias(
  80. const X509_LOOKUP_METHOD *method);
  81. int X509_OBJECT_set1_X509(X509_OBJECT *a, X509 *obj);
  82. int X509_OBJECT_set1_X509_CRL(X509_OBJECT *a, X509_CRL *obj);
  83. =head1 DESCRIPTION
  84. The B<X509_LOOKUP_METHOD> type is a structure used for the implementation of new
  85. X509_LOOKUP types. It provides a set of functions used by OpenSSL for the
  86. implementation of various X509 and X509_CRL lookup capabilities. One instance
  87. of an X509_LOOKUP_METHOD can be associated to many instantiations of an
  88. B<X509_LOOKUP> structure.
  89. X509_LOOKUP_meth_new() creates a new B<X509_LOOKUP_METHOD> structure. It should
  90. be given a human-readable string containing a brief description of the lookup
  91. method.
  92. X509_LOOKUP_meth_free() destroys a B<X509_LOOKUP_METHOD> structure.
  93. X509_LOOKUP_get_new_item() and X509_LOOKUP_set_new_item() get and set the
  94. function that is called when an B<X509_LOOKUP> object is created with
  95. X509_LOOKUP_new(). If an X509_LOOKUP_METHOD requires any per-X509_LOOKUP
  96. specific data, the supplied new_item function should allocate this data and
  97. invoke L<X509_LOOKUP_set_method_data(3)>.
  98. X509_LOOKUP_get_free() and X509_LOOKUP_set_free() get and set the function
  99. that is used to free any method data that was allocated and set from within
  100. new_item function.
  101. X509_LOOKUP_meth_get_init() and X509_LOOKUP_meth_set_init() get and set the
  102. function that is used to initialize the method data that was set with
  103. L<X509_LOOKUP_set_method_data(3)> as part of the new_item routine.
  104. X509_LOOKUP_meth_get_shutdown() and X509_LOOKUP_meth_set_shutdown() get and set
  105. the function that is used to shut down the method data whose state was
  106. previously initialized in the init function.
  107. X509_LOOKUP_meth_get_ctrl() and X509_LOOKUP_meth_set_ctrl() get and set a
  108. function to be used to handle arbitrary control commands issued by
  109. X509_LOOKUP_ctrl(). The control function is given the X509_LOOKUP
  110. B<ctx>, along with the arguments passed by X509_LOOKUP_ctrl. B<cmd> is
  111. an arbitrary integer that defines some operation. B<argc> is a pointer
  112. to an array of characters. B<argl> is an integer. B<ret>, if set,
  113. points to a location where any return data should be written to. How
  114. B<argc> and B<argl> are used depends entirely on the control function.
  115. X509_LOOKUP_set_get_by_subject(), X509_LOOKUP_set_get_by_issuer_serial(),
  116. X509_LOOKUP_set_get_by_fingerprint(), X509_LOOKUP_set_get_by_alias() set
  117. the functions used to retrieve an X509 or X509_CRL object by the object's
  118. subject, issuer, fingerprint, and alias respectively. These functions are given
  119. the X509_LOOKUP context, the type of the X509_OBJECT being requested, parameters
  120. related to the lookup, and an X509_OBJECT that will receive the requested
  121. object.
  122. Implementations must add objects they find to the B<X509_STORE> object
  123. using X509_STORE_add_cert() or X509_STORE_add_crl(). This increments
  124. its reference count. However, the X509_STORE_CTX_get_by_subject()
  125. function also increases the reference count which leads to one too
  126. many references being held. Therefore applications should
  127. additionally call X509_free() or X509_CRL_free() to decrement the
  128. reference count again.
  129. Implementations should also use either X509_OBJECT_set1_X509() or
  130. X509_OBJECT_set1_X509_CRL() to set the result. Note that this also
  131. increments the result's reference count.
  132. Any method data that was created as a result of the new_item function
  133. set by X509_LOOKUP_meth_set_new_item() can be accessed with
  134. L<X509_LOOKUP_get_method_data(3)>. The B<X509_STORE> object that owns the
  135. X509_LOOKUP may be accessed with L<X509_LOOKUP_get_store(3)>. Successful
  136. lookups should return 1, and unsuccessful lookups should return 0.
  137. X509_LOOKUP_get_get_by_subject(), X509_LOOKUP_get_get_by_issuer_serial(),
  138. X509_LOOKUP_get_get_by_fingerprint(), X509_LOOKUP_get_get_by_alias() retrieve
  139. the function set by the corresponding setter.
  140. =head1 RETURN VALUES
  141. The B<X509_LOOKUP_meth_set> functions return 1 on success or 0 on error.
  142. The B<X509_LOOKUP_meth_get> functions return the corresponding function
  143. pointers.
  144. =head1 SEE ALSO
  145. L<X509_STORE_new(3)>, L<SSL_CTX_set_cert_store(3)>
  146. =head1 HISTORY
  147. The functions described here were added in OpenSSL 1.1.0i.
  148. =head1 COPYRIGHT
  149. Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
  150. Licensed under the Apache License 2.0 (the "License"). You may not use
  151. this file except in compliance with the License. You can obtain a copy
  152. in the file LICENSE in the source distribution or at
  153. L<https://www.openssl.org/source/license.html>.
  154. =cut