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 currently only an interface to the configuration
24 * stored inside the samba registry. In the future there
25 * might be support for other configuration backends as well.
31 * - check uid 0 for write operations
32 * - check for valid parameter names and types (loadparm...) ???
33 * - check for correctness of shares (service_ok) ?
34 * - refactor to use _internal functions for pieces of code
39 #include "utils/net.h"
41 extern REGISTRY_OPS smbconf_reg_ops;
47 static int net_conf_list_usage(int argc, const char **argv)
49 d_printf("USAGE: net conf list\n");
53 static int net_conf_import_usage(int argc, const char**argv)
55 d_printf("USAGE: net conf import [--test|-T] <filename> [<servicename>]\n"
56 "\t[--test|-T] testmode - do not act, just print "
57 "what would be done\n"
58 "\t<servicename> only import service <servicename>, "
63 static int net_conf_listshares_usage(int argc, const char **argv)
65 d_printf("USAGE: net conf listshares\n");
69 static int net_conf_showshare_usage(int argc, const char **argv)
71 d_printf("USAGE: net conf showshare <sharename>\n");
75 static int net_conf_addshare_usage(int argc, const char **argv)
77 d_printf("USAGE: net conf addshare <sharename> <path> "
78 "[writeable={y|N} [guest_ok={y|N} [<comment>]]\n"
79 "\t<sharename> the new share name.\n"
80 "\t<path> the path on the filesystem to export.\n"
81 "\twriteable={y|N} set \"writeable to \"yes\" or "
82 "\"no\" (default) on this share.\n"
83 "\tguest_ok={y|N} set \"guest ok\" to \"yes\" or "
84 "\"no\" (default) on this share.\n"
85 "\t<comment> optional comment for the new share.\n");
89 static int net_conf_delshare_usage(int argc, const char **argv)
91 d_printf("USAGE: net conf delshare <sharename>\n");
95 static int net_conf_setparm_usage(int argc, const char **argv)
97 d_printf("USAGE: net conf setparm <section> <param> <type> <value>\n"
98 "\t(Supported types are 'dword' and 'sz' by now.)\n");
102 static int net_conf_getparm_usage(int argc, const char **argv)
104 d_printf("USAGE: net conf getparm <section> <param>\n");
108 static int net_conf_delparm_usage(int argc, const char **argv)
110 d_printf("USAGE: net conf delparm <section> <param>\n");
119 static char *format_value(TALLOC_CTX *mem_ctx, struct registry_value *value)
123 /* what if mem_ctx = NULL? */
125 switch (value->type) {
127 result = talloc_asprintf(mem_ctx, "%d", value->v.dword);
131 result = talloc_asprintf(mem_ctx, "%s", value->v.sz.str);
135 for (j = 0; j < value->v.multi_sz.num_strings; j++) {
136 result = talloc_asprintf(mem_ctx, "\"%s\" ",
137 value->v.multi_sz.strings[j]);
142 result = talloc_asprintf(mem_ctx, "binary (%d bytes)",
143 (int)value->v.binary.length);
146 result = talloc_asprintf(mem_ctx, "<unprintable>");
153 * add a value to a key.
155 static WERROR reg_setvalue_internal(struct registry_key *key,
160 struct registry_value val;
161 WERROR werr = WERR_OK;
165 if (strequal(valtype, "dword")) {
166 val.type = REG_DWORD;
167 val.v.dword = strtoul(valstr, NULL, 10);
169 else if (strequal(valtype, "sz")) {
171 val.v.sz.str = CONST_DISCARD(char *, valstr);
172 val.v.sz.len = strlen(valstr) + 1;
175 d_fprintf(stderr, "Sorry, only value types DWORD and SZ implementd currently for setting values.\n");
179 werr = reg_setvalue(key, valname, &val);
180 if (!W_ERROR_IS_OK(werr)) {
182 "Error adding value '%s' to "
184 valname, key->key->name, dos_errstr(werr));
192 * Open a subkey of KEY_SMBCONF (i.e a service)
193 * - variant without error output (q = quiet)-
195 static WERROR smbconf_open_path_q(TALLOC_CTX *ctx, const char *subkeyname,
196 uint32 desired_access,
197 struct registry_key **key)
199 WERROR werr = WERR_OK;
202 if (subkeyname == NULL) {
203 path = talloc_strdup(ctx, KEY_SMBCONF);
206 path = talloc_asprintf(ctx, "%s\\%s", KEY_SMBCONF, subkeyname);
209 werr = reg_open_path(ctx, path, desired_access,
210 get_root_nt_token(), key);
217 * Open a subkey of KEY_SMBCONF (i.e a service)
218 * - variant with error output -
220 static WERROR smbconf_open_path(TALLOC_CTX *ctx, const char *subkeyname,
221 uint32 desired_access,
222 struct registry_key **key)
224 WERROR werr = WERR_OK;
226 werr = smbconf_open_path_q(ctx, subkeyname, desired_access, key);
227 if (!W_ERROR_IS_OK(werr)) {
228 d_fprintf(stderr, "Error opening registry path '%s\\%s': %s\n",
230 (subkeyname == NULL) ? "" : subkeyname,
238 * open the base key KEY_SMBCONF
240 static WERROR smbconf_open_basepath(TALLOC_CTX *ctx, uint32 desired_access,
241 struct registry_key **key)
243 return smbconf_open_path(ctx, NULL, desired_access, key);
247 * delete a subkey of KEY_SMBCONF
249 static WERROR reg_delkey_internal(TALLOC_CTX *ctx, const char *keyname)
251 WERROR werr = WERR_OK;
252 struct registry_key *key = NULL;
254 werr = smbconf_open_basepath(ctx, REG_KEY_WRITE, &key);
255 if (!W_ERROR_IS_OK(werr)) {
259 werr = reg_deletekey(key, keyname);
260 if (!W_ERROR_IS_OK(werr)) {
261 d_fprintf(stderr, "Error deleting registry key %s\\%s: %s\n",
262 KEY_SMBCONF, keyname, dos_errstr(werr));
271 * create a subkey of KEY_SMBCONF
273 static WERROR reg_createkey_internal(TALLOC_CTX *ctx,
274 const char * subkeyname,
275 struct registry_key **newkey)
277 WERROR werr = WERR_OK;
278 struct registry_key *create_parent = NULL;
279 TALLOC_CTX *create_ctx;
280 enum winreg_CreateAction action = REG_ACTION_NONE;
282 /* create a new talloc ctx for creation. it will hold
283 * the intermediate parent key (SMBCONF) for creation
284 * and will be destroyed when leaving this function... */
285 if (!(create_ctx = talloc_new(ctx))) {
290 werr = smbconf_open_basepath(create_ctx, REG_KEY_WRITE, &create_parent);
291 if (!W_ERROR_IS_OK(werr)) {
295 werr = reg_createkey(ctx, create_parent, subkeyname,
296 REG_KEY_WRITE, newkey, &action);
297 if (W_ERROR_IS_OK(werr) && (action != REG_CREATED_NEW_KEY)) {
298 d_fprintf(stderr, "Key '%s' already exists.\n", subkeyname);
299 werr = WERR_ALREADY_EXISTS;
301 if (!W_ERROR_IS_OK(werr)) {
302 d_fprintf(stderr, "Error creating key %s: %s\n",
303 subkeyname, dos_errstr(werr));
307 TALLOC_FREE(create_ctx);
312 * check if a subkey of KEY_SMBCONF of a given name exists
314 static BOOL smbconf_key_exists(TALLOC_CTX *ctx, const char *subkeyname)
317 WERROR werr = WERR_OK;
319 struct registry_key *key;
321 if (!(mem_ctx = talloc_new(ctx))) {
322 d_fprintf(stderr, "ERROR: Out of memory...!\n");
326 werr = smbconf_open_path_q(mem_ctx, subkeyname, REG_KEY_READ, &key);
327 if (W_ERROR_IS_OK(werr)) {
332 TALLOC_FREE(mem_ctx);
336 static BOOL smbconf_value_exists(TALLOC_CTX *ctx, struct registry_key *key,
340 WERROR werr = WERR_OK;
341 struct registry_value *value = NULL;
343 werr = reg_queryvalue(ctx, key, param, &value);
344 if (W_ERROR_IS_OK(werr)) {
352 static WERROR list_values(TALLOC_CTX *ctx, struct registry_key *key)
354 WERROR werr = WERR_OK;
356 struct registry_value *valvalue = NULL;
357 char *valname = NULL;
360 W_ERROR_IS_OK(werr = reg_enumvalue(ctx, key, idx, &valname,
364 d_printf("\t%s = %s\n", valname, format_value(ctx, valvalue));
366 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
367 d_fprintf(stderr, "Error enumerating values: %s\n",
377 static int import_process_service(TALLOC_CTX *ctx,
378 struct share_params *share)
381 struct parm_struct *parm;
383 const char *servicename;
384 struct registry_key *key;
386 const char *valtype = NULL;
389 servicename = (share->service == GLOBAL_SECTION_SNUM)?
390 GLOBAL_NAME : lp_servicename(share->service);
393 d_printf("[%s]\n", servicename);
396 if (smbconf_key_exists(ctx, servicename)) {
397 werr = reg_delkey_internal(ctx, servicename);
398 if (!W_ERROR_IS_OK(werr)) {
402 werr = reg_createkey_internal(ctx, servicename, &key);
403 if (!W_ERROR_IS_OK(werr)) {
408 while ((parm = lp_next_parameter(share->service, &pnum, 0)))
410 void *ptr = parm->ptr;
413 if ((share->service < 0 && parm->p_class == P_LOCAL)
414 && !(parm->flags & FLAG_GLOBAL))
417 if (parm->p_class == P_LOCAL && share->service >= 0) {
418 ptr = lp_local_ptr(share->service, ptr);
423 switch (parm->type) {
425 valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
429 valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
433 valstr = talloc_asprintf(ctx, "%s", (char *)ptr);
436 valstr = talloc_asprintf(ctx, "%s",
437 BOOLSTR(*(BOOL *)ptr));
440 valstr = talloc_asprintf(ctx, "%s",
441 BOOLSTR(!*(BOOL *)ptr));
444 for (i = 0; parm->enum_list[i].name; i++) {
446 parm->enum_list[i].value)
448 valstr = talloc_asprintf(ctx, "%s",
449 parm->enum_list[i].name);
455 talloc_asprintf(ctx, "%s", octal_string(*(int *)ptr));
458 valstr = talloc_strdup(ctx, "");
459 if ((char ***)ptr && *(char ***)ptr) {
460 char **list = *(char ***)ptr;
461 for (; *list; list++) {
462 /* surround strings with whitespace
463 * in double quotes */
464 if (strchr_m(*list, ' '))
466 valstr = talloc_asprintf_append(
469 ((*(list+1))?", ":""));
472 valstr = talloc_asprintf_append(
473 valstr, "%s%s", *list,
474 ((*(list+1))?", ":""));
481 talloc_asprintf(ctx, "%d", *(int *)ptr);
486 valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
490 if (parm->type != P_SEP) {
492 d_printf("\t%s = %s\n", parm->label, valstr);
495 werr = reg_setvalue_internal(key, parm->label,
497 if (!W_ERROR_IS_OK(werr)) {
518 int net_conf_list(int argc, const char **argv)
520 WERROR werr = WERR_OK;
523 struct registry_key *base_key = NULL;
524 struct registry_key *sub_key = NULL;
526 char *subkey_name = NULL;
528 ctx = talloc_init("list");
531 net_conf_list_usage(argc, argv);
535 werr = smbconf_open_basepath(ctx, REG_KEY_READ, &base_key);
536 if (!W_ERROR_IS_OK(werr)) {
540 if (smbconf_key_exists(ctx, GLOBAL_NAME)) {
541 werr = reg_openkey(ctx, base_key, GLOBAL_NAME,
542 REG_KEY_READ, &sub_key);
543 if (!W_ERROR_IS_OK(werr)) {
544 d_fprintf(stderr, "Error opening subkey '%s' : %s\n",
545 subkey_name, dos_errstr(werr));
548 d_printf("[%s]\n", GLOBAL_NAME);
549 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
556 W_ERROR_IS_OK(werr = reg_enumkey(ctx, base_key, idx_key,
557 &subkey_name, NULL));
560 if (strequal(subkey_name, GLOBAL_NAME)) {
563 d_printf("[%s]\n", subkey_name);
565 werr = reg_openkey(ctx, base_key, subkey_name,
566 REG_KEY_READ, &sub_key);
567 if (!W_ERROR_IS_OK(werr)) {
569 "Error opening subkey '%s': %s\n",
570 subkey_name, dos_errstr(werr));
573 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
578 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
579 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
591 int net_conf_import(int argc, const char **argv)
594 const char *filename = NULL;
595 const char *servicename = NULL;
596 BOOL service_found = False;
598 struct share_iterator *shares;
599 struct share_params *share;
600 struct share_params global_share = { GLOBAL_SECTION_SNUM };
602 ctx = talloc_init("net_conf_import");
607 net_conf_import_usage(argc, argv);
610 servicename = argv[1];
616 DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
619 /* TODO: check for existence and readability */
621 if (!lp_load(filename,
622 False, /* global_only */
623 True, /* save_defaults */
625 True)) /* initialize_globals */
627 d_fprintf(stderr, "Error parsing configuration file.\n");
632 d_printf("\nTEST MODE - would import the following configuration:\n\n");
635 if ((servicename == NULL) || strequal(servicename, GLOBAL_NAME)) {
636 service_found = True;
637 if (import_process_service(ctx, &global_share) != 0) {
642 if (service_found && (servicename != NULL)) {
647 if (!(shares = share_list_all(ctx))) {
648 d_fprintf(stderr, "Could not list shares...\n");
651 while ((share = next_share(shares)) != NULL) {
652 if ((servicename == NULL)
653 || strequal(servicename, lp_servicename(share->service)))
655 service_found = True;
656 if (import_process_service(ctx, share)!= 0) {
662 if ((servicename != NULL) && !service_found) {
663 d_printf("Share %s not found in file %s\n",
664 servicename, filename);
676 int net_conf_listshares(int argc, const char **argv)
678 WERROR werr = WERR_OK;
680 struct registry_key *key;
682 char *subkey_name = NULL;
685 ctx = talloc_init("listshares");
688 net_conf_listshares_usage(argc, argv);
692 werr = smbconf_open_basepath(ctx, SEC_RIGHTS_ENUM_SUBKEYS, &key);
693 if (!W_ERROR_IS_OK(werr)) {
698 W_ERROR_IS_OK(werr = reg_enumkey(ctx, key, idx,
699 &subkey_name, NULL));
702 d_printf("%s\n", subkey_name);
704 if (! W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
705 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
717 int net_conf_showshare(int argc, const char **argv)
720 WERROR werr = WERR_OK;
721 struct registry_key *key = NULL;
724 ctx = talloc_init("showshare");
727 net_conf_showshare_usage(argc, argv);
731 werr = smbconf_open_path(ctx, argv[0], REG_KEY_READ, &key);
732 if (!W_ERROR_IS_OK(werr)) {
736 d_printf("[%s]\n", argv[0]);
738 if (!W_ERROR_IS_OK(list_values(ctx, key))) {
749 int net_conf_addshare(int argc, const char **argv)
752 WERROR werr = WERR_OK;
753 struct registry_key *newkey = NULL;
754 char *sharename = NULL;
755 const char *path = NULL;
756 const char *comment = NULL;
757 const char *guest_ok = "no";
758 const char *writeable = "no";
759 SMB_STRUCT_STAT sbuf;
765 net_conf_addshare_usage(argc, argv);
770 if (!strnequal(argv[3], "guest_ok=", 9)) {
771 net_conf_addshare_usage(argc, argv);
774 switch (argv[3][9]) {
784 net_conf_addshare_usage(argc, argv);
788 if (!strnequal(argv[2], "writeable=", 10)) {
789 net_conf_addshare_usage(argc, argv);
792 switch (argv[2][10]) {
802 net_conf_addshare_usage(argc, argv);
808 sharename = strdup_lower(argv[0]);
816 /* validate share name */
818 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
821 d_fprintf(stderr, "ERROR: share name %s contains "
822 "invalid characters (any of %s)\n",
823 sharename, INVALID_SHARENAME_CHARS);
827 if (getpwnam(sharename)) {
828 d_fprintf(stderr, "ERROR: share name %s is already a valid "
829 "system user name.\n", sharename);
833 if (strequal(sharename, GLOBAL_NAME)) {
835 "ERROR: 'global' is not a valid share name.\n");
841 if (path[0] != '/') {
843 "Error: path '%s' is not an absolute path.\n",
848 if (sys_stat(path, &sbuf) != 0) {
850 "ERROR: cannot stat path '%s' to ensure "
851 "this is a directory.\n"
853 path, strerror(errno));
857 if (!S_ISDIR(sbuf.st_mode)) {
859 "ERROR: path '%s' is not a directory.\n",
868 werr = reg_createkey_internal(NULL, argv[0], &newkey);
869 if (!W_ERROR_IS_OK(werr)) {
873 /* add config params as values */
875 werr = reg_setvalue_internal(newkey, "path", "sz", path);
876 if (!W_ERROR_IS_OK(werr))
879 if (comment != NULL) {
880 werr = reg_setvalue_internal(newkey, "comment", "sz", comment);
881 if (!W_ERROR_IS_OK(werr))
885 werr = reg_setvalue_internal(newkey, "guest ok", "sz", guest_ok);
886 if (!W_ERROR_IS_OK(werr))
889 werr = reg_setvalue_internal(newkey, "writeable", "sz", writeable);
890 if (!W_ERROR_IS_OK(werr))
897 SAFE_FREE(sharename);
901 int net_conf_delshare(int argc, const char **argv)
904 const char *sharename = NULL;
907 net_conf_delshare_usage(argc, argv);
912 if (W_ERROR_IS_OK(reg_delkey_internal(NULL, sharename))) {
919 static int net_conf_setparm(int argc, const char **argv)
922 WERROR werr = WERR_OK;
923 struct registry_key *key = NULL;
924 char *service = NULL;
927 const char *value_str = NULL;
930 ctx = talloc_init("setparm");
933 net_conf_setparm_usage(argc, argv);
936 service = strdup_lower(argv[0]);
937 param = strdup_lower(argv[1]);
938 type = strdup_lower(argv[2]);
941 if (!smbconf_key_exists(ctx, service)) {
942 werr = reg_createkey_internal(ctx, service, &key);
945 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
947 if (!W_ERROR_IS_OK(werr)) {
951 werr = reg_setvalue_internal(key, param, type, value_str);
952 if (!W_ERROR_IS_OK(werr)) {
953 d_fprintf(stderr, "Error setting value '%s': %s\n",
954 param, dos_errstr(werr));
967 static int net_conf_getparm(int argc, const char **argv)
970 WERROR werr = WERR_OK;
971 struct registry_key *key = NULL;
972 char *service = NULL;
974 struct registry_value *value = NULL;
977 ctx = talloc_init("getparm");
980 net_conf_getparm_usage(argc, argv);
983 service = strdup_lower(argv[0]);
984 param = strdup_lower(argv[1]);
986 if (!smbconf_key_exists(ctx, service)) {
988 "ERROR: given service '%s' does not exist.\n",
993 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
994 if (!W_ERROR_IS_OK(werr)) {
998 werr = reg_queryvalue(ctx, key, param, &value);
999 if (!W_ERROR_IS_OK(werr)) {
1000 d_fprintf(stderr, "Error querying value '%s': %s.\n",
1001 param, dos_errstr(werr));
1005 d_printf("%s\n", format_value(ctx, value));
1015 static int net_conf_delparm(int argc, const char **argv)
1018 WERROR werr = WERR_OK;
1019 struct registry_key *key = NULL;
1020 char *service = NULL;
1024 ctx = talloc_init("delparm");
1027 net_conf_delparm_usage(argc, argv);
1030 service = strdup_lower(argv[0]);
1031 param = strdup_lower(argv[1]);
1033 if (!smbconf_key_exists(ctx, service)) {
1035 "Error: given service '%s' does not exist.\n",
1040 werr = smbconf_open_path(ctx, service, REG_KEY_READ, &key);
1041 if (!W_ERROR_IS_OK(werr)) {
1045 if (!smbconf_value_exists(ctx, key, param)) {
1047 "Error: given parameter '%s' is not set.\n",
1051 werr = reg_deletevalue(key, param);
1052 if (!W_ERROR_IS_OK(werr)) {
1053 d_fprintf(stderr, "Error deleting value '%s': %s.\n",
1054 param, dos_errstr(werr));
1065 * Entry-point for all the CONF functions.
1068 int net_conf(int argc, const char **argv)
1071 int saved_errno = 0;
1072 struct functable2 func[] = {
1073 {"list", net_conf_list,
1074 "Dump the complete configuration in smb.conf like format."},
1075 {"import", net_conf_import,
1076 "Import configuration from file in smb.conf format."},
1077 {"listshares", net_conf_listshares,
1078 "List the registry shares."},
1079 {"showshare", net_conf_showshare,
1080 "Show the definition of a registry share."},
1081 {"addshare", net_conf_addshare,
1082 "Create a new registry share."},
1083 {"delshare", net_conf_delshare,
1084 "Delete a registry share."},
1085 {"setparm", net_conf_setparm,
1086 "Store a parameter."},
1087 {"getparm", net_conf_getparm,
1088 "Retrieve the value of a parameter."},
1089 {"delparm", net_conf_delparm,
1090 "Delete a parameter."},
1094 REGISTRY_HOOK smbconf_reg_hook = {KEY_SMBCONF, &smbconf_reg_ops};
1096 if (!regdb_init()) {
1097 saved_errno = errno;
1098 d_fprintf(stderr, "Can't open the registry");
1100 d_fprintf(stderr, ": %s\n", strerror(saved_errno));
1103 d_fprintf(stderr, "!\n");
1107 reghook_cache_init();
1108 reghook_cache_add(&smbconf_reg_hook);
1110 ret = net_run_function2(argc, argv, "net conf", func);