3 * rcfile_y.y -- Run control file parser for fetchmail
5 * For license terms, see the file COPYING in this directory.
10 #include <sys/types.h>
12 #if defined(HAVE_SYS_WAIT_H)
17 #if defined(STDC_HEADERS)
20 #if defined(HAVE_UNISTD_H)
25 #if defined(__CYGWIN__)
26 #include <sys/cygwin.h>
27 #endif /* __CYGWIN__ */
29 #include "fetchmail.h"
32 /* parser reads these */
33 char *rcfile; /* path name of rc file */
34 struct query cmd_opts; /* where to put command-line info */
36 /* parser sets these */
37 struct query *querylist; /* head of server list (globally visible) */
39 int yydebug; /* in case we didn't generate with -- debug */
41 static struct query current; /* current server record */
42 static int prc_errflag;
43 static struct hostdata *leadentry;
46 static void record_current(void);
47 static void user_reset(void);
48 static void reset_server(const char *name, int skip);
50 /* these should be of size PATH_MAX */
51 char currentwd[1024] = "", rcfiledir[1024] = "";
53 /* using Bison, this arranges that yydebug messages will show actual tokens */
55 #define YYPRINT(fp, type, val) fprintf(fp, " = \"%s\"", yytext)
64 %token DEFAULTS POLL SKIP VIA AKA LOCALDOMAINS PROTOCOL
65 %token AUTHENTICATE TIMEOUT KPOP SDPS ENVELOPE QVIRTUAL
66 %token USERNAME PASSWORD FOLDER SMTPHOST FETCHDOMAINS MDA BSMTP LMTP
67 %token SMTPADDRESS SMTPNAME SPAMRESPONSE PRECONNECT POSTCONNECT LIMIT WARNINGS
68 %token INTERFACE MONITOR PLUGIN PLUGOUT
69 %token IS HERE THERE TO MAP WILDCARD
70 %token BATCHLIMIT FETCHLIMIT FETCHSIZELIMIT FASTUIDL EXPUNGE PROPERTIES
71 %token SET LOGFILE DAEMON SYSLOG IDFILE PIDFILE INVISIBLE POSTMASTER BOUNCEMAIL
72 %token SPAMBOUNCE SHOWDOTS
73 %token <proto> PROTO AUTHTYPE
75 %token <number> NUMBER
76 %token NO KEEP FLUSH LIMITFLUSH FETCHALL REWRITE FORCECR STRIPCR PASS8BITS
77 %token DROPSTATUS DROPDELIVERED
78 %token DNS SERVICE PORT UIDL INTERVAL MIMEDECODE IDLE CHECKALIAS
79 %token SSL SSLKEY SSLCERT SSLPROTO SSLCERTCK SSLCERTPATH SSLFINGERPRINT
80 %token PRINCIPAL ESMTPNAME ESMTPPASSWORD
89 statement_list : statement
90 | statement_list statement
93 optmap : MAP | /* EMPTY */;
95 /* future global options should also have the form SET <name> optmap <value> */
96 statement : SET LOGFILE optmap STRING {run.logfile = prependdir ($4, rcfiledir);}
97 | SET IDFILE optmap STRING {run.idfile = prependdir ($4, rcfiledir);}
98 | SET PIDFILE optmap STRING {run.pidfile = prependdir ($4, rcfiledir);}
99 | SET DAEMON optmap NUMBER {run.poll_interval = $4;}
100 | SET POSTMASTER optmap STRING {run.postmaster = xstrdup($4);}
101 | SET BOUNCEMAIL {run.bouncemail = TRUE;}
102 | SET NO BOUNCEMAIL {run.bouncemail = FALSE;}
103 | SET SPAMBOUNCE {run.spambounce = TRUE;}
104 | SET NO SPAMBOUNCE {run.spambounce = FALSE;}
105 | SET PROPERTIES optmap STRING {run.properties =xstrdup($4);}
106 | SET SYSLOG {run.use_syslog = TRUE;}
107 | SET NO SYSLOG {run.use_syslog = FALSE;}
108 | SET INVISIBLE {run.invisible = TRUE;}
109 | SET NO INVISIBLE {run.invisible = FALSE;}
110 | SET SHOWDOTS {run.showdots = FLAG_TRUE;}
111 | SET NO SHOWDOTS {run.showdots = FLAG_FALSE;}
114 * The way the next two productions are written depends on the fact that
115 * userspecs cannot be empty. It's a kluge to deal with files that set
116 * up a load of defaults and then have poll statements following with no
117 * user options at all.
119 | define_server serverspecs {record_current();}
120 | define_server serverspecs userspecs
122 /* detect and complain about the most common user error */
123 | define_server serverspecs userspecs serv_option
124 {yyerror(GT_("server option after user options"));}
127 define_server : POLL STRING {reset_server($2, FALSE);}
128 | SKIP STRING {reset_server($2, TRUE);}
129 | DEFAULTS {reset_server("defaults", FALSE);}
132 serverspecs : /* EMPTY */
133 | serverspecs serv_option
136 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
137 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
140 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
141 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
144 serv_option : AKA alias_list
145 | VIA STRING {current.server.via = xstrdup($2);}
146 | LOCALDOMAINS domain_list
147 | PROTOCOL PROTO {current.server.protocol = $2;}
149 current.server.protocol = P_POP3;
151 if (current.server.authenticate == A_PASSWORD)
153 current.server.authenticate = A_KERBEROS_V5;
155 current.server.authenticate = A_KERBEROS_V4;
156 #endif /* KERBEROS_V5 */
157 current.server.service = KPOP_PORT;
159 | PRINCIPAL STRING {current.server.principal = xstrdup($2);}
160 | ESMTPNAME STRING {current.server.esmtp_name = xstrdup($2);}
161 | ESMTPPASSWORD STRING {current.server.esmtp_password = xstrdup($2);}
164 current.server.protocol = P_POP3;
165 current.server.sdps = TRUE;
167 yyerror(GT_("SDPS not enabled."));
168 #endif /* SDPS_ENABLE */
170 | UIDL {current.server.uidl = FLAG_TRUE;}
171 | NO UIDL {current.server.uidl = FLAG_FALSE;}
172 | CHECKALIAS {current.server.checkalias = FLAG_TRUE;}
173 | NO CHECKALIAS {current.server.checkalias = FLAG_FALSE;}
175 current.server.service = $2;
180 snprintf(buf, sizeof buf, "%d", port);
181 current.server.service = xstrdup(buf);
186 snprintf(buf, sizeof buf, "%d", port);
187 current.server.service = xstrdup(buf);
190 {current.server.interval = $2;}
191 | AUTHENTICATE AUTHTYPE
192 {current.server.authenticate = $2;}
194 {current.server.timeout = $2;}
195 | ENVELOPE NUMBER STRING
197 current.server.envelope =
199 current.server.envskip = $2;
203 current.server.envelope =
205 current.server.envskip = 0;
208 | QVIRTUAL STRING {current.server.qvirtual=xstrdup($2);}
211 interface_parse($2, ¤t.server);
213 fprintf(stderr, GT_("fetchmail: interface option is only supported under Linux (without IPv6) and FreeBSD\n"));
218 current.server.monitor = xstrdup($2);
220 fprintf(stderr, GT_("fetchmail: monitor option is only supported under Linux (without IPv6) and FreeBSD\n"));
223 | PLUGIN STRING { current.server.plugin = xstrdup($2); }
224 | PLUGOUT STRING { current.server.plugout = xstrdup($2); }
225 | DNS {current.server.dns = FLAG_TRUE;}
226 | NO DNS {current.server.dns = FLAG_FALSE;}
227 | NO ENVELOPE {current.server.envelope = STRING_DISABLED;}
228 | TRACEPOLLS {current.server.tracepolls = FLAG_TRUE;}
229 | NO TRACEPOLLS {current.server.tracepolls = FLAG_FALSE;}
232 userspecs : user1opts {record_current(); user_reset();}
236 explicits : explicitdef {record_current(); user_reset();}
237 | explicits explicitdef {record_current(); user_reset();}
240 explicitdef : userdef user0opts
243 userdef : USERNAME STRING {current.remotename = xstrdup($2);}
244 | USERNAME mapping_list HERE
245 | USERNAME STRING THERE {current.remotename = xstrdup($2);}
248 user0opts : /* EMPTY */
249 | user0opts user_option
252 user1opts : user_option
253 | user1opts user_option
256 localnames : WILDCARD {current.wildcard = TRUE;}
257 | mapping_list {current.wildcard = FALSE;}
258 | mapping_list WILDCARD {current.wildcard = TRUE;}
261 mapping_list : mapping
262 | mapping_list mapping
266 {save_str_pair(¤t.localnames, $1, NULL);}
268 {save_str_pair(¤t.localnames, $1, $3);}
271 folder_list : STRING {save_str(¤t.mailboxes,$1,0);}
272 | folder_list STRING {save_str(¤t.mailboxes,$2,0);}
275 smtp_list : STRING {save_str(¤t.smtphunt, $1,TRUE);}
276 | smtp_list STRING {save_str(¤t.smtphunt, $2,TRUE);}
279 fetch_list : STRING {save_str(¤t.domainlist, $1,TRUE);}
280 | fetch_list STRING {save_str(¤t.domainlist, $2,TRUE);}
286 id=save_str(¤t.antispam,STRING_DUMMY,0);
287 id->val.status.num = $1;
292 id=save_str(¤t.antispam,STRING_DUMMY,0);
293 id->val.status.num = $2;
297 user_option : TO localnames HERE
302 | IS STRING THERE {current.remotename = xstrdup($2);}
303 | PASSWORD STRING {current.password = xstrdup($2);}
306 | FETCHDOMAINS fetch_list
307 | SMTPADDRESS STRING {current.smtpaddress = xstrdup($2);}
308 | SMTPNAME STRING {current.smtpname = xstrdup($2);}
309 | SPAMRESPONSE num_list
310 | MDA STRING {current.mda = xstrdup($2);}
311 | BSMTP STRING {current.bsmtp = prependdir ($2, rcfiledir);}
312 | LMTP {current.listener = LMTP_MODE;}
313 | PRECONNECT STRING {current.preconnect = xstrdup($2);}
314 | POSTCONNECT STRING {current.postconnect = xstrdup($2);}
316 | KEEP {current.keep = FLAG_TRUE;}
317 | FLUSH {current.flush = FLAG_TRUE;}
318 | LIMITFLUSH {current.limitflush = FLAG_TRUE;}
319 | FETCHALL {current.fetchall = FLAG_TRUE;}
320 | REWRITE {current.rewrite = FLAG_TRUE;}
321 | FORCECR {current.forcecr = FLAG_TRUE;}
322 | STRIPCR {current.stripcr = FLAG_TRUE;}
323 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
324 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
325 | DROPDELIVERED {current.dropdelivered = FLAG_TRUE;}
326 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
327 | IDLE {current.idle = FLAG_TRUE;}
331 current.use_ssl = FLAG_TRUE;
333 yyerror(GT_("SSL is not enabled"));
336 | SSLKEY STRING {current.sslkey = prependdir ($2, rcfiledir);}
337 | SSLCERT STRING {current.sslcert = prependdir ($2, rcfiledir);}
338 | SSLPROTO STRING {current.sslproto = xstrdup($2);}
339 | SSLCERTCK {current.sslcertck = FLAG_TRUE;}
340 | SSLCERTPATH STRING {current.sslcertpath = prependdir($2, rcfiledir);}
341 | SSLFINGERPRINT STRING {current.sslfingerprint = xstrdup($2);}
343 | NO KEEP {current.keep = FLAG_FALSE;}
344 | NO FLUSH {current.flush = FLAG_FALSE;}
345 | NO LIMITFLUSH {current.limitflush = FLAG_FALSE;}
346 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
347 | NO REWRITE {current.rewrite = FLAG_FALSE;}
348 | NO FORCECR {current.forcecr = FLAG_FALSE;}
349 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
350 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
351 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
352 | NO DROPDELIVERED {current.dropdelivered = FLAG_FALSE;}
353 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
354 | NO IDLE {current.idle = FLAG_FALSE;}
356 | NO SSL {current.use_ssl = FLAG_FALSE;}
358 | LIMIT NUMBER {current.limit = NUM_VALUE_IN($2);}
359 | WARNINGS NUMBER {current.warnings = NUM_VALUE_IN($2);}
360 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE_IN($2);}
361 | FETCHSIZELIMIT NUMBER {current.fetchsizelimit = NUM_VALUE_IN($2);}
362 | FASTUIDL NUMBER {current.fastuidl = NUM_VALUE_IN($2);}
363 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
364 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
366 | PROPERTIES STRING {current.properties = xstrdup($2);}
370 /* lexer interface */
372 extern int prc_lineno;
376 static struct query *hosttail; /* where to add new elements */
378 void yyerror (const char *s)
379 /* report a syntax error */
381 report_at_line(stderr, 0, rcfile, prc_lineno, GT_("%s at %s"), s,
382 (yytext && yytext[0]) ? yytext : GT_("end of input"));
386 /** check that a configuration file is secure, returns PS_* status codes */
387 int prc_filecheck(const char *pathname,
388 const flag securecheck /** shortcuts permission, filetype and uid tests if false */)
395 /* special case useful for debugging purposes */
396 if (strcmp("/dev/null", pathname) == 0)
399 /* pass through the special name for stdin */
400 if (strcmp("-", pathname) == 0)
403 /* the run control file must have the same uid as the REAL uid of this
404 process, it must have permissions no greater than 600, and it must not
405 be a symbolic link. We check these conditions here. */
407 if (lstat(pathname, &statbuf) < 0) {
411 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
416 if (!securecheck) return PS_SUCCESS;
418 if (!S_ISREG(statbuf.st_mode))
420 fprintf(stderr, GT_("File %s must be a regular file.\n"), pathname);
426 if (cygwin_internal(CW_CHECK_NTSEC, pathname))
427 #endif /* __CYGWIN__ */
428 if (statbuf.st_mode & (S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH | S_IXOTH))
430 fprintf(stderr, GT_("File %s must have no more than -rwx--x--- (0710) permissions.\n"),
434 #endif /* __BEOS__ */
437 if (statbuf.st_uid != geteuid())
439 if (statbuf.st_uid != getuid())
440 #endif /* HAVE_GETEUID */
442 fprintf(stderr, GT_("File %s must be owned by you.\n"), pathname);
449 int prc_parse_file (const char *pathname, const flag securecheck)
450 /* digest the configuration into a linked list of host records */
453 querylist = hosttail = (struct query *)NULL;
457 /* Check that the file is secure */
458 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
462 * Croak if the configuration directory does not exist.
463 * This probably means an NFS mount failed and we can't
464 * see a configuration file that ought to be there.
465 * Question: is this a portable check? It's not clear
466 * that all implementations of lstat() will return ENOTDIR
467 * rather than plain ENOENT in this case...
469 if (errno == ENOTDIR)
471 else if (errno == ENOENT)
474 /* Open the configuration file and feed it to the lexer. */
475 if (strcmp(pathname, "-") == 0)
477 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
478 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
482 yyparse(); /* parse entire file */
484 fclose(yyin); /* not checking this should be safe, file mode was r */
492 static void reset_server(const char *name, int skip)
493 /* clear the entire global record and initialize it with a new name */
496 memset(¤t,'\0',sizeof(current));
497 current.smtp_socket = -1;
498 current.server.pollname = xstrdup(name);
499 current.server.skip = skip;
500 current.server.principal = (char *)NULL;
504 static void user_reset(void)
505 /* clear the global current record (user parameters) used by the parser */
507 struct hostdata save;
510 * Purpose of this code is to initialize the new server block, but
511 * preserve whatever server name was previously set. Also
512 * preserve server options unless the command-line explicitly
515 save = current.server;
517 memset(¤t, '\0', sizeof(current));
518 current.smtp_socket = -1;
520 current.server = save;
523 /** append a host record to the host list */
524 struct query *hostalloc(struct query *init /** pointer to block containing
529 /* allocate new node */
530 node = (struct query *) xmalloc(sizeof(struct query));
534 memcpy(node, init, sizeof(struct query));
537 memset(node, '\0', sizeof(struct query));
538 node->smtp_socket = -1;
541 /* append to end of list */
542 if (hosttail != (struct query *) 0)
543 hosttail->next = node; /* list contains at least one element */
545 querylist = node; /* list is empty */
549 node->server.lead_server = leadentry;
552 node->server.lead_server = NULL;
553 leadentry = &node->server;
559 static void record_current(void)
560 /* register current parameters and append to the host list */
562 (void) hostalloc(¤t);
566 char *prependdir (const char *file, const char *dir)
567 /* if a filename is relative to dir, convert it to an absolute path */
570 if (!file[0] || /* null path */
571 file[0] == '/' || /* absolute path */
572 strcmp(file, "-") == 0 || /* stdin/stdout */
573 !dir[0]) /* we don't HAVE_GETCWD */
574 return xstrdup (file);
575 newfile = xmalloc (strlen (dir) + 1 + strlen (file) + 1);
576 if (dir[strlen(dir) - 1] != '/')
577 sprintf (newfile, "%s/%s", dir, file);
579 sprintf (newfile, "%s%s", dir, file);
583 /* rcfile_y.y ends here */