3 # Samba-specific bits for optparse
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
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.
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.
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/>.
20 """Support for parsing Samba-related command-line options."""
22 __docformat__ = "restructuredText"
26 from samba.credentials import (
32 from samba.hostconfig import Hostconfig
36 class SambaOptions(optparse.OptionGroup):
37 """General Samba-related command line options."""
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
59 def get_loadparm_path(self):
60 """Return path to the smb.conf file specified on the command line."""
61 return self._configfile
63 def _load_configfile(self, option, opt_str, arg, parser):
64 self._configfile = arg
66 def _set_debuglevel(self, option, opt_str, arg, parser):
68 raise optparse.OptionValueError("invalid %s option value: %s" %
70 self._lp.set('debug level', str(arg))
72 def _set_realm(self, option, opt_str, arg, parser):
73 self._lp.set('realm', arg)
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")
81 self._lp.set(a[0], a[1])
83 raise optparse.OptionValueError("invalid --option option value: %s"
86 def get_loadparm(self):
87 """Return loadparm object with data specified on the command line."""
88 if self._configfile is not None:
89 self._lp.load(self._configfile)
90 elif os.getenv("SMB_CONF_PATH") is not None:
91 self._lp.load(os.getenv("SMB_CONF_PATH"))
93 self._lp.load_default()
96 def get_hostconfig(self):
97 return Hostconfig(self.get_loadparm())
100 class VersionOptions(optparse.OptionGroup):
101 """Command line option for printing Samba version."""
102 def __init__(self, parser):
103 optparse.OptionGroup.__init__(self, parser, "Version Options")
104 self.add_option("--version", action="callback",
105 callback=self._display_version,
106 help="Display version number")
108 def _display_version(self, option, opt_str, arg, parser):
114 def parse_kerberos_arg(arg):
115 if arg.lower() in ["yes", 'true', '1']:
116 return MUST_USE_KERBEROS
117 elif arg.lower() in ["no", 'false', '0']:
118 return DONT_USE_KERBEROS
119 elif arg.lower() in ["auto"]:
120 return AUTO_USE_KERBEROS
122 raise optparse.BadOptionError("invalid kerberos option: %s" % arg)
125 class CredentialsOptions(optparse.OptionGroup):
126 """Command line options for specifying credentials."""
128 def __init__(self, parser):
130 self.ipaddress = None
131 optparse.OptionGroup.__init__(self, parser, "Credentials Options")
132 self.add_option("--simple-bind-dn", metavar="DN", action="callback",
133 callback=self._set_simple_bind_dn, type=str,
134 help="DN to use for a simple bind")
135 self.add_option("--password", metavar="PASSWORD", action="callback",
136 help="Password", type=str, callback=self._set_password)
137 self.add_option("-U", "--username", metavar="USERNAME",
138 action="callback", type=str,
139 help="Username", callback=self._parse_username)
140 self.add_option("-W", "--workgroup", metavar="WORKGROUP",
141 action="callback", type=str,
142 help="Workgroup", callback=self._parse_workgroup)
143 self.add_option("-N", "--no-pass", action="store_true",
144 help="Don't ask for a password")
145 self.add_option("-k", "--kerberos", metavar="KERBEROS",
146 action="callback", type=str,
147 help="Use Kerberos", callback=self._set_kerberos)
148 self.add_option("", "--ipaddress", metavar="IPADDRESS",
149 action="callback", type=str,
150 help="IP address of server",
151 callback=self._set_ipaddress)
152 self.creds = Credentials()
154 def _parse_username(self, option, opt_str, arg, parser):
155 self.creds.parse_string(arg)
157 def _parse_workgroup(self, option, opt_str, arg, parser):
158 self.creds.set_domain(arg)
160 def _set_password(self, option, opt_str, arg, parser):
161 self.creds.set_password(arg)
164 def _set_ipaddress(self, option, opt_str, arg, parser):
167 def _set_kerberos(self, option, opt_str, arg, parser):
168 self.creds.set_kerberos_state(parse_kerberos_arg(arg))
170 def _set_simple_bind_dn(self, option, opt_str, arg, parser):
171 self.creds.set_bind_dn(arg)
173 def get_credentials(self, lp, fallback_machine=False):
174 """Obtain the credentials set on the command-line.
176 :param lp: Loadparm object to use.
177 :return: Credentials object
181 self.creds.set_cmdline_callbacks()
183 # possibly fallback to using the machine account, if we have
184 # access to the secrets db
185 if fallback_machine and not self.creds.authentication_requested():
187 self.creds.set_machine_account(lp)
194 class CredentialsOptionsDouble(CredentialsOptions):
195 """Command line options for specifying credentials of two servers."""
197 def __init__(self, parser):
198 CredentialsOptions.__init__(self, parser)
200 self.add_option("--simple-bind-dn2", metavar="DN2", action="callback",
201 callback=self._set_simple_bind_dn2, type=str,
202 help="DN to use for a simple bind")
203 self.add_option("--password2", metavar="PASSWORD2", action="callback",
204 help="Password", type=str,
205 callback=self._set_password2)
206 self.add_option("--username2", metavar="USERNAME2",
207 action="callback", type=str,
208 help="Username for second server",
209 callback=self._parse_username2)
210 self.add_option("--workgroup2", metavar="WORKGROUP2",
211 action="callback", type=str,
212 help="Workgroup for second server",
213 callback=self._parse_workgroup2)
214 self.add_option("--no-pass2", action="store_true",
215 help="Don't ask for a password for the second server")
216 self.add_option("--kerberos2", metavar="KERBEROS2",
217 action="callback", type=str,
218 help="Use Kerberos", callback=self._set_kerberos2)
219 self.creds2 = Credentials()
221 def _parse_username2(self, option, opt_str, arg, parser):
222 self.creds2.parse_string(arg)
224 def _parse_workgroup2(self, option, opt_str, arg, parser):
225 self.creds2.set_domain(arg)
227 def _set_password2(self, option, opt_str, arg, parser):
228 self.creds2.set_password(arg)
229 self.no_pass2 = False
231 def _set_kerberos2(self, option, opt_str, arg, parser):
232 self.creds2.set_kerberos_state(parse_kerberos_arg(arg))
234 def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
235 self.creds2.set_bind_dn(arg)
237 def get_credentials2(self, lp, guess=True):
238 """Obtain the credentials set on the command-line.
240 :param lp: Loadparm object to use.
241 :param guess: Try guess Credentials from environment
242 :return: Credentials object
245 self.creds2.guess(lp)
246 elif not self.creds2.get_username():
247 self.creds2.set_anonymous()
250 self.creds2.set_cmdline_callbacks()