1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 #include "lf_functions.h"
11 #include <rpcsvc/nis.h>
14 /*************************************************
16 *************************************************/
18 /* See local README for interface description. */
21 nisplus_open(uschar *filename, uschar **errmsg)
23 return (void *)(1); /* Just return something non-null */
28 /*************************************************
30 *************************************************/
32 /* See local README for interface description. The format of queries for a
35 [field=value,...],table-name
37 [field=value,...],table-name:result-field-name
39 in other words, a normal NIS+ "indexed name", with an optional result field
40 name tagged on the end after a colon. If there is no result-field name, the
41 yield is the concatenation of all the fields, preceded by their names and an
45 nisplus_find(void *handle, uschar *filename, const uschar *query, int length,
46 uschar **result, uschar **errmsg, uint *do_cache)
48 int error_error = FAIL;
49 const uschar * field_name = NULL;
50 nis_result *nrt = NULL;
51 nis_result *nre = NULL;
52 nis_object *tno, *eno;
55 const uschar * p = query + length;
56 gstring * yield = NULL;
58 do_cache = do_cache; /* Placate picky compilers */
60 /* Search backwards for a colon to see if a result field name
63 while (p > query && p[-1] != ':') p--;
65 if (p > query) /* get the query without the result-field */
67 uint len = p-1 - query;
69 query = string_copyn(query, len);
75 /* Now search backwards to find the comma that starts the
78 while (p > query && p[-1] != ',') p--;
81 *errmsg = US"NIS+ query malformed";
86 /* Look up the data for the table, in order to get the field names,
87 check that we got back a table, and set up pointers so the field
88 names can be scanned. */
90 nrt = nis_lookup(CS p, EXPAND_NAME | NO_CACHE);
91 if (nrt->status != NIS_SUCCESS)
93 *errmsg = string_sprintf("NIS+ error accessing %s table: %s", p,
94 nis_sperrno(nrt->status));
95 if (nrt->status != NIS_NOTFOUND && nrt->status != NIS_NOSUCHTABLE)
99 tno = nrt->objects.objects_val;
100 if (tno->zo_data.zo_type != TABLE_OBJ)
102 *errmsg = string_sprintf("NIS+ error: %s is not a table", p);
105 ta = &tno->zo_data.objdata_u.ta_data;
107 /* Now look up the entry in the table, check that we got precisely one
108 object and that it is a table entry. */
110 nre = nis_list(CS query, EXPAND_NAME, NULL, NULL);
111 if (nre->status != NIS_SUCCESS)
113 *errmsg = string_sprintf("NIS+ error accessing entry %s: %s",
114 query, nis_sperrno(nre->status));
117 if (nre->objects.objects_len > 1)
119 *errmsg = string_sprintf("NIS+ returned more than one object for %s",
123 else if (nre->objects.objects_len < 1)
125 *errmsg = string_sprintf("NIS+ returned no data for %s", query);
128 eno = nre->objects.objects_val;
129 if (eno->zo_data.zo_type != ENTRY_OBJ)
131 *errmsg = string_sprintf("NIS+ error: %s is not an entry", query);
135 /* Scan the columns in the entry and in the table. If a result field
136 was given, look for that field; otherwise concatenate all the fields
139 eo = &(eno->zo_data.objdata_u.en_data);
140 for (int i = 0; i < eo->en_cols.en_cols_len; i++)
142 table_col *tc = ta->ta_cols.ta_cols_val + i;
143 entry_col *ec = eo->en_cols.en_cols_val + i;
144 int len = ec->ec_value.ec_value_len;
145 uschar *value = US ec->ec_value.ec_value_val;
147 /* The value may be NULL for a zero-length field. Turn this into an
148 empty string for consistency. Remove trailing whitespace and zero
151 if (value == NULL) value = US""; else
152 while (len > 0 && (value[len-1] == 0 || isspace(value[len-1])))
155 /* Concatenate all fields if no specific one selected */
159 yield = string_cat (yield, tc->tc_name);
160 yield = string_catn(yield, US"=", 1);
162 /* Quote the value if it contains spaces or is empty */
164 if (value[0] == 0 || Ustrchr(value, ' ') != NULL)
166 yield = string_catn(yield, US"\"", 1);
167 for (int j = 0; j < len; j++)
169 if (value[j] == '\"' || value[j] == '\\')
170 yield = string_catn(yield, US"\\", 1);
171 yield = string_catn(yield, value+j, 1);
173 yield = string_catn(yield, US"\"", 1);
176 yield = string_catn(yield, value, len);
178 yield = string_catn(yield, US" ", 1);
181 /* When the specified field is found, grab its data and finish */
183 else if (Ustrcmp(field_name, tc->tc_name) == 0)
185 yield = string_catn(yield, value, len);
190 /* Error if a field name was specified and we didn't find it; if no
191 field name, ensure the concatenated data is zero-terminated. */
194 *errmsg = string_sprintf("NIS+ field %s not found for %s", field_name,
197 store_reset(yield->s + yield->ptr + 1);
199 /* Free result store before finishing. */
202 if (nrt) nis_freeresult(nrt);
203 if (nre) nis_freeresult(nre);
207 *result = string_from_gstring(yield);
211 return error_error; /* FAIL or DEFER */
216 /*************************************************
217 * Quote entry point *
218 *************************************************/
220 /* The only quoting that is necessary for NIS+ is to double any doublequote
221 characters. No options are recognized.
224 s the string to be quoted
225 opt additional option text or NULL if none
227 Returns: the processed string or NULL for a bad option
231 nisplus_quote(uschar *s, uschar *opt)
237 if (opt != NULL) return NULL; /* No options recognized */
239 while (*t != 0) if (*t++ == '\"') count++;
240 if (count == 0) return s;
242 t = quoted = store_get(Ustrlen(s) + count + 1);
247 if (*s++ == '\"') *t++ = '\"';
255 /*************************************************
256 * Version reporting entry point *
257 *************************************************/
259 /* See local README for interface description. */
261 #include "../version.h"
264 nisplus_version_report(FILE *f)
267 fprintf(f, "Library version: NIS+: Exim version %s\n", EXIM_VERSION_STR);
272 static lookup_info _lookup_info = {
273 US"nisplus", /* lookup name */
274 lookup_querystyle, /* query-style lookup */
275 nisplus_open, /* open function */
276 NULL, /* check function */
277 nisplus_find, /* find function */
278 NULL, /* no close function */
279 NULL, /* no tidy function */
280 nisplus_quote, /* quoting function */
281 nisplus_version_report /* version reporting */
285 #define nisplus_lookup_module_info _lookup_module_info
288 static lookup_info *_lookup_list[] = { &_lookup_info };
289 lookup_module_info nisplus_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 };
291 /* End of lookups/nisplus.c */