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 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 * This is an interface to the configuration stored inside the
23 * samba registry. In the future there might be support for other
24 * configuration backends as well.
28 #include "utils/net.h"
29 #include "libnet/libnet.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> "
45 "\t[--test|-T] testmode - do not act, just print "
46 "what would be done\n"
47 "\t<servicename> only import service <servicename>, "
52 static int net_conf_listshares_usage(int argc, const char **argv)
54 d_printf("USAGE: net conf listshares\n");
58 static int net_conf_drop_usage(int argc, const char **argv)
60 d_printf("USAGE: net conf drop\n");
64 static int net_conf_showshare_usage(int argc, const char **argv)
66 d_printf("USAGE: net conf showshare <sharename>\n");
70 static int net_conf_addshare_usage(int argc, const char **argv)
72 d_printf("USAGE: net conf addshare <sharename> <path> "
73 "[writeable={y|N} [guest_ok={y|N} [<comment>]]\n"
74 "\t<sharename> the new share name.\n"
75 "\t<path> the path on the filesystem to export.\n"
76 "\twriteable={y|N} set \"writeable to \"yes\" or "
77 "\"no\" (default) on this share.\n"
78 "\tguest_ok={y|N} set \"guest ok\" to \"yes\" or "
79 "\"no\" (default) on this share.\n"
80 "\t<comment> optional comment for the new share.\n");
84 static int net_conf_delshare_usage(int argc, const char **argv)
86 d_printf("USAGE: net conf delshare <sharename>\n");
90 static int net_conf_setparm_usage(int argc, const char **argv)
92 d_printf("USAGE: net conf setparm <section> <param> <value>\n");
96 static int net_conf_getparm_usage(int argc, const char **argv)
98 d_printf("USAGE: net conf getparm <section> <param>\n");
102 static int net_conf_delparm_usage(int argc, const char **argv)
104 d_printf("USAGE: net conf delparm <section> <param>\n");
113 static char *format_value(TALLOC_CTX *mem_ctx, struct registry_value *value)
117 /* what if mem_ctx = NULL? */
119 switch (value->type) {
121 result = talloc_asprintf(mem_ctx, "%d", value->v.dword);
125 result = talloc_asprintf(mem_ctx, "%s", value->v.sz.str);
129 for (j = 0; j < value->v.multi_sz.num_strings; j++) {
130 result = talloc_asprintf(mem_ctx, "\"%s\" ",
131 value->v.multi_sz.strings[j]);
136 result = talloc_asprintf(mem_ctx, "binary (%d bytes)",
137 (int)value->v.binary.length);
140 result = talloc_asprintf(mem_ctx, "<unprintable>");
147 * add a value to a key.
149 static WERROR reg_setvalue_internal(struct registry_key *key,
153 struct registry_value val;
154 WERROR werr = WERR_OK;
156 const char *canon_valname;
157 const char *canon_valstr;
159 if (!lp_canonicalize_parameter_with_value(valname, valstr,
163 if (canon_valname == NULL) {
164 d_fprintf(stderr, "invalid parameter '%s' given\n",
167 d_fprintf(stderr, "invalid value '%s' given for "
168 "parameter '%s'\n", valstr, valname);
170 werr = WERR_INVALID_PARAM;
177 val.v.sz.str = CONST_DISCARD(char *, canon_valstr);
178 val.v.sz.len = strlen(canon_valstr) + 1;
180 if (registry_smbconf_valname_forbidden(canon_valname)) {
181 d_fprintf(stderr, "Parameter '%s' not allowed in registry.\n",
183 werr = WERR_INVALID_PARAM;
187 subkeyname = strrchr_m(key->key->name, '\\');
188 if ((subkeyname == NULL) || (*(subkeyname +1) == '\0')) {
189 d_fprintf(stderr, "Invalid registry key '%s' given as "
190 "smbconf section.\n", key->key->name);
191 werr = WERR_INVALID_PARAM;
195 if (!strequal(subkeyname, GLOBAL_NAME) &&
196 lp_parameter_is_global(valname))
198 d_fprintf(stderr, "Global paramter '%s' not allowed in "
199 "service definition ('%s').\n", canon_valname,
201 werr = WERR_INVALID_PARAM;
205 werr = reg_setvalue(key, canon_valname, &val);
206 if (!W_ERROR_IS_OK(werr)) {
208 "Error adding value '%s' to "
210 canon_valname, key->key->name, dos_errstr(werr));
218 * delete a subkey of KEY_SMBCONF
220 static WERROR reg_delkey_internal(TALLOC_CTX *ctx, const char *keyname)
222 WERROR werr = WERR_OK;
223 struct registry_key *key = NULL;
225 werr = libnet_smbconf_open_basepath(ctx, REG_KEY_WRITE, &key);
226 if (!W_ERROR_IS_OK(werr)) {
230 werr = reg_deletekey_recursive(key, key, keyname);
231 if (!W_ERROR_IS_OK(werr)) {
232 d_fprintf(stderr, "Error deleting registry key %s\\%s: %s\n",
233 KEY_SMBCONF, keyname, dos_errstr(werr));
241 static WERROR list_values(TALLOC_CTX *ctx, struct registry_key *key)
243 WERROR werr = WERR_OK;
245 struct registry_value *valvalue = NULL;
246 char *valname = NULL;
249 W_ERROR_IS_OK(werr = reg_enumvalue(ctx, key, idx, &valname,
253 d_printf("\t%s = %s\n", valname, format_value(ctx, valvalue));
255 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
256 d_fprintf(stderr, "Error enumerating values: %s\n",
266 static WERROR drop_smbconf_internal(TALLOC_CTX *ctx)
269 WERROR werr = WERR_OK;
270 NT_USER_TOKEN *token;
271 struct registry_key *parent_key = NULL;
272 struct registry_key *new_key = NULL;
273 TALLOC_CTX* tmp_ctx = NULL;
274 enum winreg_CreateAction action;
276 tmp_ctx = talloc_new(ctx);
277 if (tmp_ctx == NULL) {
282 if (!(token = registry_create_admin_token(tmp_ctx))) {
283 /* what is the appropriate error code here? */
284 werr = WERR_CAN_NOT_COMPLETE;
288 path = talloc_strdup(tmp_ctx, KEY_SMBCONF);
290 d_fprintf(stderr, "ERROR: out of memory!\n");
294 p = strrchr(path, '\\');
296 werr = reg_open_path(tmp_ctx, path, REG_KEY_WRITE, token, &parent_key);
298 if (!W_ERROR_IS_OK(werr)) {
302 werr = reg_deletekey_recursive(tmp_ctx, parent_key, p+1);
304 if (!W_ERROR_IS_OK(werr)) {
308 werr = reg_createkey(tmp_ctx, parent_key, p+1, REG_KEY_WRITE,
312 TALLOC_FREE(tmp_ctx);
316 static char *parm_valstr(TALLOC_CTX *ctx, struct parm_struct *parm,
317 struct share_params *share)
321 void *ptr = parm->ptr;
323 if (parm->p_class == P_LOCAL && share->service >= 0) {
324 ptr = lp_local_ptr(share->service, ptr);
327 switch (parm->type) {
329 valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
333 valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
336 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(*(bool *)ptr));
339 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(!*(bool *)ptr));
342 for (i = 0; parm->enum_list[i].name; i++) {
343 if (*(int *)ptr == parm->enum_list[i].value)
345 valstr = talloc_asprintf(ctx, "%s",
346 parm->enum_list[i].name);
352 char *o = octal_string(*(int *)ptr);
353 valstr = talloc_move(ctx, &o);
357 valstr = talloc_strdup(ctx, "");
358 if ((char ***)ptr && *(char ***)ptr) {
359 char **list = *(char ***)ptr;
360 for (; *list; list++) {
361 /* surround strings with whitespace
362 * in double quotes */
363 if (strchr_m(*list, ' '))
365 valstr = talloc_asprintf_append(
368 ((*(list+1))?", ":""));
370 valstr = talloc_asprintf_append(
371 valstr, "%s%s", *list,
372 ((*(list+1))?", ":""));
378 valstr = talloc_asprintf(ctx, "%d", *(int *)ptr);
383 valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
390 static int import_process_service(TALLOC_CTX *ctx,
391 struct share_params *share)
394 struct parm_struct *parm;
396 const char *servicename;
397 struct registry_key *key;
400 TALLOC_CTX *tmp_ctx = NULL;
402 tmp_ctx = talloc_new(ctx);
403 if (tmp_ctx == NULL) {
408 servicename = (share->service == GLOBAL_SECTION_SNUM)?
409 GLOBAL_NAME : lp_servicename(share->service);
412 d_printf("[%s]\n", servicename);
414 if (libnet_smbconf_key_exists(tmp_ctx, servicename)) {
415 werr = reg_delkey_internal(tmp_ctx, servicename);
416 if (!W_ERROR_IS_OK(werr)) {
420 werr = libnet_reg_createkey_internal(tmp_ctx, servicename, &key);
421 if (!W_ERROR_IS_OK(werr)) {
426 while ((parm = lp_next_parameter(share->service, &pnum, 0)))
428 if ((share->service < 0 && parm->p_class == P_LOCAL)
429 && !(parm->flags & FLAG_GLOBAL))
432 valstr = parm_valstr(tmp_ctx, parm, share);
434 if (parm->type != P_SEP) {
436 d_printf("\t%s = %s\n", parm->label, valstr);
438 werr = reg_setvalue_internal(key, parm->label,
440 if (!W_ERROR_IS_OK(werr)) {
454 TALLOC_FREE(tmp_ctx);
458 /* return True iff there are nondefault globals */
459 static bool globals_exist(void)
462 struct parm_struct *parm;
464 while ((parm = lp_next_parameter(GLOBAL_SECTION_SNUM, &i, 0)) != NULL) {
465 if (parm->type != P_SEP) {
476 int net_conf_list(int argc, const char **argv)
478 WERROR werr = WERR_OK;
481 struct registry_key *base_key = NULL;
482 struct registry_key *sub_key = NULL;
484 char *subkey_name = NULL;
486 ctx = talloc_init("list");
489 net_conf_list_usage(argc, argv);
493 werr = libnet_smbconf_open_basepath(ctx, REG_KEY_READ, &base_key);
494 if (!W_ERROR_IS_OK(werr)) {
498 if (libnet_smbconf_key_exists(ctx, GLOBAL_NAME)) {
499 werr = reg_openkey(ctx, base_key, GLOBAL_NAME,
500 REG_KEY_READ, &sub_key);
501 if (!W_ERROR_IS_OK(werr)) {
502 d_fprintf(stderr, "Error opening subkey '%s' : %s\n",
503 subkey_name, dos_errstr(werr));
506 d_printf("[%s]\n", GLOBAL_NAME);
507 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
514 W_ERROR_IS_OK(werr = reg_enumkey(ctx, base_key, idx_key,
515 &subkey_name, NULL));
518 if (strequal(subkey_name, GLOBAL_NAME)) {
521 d_printf("[%s]\n", subkey_name);
523 werr = reg_openkey(ctx, base_key, subkey_name,
524 REG_KEY_READ, &sub_key);
525 if (!W_ERROR_IS_OK(werr)) {
527 "Error opening subkey '%s': %s\n",
528 subkey_name, dos_errstr(werr));
531 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
536 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
537 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
549 int net_conf_import(int argc, const char **argv)
552 const char *filename = NULL;
553 const char *servicename = NULL;
554 bool service_found = False;
556 struct share_iterator *shares;
557 struct share_params *share;
558 struct share_params global_share = { GLOBAL_SECTION_SNUM };
560 ctx = talloc_init("net_conf_import");
565 net_conf_import_usage(argc, argv);
568 servicename = argv[1];
574 DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
577 if (!lp_load(filename,
578 False, /* global_only */
579 True, /* save_defaults */
581 True)) /* initialize_globals */
583 d_fprintf(stderr, "Error parsing configuration file.\n");
588 d_printf("\nTEST MODE - "
589 "would import the following configuration:\n\n");
592 if (((servicename == NULL) && globals_exist()) ||
593 strequal(servicename, GLOBAL_NAME))
595 service_found = True;
596 if (import_process_service(ctx, &global_share) != 0) {
601 if (service_found && (servicename != NULL)) {
606 if (!(shares = share_list_all(ctx))) {
607 d_fprintf(stderr, "Could not list shares...\n");
610 while ((share = next_share(shares)) != NULL) {
611 if ((servicename == NULL)
612 || strequal(servicename, lp_servicename(share->service)))
614 service_found = True;
615 if (import_process_service(ctx, share)!= 0) {
621 if ((servicename != NULL) && !service_found) {
622 d_printf("Share %s not found in file %s\n",
623 servicename, filename);
635 int net_conf_listshares(int argc, const char **argv)
637 WERROR werr = WERR_OK;
639 struct registry_key *key;
641 char *subkey_name = NULL;
644 ctx = talloc_init("listshares");
647 net_conf_listshares_usage(argc, argv);
651 werr = libnet_smbconf_open_basepath(ctx, SEC_RIGHTS_ENUM_SUBKEYS, &key);
652 if (!W_ERROR_IS_OK(werr)) {
657 W_ERROR_IS_OK(werr = reg_enumkey(ctx, key, idx,
658 &subkey_name, NULL));
661 d_printf("%s\n", subkey_name);
663 if (! W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
664 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
676 int net_conf_drop(int argc, const char **argv)
682 net_conf_drop_usage(argc, argv);
686 werr = drop_smbconf_internal(NULL);
687 if (!W_ERROR_IS_OK(werr)) {
688 d_fprintf(stderr, "Error deleting configuration: %s\n",
699 int net_conf_showshare(int argc, const char **argv)
702 WERROR werr = WERR_OK;
703 struct registry_key *key = NULL;
706 ctx = talloc_init("showshare");
709 net_conf_showshare_usage(argc, argv);
713 werr = libnet_smbconf_open_path(ctx, argv[0], REG_KEY_READ, &key);
714 if (!W_ERROR_IS_OK(werr)) {
718 d_printf("[%s]\n", argv[0]);
720 if (!W_ERROR_IS_OK(list_values(ctx, key))) {
731 int net_conf_addshare(int argc, const char **argv)
734 WERROR werr = WERR_OK;
735 struct registry_key *newkey = NULL;
736 char *sharename = NULL;
737 const char *path = NULL;
738 const char *comment = NULL;
739 const char *guest_ok = "no";
740 const char *writeable = "no";
741 SMB_STRUCT_STAT sbuf;
747 net_conf_addshare_usage(argc, argv);
752 if (!strnequal(argv[3], "guest_ok=", 9)) {
753 net_conf_addshare_usage(argc, argv);
756 switch (argv[3][9]) {
766 net_conf_addshare_usage(argc, argv);
770 if (!strnequal(argv[2], "writeable=", 10)) {
771 net_conf_addshare_usage(argc, argv);
774 switch (argv[2][10]) {
784 net_conf_addshare_usage(argc, argv);
790 sharename = strdup_lower(argv[0]);
798 /* validate share name */
800 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
803 d_fprintf(stderr, "ERROR: share name %s contains "
804 "invalid characters (any of %s)\n",
805 sharename, INVALID_SHARENAME_CHARS);
809 if (getpwnam(sharename)) {
810 d_fprintf(stderr, "ERROR: share name %s is already a valid "
811 "system user name.\n", sharename);
815 if (strequal(sharename, GLOBAL_NAME)) {
817 "ERROR: 'global' is not a valid share name.\n");
823 if (path[0] != '/') {
825 "Error: path '%s' is not an absolute path.\n",
830 if (sys_stat(path, &sbuf) != 0) {
832 "ERROR: cannot stat path '%s' to ensure "
833 "this is a directory.\n"
835 path, strerror(errno));
839 if (!S_ISDIR(sbuf.st_mode)) {
841 "ERROR: path '%s' is not a directory.\n",
850 werr = libnet_reg_createkey_internal(NULL, argv[0], &newkey);
851 if (!W_ERROR_IS_OK(werr)) {
855 /* add config params as values */
857 werr = reg_setvalue_internal(newkey, "path", path);
858 if (!W_ERROR_IS_OK(werr))
861 if (comment != NULL) {
862 werr = reg_setvalue_internal(newkey, "comment", comment);
863 if (!W_ERROR_IS_OK(werr))
867 werr = reg_setvalue_internal(newkey, "guest ok", guest_ok);
868 if (!W_ERROR_IS_OK(werr))
871 werr = reg_setvalue_internal(newkey, "writeable", writeable);
872 if (!W_ERROR_IS_OK(werr))
879 SAFE_FREE(sharename);
883 int net_conf_delshare(int argc, const char **argv)
886 const char *sharename = NULL;
889 net_conf_delshare_usage(argc, argv);
894 if (W_ERROR_IS_OK(reg_delkey_internal(NULL, sharename))) {
901 static int net_conf_setparm(int argc, const char **argv)
904 WERROR werr = WERR_OK;
905 struct registry_key *key = NULL;
906 char *service = NULL;
908 const char *value_str = NULL;
911 ctx = talloc_init("setparm");
914 net_conf_setparm_usage(argc, argv);
917 service = strdup_lower(argv[0]);
918 param = strdup_lower(argv[1]);
921 if (!libnet_smbconf_key_exists(ctx, service)) {
922 werr = libnet_reg_createkey_internal(ctx, service, &key);
924 werr = libnet_smbconf_open_path(ctx, service, REG_KEY_WRITE, &key);
926 if (!W_ERROR_IS_OK(werr)) {
930 werr = reg_setvalue_internal(key, param, value_str);
931 if (!W_ERROR_IS_OK(werr)) {
932 d_fprintf(stderr, "Error setting value '%s': %s\n",
933 param, dos_errstr(werr));
946 static int net_conf_getparm(int argc, const char **argv)
949 WERROR werr = WERR_OK;
950 struct registry_key *key = NULL;
951 char *service = NULL;
953 struct registry_value *value = NULL;
956 ctx = talloc_init("getparm");
959 net_conf_getparm_usage(argc, argv);
962 service = strdup_lower(argv[0]);
963 param = strdup_lower(argv[1]);
965 if (!libnet_smbconf_key_exists(ctx, service)) {
967 "ERROR: given service '%s' does not exist.\n",
972 werr = libnet_smbconf_open_path(ctx, service, REG_KEY_READ, &key);
973 if (!W_ERROR_IS_OK(werr)) {
977 werr = reg_queryvalue(ctx, key, param, &value);
978 if (!W_ERROR_IS_OK(werr)) {
979 d_fprintf(stderr, "Error querying value '%s': %s.\n",
980 param, dos_errstr(werr));
984 d_printf("%s\n", format_value(ctx, value));
994 static int net_conf_delparm(int argc, const char **argv)
997 WERROR werr = WERR_OK;
998 struct registry_key *key = NULL;
999 char *service = NULL;
1003 ctx = talloc_init("delparm");
1006 net_conf_delparm_usage(argc, argv);
1009 service = strdup_lower(argv[0]);
1010 param = strdup_lower(argv[1]);
1012 if (!libnet_smbconf_key_exists(ctx, service)) {
1014 "Error: given service '%s' does not exist.\n",
1019 werr = libnet_smbconf_open_path(ctx, service, REG_KEY_READ, &key);
1020 if (!W_ERROR_IS_OK(werr)) {
1024 if (!libnet_smbconf_value_exists(ctx, key, param)) {
1026 "Error: given parameter '%s' is not set.\n",
1030 werr = reg_deletevalue(key, param);
1031 if (!W_ERROR_IS_OK(werr)) {
1032 d_fprintf(stderr, "Error deleting value '%s': %s.\n",
1033 param, dos_errstr(werr));
1044 * Entry-point for all the CONF functions.
1047 int net_conf(int argc, const char **argv)
1050 struct functable2 func[] = {
1051 {"list", net_conf_list,
1052 "Dump the complete configuration in smb.conf like format."},
1053 {"import", net_conf_import,
1054 "Import configuration from file in smb.conf format."},
1055 {"listshares", net_conf_listshares,
1056 "List the registry shares."},
1057 {"drop", net_conf_drop,
1058 "Delete the complete configuration from registry."},
1059 {"showshare", net_conf_showshare,
1060 "Show the definition of a registry share."},
1061 {"addshare", net_conf_addshare,
1062 "Create a new registry share."},
1063 {"delshare", net_conf_delshare,
1064 "Delete a registry share."},
1065 {"setparm", net_conf_setparm,
1066 "Store a parameter."},
1067 {"getparm", net_conf_getparm,
1068 "Retrieve the value of a parameter."},
1069 {"delparm", net_conf_delparm,
1070 "Delete a parameter."},
1074 if (!registry_init_regdb()) {
1075 d_fprintf(stderr, "Error initializing the registry!\n");
1079 ret = net_run_function2(argc, argv, "net conf", func);