path: root/usr/src/uts/common/fs/smbsrv/smb_vss.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Volume Copy Shadow Services (VSS) provides a way for users to
 * restore/recover deleted files/directories.
 * For the server to support VSS for Microsoft clients, there is
 * two basic functions that need to be implemented.
 * The first is to intercept the NT_TRANSACT_IOCTL command with
 * the function code of FSCTL_SRV_ENUMERATE_SNAPSHOTS (0x00144064).
 * This is to report the count or the count and list of snapshots
 * for that share.
 * The second function need to trap commands with the
 * SMB_FLAGS2_REPARSE_PATH bit set in the smb header.  This bit
 * means that there is a @GMT token in path that needs to be
 * processed.  The @GMT token means to process this command, but
 * in the snapshot.
 */

#include <smbsrv/smb_kproto.h>
#include <smbsrv/string.h>
#include <smbsrv/winioctl.h>
#include <smbsrv/smb_door_svc.h>

/* Size of the token on the wire due to encoding */
#define	SMB_VSS_GMT_NET_SIZE(sr) (smb_ascii_or_unicode_null_len(sr) * \
    SMB_VSS_GMT_SIZE)

#define	SMB_VSS_COUNT_SIZE 16

static boolean_t smb_vss_is_gmttoken(const char *str);
static const char *smb_vss_find_gmttoken(const char *path);
static int smb_vss_get_fsmountpath(smb_request_t *sr, char *buf,
    uint32_t buflen);
static uint32_t smb_vss_encode_gmttokens(smb_request_t *sr, smb_xa_t *xa,
    int32_t count, smb_dr_return_gmttokens_t *snap_data);
static void smb_vss_remove_first_token_from_path(char *c);

/*
 * This is to respond to the nt_transact_ioctl to either respond with the
 * number of snapshots, or to respond with the list.  It needs to be sorted
 * before the reply.  If the the max data bytes to return is
 * SMB_VSS_COUNT_SIZE, then all that is requested is the count, otherwise
 * return the count and the list of @GMT tokens (one token for each
 * snapshot).
 */
uint32_t
smb_vss_ioctl_enumerate_snaps(smb_request_t *sr, smb_xa_t *xa)
{
	uint32_t count = 0;
	char *root_path;
	uint32_t status = NT_STATUS_SUCCESS;
	smb_dr_return_gmttokens_t gmttokens;

	if (xa->smb_mdrcnt < SMB_VSS_COUNT_SIZE)
		return (NT_STATUS_INVALID_PARAMETER);

	root_path  = kmem_zalloc(MAXPATHLEN, KM_SLEEP);
	if (smb_vss_get_fsmountpath(sr, root_path, MAXPATHLEN) != 0)
		return (NT_STATUS_INVALID_PARAMETER);

	if (xa->smb_mdrcnt == SMB_VSS_COUNT_SIZE) {
		count = smb_upcall_vss_get_count(root_path);
		if (smb_mbc_encodef(&xa->rep_data_mb, "lllw", count, 0,
		    (count * SMB_VSS_GMT_NET_SIZE(sr) +
		    smb_ascii_or_unicode_null_len(sr)), 0) != 0) {
			status = NT_STATUS_INVALID_PARAMETER;
		}
	} else {
		count = xa->smb_mdrcnt / SMB_VSS_GMT_NET_SIZE(sr);

		smb_upcall_vss_get_snapshots(root_path, count, &gmttokens);

		status = smb_vss_encode_gmttokens(sr, xa, count, &gmttokens);

		smb_upcall_vss_get_snapshots_free(&gmttokens);
	}

	kmem_free(root_path, MAXPATHLEN);
	return (status);
}

