summaryrefslogtreecommitdiffstats
path: root/src/util/dict_file.c
blob: eb86b3522b301caf0212cf4f4039b3211a3b1b0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/*++
/* NAME
/*	dict_file_to_buf 3
/* SUMMARY
/*	include content from file as blob
/* SYNOPSIS
/*	#include <dict.h>
/*
/*	VSTRING	*dict_file_to_buf(
/*	DICT	*dict,
/*	const char *pathnames)
/*
/*	VSTRING	*dict_file_to_b64(
/*	DICT	*dict,
/*	const char *pathnames)
/*
/*	VSTRING	*dict_file_from_b64(
/*	DICT	*dict,
/*	const char *value)
/*
/*	char	*dict_file_get_error(
/*	DICT	*dict)
/*
/*	void	dict_file_purge_buffers(
/*	DICT	*dict)
/*
/*	const char *dict_file_lookup(
/*	DICT	*dict)
/* DESCRIPTION
/*	dict_file_to_buf() reads the content of the specified files,
/*	with names separated by CHARS_COMMA_SP, while inserting a
/*	gratuitous newline character between files. It returns a
/*	pointer to a buffer which is owned by the DICT, or a null
/*	pointer in case of error.
/*
/*	dict_file_to_b64() invokes dict_file_to_buf() and converts
/*	the result to base64. It returns a pointer to a buffer which
/*	is owned by the DICT, or a null pointer in case of error.
/*
/*	dict_file_from_b64() converts a value from base64. It returns
/*	a pointer to a buffer which is owned by the DICT, or a null
/*	pointer in case of error.
/*
/*	dict_file_purge_buffers() disposes of dict_file-related
/*	memory that are associated with this DICT.
/*
/*	dict_file_get_error() should be called only after error;
/*	it returns a desciption of the problem. Storage is owned
/*	by the caller.
/*
/*	dict_file_lookup() wraps the dictionary lookup method and
/*	decodes the base64 lookup result. The dictionary must be
/*	opened with DICT_FLAG_SRC_RHS_IS_FILE. Sets dict->error to
/*	DICT_ERR_CONFIG if the content is invalid. Decoding is not
/*	built into the dict->lookup() method, because that would
/*	complicate the implementation of map nesting (inline, thash),
/*	map composition (pipemap, unionmap), and map proxying.
/* DIAGNOSTICS
/*	Panic: interface violation.
/*
/*	In case of error the VSTRING result value is a null pointer, and
/*	an error description can be retrieved with dict_file_get_error().
/*	The storage is owned by the caller.
/* LICENSE
/* .ad
/* .fi
/*	The Secure Mailer license must be distributed with this software.
/* AUTHOR(S)
/*	Wietse Venema
/*	Google, Inc.
/*	111 8th Avenue
/*	New York, NY 10011, USA
/*--*/

 /*
  * System library.
  */
#include <sys_defs.h>
#include <sys/stat.h>
#include <string.h>

 /*
  * Utility library.
  */
#include <base64_code.h>
#include <dict.h>
#include <msg.h>
#include <mymalloc.h>
#include <vstream.h>
#include <vstring.h>

 /*
  * SLMs.
  */
#define STR(x) vstring_str(x)
#define LEN(x) VSTRING_LEN(x)

/* dict_file_to_buf - read files into a buffer */

