samba-mirror/source3/utils/net_conf.c

/*
 *  Samba Unix/Linux SMB client library
 *  Distributed SMB/CIFS Server Management Utility
 *  Local configuration interface
 *  Copyright (C) Michael Adam 2007
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

/*
 * This is an interface to the configuration stored inside the
 * samba registry. In the future there might be support for other
 * configuration backends as well.
 */

#include "includes.h"
#include "utils/net.h"
#include "libnet/libnet.h"

/*
 * usage functions
 */

static int net_conf_list_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf list\n");
	return -1;
}

static int net_conf_import_usage(int argc, const char**argv)
{
	d_printf("USAGE: net conf import [--test|-T] <filename> "
		 "[<servicename>]\n"
		 "\t[--test|-T]    testmode - do not act, just print "
		                   "what would be done\n"
		 "\t<servicename>  only import service <servicename>, "
		                   "ignore the rest\n");
	return -1;
}

static int net_conf_listshares_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf listshares\n");
	return -1;
}

static int net_conf_drop_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf drop\n");
	return -1;
}

static int net_conf_showshare_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf showshare <sharename>\n");
	return -1;
}

static int net_conf_addshare_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf addshare <sharename> <path> "
		 "[writeable={y|N} [guest_ok={y|N} [<comment>]]\n"
		 "\t<sharename>      the new share name.\n"
		 "\t<path>           the path on the filesystem to export.\n"
		 "\twriteable={y|N}  set \"writeable to \"yes\" or "
		 "\"no\" (default) on this share.\n"
		 "\tguest_ok={y|N}   set \"guest ok\" to \"yes\" or "
		 "\"no\" (default)   on this share.\n"
		 "\t<comment>        optional comment for the new share.\n");
	return -1;
}

static int net_conf_delshare_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf delshare <sharename>\n");
	return -1;
}

static int net_conf_setparm_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf setparm <section> <param> <value>\n");
	return -1;
}

static int net_conf_getparm_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf getparm <section> <param>\n");
	return -1;
}

static int net_conf_delparm_usage(int argc, const char **argv)
{
	d_printf("USAGE: net conf delparm <section> <param>\n");
	return -1;
}


/*
 * Helper functions
 */

static char *parm_valstr(TALLOC_CTX *ctx, struct parm_struct *parm,
			 struct share_params *share)
{
	char *valstr = NULL;
	int i = 0;
	void *ptr = parm->ptr;

	if (parm->p_class == P_LOCAL && share->service >= 0) {
		ptr = lp_local_ptr(share->service, ptr);
	}

	switch (parm->type) {
	case P_CHAR:
		valstr = talloc_asprintf(ctx, "%c", *(char *)ptr);
		break;
	case P_STRING:
	case P_USTRING:
		valstr = talloc_asprintf(ctx, "%s", *(char **)ptr);
		break;
	case P_BOOL:
		valstr = talloc_asprintf(ctx, "%s", BOOLSTR(*(bool *)ptr));
		break;
	case P_BOOLREV:
		valstr = talloc_asprintf(ctx, "%s", BOOLSTR(!*(bool *)ptr));
		break;
	case P_ENUM:
        	for (i = 0; parm->enum_list[i].name; i++) {
        	        if (*(int *)ptr == parm->enum_list[i].value)
			{
				valstr = talloc_asprintf(ctx, "%s",
        	                         parm->enum_list[i].name);
        	                break;
        	        }
        	}
		break;
	case P_OCTAL: {
		char *o = octal_string(*(int *)ptr);
		valstr = talloc_move(ctx, &o);
		break;
	}
	case P_LIST:
		valstr = talloc_strdup(ctx, "");
		if ((char ***)ptr && *(char ***)ptr) {
			char **list = *(char ***)ptr;
			for (; *list; list++) {
				/* surround strings with whitespace
				 * in double quotes */
				if (strchr_m(*list, ' '))
				{
					valstr = talloc_asprintf_append(
						valstr, "\"%s\"%s",
						*list,
						 ((*(list+1))?", ":""));
				} else {
					valstr = talloc_asprintf_append(
						valstr, "%s%s", *list,
						 ((*(list+1))?", ":""));
				}
			}
		}
		break;
	case P_INTEGER:
		valstr = talloc_asprintf(ctx, "%d", *(int *)ptr);
		break;
	case P_SEP:
		break;
	default:
		valstr = talloc_asprintf(ctx, "<type unimplemented>\n");
		break;
	}

