git.sur5r.net Git - openldap/blob - servers/slapd/back-ldif/ldif.c

   1 /* ldif.c - the ldif backend */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2005-2009 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* ACKNOWLEDGEMENTS:
  17  * This work was originally developed by Eric Stokes for inclusion
  18  * in OpenLDAP Software.
  19  */
  20
  21 #include "portable.h"
  22 #include <stdio.h>
  23 #include <ac/string.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <ac/dirent.h>
  27 #include <fcntl.h>
  28 #include <ac/errno.h>
  29 #include <ac/unistd.h>
  30 #include "slap.h"
  31 #include "lutil.h"
  32 #include "config.h"
  33
  34 struct ldif_tool {
  35         Entry   **entries;                      /* collected by bi_tool_entry_first() */
  36         ID              elen;                           /* length of entries[] array */
  37         ID              ecount;                         /* number of entries */
  38         ID              ecurrent;                       /* bi_tool_entry_next() position */
  39 #       define  ENTRY_BUFF_INCREMENT 500 /* initial entries[] length */
  40         struct berval   *tl_base;
  41         int             tl_scope;
  42         Filter          *tl_filter;
  43 };
  44
  45 /* Per-database data */
  46 struct ldif_info {
  47         struct berval li_base_path;                     /* database directory */
  48         struct ldif_tool li_tool;                       /* for slap tools */
  49         /*
  50          * Read-only LDAP requests readlock li_rdwr for filesystem input.
  51          * Update requests first lock li_modop_mutex for filesystem I/O,
  52          * and then writelock li_rdwr as well for filesystem output.
  53          * This allows update requests to do callbacks that acquire
  54          * read locks, e.g. access controls that inspect entries.
  55          * (An alternative would be recursive read/write locks.)
  56          */
  57         ldap_pvt_thread_mutex_t li_modop_mutex; /* serialize update requests */
  58         ldap_pvt_thread_rdwr_t  li_rdwr;        /* no other I/O when writing */
  59 };
  60
  61 #ifdef _WIN32
  62 #define mkdir(a,b)      mkdir(a)
  63 #define move_file(from, to) (!MoveFileEx(from, to, MOVEFILE_REPLACE_EXISTING))
  64 #else
  65 #define move_file(from, to) rename(from, to)
  66 #endif
  67 #define move_dir(from, to) rename(from, to)
  68
  69
  70 #define LDIF    ".ldif"
  71 #define LDIF_FILETYPE_SEP       '.'                     /* LDIF[0] */
  72
  73 /*
  74  * Unsafe/translated characters in the filesystem.
  75  *
  76  * LDIF_UNSAFE_CHAR(c) returns true if the character c is not to be used
  77  * in relative filenames, except it should accept '\\', '{' and '}' even
  78  * if unsafe.  The value should be a constant expression.
  79  *
  80  * If '\\' is unsafe, #define LDIF_ESCAPE_CHAR as a safe character.
  81  * If '{' and '}' are unsafe, #define IX_FSL/IX_FSR as safe characters.
  82  * (Not digits, '-' or '+'.  IX_FSL == IX_FSR is allowed.)
  83  *
  84  * Characters are escaped as LDIF_ESCAPE_CHAR followed by two hex digits,
  85  * except '\\' is replaced with LDIF_ESCAPE_CHAR and {} with IX_FS[LR].
  86  * Also some LDIF special chars are hex-escaped.
  87  *
  88  * Thus an LDIF filename is a valid normalized RDN (or suffix DN)
  89  * followed by ".ldif", except with '\\' replaced with LDIF_ESCAPE_CHAR.
  90  */
  91
  92 #ifndef _WIN32
  93
  94 /*
  95  * Unix/MacOSX version.  ':' vs '/' can cause confusion on MacOSX so we
  96  * escape both.  We escape them on Unix so both OS variants get the same
  97  * filenames.
  98  */
  99 #define LDIF_ESCAPE_CHAR        '\\'
 100 #define LDIF_UNSAFE_CHAR(c)     ((c) == '/' || (c) == ':')
 101
 102 #else /* _WIN32 */
 103
 104 /* Windows version - Microsoft's list of unsafe characters, except '\\' */
 105 #define LDIF_ESCAPE_CHAR        '^'                     /* Not '\\' (unsafe on Windows) */
 106 #define LDIF_UNSAFE_CHAR(c)     \
 107         ((c) == '/' || (c) == ':' || \
 108          (c) == '<' || (c) == '>' || (c) == '"' || \
 109          (c) == '|' || (c) == '?' || (c) == '*')
 110
 111 #endif /* !_WIN32 */
 112
 113 /*
 114  * Left and Right "{num}" prefix to ordered RDNs ("olcDatabase={1}bdb").
 115  * IX_DN* are for LDAP RDNs, IX_FS* for their .ldif filenames.
 116  */
 117 #define IX_DNL  '{'
 118 #define IX_DNR  '}'
 119 #ifndef IX_FSL
 120 #define IX_FSL  IX_DNL
 121 #define IX_FSR  IX_DNR
 122 #endif
 123
 124 /*
 125  * Test for unsafe chars, as well as chars handled specially by back-ldif:
 126  * - If the escape char is not '\\', it must itself be escaped.  Otherwise
 127  *   '\\' and the escape char would map to the same character.
 128  * - Escape the '.' in ".ldif", so the directory for an RDN that actually
 129  *   ends with ".ldif" can not conflict with a file of the same name.  And
 130  *   since some OSes/programs choke on multiple '.'s, escape all of them.
 131  * - If '{' and '}' are translated to some other characters, those
 132  *   characters must in turn be escaped when they occur in an RDN.
 133  */
 134 #ifndef LDIF_NEED_ESCAPE
 135 #define LDIF_NEED_ESCAPE(c) \
 136         ((LDIF_UNSAFE_CHAR(c)) || \
 137          LDIF_MAYBE_UNSAFE(c, LDIF_ESCAPE_CHAR) || \
 138          LDIF_MAYBE_UNSAFE(c, LDIF_FILETYPE_SEP) || \
 139          LDIF_MAYBE_UNSAFE(c, IX_FSL) || \
 140          (IX_FSR != IX_FSL && LDIF_MAYBE_UNSAFE(c, IX_FSR)))
 141 #endif
 142 /*
 143  * Helper macro for LDIF_NEED_ESCAPE(): Treat character x as unsafe if
 144  * back-ldif does not already treat is specially.
 145  */
 146 #define LDIF_MAYBE_UNSAFE(c, x) \
 147         (!(LDIF_UNSAFE_CHAR(x) || (x) == '\\' || (x) == IX_DNL || (x) == IX_DNR) \
 148          && (c) == (x))
 149
 150 /* Collect other "safe char" tests here, until someone needs a fix. */
 151 enum {
 152         eq_unsafe = LDIF_UNSAFE_CHAR('='),
 153         safe_filenames = STRLENOF("" LDAP_DIRSEP "") == 1 && !(
 154                 LDIF_UNSAFE_CHAR('-') || /* for "{-1}frontend" in bconfig.c */
 155                 LDIF_UNSAFE_CHAR(LDIF_ESCAPE_CHAR) ||
 156                 LDIF_UNSAFE_CHAR(IX_FSL) || LDIF_UNSAFE_CHAR(IX_FSR))
 157 };
 158 /* Sanity check: Try to force a compilation error if !safe_filenames */
 159 typedef struct {
 160         int assert_safe_filenames : safe_filenames ? 2 : -2;
 161 } assert_safe_filenames[safe_filenames ? 2 : -2];
 162
 163
 164 static ConfigTable ldifcfg[] = {
 165         { "directory", "dir", 2, 2, 0, ARG_BERVAL|ARG_OFFSET,
 166                 (void *)offsetof(struct ldif_info, li_base_path),
 167                 "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
 168                         "DESC 'Directory for database content' "
 169                         "EQUALITY caseIgnoreMatch "
 170                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
 171         { NULL, NULL, 0, 0, 0, ARG_IGNORED,
 172                 NULL, NULL, NULL, NULL }
 173 };
 174
 175 static ConfigOCs ldifocs[] = {
 176         { "( OLcfgDbOc:2.1 "
 177                 "NAME 'olcLdifConfig' "
 178                 "DESC 'LDIF backend configuration' "
 179                 "SUP olcDatabaseConfig "
 180                 "MUST ( olcDbDirectory ) )", Cft_Database, ldifcfg },
 181         { NULL, 0, NULL }
 182 };
 183
 184
 185 /*
 186  * Handle file/directory names.
 187  */
 188
 189 /* Set *res = LDIF filename path for the normalized DN */
 190 static int
 191 ndn2path( Operation *op, struct berval *dn, struct berval *res, int empty_ok )
 192 {
 193         BackendDB *be = op->o_bd;
 194         struct ldif_info *li = (struct ldif_info *) be->be_private;
 195         struct berval *suffixdn = &be->be_nsuffix[0];
 196         const char *start, *end, *next, *p;
 197         char ch, *ptr;
 198         ber_len_t len;
 199         static const char hex[] = "0123456789ABCDEF";
 200
 201         assert( dn != NULL );
 202         assert( !BER_BVISNULL( dn ) );
 203         assert( suffixdn != NULL );
 204         assert( !BER_BVISNULL( suffixdn ) );
 205         assert( dnIsSuffix( dn, suffixdn ) );
 206
 207         if ( dn->bv_len == 0 && !empty_ok ) {
 208                 return LDAP_UNWILLING_TO_PERFORM;
 209         }
 210
 211         start = dn->bv_val;
 212         end = start + dn->bv_len;
 213
 214         /* Room for dir, dirsep, dn, LDIF, "\hexpair"-escaping of unsafe chars */
 215         len = li->li_base_path.bv_len + dn->bv_len + (1 + STRLENOF( LDIF ));
 216         for ( p = start; p < end; ) {
 217                 ch = *p++;
 218                 if ( LDIF_NEED_ESCAPE( ch ) )
 219                         len += 2;
 220         }
 221         res->bv_val = ch_malloc( len + 1 );
 222
 223         ptr = lutil_strcopy( res->bv_val, li->li_base_path.bv_val );
 224         for ( next = end - suffixdn->bv_len; end > start; end = next ) {
 225                 /* Set p = start of DN component, next = &',' or start of DN */
 226                 while ( (p = next) > start ) {
 227                         --next;
 228                         if ( DN_SEPARATOR( *next ) )
 229                                 break;
 230                 }
 231                 /* Append <dirsep> <p..end-1: RDN or database-suffix> */
 232                 for ( *ptr++ = LDAP_DIRSEP[0]; p < end; *ptr++ = ch ) {
 233                         ch = *p++;
 234                         if ( LDIF_ESCAPE_CHAR != '\\' && ch == '\\' ) {
 235                                 ch = LDIF_ESCAPE_CHAR;
 236                         } else if ( IX_FSL != IX_DNL && ch == IX_DNL ) {
 237                                 ch = IX_FSL;
 238                         } else if ( IX_FSR != IX_DNR && ch == IX_DNR ) {
 239                                 ch = IX_FSR;
 240                         } else if ( LDIF_NEED_ESCAPE( ch ) ) {
 241                                 *ptr++ = LDIF_ESCAPE_CHAR;
 242                                 *ptr++ = hex[(ch & 0xFFU) >> 4];
 243                                 ch = hex[ch & 0x0FU];
 244                         }
 245                 }
 246         }
 247         ptr = lutil_strcopy( ptr, LDIF );
 248         res->bv_len = ptr - res->bv_val;
 249
 250         assert( res->bv_len <= len );
 251
 252         return LDAP_SUCCESS;
 253 }
 254
 255 /*
 256  * *dest = dupbv(<dir + LDAP_DIRSEP>), plus room for <more>-sized filename.
 257  * Return pointer past the dirname.
 258  */
 259 static char *
 260 fullpath_alloc( struct berval *dest, const struct berval *dir, ber_len_t more )
 261 {
 262         char *s = SLAP_MALLOC( dir->bv_len + more + 2 );
 263
 264         dest->bv_val = s;
 265         if ( s == NULL ) {
 266                 dest->bv_len = 0;
 267                 Debug( LDAP_DEBUG_ANY, "back-ldif: out of memory\n", 0, 0, 0 );
 268         } else {
 269                 s = lutil_strcopy( dest->bv_val, dir->bv_val );
 270                 *s++ = LDAP_DIRSEP[0];
 271                 *s = '\0';
 272                 dest->bv_len = s - dest->bv_val;
 273         }
 274         return s;
 275 }
 276
 277 /*
 278  * Append filename to fullpath_alloc() dirname or replace previous filename.
 279  * dir_end = fullpath_alloc() return value.
 280  */
 281 #define FILL_PATH(fpath, dir_end, filename) \
 282         ((fpath)->bv_len = lutil_strcopy(dir_end, filename) - (fpath)->bv_val)
 283
 284
 285 /* .ldif entry filename length <-> subtree dirname length. */
 286 #define ldif2dir_len(bv)  ((bv).bv_len -= STRLENOF(LDIF))
 287 #define dir2ldif_len(bv)  ((bv).bv_len += STRLENOF(LDIF))
 288 /* .ldif entry filename <-> subtree dirname, both with dirname length. */
 289 #define ldif2dir_name(bv) ((bv).bv_val[(bv).bv_len] = '\0')
 290 #define dir2ldif_name(bv) ((bv).bv_val[(bv).bv_len] = LDIF_FILETYPE_SEP)
 291
 292 /* Get the parent directory path, plus the LDIF suffix overwritten by a \0. */
 293 static int
 294 get_parent_path( struct berval *dnpath, struct berval *res )
 295 {
 296         ber_len_t i = dnpath->bv_len;
 297
 298         while ( i > 0 && dnpath->bv_val[ --i ] != LDAP_DIRSEP[0] ) ;
 299         if ( res == NULL ) {
 300                 res = dnpath;
 301         } else {
 302                 res->bv_val = SLAP_MALLOC( i + 1 + STRLENOF(LDIF) );
 303                 if ( res->bv_val == NULL )
 304                         return LDAP_OTHER;
 305                 AC_MEMCPY( res->bv_val, dnpath->bv_val, i );
 306         }
 307         res->bv_len = i;
 308         strcpy( res->bv_val + i, LDIF );
 309         res->bv_val[i] = '\0';
 310         return LDAP_SUCCESS;
 311 }
 312
 313 /* Make temporary filename pattern for mkstemp() based on dnpath. */
 314 static char *
 315 ldif_tempname( const struct berval *dnpath )
 316 {
 317         static const char suffix[] = ".XXXXXX";
 318         ber_len_t len = dnpath->bv_len - STRLENOF( LDIF );
 319         char *name = SLAP_MALLOC( len + sizeof( suffix ) );
 320
 321         if ( name != NULL ) {
 322                 AC_MEMCPY( name, dnpath->bv_val, len );
 323                 strcpy( name + len, suffix );
 324         }
 325         return name;
 326 }
 327
 328 /*
 329  * Read a file, or stat() it if datap == NULL.  Allocate and fill *datap.
 330  * Return LDAP_SUCCESS, LDAP_NO_SUCH_OBJECT (no such file), or another error.
 331  */
 332 static int
 333 ldif_read_file( const char *path, char **datap )
 334 {
 335         int rc, fd, len;
 336         int res = -1;   /* 0:success, <0:error, >0:file too big/growing. */
 337         struct stat st;
 338         char *data = NULL, *ptr;
 339
 340         if ( datap == NULL ) {
 341                 res = stat( path, &st );
 342                 goto done;
 343         }
 344         fd = open( path, O_RDONLY );
 345         if ( fd >= 0 ) {
 346                 if ( fstat( fd, &st ) == 0 ) {
 347                         if ( st.st_size > INT_MAX - 2 ) {
 348                                 res = 1;
 349                         } else {
 350                                 len = st.st_size + 1; /* +1 detects file size > st.st_size */
 351                                 *datap = data = ptr = SLAP_MALLOC( len + 1 );
 352                                 if ( ptr != NULL ) {
 353                                         while ( len && (res = read( fd, ptr, len )) ) {
 354                                                 if ( res > 0 ) {
 355                                                         len -= res;
 356                                                         ptr += res;
 357                                                 } else if ( errno != EINTR ) {
 358                                                         break;
 359                                                 }
 360                                         }
 361                                         *ptr = '\0';
 362                                 }
 363                         }
 364                 }
 365                 if ( close( fd ) < 0 )
 366                         res = -1;
 367         }
 368
 369  done:
 370         if ( res == 0 ) {
 371                 Debug( LDAP_DEBUG_TRACE, "ldif_read_file: %s: \"%s\"\n",
 372                         datap ? "read entry file" : "entry file exists", path, 0 );
 373                 rc = LDAP_SUCCESS;
 374         } else {
 375                 if ( res < 0 && errno == ENOENT ) {
 376                         Debug( LDAP_DEBUG_TRACE, "ldif_read_file: "
 377                                 "no entry file \"%s\"\n", path, 0, 0 );
 378                         rc = LDAP_NO_SUCH_OBJECT;
 379                 } else {
 380                         const char *msg = res < 0 ? STRERROR( errno ) : "bad stat() size";
 381                         Debug( LDAP_DEBUG_ANY, "ldif_read_file: %s for \"%s\"\n",
 382                                 msg, path, 0 );
 383                         rc = LDAP_OTHER;
 384                 }
 385                 if ( data != NULL )
 386                         SLAP_FREE( data );
 387         }
 388         return rc;
 389 }
 390
 391 /*
 392  * return nonnegative for success or -1 for error
 393  * do not return numbers less than -1
 394  */
 395 static int
 396 spew_file( int fd, const char *spew, int len, int *save_errno )
 397 {
 398         int writeres = 0;
 399
 400         while(len > 0) {
 401                 writeres = write(fd, spew, len);
 402                 if(writeres == -1) {
 403                         *save_errno = errno;
 404                         if (*save_errno != EINTR)
 405                                 break;
 406                 }
 407                 else {
 408                         spew += writeres;
 409                         len -= writeres;
 410                 }
 411         }
 412         return writeres;
 413 }
 414
 415 /* Write an entry LDIF file.  Create parentdir first if non-NULL. */
 416 static int
 417 ldif_write_entry(
 418         Operation *op,
 419         Entry *e,
 420         const struct berval *path,
 421         const char *parentdir,
 422         const char **text )
 423 {
 424         int rc = LDAP_OTHER, res, save_errno = 0;
 425         int fd, entry_length;
 426         char *entry_as_string, *tmpfname;
 427
 428         if ( op->o_abandon )
 429                 return SLAPD_ABANDON;
 430
 431         if ( parentdir != NULL && mkdir( parentdir, 0750 ) < 0 ) {
 432                 save_errno = errno;
 433                 Debug( LDAP_DEBUG_ANY, "ldif_write_entry: %s \"%s\": %s\n",
 434                         "cannot create parent directory",
 435                         parentdir, STRERROR( save_errno ) );
 436                 *text = "internal error (cannot create parent directory)";
 437                 return rc;
 438         }
 439
 440         tmpfname = ldif_tempname( path );
 441         fd = tmpfname == NULL ? -1 : mkstemp( tmpfname );
 442         if ( fd < 0 ) {
 443                 save_errno = errno;
 444                 Debug( LDAP_DEBUG_ANY, "ldif_write_entry: %s for \"%s\": %s\n",
 445                         "cannot create file", e->e_dn, STRERROR( save_errno ) );
 446                 *text = "internal error (cannot create file)";
 447
 448         } else {
 449                 ber_len_t dn_len = e->e_name.bv_len;
 450                 struct berval rdn;
 451
 452                 /* Only save the RDN onto disk */
 453                 dnRdn( &e->e_name, &rdn );
 454                 if ( rdn.bv_len != dn_len ) {
 455                         e->e_name.bv_val[rdn.bv_len] = '\0';
 456                         e->e_name.bv_len = rdn.bv_len;
 457                 }
 458
 459                 res = -2;
 460                 ldap_pvt_thread_mutex_lock( &entry2str_mutex );
 461                 entry_as_string = entry2str( e, &entry_length );
 462                 if ( entry_as_string != NULL )
 463                         res = spew_file( fd, entry_as_string, entry_length, &save_errno );
 464                 ldap_pvt_thread_mutex_unlock( &entry2str_mutex );
 465
 466                 /* Restore full DN */
 467                 if ( rdn.bv_len != dn_len ) {
 468                         e->e_name.bv_val[rdn.bv_len] = ',';
 469                         e->e_name.bv_len = dn_len;
 470                 }
 471
 472                 if ( close( fd ) < 0 && res >= 0 ) {
 473                         res = -1;
 474                         save_errno = errno;
 475                 }
 476
 477                 if ( res >= 0 ) {
 478                         if ( move_file( tmpfname, path->bv_val ) == 0 ) {
 479                                 Debug( LDAP_DEBUG_TRACE, "ldif_write_entry: "
 480                                         "wrote entry \"%s\"\n", e->e_name.bv_val, 0, 0 );
 481                                 rc = LDAP_SUCCESS;
 482                         } else {
 483                                 save_errno = errno;
 484                                 Debug( LDAP_DEBUG_ANY, "ldif_write_entry: "
 485                                         "could not put entry file for \"%s\" in place: %s\n",
 486                                         e->e_name.bv_val, STRERROR( save_errno ), 0 );
 487                                 *text = "internal error (could not put entry file in place)";
 488                         }
 489                 } else if ( res == -1 ) {
 490                         Debug( LDAP_DEBUG_ANY, "ldif_write_entry: %s \"%s\": %s\n",
 491                                 "write error to", tmpfname, STRERROR( save_errno ) );
 492                         *text = "internal error (write error to entry file)";
 493                 }
 494
 495                 if ( rc != LDAP_SUCCESS ) {
 496                         unlink( tmpfname );
 497                 }
 498         }
 499
 500         if ( tmpfname )
 501                 SLAP_FREE( tmpfname );
 502         return rc;
 503 }
 504
 505 /*
 506  * Read the entry at path, or if entryp==NULL just see if it exists.
 507  * pdn and pndn are the parent's DN and normalized DN, or both NULL.
 508  * Return an LDAP result code.
 509  */
 510 static int
 511 ldif_read_entry(
 512         Operation *op,
 513         const char *path,
 514         struct berval *pdn,
 515         struct berval *pndn,
 516         Entry **entryp,
 517         const char **text )
 518 {
 519         int rc;
 520         Entry *entry;
 521         char *entry_as_string;
 522         struct berval rdn;
 523
 524         /* TODO: Does slapd prevent Abandon of Bind as per rfc4511?
 525          * If so we need not check for LDAP_REQ_BIND here.
 526          */
 527         if ( op->o_abandon && op->o_tag != LDAP_REQ_BIND )
 528                 return SLAPD_ABANDON;
 529
 530         rc = ldif_read_file( path, entryp ? &entry_as_string : NULL );
 531
 532         switch ( rc ) {
 533         case LDAP_SUCCESS:
 534                 if ( entryp == NULL )
 535                         break;
 536                 *entryp = entry = str2entry( entry_as_string );
 537                 SLAP_FREE( entry_as_string );
 538                 if ( entry == NULL ) {
 539                         rc = LDAP_OTHER;
 540                         if ( text != NULL )
 541                                 *text = "internal error (cannot parse some entry file)";
 542                         break;
 543                 }
 544                 if ( pdn == NULL || BER_BVISEMPTY( pdn ) )
 545                         break;
 546                 /* Append parent DN to DN from LDIF file */
 547                 rdn = entry->e_name;
 548                 build_new_dn( &entry->e_name, pdn, &rdn, NULL );
 549                 SLAP_FREE( rdn.bv_val );
 550                 rdn = entry->e_nname;
 551                 build_new_dn( &entry->e_nname, pndn, &rdn, NULL );
 552                 SLAP_FREE( rdn.bv_val );
 553                 break;
 554
 555         case LDAP_OTHER:
 556                 if ( text != NULL )
 557                         *text = entryp
 558                                 ? "internal error (cannot read some entry file)"
 559                                 : "internal error (cannot stat some entry file)";
 560                 break;
 561         }
 562
 563         return rc;
 564 }
 565
 566 /*
 567  * Read the operation's entry, or if entryp==NULL just see if it exists.
 568  * Return an LDAP result code.  May set *text to a message on failure.
 569  * If pathp is non-NULL, set it to the entry filename on success.
 570  */
 571 static int
 572 get_entry(
 573         Operation *op,
 574         Entry **entryp,
 575         struct berval *pathp,
 576         const char **text )
 577 {
 578         int rc;
 579         struct berval path, pdn, pndn;
 580
 581         dnParent( &op->o_req_dn, &pdn );
 582         dnParent( &op->o_req_ndn, &pndn );
 583         rc = ndn2path( op, &op->o_req_ndn, &path, 0 );
 584         if ( rc != LDAP_SUCCESS ) {
 585                 goto done;
 586         }
 587
 588         rc = ldif_read_entry( op, path.bv_val, &pdn, &pndn, entryp, text );
 589
 590         if ( rc == LDAP_SUCCESS && pathp != NULL ) {
 591                 *pathp = path;
 592         } else {
 593                 SLAP_FREE( path.bv_val );
 594         }
 595  done:
 596         return rc;
 597 }
 598
 599
 600 /*
 601  * RDN-named directory entry, with special handling of "attr={num}val" RDNs.
 602  * For sorting, filename "attr=val.ldif" is truncated to "attr="val\0ldif",
 603  * and filename "attr={num}val.ldif" to "attr={\0um}val.ldif".
 604  * Does not sort escaped chars correctly, would need to un-escape them.
 605  */
 606 typedef struct bvlist {
 607         struct bvlist *next;
 608         char *trunc;    /* filename was truncated here */
 609         int  inum;              /* num from "attr={num}" in filename, or INT_MIN */
 610         char savech;    /* original char at *trunc */
 611         /* BVL_NAME(&bvlist) is the filename, allocated after the struct: */
 612 #       define BVL_NAME(bvl)     ((char *) ((bvl) + 1))
 613 #       define BVL_SIZE(namelen) (sizeof(bvlist) + (namelen) + 1)
 614 } bvlist;
 615
 616 static int
 617 ldif_send_entry( Operation *op, SlapReply *rs, Entry *e, int scope )
 618 {
 619         int rc = LDAP_SUCCESS;
 620
 621         if ( scope == LDAP_SCOPE_BASE || scope == LDAP_SCOPE_SUBTREE ) {
 622                 if ( rs == NULL ) {
 623                         /* Save the entry for tool mode */
 624                         struct ldif_tool *tl =
 625                                 &((struct ldif_info *) op->o_bd->be_private)->li_tool;
 626
 627                         if ( tl->ecount >= tl->elen ) {
 628                                 /* Allocate/grow entries */
 629                                 ID elen = tl->elen ? tl->elen * 2 : ENTRY_BUFF_INCREMENT;
 630                                 Entry **entries = (Entry **) SLAP_REALLOC( tl->entries,
 631                                         sizeof(Entry *) * elen );
 632                                 if ( entries == NULL ) {
 633                                         Debug( LDAP_DEBUG_ANY,
 634                                                 "ldif_send_entry: out of memory\n", 0, 0, 0 );
 635                                         rc = LDAP_OTHER;
 636                                         goto done;
 637                                 }
 638                                 tl->elen = elen;
 639                                 tl->entries = entries;
 640                         }
 641                         tl->entries[tl->ecount++] = e;
 642                         return rc;
 643                 }
 644
 645                 else if ( !get_manageDSAit( op ) && is_entry_referral( e ) ) {
 646                         /* Send a continuation reference.
 647                          * (ldif_back_referrals() handles baseobject referrals.)
 648                          * Don't check the filter since it's only a candidate.
 649                          */
 650                         BerVarray refs = get_entry_referrals( op, e );
 651                         rs->sr_ref = referral_rewrite( refs, &e->e_name, NULL, scope );
 652                         rs->sr_entry = e;
 653                         rc = send_search_reference( op, rs );
 654                         ber_bvarray_free( rs->sr_ref );
 655                         ber_bvarray_free( refs );
 656                         rs->sr_ref = NULL;
 657                         rs->sr_entry = NULL;
 658                 }
 659
 660                 else if ( test_filter( op, e, op->ors_filter ) == LDAP_COMPARE_TRUE ) {
 661                         rs->sr_entry = e;
 662                         rs->sr_attrs = op->ors_attrs;
 663                         rs->sr_flags = REP_ENTRY_MODIFIABLE;
 664                         rc = send_search_entry( op, rs );
 665                         rs->sr_entry = NULL;
 666                 }
 667         }
 668
 669  done:
 670         entry_free( e );
 671         return rc;
 672 }
 673
 674 /* Read LDIF directory <path> into <listp>.  Set *fname_maxlenp. */
 675 static int
 676 ldif_readdir(
 677         Operation *op,
 678         SlapReply *rs,
 679         const struct berval *path,
 680         bvlist **listp,
 681         ber_len_t *fname_maxlenp )
 682 {
 683         int rc = LDAP_SUCCESS;
 684         DIR *dir_of_path;
 685
 686         *listp = NULL;
 687         *fname_maxlenp = 0;
 688
 689         dir_of_path = opendir( path->bv_val );
 690         if ( dir_of_path == NULL ) {
 691                 int save_errno = errno;
 692                 struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
 693                 int is_rootDSE = (path->bv_len == li->li_base_path.bv_len);
 694
 695                 /* Absent directory is OK (leaf entry), except the database dir */
 696                 if ( is_rootDSE || save_errno != ENOENT ) {
 697                         Debug( LDAP_DEBUG_ANY,
 698                                 "=> ldif_search_entry: failed to opendir \"%s\": %s\n",
 699                                 path->bv_val, STRERROR( save_errno ), 0 );
 700                         rc = LDAP_OTHER;
 701                         if ( rs != NULL )
 702                                 rs->sr_text =
 703                                         save_errno != ENOENT ? "internal error (bad directory)"
 704                                         : !is_rootDSE ? "internal error (missing directory)"
 705                                         : "internal error (database directory does not exist)";
 706                 }
 707
 708         } else {
 709                 bvlist *ptr;
 710                 struct dirent *dir;
 711                 int save_errno = 0;
 712
 713                 while ( (dir = readdir( dir_of_path )) != NULL ) {
 714                         size_t fname_len;
 715                         bvlist *bvl, **prev;
 716                         char *trunc, *idxp, *endp, *endp2;
 717
 718                         fname_len = strlen( dir->d_name );
 719                         if ( fname_len < STRLENOF( "x=" LDIF )) /* min filename size */
 720                                 continue;
 721                         if ( strcmp( dir->d_name + fname_len - STRLENOF(LDIF), LDIF ))
 722                                 continue;
 723
 724                         if ( *fname_maxlenp < fname_len )
 725                                 *fname_maxlenp = fname_len;
 726
 727                         bvl = SLAP_MALLOC( BVL_SIZE( fname_len ) );
 728                         if ( bvl == NULL ) {
 729                                 rc = LDAP_OTHER;
 730                                 save_errno = errno;
 731                                 break;
 732                         }
 733                         strcpy( BVL_NAME( bvl ), dir->d_name );
 734
 735                         /* Make it sortable by ("attr=val" or <preceding {num}, num>) */
 736                         trunc = BVL_NAME( bvl ) + fname_len - STRLENOF( LDIF );
 737                         if ( (idxp = strchr( BVL_NAME( bvl ) + 2, IX_FSL )) != NULL &&
 738                                  (endp = strchr( ++idxp, IX_FSR )) != NULL && endp > idxp &&
 739                                  (eq_unsafe || idxp[-2] == '=' || endp + 1 == trunc) )
 740                         {
 741                                 /* attr={n}val or bconfig.c's "pseudo-indexed" attr=val{n} */
 742                                 bvl->inum = strtol( idxp, &endp2, 10 );
 743                                 if ( endp2 == endp ) {
 744                                         trunc = idxp;
 745                                         goto truncate;
 746                                 }
 747                         }
 748                         bvl->inum = INT_MIN;
 749                 truncate:
 750                         bvl->trunc = trunc;
 751                         bvl->savech = *trunc;
 752                         *trunc = '\0';
 753
 754                         /* Insertion sort */
 755                         for ( prev = listp; (ptr = *prev) != NULL; prev = &ptr->next ) {
 756                                 int cmp = strcmp( BVL_NAME( bvl ), BVL_NAME( ptr ));
 757                                 if ( cmp < 0 || (cmp == 0 && bvl->inum < ptr->inum) )
 758                                         break;
 759                         }
 760                         *prev = bvl;
 761                         bvl->next = ptr;
 762                 }
 763
 764                 if ( closedir( dir_of_path ) < 0 ) {
 765                         save_errno = errno;
 766                         rc = LDAP_OTHER;
 767                         if ( rs != NULL )
 768                                 rs->sr_text = "internal error (bad directory)";
 769                 }
 770                 if ( rc != LDAP_SUCCESS ) {
 771                         Debug( LDAP_DEBUG_ANY, "ldif_search_entry: %s \"%s\": %s\n",
 772                                 "error reading directory", path->bv_val,
 773                                 STRERROR( save_errno ) );
 774                 }
 775         }
 776
 777         return rc;
 778 }
 779
 780 /*
 781  * Send an entry, recursively search its children, and free or save it.
 782  * Return an LDAP result code.  Parameters:
 783  *  op, rs  operation and reply.  rs == NULL for slap tools.
 784  *  e       entry to search, or NULL for rootDSE.
 785  *  scope   scope for the part of the search from this entry.
 786  *  path    LDIF filename -- bv_len and non-directory part are overwritten.
 787  */
 788 static int
 789 ldif_search_entry(
 790         Operation *op,
 791         SlapReply *rs,
 792         Entry *e,
 793         int scope,
 794         struct berval *path )
 795 {
 796         int rc = LDAP_SUCCESS;
 797         struct berval dn = BER_BVC( "" ), ndn = BER_BVC( "" );
 798
 799         if ( scope != LDAP_SCOPE_BASE && e != NULL ) {
 800                 /* Copy DN/NDN since we send the entry with REP_ENTRY_MODIFIABLE,
 801                  * which bconfig.c seems to need.  (TODO: see config_rename_one.)
 802                  */
 803                 if ( ber_dupbv( &dn,  &e->e_name  ) == NULL ||
 804                          ber_dupbv( &ndn, &e->e_nname ) == NULL )
 805                 {
 806                         Debug( LDAP_DEBUG_ANY,
 807                                 "ldif_search_entry: out of memory\n", 0, 0, 0 );
 808                         rc = LDAP_OTHER;
 809                         goto done;
 810                 }
 811         }
 812
 813         /* Send the entry if appropriate, and free or save it */
 814         if ( e != NULL )
 815                 rc = ldif_send_entry( op, rs, e, scope );
 816
 817         /* Search the children */
 818         if ( scope != LDAP_SCOPE_BASE && rc == LDAP_SUCCESS ) {
 819                 bvlist *list, *ptr;
 820                 struct berval fpath;    /* becomes child pathname */
 821                 char *dir_end;  /* will point past dirname in fpath */
 822
 823                 ldif2dir_len( *path );
 824                 ldif2dir_name( *path );
 825                 rc = ldif_readdir( op, rs, path, &list, &fpath.bv_len );
 826
 827                 if ( list != NULL ) {
 828                         const char **text = rs == NULL ? NULL : &rs->sr_text;
 829
 830                         if ( scope == LDAP_SCOPE_ONELEVEL )
 831                                 scope = LDAP_SCOPE_BASE;
 832                         else if ( scope == LDAP_SCOPE_SUBORDINATE )
 833                                 scope = LDAP_SCOPE_SUBTREE;
 834
 835                         /* Allocate fpath and fill in directory part */
 836                         dir_end = fullpath_alloc( &fpath, path, fpath.bv_len );
 837                         if ( dir_end == NULL )
 838                                 rc = LDAP_OTHER;
 839
 840                         do {
 841                                 ptr = list;
 842
 843                                 if ( rc == LDAP_SUCCESS ) {
 844                                         *ptr->trunc = ptr->savech;
 845                                         FILL_PATH( &fpath, dir_end, BVL_NAME( ptr ));
 846
 847                                         rc = ldif_read_entry( op, fpath.bv_val, &dn, &ndn,
 848                                                 &e, text );
 849                                         switch ( rc ) {
 850                                         case LDAP_SUCCESS:
 851                                                 rc = ldif_search_entry( op, rs, e, scope, &fpath );
 852                                                 break;
 853                                         case LDAP_NO_SUCH_OBJECT:
 854                                                 /* Only the search baseDN may produce noSuchObject. */
 855                                                 rc = LDAP_OTHER;
 856                                                 if ( rs != NULL )
 857                                                         rs->sr_text = "internal error "
 858                                                                 "(did someone just remove an entry file?)";
 859                                                 Debug( LDAP_DEBUG_ANY, "ldif_search_entry: "
 860                                                         "file listed in parent directory does not exist: "
 861                                                         "\"%s\"\n", fpath.bv_val, 0, 0 );
 862                                                 break;
 863                                         }
 864                                 }
 865
 866                                 list = ptr->next;
 867                                 SLAP_FREE( ptr );
 868                         } while ( list != NULL );
 869
 870                         if ( !BER_BVISNULL( &fpath ) )
 871                                 SLAP_FREE( fpath.bv_val );
 872                 }
 873         }
 874
 875  done:
 876         if ( !BER_BVISEMPTY( &dn ) )
 877                 ber_memfree( dn.bv_val );
 878         if ( !BER_BVISEMPTY( &ndn ) )
 879                 ber_memfree( ndn.bv_val );
 880         return rc;
 881 }
 882
 883 static int
 884 search_tree( Operation *op, SlapReply *rs )
 885 {
 886         int rc = LDAP_SUCCESS;
 887         Entry *e = NULL;
 888         struct berval path;
 889         struct berval pdn, pndn;
 890
 891         (void) ndn2path( op, &op->o_req_ndn, &path, 1 );
 892         if ( !BER_BVISEMPTY( &op->o_req_ndn ) ) {
 893                 /* Read baseObject */
 894                 dnParent( &op->o_req_dn, &pdn );
 895                 dnParent( &op->o_req_ndn, &pndn );
 896                 rc = ldif_read_entry( op, path.bv_val, &pdn, &pndn, &e,
 897                         rs == NULL ? NULL : &rs->sr_text );
 898         }
 899         if ( rc == LDAP_SUCCESS )
 900                 rc = ldif_search_entry( op, rs, e, op->ors_scope, &path );
 901
 902         ch_free( path.bv_val );
 903         return rc;
 904 }
 905
 906
 907 /*
 908  * Prepare to create or rename an entry:
 909  * Check that the entry does not already exist.
 910  * Check that the parent entry exists and can have subordinates,
 911  * unless need_dir is NULL or adding the suffix entry.
 912  *
 913  * Return an LDAP result code.  May set *text to a message on failure.
 914  * If success, set *dnpath to LDIF entry path and *need_dir to
 915  * (directory must be created ? dirname : NULL).
 916  */
 917 static int
 918 ldif_prepare_create(
 919         Operation *op,
 920         Entry *e,
 921         struct berval *dnpath,
 922         char **need_dir,
 923         const char **text )
 924 {
 925         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
 926         struct berval *ndn = &e->e_nname;
 927         struct berval ppath = BER_BVNULL;
 928         struct stat st;
 929         Entry *parent = NULL;
 930         int rc;
 931
 932         if ( op->o_abandon )
 933                 return SLAPD_ABANDON;
 934
 935         rc = ndn2path( op, ndn, dnpath, 0 );
 936         if ( rc != LDAP_SUCCESS ) {
 937                 return rc;
 938         }
 939
 940         if ( stat( dnpath->bv_val, &st ) == 0 ) { /* entry .ldif file */
 941                 rc = LDAP_ALREADY_EXISTS;
 942
 943         } else if ( errno != ENOENT ) {
 944                 Debug( LDAP_DEBUG_ANY,
 945                         "ldif_prepare_create: cannot stat \"%s\": %s\n",
 946                         dnpath->bv_val, STRERROR( errno ), 0 );
 947                 rc = LDAP_OTHER;
 948                 *text = "internal error (cannot check entry file)";
 949
 950         } else if ( need_dir != NULL ) {
 951                 *need_dir = NULL;
 952                 rc = get_parent_path( dnpath, &ppath );
 953                 /* If parent dir exists, so does parent .ldif:
 954                  * The directory gets created after and removed before the .ldif.
 955                  * Except with the database directory, which has no matching entry.
 956                  */
 957                 if ( rc == LDAP_SUCCESS && stat( ppath.bv_val, &st ) < 0 ) {
 958                         rc = errno == ENOENT && ppath.bv_len > li->li_base_path.bv_len
 959                                 ? LDAP_NO_SUCH_OBJECT : LDAP_OTHER;
 960                 }
 961                 switch ( rc ) {
 962                 case LDAP_NO_SUCH_OBJECT:
 963                         /* No parent dir, check parent .ldif */
 964                         dir2ldif_name( ppath );
 965                         rc = ldif_read_entry( op, ppath.bv_val, NULL, NULL,
 966                                 (op->o_tag != LDAP_REQ_ADD || get_manageDSAit( op )
 967                                  ? &parent : NULL),
 968                                 text );
 969                         switch ( rc ) {
 970                         case LDAP_SUCCESS:
 971                                 /* Check that parent is not a referral, unless
 972                                  * ldif_back_referrals() already checked.
 973                                  */
 974                                 if ( parent != NULL ) {
 975                                         int is_ref = is_entry_referral( parent );
 976                                         entry_free( parent );
 977                                         if ( is_ref ) {
 978                                                 rc = LDAP_AFFECTS_MULTIPLE_DSAS;
 979                                                 *text = op->o_tag == LDAP_REQ_MODDN
 980                                                         ? "newSuperior is a referral object"
 981                                                         : "parent is a referral object";
 982                                                 break;
 983                                         }
 984                                 }
 985                                 /* Must create parent directory. */
 986                                 ldif2dir_name( ppath );
 987                                 *need_dir = ppath.bv_val;
 988                                 break;
 989                         case LDAP_NO_SUCH_OBJECT:
 990                                 *text = op->o_tag == LDAP_REQ_MODDN
 991                                         ? "newSuperior object does not exist"
 992                                         : "parent does not exist";
 993                                 break;
 994                         }
 995                         break;
 996                 case LDAP_OTHER:
 997                         Debug( LDAP_DEBUG_ANY,
 998                                 "ldif_prepare_create: cannot stat \"%s\" parent dir: %s\n",
 999                                 ndn->bv_val, STRERROR( errno ), 0 );
1000                         *text = "internal error (cannot stat parent dir)";
1001                         break;
1002                 }
1003                 if ( *need_dir == NULL && ppath.bv_val != NULL )
1004                         SLAP_FREE( ppath.bv_val );
1005         }
1006
1007         if ( rc != LDAP_SUCCESS ) {
1008                 SLAP_FREE( dnpath->bv_val );
1009                 BER_BVZERO( dnpath );
1010         }
1011         return rc;
1012 }
1013
1014 static int
1015 apply_modify_to_entry(
1016         Entry *entry,
1017         Modifications *modlist,
1018         Operation *op,
1019         SlapReply *rs )
1020 {
1021         char textbuf[SLAP_TEXT_BUFLEN];
1022         int rc = modlist ? LDAP_UNWILLING_TO_PERFORM : LDAP_SUCCESS;
1023         int is_oc = 0;
1024         Modification *mods;
1025
1026         if (!acl_check_modlist(op, entry, modlist)) {
1027                 return LDAP_INSUFFICIENT_ACCESS;
1028         }
1029
1030         for (; modlist != NULL; modlist = modlist->sml_next) {
1031                 mods = &modlist->sml_mod;
1032
1033                 if ( mods->sm_desc == slap_schema.si_ad_objectClass ) {
1034                         is_oc = 1;
1035                 }
1036                 switch (mods->sm_op) {
1037                 case LDAP_MOD_ADD:
1038                         rc = modify_add_values(entry, mods,
1039                                    get_permissiveModify(op),
1040                                    &rs->sr_text, textbuf,
1041                                    sizeof( textbuf ) );
1042                         break;
1043
1044                 case LDAP_MOD_DELETE:
1045                         rc = modify_delete_values(entry, mods,
1046                                 get_permissiveModify(op),
1047                                 &rs->sr_text, textbuf,
1048                                 sizeof( textbuf ) );
1049                         break;
1050
1051                 case LDAP_MOD_REPLACE:
1052                         rc = modify_replace_values(entry, mods,
1053                                  get_permissiveModify(op),
1054                                  &rs->sr_text, textbuf,
1055                                  sizeof( textbuf ) );
1056                         break;
1057
1058                 case LDAP_MOD_INCREMENT:
1059                         rc = modify_increment_values( entry,
1060                                 mods, get_permissiveModify(op),
1061                                 &rs->sr_text, textbuf,
1062                                 sizeof( textbuf ) );
1063                         break;
1064
1065                 case SLAP_MOD_SOFTADD:
1066                         mods->sm_op = LDAP_MOD_ADD;
1067                         rc = modify_add_values(entry, mods,
1068                                    get_permissiveModify(op),
1069                                    &rs->sr_text, textbuf,
1070                                    sizeof( textbuf ) );
1071                         mods->sm_op = SLAP_MOD_SOFTADD;
1072                         if (rc == LDAP_TYPE_OR_VALUE_EXISTS) {
1073                                 rc = LDAP_SUCCESS;
1074                         }
1075                         break;
1076                 }
1077                 if(rc != LDAP_SUCCESS) break;
1078         }
1079
1080         if ( rc == LDAP_SUCCESS ) {
1081                 rs->sr_text = NULL; /* Needed at least with SLAP_MOD_SOFTADD */
1082                 if ( is_oc ) {
1083                         entry->e_ocflags = 0;
1084                 }
1085                 /* check that the entry still obeys the schema */
1086                 rc = entry_schema_check( op, entry, NULL, 0, 0, NULL,
1087                           &rs->sr_text, textbuf, sizeof( textbuf ) );
1088         }
1089
1090         return rc;
1091 }
1092
1093
1094 static int
1095 ldif_back_referrals( Operation *op, SlapReply *rs )
1096 {
1097         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1098         struct berval path, dn = op->o_req_dn, ndn = op->o_req_ndn;
1099         ber_len_t min_dnlen;
1100         Entry *entry = NULL, **entryp;
1101         BerVarray ref;
1102         int rc;
1103
1104         min_dnlen = op->o_bd->be_nsuffix[0].bv_len;
1105         if ( min_dnlen == 0 ) {
1106                 /* Catch root DSE (empty DN), it is not a referral */
1107                 min_dnlen = 1;
1108         }
1109         if ( ndn2path( op, &ndn, &path, 0 ) != LDAP_SUCCESS ) {
1110                 return LDAP_SUCCESS;    /* Root DSE again */
1111         }
1112
1113         entryp = get_manageDSAit( op ) ? NULL : &entry;
1114         ldap_pvt_thread_rdwr_rlock( &li->li_rdwr );
1115
1116         for (;;) {
1117                 dnParent( &dn, &dn );
1118                 dnParent( &ndn, &ndn );
1119                 rc = ldif_read_entry( op, path.bv_val, &dn, &ndn,
1120                         entryp, &rs->sr_text );
1121                 if ( rc != LDAP_NO_SUCH_OBJECT )
1122                         break;
1123
1124                 rc = LDAP_SUCCESS;
1125                 if ( ndn.bv_len < min_dnlen )
1126                         break;
1127                 (void) get_parent_path( &path, NULL );
1128                 dir2ldif_name( path );
1129                 entryp = &entry;
1130         }
1131
1132         ldap_pvt_thread_rdwr_runlock( &li->li_rdwr );
1133         SLAP_FREE( path.bv_val );
1134
1135         if ( entry != NULL ) {
1136                 if ( is_entry_referral( entry ) ) {
1137                         Debug( LDAP_DEBUG_TRACE,
1138                                 "ldif_back_referrals: tag=%lu target=\"%s\" matched=\"%s\"\n",
1139                                 (unsigned long) op->o_tag, op->o_req_dn.bv_val, entry->e_dn );
1140
1141                         ref = get_entry_referrals( op, entry );
1142                         rs->sr_ref = referral_rewrite( ref, &entry->e_name, &op->o_req_dn,
1143                                 op->o_tag == LDAP_REQ_SEARCH ?
1144                                 op->ors_scope : LDAP_SCOPE_DEFAULT );
1145                         ber_bvarray_free( ref );
1146
1147                         if ( rs->sr_ref != NULL ) {
1148                                 /* send referral */
1149                                 rc = rs->sr_err = LDAP_REFERRAL;
1150                                 rs->sr_matched = entry->e_dn;
1151                                 send_ldap_result( op, rs );
1152                                 ber_bvarray_free( rs->sr_ref );
1153                                 rs->sr_ref = NULL;
1154                         } else {
1155                                 rc = LDAP_OTHER;
1156                                 rs->sr_text = "bad referral object";
1157                         }
1158                         rs->sr_matched = NULL;
1159                 }
1160
1161                 entry_free( entry );
1162         }
1163
1164         return rc;
1165 }
1166
1167
1168 /* LDAP operations */
1169
1170 static int
1171 ldif_back_bind( Operation *op, SlapReply *rs )
1172 {
1173         struct ldif_info *li;
1174         Attribute *a;
1175         AttributeDescription *password = slap_schema.si_ad_userPassword;
1176         int return_val;
1177         Entry *entry = NULL;
1178
1179         switch ( be_rootdn_bind( op, rs ) ) {
1180         case SLAP_CB_CONTINUE:
1181                 break;
1182
1183         default:
1184                 /* in case of success, front end will send result;
1185                  * otherwise, be_rootdn_bind() did */
1186                 return rs->sr_err;
1187         }
1188
1189         li = (struct ldif_info *) op->o_bd->be_private;
1190         ldap_pvt_thread_rdwr_rlock(&li->li_rdwr);
1191         return_val = get_entry(op, &entry, NULL, NULL);
1192
1193         /* no object is found for them */
1194         if(return_val != LDAP_SUCCESS) {
1195                 rs->sr_err = return_val = LDAP_INVALID_CREDENTIALS;
1196                 goto return_result;
1197         }
1198
1199         /* they don't have userpassword */
1200         if((a = attr_find(entry->e_attrs, password)) == NULL) {
1201                 rs->sr_err = LDAP_INAPPROPRIATE_AUTH;
1202                 return_val = 1;
1203                 goto return_result;
1204         }
1205
1206         /* authentication actually failed */
1207         if(slap_passwd_check(op, entry, a, &op->oq_bind.rb_cred,
1208                              &rs->sr_text) != 0) {
1209                 rs->sr_err = LDAP_INVALID_CREDENTIALS;
1210                 return_val = 1;
1211                 goto return_result;
1212         }
1213
1214         /* let the front-end send success */
1215         return_val = LDAP_SUCCESS;
1216
1217  return_result:
1218         ldap_pvt_thread_rdwr_runlock(&li->li_rdwr);
1219         if(return_val != LDAP_SUCCESS)
1220                 send_ldap_result( op, rs );
1221         if(entry != NULL)
1222                 entry_free(entry);
1223         return return_val;
1224 }
1225
1226 static int
1227 ldif_back_search( Operation *op, SlapReply *rs )
1228 {
1229         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1230
1231         ldap_pvt_thread_rdwr_rlock(&li->li_rdwr);
1232         rs->sr_err = search_tree( op, rs );
1233         ldap_pvt_thread_rdwr_runlock(&li->li_rdwr);
1234         send_ldap_result(op, rs);
1235
1236         return rs->sr_err;
1237 }
1238
1239 static int
1240 ldif_back_add( Operation *op, SlapReply *rs )
1241 {
1242         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1243         Entry * e = op->ora_e;
1244         struct berval path;
1245         char *parentdir;
1246         char textbuf[SLAP_TEXT_BUFLEN];
1247         int rc;
1248
1249         Debug( LDAP_DEBUG_TRACE, "ldif_back_add: \"%s\"\n", e->e_dn, 0, 0 );
1250
1251         rc = entry_schema_check( op, e, NULL, 0, 1, NULL,
1252                 &rs->sr_text, textbuf, sizeof( textbuf ) );
1253         if ( rc != LDAP_SUCCESS )
1254                 goto send_res;
1255
1256         rc = slap_add_opattrs( op, &rs->sr_text, textbuf, sizeof( textbuf ), 1 );
1257         if ( rc != LDAP_SUCCESS )
1258                 goto send_res;
1259
1260         ldap_pvt_thread_mutex_lock( &li->li_modop_mutex );
1261
1262         rc = ldif_prepare_create( op, e, &path, &parentdir, &rs->sr_text );
1263         if ( rc == LDAP_SUCCESS ) {
1264                 ldap_pvt_thread_rdwr_wlock( &li->li_rdwr );
1265                 rc = ldif_write_entry( op, e, &path, parentdir, &rs->sr_text );
1266                 ldap_pvt_thread_rdwr_wunlock( &li->li_rdwr );
1267
1268                 SLAP_FREE( path.bv_val );
1269                 if ( parentdir != NULL )
1270                         SLAP_FREE( parentdir );
1271         }
1272
1273         ldap_pvt_thread_mutex_unlock( &li->li_modop_mutex );
1274
1275  send_res:
1276         rs->sr_err = rc;
1277         Debug( LDAP_DEBUG_TRACE, "ldif_back_add: err: %d text: %s\n",
1278                 rc, rs->sr_text ? rs->sr_text : "", 0 );
1279         send_ldap_result( op, rs );
1280         slap_graduate_commit_csn( op );
1281         return rs->sr_err;
1282 }
1283
1284 static int
1285 ldif_back_modify( Operation *op, SlapReply *rs )
1286 {
1287         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1288         Modifications * modlst = op->orm_modlist;
1289         struct berval path;
1290         Entry *entry;
1291         int rc;
1292
1293         slap_mods_opattrs( op, &op->orm_modlist, 1 );
1294
1295         ldap_pvt_thread_mutex_lock( &li->li_modop_mutex );
1296
1297         rc = get_entry( op, &entry, &path, &rs->sr_text );
1298         if ( rc == LDAP_SUCCESS ) {
1299                 rc = apply_modify_to_entry( entry, modlst, op, rs );
1300                 if ( rc == LDAP_SUCCESS ) {
1301                         ldap_pvt_thread_rdwr_wlock( &li->li_rdwr );
1302                         rc = ldif_write_entry( op, entry, &path, NULL, &rs->sr_text );
1303                         ldap_pvt_thread_rdwr_wunlock( &li->li_rdwr );
1304                 }
1305
1306                 entry_free( entry );
1307                 SLAP_FREE( path.bv_val );
1308         }
1309
1310         ldap_pvt_thread_mutex_unlock( &li->li_modop_mutex );
1311
1312         rs->sr_err = rc;
1313         send_ldap_result( op, rs );
1314         slap_graduate_commit_csn( op );
1315         return rs->sr_err;
1316 }
1317
1318 static int
1319 ldif_back_delete( Operation *op, SlapReply *rs )
1320 {
1321         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1322         struct berval path;
1323         int rc = LDAP_SUCCESS;
1324
1325         if ( BER_BVISEMPTY( &op->o_csn )) {
1326                 struct berval csn;
1327                 char csnbuf[LDAP_PVT_CSNSTR_BUFSIZE];
1328
1329                 csn.bv_val = csnbuf;
1330                 csn.bv_len = sizeof( csnbuf );
1331                 slap_get_csn( op, &csn, 1 );
1332         }
1333
1334         ldap_pvt_thread_mutex_lock( &li->li_modop_mutex );
1335         ldap_pvt_thread_rdwr_wlock( &li->li_rdwr );
1336         if ( op->o_abandon ) {
1337                 rc = SLAPD_ABANDON;
1338                 goto done;
1339         }
1340
1341         rc = ndn2path( op, &op->o_req_ndn, &path, 0 );
1342         if ( rc != LDAP_SUCCESS ) {
1343                 goto done;
1344         }
1345
1346         ldif2dir_len( path );
1347         ldif2dir_name( path );
1348         if ( rmdir( path.bv_val ) < 0 ) {
1349                 switch ( errno ) {
1350                 case ENOTEMPTY:
1351                         rc = LDAP_NOT_ALLOWED_ON_NONLEAF;
1352                         break;
1353                 case ENOENT:
1354                         /* is leaf, go on */
1355                         break;
1356                 default:
1357                         rc = LDAP_OTHER;
1358                         rs->sr_text = "internal error (cannot delete subtree directory)";
1359                         break;
1360                 }
1361         }
1362
1363         if ( rc == LDAP_SUCCESS ) {
1364                 dir2ldif_name( path );
1365                 if ( unlink( path.bv_val ) < 0 ) {
1366                         rc = LDAP_NO_SUCH_OBJECT;
1367                         if ( errno != ENOENT ) {
1368                                 rc = LDAP_OTHER;
1369                                 rs->sr_text = "internal error (cannot delete entry file)";
1370                         }
1371                 }
1372         }
1373
1374         if ( rc == LDAP_OTHER ) {
1375                 Debug( LDAP_DEBUG_ANY, "ldif_back_delete: %s \"%s\": %s\n",
1376                         "cannot delete", path.bv_val, STRERROR( errno ) );
1377         }
1378
1379         SLAP_FREE( path.bv_val );
1380  done:
1381         ldap_pvt_thread_rdwr_wunlock( &li->li_rdwr );
1382         ldap_pvt_thread_mutex_unlock( &li->li_modop_mutex );
1383         rs->sr_err = rc;
1384         send_ldap_result( op, rs );
1385         slap_graduate_commit_csn( op );
1386         return rs->sr_err;
1387 }
1388
1389
1390 static int
1391 ldif_move_entry(
1392         Operation *op,
1393         Entry *entry,
1394         int same_ndn,
1395         struct berval *oldpath,
1396         const char **text )
1397 {
1398         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1399         struct berval newpath;
1400         char *parentdir = NULL, *trash;
1401         int rc, rename_res;
1402
1403         if ( same_ndn ) {
1404                 rc = LDAP_SUCCESS;
1405                 newpath = *oldpath;
1406         } else {
1407                 rc = ldif_prepare_create( op, entry, &newpath,
1408                         op->orr_newSup ? &parentdir : NULL, text );
1409         }
1410
1411         if ( rc == LDAP_SUCCESS ) {
1412                 ldap_pvt_thread_rdwr_wlock( &li->li_rdwr );
1413
1414                 rc = ldif_write_entry( op, entry, &newpath, parentdir, text );
1415                 if ( rc == LDAP_SUCCESS && !same_ndn ) {
1416                         trash = oldpath->bv_val; /* will be .ldif file to delete */
1417                         ldif2dir_len( newpath );
1418                         ldif2dir_len( *oldpath );
1419                         /* Move subdir before deleting old entry,
1420                          * so .ldif always exists if subdir does.
1421                          */
1422                         ldif2dir_name( newpath );
1423                         ldif2dir_name( *oldpath );
1424                         rename_res = move_dir( oldpath->bv_val, newpath.bv_val );
1425                         if ( rename_res != 0 && errno != ENOENT ) {
1426                                 rc = LDAP_OTHER;
1427                                 *text = "internal error (cannot move this subtree)";
1428                                 trash = newpath.bv_val;
1429                         }
1430
1431                         /* Delete old entry, or if error undo change */
1432                         for (;;) {
1433                                 dir2ldif_name( newpath );
1434                                 dir2ldif_name( *oldpath );
1435                                 if ( unlink( trash ) == 0 )
1436                                         break;
1437                                 if ( rc == LDAP_SUCCESS ) {
1438                                         /* Prepare to undo change and return failure */
1439                                         rc = LDAP_OTHER;
1440                                         *text = "internal error (cannot move this entry)";
1441                                         trash = newpath.bv_val;
1442                                         if ( rename_res != 0 )
1443                                                 continue;
1444                                         /* First move subdirectory back */
1445                                         ldif2dir_name( newpath );
1446                                         ldif2dir_name( *oldpath );
1447                                         if ( move_dir( newpath.bv_val, oldpath->bv_val ) == 0 )
1448                                                 continue;
1449                                 }
1450                                 *text = "added new but couldn't delete old entry!";
1451                                 break;
1452                         }
1453
1454                         if ( rc != LDAP_SUCCESS ) {
1455                                 char s[128];
1456                                 snprintf( s, sizeof s, "%s (%s)", *text, STRERROR( errno ));
1457                                 Debug( LDAP_DEBUG_ANY,
1458                                         "ldif_move_entry: %s: \"%s\" -> \"%s\"\n",
1459                                         s, op->o_req_dn.bv_val, entry->e_dn );
1460                         }
1461                 }
1462
1463                 ldap_pvt_thread_rdwr_wunlock( &li->li_rdwr );
1464                 if ( !same_ndn )
1465                         SLAP_FREE( newpath.bv_val );
1466                 if ( parentdir != NULL )
1467                         SLAP_FREE( parentdir );
1468         }
1469
1470         return rc;
1471 }
1472
1473 static int
1474 ldif_back_modrdn( Operation *op, SlapReply *rs )
1475 {
1476         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1477         struct berval new_dn = BER_BVNULL, new_ndn = BER_BVNULL;
1478         struct berval p_dn, old_path;
1479         Entry *entry;
1480         int rc, same_ndn;
1481
1482         slap_mods_opattrs( op, &op->orr_modlist, 1 );
1483
1484         ldap_pvt_thread_mutex_lock( &li->li_modop_mutex );
1485
1486         rc = get_entry( op, &entry, &old_path, &rs->sr_text );
1487         if ( rc == LDAP_SUCCESS ) {
1488                 /* build new dn, and new ndn for the entry */
1489                 if ( op->oq_modrdn.rs_newSup != NULL ) {
1490                         p_dn = *op->oq_modrdn.rs_newSup;
1491                 } else {
1492                         dnParent( &entry->e_name, &p_dn );
1493                 }
1494                 build_new_dn( &new_dn, &p_dn, &op->oq_modrdn.rs_newrdn, NULL );
1495                 dnNormalize( 0, NULL, NULL, &new_dn, &new_ndn, NULL );
1496                 same_ndn = !ber_bvcmp( &entry->e_nname, &new_ndn );
1497                 ber_memfree_x( entry->e_name.bv_val, NULL );
1498                 ber_memfree_x( entry->e_nname.bv_val, NULL );
1499                 entry->e_name = new_dn;
1500                 entry->e_nname = new_ndn;
1501
1502                 /* perform the modifications */
1503                 rc = apply_modify_to_entry( entry, op->orr_modlist, op, rs );
1504                 if ( rc == LDAP_SUCCESS )
1505                         rc = ldif_move_entry( op, entry, same_ndn, &old_path,
1506                                 &rs->sr_text );
1507
1508                 entry_free( entry );
1509                 SLAP_FREE( old_path.bv_val );
1510         }
1511
1512         ldap_pvt_thread_mutex_unlock( &li->li_modop_mutex );
1513         rs->sr_err = rc;
1514         send_ldap_result( op, rs );
1515         slap_graduate_commit_csn( op );
1516         return rs->sr_err;
1517 }
1518
1519
1520 /* Return LDAP_SUCCESS IFF we retrieve the specified entry. */
1521 static int
1522 ldif_back_entry_get(
1523         Operation *op,
1524         struct berval *ndn,
1525         ObjectClass *oc,
1526         AttributeDescription *at,
1527         int rw,
1528         Entry **e )
1529 {
1530         struct ldif_info *li = (struct ldif_info *) op->o_bd->be_private;
1531         struct berval op_dn = op->o_req_dn, op_ndn = op->o_req_ndn;
1532         int rc;
1533
1534         assert( ndn != NULL );
1535         assert( !BER_BVISNULL( ndn ) );
1536
1537         ldap_pvt_thread_rdwr_rlock( &li->li_rdwr );
1538         op->o_req_dn = *ndn;
1539         op->o_req_ndn = *ndn;
1540         rc = get_entry( op, e, NULL, NULL );
1541         op->o_req_dn = op_dn;
1542         op->o_req_ndn = op_ndn;
1543         ldap_pvt_thread_rdwr_runlock( &li->li_rdwr );
1544
1545         if ( rc == LDAP_SUCCESS && oc && !is_entry_objectclass_or_sub( *e, oc ) ) {
1546                 rc = LDAP_NO_SUCH_ATTRIBUTE;
1547                 entry_free( *e );
1548                 *e = NULL;
1549         }
1550
1551         return rc;
1552 }
1553
1554
1555 /* Slap tools */
1556
1557 static int
1558 ldif_tool_entry_open( BackendDB *be, int mode )
1559 {
1560         struct ldif_tool *tl = &((struct ldif_info *) be->be_private)->li_tool;
1561
1562         tl->ecurrent = 0;
1563         return 0;
1564 }
1565
1566 static int
1567 ldif_tool_entry_close( BackendDB *be )
1568 {
1569         struct ldif_tool *tl = &((struct ldif_info *) be->be_private)->li_tool;
1570         Entry **entries = tl->entries;
1571         ID i;
1572
1573         for ( i = tl->ecount; i--; )
1574                 if ( entries[i] )
1575                         entry_free( entries[i] );
1576         SLAP_FREE( entries );
1577         tl->entries = NULL;
1578         tl->ecount = tl->elen = 0;
1579         return 0;
1580 }
1581
1582 static ID
1583 ldif_tool_entry_next( BackendDB *be )
1584 {
1585         struct ldif_tool *tl = &((struct ldif_info *) be->be_private)->li_tool;
1586
1587         do {
1588                 Entry *e = tl->entries[ tl->ecurrent ];
1589
1590                 if ( tl->ecurrent >= tl->ecount ) {
1591                         return NOID;
1592                 }
1593
1594                 ++tl->ecurrent;
1595
1596                 if ( tl->tl_base && !dnIsSuffixScope( &e->e_nname, tl->tl_base, tl->tl_scope ) ) {
1597                         continue;
1598                 }
1599
1600                 if ( tl->tl_filter && test_filter( NULL, e, tl->tl_filter  ) != LDAP_COMPARE_TRUE ) {
1601                         continue;
1602                 }
1603
1604                 break;
1605         } while ( 1 );
1606
1607         return tl->ecurrent;
1608 }
1609
1610 static ID
1611 ldif_tool_entry_first_x( BackendDB *be, struct berval *base, int scope, Filter *f )
1612 {
1613         struct ldif_tool *tl = &((struct ldif_info *) be->be_private)->li_tool;
1614
1615         tl->tl_base = base;
1616         tl->tl_scope = scope;
1617         tl->tl_filter = f;
1618
1619         if ( tl->entries == NULL ) {
1620                 Operation op = {0};
1621
1622                 op.o_bd = be;
1623                 op.o_req_dn = *be->be_suffix;
1624                 op.o_req_ndn = *be->be_nsuffix;
1625                 op.ors_scope = LDAP_SCOPE_SUBTREE;
1626                 if ( search_tree( &op, NULL ) != LDAP_SUCCESS ) {
1627                         tl->ecurrent = tl->ecount; /* fail ldif_tool_entry_next() */
1628                         return 0; /* fail ldif_tool_entry_get() */
1629                 }
1630         }
1631         return ldif_tool_entry_next( be );
1632 }
1633
1634 static Entry *
1635 ldif_tool_entry_get( BackendDB *be, ID id )
1636 {
1637         struct ldif_tool *tl = &((struct ldif_info *) be->be_private)->li_tool;
1638         Entry *e = NULL;
1639
1640         --id;
1641         if ( id < tl->ecount ) {
1642                 e = tl->entries[id];
1643                 tl->entries[id] = NULL;
1644         }
1645         return e;
1646 }
1647
1648 static ID
1649 ldif_tool_entry_put( BackendDB *be, Entry *e, struct berval *text )
1650 {
1651         int rc;
1652         const char *errmsg = NULL;
1653         struct berval path;
1654         char *parentdir;
1655         Operation op = {0};
1656
1657         op.o_bd = be;
1658         rc = ldif_prepare_create( &op, e, &path, &parentdir, &errmsg );
1659         if ( rc == LDAP_SUCCESS ) {
1660                 rc = ldif_write_entry( &op, e, &path, parentdir, &errmsg );
1661
1662                 SLAP_FREE( path.bv_val );
1663                 if ( parentdir != NULL )
1664                         SLAP_FREE( parentdir );
1665                 if ( rc == LDAP_SUCCESS )
1666                         return 1;
1667         }
1668
1669         if ( errmsg == NULL && rc != LDAP_OTHER )
1670                 errmsg = ldap_err2string( rc );
1671         if ( errmsg != NULL )
1672                 snprintf( text->bv_val, text->bv_len, "%s", errmsg );
1673         return NOID;
1674 }
1675
1676
1677 /* Setup */
1678
1679 static int
1680 ldif_back_db_init( BackendDB *be, ConfigReply *cr )
1681 {
1682         struct ldif_info *li;
1683
1684         li = ch_calloc( 1, sizeof(struct ldif_info) );
1685         be->be_private = li;
1686         be->be_cf_ocs = ldifocs;
1687         ldap_pvt_thread_mutex_init( &li->li_modop_mutex );
1688         ldap_pvt_thread_rdwr_init( &li->li_rdwr );
1689         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_ONE_SUFFIX;
1690         return 0;
1691 }
1692
1693 static int
1694 ldif_back_db_destroy( Backend *be, ConfigReply *cr )
1695 {
1696         struct ldif_info *li = be->be_private;
1697
1698         ch_free( li->li_base_path.bv_val );
1699         ldap_pvt_thread_rdwr_destroy( &li->li_rdwr );
1700         ldap_pvt_thread_mutex_destroy( &li->li_modop_mutex );
1701         free( be->be_private );
1702         return 0;
1703 }
1704
1705 static int
1706 ldif_back_db_open( Backend *be, ConfigReply *cr )
1707 {
1708         struct ldif_info *li = (struct ldif_info *) be->be_private;
1709         if( BER_BVISEMPTY(&li->li_base_path)) {/* missing base path */
1710                 Debug( LDAP_DEBUG_ANY, "missing base path for back-ldif\n", 0, 0, 0);
1711                 return 1;
1712         }
1713         return 0;
1714 }
1715
1716 int
1717 ldif_back_initialize( BackendInfo *bi )
1718 {
1719         static char *controls[] = {
1720                 LDAP_CONTROL_MANAGEDSAIT,
1721                 NULL
1722         };
1723         int rc;
1724
1725         bi->bi_flags |=
1726                 SLAP_BFLAG_INCREMENT |
1727                 SLAP_BFLAG_REFERRALS;
1728
1729         bi->bi_controls = controls;
1730
1731         bi->bi_open = 0;
1732         bi->bi_close = 0;
1733         bi->bi_config = 0;
1734         bi->bi_destroy = 0;
1735
1736         bi->bi_db_init = ldif_back_db_init;
1737         bi->bi_db_config = config_generic_wrapper;
1738         bi->bi_db_open = ldif_back_db_open;
1739         bi->bi_db_close = 0;
1740         bi->bi_db_destroy = ldif_back_db_destroy;
1741
1742         bi->bi_op_bind = ldif_back_bind;
1743         bi->bi_op_unbind = 0;
1744         bi->bi_op_search = ldif_back_search;
1745         bi->bi_op_compare = 0;
1746         bi->bi_op_modify = ldif_back_modify;
1747         bi->bi_op_modrdn = ldif_back_modrdn;
1748         bi->bi_op_add = ldif_back_add;
1749         bi->bi_op_delete = ldif_back_delete;
1750         bi->bi_op_abandon = 0;
1751
1752         bi->bi_extended = 0;
1753
1754         bi->bi_chk_referrals = ldif_back_referrals;
1755
1756         bi->bi_connection_init = 0;
1757         bi->bi_connection_destroy = 0;
1758
1759         bi->bi_entry_get_rw = ldif_back_entry_get;
1760
1761 #if 0   /* NOTE: uncomment to completely disable access control */
1762         bi->bi_access_allowed = slap_access_always_allowed;
1763 #endif
1764
1765         bi->bi_tool_entry_open = ldif_tool_entry_open;
1766         bi->bi_tool_entry_close = ldif_tool_entry_close;
1767         bi->bi_tool_entry_first = backend_tool_entry_first;
1768         bi->bi_tool_entry_first_x = ldif_tool_entry_first_x;
1769         bi->bi_tool_entry_next = ldif_tool_entry_next;
1770         bi->bi_tool_entry_get = ldif_tool_entry_get;
1771         bi->bi_tool_entry_put = ldif_tool_entry_put;
1772         bi->bi_tool_entry_reindex = 0;
1773         bi->bi_tool_sync = 0;
1774
1775         bi->bi_tool_dn2id_get = 0;
1776         bi->bi_tool_entry_modify = 0;
1777
1778         bi->bi_cf_ocs = ldifocs;
1779
1780         rc = config_register_schema( ldifcfg, ldifocs );
1781         if ( rc ) return rc;
1782         return 0;
1783 }