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 91da177e4SLinus Torvalds #include <linux/types.h> 101da177e4SLinus Torvalds #include <linux/sched.h> 111da177e4SLinus Torvalds #include <linux/module.h> 121da177e4SLinus Torvalds #include <linux/sunrpc/clnt.h> 131da177e4SLinus Torvalds #include <linux/sunrpc/auth.h> 141da177e4SLinus Torvalds 151da177e4SLinus Torvalds #define NFS_NGROUPS 16 161da177e4SLinus Torvalds 171da177e4SLinus Torvalds struct unx_cred { 181da177e4SLinus Torvalds struct rpc_cred uc_base; 191da177e4SLinus Torvalds gid_t uc_gid; 201da177e4SLinus Torvalds gid_t uc_gids[NFS_NGROUPS]; 211da177e4SLinus Torvalds }; 221da177e4SLinus Torvalds #define uc_uid uc_base.cr_uid 231da177e4SLinus Torvalds 241da177e4SLinus Torvalds #define UNX_CRED_EXPIRE (60 * HZ) 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #define UNX_WRITESLACK (21 + (UNX_MAXNODENAME >> 2)) 271da177e4SLinus Torvalds 281da177e4SLinus Torvalds #ifdef RPC_DEBUG 291da177e4SLinus Torvalds # define RPCDBG_FACILITY RPCDBG_AUTH 301da177e4SLinus Torvalds #endif 311da177e4SLinus Torvalds 321da177e4SLinus Torvalds static struct rpc_auth unix_auth; 331da177e4SLinus Torvalds static struct rpc_cred_cache unix_cred_cache; 34f1c0a861STrond Myklebust static const struct rpc_credops unix_credops; 351da177e4SLinus Torvalds 361da177e4SLinus Torvalds static struct rpc_auth * 371da177e4SLinus Torvalds unx_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor) 381da177e4SLinus Torvalds { 3946121cf7SChuck Lever dprintk("RPC: creating UNIX authenticator for client %p\n", 4046121cf7SChuck Lever clnt); 415c9cfc82STrond Myklebust if (atomic_inc_return(&unix_auth.au_count) == 1) 421da177e4SLinus Torvalds unix_cred_cache.nextgc = jiffies + (unix_cred_cache.expire >> 1); 431da177e4SLinus Torvalds return &unix_auth; 441da177e4SLinus Torvalds } 451da177e4SLinus Torvalds 461da177e4SLinus Torvalds static void 471da177e4SLinus Torvalds unx_destroy(struct rpc_auth *auth) 481da177e4SLinus Torvalds { 491da177e4SLinus Torvalds dprintk("RPC: destroying UNIX authenticator %p\n", auth); 503ab9bb72STrond Myklebust rpcauth_clear_credcache(auth->au_credcache); 511da177e4SLinus Torvalds } 521da177e4SLinus Torvalds 531da177e4SLinus Torvalds /* 541da177e4SLinus Torvalds * Lookup AUTH_UNIX creds for current process 551da177e4SLinus Torvalds */ 561da177e4SLinus Torvalds static struct rpc_cred * 571da177e4SLinus Torvalds unx_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags) 581da177e4SLinus Torvalds { 591da177e4SLinus Torvalds return rpcauth_lookup_credcache(auth, acred, flags); 601da177e4SLinus Torvalds } 611da177e4SLinus Torvalds 621da177e4SLinus Torvalds static struct rpc_cred * 631da177e4SLinus Torvalds unx_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags) 641da177e4SLinus Torvalds { 651da177e4SLinus Torvalds struct unx_cred *cred; 661da177e4SLinus Torvalds int i; 671da177e4SLinus Torvalds 681da177e4SLinus Torvalds dprintk("RPC: allocating UNIX cred for uid %d gid %d\n", 691da177e4SLinus Torvalds acred->uid, acred->gid); 701da177e4SLinus Torvalds 718b3a7005SKris Katterjohn if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL))) 721da177e4SLinus Torvalds return ERR_PTR(-ENOMEM); 731da177e4SLinus Torvalds 745fe4755eSTrond Myklebust rpcauth_init_cred(&cred->uc_base, acred, auth, &unix_credops); 755fe4755eSTrond Myklebust cred->uc_base.cr_flags = RPCAUTH_CRED_UPTODATE; 768a317760STrond Myklebust if (flags & RPCAUTH_LOOKUP_ROOTCREDS) { 771da177e4SLinus Torvalds cred->uc_uid = 0; 781da177e4SLinus Torvalds cred->uc_gid = 0; 791da177e4SLinus Torvalds cred->uc_gids[0] = NOGROUP; 801da177e4SLinus Torvalds } else { 811da177e4SLinus Torvalds int groups = acred->group_info->ngroups; 821da177e4SLinus Torvalds if (groups > NFS_NGROUPS) 831da177e4SLinus Torvalds groups = NFS_NGROUPS; 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds cred->uc_gid = acred->gid; 861da177e4SLinus Torvalds for (i = 0; i < groups; i++) 871da177e4SLinus Torvalds cred->uc_gids[i] = GROUP_AT(acred->group_info, i); 881da177e4SLinus Torvalds if (i < NFS_NGROUPS) 891da177e4SLinus Torvalds cred->uc_gids[i] = NOGROUP; 901da177e4SLinus Torvalds } 911da177e4SLinus Torvalds 921da177e4SLinus Torvalds return (struct rpc_cred *) cred; 931da177e4SLinus Torvalds } 941da177e4SLinus Torvalds 951da177e4SLinus Torvalds static void 961da177e4SLinus Torvalds unx_destroy_cred(struct rpc_cred *cred) 971da177e4SLinus Torvalds { 981da177e4SLinus Torvalds kfree(cred); 991da177e4SLinus Torvalds } 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds /* 1021da177e4SLinus Torvalds * Match credentials against current process creds. 1031da177e4SLinus Torvalds * The root_override argument takes care of cases where the caller may 1041da177e4SLinus Torvalds * request root creds (e.g. for NFS swapping). 1051da177e4SLinus Torvalds */ 1061da177e4SLinus Torvalds static int 1078a317760STrond Myklebust unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int flags) 1081da177e4SLinus Torvalds { 1091da177e4SLinus Torvalds struct unx_cred *cred = (struct unx_cred *) rcred; 1101da177e4SLinus Torvalds int i; 1111da177e4SLinus Torvalds 1128a317760STrond Myklebust if (!(flags & RPCAUTH_LOOKUP_ROOTCREDS)) { 1131da177e4SLinus Torvalds int groups; 1141da177e4SLinus Torvalds 1151da177e4SLinus Torvalds if (cred->uc_uid != acred->uid 1161da177e4SLinus Torvalds || cred->uc_gid != acred->gid) 1171da177e4SLinus Torvalds return 0; 1181da177e4SLinus Torvalds 1191da177e4SLinus Torvalds groups = acred->group_info->ngroups; 1201da177e4SLinus Torvalds if (groups > NFS_NGROUPS) 1211da177e4SLinus Torvalds groups = NFS_NGROUPS; 1221da177e4SLinus Torvalds for (i = 0; i < groups ; i++) 1231da177e4SLinus Torvalds if (cred->uc_gids[i] != GROUP_AT(acred->group_info, i)) 1241da177e4SLinus Torvalds return 0; 1251da177e4SLinus Torvalds return 1; 1261da177e4SLinus Torvalds } 1271da177e4SLinus Torvalds return (cred->uc_uid == 0 1281da177e4SLinus Torvalds && cred->uc_gid == 0 1291da177e4SLinus Torvalds && cred->uc_gids[0] == (gid_t) NOGROUP); 1301da177e4SLinus Torvalds } 1311da177e4SLinus Torvalds 1321da177e4SLinus Torvalds /* 1331da177e4SLinus Torvalds * Marshal credentials. 1341da177e4SLinus Torvalds * Maybe we should keep a cached credential for performance reasons. 1351da177e4SLinus Torvalds */ 136d8ed029dSAlexey Dobriyan static __be32 * 137d8ed029dSAlexey Dobriyan unx_marshal(struct rpc_task *task, __be32 *p) 1381da177e4SLinus Torvalds { 1391da177e4SLinus Torvalds struct rpc_clnt *clnt = task->tk_client; 1401da177e4SLinus Torvalds struct unx_cred *cred = (struct unx_cred *) task->tk_msg.rpc_cred; 141d8ed029dSAlexey Dobriyan __be32 *base, *hold; 1421da177e4SLinus Torvalds int i; 1431da177e4SLinus Torvalds 1441da177e4SLinus Torvalds *p++ = htonl(RPC_AUTH_UNIX); 1451da177e4SLinus Torvalds base = p++; 1461da177e4SLinus Torvalds *p++ = htonl(jiffies/HZ); 1471da177e4SLinus Torvalds 1481da177e4SLinus Torvalds /* 1491da177e4SLinus Torvalds * Copy the UTS nodename captured when the client was created. 1501da177e4SLinus Torvalds */ 1511da177e4SLinus Torvalds p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen); 1521da177e4SLinus Torvalds 1531da177e4SLinus Torvalds *p++ = htonl((u32) cred->uc_uid); 1541da177e4SLinus Torvalds *p++ = htonl((u32) cred->uc_gid); 1551da177e4SLinus Torvalds hold = p++; 1561da177e4SLinus Torvalds for (i = 0; i < 16 && cred->uc_gids[i] != (gid_t) NOGROUP; i++) 1571da177e4SLinus Torvalds *p++ = htonl((u32) cred->uc_gids[i]); 1581da177e4SLinus Torvalds *hold = htonl(p - hold - 1); /* gid array length */ 1591da177e4SLinus Torvalds *base = htonl((p - base - 1) << 2); /* cred length */ 1601da177e4SLinus Torvalds 1611da177e4SLinus Torvalds *p++ = htonl(RPC_AUTH_NULL); 1621da177e4SLinus Torvalds *p++ = htonl(0); 1631da177e4SLinus Torvalds 1641da177e4SLinus Torvalds return p; 1651da177e4SLinus Torvalds } 1661da177e4SLinus Torvalds 1671da177e4SLinus Torvalds /* 1681da177e4SLinus Torvalds * Refresh credentials. This is a no-op for AUTH_UNIX 1691da177e4SLinus Torvalds */ 1701da177e4SLinus Torvalds static int 1711da177e4SLinus Torvalds unx_refresh(struct rpc_task *task) 1721da177e4SLinus Torvalds { 1731da177e4SLinus Torvalds task->tk_msg.rpc_cred->cr_flags |= RPCAUTH_CRED_UPTODATE; 1741da177e4SLinus Torvalds return 0; 1751da177e4SLinus Torvalds } 1761da177e4SLinus Torvalds 177d8ed029dSAlexey Dobriyan static __be32 * 178d8ed029dSAlexey Dobriyan unx_validate(struct rpc_task *task, __be32 *p) 1791da177e4SLinus Torvalds { 1801da177e4SLinus Torvalds rpc_authflavor_t flavor; 1811da177e4SLinus Torvalds u32 size; 1821da177e4SLinus Torvalds 1831da177e4SLinus Torvalds flavor = ntohl(*p++); 1841da177e4SLinus Torvalds if (flavor != RPC_AUTH_NULL && 1851da177e4SLinus Torvalds flavor != RPC_AUTH_UNIX && 1861da177e4SLinus Torvalds flavor != RPC_AUTH_SHORT) { 1871da177e4SLinus Torvalds printk("RPC: bad verf flavor: %u\n", flavor); 1881da177e4SLinus Torvalds return NULL; 1891da177e4SLinus Torvalds } 1901da177e4SLinus Torvalds 1911da177e4SLinus Torvalds size = ntohl(*p++); 1921da177e4SLinus Torvalds if (size > RPC_MAX_AUTH_SIZE) { 1931da177e4SLinus Torvalds printk("RPC: giant verf size: %u\n", size); 1941da177e4SLinus Torvalds return NULL; 1951da177e4SLinus Torvalds } 1961da177e4SLinus Torvalds task->tk_auth->au_rslack = (size >> 2) + 2; 1971da177e4SLinus Torvalds p += (size >> 2); 1981da177e4SLinus Torvalds 1991da177e4SLinus Torvalds return p; 2001da177e4SLinus Torvalds } 2011da177e4SLinus Torvalds 202f1c0a861STrond Myklebust const struct rpc_authops authunix_ops = { 2031da177e4SLinus Torvalds .owner = THIS_MODULE, 2041da177e4SLinus Torvalds .au_flavor = RPC_AUTH_UNIX, 2051da177e4SLinus Torvalds #ifdef RPC_DEBUG 2061da177e4SLinus Torvalds .au_name = "UNIX", 2071da177e4SLinus Torvalds #endif 2081da177e4SLinus Torvalds .create = unx_create, 2091da177e4SLinus Torvalds .destroy = unx_destroy, 2101da177e4SLinus Torvalds .lookup_cred = unx_lookup_cred, 2111da177e4SLinus Torvalds .crcreate = unx_create_cred, 2121da177e4SLinus Torvalds }; 2131da177e4SLinus Torvalds 2141da177e4SLinus Torvalds static 2151da177e4SLinus Torvalds struct rpc_cred_cache unix_cred_cache = { 2161da177e4SLinus Torvalds .expire = UNX_CRED_EXPIRE, 2171da177e4SLinus Torvalds }; 2181da177e4SLinus Torvalds 2191da177e4SLinus Torvalds static 2201da177e4SLinus Torvalds struct rpc_auth unix_auth = { 2211da177e4SLinus Torvalds .au_cslack = UNX_WRITESLACK, 2221da177e4SLinus Torvalds .au_rslack = 2, /* assume AUTH_NULL verf */ 2231da177e4SLinus Torvalds .au_ops = &authunix_ops, 22481039f1fSTrond Myklebust .au_flavor = RPC_AUTH_UNIX, 2251da177e4SLinus Torvalds .au_count = ATOMIC_INIT(0), 2261da177e4SLinus Torvalds .au_credcache = &unix_cred_cache, 2271da177e4SLinus Torvalds }; 2281da177e4SLinus Torvalds 2291da177e4SLinus Torvalds static 230f1c0a861STrond Myklebust const struct rpc_credops unix_credops = { 2311da177e4SLinus Torvalds .cr_name = "AUTH_UNIX", 2321da177e4SLinus Torvalds .crdestroy = unx_destroy_cred, 2331da177e4SLinus Torvalds .crmatch = unx_match, 2341da177e4SLinus Torvalds .crmarshal = unx_marshal, 2351da177e4SLinus Torvalds .crrefresh = unx_refresh, 2361da177e4SLinus Torvalds .crvalidate = unx_validate, 2371da177e4SLinus Torvalds }; 238