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>
10 #include <linux/seq_file.h>
11 #include <linux/hash.h>
12 #include <linux/string.h>
13 #include <linux/slab.h>
16 #include <linux/kernel.h>
17 #include <linux/user_namespace.h>
18 #define RPCDBG_FACILITY RPCDBG_AUTH
20 #include <linux/sunrpc/clnt.h>
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 int ip_map_upcall(struct cache_detail *cd, struct cache_head *h)
162 return sunrpc_cache_pipe_upcall(cd, h, ip_map_request);
165 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
166 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time_t expiry);
168 static int ip_map_parse(struct cache_detail *cd,
169 char *mesg, int mlen)
171 /* class ipaddress [domainname] */
172 /* should be safe just to use the start of the input buffer
179 struct sockaddr_in s4;
180 struct sockaddr_in6 s6;
182 struct sockaddr_in6 sin6;
186 struct auth_domain *dom;
189 if (mesg[mlen-1] != '\n')
194 len = qword_get(&mesg, class, sizeof(class));
195 if (len <= 0) return -EINVAL;
198 len = qword_get(&mesg, buf, mlen);
199 if (len <= 0) return -EINVAL;
201 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
203 switch (address.sa.sa_family) {
205 /* Form a mapped IPv4 address in sin6 */
206 sin6.sin6_family = AF_INET6;
207 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
210 #if IS_ENABLED(CONFIG_IPV6)
212 memcpy(&sin6, &address.s6, sizeof(sin6));
219 expiry = get_expiry(&mesg);
223 /* domainname, or empty for NEGATIVE */
224 len = qword_get(&mesg, buf, mlen);
225 if (len < 0) return -EINVAL;
228 dom = unix_domain_find(buf);
234 /* IPv6 scope IDs are ignored for now */
235 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
237 err = __ip_map_update(cd, ipmp,
238 container_of(dom, struct unix_domain, h),
244 auth_domain_put(dom);
250 static int ip_map_show(struct seq_file *m,
251 struct cache_detail *cd,
252 struct cache_head *h)
255 struct in6_addr addr;
256 char *dom = "-no-domain-";
259 seq_puts(m, "#class IP domain\n");
262 im = container_of(h, struct ip_map, h);
263 /* class addr domain */
266 if (test_bit(CACHE_VALID, &h->flags) &&
267 !test_bit(CACHE_NEGATIVE, &h->flags))
268 dom = im->m_client->h.name;
270 if (ipv6_addr_v4mapped(&addr)) {
271 seq_printf(m, "%s %pI4 %s\n",
272 im->m_class, &addr.s6_addr32[3], dom);
274 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
280 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
281 struct in6_addr *addr)
284 struct cache_head *ch;
286 strcpy(ip.m_class, class);
288 ch = sunrpc_cache_lookup(cd, &ip.h,
289 hash_str(class, IP_HASHBITS) ^
293 return container_of(ch, struct ip_map, h);
298 static inline struct ip_map *ip_map_lookup(struct net *net, char *class,
299 struct in6_addr *addr)
301 struct sunrpc_net *sn;
303 sn = net_generic(net, sunrpc_net_id);
304 return __ip_map_lookup(sn->ip_map_cache, class, addr);
307 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
308 struct unix_domain *udom, time_t expiry)
311 struct cache_head *ch;
316 set_bit(CACHE_NEGATIVE, &ip.h.flags);
317 ip.h.expiry_time = expiry;
318 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
319 hash_str(ipm->m_class, IP_HASHBITS) ^
320 hash_ip6(&ipm->m_addr));
327 static inline int ip_map_update(struct net *net, struct ip_map *ipm,
328 struct unix_domain *udom, time_t expiry)
330 struct sunrpc_net *sn;
332 sn = net_generic(net, sunrpc_net_id);
333 return __ip_map_update(sn->ip_map_cache, ipm, udom, expiry);
336 void svcauth_unix_purge(struct net *net)
338 struct sunrpc_net *sn;
340 sn = net_generic(net, sunrpc_net_id);
341 cache_purge(sn->ip_map_cache);
343 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
345 static inline struct ip_map *
346 ip_map_cached_get(struct svc_xprt *xprt)
348 struct ip_map *ipm = NULL;
349 struct sunrpc_net *sn;
351 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
352 spin_lock(&xprt->xpt_lock);
353 ipm = xprt->xpt_auth_cache;
355 if (!cache_valid(&ipm->h)) {
357 * The entry has been invalidated since it was
358 * remembered, e.g. by a second mount from the
361 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
362 xprt->xpt_auth_cache = NULL;
363 spin_unlock(&xprt->xpt_lock);
364 cache_put(&ipm->h, sn->ip_map_cache);
369 spin_unlock(&xprt->xpt_lock);
375 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
377 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
378 spin_lock(&xprt->xpt_lock);
379 if (xprt->xpt_auth_cache == NULL) {
380 /* newly cached, keep the reference */
381 xprt->xpt_auth_cache = ipm;
384 spin_unlock(&xprt->xpt_lock);
387 struct sunrpc_net *sn;
389 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
390 cache_put(&ipm->h, sn->ip_map_cache);
395 svcauth_unix_info_release(struct svc_xprt *xpt)
399 ipm = xpt->xpt_auth_cache;
401 struct sunrpc_net *sn;
403 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
404 cache_put(&ipm->h, sn->ip_map_cache);
408 /****************************************************************************
409 * auth.unix.gid cache
410 * simple cache to map a UID to a list of GIDs
411 * because AUTH_UNIX aka AUTH_SYS has a max of 16
413 #define GID_HASHBITS 8
414 #define GID_HASHMAX (1<<GID_HASHBITS)
419 struct group_info *gi;
422 static int unix_gid_hash(kuid_t uid)
424 return hash_long(from_kuid(&init_user_ns, uid), GID_HASHBITS);
427 static void unix_gid_put(struct kref *kref)
429 struct cache_head *item = container_of(kref, struct cache_head, ref);
430 struct unix_gid *ug = container_of(item, struct unix_gid, h);
431 if (test_bit(CACHE_VALID, &item->flags) &&
432 !test_bit(CACHE_NEGATIVE, &item->flags))
433 put_group_info(ug->gi);
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 void unix_gid_request(struct cache_detail *cd,
467 struct cache_head *h,
468 char **bpp, int *blen)
471 struct unix_gid *ug = container_of(h, struct unix_gid, h);
473 snprintf(tuid, 20, "%u", ug->uid);
474 qword_add(bpp, blen, tuid);
478 static int unix_gid_upcall(struct cache_detail *cd, struct cache_head *h)
480 return sunrpc_cache_pipe_upcall(cd, h, unix_gid_request);
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 */
495 struct unix_gid ug, *ugp;
497 if (mesg[mlen - 1] != '\n')
501 rv = get_int(&mesg, &uid);
506 expiry = get_expiry(&mesg);
510 rv = get_int(&mesg, &gids);
511 if (rv || gids < 0 || gids > 8192)
514 ug.gi = groups_alloc(gids);
518 for (i = 0 ; i < gids ; i++) {
521 rv = get_int(&mesg, &gid);
525 kgid = make_kgid(&init_user_ns, gid);
526 if (!gid_valid(kgid))
528 GROUP_AT(ug.gi, i) = kgid;
531 ugp = unix_gid_lookup(cd, uid);
533 struct cache_head *ch;
535 ug.h.expiry_time = expiry;
536 ch = sunrpc_cache_update(cd,
549 put_group_info(ug.gi);
553 static int unix_gid_show(struct seq_file *m,
554 struct cache_detail *cd,
555 struct cache_head *h)
557 struct user_namespace *user_ns = current_user_ns();
563 seq_puts(m, "#uid cnt: gids...\n");
566 ug = container_of(h, struct unix_gid, h);
567 if (test_bit(CACHE_VALID, &h->flags) &&
568 !test_bit(CACHE_NEGATIVE, &h->flags))
569 glen = ug->gi->ngroups;
573 seq_printf(m, "%u %d:", ug->uid, glen);
574 for (i = 0; i < glen; i++)
575 seq_printf(m, " %d", from_kgid_munged(user_ns, GROUP_AT(ug->gi, i)));
580 static struct cache_detail unix_gid_cache_template = {
581 .owner = THIS_MODULE,
582 .hash_size = GID_HASHMAX,
583 .name = "auth.unix.gid",
584 .cache_put = unix_gid_put,
585 .cache_upcall = unix_gid_upcall,
586 .cache_parse = unix_gid_parse,
587 .cache_show = unix_gid_show,
588 .match = unix_gid_match,
589 .init = unix_gid_init,
590 .update = unix_gid_update,
591 .alloc = unix_gid_alloc,
594 int unix_gid_cache_create(struct net *net)
596 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
597 struct cache_detail *cd;
600 cd = cache_create_net(&unix_gid_cache_template, net);
603 err = cache_register_net(cd, net);
605 cache_destroy_net(cd, net);
608 sn->unix_gid_cache = cd;
612 void unix_gid_cache_destroy(struct net *net)
614 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
615 struct cache_detail *cd = sn->unix_gid_cache;
617 sn->unix_gid_cache = NULL;
619 cache_unregister_net(cd, net);
620 cache_destroy_net(cd, net);
623 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, kuid_t uid)
626 struct cache_head *ch;
629 ch = sunrpc_cache_lookup(cd, &ug.h, unix_gid_hash(uid));
631 return container_of(ch, struct unix_gid, h);
636 static struct group_info *unix_gid_find(kuid_t uid, struct svc_rqst *rqstp)
639 struct group_info *gi;
641 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
644 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
646 return ERR_PTR(-EAGAIN);
647 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
650 return ERR_PTR(-ENOENT);
652 return ERR_PTR(-ESHUTDOWN);
654 gi = get_group_info(ug->gi);
655 cache_put(&ug->h, sn->unix_gid_cache);
658 return ERR_PTR(-EAGAIN);
663 svcauth_unix_set_client(struct svc_rqst *rqstp)
665 struct sockaddr_in *sin;
666 struct sockaddr_in6 *sin6, sin6_storage;
668 struct group_info *gi;
669 struct svc_cred *cred = &rqstp->rq_cred;
670 struct svc_xprt *xprt = rqstp->rq_xprt;
671 struct net *net = xprt->xpt_net;
672 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
674 switch (rqstp->rq_addr.ss_family) {
676 sin = svc_addr_in(rqstp);
677 sin6 = &sin6_storage;
678 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
681 sin6 = svc_addr_in6(rqstp);
687 rqstp->rq_client = NULL;
688 if (rqstp->rq_proc == 0)
691 ipm = ip_map_cached_get(xprt);
693 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
699 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
709 rqstp->rq_client = &ipm->m_client->h;
710 kref_get(&rqstp->rq_client->ref);
711 ip_map_cached_put(xprt, ipm);
715 gi = unix_gid_find(cred->cr_uid, rqstp);
716 switch (PTR_ERR(gi)) {
724 put_group_info(cred->cr_group_info);
725 cred->cr_group_info = gi;
730 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
733 svcauth_null_accept(struct svc_rqst *rqstp, __be32 *authp)
735 struct kvec *argv = &rqstp->rq_arg.head[0];
736 struct kvec *resv = &rqstp->rq_res.head[0];
737 struct svc_cred *cred = &rqstp->rq_cred;
739 cred->cr_group_info = NULL;
740 cred->cr_principal = NULL;
741 rqstp->rq_client = NULL;
743 if (argv->iov_len < 3*4)
746 if (svc_getu32(argv) != 0) {
747 dprintk("svc: bad null cred\n");
748 *authp = rpc_autherr_badcred;
751 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
752 dprintk("svc: bad null verf\n");
753 *authp = rpc_autherr_badverf;
757 /* Signal that mapping to nobody uid/gid is required */
758 cred->cr_uid = INVALID_UID;
759 cred->cr_gid = INVALID_GID;
760 cred->cr_group_info = groups_alloc(0);
761 if (cred->cr_group_info == NULL)
762 return SVC_CLOSE; /* kmalloc failure - client must retry */
764 /* Put NULL verifier */
765 svc_putnl(resv, RPC_AUTH_NULL);
768 rqstp->rq_cred.cr_flavor = RPC_AUTH_NULL;
773 svcauth_null_release(struct svc_rqst *rqstp)
775 if (rqstp->rq_client)
776 auth_domain_put(rqstp->rq_client);
777 rqstp->rq_client = NULL;
778 if (rqstp->rq_cred.cr_group_info)
779 put_group_info(rqstp->rq_cred.cr_group_info);
780 rqstp->rq_cred.cr_group_info = NULL;
782 return 0; /* don't drop */
786 struct auth_ops svcauth_null = {
788 .owner = THIS_MODULE,
789 .flavour = RPC_AUTH_NULL,
790 .accept = svcauth_null_accept,
791 .release = svcauth_null_release,
792 .set_client = svcauth_unix_set_client,
797 svcauth_unix_accept(struct svc_rqst *rqstp, __be32 *authp)
799 struct kvec *argv = &rqstp->rq_arg.head[0];
800 struct kvec *resv = &rqstp->rq_res.head[0];
801 struct svc_cred *cred = &rqstp->rq_cred;
803 int len = argv->iov_len;
805 cred->cr_group_info = NULL;
806 cred->cr_principal = NULL;
807 rqstp->rq_client = NULL;
809 if ((len -= 3*4) < 0)
812 svc_getu32(argv); /* length */
813 svc_getu32(argv); /* time stamp */
814 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
815 if (slen > 64 || (len -= (slen + 3)*4) < 0)
817 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
818 argv->iov_len -= slen*4;
820 cred->cr_uid = svc_getnl(argv); /* uid */
821 cred->cr_gid = svc_getnl(argv); /* gid */
822 slen = svc_getnl(argv); /* gids length */
823 if (slen > 16 || (len -= (slen + 2)*4) < 0)
825 cred->cr_group_info = groups_alloc(slen);
826 if (cred->cr_group_info == NULL)
828 for (i = 0; i < slen; i++) {
829 kgid_t kgid = make_kgid(&init_user_ns, svc_getnl(argv));
830 if (!gid_valid(kgid))
832 GROUP_AT(cred->cr_group_info, i) = kgid;
834 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
835 *authp = rpc_autherr_badverf;
839 /* Put NULL verifier */
840 svc_putnl(resv, RPC_AUTH_NULL);
843 rqstp->rq_cred.cr_flavor = RPC_AUTH_UNIX;
847 *authp = rpc_autherr_badcred;
852 svcauth_unix_release(struct svc_rqst *rqstp)
854 /* Verifier (such as it is) is already in place.
856 if (rqstp->rq_client)
857 auth_domain_put(rqstp->rq_client);
858 rqstp->rq_client = NULL;
859 if (rqstp->rq_cred.cr_group_info)
860 put_group_info(rqstp->rq_cred.cr_group_info);
861 rqstp->rq_cred.cr_group_info = NULL;
867 struct auth_ops svcauth_unix = {
869 .owner = THIS_MODULE,
870 .flavour = RPC_AUTH_UNIX,
871 .accept = svcauth_unix_accept,
872 .release = svcauth_unix_release,
873 .domain_release = svcauth_unix_domain_release,
874 .set_client = svcauth_unix_set_client,
877 static struct cache_detail ip_map_cache_template = {
878 .owner = THIS_MODULE,
879 .hash_size = IP_HASHMAX,
880 .name = "auth.unix.ip",
881 .cache_put = ip_map_put,
882 .cache_upcall = ip_map_upcall,
883 .cache_parse = ip_map_parse,
884 .cache_show = ip_map_show,
885 .match = ip_map_match,
888 .alloc = ip_map_alloc,
891 int ip_map_cache_create(struct net *net)
893 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
894 struct cache_detail *cd;
897 cd = cache_create_net(&ip_map_cache_template, net);
900 err = cache_register_net(cd, net);
902 cache_destroy_net(cd, net);
905 sn->ip_map_cache = cd;
909 void ip_map_cache_destroy(struct net *net)
911 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
912 struct cache_detail *cd = sn->ip_map_cache;
914 sn->ip_map_cache = NULL;
916 cache_unregister_net(cd, net);
917 cache_destroy_net(cd, net);