]> granicus.if.org Git - strace/blob - socketutils.c
xlat: treat socketlayers as a sorted array
[strace] / socketutils.c
1 /*
2  * Copyright (c) 2014 Zubin Mithra <zubin.mithra@gmail.com>
3  * Copyright (c) 2014-2016 Dmitry V. Levin <ldv@altlinux.org>
4  * Copyright (c) 2014-2018 The strace developers.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "defs.h"
31 #include <netinet/in.h>
32 #include <sys/socket.h>
33 #include <arpa/inet.h>
34 #include "netlink.h"
35 #include <linux/sock_diag.h>
36 #include <linux/inet_diag.h>
37 #include <linux/unix_diag.h>
38 #include <linux/netlink_diag.h>
39 #include <linux/rtnetlink.h>
40 #if HAVE_LINUX_GENETLINK_H
41 #include <linux/genetlink.h>
42 #endif
43
44 #include <sys/un.h>
45 #ifndef UNIX_PATH_MAX
46 # define UNIX_PATH_MAX sizeof(((struct sockaddr_un *) 0)->sun_path)
47 #endif
48
49 #include "xstring.h"
50
51 typedef struct {
52         unsigned long inode;
53         char *details;
54 } cache_entry;
55
56 #define CACHE_SIZE 1024U
57 static cache_entry cache[CACHE_SIZE];
58 #define CACHE_MASK (CACHE_SIZE - 1)
59
60 static int
61 cache_inode_details(const unsigned long inode, char *const details)
62 {
63         cache_entry *e = &cache[inode & CACHE_MASK];
64         free(e->details);
65         e->inode = inode;
66         e->details = details;
67
68         return 1;
69 }
70
71 static const char *
72 get_sockaddr_by_inode_cached(const unsigned long inode)
73 {
74         const cache_entry *const e = &cache[inode & CACHE_MASK];
75         return (e && inode == e->inode) ? e->details : NULL;
76 }
77
78 static bool
79 print_sockaddr_by_inode_cached(const unsigned long inode)
80 {
81         const char *const details = get_sockaddr_by_inode_cached(inode);
82         if (details) {
83                 tprints(details);
84                 return true;
85         }
86         return false;
87 }
88
89 static bool
90 send_query(struct tcb *tcp, const int fd, void *req, size_t req_size)
91 {
92         struct sockaddr_nl nladdr = {
93                 .nl_family = AF_NETLINK
94         };
95         struct iovec iov = {
96                 .iov_base = req,
97                 .iov_len = req_size
98         };
99         const struct msghdr msg = {
100                 .msg_name = &nladdr,
101                 .msg_namelen = sizeof(nladdr),
102                 .msg_iov = &iov,
103                 .msg_iovlen = 1
104         };
105
106         for (;;) {
107                 if (sendmsg(fd, &msg, 0) < 0) {
108                         if (errno == EINTR)
109                                 continue;
110                         return false;
111                 }
112                 return true;
113         }
114 }
115
116 static bool
117 inet_send_query(struct tcb *tcp, const int fd, const int family,
118                 const int proto)
119 {
120         struct {
121                 const struct nlmsghdr nlh;
122                 const struct inet_diag_req_v2 idr;
123         } req = {
124                 .nlh = {
125                         .nlmsg_len = sizeof(req),
126                         .nlmsg_type = SOCK_DIAG_BY_FAMILY,
127                         .nlmsg_flags = NLM_F_DUMP | NLM_F_REQUEST
128                 },
129                 .idr = {
130                         .sdiag_family = family,
131                         .sdiag_protocol = proto,
132                         .idiag_states = -1
133                 }
134         };
135         return send_query(tcp, fd, &req, sizeof(req));
136 }
137
138 static int
139 inet_parse_response(const void *const data, const int data_len,
140                     const unsigned long inode, void *opaque_data)
141 {
142         const char *const proto_name = opaque_data;
143         const struct inet_diag_msg *const diag_msg = data;
144         static const char zero_addr[sizeof(struct in6_addr)];
145         socklen_t addr_size, text_size;
146
147         if (data_len < (int) NLMSG_LENGTH(sizeof(*diag_msg)))
148                 return -1;
149         if (diag_msg->idiag_inode != inode)
150                 return 0;
151
152         switch (diag_msg->idiag_family) {
153                 case AF_INET:
154                         addr_size = sizeof(struct in_addr);
155                         text_size = INET_ADDRSTRLEN;
156                         break;
157                 case AF_INET6:
158                         addr_size = sizeof(struct in6_addr);
159                         text_size = INET6_ADDRSTRLEN;
160                         break;
161                 default:
162                         return -1;
163         }
164
165         char src_buf[text_size];
166         char *details;
167
168         /* open/closing brackets for IPv6 addresses */
169         const char *ob = diag_msg->idiag_family == AF_INET6 ? "[" : "";
170         const char *cb = diag_msg->idiag_family == AF_INET6 ? "]" : "";
171
172         if (!inet_ntop(diag_msg->idiag_family, diag_msg->id.idiag_src,
173                        src_buf, text_size))
174                 return -1;
175
176         if (diag_msg->id.idiag_dport ||
177             memcmp(zero_addr, diag_msg->id.idiag_dst, addr_size)) {
178                 char dst_buf[text_size];
179
180                 if (!inet_ntop(diag_msg->idiag_family, diag_msg->id.idiag_dst,
181                                dst_buf, text_size))
182                         return -1;
183
184                 if (asprintf(&details, "%s:[%s%s%s:%u->%s%s%s:%u]", proto_name,
185                              ob, src_buf, cb, ntohs(diag_msg->id.idiag_sport),
186                              ob, dst_buf, cb, ntohs(diag_msg->id.idiag_dport))
187                     < 0)
188                         return false;
189         } else {
190                 if (asprintf(&details, "%s:[%s%s%s:%u]",
191                              proto_name, ob, src_buf, cb,
192                              ntohs(diag_msg->id.idiag_sport)) < 0)
193                         return false;
194         }
195
196         return cache_inode_details(inode, details);
197 }
198
199 static bool
200 receive_responses(struct tcb *tcp, const int fd, const unsigned long inode,
201                   const unsigned long expected_msg_type,
202                   int (*parser)(const void *, int,
203                                 unsigned long, void *),
204                   void *opaque_data)
205 {
206         static union {
207                 struct nlmsghdr hdr;
208                 long buf[8192 / sizeof(long)];
209         } hdr_buf;
210
211         struct sockaddr_nl nladdr = {
212                 .nl_family = AF_NETLINK
213         };
214         struct iovec iov = {
215                 .iov_base = hdr_buf.buf,
216                 .iov_len = sizeof(hdr_buf.buf)
217         };
218         int flags = 0;
219
220         for (;;) {
221                 struct msghdr msg = {
222                         .msg_name = &nladdr,
223                         .msg_namelen = sizeof(nladdr),
224                         .msg_iov = &iov,
225                         .msg_iovlen = 1
226                 };
227
228                 ssize_t ret = recvmsg(fd, &msg, flags);
229                 if (ret < 0) {
230                         if (errno == EINTR)
231                                 continue;
232                         return false;
233                 }
234
235                 const struct nlmsghdr *h = &hdr_buf.hdr;
236                 if (!NLMSG_OK(h, ret))
237                         return false;
238                 for (; NLMSG_OK(h, ret); h = NLMSG_NEXT(h, ret)) {
239                         if (h->nlmsg_type != expected_msg_type)
240                                 return false;
241                         const int rc = parser(NLMSG_DATA(h),
242                                               h->nlmsg_len, inode, opaque_data);
243                         if (rc > 0)
244                                 return true;
245                         if (rc < 0)
246                                 return false;
247                 }
248                 flags = MSG_DONTWAIT;
249         }
250 }
251
252 static bool
253 unix_send_query(struct tcb *tcp, const int fd, const unsigned long inode)
254 {
255         struct {
256                 const struct nlmsghdr nlh;
257                 const struct unix_diag_req udr;
258         } req = {
259                 .nlh = {
260                         .nlmsg_len = sizeof(req),
261                         .nlmsg_type = SOCK_DIAG_BY_FAMILY,
262                         .nlmsg_flags = NLM_F_DUMP | NLM_F_REQUEST
263                 },
264                 .udr = {
265                         .sdiag_family = AF_UNIX,
266                         .udiag_ino = inode,
267                         .udiag_states = -1,
268                         .udiag_show = UDIAG_SHOW_NAME | UDIAG_SHOW_PEER
269                 }
270         };
271         return send_query(tcp, fd, &req, sizeof(req));
272 }
273
274 static int
275 unix_parse_response(const void *data, const int data_len,
276                     const unsigned long inode, void *opaque_data)
277 {
278         const char *proto_name = opaque_data;
279         const struct unix_diag_msg *diag_msg = data;
280         struct rtattr *attr;
281         int rta_len = data_len - NLMSG_LENGTH(sizeof(*diag_msg));
282         uint32_t peer = 0;
283         size_t path_len = 0;
284         char path[UNIX_PATH_MAX + 1];
285
286         if (rta_len < 0)
287                 return -1;
288         if (diag_msg->udiag_ino != inode)
289                 return 0;
290         if (diag_msg->udiag_family != AF_UNIX)
291                 return -1;
292
293         for (attr = (struct rtattr *) (diag_msg + 1);
294              RTA_OK(attr, rta_len);
295              attr = RTA_NEXT(attr, rta_len)) {
296                 switch (attr->rta_type) {
297                 case UNIX_DIAG_NAME:
298                         if (!path_len) {
299                                 path_len = RTA_PAYLOAD(attr);
300                                 if (path_len > UNIX_PATH_MAX)
301                                         path_len = UNIX_PATH_MAX;
302                                 memcpy(path, RTA_DATA(attr), path_len);
303                                 path[path_len] = '\0';
304                         }
305                         break;
306                 case UNIX_DIAG_PEER:
307                         if (RTA_PAYLOAD(attr) >= 4)
308                                 peer = *(uint32_t *) RTA_DATA(attr);
309                         break;
310                 }
311         }
312
313         /*
314          * print obtained information in the following format:
315          * "UNIX:[" SELF_INODE [ "->" PEER_INODE ][ "," SOCKET_FILE ] "]"
316          */
317         if (!peer && !path_len)
318                 return -1;
319
320         char peer_str[3 + sizeof(peer) * 3];
321         if (peer)
322                 xsprintf(peer_str, "->%u", peer);
323         else
324                 peer_str[0] = '\0';
325
326         const char *path_str;
327         if (path_len) {
328                 char *outstr = alloca(4 * path_len + 4);
329
330                 outstr[0] = ',';
331                 if (path[0] == '\0') {
332                         outstr[1] = '@';
333                         string_quote(path + 1, outstr + 2,
334                                      path_len - 1, QUOTE_0_TERMINATED, NULL);
335                 } else {
336                         string_quote(path, outstr + 1,
337                                      path_len, QUOTE_0_TERMINATED, NULL);
338                 }
339                 path_str = outstr;
340         } else {
341                 path_str = "";
342         }
343
344         char *details;
345         if (asprintf(&details, "%s:[%lu%s%s]", proto_name, inode,
346                      peer_str, path_str) < 0)
347                 return -1;
348
349         return cache_inode_details(inode, details);
350 }
351
352 static bool
353 netlink_send_query(struct tcb *tcp, const int fd, const unsigned long inode)
354 {
355         struct {
356                 const struct nlmsghdr nlh;
357                 const struct netlink_diag_req ndr;
358         } req = {
359                 .nlh = {
360                         .nlmsg_len = sizeof(req),
361                         .nlmsg_type = SOCK_DIAG_BY_FAMILY,
362                         .nlmsg_flags = NLM_F_DUMP | NLM_F_REQUEST
363                 },
364                 .ndr = {
365                         .sdiag_family = AF_NETLINK,
366                         .sdiag_protocol = NDIAG_PROTO_ALL,
367                         .ndiag_show = NDIAG_SHOW_MEMINFO
368                 }
369         };
370         return send_query(tcp, fd, &req, sizeof(req));
371 }
372
373 static int
374 netlink_parse_response(const void *data, const int data_len,
375                        const unsigned long inode, void *opaque_data)
376 {
377         const char *proto_name = opaque_data;
378         const struct netlink_diag_msg *const diag_msg = data;
379         const char *netlink_proto;
380         char *details;
381
382         if (data_len < (int) NLMSG_LENGTH(sizeof(*diag_msg)))
383                 return -1;
384         if (diag_msg->ndiag_ino != inode)
385                 return 0;
386
387         if (diag_msg->ndiag_family != AF_NETLINK)
388                 return -1;
389
390         netlink_proto = xlookup(netlink_protocols,
391                                 diag_msg->ndiag_protocol);
392
393         if (netlink_proto) {
394                 netlink_proto = STR_STRIP_PREFIX(netlink_proto, "NETLINK_");
395                 if (asprintf(&details, "%s:[%s:%u]", proto_name,
396                              netlink_proto, diag_msg->ndiag_portid) < 0)
397                         return -1;
398         } else {
399                 if (asprintf(&details, "%s:[%u]", proto_name,
400                              (unsigned) diag_msg->ndiag_protocol) < 0)
401                         return -1;
402         }
403
404         return cache_inode_details(inode, details);
405 }
406
407 static const char *
408 unix_get(struct tcb *tcp, const int fd, const unsigned long inode)
409 {
410         return unix_send_query(tcp, fd, inode)
411                 && receive_responses(tcp, fd, inode, SOCK_DIAG_BY_FAMILY,
412                                      unix_parse_response, (void *) "UNIX")
413                 ? get_sockaddr_by_inode_cached(inode) : NULL;
414 }
415
416 static const char *
417 inet_get(struct tcb *tcp, const int fd, const int family, const int protocol,
418          const unsigned long inode, const char *proto_name)
419 {
420         return inet_send_query(tcp, fd, family, protocol)
421                 && receive_responses(tcp, fd, inode, SOCK_DIAG_BY_FAMILY,
422                                      inet_parse_response, (void *) proto_name)
423                 ? get_sockaddr_by_inode_cached(inode) : NULL;
424 }
425
426 static const char *
427 tcp_v4_get(struct tcb *tcp, const int fd, const unsigned long inode)
428 {
429         return inet_get(tcp, fd, AF_INET, IPPROTO_TCP, inode, "TCP");
430 }
431
432 static const char *
433 udp_v4_get(struct tcb *tcp, const int fd, const unsigned long inode)
434 {
435         return inet_get(tcp, fd, AF_INET, IPPROTO_UDP, inode, "UDP");
436 }
437
438 static const char *
439 tcp_v6_get(struct tcb *tcp, const int fd, const unsigned long inode)
440 {
441         return inet_get(tcp, fd, AF_INET6, IPPROTO_TCP, inode, "TCPv6");
442 }
443
444 static const char *
445 udp_v6_get(struct tcb *tcp, const int fd, const unsigned long inode)
446 {
447         return inet_get(tcp, fd, AF_INET6, IPPROTO_UDP, inode, "UDPv6");
448 }
449
450 static const char *
451 netlink_get(struct tcb *tcp, const int fd, const unsigned long inode)
452 {
453         return netlink_send_query(tcp, fd, inode)
454                 && receive_responses(tcp, fd, inode, SOCK_DIAG_BY_FAMILY,
455                                      netlink_parse_response, (void *) "NETLINK")
456                 ? get_sockaddr_by_inode_cached(inode) : NULL;
457 }
458
459 static const struct {
460         const char *const name;
461         const char * (*const get)(struct tcb *, int, unsigned long);
462 } protocols[] = {
463         [SOCK_PROTO_UNIX] = { "UNIX", unix_get },
464         [SOCK_PROTO_TCP] = { "TCP", tcp_v4_get },
465         [SOCK_PROTO_UDP] = { "UDP", udp_v4_get },
466         [SOCK_PROTO_TCPv6] = { "TCPv6", tcp_v6_get },
467         [SOCK_PROTO_UDPv6] = { "UDPv6", udp_v6_get },
468         [SOCK_PROTO_NETLINK] = { "NETLINK", netlink_get }
469 };
470
471 enum sock_proto
472 get_proto_by_name(const char *const name)
473 {
474         unsigned int i;
475         for (i = (unsigned int) SOCK_PROTO_UNKNOWN + 1;
476              i < ARRAY_SIZE(protocols); ++i) {
477                 if (protocols[i].name && !strcmp(name, protocols[i].name))
478                         return (enum sock_proto) i;
479         }
480         return SOCK_PROTO_UNKNOWN;
481 }
482
483 static const char *
484 get_sockaddr_by_inode_uncached(struct tcb *tcp, const unsigned long inode,
485                                const enum sock_proto proto)
486 {
487         if ((unsigned int) proto >= ARRAY_SIZE(protocols) ||
488             (proto != SOCK_PROTO_UNKNOWN && !protocols[proto].get))
489                 return NULL;
490
491         const int fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_SOCK_DIAG);
492         if (fd < 0)
493                 return NULL;
494         const char *details = NULL;
495
496         if (proto != SOCK_PROTO_UNKNOWN) {
497                 details = protocols[proto].get(tcp, fd, inode);
498         } else {
499                 unsigned int i;
500                 for (i = (unsigned int) SOCK_PROTO_UNKNOWN + 1;
501                      i < ARRAY_SIZE(protocols); ++i) {
502                         if (!protocols[i].get)
503                                 continue;
504                         details = protocols[i].get(tcp, fd, inode);
505                         if (details)
506                                 break;
507                 }
508         }
509
510         close(fd);
511         return details;
512 }
513
514 static bool
515 print_sockaddr_by_inode_uncached(struct tcb *tcp, const unsigned long inode,
516                                  const enum sock_proto proto)
517 {
518         const char *details = get_sockaddr_by_inode_uncached(tcp, inode, proto);
519
520         if (details) {
521                 tprints(details);
522                 return true;
523         }
524
525         if ((unsigned int) proto < ARRAY_SIZE(protocols) &&
526             protocols[proto].name) {
527                 tprintf("%s:[%lu]", protocols[proto].name, inode);
528                 return true;
529         }
530
531         return false;
532 }
533
534 /* Given an inode number of a socket, return its protocol details.  */
535 const char *
536 get_sockaddr_by_inode(struct tcb *const tcp, const int fd,
537                       const unsigned long inode)
538 {
539         const char *details = get_sockaddr_by_inode_cached(inode);
540         return details ? details :
541                 get_sockaddr_by_inode_uncached(tcp, inode, getfdproto(tcp, fd));
542 }
543
544 /* Given an inode number of a socket, print out its protocol details.  */
545 bool
546 print_sockaddr_by_inode(struct tcb *const tcp, const int fd,
547                         const unsigned long inode)
548 {
549         return print_sockaddr_by_inode_cached(inode) ? true :
550                 print_sockaddr_by_inode_uncached(tcp, inode,
551                                                  getfdproto(tcp, fd));
552 }
553
554 #ifdef HAVE_LINUX_GENETLINK_H
555 /*
556  * Managing the cache for decoding communications of Netlink GENERIC protocol
557  *
558  * As name shown Netlink GENERIC protocol is generic protocol. The
559  * numbers of msg types used in the protocol are not defined
560  * statically. Kernel defines them on demand.  So the xlat converted
561  * from header files doesn't help for decoding the protocol. Following
562  * codes are building xlat(dyxlat) at runtime.
563  */
564 static bool
565 genl_send_dump_families(struct tcb *tcp, const int fd)
566 {
567         struct {
568                 const struct nlmsghdr nlh;
569                 struct genlmsghdr gnlh;
570         } req = {
571                 .nlh = {
572                         .nlmsg_len = sizeof(req),
573                         .nlmsg_type = GENL_ID_CTRL,
574                         .nlmsg_flags = NLM_F_DUMP | NLM_F_REQUEST,
575                 },
576                 .gnlh = {
577                         .cmd = CTRL_CMD_GETFAMILY,
578                 }
579         };
580         return send_query(tcp, fd, &req, sizeof(req));
581 }
582
583 static int
584 genl_parse_families_response(const void *const data,
585                              const int data_len, const unsigned long inode,
586                              void *opaque_data)
587 {
588         struct dyxlat *const dyxlat = opaque_data;
589         const struct genlmsghdr *const gnlh = data;
590         struct rtattr *attr;
591         int rta_len = data_len - NLMSG_LENGTH(sizeof(*gnlh));
592
593         char *name = NULL;
594         unsigned int name_len = 0;
595         uint16_t *id = NULL;
596
597         if (rta_len < 0)
598                 return -1;
599         if (gnlh->cmd != CTRL_CMD_NEWFAMILY)
600                 return -1;
601         if (gnlh->version != 2)
602                 return -1;
603
604         for (attr = (struct rtattr *) (gnlh + 1);
605              RTA_OK(attr, rta_len);
606              attr = RTA_NEXT(attr, rta_len)) {
607                 switch (attr->rta_type) {
608                 case CTRL_ATTR_FAMILY_NAME:
609                         if (!name) {
610                                 name = RTA_DATA(attr);
611                                 name_len = RTA_PAYLOAD(attr);
612                         }
613                         break;
614                 case CTRL_ATTR_FAMILY_ID:
615                         if (!id && RTA_PAYLOAD(attr) == sizeof(*id))
616                                 id = RTA_DATA(attr);
617                         break;
618                 }
619
620                 if (name && id) {
621                         dyxlat_add_pair(dyxlat, *id, name, name_len);
622                         name = NULL;
623                         id = NULL;
624                 }
625         }
626
627         return 0;
628 }
629
630 const struct xlat *
631 genl_families_xlat(struct tcb *tcp)
632 {
633         static struct dyxlat *dyxlat;
634
635         if (!dyxlat) {
636                 dyxlat = dyxlat_alloc(32);
637
638                 int fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_GENERIC);
639                 if (fd < 0)
640                         goto out;
641
642                 if (genl_send_dump_families(tcp, fd))
643                         receive_responses(tcp, fd, 0, GENL_ID_CTRL,
644                                           genl_parse_families_response, dyxlat);
645                 close(fd);
646         }
647
648 out:
649         return dyxlat_get(dyxlat);
650 }
651
652 #else /* !HAVE_LINUX_GENETLINK_H */
653
654 const struct xlat *
655 genl_families_xlat(struct tcb *tcp)
656 {
657         return NULL;
658 }
659 #endif