source4/lib/ldb_wrap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    LDB wrap functions
   5
   6    Copyright (C) Andrew Tridgell 2004-2009
   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   the stupidity of the unix fcntl locking design forces us to never
  24   allow a database file to be opened twice in the same process. These
  25   wrappers provide convenient access to a tdb or ldb, taking advantage
  26   of talloc destructors to ensure that only a single open is done
  27 */
  28
  29 #include "includes.h"
  30 #include "lib/events/events.h"
  31 #include "lib/ldb/include/ldb.h"
  32 #include "lib/ldb/include/ldb_errors.h"
  33 #include "lib/ldb-samba/ldif_handlers.h"
  34 #include "ldb_wrap.h"
  35 #include "dsdb/samdb/samdb.h"
  36 #include "param/param.h"
  37 #include "dlinklist.h"
  38
  39 /*
  40   this is used to catch debug messages from ldb
  41 */
  42 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  43                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
  44
  45 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  46                            const char *fmt, va_list ap)
  47 {
  48         int samba_level = -1;
  49         char *s = NULL;
  50         switch (level) {
  51         case LDB_DEBUG_FATAL:
  52                 samba_level = 0;
  53                 break;
  54         case LDB_DEBUG_ERROR:
  55                 samba_level = 1;
  56                 break;
  57         case LDB_DEBUG_WARNING:
  58                 samba_level = 2;
  59                 break;
  60         case LDB_DEBUG_TRACE:
  61                 samba_level = 5;
  62                 break;
  63
  64         };
  65         vasprintf(&s, fmt, ap);
  66         if (!s) return;
  67         DEBUG(samba_level, ("ldb: %s\n", s));
  68         free(s);
  69 }
  70
  71
  72 /*
  73   connecting to a ldb can be a relatively expensive operation because
  74   of the schema and partition loads. We keep a list of open ldb
  75   contexts here, and try to re-use when possible.
  76
  77   This means callers of ldb_wrap_connect() must use talloc_unlink() or
  78   the free of a parent to destroy the context
  79  */
  80 static struct ldb_wrap {
  81         struct ldb_wrap *next, *prev;
  82         struct ldb_wrap_context {
  83                 /* the context is what we use to tell if two ldb
  84                  * connections are exactly equivalent
  85                  */
  86                 const char *url;
  87                 struct tevent_context *ev;
  88                 struct loadparm_context *lp_ctx;
  89                 struct auth_session_info *session_info;
  90                 struct cli_credentials *credentials;
  91                 unsigned int flags;
  92         } context;
  93         struct ldb_context *ldb;
  94 } *ldb_wrap_list;
  95
  96 /*
  97   see if two database opens are equivalent
  98  */
  99 static bool ldb_wrap_same_context(const struct ldb_wrap_context *c1,
 100                                   const struct ldb_wrap_context *c2)
 101 {
 102         return (c1->ev == c2->ev &&
 103                 c1->lp_ctx == c2->lp_ctx &&
 104                 c1->session_info == c2->session_info &&
 105                 c1->credentials == c2->credentials &&
 106                 c1->flags == c2->flags &&
 107                 (c1->url == c2->url || strcmp(c1->url, c2->url) == 0));
 108 }
 109
 110 /*
 111    free a ldb_wrap structure
 112  */
 113 static int ldb_wrap_destructor(struct ldb_wrap *w)
 114 {
 115         DLIST_REMOVE(ldb_wrap_list, w);
 116         return 0;
 117 }
 118
 119 /*
 120   wrapped connection to a ldb database
 121   to close just talloc_free() the returned ldb_context
 122
 123   TODO:  We need an error_string parameter
 124  */
 125 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
 126                                      struct tevent_context *ev,
 127                                      struct loadparm_context *lp_ctx,
 128                                      const char *url,
 129                                      struct auth_session_info *session_info,
 130                                      struct cli_credentials *credentials,
 131                                      unsigned int flags)
 132 {
 133         struct ldb_context *ldb;
 134         int ret;
 135         char *real_url = NULL;
 136         struct ldb_wrap *w;
 137         struct ldb_wrap_context c;
 138
 139         c.url          = url;
 140         c.ev           = ev;
 141         c.lp_ctx       = lp_ctx;
 142         c.session_info = session_info;
 143         c.credentials  = credentials;
 144         c.flags        = flags;
 145
 146         /* see if we can re-use an existing ldb */
 147         for (w=ldb_wrap_list; w; w=w->next) {
 148                 if (ldb_wrap_same_context(&c, &w->context)) {
 149                         return talloc_reference(mem_ctx, w->ldb);
 150                 }
 151         }
 152
 153         /* we want to use the existing event context if possible. This
 154            relies on the fact that in smbd, everything is a child of
 155            the main event_context */
 156         if (ev == NULL) {
 157                 return NULL;
 158         }
 159
 160         ldb = ldb_init(mem_ctx, ev);
 161         if (ldb == NULL) {
 162                 return NULL;
 163         }
 164
 165         ldb_set_modules_dir(ldb,
 166                             talloc_asprintf(ldb,
 167                                             "%s/ldb",
 168                                             lp_modulesdir(lp_ctx)));
 169
 170         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
 171                 talloc_free(ldb);
 172                 return NULL;
 173         }
 174
 175         if (ldb_set_opaque(ldb, "credentials", credentials)) {
 176                 talloc_free(ldb);
 177                 return NULL;
 178         }
 179
 180         if (ldb_set_opaque(ldb, "loadparm", lp_ctx)) {
 181                 talloc_free(ldb);
 182                 return NULL;
 183         }
 184
 185         /* This must be done before we load the schema, as these
 186          * handlers for objectSid and objectGUID etc must take
 187          * precedence over the 'binary attribute' declaration in the
 188          * schema */
 189         ret = ldb_register_samba_handlers(ldb);
 190         if (ret == -1) {
 191                 talloc_free(ldb);
 192                 return NULL;
 193         }
 194
 195         if (lp_ctx != NULL && strcmp(lp_sam_url(lp_ctx), url) == 0) {
 196                 dsdb_set_global_schema(ldb);
 197         }
 198
 199         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 200
 201         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 202
 203         real_url = private_path(ldb, lp_ctx, url);
 204         if (real_url == NULL) {
 205                 talloc_free(ldb);
 206                 return NULL;
 207         }
 208
 209         /* allow admins to force non-sync ldb for all databases */
 210         if (lp_parm_bool(lp_ctx, NULL, "ldb", "nosync", false)) {
 211                 flags |= LDB_FLG_NOSYNC;
 212         }
 213
 214         if (DEBUGLVL(10)) {
 215                 flags |= LDB_FLG_ENABLE_TRACING;
 216         }
 217
 218         /* we usually want Samba databases to be private. If we later
 219            find we need one public, we will need to add a parameter to
 220            ldb_wrap_connect() */
 221         ldb_set_create_perms(ldb, 0600);
 222
 223         ret = ldb_connect(ldb, real_url, flags, NULL);
 224         if (ret != LDB_SUCCESS) {
 225                 talloc_free(ldb);
 226                 return NULL;
 227         }
 228
 229         /* setup for leak detection */
 230         ldb_set_opaque(ldb, "wrap_url", real_url);
 231
 232         /* add to the list of open ldb contexts */
 233         w = talloc(ldb, struct ldb_wrap);
 234         if (w == NULL) {
 235                 talloc_free(ldb);
 236                 return NULL;
 237         }
 238
 239         w->context = c;
 240         w->context.url = talloc_strdup(w, url);
 241         if (w->context.url == NULL) {
 242                 talloc_free(ldb);
 243                 return NULL;
 244         }
 245
 246         w->ldb = ldb;
 247
 248         DLIST_ADD(ldb_wrap_list, w);
 249
 250         DEBUG(3,("ldb_wrap open of %s\n", url));
 251
 252         talloc_set_destructor(w, ldb_wrap_destructor);
 253
 254         return ldb;
 255 }
 256
 257 /*
 258   when we fork() we need to make sure that any open ldb contexts have
 259   any open transactions cancelled
 260  */
 261 void ldb_wrap_fork_hook(void)
 262 {
 263
 264 }
 265