1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <linux/types.h>
3 #include <linux/sched.h>
4 #include <linux/module.h>
5 #include <linux/sunrpc/types.h>
6 #include <linux/sunrpc/xdr.h>
7 #include <linux/sunrpc/svcsock.h>
8 #include <linux/sunrpc/svcauth.h>
9 #include <linux/sunrpc/gss_api.h>
10 #include <linux/sunrpc/addr.h>
11 #include <linux/err.h>
12 #include <linux/seq_file.h>
13 #include <linux/hash.h>
14 #include <linux/string.h>
15 #include <linux/slab.h>
18 #include <linux/kernel.h>
19 #include <linux/user_namespace.h>
20 #define RPCDBG_FACILITY RPCDBG_AUTH
26 * AUTHUNIX and AUTHNULL credentials are both handled here.
27 * AUTHNULL is treated just like AUTHUNIX except that the uid/gid
28 * are always nobody (-2). i.e. we do the same IP address checks for
29 * AUTHNULL as for AUTHUNIX, and that is done here.
35 /* other stuff later */
38 extern struct auth_ops svcauth_null;
39 extern struct auth_ops svcauth_unix;
41 static void svcauth_unix_domain_release_rcu(struct rcu_head *head)
43 struct auth_domain *dom = container_of(head, struct auth_domain, rcu_head);
44 struct unix_domain *ud = container_of(dom, struct unix_domain, h);
50 static void svcauth_unix_domain_release(struct auth_domain *dom)
52 call_rcu(&dom->rcu_head, svcauth_unix_domain_release_rcu);
55 struct auth_domain *unix_domain_find(char *name)
57 struct auth_domain *rv;
58 struct unix_domain *new = NULL;
60 rv = auth_domain_find(name);
63 if (new && rv != &new->h)
64 svcauth_unix_domain_release(&new->h);
66 if (rv->flavour != &svcauth_unix) {
73 new = kmalloc(sizeof(*new), GFP_KERNEL);
76 kref_init(&new->h.ref);
77 new->h.name = kstrdup(name, GFP_KERNEL);
78 if (new->h.name == NULL) {
82 new->h.flavour = &svcauth_unix;
83 rv = auth_domain_lookup(name, &new->h);
86 EXPORT_SYMBOL_GPL(unix_domain_find);
89 /**************************************************
90 * cache for IP address to unix_domain
91 * as needed by AUTH_UNIX
94 #define IP_HASHMAX (1<<IP_HASHBITS)
98 char m_class[8]; /* e.g. "nfsd" */
99 struct in6_addr m_addr;
100 struct unix_domain *m_client;
101 struct rcu_head m_rcu;
104 static void ip_map_put(struct kref *kref)
106 struct cache_head *item = container_of(kref, struct cache_head, ref);
107 struct ip_map *im = container_of(item, struct ip_map,h);
109 if (test_bit(CACHE_VALID, &item->flags) &&
110 !test_bit(CACHE_NEGATIVE, &item->flags))
111 auth_domain_put(&im->m_client->h);
112 kfree_rcu(im, m_rcu);
115 static inline int hash_ip6(const struct in6_addr *ip)
117 return hash_32(ipv6_addr_hash(ip), IP_HASHBITS);
119 static int ip_map_match(struct cache_head *corig, struct cache_head *cnew)
121 struct ip_map *orig = container_of(corig, struct ip_map, h);
122 struct ip_map *new = container_of(cnew, struct ip_map, h);
123 return strcmp(orig->m_class, new->m_class) == 0 &&
124 ipv6_addr_equal(&orig->m_addr, &new->m_addr);
126 static void ip_map_init(struct cache_head *cnew, struct cache_head *citem)
128 struct ip_map *new = container_of(cnew, struct ip_map, h);
129 struct ip_map *item = container_of(citem, struct ip_map, h);
131 strcpy(new->m_class, item->m_class);
132 new->m_addr = item->m_addr;
134 static void update(struct cache_head *cnew, struct cache_head *citem)
136 struct ip_map *new = container_of(cnew, struct ip_map, h);
137 struct ip_map *item = container_of(citem, struct ip_map, h);
139 kref_get(&item->m_client->h.ref);
140 new->m_client = item->m_client;
142 static struct cache_head *ip_map_alloc(void)
144 struct ip_map *i = kmalloc(sizeof(*i), GFP_KERNEL);
151 static int ip_map_upcall(struct cache_detail *cd, struct cache_head *h)
153 return sunrpc_cache_pipe_upcall(cd, h);
156 static void ip_map_request(struct cache_detail *cd,
157 struct cache_head *h,
158 char **bpp, int *blen)
161 struct ip_map *im = container_of(h, struct ip_map, h);
163 if (ipv6_addr_v4mapped(&(im->m_addr))) {
164 snprintf(text_addr, 20, "%pI4", &im->m_addr.s6_addr32[3]);
166 snprintf(text_addr, 40, "%pI6", &im->m_addr);
168 qword_add(bpp, blen, im->m_class);
169 qword_add(bpp, blen, text_addr);
173 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
174 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time64_t expiry);
176 static int ip_map_parse(struct cache_detail *cd,
177 char *mesg, int mlen)
179 /* class ipaddress [domainname] */
180 /* should be safe just to use the start of the input buffer
187 struct sockaddr_in s4;
188 struct sockaddr_in6 s6;
190 struct sockaddr_in6 sin6;
194 struct auth_domain *dom;
197 if (mesg[mlen-1] != '\n')
202 len = qword_get(&mesg, class, sizeof(class));
203 if (len <= 0) return -EINVAL;
206 len = qword_get(&mesg, buf, mlen);
207 if (len <= 0) return -EINVAL;
209 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
211 switch (address.sa.sa_family) {
213 /* Form a mapped IPv4 address in sin6 */
214 sin6.sin6_family = AF_INET6;
215 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
218 #if IS_ENABLED(CONFIG_IPV6)
220 memcpy(&sin6, &address.s6, sizeof(sin6));
227 expiry = get_expiry(&mesg);
231 /* domainname, or empty for NEGATIVE */
232 len = qword_get(&mesg, buf, mlen);
233 if (len < 0) return -EINVAL;
236 dom = unix_domain_find(buf);
242 /* IPv6 scope IDs are ignored for now */
243 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
245 err = __ip_map_update(cd, ipmp,
246 container_of(dom, struct unix_domain, h),
252 auth_domain_put(dom);
258 static int ip_map_show(struct seq_file *m,
259 struct cache_detail *cd,
260 struct cache_head *h)
263 struct in6_addr addr;
264 char *dom = "-no-domain-";
267 seq_puts(m, "#class IP domain\n");
270 im = container_of(h, struct ip_map, h);
271 /* class addr domain */
274 if (test_bit(CACHE_VALID, &h->flags) &&
275 !test_bit(CACHE_NEGATIVE, &h->flags))
276 dom = im->m_client->h.name;
278 if (ipv6_addr_v4mapped(&addr)) {
279 seq_printf(m, "%s %pI4 %s\n",
280 im->m_class, &addr.s6_addr32[3], dom);
282 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
288 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
289 struct in6_addr *addr)
292 struct cache_head *ch;
294 strcpy(ip.m_class, class);
296 ch = sunrpc_cache_lookup_rcu(cd, &ip.h,
297 hash_str(class, IP_HASHBITS) ^
301 return container_of(ch, struct ip_map, h);
306 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
307 struct unix_domain *udom, time64_t expiry)
310 struct cache_head *ch;
315 set_bit(CACHE_NEGATIVE, &ip.h.flags);
316 ip.h.expiry_time = expiry;
317 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
318 hash_str(ipm->m_class, IP_HASHBITS) ^
319 hash_ip6(&ipm->m_addr));
326 void svcauth_unix_purge(struct net *net)
328 struct sunrpc_net *sn;
330 sn = net_generic(net, sunrpc_net_id);
331 cache_purge(sn->ip_map_cache);
333 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
335 static inline struct ip_map *
336 ip_map_cached_get(struct svc_xprt *xprt)
338 struct ip_map *ipm = NULL;
339 struct sunrpc_net *sn;
341 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
342 spin_lock(&xprt->xpt_lock);
343 ipm = xprt->xpt_auth_cache;
345 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
346 if (cache_is_expired(sn->ip_map_cache, &ipm->h)) {
348 * The entry has been invalidated since it was
349 * remembered, e.g. by a second mount from the
352 xprt->xpt_auth_cache = NULL;
353 spin_unlock(&xprt->xpt_lock);
354 cache_put(&ipm->h, sn->ip_map_cache);
359 spin_unlock(&xprt->xpt_lock);
365 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
367 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
368 spin_lock(&xprt->xpt_lock);
369 if (xprt->xpt_auth_cache == NULL) {
370 /* newly cached, keep the reference */
371 xprt->xpt_auth_cache = ipm;
374 spin_unlock(&xprt->xpt_lock);
377 struct sunrpc_net *sn;
379 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
380 cache_put(&ipm->h, sn->ip_map_cache);
385 svcauth_unix_info_release(struct svc_xprt *xpt)
389 ipm = xpt->xpt_auth_cache;
391 struct sunrpc_net *sn;
393 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
394 cache_put(&ipm->h, sn->ip_map_cache);
398 /****************************************************************************
399 * auth.unix.gid cache
400 * simple cache to map a UID to a list of GIDs
401 * because AUTH_UNIX aka AUTH_SYS has a max of UNX_NGROUPS
403 #define GID_HASHBITS 8
404 #define GID_HASHMAX (1<<GID_HASHBITS)
409 struct group_info *gi;
413 static int unix_gid_hash(kuid_t uid)
415 return hash_long(from_kuid(&init_user_ns, uid), GID_HASHBITS);
418 static void unix_gid_free(struct rcu_head *rcu)
420 struct unix_gid *ug = container_of(rcu, struct unix_gid, rcu);
421 struct cache_head *item = &ug->h;
423 if (test_bit(CACHE_VALID, &item->flags) &&
424 !test_bit(CACHE_NEGATIVE, &item->flags))
425 put_group_info(ug->gi);
429 static void unix_gid_put(struct kref *kref)
431 struct cache_head *item = container_of(kref, struct cache_head, ref);
432 struct unix_gid *ug = container_of(item, struct unix_gid, h);
434 call_rcu(&ug->rcu, unix_gid_free);
437 static int unix_gid_match(struct cache_head *corig, struct cache_head *cnew)
439 struct unix_gid *orig = container_of(corig, struct unix_gid, h);
440 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
441 return uid_eq(orig->uid, new->uid);
443 static void unix_gid_init(struct cache_head *cnew, struct cache_head *citem)
445 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
446 struct unix_gid *item = container_of(citem, struct unix_gid, h);
447 new->uid = item->uid;
449 static void unix_gid_update(struct cache_head *cnew, struct cache_head *citem)
451 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
452 struct unix_gid *item = container_of(citem, struct unix_gid, h);
454 get_group_info(item->gi);
457 static struct cache_head *unix_gid_alloc(void)
459 struct unix_gid *g = kmalloc(sizeof(*g), GFP_KERNEL);
466 static int unix_gid_upcall(struct cache_detail *cd, struct cache_head *h)
468 return sunrpc_cache_pipe_upcall_timeout(cd, h);
471 static void unix_gid_request(struct cache_detail *cd,
472 struct cache_head *h,
473 char **bpp, int *blen)
476 struct unix_gid *ug = container_of(h, struct unix_gid, h);
478 snprintf(tuid, 20, "%u", from_kuid(&init_user_ns, ug->uid));
479 qword_add(bpp, blen, tuid);
483 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid);
485 static int unix_gid_parse(struct cache_detail *cd,
486 char *mesg, int mlen)
488 /* uid expiry Ngid gid0 gid1 ... gidN-1 */
496 struct unix_gid ug, *ugp;
498 if (mesg[mlen - 1] != '\n')
502 rv = get_int(&mesg, &id);
505 uid = make_kuid(current_user_ns(), id);
508 expiry = get_expiry(&mesg);
512 rv = get_int(&mesg, &gids);
513 if (rv || gids < 0 || gids > 8192)
516 ug.gi = groups_alloc(gids);
520 for (i = 0 ; i < gids ; i++) {
523 rv = get_int(&mesg, &gid);
527 kgid = make_kgid(current_user_ns(), gid);
528 if (!gid_valid(kgid))
530 ug.gi->gid[i] = kgid;
534 ugp = unix_gid_lookup(cd, uid);
536 struct cache_head *ch;
538 ug.h.expiry_time = expiry;
539 ch = sunrpc_cache_update(cd,
552 put_group_info(ug.gi);
556 static int unix_gid_show(struct seq_file *m,
557 struct cache_detail *cd,
558 struct cache_head *h)
560 struct user_namespace *user_ns = m->file->f_cred->user_ns;
566 seq_puts(m, "#uid cnt: gids...\n");
569 ug = container_of(h, struct unix_gid, h);
570 if (test_bit(CACHE_VALID, &h->flags) &&
571 !test_bit(CACHE_NEGATIVE, &h->flags))
572 glen = ug->gi->ngroups;
576 seq_printf(m, "%u %d:", from_kuid_munged(user_ns, ug->uid), glen);
577 for (i = 0; i < glen; i++)
578 seq_printf(m, " %d", from_kgid_munged(user_ns, ug->gi->gid[i]));
583 static const struct cache_detail unix_gid_cache_template = {
584 .owner = THIS_MODULE,
585 .hash_size = GID_HASHMAX,
586 .name = "auth.unix.gid",
587 .cache_put = unix_gid_put,
588 .cache_upcall = unix_gid_upcall,
589 .cache_request = unix_gid_request,
590 .cache_parse = unix_gid_parse,
591 .cache_show = unix_gid_show,
592 .match = unix_gid_match,
593 .init = unix_gid_init,
594 .update = unix_gid_update,
595 .alloc = unix_gid_alloc,
598 int unix_gid_cache_create(struct net *net)
600 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
601 struct cache_detail *cd;
604 cd = cache_create_net(&unix_gid_cache_template, net);
607 err = cache_register_net(cd, net);
609 cache_destroy_net(cd, net);
612 sn->unix_gid_cache = cd;
616 void unix_gid_cache_destroy(struct net *net)
618 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
619 struct cache_detail *cd = sn->unix_gid_cache;
621 sn->unix_gid_cache = NULL;
623 cache_unregister_net(cd, net);
624 cache_destroy_net(cd, net);
627 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid)
630 struct cache_head *ch;
633 ch = sunrpc_cache_lookup_rcu(cd, &ug.h, unix_gid_hash(uid));
635 return container_of(ch, struct unix_gid, h);
640 static struct group_info *unix_gid_find(kuid_t uid, struct svc_rqst *rqstp)
643 struct group_info *gi;
645 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
648 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
650 return ERR_PTR(-EAGAIN);
651 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
654 return ERR_PTR(-ENOENT);
656 return ERR_PTR(-ESHUTDOWN);
658 gi = get_group_info(ug->gi);
659 cache_put(&ug->h, sn->unix_gid_cache);
662 return ERR_PTR(-EAGAIN);
667 svcauth_unix_set_client(struct svc_rqst *rqstp)
669 struct sockaddr_in *sin;
670 struct sockaddr_in6 *sin6, sin6_storage;
672 struct group_info *gi;
673 struct svc_cred *cred = &rqstp->rq_cred;
674 struct svc_xprt *xprt = rqstp->rq_xprt;
675 struct net *net = xprt->xpt_net;
676 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
678 switch (rqstp->rq_addr.ss_family) {
680 sin = svc_addr_in(rqstp);
681 sin6 = &sin6_storage;
682 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
685 sin6 = svc_addr_in6(rqstp);
691 rqstp->rq_client = NULL;
692 if (rqstp->rq_proc == 0)
695 rqstp->rq_auth_stat = rpc_autherr_badcred;
696 ipm = ip_map_cached_get(xprt);
698 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
704 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
714 rqstp->rq_client = &ipm->m_client->h;
715 kref_get(&rqstp->rq_client->ref);
716 ip_map_cached_put(xprt, ipm);
720 gi = unix_gid_find(cred->cr_uid, rqstp);
721 switch (PTR_ERR(gi)) {
729 put_group_info(cred->cr_group_info);
730 cred->cr_group_info = gi;
734 rqstp->rq_auth_stat = rpc_auth_ok;
738 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
741 svcauth_null_accept(struct svc_rqst *rqstp)
743 struct kvec *argv = &rqstp->rq_arg.head[0];
744 struct kvec *resv = &rqstp->rq_res.head[0];
745 struct svc_cred *cred = &rqstp->rq_cred;
747 if (argv->iov_len < 3*4)
750 if (svc_getu32(argv) != 0) {
751 dprintk("svc: bad null cred\n");
752 rqstp->rq_auth_stat = rpc_autherr_badcred;
755 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
756 dprintk("svc: bad null verf\n");
757 rqstp->rq_auth_stat = rpc_autherr_badverf;
761 /* Signal that mapping to nobody uid/gid is required */
762 cred->cr_uid = INVALID_UID;
763 cred->cr_gid = INVALID_GID;
764 cred->cr_group_info = groups_alloc(0);
765 if (cred->cr_group_info == NULL)
766 return SVC_CLOSE; /* kmalloc failure - client must retry */
768 /* Put NULL verifier */
769 svc_putnl(resv, RPC_AUTH_NULL);
772 rqstp->rq_cred.cr_flavor = RPC_AUTH_NULL;
777 svcauth_null_release(struct svc_rqst *rqstp)
779 if (rqstp->rq_client)
780 auth_domain_put(rqstp->rq_client);
781 rqstp->rq_client = NULL;
782 if (rqstp->rq_cred.cr_group_info)
783 put_group_info(rqstp->rq_cred.cr_group_info);
784 rqstp->rq_cred.cr_group_info = NULL;
786 return 0; /* don't drop */
790 struct auth_ops svcauth_null = {
792 .owner = THIS_MODULE,
793 .flavour = RPC_AUTH_NULL,
794 .accept = svcauth_null_accept,
795 .release = svcauth_null_release,
796 .set_client = svcauth_unix_set_client,
801 svcauth_unix_accept(struct svc_rqst *rqstp)
803 struct kvec *argv = &rqstp->rq_arg.head[0];
804 struct kvec *resv = &rqstp->rq_res.head[0];
805 struct svc_cred *cred = &rqstp->rq_cred;
806 struct user_namespace *userns;
808 int len = argv->iov_len;
810 if ((len -= 3*4) < 0)
813 svc_getu32(argv); /* length */
814 svc_getu32(argv); /* time stamp */
815 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
816 if (slen > 64 || (len -= (slen + 3)*4) < 0)
818 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
819 argv->iov_len -= slen*4;
821 * Note: we skip uid_valid()/gid_valid() checks here for
822 * backwards compatibility with clients that use -1 id's.
823 * Instead, -1 uid or gid is later mapped to the
824 * (export-specific) anonymous id by nfsd_setuser.
825 * Supplementary gid's will be left alone.
827 userns = (rqstp->rq_xprt && rqstp->rq_xprt->xpt_cred) ?
828 rqstp->rq_xprt->xpt_cred->user_ns : &init_user_ns;
829 cred->cr_uid = make_kuid(userns, svc_getnl(argv)); /* uid */
830 cred->cr_gid = make_kgid(userns, svc_getnl(argv)); /* gid */
831 slen = svc_getnl(argv); /* gids length */
832 if (slen > UNX_NGROUPS || (len -= (slen + 2)*4) < 0)
834 cred->cr_group_info = groups_alloc(slen);
835 if (cred->cr_group_info == NULL)
837 for (i = 0; i < slen; i++) {
838 kgid_t kgid = make_kgid(userns, svc_getnl(argv));
839 cred->cr_group_info->gid[i] = kgid;
841 groups_sort(cred->cr_group_info);
842 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
843 rqstp->rq_auth_stat = rpc_autherr_badverf;
847 /* Put NULL verifier */
848 svc_putnl(resv, RPC_AUTH_NULL);
851 rqstp->rq_cred.cr_flavor = RPC_AUTH_UNIX;
855 rqstp->rq_auth_stat = rpc_autherr_badcred;
860 svcauth_unix_release(struct svc_rqst *rqstp)
862 /* Verifier (such as it is) is already in place.
864 if (rqstp->rq_client)
865 auth_domain_put(rqstp->rq_client);
866 rqstp->rq_client = NULL;
867 if (rqstp->rq_cred.cr_group_info)
868 put_group_info(rqstp->rq_cred.cr_group_info);
869 rqstp->rq_cred.cr_group_info = NULL;
875 struct auth_ops svcauth_unix = {
877 .owner = THIS_MODULE,
878 .flavour = RPC_AUTH_UNIX,
879 .accept = svcauth_unix_accept,
880 .release = svcauth_unix_release,
881 .domain_release = svcauth_unix_domain_release,
882 .set_client = svcauth_unix_set_client,
885 static const struct cache_detail ip_map_cache_template = {
886 .owner = THIS_MODULE,
887 .hash_size = IP_HASHMAX,
888 .name = "auth.unix.ip",
889 .cache_put = ip_map_put,
890 .cache_upcall = ip_map_upcall,
891 .cache_request = ip_map_request,
892 .cache_parse = ip_map_parse,
893 .cache_show = ip_map_show,
894 .match = ip_map_match,
897 .alloc = ip_map_alloc,
900 int ip_map_cache_create(struct net *net)
902 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
903 struct cache_detail *cd;
906 cd = cache_create_net(&ip_map_cache_template, net);
909 err = cache_register_net(cd, net);
911 cache_destroy_net(cd, net);
914 sn->ip_map_cache = cd;
918 void ip_map_cache_destroy(struct net *net)
920 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
921 struct cache_detail *cd = sn->ip_map_cache;
923 sn->ip_map_cache = NULL;
925 cache_unregister_net(cd, net);
926 cache_destroy_net(cd, net);