11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * linux/net/sunrpc/auth_unix.c 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * UNIX-style authentication; no AUTH_SHORT support 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de> 71da177e4SLinus Torvalds */ 81da177e4SLinus Torvalds 95a0e3ad6STejun Heo #include <linux/slab.h> 101da177e4SLinus Torvalds #include <linux/types.h> 111da177e4SLinus Torvalds #include <linux/sched.h> 121da177e4SLinus Torvalds #include <linux/module.h> 131da177e4SLinus Torvalds #include <linux/sunrpc/clnt.h> 141da177e4SLinus Torvalds #include <linux/sunrpc/auth.h> 15ae2975bcSEric W. Biederman #include <linux/user_namespace.h> 161da177e4SLinus Torvalds 171da177e4SLinus Torvalds #define NFS_NGROUPS 16 181da177e4SLinus Torvalds 191da177e4SLinus Torvalds struct unx_cred { 201da177e4SLinus Torvalds struct rpc_cred uc_base; 217eaf040bSEric W. Biederman kgid_t uc_gid; 227eaf040bSEric W. Biederman kgid_t uc_gids[NFS_NGROUPS]; 231da177e4SLinus Torvalds }; 241da177e4SLinus Torvalds #define uc_uid uc_base.cr_uid 251da177e4SLinus Torvalds 26f895b252SJeff Layton #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 271da177e4SLinus Torvalds # define RPCDBG_FACILITY RPCDBG_AUTH 281da177e4SLinus Torvalds #endif 291da177e4SLinus Torvalds 301da177e4SLinus Torvalds static struct rpc_auth unix_auth; 31f1c0a861STrond Myklebust static const struct rpc_credops unix_credops; 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds static struct rpc_auth * 34c2190661STrond Myklebust unx_create(struct rpc_auth_create_args *args, struct rpc_clnt *clnt) 351da177e4SLinus Torvalds { 3646121cf7SChuck Lever dprintk("RPC: creating UNIX authenticator for client %p\n", 3746121cf7SChuck Lever clnt); 38f5c2187cSTrond Myklebust atomic_inc(&unix_auth.au_count); 391da177e4SLinus Torvalds return &unix_auth; 401da177e4SLinus Torvalds } 411da177e4SLinus Torvalds 421da177e4SLinus Torvalds static void 431da177e4SLinus Torvalds unx_destroy(struct rpc_auth *auth) 441da177e4SLinus Torvalds { 451da177e4SLinus Torvalds dprintk("RPC: destroying UNIX authenticator %p\n", auth); 463ab9bb72STrond Myklebust rpcauth_clear_credcache(auth->au_credcache); 471da177e4SLinus Torvalds } 481da177e4SLinus Torvalds 491da177e4SLinus Torvalds /* 501da177e4SLinus Torvalds * Lookup AUTH_UNIX creds for current process 511da177e4SLinus Torvalds */ 521da177e4SLinus Torvalds static struct rpc_cred * 531da177e4SLinus Torvalds unx_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags) 541da177e4SLinus Torvalds { 553c6e0bc8SJeff Layton return rpcauth_lookup_credcache(auth, acred, flags, GFP_NOFS); 561da177e4SLinus Torvalds } 571da177e4SLinus Torvalds 581da177e4SLinus Torvalds static struct rpc_cred * 593c6e0bc8SJeff Layton unx_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp) 601da177e4SLinus Torvalds { 611da177e4SLinus Torvalds struct unx_cred *cred; 62af093835STrond Myklebust unsigned int groups = 0; 63af093835STrond Myklebust unsigned int i; 641da177e4SLinus Torvalds 651da177e4SLinus Torvalds dprintk("RPC: allocating UNIX cred for uid %d gid %d\n", 66cdba321eSEric W. Biederman from_kuid(&init_user_ns, acred->uid), 67cdba321eSEric W. Biederman from_kgid(&init_user_ns, acred->gid)); 681da177e4SLinus Torvalds 693c6e0bc8SJeff Layton if (!(cred = kmalloc(sizeof(*cred), gfp))) 701da177e4SLinus Torvalds return ERR_PTR(-ENOMEM); 711da177e4SLinus Torvalds 725fe4755eSTrond Myklebust rpcauth_init_cred(&cred->uc_base, acred, auth, &unix_credops); 73fc432dd9STrond Myklebust cred->uc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE; 74af093835STrond Myklebust 75af093835STrond Myklebust if (acred->group_info != NULL) 76af093835STrond Myklebust groups = acred->group_info->ngroups; 771da177e4SLinus Torvalds if (groups > NFS_NGROUPS) 781da177e4SLinus Torvalds groups = NFS_NGROUPS; 791da177e4SLinus Torvalds 801da177e4SLinus Torvalds cred->uc_gid = acred->gid; 819132adb0SEric W. Biederman for (i = 0; i < groups; i++) 829132adb0SEric W. Biederman cred->uc_gids[i] = GROUP_AT(acred->group_info, i); 831da177e4SLinus Torvalds if (i < NFS_NGROUPS) 84bf37f794SEric W. Biederman cred->uc_gids[i] = INVALID_GID; 851da177e4SLinus Torvalds 86696e38dfSTrond Myklebust return &cred->uc_base; 871da177e4SLinus Torvalds } 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds static void 9031be5bf1STrond Myklebust unx_free_cred(struct unx_cred *unx_cred) 911da177e4SLinus Torvalds { 9231be5bf1STrond Myklebust dprintk("RPC: unx_free_cred %p\n", unx_cred); 9331be5bf1STrond Myklebust kfree(unx_cred); 9431be5bf1STrond Myklebust } 95696e38dfSTrond Myklebust 9631be5bf1STrond Myklebust static void 9731be5bf1STrond Myklebust unx_free_cred_callback(struct rcu_head *head) 9831be5bf1STrond Myklebust { 9931be5bf1STrond Myklebust struct unx_cred *unx_cred = container_of(head, struct unx_cred, uc_base.cr_rcu); 10031be5bf1STrond Myklebust unx_free_cred(unx_cred); 10131be5bf1STrond Myklebust } 10231be5bf1STrond Myklebust 10331be5bf1STrond Myklebust static void 10431be5bf1STrond Myklebust unx_destroy_cred(struct rpc_cred *cred) 10531be5bf1STrond Myklebust { 10631be5bf1STrond Myklebust call_rcu(&cred->cr_rcu, unx_free_cred_callback); 1071da177e4SLinus Torvalds } 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds /* 1101da177e4SLinus Torvalds * Match credentials against current process creds. 1111da177e4SLinus Torvalds * The root_override argument takes care of cases where the caller may 1121da177e4SLinus Torvalds * request root creds (e.g. for NFS swapping). 1131da177e4SLinus Torvalds */ 1141da177e4SLinus Torvalds static int 1158a317760STrond Myklebust unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int flags) 1161da177e4SLinus Torvalds { 117696e38dfSTrond Myklebust struct unx_cred *cred = container_of(rcred, struct unx_cred, uc_base); 118af093835STrond Myklebust unsigned int groups = 0; 119af093835STrond Myklebust unsigned int i; 1201da177e4SLinus Torvalds 1211da177e4SLinus Torvalds 1220b4d51b0SEric W. Biederman if (!uid_eq(cred->uc_uid, acred->uid) || !gid_eq(cred->uc_gid, acred->gid)) 1231da177e4SLinus Torvalds return 0; 1241da177e4SLinus Torvalds 125af093835STrond Myklebust if (acred->group_info != NULL) 1261da177e4SLinus Torvalds groups = acred->group_info->ngroups; 1271da177e4SLinus Torvalds if (groups > NFS_NGROUPS) 1281da177e4SLinus Torvalds groups = NFS_NGROUPS; 1299132adb0SEric W. Biederman for (i = 0; i < groups ; i++) 1309132adb0SEric W. Biederman if (!gid_eq(cred->uc_gids[i], GROUP_AT(acred->group_info, i))) 1311da177e4SLinus Torvalds return 0; 132e572fc73SEric W. Biederman if (groups < NFS_NGROUPS && gid_valid(cred->uc_gids[groups])) 133dc6f55e9SNeilBrown return 0; 1341da177e4SLinus Torvalds return 1; 1351da177e4SLinus Torvalds } 1361da177e4SLinus Torvalds 1371da177e4SLinus Torvalds /* 1381da177e4SLinus Torvalds * Marshal credentials. 1391da177e4SLinus Torvalds * Maybe we should keep a cached credential for performance reasons. 1401da177e4SLinus Torvalds */ 141d8ed029dSAlexey Dobriyan static __be32 * 142d8ed029dSAlexey Dobriyan unx_marshal(struct rpc_task *task, __be32 *p) 1431da177e4SLinus Torvalds { 1441da177e4SLinus Torvalds struct rpc_clnt *clnt = task->tk_client; 145a17c2153STrond Myklebust struct unx_cred *cred = container_of(task->tk_rqstp->rq_cred, struct unx_cred, uc_base); 146d8ed029dSAlexey Dobriyan __be32 *base, *hold; 1471da177e4SLinus Torvalds int i; 1481da177e4SLinus Torvalds 1491da177e4SLinus Torvalds *p++ = htonl(RPC_AUTH_UNIX); 1501da177e4SLinus Torvalds base = p++; 1511da177e4SLinus Torvalds *p++ = htonl(jiffies/HZ); 1521da177e4SLinus Torvalds 1531da177e4SLinus Torvalds /* 1541da177e4SLinus Torvalds * Copy the UTS nodename captured when the client was created. 1551da177e4SLinus Torvalds */ 1561da177e4SLinus Torvalds p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen); 1571da177e4SLinus Torvalds 158a570abbbSEric W. Biederman *p++ = htonl((u32) from_kuid(&init_user_ns, cred->uc_uid)); 159a570abbbSEric W. Biederman *p++ = htonl((u32) from_kgid(&init_user_ns, cred->uc_gid)); 1601da177e4SLinus Torvalds hold = p++; 161e572fc73SEric W. Biederman for (i = 0; i < 16 && gid_valid(cred->uc_gids[i]); i++) 162a570abbbSEric W. Biederman *p++ = htonl((u32) from_kgid(&init_user_ns, cred->uc_gids[i])); 1631da177e4SLinus Torvalds *hold = htonl(p - hold - 1); /* gid array length */ 1641da177e4SLinus Torvalds *base = htonl((p - base - 1) << 2); /* cred length */ 1651da177e4SLinus Torvalds 1661da177e4SLinus Torvalds *p++ = htonl(RPC_AUTH_NULL); 1671da177e4SLinus Torvalds *p++ = htonl(0); 1681da177e4SLinus Torvalds 1691da177e4SLinus Torvalds return p; 1701da177e4SLinus Torvalds } 1711da177e4SLinus Torvalds 1721da177e4SLinus Torvalds /* 1731da177e4SLinus Torvalds * Refresh credentials. This is a no-op for AUTH_UNIX 1741da177e4SLinus Torvalds */ 1751da177e4SLinus Torvalds static int 1761da177e4SLinus Torvalds unx_refresh(struct rpc_task *task) 1771da177e4SLinus Torvalds { 178a17c2153STrond Myklebust set_bit(RPCAUTH_CRED_UPTODATE, &task->tk_rqstp->rq_cred->cr_flags); 1791da177e4SLinus Torvalds return 0; 1801da177e4SLinus Torvalds } 1811da177e4SLinus Torvalds 182d8ed029dSAlexey Dobriyan static __be32 * 183d8ed029dSAlexey Dobriyan unx_validate(struct rpc_task *task, __be32 *p) 1841da177e4SLinus Torvalds { 1851da177e4SLinus Torvalds rpc_authflavor_t flavor; 1861da177e4SLinus Torvalds u32 size; 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds flavor = ntohl(*p++); 1891da177e4SLinus Torvalds if (flavor != RPC_AUTH_NULL && 1901da177e4SLinus Torvalds flavor != RPC_AUTH_UNIX && 1911da177e4SLinus Torvalds flavor != RPC_AUTH_SHORT) { 1921da177e4SLinus Torvalds printk("RPC: bad verf flavor: %u\n", flavor); 19335fa5f7bSAndy Adamson return ERR_PTR(-EIO); 1941da177e4SLinus Torvalds } 1951da177e4SLinus Torvalds 1961da177e4SLinus Torvalds size = ntohl(*p++); 1971da177e4SLinus Torvalds if (size > RPC_MAX_AUTH_SIZE) { 1981da177e4SLinus Torvalds printk("RPC: giant verf size: %u\n", size); 19935fa5f7bSAndy Adamson return ERR_PTR(-EIO); 2001da177e4SLinus Torvalds } 201a17c2153STrond Myklebust task->tk_rqstp->rq_cred->cr_auth->au_rslack = (size >> 2) + 2; 2021da177e4SLinus Torvalds p += (size >> 2); 2031da177e4SLinus Torvalds 2041da177e4SLinus Torvalds return p; 2051da177e4SLinus Torvalds } 2061da177e4SLinus Torvalds 2075d8d9a4dSTrond Myklebust int __init rpc_init_authunix(void) 2089499b434STrond Myklebust { 2095d8d9a4dSTrond Myklebust return rpcauth_init_credcache(&unix_auth); 2105d8d9a4dSTrond Myklebust } 2115d8d9a4dSTrond Myklebust 2125d8d9a4dSTrond Myklebust void rpc_destroy_authunix(void) 2135d8d9a4dSTrond Myklebust { 2145d8d9a4dSTrond Myklebust rpcauth_destroy_credcache(&unix_auth); 2159499b434STrond Myklebust } 2169499b434STrond Myklebust 217f1c0a861STrond Myklebust const struct rpc_authops authunix_ops = { 2181da177e4SLinus Torvalds .owner = THIS_MODULE, 2191da177e4SLinus Torvalds .au_flavor = RPC_AUTH_UNIX, 2201da177e4SLinus Torvalds .au_name = "UNIX", 2211da177e4SLinus Torvalds .create = unx_create, 2221da177e4SLinus Torvalds .destroy = unx_destroy, 2231da177e4SLinus Torvalds .lookup_cred = unx_lookup_cred, 2241da177e4SLinus Torvalds .crcreate = unx_create_cred, 2251da177e4SLinus Torvalds }; 2261da177e4SLinus Torvalds 2271da177e4SLinus Torvalds static 2281da177e4SLinus Torvalds struct rpc_auth unix_auth = { 2294500632fSChuck Lever .au_cslack = UNX_CALLSLACK, 2304500632fSChuck Lever .au_rslack = NUL_REPLYSLACK, 2311da177e4SLinus Torvalds .au_ops = &authunix_ops, 23281039f1fSTrond Myklebust .au_flavor = RPC_AUTH_UNIX, 2331da177e4SLinus Torvalds .au_count = ATOMIC_INIT(0), 2341da177e4SLinus Torvalds }; 2351da177e4SLinus Torvalds 2361da177e4SLinus Torvalds static 237f1c0a861STrond Myklebust const struct rpc_credops unix_credops = { 2381da177e4SLinus Torvalds .cr_name = "AUTH_UNIX", 2391da177e4SLinus Torvalds .crdestroy = unx_destroy_cred, 2405c691044STrond Myklebust .crbind = rpcauth_generic_bind_cred, 2411da177e4SLinus Torvalds .crmatch = unx_match, 2421da177e4SLinus Torvalds .crmarshal = unx_marshal, 2431da177e4SLinus Torvalds .crrefresh = unx_refresh, 2441da177e4SLinus Torvalds .crvalidate = unx_validate, 2451da177e4SLinus Torvalds }; 246