source4/setup/provision

   1 #!/usr/bin/env python
   2 #
   3 # Unix SMB/CIFS implementation.
   4 # provision a Samba4 server
   5 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
   6 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2008
   7 #
   8 # Based on the original in EJS:
   9 # Copyright (C) Andrew Tridgell 2005
  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
  25 import logging
  26 import optparse
  27 import sys
  28 import tempfile
  29
  30 # Find right directory when running from source tree
  31 sys.path.insert(0, "bin/python")
  32
  33 import samba
  34 import samba.ntacls
  35 from samba.credentials import DONT_USE_KERBEROS
  36 from samba.auth import system_session
  37 import samba.getopt as options
  38 from samba.provision import provision, FILL_FULL, FILL_NT4SYNC, FILL_DRS, ProvisioningError
  39 from samba.dsdb import (
  40         DS_DOMAIN_FUNCTION_2000,
  41         DS_DOMAIN_FUNCTION_2003,
  42         DS_DOMAIN_FUNCTION_2008,
  43         DS_DOMAIN_FUNCTION_2008_R2,
  44         )
  45
  46 # how do we make this case insensitive??
  47
  48 parser = optparse.OptionParser("provision [options]")
  49 sambaopts = options.SambaOptions(parser)
  50 parser.add_option_group(sambaopts)
  51 parser.add_option_group(options.VersionOptions(parser))
  52 credopts = options.CredentialsOptions(parser)
  53 parser.add_option_group(credopts)
  54 parser.add_option("--interactive", help="Ask for names", action="store_true")
  55 parser.add_option("--domain", type="string", metavar="DOMAIN",
  56                                   help="set domain")
  57 parser.add_option("--domain-guid", type="string", metavar="GUID",
  58                 help="set domainguid (otherwise random)")
  59 parser.add_option("--domain-sid", type="string", metavar="SID",
  60                 help="set domainsid (otherwise random)")
  61 parser.add_option("--ntds-guid", type="string", metavar="GUID",
  62                   help="set NTDS object GUID (otherwise random)")
  63 parser.add_option("--invocationid", type="string", metavar="GUID",
  64                   help="set invocationid (otherwise random)")
  65 parser.add_option("--host-name", type="string", metavar="HOSTNAME",
  66                 help="set hostname")
  67 parser.add_option("--host-ip", type="string", metavar="IPADDRESS",
  68                 help="set IPv4 ipaddress")
  69 parser.add_option("--host-ip6", type="string", metavar="IP6ADDRESS",
  70                 help="set IPv6 ipaddress")
  71 parser.add_option("--adminpass", type="string", metavar="PASSWORD",
  72                 help="choose admin password (otherwise random)")
  73 parser.add_option("--krbtgtpass", type="string", metavar="PASSWORD",
  74                 help="choose krbtgt password (otherwise random)")
  75 parser.add_option("--machinepass", type="string", metavar="PASSWORD",
  76                 help="choose machine password (otherwise random)")
  77 parser.add_option("--dns-backend", type="choice", metavar="NAMESERVER-BACKEND",
  78                   choices=["SAMBA", "BIND9", "BIND9_DLZ"],
  79         help="The DNS server backend. SAMBA is the builtin name server (experimental), BIND9 uses bind9 text database to store zone information (default), BIND9_DLZ uses samba4 AD to store zone information (recommended)")
  80 parser.add_option("--dnspass", type="string", metavar="PASSWORD",
  81                 help="choose dns password (otherwise random)")
  82 parser.add_option("--ldapadminpass", type="string", metavar="PASSWORD",
  83                 help="choose password to set between Samba and it's LDAP backend (otherwise random)")
  84 parser.add_option("--root", type="string", metavar="USERNAME",
  85                 help="choose 'root' unix username")
  86 parser.add_option("--nobody", type="string", metavar="USERNAME",
  87                 help="choose 'nobody' user")
  88 parser.add_option("--wheel", type="string", metavar="GROUPNAME",
  89                 help="choose 'wheel' privileged group")
  90 parser.add_option("--users", type="string", metavar="GROUPNAME",
  91                 help="choose 'users' group")
  92 parser.add_option("--quiet", help="Be quiet", action="store_true")
  93 parser.add_option("--blank", action="store_true",
  94                 help="do not add users or groups, just the structure")
  95 parser.add_option("--ldap-backend-extra-port", type="int", metavar="LDAP-BACKEND-EXTRA-PORT",
  96                 help="Additional TCP port for LDAP backend server (to use for replication)")
  97 parser.add_option("--ldap-backend-forced-uri", type="string", metavar="LDAP-BACKEND-FORCED-URI",
  98                 help="Force the LDAP backend connection to be to a particular URI.  Use this ONLY for 'existing' backends, or when debugging the interaction with the LDAP backend and you need to intercept the LDAP traffic")
  99 parser.add_option("--ldap-backend-type", type="choice", metavar="LDAP-BACKEND-TYPE",
 100                 help="LDAP backend type (fedora-ds or openldap)",
 101                 choices=["fedora-ds", "openldap"])
 102 parser.add_option("--ldap-backend-nosync", help="Configure LDAP backend not to call fsync() (for performance in test environments)", action="store_true")
 103 parser.add_option("--server-role", type="choice", metavar="ROLE",
 104                   choices=["domain controller", "dc", "member server", "member", "standalone"],
 105                 help="The server role (domain controller | dc | member server | member | standalone). Default is standalone.")
 106 parser.add_option("--function-level", type="choice", metavar="FOR-FUN-LEVEL",
 107                   choices=["2000", "2003", "2008", "2008_R2"],
 108                 help="The domain and forest function level (2000 | 2003 | 2008 | 2008_R2 - always native). Default is (Windows) 2003 Native.")
 109 parser.add_option("--next-rid", type="int", metavar="NEXTRID", default=1000,
 110                 help="The initial nextRid value (only needed for upgrades).  Default is 1000.")
 111 parser.add_option("--partitions-only",
 112                 help="Configure Samba's partitions, but do not modify them (ie, join a BDC)", action="store_true")
 113 parser.add_option("--targetdir", type="string", metavar="DIR",
 114                           help="Set target directory")
 115 parser.add_option("--ol-mmr-urls", type="string", metavar="LDAPSERVER",
 116                 help="List of LDAP-URLS [ ldap://<FQHN>:<PORT>/  (where <PORT> has to be different than 389!) ] separated with comma (\",\") for use with OpenLDAP-MMR (Multi-Master-Replication), e.g.: \"ldap://s4dc1:9000,ldap://s4dc2:9000\"")
 117 parser.add_option("--slapd-path", type="string", metavar="SLAPD-PATH",
 118                 help="Path to slapd for LDAP backend [e.g.:'/usr/local/libexec/slapd']. Required for Setup with LDAP-Backend. OpenLDAP Version >= 2.4.17 should be used.")
 119 parser.add_option("--setup-ds-path", type="string", metavar="SETUP_DS-PATH",
 120                 help="Path to setup-ds.pl script for Fedora DS LDAP backend [e.g.:'/usr/sbin/setup-ds.pl']. Required for Setup with Fedora DS backend.")
 121 parser.add_option("--use-xattrs", type="choice", choices=["yes","no","auto"], help="Define if we should use the native fs capabilities or a tdb file for storing attributes likes ntacl, auto tries to make an inteligent guess based on the user rights and system capabilities", default="auto")
 122 parser.add_option("--ldap-dryrun-mode", help="Configure LDAP backend, but do not run any binaries and exit early.  Used only for the test environment.  DO NOT USE", action="store_true")
 123
 124 opts = parser.parse_args()[0]
 125
 126 logger = logging.getLogger("provision")
 127 logger.addHandler(logging.StreamHandler(sys.stdout))
 128 if opts.quiet:
 129         logger.setLevel(logging.WARNING)
 130 else:
 131         logger.setLevel(logging.INFO)
 132
 133 if len(sys.argv) == 1:
 134         opts.interactive = True
 135
 136 if opts.interactive:
 137         from getpass import getpass
 138         import socket
 139         def ask(prompt, default=None):
 140                 if default is not None:
 141                         print "%s [%s]: " % (prompt,default),
 142                 else:
 143                         print "%s: " % (prompt,),
 144                 return sys.stdin.readline().rstrip("\n") or default
 145         try:
 146                 default = socket.getfqdn().split(".", 1)[1].upper()
 147         except IndexError:
 148                 default = None
 149         opts.realm = ask("Realm", default)
 150         if opts.realm in (None, ""):
 151                 print >>sys.stderr, "No realm set!"
 152                 sys.exit(1)
 153
 154         try:
 155                 default = opts.realm.split(".")[0]
 156         except IndexError:
 157                 default = None
 158         opts.domain = ask("Domain", default)
 159         if opts.domain is None:
 160                 print >> sys.stderr, "No domain set!"
 161                 sys.exit(1)
 162
 163         opts.server_role = ask("Server Role (dc, member, standalone)", "dc")
 164         for i in range(3):
 165                 opts.adminpass = getpass("Administrator password: ")
 166                 if not opts.adminpass:
 167                         print >>sys.stderr, "Invalid administrator password."
 168                 else:
 169                         break
 170 else:
 171         if opts.realm in (None, ""):
 172                 opts.realm = sambaopts._lp.get('realm')
 173         if opts.realm is None or opts.domain is None:
 174                 if opts.realm is None:
 175                         print >>sys.stderr, "No realm set!"
 176                 if opts.domain is None:
 177                         print >> sys.stderr, "No domain set!"
 178                 parser.print_usage()
 179                 sys.exit(1)
 180
 181 if not opts.adminpass:
 182         logger.info("Administrator password will be set randomly!")
 183
 184 lp = sambaopts.get_loadparm()
 185 smbconf = lp.configfile
 186
 187 if opts.server_role == "dc":
 188         server_role = "domain controller"
 189 elif opts.server_role == "member":
 190         server_role = "member server"
 191 else:
 192         server_role = opts.server_role
 193
 194 if opts.function_level is None:
 195         dom_for_fun_level = None
 196 elif opts.function_level == "2000":
 197         dom_for_fun_level = DS_DOMAIN_FUNCTION_2000
 198 elif opts.function_level == "2003":
 199         dom_for_fun_level = DS_DOMAIN_FUNCTION_2003
 200 elif opts.function_level == "2008":
 201         dom_for_fun_level = DS_DOMAIN_FUNCTION_2008
 202 elif opts.function_level == "2008_R2":
 203         dom_for_fun_level = DS_DOMAIN_FUNCTION_2008_R2
 204
 205 creds = credopts.get_credentials(lp)
 206
 207 creds.set_kerberos_state(DONT_USE_KERBEROS)
 208
 209 samdb_fill = FILL_FULL
 210 if opts.blank:
 211     samdb_fill = FILL_NT4SYNC
 212 elif opts.partitions_only:
 213     samdb_fill = FILL_DRS
 214
 215 eadb = True
 216 if opts.use_xattrs == "yes":
 217         eadb = False
 218 elif opts.use_xattrs == "auto" and not lp.get("posix:eadb"):
 219         file = tempfile.NamedTemporaryFile()
 220         try:
 221                 samba.ntacls.setntacl(lp, file.name,
 222                         "O:S-1-5-32G:S-1-5-32", "S-1-5-32", "native")
 223                 eadb = False
 224         except:
 225                 logger.info("You are not root or your system do not support xattr, using tdb backend for attributes. "
 226                             "If you intend to use this provision in production, rerun the script as root on a system supporting xattrs.")
 227         file.close()
 228
 229
 230 if opts.ldap_backend_type == "existing":
 231         if opts.ldap_backend_forced_uri is not None:
 232                 logger.warn("You have specified to use an existing LDAP server as the backend, please make sure an LDAP server is running at %s" % opts.ldap_backend_forced_uri)
 233         else:
 234                 logger.info("You have specified to use an existing LDAP server as the backend, please make sure an LDAP server is running at the default location")
 235 else:
 236         if opts.ldap_backend_forced_uri is not None:
 237                 logger.warn("You have specified to use an fixed URI %s for connecting to your LDAP server backend.  This is NOT RECOMMENDED, as our default communiation over ldapi:// is more secure and much less prone to unexpected failure or interaction" % opts.ldap_backend_forced_uri)
 238
 239 session = system_session()
 240 try:
 241         provision(logger,
 242                   session, creds, smbconf=smbconf, targetdir=opts.targetdir,
 243                   samdb_fill=samdb_fill, realm=opts.realm, domain=opts.domain,
 244                   domainguid=opts.domain_guid, domainsid=opts.domain_sid,
 245                   hostname=opts.host_name,
 246                   hostip=opts.host_ip, hostip6=opts.host_ip6,
 247                   ntdsguid=opts.ntds_guid,
 248                   invocationid=opts.invocationid, adminpass=opts.adminpass,
 249                   krbtgtpass=opts.krbtgtpass, machinepass=opts.machinepass,
 250                   dns_backend=opts.dns_backend,
 251                   dnspass=opts.dnspass, root=opts.root, nobody=opts.nobody,
 252                   wheel=opts.wheel, users=opts.users,
 253                   serverrole=server_role, dom_for_fun_level=dom_for_fun_level,
 254                   ldap_backend_extra_port=opts.ldap_backend_extra_port,
 255                   ldap_backend_forced_uri=opts.ldap_backend_forced_uri,
 256                   backend_type=opts.ldap_backend_type,
 257                   ldapadminpass=opts.ldapadminpass, ol_mmr_urls=opts.ol_mmr_urls,
 258                   slapd_path=opts.slapd_path, setup_ds_path=opts.setup_ds_path,
 259                   nosync=opts.ldap_backend_nosync, ldap_dryrun_mode=opts.ldap_dryrun_mode,
 260                   useeadb=eadb, next_rid=opts.next_rid, lp=lp)
 261 except ProvisioningError, e:
 262         print str(e)
 263         sys.exit(1)