Merge Samba3 and Samba4 together
[ira/wip.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                         CHECK_RET;
332                         if (ldb_should_b64_encode(&v)) {
333                                 ret = fprintf_fn(private_data, "%s:: ", 
334                                                  msg->elements[i].name);
335                                 CHECK_RET;
336                                 ret = base64_encode_f(ldb, fprintf_fn, private_data, 
337                                                       (char *)v.data, v.length,
338                                                       strlen(msg->elements[i].name)+3);
339                                 CHECK_RET;
340                                 ret = fprintf_fn(private_data, "\n");
341                                 CHECK_RET;
342                         } else {
343                                 ret = fprintf_fn(private_data, "%s: ", msg->elements[i].name);
344                                 CHECK_RET;
345                                 ret = fold_string(fprintf_fn, private_data,
346                                                   (char *)v.data, v.length,
347                                                   strlen(msg->elements[i].name)+2);
348                                 CHECK_RET;
349                                 ret = fprintf_fn(private_data, "\n");
350                                 CHECK_RET;
351                         }
352                         if (v.data != msg->elements[i].values[j].data) {
353                                 talloc_free(v.data);
354                         }
355                 }
356                 if (ldif->changetype == LDB_CHANGETYPE_MODIFY) {
357                         fprintf_fn(private_data, "-\n");
358                 }
359         }
360         ret = fprintf_fn(private_data,"\n");
361         CHECK_RET;
362
363         return total;
364 }
365
366 #undef CHECK_RET
367
368
369 /*
370   pull a ldif chunk, which is defined as a piece of data ending in \n\n or EOF
371   this routine removes any RFC2849 continuations and comments
372
373   caller frees
374 */
375 static char *next_chunk(struct ldb_context *ldb, 
376                         int (*fgetc_fn)(void *), void *private_data)
377 {
378         size_t alloc_size=0, chunk_size = 0;
379         char *chunk = NULL;
380         int c;
381         int in_comment = 0;
382
383         while ((c = fgetc_fn(private_data)) != EOF) {
384                 if (chunk_size+1 >= alloc_size) {
385                         char *c2;
386                         alloc_size += 1024;
387                         c2 = talloc_realloc(ldb, chunk, char, alloc_size);
388                         if (!c2) {
389                                 talloc_free(chunk);
390                                 errno = ENOMEM;
391                                 return NULL;
392                         }
393                         chunk = c2;
394                 }
395
396                 if (in_comment) {
397                         if (c == '\n') {
398                                 in_comment = 0;
399                         }
400                         continue;                       
401                 }
402                 
403                 /* handle continuation lines - see RFC2849 */
404                 if (c == ' ' && chunk_size > 1 && chunk[chunk_size-1] == '\n') {
405                         chunk_size--;
406                         continue;
407                 }
408                 
409                 /* chunks are terminated by a double line-feed */
410                 if (c == '\n' && chunk_size > 0 && chunk[chunk_size-1] == '\n') {
411                         chunk[chunk_size-1] = 0;
412                         return chunk;
413                 }
414
415                 if (c == '#' && (chunk_size == 0 || chunk[chunk_size-1] == '\n')) {
416                         in_comment = 1;
417                         continue;
418                 }
419
420                 /* ignore leading blank lines */
421                 if (chunk_size == 0 && c == '\n') {
422                         continue;
423                 }
424
425                 chunk[chunk_size++] = c;
426         }
427
428         if (chunk) {
429                 chunk[chunk_size] = 0;
430         }
431
432         return chunk;
433 }
434
435
436 /* simple ldif attribute parser */
437 static int next_attr(void *mem_ctx, char **s, const char **attr, struct ldb_val *value)
438 {
439         char *p;
440         int base64_encoded = 0;
441         int binary_file = 0;
442
443         if (strncmp(*s, "-\n", 2) == 0) {
444                 value->length = 0;
445                 *attr = "-";
446                 *s += 2;
447                 return 0;
448         }
449
450         p = strchr(*s, ':');
451         if (!p) {
452                 return -1;
453         }
454
455         *p++ = 0;
456
457         if (*p == ':') {
458                 base64_encoded = 1;
459                 p++;
460         }
461
462         if (*p == '<') {
463                 binary_file = 1;
464                 p++;
465         }
466
467         *attr = *s;
468
469         while (*p == ' ' || *p == '\t') {
470                 p++;
471         }
472
473         value->data = (uint8_t *)p;
474
475         p = strchr(p, '\n');
476
477         if (!p) {
478                 value->length = strlen((char *)value->data);
479                 *s = ((char *)value->data) + value->length;
480         } else {
481                 value->length = p - (char *)value->data;
482                 *s = p+1;
483                 *p = 0;
484         }
485
486         if (base64_encoded) {
487                 int len = ldb_base64_decode((char *)value->data);
488                 if (len == -1) {
489                         /* it wasn't valid base64 data */
490                         return -1;
491                 }
492                 value->length = len;
493         }
494
495         if (binary_file) {
496                 int len = ldb_read_data_file(mem_ctx, value);
497                 if (len == -1) {
498                         /* an error occured hile trying to retrieve the file */
499                         return -1;
500                 }
501         }
502
503         return 0;
504 }
505
506
507 /*
508   free a message from a ldif_read
509 */
510 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *ldif)
511 {
512         talloc_free(ldif);
513 }
514
515 /*
516  read from a LDIF source, creating a ldb_message
517 */
518 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
519                                int (*fgetc_fn)(void *), void *private_data)
520 {
521         struct ldb_ldif *ldif;
522         struct ldb_message *msg;
523         const char *attr=NULL;
524         char *chunk=NULL, *s;
525         struct ldb_val value;
526         unsigned flags = 0;
527
528         value.data = NULL;
529
530         ldif = talloc(ldb, struct ldb_ldif);
531         if (!ldif) return NULL;
532
533         ldif->msg = talloc(ldif, struct ldb_message);
534         if (ldif->msg == NULL) {
535                 talloc_free(ldif);
536                 return NULL;
537         }
538
539         ldif->changetype = LDB_CHANGETYPE_NONE;
540         msg = ldif->msg;
541
542         msg->dn = NULL;
543         msg->elements = NULL;
544         msg->num_elements = 0;
545
546         chunk = next_chunk(ldb, fgetc_fn, private_data);
547         if (!chunk) {
548                 goto failed;
549         }
550         talloc_steal(ldif, chunk);
551
552         s = chunk;
553
554         if (next_attr(ldif, &s, &attr, &value) != 0) {
555                 goto failed;
556         }
557         
558         /* first line must be a dn */
559         if (ldb_attr_cmp(attr, "dn") != 0) {
560                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: First line of ldif must be a dn not '%s'\n", 
561                           attr);
562                 goto failed;
563         }
564
565         msg->dn = ldb_dn_new(msg, ldb, (char *)value.data);
566
567         if ( ! ldb_dn_validate(msg->dn)) {
568                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Error: Unable to parse dn '%s'\n", 
569                                   value.data);
570                 goto failed;
571         }
572
573         while (next_attr(ldif, &s, &attr, &value) == 0) {
574                 const struct ldb_schema_attribute *a;
575                 struct ldb_message_element *el;
576                 int ret, empty = 0;
577
578                 if (ldb_attr_cmp(attr, "changetype") == 0) {
579                         int i;
580                         for (i=0;ldb_changetypes[i].name;i++) {
581                                 if (ldb_attr_cmp((char *)value.data, ldb_changetypes[i].name) == 0) {
582                                         ldif->changetype = ldb_changetypes[i].changetype;
583                                         break;
584                                 }
585                         }
586                         if (!ldb_changetypes[i].name) {
587                                 ldb_debug(ldb, LDB_DEBUG_ERROR, 
588                                           "Error: Bad ldif changetype '%s'\n",(char *)value.data);
589                         }
590                         flags = 0;
591                         continue;
592                 }
593
594                 if (ldb_attr_cmp(attr, "add") == 0) {
595                         flags = LDB_FLAG_MOD_ADD;
596                         empty = 1;
597                 }
598                 if (ldb_attr_cmp(attr, "delete") == 0) {
599                         flags = LDB_FLAG_MOD_DELETE;
600                         empty = 1;
601                 }
602                 if (ldb_attr_cmp(attr, "replace") == 0) {
603                         flags = LDB_FLAG_MOD_REPLACE;
604                         empty = 1;
605                 }
606                 if (ldb_attr_cmp(attr, "-") == 0) {
607                         flags = 0;
608                         continue;
609                 }
610
611                 if (empty) {
612                         if (ldb_msg_add_empty(msg, (char *)value.data, flags, NULL) != 0) {
613                                 goto failed;
614                         }
615                         continue;
616                 }
617                 
618                 el = &msg->elements[msg->num_elements-1];
619
620                 a = ldb_schema_attribute_by_name(ldb, attr);
621
622                 if (msg->num_elements > 0 && ldb_attr_cmp(attr, el->name) == 0 &&
623                     flags == el->flags) {
624                         /* its a continuation */
625                         el->values = 
626                                 talloc_realloc(msg->elements, el->values, 
627                                                  struct ldb_val, el->num_values+1);
628                         if (!el->values) {
629                                 goto failed;
630                         }
631                         ret = a->syntax->ldif_read_fn(ldb, ldif, &value, &el->values[el->num_values]);
632                         if (ret != 0) {
633                                 goto failed;
634                         }
635                         if (value.length == 0) {
636                                 ldb_debug(ldb, LDB_DEBUG_ERROR,
637                                           "Error: Attribute value cannot be empty for attribute '%s'\n", el->name);
638                                 goto failed;
639                         }
640                         if (value.data != el->values[el->num_values].data) {
641                                 talloc_steal(el->values, el->values[el->num_values].data);
642                         }
643                         el->num_values++;
644                 } else {
645                         /* its a new attribute */
646                         msg->elements = talloc_realloc(ldif, msg->elements, 
647                                                          struct ldb_message_element, 
648                                                          msg->num_elements+1);
649                         if (!msg->elements) {
650                                 goto failed;
651                         }
652                         el = &msg->elements[msg->num_elements];
653                         el->flags = flags;
654                         el->name = talloc_strdup(msg->elements, attr);
655                         el->values = talloc(msg->elements, struct ldb_val);
656                         if (!el->values || !el->name) {
657                                 goto failed;
658                         }
659                         el->num_values = 1;
660                         ret = a->syntax->ldif_read_fn(ldb, ldif, &value, &el->values[0]);
661                         if (ret != 0) {
662                                 goto failed;
663                         }
664                         if (value.data != el->values[0].data) {
665                                 talloc_steal(el->values, el->values[0].data);
666                         }
667                         msg->num_elements++;
668                 }
669         }
670
671         return ldif;
672
673 failed:
674         talloc_free(ldif);
675         return NULL;
676 }
677
678
679
680 /*
681   a wrapper around ldif_read() for reading from FILE*
682 */
683 struct ldif_read_file_state {
684         FILE *f;
685 };
686
687 static int fgetc_file(void *private_data)
688 {
689         struct ldif_read_file_state *state =
690                 (struct ldif_read_file_state *)private_data;
691         return fgetc(state->f);
692 }
693
694 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f)
695 {
696         struct ldif_read_file_state state;
697         state.f = f;
698         return ldb_ldif_read(ldb, fgetc_file, &state);
699 }
700
701
702 /*
703   a wrapper around ldif_read() for reading from const char*
704 */
705 struct ldif_read_string_state {
706         const char *s;
707 };
708
709 static int fgetc_string(void *private_data)
710 {
711         struct ldif_read_string_state *state =
712                 (struct ldif_read_string_state *)private_data;
713         if (state->s[0] != 0) {
714                 return *state->s++;
715         }
716         return EOF;
717 }
718
719 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char **s)
720 {
721         struct ldif_read_string_state state;
722         struct ldb_ldif *ldif;
723         state.s = *s;
724         ldif = ldb_ldif_read(ldb, fgetc_string, &state);
725         *s = state.s;
726         return ldif;
727 }
728
729
730 /*
731   wrapper around ldif_write() for a file
732 */
733 struct ldif_write_file_state {
734         FILE *f;
735 };
736
737 static int fprintf_file(void *private_data, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
738
739 static int fprintf_file(void *private_data, const char *fmt, ...)
740 {
741         struct ldif_write_file_state *state =
742                 (struct ldif_write_file_state *)private_data;
743         int ret;
744         va_list ap;
745
746         va_start(ap, fmt);
747         ret = vfprintf(state->f, fmt, ap);
748         va_end(ap);
749         return ret;
750 }
751
752 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *ldif)
753 {
754         struct ldif_write_file_state state;
755         state.f = f;
756         return ldb_ldif_write(ldb, fprintf_file, &state, ldif);
757 }