lib: Remove global xfile.h includes
[samba.git] / source3 / lib / popt_common.c
index 77c44f127a0459785446139c1058ad8d9fa7b4cb..f74543fa5ac050e49651cec9ee90cf52f39308a4 100644 (file)
@@ -3,11 +3,12 @@
    Common popt routines
 
    Copyright (C) Tim Potter 2001,2002
-   Copyright (C) Jelmer Vernooij 2002
+   Copyright (C) Jelmer Vernooij 2002,2003
+   Copyright (C) James Peach 2006
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
+#include "system/filesys.h"
+#include "popt_common.h"
+#include "lib/param/param.h"
+#include "lib/util/xfile.h"
 
 /* Handle command line options:
- *             d,--debuglevel 
- *             s,--configfile 
- *             O,--socket-options 
- *             V,--version
- *             l,--log-base
- *             n,--netbios-name
+ *             -d,--debuglevel 
+ *             -s,--configfile 
+ *             -O,--socket-options 
+ *             -V,--version
+ *             -l,--log-base
+ *             -n,--netbios-name
+ *             -W,--workgroup
+ *             -i,--scope
  */
 
-extern pstring user_socket_options;
-extern BOOL AllowDebugChange;
+enum {OPT_OPTION=1};
 
-static void popt_common_callback(poptContext con, 
-                          enum poptCallbackReason reason,
-                          const struct poptOption *opt,
-                          const char *arg, const void *data)
+extern bool override_logfile;
+
+static void set_logfile(poptContext con, const char * arg)
 {
-       pstring logfile;
+
+       char *lfile = NULL;
        const char *pname;
-       
+
        /* Find out basename of current program */
        pname = strrchr_m(poptGetInvocationName(con),'/');
 
        if (!pname)
                pname = poptGetInvocationName(con);
-       else 
+       else
                pname++;
 
+       if (asprintf(&lfile, "%s/log.%s", arg, pname) < 0) {
+               return;
+       }
+       lp_set_logfile(lfile);
+       SAFE_FREE(lfile);
+}
+
+static bool PrintSambaVersionString;
+
+static void popt_s3_talloc_log_fn(const char *message)
+{
+       DEBUG(0,("%s", message));
+}
+
+static void popt_common_callback(poptContext con,
+                          enum poptCallbackReason reason,
+                          const struct poptOption *opt,
+                          const char *arg, const void *data)
+{
+
        if (reason == POPT_CALLBACK_REASON_PRE) {
-               pstr_sprintf(logfile, "%s/log.%s", dyn_LOGFILEBASE, pname);
-               lp_set_logfile(logfile);
+               set_logfile(con, get_dyn_LOGFILEBASE());
+               talloc_set_log_fn(popt_s3_talloc_log_fn);
+               talloc_set_abort_fn(smb_panic);
+               return;
+       }
+
+       if (reason == POPT_CALLBACK_REASON_POST) {
+
+               if (PrintSambaVersionString) {
+                       printf( "Version %s\n", samba_version_string());
+                       exit(0);
+               }
+
+               if (is_default_dyn_CONFIGFILE()) {
+                       if(getenv("SMB_CONF_PATH")) {
+                               set_dyn_CONFIGFILE(getenv("SMB_CONF_PATH"));
+                       }
+               }
+
+               /* Further 'every Samba program must do this' hooks here. */
                return;
        }
 
        switch(opt->val) {
+       case OPT_OPTION:
+       {
+               struct loadparm_context *lp_ctx;
+
+               lp_ctx = loadparm_init_s3(talloc_tos(), loadparm_s3_helpers());
+               if (lp_ctx == NULL) {
+                       fprintf(stderr, "loadparm_init_s3() failed!\n");
+                       exit(1);
+               }
+
+               if (!lpcfg_set_option(lp_ctx, arg)) {
+                       fprintf(stderr, "Error setting option '%s'\n", arg);
+                       exit(1);
+               }
+               TALLOC_FREE(lp_ctx);
+               break;
+       }
        case 'd':
                if (arg) {
-                       debug_parse_levels(arg);
-                       AllowDebugChange = False;
+                       lp_set_cmdline("log level", arg);
                }
                break;
 
        case 'V':
-               printf( "Version %s\n", VERSION );
-               exit(0);
+               PrintSambaVersionString = True;
                break;
 
        case 'O':
                if (arg) {
-                       pstrcpy(user_socket_options,arg);
+                       lp_set_cmdline("socket options", arg);
                }
                break;
 
        case 's':
                if (arg) {
-                       pstrcpy(dyn_CONFIGFILE, arg);
+                       set_dyn_CONFIGFILE(arg);
                }
                break;
 
        case 'n':
                if (arg) {
-                       set_global_myname(arg);
+                       lp_set_cmdline("netbios name", arg);
                }
                break;
 
        case 'l':
                if (arg) {
-                       pstr_sprintf(logfile, "%s/log.%s", arg, pname);
-                       lp_set_logfile(logfile);
+                       set_logfile(con, arg);
+                       override_logfile = True;
+                       set_dyn_LOGFILEBASE(arg);
+               }
+               break;
+
+       case 'i':
+               if (arg) {
+                       lp_set_cmdline("netbios scope", arg);
+               }
+               break;
+
+       case 'W':
+               if (arg) {
+                       lp_set_cmdline("workgroup", arg);
                }
                break;
        }
 }
 
