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 INVISIBLE POSTMASTER BOUNCEMAIL
72 %token SPAMBOUNCE SHOWDOTS
73 %token <proto> PROTO AUTHTYPE
75 %token <number> NUMBER
76 %token NO KEEP FLUSH 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 DAEMON optmap NUMBER {run.poll_interval = $4;}
99 | SET POSTMASTER optmap STRING {run.postmaster = xstrdup($4);}
100 | SET BOUNCEMAIL {run.bouncemail = TRUE;}
101 | SET NO BOUNCEMAIL {run.bouncemail = FALSE;}
102 | SET SPAMBOUNCE {run.spambounce = TRUE;}
103 | SET NO SPAMBOUNCE {run.spambounce = FALSE;}
104 | SET PROPERTIES optmap STRING {run.properties =xstrdup($4);}
105 | SET SYSLOG {run.use_syslog = TRUE;}
106 | SET NO SYSLOG {run.use_syslog = FALSE;}
107 | SET INVISIBLE {run.invisible = TRUE;}
108 | SET NO INVISIBLE {run.invisible = FALSE;}
109 | SET SHOWDOTS {run.showdots = FLAG_TRUE;}
110 | SET NO SHOWDOTS {run.showdots = FLAG_FALSE;}
113 * The way the next two productions are written depends on the fact that
114 * userspecs cannot be empty. It's a kluge to deal with files that set
115 * up a load of defaults and then have poll statements following with no
116 * user options at all.
118 | define_server serverspecs {record_current();}
119 | define_server serverspecs userspecs
121 /* detect and complain about the most common user error */
122 | define_server serverspecs userspecs serv_option
123 {yyerror(GT_("server option after user options"));}
126 define_server : POLL STRING {reset_server($2, FALSE);}
127 | SKIP STRING {reset_server($2, TRUE);}
128 | DEFAULTS {reset_server("defaults", FALSE);}
131 serverspecs : /* EMPTY */
132 | serverspecs serv_option
135 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
136 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
139 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
140 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
143 serv_option : AKA alias_list
144 | VIA STRING {current.server.via = xstrdup($2);}
145 | LOCALDOMAINS domain_list
146 | PROTOCOL PROTO {current.server.protocol = $2;}
148 current.server.protocol = P_POP3;
150 if (current.server.authenticate == A_PASSWORD)
152 current.server.authenticate = A_KERBEROS_V5;
154 current.server.authenticate = A_KERBEROS_V4;
155 #endif /* KERBEROS_V5 */
156 current.server.service = KPOP_PORT;
158 | PRINCIPAL STRING {current.server.principal = xstrdup($2);}
159 | ESMTPNAME STRING {current.server.esmtp_name = xstrdup($2);}
160 | ESMTPPASSWORD STRING {current.server.esmtp_password = xstrdup($2);}
163 current.server.protocol = P_POP3;
164 current.server.sdps = TRUE;
166 yyerror(GT_("SDPS not enabled."));
167 #endif /* SDPS_ENABLE */
169 | UIDL {current.server.uidl = FLAG_TRUE;}
170 | NO UIDL {current.server.uidl = FLAG_FALSE;}
171 | CHECKALIAS {current.server.checkalias = FLAG_TRUE;}
172 | NO CHECKALIAS {current.server.checkalias = FLAG_FALSE;}
174 current.server.service = $2;
179 snprintf(buf, sizeof buf, "%d", port);
180 current.server.service = xstrdup(buf);
183 {current.server.interval = $2;}
184 | AUTHENTICATE AUTHTYPE
185 {current.server.authenticate = $2;}
187 {current.server.timeout = $2;}
188 | ENVELOPE NUMBER STRING
190 current.server.envelope =
192 current.server.envskip = $2;
196 current.server.envelope =
198 current.server.envskip = 0;
201 | QVIRTUAL STRING {current.server.qvirtual=xstrdup($2);}
204 interface_parse($2, ¤t.server);
206 fprintf(stderr, GT_("fetchmail: interface option is only supported under Linux (without IPv6) and FreeBSD\n"));
211 current.server.monitor = xstrdup($2);
213 fprintf(stderr, GT_("fetchmail: monitor option is only supported under Linux (without IPv6) and FreeBSD\n"));
216 | PLUGIN STRING { current.server.plugin = xstrdup($2); }
217 | PLUGOUT STRING { current.server.plugout = xstrdup($2); }
218 | DNS {current.server.dns = FLAG_TRUE;}
219 | NO DNS {current.server.dns = FLAG_FALSE;}
220 | NO ENVELOPE {current.server.envelope = STRING_DISABLED;}
221 | TRACEPOLLS {current.server.tracepolls = FLAG_TRUE;}
222 | NO TRACEPOLLS {current.server.tracepolls = FLAG_FALSE;}
225 userspecs : user1opts {record_current(); user_reset();}
229 explicits : explicitdef {record_current(); user_reset();}
230 | explicits explicitdef {record_current(); user_reset();}
233 explicitdef : userdef user0opts
236 userdef : USERNAME STRING {current.remotename = xstrdup($2);}
237 | USERNAME mapping_list HERE
238 | USERNAME STRING THERE {current.remotename = xstrdup($2);}
241 user0opts : /* EMPTY */
242 | user0opts user_option
245 user1opts : user_option
246 | user1opts user_option
249 localnames : WILDCARD {current.wildcard = TRUE;}
250 | mapping_list {current.wildcard = FALSE;}
251 | mapping_list WILDCARD {current.wildcard = TRUE;}
254 mapping_list : mapping
255 | mapping_list mapping
259 {save_str_pair(¤t.localnames, $1, NULL);}
261 {save_str_pair(¤t.localnames, $1, $3);}
264 folder_list : STRING {save_str(¤t.mailboxes,$1,0);}
265 | folder_list STRING {save_str(¤t.mailboxes,$2,0);}
268 smtp_list : STRING {save_str(¤t.smtphunt, $1,TRUE);}
269 | smtp_list STRING {save_str(¤t.smtphunt, $2,TRUE);}
272 fetch_list : STRING {save_str(¤t.domainlist, $1,TRUE);}
273 | fetch_list STRING {save_str(¤t.domainlist, $2,TRUE);}
279 id=save_str(¤t.antispam,STRING_DUMMY,0);
280 id->val.status.num = $1;
285 id=save_str(¤t.antispam,STRING_DUMMY,0);
286 id->val.status.num = $2;
290 user_option : TO localnames HERE
295 | IS STRING THERE {current.remotename = xstrdup($2);}
296 | PASSWORD STRING {current.password = xstrdup($2);}
299 | FETCHDOMAINS fetch_list
300 | SMTPADDRESS STRING {current.smtpaddress = xstrdup($2);}
301 | SMTPNAME STRING {current.smtpname = xstrdup($2);}
302 | SPAMRESPONSE num_list
303 | MDA STRING {current.mda = xstrdup($2);}
304 | BSMTP STRING {current.bsmtp = prependdir ($2, rcfiledir);}
305 | LMTP {current.listener = LMTP_MODE;}
306 | PRECONNECT STRING {current.preconnect = xstrdup($2);}
307 | POSTCONNECT STRING {current.postconnect = xstrdup($2);}
309 | KEEP {current.keep = FLAG_TRUE;}
310 | FLUSH {current.flush = FLAG_TRUE;}
311 | FETCHALL {current.fetchall = FLAG_TRUE;}
312 | REWRITE {current.rewrite = FLAG_TRUE;}
313 | FORCECR {current.forcecr = FLAG_TRUE;}
314 | STRIPCR {current.stripcr = FLAG_TRUE;}
315 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
316 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
317 | DROPDELIVERED {current.dropdelivered = FLAG_TRUE;}
318 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
319 | IDLE {current.idle = FLAG_TRUE;}
323 current.use_ssl = FLAG_TRUE;
325 yyerror(GT_("SSL is not enabled"));
328 | SSLKEY STRING {current.sslkey = prependdir ($2, rcfiledir);}
329 | SSLCERT STRING {current.sslcert = prependdir ($2, rcfiledir);}
330 | SSLPROTO STRING {current.sslproto = xstrdup($2);}
331 | SSLCERTCK {current.sslcertck = FLAG_TRUE;}
332 | SSLCERTPATH STRING {current.sslcertpath = prependdir($2, rcfiledir);}
333 | SSLFINGERPRINT STRING {current.sslfingerprint = xstrdup($2);}
335 | NO KEEP {current.keep = FLAG_FALSE;}
336 | NO FLUSH {current.flush = FLAG_FALSE;}
337 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
338 | NO REWRITE {current.rewrite = FLAG_FALSE;}
339 | NO FORCECR {current.forcecr = FLAG_FALSE;}
340 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
341 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
342 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
343 | NO DROPDELIVERED {current.dropdelivered = FLAG_FALSE;}
344 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
345 | NO IDLE {current.idle = FLAG_FALSE;}
347 | NO SSL {current.use_ssl = FLAG_FALSE;}
349 | LIMIT NUMBER {current.limit = NUM_VALUE_IN($2);}
350 | WARNINGS NUMBER {current.warnings = NUM_VALUE_IN($2);}
351 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE_IN($2);}
352 | FETCHSIZELIMIT NUMBER {current.fetchsizelimit = NUM_VALUE_IN($2);}
353 | FASTUIDL NUMBER {current.fastuidl = NUM_VALUE_IN($2);}
354 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
355 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
357 | PROPERTIES STRING {current.properties = xstrdup($2);}
361 /* lexer interface */
363 extern int prc_lineno;
367 static struct query *hosttail; /* where to add new elements */
369 void yyerror (const char *s)
370 /* report a syntax error */
372 report_at_line(stderr, 0, rcfile, prc_lineno, GT_("%s at %s"), s,
373 (yytext && yytext[0]) ? yytext : GT_("end of input"));
377 int prc_filecheck(const char *pathname, const flag securecheck)
378 /* check that a configuration file is secure */
385 /* special case useful for debugging purposes */
386 if (strcmp("/dev/null", pathname) == 0)
389 /* pass through the special name for stdin */
390 if (strcmp("-", pathname) == 0)
393 /* the run control file must have the same uid as the REAL uid of this
394 process, it must have permissions no greater than 600, and it must not
395 be a symbolic link. We check these conditions here. */
397 if (lstat(pathname, &statbuf) < 0) {
401 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
406 if (!securecheck) return PS_SUCCESS;
408 if (!S_ISREG(statbuf.st_mode))
410 fprintf(stderr, GT_("File %s must be a regular file.\n"), pathname);
416 if (cygwin_internal(CW_CHECK_NTSEC, pathname))
417 #endif /* __CYGWIN__ */
418 if (statbuf.st_mode & (S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH | S_IXOTH))
420 fprintf(stderr, GT_("File %s must have no more than -rwx--x--- (0710) permissions.\n"),
424 #endif /* __BEOS__ */
427 if (statbuf.st_uid != geteuid())
429 if (statbuf.st_uid != getuid())
430 #endif /* HAVE_GETEUID */
432 fprintf(stderr, GT_("File %s must be owned by you.\n"), pathname);
439 int prc_parse_file (const char *pathname, const flag securecheck)
440 /* digest the configuration into a linked list of host records */
443 querylist = hosttail = (struct query *)NULL;
447 /* Check that the file is secure */
448 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
452 * Croak if the configuration directory does not exist.
453 * This probably means an NFS mount failed and we can't
454 * see a configuration file that ought to be there.
455 * Question: is this a portable check? It's not clear
456 * that all implementations of lstat() will return ENOTDIR
457 * rather than plain ENOENT in this case...
459 if (errno == ENOTDIR)
461 else if (errno == ENOENT)
464 /* Open the configuration file and feed it to the lexer. */
465 if (strcmp(pathname, "-") == 0)
467 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
468 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
472 yyparse(); /* parse entire file */
474 fclose(yyin); /* not checking this should be safe, file mode was r */
482 static void reset_server(const char *name, int skip)
483 /* clear the entire global record and initialize it with a new name */
486 memset(¤t,'\0',sizeof(current));
487 current.smtp_socket = -1;
488 current.server.pollname = xstrdup(name);
489 current.server.skip = skip;
490 current.server.principal = (char *)NULL;
494 static void user_reset(void)
495 /* clear the global current record (user parameters) used by the parser */
497 struct hostdata save;
500 * Purpose of this code is to initialize the new server block, but
501 * preserve whatever server name was previously set. Also
502 * preserve server options unless the command-line explicitly
505 save = current.server;
507 memset(¤t, '\0', sizeof(current));
508 current.smtp_socket = -1;
510 current.server = save;
513 struct query *hostalloc(init)
514 /* append a host record to the host list */
515 struct query *init; /* pointer to block containing initial values */
519 /* allocate new node */
520 node = (struct query *) xmalloc(sizeof(struct query));
524 memcpy(node, init, sizeof(struct query));
527 memset(node, '\0', sizeof(struct query));
528 node->smtp_socket = -1;
531 /* append to end of list */
532 if (hosttail != (struct query *) 0)
533 hosttail->next = node; /* list contains at least one element */
535 querylist = node; /* list is empty */
539 node->server.lead_server = leadentry;
542 node->server.lead_server = NULL;
543 leadentry = &node->server;
549 static void record_current(void)
550 /* register current parameters and append to the host list */
552 (void) hostalloc(¤t);
556 char *prependdir (const char *file, const char *dir)
557 /* if a filename is relative to dir, convert it to an absolute path */
560 if (!file[0] || /* null path */
561 file[0] == '/' || /* absolute path */
562 strcmp(file, "-") == 0 || /* stdin/stdout */
563 !dir[0]) /* we don't HAVE_GETCWD */
564 return xstrdup (file);
565 newfile = xmalloc (strlen (dir) + 1 + strlen (file) + 1);
566 if (dir[strlen(dir) - 1] != '/')
567 sprintf (newfile, "%s/%s", dir, file);
569 sprintf (newfile, "%s%s", dir, file);
573 /* easier to do this than cope with variations in where the library lives */
574 int yywrap(void) {return 1;}
576 /* rcfile_y.y ends here */