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 * delete a subkey of KEY_SMBCONF
149 static WERROR reg_delkey_internal(TALLOC_CTX *ctx, const char *keyname)
151 WERROR werr = WERR_OK;
152 struct registry_key *key = NULL;
154 werr = libnet_smbconf_open_basepath(ctx, REG_KEY_WRITE, &key);
155 if (!W_ERROR_IS_OK(werr)) {
159 werr = reg_deletekey_recursive(key, key, keyname);
160 if (!W_ERROR_IS_OK(werr)) {
161 d_fprintf(stderr, "Error deleting registry key %s\\%s: %s\n",
162 KEY_SMBCONF, keyname, dos_errstr(werr));
170 static WERROR list_values(TALLOC_CTX *ctx, struct registry_key *key)
172 WERROR werr = WERR_OK;
174 struct registry_value *valvalue = NULL;
175 char *valname = NULL;
178 W_ERROR_IS_OK(werr = reg_enumvalue(ctx, key, idx, &valname,
182 d_printf("\t%s = %s\n", valname, format_value(ctx, valvalue));
184 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
185 d_fprintf(stderr, "Error enumerating values: %s\n",
195 static WERROR drop_smbconf_internal(TALLOC_CTX *ctx)
198 WERROR werr = WERR_OK;
199 NT_USER_TOKEN *token;
200 struct registry_key *parent_key = NULL;
201 struct registry_key *new_key = NULL;
202 TALLOC_CTX* tmp_ctx = NULL;
203 enum winreg_CreateAction action;
205 tmp_ctx = talloc_new(ctx);
206 if (tmp_ctx == NULL) {
211 if (!(token = registry_create_admin_token(tmp_ctx))) {
212 /* what is the appropriate error code here? */
213 werr = WERR_CAN_NOT_COMPLETE;
217 path = talloc_strdup(tmp_ctx, KEY_SMBCONF);
219 d_fprintf(stderr, "ERROR: out of memory!\n");
223 p = strrchr(path, '\\');
225 werr = reg_open_path(tmp_ctx, path, REG_KEY_WRITE, token, &parent_key);
227 if (!W_ERROR_IS_OK(werr)) {
231 werr = reg_deletekey_recursive(tmp_ctx, parent_key, p+1);
233 if (!W_ERROR_IS_OK(werr)) {
237 werr = reg_createkey(tmp_ctx, parent_key, p+1, REG_KEY_WRITE,
241 TALLOC_FREE(tmp_ctx);
245 static char *parm_valstr(TALLOC_CTX *ctx, struct parm_struct *parm,
246 struct share_params *share)
250 void *ptr = parm->ptr;
252 if (parm->p_class == P_LOCAL && share->service >= 0) {
253 ptr = lp_local_ptr(share->service, ptr);
256 switch (parm->type) {
258 valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
262 valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
265 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(*(bool *)ptr));
268 valstr = talloc_asprintf(ctx, "%s", BOOLSTR(!*(bool *)ptr));
271 for (i = 0; parm->enum_list[i].name; i++) {
272 if (*(int *)ptr == parm->enum_list[i].value)
274 valstr = talloc_asprintf(ctx, "%s",
275 parm->enum_list[i].name);
281 char *o = octal_string(*(int *)ptr);
282 valstr = talloc_move(ctx, &o);
286 valstr = talloc_strdup(ctx, "");
287 if ((char ***)ptr && *(char ***)ptr) {
288 char **list = *(char ***)ptr;
289 for (; *list; list++) {
290 /* surround strings with whitespace
291 * in double quotes */
292 if (strchr_m(*list, ' '))
294 valstr = talloc_asprintf_append(
297 ((*(list+1))?", ":""));
299 valstr = talloc_asprintf_append(
300 valstr, "%s%s", *list,
301 ((*(list+1))?", ":""));
307 valstr = talloc_asprintf(ctx, "%d", *(int *)ptr);
312 valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
319 static int import_process_service(TALLOC_CTX *ctx,
320 struct share_params *share)
323 struct parm_struct *parm;
325 const char *servicename;
326 struct registry_key *key;
329 TALLOC_CTX *tmp_ctx = NULL;
331 tmp_ctx = talloc_new(ctx);
332 if (tmp_ctx == NULL) {
337 servicename = (share->service == GLOBAL_SECTION_SNUM)?
338 GLOBAL_NAME : lp_servicename(share->service);
341 d_printf("[%s]\n", servicename);
343 if (libnet_smbconf_key_exists(tmp_ctx, servicename)) {
344 werr = reg_delkey_internal(tmp_ctx, servicename);
345 if (!W_ERROR_IS_OK(werr)) {
349 werr = libnet_smbconf_reg_createkey_internal(tmp_ctx, servicename, &key);
350 if (!W_ERROR_IS_OK(werr)) {
355 while ((parm = lp_next_parameter(share->service, &pnum, 0)))
357 if ((share->service < 0 && parm->p_class == P_LOCAL)
358 && !(parm->flags & FLAG_GLOBAL))
361 valstr = parm_valstr(tmp_ctx, parm, share);
363 if (parm->type != P_SEP) {
365 d_printf("\t%s = %s\n", parm->label, valstr);
367 werr = libnet_smbconf_reg_setvalue_internal(key,
368 parm->label, valstr);
369 if (!W_ERROR_IS_OK(werr)) {
383 TALLOC_FREE(tmp_ctx);
387 /* return True iff there are nondefault globals */
388 static bool globals_exist(void)
391 struct parm_struct *parm;
393 while ((parm = lp_next_parameter(GLOBAL_SECTION_SNUM, &i, 0)) != NULL) {
394 if (parm->type != P_SEP) {
405 int net_conf_list(int argc, const char **argv)
407 WERROR werr = WERR_OK;
410 struct registry_key *base_key = NULL;
411 struct registry_key *sub_key = NULL;
413 char *subkey_name = NULL;
415 ctx = talloc_init("list");
418 net_conf_list_usage(argc, argv);
422 werr = libnet_smbconf_open_basepath(ctx, REG_KEY_READ, &base_key);
423 if (!W_ERROR_IS_OK(werr)) {
427 if (libnet_smbconf_key_exists(ctx, GLOBAL_NAME)) {
428 werr = reg_openkey(ctx, base_key, GLOBAL_NAME,
429 REG_KEY_READ, &sub_key);
430 if (!W_ERROR_IS_OK(werr)) {
431 d_fprintf(stderr, "Error opening subkey '%s' : %s\n",
432 subkey_name, dos_errstr(werr));
435 d_printf("[%s]\n", GLOBAL_NAME);
436 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
443 W_ERROR_IS_OK(werr = reg_enumkey(ctx, base_key, idx_key,
444 &subkey_name, NULL));
447 if (strequal(subkey_name, GLOBAL_NAME)) {
450 d_printf("[%s]\n", subkey_name);
452 werr = reg_openkey(ctx, base_key, subkey_name,
453 REG_KEY_READ, &sub_key);
454 if (!W_ERROR_IS_OK(werr)) {
456 "Error opening subkey '%s': %s\n",
457 subkey_name, dos_errstr(werr));
460 if (!W_ERROR_IS_OK(list_values(ctx, sub_key))) {
465 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
466 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
478 int net_conf_import(int argc, const char **argv)
481 const char *filename = NULL;
482 const char *servicename = NULL;
483 bool service_found = False;
485 struct share_iterator *shares;
486 struct share_params *share;
487 struct share_params global_share = { GLOBAL_SECTION_SNUM };
489 ctx = talloc_init("net_conf_import");
494 net_conf_import_usage(argc, argv);
497 servicename = argv[1];
503 DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
506 if (!lp_load(filename,
507 False, /* global_only */
508 True, /* save_defaults */
510 True)) /* initialize_globals */
512 d_fprintf(stderr, "Error parsing configuration file.\n");
517 d_printf("\nTEST MODE - "
518 "would import the following configuration:\n\n");
521 if (((servicename == NULL) && globals_exist()) ||
522 strequal(servicename, GLOBAL_NAME))
524 service_found = True;
525 if (import_process_service(ctx, &global_share) != 0) {
530 if (service_found && (servicename != NULL)) {
535 if (!(shares = share_list_all(ctx))) {
536 d_fprintf(stderr, "Could not list shares...\n");
539 while ((share = next_share(shares)) != NULL) {
540 if ((servicename == NULL)
541 || strequal(servicename, lp_servicename(share->service)))
543 service_found = True;
544 if (import_process_service(ctx, share)!= 0) {
550 if ((servicename != NULL) && !service_found) {
551 d_printf("Share %s not found in file %s\n",
552 servicename, filename);
564 int net_conf_listshares(int argc, const char **argv)
566 WERROR werr = WERR_OK;
568 struct registry_key *key;
570 char *subkey_name = NULL;
573 ctx = talloc_init("listshares");
576 net_conf_listshares_usage(argc, argv);
580 werr = libnet_smbconf_open_basepath(ctx, SEC_RIGHTS_ENUM_SUBKEYS, &key);
581 if (!W_ERROR_IS_OK(werr)) {
586 W_ERROR_IS_OK(werr = reg_enumkey(ctx, key, idx,
587 &subkey_name, NULL));
590 d_printf("%s\n", subkey_name);
592 if (! W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
593 d_fprintf(stderr, "Error enumerating subkeys: %s\n",
605 int net_conf_drop(int argc, const char **argv)
611 net_conf_drop_usage(argc, argv);
615 werr = drop_smbconf_internal(NULL);
616 if (!W_ERROR_IS_OK(werr)) {
617 d_fprintf(stderr, "Error deleting configuration: %s\n",
628 int net_conf_showshare(int argc, const char **argv)
631 WERROR werr = WERR_OK;
632 struct registry_key *key = NULL;
635 ctx = talloc_init("showshare");
638 net_conf_showshare_usage(argc, argv);
642 werr = libnet_smbconf_open_path(ctx, argv[0], REG_KEY_READ, &key);
643 if (!W_ERROR_IS_OK(werr)) {
647 d_printf("[%s]\n", argv[0]);
649 if (!W_ERROR_IS_OK(list_values(ctx, key))) {
660 int net_conf_addshare(int argc, const char **argv)
663 WERROR werr = WERR_OK;
664 struct registry_key *newkey = NULL;
665 char *sharename = NULL;
666 const char *path = NULL;
667 const char *comment = NULL;
668 const char *guest_ok = "no";
669 const char *writeable = "no";
670 SMB_STRUCT_STAT sbuf;
676 net_conf_addshare_usage(argc, argv);
681 if (!strnequal(argv[3], "guest_ok=", 9)) {
682 net_conf_addshare_usage(argc, argv);
685 switch (argv[3][9]) {
695 net_conf_addshare_usage(argc, argv);
699 if (!strnequal(argv[2], "writeable=", 10)) {
700 net_conf_addshare_usage(argc, argv);
703 switch (argv[2][10]) {
713 net_conf_addshare_usage(argc, argv);
719 sharename = strdup_lower(argv[0]);
727 /* validate share name */
729 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
732 d_fprintf(stderr, "ERROR: share name %s contains "
733 "invalid characters (any of %s)\n",
734 sharename, INVALID_SHARENAME_CHARS);
738 if (getpwnam(sharename)) {
739 d_fprintf(stderr, "ERROR: share name %s is already a valid "
740 "system user name.\n", sharename);
744 if (strequal(sharename, GLOBAL_NAME)) {
746 "ERROR: 'global' is not a valid share name.\n");
752 if (path[0] != '/') {
754 "Error: path '%s' is not an absolute path.\n",
759 if (sys_stat(path, &sbuf) != 0) {
761 "ERROR: cannot stat path '%s' to ensure "
762 "this is a directory.\n"
764 path, strerror(errno));
768 if (!S_ISDIR(sbuf.st_mode)) {
770 "ERROR: path '%s' is not a directory.\n",
779 werr = libnet_smbconf_reg_createkey_internal(NULL, argv[0], &newkey);
780 if (!W_ERROR_IS_OK(werr)) {
784 /* add config params as values */
786 werr = libnet_smbconf_reg_setvalue_internal(newkey, "path", path);
787 if (!W_ERROR_IS_OK(werr))
790 if (comment != NULL) {
791 werr = libnet_smbconf_reg_setvalue_internal(newkey, "comment",
793 if (!W_ERROR_IS_OK(werr))
797 werr = libnet_smbconf_reg_setvalue_internal(newkey, "guest ok",
799 if (!W_ERROR_IS_OK(werr))
802 werr = libnet_smbconf_reg_setvalue_internal(newkey, "writeable",
804 if (!W_ERROR_IS_OK(werr))
811 SAFE_FREE(sharename);
815 int net_conf_delshare(int argc, const char **argv)
818 const char *sharename = NULL;
821 net_conf_delshare_usage(argc, argv);
826 if (W_ERROR_IS_OK(reg_delkey_internal(NULL, sharename))) {
833 static int net_conf_setparm(int argc, const char **argv)
836 WERROR werr = WERR_OK;
837 char *service = NULL;
839 const char *value_str = NULL;
842 ctx = talloc_init("setparm");
845 net_conf_setparm_usage(argc, argv);
848 service = strdup_lower(argv[0]);
849 param = strdup_lower(argv[1]);
852 werr = libnet_smbconf_setparm(ctx, service, param, value_str);
854 if (!W_ERROR_IS_OK(werr)) {
855 d_fprintf(stderr, "Error setting value '%s': %s\n",
856 param, dos_errstr(werr));
868 static int net_conf_getparm(int argc, const char **argv)
871 WERROR werr = WERR_OK;
872 char *service = NULL;
874 struct registry_value *value = NULL;
877 ctx = talloc_init("getparm");
880 net_conf_getparm_usage(argc, argv);
883 service = strdup_lower(argv[0]);
884 param = strdup_lower(argv[1]);
886 werr = libnet_smbconf_getparm(ctx, service, param, &value);
888 if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
890 "Error: given service '%s' does not exist.\n",
893 } else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
895 "Error: given parameter '%s' is not set.\n",
898 } else if (!W_ERROR_IS_OK(werr)) {
899 d_fprintf(stderr, "Error getting value '%s': %s.\n",
900 param, dos_errstr(werr));
904 d_printf("%s\n", format_value(ctx, value));
914 static int net_conf_delparm(int argc, const char **argv)
917 WERROR werr = WERR_OK;
918 char *service = NULL;
922 ctx = talloc_init("delparm");
925 net_conf_delparm_usage(argc, argv);
928 service = strdup_lower(argv[0]);
929 param = strdup_lower(argv[1]);
931 werr = libnet_smbconf_delparm(ctx, service, param);
933 if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
935 "Error: given service '%s' does not exist.\n",
938 } else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
940 "Error: given parameter '%s' is not set.\n",
943 } else if (!W_ERROR_IS_OK(werr)) {
944 d_fprintf(stderr, "Error deleting value '%s': %s.\n",
945 param, dos_errstr(werr));
956 * Entry-point for all the CONF functions.
959 int net_conf(int argc, const char **argv)
962 struct functable2 func[] = {
963 {"list", net_conf_list,
964 "Dump the complete configuration in smb.conf like format."},
965 {"import", net_conf_import,
966 "Import configuration from file in smb.conf format."},
967 {"listshares", net_conf_listshares,
968 "List the registry shares."},
969 {"drop", net_conf_drop,
970 "Delete the complete configuration from registry."},
971 {"showshare", net_conf_showshare,
972 "Show the definition of a registry share."},
973 {"addshare", net_conf_addshare,
974 "Create a new registry share."},
975 {"delshare", net_conf_delshare,
976 "Delete a registry share."},
977 {"setparm", net_conf_setparm,
978 "Store a parameter."},
979 {"getparm", net_conf_getparm,
980 "Retrieve the value of a parameter."},
981 {"delparm", net_conf_delparm,
982 "Delete a parameter."},
986 if (!registry_init_regdb()) {
987 d_fprintf(stderr, "Error initializing the registry!\n");
991 ret = net_run_function2(argc, argv, "net conf", func);