r25068: Older samba3 DCs will return DCERPC_FAULT_OP_RNG_ERROR for every opcode on the

[Samba.git] / source / lib / ldb / common / ldb_ldif.c

/* 
   ldb database library

   Copyright (C) Andrew Tridgell  2004

     ** NOTE! The following LGPL license applies to the ldb
     ** library. This does NOT imply that all of Samba is released
     ** under the LGPL
   
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/*
 *  Name: ldb
 *
 *  Component: ldif routines
 *
 *  Description: ldif pack/unpack routines
 *
 *  Author: Andrew Tridgell
 */

/*
  see RFC2849 for the LDIF format definition
*/

#include "includes.h"
#include "ldb/include/includes.h"
#include "system/locale.h"

/*
  
*/
static int ldb_read_data_file(void *mem_ctx, struct ldb_val *value)
{
        struct stat statbuf;
        char *buf;
        int count, size, bytes;
        int ret;
        int f;
        const char *fname = (const char *)value->data;

        if (strncmp(fname, "file://", 7) != 0) {
                return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
        }
        fname += 7;

        f = open(fname, O_RDONLY);
        if (f == -1) {
                return -1;
        }

        if (fstat(f, &statbuf) != 0) {
                ret = -1;
                goto done;
        }

        if (statbuf.st_size == 0) {
                ret = -1;
                goto done;
        }

        value->data = (uint8_t *)talloc_size(mem_ctx, statbuf.st_size + 1);
        if (value->data == NULL) {
                ret = -1;
                goto done;
        }
        value->data[statbuf.st_size] = 0;

        count = 0;
        size = statbuf.st_size;
        buf = (char *)value->data;
        while (count < statbuf.st_size) {
                bytes = read(f, buf, size);
                if (bytes == -1) {
                        talloc_free(value->data);
                        ret = -1;
                        goto done;
                }
                count += bytes;
                buf += bytes;
                size -= bytes;
        }

        value->length = statbuf.st_size;
        ret = statbuf.st_size;

done:
        close(f);
        return ret;
}

/*
  this base64 decoder was taken from jitterbug (written by tridge).
  we might need to replace it with a new version
*/
int ldb_base64_decode(char *s)
{
        const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
        int bit_offset=0, byte_offset, idx, i, n;
        uint8_t *d = (uint8_t *)s;
        char *p=NULL;

        n=i=0;

        while (*s && (p=strchr(b64,*s))) {
                idx = (int)(p - b64);
                byte_offset = (i*6)/8;
                bit_offset = (i*6)%8;
                d[byte_offset] &= ~((1<<(8-bit_offset))-1);
                if (bit_offset < 3) {
                        d[byte_offset] |= (idx << (2-bit_offset));
                        n = byte_offset+1;
                } else {
                        d[byte_offset] |= (idx >> (bit_offset-2));
                        d[byte_offset+1] = 0;
                        d[byte_offset+1] |= (idx << (8-(bit_offset-2))) & 0xFF;
                        n = byte_offset+2;
                }
                s++; i++;
        }
        if (bit_offset >= 3) {
                n--;
        }

        if (*s && !p) {
                /* the only termination allowed */
                if (*s != '=') {
                        return -1;
                }
        }

        /* null terminate */
        d[n] = 0;
        return n;
}


/*
  encode as base64
  caller frees
*/
char *ldb_base64_encode(void *mem_ctx, const char *buf, int len)
{
        const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
        int bit_offset, byte_offset, idx, i;
        const uint8_t *d = (const uint8_t *)buf;
        int bytes = (len*8 + 5)/6, pad_bytes = (bytes % 4) ? 4 - (bytes % 4) : 0;
        char *out;

        out = talloc_array(mem_ctx, char, bytes+pad_bytes+1);
        if (!out) return NULL;

        for (i=0;i<bytes;i++) {
                byte_offset = (i*6)/8;
                bit_offset = (i*6)%8;
                if (bit_offset < 3) {
                        idx = (d[byte_offset] >> (2-bit_offset)) & 0x3F;
                } else {
                        idx = (d[byte_offset] << (bit_offset-2)) & 0x3F;
                        if (byte_offset+1 < len) {
                                idx |= (d[byte_offset+1] >> (8-(bit_offset-2)));
                        }
                }
                out[i] = b64[idx];
        }

        for (;i<bytes+pad_bytes;i++)
                out[i] = '=';
        out[i] = 0;

        return out;
}

