PEP8: fix E203: whitespace before ':'
[nivanova/samba-autobuild/.git] / 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     # the schema files (and corresponding object version) that we know about
66     base_schemas = {
67         "2008_R2_old": ("MS-AD_Schema_2K8_R2_Attributes.txt",
68                          "MS-AD_Schema_2K8_R2_Classes.txt",
69                          47),
70        "2008_R2": ("Attributes_for_AD_DS__Windows_Server_2008_R2.ldf",
71                     "Classes_for_AD_DS__Windows_Server_2008_R2.ldf",
72                     47),
73        "2012": ("AD_DS_Attributes__Windows_Server_2012.ldf",
74                     "AD_DS_Classes__Windows_Server_2012.ldf",
75                     56),
76        "2012_R2": ("AD_DS_Attributes__Windows_Server_2012_R2.ldf",
77                     "AD_DS_Classes__Windows_Server_2012_R2.ldf",
78                     69),
79     }
80
81     def __init__(self, domain_sid, invocationid=None, schemadn=None,
82                  files=None, override_prefixmap=None, additional_prefixmap=None,
83                  base_schema=None):
84         from samba.provision import setup_path
85
86         """Load schema for the SamDB from the AD schema files and
87         samba4_schema.ldif
88
89         :param samdb: Load a schema into a SamDB.
90         :param schemadn: DN of the schema
91
92         Returns the schema data loaded, to avoid double-parsing when then
93         needing to add it to the db
94         """
95
96         if base_schema is None:
97             base_schema = Schema.default_base_schema()
98
99         self.base_schema = base_schema
100
101         self.schemadn = schemadn
102         # We need to have the am_rodc=False just to keep some warnings quiet -
103         # this isn't a real SAM, so it's meaningless.
104         self.ldb = SamDB(global_schema=False, am_rodc=False)
105         if invocationid is not None:
106             self.ldb.set_invocation_id(invocationid)
107
108         self.schema_data = read_ms_schema(
109             setup_path('ad-schema/%s' % Schema.base_schemas[base_schema][0]),
110             setup_path('ad-schema/%s' % Schema.base_schemas[base_schema][1]))
111
112         if files is not None:
113             for file in files:
114                 self.schema_data += open(file, 'r').read()
115
116         self.schema_data = substitute_var(self.schema_data,
117                                           {"SCHEMADN": schemadn})
118         check_all_substituted(self.schema_data)
119
120         schema_version = str(Schema.get_version(base_schema))
121         self.schema_dn_modify = read_and_sub_file(
122             setup_path("provision_schema_basedn_modify.ldif"),
123             {"SCHEMADN": schemadn, "OBJVERSION": schema_version})
124
125         descr = b64encode(get_schema_descriptor(domain_sid)).decode('utf8')
126         self.schema_dn_add = read_and_sub_file(
127             setup_path("provision_schema_basedn.ldif"),
128             {"SCHEMADN": schemadn, "DESCRIPTOR": descr})
129
130         if override_prefixmap is not None:
131             self.prefixmap_data = override_prefixmap
132         else:
133             self.prefixmap_data = open(setup_path("prefixMap.txt"), 'r').read()
134
135         if additional_prefixmap is not None:
136             for map in additional_prefixmap:
137                 self.prefixmap_data += "%s\n" % map
138
139         self.prefixmap_data = b64encode(self.prefixmap_data).decode('utf8')
140
141         # We don't actually add this ldif, just parse it
142         prefixmap_ldif = "dn: %s\nprefixMap:: %s\n\n" % (self.schemadn, self.prefixmap_data)
143         self.set_from_ldif(prefixmap_ldif, self.schema_data, self.schemadn)
144
145     @staticmethod
146     def default_base_schema():
147         """Returns the default base schema to use"""
148         return "2008_R2"
149
150     @staticmethod
151     def get_version(base_schema):
152         """Returns the base schema's object version, e.g. 47 for 2008_R2"""
153         return Schema.base_schemas[base_schema][2]
154
155     def set_from_ldif(self, pf, df, dn):
156         dsdb._dsdb_set_schema_from_ldif(self.ldb, pf, df, dn)
157
158     def write_to_tmp_ldb(self, schemadb_path):
159         self.ldb.connect(url=schemadb_path)
160         self.ldb.transaction_start()
161         try:
162             # These are actually ignored, as the schema has been forced
163             # when the ldb object was created, and that overrides this
164             self.ldb.add_ldif("""dn: @ATTRIBUTES
165 linkID: INTEGER
166
167 dn: @INDEXLIST
168 @IDXATTR: linkID
169 @IDXATTR: attributeSyntax
170 @IDXGUID: objectGUID
171 """)
172
173             schema_dn_add = self.schema_dn_add \
174             + "objectGUID: 24e2ca70-b093-4ae8-84c0-2d7ac652a1b8\n"
175
176             # These bits of LDIF are supplied when the Schema object is created
177             self.ldb.add_ldif(schema_dn_add)
178             self.ldb.modify_ldif(self.schema_dn_modify)
179             self.ldb.add_ldif(self.schema_data)
180         except:
181             self.ldb.transaction_cancel()
182             raise
183         else:
184             self.ldb.transaction_commit()
185
186     # Return a hash with the forward attribute as a key and the back as the
187     # value
188     def linked_attributes(self):
189         return get_linked_attributes(self.schemadn, self.ldb)
190
191     def dnsyntax_attributes(self):
192         return get_dnsyntax_attributes(self.schemadn, self.ldb)
193
194     def convert_to_openldap(self, target, mapping):
195         return dsdb._dsdb_convert_schema_to_openldap(self.ldb, target, mapping)
196
197
198 # Return a hash with the forward attribute as a key and the back as the value
199 def get_linked_attributes(schemadn, schemaldb):
200     attrs = ["linkID", "lDAPDisplayName"]
201     res = schemaldb.search(
202         expression="(&(linkID=*)"
203                    "(!(linkID:1.2.840.113556.1.4.803:=1))"
204                    "(objectclass=attributeSchema)"
205                    "(attributeSyntax=2.5.5.1))",
206         base=schemadn, scope=SCOPE_ONELEVEL, attrs=attrs)
207     attributes = {}
208     for i in range(0, len(res)):
209         expression = ("(&(objectclass=attributeSchema)(linkID=%d)"
210                       "(attributeSyntax=2.5.5.1))" %
211                       (int(res[i]["linkID"][0])+1))
212         target = schemaldb.searchone(basedn=schemadn,
213                                      expression=expression,
214                                      attribute="lDAPDisplayName",
215                                      scope=SCOPE_SUBTREE)
216         if target is not None:
217             attributes[str(res[i]["lDAPDisplayName"])]=str(target)
218
219     return attributes
220
221
222 def get_dnsyntax_attributes(schemadn,schemaldb):
223     res = schemaldb.search(
224         expression="(&(!(linkID=*))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))",
225         base=schemadn, scope=SCOPE_ONELEVEL,
226         attrs=["linkID", "lDAPDisplayName"])
227     attributes = []
228     for i in range(0, len(res)):
229         attributes.append(str(res[i]["lDAPDisplayName"]))
230     return attributes
231
232
233 def ldb_with_schema(schemadn="cn=schema,cn=configuration,dc=example,dc=com",
234                     domainsid=None,
235                     override_prefixmap=None):
236     """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
237
238     :param schemadn: DN of the schema
239     :param serverdn: DN of the server
240
241     Returns the schema data loaded as an object, with .ldb being a
242     new ldb with the schema loaded.  This allows certain tests to
243     operate without a remote or local schema.
244     """
245
246     if domainsid is None:
247         domainsid = security.random_sid()
248     else:
249         domainsid = security.dom_sid(domainsid)
250     return Schema(domainsid, schemadn=schemadn,
251                   override_prefixmap=override_prefixmap)