mount_clnt.c 12.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
2
/*
3
 * In-kernel MOUNT protocol client
Linus Torvalds's avatar
Linus Torvalds committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * Copyright (C) 1997, Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/types.h>
#include <linux/socket.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/uio.h>
#include <linux/net.h>
#include <linux/in.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/sched.h>
#include <linux/nfs_fs.h>
18
#include "internal.h"
Linus Torvalds's avatar
Linus Torvalds committed
19

20
#define NFSDBG_FACILITY	NFSDBG_MOUNT
Linus Torvalds's avatar
Linus Torvalds committed
21

22 23 24 25 26 27 28 29 30
/*
 * Defined by RFC 1094, section A.3; and RFC 1813, section 5.1.4
 */
#define MNTPATHLEN		(1024)

/*
 * XDR data type sizes
 */
#define encode_dirpath_sz	(1 + XDR_QUADLEN(MNTPATHLEN))
31 32
#define MNT_status_sz		(1)
#define MNT_fhs_status_sz	(1)
33 34
#define MNT_fhandle_sz		XDR_QUADLEN(NFS2_FHSIZE)
#define MNT_fhandle3_sz		(1 + XDR_QUADLEN(NFS3_FHSIZE))
35
#define MNT_authflav3_sz	(1 + NFS_MAX_SECFLAVORS)
36 37 38 39 40

/*
 * XDR argument and result sizes
 */
#define MNT_enc_dirpath_sz	encode_dirpath_sz
41 42 43
#define MNT_dec_mountres_sz	(MNT_status_sz + MNT_fhandle_sz)
#define MNT_dec_mountres3_sz	(MNT_status_sz + MNT_fhandle_sz + \
				 MNT_authflav3_sz)
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/*
 * Defined by RFC 1094, section A.5
 */
enum {
	MOUNTPROC_NULL		= 0,
	MOUNTPROC_MNT		= 1,
	MOUNTPROC_DUMP		= 2,
	MOUNTPROC_UMNT		= 3,
	MOUNTPROC_UMNTALL	= 4,
	MOUNTPROC_EXPORT	= 5,
};

/*
 * Defined by RFC 1813, section 5.2
 */
enum {
	MOUNTPROC3_NULL		= 0,
	MOUNTPROC3_MNT		= 1,
	MOUNTPROC3_DUMP		= 2,
	MOUNTPROC3_UMNT		= 3,
	MOUNTPROC3_UMNTALL	= 4,
	MOUNTPROC3_EXPORT	= 5,
};

69
static const struct rpc_program mnt_program;
Linus Torvalds's avatar
Linus Torvalds committed
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
/*
 * Defined by OpenGroup XNFS Version 3W, chapter 8
 */
enum mountstat {
	MNT_OK			= 0,
	MNT_EPERM		= 1,
	MNT_ENOENT		= 2,
	MNT_EACCES		= 13,
	MNT_EINVAL		= 22,
};

static struct {
	u32 status;
	int errno;
} mnt_errtbl[] = {
	{ .status = MNT_OK,			.errno = 0,		},
	{ .status = MNT_EPERM,			.errno = -EPERM,	},
	{ .status = MNT_ENOENT,			.errno = -ENOENT,	},
	{ .status = MNT_EACCES,			.errno = -EACCES,	},
	{ .status = MNT_EINVAL,			.errno = -EINVAL,	},
};

/*
 * Defined by RFC 1813, section 5.1.5
 */
enum mountstat3 {
	MNT3_OK			= 0,		/* no error */
	MNT3ERR_PERM		= 1,		/* Not owner */
	MNT3ERR_NOENT		= 2,		/* No such file or directory */
	MNT3ERR_IO		= 5,		/* I/O error */
	MNT3ERR_ACCES		= 13,		/* Permission denied */
	MNT3ERR_NOTDIR		= 20,		/* Not a directory */
	MNT3ERR_INVAL		= 22,		/* Invalid argument */
	MNT3ERR_NAMETOOLONG	= 63,		/* Filename too long */
	MNT3ERR_NOTSUPP		= 10004,	/* Operation not supported */
	MNT3ERR_SERVERFAULT	= 10006,	/* A failure on the server */
};

