SPDX: Mass-update to GPL-2.0-or-later
[exim.git] / src / src / lookups / lf_check_file.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
9
10
11 #include "../exim.h"
12 #include "lf_functions.h"
13
14
15
16 /*************************************************
17 *         Check a file's credentials             *
18 *************************************************/
19
20 /* fstat can normally be expected to work on an open file, but there are some
21 NFS states where it may not.
22
23 Arguments:
24   fd         an open file descriptor or -1
25   filename   a file name if fd is -1
26   s_type     type of file (S_IFREG or S_IFDIR)
27   modemask   a mask specifying mode bits that must *not* be set
28   owners     NULL or a list of of allowable uids, count in the first item
29   owngroups  NULL or a list of allowable gids, count in the first item
30   type       name of lookup type for putting in error message
31   errmsg     where to put an error message
32
33 Returns:     -1 stat() or fstat() failed
34               0 OK
35              +1 something didn't match
36
37 Side effect: sets errno to ERRNO_BADUGID, ERRNO_NOTREGULAR or ERRNO_BADMODE for
38              bad uid/gid, not a regular file, or bad mode; otherwise leaves it
39              to what fstat set it to.
40 */
41
42 int
43 lf_check_file(int fd, const uschar * filename, int s_type, int modemask,
44   uid_t * owners, gid_t * owngroups, const char * type, uschar ** errmsg)
45 {
46 struct stat statbuf;
47
48 if ((fd >= 0 && fstat(fd, &statbuf) != 0) ||
49     (fd  < 0 && Ustat(filename, &statbuf) != 0))
50   {
51   int save_errno = errno;
52   *errmsg = string_sprintf("%s: stat failed", filename);
53   errno = save_errno;
54   return -1;
55   }
56
57 if ((statbuf.st_mode & S_IFMT) != s_type)
58   {
59   if (s_type == S_IFREG)
60     {
61     *errmsg = string_sprintf("%s is not a regular file (%s lookup)",
62       filename, type);
63     errno = ERRNO_NOTREGULAR;
64     }
65   else
66     {
67     *errmsg = string_sprintf("%s is not a directory (%s lookup)",
68       filename, type);
69     errno = ERRNO_NOTDIRECTORY;
70     }
71   return +1;
72   }
73
74 if ((statbuf.st_mode & modemask) != 0)
75   {
76   *errmsg = string_sprintf("%s (%s lookup): file mode %.4o should not contain "
77     "%.4o", filename, type,  statbuf.st_mode & 07777,
78     statbuf.st_mode & modemask);
79   errno = ERRNO_BADMODE;
80   return +1;
81   }
82
83 if (owners != NULL)
84   {
85   BOOL uid_ok = FALSE;
86   for (int i = 1; i <= (int)owners[0]; i++)
87     if (owners[i] == statbuf.st_uid) { uid_ok = TRUE; break; }
88   if (!uid_ok)
89     {
90     *errmsg = string_sprintf("%s (%s lookup): file has wrong owner", filename,
91       type);
92     errno = ERRNO_BADUGID;
93     return +1;
94     }
95   }
96
97 if (owngroups != NULL)
98   {
99   BOOL gid_ok = FALSE;
100   for (int i = 1; i <= (int)owngroups[0]; i++)
101     if (owngroups[i] == statbuf.st_gid) { gid_ok = TRUE; break; }
102   if (!gid_ok)
103     {
104     *errmsg = string_sprintf("%s (%s lookup): file has wrong group", filename,
105       type);
106     errno = ERRNO_BADUGID;
107     return +1;
108     }
109   }
110
111 return 0;
112 }
113
114 /* End of lf_check_file.c */