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 LIMITFLUSH 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 | LIMITFLUSH {current.limitflush = FLAG_TRUE;}
312 | FETCHALL {current.fetchall = FLAG_TRUE;}
313 | REWRITE {current.rewrite = FLAG_TRUE;}
314 | FORCECR {current.forcecr = FLAG_TRUE;}
315 | STRIPCR {current.stripcr = FLAG_TRUE;}
316 | PASS8BITS {current.pass8bits = FLAG_TRUE;}
317 | DROPSTATUS {current.dropstatus = FLAG_TRUE;}
318 | DROPDELIVERED {current.dropdelivered = FLAG_TRUE;}
319 | MIMEDECODE {current.mimedecode = FLAG_TRUE;}
320 | IDLE {current.idle = FLAG_TRUE;}
324 current.use_ssl = FLAG_TRUE;
326 yyerror(GT_("SSL is not enabled"));
329 | SSLKEY STRING {current.sslkey = prependdir ($2, rcfiledir);}
330 | SSLCERT STRING {current.sslcert = prependdir ($2, rcfiledir);}
331 | SSLPROTO STRING {current.sslproto = xstrdup($2);}
332 | SSLCERTCK {current.sslcertck = FLAG_TRUE;}
333 | SSLCERTPATH STRING {current.sslcertpath = prependdir($2, rcfiledir);}
334 | SSLFINGERPRINT STRING {current.sslfingerprint = xstrdup($2);}
336 | NO KEEP {current.keep = FLAG_FALSE;}
337 | NO FLUSH {current.flush = FLAG_FALSE;}
338 | NO LIMITFLUSH {current.limitflush = FLAG_FALSE;}
339 | NO FETCHALL {current.fetchall = FLAG_FALSE;}
340 | NO REWRITE {current.rewrite = FLAG_FALSE;}
341 | NO FORCECR {current.forcecr = FLAG_FALSE;}
342 | NO STRIPCR {current.stripcr = FLAG_FALSE;}
343 | NO PASS8BITS {current.pass8bits = FLAG_FALSE;}
344 | NO DROPSTATUS {current.dropstatus = FLAG_FALSE;}
345 | NO DROPDELIVERED {current.dropdelivered = FLAG_FALSE;}
346 | NO MIMEDECODE {current.mimedecode = FLAG_FALSE;}
347 | NO IDLE {current.idle = FLAG_FALSE;}
349 | NO SSL {current.use_ssl = FLAG_FALSE;}
351 | LIMIT NUMBER {current.limit = NUM_VALUE_IN($2);}
352 | WARNINGS NUMBER {current.warnings = NUM_VALUE_IN($2);}
353 | FETCHLIMIT NUMBER {current.fetchlimit = NUM_VALUE_IN($2);}
354 | FETCHSIZELIMIT NUMBER {current.fetchsizelimit = NUM_VALUE_IN($2);}
355 | FASTUIDL NUMBER {current.fastuidl = NUM_VALUE_IN($2);}
356 | BATCHLIMIT NUMBER {current.batchlimit = NUM_VALUE_IN($2);}
357 | EXPUNGE NUMBER {current.expunge = NUM_VALUE_IN($2);}
359 | PROPERTIES STRING {current.properties = xstrdup($2);}
363 /* lexer interface */
365 extern int prc_lineno;
369 static struct query *hosttail; /* where to add new elements */
371 void yyerror (const char *s)
372 /* report a syntax error */
374 report_at_line(stderr, 0, rcfile, prc_lineno, GT_("%s at %s"), s,
375 (yytext && yytext[0]) ? yytext : GT_("end of input"));
379 int prc_filecheck(const char *pathname, const flag securecheck)
380 /* check that a configuration file is secure */
387 /* special case useful for debugging purposes */
388 if (strcmp("/dev/null", pathname) == 0)
391 /* pass through the special name for stdin */
392 if (strcmp("-", pathname) == 0)
395 /* the run control file must have the same uid as the REAL uid of this
396 process, it must have permissions no greater than 600, and it must not
397 be a symbolic link. We check these conditions here. */
399 if (lstat(pathname, &statbuf) < 0) {
403 report(stderr, "lstat: %s: %s\n", pathname, strerror(errno));
408 if (!securecheck) return PS_SUCCESS;
410 if (!S_ISREG(statbuf.st_mode))
412 fprintf(stderr, GT_("File %s must be a regular file.\n"), pathname);
418 if (cygwin_internal(CW_CHECK_NTSEC, pathname))
419 #endif /* __CYGWIN__ */
420 if (statbuf.st_mode & (S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH | S_IXOTH))
422 fprintf(stderr, GT_("File %s must have no more than -rwx--x--- (0710) permissions.\n"),
426 #endif /* __BEOS__ */
429 if (statbuf.st_uid != geteuid())
431 if (statbuf.st_uid != getuid())
432 #endif /* HAVE_GETEUID */
434 fprintf(stderr, GT_("File %s must be owned by you.\n"), pathname);
441 int prc_parse_file (const char *pathname, const flag securecheck)
442 /* digest the configuration into a linked list of host records */
445 querylist = hosttail = (struct query *)NULL;
449 /* Check that the file is secure */
450 if ( (prc_errflag = prc_filecheck(pathname, securecheck)) != 0 )
454 * Croak if the configuration directory does not exist.
455 * This probably means an NFS mount failed and we can't
456 * see a configuration file that ought to be there.
457 * Question: is this a portable check? It's not clear
458 * that all implementations of lstat() will return ENOTDIR
459 * rather than plain ENOENT in this case...
461 if (errno == ENOTDIR)
463 else if (errno == ENOENT)
466 /* Open the configuration file and feed it to the lexer. */
467 if (strcmp(pathname, "-") == 0)
469 else if ((yyin = fopen(pathname,"r")) == (FILE *)NULL) {
470 report(stderr, "open: %s: %s\n", pathname, strerror(errno));
474 yyparse(); /* parse entire file */
476 fclose(yyin); /* not checking this should be safe, file mode was r */
484 static void reset_server(const char *name, int skip)
485 /* clear the entire global record and initialize it with a new name */
488 memset(¤t,'\0',sizeof(current));
489 current.smtp_socket = -1;
490 current.server.pollname = xstrdup(name);
491 current.server.skip = skip;
492 current.server.principal = (char *)NULL;
496 static void user_reset(void)
497 /* clear the global current record (user parameters) used by the parser */
499 struct hostdata save;
502 * Purpose of this code is to initialize the new server block, but
503 * preserve whatever server name was previously set. Also
504 * preserve server options unless the command-line explicitly
507 save = current.server;
509 memset(¤t, '\0', sizeof(current));
510 current.smtp_socket = -1;
512 current.server = save;
515 struct query *hostalloc(init)
516 /* append a host record to the host list */
517 struct query *init; /* pointer to block containing initial values */
521 /* allocate new node */
522 node = (struct query *) xmalloc(sizeof(struct query));
526 memcpy(node, init, sizeof(struct query));
529 memset(node, '\0', sizeof(struct query));
530 node->smtp_socket = -1;
533 /* append to end of list */
534 if (hosttail != (struct query *) 0)
535 hosttail->next = node; /* list contains at least one element */
537 querylist = node; /* list is empty */
541 node->server.lead_server = leadentry;
544 node->server.lead_server = NULL;
545 leadentry = &node->server;
551 static void record_current(void)
552 /* register current parameters and append to the host list */
554 (void) hostalloc(¤t);
558 char *prependdir (const char *file, const char *dir)
559 /* if a filename is relative to dir, convert it to an absolute path */
562 if (!file[0] || /* null path */
563 file[0] == '/' || /* absolute path */
564 strcmp(file, "-") == 0 || /* stdin/stdout */
565 !dir[0]) /* we don't HAVE_GETCWD */
566 return xstrdup (file);
567 newfile = xmalloc (strlen (dir) + 1 + strlen (file) + 1);
568 if (dir[strlen(dir) - 1] != '/')
569 sprintf (newfile, "%s/%s", dir, file);
571 sprintf (newfile, "%s%s", dir, file);
575 /* easier to do this than cope with variations in where the library lives */
576 int yywrap(void) {return 1;}
578 /* rcfile_y.y ends here */