static struct {
	u32 status;
	int errno;
} mnt3_errtbl[] = {
	{ .status = MNT3_OK,			.errno = 0,		},
	{ .status = MNT3ERR_PERM,		.errno = -EPERM,	},
	{ .status = MNT3ERR_NOENT,		.errno = -ENOENT,	},
	{ .status = MNT3ERR_IO,			.errno = -EIO,		},
	{ .status = MNT3ERR_ACCES,		.errno = -EACCES,	},
	{ .status = MNT3ERR_NOTDIR,		.errno = -ENOTDIR,	},
	{ .status = MNT3ERR_INVAL,		.errno = -EINVAL,	},
	{ .status = MNT3ERR_NAMETOOLONG,	.errno = -ENAMETOOLONG,	},
	{ .status = MNT3ERR_NOTSUPP,		.errno = -ENOTSUPP,	},
122
	{ .status = MNT3ERR_SERVERFAULT,	.errno = -EREMOTEIO,	},
123 124 125 126 127
};

struct mountres {
	int errno;
	struct nfs_fh *fh;
128 129
	unsigned int *auth_count;
	rpc_authflavor_t *auth_flavors;
130 131
};

Linus Torvalds's avatar
Linus Torvalds committed
132
struct mnt_fhstatus {
133 134
	u32 status;
	struct nfs_fh *fh;
Linus Torvalds's avatar
Linus Torvalds committed
135 136
};

137 138
/**
 * nfs_mount - Obtain an NFS file handle for the given host and path
139
 * @info: pointer to mount request arguments
140
 *
141 142 143 144
 * Uses default timeout parameters specified by underlying transport. On
 * successful return, the auth_flavs list and auth_flav_len will be populated
 * with the list from the server or a faked-up list if the server didn't
 * provide one.
Linus Torvalds's avatar
Linus Torvalds committed
145
 */
146
int nfs_mount(struct nfs_mount_request *info)
Linus Torvalds's avatar
Linus Torvalds committed
147
{
148 149 150 151
	struct mountres	result = {
		.fh		= info->fh,
		.auth_count	= info->auth_flav_len,
		.auth_flavors	= info->auth_flavs,
Linus Torvalds's avatar
Linus Torvalds committed
152
	};
153
	struct rpc_message msg	= {
154
		.rpc_argp	= info->dirpath,
155 156
		.rpc_resp	= &result,
	};
157
	struct rpc_create_args args = {
158
		.net		= info->net,
159 160 161 162
		.protocol	= info->protocol,
		.address	= info->sap,
		.addrsize	= info->salen,
		.servername	= info->hostname,
163
		.program	= &mnt_program,
164
		.version	= info->version,
165 166 167
		.authflavor	= RPC_AUTH_UNIX,
	};
	struct rpc_clnt		*mnt_clnt;
Linus Torvalds's avatar
Linus Torvalds committed
168 169
	int			status;

170
	dprintk("NFS: sending MNT request for %s:%s\n",
171 172
		(info->hostname ? info->hostname : "server"),
			info->dirpath);
Linus Torvalds's avatar
Linus Torvalds committed
173

174 175 176
	if (strlen(info->dirpath) > MNTPATHLEN)
		return -ENAMETOOLONG;

177 178 179
	if (info->noresvport)
		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;

180
	mnt_clnt = rpc_create(&args);
Linus Torvalds's avatar
Linus Torvalds committed
181
	if (IS_ERR(mnt_clnt))
182
		goto out_clnt_err;
Linus Torvalds's avatar
Linus Torvalds committed
183

184
	if (info->version == NFS_MNT3_VERSION)
185 186
		msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC3_MNT];
	else
187
		msg.rpc_proc = &mnt_clnt->cl_procinfo[MOUNTPROC_MNT];
188

189
	status = rpc_call_sync(mnt_clnt, &msg, RPC_TASK_SOFT|RPC_TASK_TIMEOUT);
190
	rpc_shutdown_client(mnt_clnt);
191 192 193

	if (status < 0)
		goto out_call_err;
194
	if (result.errno != 0)
195 196 197 198 199
		goto out_mnt_err;

	dprintk("NFS: MNT request succeeded\n");
	status = 0;