-struct poptOption popt_common_debug[] = {
-       { NULL, 0, POPT_ARG_CALLBACK, popt_common_callback },
-       { "debuglevel", 'd', POPT_ARG_STRING, NULL, 'd', "Set debug level", 
-         "DEBUGLEVEL" },
-       { 0 }
+struct poptOption popt_common_connection[] = {
+       { NULL, 0, POPT_ARG_CALLBACK, (void *)popt_common_callback },
+       { "socket-options", 'O', POPT_ARG_STRING, NULL, 'O', "socket options to use",
+         "SOCKETOPTIONS" },
+       { "netbiosname", 'n', POPT_ARG_STRING, NULL, 'n', "Primary netbios name", "NETBIOSNAME" },
+       { "workgroup", 'W', POPT_ARG_STRING, NULL, 'W', "Set the workgroup name", "WORKGROUP" },
+       { "scope", 'i', POPT_ARG_STRING, NULL, 'i', "Use this Netbios scope", "SCOPE" },
+
+       POPT_TABLEEND
 };
 
-struct poptOption popt_common_configfile[] = {
-       { NULL, 0, POPT_ARG_CALLBACK, popt_common_callback },
-       { "configfile", 's', POPT_ARG_STRING, NULL, 's', "Use alternative configuration file" },
-       { 0 }
+struct poptOption popt_common_samba[] = {
+       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_PRE|POPT_CBFLAG_POST, (void *)popt_common_callback },
+       { "debuglevel", 'd', POPT_ARG_STRING, NULL, 'd', "Set debug level", "DEBUGLEVEL" },
+       { "configfile", 's', POPT_ARG_STRING, NULL, 's', "Use alternate configuration file", "CONFIGFILE" },
+       { "log-basename", 'l', POPT_ARG_STRING, NULL, 'l', "Base name for log files", "LOGFILEBASE" },
+       { "version", 'V', POPT_ARG_NONE, NULL, 'V', "Print version" },
+       { "option",         0, POPT_ARG_STRING, NULL, OPT_OPTION, "Set smb.conf option from command line", "name=value" },
+       POPT_TABLEEND
 };
 
-struct poptOption popt_common_socket_options[] = {
-       { NULL, 0, POPT_ARG_CALLBACKpopt_common_callback },
-       {"socket-options", 'O', POPT_ARG_STRING, NULL, 'O', "socket options to use" },
-       { 0 }
+struct poptOption popt_common_configfile[] = {
+       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_PRE|POPT_CBFLAG_POST, (void *)popt_common_callback },
+       { "configfile", 0, POPT_ARG_STRING, NULL, 's', "Use alternate configuration file", "CONFIGFILE" },
+       POPT_TABLEEND
 };
 
 struct poptOption popt_common_version[] = {
-       { NULL, 0, POPT_ARG_CALLBACK, popt_common_callback },
-       {"version", 'V', POPT_ARG_NONE, NULL, 'V', "Print version" },
-       { 0 }
+       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_POST, (void *)popt_common_callback },
+       { "version", 'V', POPT_ARG_NONE, NULL, 'V', "Print version" },
+       POPT_TABLEEND
+};
+
+struct poptOption popt_common_debuglevel[] = {
+       { NULL, 0, POPT_ARG_CALLBACK, (void *)popt_common_callback },
+       { "debuglevel", 'd', POPT_ARG_STRING, NULL, 'd', "Set debug level", "DEBUGLEVEL" },
+       POPT_TABLEEND
 };
 
