libsmbconf: rewrite API to use smbconf_service struct
[Samba.git] / source / lib / smbconf / smbconf_reg.c
blob5f5724c406a4137e048872f1ba790b4b967b33dc
1 /*
2 * Unix SMB/CIFS implementation.
3 * libsmbconf - Samba configuration library, registry backend
4 * Copyright (C) Michael Adam 2008
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include "includes.h"
21 #include "smbconf_private.h"
23 #define INCLUDES_VALNAME "includes"
25 struct reg_private_data {
26 NT_USER_TOKEN *token;
27 bool open; /* did _we_ open the registry? */
30 /**********************************************************************
32 * helper functions
34 **********************************************************************/
36 /**
37 * a convenience helper to cast the private data structure
39 static struct reg_private_data *rpd(struct smbconf_ctx *ctx)
41 return (struct reg_private_data *)(ctx->data);
45 * check whether a given value name is forbidden in registry (smbconf)
47 static bool smbconf_reg_valname_forbidden(const char *valname)
49 /* hard code the list of forbidden names here for now */
50 const char *forbidden_valnames[] = {
51 "lock directory",
52 "lock dir",
53 "config backend",
54 "include",
55 NULL
57 const char **forbidden = NULL;
59 for (forbidden = forbidden_valnames; *forbidden != NULL; forbidden++) {
60 if (strwicmp(valname, *forbidden) == 0) {
61 return true;
64 return false;
67 static bool smbconf_reg_valname_valid(const char *valname)
69 return (lp_parameter_is_valid(valname) &&
70 !smbconf_reg_valname_forbidden(valname));
73 /**
74 * Open a registry key specified by "path"
76 static WERROR smbconf_reg_open_path(TALLOC_CTX *mem_ctx,
77 struct smbconf_ctx *ctx,
78 const char *path,
79 uint32 desired_access,
80 struct registry_key **key)
82 WERROR werr = WERR_OK;
84 if (ctx == NULL) {
85 DEBUG(1, ("Error: configuration is not open!\n"));
86 werr = WERR_INVALID_PARAM;
87 goto done;
90 if (rpd(ctx)->token == NULL) {
91 DEBUG(1, ("Error: token missing from smbconf_ctx. "
92 "was smbconf_init() called?\n"));
93 werr = WERR_INVALID_PARAM;
94 goto done;
97 werr = ctx->ops->open_conf(ctx);
98 if (!W_ERROR_IS_OK(werr)) {
99 DEBUG(1, ("Error opening the registry.\n"));
100 goto done;
103 if (path == NULL) {
104 DEBUG(1, ("Error: NULL path string given\n"));
105 werr = WERR_INVALID_PARAM;
106 goto done;
109 werr = reg_open_path(mem_ctx, path, desired_access, rpd(ctx)->token,
110 key);
112 if (!W_ERROR_IS_OK(werr)) {
113 DEBUG(1, ("Error opening registry path '%s': %s\n",
114 path, dos_errstr(werr)));
117 done:
118 return werr;
122 * Open a subkey of the base key (i.e a service)
124 static WERROR smbconf_reg_open_service_key(TALLOC_CTX *mem_ctx,
125 struct smbconf_ctx *ctx,
126 const char *servicename,
127 uint32 desired_access,
128 struct registry_key **key)
130 WERROR werr = WERR_OK;
131 char *path = NULL;
133 if (servicename == NULL) {
134 path = talloc_strdup(mem_ctx, ctx->path);
135 } else {
136 path = talloc_asprintf(mem_ctx, "%s\\%s", ctx->path,
137 servicename);
139 if (path == NULL) {
140 werr = WERR_NOMEM;
141 goto done;
144 werr = smbconf_reg_open_path(mem_ctx, ctx, path, desired_access, key);
146 done:
147 TALLOC_FREE(path);
148 return werr;
152 * open the base key
154 static WERROR smbconf_reg_open_base_key(TALLOC_CTX *mem_ctx,
155 struct smbconf_ctx *ctx,
156 uint32 desired_access,
157 struct registry_key **key)
159 return smbconf_reg_open_path(mem_ctx, ctx, ctx->path, desired_access,
160 key);
164 * check if a value exists in a given registry key
166 static bool smbconf_value_exists(struct registry_key *key, const char *param)
168 bool ret = false;
169 WERROR werr = WERR_OK;
170 TALLOC_CTX *ctx = talloc_stackframe();
171 struct registry_value *value = NULL;
173 werr = reg_queryvalue(ctx, key, param, &value);
174 if (W_ERROR_IS_OK(werr)) {
175 ret = true;
178 TALLOC_FREE(ctx);
179 return ret;
183 * create a subkey of the base key (i.e. a service...)
185 static WERROR smbconf_reg_create_service_key(TALLOC_CTX *mem_ctx,
186 struct smbconf_ctx *ctx,
187 const char * subkeyname,
188 struct registry_key **newkey)
190 WERROR werr = WERR_OK;
191 struct registry_key *create_parent = NULL;
192 TALLOC_CTX *create_ctx;
193 enum winreg_CreateAction action = REG_ACTION_NONE;
195 /* create a new talloc ctx for creation. it will hold
196 * the intermediate parent key (SMBCONF) for creation
197 * and will be destroyed when leaving this function... */
198 if (!(create_ctx = talloc_stackframe())) {
199 werr = WERR_NOMEM;
200 goto done;
203 werr = smbconf_reg_open_base_key(create_ctx, ctx, REG_KEY_WRITE,
204 &create_parent);
205 if (!W_ERROR_IS_OK(werr)) {
206 goto done;
209 werr = reg_createkey(mem_ctx, create_parent, subkeyname,
210 REG_KEY_WRITE, newkey, &action);
211 if (W_ERROR_IS_OK(werr) && (action != REG_CREATED_NEW_KEY)) {
212 DEBUG(10, ("Key '%s' already exists.\n", subkeyname));
213 werr = WERR_ALREADY_EXISTS;
215 if (!W_ERROR_IS_OK(werr)) {
216 DEBUG(5, ("Error creating key %s: %s\n",
217 subkeyname, dos_errstr(werr)));
220 done:
221 TALLOC_FREE(create_ctx);
222 return werr;
226 * add a value to a key.
228 static WERROR smbconf_reg_set_value(struct registry_key *key,
229 const char *valname,
230 const char *valstr)
232 struct registry_value val;
233 WERROR werr = WERR_OK;
234 char *subkeyname;
235 const char *canon_valname;
236 const char *canon_valstr;
238 if (!lp_canonicalize_parameter_with_value(valname, valstr,
239 &canon_valname,
240 &canon_valstr))
242 if (canon_valname == NULL) {
243 DEBUG(5, ("invalid parameter '%s' given\n",
244 valname));
245 } else {
246 DEBUG(5, ("invalid value '%s' given for "
247 "parameter '%s'\n", valstr, valname));
249 werr = WERR_INVALID_PARAM;
250 goto done;
253 if (smbconf_reg_valname_forbidden(canon_valname)) {
254 DEBUG(5, ("Parameter '%s' not allowed in registry.\n",
255 canon_valname));
256 werr = WERR_INVALID_PARAM;
257 goto done;
260 subkeyname = strrchr_m(key->key->name, '\\');
261 if ((subkeyname == NULL) || (*(subkeyname +1) == '\0')) {
262 DEBUG(5, ("Invalid registry key '%s' given as "
263 "smbconf section.\n", key->key->name));
264 werr = WERR_INVALID_PARAM;
265 goto done;
267 subkeyname++;
268 if (!strequal(subkeyname, GLOBAL_NAME) &&
269 lp_parameter_is_global(valname))
271 DEBUG(5, ("Global paramter '%s' not allowed in "
272 "service definition ('%s').\n", canon_valname,
273 subkeyname));
274 werr = WERR_INVALID_PARAM;
275 goto done;
278 ZERO_STRUCT(val);
280 val.type = REG_SZ;
281 val.v.sz.str = CONST_DISCARD(char *, canon_valstr);
282 val.v.sz.len = strlen(canon_valstr) + 1;
284 werr = reg_setvalue(key, canon_valname, &val);
285 if (!W_ERROR_IS_OK(werr)) {
286 DEBUG(5, ("Error adding value '%s' to "
287 "key '%s': %s\n",
288 canon_valname, key->key->name, dos_errstr(werr)));
291 done:
292 return werr;
295 static WERROR smbconf_reg_set_multi_sz_value(struct registry_key *key,
296 const char *valname,
297 const uint32_t num_strings,
298 const char **strings)
300 WERROR werr;
301 struct registry_value *value;
302 uint32_t count;
303 TALLOC_CTX *tmp_ctx = talloc_stackframe();
305 if (strings == NULL) {
306 werr = WERR_INVALID_PARAM;
307 goto done;
310 value = TALLOC_ZERO_P(tmp_ctx, struct registry_value);
312 value->type = REG_MULTI_SZ;
313 value->v.multi_sz.num_strings = num_strings;
314 value->v.multi_sz.strings = TALLOC_ARRAY(tmp_ctx, char *, num_strings);
315 if (value->v.multi_sz.strings == NULL) {
316 werr = WERR_NOMEM;
317 goto done;
319 for (count = 0; count < num_strings; count++) {
320 value->v.multi_sz.strings[count] =
321 talloc_strdup(value->v.multi_sz.strings,
322 strings[count]);
323 if (value->v.multi_sz.strings[count] == NULL) {
324 werr = WERR_NOMEM;
325 goto done;
329 werr = reg_setvalue(key, valname, value);
330 if (!W_ERROR_IS_OK(werr)) {
331 DEBUG(5, ("Error adding value '%s' to key '%s': %s\n",
332 valname, key->key->name, dos_errstr(werr)));
335 done:
336 TALLOC_FREE(tmp_ctx);
337 return werr;
341 * format a registry_value into a string.
343 * This is intended to be used for smbconf registry values,
344 * which are ar stored as REG_SZ values, so the incomplete
345 * handling should be ok.
347 static char *smbconf_format_registry_value(TALLOC_CTX *mem_ctx,
348 struct registry_value *value)
350 char *result = NULL;
352 /* alternatively, create a new talloc context? */
353 if (mem_ctx == NULL) {
354 return result;
357 switch (value->type) {
358 case REG_DWORD:
359 result = talloc_asprintf(mem_ctx, "%d", value->v.dword);
360 break;
361 case REG_SZ:
362 case REG_EXPAND_SZ:
363 result = talloc_asprintf(mem_ctx, "%s", value->v.sz.str);
364 break;
365 case REG_MULTI_SZ: {
366 uint32 j;
367 for (j = 0; j < value->v.multi_sz.num_strings; j++) {
368 result = talloc_asprintf(mem_ctx, "%s\"%s\" ",
369 result ? result : "" ,
370 value->v.multi_sz.strings[j]);
371 if (result == NULL) {
372 break;
375 break;
377 case REG_BINARY:
378 result = talloc_asprintf(mem_ctx, "binary (%d bytes)",
379 (int)value->v.binary.length);
380 break;
381 default:
382 result = talloc_asprintf(mem_ctx, "<unprintable>");
383 break;
385 return result;
388 static WERROR smbconf_reg_get_includes_internal(TALLOC_CTX *mem_ctx,
389 struct registry_key *key,
390 uint32_t *num_includes,
391 char ***includes)
393 WERROR werr;
394 uint32_t count;
395 struct registry_value *value = NULL;
396 char **tmp_includes = NULL;
397 TALLOC_CTX *tmp_ctx = talloc_stackframe();
399 if (!smbconf_value_exists(key, INCLUDES_VALNAME)) {
400 /* no includes */
401 *num_includes = 0;
402 *includes = NULL;
403 werr = WERR_OK;
404 goto done;
407 werr = reg_queryvalue(tmp_ctx, key, INCLUDES_VALNAME, &value);
408 if (!W_ERROR_IS_OK(werr)) {
409 goto done;
412 if (value->type != REG_MULTI_SZ) {
413 /* wront type -- ignore */
414 goto done;
417 for (count = 0; count < value->v.multi_sz.num_strings; count++)
419 werr = smbconf_add_string_to_array(tmp_ctx,
420 &tmp_includes,
421 count,
422 value->v.multi_sz.strings[count]);
423 if (!W_ERROR_IS_OK(werr)) {
424 goto done;
428 if (count > 0) {
429 *includes = talloc_move(mem_ctx, &tmp_includes);
430 if (*includes == NULL) {
431 werr = WERR_NOMEM;
432 goto done;
434 *num_includes = count;
435 } else {
436 *num_includes = 0;
437 *includes = NULL;
440 done:
441 TALLOC_FREE(tmp_ctx);
442 return werr;
446 * Get the values of a key as a list of value names
447 * and a list of value strings (ordered)
449 static WERROR smbconf_reg_get_values(TALLOC_CTX *mem_ctx,
450 struct registry_key *key,
451 uint32_t *num_values,
452 char ***value_names,
453 char ***value_strings)
455 TALLOC_CTX *tmp_ctx = NULL;
456 WERROR werr = WERR_OK;
457 uint32_t count;
458 struct registry_value *valvalue = NULL;
459 char *valname = NULL;
460 uint32_t tmp_num_values = 0;
461 char **tmp_valnames = NULL;
462 char **tmp_valstrings = NULL;
463 uint32_t num_includes = 0;
464 char **includes = NULL;
466 if ((num_values == NULL) || (value_names == NULL) ||
467 (value_strings == NULL))
469 werr = WERR_INVALID_PARAM;
470 goto done;
473 tmp_ctx = talloc_stackframe();
474 if (tmp_ctx == NULL) {
475 werr = WERR_NOMEM;
476 goto done;
479 for (count = 0;
480 werr = reg_enumvalue(tmp_ctx, key, count, &valname, &valvalue),
481 W_ERROR_IS_OK(werr);
482 count++)
484 char *valstring;
486 if (!smbconf_reg_valname_valid(valname)) {
487 continue;
490 werr = smbconf_add_string_to_array(tmp_ctx,
491 &tmp_valnames,
492 tmp_num_values, valname);
493 if (!W_ERROR_IS_OK(werr)) {
494 goto done;
497 valstring = smbconf_format_registry_value(tmp_ctx, valvalue);
498 werr = smbconf_add_string_to_array(tmp_ctx, &tmp_valstrings,
499 tmp_num_values, valstring);
500 if (!W_ERROR_IS_OK(werr)) {
501 goto done;
503 tmp_num_values++;
505 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
506 goto done;
509 /* now add the includes at the end */
510 werr = smbconf_reg_get_includes_internal(tmp_ctx, key, &num_includes,
511 &includes);
512 if (!W_ERROR_IS_OK(werr)) {
513 goto done;
515 for (count = 0; count < num_includes; count++) {
516 werr = smbconf_add_string_to_array(tmp_ctx, &tmp_valnames,
517 tmp_num_values, "include");
518 if (!W_ERROR_IS_OK(werr)) {
519 goto done;
522 werr = smbconf_add_string_to_array(tmp_ctx, &tmp_valstrings,
523 tmp_num_values,
524 includes[count]);
525 if (!W_ERROR_IS_OK(werr)) {
526 goto done;
529 tmp_num_values++;
532 *num_values = tmp_num_values;
533 if (tmp_num_values > 0) {
534 *value_names = talloc_move(mem_ctx, &tmp_valnames);
535 *value_strings = talloc_move(mem_ctx, &tmp_valstrings);
536 } else {
537 *value_names = NULL;
538 *value_strings = NULL;
541 done:
542 TALLOC_FREE(tmp_ctx);
543 return werr;
546 static bool smbconf_reg_key_has_values(struct registry_key *key)
548 WERROR werr;
549 uint32_t num_subkeys;
550 uint32_t max_subkeylen;
551 uint32_t max_subkeysize;
552 uint32_t num_values;
553 uint32_t max_valnamelen;
554 uint32_t max_valbufsize;
555 uint32_t secdescsize;
556 NTTIME last_changed_time;
558 werr = reg_queryinfokey(key, &num_subkeys, &max_subkeylen,
559 &max_subkeysize, &num_values, &max_valnamelen,
560 &max_valbufsize, &secdescsize,
561 &last_changed_time);
562 if (!W_ERROR_IS_OK(werr)) {
563 return false;
566 return (num_values != 0);
570 * delete all values from a key
572 static WERROR smbconf_reg_delete_values(struct registry_key *key)
574 WERROR werr;
575 char *valname;
576 struct registry_value *valvalue;
577 uint32_t count;
578 TALLOC_CTX *mem_ctx = talloc_stackframe();
580 for (count = 0;
581 werr = reg_enumvalue(mem_ctx, key, count, &valname, &valvalue),
582 W_ERROR_IS_OK(werr);
583 count++)
585 werr = reg_deletevalue(key, valname);
586 if (!W_ERROR_IS_OK(werr)) {
587 goto done;
590 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
591 DEBUG(1, ("smbconf_reg_delete_values: "
592 "Error enumerating values of %s: %s\n",
593 key->key->name,
594 dos_errstr(werr)));
595 goto done;
598 werr = WERR_OK;
600 done:
601 TALLOC_FREE(mem_ctx);
602 return werr;
605 /**********************************************************************
607 * smbconf operations: registry implementations
609 **********************************************************************/
612 * initialize the registry smbconf backend
614 static WERROR smbconf_reg_init(struct smbconf_ctx *ctx, const char *path)
616 WERROR werr = WERR_OK;
618 if (path == NULL) {
619 path = KEY_SMBCONF;
621 ctx->path = talloc_strdup(ctx, path);
622 if (ctx->path == NULL) {
623 werr = WERR_NOMEM;
624 goto done;
627 ctx->data = TALLOC_ZERO_P(ctx, struct reg_private_data);
629 werr = ntstatus_to_werror(registry_create_admin_token(ctx,
630 &(rpd(ctx)->token)));
631 if (!W_ERROR_IS_OK(werr)) {
632 DEBUG(1, ("Error creating admin token\n"));
633 goto done;
635 rpd(ctx)->open = false;
637 werr = registry_init_smbconf(path);
638 if (!W_ERROR_IS_OK(werr)) {
639 goto done;
642 done:
643 return werr;
646 static int smbconf_reg_shutdown(struct smbconf_ctx *ctx)
648 return ctx->ops->close_conf(ctx);
651 static WERROR smbconf_reg_open(struct smbconf_ctx *ctx)
653 WERROR werr;
655 if (rpd(ctx)->open) {
656 return WERR_OK;
659 werr = regdb_open();
660 if (W_ERROR_IS_OK(werr)) {
661 rpd(ctx)->open = true;
663 return werr;
666 static int smbconf_reg_close(struct smbconf_ctx *ctx)
668 int ret;
670 if (!rpd(ctx)->open) {
671 return 0;
674 ret = regdb_close();
675 if (ret == 0) {
676 rpd(ctx)->open = false;
678 return ret;
682 * Get the change sequence number of the given service/parameter.
683 * service and parameter strings may be NULL.
685 static void smbconf_reg_get_csn(struct smbconf_ctx *ctx,
686 struct smbconf_csn *csn,
687 const char *service, const char *param)
689 if (csn == NULL) {
690 return;
693 if (!W_ERROR_IS_OK(ctx->ops->open_conf(ctx))) {
694 return;
697 csn->csn = (uint64_t)regdb_get_seqnum();
701 * Drop the whole configuration (restarting empty) - registry version
703 static WERROR smbconf_reg_drop(struct smbconf_ctx *ctx)
705 char *path, *p;
706 WERROR werr = WERR_OK;
707 struct registry_key *parent_key = NULL;
708 struct registry_key *new_key = NULL;
709 TALLOC_CTX* mem_ctx = talloc_stackframe();
710 enum winreg_CreateAction action;
712 path = talloc_strdup(mem_ctx, ctx->path);
713 if (path == NULL) {
714 werr = WERR_NOMEM;
715 goto done;
717 p = strrchr(path, '\\');
718 *p = '\0';
719 werr = smbconf_reg_open_path(mem_ctx, ctx, path, REG_KEY_WRITE,
720 &parent_key);
722 if (!W_ERROR_IS_OK(werr)) {
723 goto done;
726 werr = reg_deletekey_recursive(mem_ctx, parent_key, p+1);
728 if (!W_ERROR_IS_OK(werr)) {
729 goto done;
732 werr = reg_createkey(mem_ctx, parent_key, p+1, REG_KEY_WRITE,
733 &new_key, &action);
735 done:
736 TALLOC_FREE(mem_ctx);
737 return werr;
741 * get the list of share names defined in the configuration.
742 * registry version.
744 static WERROR smbconf_reg_get_share_names(struct smbconf_ctx *ctx,
745 TALLOC_CTX *mem_ctx,
746 uint32_t *num_shares,
747 char ***share_names)
749 uint32_t count;
750 uint32_t added_count = 0;
751 TALLOC_CTX *tmp_ctx = NULL;
752 WERROR werr = WERR_OK;
753 struct registry_key *key = NULL;
754 char *subkey_name = NULL;
755 char **tmp_share_names = NULL;
757 if ((num_shares == NULL) || (share_names == NULL)) {
758 werr = WERR_INVALID_PARAM;
759 goto done;
762 tmp_ctx = talloc_stackframe();
763 if (tmp_ctx == NULL) {
764 werr = WERR_NOMEM;
765 goto done;
768 /* if there are values in the base key, return NULL as share name */
769 werr = smbconf_reg_open_base_key(tmp_ctx, ctx,
770 SEC_RIGHTS_ENUM_SUBKEYS, &key);
771 if (!W_ERROR_IS_OK(werr)) {
772 goto done;
775 if (smbconf_reg_key_has_values(key)) {
776 werr = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
777 0, NULL);
778 if (!W_ERROR_IS_OK(werr)) {
779 goto done;
781 added_count++;
784 /* make sure "global" is always listed first */
785 if (smbconf_share_exists(ctx, GLOBAL_NAME)) {
786 werr = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
787 added_count, GLOBAL_NAME);
788 if (!W_ERROR_IS_OK(werr)) {
789 goto done;
791 added_count++;
794 for (count = 0;
795 werr = reg_enumkey(tmp_ctx, key, count, &subkey_name, NULL),
796 W_ERROR_IS_OK(werr);
797 count++)
799 if (strequal(subkey_name, GLOBAL_NAME)) {
800 continue;
803 werr = smbconf_add_string_to_array(tmp_ctx,
804 &tmp_share_names,
805 added_count,
806 subkey_name);
807 if (!W_ERROR_IS_OK(werr)) {
808 goto done;
810 added_count++;
812 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
813 goto done;
815 werr = WERR_OK;
817 *num_shares = added_count;
818 if (added_count > 0) {
819 *share_names = talloc_move(mem_ctx, &tmp_share_names);
820 } else {
821 *share_names = NULL;
824 done:
825 TALLOC_FREE(tmp_ctx);
826 return werr;
830 * check if a share/service of a given name exists - registry version
832 static bool smbconf_reg_share_exists(struct smbconf_ctx *ctx,
833 const char *servicename)
835 bool ret = false;
836 WERROR werr = WERR_OK;
837 TALLOC_CTX *mem_ctx = talloc_stackframe();
838 struct registry_key *key = NULL;
840 werr = smbconf_reg_open_service_key(mem_ctx, ctx, servicename,
841 REG_KEY_READ, &key);
842 if (W_ERROR_IS_OK(werr)) {
843 ret = true;
846 TALLOC_FREE(mem_ctx);
847 return ret;
851 * Add a service if it does not already exist - registry version
853 static WERROR smbconf_reg_create_share(struct smbconf_ctx *ctx,
854 const char *servicename)
856 WERROR werr;
857 TALLOC_CTX *mem_ctx = talloc_stackframe();
858 struct registry_key *key = NULL;
860 if (servicename == NULL) {
861 werr = smbconf_reg_open_base_key(mem_ctx, ctx, REG_KEY_WRITE,
862 &key);
863 } else {
864 werr = smbconf_reg_create_service_key(mem_ctx, ctx,
865 servicename, &key);
868 TALLOC_FREE(mem_ctx);
869 return werr;
873 * get a definition of a share (service) from configuration.
875 static WERROR smbconf_reg_get_share(struct smbconf_ctx *ctx,
876 TALLOC_CTX *mem_ctx,
877 const char *servicename,
878 struct smbconf_service **service)
880 WERROR werr = WERR_OK;
881 struct registry_key *key = NULL;
882 struct smbconf_service *tmp_service = NULL;
883 TALLOC_CTX *tmp_ctx = talloc_stackframe();
885 werr = smbconf_reg_open_service_key(tmp_ctx, ctx, servicename,
886 REG_KEY_READ, &key);
887 if (!W_ERROR_IS_OK(werr)) {
888 goto done;
891 tmp_service = TALLOC_ZERO_P(tmp_ctx, struct smbconf_service);
892 if (tmp_service == NULL) {
893 werr = WERR_NOMEM;
894 goto done;
897 if (servicename != NULL) {
898 tmp_service->name = talloc_strdup(tmp_service, servicename);
899 if (tmp_service->name == NULL) {
900 werr = WERR_NOMEM;
901 goto done;
905 werr = smbconf_reg_get_values(tmp_service, key,
906 &(tmp_service->num_params),
907 &(tmp_service->param_names),
908 &(tmp_service->param_values));
910 if (W_ERROR_IS_OK(werr)) {
911 *service = talloc_move(mem_ctx, &tmp_service);
914 done:
915 TALLOC_FREE(tmp_ctx);
916 return werr;
920 * delete a service from configuration
922 static WERROR smbconf_reg_delete_share(struct smbconf_ctx *ctx,
923 const char *servicename)
925 WERROR werr = WERR_OK;
926 struct registry_key *key = NULL;
927 TALLOC_CTX *mem_ctx = talloc_stackframe();
929 werr = smbconf_reg_open_base_key(mem_ctx, ctx, REG_KEY_WRITE, &key);
930 if (!W_ERROR_IS_OK(werr)) {
931 goto done;
934 if (servicename != NULL) {
935 werr = reg_deletekey_recursive(key, key, servicename);
936 } else {
937 werr = smbconf_reg_delete_values(key);
940 done:
941 TALLOC_FREE(mem_ctx);
942 return werr;
946 * set a configuration parameter to the value provided.
948 static WERROR smbconf_reg_set_parameter(struct smbconf_ctx *ctx,
949 const char *service,
950 const char *param,
951 const char *valstr)
953 WERROR werr;
954 struct registry_key *key = NULL;
955 TALLOC_CTX *mem_ctx = talloc_stackframe();
957 werr = smbconf_reg_open_service_key(mem_ctx, ctx, service,
958 REG_KEY_WRITE, &key);
959 if (!W_ERROR_IS_OK(werr)) {
960 goto done;
963 werr = smbconf_reg_set_value(key, param, valstr);
965 done:
966 TALLOC_FREE(mem_ctx);
967 return werr;
971 * get the value of a configuration parameter as a string
973 static WERROR smbconf_reg_get_parameter(struct smbconf_ctx *ctx,
974 TALLOC_CTX *mem_ctx,
975 const char *service,
976 const char *param,
977 char **valstr)
979 WERROR werr = WERR_OK;
980 struct registry_key *key = NULL;
981 struct registry_value *value = NULL;
983 werr = smbconf_reg_open_service_key(mem_ctx, ctx, service,
984 REG_KEY_READ, &key);
985 if (!W_ERROR_IS_OK(werr)) {
986 goto done;
989 if (!smbconf_reg_valname_valid(param)) {
990 werr = WERR_INVALID_PARAM;
991 goto done;
994 if (!smbconf_value_exists(key, param)) {
995 werr = WERR_INVALID_PARAM;
996 goto done;
999 werr = reg_queryvalue(mem_ctx, key, param, &value);
1000 if (!W_ERROR_IS_OK(werr)) {
1001 goto done;
1004 *valstr = smbconf_format_registry_value(mem_ctx, value);
1006 if (*valstr == NULL) {
1007 werr = WERR_NOMEM;
1010 done:
1011 TALLOC_FREE(key);
1012 TALLOC_FREE(value);
1013 return werr;
1017 * delete a parameter from configuration
1019 static WERROR smbconf_reg_delete_parameter(struct smbconf_ctx *ctx,
1020 const char *service,
1021 const char *param)
1023 struct registry_key *key = NULL;
1024 WERROR werr = WERR_OK;
1025 TALLOC_CTX *mem_ctx = talloc_stackframe();
1027 werr = smbconf_reg_open_service_key(mem_ctx, ctx, service,
1028 REG_KEY_ALL, &key);
1029 if (!W_ERROR_IS_OK(werr)) {
1030 goto done;
1033 if (!smbconf_reg_valname_valid(param)) {
1034 werr = WERR_INVALID_PARAM;
1035 goto done;
1038 if (!smbconf_value_exists(key, param)) {
1039 werr = WERR_INVALID_PARAM;
1040 goto done;
1043 werr = reg_deletevalue(key, param);
1045 done:
1046 TALLOC_FREE(mem_ctx);
1047 return werr;
1050 static WERROR smbconf_reg_get_includes(struct smbconf_ctx *ctx,
1051 TALLOC_CTX *mem_ctx,
1052 const char *service,
1053 uint32_t *num_includes,
1054 char ***includes)
1056 WERROR werr;
1057 struct registry_key *key = NULL;
1058 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1060 werr = smbconf_reg_open_service_key(tmp_ctx, ctx, service,
1061 REG_KEY_READ, &key);
1062 if (!W_ERROR_IS_OK(werr)) {
1063 goto done;
1066 werr = smbconf_reg_get_includes_internal(mem_ctx, key, num_includes,
1067 includes);
1069 done:
1070 TALLOC_FREE(tmp_ctx);
1071 return werr;
1074 static WERROR smbconf_reg_set_includes(struct smbconf_ctx *ctx,
1075 const char *service,
1076 uint32_t num_includes,
1077 const char **includes)
1079 WERROR werr = WERR_OK;
1080 struct registry_key *key = NULL;
1081 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1083 werr = smbconf_reg_open_service_key(tmp_ctx, ctx, service,
1084 REG_KEY_ALL, &key);
1085 if (!W_ERROR_IS_OK(werr)) {
1086 goto done;
1089 if (num_includes == 0) {
1090 if (!smbconf_value_exists(key, INCLUDES_VALNAME)) {
1091 goto done;
1093 werr = reg_deletevalue(key, INCLUDES_VALNAME);
1094 } else {
1095 werr = smbconf_reg_set_multi_sz_value(key, INCLUDES_VALNAME,
1096 num_includes, includes);
1099 done:
1100 TALLOC_FREE(tmp_ctx);
1101 return werr;
1104 static WERROR smbconf_reg_delete_includes(struct smbconf_ctx *ctx,
1105 const char *service)
1107 WERROR werr = WERR_OK;
1108 struct registry_key *key = NULL;
1109 TALLOC_CTX *tmp_ctx = talloc_stackframe();
1111 werr = smbconf_reg_open_service_key(tmp_ctx, ctx, service,
1112 REG_KEY_ALL, &key);
1113 if (!W_ERROR_IS_OK(werr)) {
1114 goto done;
1117 if (!smbconf_value_exists(key, INCLUDES_VALNAME)) {
1118 goto done;
1121 werr = reg_deletevalue(key, INCLUDES_VALNAME);
1124 done:
1125 TALLOC_FREE(tmp_ctx);
1126 return werr;
1129 struct smbconf_ops smbconf_ops_reg = {
1130 .init = smbconf_reg_init,
1131 .shutdown = smbconf_reg_shutdown,
1132 .open_conf = smbconf_reg_open,
1133 .close_conf = smbconf_reg_close,
1134 .get_csn = smbconf_reg_get_csn,
1135 .drop = smbconf_reg_drop,
1136 .get_share_names = smbconf_reg_get_share_names,
1137 .share_exists = smbconf_reg_share_exists,
1138 .create_share = smbconf_reg_create_share,
1139 .get_share = smbconf_reg_get_share,
1140 .delete_share = smbconf_reg_delete_share,
1141 .set_parameter = smbconf_reg_set_parameter,
1142 .get_parameter = smbconf_reg_get_parameter,
1143 .delete_parameter = smbconf_reg_delete_parameter,
1144 .get_includes = smbconf_reg_get_includes,
1145 .set_includes = smbconf_reg_set_includes,
1146 .delete_includes = smbconf_reg_delete_includes,
1151 * initialize the smbconf registry backend
1152 * the only function that is exported from this module
1154 WERROR smbconf_init_reg(TALLOC_CTX *mem_ctx, struct smbconf_ctx **conf_ctx,
1155 const char *path)
1157 return smbconf_init_internal(mem_ctx, conf_ctx, path, &smbconf_ops_reg);