source4/libcli/ldap/ldap_client.h

   1 /*
   2    Unix SMB/CIFS Implementation.
   3
   4    ldap client side header
   5
   6    Copyright (C) Andrew Tridgell 2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22
  23 #include "system/network.h" /* for struct iovec */
  24 #include "libcli/ldap/libcli_ldap.h"
  25
  26 enum ldap_request_state { LDAP_REQUEST_SEND=1, LDAP_REQUEST_PENDING=2, LDAP_REQUEST_DONE=3, LDAP_REQUEST_ERROR=4 };
  27
  28 /* this is the handle that the caller gets when an async ldap message
  29    is sent */
  30 struct ldap_request {
  31         struct ldap_request *next, *prev;
  32         struct ldap_connection *conn;
  33
  34         enum ldap_request_tag type;
  35         int messageid;
  36         enum ldap_request_state state;
  37
  38         int num_replies;
  39         struct ldap_message **replies;
  40
  41         NTSTATUS status;
  42         DATA_BLOB data;
  43         struct iovec write_iov;
  44
  45         struct {
  46                 void (*fn)(struct ldap_request *);
  47                 void *private_data;
  48         } async;
  49
  50         struct tevent_timer *time_event;
  51 };
  52
  53
  54 /* main context for a ldap client connection */
  55 struct ldap_connection {
  56         struct {
  57                 struct tstream_context *raw;
  58                 struct tstream_context *tls;
  59                 struct tstream_context *sasl;
  60                 struct tstream_context *active;
  61
  62                 struct tevent_queue *send_queue;
  63                 struct tevent_req *recv_subreq;
  64         } sockets;
  65
  66         struct loadparm_context *lp_ctx;
  67
  68         char *host;
  69         uint16_t port;
  70         bool ldaps;
  71         bool starttls;
  72
  73         const char *auth_dn;
  74         const char *simple_pw;
  75
  76         struct {
  77                 char *url;
  78                 int max_retries;
  79                 int retries;
  80                 time_t previous;
  81         } reconnect;
  82
  83         struct {
  84                 enum { LDAP_BIND_SIMPLE, LDAP_BIND_SASL } type;
  85                 void *creds;
  86         } bind;
  87
  88         /* next message id to assign */
  89         unsigned next_messageid;
  90
  91         /* Outstanding LDAP requests that have not yet been replied to */
  92         struct ldap_request *pending;
  93
  94         /* Let's support SASL */
  95         struct gensec_security *gensec;
  96
  97         /* the default timeout for messages */
  98         int timeout;
  99
 100         /* last error message */
 101         char *last_error;
 102
 103         struct {
 104                 struct tevent_context *event_ctx;
 105         } event;
 106 };
 107
 108 struct ldap_connection *ldap4_new_connection(TALLOC_CTX *mem_ctx,
 109                                              struct loadparm_context *lp_ctx,
 110                                              struct tevent_context *ev);
 111
 112 NTSTATUS ldap_connect(struct ldap_connection *conn, const char *url);
 113 struct composite_context *ldap_connect_send(struct ldap_connection *conn,
 114                                             const char *url);
 115
 116 NTSTATUS ldap_rebind(struct ldap_connection *conn);
 117 NTSTATUS ldap_bind_simple(struct ldap_connection *conn,
 118                           const char *userdn, const char *password);
 119 NTSTATUS ldap_bind_sasl(struct ldap_connection *conn,
 120                         struct cli_credentials *creds,
 121                         struct loadparm_context *lp_ctx);
 122 struct ldap_request *ldap_request_send(struct ldap_connection *conn,
 123                                        struct ldap_message *msg);
 124 NTSTATUS ldap_request_wait(struct ldap_request *req);
 125 struct composite_context;
 126 NTSTATUS ldap_connect_recv(struct composite_context *ctx);
 127 NTSTATUS ldap_result_n(struct ldap_request *req, int n, struct ldap_message **msg);
 128 NTSTATUS ldap_result_one(struct ldap_request *req, struct ldap_message **msg, int type);
 129 NTSTATUS ldap_transaction(struct ldap_connection *conn, struct ldap_message *msg);
 130 const char *ldap_errstr(struct ldap_connection *conn,
 131                         TALLOC_CTX *mem_ctx,
 132                         NTSTATUS status);
 133 NTSTATUS ldap_check_response(struct ldap_connection *conn, struct ldap_Result *r);
 134 void ldap_set_reconn_params(struct ldap_connection *conn, int max_retries);
 135 int ildap_count_entries(struct ldap_connection *conn, struct ldap_message **res);
 136 NTSTATUS ildap_search_bytree(struct ldap_connection *conn, const char *basedn,
 137                              int scope, struct ldb_parse_tree *tree,
 138                              const char * const *attrs, bool attributesonly,
 139                              struct ldb_control **control_req,
 140                              struct ldb_control ***control_res,
 141                              struct ldap_message ***results);
 142 NTSTATUS ildap_search(struct ldap_connection *conn, const char *basedn,
 143                       int scope, const char *expression,
 144                       const char * const *attrs, bool attributesonly,
 145                       struct ldb_control **control_req,
 146                       struct ldb_control ***control_res,
 147                       struct ldap_message ***results);
 148
 149
 150