/*
  see if a buffer should be base64 encoded
*/
int ldb_should_b64_encode(const struct ldb_val *val)
{
        unsigned int i;
        uint8_t *p = val->data;

        if (val->length == 0) {
                return 0;
        }

        if (p[0] == ' ' || p[0] == ':') {
                return 1;
        }

        for (i=0; i<val->length; i++) {
                if (!isprint(p[i]) || p[i] == '\n') {
                        return 1;
                }
        }
        return 0;
}

/* this macro is used to handle the return checking on fprintf_fn() */
#define CHECK_RET do { if (ret < 0) return ret; total += ret; } while (0)

/*
  write a line folded string onto a file
*/
static int fold_string(int (*fprintf_fn)(void *, const char *, ...), void *private_data,
                        const char *buf, size_t length, int start_pos)
{
        unsigned int i;
        int total=0, ret;

        for (i=0;i<length;i++) {
                ret = fprintf_fn(private_data, "%c", buf[i]);
                CHECK_RET;
                if (i != (length-1) && (i + start_pos) % 77 == 0) {
                        ret = fprintf_fn(private_data, "\n ");
                        CHECK_RET;
                }
        }

        return total;
}

#undef CHECK_RET

/*
  encode as base64 to a file
*/
static int base64_encode_f(struct ldb_context *ldb,
                           int (*fprintf_fn)(void *, const char *, ...), 
                           void *private_data,
                           const char *buf, int len, int start_pos)
{
        char *b = ldb_base64_encode(ldb, buf, len);
        int ret;

        if (!b) {
                return -1;
        }

        ret = fold_string(fprintf_fn, private_data, b, strlen(b), start_pos);

        talloc_free(b);
        return ret;
}


static const struct {
        const char *name;
        enum ldb_changetype changetype;
} ldb_changetypes[] = {
        {"add",    LDB_CHANGETYPE_ADD},
        {"delete", LDB_CHANGETYPE_DELETE},
        {"modify", LDB_CHANGETYPE_MODIFY},
        {NULL, 0}
};

/* this macro is used to handle the return checking on fprintf_fn() */
#define CHECK_RET do { if (ret < 0) { talloc_free(mem_ctx); return ret; } total += ret; } while (0)

