src/src/lookups/dbmdb.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9 #include "../exim.h"
  10 #include "lf_functions.h"
  11
  12
  13 /*************************************************
  14 *              Open entry point                  *
  15 *************************************************/
  16
  17 /* See local README for interface description */
  18
  19 static void *
  20 dbmdb_open(const uschar * filename, uschar ** errmsg)
  21 {
  22 uschar * dirname = string_copy(filename);
  23 uschar * s;
  24 EXIM_DB * yield = NULL;
  25
  26 if ((s = Ustrrchr(dirname, '/'))) *s = '\0';
  27 if (!(yield = exim_dbopen(filename, dirname, O_RDONLY, 0)))
  28   *errmsg = string_open_failed("%s as a %s file", filename, EXIM_DBTYPE);
  29 return yield;
  30 }
  31
  32
  33
  34 /*************************************************
  35 *             Check entry point                  *
  36 *************************************************/
  37
  38 /* This needs to know more about the underlying files than is good for it!
  39 We need to know what the real file names are in order to check the owners and
  40 modes. If USE_DB is set, we know it is Berkeley DB, which uses an unmodified
  41 file name. If USE_TDB or USE_GDBM is set, we know it is tdb or gdbm, which do
  42 the same. Otherwise, for safety, we have to check for x.db or x.dir and x.pag.
  43 */
  44
  45 static BOOL
  46 dbmdb_check(void *handle, const uschar *filename, int modemask, uid_t *owners,
  47   gid_t *owngroups, uschar **errmsg)
  48 {
  49 int rc;
  50
  51 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
  52 rc = lf_check_file(-1, filename, S_IFREG, modemask, owners, owngroups,
  53   "dbm", errmsg);
  54 #else
  55   {
  56   uschar filebuffer[256];
  57   (void)sprintf(CS filebuffer, "%.250s.db", filename);
  58   rc = lf_check_file(-1, filebuffer, S_IFREG, modemask, owners, owngroups,
  59     "dbm", errmsg);
  60   if (rc < 0)        /* stat() failed */
  61     {
  62     (void)sprintf(CS filebuffer, "%.250s.dir", filename);
  63     rc = lf_check_file(-1, filebuffer, S_IFREG, modemask, owners, owngroups,
  64       "dbm", errmsg);
  65     if (rc == 0)     /* x.dir was OK */
  66       {
  67       (void)sprintf(CS filebuffer, "%.250s.pag", filename);
  68       rc = lf_check_file(-1, filebuffer, S_IFREG, modemask, owners, owngroups,
  69         "dbm", errmsg);
  70       }
  71     }
  72   }
  73 #endif
  74
  75 return rc == 0;
  76 }
  77
  78
  79
  80 /*************************************************
  81 *              Find entry point                  *
  82 *************************************************/
  83
  84 /* See local README for interface description. This function adds 1 to
  85 the keylength in order to include the terminating zero. */
  86
  87 static int
  88 dbmdb_find(void * handle, const uschar * filename, const uschar * keystring,
  89   int length, uschar ** result, uschar ** errmsg, uint * do_cache,
  90   const uschar * opts)
  91 {
  92 EXIM_DB *d = (EXIM_DB *)handle;
  93 EXIM_DATUM key, data;
  94
  95 exim_datum_init(&key);               /* Some DBM libraries require datums to */
  96 exim_datum_init(&data);              /* be cleared before use. */
  97 exim_datum_data_set(&key, string_copyn(keystring, length));
  98 exim_datum_size_set(&key, length + 1);
  99
 100 if (exim_dbget(d, &key, &data))
 101   {
 102   *result = string_copyn(exim_datum_data_get(&data), exim_datum_size_get(&data));
 103   exim_datum_free(&data);            /* Some DBM libraries need a free() call */
 104   return OK;
 105   }
 106 return FAIL;
 107 }
 108
 109
 110
 111 /*************************************************
 112 *      Find entry point - no zero on key         *
 113 *************************************************/
 114
 115 /* See local README for interface description */
 116
 117 static int
 118 dbmnz_find(void * handle, const uschar * filename, const uschar * keystring,
 119   int length, uschar ** result, uschar ** errmsg, uint * do_cache,
 120   const uschar * opts)
 121 {
 122 return dbmdb_find(handle, filename, keystring, length-1, result, errmsg,
 123   do_cache, opts);
 124 }
 125
 126
 127
 128 /*************************************************
 129 *     Find entry point - zero-joined list key    *
 130 *************************************************/
 131
 132 /*
 133  * The parameter passed as a key is a list in normal Exim list syntax.
 134  * The elements of that list are joined together on NUL, with no trailing
 135  * NUL, to form the key.
 136  */
 137
 138 static int
 139 dbmjz_find(void * handle, const uschar * filename, const uschar * keystring,
 140   int length, uschar ** result, uschar ** errmsg, uint * do_cache,
 141   const uschar * opts)
 142 {
 143 uschar *key_item, *key_buffer, *key_p;
 144 const uschar *key_elems = keystring;
 145 int buflen, bufleft, key_item_len, sep = 0;
 146
 147 /* To a first approximation, the size of the lookup key needs to be about,
 148 or less than, the length of the delimited list passed in + 1. */
 149
 150 buflen = length + 3;
 151 key_buffer = store_get(buflen, keystring);
 152
 153 key_buffer[0] = '\0';
 154
 155 key_p = key_buffer;
 156 bufleft = buflen;
 157
 158 /* In all cases of an empty list item, we can set 1 and advance by 1 and then
 159 pick up the trailing NUL from the previous list item, EXCEPT when at the
 160 beginning of the output string, in which case we need to supply that NUL
 161 ourselves.  */
 162 while ((key_item = string_nextinlist(&key_elems, &sep, key_p, bufleft)) != NULL)
 163   {
 164   key_item_len = Ustrlen(key_item) + 1;
 165   if (key_item_len == 1)
 166     {
 167     key_p[0] = '\0';
 168     if (key_p == key_buffer)
 169       {
 170       key_p[1] = '\0';
 171       key_item_len += 1;
 172       }
 173     }
 174
 175   bufleft -= key_item_len;
 176   if (bufleft <= 0)
 177     {
 178     /* The string_nextinlist() will stop at buffer size, but we should always
 179     have at least 1 character extra, so some assumption has failed. */
 180     *errmsg = string_copy(US"Ran out of buffer space for joining elements");
 181     return DEFER;
 182     }
 183   key_p += key_item_len;
 184   }
 185
 186 if (key_p == key_buffer)
 187   {
 188   *errmsg = string_copy(US"empty list key");
 189   return FAIL;
 190   }
 191
 192 /* We do not pass in the final NULL; if needed, the list should include an
 193 empty element to put one in. Boundary: key length 1, is a NULL */
 194 key_item_len = key_p - key_buffer - 1;
 195
 196 DEBUG(D_lookup) debug_printf_indent("NUL-joined key length: %d\n", key_item_len);
 197
 198 /* beware that dbmdb_find() adds 1 to length to get back terminating NUL, so
 199 because we've calculated the real length, we need to subtract one more here */
 200
 201 return dbmdb_find(handle, filename, key_buffer, key_item_len - 1,
 202     result, errmsg, do_cache, opts);
 203 }
 204
 205
 206
 207 /*************************************************
 208 *              Close entry point                 *
 209 *************************************************/
 210
 211 /* See local README for interface description */
 212
 213 void
 214 static dbmdb_close(void *handle)
 215 {
 216 exim_dbclose((EXIM_DB *)handle);
 217 }
 218
 219
 220
 221 /*************************************************
 222 *         Version reporting entry point          *
 223 *************************************************/
 224
 225 /* See local README for interface description. */
 226
 227 #include "../version.h"
 228
 229 gstring *
 230 dbm_version_report(gstring * g)
 231 {
 232 #ifdef DYNLOOKUP
 233 g = string_fmt_append(g, "Library version: DBM: Exim version %s\n", EXIM_VERSION_STR);
 234 #endif
 235 return g;
 236 }
 237
 238
 239 lookup_info dbm_lookup_info = {
 240   .name = US"dbm",                      /* lookup name */
 241   .type = lookup_absfile,               /* uses absolute file name */
 242   .open = dbmdb_open,                   /* open function */
 243   .check = dbmdb_check,                 /* check function */
 244   .find = dbmdb_find,                   /* find function */
 245   .close = dbmdb_close,                 /* close function */
 246   .tidy = NULL,                         /* no tidy function */
 247   .quote = NULL,                        /* no quoting function */
 248   .version_report = dbm_version_report             /* version reporting */
 249 };
 250
 251 lookup_info dbmz_lookup_info = {
 252   .name = US"dbmnz",                    /* lookup name */
 253   .type = lookup_absfile,               /* uses absolute file name */
 254   .open = dbmdb_open,                   /* sic */     /* open function */
 255   .check = dbmdb_check,                 /* sic */     /* check function */
 256   .find = dbmnz_find,                   /* find function */
 257   .close = dbmdb_close,                 /* sic */     /* close function */
 258   .tidy = NULL,                         /* no tidy function */
 259   .quote = NULL,                        /* no quoting function */
 260   .version_report = NULL                           /* no version reporting (redundant) */
 261 };
 262
 263 lookup_info dbmjz_lookup_info = {
 264   .name = US"dbmjz",                    /* lookup name */
 265   .type = lookup_absfile,               /* uses absolute file name */
 266   .open = dbmdb_open,                   /* sic */     /* open function */
 267   .check = dbmdb_check,                 /* sic */     /* check function */
 268   .find = dbmjz_find,                   /* find function */
 269   .close = dbmdb_close,                 /* sic */     /* close function */
 270   .tidy = NULL,                         /* no tidy function */
 271   .quote = NULL,                        /* no quoting function */
 272   .version_report = NULL                           /* no version reporting (redundant) */
 273 };
 274
 275 #ifdef DYNLOOKUP
 276 #define dbmdb_lookup_module_info _lookup_module_info
 277 #endif
 278
 279 static lookup_info *_lookup_list[] = { &dbm_lookup_info, &dbmz_lookup_info, &dbmjz_lookup_info };
 280 lookup_module_info dbmdb_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 3 };
 281
 282 /* End of lookups/dbmdb.c */