source4/scripting/python/samba/getopt.py

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