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 void ip_map_request(struct cache_detail *cd,
152 struct cache_head *h,
153 char **bpp, int *blen)
156 struct ip_map *im = container_of(h, struct ip_map, h);
158 if (ipv6_addr_v4mapped(&(im->m_addr))) {
159 snprintf(text_addr, 20, "%pI4", &im->m_addr.s6_addr32[3]);
161 snprintf(text_addr, 40, "%pI6", &im->m_addr);
163 qword_add(bpp, blen, im->m_class);
164 qword_add(bpp, blen, text_addr);
168 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
169 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time_t expiry);
171 static int ip_map_parse(struct cache_detail *cd,
172 char *mesg, int mlen)
174 /* class ipaddress [domainname] */
175 /* should be safe just to use the start of the input buffer
182 struct sockaddr_in s4;
183 struct sockaddr_in6 s6;
185 struct sockaddr_in6 sin6;
189 struct auth_domain *dom;
192 if (mesg[mlen-1] != '\n')
197 len = qword_get(&mesg, class, sizeof(class));
198 if (len <= 0) return -EINVAL;
201 len = qword_get(&mesg, buf, mlen);
202 if (len <= 0) return -EINVAL;
204 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
206 switch (address.sa.sa_family) {
208 /* Form a mapped IPv4 address in sin6 */
209 sin6.sin6_family = AF_INET6;
210 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
213 #if IS_ENABLED(CONFIG_IPV6)
215 memcpy(&sin6, &address.s6, sizeof(sin6));
222 expiry = get_expiry(&mesg);
226 /* domainname, or empty for NEGATIVE */
227 len = qword_get(&mesg, buf, mlen);
228 if (len < 0) return -EINVAL;
231 dom = unix_domain_find(buf);
237 /* IPv6 scope IDs are ignored for now */
238 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
240 err = __ip_map_update(cd, ipmp,
241 container_of(dom, struct unix_domain, h),
247 auth_domain_put(dom);
253 static int ip_map_show(struct seq_file *m,
254 struct cache_detail *cd,
255 struct cache_head *h)
258 struct in6_addr addr;
259 char *dom = "-no-domain-";
262 seq_puts(m, "#class IP domain\n");
265 im = container_of(h, struct ip_map, h);
266 /* class addr domain */
269 if (test_bit(CACHE_VALID, &h->flags) &&
270 !test_bit(CACHE_NEGATIVE, &h->flags))
271 dom = im->m_client->h.name;
273 if (ipv6_addr_v4mapped(&addr)) {
274 seq_printf(m, "%s %pI4 %s\n",
275 im->m_class, &addr.s6_addr32[3], dom);
277 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
283 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
284 struct in6_addr *addr)
287 struct cache_head *ch;
289 strcpy(ip.m_class, class);
291 ch = sunrpc_cache_lookup_rcu(cd, &ip.h,
292 hash_str(class, IP_HASHBITS) ^
296 return container_of(ch, struct ip_map, h);
301 static inline struct ip_map *ip_map_lookup(struct net *net, char *class,
302 struct in6_addr *addr)
304 struct sunrpc_net *sn;
306 sn = net_generic(net, sunrpc_net_id);
307 return __ip_map_lookup(sn->ip_map_cache, class, addr);
310 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
311 struct unix_domain *udom, time_t expiry)
314 struct cache_head *ch;
319 set_bit(CACHE_NEGATIVE, &ip.h.flags);
320 ip.h.expiry_time = expiry;
321 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
322 hash_str(ipm->m_class, IP_HASHBITS) ^
323 hash_ip6(&ipm->m_addr));
330 static inline int ip_map_update(struct net *net, struct ip_map *ipm,
331 struct unix_domain *udom, time_t expiry)
333 struct sunrpc_net *sn;
335 sn = net_generic(net, sunrpc_net_id);
336 return __ip_map_update(sn->ip_map_cache, ipm, udom, expiry);
339 void svcauth_unix_purge(struct net *net)
341 struct sunrpc_net *sn;
343 sn = net_generic(net, sunrpc_net_id);
344 cache_purge(sn->ip_map_cache);
346 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
348 static inline struct ip_map *
349 ip_map_cached_get(struct svc_xprt *xprt)
351 struct ip_map *ipm = NULL;
352 struct sunrpc_net *sn;
354 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
355 spin_lock(&xprt->xpt_lock);
356 ipm = xprt->xpt_auth_cache;
358 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
359 if (cache_is_expired(sn->ip_map_cache, &ipm->h)) {
361 * The entry has been invalidated since it was
362 * remembered, e.g. by a second mount from the
365 xprt->xpt_auth_cache = NULL;
366 spin_unlock(&xprt->xpt_lock);
367 cache_put(&ipm->h, sn->ip_map_cache);
372 spin_unlock(&xprt->xpt_lock);
378 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
380 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
381 spin_lock(&xprt->xpt_lock);
382 if (xprt->xpt_auth_cache == NULL) {
383 /* newly cached, keep the reference */
384 xprt->xpt_auth_cache = ipm;
387 spin_unlock(&xprt->xpt_lock);
390 struct sunrpc_net *sn;
392 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
393 cache_put(&ipm->h, sn->ip_map_cache);
398 svcauth_unix_info_release(struct svc_xprt *xpt)
402 ipm = xpt->xpt_auth_cache;
404 struct sunrpc_net *sn;
406 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
407 cache_put(&ipm->h, sn->ip_map_cache);
411 /****************************************************************************
412 * auth.unix.gid cache
413 * simple cache to map a UID to a list of GIDs
414 * because AUTH_UNIX aka AUTH_SYS has a max of UNX_NGROUPS
416 #define GID_HASHBITS 8
417 #define GID_HASHMAX (1<<GID_HASHBITS)
422 struct group_info *gi;
426 static int unix_gid_hash(kuid_t uid)
428 return hash_long(from_kuid(&init_user_ns, uid), GID_HASHBITS);
431 static void unix_gid_free(struct rcu_head *rcu)
433 struct unix_gid *ug = container_of(rcu, struct unix_gid, rcu);
434 struct cache_head *item = &ug->h;
436 if (test_bit(CACHE_VALID, &item->flags) &&
437 !test_bit(CACHE_NEGATIVE, &item->flags))
438 put_group_info(ug->gi);
442 static void unix_gid_put(struct kref *kref)
444 struct cache_head *item = container_of(kref, struct cache_head, ref);
445 struct unix_gid *ug = container_of(item, struct unix_gid, h);
447 call_rcu(&ug->rcu, unix_gid_free);
450 static int unix_gid_match(struct cache_head *corig, struct cache_head *cnew)
452 struct unix_gid *orig = container_of(corig, struct unix_gid, h);
453 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
454 return uid_eq(orig->uid, new->uid);
456 static void unix_gid_init(struct cache_head *cnew, struct cache_head *citem)
458 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
459 struct unix_gid *item = container_of(citem, struct unix_gid, h);
460 new->uid = item->uid;
462 static void unix_gid_update(struct cache_head *cnew, struct cache_head *citem)
464 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
465 struct unix_gid *item = container_of(citem, struct unix_gid, h);
467 get_group_info(item->gi);
470 static struct cache_head *unix_gid_alloc(void)
472 struct unix_gid *g = kmalloc(sizeof(*g), GFP_KERNEL);
479 static void unix_gid_request(struct cache_detail *cd,
480 struct cache_head *h,
481 char **bpp, int *blen)
484 struct unix_gid *ug = container_of(h, struct unix_gid, h);
486 snprintf(tuid, 20, "%u", from_kuid(&init_user_ns, ug->uid));
487 qword_add(bpp, blen, tuid);
491 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid);
493 static int unix_gid_parse(struct cache_detail *cd,
494 char *mesg, int mlen)
496 /* uid expiry Ngid gid0 gid1 ... gidN-1 */
504 struct unix_gid ug, *ugp;
506 if (mesg[mlen - 1] != '\n')
510 rv = get_int(&mesg, &id);
513 uid = make_kuid(current_user_ns(), id);
516 expiry = get_expiry(&mesg);
520 rv = get_int(&mesg, &gids);
521 if (rv || gids < 0 || gids > 8192)
524 ug.gi = groups_alloc(gids);
528 for (i = 0 ; i < gids ; i++) {
531 rv = get_int(&mesg, &gid);
535 kgid = make_kgid(current_user_ns(), gid);
536 if (!gid_valid(kgid))
538 ug.gi->gid[i] = kgid;
542 ugp = unix_gid_lookup(cd, uid);
544 struct cache_head *ch;
546 ug.h.expiry_time = expiry;
547 ch = sunrpc_cache_update(cd,
560 put_group_info(ug.gi);
564 static int unix_gid_show(struct seq_file *m,
565 struct cache_detail *cd,
566 struct cache_head *h)
568 struct user_namespace *user_ns = m->file->f_cred->user_ns;
574 seq_puts(m, "#uid cnt: gids...\n");
577 ug = container_of(h, struct unix_gid, h);
578 if (test_bit(CACHE_VALID, &h->flags) &&
579 !test_bit(CACHE_NEGATIVE, &h->flags))
580 glen = ug->gi->ngroups;
584 seq_printf(m, "%u %d:", from_kuid_munged(user_ns, ug->uid), glen);
585 for (i = 0; i < glen; i++)
586 seq_printf(m, " %d", from_kgid_munged(user_ns, ug->gi->gid[i]));
591 static const struct cache_detail unix_gid_cache_template = {
592 .owner = THIS_MODULE,
593 .hash_size = GID_HASHMAX,
594 .name = "auth.unix.gid",
595 .cache_put = unix_gid_put,
596 .cache_request = unix_gid_request,
597 .cache_parse = unix_gid_parse,
598 .cache_show = unix_gid_show,
599 .match = unix_gid_match,
600 .init = unix_gid_init,
601 .update = unix_gid_update,
602 .alloc = unix_gid_alloc,
605 int unix_gid_cache_create(struct net *net)
607 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
608 struct cache_detail *cd;
611 cd = cache_create_net(&unix_gid_cache_template, net);
614 err = cache_register_net(cd, net);
616 cache_destroy_net(cd, net);
619 sn->unix_gid_cache = cd;
623 void unix_gid_cache_destroy(struct net *net)
625 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
626 struct cache_detail *cd = sn->unix_gid_cache;
628 sn->unix_gid_cache = NULL;
630 cache_unregister_net(cd, net);
631 cache_destroy_net(cd, net);
634 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid)
637 struct cache_head *ch;
640 ch = sunrpc_cache_lookup_rcu(cd, &ug.h, unix_gid_hash(uid));
642 return container_of(ch, struct unix_gid, h);
647 static struct group_info *unix_gid_find(kuid_t uid, struct svc_rqst *rqstp)
650 struct group_info *gi;
652 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
655 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
657 return ERR_PTR(-EAGAIN);
658 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
661 return ERR_PTR(-ENOENT);
663 return ERR_PTR(-ESHUTDOWN);
665 gi = get_group_info(ug->gi);
666 cache_put(&ug->h, sn->unix_gid_cache);
669 return ERR_PTR(-EAGAIN);
674 svcauth_unix_set_client(struct svc_rqst *rqstp)
676 struct sockaddr_in *sin;
677 struct sockaddr_in6 *sin6, sin6_storage;
679 struct group_info *gi;
680 struct svc_cred *cred = &rqstp->rq_cred;
681 struct svc_xprt *xprt = rqstp->rq_xprt;
682 struct net *net = xprt->xpt_net;
683 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
685 switch (rqstp->rq_addr.ss_family) {
687 sin = svc_addr_in(rqstp);
688 sin6 = &sin6_storage;
689 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
692 sin6 = svc_addr_in6(rqstp);
698 rqstp->rq_client = NULL;
699 if (rqstp->rq_proc == 0)
702 ipm = ip_map_cached_get(xprt);
704 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
710 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
720 rqstp->rq_client = &ipm->m_client->h;
721 kref_get(&rqstp->rq_client->ref);
722 ip_map_cached_put(xprt, ipm);
726 gi = unix_gid_find(cred->cr_uid, rqstp);
727 switch (PTR_ERR(gi)) {
735 put_group_info(cred->cr_group_info);
736 cred->cr_group_info = gi;
741 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
744 svcauth_null_accept(struct svc_rqst *rqstp, __be32 *authp)
746 struct kvec *argv = &rqstp->rq_arg.head[0];
747 struct kvec *resv = &rqstp->rq_res.head[0];
748 struct svc_cred *cred = &rqstp->rq_cred;
750 if (argv->iov_len < 3*4)
753 if (svc_getu32(argv) != 0) {
754 dprintk("svc: bad null cred\n");
755 *authp = rpc_autherr_badcred;
758 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
759 dprintk("svc: bad null verf\n");
760 *authp = rpc_autherr_badverf;
764 /* Signal that mapping to nobody uid/gid is required */
765 cred->cr_uid = INVALID_UID;
766 cred->cr_gid = INVALID_GID;
767 cred->cr_group_info = groups_alloc(0);
768 if (cred->cr_group_info == NULL)
769 return SVC_CLOSE; /* kmalloc failure - client must retry */
771 /* Put NULL verifier */
772 svc_putnl(resv, RPC_AUTH_NULL);
775 rqstp->rq_cred.cr_flavor = RPC_AUTH_NULL;
780 svcauth_null_release(struct svc_rqst *rqstp)
782 if (rqstp->rq_client)
783 auth_domain_put(rqstp->rq_client);
784 rqstp->rq_client = NULL;
785 if (rqstp->rq_cred.cr_group_info)
786 put_group_info(rqstp->rq_cred.cr_group_info);
787 rqstp->rq_cred.cr_group_info = NULL;
789 return 0; /* don't drop */
793 struct auth_ops svcauth_null = {
795 .owner = THIS_MODULE,
796 .flavour = RPC_AUTH_NULL,
797 .accept = svcauth_null_accept,
798 .release = svcauth_null_release,
799 .set_client = svcauth_unix_set_client,
804 svcauth_unix_accept(struct svc_rqst *rqstp, __be32 *authp)
806 struct kvec *argv = &rqstp->rq_arg.head[0];
807 struct kvec *resv = &rqstp->rq_res.head[0];
808 struct svc_cred *cred = &rqstp->rq_cred;
809 struct user_namespace *userns;
811 int len = argv->iov_len;
813 if ((len -= 3*4) < 0)
816 svc_getu32(argv); /* length */
817 svc_getu32(argv); /* time stamp */
818 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
819 if (slen > 64 || (len -= (slen + 3)*4) < 0)
821 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
822 argv->iov_len -= slen*4;
824 * Note: we skip uid_valid()/gid_valid() checks here for
825 * backwards compatibility with clients that use -1 id's.
826 * Instead, -1 uid or gid is later mapped to the
827 * (export-specific) anonymous id by nfsd_setuser.
828 * Supplementary gid's will be left alone.
830 userns = (rqstp->rq_xprt && rqstp->rq_xprt->xpt_cred) ?
831 rqstp->rq_xprt->xpt_cred->user_ns : &init_user_ns;
832 cred->cr_uid = make_kuid(userns, svc_getnl(argv)); /* uid */
833 cred->cr_gid = make_kgid(userns, svc_getnl(argv)); /* gid */
834 slen = svc_getnl(argv); /* gids length */
835 if (slen > UNX_NGROUPS || (len -= (slen + 2)*4) < 0)
837 cred->cr_group_info = groups_alloc(slen);
838 if (cred->cr_group_info == NULL)
840 for (i = 0; i < slen; i++) {
841 kgid_t kgid = make_kgid(userns, svc_getnl(argv));
842 cred->cr_group_info->gid[i] = kgid;
844 groups_sort(cred->cr_group_info);
845 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
846 *authp = rpc_autherr_badverf;
850 /* Put NULL verifier */
851 svc_putnl(resv, RPC_AUTH_NULL);
854 rqstp->rq_cred.cr_flavor = RPC_AUTH_UNIX;
858 *authp = rpc_autherr_badcred;
863 svcauth_unix_release(struct svc_rqst *rqstp)
865 /* Verifier (such as it is) is already in place.
867 if (rqstp->rq_client)
868 auth_domain_put(rqstp->rq_client);
869 rqstp->rq_client = NULL;
870 if (rqstp->rq_cred.cr_group_info)
871 put_group_info(rqstp->rq_cred.cr_group_info);
872 rqstp->rq_cred.cr_group_info = NULL;
878 struct auth_ops svcauth_unix = {
880 .owner = THIS_MODULE,
881 .flavour = RPC_AUTH_UNIX,
882 .accept = svcauth_unix_accept,
883 .release = svcauth_unix_release,
884 .domain_release = svcauth_unix_domain_release,
885 .set_client = svcauth_unix_set_client,
888 static const struct cache_detail ip_map_cache_template = {
889 .owner = THIS_MODULE,
890 .hash_size = IP_HASHMAX,
891 .name = "auth.unix.ip",
892 .cache_put = ip_map_put,
893 .cache_request = ip_map_request,
894 .cache_parse = ip_map_parse,
895 .cache_show = ip_map_show,
896 .match = ip_map_match,
899 .alloc = ip_map_alloc,
902 int ip_map_cache_create(struct net *net)
904 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
905 struct cache_detail *cd;
908 cd = cache_create_net(&ip_map_cache_template, net);
911 err = cache_register_net(cd, net);
913 cache_destroy_net(cd, net);
916 sn->ip_map_cache = cd;
920 void ip_map_cache_destroy(struct net *net)
922 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
923 struct cache_detail *cd = sn->ip_map_cache;
925 sn->ip_map_cache = NULL;
927 cache_unregister_net(cd, net);
928 cache_destroy_net(cd, net);