	return valstr;
}

static int import_process_service(TALLOC_CTX *ctx,
				  struct share_params *share)
{
	int ret = -1;
	struct parm_struct *parm;
	int pnum = 0;
	const char *servicename;
	WERROR werr;
	char *valstr = NULL;
	TALLOC_CTX *tmp_ctx = NULL;

	tmp_ctx = talloc_new(ctx);
	if (tmp_ctx == NULL) {
		werr = WERR_NOMEM;
		goto done;
	}

	servicename = (share->service == GLOBAL_SECTION_SNUM)?
		GLOBAL_NAME : lp_servicename(share->service);

	if (opt_testmode) {
		d_printf("[%s]\n", servicename);
	} else {
		if (libnet_smbconf_share_exists(servicename)) {
			werr = libnet_smbconf_delshare(servicename);
			if (!W_ERROR_IS_OK(werr)) {
				goto done;
			}
		}
	}

	while ((parm = lp_next_parameter(share->service, &pnum, 0)))
	{
		if ((share->service < 0 && parm->p_class == P_LOCAL)
		    && !(parm->flags & FLAG_GLOBAL))
			continue;

		valstr = parm_valstr(tmp_ctx, parm, share);

		if (parm->type != P_SEP) {
			if (opt_testmode) {
				d_printf("\t%s = %s\n", parm->label, valstr);
			} else {
				werr = libnet_smbconf_setparm(servicename,
							      parm->label,
							      valstr);
				if (!W_ERROR_IS_OK(werr)) {
					d_fprintf(stderr,
						  "Error setting parameter '%s'"
						  ": %s\n", parm->label,
						   dos_errstr(werr));
					goto done;
				}
			}
		}
	}

	if (opt_testmode) {
		d_printf("\n");
	}

	ret = 0;

done:
	TALLOC_FREE(tmp_ctx);
	return ret;
}

/* return true iff there are nondefault globals */
static bool globals_exist(void)
{
	int i = 0;
	struct parm_struct *parm;

	while ((parm = lp_next_parameter(GLOBAL_SECTION_SNUM, &i, 0)) != NULL) {
		if (parm->type != P_SEP) {
			return true;
		}
	}
	return false;
}

/*
 * the conf functions
 */

static int net_conf_list(int argc, const char **argv)
{
	WERROR werr = WERR_OK;
	int ret = -1;
	TALLOC_CTX *ctx;
	uint32_t num_shares;
	char **share_names;
	uint32_t *num_params;
	char ***param_names;
	char ***param_values;
	uint32_t share_count, param_count;

	ctx = talloc_init("list");

	if (argc != 0) {
		net_conf_list_usage(argc, argv);
		goto done;
	}

	werr = libnet_smbconf_get_config(ctx, &num_shares, &share_names,
					 &num_params, &param_names,
					 &param_values);
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error getting config: %s\n",
			  dos_errstr(werr));
		goto done;
	}

	for (share_count = 0; share_count < num_shares; share_count++) {
		d_printf("[%s]\n", share_names[share_count]);
		for (param_count = 0; param_count < num_params[share_count];
		     param_count++)
		{
			d_printf("\t%s = %s\n",
				 param_names[share_count][param_count],
				 param_values[share_count][param_count]);
		}
		d_printf("\n");
	}

	ret = 0;

done:
	TALLOC_FREE(ctx);
	return ret;
}

