2 * Unix SMB/CIFS implementation.
3 * libnet smbconf registry Support
4 * Copyright (C) Michael Adam 2007
5 * Copyright (C) Guenther Deschner 2007
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/>.
22 #include "libnet/libnet.h"
24 /**********************************************************************
26 * Helper functions (mostly registry related)
27 * TODO: These should be eventually static.
29 **********************************************************************/
32 * add a string to a talloced array of strings.
34 static WERROR libnet_smbconf_add_string_to_array(TALLOC_CTX *mem_ctx,
39 char **new_array = NULL;
41 if ((array == NULL) || (string == NULL)) {
42 return WERR_INVALID_PARAM;
45 new_array = TALLOC_REALLOC_ARRAY(mem_ctx, *array, char *, count + 1);
46 if (new_array == NULL) {
50 new_array[count] = talloc_strdup(new_array, string);
58 * Open a subkey of KEY_SMBCONF (i.e a service)
60 static WERROR libnet_smbconf_reg_open_path(TALLOC_CTX *ctx,
61 const char *subkeyname,
62 uint32 desired_access,
63 struct registry_key **key)
65 WERROR werr = WERR_OK;
69 if (!(token = registry_create_admin_token(ctx))) {
70 DEBUG(1, ("Error creating admin token\n"));
74 if (subkeyname == NULL) {
75 path = talloc_strdup(ctx, KEY_SMBCONF);
77 path = talloc_asprintf(ctx, "%s\\%s", KEY_SMBCONF, subkeyname);
80 werr = reg_open_path(ctx, path, desired_access,
83 if (!W_ERROR_IS_OK(werr)) {
84 DEBUG(1, ("Error opening registry path '%s': %s\n",
85 path, dos_errstr(werr)));
94 * open the base key KEY_SMBCONF
96 static WERROR libnet_smbconf_reg_open_basepath(TALLOC_CTX *ctx,
97 uint32 desired_access,
98 struct registry_key **key)
100 return libnet_smbconf_reg_open_path(ctx, NULL, desired_access, key);
104 * check if a subkey of KEY_SMBCONF of a given name exists
106 bool libnet_smbconf_key_exists(const char *subkeyname)
109 WERROR werr = WERR_OK;
110 TALLOC_CTX *mem_ctx = talloc_stackframe();
111 struct registry_key *key = NULL;
113 werr = libnet_smbconf_reg_open_path(mem_ctx, subkeyname, REG_KEY_READ,
115 if (W_ERROR_IS_OK(werr)) {
119 TALLOC_FREE(mem_ctx);
123 static bool libnet_smbconf_value_exists(struct registry_key *key,
127 WERROR werr = WERR_OK;
128 TALLOC_CTX *ctx = talloc_stackframe();
129 struct registry_value *value = NULL;
131 werr = reg_queryvalue(ctx, key, param, &value);
132 if (W_ERROR_IS_OK(werr)) {
141 * create a subkey of KEY_SMBCONF
143 WERROR libnet_smbconf_reg_createkey_internal(TALLOC_CTX *ctx,
144 const char * subkeyname,
145 struct registry_key **newkey)
147 WERROR werr = WERR_OK;
148 struct registry_key *create_parent = NULL;
149 TALLOC_CTX *create_ctx;
150 enum winreg_CreateAction action = REG_ACTION_NONE;
152 /* create a new talloc ctx for creation. it will hold
153 * the intermediate parent key (SMBCONF) for creation
154 * and will be destroyed when leaving this function... */
155 if (!(create_ctx = talloc_new(ctx))) {
160 werr = libnet_smbconf_reg_open_basepath(create_ctx, REG_KEY_WRITE,
162 if (!W_ERROR_IS_OK(werr)) {
166 werr = reg_createkey(ctx, create_parent, subkeyname,
167 REG_KEY_WRITE, newkey, &action);
168 if (W_ERROR_IS_OK(werr) && (action != REG_CREATED_NEW_KEY)) {
169 DEBUG(10, ("Key '%s' already exists.\n", subkeyname));
170 werr = WERR_ALREADY_EXISTS;
172 if (!W_ERROR_IS_OK(werr)) {
173 DEBUG(5, ("Error creating key %s: %s\n",
174 subkeyname, dos_errstr(werr)));
178 TALLOC_FREE(create_ctx);
183 * add a value to a key.
185 WERROR libnet_smbconf_reg_setvalue_internal(struct registry_key *key,
189 struct registry_value val;
190 WERROR werr = WERR_OK;
192 const char *canon_valname;
193 const char *canon_valstr;
195 if (!lp_canonicalize_parameter_with_value(valname, valstr,
199 if (canon_valname == NULL) {
200 DEBUG(5, ("invalid parameter '%s' given\n",
203 DEBUG(5, ("invalid value '%s' given for "
204 "parameter '%s'\n", valstr, valname));
206 werr = WERR_INVALID_PARAM;
213 val.v.sz.str = CONST_DISCARD(char *, canon_valstr);
214 val.v.sz.len = strlen(canon_valstr) + 1;
216 if (registry_smbconf_valname_forbidden(canon_valname)) {
217 DEBUG(5, ("Parameter '%s' not allowed in registry.\n",
219 werr = WERR_INVALID_PARAM;
223 subkeyname = strrchr_m(key->key->name, '\\');
224 if ((subkeyname == NULL) || (*(subkeyname +1) == '\0')) {
225 DEBUG(5, ("Invalid registry key '%s' given as "
226 "smbconf section.\n", key->key->name));
227 werr = WERR_INVALID_PARAM;
231 if (!strequal(subkeyname, GLOBAL_NAME) &&
232 lp_parameter_is_global(valname))
234 DEBUG(5, ("Global paramter '%s' not allowed in "
235 "service definition ('%s').\n", canon_valname,
237 werr = WERR_INVALID_PARAM;
241 werr = reg_setvalue(key, canon_valname, &val);
242 if (!W_ERROR_IS_OK(werr)) {
243 DEBUG(5, ("Error adding value '%s' to "
245 canon_valname, key->key->name, dos_errstr(werr)));
253 * format a registry_value into a string.
255 * This is intended to be used for smbconf registry values,
256 * which are ar stored as REG_SZ values, so the incomplete
257 * handling should be ok.
259 static char *libnet_smbconf_format_registry_value(TALLOC_CTX *mem_ctx,
260 struct registry_value *value)
264 /* alternatively, create a new talloc context? */
265 if (mem_ctx == NULL) {
269 switch (value->type) {
271 result = talloc_asprintf(mem_ctx, "%d", value->v.dword);
275 result = talloc_asprintf(mem_ctx, "%s", value->v.sz.str);
279 for (j = 0; j < value->v.multi_sz.num_strings; j++) {
280 result = talloc_asprintf(mem_ctx, "\"%s\" ",
281 value->v.multi_sz.strings[j]);
286 result = talloc_asprintf(mem_ctx, "binary (%d bytes)",
287 (int)value->v.binary.length);
290 result = talloc_asprintf(mem_ctx, "<unprintable>");
297 * Get the values of a key as a list of value names
298 * and a list of value strings (ordered)
300 static WERROR libnet_smbconf_reg_get_values(TALLOC_CTX *mem_ctx,
301 struct registry_key *key,
302 uint32_t *num_values,
304 char ***value_strings)
306 TALLOC_CTX *tmp_ctx = NULL;
307 WERROR werr = WERR_OK;
309 struct registry_value *valvalue = NULL;
310 char *valname = NULL;
311 char **tmp_valnames = NULL;
312 char **tmp_valstrings = NULL;
314 if ((num_values == NULL) || (value_names == NULL) ||
315 (value_strings == NULL))
317 werr = WERR_INVALID_PARAM;
321 tmp_ctx = talloc_new(mem_ctx);
322 if (tmp_ctx == NULL) {
328 W_ERROR_IS_OK(werr = reg_enumvalue(tmp_ctx, key, count, &valname,
334 werr = libnet_smbconf_add_string_to_array(tmp_ctx,
337 if (!W_ERROR_IS_OK(werr)) {
341 valstring = libnet_smbconf_format_registry_value(tmp_ctx,
343 werr = libnet_smbconf_add_string_to_array(tmp_ctx,
347 if (!W_ERROR_IS_OK(werr)) {
351 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
359 *value_names = talloc_move(mem_ctx, &tmp_valnames);
360 *value_strings = talloc_move(mem_ctx, &tmp_valstrings);
363 *value_strings = NULL;
367 TALLOC_FREE(tmp_ctx);
371 /**********************************************************************
373 * The actual net conf api functions, that are exported.
375 **********************************************************************/
378 * Drop the whole configuration (restarting empty).
380 WERROR libnet_smbconf_drop(void)
383 WERROR werr = WERR_OK;
384 NT_USER_TOKEN *token;
385 struct registry_key *parent_key = NULL;
386 struct registry_key *new_key = NULL;
387 TALLOC_CTX* mem_ctx = talloc_stackframe();
388 enum winreg_CreateAction action;
390 if (!(token = registry_create_admin_token(mem_ctx))) {
391 /* what is the appropriate error code here? */
392 werr = WERR_CAN_NOT_COMPLETE;
396 path = talloc_strdup(mem_ctx, KEY_SMBCONF);
401 p = strrchr(path, '\\');
403 werr = reg_open_path(mem_ctx, path, REG_KEY_WRITE, token, &parent_key);
405 if (!W_ERROR_IS_OK(werr)) {
409 werr = reg_deletekey_recursive(mem_ctx, parent_key, p+1);
411 if (!W_ERROR_IS_OK(werr)) {
415 werr = reg_createkey(mem_ctx, parent_key, p+1, REG_KEY_WRITE,
419 TALLOC_FREE(mem_ctx);
424 * Get the whole configuration as lists of strings with counts:
426 * num_shares : number of shares
427 * share_names : list of length num_shares of share names
428 * num_params : list of length num_shares of parameter counts for each share
429 * param_names : list of lists of parameter names for each share
430 * param_values : list of lists of parameter values for each share
432 WERROR libnet_smbconf_get_config(TALLOC_CTX *mem_ctx, uint32_t *num_shares,
433 char ***share_names, uint32_t **num_params,
434 char ****param_names, char ****param_values)
436 WERROR werr = WERR_OK;
437 TALLOC_CTX *tmp_ctx = NULL;
438 uint32_t tmp_num_shares;
439 char **tmp_share_names;
440 uint32_t *tmp_num_params;
441 char ***tmp_param_names;
442 char ***tmp_param_values;
445 if ((num_shares == NULL) || (share_names == NULL) ||
446 (num_params == NULL) || (param_names == NULL) ||
447 (param_values == NULL))
449 werr = WERR_INVALID_PARAM;
453 tmp_ctx = talloc_new(mem_ctx);
454 if (tmp_ctx == NULL) {
459 werr = libnet_smbconf_get_share_names(tmp_ctx, &tmp_num_shares,
461 if (!W_ERROR_IS_OK(werr)) {
465 tmp_num_params = TALLOC_ARRAY(tmp_ctx, uint32_t, tmp_num_shares);
466 tmp_param_names = TALLOC_ARRAY(tmp_ctx, char **, tmp_num_shares);
467 tmp_param_values = TALLOC_ARRAY(tmp_ctx, char **, tmp_num_shares);
469 if ((tmp_num_params == NULL) || (tmp_param_names == NULL) ||
470 (tmp_param_values == NULL))
476 for (count = 0; count < tmp_num_shares; count++) {
477 werr = libnet_smbconf_getshare(mem_ctx, tmp_share_names[count],
478 &tmp_num_params[count],
479 &tmp_param_names[count],
480 &tmp_param_values[count]);
481 if (!W_ERROR_IS_OK(werr)) {
488 *num_shares = tmp_num_shares;
489 if (tmp_num_shares > 0) {
490 *share_names = talloc_move(mem_ctx, &tmp_share_names);
491 *num_params = talloc_move(mem_ctx, &tmp_num_params);
492 *param_names = talloc_move(mem_ctx, &tmp_param_names);
493 *param_values = talloc_move(mem_ctx, &tmp_param_values);
498 *param_values = NULL;
502 TALLOC_FREE(tmp_ctx);
508 * get the list of share names defined in the configuration.
510 WERROR libnet_smbconf_get_share_names(TALLOC_CTX *mem_ctx, uint32_t *num_shares,
514 uint32_t added_count = 0;
515 TALLOC_CTX *tmp_ctx = NULL;
516 WERROR werr = WERR_OK;
517 struct registry_key *key = NULL;
518 char *subkey_name = NULL;
519 char **tmp_share_names = NULL;
521 if ((num_shares == NULL) || (share_names == NULL)) {
522 werr = WERR_INVALID_PARAM;
526 tmp_ctx = talloc_new(mem_ctx);
527 if (tmp_ctx == NULL) {
532 /* make sure "global" is always listed first */
533 if (libnet_smbconf_key_exists(GLOBAL_NAME)) {
534 werr = libnet_smbconf_add_string_to_array(tmp_ctx,
537 if (!W_ERROR_IS_OK(werr)) {
543 werr = libnet_smbconf_reg_open_basepath(tmp_ctx,
544 SEC_RIGHTS_ENUM_SUBKEYS,
546 if (!W_ERROR_IS_OK(werr)) {
551 W_ERROR_IS_OK(werr = reg_enumkey(tmp_ctx, key, count,
552 &subkey_name, NULL));
555 if (strequal(subkey_name, GLOBAL_NAME)) {
559 werr = libnet_smbconf_add_string_to_array(tmp_ctx,
563 if (!W_ERROR_IS_OK(werr)) {
568 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
573 *num_shares = added_count;
574 if (added_count > 0) {
575 *share_names = talloc_move(mem_ctx, &tmp_share_names);
581 TALLOC_FREE(tmp_ctx);
586 * get a definition of a share (service) from configuration.
588 WERROR libnet_smbconf_getshare(TALLOC_CTX *mem_ctx, const char *servicename,
589 uint32_t *num_params, char ***param_names,
590 char ***param_values)
592 WERROR werr = WERR_OK;
593 struct registry_key *key = NULL;
595 werr = libnet_smbconf_reg_open_path(mem_ctx, servicename, REG_KEY_READ,
597 if (!W_ERROR_IS_OK(werr)) {
601 werr = libnet_smbconf_reg_get_values(mem_ctx, key, num_params,
602 param_names, param_values);
610 * delete a service from configuration
612 WERROR libnet_smbconf_delshare(const char *servicename)
614 WERROR werr = WERR_OK;
615 struct registry_key *key = NULL;
616 TALLOC_CTX *ctx = talloc_stackframe();
618 werr = libnet_smbconf_reg_open_basepath(ctx, REG_KEY_WRITE, &key);
619 if (!W_ERROR_IS_OK(werr)) {
623 werr = reg_deletekey_recursive(key, key, servicename);
631 * set a configuration parameter to the value provided.
633 WERROR libnet_smbconf_setparm(const char *service,
638 struct registry_key *key = NULL;
639 TALLOC_CTX *mem_ctx = talloc_stackframe();
641 if (!libnet_smbconf_key_exists(service)) {
642 werr = libnet_smbconf_reg_createkey_internal(mem_ctx, service,
645 werr = libnet_smbconf_reg_open_path(mem_ctx, service,
646 REG_KEY_WRITE, &key);
648 if (!W_ERROR_IS_OK(werr)) {
652 werr = libnet_smbconf_reg_setvalue_internal(key, param, valstr);
655 TALLOC_FREE(mem_ctx);
660 * get the value of a configuration parameter as a string
662 WERROR libnet_smbconf_getparm(TALLOC_CTX *mem_ctx,
667 WERROR werr = WERR_OK;
668 struct registry_key *key = NULL;
669 struct registry_value *value = NULL;
671 if (valstr == NULL) {
672 werr = WERR_INVALID_PARAM;
676 if (!libnet_smbconf_key_exists(service)) {
677 werr = WERR_NO_SUCH_SERVICE;
681 werr = libnet_smbconf_reg_open_path(mem_ctx, service, REG_KEY_READ,
683 if (!W_ERROR_IS_OK(werr)) {
687 if (!libnet_smbconf_value_exists(key, param)) {
688 werr = WERR_INVALID_PARAM;
692 werr = reg_queryvalue(mem_ctx, key, param, &value);
693 if (!W_ERROR_IS_OK(werr)) {
697 *valstr = libnet_smbconf_format_registry_value(mem_ctx, value);
699 if (*valstr == NULL) {
710 * delete a parameter from configuration
712 WERROR libnet_smbconf_delparm(const char *service,
715 struct registry_key *key = NULL;
716 WERROR werr = WERR_OK;
717 TALLOC_CTX *mem_ctx = talloc_stackframe();
719 if (!libnet_smbconf_key_exists(service)) {
720 return WERR_NO_SUCH_SERVICE;
723 werr = libnet_smbconf_reg_open_path(mem_ctx, service, REG_KEY_ALL, &key);
724 if (!W_ERROR_IS_OK(werr)) {
728 if (!libnet_smbconf_value_exists(key, param)) {
729 werr = WERR_INVALID_PARAM;
733 werr = reg_deletevalue(key, param);
736 TALLOC_FREE(mem_ctx);
741 /**********************************************************************
743 * Convenience functions that are also exported.
745 **********************************************************************/
747 WERROR libnet_smbconf_set_global_param(const char *param,
750 return libnet_smbconf_setparm(GLOBAL_NAME, param, val);