lib/ldb/tools/ldbdump.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    simple ldb tdb dump util
   4    Copyright (C) Andrew Tridgell              2001
   5    Copyright (C) Andrew Bartlett              2012
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "replace.h"
  22 #include "system/locale.h"
  23 #include "system/time.h"
  24 #include "system/filesys.h"
  25 #include "system/wait.h"
  26 #include <tdb.h>
  27 #include <ldb.h>
  28 #include <ldb_private.h>
  29
  30 #ifdef HAVE_LMDB
  31 #include <lmdb.h>
  32 #endif /* ifdef HAVE_LMDB */
  33
  34
  35 static struct ldb_context *ldb;
  36 bool show_index = false;
  37 bool validate_contents = false;
  38
  39 static int traverse_fn(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA _dbuf, void *state)
  40 {
  41         int ret, i, j;
  42         struct ldb_dn *dn = state;
  43         struct ldb_message *msg = talloc_zero(NULL, struct ldb_message);
  44         struct ldb_val dbuf = {
  45                 .data = _dbuf.dptr,
  46                 .length = _dbuf.dsize,
  47         };
  48         struct ldb_ldif ldif = {
  49                 .msg = msg,
  50                 .changetype = LDB_CHANGETYPE_NONE
  51         };
  52         if (!msg) {
  53                 return -1;
  54         }
  55
  56         ret = ldb_unpack_data(ldb, &dbuf, msg);
  57         if (ret != 0) {
  58                 fprintf(stderr, "Failed to parse record %*.*s as an LDB record\n", (int)key.dsize, (int)key.dsize, (char *)key.dptr);
  59                 TALLOC_FREE(msg);
  60                 return 0;
  61         }
  62
  63         if (dn && ldb_dn_compare(msg->dn, dn) != 0) {
  64                 TALLOC_FREE(msg);
  65                 return 0;
  66         }
  67
  68         if (!show_index && ldb_dn_is_special(msg->dn)) {
  69                 const char *dn_lin = ldb_dn_get_linearized(msg->dn);
  70                 if ((strcmp(dn_lin, "@BASEINFO") == 0) || (strncmp(dn_lin, "@INDEX:", strlen("@INDEX:")) == 0)) {
  71                         /*
  72                           the user has asked not to show index
  73                           records. Also exclude BASEINFO as it
  74                           contains meta-data which will be re-created
  75                           if this database is restored
  76                          */
  77                         TALLOC_FREE(msg);
  78                         return 0;
  79                 }
  80         }
  81
  82         if (!validate_contents || ldb_dn_is_special(msg->dn)) {
  83                 ldb_ldif_write_file(ldb, stdout, &ldif);
  84                 TALLOC_FREE(msg);
  85                 return 0;
  86         }
  87
  88         for (i=0;i<msg->num_elements;i++) {
  89                 const struct ldb_schema_attribute *a;
  90
  91                 a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name);
  92                 for (j=0;j<msg->elements[i].num_values;j++) {
  93                         struct ldb_val v;
  94                         ret = a->syntax->ldif_write_fn(ldb, msg, &msg->elements[i].values[j], &v);
  95                         if (ret != 0) {
  96                                 v = msg->elements[i].values[j];
  97                                 if (ldb_should_b64_encode(ldb, &v)) {
  98                                         v.data = (uint8_t *)ldb_base64_encode(ldb, (char *)v.data, v.length);
  99                                         v.length = strlen((char *)v.data);
 100                                 }
 101                                 fprintf(stderr, "On %s element %s value %d (%*.*s) failed to convert to LDIF correctly, skipping possibly corrupt record\n",
 102                                         ldb_dn_get_linearized(msg->dn),
 103                                         msg->elements[i].name,
 104                                         j, (int)v.length, (int)v.length,
 105                                         v.data);
 106                                 TALLOC_FREE(msg);
 107                                 return 0;
 108                         }
 109                 }
 110         }
 111         ldb_ldif_write_file(ldb, stdout, &ldif);
 112         TALLOC_FREE(msg);
 113
 114         return 0;
 115 }
 116
 117 static void log_stderr(struct tdb_context *tdb, enum tdb_debug_level level,
 118                        const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
 119
 120 static void log_stderr(struct tdb_context *tdb, enum tdb_debug_level level,
 121                        const char *fmt, ...)
 122 {
 123         va_list ap;
 124         const char *name = tdb_name(tdb);
 125         const char *prefix = "";
 126
 127         if (!name)
 128                 name = "unnamed";
 129
 130         switch (level) {
 131         case TDB_DEBUG_ERROR:
 132                 prefix = "ERROR: ";
 133                 break;
 134         case TDB_DEBUG_WARNING:
 135                 prefix = "WARNING: ";
 136                 break;
 137         case TDB_DEBUG_TRACE:
 138                 return;
 139
 140         default:
 141         case TDB_DEBUG_FATAL:
 142                 prefix = "FATAL: ";
 143                 break;
 144         }
 145
 146         va_start(ap, fmt);
 147         fprintf(stderr, "tdb(%s): %s", name, prefix);
 148         vfprintf(stderr, fmt, ap);
 149         va_end(ap);
 150 }
 151
 152 static void emergency_walk(TDB_DATA key, TDB_DATA dbuf, void *keyname)
 153 {
 154         traverse_fn(NULL, key, dbuf, keyname);
 155 }
 156
 157 static int dump_tdb(const char *fname, struct ldb_dn *dn, bool emergency)
 158 {
 159         TDB_CONTEXT *tdb;
 160         struct tdb_logging_context logfn = { log_stderr };
 161
 162         tdb = tdb_open_ex(fname, 0, 0, O_RDONLY, 0, &logfn, NULL);
 163         if (!tdb) {
 164                 fprintf(stderr, "Failed to open %s\n", fname);
 165                 return 1;
 166         }
 167
 168         if (emergency) {
 169                 return tdb_rescue(tdb, emergency_walk, dn) == 0;
 170         }
 171         return tdb_traverse(tdb, traverse_fn, dn) == -1 ? 1 : 0;
 172 }
 173
 174 #ifdef HAVE_LMDB
 175 static int dump_lmdb(const char *fname, struct ldb_dn *dn, bool emergency)
 176 {
 177         int ret;
 178         struct MDB_env *env = NULL;
 179         struct MDB_txn *txn = NULL;
 180         MDB_dbi dbi;
 181         struct MDB_cursor *cursor = NULL;
 182         struct MDB_val key;
 183         struct MDB_val data;
 184
 185         ret = mdb_env_create(&env);
 186         if (ret != 0) {
 187                 fprintf(stderr,
 188                         "Could not create MDB environment: (%d)  %s\n",
 189                         ret,
 190                         mdb_strerror(ret));
 191                 goto close_env;
 192         }
 193
 194         ret = mdb_env_open(env,
 195                            fname,
 196                            MDB_NOSUBDIR|MDB_NOTLS|MDB_RDONLY,
 197                            0600);
 198         if (ret != 0) {
 199                 fprintf(stderr,
 200                         "Could not open environment for %s: (%d)  %s\n",
 201                         fname,
 202                         ret,
 203                         mdb_strerror(ret));
 204                 goto close_env;
 205         }
 206
 207         ret = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
 208         if (ret != 0) {
 209                 fprintf(stderr,
 210                         "Could not start transaction: (%d)  %s\n",
 211                         ret,
 212                         mdb_strerror(ret));
 213                 goto close_env;
 214         }
 215
 216         ret = mdb_dbi_open(txn, NULL, 0, &dbi);
 217         if (ret != 0) {
 218                 fprintf(stderr,
 219                         "Could not open database: (%d)  %s\n",
 220                         ret,
 221                         mdb_strerror(ret));
 222                 goto close_txn;
 223         }
 224
 225         ret = mdb_cursor_open(txn, dbi, &cursor);
 226         if (ret != 0) {
 227                 fprintf(stderr,
 228                         "Could not open cursor: (%d)  %s\n",
 229                         ret,
 230                         mdb_strerror(ret));
 231                 goto close_txn;
 232         }
 233
 234         ret = mdb_cursor_get(cursor, &key, &data, MDB_FIRST);
 235         if (ret != 0 && ret != MDB_NOTFOUND) {
 236                 fprintf(stderr,
 237                         "Could not find first record: (%d)  %s\n",
 238                         ret,
 239                         mdb_strerror(ret));
 240                 goto close_cursor;
 241         }
 242         while (ret != MDB_NOTFOUND) {
 243                 struct TDB_DATA tkey = {
 244                         .dptr = key.mv_data,
 245                         .dsize = key.mv_size
 246                 };
 247                 struct TDB_DATA tdata = {
 248                         .dptr = data.mv_data,
 249                         .dsize = data.mv_size
 250                 };
 251                 traverse_fn(NULL, tkey, tdata, dn);
 252                 ret = mdb_cursor_get(cursor, &key, &data, MDB_NEXT);
 253                 if (ret != 0 && ret != MDB_NOTFOUND) {
 254                         fprintf(stderr,
 255                                 "Could not read next record: (%d)  %s\n",
 256                                 ret,
 257                                 mdb_strerror(ret));
 258                         goto close_cursor;
 259                 }
 260         }
 261         ret = 0;
 262
 263 close_cursor:
 264         mdb_cursor_close(cursor);
 265 close_txn:
 266         mdb_txn_commit(txn);
 267 close_env:
 268         mdb_env_close(env);
 269
 270         if (ret != 0) {
 271                 return 1;
 272         }
 273         return 0;
 274
 275 }
 276 #else
 277 static int dump_lmdb(const char *fname, struct ldb_dn *dn, bool emergency)
 278 {
 279         /* not built with lmdb support */
 280         return 1;
 281 }
 282 #endif /* #ifdef HAVE_LMDB */
 283
 284 static void usage( void)
 285 {
 286         printf( "Usage: ldbdump [options] <filename>\n\n");
 287         printf( "   -h          this help message\n");
 288         printf( "   -d DN       dumps DN only\n");
 289         printf( "   -e          emergency dump, for corrupt databases\n");
 290         printf( "   -i          include index and @BASEINFO records in dump\n");
 291         printf( "   -c          validate contents of the records\n");
 292 }
 293
 294  int main(int argc, char *argv[])
 295 {
 296         bool emergency = false;
 297         int c, rc;
 298         char *fname;
 299         struct ldb_dn *dn = NULL;
 300
 301         ldb = ldb_init(NULL, NULL);
 302         if (ldb == NULL) {
 303                 fprintf(stderr, "ldb: ldb_init failed()");
 304                 exit(1);
 305         }
 306
 307         rc = ldb_modules_hook(ldb, LDB_MODULE_HOOK_CMDLINE_PRECONNECT);
 308         if (rc != LDB_SUCCESS) {
 309                 fprintf(stderr, "ldb: failed to run preconnect hooks (needed to get Samba LDIF handlers): %s\n", ldb_strerror(rc));
 310                 exit(1);
 311         }
 312
 313         if (argc < 2) {
 314                 printf("Usage: ldbdump <fname>\n");
 315                 exit(1);
 316         }
 317
 318         while ((c = getopt( argc, argv, "hd:eic")) != -1) {
 319                 switch (c) {
 320                 case 'h':
 321                         usage();
 322                         exit( 0);
 323                 case 'd':
 324                         dn = ldb_dn_new(ldb, ldb, optarg);
 325                         if (!dn) {
 326                                 fprintf(stderr, "ldb failed to parse %s as a DN\n", optarg);
 327                                 exit(1);
 328                         }
 329                         break;
 330                 case 'e':
 331                         emergency = true;
 332                         break;
 333                 case 'i':
 334                         show_index = true;
 335                         break;
 336                 case 'c':
 337                         validate_contents = true;
 338                         break;
 339                 default:
 340                         usage();
 341                         exit( 1);
 342                 }
 343         }
 344
 345         fname = argv[optind];
 346
 347         rc = dump_lmdb(fname, dn, emergency);
 348         if (rc != 0) {
 349                 rc = dump_tdb(fname, dn, emergency);
 350                 if (rc != 0) {
 351                         fprintf(stderr, "Failed to open %s\n", fname);
 352                         return 1;
 353                 }
 354         }
 355         return 0;
 356
 357 }