source4/scripting/python/samba/schema.py

   1 #
   2 # Unix SMB/CIFS implementation.
   3 # backend code for provisioning a Samba4 server
   4 #
   5 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
   6 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2008-2009
   7 # Copyright (C) Oliver Liebel <oliver@itc.li> 2008-2009
   8 #
   9 # Based on the original in EJS:
  10 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
  11 #
  12 # This program is free software; you can redistribute it and/or modify
  13 # it under the terms of the GNU General Public License as published by
  14 # the Free Software Foundation; either version 3 of the License, or
  15 # (at your option) any later version.
  16 #
  17 # This program is distributed in the hope that it will be useful,
  18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 # GNU General Public License for more details.
  21 #
  22 # You should have received a copy of the GNU General Public License
  23 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25
  26 """Functions for setting up a Samba Schema."""
  27
  28 from base64 import b64encode
  29 from ms_schema import read_ms_schema
  30 from samba.dcerpc import security
  31 from samba import read_and_sub_file, substitute_var, check_all_substituted
  32 from samba import Ldb
  33 from samba.ndr import ndr_pack
  34 from ldb import SCOPE_SUBTREE, SCOPE_ONELEVEL, SCOPE_BASE
  35 import os
  36
  37 def get_schema_descriptor(domain_sid):
  38     sddl = "O:SAG:SAD:(A;CI;RPLCLORC;;;AU)(A;CI;RPWPCRCCLCLORCWOWDSW;;;SA)" \
  39            "(A;CI;RPWPCRCCDCLCLORCWOWDSDDTSW;;;SY)" \
  40            "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
  41            "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ED)" \
  42            "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
  43            "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;BA)" \
  44            "S:(AU;SA;WPCCDCWOWDSDDTSW;;;WD)" \
  45            "(AU;CISA;WP;;;WD)(AU;SA;CR;;;BA)" \
  46            "(AU;SA;CR;;;DU)(OU;SA;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;WD)" \
  47            "(OU;SA;CR;45ec5156-db7e-47bb-b53f-dbeb2d03c40f;;WD)"
  48     sec = security.descriptor.from_sddl(sddl, domain_sid)
  49     return ndr_pack(sec)
  50
  51
  52 class Schema(object):
  53     def __init__(self, setup_path, domain_sid, schemadn=None,
  54                  serverdn=None, files=None, prefixmap=None):
  55         """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
  56
  57         :param samdb: Load a schema into a SamDB.
  58         :param setup_path: Setup path function.
  59         :param schemadn: DN of the schema
  60         :param serverdn: DN of the server
  61
  62         Returns the schema data loaded, to avoid double-parsing when then needing to add it to the db
  63         """
  64
  65         self.schemadn = schemadn
  66         self.ldb = Ldb()
  67         self.schema_data = read_ms_schema(setup_path('ad-schema/MS-AD_Schema_2K8_R2_Attributes.txt'),
  68                                           setup_path('ad-schema/MS-AD_Schema_2K8_R2_Classes.txt'))
  69
  70         if files is not None:
  71             for file in files:
  72                 self.schema_data += open(file, 'r').read()
  73
  74         self.schema_data = substitute_var(self.schema_data, {"SCHEMADN": schemadn})
  75         check_all_substituted(self.schema_data)
  76
  77         self.schema_dn_modify = read_and_sub_file(setup_path("provision_schema_basedn_modify.ldif"),
  78                                                   {"SCHEMADN": schemadn,
  79                                                    "SERVERDN": serverdn,
  80                                                    })
  81
  82         descr = b64encode(get_schema_descriptor(domain_sid))
  83         self.schema_dn_add = read_and_sub_file(setup_path("provision_schema_basedn.ldif"),
  84                                                {"SCHEMADN": schemadn,
  85                                                 "DESCRIPTOR": descr
  86                                                 })
  87
  88         self.prefixmap_data = open(setup_path("prefixMap.txt"), 'r').read()
  89
  90         if prefixmap is not None:
  91             for map in prefixmap:
  92                 self.prefixmap_data += "%s\n" % map
  93
  94         self.prefixmap_data = b64encode(self.prefixmap_data)
  95
  96
  97
  98         # We don't actually add this ldif, just parse it
  99         prefixmap_ldif = "dn: cn=schema\nprefixMap:: %s\n\n" % self.prefixmap_data
 100         self.ldb.set_schema_from_ldif(prefixmap_ldif, self.schema_data)
 101
 102     def write_to_tmp_ldb(self, schemadb_path):
 103         self.ldb.connect(schemadb_path)
 104         self.ldb.transaction_start()
 105
 106         self.ldb.add_ldif("""dn: @ATTRIBUTES
 107 linkID: INTEGER
 108
 109 dn: @INDEXLIST
 110 @IDXATTR: linkID
 111 @IDXATTR: attributeSyntax
 112 """)
 113         # These bits of LDIF are supplied when the Schema object is created
 114         self.ldb.add_ldif(self.schema_dn_add)
 115         self.ldb.modify_ldif(self.schema_dn_modify)
 116         self.ldb.add_ldif(self.schema_data)
 117         self.ldb.transaction_commit()
 118
 119     # Return a hash with the forward attribute as a key and the back as the value
 120     def linked_attributes(self):
 121         return get_linked_attributes(self.schemadn, self.ldb)
 122
 123     def dnsyntax_attributes(self):
 124         return get_dnsyntax_attributes(self.schemadn, self.ldb)
 125
 126 # Return a hash with the forward attribute as a key and the back as the value
 127 def get_linked_attributes(schemadn,schemaldb):
 128     attrs = ["linkID", "lDAPDisplayName"]
 129     res = schemaldb.search(expression="(&(linkID=*)(!(linkID:1.2.840.113556.1.4.803:=1))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))", base=schemadn, scope=SCOPE_ONELEVEL, attrs=attrs)
 130     attributes = {}
 131     for i in range (0, len(res)):
 132         expression = "(&(objectclass=attributeSchema)(linkID=%d)(attributeSyntax=2.5.5.1))" % (int(res[i]["linkID"][0])+1)
 133         target = schemaldb.searchone(basedn=schemadn,
 134                                      expression=expression,
 135                                      attribute="lDAPDisplayName",
 136                                      scope=SCOPE_SUBTREE)
 137         if target is not None:
 138             attributes[str(res[i]["lDAPDisplayName"])]=str(target)
 139
 140     return attributes
 141
 142 def get_dnsyntax_attributes(schemadn,schemaldb):
 143     attrs = ["linkID", "lDAPDisplayName"]
 144     res = schemaldb.search(expression="(&(!(linkID=*))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))", base=schemadn, scope=SCOPE_ONELEVEL, attrs=attrs)
 145     attributes = []
 146     for i in range (0, len(res)):
 147         attributes.append(str(res[i]["lDAPDisplayName"]))
 148
 149     return attributes
 150
 151 def ldb_with_schema(setup_dir=None, schemadn="cn=schema,cn=configuration,dc=example,dc=com",
 152                     serverdn="cn=server,cn=servers,cn=default-first-site-name,cn=sites,cn=cn=configuration,dc=example,dc=com",
 153                     domainsid=None):
 154     """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
 155
 156     :param setup_dir: Setup path
 157     :param schemadn: DN of the schema
 158     :param serverdn: DN of the server
 159
 160     Returns the schema data loaded as an object, with .ldb being a
 161     new ldb with the schema loaded.  This allows certain tests to
 162     operate without a remote or local schema.
 163     """
 164
 165     def setup_path(file):
 166         return os.path.join(setup_dir, file)
 167
 168     if domainsid is None:
 169         domainsid = security.random_sid()
 170     else:
 171         domainsid = security.dom_sid(domainsid)
 172     return Schema(setup_path, domainsid, schemadn=schemadn, serverdn=serverdn)