2 * Samba Unix/Linux SMB client library
3 * Distributed SMB/CIFS Server Management Utility
4 * Local configuration interface
5 * Copyright (C) Michael Adam 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 2 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, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * This is an interface to the configuration stored inside the
24 * samba registry. In the future there might be support for other
25 * configuration backends as well.
29 #include "utils/net.h"
35 static int net_conf_list_usage(int argc, const char **argv)
37 d_printf("USAGE: net conf list\n");
41 static int net_conf_import_usage(int argc, const char**argv)
43 d_printf("USAGE: net conf import [--test|-T] <filename> [<servicename>]\n"
44 "\t[--test|-T] testmode - do not act, just print "
45 "what would be done\n"
46 "\t<servicename> only import service <servicename>, "
51 static int net_conf_listshares_usage(int argc, const char **argv)
53 d_printf("USAGE: net conf listshares\n");
57 static int net_conf_showshare_usage(int argc, const char **argv)
59 d_printf("USAGE: net conf showshare <sharename>\n");
63 static int net_conf_addshare_usage(int argc, const char **argv)
65 d_printf("USAGE: net conf addshare <sharename> <path> "
66 "[writeable={y|N} [guest_ok={y|N} [<comment>]]\n"
67 "\t<sharename> the new share name.\n"
68 "\t<path> the path on the filesystem to export.\n"
69 "\twriteable={y|N} set \"writeable to \"yes\" or "
70 "\"no\" (default) on this share.\n"
71 "\tguest_ok={y|N} set \"guest ok\" to \"yes\" or "
72 "\"no\" (default) on this share.\n"
73 "\t<comment> optional comment for the new share.\n");
77 static int net_conf_delshare_usage(int argc, const char **argv)
79 d_printf("USAGE: net conf delshare <sharename>\n");
83 static int net_conf_setparm_usage(int argc, const char **argv)
85 d_printf("USAGE: net conf setparm <section> <param> <type> <value>\n"
86 "\t(Supported types are 'dword' and 'sz' by now.)\n");
90 static int net_conf_getparm_usage(int argc, const char **argv)
92 d_printf("USAGE: net conf getparm <section> <param>\n");
96 static int net_conf_delparm_usage(int argc, const char **argv)
98 d_printf("USAGE: net conf delparm <section> <param>\n");
107 static char *format_value(TALLOC_CTX *mem_ctx, struct registry_value *value)
111 /* what if mem_ctx = NULL? */
113 switch (value->type) {
115 result = talloc_asprintf(mem_ctx, "%d", value->v.dword);
119 result = talloc_asprintf(mem_ctx, "%s", value->v.sz.str);
123 for (j = 0; j < value->v.multi_sz.num_strings; j++) {
124 result = talloc_asprintf(mem_ctx, "\"%s\" ",
125 value->v.multi_sz.strings[j]);
130 result = talloc_asprintf(mem_ctx, "binary (%d bytes)",
131 (int)value->v.binary.length);
134 result = talloc_asprintf(mem_ctx, "<unprintable>");
141 * add a value to a key.
143 static WERROR reg_setvalue_internal(struct registry_key *key,
148 struct registry_value val;
149 WERROR werr = WERR_OK;
153 if (strequal(valtype, "dword")) {
154 val.type = REG_DWORD;
155 val.v.dword = strtoul(valstr, NULL, 10);
157 else if (strequal(valtype, "sz")) {
159 val.v.sz.str = CONST_DISCARD(char *, valstr);
160 val.v.sz.len = strlen(valstr) + 1;
163 d_fprintf(stderr, "Sorry, only value types DWORD and SZ implementd currently for setting values.\n");
167 werr = reg_setvalue(key, valname, &val);
168 if (!W_ERROR_IS_OK(werr)) {
170 "Error adding value '%s' to "
172 valname, key->key->name, dos_errstr(werr));
180 * Open a subkey of KEY_SMBCONF (i.e a service)
181 * - variant without error output (q = quiet)-
183 static WERROR smbconf_open_path_q(TALLOC_CTX *ctx, const char *subkeyname,
184 uint32 desired_access,
185 struct registry_key **key)
187 WERROR werr = WERR_OK;
189 NT_USER_TOKEN *token;
191 if (!(token = registry_create_admin_token(ctx))) {
192 DEBUG(1, ("Error creating admin token\n"));
196 if (subkeyname == NULL) {
197 path = talloc_strdup(ctx, KEY_SMBCONF);
200 path = talloc_asprintf(ctx, "%s\\%s", KEY_SMBCONF, subkeyname);
203 werr = reg_open_path(ctx, path, desired_access,
212 * Open a subkey of KEY_SMBCONF (i.e a service)
213 * - variant with error output -
215 static WERROR smbconf_open_path(TALLOC_CTX *ctx, const char *subkeyname,
216 uint32 desired_access,
217 struct registry_key **key)
219 WERROR werr = WERR_OK;
221 werr = smbconf_open_path_q(ctx, subkeyname, desired_access, key);
222 if (!W_ERROR_IS_OK(werr)) {
223 d_fprintf(stderr, "Error opening registry path '%s\\%s': %s\n",
225 (subkeyname == NULL) ? "" : subkeyname,
233 * open the base key KEY_SMBCONF
235 static WERROR smbconf_open_basepath(TALLOC_CTX *ctx, uint32 desired_access,
236 struct registry_key **key)
238 return smbconf_open_path(ctx, NULL, desired_access, key);
242 * delete a subkey of KEY_SMBCONF
244 static WERROR reg_delkey_internal(TALLOC_CTX *ctx, const char *keyname)
246 WERROR werr = WERR_OK;
247 struct registry_key *key = NULL;
249 werr = smbconf_open_basepath(ctx, REG_KEY_WRITE, &key);
250 if (!W_ERROR_IS_OK(werr)) {
254 werr = reg_deletekey(key, keyname);
255 if (!W_ERROR_IS_OK(werr)) {
256 d_fprintf(stderr, "Error deleting registry key %s\\%s: %s\n",
257 KEY_SMBCONF, keyname, dos_errstr(werr));
266 * create a subkey of KEY_SMBCONF
268 static WERROR reg_createkey_internal(TALLOC_CTX *ctx,
269 const char * subkeyname,
270 struct registry_key **newkey)
272 WERROR werr = WERR_OK;
273 struct registry_key *create_parent = NULL;
274 TALLOC_CTX *create_ctx;
275 enum winreg_CreateAction action = REG_ACTION_NONE;
277 /* create a new talloc ctx for creation. it will hold
278 * the intermediate parent key (SMBCONF) for creation
279 * and will be destroyed when leaving this function... */
280 if (!(create_ctx = talloc_new(ctx))) {
285 werr = smbconf_open_basepath(create_ctx, REG_KEY_WRITE, &create_parent);
286 if (!W_ERROR_IS_OK(werr)) {
290 werr = reg_createkey(ctx, create_parent, subkeyname,
291 REG_KEY_WRITE, newkey, &action);
292 if (W_ERROR_IS_OK(werr) && (action != REG_CREATED_NEW_KEY)) {
293 d_fprintf(stderr, "Key '%s' already exists.\n", subkeyname);
294 werr = WERR_ALREADY_EXISTS;
296 if (!W_ERROR_IS_OK(werr)) {
297 d_fprintf(stderr, "Error creating key %s: %s\n",
298 subkeyname, dos_errstr(werr));
302 TALLOC_FREE(create_ctx);
307 * check if a subkey of KEY_SMBCONF of a given name exists
309 static BOOL smbconf_key_exists(TALLOC_CTX *ctx, const char *subkeyname)
312 WERROR werr = WERR_OK;
314 struct registry_key *key;
316 if (!(mem_ctx = talloc_new(ctx))) {
317 d_fprintf(stderr, "ERROR: Out of memory...!\n");
321 werr = smbconf_open_path_q(mem_ctx, subkeyname, REG_KEY_READ, &key);
322 if (W_ERROR_IS_OK(werr)) {
327 TALLOC_FREE(mem_ctx);
331 static BOOL smbconf_value_exists(TALLOC_CTX *ctx, struct registry_key *key,
335 WERROR werr = WERR_OK;
336 struct registry_value *value = NULL;
338 werr = reg_queryvalue(ctx, key, param, &value);
339 if (W_ERROR_IS_OK(werr)) {
347 static WERROR list_values(TALLOC_CTX *ctx, struct registry_key *key)
349 WERROR werr = WERR_OK;
351 struct registry_value *valvalue = NULL;
352 char *valname = NULL;
355 W_ERROR_IS_OK(werr = reg_enumvalue(ctx, key, idx, &valname,
359 d_printf("\t%s = %s\n", valname, format_value(ctx, valvalue));
361 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
362 d_fprintf(stderr, "Error enumerating values: %s\n",
372 static int import_process_service(TALLOC_CTX *ctx,
373 struct share_params *share)
376 struct parm_struct *parm;
378 const char *servicename;
379 struct registry_key *key;
381 const char *valtype = NULL;
384 servicename = (share->service == GLOBAL_SECTION_SNUM)?
385 GLOBAL_NAME : lp_servicename(share->service);
388 d_printf("[%s]\n", servicename);
391 if (smbconf_key_exists(ctx, servicename)) {
392 werr = reg_delkey_internal(ctx, servicename);
393 if (!W_ERROR_IS_OK(werr)) {
397 werr = reg_createkey_internal(ctx, servicename, &key);
398 if (!W_ERROR_IS_OK(werr)) {
403 while ((parm = lp_next_parameter(share->service, &pnum, 0)))
405 void *ptr = parm->ptr;
408 if ((share->service < 0 && parm->p_class == P_LOCAL)
409 && !(parm->flags & FLAG_GLOBAL))
412 if (parm->p_class == P_LOCAL && share->service >= 0) {
413 ptr = lp_local_ptr(share->service, ptr);
418 switch (parm->type) {
420 valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
424 valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
428 valstr = talloc_asprintf(ctx, "%s", (char *)ptr);
431 valstr = talloc_asprintf(ctx, "%s",
432 BOOLSTR(*(BOOL *)ptr));
435 valstr = talloc_asprintf(ctx, "%s",
436 BOOLSTR(!*(BOOL *)ptr));
439 for (i = 0; parm->enum_list[i].name; i++) {
441 parm->enum_list[i].value)
443 valstr = talloc_asprintf(ctx, "%s",
444 parm->enum_list[i].name);
450 talloc_asprintf(ctx, "%s", octal_string(*(int *)ptr));
453 valstr = talloc_strdup(ctx, "");
454 if ((char ***)ptr && *(char ***)ptr) {
455 char **list = *(char ***)ptr;
456 for (; *list; list++) {
457 /* surround strings with whitespace
458 * in double quotes */
459 if (strchr_m(*list, ' '))
461 valstr = talloc_asprintf_append(
464 ((*(list+1))?", ":""));
467 valstr = talloc_asprintf_append(
468 valstr, "%s%s", *list,
469 ((*(list+1))?", ":""));
476 talloc_asprintf(ctx, "%d", *(int *)ptr);
481 valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
485 if (parm->type != P_SEP) {
487 d_printf("\t%s = %s\n", parm->label, valstr);
490 werr = reg_setvalue_internal(key, parm->label,
492 if (!W_ERROR_IS_OK(werr)) {
513 int net_conf_list(int argc, const char **argv)
515 WERROR werr = WERR_OK;
518 struct registry_key *base_key = NULL;
519 struct registry_key *sub_key = NULL;
521 char *subkey_name = NULL;
523 ctx = talloc_init("list");
526 net_conf_list_usage(argc, argv);
530 werr = smbconf_open_basepath(ctx, REG_KEY_READ, &base_key);
531 if (!W_ERROR_IS_OK(werr)) {
535 if (smbconf_key_exists(ctx, GLOBAL_NAME)) {
536 werr = reg_openkey(ctx, base_key, GLOBAL_NAME,
537 REG_KEY_READ, &sub_key);
538 if (!W_ERROR_IS_OK(werr)) {
539 d_fprintf(stderr, "Error opening subkey '%s' : %s\n",
540 subkey_name, dos_errstr(werr));
543 d_printf("[%s]\n", GLOBAL_NAME);
544 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
551 W_ERROR_IS_OK(werr = reg_enumkey(ctx, base_key, idx_key,
552 &subkey_name, NULL));
555 if (strequal(subkey_name, GLOBAL_NAME)) {
558 d_printf("[%s]\n", subkey_name);
560 werr = reg_openkey(ctx, base_key, subkey_name,
561 REG_KEY_READ, &sub_key);
562 if (!W_ERROR_IS_OK(werr)) {
564 "Error opening subkey '%s': %s\n",
565 subkey_name, dos_errstr(werr));
568 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
573 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
574 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
586 int net_conf_import(int argc, const char **argv)
589 const char *filename = NULL;
590 const char *servicename = NULL;
591 BOOL service_found = False;
593 struct share_iterator *shares;
594 struct share_params *share;
595 struct share_params global_share = { GLOBAL_SECTION_SNUM };
597 ctx = talloc_init("net_conf_import");
602 net_conf_import_usage(argc, argv);
605 servicename = argv[1];
611 DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
614 /* TODO: check for existence and readability */
616 if (!lp_load(filename,
617 False, /* global_only */
618 True, /* save_defaults */
620 True)) /* initialize_globals */
622 d_fprintf(stderr, "Error parsing configuration file.\n");
627 d_printf("\nTEST MODE - would import the following configuration:\n\n");
630 if ((servicename == NULL) || strequal(servicename, GLOBAL_NAME)) {
631 service_found = True;
632 if (import_process_service(ctx, &global_share) != 0) {
637 if (service_found && (servicename != NULL)) {
642 if (!(shares = share_list_all(ctx))) {
643 d_fprintf(stderr, "Could not list shares...\n");
646 while ((share = next_share(shares)) != NULL) {
647 if ((servicename == NULL)
648 || strequal(servicename, lp_servicename(share->service)))
650 service_found = True;
651 if (import_process_service(ctx, share)!= 0) {
657 if ((servicename != NULL) && !service_found) {
658 d_printf("Share %s not found in file %s\n",
659 servicename, filename);
671 int net_conf_listshares(int argc, const char **argv)
673 WERROR werr = WERR_OK;
675 struct registry_key *key;
677 char *subkey_name = NULL;
680 ctx = talloc_init("listshares");
683 net_conf_listshares_usage(argc, argv);
687 werr = smbconf_open_basepath(ctx, SEC_RIGHTS_ENUM_SUBKEYS, &key);
688 if (!W_ERROR_IS_OK(werr)) {
693 W_ERROR_IS_OK(werr = reg_enumkey(ctx, key, idx,
694 &subkey_name, NULL));
697 d_printf("%s\n", subkey_name);
699 if (! W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
700 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
712 int net_conf_showshare(int argc, const char **argv)
715 WERROR werr = WERR_OK;
716 struct registry_key *key = NULL;
719 ctx = talloc_init("showshare");
722 net_conf_showshare_usage(argc, argv);
726 werr = smbconf_open_path(ctx, argv[0], REG_KEY_READ, &key);
727 if (!W_ERROR_IS_OK(werr)) {
731 d_printf("[%s]\n", argv[0]);
733 if (!W_ERROR_IS_OK(list_values(ctx, key))) {
744 int net_conf_addshare(int argc, const char **argv)
747 WERROR werr = WERR_OK;
748 struct registry_key *newkey = NULL;
749 char *sharename = NULL;
750 const char *path = NULL;
751 const char *comment = NULL;
752 const char *guest_ok = "no";
753 const char *writeable = "no";
754 SMB_STRUCT_STAT sbuf;
760 net_conf_addshare_usage(argc, argv);
765 if (!strnequal(argv[3], "guest_ok=", 9)) {
766 net_conf_addshare_usage(argc, argv);
769 switch (argv[3][9]) {
779 net_conf_addshare_usage(argc, argv);
783 if (!strnequal(argv[2], "writeable=", 10)) {
784 net_conf_addshare_usage(argc, argv);
787 switch (argv[2][10]) {
797 net_conf_addshare_usage(argc, argv);
803 sharename = strdup_lower(argv[0]);
811 /* validate share name */
813 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
816 d_fprintf(stderr, "ERROR: share name %s contains "
817 "invalid characters (any of %s)\n",
818 sharename, INVALID_SHARENAME_CHARS);
822 if (getpwnam(sharename)) {
823 d_fprintf(stderr, "ERROR: share name %s is already a valid "
824 "system user name.\n", sharename);
828 if (strequal(sharename, GLOBAL_NAME)) {
830 "ERROR: 'global' is not a valid share name.\n");
836 if (path[0] != '/') {
838 "Error: path '%s' is not an absolute path.\n",
843 if (sys_stat(path, &sbuf) != 0) {
845 "ERROR: cannot stat path '%s' to ensure "
846 "this is a directory.\n"
848 path, strerror(errno));
852 if (!S_ISDIR(sbuf.st_mode)) {
854 "ERROR: path '%s' is not a directory.\n",
863 werr = reg_createkey_internal(NULL, argv[0], &newkey);
864 if (!W_ERROR_IS_OK(werr)) {
868 /* add config params as values */
870 werr = reg_setvalue_internal(newkey, "path", "sz", path);
871 if (!W_ERROR_IS_OK(werr))
874 if (comment != NULL) {
875 werr = reg_setvalue_internal(newkey, "comment", "sz", comment);
876 if (!W_ERROR_IS_OK(werr))
880 werr = reg_setvalue_internal(newkey, "guest ok", "sz", guest_ok);
881 if (!W_ERROR_IS_OK(werr))
884 werr = reg_setvalue_internal(newkey, "writeable", "sz", writeable);
885 if (!W_ERROR_IS_OK(werr))
892 SAFE_FREE(sharename);
896 int net_conf_delshare(int argc, const char **argv)
899 const char *sharename = NULL;
902 net_conf_delshare_usage(argc, argv);
907 if (W_ERROR_IS_OK(reg_delkey_internal(NULL, sharename))) {
914 static int net_conf_setparm(int argc, const char **argv)
917 WERROR werr = WERR_OK;
918 struct registry_key *key = NULL;
919 char *service = NULL;
922 const char *value_str = NULL;
925 ctx = talloc_init("setparm");
928 net_conf_setparm_usage(argc, argv);
931 service = strdup_lower(argv[0]);
932 param = strdup_lower(argv[1]);
933 type = strdup_lower(argv[2]);
936 if (!smbconf_key_exists(ctx, service)) {
937 werr = reg_createkey_internal(ctx, service, &key);
940 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
942 if (!W_ERROR_IS_OK(werr)) {
946 werr = reg_setvalue_internal(key, param, type, value_str);
947 if (!W_ERROR_IS_OK(werr)) {
948 d_fprintf(stderr, "Error setting value '%s': %s\n",
949 param, dos_errstr(werr));
962 static int net_conf_getparm(int argc, const char **argv)
965 WERROR werr = WERR_OK;
966 struct registry_key *key = NULL;
967 char *service = NULL;
969 struct registry_value *value = NULL;
972 ctx = talloc_init("getparm");
975 net_conf_getparm_usage(argc, argv);
978 service = strdup_lower(argv[0]);
979 param = strdup_lower(argv[1]);
981 if (!smbconf_key_exists(ctx, service)) {
983 "ERROR: given service '%s' does not exist.\n",
988 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
989 if (!W_ERROR_IS_OK(werr)) {
993 werr = reg_queryvalue(ctx, key, param, &value);
994 if (!W_ERROR_IS_OK(werr)) {
995 d_fprintf(stderr, "Error querying value '%s': %s.\n",
996 param, dos_errstr(werr));
1000 d_printf("%s\n", format_value(ctx, value));
1010 static int net_conf_delparm(int argc, const char **argv)
1013 WERROR werr = WERR_OK;
1014 struct registry_key *key = NULL;
1015 char *service = NULL;
1019 ctx = talloc_init("delparm");
1022 net_conf_delparm_usage(argc, argv);
1025 service = strdup_lower(argv[0]);
1026 param = strdup_lower(argv[1]);
1028 if (!smbconf_key_exists(ctx, service)) {
1030 "Error: given service '%s' does not exist.\n",
1035 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
1036 if (!W_ERROR_IS_OK(werr)) {
1040 if (!smbconf_value_exists(ctx, key, param)) {
1042 "Error: given parameter '%s' is not set.\n",
1046 werr = reg_deletevalue(key, param);
1047 if (!W_ERROR_IS_OK(werr)) {
1048 d_fprintf(stderr, "Error deleting value '%s': %s.\n",
1049 param, dos_errstr(werr));
1060 * Entry-point for all the CONF functions.
1063 int net_conf(int argc, const char **argv)
1066 struct functable2 func[] = {
1067 {"list", net_conf_list,
1068 "Dump the complete configuration in smb.conf like format."},
1069 {"import", net_conf_import,
1070 "Import configuration from file in smb.conf format."},
1071 {"listshares", net_conf_listshares,
1072 "List the registry shares."},
1073 {"showshare", net_conf_showshare,
1074 "Show the definition of a registry share."},
1075 {"addshare", net_conf_addshare,
1076 "Create a new registry share."},
1077 {"delshare", net_conf_delshare,
1078 "Delete a registry share."},
1079 {"setparm", net_conf_setparm,
1080 "Store a parameter."},
1081 {"getparm", net_conf_getparm,
1082 "Retrieve the value of a parameter."},
1083 {"delparm", net_conf_delparm,
1084 "Delete a parameter."},
1088 if (!registry_init_regdb()) {
1089 d_fprintf(stderr, "Error initializing the registry!\n");
1093 ret = net_run_function2(argc, argv, "net conf", func);