/*
  write to ldif, using a caller supplied write method
*/
int ldb_ldif_write(struct ldb_context *ldb,
                   int (*fprintf_fn)(void *, const char *, ...), 
                   void *private_data,
                   const struct ldb_ldif *ldif)
{
        TALLOC_CTX *mem_ctx;
        unsigned int i, j;
        int total=0, ret;
        const struct ldb_message *msg;

        mem_ctx = talloc_named_const(NULL, 0, "ldb_ldif_write");

        msg = ldif->msg;

        ret = fprintf_fn(private_data, "dn: %s\n", ldb_dn_linearize(msg->dn, msg->dn));
        CHECK_RET;

        if (ldif->changetype != LDB_CHANGETYPE_NONE) {
                for (i=0;ldb_changetypes[i].name;i++) {
                        if (ldb_changetypes[i].changetype == ldif->changetype) {
                                break;
                        }
                }
                if (!ldb_changetypes[i].name) {
                        ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Invalid ldif changetype %d\n",
                                  ldif->changetype);
                        talloc_free(mem_ctx);
                        return -1;
                }
                ret = fprintf_fn(private_data, "changetype: %s\n", ldb_changetypes[i].name);
                CHECK_RET;
        }

        for (i=0;i<msg->num_elements;i++) {
                const struct ldb_attrib_handler *h;

                h = ldb_attrib_handler(ldb, msg->elements[i].name);

                if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
                        switch (msg->elements[i].flags & LDB_FLAG_MOD_MASK) {
                        case LDB_FLAG_MOD_ADD:
                                fprintf_fn(private_data, "add: %s\n", 
                                           msg->elements[i].name);
                                break;
                        case LDB_FLAG_MOD_DELETE:
                                fprintf_fn(private_data, "delete: %s\n", 
                                           msg->elements[i].name);
                                break;
                        case LDB_FLAG_MOD_REPLACE:
                                fprintf_fn(private_data, "replace: %s\n", 
                                           msg->elements[i].name);
                                break;
                        }
                }

                for (j=0;j<msg->elements[i].num_values;j++) {
                        struct ldb_val v;
                        ret = h->ldif_write_fn(ldb, mem_ctx, &msg->elements[i].values[j], &v);
                        CHECK_RET;
                        if (ldb_should_b64_encode(&v)) {
                                ret = fprintf_fn(private_data, "%s:: ", 
                                                 msg->elements[i].name);
                                CHECK_RET;
                                ret = base64_encode_f(ldb, fprintf_fn, private_data, 
                                                      (char *)v.data, v.length,
                                                      strlen(msg->elements[i].name)+3);
                                CHECK_RET;
                                ret = fprintf_fn(private_data, "\n");
                                CHECK_RET;
                        } else {
                                ret = fprintf_fn(private_data, "%s: ", msg->elements[i].name);
                                CHECK_RET;
                                ret = fold_string(fprintf_fn, private_data,
                                                  (char *)v.data, v.length,
                                                  strlen(msg->elements[i].name)+2);
                                CHECK_RET;
                                ret = fprintf_fn(private_data, "\n");
                                CHECK_RET;
                        }
                        if (v.data != msg->elements[i].values[j].data) {
                                talloc_free(v.data);
                        }
                }
                if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
                        fprintf_fn(private_data, "-\n");
                }
        }
        ret = fprintf_fn(private_data,"\n");
        CHECK_RET;

        return total;
}

#undef CHECK_RET


/*
  pull a ldif chunk, which is defined as a piece of data ending in \n\n or EOF
  this routine removes any RFC2849 continuations and comments

  caller frees
*/
static char *next_chunk(struct ldb_context *ldb, 
                        int (*fgetc_fn)(void *), void *private_data)
{
        size_t alloc_size=0, chunk_size = 0;
        char *chunk = NULL;
        int c;
        int in_comment = 0;

        while ((c = fgetc_fn(private_data)) != EOF) {
                if (chunk_size+1 >= alloc_size) {
                        char *c2;
                        alloc_size += 1024;
                        c2 = talloc_realloc(ldb, chunk, char, alloc_size);
                        if (!c2) {
                                talloc_free(chunk);
                                errno = ENOMEM;
                                return NULL;
                        }
                        chunk = c2;
                }

                if (in_comment) {
                        if (c == '\n') {
                                in_comment = 0;
                        }
                        continue;                       
                }
                
                /* handle continuation lines - see RFC2849 */
                if (c == ' ' && chunk_size > 1 && chunk[chunk_size-1] == '\n') {
                        chunk_size--;
                        continue;
                }
                
                /* chunks are terminated by a double line-feed */
                if (c == '\n' && chunk_size > 0 && chunk[chunk_size-1] == '\n') {
                        chunk[chunk_size-1] = 0;
                        return chunk;
                }

                if (c == '#' && (chunk_size == 0 || chunk[chunk_size-1] == '\n')) {
                        in_comment = 1;
                        continue;
                }

                /* ignore leading blank lines */
                if (chunk_size == 0 && c == '\n') {
                        continue;
                }

                chunk[chunk_size++] = c;
        }

        if (chunk) {
                chunk[chunk_size] = 0;
        }

        return chunk;
}


