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 length++;
  98 exim_datum_data_set(&key,
  99   memcpy(store_get(length, keystring), keystring, length)); /* key can have embedded NUL */
 100 exim_datum_size_set(&key, length);
 101
 102 if (exim_dbget(d, &key, &data))
 103   {
 104   *result = string_copyn(exim_datum_data_get(&data), exim_datum_size_get(&data));
 105   exim_datum_free(&data);            /* Some DBM libraries need a free() call */
 106   return OK;
 107   }
 108 return FAIL;
 109 }
 110
 111
 112
 113 /*************************************************
 114 *      Find entry point - no zero on key         *
 115 *************************************************/
 116
 117 /* See local README for interface description */
 118
 119 static int
 120 dbmnz_find(void * handle, const uschar * filename, const uschar * keystring,
 121   int length, uschar ** result, uschar ** errmsg, uint * do_cache,
 122   const uschar * opts)
 123 {
 124 return dbmdb_find(handle, filename, keystring, length-1, result, errmsg,
 125   do_cache, opts);
 126 }
 127
 128
 129
 130 /*************************************************
 131 *     Find entry point - zero-joined list key    *
 132 *************************************************/
 133
 134 /*
 135  * The parameter passed as a key is a list in normal Exim list syntax.
 136  * The elements of that list are joined together on NUL, with no trailing
 137  * NUL, to form the key.
 138  */
 139
 140 static int
 141 dbmjz_find(void * handle, const uschar * filename, const uschar * keystring,
 142   int length, uschar ** result, uschar ** errmsg, uint * do_cache,
 143   const uschar * opts)
 144 {
 145 uschar *key_item, *key_buffer, *key_p;
 146 const uschar *key_elems = keystring;
 147 int buflen, bufleft, key_item_len, sep = 0;
 148
 149 /* To a first approximation, the size of the lookup key needs to be about,
 150 or less than, the length of the delimited list passed in + 1. */
 151
 152 buflen = length + 3;
 153 key_buffer = store_get(buflen, keystring);
 154
 155 key_buffer[0] = '\0';
 156
 157 key_p = key_buffer;
 158 bufleft = buflen;
 159
 160 /* In all cases of an empty list item, we can set 1 and advance by 1 and then
 161 pick up the trailing NUL from the previous list item, EXCEPT when at the
 162 beginning of the output string, in which case we need to supply that NUL
 163 ourselves.  */
 164 while ((key_item = string_nextinlist(&key_elems, &sep, key_p, bufleft)) != NULL)
 165   {
 166   key_item_len = Ustrlen(key_item) + 1;
 167   if (key_item_len == 1)
 168     {
 169     key_p[0] = '\0';
 170     if (key_p == key_buffer)
 171       {
 172       key_p[1] = '\0';
 173       key_item_len += 1;
 174       }
 175     }
 176
 177   bufleft -= key_item_len;
 178   if (bufleft <= 0)
 179     {
 180     /* The string_nextinlist() will stop at buffer size, but we should always
 181     have at least 1 character extra, so some assumption has failed. */
 182     *errmsg = string_copy(US"Ran out of buffer space for joining elements");
 183     return DEFER;
 184     }
 185   key_p += key_item_len;
 186   }
 187
 188 if (key_p == key_buffer)
 189   {
 190   *errmsg = string_copy(US"empty list key");
 191   return FAIL;
 192   }
 193
 194 /* We do not pass in the final NULL; if needed, the list should include an
 195 empty element to put one in. Boundary: key length 1, is a NULL */
 196 key_item_len = key_p - key_buffer - 1;
 197
 198 DEBUG(D_lookup) debug_printf_indent("NUL-joined key length: %d\n", key_item_len);
 199
 200 /* beware that dbmdb_find() adds 1 to length to get back terminating NUL, so
 201 because we've calculated the real length, we need to subtract one more here */
 202
 203 return dbmdb_find(handle, filename, key_buffer, key_item_len - 1,
 204     result, errmsg, do_cache, opts);
 205 }
 206
 207
 208
 209 /*************************************************
 210 *              Close entry point                 *
 211 *************************************************/
 212
 213 /* See local README for interface description */
 214
 215 void
 216 static dbmdb_close(void *handle)
 217 {
 218 exim_dbclose((EXIM_DB *)handle);
 219 }
 220
 221
 222
 223 /*************************************************
 224 *         Version reporting entry point          *
 225 *************************************************/
 226
 227 /* See local README for interface description. */
 228
 229 #include "../version.h"
 230
 231 gstring *
 232 dbm_version_report(gstring * g)
 233 {
 234 #ifdef DYNLOOKUP
 235 g = string_fmt_append(g, "Library version: DBM: Exim version %s\n", EXIM_VERSION_STR);
 236 #endif
 237 return g;
 238 }
 239
 240
 241 lookup_info dbm_lookup_info = {
 242   .name = US"dbm",                      /* lookup name */
 243   .type = lookup_absfile,               /* uses absolute file name */
 244   .open = dbmdb_open,                   /* open function */
 245   .check = dbmdb_check,                 /* check function */
 246   .find = dbmdb_find,                   /* find function */
 247   .close = dbmdb_close,                 /* close function */
 248   .tidy = NULL,                         /* no tidy function */
 249   .quote = NULL,                        /* no quoting function */
 250   .version_report = dbm_version_report             /* version reporting */
 251 };
 252
 253 lookup_info dbmz_lookup_info = {
 254   .name = US"dbmnz",                    /* lookup name */
 255   .type = lookup_absfile,               /* uses absolute file name */
 256   .open = dbmdb_open,                   /* sic */     /* open function */
 257   .check = dbmdb_check,                 /* sic */     /* check function */
 258   .find = dbmnz_find,                   /* find function */
 259   .close = dbmdb_close,                 /* sic */     /* close function */
 260   .tidy = NULL,                         /* no tidy function */
 261   .quote = NULL,                        /* no quoting function */
 262   .version_report = NULL                           /* no version reporting (redundant) */
 263 };
 264
 265 lookup_info dbmjz_lookup_info = {
 266   .name = US"dbmjz",                    /* lookup name */
 267   .type = lookup_absfile,               /* uses absolute file name */
 268   .open = dbmdb_open,                   /* sic */     /* open function */
 269   .check = dbmdb_check,                 /* sic */     /* check function */
 270   .find = dbmjz_find,                   /* find function */
 271   .close = dbmdb_close,                 /* sic */     /* close function */
 272   .tidy = NULL,                         /* no tidy function */
 273   .quote = NULL,                        /* no quoting function */
 274   .version_report = NULL                           /* no version reporting (redundant) */
 275 };
 276
 277 #ifdef DYNLOOKUP
 278 #define dbmdb_lookup_module_info _lookup_module_info
 279 #endif
 280
 281 static lookup_info *_lookup_list[] = { &dbm_lookup_info, &dbmz_lookup_info, &dbmjz_lookup_info };
 282 lookup_module_info dbmdb_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 3 };
 283
 284 /* End of lookups/dbmdb.c */