-struct poptOption popt_common_netbios_name[] = {
-       { NULL, 0, POPT_ARG_CALLBACKpopt_common_callback },
-       {"netbiosname", 'n', POPT_ARG_STRING, NULL, 'n', "Primary netbios name"},
-       { 0 }
+struct poptOption popt_common_option[] = {
+       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_POST, (void *)popt_common_callback },
+       { "option",         0, POPT_ARG_STRING, NULL, OPT_OPTION, "Set smb.conf option from command line", "name=value" },
+       POPT_TABLEEND
 };
 
-struct poptOption popt_common_log_base[] = {
-       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_PRE, popt_common_callback },
-       { "log-basename", 'l', POPT_ARG_STRING, NULL, 'l', "Basename for log/debug files"},
-       { 0 }
+/****************************************************************************
+ * get a password from a a file or file descriptor
+ * exit on failure
+ * ****************************************************************************/
+
+static void get_password_file(struct user_auth_info *auth_info)
+{
+       int fd = -1;
+       char *p;
+       bool close_it = False;
+       char *spec = NULL;
+       char pass[128];
+
+       if ((p = getenv("PASSWD_FD")) != NULL) {
+               if (asprintf(&spec, "descriptor %s", p) < 0) {
+                       return;
+               }
+               sscanf(p, "%d", &fd);
+               close_it = false;
+       } else if ((p = getenv("PASSWD_FILE")) != NULL) {
+               fd = open(p, O_RDONLY, 0);
+               spec = SMB_STRDUP(p);
+               if (fd < 0) {
+                       fprintf(stderr, "Error opening PASSWD_FILE %s: %s\n",
+                                       spec, strerror(errno));
+                       exit(1);
+               }
+               close_it = True;
+       }
+
+       if (fd < 0) {
+               fprintf(stderr, "fd = %d, < 0\n", fd);
+               exit(1);
+       }
+
+       for(p = pass, *p = '\0'; /* ensure that pass is null-terminated */
+               p && p - pass < sizeof(pass);) {
+               switch (read(fd, p, 1)) {
+               case 1:
+                       if (*p != '\n' && *p != '\0') {
+                               *++p = '\0'; /* advance p, and null-terminate pass */
+                               break;
+                       }
+               case 0:
+                       if (p - pass) {
+                               *p = '\0'; /* null-terminate it, just in case... */
+                               p = NULL; /* then force the loop condition to become false */
+                               break;
+                       } else {
+                               fprintf(stderr, "Error reading password from file %s: %s\n",
+                                               spec, "empty password\n");
+                               SAFE_FREE(spec);
+                               exit(1);
+                       }
+
+               default:
+                       fprintf(stderr, "Error reading password from file %s: %s\n",
+                                       spec, strerror(errno));
+                       SAFE_FREE(spec);
+                       exit(1);
+               }
+       }
+       SAFE_FREE(spec);
+
+       set_cmdline_auth_info_password(auth_info, pass);
+       if (close_it) {
+               close(fd);
+       }
+}
+
+static void get_credentials_file(struct user_auth_info *auth_info,
+                                const char *file)
+{
+       XFILE *auth;
+       fstring buf;
+       uint16_t len = 0;
+       char *ptr, *val, *param;
+
+       if ((auth=x_fopen(file, O_RDONLY, 0)) == NULL)
+       {
+               /* fail if we can't open the credentials file */
+               d_printf("ERROR: Unable to open credentials file!\n");
+               exit(-1);
+       }
+
+       while (!x_feof(auth))
+       {
+               /* get a line from the file */
+               if (!x_fgets(buf, sizeof(buf), auth))
+                       continue;
+               len = strlen(buf);
+
+               if ((len) && (buf[len-1]=='\n'))
+               {
+                       buf[len-1] = '\0';
+                       len--;
+               }
+               if (len == 0)
+                       continue;
+
+               /* break up the line into parameter & value.
+                * will need to eat a little whitespace possibly */
+               param = buf;
+               if (!(ptr = strchr_m (buf, '=')))
+                       continue;
+
+               val = ptr+1;
+               *ptr = '\0';
+
+               /* eat leading white space */
+               while ((*val!='\0') && ((*val==' ') || (*val=='\t')))
+                       val++;
+
+               if (strwicmp("password", param) == 0) {
+                       set_cmdline_auth_info_password(auth_info, val);
+               } else if (strwicmp("username", param) == 0) {
+                       set_cmdline_auth_info_username(auth_info, val);
+               } else if (strwicmp("domain", param) == 0) {
+                       set_cmdline_auth_info_domain(auth_info, val);
+               }
+               memset(buf, 0, sizeof(buf));
+       }
+       x_fclose(auth);
+}
+
+/* Handle command line options:
+ *             -U,--user
+ *             -A,--authentication-file
+ *             -k,--use-kerberos
+ *             -N,--no-pass
+ *             -S,--signing
+ *              -P --machine-pass
+ *             -e --encrypt
+ *             -C --use-ccache
+ */
+
+struct user_auth_info *cmdline_auth_info;
+static bool popt_common_credentials_delay_post;
+
+void popt_common_credentials_set_delay_post(void)
+{
+       popt_common_credentials_delay_post = true;
+}
+
+void popt_common_credentials_post(void)
+{
+       struct user_auth_info *auth_info = cmdline_auth_info;
+
+       if (get_cmdline_auth_info_use_machine_account(auth_info) &&
+           !set_cmdline_auth_info_machine_account_creds(auth_info))
+       {
+               fprintf(stderr,
+                       "Failed to use machine account credentials\n");
+               exit(1);
+       }
+
+       set_cmdline_auth_info_getpass(auth_info);
+}
+
+static void popt_common_credentials_callback(poptContext con,
+                                       enum poptCallbackReason reason,
+                                       const struct poptOption *opt,
+                                       const char *arg, const void *data)
+{
+       struct user_auth_info *auth_info = cmdline_auth_info;
+
+       if (reason == POPT_CALLBACK_REASON_PRE) {
+               if (auth_info == NULL) {
+                       auth_info = user_auth_info_init(talloc_autofree_context());
+                       if (auth_info == NULL) {
+                               fprintf(stderr, "user_auth_info_init() failed\n");
+                               exit(1);
+                       }
+                       cmdline_auth_info = auth_info;
+               }
+
+               set_cmdline_auth_info_username(auth_info, "GUEST");
+
+               if (getenv("LOGNAME")) {
+                       set_cmdline_auth_info_username(auth_info,
+                                                      getenv("LOGNAME"));
+               }
+
+               if (getenv("USER")) {
+                       set_cmdline_auth_info_username(auth_info,
+                                                      getenv("USER"));
+               }
+
+               if (getenv("PASSWD")) {
+                       set_cmdline_auth_info_password(auth_info,
+                                                      getenv("PASSWD"));
+               }
+
+               if (getenv("PASSWD_FD") || getenv("PASSWD_FILE")) {
+                       get_password_file(auth_info);
+               }
+
+               return;
+       }
+
+       if (reason == POPT_CALLBACK_REASON_POST) {
+               if (popt_common_credentials_delay_post) {
+                       return;
+               }
+
+               popt_common_credentials_post();
+               return;
+       }
+
+       switch(opt->val) {
+       case 'U':
+               {
+                       char *lp;
+                       char *puser = SMB_STRDUP(arg);
+
+                       if ((lp=strchr_m(puser,'%'))) {
+                               size_t len;
+                               *lp = '\0';
+                               set_cmdline_auth_info_username(auth_info,
+                                                              puser);
+                               set_cmdline_auth_info_password(auth_info,
+                                                              lp+1);
+                               len = strlen(lp+1);
+                               memset(lp + 1, '\0', len);
+                       } else {
+                               set_cmdline_auth_info_username(auth_info,
+                                                              puser);
+                       }
+                       SAFE_FREE(puser);
+               }
+               break;
+
+       case 'A':
+               get_credentials_file(auth_info, arg);
+               break;
+
+       case 'k':
+#ifndef HAVE_KRB5
+               d_printf("No kerberos support compiled in\n");
+               exit(1);
+#else
+               set_cmdline_auth_info_use_krb5_ticket(auth_info);
+#endif
+               break;
+
+       case 'S':
+               if (!set_cmdline_auth_info_signing_state(auth_info, arg)) {
+                       fprintf(stderr, "Unknown signing option %s\n", arg );
+                       exit(1);
+               }
+               break;
+       case 'P':
+               set_cmdline_auth_info_use_machine_account(auth_info);
+               break;
+       case 'N':
+               set_cmdline_auth_info_password(auth_info, "");
+               break;
+       case 'e':
+               set_cmdline_auth_info_smb_encrypt(auth_info);
+               break;
+       case 'C':
+               set_cmdline_auth_info_use_ccache(auth_info, true);
+               break;
+       case 'H':
+               set_cmdline_auth_info_use_pw_nt_hash(auth_info, true);
+               break;
+       }
+}
+
+/**
+ * @brief Burn the commandline password.
+ *
+ * This function removes the password from the command line so we
+ * don't leak the password e.g. in 'ps aux'.
+ *
+ * It should be called after processing the options and you should pass down
+ * argv from main().
+ *
+ * @param[in]  argc     The number of arguments.
+ *
+ * @param[in]  argv[]   The argument array we will find the array.
+ */
+void popt_burn_cmdline_password(int argc, char *argv[])
+{
+       bool found = false;
+       char *p = NULL;
+       int i, ulen = 0;
+
+       for (i = 0; i < argc; i++) {
+               p = argv[i];
+               if (strncmp(p, "-U", 2) == 0) {
+                       ulen = 2;
+                       found = true;
+               } else if (strncmp(p, "--user", 6) == 0) {
+                       ulen = 6;
+                       found = true;
+               }
+
+               if (found) {
+                       if (p == NULL) {
+                               return;
+                       }
+
+                       if (strlen(p) == ulen) {
+                               continue;
+                       }
+
+                       p = strchr_m(p, '%');
+                       if (p != NULL) {
+                               memset(p, '\0', strlen(p));
+                       }
+                       found = false;
+               }
+       }
+}
+
+struct poptOption popt_common_credentials[] = {
+       { NULL, 0, POPT_ARG_CALLBACK|POPT_CBFLAG_PRE|POPT_CBFLAG_POST,
+         (void *)popt_common_credentials_callback, 0, NULL },
+       { "user", 'U', POPT_ARG_STRING, NULL, 'U', "Set the network username", "USERNAME" },
+       { "no-pass", 'N', POPT_ARG_NONE, NULL, 'N', "Don't ask for a password" },
+       { "kerberos", 'k', POPT_ARG_NONE, NULL, 'k', "Use kerberos (active directory) authentication" },
+       { "authentication-file", 'A', POPT_ARG_STRING, NULL, 'A', "Get the credentials from a file", "FILE" },
+       { "signing", 'S', POPT_ARG_STRING, NULL, 'S', "Set the client signing state", "on|off|required" },
+       {"machine-pass", 'P', POPT_ARG_NONE, NULL, 'P', "Use stored machine account password" },
+       {"encrypt", 'e', POPT_ARG_NONE, NULL, 'e', "Encrypt SMB transport" },
+       {"use-ccache", 'C', POPT_ARG_NONE, NULL, 'C',
+        "Use the winbind ccache for authentication" },
+       {"pw-nt-hash", '\0', POPT_ARG_NONE, NULL, 'H',
+        "The supplied password is the NT hash" },
+       POPT_TABLEEND
 };