static int net_conf_import(int argc, const char **argv)
{
	int ret = -1;
	const char *filename = NULL;
	const char *servicename = NULL;
	bool service_found = false;
	TALLOC_CTX *ctx;
	struct share_iterator *shares;
	struct share_params *share;
	struct share_params global_share = { GLOBAL_SECTION_SNUM };

	ctx = talloc_init("net_conf_import");

	switch (argc) {
		case 0:
		default:
			net_conf_import_usage(argc, argv);
			goto done;
		case 2:
			servicename = argv[1];
		case 1:
			filename = argv[0];
			break;
	}

	DEBUG(3,("net_conf_import: reading configuration from file %s.\n",
		filename));

	if (!lp_load(filename,
		     false,     /* global_only */
		     true,      /* save_defaults */
		     false,     /* add_ipc */
		     true))     /* initialize_globals */
	{
		d_fprintf(stderr, "Error parsing configuration file.\n");
		goto done;
	}

	if (opt_testmode) {
		d_printf("\nTEST MODE - "
			 "would import the following configuration:\n\n");
	}

	if (((servicename == NULL) && globals_exist()) ||
	    strequal(servicename, GLOBAL_NAME))
	{
		service_found = true;
		if (import_process_service(ctx, &global_share) != 0) {
			goto done;
		}
	}

	if (service_found && (servicename != NULL)) {
		ret = 0;
		goto done;
	}

	if (!(shares = share_list_all(ctx))) {
		d_fprintf(stderr, "Could not list shares...\n");
		goto done;
	}
	while ((share = next_share(shares)) != NULL) {
		if ((servicename == NULL)
		    || strequal(servicename, lp_servicename(share->service)))
		{
			service_found = true;
			if (import_process_service(ctx, share)!= 0) {
				goto done;
			}
		}
	}

	if ((servicename != NULL) && !service_found) {
		d_printf("Share %s not found in file %s\n",
			 servicename, filename);
		goto done;

	}

	ret = 0;

done:
	TALLOC_FREE(ctx);
	return ret;
}

static int net_conf_listshares(int argc, const char **argv)
{
	WERROR werr = WERR_OK;
	int ret = -1;
	uint32_t count, num_shares = 0;
	char **share_names = NULL;
	TALLOC_CTX *ctx;

	ctx = talloc_init("listshares");

	if (argc != 0) {
		net_conf_listshares_usage(argc, argv);
		goto done;
	}

	werr = libnet_smbconf_get_share_names(ctx, &num_shares, &share_names);
	if (!W_ERROR_IS_OK(werr)) {
		goto done;
	}

	for (count = 0; count < num_shares; count++)
	{
		d_printf("%s\n", share_names[count]);
	}

	ret = 0;

done:
	TALLOC_FREE(ctx);
	return ret;
}

static int net_conf_drop(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr;

	if (argc != 0) {
		net_conf_drop_usage(argc, argv);
		goto done;
	}

	werr = libnet_smbconf_drop();
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error deleting configuration: %s\n",
			  dos_errstr(werr));
		goto done;
	}

	ret = 0;

done:
	return ret;
}

static int net_conf_showshare(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr = WERR_OK;
	const char *sharename = NULL;
	TALLOC_CTX *ctx;
	uint32_t num_params;
	uint32_t count;
	char **param_names;
	char **param_values;

	ctx = talloc_init("showshare");

	if (argc != 1) {
		net_conf_showshare_usage(argc, argv);
		goto done;
	}

	sharename = argv[0];

	werr = libnet_smbconf_getshare(ctx, sharename, &num_params,
				       &param_names, &param_values);
	if (!W_ERROR_IS_OK(werr)) {
		d_printf("error getting share parameters: %s\n",
			 dos_errstr(werr));
		goto done;
	}

	d_printf("[%s]\n", sharename);

	for (count = 0; count < num_params; count++) {
		d_printf("\t%s = %s\n", param_names[count],
			 param_values[count]);
	}

	ret = 0;

done:
	TALLOC_FREE(ctx);
	return ret;
}

/**
 * Add a share, with a couple of standard parameters, partly optional.
 *
 * This is a high level utility function of the net conf utility,
 * not a direct frontend to the libnet_conf API.
 */
