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 print("--option takes a 'a=b' argument")
81 self._lp.set(a[0], a[1])
83 def get_loadparm(self):
84 """Return loadparm object with data specified on the command line."""
85 if self._configfile is not None:
86 self._lp.load(self._configfile)
87 elif os.getenv("SMB_CONF_PATH") is not None:
88 self._lp.load(os.getenv("SMB_CONF_PATH"))
90 self._lp.load_default()
93 def get_hostconfig(self):
94 return Hostconfig(self.get_loadparm())
97 class VersionOptions(optparse.OptionGroup):
98 """Command line option for printing Samba version."""
99 def __init__(self, parser):
100 optparse.OptionGroup.__init__(self, parser, "Version Options")
101 self.add_option("--version", action="callback",
102 callback=self._display_version,
103 help="Display version number")
105 def _display_version(self, option, opt_str, arg, parser):
111 def parse_kerberos_arg(arg):
112 if arg.lower() in ["yes", 'true', '1']:
113 return MUST_USE_KERBEROS
114 elif arg.lower() in ["no", 'false', '0']:
115 return DONT_USE_KERBEROS
116 elif arg.lower() in ["auto"]:
117 return AUTO_USE_KERBEROS
119 raise optparse.BadOptionError("invalid kerberos option: %s" % arg)
122 class CredentialsOptions(optparse.OptionGroup):
123 """Command line options for specifying credentials."""
125 def __init__(self, parser):
127 self.ipaddress = None
128 optparse.OptionGroup.__init__(self, parser, "Credentials Options")
129 self.add_option("--simple-bind-dn", metavar="DN", action="callback",
130 callback=self._set_simple_bind_dn, type=str,
131 help="DN to use for a simple bind")
132 self.add_option("--password", metavar="PASSWORD", action="callback",
133 help="Password", type=str, callback=self._set_password)
134 self.add_option("-U", "--username", metavar="USERNAME",
135 action="callback", type=str,
136 help="Username", callback=self._parse_username)
137 self.add_option("-W", "--workgroup", metavar="WORKGROUP",
138 action="callback", type=str,
139 help="Workgroup", callback=self._parse_workgroup)
140 self.add_option("-N", "--no-pass", action="store_true",
141 help="Don't ask for a password")
142 self.add_option("-k", "--kerberos", metavar="KERBEROS",
143 action="callback", type=str,
144 help="Use Kerberos", callback=self._set_kerberos)
145 self.add_option("", "--ipaddress", metavar="IPADDRESS",
146 action="callback", type=str,
147 help="IP address of server",
148 callback=self._set_ipaddress)
149 self.creds = Credentials()
151 def _parse_username(self, option, opt_str, arg, parser):
152 self.creds.parse_string(arg)
154 def _parse_workgroup(self, option, opt_str, arg, parser):
155 self.creds.set_domain(arg)
157 def _set_password(self, option, opt_str, arg, parser):
158 self.creds.set_password(arg)
161 def _set_ipaddress(self, option, opt_str, arg, parser):
164 def _set_kerberos(self, option, opt_str, arg, parser):
165 self.creds.set_kerberos_state(parse_kerberos_arg(arg))
167 def _set_simple_bind_dn(self, option, opt_str, arg, parser):
168 self.creds.set_bind_dn(arg)
170 def get_credentials(self, lp, fallback_machine=False):
171 """Obtain the credentials set on the command-line.
173 :param lp: Loadparm object to use.
174 :return: Credentials object
178 self.creds.set_cmdline_callbacks()
180 # possibly fallback to using the machine account, if we have
181 # access to the secrets db
182 if fallback_machine and not self.creds.authentication_requested():
184 self.creds.set_machine_account(lp)
191 class CredentialsOptionsDouble(CredentialsOptions):
192 """Command line options for specifying credentials of two servers."""
194 def __init__(self, parser):
195 CredentialsOptions.__init__(self, parser)
197 self.add_option("--simple-bind-dn2", metavar="DN2", action="callback",
198 callback=self._set_simple_bind_dn2, type=str,
199 help="DN to use for a simple bind")
200 self.add_option("--password2", metavar="PASSWORD2", action="callback",
201 help="Password", type=str,
202 callback=self._set_password2)
203 self.add_option("--username2", metavar="USERNAME2",
204 action="callback", type=str,
205 help="Username for second server",
206 callback=self._parse_username2)
207 self.add_option("--workgroup2", metavar="WORKGROUP2",
208 action="callback", type=str,
209 help="Workgroup for second server",
210 callback=self._parse_workgroup2)
211 self.add_option("--no-pass2", action="store_true",
212 help="Don't ask for a password for the second server")
213 self.add_option("--kerberos2", metavar="KERBEROS2",
214 action="callback", type=str,
215 help="Use Kerberos", callback=self._set_kerberos2)
216 self.creds2 = Credentials()
218 def _parse_username2(self, option, opt_str, arg, parser):
219 self.creds2.parse_string(arg)
221 def _parse_workgroup2(self, option, opt_str, arg, parser):
222 self.creds2.set_domain(arg)
224 def _set_password2(self, option, opt_str, arg, parser):
225 self.creds2.set_password(arg)
226 self.no_pass2 = False
228 def _set_kerberos2(self, option, opt_str, arg, parser):
229 self.creds2.set_kerberos_state(parse_kerberos_arg(arg))
231 def _set_simple_bind_dn2(self, option, opt_str, arg, parser):
232 self.creds2.set_bind_dn(arg)
234 def get_credentials2(self, lp, guess=True):
235 """Obtain the credentials set on the command-line.
237 :param lp: Loadparm object to use.
238 :param guess: Try guess Credentials from environment
239 :return: Credentials object
242 self.creds2.guess(lp)
243 elif not self.creds2.get_username():
244 self.creds2.set_anonymous()
247 self.creds2.set_cmdline_callbacks()