VSTRING *dict_file_to_buf(DICT *dict, const char *pathnames)
{
    struct stat st;
    VSTREAM *fp = 0;
    ARGV   *argv;
    char  **cpp;

    /* dict_file_to_buf() postcondition: dict->file_buf exists. */
    if (dict->file_buf == 0)
	dict->file_buf = vstring_alloc(100);

#define DICT_FILE_RETURN(retval) do { \
	argv_free(argv); \
	if (fp) vstream_fclose(fp); \
	return (retval); \
    } while (0);

    argv = argv_split(pathnames, CHARS_COMMA_SP);
    if (argv->argc == 0) {
	vstring_sprintf(dict->file_buf, "empty pathname list: >>%s<<'",
			pathnames);
	DICT_FILE_RETURN(0);
    }
    VSTRING_RESET(dict->file_buf);
    for (cpp = argv->argv; *cpp; cpp++) {
	if ((fp = vstream_fopen(*cpp, O_RDONLY, 0)) == 0
	    || fstat(vstream_fileno(fp), &st) < 0) {
	    vstring_sprintf(dict->file_buf, "open %s: %m", *cpp);
	    DICT_FILE_RETURN(0);
	}
	if (st.st_size > SSIZE_T_MAX - LEN(dict->file_buf)) {
	    vstring_sprintf(dict->file_buf, "file too large: %s", pathnames);
	    DICT_FILE_RETURN(0);
	}
	if (vstream_fread_app(fp, dict->file_buf, st.st_size) != st.st_size) {
	    vstring_sprintf(dict->file_buf, "read %s: %m", *cpp);
	    DICT_FILE_RETURN(0);
	}
	(void) vstream_fclose(fp);
	fp = 0;
	if (cpp[1] != 0)
	    VSTRING_ADDCH(dict->file_buf, '\n');
    }
    VSTRING_TERMINATE(dict->file_buf);
    DICT_FILE_RETURN(dict->file_buf);
}

/* dict_file_to_b64 - read files into a base64-encoded buffer */

VSTRING *dict_file_to_b64(DICT *dict, const char *pathnames)
{
    ssize_t helper;

    if (dict_file_to_buf(dict, pathnames) == 0)
	return (0);
    if (dict->file_b64 == 0)
	dict->file_b64 = vstring_alloc(100);
    helper = (LEN(dict->file_buf) + 2) / 3;
    if (helper > SSIZE_T_MAX / 4) {
	vstring_sprintf(dict->file_buf, "file too large: %s", pathnames);
	return (0);
    }
    VSTRING_RESET(dict->file_b64);
    VSTRING_SPACE(dict->file_b64, helper * 4);
    return (base64_encode(dict->file_b64, STR(dict->file_buf),
			  LEN(dict->file_buf)));
}

/* dict_file_from_b64 - convert value from base64 */

VSTRING *dict_file_from_b64(DICT *dict, const char *value)
{
    ssize_t helper;
    VSTRING *result;

    if (dict->file_buf == 0)
	dict->file_buf = vstring_alloc(100);
    helper = strlen(value) / 4;
    VSTRING_RESET(dict->file_buf);
    VSTRING_SPACE(dict->file_buf, helper * 3);
    result = base64_decode(dict->file_buf, value, strlen(value));
    if (result == 0)
	vstring_sprintf(dict->file_buf, "malformed BASE64 value: %.30s", value);
    return (result);
}

/* dict_file_get_error - return error text */

char   *dict_file_get_error(DICT *dict)
{
    if (dict->file_buf == 0)
	msg_panic("dict_file_get_error: no buffer");
    return (mystrdup(STR(dict->file_buf)));
}

/* dict_file_purge_buffers - purge file buffers */

void    dict_file_purge_buffers(DICT *dict)
{
    if (dict->file_buf) {
	vstring_free(dict->file_buf);
	dict->file_buf = 0;
    }
    if (dict->file_b64) {
	vstring_free(dict->file_b64);
	dict->file_b64 = 0;
    }
}

/* dict_file_lookup - look up and decode dictionary entry */

const char *dict_file_lookup(DICT *dict, const char *key)
{
    const char myname[] = "dict_file_lookup";
    const char *res;
    VSTRING *unb64;
    char   *err;

    if ((dict->flags & DICT_FLAG_SRC_RHS_IS_FILE) == 0)
	msg_panic("%s: dictionary opened without DICT_FLAG_SRC_RHS_IS_FILE",
		  myname);
    if ((res = dict->lookup(dict, key)) == 0)
	return (0);
    if ((unb64 = dict_file_from_b64(dict, res)) == 0) {
	err = dict_file_get_error(dict);
	msg_warn("table %s:%s: key %s: %s", dict->type, dict->name, key, err);
	myfree(err);
	dict->error = DICT_ERR_CONFIG;
	return (0);
    }
    return STR(unb64);
}