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 import os
  36 from samba.credentials import DONT_USE_KERBEROS
  37 from samba.auth import system_session
  38 import samba.getopt as options
  39 from samba.provision import (
  40     provision,
  41     FILL_FULL,
  42     FILL_NT4SYNC,
  43     FILL_DRS,
  44     ProvisioningError,
  45     )
  46 from samba.dsdb import (
  47     DS_DOMAIN_FUNCTION_2000,
  48     DS_DOMAIN_FUNCTION_2003,
  49     DS_DOMAIN_FUNCTION_2008,
  50     DS_DOMAIN_FUNCTION_2008_R2,
  51     )
  52
  53 # how do we make this case insensitive??
  54
  55 parser = optparse.OptionParser("provision [options]")
  56 sambaopts = options.SambaOptions(parser)
  57 parser.add_option_group(sambaopts)
  58 parser.add_option_group(options.VersionOptions(parser))
  59 credopts = options.CredentialsOptions(parser)
  60 parser.add_option_group(credopts)
  61 parser.add_option("--interactive", help="Ask for names", action="store_true")
  62 parser.add_option("--domain", type="string", metavar="DOMAIN",
  63                   help="set domain")
  64 parser.add_option("--domain-guid", type="string", metavar="GUID",
  65         help="set domainguid (otherwise random)")
  66 parser.add_option("--domain-sid", type="string", metavar="SID",
  67         help="set domainsid (otherwise random)")
  68 parser.add_option("--ntds-guid", type="string", metavar="GUID",
  69           help="set NTDS object GUID (otherwise random)")
  70 parser.add_option("--invocationid", type="string", metavar="GUID",
  71           help="set invocationid (otherwise random)")
  72 parser.add_option("--host-name", type="string", metavar="HOSTNAME",
  73         help="set hostname")
  74 parser.add_option("--host-ip", type="string", metavar="IPADDRESS",
  75         help="set IPv4 ipaddress")
  76 parser.add_option("--host-ip6", type="string", metavar="IP6ADDRESS",
  77         help="set IPv6 ipaddress")
  78 parser.add_option("--adminpass", type="string", metavar="PASSWORD",
  79         help="choose admin password (otherwise random)")
  80 parser.add_option("--krbtgtpass", type="string", metavar="PASSWORD",
  81         help="choose krbtgt password (otherwise random)")
  82 parser.add_option("--machinepass", type="string", metavar="PASSWORD",
  83         help="choose machine password (otherwise random)")
  84 parser.add_option("--dns-backend", type="choice", metavar="NAMESERVER-BACKEND",
  85           choices=["SAMBA_INTERNAL", "BIND9_FLATFILE", "BIND9_DLZ", "NONE"],
  86         help="The DNS server backend. SAMBA_INTERNAL is the builtin name server, " \
  87              "BIND9_FLATFILE uses bind9 text database to store zone information, " \
  88              "BIND9_DLZ uses samba4 AD to store zone information (default), " \
  89              "NONE skips the DNS setup entirely (not recommended)",
  90         default="BIND9_DLZ")
  91 parser.add_option("--dnspass", type="string", metavar="PASSWORD",
  92         help="choose dns password (otherwise random)")
  93 parser.add_option("--ldapadminpass", type="string", metavar="PASSWORD",
  94         help="choose password to set between Samba and it's LDAP backend (otherwise random)")
  95 parser.add_option("--root", type="string", metavar="USERNAME",
  96         help="choose 'root' unix username")
  97 parser.add_option("--nobody", type="string", metavar="USERNAME",
  98         help="choose 'nobody' user")
  99 parser.add_option("--wheel", type="string", metavar="GROUPNAME",
 100         help="choose 'wheel' privileged group")
 101 parser.add_option("--users", type="string", metavar="GROUPNAME",
 102         help="choose 'users' group")
 103 parser.add_option("--quiet", help="Be quiet", action="store_true")
 104 parser.add_option("--blank", action="store_true",
 105         help="do not add users or groups, just the structure")
 106 parser.add_option("--ldap-backend-type", type="choice", metavar="LDAP-BACKEND-TYPE",
 107         help="Test initialisation support for unsupported LDAP backend type (fedora-ds or openldap) DO NOT USE",
 108         choices=["fedora-ds", "openldap"])
 109 parser.add_option("--server-role", type="choice", metavar="ROLE",
 110           choices=["domain controller", "dc", "member server", "member", "standalone"],
 111         help="The server role (domain controller | dc | member server | member | standalone). Default is dc.",
 112         default="domain controller")
 113 parser.add_option("--function-level", type="choice", metavar="FOR-FUN-LEVEL",
 114           choices=["2000", "2003", "2008", "2008_R2"],
 115         help="The domain and forest function level (2000 | 2003 | 2008 | 2008_R2 - always native). Default is (Windows) 2003 Native.",
 116         default="2003")
 117 parser.add_option("--next-rid", type="int", metavar="NEXTRID", default=1000,
 118         help="The initial nextRid value (only needed for upgrades).  Default is 1000.")
 119 parser.add_option("--partitions-only",
 120         help="Configure Samba's partitions, but do not modify them (ie, join a BDC)", action="store_true")
 121 parser.add_option("--targetdir", type="string", metavar="DIR",
 122                   help="Set target directory")
 123 parser.add_option("--ol-mmr-urls", type="string", metavar="LDAPSERVER",
 124                 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\"")
 125 parser.add_option("--slapd-path", type="string", metavar="SLAPD-PATH",
 126         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.")
 127 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")
 128 parser.add_option("--use-s3fs", action="store_true", help="Use s3fs for the fileserver (default = no)")
 129
 130 opts = parser.parse_args()[0]
 131
 132 logger = logging.getLogger("provision")
 133 logger.addHandler(logging.StreamHandler(sys.stdout))
 134 if opts.quiet:
 135     logger.setLevel(logging.WARNING)
 136 else:
 137     logger.setLevel(logging.INFO)
 138
 139 if len(sys.argv) == 1:
 140     opts.interactive = True
 141
 142 if opts.interactive:
 143     from getpass import getpass
 144     import socket
 145
 146     def ask(prompt, default=None):
 147         if default is not None:
 148             print "%s [%s]: " % (prompt, default),
 149         else:
 150             print "%s: " % (prompt,),
 151         return sys.stdin.readline().rstrip("\n") or default
 152     try:
 153         default = socket.getfqdn().split(".", 1)[1].upper()
 154     except IndexError:
 155         default = None
 156     opts.realm = ask("Realm", default)
 157     if opts.realm in (None, ""):
 158         print >>sys.stderr, "No realm set!"
 159         sys.exit(1)
 160
 161     try:
 162         default = opts.realm.split(".")[0]
 163     except IndexError:
 164         default = None
 165     opts.domain = ask("Domain", default)
 166     if opts.domain is None:
 167         print >> sys.stderr, "No domain set!"
 168         sys.exit(1)
 169
 170     opts.server_role = ask("Server Role (dc, member, standalone)", "dc")
 171     while True:
 172         adminpass = getpass("Administrator password: ")
 173         if not adminpass:
 174             print >>sys.stderr, "Invalid administrator password."
 175         else:
 176             adminpassverify = getpass("Retype password: ")
 177             if not adminpass == adminpassverify:
 178                 print >>sys.stderr, "Sorry, passwords do not match."
 179             else:
 180                 opts.adminpass = adminpass
 181                 break
 182
 183 else:
 184     if opts.realm in (None, ""):
 185         opts.realm = sambaopts._lp.get('realm')
 186     if opts.realm is None or opts.domain is None:
 187         if opts.realm is None:
 188             print >>sys.stderr, "No realm set!"
 189         if opts.domain is None:
 190             print >> sys.stderr, "No domain set!"
 191         parser.print_usage()
 192         sys.exit(1)
 193
 194 if not opts.adminpass:
 195     logger.info("Administrator password will be set randomly!")
 196
 197 lp = sambaopts.get_loadparm()
 198 smbconf = lp.configfile
 199
 200 if opts.function_level == "2000":
 201     dom_for_fun_level = DS_DOMAIN_FUNCTION_2000
 202 elif opts.function_level == "2003":
 203     dom_for_fun_level = DS_DOMAIN_FUNCTION_2003
 204 elif opts.function_level == "2008":
 205     dom_for_fun_level = DS_DOMAIN_FUNCTION_2008
 206 elif opts.function_level == "2008_R2":
 207     dom_for_fun_level = DS_DOMAIN_FUNCTION_2008_R2
 208
 209 creds = credopts.get_credentials(lp)
 210
 211 creds.set_kerberos_state(DONT_USE_KERBEROS)
 212
 213 samdb_fill = FILL_FULL
 214 if opts.blank:
 215     samdb_fill = FILL_NT4SYNC
 216 elif opts.partitions_only:
 217     samdb_fill = FILL_DRS
 218
 219 if opts.targetdir is not None:
 220     if not os.path.isdir(opts.targetdir):
 221         os.mkdir(opts.targetdir)
 222
 223 eadb = True
 224
 225 if opts.use_xattrs == "yes":
 226     eadb = False
 227 elif opts.use_xattrs == "auto" and not lp.get("posix:eadb"):
 228     if opts.targetdir:
 229         file = tempfile.NamedTemporaryFile(dir=os.path.abspath(opts.targetdir))
 230     else:
 231         file = tempfile.NamedTemporaryFile(dir=os.path.abspath(os.path.dirname(lp.get("private dir"))))
 232     try:
 233         try:
 234             samba.ntacls.setntacl(lp, file.name,
 235                                   "O:S-1-5-32G:S-1-5-32", "S-1-5-32", "native")
 236             eadb = False
 237         except Exception:
 238             logger.info("You are not root or your system do not support xattr, using tdb backend for attributes. ")
 239     finally:
 240         file.close()
 241
 242 if eadb:
 243     logger.info("not using extended attributes to store ACLs and other metadata. If you intend to use this provision in production, rerun the script as root on a system supporting xattrs.")
 244
 245 session = system_session()
 246 try:
 247     result = provision(logger,
 248           session, creds, smbconf=smbconf, targetdir=opts.targetdir,
 249           samdb_fill=samdb_fill, realm=opts.realm, domain=opts.domain,
 250           domainguid=opts.domain_guid, domainsid=opts.domain_sid,
 251           hostname=opts.host_name,
 252           hostip=opts.host_ip, hostip6=opts.host_ip6,
 253           ntdsguid=opts.ntds_guid,
 254           invocationid=opts.invocationid, adminpass=opts.adminpass,
 255           krbtgtpass=opts.krbtgtpass, machinepass=opts.machinepass,
 256           dns_backend=opts.dns_backend,
 257           dnspass=opts.dnspass, root=opts.root, nobody=opts.nobody,
 258           wheel=opts.wheel, users=opts.users,
 259           serverrole=opts.server_role, dom_for_fun_level=dom_for_fun_level,
 260           backend_type=opts.ldap_backend_type,
 261           ldapadminpass=opts.ldapadminpass, ol_mmr_urls=opts.ol_mmr_urls,
 262           slapd_path=opts.slapd_path,
 263           useeadb=eadb, next_rid=opts.next_rid, lp=lp, use_ntvfs=(not opts.use_s3fs))
 264 except ProvisioningError, e:
 265     print str(e)
 266     sys.exit(1)
 267
 268 result.report_logger(logger)