loadparm.c

   1 /*
   2  * This program is free software; you can redistribute it and/or modify
   3  * it under the terms of the GNU General Public License as published by
   4  * the Free Software Foundation; either version 3 of the License, or
   5  * (at your option) any later version.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License along
  13  * with this program; if not, visit the http://fsf.org website.
  14  *
  15  * This is based on loadparm.c from Samba, written by Andrew Tridgell
  16  * and Karl Auer.  Some of the changes are:
  17  *
  18  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
  19  * Copyright (C) 2003-2020 Wayne Davison
  20  */
  21
  22 /* Load parameters.
  23  *
  24  *  This module provides suitable callback functions for the params
  25  *  module. It builds the internal table of section details which is
  26  *  then used by the rest of the server.
  27  *
  28  * To add a parameter:
  29  *
  30  * 1) add it to the global_vars or local_vars structure definition
  31  * 2) add it to the parm_table
  32  * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
  33  * 4) initialise it in the Defaults static structure
  34  *
  35  * Notes:
  36  *   The configuration file is processed sequentially for speed. For this
  37  *   reason, there is a fair bit of sequence-dependent code here - ie., code
  38  *   which assumes that certain things happen before others. In particular, the
  39  *   code which happens at the boundary between sections is delicately poised,
  40  *   so be careful!
  41  */
  42
  43 #include "rsync.h"
  44 #include "itypes.h"
  45 #include "ifuncs.h"
  46 #include "default-dont-compress.h"
  47
  48 extern item_list dparam_list;
  49
  50 #define strequal(a, b) (strcasecmp(a, b)==0)
  51 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  52
  53 #ifndef LOG_DAEMON
  54 #define LOG_DAEMON 0
  55 #endif
  56
  57 /* the following are used by loadparm for option lists */
  58 typedef enum {
  59         P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER,
  60         P_OCTAL, P_PATH, P_STRING, P_ENUM
  61 } parm_type;
  62
  63 typedef enum {
  64         P_LOCAL, P_GLOBAL, P_NONE
  65 } parm_class;
  66
  67 struct enum_list {
  68         int value;
  69         char *name;
  70 };
  71
  72 struct parm_struct {
  73         char *label;
  74         parm_type type;
  75         parm_class class;
  76         void *ptr;
  77         struct enum_list *enum_list;
  78         unsigned flags;
  79 };
  80
  81 #ifndef GLOBAL_NAME
  82 #define GLOBAL_NAME "global"
  83 #endif
  84
  85 /* some helpful bits */
  86 #define iSECTION(i) ((local_vars*)section_list.items)[i]
  87 #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
  88 #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Vars.l))
  89
  90 /* This structure describes global (ie., server-wide) parameters. */
  91 typedef struct {
  92         char *bind_address;
  93         char *daemon_chroot;
  94         char *daemon_gid;
  95         char *daemon_uid;
  96         char *motd_file;
  97         char *pid_file;
  98         char *socket_options;
  99
 100         /* Each _EXP var tracks if the associated char* var has been expanded yet or not. */
 101         BOOL bind_address_EXP;
 102         BOOL daemon_chroot_EXP;
 103         BOOL daemon_gid_EXP;
 104         BOOL daemon_uid_EXP;
 105         BOOL motd_file_EXP;
 106         BOOL pid_file_EXP;
 107         BOOL socket_options_EXP;
 108
 109         int listen_backlog;
 110         int rsync_port;
 111
 112         BOOL proxy_protocol;
 113 } global_vars;
 114
 115 /* This structure describes a single section.  Their order must match the
 116  * initializers below, which you can accomplish by keeping each sub-section
 117  * sorted.  (e.g. in vim, just visually select each subsection and use !sort.)
 118  * NOTE: the char* variables MUST all remain at the start of the struct! */
 119 typedef struct {
 120         char *auth_users;
 121         char *charset;
 122         char *comment;
 123         char *dont_compress;
 124         char *early_exec;
 125         char *exclude;
 126         char *exclude_from;
 127         char *filter;
 128         char *gid;
 129         char *hosts_allow;
 130         char *hosts_deny;
 131         char *include;
 132         char *include_from;
 133         char *incoming_chmod;
 134         char *lock_file;
 135         char *log_file;
 136         char *log_format;
 137         char *name;
 138         char *outgoing_chmod;
 139         char *path;
 140         char *postxfer_exec;
 141         char *prexfer_exec;
 142         char *refuse_options;
 143         char *secrets_file;
 144         char *syslog_tag;
 145         char *temp_dir;
 146         char *uid;
 147
 148         /* Each _EXP var tracks if the associated char* var has been expanded yet or not. */
 149         BOOL auth_users_EXP;
 150         BOOL charset_EXP;
 151         BOOL comment_EXP;
 152         BOOL dont_compress_EXP;
 153         BOOL early_exec_EXP;
 154         BOOL exclude_EXP;
 155         BOOL exclude_from_EXP;
 156         BOOL filter_EXP;
 157         BOOL gid_EXP;
 158         BOOL hosts_allow_EXP;
 159         BOOL hosts_deny_EXP;
 160         BOOL include_EXP;
 161         BOOL include_from_EXP;
 162         BOOL incoming_chmod_EXP;
 163         BOOL lock_file_EXP;
 164         BOOL log_file_EXP;
 165         BOOL log_format_EXP;
 166         BOOL name_EXP;
 167         BOOL outgoing_chmod_EXP;
 168         BOOL path_EXP;
 169         BOOL postxfer_exec_EXP;
 170         BOOL prexfer_exec_EXP;
 171         BOOL refuse_options_EXP;
 172         BOOL secrets_file_EXP;
 173         BOOL syslog_tag_EXP;
 174         BOOL temp_dir_EXP;
 175         BOOL uid_EXP;
 176
 177         int max_connections;
 178         int max_verbosity;
 179         int syslog_facility;
 180         int timeout;
 181
 182         BOOL fake_super;
 183         BOOL forward_lookup;
 184         BOOL ignore_errors;
 185         BOOL ignore_nonreadable;
 186         BOOL list;
 187         BOOL munge_symlinks;
 188         BOOL numeric_ids;
 189         BOOL read_only;
 190         BOOL reverse_lookup;
 191         BOOL strict_modes;
 192         BOOL transfer_logging;
 193         BOOL use_chroot;
 194         BOOL write_only;
 195 } local_vars;
 196
 197 /* This structure describes the global variables (g) as well as the globally
 198  * specified values of the local variables (l), which are used when modules
 199  * don't specify their own values. */
 200 typedef struct {
 201         global_vars g;
 202         local_vars l;
 203 } all_vars;
 204
 205 /* The application defaults for all the variables.  "Defaults" is
 206  * used to re-initialize "Vars" before each config-file read.
 207  *
 208  * In order to keep these sorted in the same way as the structure
 209  * above, use the variable name in the leading comment, including a
 210  * trailing ';' (to avoid a sorting problem with trailing digits). */
 211 static const all_vars Defaults = {
 212  /* ==== global_vars ==== */
 213  {
 214  /* bind_address; */            NULL,
 215  /* daemon_chroot; */           NULL,
 216  /* daemon_gid; */              NULL,
 217  /* daemon_uid; */              NULL,
 218  /* motd_file; */               NULL,
 219  /* pid_file; */                NULL,
 220  /* socket_options; */          NULL,
 221
 222  /* bind_address_EXP; */        False,
 223  /* daemon_chroot_EXP; */       False,
 224  /* daemon_gid_EXP; */          False,
 225  /* daemon_uid_EXP; */          False,
 226  /* motd_file_EXP; */           False,
 227  /* pid_file_EXP; */            False,
 228  /* socket_options_EXP; */      False,
 229
 230  /* listen_backlog; */          5,
 231  /* rsync_port; */              0,
 232
 233  /* proxy_protocol; */          False,
 234  },
 235
 236  /* ==== local_vars ==== */
 237  {
 238  /* auth_users; */              NULL,
 239  /* charset; */                 NULL,
 240  /* comment; */                 NULL,
 241  /* dont_compress; */           DEFAULT_DONT_COMPRESS,
 242  /* early_exec; */              NULL,
 243  /* exclude; */                 NULL,
 244  /* exclude_from; */            NULL,
 245  /* filter; */                  NULL,
 246  /* gid; */                     NULL,
 247  /* hosts_allow; */             NULL,
 248  /* hosts_deny; */              NULL,
 249  /* include; */                 NULL,
 250  /* include_from; */            NULL,
 251  /* incoming_chmod; */          NULL,
 252  /* lock_file; */               DEFAULT_LOCK_FILE,
 253  /* log_file; */                NULL,
 254  /* log_format; */              "%o %h [%a] %m (%u) %f %l",
 255  /* name; */                    NULL,
 256  /* outgoing_chmod; */          NULL,
 257  /* path; */                    NULL,
 258  /* postxfer_exec; */           NULL,
 259  /* prexfer_exec; */            NULL,
 260  /* refuse_options; */          NULL,
 261  /* secrets_file; */            NULL,
 262  /* syslog_tag; */              "rsyncd",
 263  /* temp_dir; */                NULL,
 264  /* uid; */                     NULL,
 265
 266  /* auth_users_EXP; */          False,
 267  /* charset_EXP; */             False,
 268  /* comment_EXP; */             False,
 269  /* dont_compress_EXP; */       False,
 270  /* early_exec_EXP; */          False,
 271  /* exclude_EXP; */             False,
 272  /* exclude_from_EXP; */        False,
 273  /* filter_EXP; */              False,
 274  /* gid_EXP; */                 False,
 275  /* hosts_allow_EXP; */         False,
 276  /* hosts_deny_EXP; */          False,
 277  /* include_EXP; */             False,
 278  /* include_from_EXP; */        False,
 279  /* incoming_chmod_EXP; */      False,
 280  /* lock_file_EXP; */           False,
 281  /* log_file_EXP; */            False,
 282  /* log_format_EXP; */          False,
 283  /* name_EXP; */                False,
 284  /* outgoing_chmod_EXP; */      False,
 285  /* path_EXP; */                False,
 286  /* postxfer_exec_EXP; */       False,
 287  /* prexfer_exec_EXP; */        False,
 288  /* refuse_options_EXP; */      False,
 289  /* secrets_file_EXP; */        False,
 290  /* syslog_tag_EXP; */          False,
 291  /* temp_dir_EXP; */            False,
 292  /* uid_EXP; */                 False,
 293
 294  /* max_connections; */         0,
 295  /* max_verbosity; */           1,
 296  /* syslog_facility; */         LOG_DAEMON,
 297  /* timeout; */                 0,
 298
 299  /* fake_super; */              False,
 300  /* forward_lookup; */          True,
 301  /* ignore_errors; */           False,
 302  /* ignore_nonreadable; */      False,
 303  /* list; */                    True,
 304  /* munge_symlinks; */          (BOOL)-1,
 305  /* numeric_ids; */             (BOOL)-1,
 306  /* read_only; */               True,
 307  /* reverse_lookup; */          True,
 308  /* strict_modes; */            True,
 309  /* transfer_logging; */        False,
 310  /* use_chroot; */              True,
 311  /* write_only; */              False,
 312  }
 313 };
 314
 315 /* The currently configured values for all the variables. */
 316 static all_vars Vars;
 317
 318 /* Stack of "Vars" values used by the &include directive. */
 319 static item_list Vars_stack = EMPTY_ITEM_LIST;
 320
 321 /* The array of section values that holds all the defined modules. */
 322 static item_list section_list = EMPTY_ITEM_LIST;
 323
 324 static int iSectionIndex = -1;
 325 static BOOL bInGlobalSection = True;
 326
 327 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
 328
 329 static struct enum_list enum_facilities[] = {
 330 #ifdef LOG_AUTH
 331         { LOG_AUTH, "auth" },
 332 #endif
 333 #ifdef LOG_AUTHPRIV
 334         { LOG_AUTHPRIV, "authpriv" },
 335 #endif
 336 #ifdef LOG_CRON
 337         { LOG_CRON, "cron" },
 338 #endif
 339 #ifdef LOG_DAEMON
 340         { LOG_DAEMON, "daemon" },
 341 #endif
 342 #ifdef LOG_FTP
 343         { LOG_FTP, "ftp" },
 344 #endif
 345 #ifdef LOG_KERN
 346         { LOG_KERN, "kern" },
 347 #endif
 348 #ifdef LOG_LPR
 349         { LOG_LPR, "lpr" },
 350 #endif
 351 #ifdef LOG_MAIL
 352         { LOG_MAIL, "mail" },
 353 #endif
 354 #ifdef LOG_NEWS
 355         { LOG_NEWS, "news" },
 356 #endif
 357 #ifdef LOG_AUTH
 358         { LOG_AUTH, "security" },
 359 #endif
 360 #ifdef LOG_SYSLOG
 361         { LOG_SYSLOG, "syslog" },
 362 #endif
 363 #ifdef LOG_USER
 364         { LOG_USER, "user" },
 365 #endif
 366 #ifdef LOG_UUCP
 367         { LOG_UUCP, "uucp" },
 368 #endif
 369 #ifdef LOG_LOCAL0
 370         { LOG_LOCAL0, "local0" },
 371 #endif
 372 #ifdef LOG_LOCAL1
 373         { LOG_LOCAL1, "local1" },
 374 #endif
 375 #ifdef LOG_LOCAL2
 376         { LOG_LOCAL2, "local2" },
 377 #endif
 378 #ifdef LOG_LOCAL3
 379         { LOG_LOCAL3, "local3" },
 380 #endif
 381 #ifdef LOG_LOCAL4
 382         { LOG_LOCAL4, "local4" },
 383 #endif
 384 #ifdef LOG_LOCAL5
 385         { LOG_LOCAL5, "local5" },
 386 #endif
 387 #ifdef LOG_LOCAL6
 388         { LOG_LOCAL6, "local6" },
 389 #endif
 390 #ifdef LOG_LOCAL7
 391         { LOG_LOCAL7, "local7" },
 392 #endif
 393         { -1, NULL }
 394 };
 395
 396 static struct parm_struct parm_table[] =
 397 {
 398  {"address",           P_STRING, P_GLOBAL,&Vars.g.bind_address,        NULL,0},
 399  {"daemon chroot",     P_STRING, P_GLOBAL,&Vars.g.daemon_chroot,       NULL,0},
 400  {"daemon gid",        P_STRING, P_GLOBAL,&Vars.g.daemon_gid,          NULL,0},
 401  {"daemon uid",        P_STRING, P_GLOBAL,&Vars.g.daemon_uid,          NULL,0},
 402  {"listen backlog",    P_INTEGER,P_GLOBAL,&Vars.g.listen_backlog,      NULL,0},
 403  {"motd file",         P_STRING, P_GLOBAL,&Vars.g.motd_file,           NULL,0},
 404  {"pid file",          P_STRING, P_GLOBAL,&Vars.g.pid_file,            NULL,0},
 405  {"port",              P_INTEGER,P_GLOBAL,&Vars.g.rsync_port,          NULL,0},
 406  {"proxy protocol",    P_BOOL,   P_LOCAL, &Vars.g.proxy_protocol,      NULL,0},
 407  {"socket options",    P_STRING, P_GLOBAL,&Vars.g.socket_options,      NULL,0},
 408
 409  {"auth users",        P_STRING, P_LOCAL, &Vars.l.auth_users,          NULL,0},
 410  {"charset",           P_STRING, P_LOCAL, &Vars.l.charset,             NULL,0},
 411  {"comment",           P_STRING, P_LOCAL, &Vars.l.comment,             NULL,0},
 412  {"dont compress",     P_STRING, P_LOCAL, &Vars.l.dont_compress,       NULL,0},
 413  {"early exec",        P_STRING, P_LOCAL, &Vars.l.early_exec,          NULL,0},
 414  {"exclude from",      P_STRING, P_LOCAL, &Vars.l.exclude_from,        NULL,0},
 415  {"exclude",           P_STRING, P_LOCAL, &Vars.l.exclude,             NULL,0},
 416  {"fake super",        P_BOOL,   P_LOCAL, &Vars.l.fake_super,          NULL,0},
 417  {"filter",            P_STRING, P_LOCAL, &Vars.l.filter,              NULL,0},
 418  {"forward lookup",    P_BOOL,   P_LOCAL, &Vars.l.forward_lookup,      NULL,0},
 419  {"gid",               P_STRING, P_LOCAL, &Vars.l.gid,                 NULL,0},
 420  {"hosts allow",       P_STRING, P_LOCAL, &Vars.l.hosts_allow,         NULL,0},
 421  {"hosts deny",        P_STRING, P_LOCAL, &Vars.l.hosts_deny,          NULL,0},
 422  {"ignore errors",     P_BOOL,   P_LOCAL, &Vars.l.ignore_errors,       NULL,0},
 423  {"ignore nonreadable",P_BOOL,   P_LOCAL, &Vars.l.ignore_nonreadable,  NULL,0},
 424  {"include from",      P_STRING, P_LOCAL, &Vars.l.include_from,        NULL,0},
 425  {"include",           P_STRING, P_LOCAL, &Vars.l.include,             NULL,0},
 426  {"incoming chmod",    P_STRING, P_LOCAL, &Vars.l.incoming_chmod,      NULL,0},
 427  {"list",              P_BOOL,   P_LOCAL, &Vars.l.list,                NULL,0},
 428  {"lock file",         P_STRING, P_LOCAL, &Vars.l.lock_file,           NULL,0},
 429  {"log file",          P_STRING, P_LOCAL, &Vars.l.log_file,            NULL,0},
 430  {"log format",        P_STRING, P_LOCAL, &Vars.l.log_format,          NULL,0},
 431  {"max connections",   P_INTEGER,P_LOCAL, &Vars.l.max_connections,     NULL,0},
 432  {"max verbosity",     P_INTEGER,P_LOCAL, &Vars.l.max_verbosity,       NULL,0},
 433  {"munge symlinks",    P_BOOL,   P_LOCAL, &Vars.l.munge_symlinks,      NULL,0},
 434  {"name",              P_STRING, P_LOCAL, &Vars.l.name,                NULL,0},
 435  {"numeric ids",       P_BOOL,   P_LOCAL, &Vars.l.numeric_ids,         NULL,0},
 436  {"outgoing chmod",    P_STRING, P_LOCAL, &Vars.l.outgoing_chmod,      NULL,0},
 437  {"path",              P_PATH,   P_LOCAL, &Vars.l.path,                NULL,0},
 438 #ifdef HAVE_PUTENV
 439  {"post-xfer exec",    P_STRING, P_LOCAL, &Vars.l.postxfer_exec,       NULL,0},
 440  {"pre-xfer exec",     P_STRING, P_LOCAL, &Vars.l.prexfer_exec,        NULL,0},
 441 #endif
 442  {"read only",         P_BOOL,   P_LOCAL, &Vars.l.read_only,           NULL,0},
 443  {"refuse options",    P_STRING, P_LOCAL, &Vars.l.refuse_options,      NULL,0},
 444  {"reverse lookup",    P_BOOL,   P_LOCAL, &Vars.l.reverse_lookup,      NULL,0},
 445  {"secrets file",      P_STRING, P_LOCAL, &Vars.l.secrets_file,        NULL,0},
 446  {"strict modes",      P_BOOL,   P_LOCAL, &Vars.l.strict_modes,        NULL,0},
 447  {"syslog facility",   P_ENUM,   P_LOCAL, &Vars.l.syslog_facility,     enum_facilities,0},
 448  {"syslog tag",        P_STRING, P_LOCAL, &Vars.l.syslog_tag,          NULL,0},
 449  {"temp dir",          P_PATH,   P_LOCAL, &Vars.l.temp_dir,            NULL,0},
 450  {"timeout",           P_INTEGER,P_LOCAL, &Vars.l.timeout,             NULL,0},
 451  {"transfer logging",  P_BOOL,   P_LOCAL, &Vars.l.transfer_logging,    NULL,0},
 452  {"uid",               P_STRING, P_LOCAL, &Vars.l.uid,                 NULL,0},
 453  {"use chroot",        P_BOOL,   P_LOCAL, &Vars.l.use_chroot,          NULL,0},
 454  {"write only",        P_BOOL,   P_LOCAL, &Vars.l.write_only,          NULL,0},
 455  {NULL,                P_BOOL,   P_NONE,  NULL,                        NULL,0}
 456 };
 457
 458 /* Initialise the Default all_vars structure. */
 459 void reset_daemon_vars(void)
 460 {
 461         memcpy(&Vars, &Defaults, sizeof Vars);
 462 }
 463
 464 /* Expand %VAR% references.  Any unknown vars or unrecognized
 465  * syntax leaves the raw chars unchanged. */
 466 static char *expand_vars(const char *str)
 467 {
 468         char *buf, *t;
 469         const char *f;
 470         int bufsize;
 471
 472         if (!str || !strchr(str, '%'))
 473                 return (char *)str; /* TODO change return value to const char* at some point. */
 474
 475         bufsize = strlen(str) + 2048;
 476         buf = new_array(char, bufsize+1); /* +1 for trailing '\0' */
 477
 478         for (t = buf, f = str; bufsize && *f; ) {
 479                 if (*f == '%' && isUpper(f+1)) {
 480                         char *percent = strchr(f+1, '%');
 481                         if (percent && percent - f < bufsize) {
 482                                 char *val;
 483                                 strlcpy(t, f+1, percent - f);
 484                                 val = getenv(t);
 485                                 if (val) {
 486                                         int len = strlcpy(t, val, bufsize+1);
 487                                         if (len > bufsize)
 488                                                 break;
 489                                         bufsize -= len;
 490                                         t += len;
 491                                         f = percent + 1;
 492                                         continue;
 493                                 }
 494                         }
 495                 }
 496                 *t++ = *f++;
 497                 bufsize--;
 498         }
 499         *t = '\0';
 500
 501         if (*f) {
 502                 rprintf(FLOG, "Overflowed buf in expand_vars() trying to expand: %s\n", str);
 503                 exit_cleanup(RERR_MALLOC);
 504         }
 505
 506         if (bufsize && (buf = realloc(buf, t - buf + 1)) == NULL)
 507                 out_of_memory("expand_vars");
 508
 509         return buf;
 510 }
 511
 512 /* NOTE: use this function and all the FN_{GLOBAL,LOCAL} ones WITHOUT a trailing semicolon! */
 513 #define RETURN_EXPANDED(val) {if (!val ## _EXP) {val = expand_vars(val); val ## _EXP = True;} return val ? val : "";}
 514
 515 /* In this section all the functions that are used to access the
 516  * parameters from the rest of the program are defined. */
 517
 518 #define FN_GLOBAL_STRING(fn_name, val) \
 519  char *fn_name(void) RETURN_EXPANDED(Vars.g.val)
 520 #define FN_GLOBAL_BOOL(fn_name, val) \
 521  BOOL fn_name(void) {return Vars.g.val;}
 522 #define FN_GLOBAL_CHAR(fn_name, val) \
 523  char fn_name(void) {return Vars.g.val;}
 524 #define FN_GLOBAL_INTEGER(fn_name, val) \
 525  int fn_name(void) {return Vars.g.val;}
 526
 527 #define FN_LOCAL_STRING(fn_name, val) \
 528  char *fn_name(int i) {if (LP_SNUM_OK(i) && iSECTION(i).val) RETURN_EXPANDED(iSECTION(i).val) else RETURN_EXPANDED(Vars.l.val)}
 529 #define FN_LOCAL_BOOL(fn_name, val) \
 530  BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 531 #define FN_LOCAL_CHAR(fn_name, val) \
 532  char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 533 #define FN_LOCAL_INTEGER(fn_name, val) \
 534  int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 535
 536 FN_GLOBAL_STRING(lp_bind_address, bind_address)
 537 FN_GLOBAL_STRING(lp_daemon_chroot, daemon_chroot)
 538 FN_GLOBAL_STRING(lp_daemon_gid, daemon_gid)
 539 FN_GLOBAL_STRING(lp_daemon_uid, daemon_uid)
 540 FN_GLOBAL_STRING(lp_motd_file, motd_file)
 541 FN_GLOBAL_STRING(lp_pid_file, pid_file)
 542 FN_GLOBAL_STRING(lp_socket_options, socket_options)
 543
 544 FN_GLOBAL_INTEGER(lp_listen_backlog, listen_backlog)
 545 FN_GLOBAL_INTEGER(lp_rsync_port, rsync_port)
 546
 547 FN_GLOBAL_BOOL(lp_proxy_protocol, proxy_protocol)
 548
 549 FN_LOCAL_STRING(lp_auth_users, auth_users)
 550 FN_LOCAL_STRING(lp_charset, charset)
 551 FN_LOCAL_STRING(lp_comment, comment)
 552 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
 553 FN_LOCAL_STRING(lp_early_exec, early_exec)
 554 FN_LOCAL_STRING(lp_exclude, exclude)
 555 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
 556 FN_LOCAL_STRING(lp_filter, filter)
 557 FN_LOCAL_STRING(lp_gid, gid)
 558 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
 559 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
 560 FN_LOCAL_STRING(lp_include, include)
 561 FN_LOCAL_STRING(lp_include_from, include_from)
 562 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
 563 FN_LOCAL_STRING(lp_lock_file, lock_file)
 564 FN_LOCAL_STRING(lp_log_file, log_file)
 565 FN_LOCAL_STRING(lp_log_format, log_format)
 566 FN_LOCAL_STRING(lp_name, name)
 567 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
 568 FN_LOCAL_STRING(lp_path, path)
 569 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
 570 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
 571 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
 572 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
 573 FN_LOCAL_STRING(lp_syslog_tag, syslog_tag)
 574 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
 575 FN_LOCAL_STRING(lp_uid, uid)
 576
 577 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
 578 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
 579 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
 580 FN_LOCAL_INTEGER(lp_timeout, timeout)
 581
 582 FN_LOCAL_BOOL(lp_fake_super, fake_super)
 583 FN_LOCAL_BOOL(lp_forward_lookup, forward_lookup)
 584 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
 585 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
 586 FN_LOCAL_BOOL(lp_list, list)
 587 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
 588 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
 589 FN_LOCAL_BOOL(lp_read_only, read_only)
 590 FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
 591 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
 592 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
 593 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
 594 FN_LOCAL_BOOL(lp_write_only, write_only)
 595
 596 /* Assign a copy of v to *s.  Handles NULL strings.  We don't worry
 597  * about overwriting a malloc'd string because the long-running
 598  * (port-listening) daemon only loads the config file once, and the
 599  * per-job (forked or xinitd-ran) daemon only re-reads the file at
 600  * the start, so any lost memory is inconsequential. */
 601 static inline void string_set(char **s, const char *v)
 602 {
 603         *s = v ? strdup(v) : NULL;
 604 }
 605
 606 /* Copy local_vars into a new section. No need to strdup since we don't free. */
 607 static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
 608 {
 609         memcpy(psectionDest, psectionSource, sizeof psectionDest[0]);
 610 }
 611
 612 /* Initialise a section to the defaults. */
 613 static void init_section(local_vars *psection)
 614 {
 615         memset(psection, 0, sizeof (local_vars));
 616         copy_section(psection, &Vars.l);
 617 }
 618
 619 /* Do a case-insensitive, whitespace-ignoring string compare. */
 620 static int strwicmp(char *psz1, char *psz2)
 621 {
 622         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
 623         /* appropriate value. */
 624         if (psz1 == psz2)
 625                 return 0;
 626
 627         if (psz1 == NULL)
 628                 return -1;
 629
 630         if (psz2 == NULL)
 631                 return 1;
 632
 633         /* sync the strings on first non-whitespace */
 634         while (1) {
 635                 while (isSpace(psz1))
 636                         psz1++;
 637                 while (isSpace(psz2))
 638                         psz2++;
 639                 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
 640                         break;
 641                 psz1++;
 642                 psz2++;
 643         }
 644         return *psz1 - *psz2;
 645 }
 646
 647 /* Find a section by name. Otherwise works like get_section. */
 648 static int getsectionbyname(char *name)
 649 {
 650         int i;
 651
 652         for (i = section_list.count - 1; i >= 0; i--) {
 653                 if (strwicmp(iSECTION(i).name, name) == 0)
 654                         break;
 655         }
 656
 657         return i;
 658 }
 659
 660 /* Add a new section to the sections array w/the default values. */
 661 static int add_a_section(char *name)
 662 {
 663         int i;
 664         local_vars *s;
 665
 666         /* it might already exist */
 667         if (name) {
 668                 i = getsectionbyname(name);
 669                 if (i >= 0)
 670                         return i;
 671         }
 672
 673         i = section_list.count;
 674         s = EXPAND_ITEM_LIST(&section_list, local_vars, 2);
 675
 676         init_section(s);
 677         if (name)
 678                 string_set(&s->name, name);
 679
 680         return i;
 681 }
 682
 683 /* Map a parameter's string representation to something we can use.
 684  * Returns False if the parameter string is not recognised, else TRUE. */
 685 static int map_parameter(char *parmname)
 686 {
 687         int iIndex;
 688
 689         if (*parmname == '-')
 690                 return -1;
 691
 692         for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
 693                 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
 694                         return iIndex;
 695         }
 696
 697         rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
 698         return -1;
 699 }
 700
 701 /* Set a boolean variable from the text value stored in the passed string.
 702  * Returns True in success, False if the passed string does not correctly
 703  * represent a boolean. */
 704 static BOOL set_boolean(BOOL *pb, char *parmvalue)
 705 {
 706         if (strwicmp(parmvalue, "yes") == 0
 707          || strwicmp(parmvalue, "true") == 0
 708          || strwicmp(parmvalue, "1") == 0)
 709                 *pb = True;
 710         else if (strwicmp(parmvalue, "no") == 0
 711               || strwicmp(parmvalue, "False") == 0
 712               || strwicmp(parmvalue, "0") == 0)
 713                 *pb = False;
 714         else {
 715                 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
 716                 return False;
 717         }
 718         return True;
 719 }
 720
 721 /* Process a parameter. */
 722 static BOOL do_parameter(char *parmname, char *parmvalue)
 723 {
 724         int parmnum, i;
 725         void *parm_ptr; /* where we are going to store the result */
 726         void *def_ptr;
 727         char *cp;
 728
 729         parmnum = map_parameter(parmname);
 730
 731         if (parmnum < 0) {
 732                 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
 733                 return True;
 734         }
 735
 736         def_ptr = parm_table[parmnum].ptr;
 737
 738         if (bInGlobalSection)
 739                 parm_ptr = def_ptr;
 740         else {
 741                 if (parm_table[parmnum].class == P_GLOBAL) {
 742                         rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
 743                         return True;
 744                 }
 745                 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
 746         }
 747
 748         /* now switch on the type of variable it is */
 749         switch (parm_table[parmnum].type) {
 750         case P_PATH:
 751         case P_STRING:
 752                 /* delay expansion of %VAR% strings */
 753                 break;
 754         default:
 755                 /* expand any %VAR% strings now */
 756                 parmvalue = expand_vars(parmvalue);
 757                 break;
 758         }
 759
 760         switch (parm_table[parmnum].type) {
 761         case P_BOOL:
 762                 set_boolean(parm_ptr, parmvalue);
 763                 break;
 764
 765         case P_BOOLREV:
 766                 set_boolean(parm_ptr, parmvalue);
 767                 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
 768                 break;
 769
 770         case P_INTEGER:
 771                 *(int *)parm_ptr = atoi(parmvalue);
 772                 break;
 773
 774         case P_CHAR:
 775                 *(char *)parm_ptr = *parmvalue;
 776                 break;
 777
 778         case P_OCTAL:
 779                 sscanf(parmvalue, "%o", (int *)parm_ptr);
 780                 break;
 781
 782         case P_PATH:
 783                 string_set(parm_ptr, parmvalue);
 784                 if ((cp = *(char**)parm_ptr) != NULL) {
 785                         int len = strlen(cp);
 786                         while (len > 1 && cp[len-1] == '/') len--;
 787                         cp[len] = '\0';
 788                 }
 789                 break;
 790
 791         case P_STRING:
 792                 string_set(parm_ptr, parmvalue);
 793                 break;
 794
 795         case P_ENUM:
 796                 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
 797                         if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
 798                                 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
 799                                 break;
 800                         }
 801                 }
 802                 if (!parm_table[parmnum].enum_list[i].name) {
 803                         if (atoi(parmvalue) > 0)
 804                                 *(int *)parm_ptr = atoi(parmvalue);
 805                 }
 806                 break;
 807         }
 808
 809         return True;
 810 }
 811
 812 /* Process a new section (rsync module).
 813  * Returns True on success, False on failure. */
 814 static BOOL do_section(char *sectionname)
 815 {
 816         BOOL isglobal;
 817
 818         if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
 819                 bInGlobalSection = 1;
 820                 if (strcmp(sectionname+1, "push") == 0) {
 821                         all_vars *vp = EXPAND_ITEM_LIST(&Vars_stack, all_vars, 2);
 822                         memcpy(vp, &Vars, sizeof Vars);
 823                 } else if (strcmp(sectionname+1, "pop") == 0
 824                  || strcmp(sectionname+1, "reset") == 0) {
 825                         all_vars *vp = ((all_vars*)Vars_stack.items) + Vars_stack.count - 1;
 826                         if (!Vars_stack.count)
 827                                 return False;
 828                         memcpy(&Vars, vp, sizeof Vars);
 829                         if (sectionname[1] == 'p')
 830                                 Vars_stack.count--;
 831                 } else
 832                         return False;
 833                 return True;
 834         }
 835
 836         isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
 837
 838         /* At the end of the global section, add any --dparam items. */
 839         if (bInGlobalSection && !isglobal) {
 840                 if (!section_list.count)
 841                         set_dparams(0);
 842         }
 843
 844         /* if we've just struck a global section, note the fact. */
 845         bInGlobalSection = isglobal;
 846
 847         /* check for multiple global sections */
 848         if (bInGlobalSection)
 849                 return True;
 850
 851 #if 0
 852         /* If we have a current section, tidy it up before moving on. */
 853         if (iSectionIndex >= 0) {
 854                 /* Add any tidy work as needed ... */
 855                 if (problem)
 856                         return False;
 857         }
 858 #endif
 859
 860         if (strchr(sectionname, '/') != NULL) {
 861                 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
 862                 return False;
 863         }
 864
 865         if ((iSectionIndex = add_a_section(sectionname)) < 0) {
 866                 rprintf(FLOG, "Failed to add a new module\n");
 867                 bInGlobalSection = True;
 868                 return False;
 869         }
 870
 871         return True;
 872 }
 873
 874 /* Load the modules from the config file. Return True on success,
 875  * False on failure. */
 876 int lp_load(char *pszFname, int globals_only)
 877 {
 878         bInGlobalSection = True;
 879
 880         reset_daemon_vars();
 881
 882         /* We get sections first, so have to start 'behind' to make up. */
 883         iSectionIndex = -1;
 884         return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
 885 }
 886
 887 BOOL set_dparams(int syntax_check_only)
 888 {
 889         char *equal, *val, **params = dparam_list.items;
 890         unsigned j;
 891
 892         for (j = 0; j < dparam_list.count; j++) {
 893                 equal = strchr(params[j], '='); /* options.c verified this */
 894                 *equal = '\0';
 895                 if (syntax_check_only) {
 896                         if (map_parameter(params[j]) < 0) {
 897                                 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
 898                                 *equal = '=';
 899                                 return False;
 900                         }
 901                 } else {
 902                         for (val = equal+1; isSpace(val); val++) {}
 903                         do_parameter(params[j], val);
 904                 }
 905                 *equal = '=';
 906         }
 907
 908         return True;
 909 }
 910
 911 /* Return the max number of modules (sections). */
 912 int lp_num_modules(void)
 913 {
 914         return section_list.count;
 915 }
 916
 917 /* Return the number of the module with the given name, or -1 if it doesn't
 918  * exist. Note that this is a DIFFERENT ANIMAL from the internal function
 919  * getsectionbyname()! This works ONLY if all sections have been loaded,
 920  * and does not copy the found section. */
 921 int lp_number(char *name)
 922 {
 923         int i;
 924
 925         for (i = section_list.count - 1; i >= 0; i--) {
 926                 if (strcmp(lp_name(i), name) == 0)
 927                         break;
 928         }
 929
 930         return i;
 931 }