source3/include/tldap.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Infrastructure for async ldap client requests
   4    Copyright (C) Volker Lendecke 2009
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __TLDAP_H__
  21 #define __TLDAP_H__
  22
  23 #include "replace.h"
  24 #include <talloc.h>
  25 #include <tevent.h>
  26 #include "lib/util/data_blob.h"
  27
  28 struct tldap_context;
  29 struct tldap_message;
  30
  31 struct tldap_control {
  32         const char *oid;
  33         DATA_BLOB value;
  34         bool critical;
  35 };
  36
  37 struct tldap_attribute {
  38         char *name;
  39         int num_values;
  40         DATA_BLOB *values;
  41 };
  42
  43 struct tldap_mod {
  44         int mod_op;
  45         char *attribute;
  46         int num_values;
  47         DATA_BLOB *values;
  48 };
  49
  50 #if defined(HAVE_IMMEDIATE_STRUCTURES)
  51 typedef struct { uint8_t rc; } TLDAPRC;
  52 #define TLDAP_RC(x) ((TLDAPRC){.rc = x})
  53 #define TLDAP_RC_V(x) ((x).rc)
  54 #else
  55 typedef uint8_t TLDAPRC;
  56 #define TLDAP_RC(x) (x)
  57 #define TLDAP_RC_V(x) (x)
  58 #endif
  59
  60 #define TLDAP_RC_EQUAL(x,y) (TLDAP_RC_V(x)==TLDAP_RC_V(y))
  61 #define TLDAP_RC_IS_SUCCESS(x) TLDAP_RC_EQUAL(x,TLDAP_SUCCESS)
  62
  63 #define TLDAP_SUCCESS TLDAP_RC(0x00)
  64 #define TLDAP_OPERATIONS_ERROR TLDAP_RC(0x01)
  65 #define TLDAP_PROTOCOL_ERROR TLDAP_RC(0x02)
  66 #define TLDAP_TIMELIMIT_EXCEEDED TLDAP_RC(0x03)
  67 #define TLDAP_SIZELIMIT_EXCEEDED TLDAP_RC(0x04)
  68 #define TLDAP_COMPARE_FALSE TLDAP_RC(0x05)
  69 #define TLDAP_COMPARE_TRUE TLDAP_RC(0x06)
  70 #define TLDAP_STRONG_AUTH_NOT_SUPPORTED TLDAP_RC(0x07)
  71 #define TLDAP_STRONG_AUTH_REQUIRED TLDAP_RC(0x08)
  72 #define TLDAP_REFERRAL TLDAP_RC(0x0a)
  73 #define TLDAP_ADMINLIMIT_EXCEEDED TLDAP_RC(0x0b)
  74 #define TLDAP_UNAVAILABLE_CRITICAL_EXTENSION TLDAP_RC(0x0c)
  75 #define TLDAP_CONFIDENTIALITY_REQUIRED TLDAP_RC(0x0d)
  76 #define TLDAP_SASL_BIND_IN_PROGRESS TLDAP_RC(0x0e)
  77 #define TLDAP_NO_SUCH_ATTRIBUTE TLDAP_RC(0x10)
  78 #define TLDAP_UNDEFINED_TYPE TLDAP_RC(0x11)
  79 #define TLDAP_INAPPROPRIATE_MATCHING TLDAP_RC(0x12)
  80 #define TLDAP_CONSTRAINT_VIOLATION TLDAP_RC(0x13)
  81 #define TLDAP_TYPE_OR_VALUE_EXISTS TLDAP_RC(0x14)
  82 #define TLDAP_INVALID_SYNTAX TLDAP_RC(0x15)
  83 #define TLDAP_NO_SUCH_OBJECT TLDAP_RC(0x20)
  84 #define TLDAP_ALIAS_PROBLEM TLDAP_RC(0x21)
  85 #define TLDAP_INVALID_DN_SYNTAX TLDAP_RC(0x22)
  86 #define TLDAP_IS_LEAF TLDAP_RC(0x23)
  87 #define TLDAP_ALIAS_DEREF_PROBLEM TLDAP_RC(0x24)
  88 #define TLDAP_INAPPROPRIATE_AUTH TLDAP_RC(0x30)
  89 #define TLDAP_INVALID_CREDENTIALS TLDAP_RC(0x31)
  90 #define TLDAP_INSUFFICIENT_ACCESS TLDAP_RC(0x32)
  91 #define TLDAP_BUSY TLDAP_RC(0x33)
  92 #define TLDAP_UNAVAILABLE TLDAP_RC(0x34)
  93 #define TLDAP_UNWILLING_TO_PERFORM TLDAP_RC(0x35)
  94 #define TLDAP_LOOP_DETECT TLDAP_RC(0x36)
  95 #define TLDAP_NAMING_VIOLATION TLDAP_RC(0x40)
  96 #define TLDAP_OBJECT_CLASS_VIOLATION TLDAP_RC(0x41)
  97 #define TLDAP_NOT_ALLOWED_ON_NONLEAF TLDAP_RC(0x42)
  98 #define TLDAP_NOT_ALLOWED_ON_RDN TLDAP_RC(0x43)
  99 #define TLDAP_ALREADY_EXISTS TLDAP_RC(0x44)
 100 #define TLDAP_NO_OBJECT_CLASS_MODS TLDAP_RC(0x45)
 101 #define TLDAP_RESULTS_TOO_LARGE TLDAP_RC(0x46)
 102 #define TLDAP_AFFECTS_MULTIPLE_DSAS TLDAP_RC(0x47)
 103 #define TLDAP_OTHER TLDAP_RC(0x50)
 104 #define TLDAP_SERVER_DOWN TLDAP_RC(0x51)
 105 #define TLDAP_LOCAL_ERROR TLDAP_RC(0x52)
 106 #define TLDAP_ENCODING_ERROR TLDAP_RC(0x53)
 107 #define TLDAP_DECODING_ERROR TLDAP_RC(0x54)
 108 #define TLDAP_TIMEOUT TLDAP_RC(0x55)
 109 #define TLDAP_AUTH_UNKNOWN TLDAP_RC(0x56)
 110 #define TLDAP_FILTER_ERROR TLDAP_RC(0x57)
 111 #define TLDAP_USER_CANCELLED TLDAP_RC(0x58)
 112 #define TLDAP_PARAM_ERROR TLDAP_RC(0x59)
 113 #define TLDAP_NO_MEMORY TLDAP_RC(0x5a)
 114 #define TLDAP_CONNECT_ERROR TLDAP_RC(0x5b)
 115 #define TLDAP_NOT_SUPPORTED TLDAP_RC(0x5c)
 116 #define TLDAP_CONTROL_NOT_FOUND TLDAP_RC(0x5d)
 117 #define TLDAP_NO_RESULTS_RETURNED TLDAP_RC(0x5e)
 118 #define TLDAP_MORE_RESULTS_TO_RETURN TLDAP_RC(0x5f)
 119 #define TLDAP_CLIENT_LOOP TLDAP_RC(0x60)
 120 #define TLDAP_REFERRAL_LIMIT_EXCEEDED TLDAP_RC(0x61)
 121
 122 bool tevent_req_ldap_error(struct tevent_req *req, TLDAPRC rc);
 123 bool tevent_req_is_ldap_error(struct tevent_req *req, TLDAPRC *perr);
 124
 125 struct tldap_context *tldap_context_create(TALLOC_CTX *mem_ctx, int fd);
 126 struct tstream_context *tldap_get_plain_tstream(struct tldap_context *ld);
 127 bool tldap_has_gensec_tstream(struct tldap_context *ld);
 128 void tldap_set_gensec_tstream(struct tldap_context *ld,
 129                               struct tstream_context **stream);
 130
 131 bool tldap_connection_ok(struct tldap_context *ld);
 132 bool tldap_context_setattr(struct tldap_context *ld,
 133                            const char *name, const void *pptr);
 134 void *tldap_context_getattr(struct tldap_context *ld, const char *name);
 135
 136 struct tevent_req *tldap_sasl_bind_send(TALLOC_CTX *mem_ctx,
 137                                         struct tevent_context *ev,
 138                                         struct tldap_context *ld,
 139                                         const char *dn,
 140                                         const char *mechanism,
 141                                         DATA_BLOB *creds,
 142                                         struct tldap_control *sctrls,
 143                                         int num_sctrls,
 144                                         struct tldap_control *cctrls,
 145                                         int num_cctrls);
 146 TLDAPRC tldap_sasl_bind_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 147                              DATA_BLOB *serverSaslCreds);
 148 TLDAPRC tldap_sasl_bind(struct tldap_context *ldap,
 149                         const char *dn,
 150                         const char *mechanism,
 151                         DATA_BLOB *creds,
 152                         struct tldap_control *sctrls,
 153                         int num_sctrls,
 154                         struct tldap_control *cctrls,
 155                         int num_cctrls,
 156                         TALLOC_CTX *mem_ctx,
 157                         DATA_BLOB *serverSaslCreds);
 158
 159 struct tevent_req *tldap_simple_bind_send(TALLOC_CTX *mem_ctx,
 160                                           struct tevent_context *ev,
 161                                           struct tldap_context *ldap,
 162                                           const char *dn,
 163                                           const char *passwd);
 164 TLDAPRC tldap_simple_bind_recv(struct tevent_req *req);
 165 TLDAPRC tldap_simple_bind(struct tldap_context *ldap, const char *dn,
 166                           const char *passwd);
 167
 168 struct tevent_req *tldap_search_send(TALLOC_CTX *mem_ctx,
 169                                      struct tevent_context *ev,
 170                                      struct tldap_context *ld,
 171                                      const char *base, int scope,
 172                                      const char *filter,
 173                                      const char **attrs,
 174                                      int num_attrs,
 175                                      int attrsonly,
 176                                      struct tldap_control *sctrls,
 177                                      int num_sctrls,
 178                                      struct tldap_control *cctrls,
 179                                      int num_cctrls,
 180                                      int timelimit,
 181                                      int sizelimit,
 182                                      int deref);
 183 TLDAPRC tldap_search_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 184                           struct tldap_message **pmsg);
 185
 186 struct tevent_req *tldap_search_all_send(
 187         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 188         struct tldap_context *ld, const char *base, int scope,
 189         const char *filter, const char **attrs, int num_attrs, int attrsonly,
 190         struct tldap_control *sctrls, int num_sctrls,
 191         struct tldap_control *cctrls, int num_cctrls,
 192         int timelimit, int sizelimit, int deref);
 193 TLDAPRC tldap_search_all_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 194                               struct tldap_message ***msgs,
 195                               struct tldap_message **result);
 196
 197 TLDAPRC tldap_search(struct tldap_context *ld,
 198                      const char *base, int scope, const char *filter,
 199                      const char **attrs, int num_attrs, int attrsonly,
 200                      struct tldap_control *sctrls, int num_sctrls,
 201                      struct tldap_control *cctrls, int num_cctrls,
 202                      int timelimit, int sizelimit, int deref,
 203                      TALLOC_CTX *mem_ctx, struct tldap_message ***pmsgs);
 204
 205 bool tldap_entry_dn(struct tldap_message *msg, char **dn);
 206 bool tldap_entry_attributes(struct tldap_message *msg,
 207                             struct tldap_attribute **attributes,
 208                             int *num_attributes);
 209
 210 struct tevent_req *tldap_add_send(TALLOC_CTX *mem_ctx,
 211                                   struct tevent_context *ev,
 212                                   struct tldap_context *ld,
 213                                   const char *dn,
 214                                   struct tldap_mod *attributes,
 215                                   int num_attributes,
 216                                   struct tldap_control *sctrls,
 217                                   int num_sctrls,
 218                                   struct tldap_control *cctrls,
 219                                   int num_cctrls);
 220 TLDAPRC tldap_add_recv(struct tevent_req *req);
 221 TLDAPRC tldap_add(struct tldap_context *ld, const char *dn,
 222                   struct tldap_mod *attributes, int num_attributes,
 223                   struct tldap_control *sctrls, int num_sctrls,
 224                   struct tldap_control *cctrls, int num_cctrls);
 225
 226 struct tevent_req *tldap_modify_send(TALLOC_CTX *mem_ctx,
 227                                      struct tevent_context *ev,
 228                                      struct tldap_context *ld,
 229                                      const char *dn,
 230                                      struct tldap_mod *mods, int num_mods,
 231                                      struct tldap_control *sctrls,
 232                                      int num_sctrls,
 233                                      struct tldap_control *cctrls,
 234                                      int num_cctrls);
 235 TLDAPRC tldap_modify_recv(struct tevent_req *req);
 236 TLDAPRC tldap_modify(struct tldap_context *ld, const char *dn,
 237                      struct tldap_mod *mods, int num_mods,
 238                      struct tldap_control *sctrls, int num_sctrls,
 239                      struct tldap_control *cctrls, int num_cctrls);
 240
 241 struct tevent_req *tldap_delete_send(TALLOC_CTX *mem_ctx,
 242                                      struct tevent_context *ev,
 243                                      struct tldap_context *ld,
 244                                      const char *dn,
 245                                      struct tldap_control *sctrls,
 246                                      int num_sctrls,
 247                                      struct tldap_control *cctrls,
 248                                      int num_cctrls);
 249 TLDAPRC tldap_delete_recv(struct tevent_req *req);
 250 TLDAPRC tldap_delete(struct tldap_context *ld, const char *dn,
 251                      struct tldap_control *sctrls, int num_sctrls,
 252                      struct tldap_control *cctrls, int num_cctrls);
 253
 254 int tldap_msg_id(const struct tldap_message *msg);
 255 int tldap_msg_type(const struct tldap_message *msg);
 256 const char *tldap_msg_matcheddn(struct tldap_message *msg);
 257 const char *tldap_msg_diagnosticmessage(struct tldap_message *msg);
 258 const char *tldap_msg_referral(struct tldap_message *msg);
 259 void tldap_msg_sctrls(struct tldap_message *msg, int *num_sctrls,
 260                       struct tldap_control **sctrls);
 261 struct tldap_message *tldap_ctx_lastmsg(struct tldap_context *ld);
 262 const char *tldap_rc2string(TLDAPRC rc);
 263
 264 /* DEBUG */
 265 enum tldap_debug_level {
 266         TLDAP_DEBUG_FATAL,
 267         TLDAP_DEBUG_ERROR,
 268         TLDAP_DEBUG_WARNING,
 269         TLDAP_DEBUG_TRACE
 270 };
 271
 272 void tldap_set_debug(struct tldap_context *ld,
 273                      void (*log_fn)(void *log_private,
 274                                     enum tldap_debug_level level,
 275                                     const char *fmt,
 276                                     va_list ap) PRINTF_ATTRIBUTE(3,0),
 277                      void *log_private);
 278
 279 /*
 280  * "+ 0x60" is from ASN1_APPLICATION
 281  */
 282 #define TLDAP_REQ_BIND (0 + 0x60)
 283 #define TLDAP_RES_BIND (1 + 0x60)
 284 #define TLDAP_REQ_UNBIND (2 + 0x60)
 285 #define TLDAP_REQ_SEARCH (3 + 0x60)
 286 #define TLDAP_RES_SEARCH_ENTRY (4 + 0x60)
 287 #define TLDAP_RES_SEARCH_RESULT (5 + 0x60)
 288 #define TLDAP_REQ_MODIFY (6 + 0x60)
 289 #define TLDAP_RES_MODIFY (7 + 0x60)
 290 #define TLDAP_REQ_ADD (8 + 0x60)
 291 #define TLDAP_RES_ADD (9 + 0x60)
 292 /* ASN1_APPLICATION_SIMPLE instead of ASN1_APPLICATION */
 293 #define TLDAP_REQ_DELETE (10 + 0x40)
 294 #define TLDAP_RES_DELETE (11 + 0x60)
 295 #define TLDAP_REQ_MODDN (12 + 0x60)
 296 #define TLDAP_RES_MODDN (13 + 0x60)
 297 #define TLDAP_REQ_COMPARE (14 + 0x60)
 298 #define TLDAP_RES_COMPARE (15 + 0x60)
 299 /* ASN1_APPLICATION_SIMPLE instead of ASN1_APPLICATION */
 300 #define TLDAP_REQ_ABANDON (16 + 0x40)
 301 #define TLDAP_RES_SEARCH_REFERENCE (19 + 0x60)
 302 #define TLDAP_REQ_EXTENDED (23 + 0x60)
 303 #define TLDAP_RES_EXTENDED (24 + 0x60)
 304 #define TLDAP_RES_INTERMEDIATE (25 + 0x60)
 305
 306 #define TLDAP_MOD_ADD (0)
 307 #define TLDAP_MOD_DELETE (1)
 308 #define TLDAP_MOD_REPLACE (2)
 309
 310 #define TLDAP_SCOPE_BASE (0)
 311 #define TLDAP_SCOPE_ONE (1)
 312 #define TLDAP_SCOPE_SUB (2)
 313
 314 #define TLDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319"
 315
 316 #endif