/*
 * sr - the request info, used to find root of dataset,
 *      unicode or ascii, where the share is rooted in the
 *      dataset
 * root_node - root of the share
 * cur_node - where in the share for the command
 * buf - is the path for the command to be processed
 *       returned without @GMT if processed
 * vss_cur_node - returned value for the snapshot version
 *                of the cur_node
 * vss_root_node - returned value for the snapshot version
 *                 of the root_node
 *
 * This routine is the processing for handling the
 * SMB_FLAGS2_REPARSE_PATH bit being set in the smb header.
 *
 * By using the cur_node passed in, a new node is found or
 * created that is the same place in the directory tree, but
 * in the snapshot. We also use root_node to do the same for
 * the root.
 * One the new smb node is found, the path is modified by
 * removing the @GMT token from the path in the buf.
 */
int
smb_vss_lookup_nodes(smb_request_t *sr, smb_node_t *root_node,
    smb_node_t *cur_node, char *buf, smb_node_t **vss_cur_node,
    smb_node_t **vss_root_node)
{
	const char *p;
	char *rootpath;
	char *snapname;
	char *nodepath;
	char gmttoken[SMB_VSS_GMT_SIZE];
	vnode_t *fsrootvp;
	vnode_t *vp = NULL;
	int err = 0;

	if (sr->tid_tree == NULL)
		return (ESTALE);

	ASSERT(sr->tid_tree->t_snode);
	ASSERT(sr->tid_tree->t_snode->vp);
	ASSERT(sr->tid_tree->t_snode->vp->v_vfsp);

	if ((p = smb_vss_find_gmttoken(buf)) == NULL)
		return (ENOENT);

	bcopy(p, gmttoken, SMB_VSS_GMT_SIZE);
	gmttoken[SMB_VSS_GMT_SIZE - 1] = '\0';

	err = VFS_ROOT(sr->tid_tree->t_snode->vp->v_vfsp, &fsrootvp);
	if (err != 0)
		return (err);

	rootpath = kmem_alloc(MAXPATHLEN, KM_SLEEP);
	snapname = kmem_alloc(MAXNAMELEN, KM_SLEEP);
	nodepath = kmem_alloc(MAXPATHLEN, KM_SLEEP);

	err = smb_vss_get_fsmountpath(sr, rootpath, MAXPATHLEN);
	if (err != 0)
		goto error;

	*snapname = '\0';

	smb_upcall_vss_map_gmttoken(rootpath, gmttoken, snapname);

	if (!*snapname) {
		err = ENOENT;
		goto error;
	}

	/* note the value of root_node->vp */
	err = vnodetopath(fsrootvp, root_node->vp, nodepath,
	    MAXPATHLEN, kcred);

	if (err != 0)
		goto error;

	(void) snprintf(rootpath, MAXPATHLEN, ".zfs/snapshot/%s/%s",
	    snapname, nodepath);

	vp = smb_lookuppathvptovp(sr, rootpath, fsrootvp, fsrootvp);

	if (vp) {
		/* note the value of cur_node->vp */
		err = vnodetopath(fsrootvp, cur_node->vp, nodepath,
		    MAXPATHLEN, kcred);
		if (err != 0) {
			VN_RELE(vp);
			goto error;
		}

		*vss_root_node = smb_node_lookup(sr, NULL, kcred, vp,
		    gmttoken, cur_node, NULL);
		VN_RELE(vp);

		if (*vss_root_node == NULL) {
			err = ENOENT;
			goto error;
		}

		(void) snprintf(rootpath, MAXPATHLEN, ".zfs/snapshot/%s/%s",
		    snapname, nodepath);


		vp = smb_lookuppathvptovp(sr, rootpath, fsrootvp, fsrootvp);

		if (vp) {
			*vss_cur_node = smb_node_lookup(sr, NULL, kcred, vp,
			    gmttoken, cur_node, NULL);
			VN_RELE(vp);

			if (*vss_cur_node != NULL) {
				smb_vss_remove_first_token_from_path(buf);
			} else {
				(void) smb_node_release(*vss_root_node);
				err = ENOENT;
			}
		} else {
			(void) smb_node_release(*vss_root_node);
			err = ENOENT;
		}
	} else {
		err = ENOENT;
	}

error:
	VN_RELE(fsrootvp);
	kmem_free(rootpath, MAXPATHLEN);
	kmem_free(snapname, MAXNAMELEN);
	kmem_free(nodepath, MAXPATHLEN);

	return (err);
}

