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