1 #include <linux/types.h>
2 #include <linux/sched.h>
3 #include <linux/module.h>
4 #include <linux/sunrpc/types.h>
5 #include <linux/sunrpc/xdr.h>
6 #include <linux/sunrpc/svcsock.h>
7 #include <linux/sunrpc/svcauth.h>
8 #include <linux/sunrpc/gss_api.h>
9 #include <linux/sunrpc/addr.h>
10 #include <linux/err.h>
11 #include <linux/seq_file.h>
12 #include <linux/hash.h>
13 #include <linux/string.h>
14 #include <linux/slab.h>
17 #include <linux/kernel.h>
18 #include <linux/user_namespace.h>
19 #define RPCDBG_FACILITY RPCDBG_AUTH
25 * AUTHUNIX and AUTHNULL credentials are both handled here.
26 * AUTHNULL is treated just like AUTHUNIX except that the uid/gid
27 * are always nobody (-2). i.e. we do the same IP address checks for
28 * AUTHNULL as for AUTHUNIX, and that is done here.
34 /* other stuff later */
37 extern struct auth_ops svcauth_null;
38 extern struct auth_ops svcauth_unix;
40 static void svcauth_unix_domain_release(struct auth_domain *dom)
42 struct unix_domain *ud = container_of(dom, struct unix_domain, h);
48 struct auth_domain *unix_domain_find(char *name)
50 struct auth_domain *rv;
51 struct unix_domain *new = NULL;
53 rv = auth_domain_lookup(name, NULL);
56 if (new && rv != &new->h)
57 svcauth_unix_domain_release(&new->h);
59 if (rv->flavour != &svcauth_unix) {
66 new = kmalloc(sizeof(*new), GFP_KERNEL);
69 kref_init(&new->h.ref);
70 new->h.name = kstrdup(name, GFP_KERNEL);
71 if (new->h.name == NULL) {
75 new->h.flavour = &svcauth_unix;
76 rv = auth_domain_lookup(name, &new->h);
79 EXPORT_SYMBOL_GPL(unix_domain_find);
82 /**************************************************
83 * cache for IP address to unix_domain
84 * as needed by AUTH_UNIX
87 #define IP_HASHMAX (1<<IP_HASHBITS)
91 char m_class[8]; /* e.g. "nfsd" */
92 struct in6_addr m_addr;
93 struct unix_domain *m_client;
96 static void ip_map_put(struct kref *kref)
98 struct cache_head *item = container_of(kref, struct cache_head, ref);
99 struct ip_map *im = container_of(item, struct ip_map,h);
101 if (test_bit(CACHE_VALID, &item->flags) &&
102 !test_bit(CACHE_NEGATIVE, &item->flags))
103 auth_domain_put(&im->m_client->h);
107 static inline int hash_ip6(const struct in6_addr *ip)
109 return hash_32(ipv6_addr_hash(ip), IP_HASHBITS);
111 static int ip_map_match(struct cache_head *corig, struct cache_head *cnew)
113 struct ip_map *orig = container_of(corig, struct ip_map, h);
114 struct ip_map *new = container_of(cnew, struct ip_map, h);
115 return strcmp(orig->m_class, new->m_class) == 0 &&
116 ipv6_addr_equal(&orig->m_addr, &new->m_addr);
118 static void ip_map_init(struct cache_head *cnew, struct cache_head *citem)
120 struct ip_map *new = container_of(cnew, struct ip_map, h);
121 struct ip_map *item = container_of(citem, struct ip_map, h);
123 strcpy(new->m_class, item->m_class);
124 new->m_addr = item->m_addr;
126 static void update(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 kref_get(&item->m_client->h.ref);
132 new->m_client = item->m_client;
134 static struct cache_head *ip_map_alloc(void)
136 struct ip_map *i = kmalloc(sizeof(*i), GFP_KERNEL);
143 static void ip_map_request(struct cache_detail *cd,
144 struct cache_head *h,
145 char **bpp, int *blen)
148 struct ip_map *im = container_of(h, struct ip_map, h);
150 if (ipv6_addr_v4mapped(&(im->m_addr))) {
151 snprintf(text_addr, 20, "%pI4", &im->m_addr.s6_addr32[3]);
153 snprintf(text_addr, 40, "%pI6", &im->m_addr);
155 qword_add(bpp, blen, im->m_class);
156 qword_add(bpp, blen, text_addr);
160 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
161 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time_t expiry);
163 static int ip_map_parse(struct cache_detail *cd,
164 char *mesg, int mlen)
166 /* class ipaddress [domainname] */
167 /* should be safe just to use the start of the input buffer
174 struct sockaddr_in s4;
175 struct sockaddr_in6 s6;
177 struct sockaddr_in6 sin6;
181 struct auth_domain *dom;
184 if (mesg[mlen-1] != '\n')
189 len = qword_get(&mesg, class, sizeof(class));
190 if (len <= 0) return -EINVAL;
193 len = qword_get(&mesg, buf, mlen);
194 if (len <= 0) return -EINVAL;
196 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
198 switch (address.sa.sa_family) {
200 /* Form a mapped IPv4 address in sin6 */
201 sin6.sin6_family = AF_INET6;
202 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
205 #if IS_ENABLED(CONFIG_IPV6)
207 memcpy(&sin6, &address.s6, sizeof(sin6));
214 expiry = get_expiry(&mesg);
218 /* domainname, or empty for NEGATIVE */
219 len = qword_get(&mesg, buf, mlen);
220 if (len < 0) return -EINVAL;
223 dom = unix_domain_find(buf);
229 /* IPv6 scope IDs are ignored for now */
230 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
232 err = __ip_map_update(cd, ipmp,
233 container_of(dom, struct unix_domain, h),
239 auth_domain_put(dom);
245 static int ip_map_show(struct seq_file *m,
246 struct cache_detail *cd,
247 struct cache_head *h)
250 struct in6_addr addr;
251 char *dom = "-no-domain-";
254 seq_puts(m, "#class IP domain\n");
257 im = container_of(h, struct ip_map, h);
258 /* class addr domain */
261 if (test_bit(CACHE_VALID, &h->flags) &&
262 !test_bit(CACHE_NEGATIVE, &h->flags))
263 dom = im->m_client->h.name;
265 if (ipv6_addr_v4mapped(&addr)) {
266 seq_printf(m, "%s %pI4 %s\n",
267 im->m_class, &addr.s6_addr32[3], dom);
269 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
275 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
276 struct in6_addr *addr)
279 struct cache_head *ch;
281 strcpy(ip.m_class, class);
283 ch = sunrpc_cache_lookup(cd, &ip.h,
284 hash_str(class, IP_HASHBITS) ^
288 return container_of(ch, struct ip_map, h);
293 static inline struct ip_map *ip_map_lookup(struct net *net, char *class,
294 struct in6_addr *addr)
296 struct sunrpc_net *sn;
298 sn = net_generic(net, sunrpc_net_id);
299 return __ip_map_lookup(sn->ip_map_cache, class, addr);
302 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
303 struct unix_domain *udom, time_t expiry)
306 struct cache_head *ch;
311 set_bit(CACHE_NEGATIVE, &ip.h.flags);
312 ip.h.expiry_time = expiry;
313 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
314 hash_str(ipm->m_class, IP_HASHBITS) ^
315 hash_ip6(&ipm->m_addr));
322 static inline int ip_map_update(struct net *net, struct ip_map *ipm,
323 struct unix_domain *udom, time_t expiry)
325 struct sunrpc_net *sn;
327 sn = net_generic(net, sunrpc_net_id);
328 return __ip_map_update(sn->ip_map_cache, ipm, udom, expiry);
331 void svcauth_unix_purge(struct net *net)
333 struct sunrpc_net *sn;
335 sn = net_generic(net, sunrpc_net_id);
336 cache_purge(sn->ip_map_cache);
338 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
340 static inline struct ip_map *
341 ip_map_cached_get(struct svc_xprt *xprt)
343 struct ip_map *ipm = NULL;
344 struct sunrpc_net *sn;
346 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
347 spin_lock(&xprt->xpt_lock);
348 ipm = xprt->xpt_auth_cache;
350 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
351 if (cache_is_expired(sn->ip_map_cache, &ipm->h)) {
353 * The entry has been invalidated since it was
354 * remembered, e.g. by a second mount from the
357 xprt->xpt_auth_cache = NULL;
358 spin_unlock(&xprt->xpt_lock);
359 cache_put(&ipm->h, sn->ip_map_cache);
364 spin_unlock(&xprt->xpt_lock);
370 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
372 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
373 spin_lock(&xprt->xpt_lock);
374 if (xprt->xpt_auth_cache == NULL) {
375 /* newly cached, keep the reference */
376 xprt->xpt_auth_cache = ipm;
379 spin_unlock(&xprt->xpt_lock);
382 struct sunrpc_net *sn;
384 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
385 cache_put(&ipm->h, sn->ip_map_cache);
390 svcauth_unix_info_release(struct svc_xprt *xpt)
394 ipm = xpt->xpt_auth_cache;
396 struct sunrpc_net *sn;
398 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
399 cache_put(&ipm->h, sn->ip_map_cache);
403 /****************************************************************************
404 * auth.unix.gid cache
405 * simple cache to map a UID to a list of GIDs
406 * because AUTH_UNIX aka AUTH_SYS has a max of 16
408 #define GID_HASHBITS 8
409 #define GID_HASHMAX (1<<GID_HASHBITS)
414 struct group_info *gi;
417 static int unix_gid_hash(kuid_t uid)
419 return hash_long(from_kuid(&init_user_ns, uid), GID_HASHBITS);
422 static void unix_gid_put(struct kref *kref)
424 struct cache_head *item = container_of(kref, struct cache_head, ref);
425 struct unix_gid *ug = container_of(item, struct unix_gid, h);
426 if (test_bit(CACHE_VALID, &item->flags) &&
427 !test_bit(CACHE_NEGATIVE, &item->flags))
428 put_group_info(ug->gi);
432 static int unix_gid_match(struct cache_head *corig, struct cache_head *cnew)
434 struct unix_gid *orig = container_of(corig, struct unix_gid, h);
435 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
436 return uid_eq(orig->uid, new->uid);
438 static void unix_gid_init(struct cache_head *cnew, struct cache_head *citem)
440 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
441 struct unix_gid *item = container_of(citem, struct unix_gid, h);
442 new->uid = item->uid;
444 static void unix_gid_update(struct cache_head *cnew, struct cache_head *citem)
446 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
447 struct unix_gid *item = container_of(citem, struct unix_gid, h);
449 get_group_info(item->gi);
452 static struct cache_head *unix_gid_alloc(void)
454 struct unix_gid *g = kmalloc(sizeof(*g), GFP_KERNEL);
461 static void unix_gid_request(struct cache_detail *cd,
462 struct cache_head *h,
463 char **bpp, int *blen)
466 struct unix_gid *ug = container_of(h, struct unix_gid, h);
468 snprintf(tuid, 20, "%u", from_kuid(&init_user_ns, ug->uid));
469 qword_add(bpp, blen, tuid);
473 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid);
475 static int unix_gid_parse(struct cache_detail *cd,
476 char *mesg, int mlen)
478 /* uid expiry Ngid gid0 gid1 ... gidN-1 */
486 struct unix_gid ug, *ugp;
488 if (mesg[mlen - 1] != '\n')
492 rv = get_int(&mesg, &id);
495 uid = make_kuid(&init_user_ns, id);
498 expiry = get_expiry(&mesg);
502 rv = get_int(&mesg, &gids);
503 if (rv || gids < 0 || gids > 8192)
506 ug.gi = groups_alloc(gids);
510 for (i = 0 ; i < gids ; i++) {
513 rv = get_int(&mesg, &gid);
517 kgid = make_kgid(&init_user_ns, gid);
518 if (!gid_valid(kgid))
520 ug.gi->gid[i] = kgid;
524 ugp = unix_gid_lookup(cd, uid);
526 struct cache_head *ch;
528 ug.h.expiry_time = expiry;
529 ch = sunrpc_cache_update(cd,
542 put_group_info(ug.gi);
546 static int unix_gid_show(struct seq_file *m,
547 struct cache_detail *cd,
548 struct cache_head *h)
550 struct user_namespace *user_ns = &init_user_ns;
556 seq_puts(m, "#uid cnt: gids...\n");
559 ug = container_of(h, struct unix_gid, h);
560 if (test_bit(CACHE_VALID, &h->flags) &&
561 !test_bit(CACHE_NEGATIVE, &h->flags))
562 glen = ug->gi->ngroups;
566 seq_printf(m, "%u %d:", from_kuid_munged(user_ns, ug->uid), glen);
567 for (i = 0; i < glen; i++)
568 seq_printf(m, " %d", from_kgid_munged(user_ns, ug->gi->gid[i]));
573 static struct cache_detail unix_gid_cache_template = {
574 .owner = THIS_MODULE,
575 .hash_size = GID_HASHMAX,
576 .name = "auth.unix.gid",
577 .cache_put = unix_gid_put,
578 .cache_request = unix_gid_request,
579 .cache_parse = unix_gid_parse,
580 .cache_show = unix_gid_show,
581 .match = unix_gid_match,
582 .init = unix_gid_init,
583 .update = unix_gid_update,
584 .alloc = unix_gid_alloc,
587 int unix_gid_cache_create(struct net *net)
589 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
590 struct cache_detail *cd;
593 cd = cache_create_net(&unix_gid_cache_template, net);
596 err = cache_register_net(cd, net);
598 cache_destroy_net(cd, net);
601 sn->unix_gid_cache = cd;
605 void unix_gid_cache_destroy(struct net *net)
607 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
608 struct cache_detail *cd = sn->unix_gid_cache;
610 sn->unix_gid_cache = NULL;
612 cache_unregister_net(cd, net);
613 cache_destroy_net(cd, net);
616 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid)
619 struct cache_head *ch;
622 ch = sunrpc_cache_lookup(cd, &ug.h, unix_gid_hash(uid));
624 return container_of(ch, struct unix_gid, h);
629 static struct group_info *unix_gid_find(kuid_t uid, struct svc_rqst *rqstp)
632 struct group_info *gi;
634 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
637 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
639 return ERR_PTR(-EAGAIN);
640 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
643 return ERR_PTR(-ENOENT);
645 return ERR_PTR(-ESHUTDOWN);
647 gi = get_group_info(ug->gi);
648 cache_put(&ug->h, sn->unix_gid_cache);
651 return ERR_PTR(-EAGAIN);
656 svcauth_unix_set_client(struct svc_rqst *rqstp)
658 struct sockaddr_in *sin;
659 struct sockaddr_in6 *sin6, sin6_storage;
661 struct group_info *gi;
662 struct svc_cred *cred = &rqstp->rq_cred;
663 struct svc_xprt *xprt = rqstp->rq_xprt;
664 struct net *net = xprt->xpt_net;
665 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
667 switch (rqstp->rq_addr.ss_family) {
669 sin = svc_addr_in(rqstp);
670 sin6 = &sin6_storage;
671 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
674 sin6 = svc_addr_in6(rqstp);
680 rqstp->rq_client = NULL;
681 if (rqstp->rq_proc == 0)
684 ipm = ip_map_cached_get(xprt);
686 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
692 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
702 rqstp->rq_client = &ipm->m_client->h;
703 kref_get(&rqstp->rq_client->ref);
704 ip_map_cached_put(xprt, ipm);
708 gi = unix_gid_find(cred->cr_uid, rqstp);
709 switch (PTR_ERR(gi)) {
717 put_group_info(cred->cr_group_info);
718 cred->cr_group_info = gi;
723 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
726 svcauth_null_accept(struct svc_rqst *rqstp, __be32 *authp)
728 struct kvec *argv = &rqstp->rq_arg.head[0];
729 struct kvec *resv = &rqstp->rq_res.head[0];
730 struct svc_cred *cred = &rqstp->rq_cred;
732 if (argv->iov_len < 3*4)
735 if (svc_getu32(argv) != 0) {
736 dprintk("svc: bad null cred\n");
737 *authp = rpc_autherr_badcred;
740 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
741 dprintk("svc: bad null verf\n");
742 *authp = rpc_autherr_badverf;
746 /* Signal that mapping to nobody uid/gid is required */
747 cred->cr_uid = INVALID_UID;
748 cred->cr_gid = INVALID_GID;
749 cred->cr_group_info = groups_alloc(0);
750 if (cred->cr_group_info == NULL)
751 return SVC_CLOSE; /* kmalloc failure - client must retry */
753 /* Put NULL verifier */
754 svc_putnl(resv, RPC_AUTH_NULL);
757 rqstp->rq_cred.cr_flavor = RPC_AUTH_NULL;
762 svcauth_null_release(struct svc_rqst *rqstp)
764 if (rqstp->rq_client)
765 auth_domain_put(rqstp->rq_client);
766 rqstp->rq_client = NULL;
767 if (rqstp->rq_cred.cr_group_info)
768 put_group_info(rqstp->rq_cred.cr_group_info);
769 rqstp->rq_cred.cr_group_info = NULL;
771 return 0; /* don't drop */
775 struct auth_ops svcauth_null = {
777 .owner = THIS_MODULE,
778 .flavour = RPC_AUTH_NULL,
779 .accept = svcauth_null_accept,
780 .release = svcauth_null_release,
781 .set_client = svcauth_unix_set_client,
786 svcauth_unix_accept(struct svc_rqst *rqstp, __be32 *authp)
788 struct kvec *argv = &rqstp->rq_arg.head[0];
789 struct kvec *resv = &rqstp->rq_res.head[0];
790 struct svc_cred *cred = &rqstp->rq_cred;
792 int len = argv->iov_len;
794 if ((len -= 3*4) < 0)
797 svc_getu32(argv); /* length */
798 svc_getu32(argv); /* time stamp */
799 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
800 if (slen > 64 || (len -= (slen + 3)*4) < 0)
802 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
803 argv->iov_len -= slen*4;
805 * Note: we skip uid_valid()/gid_valid() checks here for
806 * backwards compatibility with clients that use -1 id's.
807 * Instead, -1 uid or gid is later mapped to the
808 * (export-specific) anonymous id by nfsd_setuser.
809 * Supplementary gid's will be left alone.
811 cred->cr_uid = make_kuid(&init_user_ns, svc_getnl(argv)); /* uid */
812 cred->cr_gid = make_kgid(&init_user_ns, svc_getnl(argv)); /* gid */
813 slen = svc_getnl(argv); /* gids length */
814 if (slen > 16 || (len -= (slen + 2)*4) < 0)
816 cred->cr_group_info = groups_alloc(slen);
817 if (cred->cr_group_info == NULL)
819 for (i = 0; i < slen; i++) {
820 kgid_t kgid = make_kgid(&init_user_ns, svc_getnl(argv));
821 cred->cr_group_info->gid[i] = kgid;
823 groups_sort(cred->cr_group_info);
824 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
825 *authp = rpc_autherr_badverf;
829 /* Put NULL verifier */
830 svc_putnl(resv, RPC_AUTH_NULL);
833 rqstp->rq_cred.cr_flavor = RPC_AUTH_UNIX;
837 *authp = rpc_autherr_badcred;
842 svcauth_unix_release(struct svc_rqst *rqstp)
844 /* Verifier (such as it is) is already in place.
846 if (rqstp->rq_client)
847 auth_domain_put(rqstp->rq_client);
848 rqstp->rq_client = NULL;
849 if (rqstp->rq_cred.cr_group_info)
850 put_group_info(rqstp->rq_cred.cr_group_info);
851 rqstp->rq_cred.cr_group_info = NULL;
857 struct auth_ops svcauth_unix = {
859 .owner = THIS_MODULE,
860 .flavour = RPC_AUTH_UNIX,
861 .accept = svcauth_unix_accept,
862 .release = svcauth_unix_release,
863 .domain_release = svcauth_unix_domain_release,
864 .set_client = svcauth_unix_set_client,
867 static struct cache_detail ip_map_cache_template = {
868 .owner = THIS_MODULE,
869 .hash_size = IP_HASHMAX,
870 .name = "auth.unix.ip",
871 .cache_put = ip_map_put,
872 .cache_request = ip_map_request,
873 .cache_parse = ip_map_parse,
874 .cache_show = ip_map_show,
875 .match = ip_map_match,
878 .alloc = ip_map_alloc,
881 int ip_map_cache_create(struct net *net)
883 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
884 struct cache_detail *cd;
887 cd = cache_create_net(&ip_map_cache_template, net);
890 err = cache_register_net(cd, net);
892 cache_destroy_net(cd, net);
895 sn->ip_map_cache = cd;
899 void ip_map_cache_destroy(struct net *net)
901 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
902 struct cache_detail *cd = sn->ip_map_cache;
904 sn->ip_map_cache = NULL;
906 cache_unregister_net(cd, net);
907 cache_destroy_net(cd, net);