python/samba/netcmd/testparm.py

   1 #   Unix SMB/CIFS implementation.
   2 #   Test validity of smb.conf
   3 #   Copyright (C) 2010-2011 Jelmer Vernooij <jelmer@samba.org>
   4 #
   5 # Based on the original in C:
   6 #   Copyright (C) Karl Auer 1993, 1994-1998
   7 #   Extensively modified by Andrew Tridgell, 1995
   8 #   Converted to popt by Jelmer Vernooij (jelmer@nl.linux.org), 2002
   9 #   Updated for Samba4 by Andrew Bartlett <abartlet@samba.org> 2006
  10 #
  11 # This program is free software; you can redistribute it and/or modify
  12 # it under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # This program is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23 #
  24 # Testbed for loadparm.c/params.c
  25 #
  26 # This module simply loads a specified configuration file and
  27 # if successful, dumps it's contents to stdout. Note that the
  28 # operation is performed with DEBUGLEVEL at 3.
  29 #
  30 # Useful for a quick 'syntax check' of a configuration file.
  31 #
  32
  33 import os
  34 import sys
  35
  36 import samba
  37 import samba.getopt as options
  38 from samba.netcmd import Command, CommandError, Option
  39
  40
  41 class cmd_testparm(Command):
  42     """Syntax check the configuration file."""
  43
  44     synopsis = "%prog [options]"
  45
  46     takes_optiongroups = {
  47         "sambaopts": options.SambaOptions,
  48         "versionopts": options.VersionOptions
  49     }
  50
  51     takes_options = [
  52         Option("--section-name", type=str,
  53                help="Limit testparm to a named section"),
  54         Option("--parameter-name", type=str,
  55                help="Limit testparm to a named parameter"),
  56         Option("--client-name", type=str,
  57                help="Client DNS name for 'hosts allow' checking "
  58                     "(should match reverse lookup)"),
  59         Option("--client-ip", type=str,
  60                help="Client IP address for 'hosts allow' checking"),
  61         Option("--suppress-prompt", action="store_true", default=False,
  62                help="Suppress prompt for enter"),
  63         Option("-v", "--verbose", action="store_true",
  64                default=False, help="Show default options too"),
  65         # We need support for smb.conf macros before this will work again
  66         Option("--server", type=str, help="Set %L macro to servername"),
  67         # These are harder to do with the new code structure
  68         Option("--show-all-parameters", action="store_true", default=False,
  69                help="Show the parameters, type, possible values")
  70     ]
  71
  72     takes_args = []
  73
  74     def run(self, sambaopts, versionopts, section_name=None,
  75             parameter_name=None, client_ip=None, client_name=None,
  76             verbose=False, suppress_prompt=None, show_all_parameters=False,
  77             server=None):
  78         if server:
  79             raise NotImplementedError("--server not yet implemented")
  80         if show_all_parameters:
  81             raise NotImplementedError("--show-all-parameters not yet implemented")
  82         if client_name is not None and client_ip is None:
  83             raise CommandError("Both a DNS name and an IP address are "
  84                                "required for the host access check")
  85
  86         try:
  87             lp = sambaopts.get_loadparm()
  88         except RuntimeError as err:
  89             raise CommandError(err)
  90
  91         # We need this to force the output
  92         samba.set_debug_level(2)
  93
  94         logger = self.get_logger("testparm")
  95
  96         logger.info("Loaded smb config files from %s", lp.configfile)
  97         logger.info("Loaded services file OK.")
  98
  99         valid = self.do_global_checks(lp, logger)
 100         valid = valid and self.do_share_checks(lp, logger)
 101         if client_name is not None and client_ip is not None:
 102             self.check_client_access(lp, logger, client_name, client_ip)
 103         else:
 104             if section_name is not None or parameter_name is not None:
 105                 if parameter_name is None:
 106                     try:
 107                         section = lp[section_name]
 108                     except KeyError:
 109                         if section_name in ['global', 'globals']:
 110                             lp.dump_globals()
 111                         else:
 112                             raise CommandError(f"Unknown section {section_name}")
 113                     else:
 114                         section.dump(lp.default_service, verbose)
 115                 else:
 116                     try:
 117                         lp.dump_a_parameter(parameter_name, section_name)
 118                     except RuntimeError as e:
 119                         raise CommandError(e)
 120             else:
 121                 if not suppress_prompt:
 122                     self.outf.write("Press enter to see a dump of your service definitions\n")
 123                     sys.stdin.readline()
 124                 lp.dump(verbose)
 125         if valid:
 126             return
 127         else:
 128             raise CommandError("Invalid smb.conf")
 129
 130     def do_global_checks(self, lp, logger):
 131         valid = True
 132
 133         netbios_name = lp.get("netbios name")
 134         if not samba.valid_netbios_name(netbios_name):
 135             logger.error("netbios name %s is not a valid netbios name",
 136                          netbios_name)
 137             valid = False
 138
 139         workgroup = lp.get("workgroup")
 140         if not samba.valid_netbios_name(workgroup):
 141             logger.error("workgroup name %s is not a valid netbios name",
 142                          workgroup)
 143             valid = False
 144
 145         lockdir = lp.get("lockdir")
 146
 147         if not os.path.isdir(lockdir):
 148             logger.error("lock directory %s does not exist", lockdir)
 149             valid = False
 150
 151         piddir = lp.get("pid directory")
 152
 153         if not os.path.isdir(piddir):
 154             logger.error("pid directory %s does not exist", piddir)
 155             valid = False
 156
 157         winbind_separator = lp.get("winbind separator")
 158
 159         if len(winbind_separator) != 1:
 160             logger.error("the 'winbind separator' parameter must be a single "
 161                          "character.")
 162             valid = False
 163
 164         if winbind_separator == '+':
 165             logger.error(
 166                 "'winbind separator = +' might cause problems with group "
 167                 "membership.")
 168             valid = False
 169
 170         role = lp.get("server role")
 171
 172         if role in ["active directory domain controller", "domain controller", "dc"]:
 173             charset = lp.get("unix charset").upper()
 174             if charset not in ["UTF-8", "UTF8"]:
 175                 logger.warning(
 176                     "When acting as Active Directory domain controller, "
 177                     "unix charset is expected to be UTF-8.")
 178             vfsobjects = lp.get("vfs objects")
 179             if vfsobjects:
 180                 for entry in ['dfs_samba4', 'acl_xattr']:
 181                     if entry not in vfsobjects:
 182                         logger.warning(
 183                             "When acting as Active Directory domain controller, " +
 184                             entry + " should be in vfs objects.")
 185
 186         return valid
 187
 188     def allow_access(self, deny_list, allow_list, cname, caddr):
 189         raise NotImplementedError(self.allow_access)
 190
 191     def do_share_checks(self, lp, logger):
 192         valid = True
 193         for s in lp.services():
 194             if len(s) > 12:
 195                 logger.warning(
 196                     "You have some share names that are longer than 12 "
 197                     "characters. These may not be accessible to some older "
 198                     "clients. (Eg. Windows9x, WindowsMe, and not listed in "
 199                     "smbclient in Samba 3.0.)")
 200                 break
 201
 202         for s in lp.services():
 203             deny_list = lp.get("hosts deny", s)
 204             allow_list = lp.get("hosts allow", s)
 205             if deny_list:
 206                 for entry in deny_list:
 207                     if "*" in entry or "?" in entry:
 208                         logger.error("Invalid character (* or ?) in hosts deny "
 209                                      "list (%s) for service %s.", entry, s)
 210                         valid = False
 211
 212             if allow_list:
 213                 for entry in allow_list:
 214                     if "*" in entry or "?" in entry:
 215                         logger.error("Invalid character (* or ?) in hosts allow "
 216                                      "list (%s) for service %s.", entry, s)
 217                         valid = False
 218         return valid
 219
 220     def check_client_access(self, lp, logger, cname, caddr):
 221         # this is totally ugly, a real `quick' hack
 222         for s in lp.services():
 223             if (self.allow_access(lp.get("hosts deny"), lp.get("hosts allow"), cname,
 224                                   caddr) and
 225                 self.allow_access(lp.get("hosts deny", s), lp.get("hosts allow", s),
 226                                   cname, caddr)):
 227                 logger.info("Allow connection from %s (%s) to %s", cname, caddr, s)
 228             else:
 229                 logger.info("Deny connection from %s (%s) to %s", cname, caddr, s)
 230
 231 ##   FIXME: We need support for smb.conf macros before this will work again
 232 ##
 233 ##    if (new_local_machine) {
 234 ##        set_local_machine_name(new_local_machine, True)
 235 ##    }
 236 #