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 int poll_interval; /* poll interval in seconds */
37 char *logfile; /* log file for daemon mode */
38 flag errors_to_syslog; /* if syslog was set */
39 flag use_invisible; /* if invisible was set */
40 struct query *querylist; /* head of server list (globally visible) */
42 int yydebug; /* in case we didn't generate with -- debug */
44 static struct query current; /* current server record */
45 static int prc_errflag;
46 static struct hostdata *leadentry;
49 static void record_current();
50 static void user_reset();
51 static void reset_server(char *name, int skip);
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 KERBEROS4 KERBEROS5 KERBEROS
66 %token ENVELOPE QVIRTUAL USERNAME PASSWORD FOLDER SMTPHOST MDA SMTPADDRESS
67 %token SPAMRESPONSE PRECONNECT POSTCONNECT LIMIT
68 %token IS HERE THERE TO MAP WILDCARD
69 %token BATCHLIMIT FETCHLIMIT EXPUNGE
70 %token SET LOGFILE DAEMON SYSLOG IDFILE INVISIBLE NETSEC INTERFACE MONITOR
73 %token <number> NUMBER
74 %token NO KEEP FLUSH FETCHALL REWRITE FORCECR STRIPCR PASS8BITS DROPSTATUS
75 %token DNS SERVICE PORT UIDL INTERVAL MIMEDECODE
83 statement_list : statement
84 | statement_list statement
87 optmap : MAP | /* EMPTY */;
89 /* future global options should also have the form SET <name> optmap <value> */
90 statement : SET LOGFILE optmap STRING {run.logfile = xstrdup($4);}
91 | SET IDFILE optmap STRING {run.idfile = xstrdup($4);}
92 | SET DAEMON optmap NUMBER {run.poll_interval = $4;}
93 | SET SYSLOG {run.use_syslog = TRUE;}
94 | SET INVISIBLE {run.invisible = TRUE;}
97 * The way the next two productions are written depends on the fact that
98 * userspecs cannot be empty. It's a kluge to deal with files that set
99 * up a load of defaults and then have poll statements following with no
100 * user options at all.
102 | define_server serverspecs {record_current();}
103 | define_server serverspecs userspecs
105 /* detect and complain about the most common user error */
106 | define_server serverspecs userspecs serv_option
107 {yyerror("server option after user options");}
110 define_server : POLL STRING {reset_server($2, FALSE);}
111 | SKIP STRING {reset_server($2, TRUE);}
112 | DEFAULTS {reset_server("defaults", FALSE);}
115 serverspecs : /* EMPTY */
116 | serverspecs serv_option
119 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
120 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
123 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
124 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
127 serv_option : AKA alias_list
128 | VIA STRING {current.server.via = xstrdup($2);}
129 | LOCALDOMAINS domain_list
130 | PROTOCOL PROTO {current.server.protocol = $2;}
132 current.server.protocol = P_POP3;
134 current.server.preauthenticate = A_KERBEROS_V5;
136 current.server.preauthenticate = A_KERBEROS_V4;
137 #endif /* KERBEROS_V5 */
139 current.server.service = KPOP_PORT;
141 current.server.port = KPOP_PORT;
144 | UIDL {current.server.uidl = FLAG_TRUE;}
145 | NO UIDL {current.server.uidl = FLAG_FALSE;}
148 current.server.service = $2;
153 current.server.port = $2;
156 | INTERVAL NUMBER {current.server.interval = $2;}
157 | AUTHENTICATE PASSWORD {current.server.preauthenticate = A_PASSWORD;}
158 | AUTHENTICATE KERBEROS4 {current.server.preauthenticate = A_KERBEROS_V4;}
159 | AUTHENTICATE KERBEROS5 {current.server.preauthenticate = A_KERBEROS_V5;}
160 | AUTHENTICATE KERBEROS {
162 current.server.preauthenticate = A_KERBEROS_V5;
164 current.server.preauthenticate = A_KERBEROS_V4;
165 #endif /* KERBEROS_V5 */
167 | TIMEOUT NUMBER {current.server.timeout = $2;}
169 | ENVELOPE NUMBER STRING
171 current.server.envelope =
173 current.server.envskip = $2;
177 current.server.envelope =
179 current.server.envskip = 0;
182 | QVIRTUAL STRING {current.server.qvirtual=xstrdup($2);}
188 if (net_security_strtorequest($2, &request, &requestlen))
189 yyerror("invalid security request");
191 current.server.netsec = xstrdup($2);
195 yyerror("network-security support disabled");
196 #endif /* NET_SECURITY */
199 #if defined(linux) && !defined(INET6)
200 interface_parse($2, ¤t.server);
201 #else /* defined(linux) && !defined(INET6) */
202 fprintf(stderr, "fetchmail: interface option is only supported under Linux\n");
203 #endif /* defined(linux) && !defined(INET6) */
206 #if defined(linux) && !defined(INET6)
207 current.server.monitor = xstrdup($2);
208 #else /* defined(linux) && !defined(INET6) */
209 fprintf(stderr, "fetchmail: monitor option is only supported under Linux\n");
210 #endif /* defined(linux) && !defined(INET6) */
212 | DNS {current.server.dns = FLAG_TRUE;}
213 | NO DNS {current.server.dns = FLAG_FALSE;}
214 | NO ENVELOPE {current.server.envelope = STRING_DISABLED;}
217 userspecs : user1opts {record_current(); user_reset();}
221 explicits : explicitdef {record_current(); user_reset();}
222 | explicits explicitdef {record_current(); user_reset();}
225 explicitdef : userdef user0opts
228 userdef : USERNAME STRING {current.remotename = xstrdup($2);}
229 | USERNAME mapping_list HERE
230 | USERNAME STRING THERE {current.remotename = xstrdup($2);}
233 user0opts : /* EMPTY */
234 | user0opts user_option
237 user1opts : user_option
238 | user1opts user_option
241 localnames : WILDCARD {current.wildcard = TRUE;}
242 | mapping_list {current.wildcard = FALSE;}
243 | mapping_list WILDCARD {current.wildcard = TRUE;}
246 mapping_list : mapping
247 | mapping_list mapping
251 {save_str_pair(¤t.localnames, $1, NULL);}
253 {save_str_pair(¤t.localnames, $1, $3);}
256 folder_list : STRING {save_str(¤t.mailboxes,$1,0);}
257 | folder_list STRING {save_str(¤t.mailboxes,$2,0);}
260 smtp_list : STRING {save_str(¤t.smtphunt, $1,TRUE);}
261 | smtp_list STRING {save_str(¤t.smtphunt, $2,TRUE);}
264 user_option : TO localnames HERE
269 | IS STRING THERE {current.remotename = xstrdup($2);}
270 | PASSWORD STRING {current.password = xstrdup($2);}
273 | SMTPADDRESS STRING {current.smtpaddress = xstrdup($2);}
274 | SPAMRESPONSE NUMBER {current.antispam = $2;}
275 | MDA STRING {current.mda = xstrdup($2);}
276 | PRECONNECT STRING {current.preconnect = xstrdup($2);}
277 | POSTCONNECT STRING {current.postconnect = xstrdup($2);}
279 | KEEP {current.keep = FLAG_TRUE;}
280 | FLUSH {current.flush = FLAG_TRUE;}
281 | FETCHALL {current.fetchall = FLAG_TRUE;}
282 | REWRITE {current.rewrite = FLAG_TRUE;}
283 | FORCECR {current.forcecr = FLAG_TRUE;}
284 | STRIPCR {current.stripcr = FLAG_TRUE;}
285 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
286 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
287 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
289 | NO KEEP {current.keep = FLAG_FALSE;}
290 | NO FLUSH {current.flush = FLAG_FALSE;}
291 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
292 | NO REWRITE {current.rewrite = FLAG_FALSE;}
293 | NO FORCECR {current.forcecr = FLAG_FALSE;}
294 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
295 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
296 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
297 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
299 | LIMIT NUMBER {current.limit = NUM_VALUE($2);}
300 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE($2);}
301 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE($2);}
302 | EXPUNGE NUMBER {current.expunge = NUM_VALUE($2);}
306 /* lexer interface */
308 extern int prc_lineno;
312 static struct query *hosttail; /* where to add new elements */
314 void yyerror (const char *s)
315 /* report a syntax error */
317 error_at_line( 0, 0, rcfile, prc_lineno, "%s at %s", s,
318 (yytext && yytext[0]) ? yytext : "end of input");
322 int prc_filecheck(pathname, securecheck)
323 /* check that a configuration file is secure */
324 const char *pathname; /* pathname for the configuration file */
325 const flag securecheck;
332 /* special cases useful for debugging purposes */
333 if (strcmp("/dev/null", pathname) == 0)
336 /* the run control file must have the same uid as the REAL uid of this
337 process, it must have permissions no greater than 600, and it must not
338 be a symbolic link. We check these conditions here. */
340 if (lstat(pathname, &statbuf) < 0) {
344 error(0, errno, "lstat: %s", pathname);
349 if (!securecheck) return 0;
351 if ((statbuf.st_mode & S_IFLNK) == S_IFLNK) {
352 fprintf(stderr, "File %s must not be a symbolic link.\n", pathname);
356 if (statbuf.st_mode & ~(S_IFREG | S_IREAD | S_IWRITE)) {
357 fprintf(stderr, "File %s must have no more than -rw------ (0600) permissions.\n",
362 if (statbuf.st_uid != getuid()) {
363 fprintf(stderr, "File %s must be owned by you.\n", pathname);
370 int prc_parse_file (const char *pathname, const flag securecheck)
371 /* digest the configuration into a linked list of host records */
374 querylist = hosttail = (struct query *)NULL;
378 /* Check that the file is secure */
379 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
385 /* Open the configuration and feed it to the lexer. */
386 if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
387 error(0, errno, "open: %s", pathname);
391 yyparse(); /* parse entire file */
401 static void reset_server(char *name, int skip)
402 /* clear the entire global record and initialize it with a new name */
405 memset(¤t,'\0',sizeof(current));
406 current.smtp_socket = -1;
407 current.server.pollname = xstrdup(name);
408 current.server.skip = skip;
412 static void user_reset(void)
413 /* clear the global current record (user parameters) used by the parser */
415 struct hostdata save;
418 * Purpose of this code is to initialize the new server block, but
419 * preserve whatever server name was previously set. Also
420 * preserve server options unless the command-line explicitly
423 save = current.server;
425 memset(¤t, '\0', sizeof(current));
426 current.smtp_socket = -1;
428 current.server = save;
431 struct query *hostalloc(init)
432 /* append a host record to the host list */
433 struct query *init; /* pointer to block containing initial values */
437 /* allocate new node */
438 node = (struct query *) xmalloc(sizeof(struct query));
442 memcpy(node, init, sizeof(struct query));
445 memset(node, '\0', sizeof(struct query));
446 node->smtp_socket = -1;
449 /* append to end of list */
450 if (hosttail != (struct query *) 0)
451 hosttail->next = node; /* list contains at least one element */
453 querylist = node; /* list is empty */
457 node->server.lead_server = leadentry;
460 node->server.lead_server = NULL;
461 leadentry = &node->server;
467 static void record_current(void)
468 /* register current parameters and append to the host list */
470 #define FLAG_FORCE(fld) if (cmd_opts.fld) current.fld = cmd_opts.fld
471 FLAG_FORCE(server.localdomains);
472 FLAG_FORCE(localnames);
473 FLAG_FORCE(mailboxes);
474 FLAG_FORCE(smtphunt);
476 FLAG_FORCE(server.via);
477 FLAG_FORCE(server.protocol);
479 FLAG_FORCE(server.service);
480 FLAG_FORCE(server.netsec);
482 FLAG_FORCE(server.port);
484 FLAG_FORCE(server.interval);
485 FLAG_FORCE(server.preauthenticate);
486 FLAG_FORCE(server.timeout);
487 FLAG_FORCE(server.envelope);
488 FLAG_FORCE(server.envskip);
489 FLAG_FORCE(server.qvirtual);
490 FLAG_FORCE(server.skip);
491 FLAG_FORCE(server.dns);
492 FLAG_FORCE(server.uidl);
495 FLAG_FORCE(server.interface);
496 FLAG_FORCE(server.monitor);
497 FLAG_FORCE(server.interface_pair);
500 FLAG_FORCE(remotename);
501 FLAG_FORCE(password);
503 FLAG_FORCE(smtpaddress);
504 FLAG_FORCE(antispam);
505 FLAG_FORCE(preconnect);
506 FLAG_FORCE(postconnect);
510 FLAG_FORCE(fetchall);
514 FLAG_FORCE(pass8bits);
515 FLAG_FORCE(dropstatus);
516 FLAG_FORCE(mimedecode);
518 FLAG_FORCE(fetchlimit);
519 FLAG_FORCE(batchlimit);
524 (void) hostalloc(¤t);
529 void optmerge(struct query *h2, struct query *h1)
530 /* merge two options records; empty fields in h2 are filled in from h1 */
532 append_str_list(&h2->server.localdomains, &h1->server.localdomains);
533 append_str_list(&h2->localnames, &h1->localnames);
534 append_str_list(&h2->mailboxes, &h1->mailboxes);
535 append_str_list(&h2->smtphunt, &h1->smtphunt);
537 #define FLAG_MERGE(fld) if (!h2->fld) h2->fld = h1->fld
538 FLAG_MERGE(server.via);
539 FLAG_MERGE(server.protocol);
541 FLAG_MERGE(server.service);
542 FLAG_MERGE(server.netsec);
544 FLAG_MERGE(server.port);
546 FLAG_MERGE(server.interval);
547 FLAG_MERGE(server.preauthenticate);
548 FLAG_MERGE(server.timeout);
549 FLAG_MERGE(server.envelope);
550 FLAG_MERGE(server.envskip);
551 FLAG_MERGE(server.qvirtual);
552 FLAG_MERGE(server.skip);
553 FLAG_MERGE(server.dns);
554 FLAG_MERGE(server.uidl);
557 FLAG_MERGE(server.interface);
558 FLAG_MERGE(server.monitor);
559 FLAG_MERGE(server.interface_pair);
562 FLAG_MERGE(remotename);
563 FLAG_MERGE(password);
565 FLAG_MERGE(smtpaddress);
566 FLAG_MERGE(antispam);
567 FLAG_MERGE(preconnect);
571 FLAG_MERGE(fetchall);
575 FLAG_MERGE(pass8bits);
576 FLAG_MERGE(dropstatus);
577 FLAG_MERGE(mimedecode);
579 FLAG_MERGE(fetchlimit);
580 FLAG_MERGE(batchlimit);
585 /* easier to do this than cope with variations in where the library lives */
586 int yywrap(void) {return 1;}
588 /* rcfile_y.y ends here */