static int net_conf_addshare(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr = WERR_OK;
	char *sharename = NULL;
	const char *path = NULL;
	const char *comment = NULL;
	const char *guest_ok = "no";
	const char *writeable = "no";
	SMB_STRUCT_STAT sbuf;

	switch (argc) {
		case 0:
		case 1:
		default:
			net_conf_addshare_usage(argc, argv);
			goto done;
		case 5:
			comment = argv[4];
		case 4:
			if (!strnequal(argv[3], "guest_ok=", 9)) {
				net_conf_addshare_usage(argc, argv);
				goto done;
			}
			switch (argv[3][9]) {
				case 'y':
				case 'Y':
					guest_ok = "yes";
					break;
				case 'n':
				case 'N':
					guest_ok = "no";
					break;
				default:
					net_conf_addshare_usage(argc, argv);
					goto done;
			}
		case 3:
			if (!strnequal(argv[2], "writeable=", 10)) {
				net_conf_addshare_usage(argc, argv);
				goto done;
			}
			switch (argv[2][10]) {
				case 'y':
				case 'Y':
					writeable = "yes";
					break;
				case 'n':
				case 'N':
					writeable = "no";
					break;
				default:
					net_conf_addshare_usage(argc, argv);
					goto done;
			}
		case 2:
			path = argv[1];
			sharename = strdup_lower(argv[0]);
			break;
	}

	/*
	 * validate arguments
	 */

	/* validate share name */

	if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS,
			       strlen(sharename)))
	{
		d_fprintf(stderr, "ERROR: share name %s contains "
                        "invalid characters (any of %s)\n",
                        sharename, INVALID_SHARENAME_CHARS);
		goto done;
	}

	if (getpwnam(sharename)) {
		d_fprintf(stderr, "ERROR: share name %s is already a valid "
			  "system user name.\n", sharename);
		goto done;
	}

	if (strequal(sharename, GLOBAL_NAME)) {
		d_fprintf(stderr,
			  "ERROR: 'global' is not a valid share name.\n");
		goto done;
	}

	if (libnet_smbconf_share_exists(sharename)) {
		d_fprintf(stderr, "ERROR: share %s already exists.\n",
			  sharename);
		goto done;
	}

	/* validate path */

	if (path[0] != '/') {
		d_fprintf(stderr,
			  "Error: path '%s' is not an absolute path.\n",
			  path);
		goto done;
	}

	if (sys_stat(path, &sbuf) != 0) {
		d_fprintf(stderr,
			  "ERROR: cannot stat path '%s' to ensure "
			  "this is a directory.\n"
			  "Error was '%s'.\n",
			  path, strerror(errno));
		goto done;
	}

	if (!S_ISDIR(sbuf.st_mode)) {
		d_fprintf(stderr,
			  "ERROR: path '%s' is not a directory.\n",
			  path);
		goto done;
	}

	/*
	 * create the share by adding the parameters
	 */

	werr = libnet_smbconf_setparm(sharename, "path", path);
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error setting parameter %s: %s\n",
			  "path", dos_errstr(werr));
		goto done;
	}

	if (comment != NULL) {
		werr = libnet_smbconf_setparm(sharename, "comment", comment);
		if (!W_ERROR_IS_OK(werr)) {
			d_fprintf(stderr, "Error setting parameter %s: %s\n",
				  "comment", dos_errstr(werr));
			goto done;
		}
	}

	werr = libnet_smbconf_setparm(sharename, "guest ok", guest_ok);
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error setting parameter %s: %s\n",
			  "'guest ok'", dos_errstr(werr));
		goto done;
	}

	werr = libnet_smbconf_setparm(sharename, "writeable", writeable);
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error setting parameter %s: %s\n",
			  "writeable", dos_errstr(werr));
		goto done;
	}

	ret = 0;

done:
	SAFE_FREE(sharename);
	return ret;
}

static int net_conf_delshare(int argc, const char **argv)
{
	int ret = -1;
	const char *sharename = NULL;
	WERROR werr = WERR_OK;

	if (argc != 1) {
		net_conf_delshare_usage(argc, argv);
		goto done;
	}
	sharename = argv[0];

	werr = libnet_smbconf_delshare(sharename);
	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error deleting share %s: %s\n",
			  sharename, dos_errstr(werr));
		goto done;
	}

	ret = 0;
