69490e670bf98be466d2061f098e08534c3a6b92
[kai/samba.git] / source4 / lib / ldb / common / ldb_ldif.c
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  2004
5
6      ** NOTE! The following LGPL license applies to the ldb
7      ** library. This does NOT imply that all of Samba is released
8      ** under the LGPL
9    
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.
14
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.
19
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/>.
22 */
23
24 /*
25  *  Name: ldb
26  *
27  *  Component: ldif routines
28  *
29  *  Description: ldif pack/unpack routines
30  *
31  *  Author: Andrew Tridgell
32  */
33
34 /*
35   see RFC2849 for the LDIF format definition
36 */
37
38 #include "ldb_includes.h"
39 #include "system/locale.h"
40
41 /*
42   
43 */
44 static int ldb_read_data_file(void *mem_ctx, struct ldb_val *value)
45 {
46         struct stat statbuf;
47         char *buf;
48         int count, size, bytes;
49         int ret;
50         int f;
51         const char *fname = (const char *)value->data;
52
53         if (strncmp(fname, "file://", 7) != 0) {
54                 return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
55         }
56         fname += 7;
57
58         f = open(fname, O_RDONLY);
59         if (f == -1) {
60                 return -1;
61         }
62
63         if (fstat(f, &statbuf) != 0) {
64                 ret = -1;
65                 goto done;
66         }
67
68         if (statbuf.st_size == 0) {
69                 ret = -1;
70                 goto done;
71         }
72
73         value->data = (uint8_t *)talloc_size(mem_ctx, statbuf.st_size + 1);
74         if (value->data == NULL) {
75                 ret = -1;
76                 goto done;
77         }
78         value->data[statbuf.st_size] = 0;
79
80         count = 0;
81         size = statbuf.st_size;
82         buf = (char *)value->data;
83         while (count < statbuf.st_size) {
84                 bytes = read(f, buf, size);
85                 if (bytes == -1) {
86                         talloc_free(value->data);
87                         ret = -1;
88                         goto done;
89                 }
90                 count += bytes;
91                 buf += bytes;
92                 size -= bytes;
93         }
94
95         value->length = statbuf.st_size;
96         ret = statbuf.st_size;
97
98 done:
99         close(f);
100         return ret;
101 }
102
103 /*
104   this base64 decoder was taken from jitterbug (written by tridge).
105   we might need to replace it with a new version
106 */
107 int ldb_base64_decode(char *s)
108 {
109         const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
110         int bit_offset=0, byte_offset, idx, i, n;
111         uint8_t *d = (uint8_t *)s;
112         char *p=NULL;
113
114         n=i=0;
115
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));
123                         n = byte_offset+1;
124                 } else {
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;
128                         n = byte_offset+2;
129                 }
130                 s++; i++;
131         }
132         if (bit_offset >= 3) {
133                 n--;
134         }
135
136         if (*s && !p) {
137                 /* the only termination allowed */
138                 if (*s != '=') {
139                         return -1;
140                 }
141         }
142
143         /* null terminate */
144         d[n] = 0;
145         return n;
146 }
147
148
149 /*
150   encode as base64
151   caller frees
152 */
153 char *ldb_base64_encode(void *mem_ctx, const char *buf, int len)
154 {
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;
159         char *out;
160
161         out = talloc_array(mem_ctx, char, bytes+pad_bytes+1);
162         if (!out) return NULL;
163
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;
169                 } else {
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)));
173                         }
174                 }
175                 out[i] = b64[idx];
176         }
177
178         for (;i<bytes+pad_bytes;i++)
179                 out[i] = '=';
180         out[i] = 0;
181
182         return out;
183 }
184
185 /*
186   see if a buffer should be base64 encoded
187 */
188 int ldb_should_b64_encode(const struct ldb_val *val)
189 {
190         unsigned int i;
191         uint8_t *p = val->data;
192
193         if (val->length == 0) {
194                 return 0;
195         }
196
197         if (p[0] == ' ' || p[0] == ':') {
198                 return 1;
199         }
200
201         for (i=0; i<val->length; i++) {
202                 if (!isprint(p[i]) || p[i] == '\n') {
203                         return 1;
204                 }
205         }
206         return 0;
207 }
208
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)
211
212 /*
213   write a line folded string onto a file
214 */
215 static int fold_string(int (*fprintf_fn)(void *, const char *, ...), void *private_data,
216                         const char *buf, size_t length, int start_pos)
217 {
218         unsigned int i;
219         int total=0, ret;
220
221         for (i=0;i<length;i++) {
222                 ret = fprintf_fn(private_data, "%c", buf[i]);
223                 CHECK_RET;
224                 if (i != (length-1) && (i + start_pos) % 77 == 0) {
225                         ret = fprintf_fn(private_data, "\n ");
226                         CHECK_RET;
227                 }
228         }
229
230         return total;
231 }
232
233 #undef CHECK_RET
234
235 /*
236   encode as base64 to a file
237 */
238 static int base64_encode_f(struct ldb_context *ldb,
239                            int (*fprintf_fn)(void *, const char *, ...), 
240                            void *private_data,
241                            const char *buf, int len, int start_pos)
242 {
243         char *b = ldb_base64_encode(ldb, buf, len);
244         int ret;
245
246         if (!b) {
247                 return -1;
248         }
249
250         ret = fold_string(fprintf_fn, private_data, b, strlen(b), start_pos);
251
252         talloc_free(b);
253         return ret;
254 }
255
256
257 static const struct {
258         const char *name;
259         enum ldb_changetype changetype;
260 } ldb_changetypes[] = {
261         {"add",    LDB_CHANGETYPE_ADD},
262         {"delete", LDB_CHANGETYPE_DELETE},
263         {"modify", LDB_CHANGETYPE_MODIFY},
264         {NULL, 0}
265 };
266
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)
269
270 /*
271   write to ldif, using a caller supplied write method
272 */
273 int ldb_ldif_write(struct ldb_context *ldb,
274                    int (*fprintf_fn)(void *, const char *, ...), 
275                    void *private_data,
276                    const struct ldb_ldif *ldif)
277 {
278         TALLOC_CTX *mem_ctx;
279         unsigned int i, j;
280         int total=0, ret;
281         const struct ldb_message *msg;
282
283         mem_ctx = talloc_named_const(NULL, 0, "ldb_ldif_write");
284
285         msg = ldif->msg;
286
287         ret = fprintf_fn(private_data, "dn: %s\n", ldb_dn_get_linearized(msg->dn));
288         CHECK_RET;
289
290         if (ldif->changetype != LDB_CHANGETYPE_NONE) {
291                 for (i=0;ldb_changetypes[i].name;i++) {
292                         if (ldb_changetypes[i].changetype == ldif->changetype) {
293                                 break;
294                         }
295                 }
296                 if (!ldb_changetypes[i].name) {
297                         ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Invalid ldif changetype %d\n",
298                                   ldif->changetype);
299                         talloc_free(mem_ctx);
300                         return -1;
301                 }
302                 ret = fprintf_fn(private_data, "changetype: %s\n", ldb_changetypes[i].name);
303                 CHECK_RET;
304         }
305
306         for (i=0;i<msg->num_elements;i++) {
307                 const struct ldb_schema_attribute *a;
308
309                 a = ldb_schema_attribute_by_name(ldb, msg->elements[i].name);
310
311                 if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
312                         switch (msg->elements[i].flags & LDB_FLAG_MOD_MASK) {
313                         case LDB_FLAG_MOD_ADD:
314                                 fprintf_fn(private_data, "add: %s\n", 
315                                            msg->elements[i].name);
316                                 break;
317                         case LDB_FLAG_MOD_DELETE:
318                                 fprintf_fn(private_data, "delete: %s\n", 
319                                            msg->elements[i].name);
320                                 break;
321                         case LDB_FLAG_MOD_REPLACE:
322                                 fprintf_fn(private_data, "replace: %s\n", 
323                                            msg->elements[i].name);
324                                 break;
325                         }
326                 }
327
328                 for (j=0;j<msg->elements[i].num_values;j++) {
329                         struct ldb_val v;
330                         ret = a->syntax->ldif_write_fn(ldb, mem_ctx, &msg->elements[i].values[j], &v);
331                         if (ret != LDB_SUCCESS) {
332                                 v = msg->elements[i].values[j];
333                         }
334                         if (ret != LDB_SUCCESS || ldb_should_b64_encode(&v)) {
335                                 ret = fprintf_fn(private_data, "%s:: ", 
336                                                  msg->elements[i].name);
337                                 CHECK_RET;
338                                 ret = base64_encode_f(ldb, fprintf_fn, private_data, 
339                                                       (char *)v.data, v.length,
340                                                       strlen(msg->elements[i].name)+3);
341                                 CHECK_RET;
342                                 ret = fprintf_fn(private_data, "\n");
343                                 CHECK_RET;
344                         } else {
345                                 ret = fprintf_fn(private_data, "%s: ", msg->elements[i].name);
346                                 CHECK_RET;
347                                 ret = fold_string(fprintf_fn, private_data,
348                                                   (char *)v.data, v.length,
349                                                   strlen(msg->elements[i].name)+2);
350                                 CHECK_RET;
351                                 ret = fprintf_fn(private_data, "\n");
352                                 CHECK_RET;
353                         }
354                         if (v.data != msg->elements[i].values[j].data) {
355                                 talloc_free(v.data);
356                         }
357                 }
358                 if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
359                         fprintf_fn(private_data, "-\n");
360                 }
361         }
362         ret = fprintf_fn(private_data,"\n");
363         CHECK_RET;
364
365         return total;
366 }
367
368 #undef CHECK_RET
369
370
371 /*
372   pull a ldif chunk, which is defined as a piece of data ending in \n\n or EOF
373   this routine removes any RFC2849 continuations and comments
374
375   caller frees
376 */
377 static char *next_chunk(struct ldb_context *ldb, 
378                         int (*fgetc_fn)(void *), void *private_data)
379 {
380         size_t alloc_size=0, chunk_size = 0;
381         char *chunk = NULL;
382         int c;
383         int in_comment = 0;
384
385         while ((c = fgetc_fn(private_data)) != EOF) {
386                 if (chunk_size+1 >= alloc_size) {
387                         char *c2;
388                         alloc_size += 1024;
389                         c2 = talloc_realloc(ldb, chunk, char, alloc_size);
390                         if (!c2) {
391                                 talloc_free(chunk);
392                                 errno = ENOMEM;
393                                 return NULL;
394                         }
395                         chunk = c2;
396                 }
397
398                 if (in_comment) {
399                         if (c == '\n') {
400                                 in_comment = 0;
401                         }
402                         continue;                       
403                 }
404                 
405                 /* handle continuation lines - see RFC2849 */
406                 if (c == ' ' && chunk_size > 1 && chunk[chunk_size-1] == '\n') {
407                         chunk_size--;
408                         continue;
409                 }
410                 
411                 /* chunks are terminated by a double line-feed */
412                 if (c == '\n' && chunk_size > 0 && chunk[chunk_size-1] == '\n') {
413                         chunk[chunk_size-1] = 0;
414                         return chunk;
415                 }
416
417                 if (c == '#' && (chunk_size == 0 || chunk[chunk_size-1] == '\n')) {
418                         in_comment = 1;
419                         continue;
420                 }
421
422                 /* ignore leading blank lines */
423                 if (chunk_size == 0 && c == '\n') {
424                         continue;
425                 }
426
427                 chunk[chunk_size++] = c;
428         }
429
430         if (chunk) {
431                 chunk[chunk_size] = 0;
432         }
433
434         return chunk;
435 }
436
437
438 /* simple ldif attribute parser */
439 static int next_attr(void *mem_ctx, char **s, const char **attr, struct ldb_val *value)
440 {
441         char *p;
442         int base64_encoded = 0;
443         int binary_file = 0;
444
445         if (strncmp(*s, "-\n", 2) == 0) {
446                 value->length = 0;
447                 *attr = "-";
448                 *s += 2;
449                 return 0;
450         }
451
452         p = strchr(*s, ':');
453         if (!p) {
454                 return -1;
455         }
456
457         *p++ = 0;
458
459         if (*p == ':') {
460                 base64_encoded = 1;
461                 p++;
462         }
463
464         if (*p == '<') {
465                 binary_file = 1;
466                 p++;
467         }
468
469         *attr = *s;
470
471         while (*p == ' ' || *p == '\t') {
472                 p++;
473         }
474
475         value->data = (uint8_t *)p;
476
477         p = strchr(p, '\n');
478
479         if (!p) {
480                 value->length = strlen((char *)value->data);
481                 *s = ((char *)value->data) + value->length;
482         } else {
483                 value->length = p - (char *)value->data;
484                 *s = p+1;
485                 *p = 0;
486         }
487
488         if (base64_encoded) {
489                 int len = ldb_base64_decode((char *)value->data);
490                 if (len == -1) {
491                         /* it wasn't valid base64 data */
492                         return -1;
493                 }
494                 value->length = len;
495         }
496
497         if (binary_file) {
498                 int len = ldb_read_data_file(mem_ctx, value);
499                 if (len == -1) {
500                         /* an error occured hile trying to retrieve the file */
501                         return -1;
502                 }
503         }
504
505         return 0;
506 }
507
508
509 /*
510   free a message from a ldif_read
511 */
512 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *ldif)
513 {
514         talloc_free(ldif);
515 }
516
517 /*
518  read from a LDIF source, creating a ldb_message
519 */
520 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
521                                int (*fgetc_fn)(void *), void *private_data)
522 {
523         struct ldb_ldif *ldif;
524         struct ldb_message *msg;
525         const char *attr=NULL;
526         char *chunk=NULL, *s;
527         struct ldb_val value;
528         unsigned flags = 0;
529
530         value.data = NULL;
531
532         ldif = talloc(ldb, struct ldb_ldif);
533         if (!ldif) return NULL;
534
535         ldif->msg = talloc(ldif, struct ldb_message);
536         if (ldif->msg == NULL) {
537                 talloc_free(ldif);
538                 return NULL;
539         }
540
541         ldif->changetype = LDB_CHANGETYPE_NONE;
542         msg = ldif->msg;
543
544         msg->dn = NULL;
545         msg->elements = NULL;
546         msg->num_elements = 0;
547
548         chunk = next_chunk(ldb, fgetc_fn, private_data);
549         if (!chunk) {
550                 goto failed;
551         }
552         talloc_steal(ldif, chunk);
553
554         s = chunk;
555
556         if (next_attr(ldif, &s, &attr, &value) != 0) {
557                 goto failed;
558         }
559         
560         /* first line must be a dn */
561         if (ldb_attr_cmp(attr, "dn") != 0) {
562                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: First line of ldif must be a dn not '%s'\n", 
563                           attr);
564                 goto failed;
565         }
566
567         msg->dn = ldb_dn_from_ldb_val(msg, ldb, &value);
568
569         if ( ! ldb_dn_validate(msg->dn)) {
570                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Unable to parse dn '%s'\n", 
571                           (char *)value.data);
572                 goto failed;
573         }
574
575         while (next_attr(ldif, &s, &attr, &value) == 0) {
576                 const struct ldb_schema_attribute *a;
577                 struct ldb_message_element *el;
578                 int ret, empty = 0;
579
580                 if (ldb_attr_cmp(attr, "changetype") == 0) {
581                         int i;
582                         for (i=0;ldb_changetypes[i].name;i++) {
583                                 if (ldb_attr_cmp((char *)value.data, ldb_changetypes[i].name) == 0) {
584                                         ldif->changetype = ldb_changetypes[i].changetype;
585                                         break;
586                                 }
587                         }
588                         if (!ldb_changetypes[i].name) {
589                                 ldb_debug(ldb, LDB_DEBUG_ERROR, 
590                                           "Error: Bad ldif changetype '%s'\n",(char *)value.data);
591                         }
592                         flags = 0;
593                         continue;
594                 }
595
596                 if (ldb_attr_cmp(attr, "add") == 0) {
597                         flags = LDB_FLAG_MOD_ADD;
598                         empty = 1;
599                 }
600                 if (ldb_attr_cmp(attr, "delete") == 0) {
601                         flags = LDB_FLAG_MOD_DELETE;
602                         empty = 1;
603                 }
604                 if (ldb_attr_cmp(attr, "replace") == 0) {
605                         flags = LDB_FLAG_MOD_REPLACE;
606                         empty = 1;
607                 }
608                 if (ldb_attr_cmp(attr, "-") == 0) {
609                         flags = 0;
610                         continue;
611                 }
612
613                 if (empty) {
614                         if (ldb_msg_add_empty(msg, (char *)value.data, flags, NULL) != 0) {
615                                 goto failed;
616                         }
617                         continue;
618                 }
619                 
620                 el = &msg->elements[msg->num_elements-1];
621
622                 a = ldb_schema_attribute_by_name(ldb, attr);
623
624                 if (msg->num_elements > 0 && ldb_attr_cmp(attr, el->name) == 0 &&
625                     flags == el->flags) {
626                         /* its a continuation */
627                         el->values = 
628                                 talloc_realloc(msg->elements, el->values, 
629                                                  struct ldb_val, el->num_values+1);
630                         if (!el->values) {
631                                 goto failed;
632                         }
633                         ret = a->syntax->ldif_read_fn(ldb, ldif, &value, &el->values[el->num_values]);
634                         if (ret != 0) {
635                                 goto failed;
636                         }
637                         if (value.length == 0) {
638                                 ldb_debug(ldb, LDB_DEBUG_ERROR,
639                                           "Error: Attribute value cannot be empty for attribute '%s'\n", el->name);
640                                 goto failed;
641                         }
642                         if (value.data != el->values[el->num_values].data) {
643                                 talloc_steal(el->values, el->values[el->num_values].data);
644                         }
645                         el->num_values++;
646                 } else {
647                         /* its a new attribute */
648                         msg->elements = talloc_realloc(ldif, msg->elements, 
649                                                          struct ldb_message_element, 
650                                                          msg->num_elements+1);
651                         if (!msg->elements) {
652                                 goto failed;
653                         }
654                         el = &msg->elements[msg->num_elements];
655                         el->flags = flags;
656                         el->name = talloc_strdup(msg->elements, attr);
657                         el->values = talloc(msg->elements, struct ldb_val);
658                         if (!el->values || !el->name) {
659                                 goto failed;
660                         }
661                         el->num_values = 1;
662                         ret = a->syntax->ldif_read_fn(ldb, ldif, &value, &el->values[0]);
663                         if (ret != 0) {
664                                 goto failed;
665                         }
666                         if (value.data != el->values[0].data) {
667                                 talloc_steal(el->values, el->values[0].data);
668                         }
669                         msg->num_elements++;
670                 }
671         }
672
673         return ldif;
674
675 failed:
676         talloc_free(ldif);
677         return NULL;
678 }
679
680
681
682 /*
683   a wrapper around ldif_read() for reading from FILE*
684 */
685 struct ldif_read_file_state {
686         FILE *f;
687 };
688
689 static int fgetc_file(void *private_data)
690 {
691         struct ldif_read_file_state *state =
692                 (struct ldif_read_file_state *)private_data;
693         return fgetc(state->f);
694 }
695
696 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f)
697 {
698         struct ldif_read_file_state state;
699         state.f = f;
700         return ldb_ldif_read(ldb, fgetc_file, &state);
701 }
702
703
704 /*
705   a wrapper around ldif_read() for reading from const char*
706 */
707 struct ldif_read_string_state {
708         const char *s;
709 };
710
711 static int fgetc_string(void *private_data)
712 {
713         struct ldif_read_string_state *state =
714                 (struct ldif_read_string_state *)private_data;
715         if (state->s[0] != 0) {
716                 return *state->s++;
717         }
718         return EOF;
719 }
720
721 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s)
722 {
723         struct ldif_read_string_state state;
724         struct ldb_ldif *ldif;
725         state.s = *s;
726         ldif = ldb_ldif_read(ldb, fgetc_string, &state);
727         *s = state.s;
728         return ldif;
729 }
730
731
732 /*
733   wrapper around ldif_write() for a file
734 */
735 struct ldif_write_file_state {
736         FILE *f;
737 };
738
739 static int fprintf_file(void *private_data, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
740
741 static int fprintf_file(void *private_data, const char *fmt, ...)
742 {
743         struct ldif_write_file_state *state =
744                 (struct ldif_write_file_state *)private_data;
745         int ret;
746         va_list ap;
747
748         va_start(ap, fmt);
749         ret = vfprintf(state->f, fmt, ap);
750         va_end(ap);
751         return ret;
752 }
753
754 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *ldif)
755 {
756         struct ldif_write_file_state state;
757         state.f = f;
758         return ldb_ldif_write(ldb, fprintf_file, &state, ldif);
759 }