fs/nfs/callback.c

/*
 * linux/fs/nfs/callback.c
 *
 * Copyright (C) 2004 Trond Myklebust
 *
 * NFSv4 callback handling
 */

#include <linux/config.h>
#include <linux/completion.h>
#include <linux/ip.h>
#include <linux/module.h>
#include <linux/smp_lock.h>
#include <linux/sunrpc/svc.h>
#include <linux/sunrpc/svcsock.h>
#include <linux/nfs_fs.h>
#include "callback.h"

#define NFSDBG_FACILITY NFSDBG_CALLBACK

struct nfs_callback_data {
	unsigned int users;
	struct svc_serv *serv;
	pid_t pid;
	struct completion started;
	struct completion stopped;
};

static struct nfs_callback_data nfs_callback_info;
static DECLARE_MUTEX(nfs_callback_sema);
static struct svc_program nfs4_callback_program;

unsigned short nfs_callback_tcpport;

/*
 * This is the callback kernel thread.
 */
static void nfs_callback_svc(struct svc_rqst *rqstp)
{
	struct svc_serv *serv = rqstp->rq_server;
	int err;

	__module_get(THIS_MODULE);
	lock_kernel();

	nfs_callback_info.pid = current->pid;
	daemonize("nfsv4-svc");
	/* Process request with signals blocked, but allow SIGKILL.  */
	allow_signal(SIGKILL);

	complete(&nfs_callback_info.started);

	while (nfs_callback_info.users != 0 || !signalled()) {
		/*
		 * Listen for a request on the socket
		 */
		err = svc_recv(serv, rqstp, MAX_SCHEDULE_TIMEOUT);
		if (err == -EAGAIN || err == -EINTR)
			continue;
		if (err < 0) {
			printk(KERN_WARNING
					"%s: terminating on error %d\n",
					__FUNCTION__, -err);
			break;
		}
		dprintk("%s: request from %u.%u.%u.%u\n", __FUNCTION__,
				NIPQUAD(rqstp->rq_addr.sin_addr.s_addr));
		svc_process(serv, rqstp);
	}

	nfs_callback_info.pid = 0;
	complete(&nfs_callback_info.stopped);
	unlock_kernel();
	module_put_and_exit(0);
}

/*
 * Bring up the server process if it is not already up.
 */
int nfs_callback_up(void)
{
	struct svc_serv *serv;
	struct svc_sock *svsk;
	int ret = 0;

	lock_kernel();
	down(&nfs_callback_sema);
	if (nfs_callback_info.users++ || nfs_callback_info.pid != 0)
		goto out;
	init_completion(&nfs_callback_info.started);
	init_completion(&nfs_callback_info.stopped);
	serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE);
	ret = -ENOMEM;
	if (!serv)
		goto out_err;
	/* FIXME: We don't want to register this socket with the portmapper */
	ret = svc_makesock(serv, IPPROTO_TCP, 0);
	if (ret < 0)
		goto out_destroy;
	if (!list_empty(&serv->sv_permsocks)) {
		svsk = list_entry(serv->sv_permsocks.next,
				struct svc_sock, sk_list);
		nfs_callback_tcpport = ntohs(inet_sk(svsk->sk_sk)->sport);
		dprintk ("Callback port = 0x%x\n", nfs_callback_tcpport);
	} else
		BUG();
	ret = svc_create_thread(nfs_callback_svc, serv);
	if (ret < 0)
		goto out_destroy;
	nfs_callback_info.serv = serv;
	wait_for_completion(&nfs_callback_info.started);
out:
	up(&nfs_callback_sema);
	unlock_kernel();
	return ret;
out_destroy:
	svc_destroy(serv);
out_err:
	nfs_callback_info.users--;
	goto out;
}

/*
 * Kill the server process if it is not already up.
 */
int nfs_callback_down(void)
{
	int ret = 0;

	lock_kernel();
	down(&nfs_callback_sema);
	if (--nfs_callback_info.users || nfs_callback_info.pid == 0)
		goto out;
	kill_proc(nfs_callback_info.pid, SIGKILL, 1);
	wait_for_completion(&nfs_callback_info.stopped);
out:
	up(&nfs_callback_sema);
	unlock_kernel();
	return ret;
}

/*
 * AUTH_NULL authentication
 */
static int nfs_callback_null_accept(struct svc_rqst *rqstp, u32 *authp)
{
	struct kvec    *argv = &rqstp->rq_arg.head[0];
	struct kvec    *resv = &rqstp->rq_res.head[0];

	if (argv->iov_len < 3*4)
		return SVC_GARBAGE;

	if (svc_getu32(argv) != 0) {
		dprintk("svc: bad null cred\n");
		*authp = rpc_autherr_badcred;
		return SVC_DENIED;
	}
	if (svc_getu32(argv) != RPC_AUTH_NULL || svc_getu32(argv) != 0) {
		dprintk("svc: bad null verf\n");
		 *authp = rpc_autherr_badverf;
		 return SVC_DENIED;
	}

	/* Signal that mapping to nobody uid/gid is required */
	rqstp->rq_cred.cr_uid = (uid_t) -1;
	rqstp->rq_cred.cr_gid = (gid_t) -1;
	rqstp->rq_cred.cr_group_info = groups_alloc(0);
	if (rqstp->rq_cred.cr_group_info == NULL)
		return SVC_DROP; /* kmalloc failure - client must retry */

	/* Put NULL verifier */
	svc_putu32(resv, RPC_AUTH_NULL);
	svc_putu32(resv, 0);
	dprintk("%s: success, returning %d!\n", __FUNCTION__, SVC_OK);
	return SVC_OK;
}

