txt_db.c revision 280304
1/* crypto/txt_db/txt_db.c */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
8 *
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to.  The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 *
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 *    notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 *    notice, this list of conditions and the following disclaimer in the
30 *    documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 *    must display the following acknowledgement:
33 *    "This product includes cryptographic software written by
34 *     Eric Young (eay@cryptsoft.com)"
35 *    The word 'cryptographic' can be left out if the rouines from the library
36 *    being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 *    the apps directory (application code) you must include an acknowledgement:
39 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 *
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed.  i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58
59#include <stdio.h>
60#include <stdlib.h>
61#include <string.h>
62#include "cryptlib.h"
63#include <openssl/buffer.h>
64#include <openssl/txt_db.h>
65
66#undef BUFSIZE
67#define BUFSIZE 512
68
69const char TXT_DB_version[] = "TXT_DB" OPENSSL_VERSION_PTEXT;
70
71TXT_DB *TXT_DB_read(BIO *in, int num)
72{
73    TXT_DB *ret = NULL;
74    int er = 1;
75    int esc = 0;
76    long ln = 0;
77    int i, add, n;
78    int size = BUFSIZE;
79    int offset = 0;
80    char *p, *f;
81    OPENSSL_STRING *pp;
82    BUF_MEM *buf = NULL;
83
84    if ((buf = BUF_MEM_new()) == NULL)
85        goto err;
86    if (!BUF_MEM_grow(buf, size))
87        goto err;
88
89    if ((ret = OPENSSL_malloc(sizeof(TXT_DB))) == NULL)
90        goto err;
91    ret->num_fields = num;
92    ret->index = NULL;
93    ret->qual = NULL;
94    if ((ret->data = sk_OPENSSL_PSTRING_new_null()) == NULL)
95        goto err;
96    if ((ret->index = OPENSSL_malloc(sizeof(*ret->index) * num)) == NULL)
97        goto err;
98    if ((ret->qual = OPENSSL_malloc(sizeof(*(ret->qual)) * num)) == NULL)
99        goto err;
100    for (i = 0; i < num; i++) {
101        ret->index[i] = NULL;
102        ret->qual[i] = NULL;
103    }
104
105    add = (num + 1) * sizeof(char *);
106    buf->data[size - 1] = '\0';
107    offset = 0;
108    for (;;) {
109        if (offset != 0) {
110            size += BUFSIZE;
111            if (!BUF_MEM_grow_clean(buf, size))
112                goto err;
113        }
114        buf->data[offset] = '\0';
115        BIO_gets(in, &(buf->data[offset]), size - offset);
116        ln++;
117        if (buf->data[offset] == '\0')
118            break;
119        if ((offset == 0) && (buf->data[0] == '#'))
120            continue;
121        i = strlen(&(buf->data[offset]));
122        offset += i;
123        if (buf->data[offset - 1] != '\n')
124            continue;
125        else {
126            buf->data[offset - 1] = '\0'; /* blat the '\n' */
127            if (!(p = OPENSSL_malloc(add + offset)))
128                goto err;
129            offset = 0;
130        }
131        pp = (char **)p;
132        p += add;
133        n = 0;
134        pp[n++] = p;
135        i = 0;
136        f = buf->data;
137
138        esc = 0;
139        for (;;) {
140            if (*f == '\0')
141                break;
142            if (*f == '\t') {
143                if (esc)
144                    p--;
145                else {
146                    *(p++) = '\0';
147                    f++;
148                    if (n >= num)
149                        break;
150                    pp[n++] = p;
151                    continue;
152                }
153            }
154            esc = (*f == '\\');
155            *(p++) = *(f++);
156        }
157        *(p++) = '\0';
158        if ((n != num) || (*f != '\0')) {
159#if !defined(OPENSSL_NO_STDIO) && !defined(OPENSSL_SYS_WIN16) /* temporary
160                                                               * fix :-( */
161            fprintf(stderr,
162                    "wrong number of fields on line %ld (looking for field %d, got %d, '%s' left)\n",
163                    ln, num, n, f);
164#endif
165            er = 2;
166            goto err;
167        }
168        pp[n] = p;
169        if (!sk_OPENSSL_PSTRING_push(ret->data, pp)) {
170#if !defined(OPENSSL_NO_STDIO) && !defined(OPENSSL_SYS_WIN16) /* temporary
171                                                               * fix :-( */
172            fprintf(stderr, "failure in sk_push\n");
173#endif
174            er = 2;
175            goto err;
176        }
177    }
178    er = 0;
179 err:
180    BUF_MEM_free(buf);
181    if (er) {
182#if !defined(OPENSSL_NO_STDIO) && !defined(OPENSSL_SYS_WIN16)
183        if (er == 1)
184            fprintf(stderr, "OPENSSL_malloc failure\n");
185#endif
186        if (ret != NULL) {
187            if (ret->data != NULL)
188                sk_OPENSSL_PSTRING_free(ret->data);
189            if (ret->index != NULL)
190                OPENSSL_free(ret->index);
191            if (ret->qual != NULL)
192                OPENSSL_free(ret->qual);
193            if (ret != NULL)
194                OPENSSL_free(ret);
195        }
196        return (NULL);
197    } else
198        return (ret);
199}
200
201OPENSSL_STRING *TXT_DB_get_by_index(TXT_DB *db, int idx,
202                                    OPENSSL_STRING *value)
203{
204    OPENSSL_STRING *ret;
205    LHASH_OF(OPENSSL_STRING) *lh;
206
207    if (idx >= db->num_fields) {
208        db->error = DB_ERROR_INDEX_OUT_OF_RANGE;
209        return (NULL);
210    }
211    lh = db->index[idx];
212    if (lh == NULL) {
213        db->error = DB_ERROR_NO_INDEX;
214        return (NULL);
215    }
216    ret = lh_OPENSSL_STRING_retrieve(lh, value);
217    db->error = DB_ERROR_OK;
218    return (ret);
219}
220
221int TXT_DB_create_index(TXT_DB *db, int field, int (*qual) (OPENSSL_STRING *),
222                        LHASH_HASH_FN_TYPE hash, LHASH_COMP_FN_TYPE cmp)
223{
224    LHASH_OF(OPENSSL_STRING) *idx;
225    OPENSSL_STRING *r;
226    int i, n;
227
228    if (field >= db->num_fields) {
229        db->error = DB_ERROR_INDEX_OUT_OF_RANGE;
230        return (0);
231    }
232    /* FIXME: we lose type checking at this point */
233    if ((idx = (LHASH_OF(OPENSSL_STRING) *)lh_new(hash, cmp)) == NULL) {
234        db->error = DB_ERROR_MALLOC;
235        return (0);
236    }
237    n = sk_OPENSSL_PSTRING_num(db->data);
238    for (i = 0; i < n; i++) {
239        r = sk_OPENSSL_PSTRING_value(db->data, i);
240        if ((qual != NULL) && (qual(r) == 0))
241            continue;
242        if ((r = lh_OPENSSL_STRING_insert(idx, r)) != NULL) {
243            db->error = DB_ERROR_INDEX_CLASH;
244            db->arg1 = sk_OPENSSL_PSTRING_find(db->data, r);
245            db->arg2 = i;
246            lh_OPENSSL_STRING_free(idx);
247            return (0);
248        }
249    }
250    if (db->index[field] != NULL)
251        lh_OPENSSL_STRING_free(db->index[field]);
252    db->index[field] = idx;
253    db->qual[field] = qual;
254    return (1);
255}
256
257long TXT_DB_write(BIO *out, TXT_DB *db)
258{
259    long i, j, n, nn, l, tot = 0;
260    char *p, **pp, *f;
261    BUF_MEM *buf = NULL;
262    long ret = -1;
263
264    if ((buf = BUF_MEM_new()) == NULL)
265        goto err;
266    n = sk_OPENSSL_PSTRING_num(db->data);
267    nn = db->num_fields;
268    for (i = 0; i < n; i++) {
269        pp = sk_OPENSSL_PSTRING_value(db->data, i);
270
271        l = 0;
272        for (j = 0; j < nn; j++) {
273            if (pp[j] != NULL)
274                l += strlen(pp[j]);
275        }
276        if (!BUF_MEM_grow_clean(buf, (int)(l * 2 + nn)))
277            goto err;
278
279        p = buf->data;
280        for (j = 0; j < nn; j++) {
281            f = pp[j];
282            if (f != NULL)
283                for (;;) {
284                    if (*f == '\0')
285                        break;
286                    if (*f == '\t')
287                        *(p++) = '\\';
288                    *(p++) = *(f++);
289                }
290            *(p++) = '\t';
291        }
292        p[-1] = '\n';
293        j = p - buf->data;
294        if (BIO_write(out, buf->data, (int)j) != j)
295            goto err;
296        tot += j;
297    }
298    ret = tot;
299 err:
300    if (buf != NULL)
301        BUF_MEM_free(buf);
302    return (ret);
303}
304
305int TXT_DB_insert(TXT_DB *db, OPENSSL_STRING *row)
306{
307    int i;
308    OPENSSL_STRING *r;
309
310    for (i = 0; i < db->num_fields; i++) {
311        if (db->index[i] != NULL) {
312            if ((db->qual[i] != NULL) && (db->qual[i] (row) == 0))
313                continue;
314            r = lh_OPENSSL_STRING_retrieve(db->index[i], row);
315            if (r != NULL) {
316                db->error = DB_ERROR_INDEX_CLASH;
317                db->arg1 = i;
318                db->arg_row = r;
319                goto err;
320            }
321        }
322    }
323    /* We have passed the index checks, now just append and insert */
324    if (!sk_OPENSSL_PSTRING_push(db->data, row)) {
325        db->error = DB_ERROR_MALLOC;
326        goto err;
327    }
328
329    for (i = 0; i < db->num_fields; i++) {
330        if (db->index[i] != NULL) {
331            if ((db->qual[i] != NULL) && (db->qual[i] (row) == 0))
332                continue;
333            (void)lh_OPENSSL_STRING_insert(db->index[i], row);
334        }
335    }
336    return (1);
337 err:
338    return (0);
339}
340
341void TXT_DB_free(TXT_DB *db)
342{
343    int i, n;
344    char **p, *max;
345
346    if (db == NULL)
347        return;
348
349    if (db->index != NULL) {
350        for (i = db->num_fields - 1; i >= 0; i--)
351            if (db->index[i] != NULL)
352                lh_OPENSSL_STRING_free(db->index[i]);
353        OPENSSL_free(db->index);
354    }
355    if (db->qual != NULL)
356        OPENSSL_free(db->qual);
357    if (db->data != NULL) {
358        for (i = sk_OPENSSL_PSTRING_num(db->data) - 1; i >= 0; i--) {
359            /*
360             * check if any 'fields' have been allocated from outside of the
361             * initial block
362             */
363            p = sk_OPENSSL_PSTRING_value(db->data, i);
364            max = p[db->num_fields]; /* last address */
365            if (max == NULL) {  /* new row */
366                for (n = 0; n < db->num_fields; n++)
367                    if (p[n] != NULL)
368                        OPENSSL_free(p[n]);
369            } else {
370                for (n = 0; n < db->num_fields; n++) {
371                    if (((p[n] < (char *)p) || (p[n] > max))
372                        && (p[n] != NULL))
373                        OPENSSL_free(p[n]);
374                }
375            }
376            OPENSSL_free(sk_OPENSSL_PSTRING_value(db->data, i));
377        }
378        sk_OPENSSL_PSTRING_free(db->data);
379    }
380    OPENSSL_free(db);
381}
382