python/samba/getopt.py

   1 # Samba-specific bits for optparse
   2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 """Support for parsing Samba-related command-line options."""
  19
  20 __docformat__ = "restructuredText"
  21
  22 import optparse
  23 import os
  24 from samba.credentials import (
  25     Credentials,
  26     AUTO_USE_KERBEROS,
  27     DONT_USE_KERBEROS,
  28     MUST_USE_KERBEROS,
  29     )
  30 import sys
  31
  32
  33 class SambaOptions(optparse.OptionGroup):
  34     """General Samba-related command line options."""
  35
  36     def __init__(self, parser):
  37         from samba.param import LoadParm
  38         optparse.OptionGroup.__init__(self, parser, "Samba Common Options")
  39         self.add_option("-s", "--configfile", action="callback",
  40                         type=str, metavar="FILE", help="Configuration file",
  41                         callback=self._load_configfile)
  42         self.add_option("-d", "--debuglevel", action="callback",
  43                         type=int, metavar="DEBUGLEVEL", help="debug level",
  44                         callback=self._set_debuglevel)
  45         self.add_option("--option", action="callback",
  46                         type=str, metavar="OPTION",
  47                         help="set smb.conf option from command line",
  48                         callback=self._set_option)
  49         self.add_option("--realm", action="callback",
  50                         type=str, metavar="REALM", help="set the realm name",
  51                         callback=self._set_realm)
  52         self._configfile = None
  53         self._lp = LoadParm()
  54         self.realm = None
  55
  56     def get_loadparm_path(self):
  57         """Return path to the smb.conf file specified on the command line."""
  58         return self._configfile
  59
  60     def _load_configfile(self, option, opt_str, arg, parser):
  61         self._configfile = arg
  62
  63     def _set_debuglevel(self, option, opt_str, arg, parser):
  64         if arg < 0:
  65             raise optparse.OptionValueError("invalid %s option value: %s" %
  66                                             (opt_str, arg))
  67         self._lp.set('debug level', str(arg))
  68         parser.values.debuglevel = int(arg)
  69
  70     def _set_realm(self, option, opt_str, arg, parser):
  71         self._lp.set('realm', arg)
  72         self.realm = arg
  73
  74     def _set_option(self, option, opt_str, arg, parser):
  75         if arg.find('=') == -1:
  76             raise optparse.OptionValueError(
  77                 "--option option takes a 'a=b' argument")
  78         a = arg.split('=')
  79         try:
  80             self._lp.set(a[0], a[1])
  81         except Exception as e:
  82             raise optparse.OptionValueError(
  83                 "invalid --option option value %r: %s" % (arg, e))
  84
  85     def get_loadparm(self):
  86         """Return loadparm object with data specified on the command line."""
  87         if self._configfile is not None:
  88             self._lp.load(self._configfile)
  89         elif os.getenv("SMB_CONF_PATH") is not None:
  90             self._lp.load(os.getenv("SMB_CONF_PATH"))
  91         else:
  92             self._lp.load_default()
  93         return self._lp
  94
  95
  96 class VersionOptions(optparse.OptionGroup):
  97     """Command line option for printing Samba version."""
  98     def __init__(self, parser):
  99         optparse.OptionGroup.__init__(self, parser, "Version Options")
 100         self.add_option("-V", "--version", action="callback",
 101                 callback=self._display_version,
 102                 help="Display version number")
 103
 104     def _display_version(self, option, opt_str, arg, parser):
 105         import samba
 106         print(samba.version)
 107         sys.exit(0)
 108
 109
 110 def parse_kerberos_arg(arg, opt_str):
 111     if arg.lower() in ["yes", 'true', '1']:
 112         return MUST_USE_KERBEROS
 113     elif arg.lower() in ["no", 'false', '0']:
 114         return DONT_USE_KERBEROS
 115     elif arg.lower() in ["auto"]:
 116         return AUTO_USE_KERBEROS
 117     else:
 118         raise optparse.OptionValueError("invalid %s option value: %s" %
 119                                         (opt_str, arg))
 120
 121
 122 class CredentialsOptions(optparse.OptionGroup):
 123     """Command line options for specifying credentials."""
 124
 125     def __init__(self, parser, special_name=None):
 126         self.special_name = special_name
 127         if special_name is not None:
 128             self.section = "Credentials Options (%s)" % special_name
 129         else:
 130             self.section = "Credentials Options"
 131
 132         self.ask_for_password = True
 133         self.ipaddress = None
 134         self.machine_pass = False
 135         optparse.OptionGroup.__init__(self, parser, self.section)
 136         self._add_option("--simple-bind-dn", metavar="DN", action="callback",
 137                         callback=self._set_simple_bind_dn, type=str,
 138                         help="DN to use for a simple bind")
 139         self._add_option("--password", metavar="PASSWORD", action="callback",
 140                         help="Password", type=str, callback=self._set_password)
 141         self._add_option("-U", "--username", metavar="USERNAME",
 142                         action="callback", type=str,
 143                         help="Username", callback=self._parse_username)
 144         self._add_option("-W", "--workgroup", metavar="WORKGROUP",
 145                         action="callback", type=str,
 146                         help="Workgroup", callback=self._parse_workgroup)
 147         self._add_option("-N", "--no-pass", action="callback",
 148                         help="Don't ask for a password",
 149                         callback=self._set_no_password)
 150         self._add_option("-k", "--kerberos", metavar="KERBEROS",
 151                         action="callback", type=str,
 152                         help="Use Kerberos", callback=self._set_kerberos)
 153         self._add_option("", "--ipaddress", metavar="IPADDRESS",
 154                         action="callback", type=str,
 155                         help="IP address of server",
 156                         callback=self._set_ipaddress)
 157         self._add_option("-P", "--machine-pass",
 158                         action="callback",
 159                         help="Use stored machine account password",
 160                         callback=self._set_machine_pass)
 161         self.creds = Credentials()
 162
 163     def _add_option(self, *args1, **kwargs):
 164         if self.special_name is None:
 165             return self.add_option(*args1, **kwargs)
 166
 167         args2 = ()
 168         for a in args1:
 169             if not a.startswith("--"):
 170                 continue
 171             args2 += (a.replace("--", "--%s-" % self.special_name),)
 172         self.add_option(*args2, **kwargs)
 173
 174     def _parse_username(self, option, opt_str, arg, parser):
 175         self.creds.parse_string(arg)
 176         self.machine_pass = False
 177
 178     def _parse_workgroup(self, option, opt_str, arg, parser):
 179         self.creds.set_domain(arg)
 180
 181     def _set_password(self, option, opt_str, arg, parser):
 182         self.creds.set_password(arg)
 183         self.ask_for_password = False
 184         self.machine_pass = False
 185
 186     def _set_no_password(self, option, opt_str, arg, parser):
 187         self.ask_for_password = False
 188
 189     def _set_machine_pass(self, option, opt_str, arg, parser):
 190         self.machine_pass = True
 191
 192     def _set_ipaddress(self, option, opt_str, arg, parser):
 193         self.ipaddress = arg
 194
 195     def _set_kerberos(self, option, opt_str, arg, parser):
 196         self.creds.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 197
 198     def _set_simple_bind_dn(self, option, opt_str, arg, parser):
 199         self.creds.set_bind_dn(arg)
 200
 201     def get_credentials(self, lp, fallback_machine=False):
 202         """Obtain the credentials set on the command-line.
 203
 204         :param lp: Loadparm object to use.
 205         :return: Credentials object
 206         """
 207         self.creds.guess(lp)
 208         if self.machine_pass:
 209             self.creds.set_machine_account(lp)
 210         elif self.ask_for_password:
 211             self.creds.set_cmdline_callbacks()
 212
 213         # possibly fallback to using the machine account, if we have
 214         # access to the secrets db
 215         if fallback_machine and not self.creds.authentication_requested():
 216             try:
 217                 self.creds.set_machine_account(lp)
 218             except Exception:
 219                 pass
 220
 221         return self.creds
 222
 223
 224 class CredentialsOptionsDouble(CredentialsOptions):
 225     """Command line options for specifying credentials of two servers."""
 226
 227     def __init__(self, parser):
 228         CredentialsOptions.__init__(self, parser)
 229         self.no_pass2 = True
 230         self.add_option("--simple-bind-dn2", metavar="DN2", action="callback",
 231                         callback=self._set_simple_bind_dn2, type=str,
 232                         help="DN to use for a simple bind")
 233         self.add_option("--password2", metavar="PASSWORD2", action="callback",
 234                         help="Password", type=str,
 235                         callback=self._set_password2)
 236         self.add_option("--username2", metavar="USERNAME2",
 237                         action="callback", type=str,
 238                         help="Username for second server",
 239                         callback=self._parse_username2)
 240         self.add_option("--workgroup2", metavar="WORKGROUP2",
 241                         action="callback", type=str,
 242                         help="Workgroup for second server",
 243                         callback=self._parse_workgroup2)
 244         self.add_option("--no-pass2", action="store_true",
 245                         help="Don't ask for a password for the second server")
 246         self.add_option("--kerberos2", metavar="KERBEROS2",
 247                         action="callback", type=str,
 248                         help="Use Kerberos", callback=self._set_kerberos2)
 249         self.creds2 = Credentials()
 250
 251     def _parse_username2(self, option, opt_str, arg, parser):
 252         self.creds2.parse_string(arg)
 253
 254     def _parse_workgroup2(self, option, opt_str, arg, parser):
 255         self.creds2.set_domain(arg)
 256
 257     def _set_password2(self, option, opt_str, arg, parser):
 258         self.creds2.set_password(arg)
 259         self.no_pass2 = False
 260
 261     def _set_kerberos2(self, option, opt_str, arg, parser):
 262         self.creds2.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 263
 264     def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
 265         self.creds2.set_bind_dn(arg)
 266
 267     def get_credentials2(self, lp, guess=True):
 268         """Obtain the credentials set on the command-line.
 269
 270         :param lp: Loadparm object to use.
 271         :param guess: Try guess Credentials from environment
 272         :return: Credentials object
 273         """
 274         if guess:
 275             self.creds2.guess(lp)
 276         elif not self.creds2.get_username():
 277             self.creds2.set_anonymous()
 278
 279         if self.no_pass2:
 280             self.creds2.set_cmdline_callbacks()
 281         return self.creds2