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)
26 #include <net/security.h>
27 #endif /* NET_SECURITY */
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 /* using Bison, this arranges that yydebug messages will show actual tokens */
52 #define YYPRINT(fp, type, val) fprintf(fp, " = \"%s\"", yytext)
61 %token DEFAULTS POLL SKIP VIA AKA LOCALDOMAINS PROTOCOL
62 %token AUTHENTICATE TIMEOUT KPOP SDPS
63 %token ENVELOPE QVIRTUAL USERNAME PASSWORD FOLDER SMTPHOST MDA BSMTP LMTP
64 %token SMTPADDRESS SMTPNAME SPAMRESPONSE PRECONNECT POSTCONNECT LIMIT WARNINGS
65 %token NETSEC INTERFACE MONITOR PLUGIN PLUGOUT
66 %token IS HERE THERE TO MAP WILDCARD
67 %token BATCHLIMIT FETCHLIMIT EXPUNGE PROPERTIES
68 %token SET LOGFILE DAEMON SYSLOG IDFILE INVISIBLE POSTMASTER BOUNCEMAIL
69 %token SPAMBOUNCE SHOWDOTS
70 %token <proto> PROTO AUTHTYPE
72 %token <number> NUMBER
73 %token NO KEEP FLUSH FETCHALL REWRITE FORCECR STRIPCR PASS8BITS
74 %token DROPSTATUS DROPDELIVERED
75 %token DNS SERVICE PORT UIDL INTERVAL MIMEDECODE IDLE CHECKALIAS
76 %token SSL SSLKEY SSLCERT SSLPROTO
85 statement_list : statement
86 | statement_list statement
89 optmap : MAP | /* EMPTY */;
91 /* future global options should also have the form SET <name> optmap <value> */
92 statement : SET LOGFILE optmap STRING {run.logfile = xstrdup($4);}
93 | SET IDFILE optmap STRING {run.idfile = xstrdup($4);}
94 | SET DAEMON optmap NUMBER {run.poll_interval = $4;}
95 | SET POSTMASTER optmap STRING {run.postmaster = xstrdup($4);}
96 | SET BOUNCEMAIL {run.bouncemail = TRUE;}
97 | SET NO BOUNCEMAIL {run.bouncemail = FALSE;}
98 | SET SPAMBOUNCE {run.spambounce = TRUE;}
99 | SET NO SPAMBOUNCE {run.spambounce = FALSE;}
100 | SET PROPERTIES optmap STRING {run.properties =xstrdup($4);}
101 | SET SYSLOG {run.use_syslog = TRUE;}
102 | SET INVISIBLE {run.invisible = TRUE;}
103 | SET SHOWDOTS {run.showdots = TRUE;}
106 * The way the next two productions are written depends on the fact that
107 * userspecs cannot be empty. It's a kluge to deal with files that set
108 * up a load of defaults and then have poll statements following with no
109 * user options at all.
111 | define_server serverspecs {record_current();}
112 | define_server serverspecs userspecs
114 /* detect and complain about the most common user error */
115 | define_server serverspecs userspecs serv_option
116 {yyerror(_("server option after user options"));}
119 define_server : POLL STRING {reset_server($2, FALSE);}
120 | SKIP STRING {reset_server($2, TRUE);}
121 | DEFAULTS {reset_server("defaults", FALSE);}
124 serverspecs : /* EMPTY */
125 | serverspecs serv_option
128 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
129 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
132 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
133 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
136 serv_option : AKA alias_list
137 | VIA STRING {current.server.via = xstrdup($2);}
138 | LOCALDOMAINS domain_list
139 | PROTOCOL PROTO {current.server.protocol = $2;}
141 current.server.protocol = P_POP3;
143 if (current.server.authenticate == A_PASSWORD)
145 current.server.authenticate = A_KERBEROS_V5;
147 current.server.authenticate = A_KERBEROS_V4;
148 #endif /* KERBEROS_V5 */
150 current.server.service = KPOP_PORT;
151 #else /* INET6_ENABLE */
152 current.server.port = KPOP_PORT;
153 #endif /* INET6_ENABLE */
155 | PRINCIPAL STRING {current.server.principal = xstrdup($2);}
158 current.server.protocol = P_POP3;
159 current.server.sdps = TRUE;
161 yyerror(_("SDPS not enabled."));
162 #endif /* SDPS_ENABLE */
164 | UIDL {current.server.uidl = FLAG_TRUE;}
165 | NO UIDL {current.server.uidl = FLAG_FALSE;}
166 | CHECKALIAS {current.server.checkalias = FLAG_TRUE;}
167 | NO CHECKALIAS {current.server.checkalias = FLAG_FALSE;}
170 current.server.service = $2;
171 #endif /* INET6_ENABLE */
177 sprintf(buf, "%d", port);
178 current.server.service = xstrdup(buf);
180 current.server.port = $2;
181 #endif /* INET6_ENABLE */
184 {current.server.interval = $2;}
185 | AUTHENTICATE AUTHTYPE
186 {current.server.authenticate = $2;}
188 {current.server.timeout = $2;}
189 | ENVELOPE NUMBER STRING
191 current.server.envelope =
193 current.server.envskip = $2;
197 current.server.envelope =
199 current.server.envskip = 0;
202 | QVIRTUAL STRING {current.server.qvirtual=xstrdup($2);}
208 if (net_security_strtorequest($2, &request, &requestlen))
209 yyerror(_("invalid security request"));
211 current.server.netsec = xstrdup($2);
215 yyerror(_("network-security support disabled"));
216 #endif /* NET_SECURITY */
219 #if (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__)
220 interface_parse($2, ¤t.server);
221 #else /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
222 fprintf(stderr, _("fetchmail: interface option is only supported under Linux (without IPv6) and FreeBSD\n"));
223 #endif /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
226 #if (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__)
227 current.server.monitor = xstrdup($2);
228 #else /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
229 fprintf(stderr, _("fetchmail: monitor option is only supported under Linux (without IPv6) and FreeBSD\n"));
230 #endif /* (defined(linux) && !defined(INET6_ENABLE) || defined(__FreeBSD__)) */
232 | PLUGIN STRING { current.server.plugin = xstrdup($2); }
233 | PLUGOUT STRING { current.server.plugout = xstrdup($2); }
234 | DNS {current.server.dns = FLAG_TRUE;}
235 | NO DNS {current.server.dns = FLAG_FALSE;}
236 | NO ENVELOPE {current.server.envelope = STRING_DISABLED;}
239 userspecs : user1opts {record_current(); user_reset();}
243 explicits : explicitdef {record_current(); user_reset();}
244 | explicits explicitdef {record_current(); user_reset();}
247 explicitdef : userdef user0opts
250 userdef : USERNAME STRING {current.remotename = xstrdup($2);}
251 | USERNAME mapping_list HERE
252 | USERNAME STRING THERE {current.remotename = xstrdup($2);}
255 user0opts : /* EMPTY */
256 | user0opts user_option
259 user1opts : user_option
260 | user1opts user_option
263 localnames : WILDCARD {current.wildcard = TRUE;}
264 | mapping_list {current.wildcard = FALSE;}
265 | mapping_list WILDCARD {current.wildcard = TRUE;}
268 mapping_list : mapping
269 | mapping_list mapping
273 {save_str_pair(¤t.localnames, $1, NULL);}
275 {save_str_pair(¤t.localnames, $1, $3);}
278 folder_list : STRING {save_str(¤t.mailboxes,$1,0);}
279 | folder_list STRING {save_str(¤t.mailboxes,$2,0);}
282 smtp_list : STRING {save_str(¤t.smtphunt, $1,TRUE);}
283 | smtp_list STRING {save_str(¤t.smtphunt, $2,TRUE);}
289 id=save_str(¤t.antispam,STRING_DUMMY,0);
290 id->val.status.num = $1;
295 id=save_str(¤t.antispam,STRING_DUMMY,0);
296 id->val.status.num = $2;
300 user_option : TO localnames HERE
305 | IS STRING THERE {current.remotename = xstrdup($2);}
306 | PASSWORD STRING {current.password = xstrdup($2);}
309 | SMTPADDRESS STRING {current.smtpaddress = xstrdup($2);}
310 | SMTPNAME STRING {current.smtpname = xstrdup($2);}
311 | SPAMRESPONSE num_list
312 | MDA STRING {current.mda = xstrdup($2);}
313 | BSMTP STRING {current.bsmtp = xstrdup($2);}
314 | LMTP {current.listener = LMTP_MODE;}
315 | PRECONNECT STRING {current.preconnect = xstrdup($2);}
316 | POSTCONNECT STRING {current.postconnect = xstrdup($2);}
318 | KEEP {current.keep = FLAG_TRUE;}
319 | FLUSH {current.flush = FLAG_TRUE;}
320 | FETCHALL {current.fetchall = FLAG_TRUE;}
321 | REWRITE {current.rewrite = FLAG_TRUE;}
322 | FORCECR {current.forcecr = FLAG_TRUE;}
323 | STRIPCR {current.stripcr = FLAG_TRUE;}
324 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
325 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
326 | DROPDELIVERED {current.dropdelivered = FLAG_TRUE;}
327 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
328 | IDLE {current.idle = FLAG_TRUE;}
330 | SSL {current.use_ssl = FLAG_TRUE;}
331 | SSLKEY STRING {current.sslkey = xstrdup($2);}
332 | SSLCERT STRING {current.sslcert = xstrdup($2);}
333 | SSLPROTO STRING {current.sslproto = 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 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
353 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
355 | PROPERTIES STRING {current.properties = xstrdup($2);}
359 /* lexer interface */
361 extern int prc_lineno;
365 static struct query *hosttail; /* where to add new elements */
367 void yyerror (const char *s)
368 /* report a syntax error */
370 report_at_line(stderr, 0, rcfile, prc_lineno, _("%s at %s"), s,
371 (yytext && yytext[0]) ? yytext : _("end of input"));
375 int prc_filecheck(const char *pathname, const flag securecheck)
376 /* check that a configuration file is secure */
383 /* special case useful for debugging purposes */
384 if (strcmp("/dev/null", pathname) == 0)
387 /* pass through the special name for stdin */
388 if (strcmp("-", pathname) == 0)
391 /* the run control file must have the same uid as the REAL uid of this
392 process, it must have permissions no greater than 600, and it must not
393 be a symbolic link. We check these conditions here. */
395 if (lstat(pathname, &statbuf) < 0) {
399 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
404 if (!securecheck) return PS_SUCCESS;
406 if ((statbuf.st_mode & S_IFLNK) == S_IFLNK)
408 fprintf(stderr, _("File %s must not be a symbolic link.\n"), pathname);
413 if (statbuf.st_mode & ~(S_IFREG | S_IREAD | S_IWRITE | S_IEXEC | S_IXGRP))
415 fprintf(stderr, _("File %s must have no more than -rwx--x--- (0710) permissions.\n"),
419 #endif /* __BEOS__ */
422 if (statbuf.st_uid != geteuid())
424 if (statbuf.st_uid != getuid())
425 #endif /* HAVE_GETEUID */
427 fprintf(stderr, _("File %s must be owned by you.\n"), pathname);
434 int prc_parse_file (const char *pathname, const flag securecheck)
435 /* digest the configuration into a linked list of host records */
438 querylist = hosttail = (struct query *)NULL;
442 /* Check that the file is secure */
443 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
447 * Croak if the configuration directory does not exist.
448 * This probably means an NFS mount failed and we can't
449 * see a configuration file that ought to be there.
450 * Question: is this a portable check? It's not clear
451 * that all implementations of lstat() will return ENOTDIR
452 * rather than plain ENOENT in this case...
454 if (errno == ENOTDIR)
456 else if (errno == ENOENT)
459 /* Open the configuration file and feed it to the lexer. */
460 if (strcmp(pathname, "-") == 0)
462 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
463 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
467 yyparse(); /* parse entire file */
469 fclose(yyin); /* not checking this should be safe, file mode was r */
477 static void reset_server(const char *name, int skip)
478 /* clear the entire global record and initialize it with a new name */
481 memset(¤t,'\0',sizeof(current));
482 current.smtp_socket = -1;
483 current.server.pollname = xstrdup(name);
484 current.server.skip = skip;
485 current.server.principal = (char *)NULL;
489 static void user_reset(void)
490 /* clear the global current record (user parameters) used by the parser */
492 struct hostdata save;
495 * Purpose of this code is to initialize the new server block, but
496 * preserve whatever server name was previously set. Also
497 * preserve server options unless the command-line explicitly
500 save = current.server;
502 memset(¤t, '\0', sizeof(current));
503 current.smtp_socket = -1;
505 current.server = save;
508 struct query *hostalloc(init)
509 /* append a host record to the host list */
510 struct query *init; /* pointer to block containing initial values */
514 /* allocate new node */
515 node = (struct query *) xmalloc(sizeof(struct query));
519 memcpy(node, init, sizeof(struct query));
522 memset(node, '\0', sizeof(struct query));
523 node->smtp_socket = -1;
526 /* append to end of list */
527 if (hosttail != (struct query *) 0)
528 hosttail->next = node; /* list contains at least one element */
530 querylist = node; /* list is empty */
534 node->server.lead_server = leadentry;
537 node->server.lead_server = NULL;
538 leadentry = &node->server;
544 static void record_current(void)
545 /* register current parameters and append to the host list */
547 (void) hostalloc(¤t);
551 /* easier to do this than cope with variations in where the library lives */
552 int yywrap(void) {return 1;}
554 /* rcfile_y.y ends here */