apr_ldap.h 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. /* Licensed to the Apache Software Foundation (ASF) under one or more
  2. * contributor license agreements. See the NOTICE file distributed with
  3. * this work for additional information regarding copyright ownership.
  4. * The ASF licenses this file to You under the Apache License, Version 2.0
  5. * (the "License"); you may not use this file except in compliance with
  6. * the License. You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /*
  17. * apr_ldap.h is generated from apr_ldap.h.in by configure -- do not edit apr_ldap.h
  18. */
  19. /**
  20. * @file apr_ldap.h
  21. * @brief APR-UTIL LDAP
  22. */
  23. #ifndef APU_LDAP_H
  24. #define APU_LDAP_H
  25. /**
  26. * @defgroup APR_Util_LDAP LDAP
  27. * @ingroup APR_Util
  28. * @{
  29. */
  30. /* this will be defined if LDAP support was compiled into apr-util */
  31. #define APR_HAS_LDAP 0
  32. /* identify the LDAP toolkit used */
  33. #define APR_HAS_NETSCAPE_LDAPSDK 0
  34. #define APR_HAS_SOLARIS_LDAPSDK 0
  35. #define APR_HAS_NOVELL_LDAPSDK 0
  36. #define APR_HAS_MOZILLA_LDAPSDK 0
  37. #define APR_HAS_OPENLDAP_LDAPSDK 0
  38. #define APR_HAS_MICROSOFT_LDAPSDK 0
  39. #define APR_HAS_TIVOLI_LDAPSDK 0
  40. #define APR_HAS_ZOS_LDAPSDK 0
  41. #define APR_HAS_OTHER_LDAPSDK 0
  42. /*
  43. * Handle the case when LDAP is enabled
  44. */
  45. #if APR_HAS_LDAP
  46. /*
  47. * The following #defines are DEPRECATED and should not be used for
  48. * anything. They remain to maintain binary compatibility.
  49. * The original code defined the OPENLDAP SDK as present regardless
  50. * of what really was there, which was way bogus. In addition, the
  51. * apr_ldap_url_parse*() functions have been rewritten specifically for
  52. * APR, so the APR_HAS_LDAP_URL_PARSE macro is forced to zero.
  53. */
  54. #if APR_HAS_TIVOLI_LDAPSDK
  55. #define APR_HAS_LDAP_SSL 0
  56. #else
  57. #define APR_HAS_LDAP_SSL 1
  58. #endif
  59. #define APR_HAS_LDAP_URL_PARSE 0
  60. #if APR_HAS_OPENLDAP_LDAPSDK && !defined(LDAP_DEPRECATED)
  61. /* Ensure that the "deprecated" interfaces are still exposed
  62. * with OpenLDAP >= 2.3; these were exposed by default in earlier
  63. * releases. */
  64. #define LDAP_DEPRECATED 1
  65. #endif
  66. /*
  67. * Include the standard LDAP header files.
  68. */
  69. /*
  70. * Detected standard functions
  71. */
  72. #define APR_HAS_LDAPSSL_CLIENT_INIT 0
  73. #define APR_HAS_LDAPSSL_CLIENT_DEINIT 0
  74. #define APR_HAS_LDAPSSL_ADD_TRUSTED_CERT 0
  75. #define APR_HAS_LDAP_START_TLS_S 0
  76. #define APR_HAS_LDAP_SSLINIT 0
  77. #define APR_HAS_LDAPSSL_INIT 0
  78. #define APR_HAS_LDAPSSL_INSTALL_ROUTINES 0
  79. /*
  80. * Make sure the secure LDAP port is defined
  81. */
  82. #ifndef LDAPS_PORT
  83. #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
  84. #endif
  85. /*
  86. * For ldap function calls that input a size limit on the number of returned elements
  87. * Some SDKs do not have the define for LDAP_DEFAULT_LIMIT (-1) or LDAP_NO_LIMIT (0)
  88. * LDAP_DEFAULT_LIMIT is preferred as it allows inheritance from whatever the SDK
  89. * or process is configured for.
  90. */
  91. #ifdef LDAP_DEFAULT_LIMIT
  92. #define APR_LDAP_SIZELIMIT LDAP_DEFAULT_LIMIT
  93. #else
  94. #ifdef LDAP_NO_LIMIT
  95. #define APR_LDAP_SIZELIMIT LDAP_NO_LIMIT
  96. #endif
  97. #endif
  98. #ifndef APR_LDAP_SIZELIMIT
  99. #define APR_LDAP_SIZELIMIT 0 /* equivalent to LDAP_NO_LIMIT, and what goes on the wire */
  100. #endif
  101. /*
  102. * z/OS is missing some defines
  103. */
  104. #ifndef LDAP_VERSION_MAX
  105. #define LDAP_VERSION_MAX LDAP_VERSION
  106. #endif
  107. #if APR_HAS_ZOS_LDAPSDK
  108. #define LDAP_VENDOR_NAME "IBM z/OS"
  109. #endif
  110. /* Note: Macros defining const casting has been removed in APR v1.0,
  111. * pending real support for LDAP v2.0 toolkits.
  112. *
  113. * In the mean time, please use an LDAP v3.0 toolkit.
  114. */
  115. #if LDAP_VERSION_MAX <= 2
  116. #error Support for LDAP v2.0 toolkits has been removed from apr-util. Please use an LDAP v3.0 toolkit.
  117. #endif
  118. #ifdef __cplusplus
  119. extern "C" {
  120. #endif /* __cplusplus */
  121. /**
  122. * This structure allows the C LDAP API error codes to be returned
  123. * along with plain text error messages that explain to us mere mortals
  124. * what really happened.
  125. */
  126. typedef struct apr_ldap_err_t {
  127. const char *reason;
  128. const char *msg;
  129. int rc;
  130. } apr_ldap_err_t;
  131. #ifdef __cplusplus
  132. }
  133. #endif
  134. /* The MS SDK returns LDAP_UNAVAILABLE when the backend has closed the connection
  135. * between LDAP calls. Protect with APR_HAS_MICROSOFT_LDAPSDK in case someone
  136. * manually chooses another SDK on Windows
  137. */
  138. #if APR_HAS_MICROSOFT_LDAPSDK
  139. #define APR_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN \
  140. || (s) == LDAP_UNAVAILABLE)
  141. #else
  142. #define APR_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN)
  143. #endif
  144. /* These symbols are not actually exported in a DSO build, but mapped into
  145. * a private exported function array for apr_ldap_stub to bind dynamically.
  146. * Rename them appropriately to protect the global namespace.
  147. */
  148. #ifdef APU_DSO_LDAP_BUILD
  149. #define apr_ldap_info apr__ldap_info
  150. #define apr_ldap_init apr__ldap_init
  151. #define apr_ldap_ssl_init apr__ldap_ssl_init
  152. #define apr_ldap_ssl_deinit apr__ldap_ssl_deinit
  153. #define apr_ldap_get_option apr__ldap_get_option
  154. #define apr_ldap_set_option apr__ldap_set_option
  155. #define apr_ldap_rebind_init apr__ldap_rebind_init
  156. #define apr_ldap_rebind_add apr__ldap_rebind_add
  157. #define apr_ldap_rebind_remove apr__ldap_rebind_remove
  158. #define APU_DECLARE_LDAP(type) type
  159. #else
  160. #define APU_DECLARE_LDAP(type) APU_DECLARE(type)
  161. #endif
  162. #include "apr_ldap_url.h"
  163. #include "apr_ldap_init.h"
  164. #include "apr_ldap_option.h"
  165. #include "apr_ldap_rebind.h"
  166. #endif /* APR_HAS_LDAP */
  167. /** @} */
  168. #endif /* APU_LDAP_H */