/* simple ldif attribute parser */
static int next_attr(void *mem_ctx, char **s, const char **attr, struct ldb_val *value)
{
        char *p;
        int base64_encoded = 0;
        int binary_file = 0;

        if (strncmp(*s, "-\n", 2) == 0) {
                value->length = 0;
                *attr = "-";
                *s += 2;
                return 0;
        }

        p = strchr(*s, ':');
        if (!p) {
                return -1;
        }

        *p++ = 0;

        if (*p == ':') {
                base64_encoded = 1;
                p++;
        }

        if (*p == '<') {
                binary_file = 1;
                p++;
        }

        *attr = *s;

        while (*p == ' ' || *p == '\t') {
                p++;
        }

        value->data = (uint8_t *)p;

        p = strchr(p, '\n');

        if (!p) {
                value->length = strlen((char *)value->data);
                *s = ((char *)value->data) + value->length;
        } else {
                value->length = p - (char *)value->data;
                *s = p+1;
                *p = 0;
        }

        if (base64_encoded) {
                int len = ldb_base64_decode((char *)value->data);
                if (len == -1) {
                        /* it wasn't valid base64 data */
                        return -1;
                }
                value->length = len;
        }

        if (binary_file) {
                int len = ldb_read_data_file(mem_ctx, value);
                if (len == -1) {
                        /* an error occured hile trying to retrieve the file */
                        return -1;
                }
        }

        return 0;
}


/*
  free a message from a ldif_read
*/
void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *ldif)
{
        talloc_free(ldif);
}

/*
 read from a LDIF source, creating a ldb_message
*/
struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
                               int (*fgetc_fn)(void *), void *private_data)
{
        struct ldb_ldif *ldif;
        struct ldb_message *msg;
        const char *attr=NULL;
        char *chunk=NULL, *s;
        struct ldb_val value;
        unsigned flags = 0;

        value.data = NULL;

        ldif = talloc(ldb, struct ldb_ldif);
        if (!ldif) return NULL;

        ldif->msg = talloc(ldif, struct ldb_message);
        if (ldif->msg == NULL) {
                talloc_free(ldif);
                return NULL;
        }

        ldif->changetype = LDB_CHANGETYPE_NONE;
        msg = ldif->msg;

        msg->dn = NULL;
        msg->elements = NULL;
        msg->num_elements = 0;
        msg->private_data = NULL;

        chunk = next_chunk(ldb, fgetc_fn, private_data);
        if (!chunk) {
                goto failed;
        }
        talloc_steal(ldif, chunk);

        msg->private_data = chunk;
        s = chunk;

        if (next_attr(ldif, &s, &attr, &value) != 0) {
                goto failed;
        }
        
        /* first line must be a dn */
        if (ldb_attr_cmp(attr, "dn") != 0) {
                ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: First line of ldif must be a dn not '%s'\n", 
                          attr);
                goto failed;
        }

        msg->dn = ldb_dn_explode(msg, (char *)value.data);

        if (msg->dn == NULL) {
                ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Unable to parse dn '%s'\n", 
                                  value.data);
                goto failed;
        }

        while (next_attr(ldif, &s, &attr, &value) == 0) {
                const struct ldb_attrib_handler *h;             
                struct ldb_message_element *el;
                int ret, empty = 0;

                if (ldb_attr_cmp(attr, "changetype") == 0) {
                        int i;
                        for (i=0;ldb_changetypes[i].name;i++) {
                                if (ldb_attr_cmp((char *)value.data, ldb_changetypes[i].name) == 0) {
                                        ldif->changetype = ldb_changetypes[i].changetype;
                                        break;
                                }
                        }
                        if (!ldb_changetypes[i].name) {
                                ldb_debug(ldb, LDB_DEBUG_ERROR, 
                                          "Error: Bad ldif changetype '%s'\n",(char *)value.data);
                        }
                        flags = 0;
                        continue;
                }

                if (ldb_attr_cmp(attr, "add") == 0) {
                        flags = LDB_FLAG_MOD_ADD;
                        empty = 1;
                }
                if (ldb_attr_cmp(attr, "delete") == 0) {
                        flags = LDB_FLAG_MOD_DELETE;
                        empty = 1;
                }
                if (ldb_attr_cmp(attr, "replace") == 0) {
                        flags = LDB_FLAG_MOD_REPLACE;
                        empty = 1;
                }
                if (ldb_attr_cmp(attr, "-") == 0) {
                        flags = 0;
                        continue;
                }

                if (empty) {
                        if (ldb_msg_add_empty(msg, (char *)value.data, flags, NULL) != 0) {
                                goto failed;
                        }
                        continue;
                }
                
                el = &msg->elements[msg->num_elements-1];

                h = ldb_attrib_handler(ldb, attr);

                if (msg->num_elements > 0 && ldb_attr_cmp(attr, el->name) == 0 &&
                    flags == el->flags) {
                        /* its a continuation */
                        el->values = 
                                talloc_realloc(msg->elements, el->values, 
                                                 struct ldb_val, el->num_values+1);
                        if (!el->values) {
                                goto failed;
                        }
                        ret = h->ldif_read_fn(ldb, ldif, &value, &el->values[el->num_values]);
                        if (ret != 0) {
                                goto failed;
                        }
                        if (value.length == 0) {
                                ldb_debug(ldb, LDB_DEBUG_ERROR,
                                          "Error: Attribute value cannot be empty for attribute '%s'\n", el->name);
                                goto failed;
                        }
                        if (value.data != el->values[el->num_values].data) {
                                talloc_steal(el->values, el->values[el->num_values].data);
                        }
                        el->num_values++;
                } else {
                        /* its a new attribute */
                        msg->elements = talloc_realloc(ldif, msg->elements, 
                                                         struct ldb_message_element, 
                                                         msg->num_elements+1);
                        if (!msg->elements) {
                                goto failed;
                        }
                        el = &msg->elements[msg->num_elements];
                        el->flags = flags;
                        el->name = talloc_strdup(msg->elements, attr);
                        el->values = talloc(msg->elements, struct ldb_val);
                        if (!el->values || !el->name) {
                                goto failed;
                        }
                        el->num_values = 1;
                        ret = h->ldif_read_fn(ldb, ldif, &value, &el->values[0]);
                        if (ret != 0) {
                                goto failed;
                        }
                        if (value.data != el->values[0].data) {
                                talloc_steal(el->values, el->values[0].data);
                        }
                        msg->num_elements++;
                }
        }

        return ldif;

