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 from samba.hostconfig import Hostconfig
  31 import sys
  32
  33
  34 class SambaOptions(optparse.OptionGroup):
  35     """General Samba-related command line options."""
  36
  37     def __init__(self, parser):
  38         from samba.param import LoadParm
  39         optparse.OptionGroup.__init__(self, parser, "Samba Common Options")
  40         self.add_option("-s", "--configfile", action="callback",
  41                         type=str, metavar="FILE", help="Configuration file",
  42                         callback=self._load_configfile)
  43         self.add_option("-d", "--debuglevel", action="callback",
  44                         type=int, metavar="DEBUGLEVEL", help="debug level",
  45                         callback=self._set_debuglevel)
  46         self.add_option("--option", action="callback",
  47                         type=str, metavar="OPTION",
  48                         help="set smb.conf option from command line",
  49                         callback=self._set_option)
  50         self.add_option("--realm", action="callback",
  51                         type=str, metavar="REALM", help="set the realm name",
  52                         callback=self._set_realm)
  53         self._configfile = None
  54         self._lp = LoadParm()
  55         self.realm = None
  56
  57     def get_loadparm_path(self):
  58         """Return path to the smb.conf file specified on the command line."""
  59         return self._configfile
  60
  61     def _load_configfile(self, option, opt_str, arg, parser):
  62         self._configfile = arg
  63
  64     def _set_debuglevel(self, option, opt_str, arg, parser):
  65         if arg < 0:
  66             raise optparse.OptionValueError("invalid %s option value: %s" %
  67                                             (opt_str, arg))
  68         self._lp.set('debug level', str(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, 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     def get_hostconfig(self):
  96         return Hostconfig(self.get_loadparm())
  97
  98
  99 class VersionOptions(optparse.OptionGroup):
 100     """Command line option for printing Samba version."""
 101     def __init__(self, parser):
 102         optparse.OptionGroup.__init__(self, parser, "Version Options")
 103         self.add_option("-V", "--version", action="callback",
 104                 callback=self._display_version,
 105                 help="Display version number")
 106
 107     def _display_version(self, option, opt_str, arg, parser):
 108         import samba
 109         print samba.version
 110         sys.exit(0)
 111
 112
 113 def parse_kerberos_arg(arg, opt_str):
 114     if arg.lower() in ["yes", 'true', '1']:
 115         return MUST_USE_KERBEROS
 116     elif arg.lower() in ["no", 'false', '0']:
 117         return DONT_USE_KERBEROS
 118     elif arg.lower() in ["auto"]:
 119         return AUTO_USE_KERBEROS
 120     else:
 121         raise optparse.OptionValueError("invalid %s option value: %s" %
 122                                         (opt_str, arg))
 123
 124
 125 class CredentialsOptions(optparse.OptionGroup):
 126     """Command line options for specifying credentials."""
 127
 128     def __init__(self, parser, special_name=None):
 129         self.special_name = special_name
 130         if special_name is not None:
 131             self.section = "Credentials Options (%s)" % special_name
 132         else:
 133             self.section = "Credentials Options"
 134
 135         self.ask_for_password = True
 136         self.ipaddress = None
 137         self.machine_pass = False
 138         optparse.OptionGroup.__init__(self, parser, self.section)
 139         self._add_option("--simple-bind-dn", metavar="DN", action="callback",
 140                         callback=self._set_simple_bind_dn, type=str,
 141                         help="DN to use for a simple bind")
 142         self._add_option("--password", metavar="PASSWORD", action="callback",
 143                         help="Password", type=str, callback=self._set_password)
 144         self._add_option("-U", "--username", metavar="USERNAME",
 145                         action="callback", type=str,
 146                         help="Username", callback=self._parse_username)
 147         self._add_option("-W", "--workgroup", metavar="WORKGROUP",
 148                         action="callback", type=str,
 149                         help="Workgroup", callback=self._parse_workgroup)
 150         self._add_option("-N", "--no-pass", action="callback",
 151                         help="Don't ask for a password",
 152                         callback=self._set_no_password)
 153         self._add_option("-k", "--kerberos", metavar="KERBEROS",
 154                         action="callback", type=str,
 155                         help="Use Kerberos", callback=self._set_kerberos)
 156         self._add_option("", "--ipaddress", metavar="IPADDRESS",
 157                         action="callback", type=str,
 158                         help="IP address of server",
 159                         callback=self._set_ipaddress)
 160         self._add_option("-P", "--machine-pass",
 161                         action="callback",
 162                         help="Use stored machine account password",
 163                         callback=self._set_machine_pass)
 164         self.creds = Credentials()
 165
 166     def _add_option(self, *args1, **kwargs):
 167         if self.special_name is None:
 168             return self.add_option(*args1, **kwargs)
 169
 170         args2 = ()
 171         for a in args1:
 172             if not a.startswith("--"):
 173                 continue
 174             args2 += (a.replace("--", "--%s-" % self.special_name),)
 175         self.add_option(*args2, **kwargs)
 176
 177     def _parse_username(self, option, opt_str, arg, parser):
 178         self.creds.parse_string(arg)
 179         self.machine_pass = False
 180
 181     def _parse_workgroup(self, option, opt_str, arg, parser):
 182         self.creds.set_domain(arg)
 183
 184     def _set_password(self, option, opt_str, arg, parser):
 185         self.creds.set_password(arg)
 186         self.ask_for_password = False
 187         self.machine_pass = False
 188
 189     def _set_no_password(self, option, opt_str, arg, parser):
 190         self.ask_for_password = False
 191
 192     def _set_machine_pass(self, option, opt_str, arg, parser):
 193         self.machine_pass = True
 194
 195     def _set_ipaddress(self, option, opt_str, arg, parser):
 196         self.ipaddress = arg
 197
 198     def _set_kerberos(self, option, opt_str, arg, parser):
 199         self.creds.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 200
 201     def _set_simple_bind_dn(self, option, opt_str, arg, parser):
 202         self.creds.set_bind_dn(arg)
 203
 204     def get_credentials(self, lp, fallback_machine=False):
 205         """Obtain the credentials set on the command-line.
 206
 207         :param lp: Loadparm object to use.
 208         :return: Credentials object
 209         """
 210         self.creds.guess(lp)
 211         if self.machine_pass:
 212             self.creds.set_machine_account(lp)
 213         elif self.ask_for_password:
 214             self.creds.set_cmdline_callbacks()
 215
 216         # possibly fallback to using the machine account, if we have
 217         # access to the secrets db
 218         if fallback_machine and not self.creds.authentication_requested():
 219             try:
 220                 self.creds.set_machine_account(lp)
 221             except Exception:
 222                 pass
 223
 224         return self.creds
 225
 226
 227 class CredentialsOptionsDouble(CredentialsOptions):
 228     """Command line options for specifying credentials of two servers."""
 229
 230     def __init__(self, parser):
 231         CredentialsOptions.__init__(self, parser)
 232         self.no_pass2 = True
 233         self.add_option("--simple-bind-dn2", metavar="DN2", action="callback",
 234                         callback=self._set_simple_bind_dn2, type=str,
 235                         help="DN to use for a simple bind")
 236         self.add_option("--password2", metavar="PASSWORD2", action="callback",
 237                         help="Password", type=str,
 238                         callback=self._set_password2)
 239         self.add_option("--username2", metavar="USERNAME2",
 240                         action="callback", type=str,
 241                         help="Username for second server",
 242                         callback=self._parse_username2)
 243         self.add_option("--workgroup2", metavar="WORKGROUP2",
 244                         action="callback", type=str,
 245                         help="Workgroup for second server",
 246                         callback=self._parse_workgroup2)
 247         self.add_option("--no-pass2", action="store_true",
 248                         help="Don't ask for a password for the second server")
 249         self.add_option("--kerberos2", metavar="KERBEROS2",
 250                         action="callback", type=str,
 251                         help="Use Kerberos", callback=self._set_kerberos2)
 252         self.creds2 = Credentials()
 253
 254     def _parse_username2(self, option, opt_str, arg, parser):
 255         self.creds2.parse_string(arg)
 256
 257     def _parse_workgroup2(self, option, opt_str, arg, parser):
 258         self.creds2.set_domain(arg)
 259
 260     def _set_password2(self, option, opt_str, arg, parser):
 261         self.creds2.set_password(arg)
 262         self.no_pass2 = False
 263
 264     def _set_kerberos2(self, option, opt_str, arg, parser):
 265         self.creds2.set_kerberos_state(parse_kerberos_arg(arg, opt_str))
 266
 267     def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
 268         self.creds2.set_bind_dn(arg)
 269
 270     def get_credentials2(self, lp, guess=True):
 271         """Obtain the credentials set on the command-line.
 272
 273         :param lp: Loadparm object to use.
 274         :param guess: Try guess Credentials from environment
 275         :return: Credentials object
 276         """
 277         if guess:
 278             self.creds2.guess(lp)
 279         elif not self.creds2.get_username():
 280             self.creds2.set_anonymous()
 281
 282         if self.no_pass2:
 283             self.creds2.set_cmdline_callbacks()
 284         return self.creds2