done:
	return ret;
}

static int net_conf_setparm(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr = WERR_OK;
	char *service = NULL;
	char *param = NULL;
	const char *value_str = NULL;

	if (argc != 3) {
		net_conf_setparm_usage(argc, argv);
		goto done;
	}
	service = strdup_lower(argv[0]);
	param = strdup_lower(argv[1]);
	value_str = argv[2];

	werr = libnet_smbconf_setparm(service, param, value_str);

	if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error setting value '%s': %s\n",
			  param, dos_errstr(werr));
		goto done;
	}

	ret = 0;

done:
	SAFE_FREE(service);
	SAFE_FREE(param);
	return ret;
}

static int net_conf_getparm(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr = WERR_OK;
	char *service = NULL;
	char *param = NULL;
	char *valstr = NULL;
	TALLOC_CTX *ctx;

	ctx = talloc_init("getparm");

	if (argc != 2) {
		net_conf_getparm_usage(argc, argv);
		goto done;
	}
	service = strdup_lower(argv[0]);
	param = strdup_lower(argv[1]);

	werr = libnet_smbconf_getparm(ctx, service, param, &valstr);

	if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
		d_fprintf(stderr,
			  "Error: given service '%s' does not exist.\n",
			  service);
		goto done;
	} else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
		d_fprintf(stderr,
			  "Error: given parameter '%s' is not set.\n",
			  param);
		goto done;
	} else if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error getting value '%s': %s.\n",
			  param, dos_errstr(werr));
		goto done;
	}

	d_printf("%s\n", valstr);

	ret = 0;
done:
	SAFE_FREE(service);
	SAFE_FREE(param);
	TALLOC_FREE(ctx);
	return ret;
}

static int net_conf_delparm(int argc, const char **argv)
{
	int ret = -1;
	WERROR werr = WERR_OK;
	char *service = NULL;
	char *param = NULL;

	if (argc != 2) {
		net_conf_delparm_usage(argc, argv);
		goto done;
	}
	service = strdup_lower(argv[0]);
	param = strdup_lower(argv[1]);

	werr = libnet_smbconf_delparm(service, param);

	if (W_ERROR_EQUAL(werr, WERR_NO_SUCH_SERVICE)) {
		d_fprintf(stderr,
			  "Error: given service '%s' does not exist.\n",
			  service);
		goto done;
	} else if (W_ERROR_EQUAL(werr, WERR_INVALID_PARAM)) {
		d_fprintf(stderr,
			  "Error: given parameter '%s' is not set.\n",
			  param);
		goto done;
	} else if (!W_ERROR_IS_OK(werr)) {
		d_fprintf(stderr, "Error deleting value '%s': %s.\n",
			  param, dos_errstr(werr));
		goto done;
	}

	ret = 0;

done:
	SAFE_FREE(service);
	SAFE_FREE(param);
	return ret;
}

/*
 * Entry-point for all the CONF functions.
 */

int net_conf(int argc, const char **argv)
{
	int ret = -1;
	struct functable2 func[] = {
		{"list", net_conf_list,
		 "Dump the complete configuration in smb.conf like format."},
		{"import", net_conf_import,
		 "Import configuration from file in smb.conf format."},
		{"listshares", net_conf_listshares,
		 "List the registry shares."},
		{"drop", net_conf_drop,
		 "Delete the complete configuration from registry."},
		{"showshare", net_conf_showshare,
		 "Show the definition of a registry share."},
		{"addshare", net_conf_addshare,
		 "Create a new registry share."},
		{"delshare", net_conf_delshare,
		 "Delete a registry share."},
		{"setparm", net_conf_setparm,
		 "Store a parameter."},
		{"getparm", net_conf_getparm,
		 "Retrieve the value of a parameter."},
		{"delparm", net_conf_delparm,
		 "Delete a parameter."},
		{NULL, NULL, NULL}
	};

	if (!registry_init_regdb()) {
		d_fprintf(stderr, "Error initializing the registry!\n");
		goto done;
	}

	ret = net_run_function2(argc, argv, "net conf", func);

	regdb_close();

done:
	return ret;
}