1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /*************************************************
10 * Build configuration header for Exim *
11 *************************************************/
13 /* This auxiliary program builds the file config.h by the following
16 First, it determines the size of off_t and time_t variables, and generates
17 macro code to define OFF_T_FMT and TIME_T_FMT as suitable formats, if they are
18 not already defined in the system-specific header file.
20 Then it reads Makefile, looking for certain OS-specific definitions which it
21 uses to define some specific macros. Finally, it reads the defaults file
24 The defaults file contains normal C #define statements for various macros; if
25 the name of a macro is found in the environment, the environment value replaces
26 the default. If the default #define does not contain any value, then that macro
27 is not copied to the created file unless there is some value in the
30 This program is compiled and run as part of the Make process and is not
31 normally called independently. */
38 #include <sys/types.h>
52 static const char *db_opts[] = { "", "USE_DB", "USE_GDBM", "USE_TDB" };
54 static int have_ipv6 = 0;
55 static int have_iconv = 0;
57 static char errno_quota[256];
58 static char ostype[256];
61 /* If any entry is an initial substring of another, the longer one must
64 static have_item have_list[] = {
65 { "HAVE_IPV6", &have_ipv6 },
66 { "HAVE_ICONV", &have_iconv },
70 static save_item save_list[] = {
71 { "ERRNO_QUOTA", errno_quota },
78 /* Subroutine to check a string for precisely one instance of "%s". If not,
82 check_percent_ess(char *value, char *name)
85 char *p = strstr(value, "%s");
86 if (p != NULL) OK = strstr(p+2, "%s") == NULL;
89 printf("\n*** \"%s\" (%s) must contain precisely one occurrence of\n"
90 "*** \"%%s\". Please review your build-time configuration.\n\n/", value,
100 main(int argc, char **argv)
102 off_t test_off_t = 0;
103 time_t test_time_t = 0;
104 #if ! (__STDC_VERSION__ >= 199901L)
105 size_t test_size_t = 0;
106 unsigned long test_ulong_t = 0L;
108 long test_long_t = 0;
111 int last_initial = 'A';
114 int in_local_makefile = 0;
115 int use_which_db = 0;
116 int use_which_db_in_local_makefile = 0;
117 int support_crypteq = 0;
122 printf("*** Buildconfig: called with incorrect arguments\n");
126 new = fopen("config.h", "wb");
129 printf("*** Buildconfig: failed to open config.h for output\n");
133 printf("Building configuration file config.h\n");
135 fprintf(new, "/*************************************************\n");
136 fprintf(new, "* Configuration header for Exim *\n");
137 fprintf(new, "*************************************************/\n\n");
139 fprintf(new, "/* This file was automatically generated from Makefile and "
140 "config.h.defaults,\n");
141 fprintf(new, "using values specified in the configuration file Local/Makefile.\n");
142 fprintf(new, "Do not edit it. Instead, edit Local/Makefile and "
143 "rerun make. */\n\n");
145 /* First, deal with the printing format for off_t variables. We assume that if
146 the size of off_t is greater than 4, "%lld" will be available as a format for
147 printing long long variables, and there will be support for the long long type.
148 This assumption is known to be OK for the common operating systems. */
150 fprintf(new, "#ifndef OFF_T_FMT\n");
151 if (sizeof(test_off_t) > sizeof(test_long_t))
153 fprintf(new, "#define OFF_T_FMT \"%%lld\"\n");
154 fprintf(new, "#define LONGLONG_T long long int\n");
158 fprintf(new, "#define OFF_T_FMT \"%%ld\"\n");
159 fprintf(new, "#define LONGLONG_T long int\n");
161 fprintf(new, "#endif\n\n");
163 /* Now do the same thing for time_t variables. If the length is greater than
164 4, we want to assume long long support (even if off_t was less than 4). If the
165 length is 4 or less, we can leave LONGLONG_T to whatever was defined above for
168 fprintf(new, "#ifndef TIME_T_FMT\n");
169 if (sizeof(test_time_t) > sizeof(test_long_t))
171 fprintf(new, "#define TIME_T_FMT \"%%lld\"\n");
172 fprintf(new, "#undef LONGLONG_T\n");
173 fprintf(new, "#define LONGLONG_T long long int\n");
177 fprintf(new, "#define TIME_T_FMT \"%%ld\"\n");
179 fprintf(new, "#endif\n\n");
181 /* And for sizeof() results, size_t, which should with C99 be just %zu, deal
182 with C99 not being ubiquitous yet. Unfortunately. */
184 #if __STDC_VERSION__ >= 199901L
185 fprintf(new, "#define SIZE_T_FMT \"%%zu\"\n");
187 if (sizeof(test_size_t) > sizeof (test_ulong_t))
188 fprintf(new, "#define SIZE_T_FMT \"%%llu\"\n");
190 fprintf(new, "#define SIZE_T_FMT \"%%lu\"\n");
193 /* Now search the makefile for certain settings */
195 base = fopen("Makefile", "rb");
198 printf("*** Buildconfig: failed to open Makefile\n");
203 errno_quota[0] = 0; /* no over-riding value set */
204 ostype[0] = 0; /* just in case */
207 while (fgets(buffer, sizeof(buffer), base) != NULL)
212 char *p = buffer + (int)strlen(buffer);
214 while (p > buffer && isspace((unsigned char)p[-1])) p--;
217 while (isspace((unsigned char)*p)) p++;
219 /* Notice when we hit the user's makefile */
221 if (strcmp(p, "# From Local/Makefile") == 0)
223 in_local_makefile = 1;
227 /* Remember the last DB option setting. If we hit two in the user's
228 Makefile, complain. */
230 for (i = 1; i < sizeof(db_opts)/sizeof(char *); i++)
232 int len = (int)strlen(db_opts[i]);
233 if (strncmp(p, db_opts[i], len) == 0 && (p[len] == ' ' || p[len] == '='))
235 if (in_local_makefile)
237 if (use_which_db_in_local_makefile)
239 printf("*** Only one of USE_DB, USE_GDBM, or USE_TDB should be "
240 "defined in Local/Makefile\n");
243 use_which_db_in_local_makefile = 1;
249 if (i < sizeof(db_opts)/sizeof(char *)) continue;
251 /* Items where we just save a boolean */
253 for (h = have_list; h->name != NULL; h++)
255 int len = (int)strlen(h->name);
256 if (strncmp(p, h->name, len) == 0)
259 while (isspace((unsigned char)*p)) p++;
262 printf("*** Buildconfig: syntax error in Makefile line %d\n", linecount);
265 while (isspace((unsigned char)*p)) p++;
266 if (strcmp(p, "YES") == 0 || strcmp(p, "yes") == 0) *(h->flag) = 1;
267 else *(h->flag) = 0; /* Must reset in case multiple instances */
272 if (h->name != NULL) continue;
274 /* Items where we save the complete string */
276 for (s = save_list; s->name != NULL; s++)
278 int len = (int)strlen(s->name);
279 if (strncmp(p, s->name, len) == 0)
282 while (isspace((unsigned char)*p)) p++;
285 printf("*** Buildconfig: syntax error in Makefile line %d\n", linecount);
288 while (isspace((unsigned char)*p)) p++;
294 fprintf(new, "#define HAVE_IPV6 %s\n",
295 have_ipv6? "TRUE" : "FALSE");
297 fprintf(new, "#define HAVE_ICONV %s\n",
298 have_iconv? "TRUE" : "FALSE");
300 if (errno_quota[0] != 0)
301 fprintf(new, "\n#define ERRNO_QUOTA %s\n", errno_quota);
303 if (strcmp(cc, "gcc") == 0 &&
304 (strstr(ostype, "IRIX") != NULL || strstr(ostype, "AIX") != NULL))
306 fprintf(new, "\n/* This switch includes the code to fix the inet_ntoa() */");
307 fprintf(new, "\n/* bug when using gcc on an IRIX or AIX system. */");
308 fprintf(new, "\n#define USE_INET_NTOA_FIX");
315 /* Now handle the macros listed in the defaults */
317 base = fopen("../src/config.h.defaults", "rb");
320 printf("*** Buildconfig: failed to open ../src/config.h.defaults\n");
325 while (fgets(buffer, sizeof(buffer), base) != NULL)
333 while (*p == ' ' || *p == '\t') p++;
335 if (strncmp(p, "#ifdef ", 7) == 0
336 || strncmp(p, "#ifndef ", 8) == 0
337 || strncmp(p, "#if ", 4) == 0
338 || strncmp(p, "#endif", 6) == 0
345 if (strncmp(p, "#define ", 8) != 0) continue;
348 while (*p == ' ' || *p == '\t') p++;
350 if (*p < last_initial) fprintf(new, "\n");
353 while (*p && (isalnum((unsigned char)*p) || *p == '_')) *q++ = *p++;
356 /* USE_DB, USE_GDBM, and USE_TDB are special cases. We want to have only
357 one of them set. The scan of the Makefile has saved which was the last one
360 for (i = 1; i < sizeof(db_opts)/sizeof(char *); i++)
362 if (strcmp(name, db_opts[i]) == 0)
364 if (use_which_db == i)
365 fprintf(new, "#define %s %.*syes\n", db_opts[i],
366 21 - (int)strlen(db_opts[i]), " ");
368 fprintf(new, "/* %s not set */\n", name);
372 if (i < sizeof(db_opts)/sizeof(char *)) continue;
374 /* EXIM_USER is a special case. We look in the environment for EXIM_USER or
375 EXIM_UID (the latter for backward compatibility with Exim 3). If the value is
376 not numeric, we look up the user, and default the GID if found. Otherwise,
377 EXIM_GROUP or EXIM_GID must be in the environment. */
379 if (strcmp(name, "EXIM_UID") == 0)
385 char *username = NULL;
386 char *groupname = NULL;
388 char *user = getenv("EXIM_USER");
389 char *group = getenv("EXIM_GROUP");
391 if (user == NULL) user = getenv("EXIM_UID");
392 if (group == NULL) group = getenv("EXIM_GID");
396 printf("\n*** EXIM_USER has not been defined in any of the Makefiles in "
397 "the\n \"Local\" directory. Please review your build-time "
398 "configuration.\n\n");
402 while (isspace((unsigned char)(*user))) user++;
405 printf("\n*** EXIM_USER is defined as an empty string in one of the "
406 "files\n in the \"Local\" directory. Please review your build-time"
407 "\n configuration.\n\n");
411 for (s = user; *s != 0; s++)
413 if (iscntrl((unsigned char)(*s)))
415 printf("\n*** EXIM_USER contains the control character 0x%02X in one "
416 "of the files\n in the \"Local\" directory. Please review your "
417 "build-time\n configuration.\n\n", *s);
422 /* Numeric uid given */
424 if (user[strspn(user, "0123456789")] == 0)
426 uid = (uid_t)atoi(user);
429 /* User name given. Normally, we look up the uid right away. However,
430 people building binary distributions sometimes want to retain the name till
431 runtime. This is supported if the name begins "ref:". */
433 else if (strncmp(user, "ref:", 4) == 0)
436 while (isspace(*user)) user++;
444 struct passwd *pw = getpwnam(user);
447 printf("\n*** User \"%s\" (specified in one of the Makefiles) does not "
448 "exist.\n Please review your build-time configuration.\n\n",
458 /* Use explicit group if set. */
462 while (isspace((unsigned char)(*group))) group++;
465 printf("\n*** EXIM_GROUP is defined as an empty string in one of "
466 "the files in the\n \"Local\" directory. ");
469 printf("If you want the Exim group to be taken from the\n "
470 "password data for the Exim user, just remove the EXIM_GROUP "
471 "setting.\n Otherwise, p");
473 else printf("EXIM_USER is defined numerically, so there is no"
474 "\n default for EXIM_GROUP and you must set it explicitly.\n P");
475 printf("lease review your build-time configuration.\n\n");
479 for (s = group; *s != 0; s++)
481 if (iscntrl((unsigned char)(*s)))
483 printf("\n*** EXIM_GROUP contains the control character 0x%02X in one "
484 "of the files\n in the \"Local\" directory. Please review your "
485 "build-time\n configuration.\n\n", *s);
490 /* Group name given. This may be by reference or to be looked up now,
493 if (strncmp(group, "ref:", 4) == 0)
496 while (isspace(*group)) group++;
500 else if (username != NULL)
505 else if (group[strspn(group, "0123456789")] == 0)
507 gid = (gid_t)atoi(group);
512 struct group *gr = getgrnam(group);
515 printf("\n*** Group \"%s\" (specified in one of the Makefiles) does "
516 "not exist.\n Please review your build-time configuration.\n\n",
524 /* Else trouble unless found in passwd file with user */
528 printf("\n*** No group set for Exim. Please review your build-time "
529 "configuration.\n\n");
533 /* security sanity checks
534 if ref: is being used, we can never be sure, but we can take reasonable
535 steps to filter out the most obvious ones. */
537 if ((!uid_not_set && uid == 0) ||
538 ((username != NULL) && (
539 (strcmp(username, "root") == 0) ||
540 (strcmp(username, "toor") == 0) )))
542 printf("\n*** Exim's internal user must not be root.\n\n");
546 /* Output user and group names or uid/gid. When names are set, uid/gid
547 are set to zero but will be replaced at runtime. */
549 if (username != NULL)
550 fprintf(new, "#define EXIM_USERNAME \"%s\"\n", username);
551 if (groupname != NULL)
552 fprintf(new, "#define EXIM_GROUPNAME \"%s\"\n", groupname);
554 fprintf(new, "#define EXIM_UID %d\n", (int)uid);
555 fprintf(new, "#define EXIM_GID %d\n", (int)gid);
559 /* CONFIGURE_OWNER and CONFIGURE_GROUP are special cases. We look in the
560 environment for first. If the value is not numeric, we look up the user or
561 group. A lot of this code is similar to that for EXIM_USER, but it's easier
562 to keep it separate. */
564 if (strcmp(name, "CONFIGURE_OWNER") == 0 ||
565 strcmp(name, "CONFIGURE_GROUP") == 0)
567 int isgroup = name[10] == 'G';
571 const char *username = NULL;
572 const char *user = getenv(name);
574 if (user == NULL) user = "";
575 while (isspace((unsigned char)(*user))) user++;
578 fprintf(new, "/* %s not set */\n", name);
582 for (s = user; *s != 0; s++)
584 if (iscntrl((unsigned char)(*s)))
586 printf("\n*** %s contains the control character 0x%02X in "
587 "one of the files\n in the \"Local\" directory. Please review "
588 "your build-time\n configuration.\n\n", name, *s);
593 /* Numeric uid given */
595 if (user[strspn(user, "0123456789")] == 0)
598 gid = (gid_t)atoi(user);
600 uid = (uid_t)atoi(user);
603 /* Name given. Normally, we look up the uid or gid right away. However,
604 people building binary distributions sometimes want to retain the name till
605 runtime. This is supported if the name begins "ref:". */
607 else if (strncmp(user, "ref:", 4) == 0)
610 while (isspace(*user)) user++;
615 struct group *gr = getgrnam(user);
618 printf("\n*** Group \"%s\" (specified in one of the Makefiles) does not "
619 "exist.\n Please review your build-time configuration.\n\n",
628 struct passwd *pw = getpwnam(user);
631 printf("\n*** User \"%s\" (specified in one of the Makefiles) does not "
632 "exist.\n Please review your build-time configuration.\n\n",
639 /* Output user and group names or uid/gid. When names are set, uid/gid
640 are set to zero but will be replaced at runtime. */
642 if (username != NULL)
645 fprintf(new, "#define CONFIGURE_GROUPNAME \"%s\"\n", username);
647 fprintf(new, "#define CONFIGURE_OWNERNAME \"%s\"\n", username);
651 fprintf(new, "#define CONFIGURE_GROUP %d\n", (int)gid);
653 fprintf(new, "#define CONFIGURE_OWNER %d\n", (int)uid);
657 /* FIXED_NEVER_USERS is another special case. Look up the uid values and
658 create suitable initialization data for a vector. */
660 if (strcmp(name, "FIXED_NEVER_USERS") == 0)
662 char *list = getenv("FIXED_NEVER_USERS");
665 fprintf(new, "#define FIXED_NEVER_USERS 0\n");
673 while (*p != 0) if (*p++ == ':') count++;
675 vector = malloc((count+1) * sizeof(uid_t));
676 vector[0] = (uid_t)count;
678 for (i = 1, j = 0; i <= count; list++, i++)
683 while (*list != 0 && *list != ':') list++;
684 strncpy(name, p, list-p);
691 else if (name[strspn(name, "0123456789")] == 0)
693 vector[j++] = (uid_t)atoi(name);
697 struct passwd *pw = getpwnam(name);
700 printf("\n*** User \"%s\" (specified for FIXED_NEVER_USERS in one of the Makefiles) does not "
701 "exist.\n Please review your build-time configuration.\n\n",
705 vector[j++] = pw->pw_uid;
708 fprintf(new, "#define FIXED_NEVER_USERS %d", j);
709 for (i = 0; i < j; i++) fprintf(new, ", %d", (unsigned int)vector[i]);
715 /* WITH_CONTENT_SCAN is another special case: it must be set if either it or
716 WITH_OLD_DEMIME is set. */
718 if (strcmp(name, "WITH_CONTENT_SCAN") == 0)
720 char *wcs = getenv("WITH_CONTENT_SCAN");
721 char *wod = getenv("WITH_OLD_DEMIME");
722 char *dcc = getenv("EXPERIMENTAL_DCC");
723 if (wcs != NULL || wod != NULL || dcc != NULL)
724 fprintf(new, "#define WITH_CONTENT_SCAN yes\n");
725 else fprintf(new, "/* WITH_CONTENT_SCAN not set */\n");
729 /* Otherwise, check whether a value exists in the environment. Remember if
730 it is an AUTH setting or SUPPORT_CRYPTEQ. */
732 if ((value = getenv(name)) != NULL)
735 len = 21 - (int)strlen(name);
737 if (strncmp(name, "AUTH_", 5) == 0) have_auth = 1;
738 if (strncmp(name, "SUPPORT_CRYPTEQ", 15) == 0) support_crypteq = 1;
740 /* The text value of LDAP_LIB_TYPE refers to a macro that gets set. */
742 if (strcmp(name, "LDAP_LIB_TYPE") == 0)
744 if (strcmp(value, "NETSCAPE") == 0 ||
745 strcmp(value, "UMICHIGAN") == 0 ||
746 strcmp(value, "OPENLDAP1") == 0 ||
747 strcmp(value, "OPENLDAP2") == 0 ||
748 strcmp(value, "SOLARIS") == 0 ||
749 strcmp(value, "SOLARIS7") == 0) /* Compatibility */
751 fprintf(new, "#define LDAP_LIB_%s\n", value);
755 printf("\n*** LDAP_LIB_TYPE=%s is not a recognized LDAP library type."
756 "\n*** Please review your build-time configuration.\n\n", value);
761 else if (strcmp(name, "RADIUS_LIB_TYPE") == 0)
763 if (strcmp(value, "RADIUSCLIENT") == 0 ||
764 strcmp(value, "RADIUSCLIENTNEW") == 0 ||
765 strcmp(value, "RADLIB") == 0)
767 fprintf(new, "#define RADIUS_LIB_%s\n", value);
771 printf("\n*** RADIUS_LIB_TYPE=%s is not a recognized RADIUS library type."
772 "\n*** Please review your build-time configuration.\n\n", value);
777 /* Other macros get set to the environment value. */
781 fprintf(new, "#define %s ", name);
782 while(len-- > 0) fputc(' ', new);
784 /* LOG_FILE_PATH is now messy because it can be a path containing %s or
785 it can be "syslog" or ":syslog" or "syslog:path" or even "path:syslog". */
787 if (strcmp(name, "LOG_FILE_PATH") == 0)
793 char *sss = strchr(ss, ':');
796 strncpy(buffer, ss, sss-ss);
797 buffer[sss-ss] = 0; /* For empty case */
799 else strcpy(buffer, ss);
800 pp = buffer + (int)strlen(buffer);
801 while (pp > buffer && isspace((unsigned char)pp[-1])) pp--;
803 if (buffer[0] != 0 && strcmp(buffer, "syslog") != 0)
804 check_percent_ess(buffer, name);
805 if (sss == NULL) break;
807 while (isspace((unsigned char)*ss)) ss++;
809 fprintf(new, "\"%s\"\n", value);
812 /* Timezone values HEADERS_CHARSET, TCP_WRAPPERS_DAEMON_NAME and
813 WHITELIST_D_MACROS get quoted */
815 else if (strcmp(name, "TIMEZONE_DEFAULT") == 0||
816 strcmp(name, "TCP_WRAPPERS_DAEMON_NAME") == 0||
817 strcmp(name, "HEADERS_CHARSET") == 0||
818 strcmp(name, "WHITELIST_D_MACROS") == 0)
819 fprintf(new, "\"%s\"\n", value);
821 /* For others, quote any paths and don't quote anything else */
825 if (value[0] == '/') fprintf(new, "\"%s\"\n", value);
826 else fprintf(new, "%s\n", value);
831 /* Value not defined in the environment; use the default */
836 while (*p == ' ' || *p == '\t') p++;
837 if (*p != '\n') fputs(buffer, new); else
840 if (strcmp(name, "BIN_DIRECTORY") == 0 ||
841 strcmp(name, "CONFIGURE_FILE") == 0)
843 printf("\n*** %s has not been defined in any of the Makefiles in the\n"
844 " \"Local\" directory. "
845 "Please review your build-time configuration.\n\n", name);
849 if (strcmp(name, "TIMEZONE_DEFAULT") == 0)
851 char *tz = getenv("TZ");
852 fprintf(new, "#define TIMEZONE_DEFAULT ");
853 if (tz == NULL) fprintf(new, "NULL\n"); else
854 fprintf(new, "\"%s\"\n", tz);
857 else fprintf(new, "/* %s not set */\n", name);
864 /* If any AUTH macros were defined, ensure that SUPPORT_CRYPTEQ is also
869 if (!support_crypteq) fprintf(new, "/* Force SUPPORT_CRYPTEQ for AUTH */\n"
870 "#define SUPPORT_CRYPTEQ\n");
875 fprintf(new, "\n/* End of config.h */\n");
880 /* End of buildconfig.c */