200 201 202 203 204 205 206 207 208
	/*
	 * If the server didn't provide a flavor list, allow the
	 * client to try any flavor.
	 */
	if (info->version != NFS_MNT3_VERSION || *info->auth_flav_len == 0) {
		dprintk("NFS: Faking up auth_flavs list\n");
		info->auth_flavs[0] = RPC_AUTH_NULL;
		*info->auth_flav_len = 1;
	}
209 210 211 212 213
out:
	return status;

out_clnt_err:
	status = PTR_ERR(mnt_clnt);
214
	dprintk("NFS: failed to create MNT RPC client, status=%d\n", status);
215 216 217
	goto out;

out_call_err:
218
	dprintk("NFS: MNT request failed, status=%d\n", status);
219 220 221
	goto out;

out_mnt_err:
222 223
	dprintk("NFS: MNT server returned result %d\n", result.errno);
	status = result.errno;
224
	goto out;
Linus Torvalds's avatar
Linus Torvalds committed
225 226
}

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
/**
 * nfs_umount - Notify a server that we have unmounted this export
 * @info: pointer to umount request arguments
 *
 * MOUNTPROC_UMNT is advisory, so we set a short timeout, and always
 * use UDP.
 */
void nfs_umount(const struct nfs_mount_request *info)
{
	static const struct rpc_timeout nfs_umnt_timeout = {
		.to_initval = 1 * HZ,
		.to_maxval = 3 * HZ,
		.to_retries = 2,
	};
	struct rpc_create_args args = {
242
		.net		= info->net,
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
		.protocol	= IPPROTO_UDP,
		.address	= info->sap,
		.addrsize	= info->salen,
		.timeout	= &nfs_umnt_timeout,
		.servername	= info->hostname,
		.program	= &mnt_program,
		.version	= info->version,
		.authflavor	= RPC_AUTH_UNIX,
		.flags		= RPC_CLNT_CREATE_NOPING,
	};
	struct rpc_message msg	= {
		.rpc_argp	= info->dirpath,
	};
	struct rpc_clnt *clnt;
	int status;

259 260 261
	if (strlen(info->dirpath) > MNTPATHLEN)
		return;

262 263 264 265
	if (info->noresvport)
		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;

	clnt = rpc_create(&args);
266
	if (IS_ERR(clnt))
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
		goto out_clnt_err;

	dprintk("NFS: sending UMNT request for %s:%s\n",
		(info->hostname ? info->hostname : "server"), info->dirpath);

	if (info->version == NFS_MNT3_VERSION)
		msg.rpc_proc = &clnt->cl_procinfo[MOUNTPROC3_UMNT];
	else
		msg.rpc_proc = &clnt->cl_procinfo[MOUNTPROC_UMNT];

	status = rpc_call_sync(clnt, &msg, 0);
	rpc_shutdown_client(clnt);

	if (unlikely(status < 0))
		goto out_call_err;

	return;

out_clnt_err:
	dprintk("NFS: failed to create UMNT RPC client, status=%ld\n",
			PTR_ERR(clnt));
	return;

out_call_err:
	dprintk("NFS: UMNT request failed, status=%d\n", status);
}

Linus Torvalds's avatar
Linus Torvalds committed
294 295 296 297
/*
 * XDR encode/decode functions for MOUNT
 */

298
static void encode_mntdirpath(struct xdr_stream *xdr, const char *pathname)
299 300 301 302
{
	const u32 pathname_len = strlen(pathname);
	__be32 *p;

303
	p = xdr_reserve_space(xdr, 4 + pathname_len);
304 305 306
	xdr_encode_opaque(p, pathname, pathname_len);
}

307
static void mnt_xdr_enc_dirpath(struct rpc_rqst *req, struct xdr_stream *xdr,
308
				const void *dirpath)
309
{
310
	encode_mntdirpath(xdr, dirpath);
311 312
}

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
/*
 * RFC 1094: "A non-zero status indicates some sort of error.  In this
 * case, the status is a UNIX error number."  This can be problematic
 * if the server and client use different errno values for the same
 * error.
 *
 * However, the OpenGroup XNFS spec provides a simple mapping that is
 * independent of local errno values on the server and the client.
 */
