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 # This program is free software; you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # This program is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 #
  22
  23 """Functions for setting up a Samba Schema."""
  24
  25 from base64 import b64encode
  26 from samba import read_and_sub_file, substitute_var, check_all_substituted
  27 from samba.dcerpc import security
  28 from samba.ms_schema import read_ms_schema
  29 from samba.ndr import ndr_pack
  30 from samba.samdb import SamDB
  31 from samba import dsdb
  32 from ldb import SCOPE_SUBTREE, SCOPE_ONELEVEL
  33 import os
  34
  35 def get_schema_descriptor(domain_sid, name_map={}):
  36     sddl = "O:SAG:SAD:AI(OA;;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;SA)" \
  37            "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
  38            "(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
  39            "(OA;;CR;1131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
  40            "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
  41            "(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
  42            "(OA;;CR;1131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
  43            "(A;CI;RPLCLORC;;;AU)" \
  44            "(A;CI;RPWPCRCCLCLORCWOWDSW;;;SA)" \
  45            "(A;CI;RPWPCRCCDCLCLORCWOWDSDDTSW;;;SY)" \
  46            "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
  47            "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ED)" \
  48            "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
  49            "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;BA)" \
  50            "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;ER)" \
  51            "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;ER)" \
  52            "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ER)" \
  53            "S:(AU;SA;WPCCDCWOWDSDDTSW;;;WD)" \
  54            "(AU;CISA;WP;;;WD)" \
  55            "(AU;SA;CR;;;BA)" \
  56            "(AU;SA;CR;;;DU)" \
  57            "(OU;SA;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;WD)" \
  58            "(OU;SA;CR;45ec5156-db7e-47bb-b53f-dbeb2d03c40f;;WD)"
  59     sec = security.descriptor.from_sddl(sddl, domain_sid)
  60     return ndr_pack(sec)
  61
  62
  63 class Schema(object):
  64
  65     def __init__(self, domain_sid, invocationid=None, schemadn=None,
  66                  files=None, override_prefixmap=None, additional_prefixmap=None):
  67         from samba.provision import setup_path
  68
  69         """Load schema for the SamDB from the AD schema files and
  70         samba4_schema.ldif
  71
  72         :param samdb: Load a schema into a SamDB.
  73         :param schemadn: DN of the schema
  74
  75         Returns the schema data loaded, to avoid double-parsing when then
  76         needing to add it to the db
  77         """
  78
  79         self.schemadn = schemadn
  80         # We need to have the am_rodc=False just to keep some warnings quiet -
  81         # this isn't a real SAM, so it's meaningless.
  82         self.ldb = SamDB(global_schema=False, am_rodc=False)
  83         if invocationid is not None:
  84             self.ldb.set_invocation_id(invocationid)
  85
  86         self.schema_data = read_ms_schema(
  87             setup_path('ad-schema/MS-AD_Schema_2K8_R2_Attributes.txt'),
  88             setup_path('ad-schema/MS-AD_Schema_2K8_R2_Classes.txt'))
  89
  90         if files is not None:
  91             for file in files:
  92                 self.schema_data += open(file, 'r').read()
  93
  94         self.schema_data = substitute_var(self.schema_data,
  95             {"SCHEMADN": schemadn})
  96         check_all_substituted(self.schema_data)
  97
  98         self.schema_dn_modify = read_and_sub_file(
  99             setup_path("provision_schema_basedn_modify.ldif"),
 100             {"SCHEMADN": schemadn})
 101
 102         descr = b64encode(get_schema_descriptor(domain_sid))
 103         self.schema_dn_add = read_and_sub_file(
 104             setup_path("provision_schema_basedn.ldif"),
 105             {"SCHEMADN": schemadn, "DESCRIPTOR": descr})
 106
 107         if override_prefixmap is not None:
 108             self.prefixmap_data = override_prefixmap
 109         else:
 110             self.prefixmap_data = open(setup_path("prefixMap.txt"), 'r').read()
 111
 112         if additional_prefixmap is not None:
 113             for map in additional_prefixmap:
 114                 self.prefixmap_data += "%s\n" % map
 115
 116         self.prefixmap_data = b64encode(self.prefixmap_data)
 117
 118         # We don't actually add this ldif, just parse it
 119         prefixmap_ldif = "dn: %s\nprefixMap:: %s\n\n" % (self.schemadn, self.prefixmap_data)
 120         self.set_from_ldif(prefixmap_ldif, self.schema_data, self.schemadn)
 121
 122     def set_from_ldif(self, pf, df, dn):
 123         dsdb._dsdb_set_schema_from_ldif(self.ldb, pf, df, dn)
 124
 125     def write_to_tmp_ldb(self, schemadb_path):
 126         self.ldb.connect(url=schemadb_path)
 127         self.ldb.transaction_start()
 128         try:
 129             self.ldb.add_ldif("""dn: @ATTRIBUTES
 130 linkID: INTEGER
 131
 132 dn: @INDEXLIST
 133 @IDXATTR: linkID
 134 @IDXATTR: attributeSyntax
 135 """)
 136             # These bits of LDIF are supplied when the Schema object is created
 137             self.ldb.add_ldif(self.schema_dn_add)
 138             self.ldb.modify_ldif(self.schema_dn_modify)
 139             self.ldb.add_ldif(self.schema_data)
 140         except:
 141             self.ldb.transaction_cancel()
 142             raise
 143         else:
 144             self.ldb.transaction_commit()
 145
 146     # Return a hash with the forward attribute as a key and the back as the
 147     # value
 148     def linked_attributes(self):
 149         return get_linked_attributes(self.schemadn, self.ldb)
 150
 151     def dnsyntax_attributes(self):
 152         return get_dnsyntax_attributes(self.schemadn, self.ldb)
 153
 154     def convert_to_openldap(self, target, mapping):
 155         return dsdb._dsdb_convert_schema_to_openldap(self.ldb, target, mapping)
 156
 157
 158 # Return a hash with the forward attribute as a key and the back as the value
 159 def get_linked_attributes(schemadn,schemaldb):
 160     attrs = ["linkID", "lDAPDisplayName"]
 161     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)
 162     attributes = {}
 163     for i in range (0, len(res)):
 164         expression = "(&(objectclass=attributeSchema)(linkID=%d)(attributeSyntax=2.5.5.1))" % (int(res[i]["linkID"][0])+1)
 165         target = schemaldb.searchone(basedn=schemadn,
 166                                      expression=expression,
 167                                      attribute="lDAPDisplayName",
 168                                      scope=SCOPE_SUBTREE)
 169         if target is not None:
 170             attributes[str(res[i]["lDAPDisplayName"])]=str(target)
 171
 172     return attributes
 173
 174
 175 def get_dnsyntax_attributes(schemadn,schemaldb):
 176     res = schemaldb.search(
 177         expression="(&(!(linkID=*))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))",
 178         base=schemadn, scope=SCOPE_ONELEVEL,
 179         attrs=["linkID", "lDAPDisplayName"])
 180     attributes = []
 181     for i in range (0, len(res)):
 182         attributes.append(str(res[i]["lDAPDisplayName"]))
 183     return attributes
 184
 185
 186 def ldb_with_schema(schemadn="cn=schema,cn=configuration,dc=example,dc=com",
 187                     domainsid=None,
 188                     override_prefixmap=None):
 189     """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
 190
 191     :param schemadn: DN of the schema
 192     :param serverdn: DN of the server
 193
 194     Returns the schema data loaded as an object, with .ldb being a
 195     new ldb with the schema loaded.  This allows certain tests to
 196     operate without a remote or local schema.
 197     """
 198
 199     if domainsid is None:
 200         domainsid = security.random_sid()
 201     else:
 202         domainsid = security.dom_sid(domainsid)
 203     return Schema(domainsid, schemadn=schemadn,
 204         override_prefixmap=override_prefixmap)