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>");
146 static WERROR list_values(TALLOC_CTX *ctx, struct registry_key *key)
148 WERROR werr = WERR_OK;
150 struct registry_value *valvalue = NULL;
151 char *valname = NULL;
154 W_ERROR_IS_OK(werr = reg_enumvalue(ctx, key, idx, &valname,
158 d_printf("\t%s = %s\n", valname, format_value(ctx, valvalue));
160 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
161 d_fprintf(stderr, "Error enumerating values: %s\n",
171 static char *parm_valstr(TALLOC_CTX *ctx, struct parm_struct *parm,
172 struct share_params *share)
176 void *ptr = parm->ptr;
178 if (parm->p_class == P_LOCAL && share->service >= 0) {
179 ptr = lp_local_ptr(share->service, ptr);
182 switch (parm->type) {
184 valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
188 valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
191 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(*(bool *)ptr));
194 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(!*(bool *)ptr));
197 for (i = 0; parm->enum_list[i].name; i++) {
198 if (*(int *)ptr == parm->enum_list[i].value)
200 valstr = talloc_asprintf(ctx, "%s",
201 parm->enum_list[i].name);
207 char *o = octal_string(*(int *)ptr);
208 valstr = talloc_move(ctx, &o);
212 valstr = talloc_strdup(ctx, "");
213 if ((char ***)ptr && *(char ***)ptr) {
214 char **list = *(char ***)ptr;
215 for (; *list; list++) {
216 /* surround strings with whitespace
217 * in double quotes */
218 if (strchr_m(*list, ' '))
220 valstr = talloc_asprintf_append(
223 ((*(list+1))?", ":""));
225 valstr = talloc_asprintf_append(
226 valstr, "%s%s", *list,
227 ((*(list+1))?", ":""));
233 valstr = talloc_asprintf(ctx, "%d", *(int *)ptr);
238 valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
245 static int import_process_service(TALLOC_CTX *ctx,
246 struct share_params *share)
249 struct parm_struct *parm;
251 const char *servicename;
252 struct registry_key *key;
255 TALLOC_CTX *tmp_ctx = NULL;
257 tmp_ctx = talloc_new(ctx);
258 if (tmp_ctx == NULL) {
263 servicename = (share->service == GLOBAL_SECTION_SNUM)?
264 GLOBAL_NAME : lp_servicename(share->service);
267 d_printf("[%s]\n", servicename);
269 if (libnet_smbconf_key_exists(servicename)) {
270 werr = libnet_smbconf_delshare(servicename);
271 if (!W_ERROR_IS_OK(werr)) {
275 werr = libnet_smbconf_reg_createkey_internal(tmp_ctx, servicename, &key);
276 if (!W_ERROR_IS_OK(werr)) {
281 while ((parm = lp_next_parameter(share->service, &pnum, 0)))
283 if ((share->service < 0 && parm->p_class == P_LOCAL)
284 && !(parm->flags & FLAG_GLOBAL))
287 valstr = parm_valstr(tmp_ctx, parm, share);
289 if (parm->type != P_SEP) {
291 d_printf("\t%s = %s\n", parm->label, valstr);
293 werr = libnet_smbconf_reg_setvalue_internal(key,
294 parm->label, valstr);
295 if (!W_ERROR_IS_OK(werr)) {
309 TALLOC_FREE(tmp_ctx);
313 /* return true iff there are nondefault globals */
314 static bool globals_exist(void)
317 struct parm_struct *parm;
319 while ((parm = lp_next_parameter(GLOBAL_SECTION_SNUM, &i, 0)) != NULL) {
320 if (parm->type != P_SEP) {
331 int net_conf_list(int argc, const char **argv)
333 WERROR werr = WERR_OK;
336 struct registry_key *base_key = NULL;
337 struct registry_key *sub_key = NULL;
339 char *subkey_name = NULL;
341 ctx = talloc_init("list");
344 net_conf_list_usage(argc, argv);
348 werr = libnet_smbconf_open_basepath(ctx, REG_KEY_READ, &base_key);
349 if (!W_ERROR_IS_OK(werr)) {
353 if (libnet_smbconf_key_exists(GLOBAL_NAME)) {
354 werr = reg_openkey(ctx, base_key, GLOBAL_NAME,
355 REG_KEY_READ, &sub_key);
356 if (!W_ERROR_IS_OK(werr)) {
357 d_fprintf(stderr, "Error opening subkey '%s' : %s\n",
358 subkey_name, dos_errstr(werr));
361 d_printf("[%s]\n", GLOBAL_NAME);
362 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
369 W_ERROR_IS_OK(werr = reg_enumkey(ctx, base_key, idx_key,
370 &subkey_name, NULL));
373 if (strequal(subkey_name, GLOBAL_NAME)) {
376 d_printf("[%s]\n", subkey_name);
378 werr = reg_openkey(ctx, base_key, subkey_name,
379 REG_KEY_READ, &sub_key);
380 if (!W_ERROR_IS_OK(werr)) {
382 "Error opening subkey '%s': %s\n",
383 subkey_name, dos_errstr(werr));
386 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
391 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
392 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
404 int net_conf_import(int argc, const char **argv)
407 const char *filename = NULL;
408 const char *servicename = NULL;
409 bool service_found = false;
411 struct share_iterator *shares;
412 struct share_params *share;
413 struct share_params global_share = { GLOBAL_SECTION_SNUM };
415 ctx = talloc_init("net_conf_import");
420 net_conf_import_usage(argc, argv);
423 servicename = argv[1];
429 DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
432 if (!lp_load(filename,
433 false, /* global_only */
434 true, /* save_defaults */
436 true)) /* initialize_globals */
438 d_fprintf(stderr, "Error parsing configuration file.\n");
443 d_printf("\nTEST MODE - "
444 "would import the following configuration:\n\n");
447 if (((servicename == NULL) && globals_exist()) ||
448 strequal(servicename, GLOBAL_NAME))
450 service_found = true;
451 if (import_process_service(ctx, &global_share) != 0) {
456 if (service_found && (servicename != NULL)) {
461 if (!(shares = share_list_all(ctx))) {
462 d_fprintf(stderr, "Could not list shares...\n");
465 while ((share = next_share(shares)) != NULL) {
466 if ((servicename == NULL)
467 || strequal(servicename, lp_servicename(share->service)))
469 service_found = true;
470 if (import_process_service(ctx, share)!= 0) {
476 if ((servicename != NULL) && !service_found) {
477 d_printf("Share %s not found in file %s\n",
478 servicename, filename);
490 int net_conf_listshares(int argc, const char **argv)
492 WERROR werr = WERR_OK;
494 struct registry_key *key;
496 char *subkey_name = NULL;
499 ctx = talloc_init("listshares");
502 net_conf_listshares_usage(argc, argv);
506 werr = libnet_smbconf_open_basepath(ctx, SEC_RIGHTS_ENUM_SUBKEYS, &key);
507 if (!W_ERROR_IS_OK(werr)) {
512 W_ERROR_IS_OK(werr = reg_enumkey(ctx, key, idx,
513 &subkey_name, NULL));
516 d_printf("%s\n", subkey_name);
518 if (! W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
519 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
531 int net_conf_drop(int argc, const char **argv)
537 net_conf_drop_usage(argc, argv);
541 werr = libnet_smbconf_drop();
542 if (!W_ERROR_IS_OK(werr)) {
543 d_fprintf(stderr, "Error deleting configuration: %s\n",
554 int net_conf_showshare(int argc, const char **argv)
557 WERROR werr = WERR_OK;
558 struct registry_key *key = NULL;
561 ctx = talloc_init("showshare");
564 net_conf_showshare_usage(argc, argv);
568 werr = libnet_smbconf_open_path(ctx, argv[0], REG_KEY_READ, &key);
569 if (!W_ERROR_IS_OK(werr)) {
573 d_printf("[%s]\n", argv[0]);
575 if (!W_ERROR_IS_OK(list_values(ctx, key))) {
586 int net_conf_addshare(int argc, const char **argv)
589 WERROR werr = WERR_OK;
590 struct registry_key *newkey = NULL;
591 char *sharename = NULL;
592 const char *path = NULL;
593 const char *comment = NULL;
594 const char *guest_ok = "no";
595 const char *writeable = "no";
596 SMB_STRUCT_STAT sbuf;
602 net_conf_addshare_usage(argc, argv);
607 if (!strnequal(argv[3], "guest_ok=", 9)) {
608 net_conf_addshare_usage(argc, argv);
611 switch (argv[3][9]) {
621 net_conf_addshare_usage(argc, argv);
625 if (!strnequal(argv[2], "writeable=", 10)) {
626 net_conf_addshare_usage(argc, argv);
629 switch (argv[2][10]) {
639 net_conf_addshare_usage(argc, argv);
645 sharename = strdup_lower(argv[0]);
653 /* validate share name */
655 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
658 d_fprintf(stderr, "ERROR: share name %s contains "
659 "invalid characters (any of %s)\n",
660 sharename, INVALID_SHARENAME_CHARS);
664 if (getpwnam(sharename)) {
665 d_fprintf(stderr, "ERROR: share name %s is already a valid "
666 "system user name.\n", sharename);
670 if (strequal(sharename, GLOBAL_NAME)) {
672 "ERROR: 'global' is not a valid share name.\n");
678 if (path[0] != '/') {
680 "Error: path '%s' is not an absolute path.\n",
685 if (sys_stat(path, &sbuf) != 0) {
687 "ERROR: cannot stat path '%s' to ensure "
688 "this is a directory.\n"
690 path, strerror(errno));
694 if (!S_ISDIR(sbuf.st_mode)) {
696 "ERROR: path '%s' is not a directory.\n",
705 werr = libnet_smbconf_reg_createkey_internal(NULL, argv[0], &newkey);
706 if (!W_ERROR_IS_OK(werr)) {
710 /* add config params as values */
712 werr = libnet_smbconf_reg_setvalue_internal(newkey, "path", path);
713 if (!W_ERROR_IS_OK(werr))
716 if (comment != NULL) {
717 werr = libnet_smbconf_reg_setvalue_internal(newkey, "comment",
719 if (!W_ERROR_IS_OK(werr))
723 werr = libnet_smbconf_reg_setvalue_internal(newkey, "guest ok",
725 if (!W_ERROR_IS_OK(werr))
728 werr = libnet_smbconf_reg_setvalue_internal(newkey, "writeable",
730 if (!W_ERROR_IS_OK(werr))
737 SAFE_FREE(sharename);
741 int net_conf_delshare(int argc, const char **argv)
744 const char *sharename = NULL;
745 WERROR werr = WERR_OK;
748 net_conf_delshare_usage(argc, argv);
753 werr = libnet_smbconf_delshare(sharename);
754 if (!W_ERROR_IS_OK(werr)) {
755 d_fprintf(stderr, "Error deleting share %s: %s\n",
756 sharename, dos_errstr(werr));
765 static int net_conf_setparm(int argc, const char **argv)
768 WERROR werr = WERR_OK;
769 char *service = NULL;
771 const char *value_str = NULL;
774 net_conf_setparm_usage(argc, argv);
777 service = strdup_lower(argv[0]);
778 param = strdup_lower(argv[1]);
781 werr = libnet_smbconf_setparm(service, param, value_str);
783 if (!W_ERROR_IS_OK(werr)) {
784 d_fprintf(stderr, "Error setting value '%s': %s\n",
785 param, dos_errstr(werr));
797 static int net_conf_getparm(int argc, const char **argv)
800 WERROR werr = WERR_OK;
801 char *service = NULL;
803 struct registry_value *value = NULL;
806 ctx = talloc_init("getparm");
809 net_conf_getparm_usage(argc, argv);
812 service = strdup_lower(argv[0]);
813 param = strdup_lower(argv[1]);
815 werr = libnet_smbconf_getparm(ctx, service, param, &value);
817 if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
819 "Error: given service '%s' does not exist.\n",
822 } else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
824 "Error: given parameter '%s' is not set.\n",
827 } else if (!W_ERROR_IS_OK(werr)) {
828 d_fprintf(stderr, "Error getting value '%s': %s.\n",
829 param, dos_errstr(werr));
833 d_printf("%s\n", format_value(ctx, value));
843 static int net_conf_delparm(int argc, const char **argv)
846 WERROR werr = WERR_OK;
847 char *service = NULL;
851 net_conf_delparm_usage(argc, argv);
854 service = strdup_lower(argv[0]);
855 param = strdup_lower(argv[1]);
857 werr = libnet_smbconf_delparm(service, param);
859 if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
861 "Error: given service '%s' does not exist.\n",
864 } else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
866 "Error: given parameter '%s' is not set.\n",
869 } else if (!W_ERROR_IS_OK(werr)) {
870 d_fprintf(stderr, "Error deleting value '%s': %s.\n",
871 param, dos_errstr(werr));
884 * Entry-point for all the CONF functions.
887 int net_conf(int argc, const char **argv)
890 struct functable2 func[] = {
891 {"list", net_conf_list,
892 "Dump the complete configuration in smb.conf like format."},
893 {"import", net_conf_import,
894 "Import configuration from file in smb.conf format."},
895 {"listshares", net_conf_listshares,
896 "List the registry shares."},
897 {"drop", net_conf_drop,
898 "Delete the complete configuration from registry."},
899 {"showshare", net_conf_showshare,
900 "Show the definition of a registry share."},
901 {"addshare", net_conf_addshare,
902 "Create a new registry share."},
903 {"delshare", net_conf_delshare,
904 "Delete a registry share."},
905 {"setparm", net_conf_setparm,
906 "Store a parameter."},
907 {"getparm", net_conf_getparm,
908 "Retrieve the value of a parameter."},
909 {"delparm", net_conf_delparm,
910 "Delete a parameter."},
914 if (!registry_init_regdb()) {
915 d_fprintf(stderr, "Error initializing the registry!\n");
919 ret = net_run_function2(argc, argv, "net conf", func);