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"
31 /* parser reads these */
32 char *rcfile; /* path name of rc file */
33 struct query cmd_opts; /* where to put command-line info */
35 /* parser sets these */
36 struct query *querylist; /* head of server list (globally visible) */
38 int yydebug; /* in case we didn't generate with -- debug */
40 static struct query current; /* current server record */
41 static int prc_errflag;
42 static struct hostdata *leadentry;
45 static void record_current(void);
46 static void user_reset(void);
47 static void reset_server(const char *name, int skip);
49 /* using Bison, this arranges that yydebug messages will show actual tokens */
51 #define YYPRINT(fp, type, val) fprintf(fp, " = \"%s\"", yytext)
60 %token DEFAULTS POLL SKIP VIA AKA LOCALDOMAINS PROTOCOL
61 %token PREAUTHENTICATE TIMEOUT KPOP SDPS KERBEROS4 KERBEROS5 KERBEROS SSH
62 %token ENVELOPE QVIRTUAL USERNAME PASSWORD FOLDER SMTPHOST MDA BSMTP LMTP
63 %token SMTPADDRESS SPAMRESPONSE PRECONNECT POSTCONNECT LIMIT WARNINGS
64 %token NETSEC INTERFACE MONITOR PLUGIN PLUGOUT
65 %token IS HERE THERE TO MAP WILDCARD
66 %token BATCHLIMIT FETCHLIMIT EXPUNGE PROPERTIES
67 %token SET LOGFILE DAEMON SYSLOG IDFILE INVISIBLE POSTMASTER BOUNCEMAIL
70 %token <number> NUMBER
71 %token NO KEEP FLUSH FETCHALL REWRITE FORCECR STRIPCR PASS8BITS DROPSTATUS
72 %token DNS SERVICE PORT UIDL INTERVAL MIMEDECODE IDLE CHECKALIAS
73 %token SSL SSLKEY SSLCERT
81 statement_list : statement
82 | statement_list statement
85 optmap : MAP | /* EMPTY */;
87 /* future global options should also have the form SET <name> optmap <value> */
88 statement : SET LOGFILE optmap STRING {run.logfile = xstrdup($4);}
89 | SET IDFILE optmap STRING {run.idfile = xstrdup($4);}
90 | SET DAEMON optmap NUMBER {run.poll_interval = $4;}
91 | SET POSTMASTER optmap STRING {run.postmaster = xstrdup($4);}
92 | SET BOUNCEMAIL {run.bouncemail = TRUE;}
93 | SET NO BOUNCEMAIL {run.bouncemail = FALSE;}
94 | SET PROPERTIES optmap STRING {run.properties =xstrdup($4);}
95 | SET SYSLOG {run.use_syslog = TRUE;}
96 | SET INVISIBLE {run.invisible = TRUE;}
99 * The way the next two productions are written depends on the fact that
100 * userspecs cannot be empty. It's a kluge to deal with files that set
101 * up a load of defaults and then have poll statements following with no
102 * user options at all.
104 | define_server serverspecs {record_current();}
105 | define_server serverspecs userspecs
107 /* detect and complain about the most common user error */
108 | define_server serverspecs userspecs serv_option
109 {yyerror("server option after user options");}
112 define_server : POLL STRING {reset_server($2, FALSE);}
113 | SKIP STRING {reset_server($2, TRUE);}
114 | DEFAULTS {reset_server("defaults", FALSE);}
117 serverspecs : /* EMPTY */
118 | serverspecs serv_option
121 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
122 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
125 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
126 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
129 serv_option : AKA alias_list
130 | VIA STRING {current.server.via = xstrdup($2);}
131 | LOCALDOMAINS domain_list
132 | PROTOCOL PROTO {current.server.protocol = $2;}
134 current.server.protocol = P_POP3;
136 if (current.server.preauthenticate == A_PASSWORD)
138 current.server.preauthenticate = A_KERBEROS_V5;
140 current.server.preauthenticate = A_KERBEROS_V4;
141 #endif /* KERBEROS_V5 */
143 current.server.service = KPOP_PORT;
144 #else /* INET6_ENABLE */
145 current.server.port = KPOP_PORT;
146 #endif /* INET6_ENABLE */
150 current.server.protocol = P_POP3;
151 current.server.sdps = TRUE;
153 yyerror("SDPS not enabled.");
154 #endif /* SDPS_ENABLE */
156 | UIDL {current.server.uidl = FLAG_TRUE;}
157 | NO UIDL {current.server.uidl = FLAG_FALSE;}
158 | CHECKALIAS {current.server.checkalias = FLAG_TRUE;}
159 | NO CHECKALIAS {current.server.checkalias = FLAG_FALSE;}
162 current.server.service = $2;
163 #endif /* INET6_ENABLE */
169 sprintf(buf, "%d", port);
170 current.server.service = xstrdup(buf);
172 current.server.port = $2;
173 #endif /* INET6_ENABLE */
175 | INTERVAL NUMBER {current.server.interval = $2;}
176 | PREAUTHENTICATE PASSWORD {current.server.preauthenticate = A_PASSWORD;}
177 | PREAUTHENTICATE KERBEROS4 {current.server.preauthenticate = A_KERBEROS_V4;}
178 | PREAUTHENTICATE KERBEROS5 {current.server.preauthenticate = A_KERBEROS_V5;}
179 | PREAUTHENTICATE KERBEROS {
181 current.server.preauthenticate = A_KERBEROS_V5;
183 current.server.preauthenticate = A_KERBEROS_V4;
184 #endif /* KERBEROS_V5 */
186 | PREAUTHENTICATE SSH {current.server.preauthenticate = A_SSH;}
187 | TIMEOUT NUMBER {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 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\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 | SPAMRESPONSE num_list
311 | MDA STRING {current.mda = xstrdup($2);}
312 | BSMTP STRING {current.bsmtp = xstrdup($2);}
313 | LMTP {current.listener = LMTP_MODE;}
314 | PRECONNECT STRING {current.preconnect = xstrdup($2);}
315 | POSTCONNECT STRING {current.postconnect = xstrdup($2);}
317 | KEEP {current.keep = FLAG_TRUE;}
318 | FLUSH {current.flush = 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 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
326 | IDLE {current.idle = FLAG_TRUE;}
328 | SSL {current.use_ssl = FLAG_TRUE;}
329 | SSLKEY STRING {current.sslkey = xstrdup($2);}
330 | SSLCERT STRING {current.sslcert = xstrdup($2);}
332 | NO KEEP {current.keep = FLAG_FALSE;}
333 | NO FLUSH {current.flush = FLAG_FALSE;}
334 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
335 | NO REWRITE {current.rewrite = FLAG_FALSE;}
336 | NO FORCECR {current.forcecr = FLAG_FALSE;}
337 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
338 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
339 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
340 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
341 | NO IDLE {current.idle = FLAG_FALSE;}
343 | NO SSL {current.use_ssl = FLAG_FALSE;}
345 | LIMIT NUMBER {current.limit = NUM_VALUE_IN($2);}
346 | WARNINGS NUMBER {current.warnings = NUM_VALUE_IN($2);}
347 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE_IN($2);}
348 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
349 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
351 | PROPERTIES STRING {current.properties = xstrdup($2);}
355 /* lexer interface */
357 extern int prc_lineno;
361 static struct query *hosttail; /* where to add new elements */
363 void yyerror (const char *s)
364 /* report a syntax error */
366 report_at_line(stderr, 0, rcfile, prc_lineno, "%s at %s", s,
367 (yytext && yytext[0]) ? yytext : "end of input");
371 int prc_filecheck(const char *pathname, const flag securecheck)
372 /* check that a configuration file is secure */
379 /* special case useful for debugging purposes */
380 if (strcmp("/dev/null", pathname) == 0)
383 /* pass through the special name for stdin */
384 if (strcmp("-", pathname) == 0)
387 /* the run control file must have the same uid as the REAL uid of this
388 process, it must have permissions no greater than 600, and it must not
389 be a symbolic link. We check these conditions here. */
391 if (lstat(pathname, &statbuf) < 0) {
395 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
400 if (!securecheck) return PS_SUCCESS;
402 if ((statbuf.st_mode & S_IFLNK) == S_IFLNK)
404 fprintf(stderr, "File %s must not be a symbolic link.\n", pathname);
408 if (statbuf.st_mode & ~(S_IFREG | S_IREAD | S_IWRITE | S_IEXEC | S_IXGRP))
410 fprintf(stderr, "File %s must have no more than -rwx--x--- (0710) permissions.\n",
416 if (statbuf.st_uid != geteuid())
418 if (statbuf.st_uid != getuid())
419 #endif /* HAVE_GETEUID */
421 fprintf(stderr, "File %s must be owned by you.\n", pathname);
428 int prc_parse_file (const char *pathname, const flag securecheck)
429 /* digest the configuration into a linked list of host records */
432 querylist = hosttail = (struct query *)NULL;
436 /* Check that the file is secure */
437 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
441 * Croak if the configuration directory does not exist.
442 * This probably means an NFS mount failed and we can't
443 * see a configuration file that ought to be there.
444 * Question: is this a portable check? It's not clear
445 * that all implementations of lstat() will return ENOTDIR
446 * rather than plain ENOENT in this case...
448 if (errno == ENOTDIR)
450 else if (errno == ENOENT)
453 /* Open the configuration file and feed it to the lexer. */
454 if (strcmp(pathname, "-") == 0)
456 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
457 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
461 yyparse(); /* parse entire file */
463 fclose(yyin); /* not checking this should be safe, file mode was r */
471 static void reset_server(const char *name, int skip)
472 /* clear the entire global record and initialize it with a new name */
475 memset(¤t,'\0',sizeof(current));
476 current.smtp_socket = -1;
477 current.server.pollname = xstrdup(name);
478 current.server.skip = skip;
482 static void user_reset(void)
483 /* clear the global current record (user parameters) used by the parser */
485 struct hostdata save;
488 * Purpose of this code is to initialize the new server block, but
489 * preserve whatever server name was previously set. Also
490 * preserve server options unless the command-line explicitly
493 save = current.server;
495 memset(¤t, '\0', sizeof(current));
496 current.smtp_socket = -1;
498 current.server = save;
501 struct query *hostalloc(init)
502 /* append a host record to the host list */
503 struct query *init; /* pointer to block containing initial values */
507 /* allocate new node */
508 node = (struct query *) xmalloc(sizeof(struct query));
512 memcpy(node, init, sizeof(struct query));
515 memset(node, '\0', sizeof(struct query));
516 node->smtp_socket = -1;
519 /* append to end of list */
520 if (hosttail != (struct query *) 0)
521 hosttail->next = node; /* list contains at least one element */
523 querylist = node; /* list is empty */
527 node->server.lead_server = leadentry;
530 node->server.lead_server = NULL;
531 leadentry = &node->server;
537 static void record_current(void)
538 /* register current parameters and append to the host list */
540 (void) hostalloc(¤t);
544 /* easier to do this than cope with variations in where the library lives */
545 int yywrap(void) {return 1;}
547 /* rcfile_y.y ends here */