static int decode_status(struct xdr_stream *xdr, struct mountres *res)
{
	unsigned int i;
	u32 status;
	__be32 *p;

328
	p = xdr_inline_decode(xdr, 4);
329 330
	if (unlikely(p == NULL))
		return -EIO;
331
	status = be32_to_cpup(p);
332

333
	for (i = 0; i < ARRAY_SIZE(mnt_errtbl); i++) {
334 335 336 337 338 339 340 341 342 343 344
		if (mnt_errtbl[i].status == status) {
			res->errno = mnt_errtbl[i].errno;
			return 0;
		}
	}

	dprintk("NFS: unrecognized MNT status code: %u\n", status);
	res->errno = -EACCES;
	return 0;
}

345 346 347 348 349 350 351 352 353 354 355 356 357 358
static int decode_fhandle(struct xdr_stream *xdr, struct mountres *res)
{
	struct nfs_fh *fh = res->fh;
	__be32 *p;

	p = xdr_inline_decode(xdr, NFS2_FHSIZE);
	if (unlikely(p == NULL))
		return -EIO;

	fh->size = NFS2_FHSIZE;
	memcpy(fh->data, p, NFS2_FHSIZE);
	return 0;
}

359 360
static int mnt_xdr_dec_mountres(struct rpc_rqst *req,
				struct xdr_stream *xdr,
361
				void *data)
362
{
363
	struct mountres *res = data;
364 365
	int status;

366
	status = decode_status(xdr, res);
367 368
	if (unlikely(status != 0 || res->errno != 0))
		return status;
369
	return decode_fhandle(xdr, res);
370 371
}

372 373 374 375 376 377
static int decode_fhs_status(struct xdr_stream *xdr, struct mountres *res)
{
	unsigned int i;
	u32 status;
	__be32 *p;

378
	p = xdr_inline_decode(xdr, 4);
379 380
	if (unlikely(p == NULL))
		return -EIO;
381
	status = be32_to_cpup(p);
382

383
	for (i = 0; i < ARRAY_SIZE(mnt3_errtbl); i++) {
384 385 386 387 388 389 390 391 392 393 394
		if (mnt3_errtbl[i].status == status) {
			res->errno = mnt3_errtbl[i].errno;
			return 0;
		}
	}

	dprintk("NFS: unrecognized MNT3 status code: %u\n", status);
	res->errno = -EACCES;
	return 0;
}

395 396 397 398 399 400
static int decode_fhandle3(struct xdr_stream *xdr, struct mountres *res)
{
	struct nfs_fh *fh = res->fh;
	u32 size;
	__be32 *p;

401
	p = xdr_inline_decode(xdr, 4);
402 403 404
	if (unlikely(p == NULL))
		return -EIO;

405
	size = be32_to_cpup(p);
406 407 408 409 410 411 412 413 414 415 416 417
	if (size > NFS3_FHSIZE || size == 0)
		return -EIO;

	p = xdr_inline_decode(xdr, size);
	if (unlikely(p == NULL))
		return -EIO;

	fh->size = size;
	memcpy(fh->data, p, size);
	return 0;
}

418 419 420 421 422 423 424 425 426 427
static int decode_auth_flavors(struct xdr_stream *xdr, struct mountres *res)
{
	rpc_authflavor_t *flavors = res->auth_flavors;
	unsigned int *count = res->auth_count;
	u32 entries, i;
	__be32 *p;

	if (*count == 0)
		return 0;

428
	p = xdr_inline_decode(xdr, 4);
429 430
	if (unlikely(p == NULL))
		return -EIO;
431
	entries = be32_to_cpup(p);
432 433 434 435
	dprintk("NFS: received %u auth flavors\n", entries);
	if (entries > NFS_MAX_SECFLAVORS)
		entries = NFS_MAX_SECFLAVORS;

436
	p = xdr_inline_decode(xdr, 4 * entries);
437 438 439 440 441 442 443
	if (unlikely(p == NULL))
		return -EIO;

	if (entries > *count)
		entries = *count;

	for (i = 0; i < entries; i++) {
444
		flavors[i] = be32_to_cpup(p++);
445
		dprintk("NFS:   auth flavor[%u]: %d\n", i, flavors[i]);
446 447 448 449 450 451
	}
	*count = i;

	return 0;
}

452 453
static int mnt_xdr_dec_mountres3(struct rpc_rqst *req,
				 struct xdr_stream *xdr,
454
				 void *data)
