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