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 CHECKALIAS SSL SSLKEY SSLCERT
80 statement_list : statement
81 | statement_list statement
84 optmap : MAP | /* EMPTY */;
86 /* future global options should also have the form SET <name> optmap <value> */
87 statement : SET LOGFILE optmap STRING {run.logfile = xstrdup($4);}
88 | SET IDFILE optmap STRING {run.idfile = xstrdup($4);}
89 | SET DAEMON optmap NUMBER {run.poll_interval = $4;}
90 | SET POSTMASTER optmap STRING {run.postmaster = xstrdup($4);}
91 | SET BOUNCEMAIL {run.bouncemail = TRUE;}
92 | SET NO BOUNCEMAIL {run.bouncemail = FALSE;}
93 | SET PROPERTIES optmap STRING {run.properties =xstrdup($4);}
94 | SET SYSLOG {run.use_syslog = TRUE;}
95 | SET INVISIBLE {run.invisible = TRUE;}
98 * The way the next two productions are written depends on the fact that
99 * userspecs cannot be empty. It's a kluge to deal with files that set
100 * up a load of defaults and then have poll statements following with no
101 * user options at all.
103 | define_server serverspecs {record_current();}
104 | define_server serverspecs userspecs
106 /* detect and complain about the most common user error */
107 | define_server serverspecs userspecs serv_option
108 {yyerror("server option after user options");}
111 define_server : POLL STRING {reset_server($2, FALSE);}
112 | SKIP STRING {reset_server($2, TRUE);}
113 | DEFAULTS {reset_server("defaults", FALSE);}
116 serverspecs : /* EMPTY */
117 | serverspecs serv_option
120 alias_list : STRING {save_str(¤t.server.akalist,$1,0);}
121 | alias_list STRING {save_str(¤t.server.akalist,$2,0);}
124 domain_list : STRING {save_str(¤t.server.localdomains,$1,0);}
125 | domain_list STRING {save_str(¤t.server.localdomains,$2,0);}
128 serv_option : AKA alias_list
129 | VIA STRING {current.server.via = xstrdup($2);}
130 | LOCALDOMAINS domain_list
131 | PROTOCOL PROTO {current.server.protocol = $2;}
133 current.server.protocol = P_POP3;
135 if (current.server.preauthenticate == A_PASSWORD)
137 current.server.preauthenticate = A_KERBEROS_V5;
139 current.server.preauthenticate = A_KERBEROS_V4;
140 #endif /* KERBEROS_V5 */
142 current.server.service = KPOP_PORT;
143 #else /* INET6_ENABLE */
144 current.server.port = KPOP_PORT;
145 #endif /* INET6_ENABLE */
149 current.server.protocol = P_POP3;
150 current.server.sdps = TRUE;
152 yyerror("SDPS not enabled.");
153 #endif /* SDPS_ENABLE */
155 | UIDL {current.server.uidl = FLAG_TRUE;}
156 | NO UIDL {current.server.uidl = FLAG_FALSE;}
157 | CHECKALIAS {current.server.checkalias = FLAG_TRUE;}
158 | NO CHECKALIAS {current.server.checkalias = FLAG_FALSE;}
161 current.server.service = $2;
162 #endif /* INET6_ENABLE */
168 sprintf(buf, "%d", port);
169 current.server.service = xstrdup(buf);
171 current.server.port = $2;
172 #endif /* INET6_ENABLE */
174 | INTERVAL NUMBER {current.server.interval = $2;}
175 | PREAUTHENTICATE PASSWORD {current.server.preauthenticate = A_PASSWORD;}
176 | PREAUTHENTICATE KERBEROS4 {current.server.preauthenticate = A_KERBEROS_V4;}
177 | PREAUTHENTICATE KERBEROS5 {current.server.preauthenticate = A_KERBEROS_V5;}
178 | PREAUTHENTICATE KERBEROS {
180 current.server.preauthenticate = A_KERBEROS_V5;
182 current.server.preauthenticate = A_KERBEROS_V4;
183 #endif /* KERBEROS_V5 */
185 | PREAUTHENTICATE SSH {current.server.preauthenticate = A_SSH;}
186 | TIMEOUT NUMBER {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);}
207 if (net_security_strtorequest($2, &request, &requestlen))
208 yyerror("invalid security request");
210 current.server.netsec = xstrdup($2);
214 yyerror("network-security support disabled");
215 #endif /* NET_SECURITY */
218 #if (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__)
219 interface_parse($2, ¤t.server);
220 #else /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
221 fprintf(stderr, "fetchmail: interface option is only supported under Linux and FreeBSD\n");
222 #endif /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
225 #if (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__)
226 current.server.monitor = xstrdup($2);
227 #else /* (defined(linux) && !defined(INET6_ENABLE)) || defined(__FreeBSD__) */
228 fprintf(stderr, "fetchmail: monitor option is only supported under Linux\n");
229 #endif /* (defined(linux) && !defined(INET6_ENABLE) || defined(__FreeBSD__)) */
231 | PLUGIN STRING { current.server.plugin = xstrdup($2); }
232 | PLUGOUT STRING { current.server.plugout = xstrdup($2); }
233 | DNS {current.server.dns = FLAG_TRUE;}
234 | NO DNS {current.server.dns = FLAG_FALSE;}
235 | NO ENVELOPE {current.server.envelope = STRING_DISABLED;}
238 userspecs : user1opts {record_current(); user_reset();}
242 explicits : explicitdef {record_current(); user_reset();}
243 | explicits explicitdef {record_current(); user_reset();}
246 explicitdef : userdef user0opts
249 userdef : USERNAME STRING {current.remotename = xstrdup($2);}
250 | USERNAME mapping_list HERE
251 | USERNAME STRING THERE {current.remotename = xstrdup($2);}
254 user0opts : /* EMPTY */
255 | user0opts user_option
258 user1opts : user_option
259 | user1opts user_option
262 localnames : WILDCARD {current.wildcard = TRUE;}
263 | mapping_list {current.wildcard = FALSE;}
264 | mapping_list WILDCARD {current.wildcard = TRUE;}
267 mapping_list : mapping
268 | mapping_list mapping
272 {save_str_pair(¤t.localnames, $1, NULL);}
274 {save_str_pair(¤t.localnames, $1, $3);}
277 folder_list : STRING {save_str(¤t.mailboxes,$1,0);}
278 | folder_list STRING {save_str(¤t.mailboxes,$2,0);}
281 smtp_list : STRING {save_str(¤t.smtphunt, $1,TRUE);}
282 | smtp_list STRING {save_str(¤t.smtphunt, $2,TRUE);}
288 id=save_str(¤t.antispam,STRING_DUMMY,0);
289 id->val.status.num = $1;
294 id=save_str(¤t.antispam,STRING_DUMMY,0);
295 id->val.status.num = $2;
299 user_option : TO localnames HERE
304 | IS STRING THERE {current.remotename = xstrdup($2);}
305 | PASSWORD STRING {current.password = xstrdup($2);}
308 | SMTPADDRESS STRING {current.smtpaddress = xstrdup($2);}
309 | SPAMRESPONSE num_list
310 | MDA STRING {current.mda = xstrdup($2);}
311 | BSMTP STRING {current.bsmtp = xstrdup($2);}
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 | FETCHALL {current.fetchall = FLAG_TRUE;}
319 | REWRITE {current.rewrite = FLAG_TRUE;}
320 | FORCECR {current.forcecr = FLAG_TRUE;}
321 | STRIPCR {current.stripcr = FLAG_TRUE;}
322 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
323 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
324 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
326 | SSL {current.use_ssl = FLAG_TRUE;}
327 | SSLKEY STRING {current.sslkey = xstrdup($2);}
328 | SSLCERT STRING {current.sslcert = xstrdup($2);}
330 | NO KEEP {current.keep = FLAG_FALSE;}
331 | NO FLUSH {current.flush = FLAG_FALSE;}
332 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
333 | NO REWRITE {current.rewrite = FLAG_FALSE;}
334 | NO FORCECR {current.forcecr = FLAG_FALSE;}
335 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
336 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
337 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
338 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
340 | NO SSL {current.use_ssl = FLAG_FALSE;}
342 | LIMIT NUMBER {current.limit = NUM_VALUE_IN($2);}
343 | WARNINGS NUMBER {current.warnings = NUM_VALUE_IN($2);}
344 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE_IN($2);}
345 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
346 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
348 | PROPERTIES STRING {current.properties = xstrdup($2);}
352 /* lexer interface */
354 extern int prc_lineno;
358 static struct query *hosttail; /* where to add new elements */
360 void yyerror (const char *s)
361 /* report a syntax error */
363 report_at_line(stderr, 0, rcfile, prc_lineno, "%s at %s", s,
364 (yytext && yytext[0]) ? yytext : "end of input");
368 int prc_filecheck(const char *pathname, const flag securecheck)
369 /* check that a configuration file is secure */
376 /* special case useful for debugging purposes */
377 if (strcmp("/dev/null", pathname) == 0)
380 /* pass through the special name for stdin */
381 if (strcmp("-", pathname) == 0)
384 /* the run control file must have the same uid as the REAL uid of this
385 process, it must have permissions no greater than 600, and it must not
386 be a symbolic link. We check these conditions here. */
388 if (lstat(pathname, &statbuf) < 0) {
392 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
397 if (!securecheck) return PS_SUCCESS;
399 if ((statbuf.st_mode & S_IFLNK) == S_IFLNK)
401 fprintf(stderr, "File %s must not be a symbolic link.\n", pathname);
405 if (statbuf.st_mode & ~(S_IFREG | S_IREAD | S_IWRITE | S_IEXEC | S_IXGRP))
407 fprintf(stderr, "File %s must have no more than -rwx--x--- (0710) permissions.\n",
413 if (statbuf.st_uid != geteuid())
415 if (statbuf.st_uid != getuid())
416 #endif /* HAVE_GETEUID */
418 fprintf(stderr, "File %s must be owned by you.\n", pathname);
425 int prc_parse_file (const char *pathname, const flag securecheck)
426 /* digest the configuration into a linked list of host records */
429 querylist = hosttail = (struct query *)NULL;
433 /* Check that the file is secure */
434 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
438 * Croak if the configuration directory does not exist.
439 * This probably means an NFS mount failed and we can't
440 * see a configuration file that ought to be there.
441 * Question: is this a portable check? It's not clear
442 * that all implementations of lstat() will return ENOTDIR
443 * rather than plain ENOENT in this case...
445 if (errno == ENOTDIR)
447 else if (errno == ENOENT)
450 /* Open the configuration file and feed it to the lexer. */
451 if (strcmp(pathname, "-") == 0)
453 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
454 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
458 yyparse(); /* parse entire file */
460 fclose(yyin); /* not checking this should be safe, file mode was r */
468 static void reset_server(const char *name, int skip)
469 /* clear the entire global record and initialize it with a new name */
472 memset(¤t,'\0',sizeof(current));
473 current.smtp_socket = -1;
474 current.server.pollname = xstrdup(name);
475 current.server.skip = skip;
479 static void user_reset(void)
480 /* clear the global current record (user parameters) used by the parser */
482 struct hostdata save;
485 * Purpose of this code is to initialize the new server block, but
486 * preserve whatever server name was previously set. Also
487 * preserve server options unless the command-line explicitly
490 save = current.server;
492 memset(¤t, '\0', sizeof(current));
493 current.smtp_socket = -1;
495 current.server = save;
498 struct query *hostalloc(init)
499 /* append a host record to the host list */
500 struct query *init; /* pointer to block containing initial values */
504 /* allocate new node */
505 node = (struct query *) xmalloc(sizeof(struct query));
509 memcpy(node, init, sizeof(struct query));
512 memset(node, '\0', sizeof(struct query));
513 node->smtp_socket = -1;
516 /* append to end of list */
517 if (hosttail != (struct query *) 0)
518 hosttail->next = node; /* list contains at least one element */
520 querylist = node; /* list is empty */
524 node->server.lead_server = leadentry;
527 node->server.lead_server = NULL;
528 leadentry = &node->server;
534 static void record_current(void)
535 /* register current parameters and append to the host list */
537 (void) hostalloc(¤t);
541 /* easier to do this than cope with variations in where the library lives */
542 int yywrap(void) {return 1;}
544 /* rcfile_y.y ends here */