455
{
456
	struct mountres *res = data;
457 458
	int status;

459
	status = decode_fhs_status(xdr, res);
460 461
	if (unlikely(status != 0 || res->errno != 0))
		return status;
462
	status = decode_fhandle3(xdr, res);
463 464 465 466
	if (unlikely(status != 0)) {
		res->errno = -EBADHANDLE;
		return 0;
	}
467
	return decode_auth_flavors(xdr, res);
468 469
}

470
static const struct rpc_procinfo mnt_procedures[] = {
471 472
	[MOUNTPROC_MNT] = {
		.p_proc		= MOUNTPROC_MNT,
473
		.p_encode	= mnt_xdr_enc_dirpath,
474
		.p_decode	= mnt_xdr_dec_mountres,
475
		.p_arglen	= MNT_enc_dirpath_sz,
476
		.p_replen	= MNT_dec_mountres_sz,
477
		.p_statidx	= MOUNTPROC_MNT,
478
		.p_name		= "MOUNT",
Linus Torvalds's avatar
Linus Torvalds committed
479
	},
480 481
	[MOUNTPROC_UMNT] = {
		.p_proc		= MOUNTPROC_UMNT,
482
		.p_encode	= mnt_xdr_enc_dirpath,
483 484 485 486
		.p_arglen	= MNT_enc_dirpath_sz,
		.p_statidx	= MOUNTPROC_UMNT,
		.p_name		= "UMOUNT",
	},
Linus Torvalds's avatar
Linus Torvalds committed
487 488
};

489
static const struct rpc_procinfo mnt3_procedures[] = {
490 491
	[MOUNTPROC3_MNT] = {
		.p_proc		= MOUNTPROC3_MNT,
492
		.p_encode	= mnt_xdr_enc_dirpath,
493
		.p_decode	= mnt_xdr_dec_mountres3,
494
		.p_arglen	= MNT_enc_dirpath_sz,
495
		.p_replen	= MNT_dec_mountres3_sz,
496 497
		.p_statidx	= MOUNTPROC3_MNT,
		.p_name		= "MOUNT",
Linus Torvalds's avatar
Linus Torvalds committed
498
	},
499 500
	[MOUNTPROC3_UMNT] = {
		.p_proc		= MOUNTPROC3_UMNT,
501
		.p_encode	= mnt_xdr_enc_dirpath,
502 503 504 505
		.p_arglen	= MNT_enc_dirpath_sz,
		.p_statidx	= MOUNTPROC3_UMNT,
		.p_name		= "UMOUNT",
	},
Linus Torvalds's avatar
Linus Torvalds committed
506 507
};

508
static unsigned int mnt_counts[ARRAY_SIZE(mnt_procedures)];
509
static const struct rpc_version mnt_version1 = {
510
	.number		= 1,
511
	.nrprocs	= ARRAY_SIZE(mnt_procedures),
512
	.procs		= mnt_procedures,
513
	.counts		= mnt_counts,
Linus Torvalds's avatar
Linus Torvalds committed
514 515
};

516
static unsigned int mnt3_counts[ARRAY_SIZE(mnt3_procedures)];
517
static const struct rpc_version mnt_version3 = {
518
	.number		= 3,
519
	.nrprocs	= ARRAY_SIZE(mnt3_procedures),
520
	.procs		= mnt3_procedures,
521
	.counts		= mnt3_counts,
Linus Torvalds's avatar
Linus Torvalds committed
522 523
};

524
static const struct rpc_version *mnt_version[] = {
Linus Torvalds's avatar
Linus Torvalds committed
525 526 527 528 529 530
	NULL,
	&mnt_version1,
	NULL,
	&mnt_version3,
};

531
static struct rpc_stat mnt_stats;
Linus Torvalds's avatar
Linus Torvalds committed
532

533
static const struct rpc_program mnt_program = {
Linus Torvalds's avatar
Linus Torvalds committed
534 535
	.name		= "mount",
	.number		= NFS_MNT_PROGRAM,
536
	.nrvers		= ARRAY_SIZE(mnt_version),
Linus Torvalds's avatar
Linus Torvalds committed
537 538 539
	.version	= mnt_version,
	.stats		= &mnt_stats,
};