static int nfs_callback_null_release(struct svc_rqst *rqstp)
{
	if (rqstp->rq_cred.cr_group_info)
		put_group_info(rqstp->rq_cred.cr_group_info);
	rqstp->rq_cred.cr_group_info = NULL;
	return 0; /* don't drop */
}

static struct auth_ops nfs_callback_auth_null = {
	.name = "null",
	.flavour = RPC_AUTH_NULL,
	.accept = nfs_callback_null_accept,
	.release = nfs_callback_null_release,
};

/*
 * AUTH_SYS authentication
 */
static int nfs_callback_unix_accept(struct svc_rqst *rqstp, u32 *authp)
{
	struct kvec    *argv = &rqstp->rq_arg.head[0];
	struct kvec    *resv = &rqstp->rq_res.head[0];
	struct svc_cred *cred = &rqstp->rq_cred;
	u32 slen, i;
	int len = argv->iov_len;

	dprintk("%s: start\n", __FUNCTION__);
	cred->cr_group_info = NULL;
	rqstp->rq_client = NULL;
	if ((len -= 3*4) < 0)
		return SVC_GARBAGE;

	/* Get length, time stamp and machine name */
	svc_getu32(argv);
	svc_getu32(argv);
	slen = XDR_QUADLEN(ntohl(svc_getu32(argv)));
	if (slen > 64 || (len -= (slen + 3)*4) < 0)
		goto badcred;
	argv->iov_base = (void*)((u32*)argv->iov_base + slen);
	argv->iov_len -= slen*4;

	cred->cr_uid = ntohl(svc_getu32(argv));
	cred->cr_gid = ntohl(svc_getu32(argv));
	slen = ntohl(svc_getu32(argv));
	if (slen > 16 || (len -= (slen + 2)*4) < 0)
		goto badcred;
	cred->cr_group_info = groups_alloc(slen);
	if (cred->cr_group_info == NULL)
		return SVC_DROP;
	for (i = 0; i < slen; i++)
		GROUP_AT(cred->cr_group_info, i) = ntohl(svc_getu32(argv));

	if (svc_getu32(argv) != RPC_AUTH_NULL || svc_getu32(argv) != 0) {
		*authp = rpc_autherr_badverf;
		return SVC_DENIED;
	}
	/* Put NULL verifier */
	svc_putu32(resv, RPC_AUTH_NULL);
	svc_putu32(resv, 0);
	dprintk("%s: success, returning %d!\n", __FUNCTION__, SVC_OK);
	return SVC_OK;
badcred:
	*authp = rpc_autherr_badcred;
	return SVC_DENIED;
}

static int nfs_callback_unix_release(struct svc_rqst *rqstp)
{
	if (rqstp->rq_cred.cr_group_info)
		put_group_info(rqstp->rq_cred.cr_group_info);
	rqstp->rq_cred.cr_group_info = NULL;
	return 0;
}

static struct auth_ops nfs_callback_auth_unix = {
	.name = "unix",
	.flavour = RPC_AUTH_UNIX,
	.accept = nfs_callback_unix_accept,
	.release = nfs_callback_unix_release,
};

/*
 * Hook the authentication protocol
 */
static int nfs_callback_auth(struct svc_rqst *rqstp, u32 *authp)
{
	struct in_addr *addr = &rqstp->rq_addr.sin_addr;
	struct nfs4_client *clp;
	struct kvec *argv = &rqstp->rq_arg.head[0];
	int flavour;
	int retval;

	/* Don't talk to strangers */
	clp = nfs4_find_client(addr);
	if (clp == NULL)
		return SVC_DROP;
	dprintk("%s: %u.%u.%u.%u NFSv4 callback!\n", __FUNCTION__, NIPQUAD(addr));
	nfs4_put_client(clp);
	flavour = ntohl(svc_getu32(argv));
	switch(flavour) {
		case RPC_AUTH_NULL:
			if (rqstp->rq_proc != CB_NULL) {
				*authp = rpc_autherr_tooweak;
				retval = SVC_DENIED;
				break;
			}
			rqstp->rq_authop = &nfs_callback_auth_null;
			retval = nfs_callback_null_accept(rqstp, authp);
			break;
		case RPC_AUTH_UNIX:
			/* Eat the authentication flavour */
			rqstp->rq_authop = &nfs_callback_auth_unix;
			retval = nfs_callback_unix_accept(rqstp, authp);
			break;
		default:
			/* FIXME: need to add RPCSEC_GSS upcalls */
#if 0
			svc_ungetu32(argv);
			retval = svc_authenticate(rqstp, authp);
#else
			*authp = rpc_autherr_rejectedcred;
			retval = SVC_DENIED;
#endif
	}
	dprintk("%s: flavour %d returning error %d\n", __FUNCTION__, flavour, retval);
	return retval;
}

/*
 * Define NFS4 callback program
 */
extern struct svc_version nfs4_callback_version1;

static struct svc_version *nfs4_callback_version[] = {
	[1] = &nfs4_callback_version1,
};

static struct svc_stat nfs4_callback_stats;

static struct svc_program nfs4_callback_program = {
	.pg_prog = NFS4_CALLBACK,			/* RPC service number */
	.pg_nvers = ARRAY_SIZE(nfs4_callback_version),	/* Number of entries */
	.pg_vers = nfs4_callback_version,		/* version table */
	.pg_name = "NFSv4 callback",			/* service name */
	.pg_class = "nfs",				/* authentication class */
	.pg_stats = &nfs4_callback_stats,
	.pg_authenticate = nfs_callback_auth,
};