failed:
        talloc_free(ldif);
        return NULL;
}



/*
  a wrapper around ldif_read() for reading from FILE*
*/
struct ldif_read_file_state {
        FILE *f;
};

static int fgetc_file(void *private_data)
{
        struct ldif_read_file_state *state =
                (struct ldif_read_file_state *)private_data;
        return fgetc(state->f);
}

struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f)
{
        struct ldif_read_file_state state;
        state.f = f;
        return ldb_ldif_read(ldb, fgetc_file, &state);
}


/*
  a wrapper around ldif_read() for reading from const char*
*/
struct ldif_read_string_state {
        const char *s;
};

static int fgetc_string(void *private_data)
{
        struct ldif_read_string_state *state =
                (struct ldif_read_string_state *)private_data;
        if (state->s[0] != 0) {
                return *state->s++;
        }
        return EOF;
}

struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s)
{
        struct ldif_read_string_state state;
        struct ldb_ldif *ldif;
        state.s = *s;
        ldif = ldb_ldif_read(ldb, fgetc_string, &state);
        *s = state.s;
        return ldif;
}


/*
  wrapper around ldif_write() for a file
*/
struct ldif_write_file_state {
        FILE *f;
};

static int fprintf_file(void *private_data, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);

static int fprintf_file(void *private_data, const char *fmt, ...)
{
        struct ldif_write_file_state *state =
                (struct ldif_write_file_state *)private_data;
        int ret;
        va_list ap;

        va_start(ap, fmt);
        ret = vfprintf(state->f, fmt, ap);
        va_end(ap);
        return ret;
}

int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *ldif)
{
        struct ldif_write_file_state state;
        state.f = f;
        return ldb_ldif_write(ldb, fprintf_file, &state, ldif);
}