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);
108 /* hash_long on a 64 bit machine is currently REALLY BAD for
109 * IP addresses in reverse-endian (i.e. on a little-endian machine).
110 * So use a trivial but reliable hash instead
112 static inline int hash_ip(__be32 ip)
114 int hash = (__force u32)ip ^ ((__force u32)ip>>16);
115 return (hash ^ (hash>>8)) & 0xff;
118 static inline int hash_ip6(struct in6_addr ip)
120 return (hash_ip(ip.s6_addr32[0]) ^
121 hash_ip(ip.s6_addr32[1]) ^
122 hash_ip(ip.s6_addr32[2]) ^
123 hash_ip(ip.s6_addr32[3]));
125 static int ip_map_match(struct cache_head *corig, struct cache_head *cnew)
127 struct ip_map *orig = container_of(corig, struct ip_map, h);
128 struct ip_map *new = container_of(cnew, struct ip_map, h);
129 return strcmp(orig->m_class, new->m_class) == 0 &&
130 ipv6_addr_equal(&orig->m_addr, &new->m_addr);
132 static void ip_map_init(struct cache_head *cnew, struct cache_head *citem)
134 struct ip_map *new = container_of(cnew, struct ip_map, h);
135 struct ip_map *item = container_of(citem, struct ip_map, h);
137 strcpy(new->m_class, item->m_class);
138 new->m_addr = item->m_addr;
140 static void update(struct cache_head *cnew, struct cache_head *citem)
142 struct ip_map *new = container_of(cnew, struct ip_map, h);
143 struct ip_map *item = container_of(citem, struct ip_map, h);
145 kref_get(&item->m_client->h.ref);
146 new->m_client = item->m_client;
148 static struct cache_head *ip_map_alloc(void)
150 struct ip_map *i = kmalloc(sizeof(*i), GFP_KERNEL);
157 static void ip_map_request(struct cache_detail *cd,
158 struct cache_head *h,
159 char **bpp, int *blen)
162 struct ip_map *im = container_of(h, struct ip_map, h);
164 if (ipv6_addr_v4mapped(&(im->m_addr))) {
165 snprintf(text_addr, 20, "%pI4", &im->m_addr.s6_addr32[3]);
167 snprintf(text_addr, 40, "%pI6", &im->m_addr);
169 qword_add(bpp, blen, im->m_class);
170 qword_add(bpp, blen, text_addr);
174 static int ip_map_upcall(struct cache_detail *cd, struct cache_head *h)
176 return sunrpc_cache_pipe_upcall(cd, h, ip_map_request);
179 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
180 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time_t expiry);
182 static int ip_map_parse(struct cache_detail *cd,
183 char *mesg, int mlen)
185 /* class ipaddress [domainname] */
186 /* should be safe just to use the start of the input buffer
193 struct sockaddr_in s4;
194 struct sockaddr_in6 s6;
196 struct sockaddr_in6 sin6;
200 struct auth_domain *dom;
203 if (mesg[mlen-1] != '\n')
208 len = qword_get(&mesg, class, sizeof(class));
209 if (len <= 0) return -EINVAL;
212 len = qword_get(&mesg, buf, mlen);
213 if (len <= 0) return -EINVAL;
215 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
217 switch (address.sa.sa_family) {
219 /* Form a mapped IPv4 address in sin6 */
220 sin6.sin6_family = AF_INET6;
221 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
224 #if IS_ENABLED(CONFIG_IPV6)
226 memcpy(&sin6, &address.s6, sizeof(sin6));
233 expiry = get_expiry(&mesg);
237 /* domainname, or empty for NEGATIVE */
238 len = qword_get(&mesg, buf, mlen);
239 if (len < 0) return -EINVAL;
242 dom = unix_domain_find(buf);
248 /* IPv6 scope IDs are ignored for now */
249 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
251 err = __ip_map_update(cd, ipmp,
252 container_of(dom, struct unix_domain, h),
258 auth_domain_put(dom);
264 static int ip_map_show(struct seq_file *m,
265 struct cache_detail *cd,
266 struct cache_head *h)
269 struct in6_addr addr;
270 char *dom = "-no-domain-";
273 seq_puts(m, "#class IP domain\n");
276 im = container_of(h, struct ip_map, h);
277 /* class addr domain */
280 if (test_bit(CACHE_VALID, &h->flags) &&
281 !test_bit(CACHE_NEGATIVE, &h->flags))
282 dom = im->m_client->h.name;
284 if (ipv6_addr_v4mapped(&addr)) {
285 seq_printf(m, "%s %pI4 %s\n",
286 im->m_class, &addr.s6_addr32[3], dom);
288 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
294 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
295 struct in6_addr *addr)
298 struct cache_head *ch;
300 strcpy(ip.m_class, class);
302 ch = sunrpc_cache_lookup(cd, &ip.h,
303 hash_str(class, IP_HASHBITS) ^
307 return container_of(ch, struct ip_map, h);
312 static inline struct ip_map *ip_map_lookup(struct net *net, char *class,
313 struct in6_addr *addr)
315 struct sunrpc_net *sn;
317 sn = net_generic(net, sunrpc_net_id);
318 return __ip_map_lookup(sn->ip_map_cache, class, addr);
321 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
322 struct unix_domain *udom, time_t expiry)
325 struct cache_head *ch;
330 set_bit(CACHE_NEGATIVE, &ip.h.flags);
331 ip.h.expiry_time = expiry;
332 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
333 hash_str(ipm->m_class, IP_HASHBITS) ^
334 hash_ip6(ipm->m_addr));
341 static inline int ip_map_update(struct net *net, struct ip_map *ipm,
342 struct unix_domain *udom, time_t expiry)
344 struct sunrpc_net *sn;
346 sn = net_generic(net, sunrpc_net_id);
347 return __ip_map_update(sn->ip_map_cache, ipm, udom, expiry);
351 void svcauth_unix_purge(void)
356 struct sunrpc_net *sn;
358 sn = net_generic(net, sunrpc_net_id);
359 cache_purge(sn->ip_map_cache);
362 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
364 static inline struct ip_map *
365 ip_map_cached_get(struct svc_xprt *xprt)
367 struct ip_map *ipm = NULL;
368 struct sunrpc_net *sn;
370 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
371 spin_lock(&xprt->xpt_lock);
372 ipm = xprt->xpt_auth_cache;
374 if (!cache_valid(&ipm->h)) {
376 * The entry has been invalidated since it was
377 * remembered, e.g. by a second mount from the
380 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
381 xprt->xpt_auth_cache = NULL;
382 spin_unlock(&xprt->xpt_lock);
383 cache_put(&ipm->h, sn->ip_map_cache);
388 spin_unlock(&xprt->xpt_lock);
394 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
396 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
397 spin_lock(&xprt->xpt_lock);
398 if (xprt->xpt_auth_cache == NULL) {
399 /* newly cached, keep the reference */
400 xprt->xpt_auth_cache = ipm;
403 spin_unlock(&xprt->xpt_lock);
406 struct sunrpc_net *sn;
408 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
409 cache_put(&ipm->h, sn->ip_map_cache);
414 svcauth_unix_info_release(struct svc_xprt *xpt)
418 ipm = xpt->xpt_auth_cache;
420 struct sunrpc_net *sn;
422 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
423 cache_put(&ipm->h, sn->ip_map_cache);
427 /****************************************************************************
428 * auth.unix.gid cache
429 * simple cache to map a UID to a list of GIDs
430 * because AUTH_UNIX aka AUTH_SYS has a max of 16
432 #define GID_HASHBITS 8
433 #define GID_HASHMAX (1<<GID_HASHBITS)
438 struct group_info *gi;
441 static void unix_gid_put(struct kref *kref)
443 struct cache_head *item = container_of(kref, struct cache_head, ref);
444 struct unix_gid *ug = container_of(item, struct unix_gid, h);
445 if (test_bit(CACHE_VALID, &item->flags) &&
446 !test_bit(CACHE_NEGATIVE, &item->flags))
447 put_group_info(ug->gi);
451 static int unix_gid_match(struct cache_head *corig, struct cache_head *cnew)
453 struct unix_gid *orig = container_of(corig, struct unix_gid, h);
454 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
455 return orig->uid == new->uid;
457 static void unix_gid_init(struct cache_head *cnew, struct cache_head *citem)
459 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
460 struct unix_gid *item = container_of(citem, struct unix_gid, h);
461 new->uid = item->uid;
463 static void unix_gid_update(struct cache_head *cnew, struct cache_head *citem)
465 struct unix_gid *new = container_of(cnew, struct unix_gid, h);
466 struct unix_gid *item = container_of(citem, struct unix_gid, h);
468 get_group_info(item->gi);
471 static struct cache_head *unix_gid_alloc(void)
473 struct unix_gid *g = kmalloc(sizeof(*g), GFP_KERNEL);
480 static void unix_gid_request(struct cache_detail *cd,
481 struct cache_head *h,
482 char **bpp, int *blen)
485 struct unix_gid *ug = container_of(h, struct unix_gid, h);
487 snprintf(tuid, 20, "%u", ug->uid);
488 qword_add(bpp, blen, tuid);
492 static int unix_gid_upcall(struct cache_detail *cd, struct cache_head *h)
494 return sunrpc_cache_pipe_upcall(cd, h, unix_gid_request);
497 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, uid_t uid);
499 static int unix_gid_parse(struct cache_detail *cd,
500 char *mesg, int mlen)
502 /* uid expiry Ngid gid0 gid1 ... gidN-1 */
509 struct unix_gid ug, *ugp;
511 if (mesg[mlen - 1] != '\n')
515 rv = get_int(&mesg, &uid);
520 expiry = get_expiry(&mesg);
524 rv = get_int(&mesg, &gids);
525 if (rv || gids < 0 || gids > 8192)
528 ug.gi = groups_alloc(gids);
532 for (i = 0 ; i < gids ; i++) {
535 rv = get_int(&mesg, &gid);
539 kgid = make_kgid(&init_user_ns, gid);
540 if (!gid_valid(kgid))
542 GROUP_AT(ug.gi, i) = kgid;
545 ugp = unix_gid_lookup(cd, uid);
547 struct cache_head *ch;
549 ug.h.expiry_time = expiry;
550 ch = sunrpc_cache_update(cd,
552 hash_long(uid, GID_HASHBITS));
563 put_group_info(ug.gi);
567 static int unix_gid_show(struct seq_file *m,
568 struct cache_detail *cd,
569 struct cache_head *h)
571 struct user_namespace *user_ns = current_user_ns();
577 seq_puts(m, "#uid cnt: gids...\n");
580 ug = container_of(h, struct unix_gid, h);
581 if (test_bit(CACHE_VALID, &h->flags) &&
582 !test_bit(CACHE_NEGATIVE, &h->flags))
583 glen = ug->gi->ngroups;
587 seq_printf(m, "%u %d:", ug->uid, glen);
588 for (i = 0; i < glen; i++)
589 seq_printf(m, " %d", from_kgid_munged(user_ns, GROUP_AT(ug->gi, i)));
594 static struct cache_detail unix_gid_cache_template = {
595 .owner = THIS_MODULE,
596 .hash_size = GID_HASHMAX,
597 .name = "auth.unix.gid",
598 .cache_put = unix_gid_put,
599 .cache_upcall = unix_gid_upcall,
600 .cache_parse = unix_gid_parse,
601 .cache_show = unix_gid_show,
602 .match = unix_gid_match,
603 .init = unix_gid_init,
604 .update = unix_gid_update,
605 .alloc = unix_gid_alloc,
608 int unix_gid_cache_create(struct net *net)
610 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
611 struct cache_detail *cd;
614 cd = cache_create_net(&unix_gid_cache_template, net);
617 err = cache_register_net(cd, net);
619 cache_destroy_net(cd, net);
622 sn->unix_gid_cache = cd;
626 void unix_gid_cache_destroy(struct net *net)
628 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
629 struct cache_detail *cd = sn->unix_gid_cache;
631 sn->unix_gid_cache = NULL;
633 cache_unregister_net(cd, net);
634 cache_destroy_net(cd, net);
637 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, uid_t uid)
640 struct cache_head *ch;
643 ch = sunrpc_cache_lookup(cd, &ug.h, hash_long(uid, GID_HASHBITS));
645 return container_of(ch, struct unix_gid, h);
650 static struct group_info *unix_gid_find(uid_t uid, struct svc_rqst *rqstp)
653 struct group_info *gi;
655 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
658 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
660 return ERR_PTR(-EAGAIN);
661 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
664 return ERR_PTR(-ENOENT);
666 return ERR_PTR(-ESHUTDOWN);
668 gi = get_group_info(ug->gi);
669 cache_put(&ug->h, sn->unix_gid_cache);
672 return ERR_PTR(-EAGAIN);
677 svcauth_unix_set_client(struct svc_rqst *rqstp)
679 struct sockaddr_in *sin;
680 struct sockaddr_in6 *sin6, sin6_storage;
682 struct group_info *gi;
683 struct svc_cred *cred = &rqstp->rq_cred;
684 struct svc_xprt *xprt = rqstp->rq_xprt;
685 struct net *net = xprt->xpt_net;
686 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
688 switch (rqstp->rq_addr.ss_family) {
690 sin = svc_addr_in(rqstp);
691 sin6 = &sin6_storage;
692 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
695 sin6 = svc_addr_in6(rqstp);
701 rqstp->rq_client = NULL;
702 if (rqstp->rq_proc == 0)
705 ipm = ip_map_cached_get(xprt);
707 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
713 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
723 rqstp->rq_client = &ipm->m_client->h;
724 kref_get(&rqstp->rq_client->ref);
725 ip_map_cached_put(xprt, ipm);
729 gi = unix_gid_find(cred->cr_uid, rqstp);
730 switch (PTR_ERR(gi)) {
738 put_group_info(cred->cr_group_info);
739 cred->cr_group_info = gi;
744 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
747 svcauth_null_accept(struct svc_rqst *rqstp, __be32 *authp)
749 struct kvec *argv = &rqstp->rq_arg.head[0];
750 struct kvec *resv = &rqstp->rq_res.head[0];
751 struct svc_cred *cred = &rqstp->rq_cred;
753 cred->cr_group_info = NULL;
754 rqstp->rq_client = NULL;
756 if (argv->iov_len < 3*4)
759 if (svc_getu32(argv) != 0) {
760 dprintk("svc: bad null cred\n");
761 *authp = rpc_autherr_badcred;
764 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
765 dprintk("svc: bad null verf\n");
766 *authp = rpc_autherr_badverf;
770 /* Signal that mapping to nobody uid/gid is required */
771 cred->cr_uid = (uid_t) -1;
772 cred->cr_gid = (gid_t) -1;
773 cred->cr_group_info = groups_alloc(0);
774 if (cred->cr_group_info == NULL)
775 return SVC_CLOSE; /* kmalloc failure - client must retry */
777 /* Put NULL verifier */
778 svc_putnl(resv, RPC_AUTH_NULL);
781 rqstp->rq_flavor = RPC_AUTH_NULL;
786 svcauth_null_release(struct svc_rqst *rqstp)
788 if (rqstp->rq_client)
789 auth_domain_put(rqstp->rq_client);
790 rqstp->rq_client = NULL;
791 if (rqstp->rq_cred.cr_group_info)
792 put_group_info(rqstp->rq_cred.cr_group_info);
793 rqstp->rq_cred.cr_group_info = NULL;
795 return 0; /* don't drop */
799 struct auth_ops svcauth_null = {
801 .owner = THIS_MODULE,
802 .flavour = RPC_AUTH_NULL,
803 .accept = svcauth_null_accept,
804 .release = svcauth_null_release,
805 .set_client = svcauth_unix_set_client,
810 svcauth_unix_accept(struct svc_rqst *rqstp, __be32 *authp)
812 struct kvec *argv = &rqstp->rq_arg.head[0];
813 struct kvec *resv = &rqstp->rq_res.head[0];
814 struct svc_cred *cred = &rqstp->rq_cred;
816 int len = argv->iov_len;
818 cred->cr_group_info = NULL;
819 rqstp->rq_client = NULL;
821 if ((len -= 3*4) < 0)
824 svc_getu32(argv); /* length */
825 svc_getu32(argv); /* time stamp */
826 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
827 if (slen > 64 || (len -= (slen + 3)*4) < 0)
829 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
830 argv->iov_len -= slen*4;
832 cred->cr_uid = svc_getnl(argv); /* uid */
833 cred->cr_gid = svc_getnl(argv); /* gid */
834 slen = svc_getnl(argv); /* gids length */
835 if (slen > 16 || (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(&init_user_ns, svc_getnl(argv));
842 if (!gid_valid(kgid))
844 GROUP_AT(cred->cr_group_info, i) = kgid;
846 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
847 *authp = rpc_autherr_badverf;
851 /* Put NULL verifier */
852 svc_putnl(resv, RPC_AUTH_NULL);
855 rqstp->rq_flavor = RPC_AUTH_UNIX;
859 *authp = rpc_autherr_badcred;
864 svcauth_unix_release(struct svc_rqst *rqstp)
866 /* Verifier (such as it is) is already in place.
868 if (rqstp->rq_client)
869 auth_domain_put(rqstp->rq_client);
870 rqstp->rq_client = NULL;
871 if (rqstp->rq_cred.cr_group_info)
872 put_group_info(rqstp->rq_cred.cr_group_info);
873 rqstp->rq_cred.cr_group_info = NULL;
879 struct auth_ops svcauth_unix = {
881 .owner = THIS_MODULE,
882 .flavour = RPC_AUTH_UNIX,
883 .accept = svcauth_unix_accept,
884 .release = svcauth_unix_release,
885 .domain_release = svcauth_unix_domain_release,
886 .set_client = svcauth_unix_set_client,
889 static struct cache_detail ip_map_cache_template = {
890 .owner = THIS_MODULE,
891 .hash_size = IP_HASHMAX,
892 .name = "auth.unix.ip",
893 .cache_put = ip_map_put,
894 .cache_upcall = ip_map_upcall,
895 .cache_parse = ip_map_parse,
896 .cache_show = ip_map_show,
897 .match = ip_map_match,
900 .alloc = ip_map_alloc,
903 int ip_map_cache_create(struct net *net)
905 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
906 struct cache_detail *cd;
909 cd = cache_create_net(&ip_map_cache_template, net);
912 err = cache_register_net(cd, net);
914 cache_destroy_net(cd, net);
917 sn->ip_map_cache = cd;
921 void ip_map_cache_destroy(struct net *net)
923 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
924 struct cache_detail *cd = sn->ip_map_cache;
926 sn->ip_map_cache = NULL;
928 cache_unregister_net(cd, net);
929 cache_destroy_net(cd, net);