2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
5 Copyright (C) Wilco Baan Hofman <wilco@baanhofman.nl> 2010
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "libcli/util/pyerrors.h"
24 #include "lib/registry/registry.h"
25 #include "lib/talloc/pytalloc.h"
26 #include "lib/events/events.h"
27 #include "auth/credentials/pycredentials.h"
28 #include "param/pyparam.h"
30 extern PyTypeObject PyRegistryKey
;
31 extern PyTypeObject PyRegistry
;
32 extern PyTypeObject PyHiveKey
;
34 /*#define PyRegistryKey_AsRegistryKey(obj) py_talloc_get_type(obj, struct registry_key)*/
35 #define PyRegistry_AsRegistryContext(obj) ((struct registry_context *)py_talloc_get_ptr(obj))
36 #define PyHiveKey_AsHiveKey(obj) ((struct hive_key*)py_talloc_get_ptr(obj))
39 static PyObject
*py_get_predefined_key_by_name(PyObject
*self
, PyObject
*args
)
43 struct registry_context
*ctx
= PyRegistry_AsRegistryContext(self
);
44 struct registry_key
*key
;
46 if (!PyArg_ParseTuple(args
, "s", &name
))
49 result
= reg_get_predefined_key_by_name(ctx
, name
, &key
);
50 PyErr_WERROR_IS_ERR_RAISE(result
);
52 return py_talloc_steal(&PyRegistryKey
, key
);
55 static PyObject
*py_key_del_abs(PyObject
*self
, PyObject
*args
)
59 struct registry_context
*ctx
= PyRegistry_AsRegistryContext(self
);
61 if (!PyArg_ParseTuple(args
, "s", &path
))
64 result
= reg_key_del_abs(ctx
, path
);
65 PyErr_WERROR_IS_ERR_RAISE(result
);
70 static PyObject
*py_get_predefined_key(PyObject
*self
, PyObject
*args
)
73 struct registry_context
*ctx
= PyRegistry_AsRegistryContext(self
);
75 struct registry_key
*key
;
77 if (!PyArg_ParseTuple(args
, "I", &hkey
))
80 result
= reg_get_predefined_key(ctx
, hkey
, &key
);
81 PyErr_WERROR_IS_ERR_RAISE(result
);
83 return py_talloc_steal(&PyRegistryKey
, key
);
86 static PyObject
*py_diff_apply(PyObject
*self
, PyObject
*args
)
90 struct registry_context
*ctx
= PyRegistry_AsRegistryContext(self
);
91 if (!PyArg_ParseTuple(args
, "s", &filename
))
94 result
= reg_diff_apply(ctx
, filename
);
95 PyErr_WERROR_IS_ERR_RAISE(result
);
100 static PyObject
*py_mount_hive(PyObject
*self
, PyObject
*args
)
102 struct registry_context
*ctx
= PyRegistry_AsRegistryContext(self
);
104 PyObject
*py_hivekey
, *py_elements
= Py_None
;
105 const char **elements
;
108 if (!PyArg_ParseTuple(args
, "OI|O", &py_hivekey
, &hkey
, &py_elements
))
111 if (!PyList_Check(py_elements
) && py_elements
!= Py_None
) {
112 PyErr_SetString(PyExc_TypeError
, "Expected list of elements");
116 if (py_elements
== Py_None
) {
120 elements
= talloc_array(NULL
, const char *, PyList_Size(py_elements
));
121 for (i
= 0; i
< PyList_Size(py_elements
); i
++)
122 elements
[i
] = PyString_AsString(PyList_GetItem(py_elements
, i
));
125 SMB_ASSERT(ctx
!= NULL
);
127 result
= reg_mount_hive(ctx
, PyHiveKey_AsHiveKey(py_hivekey
), hkey
, elements
);
128 PyErr_WERROR_IS_ERR_RAISE(result
);
133 static PyObject
*registry_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
)
136 struct registry_context
*ctx
;
137 result
= reg_open_local(NULL
, &ctx
);
138 PyErr_WERROR_IS_ERR_RAISE(result
);
139 return py_talloc_steal(&PyRegistry
, ctx
);
142 static PyMethodDef registry_methods
[] = {
143 { "get_predefined_key_by_name", py_get_predefined_key_by_name
, METH_VARARGS
,
144 "S.get_predefined_key_by_name(name) -> key\n"
145 "Find a predefined key by name" },
146 { "key_del_abs", py_key_del_abs
, METH_VARARGS
, "S.key_del_abs(name) -> None\n"
147 "Delete a key by absolute path." },
148 { "get_predefined_key", py_get_predefined_key
, METH_VARARGS
, "S.get_predefined_key(hkey_id) -> key\n"
149 "Find a predefined key by id" },
150 { "diff_apply", py_diff_apply
, METH_VARARGS
, "S.diff_apply(filename) -> None\n"
151 "Apply the diff from the specified file" },
152 { "mount_hive", py_mount_hive
, METH_VARARGS
, "S.mount_hive(key, key_id, elements=None) -> None\n"
153 "Mount the specified key at the specified path." },
157 PyTypeObject PyRegistry
= {
158 .tp_name
= "Registry",
159 .tp_methods
= registry_methods
,
160 .tp_new
= registry_new
,
161 .tp_basicsize
= sizeof(py_talloc_Object
),
162 .tp_flags
= Py_TPFLAGS_DEFAULT
,
165 static PyObject
*py_hive_key_del(PyObject
*self
, PyObject
*args
)
168 struct hive_key
*key
= PyHiveKey_AsHiveKey(self
);
171 if (!PyArg_ParseTuple(args
, "s", &name
))
174 result
= hive_key_del(NULL
, key
, name
);
176 PyErr_WERROR_IS_ERR_RAISE(result
);
181 static PyObject
*py_hive_key_flush(PyObject
*self
)
184 struct hive_key
*key
= PyHiveKey_AsHiveKey(self
);
186 result
= hive_key_flush(key
);
187 PyErr_WERROR_IS_ERR_RAISE(result
);
192 static PyObject
*py_hive_key_del_value(PyObject
*self
, PyObject
*args
)
196 struct hive_key
*key
= PyHiveKey_AsHiveKey(self
);
198 if (!PyArg_ParseTuple(args
, "s", &name
))
201 result
= hive_key_del_value(NULL
, key
, name
);
203 PyErr_WERROR_IS_ERR_RAISE(result
);
208 static PyObject
*py_hive_key_set_value(PyObject
*self
, PyObject
*args
)
214 struct hive_key
*key
= PyHiveKey_AsHiveKey(self
);
216 if (!PyArg_ParseTuple(args
, "siz#", &name
, &type
, &value
.data
, &value
.length
))
219 if (value
.data
!= NULL
)
220 result
= hive_key_set_value(key
, name
, type
, value
);
222 result
= hive_key_del_value(NULL
, key
, name
);
224 PyErr_WERROR_IS_ERR_RAISE(result
);
229 static PyMethodDef hive_key_methods
[] = {
230 { "del", py_hive_key_del
, METH_VARARGS
, "S.del(name) -> None\n"
232 { "flush", (PyCFunction
)py_hive_key_flush
, METH_NOARGS
, "S.flush() -> None\n"
233 "Flush this key to disk" },
234 { "del_value", py_hive_key_del_value
, METH_VARARGS
, "S.del_value(name) -> None\n"
236 { "set_value", py_hive_key_set_value
, METH_VARARGS
, "S.set_value(name, type, data) -> None\n"
241 static PyObject
*hive_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
) {
245 static PyObject
*py_open_hive(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
)
247 const char *kwnames
[] = { "location", "lp_ctx", "session_info", "credentials", NULL
};
249 struct loadparm_context
*lp_ctx
;
250 PyObject
*py_lp_ctx
, *py_session_info
, *py_credentials
;
251 struct auth_session_info
*session_info
;
252 struct cli_credentials
*credentials
;
254 struct hive_key
*hive_key
;
257 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "s|OOO",
258 discard_const_p(char *, kwnames
),
260 &py_lp_ctx
, &py_session_info
,
264 mem_ctx
= talloc_new(NULL
);
265 if (mem_ctx
== NULL
) {
270 lp_ctx
= lpcfg_from_py_object(mem_ctx
, py_lp_ctx
);
271 if (lp_ctx
== NULL
) {
272 PyErr_SetString(PyExc_TypeError
, "Expected loadparm context");
273 talloc_free(mem_ctx
);
277 credentials
= cli_credentials_from_py_object(py_credentials
);
278 if (credentials
== NULL
) {
279 PyErr_SetString(PyExc_TypeError
, "Expected credentials");
280 talloc_free(mem_ctx
);
285 result
= reg_open_hive(NULL
, location
, session_info
, credentials
,
286 tevent_context_init(NULL
),
288 talloc_free(mem_ctx
);
289 PyErr_WERROR_IS_ERR_RAISE(result
);
291 return py_talloc_steal(&PyHiveKey
, hive_key
);
294 PyTypeObject PyHiveKey
= {
295 .tp_name
= "HiveKey",
296 .tp_methods
= hive_key_methods
,
298 .tp_basicsize
= sizeof(py_talloc_Object
),
299 .tp_flags
= Py_TPFLAGS_DEFAULT
,
302 PyTypeObject PyRegistryKey
= {
303 .tp_name
= "RegistryKey",
304 .tp_basicsize
= sizeof(py_talloc_Object
),
305 .tp_flags
= Py_TPFLAGS_DEFAULT
,
308 static PyObject
*py_open_samba(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
310 const char *kwnames
[] = { "lp_ctx", "session_info", NULL
};
311 struct registry_context
*reg_ctx
;
313 struct loadparm_context
*lp_ctx
;
314 PyObject
*py_lp_ctx
, *py_session_info
, *py_credentials
;
315 struct auth_session_info
*session_info
;
316 struct cli_credentials
*credentials
;
319 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "|OOO",
320 discard_const_p(char *, kwnames
),
321 &py_lp_ctx
, &py_session_info
,
325 mem_ctx
= talloc_new(NULL
);
326 if (mem_ctx
== NULL
) {
331 lp_ctx
= lpcfg_from_py_object(mem_ctx
, py_lp_ctx
);
332 if (lp_ctx
== NULL
) {
333 PyErr_SetString(PyExc_TypeError
, "Expected loadparm context");
334 talloc_free(mem_ctx
);
338 credentials
= cli_credentials_from_py_object(py_credentials
);
339 if (credentials
== NULL
) {
340 PyErr_SetString(PyExc_TypeError
, "Expected credentials");
341 talloc_free(mem_ctx
);
345 session_info
= NULL
; /* FIXME */
347 result
= reg_open_samba(NULL
, ®_ctx
, NULL
,
348 lp_ctx
, session_info
, credentials
);
349 talloc_free(mem_ctx
);
350 if (!W_ERROR_IS_OK(result
)) {
351 PyErr_SetWERROR(result
);
355 return py_talloc_steal(&PyRegistry
, reg_ctx
);
358 static PyObject
*py_open_directory(PyObject
*self
, PyObject
*args
)
362 struct hive_key
*key
;
364 if (!PyArg_ParseTuple(args
, "s", &location
))
367 result
= reg_open_directory(NULL
, location
, &key
);
368 PyErr_WERROR_IS_ERR_RAISE(result
);
370 return py_talloc_steal(&PyHiveKey
, key
);
373 static PyObject
*py_create_directory(PyObject
*self
, PyObject
*args
)
377 struct hive_key
*key
;
379 if (!PyArg_ParseTuple(args
, "s", &location
))
382 result
= reg_create_directory(NULL
, location
, &key
);
383 PyErr_WERROR_IS_ERR_RAISE(result
);
385 return py_talloc_steal(&PyHiveKey
, key
);
388 static PyObject
*py_open_ldb_file(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
390 const char *kwnames
[] = { "location", "session_info", "credentials", "lp_ctx", NULL
};
391 PyObject
*py_session_info
= Py_None
, *py_credentials
= Py_None
, *py_lp_ctx
= Py_None
;
394 struct loadparm_context
*lp_ctx
;
395 struct cli_credentials
*credentials
;
396 struct hive_key
*key
;
397 struct auth_session_info
*session_info
;
400 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "s|OOO",
401 discard_const_p(char *, kwnames
),
402 &location
, &py_session_info
,
403 &py_credentials
, &py_lp_ctx
))
406 mem_ctx
= talloc_new(NULL
);
407 if (mem_ctx
== NULL
) {
412 lp_ctx
= lpcfg_from_py_object(mem_ctx
, py_lp_ctx
);
413 if (lp_ctx
== NULL
) {
414 PyErr_SetString(PyExc_TypeError
, "Expected loadparm context");
415 talloc_free(mem_ctx
);
419 credentials
= cli_credentials_from_py_object(py_credentials
);
420 if (credentials
== NULL
) {
421 PyErr_SetString(PyExc_TypeError
, "Expected credentials");
422 talloc_free(mem_ctx
);
426 session_info
= NULL
; /* FIXME */
428 result
= reg_open_ldb_file(NULL
, location
, session_info
, credentials
,
429 s4_event_context_init(NULL
), lp_ctx
, &key
);
430 talloc_free(mem_ctx
);
431 PyErr_WERROR_IS_ERR_RAISE(result
);
433 return py_talloc_steal(&PyHiveKey
, key
);
436 static PyObject
*py_str_regtype(PyObject
*self
, PyObject
*args
)
440 if (!PyArg_ParseTuple(args
, "i", ®type
))
443 return PyString_FromString(str_regtype(regtype
));
446 static PyObject
*py_get_predef_name(PyObject
*self
, PyObject
*args
)
451 if (!PyArg_ParseTuple(args
, "I", &hkey
))
454 str
= reg_get_predef_name(hkey
);
457 return PyString_FromString(str
);
460 static PyMethodDef py_registry_methods
[] = {
461 { "open_samba", (PyCFunction
)py_open_samba
, METH_VARARGS
|METH_KEYWORDS
, "open_samba() -> reg" },
462 { "open_directory", py_open_directory
, METH_VARARGS
, "open_dir(location) -> key" },
463 { "create_directory", py_create_directory
, METH_VARARGS
, "create_dir(location) -> key" },
464 { "open_ldb", (PyCFunction
)py_open_ldb_file
, METH_VARARGS
|METH_KEYWORDS
, "open_ldb(location, session_info=None, credentials=None, loadparm_context=None) -> key" },
465 { "open_hive", (PyCFunction
)py_open_hive
, METH_VARARGS
|METH_KEYWORDS
, "open_hive(location, session_info=None, credentials=None, loadparm_context=None) -> key" },
466 { "str_regtype", py_str_regtype
, METH_VARARGS
, "str_regtype(int) -> str" },
467 { "get_predef_name", py_get_predef_name
, METH_VARARGS
, "get_predef_name(hkey) -> str" },
471 void initregistry(void)
474 PyTypeObject
*talloc_type
= PyTalloc_GetObjectType();
476 if (talloc_type
== NULL
)
479 PyHiveKey
.tp_base
= talloc_type
;
480 PyRegistry
.tp_base
= talloc_type
;
481 PyRegistryKey
.tp_base
= talloc_type
;
483 if (PyType_Ready(&PyHiveKey
) < 0)
486 if (PyType_Ready(&PyRegistry
) < 0)
489 if (PyType_Ready(&PyRegistryKey
) < 0)
492 m
= Py_InitModule3("registry", py_registry_methods
, "Registry");
496 PyModule_AddObject(m
, "HKEY_CLASSES_ROOT", PyInt_FromLong(HKEY_CLASSES_ROOT
));
497 PyModule_AddObject(m
, "HKEY_CURRENT_USER", PyInt_FromLong(HKEY_CURRENT_USER
));
498 PyModule_AddObject(m
, "HKEY_LOCAL_MACHINE", PyInt_FromLong(HKEY_LOCAL_MACHINE
));
499 PyModule_AddObject(m
, "HKEY_USERS", PyInt_FromLong(HKEY_USERS
));
500 PyModule_AddObject(m
, "HKEY_PERFORMANCE_DATA", PyInt_FromLong(HKEY_PERFORMANCE_DATA
));
501 PyModule_AddObject(m
, "HKEY_CURRENT_CONFIG", PyInt_FromLong(HKEY_CURRENT_CONFIG
));
502 PyModule_AddObject(m
, "HKEY_DYN_DATA", PyInt_FromLong(HKEY_DYN_DATA
));
503 PyModule_AddObject(m
, "HKEY_PERFORMANCE_TEXT", PyInt_FromLong(HKEY_PERFORMANCE_TEXT
));
504 PyModule_AddObject(m
, "HKEY_PERFORMANCE_NLSTEXT", PyInt_FromLong(HKEY_PERFORMANCE_NLSTEXT
));
506 Py_INCREF(&PyRegistry
);
507 PyModule_AddObject(m
, "Registry", (PyObject
*)&PyRegistry
);
509 Py_INCREF(&PyHiveKey
);
510 PyModule_AddObject(m
, "HiveKey", (PyObject
*)&PyHiveKey
);
512 Py_INCREF(&PyRegistryKey
);
513 PyModule_AddObject(m
, "RegistryKey", (PyObject
*)&PyRegistryKey
);