static boolean_t
smb_vss_is_gmttoken(const char *s)
{
	char *t = "@GMT-NNNN.NN.NN-NN.NN.NN";
	const char *str;
	char *template;

	template = t;
	str = s;

	while (*template) {
		if (*template == 'N') {
			if (!smb_isdigit(*str))
				return (B_FALSE);
		} else if (*template != *str) {
			return (B_FALSE);
		}

		template++;
		str++;
	}

	/* Make sure it is JUST the @GMT token */
	if ((*str == '\0') || (*str == '/'))
		return (B_TRUE);

	return (B_FALSE);
}

static const char *
smb_vss_find_gmttoken(const char *path)
{
	const char *p;

	p = path;

	while (*p) {
		if (smb_vss_is_gmttoken(p))
			return (p);
		p++;
	}
	return (NULL);
}

static int
smb_vss_get_fsmountpath(smb_request_t *sr, char *buf, uint32_t buflen)
{
	vnode_t *vp, *root_vp;
	vfs_t *vfsp;
	int err;

	ASSERT(sr->tid_tree);
	ASSERT(sr->tid_tree->t_snode);
	ASSERT(sr->tid_tree->t_snode->vp);
	ASSERT(sr->tid_tree->t_snode->vp->v_vfsp);

	vp = sr->tid_tree->t_snode->vp;
	vfsp = vp->v_vfsp;

	if (VFS_ROOT(vfsp, &root_vp))
		return (ENOENT);

	VN_HOLD(vp);

	/* NULL is passed in as we want to start at "/" */
	err = vnodetopath(NULL, root_vp, buf, buflen, sr->user_cr);

	VN_RELE(vp);
	VN_RELE(root_vp);
	return (err);
}

static uint32_t
smb_vss_encode_gmttokens(smb_request_t *sr, smb_xa_t *xa,
    int32_t count, smb_dr_return_gmttokens_t *snap_data)
{
	uint32_t i;
	uint32_t returned_count;
	uint32_t num_gmttokens;
	char **gmttokens;
	uint32_t status = NT_STATUS_SUCCESS;
	uint32_t data_size;

	returned_count = snap_data->rg_count;
	num_gmttokens = snap_data->rg_gmttokens.rg_gmttokens_len;
	gmttokens = snap_data->rg_gmttokens.rg_gmttokens_val;

	if (returned_count > count)
		status = NT_STATUS_BUFFER_TOO_SMALL;

	data_size = returned_count * SMB_VSS_GMT_NET_SIZE(sr) +
	    smb_ascii_or_unicode_null_len(sr);

	if (smb_mbc_encodef(&xa->rep_data_mb, "lll", returned_count,
	    num_gmttokens, data_size) != 0)
		return (NT_STATUS_INVALID_PARAMETER);

	if (status == NT_STATUS_SUCCESS) {
		for (i = 0; i < num_gmttokens; i++) {
			if (smb_mbc_encodef(&xa->rep_data_mb, "%u", sr,
			    *gmttokens) != 0)
				status = NT_STATUS_INVALID_PARAMETER;
			gmttokens++;
		}
	}

	return (status);
}

/* This removes the first @GMT from the path */
static void
smb_vss_remove_first_token_from_path(char *path)
{
	boolean_t found;
	char *src, *dest;

	src = path;
	dest = path;

	found = B_FALSE;

	while (*src != '\0') {
		if (!found && smb_vss_is_gmttoken(src)) {
			src += SMB_VSS_GMT_SIZE - 1;
			if (*src == '/')
				src += 1;
			found = B_TRUE;
			continue;
		}
		*dest = *src;
		src++;
		dest++;
	}
	*dest = *src;
}