4 Copyright (C) Andrew Tridgell 2004
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 3 of the License, or (at your option) any later version.
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 * Component: ldif routines
29 * Description: ldif pack/unpack routines
31 * Author: Andrew Tridgell
35 see RFC2849 for the LDIF format definition
38 #include "ldb_private.h"
39 #include "system/locale.h"
44 static int ldb_read_data_file(TALLOC_CTX *mem_ctx, struct ldb_val *value)
48 int count, size, bytes;
51 const char *fname = (const char *)value->data;
53 if (strncmp(fname, "file://", 7) != 0) {
54 return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
58 f = open(fname, O_RDONLY);
63 if (fstat(f, &statbuf) != 0) {
68 if (statbuf.st_size == 0) {
73 value->data = (uint8_t *)talloc_size(mem_ctx, statbuf.st_size + 1);
74 if (value->data == NULL) {
78 value->data[statbuf.st_size] = 0;
81 size = statbuf.st_size;
82 buf = (char *)value->data;
83 while (count < statbuf.st_size) {
84 bytes = read(f, buf, size);
86 talloc_free(value->data);
95 value->length = statbuf.st_size;
96 ret = statbuf.st_size;
104 this base64 decoder was taken from jitterbug (written by tridge).
105 we might need to replace it with a new version
107 int ldb_base64_decode(char *s)
109 const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
110 int bit_offset=0, byte_offset, idx, i, n;
111 uint8_t *d = (uint8_t *)s;
116 while (*s && (p=strchr(b64,*s))) {
117 idx = (int)(p - b64);
118 byte_offset = (i*6)/8;
119 bit_offset = (i*6)%8;
120 d[byte_offset] &= ~((1<<(8-bit_offset))-1);
121 if (bit_offset < 3) {
122 d[byte_offset] |= (idx << (2-bit_offset));
125 d[byte_offset] |= (idx >> (bit_offset-2));
126 d[byte_offset+1] = 0;
127 d[byte_offset+1] |= (idx << (8-(bit_offset-2))) & 0xFF;
132 if (bit_offset >= 3) {
137 /* the only termination allowed */
153 char *ldb_base64_encode(TALLOC_CTX *mem_ctx, const char *buf, int len)
155 const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
156 int bit_offset, byte_offset, idx, i;
157 const uint8_t *d = (const uint8_t *)buf;
158 int bytes = (len*8 + 5)/6, pad_bytes = (bytes % 4) ? 4 - (bytes % 4) : 0;
161 out = talloc_array(mem_ctx, char, bytes+pad_bytes+1);
162 if (!out) return NULL;
164 for (i=0;i<bytes;i++) {
165 byte_offset = (i*6)/8;
166 bit_offset = (i*6)%8;
167 if (bit_offset < 3) {
168 idx = (d[byte_offset] >> (2-bit_offset)) & 0x3F;
170 idx = (d[byte_offset] << (bit_offset-2)) & 0x3F;
171 if (byte_offset+1 < len) {
172 idx |= (d[byte_offset+1] >> (8-(bit_offset-2)));
178 for (;i<bytes+pad_bytes;i++)
186 see if a buffer should be base64 encoded
188 int ldb_should_b64_encode(struct ldb_context *ldb, const struct ldb_val *val)
191 uint8_t *p = val->data;
193 if (val->length == 0) {
197 if (p[0] == ' ' || p[0] == ':') {
201 for (i=0; i<val->length; i++) {
202 if (!isprint(p[i]) || p[i] == '\n') {
209 /* this macro is used to handle the return checking on fprintf_fn() */
210 #define CHECK_RET do { if (ret < 0) return ret; total += ret; } while (0)
213 write a line folded string onto a file
215 static int fold_string(int (*fprintf_fn)(void *, const char *, ...), void *private_data,
216 const char *buf, size_t length, int start_pos)
221 for (i=0;i<length;i++) {
222 ret = fprintf_fn(private_data, "%c", buf[i]);
224 if (i != (length-1) && (i + start_pos) % 77 == 0) {
225 ret = fprintf_fn(private_data, "\n ");
236 encode as base64 to a file
238 static int base64_encode_f(struct ldb_context *ldb,
239 int (*fprintf_fn)(void *, const char *, ...),
241 const char *buf, int len, int start_pos)
243 char *b = ldb_base64_encode(ldb, buf, len);
250 ret = fold_string(fprintf_fn, private_data, b, strlen(b), start_pos);
257 static const struct {
259 enum ldb_changetype changetype;
260 } ldb_changetypes[] = {
261 {"add", LDB_CHANGETYPE_ADD},
262 {"delete", LDB_CHANGETYPE_DELETE},
263 {"modify", LDB_CHANGETYPE_MODIFY},
267 /* this macro is used to handle the return checking on fprintf_fn() */
268 #define CHECK_RET do { if (ret < 0) { talloc_free(mem_ctx); return ret; } total += ret; } while (0)
271 write to ldif, using a caller supplied write method
273 int ldb_ldif_write(struct ldb_context *ldb,
274 int (*fprintf_fn)(void *, const char *, ...),
276 const struct ldb_ldif *ldif)
282 const struct ldb_message *msg;
284 mem_ctx = talloc_named_const(NULL, 0, "ldb_ldif_write");
287 p = ldb_dn_get_extended_linearized(mem_ctx, msg->dn, 1);
288 ret = fprintf_fn(private_data, "dn: %s\n", p);
292 if (ldif->changetype != LDB_CHANGETYPE_NONE) {
293 for (i=0;ldb_changetypes[i].name;i++) {
294 if (ldb_changetypes[i].changetype == ldif->changetype) {
298 if (!ldb_changetypes[i].name) {
299 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Invalid ldif changetype %d",
301 talloc_free(mem_ctx);
304 ret = fprintf_fn(private_data, "changetype: %s\n", ldb_changetypes[i].name);
308 for (i=0;i<msg->num_elements;i++) {
309 const struct ldb_schema_attribute *a;
311 a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name);
313 if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
314 switch (msg->elements[i].flags & LDB_FLAG_MOD_MASK) {
315 case LDB_FLAG_MOD_ADD:
316 fprintf_fn(private_data, "add: %s\n",
317 msg->elements[i].name);
319 case LDB_FLAG_MOD_DELETE:
320 fprintf_fn(private_data, "delete: %s\n",
321 msg->elements[i].name);
323 case LDB_FLAG_MOD_REPLACE:
324 fprintf_fn(private_data, "replace: %s\n",
325 msg->elements[i].name);
330 for (j=0;j<msg->elements[i].num_values;j++) {
333 ret = a->syntax->ldif_write_fn(ldb, mem_ctx, &msg->elements[i].values[j], &v);
334 if (ret != LDB_SUCCESS) {
335 v = msg->elements[i].values[j];
337 use_b64_encode = !(ldb->flags & LDB_FLG_SHOW_BINARY)
338 && ldb_should_b64_encode(ldb, &v);
339 if (ret != LDB_SUCCESS || use_b64_encode) {
340 ret = fprintf_fn(private_data, "%s:: ",
341 msg->elements[i].name);
343 ret = base64_encode_f(ldb, fprintf_fn, private_data,
344 (char *)v.data, v.length,
345 strlen(msg->elements[i].name)+3);
347 ret = fprintf_fn(private_data, "\n");
350 ret = fprintf_fn(private_data, "%s: ", msg->elements[i].name);
352 if (ldb->flags & LDB_FLG_SHOW_BINARY) {
353 ret = fprintf_fn(private_data, "%*.*s",
354 v.length, v.length, (char *)v.data);
356 ret = fold_string(fprintf_fn, private_data,
357 (char *)v.data, v.length,
358 strlen(msg->elements[i].name)+2);
361 ret = fprintf_fn(private_data, "\n");
364 if (v.data != msg->elements[i].values[j].data) {
368 if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
369 fprintf_fn(private_data, "-\n");
372 ret = fprintf_fn(private_data,"\n");
375 talloc_free(mem_ctx);
384 pull a ldif chunk, which is defined as a piece of data ending in \n\n or EOF
385 this routine removes any RFC2849 continuations and comments
389 static char *next_chunk(struct ldb_context *ldb,
390 int (*fgetc_fn)(void *), void *private_data)
392 size_t alloc_size=0, chunk_size = 0;
397 while ((c = fgetc_fn(private_data)) != EOF) {
398 if (chunk_size+1 >= alloc_size) {
401 c2 = talloc_realloc(ldb, chunk, char, alloc_size);
417 /* handle continuation lines - see RFC2849 */
418 if (c == ' ' && chunk_size > 1 && chunk[chunk_size-1] == '\n') {
423 /* chunks are terminated by a double line-feed */
424 if (c == '\n' && chunk_size > 0 && chunk[chunk_size-1] == '\n') {
425 chunk[chunk_size-1] = 0;
429 if (c == '#' && (chunk_size == 0 || chunk[chunk_size-1] == '\n')) {
434 /* ignore leading blank lines */
435 if (chunk_size == 0 && c == '\n') {
439 chunk[chunk_size++] = c;
443 chunk[chunk_size] = 0;
450 /* simple ldif attribute parser */
451 static int next_attr(TALLOC_CTX *mem_ctx, char **s, const char **attr, struct ldb_val *value)
454 int base64_encoded = 0;
457 if (strncmp(*s, "-\n", 2) == 0) {
483 while (*p == ' ' || *p == '\t') {
487 value->data = (uint8_t *)p;
492 value->length = strlen((char *)value->data);
493 *s = ((char *)value->data) + value->length;
495 value->length = p - (char *)value->data;
500 if (base64_encoded) {
501 int len = ldb_base64_decode((char *)value->data);
503 /* it wasn't valid base64 data */
510 int len = ldb_read_data_file(mem_ctx, value);
512 /* an error occurred while trying to retrieve the file */
522 free a message from a ldif_read
524 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *ldif)
530 read from a LDIF source, creating a ldb_message
532 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
533 int (*fgetc_fn)(void *), void *private_data)
535 struct ldb_ldif *ldif;
536 struct ldb_message *msg;
537 const char *attr=NULL;
538 char *chunk=NULL, *s;
539 struct ldb_val value;
544 ldif = talloc(ldb, struct ldb_ldif);
545 if (!ldif) return NULL;
547 ldif->msg = talloc(ldif, struct ldb_message);
548 if (ldif->msg == NULL) {
553 ldif->changetype = LDB_CHANGETYPE_NONE;
557 msg->elements = NULL;
558 msg->num_elements = 0;
560 chunk = next_chunk(ldb, fgetc_fn, private_data);
564 talloc_steal(ldif, chunk);
568 if (next_attr(ldif, &s, &attr, &value) != 0) {
572 /* first line must be a dn */
573 if (ldb_attr_cmp(attr, "dn") != 0) {
574 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: First line of ldif must be a dn not '%s'",
579 msg->dn = ldb_dn_from_ldb_val(msg, ldb, &value);
581 if ( ! ldb_dn_validate(msg->dn)) {
582 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Unable to parse dn '%s'",
587 while (next_attr(ldif, &s, &attr, &value) == 0) {
588 const struct ldb_schema_attribute *a;
589 struct ldb_message_element *el;
592 if (ldb_attr_cmp(attr, "changetype") == 0) {
594 for (i=0;ldb_changetypes[i].name;i++) {
595 if (ldb_attr_cmp((char *)value.data, ldb_changetypes[i].name) == 0) {
596 ldif->changetype = ldb_changetypes[i].changetype;
600 if (!ldb_changetypes[i].name) {
601 ldb_debug(ldb, LDB_DEBUG_ERROR,
602 "Error: Bad ldif changetype '%s'",(char *)value.data);
608 if (ldb_attr_cmp(attr, "add") == 0) {
609 flags = LDB_FLAG_MOD_ADD;
612 if (ldb_attr_cmp(attr, "delete") == 0) {
613 flags = LDB_FLAG_MOD_DELETE;
616 if (ldb_attr_cmp(attr, "replace") == 0) {
617 flags = LDB_FLAG_MOD_REPLACE;
620 if (ldb_attr_cmp(attr, "-") == 0) {
626 if (ldb_msg_add_empty(msg, (char *)value.data, flags, NULL) != 0) {
632 el = &msg->elements[msg->num_elements-1];
634 a = ldb_schema_attribute_by_name(ldb, attr);
636 if (msg->num_elements > 0 && ldb_attr_cmp(attr, el->name) == 0 &&
637 flags == el->flags) {
638 /* its a continuation */
640 talloc_realloc(msg->elements, el->values,
641 struct ldb_val, el->num_values+1);
645 ret = a->syntax->ldif_read_fn(ldb, el->values, &value, &el->values[el->num_values]);
649 if (value.length == 0) {
650 ldb_debug(ldb, LDB_DEBUG_ERROR,
651 "Error: Attribute value cannot be empty for attribute '%s'", el->name);
654 if (value.data != el->values[el->num_values].data) {
655 talloc_steal(el->values, el->values[el->num_values].data);
659 /* its a new attribute */
660 msg->elements = talloc_realloc(msg, msg->elements,
661 struct ldb_message_element,
662 msg->num_elements+1);
663 if (!msg->elements) {
666 el = &msg->elements[msg->num_elements];
668 el->name = talloc_strdup(msg->elements, attr);
669 el->values = talloc(msg->elements, struct ldb_val);
670 if (!el->values || !el->name) {
674 ret = a->syntax->ldif_read_fn(ldb, el->values, &value, &el->values[0]);
678 if (value.data != el->values[0].data) {
679 talloc_steal(el->values, el->values[0].data);
695 a wrapper around ldif_read() for reading from FILE*
697 struct ldif_read_file_state {
701 static int fgetc_file(void *private_data)
703 struct ldif_read_file_state *state =
704 (struct ldif_read_file_state *)private_data;
705 return fgetc(state->f);
708 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f)
710 struct ldif_read_file_state state;
712 return ldb_ldif_read(ldb, fgetc_file, &state);
717 a wrapper around ldif_read() for reading from const char*
719 struct ldif_read_string_state {
723 static int fgetc_string(void *private_data)
725 struct ldif_read_string_state *state =
726 (struct ldif_read_string_state *)private_data;
727 if (state->s[0] != 0) {
733 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s)
735 struct ldif_read_string_state state;
736 struct ldb_ldif *ldif;
738 ldif = ldb_ldif_read(ldb, fgetc_string, &state);
745 wrapper around ldif_write() for a file
747 struct ldif_write_file_state {
751 static int fprintf_file(void *private_data, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
753 static int fprintf_file(void *private_data, const char *fmt, ...)
755 struct ldif_write_file_state *state =
756 (struct ldif_write_file_state *)private_data;
761 ret = vfprintf(state->f, fmt, ap);
766 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *ldif)
768 struct ldif_write_file_state state;
770 return ldb_ldif_write(ldb, fprintf_file, &state, ldif);
774 wrapper around ldif_write() for a string
776 struct ldif_write_string_state {
780 static int ldif_printf_string(void *private_data, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
782 static int ldif_printf_string(void *private_data, const char *fmt, ...)
784 struct ldif_write_string_state *state =
785 (struct ldif_write_string_state *)private_data;
787 size_t oldlen = talloc_get_size(state->string);
790 state->string = talloc_vasprintf_append(state->string, fmt, ap);
792 if (!state->string) {
796 return talloc_get_size(state->string) - oldlen;
799 char *ldb_ldif_write_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
800 const struct ldb_ldif *ldif)
802 struct ldif_write_string_state state;
803 state.string = talloc_strdup(mem_ctx, "");
807 if (ldb_ldif_write(ldb, ldif_printf_string, &state, ldif) == -1) {
814 convenient function to turn a ldb_message into a string. Useful for
817 char *ldb_ldif_message_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
818 enum ldb_changetype changetype,
819 const struct ldb_message *msg)
821 struct ldb_ldif ldif;
823 ldif.changetype = changetype;
824 ldif.msg = discard_const_p(struct ldb_message, msg);
826 return ldb_ldif_write_string(ldb, mem_ctx, &ldif);