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 #define RPCDBG_FACILITY RPCDBG_AUTH
19 #include <linux/sunrpc/clnt.h>
24 * AUTHUNIX and AUTHNULL credentials are both handled here.
25 * AUTHNULL is treated just like AUTHUNIX except that the uid/gid
26 * are always nobody (-2). i.e. we do the same IP address checks for
27 * AUTHNULL as for AUTHUNIX, and that is done here.
33 /* other stuff later */
36 extern struct auth_ops svcauth_null;
37 extern struct auth_ops svcauth_unix;
39 static void svcauth_unix_domain_release(struct auth_domain *dom)
41 struct unix_domain *ud = container_of(dom, struct unix_domain, h);
47 struct auth_domain *unix_domain_find(char *name)
49 struct auth_domain *rv;
50 struct unix_domain *new = NULL;
52 rv = auth_domain_lookup(name, NULL);
55 if (new && rv != &new->h)
56 svcauth_unix_domain_release(&new->h);
58 if (rv->flavour != &svcauth_unix) {
65 new = kmalloc(sizeof(*new), GFP_KERNEL);
68 kref_init(&new->h.ref);
69 new->h.name = kstrdup(name, GFP_KERNEL);
70 if (new->h.name == NULL) {
74 new->h.flavour = &svcauth_unix;
75 rv = auth_domain_lookup(name, &new->h);
78 EXPORT_SYMBOL_GPL(unix_domain_find);
81 /**************************************************
82 * cache for IP address to unix_domain
83 * as needed by AUTH_UNIX
86 #define IP_HASHMAX (1<<IP_HASHBITS)
90 char m_class[8]; /* e.g. "nfsd" */
91 struct in6_addr m_addr;
92 struct unix_domain *m_client;
95 static void ip_map_put(struct kref *kref)
97 struct cache_head *item = container_of(kref, struct cache_head, ref);
98 struct ip_map *im = container_of(item, struct ip_map,h);
100 if (test_bit(CACHE_VALID, &item->flags) &&
101 !test_bit(CACHE_NEGATIVE, &item->flags))
102 auth_domain_put(&im->m_client->h);
107 /* hash_long on a 64 bit machine is currently REALLY BAD for
108 * IP addresses in reverse-endian (i.e. on a little-endian machine).
109 * So use a trivial but reliable hash instead
111 static inline int hash_ip(__be32 ip)
113 int hash = (__force u32)ip ^ ((__force u32)ip>>16);
114 return (hash ^ (hash>>8)) & 0xff;
117 static inline int hash_ip6(struct in6_addr ip)
119 return (hash_ip(ip.s6_addr32[0]) ^
120 hash_ip(ip.s6_addr32[1]) ^
121 hash_ip(ip.s6_addr32[2]) ^
122 hash_ip(ip.s6_addr32[3]));
124 static int ip_map_match(struct cache_head *corig, struct cache_head *cnew)
126 struct ip_map *orig = container_of(corig, struct ip_map, h);
127 struct ip_map *new = container_of(cnew, struct ip_map, h);
128 return strcmp(orig->m_class, new->m_class) == 0 &&
129 ipv6_addr_equal(&orig->m_addr, &new->m_addr);
131 static void ip_map_init(struct cache_head *cnew, struct cache_head *citem)
133 struct ip_map *new = container_of(cnew, struct ip_map, h);
134 struct ip_map *item = container_of(citem, struct ip_map, h);
136 strcpy(new->m_class, item->m_class);
137 new->m_addr = item->m_addr;
139 static void update(struct cache_head *cnew, struct cache_head *citem)
141 struct ip_map *new = container_of(cnew, struct ip_map, h);
142 struct ip_map *item = container_of(citem, struct ip_map, h);
144 kref_get(&item->m_client->h.ref);
145 new->m_client = item->m_client;
147 static struct cache_head *ip_map_alloc(void)
149 struct ip_map *i = kmalloc(sizeof(*i), GFP_KERNEL);
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 int ip_map_upcall(struct cache_detail *cd, struct cache_head *h)
175 return sunrpc_cache_pipe_upcall(cd, h, ip_map_request);
178 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class, struct in6_addr *addr);
179 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm, struct unix_domain *udom, time_t expiry);
181 static int ip_map_parse(struct cache_detail *cd,
182 char *mesg, int mlen)
184 /* class ipaddress [domainname] */
185 /* should be safe just to use the start of the input buffer
192 struct sockaddr_in s4;
193 struct sockaddr_in6 s6;
195 struct sockaddr_in6 sin6;
199 struct auth_domain *dom;
202 if (mesg[mlen-1] != '\n')
207 len = qword_get(&mesg, class, sizeof(class));
208 if (len <= 0) return -EINVAL;
211 len = qword_get(&mesg, buf, mlen);
212 if (len <= 0) return -EINVAL;
214 if (rpc_pton(cd->net, buf, len, &address.sa, sizeof(address)) == 0)
216 switch (address.sa.sa_family) {
218 /* Form a mapped IPv4 address in sin6 */
219 sin6.sin6_family = AF_INET6;
220 ipv6_addr_set_v4mapped(address.s4.sin_addr.s_addr,
223 #if IS_ENABLED(CONFIG_IPV6)
225 memcpy(&sin6, &address.s6, sizeof(sin6));
232 expiry = get_expiry(&mesg);
236 /* domainname, or empty for NEGATIVE */
237 len = qword_get(&mesg, buf, mlen);
238 if (len < 0) return -EINVAL;
241 dom = unix_domain_find(buf);
247 /* IPv6 scope IDs are ignored for now */
248 ipmp = __ip_map_lookup(cd, class, &sin6.sin6_addr);
250 err = __ip_map_update(cd, ipmp,
251 container_of(dom, struct unix_domain, h),
257 auth_domain_put(dom);
263 static int ip_map_show(struct seq_file *m,
264 struct cache_detail *cd,
265 struct cache_head *h)
268 struct in6_addr addr;
269 char *dom = "-no-domain-";
272 seq_puts(m, "#class IP domain\n");
275 im = container_of(h, struct ip_map, h);
276 /* class addr domain */
279 if (test_bit(CACHE_VALID, &h->flags) &&
280 !test_bit(CACHE_NEGATIVE, &h->flags))
281 dom = im->m_client->h.name;
283 if (ipv6_addr_v4mapped(&addr)) {
284 seq_printf(m, "%s %pI4 %s\n",
285 im->m_class, &addr.s6_addr32[3], dom);
287 seq_printf(m, "%s %pI6 %s\n", im->m_class, &addr, dom);
293 static struct ip_map *__ip_map_lookup(struct cache_detail *cd, char *class,
294 struct in6_addr *addr)
297 struct cache_head *ch;
299 strcpy(ip.m_class, class);
301 ch = sunrpc_cache_lookup(cd, &ip.h,
302 hash_str(class, IP_HASHBITS) ^
306 return container_of(ch, struct ip_map, h);
311 static inline struct ip_map *ip_map_lookup(struct net *net, char *class,
312 struct in6_addr *addr)
314 struct sunrpc_net *sn;
316 sn = net_generic(net, sunrpc_net_id);
317 return __ip_map_lookup(sn->ip_map_cache, class, addr);
320 static int __ip_map_update(struct cache_detail *cd, struct ip_map *ipm,
321 struct unix_domain *udom, time_t expiry)
324 struct cache_head *ch;
329 set_bit(CACHE_NEGATIVE, &ip.h.flags);
330 ip.h.expiry_time = expiry;
331 ch = sunrpc_cache_update(cd, &ip.h, &ipm->h,
332 hash_str(ipm->m_class, IP_HASHBITS) ^
333 hash_ip6(ipm->m_addr));
340 static inline int ip_map_update(struct net *net, struct ip_map *ipm,
341 struct unix_domain *udom, time_t expiry)
343 struct sunrpc_net *sn;
345 sn = net_generic(net, sunrpc_net_id);
346 return __ip_map_update(sn->ip_map_cache, ipm, udom, expiry);
350 void svcauth_unix_purge(void)
355 struct sunrpc_net *sn;
357 sn = net_generic(net, sunrpc_net_id);
358 cache_purge(sn->ip_map_cache);
361 EXPORT_SYMBOL_GPL(svcauth_unix_purge);
363 static inline struct ip_map *
364 ip_map_cached_get(struct svc_xprt *xprt)
366 struct ip_map *ipm = NULL;
367 struct sunrpc_net *sn;
369 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
370 spin_lock(&xprt->xpt_lock);
371 ipm = xprt->xpt_auth_cache;
373 if (!cache_valid(&ipm->h)) {
375 * The entry has been invalidated since it was
376 * remembered, e.g. by a second mount from the
379 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
380 xprt->xpt_auth_cache = NULL;
381 spin_unlock(&xprt->xpt_lock);
382 cache_put(&ipm->h, sn->ip_map_cache);
387 spin_unlock(&xprt->xpt_lock);
393 ip_map_cached_put(struct svc_xprt *xprt, struct ip_map *ipm)
395 if (test_bit(XPT_CACHE_AUTH, &xprt->xpt_flags)) {
396 spin_lock(&xprt->xpt_lock);
397 if (xprt->xpt_auth_cache == NULL) {
398 /* newly cached, keep the reference */
399 xprt->xpt_auth_cache = ipm;
402 spin_unlock(&xprt->xpt_lock);
405 struct sunrpc_net *sn;
407 sn = net_generic(xprt->xpt_net, sunrpc_net_id);
408 cache_put(&ipm->h, sn->ip_map_cache);
413 svcauth_unix_info_release(struct svc_xprt *xpt)
417 ipm = xpt->xpt_auth_cache;
419 struct sunrpc_net *sn;
421 sn = net_generic(xpt->xpt_net, sunrpc_net_id);
422 cache_put(&ipm->h, sn->ip_map_cache);
426 /****************************************************************************
427 * auth.unix.gid cache
428 * simple cache to map a UID to a list of GIDs
429 * because AUTH_UNIX aka AUTH_SYS has a max of 16
431 #define GID_HASHBITS 8
432 #define GID_HASHMAX (1<<GID_HASHBITS)
437 struct group_info *gi;
440 static void unix_gid_put(struct kref *kref)
442 struct cache_head *item = container_of(kref, struct cache_head, ref);
443 struct unix_gid *ug = container_of(item, struct unix_gid, h);
444 if (test_bit(CACHE_VALID, &item->flags) &&
445 !test_bit(CACHE_NEGATIVE, &item->flags))
446 put_group_info(ug->gi);
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 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", ug->uid);
487 qword_add(bpp, blen, tuid);
491 static int unix_gid_upcall(struct cache_detail *cd, struct cache_head *h)
493 return sunrpc_cache_pipe_upcall(cd, h, unix_gid_request);
496 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, uid_t uid);
498 static int unix_gid_parse(struct cache_detail *cd,
499 char *mesg, int mlen)
501 /* uid expiry Ngid gid0 gid1 ... gidN-1 */
508 struct unix_gid ug, *ugp;
510 if (mesg[mlen - 1] != '\n')
514 rv = get_int(&mesg, &uid);
519 expiry = get_expiry(&mesg);
523 rv = get_int(&mesg, &gids);
524 if (rv || gids < 0 || gids > 8192)
527 ug.gi = groups_alloc(gids);
531 for (i = 0 ; i < gids ; i++) {
533 rv = get_int(&mesg, &gid);
537 GROUP_AT(ug.gi, i) = gid;
540 ugp = unix_gid_lookup(cd, uid);
542 struct cache_head *ch;
544 ug.h.expiry_time = expiry;
545 ch = sunrpc_cache_update(cd,
547 hash_long(uid, GID_HASHBITS));
558 put_group_info(ug.gi);
562 static int unix_gid_show(struct seq_file *m,
563 struct cache_detail *cd,
564 struct cache_head *h)
571 seq_puts(m, "#uid cnt: gids...\n");
574 ug = container_of(h, struct unix_gid, h);
575 if (test_bit(CACHE_VALID, &h->flags) &&
576 !test_bit(CACHE_NEGATIVE, &h->flags))
577 glen = ug->gi->ngroups;
581 seq_printf(m, "%u %d:", ug->uid, glen);
582 for (i = 0; i < glen; i++)
583 seq_printf(m, " %d", GROUP_AT(ug->gi, i));
588 static struct cache_detail unix_gid_cache_template = {
589 .owner = THIS_MODULE,
590 .hash_size = GID_HASHMAX,
591 .name = "auth.unix.gid",
592 .cache_put = unix_gid_put,
593 .cache_upcall = unix_gid_upcall,
594 .cache_parse = unix_gid_parse,
595 .cache_show = unix_gid_show,
596 .match = unix_gid_match,
597 .init = unix_gid_init,
598 .update = unix_gid_update,
599 .alloc = unix_gid_alloc,
602 int unix_gid_cache_create(struct net *net)
604 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
605 struct cache_detail *cd;
608 cd = cache_create_net(&unix_gid_cache_template, net);
611 err = cache_register_net(cd, net);
613 cache_destroy_net(cd, net);
616 sn->unix_gid_cache = cd;
620 void unix_gid_cache_destroy(struct net *net)
622 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
623 struct cache_detail *cd = sn->unix_gid_cache;
625 sn->unix_gid_cache = NULL;
627 cache_unregister_net(cd, net);
628 cache_destroy_net(cd, net);
631 static struct unix_gid *unix_gid_lookup(struct cache_detail *cd, uid_t uid)
634 struct cache_head *ch;
637 ch = sunrpc_cache_lookup(cd, &ug.h, hash_long(uid, GID_HASHBITS));
639 return container_of(ch, struct unix_gid, h);
644 static struct group_info *unix_gid_find(uid_t uid, struct svc_rqst *rqstp)
647 struct group_info *gi;
649 struct sunrpc_net *sn = net_generic(rqstp->rq_xprt->xpt_net,
652 ug = unix_gid_lookup(sn->unix_gid_cache, uid);
654 return ERR_PTR(-EAGAIN);
655 ret = cache_check(sn->unix_gid_cache, &ug->h, &rqstp->rq_chandle);
658 return ERR_PTR(-ENOENT);
660 return ERR_PTR(-ESHUTDOWN);
662 gi = get_group_info(ug->gi);
663 cache_put(&ug->h, sn->unix_gid_cache);
666 return ERR_PTR(-EAGAIN);
671 svcauth_unix_set_client(struct svc_rqst *rqstp)
673 struct sockaddr_in *sin;
674 struct sockaddr_in6 *sin6, sin6_storage;
676 struct group_info *gi;
677 struct svc_cred *cred = &rqstp->rq_cred;
678 struct svc_xprt *xprt = rqstp->rq_xprt;
679 struct net *net = xprt->xpt_net;
680 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
682 switch (rqstp->rq_addr.ss_family) {
684 sin = svc_addr_in(rqstp);
685 sin6 = &sin6_storage;
686 ipv6_addr_set_v4mapped(sin->sin_addr.s_addr, &sin6->sin6_addr);
689 sin6 = svc_addr_in6(rqstp);
695 rqstp->rq_client = NULL;
696 if (rqstp->rq_proc == 0)
699 ipm = ip_map_cached_get(xprt);
701 ipm = __ip_map_lookup(sn->ip_map_cache, rqstp->rq_server->sv_program->pg_class,
707 switch (cache_check(sn->ip_map_cache, &ipm->h, &rqstp->rq_chandle)) {
717 rqstp->rq_client = &ipm->m_client->h;
718 kref_get(&rqstp->rq_client->ref);
719 ip_map_cached_put(xprt, ipm);
723 gi = unix_gid_find(cred->cr_uid, rqstp);
724 switch (PTR_ERR(gi)) {
732 put_group_info(cred->cr_group_info);
733 cred->cr_group_info = gi;
738 EXPORT_SYMBOL_GPL(svcauth_unix_set_client);
741 svcauth_null_accept(struct svc_rqst *rqstp, __be32 *authp)
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 cred->cr_group_info = NULL;
748 rqstp->rq_client = NULL;
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 = (uid_t) -1;
766 cred->cr_gid = (gid_t) -1;
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_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;
810 int len = argv->iov_len;
812 cred->cr_group_info = NULL;
813 rqstp->rq_client = NULL;
815 if ((len -= 3*4) < 0)
818 svc_getu32(argv); /* length */
819 svc_getu32(argv); /* time stamp */
820 slen = XDR_QUADLEN(svc_getnl(argv)); /* machname length */
821 if (slen > 64 || (len -= (slen + 3)*4) < 0)
823 argv->iov_base = (void*)((__be32*)argv->iov_base + slen); /* skip machname */
824 argv->iov_len -= slen*4;
826 cred->cr_uid = svc_getnl(argv); /* uid */
827 cred->cr_gid = svc_getnl(argv); /* gid */
828 slen = svc_getnl(argv); /* gids length */
829 if (slen > 16 || (len -= (slen + 2)*4) < 0)
831 cred->cr_group_info = groups_alloc(slen);
832 if (cred->cr_group_info == NULL)
834 for (i = 0; i < slen; i++)
835 GROUP_AT(cred->cr_group_info, i) = svc_getnl(argv);
836 if (svc_getu32(argv) != htonl(RPC_AUTH_NULL) || svc_getu32(argv) != 0) {
837 *authp = rpc_autherr_badverf;
841 /* Put NULL verifier */
842 svc_putnl(resv, RPC_AUTH_NULL);
845 rqstp->rq_flavor = RPC_AUTH_UNIX;
849 *authp = rpc_autherr_badcred;
854 svcauth_unix_release(struct svc_rqst *rqstp)
856 /* Verifier (such as it is) is already in place.
858 if (rqstp->rq_client)
859 auth_domain_put(rqstp->rq_client);
860 rqstp->rq_client = NULL;
861 if (rqstp->rq_cred.cr_group_info)
862 put_group_info(rqstp->rq_cred.cr_group_info);
863 rqstp->rq_cred.cr_group_info = NULL;
869 struct auth_ops svcauth_unix = {
871 .owner = THIS_MODULE,
872 .flavour = RPC_AUTH_UNIX,
873 .accept = svcauth_unix_accept,
874 .release = svcauth_unix_release,
875 .domain_release = svcauth_unix_domain_release,
876 .set_client = svcauth_unix_set_client,
879 static struct cache_detail ip_map_cache_template = {
880 .owner = THIS_MODULE,
881 .hash_size = IP_HASHMAX,
882 .name = "auth.unix.ip",
883 .cache_put = ip_map_put,
884 .cache_upcall = ip_map_upcall,
885 .cache_parse = ip_map_parse,
886 .cache_show = ip_map_show,
887 .match = ip_map_match,
890 .alloc = ip_map_alloc,
893 int ip_map_cache_create(struct net *net)
895 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
896 struct cache_detail *cd;
899 cd = cache_create_net(&ip_map_cache_template, net);
902 err = cache_register_net(cd, net);
904 cache_destroy_net(cd, net);
907 sn->ip_map_cache = cd;
911 void ip_map_cache_destroy(struct net *net)
913 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
914 struct cache_detail *cd = sn->ip_map_cache;
916 sn->ip_map_cache = NULL;
918 cache_unregister_net(cd, net);
919 cache_destroy_net(cd, net);