]> granicus.if.org Git - strace/blob - netlink.c
netlink: introduce netlink.h
[strace] / netlink.c
1 /*
2  * Copyright (c) 2016 Fabien Siron <fabien.siron@epita.fr>
3  * Copyright (c) 2016 Dmitry V. Levin <ldv@altlinux.org>
4  * Copyright (c) 2016-2017 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 "netlink.h"
32 #include <linux/audit.h>
33 #include <linux/rtnetlink.h>
34 #include <linux/xfrm.h>
35 #include "xlat/netlink_flags.h"
36 #include "xlat/netlink_get_flags.h"
37 #include "xlat/netlink_new_flags.h"
38 #include "xlat/netlink_protocols.h"
39 #include "xlat/netlink_types.h"
40 #include "xlat/nl_audit_types.h"
41 #include "xlat/nl_netfilter_msg_types.h"
42 #include "xlat/nl_netfilter_subsys_ids.h"
43 #include "xlat/nl_route_types.h"
44 #include "xlat/nl_selinux_types.h"
45 #include "xlat/nl_sock_diag_types.h"
46 #include "xlat/nl_xfrm_types.h"
47
48 /*
49  * Fetch a struct nlmsghdr from the given address.
50  */
51 static bool
52 fetch_nlmsghdr(struct tcb *const tcp, struct nlmsghdr *const nlmsghdr,
53                const kernel_ulong_t addr, const kernel_ulong_t len)
54 {
55         if (len < sizeof(struct nlmsghdr)) {
56                 printstrn(tcp, addr, len);
57                 return false;
58         }
59
60         if (umove_or_printaddr(tcp, addr, nlmsghdr))
61                 return false;
62
63         return true;
64 }
65
66 enum {
67         NL_FAMILY_ERROR = -1,
68         NL_FAMILY_DEFAULT = -2
69 };
70
71 static int
72 get_fd_nl_family(struct tcb *const tcp, const int fd)
73 {
74         const unsigned long inode = getfdinode(tcp, fd);
75         if (!inode)
76                 return NL_FAMILY_ERROR;
77
78         const char *const details = get_sockaddr_by_inode(tcp, fd, inode);
79         if (!details)
80                 return NL_FAMILY_ERROR;
81
82         const char *const nl_details = STR_STRIP_PREFIX(details, "NETLINK:[");
83         if (nl_details == details)
84                 return NL_FAMILY_ERROR;
85
86         const struct xlat *xlats = netlink_protocols;
87         for (; xlats->str; ++xlats) {
88                 const char *name = STR_STRIP_PREFIX(xlats->str, "NETLINK_");
89                 if (!strncmp(nl_details, name, strlen(name)))
90                         return xlats->val;
91         }
92
93         if (*nl_details >= '0' && *nl_details <= '9')
94                 return atoi(nl_details);
95
96         return NL_FAMILY_ERROR;
97 }
98
99 static void
100 decode_nlmsg_type_default(const struct xlat *const xlat,
101                           const uint16_t type,
102                           const char *const dflt)
103 {
104         printxval(xlat, type, dflt);
105 }
106
107 static void
108 decode_nlmsg_type_generic(const struct xlat *const xlat,
109                           const uint16_t type,
110                           const char *const dflt)
111 {
112         printxval(genl_families_xlat(), type, dflt);
113 }
114
115 static void
116 decode_nlmsg_type_netfilter(const struct xlat *const xlat,
117                             const uint16_t type,
118                             const char *const dflt)
119 {
120         /* Reserved control nfnetlink messages first. */
121         const char *const text = xlookup(nl_netfilter_msg_types, type);
122         if (text) {
123                 tprints(text);
124                 return;
125         }
126
127         /*
128          * Other netfilter message types are split
129          * in two pieces: 8 bits subsystem and 8 bits type.
130          */
131         const uint8_t subsys_id = (uint8_t) (type >> 8);
132         const uint8_t msg_type = (uint8_t) type;
133
134         printxval(xlat, subsys_id, dflt);
135
136         /*
137          * The type is subsystem specific,
138          * print it in numeric format for now.
139          */
140         tprintf("<<8|%#x", msg_type);
141 }
142
143 typedef void (*nlmsg_types_decoder_t)(const struct xlat *,
144                                       uint16_t type,
145                                       const char *dflt);
146
147 static const struct {
148         const nlmsg_types_decoder_t decoder;
149         const struct xlat *const xlat;
150         const char *const dflt;
151 } nlmsg_types[] = {
152         [NETLINK_AUDIT] = { NULL, nl_audit_types, "AUDIT_???" },
153         [NETLINK_GENERIC] = {
154                 decode_nlmsg_type_generic,
155                 NULL,
156                 "GENERIC_FAMILY_???"
157         },
158         [NETLINK_NETFILTER] = {
159                 decode_nlmsg_type_netfilter,
160                 nl_netfilter_subsys_ids,
161                 "NFNL_SUBSYS_???"
162         },
163         [NETLINK_ROUTE] = { NULL, nl_route_types, "RTM_???" },
164         [NETLINK_SELINUX] = { NULL, nl_selinux_types, "SELNL_MSG_???" },
165         [NETLINK_SOCK_DIAG] = { NULL, nl_sock_diag_types, "SOCK_DIAG_???" },
166         [NETLINK_XFRM] = { NULL, nl_xfrm_types, "XFRM_MSG_???" }
167 };
168
169 /*
170  * As all valid netlink families are positive integers, use unsigned int
171  * for family here to filter out NL_FAMILY_ERROR and NL_FAMILY_DEFAULT.
172  */
173 static void
174 decode_nlmsg_type(const uint16_t type, const unsigned int family)
175 {
176         nlmsg_types_decoder_t decoder = decode_nlmsg_type_default;
177         const struct xlat *xlat = netlink_types;
178         const char *dflt = "NLMSG_???";
179
180         if (family < ARRAY_SIZE(nlmsg_types)) {
181                 if (nlmsg_types[family].decoder)
182                         decoder = nlmsg_types[family].decoder;
183                 if (nlmsg_types[family].xlat)
184                         xlat = nlmsg_types[family].xlat;
185                 if (nlmsg_types[family].dflt)
186                         dflt = nlmsg_types[family].dflt;
187         }
188
189         decoder(xlat, type, dflt);
190 }
191
192 static void
193 decode_nlmsg_flags(const uint16_t flags, const uint16_t type, const int family)
194 {
195         const struct xlat *table = NULL;
196
197         switch (family) {
198         case NETLINK_SOCK_DIAG:
199                 table = netlink_get_flags;
200                 break;
201         case NETLINK_ROUTE:
202                 if (type == RTM_DELACTION) {
203                         table = netlink_get_flags;
204                         break;
205                 }
206                 switch (type & 3) {
207                 case  0:
208                         table = netlink_new_flags;
209                         break;
210                 case  2:
211                         table = netlink_get_flags;
212                         break;
213                 }
214                 break;
215         case NETLINK_XFRM:
216                 switch (type) {
217                 case XFRM_MSG_NEWSA:
218                 case XFRM_MSG_NEWPOLICY:
219                 case XFRM_MSG_NEWAE:
220                 case XFRM_MSG_NEWSADINFO:
221                 case XFRM_MSG_NEWSPDINFO:
222                         table = netlink_new_flags;
223                         break;
224
225                 case XFRM_MSG_GETSA:
226                 case XFRM_MSG_GETPOLICY:
227                 case XFRM_MSG_GETAE:
228                 case XFRM_MSG_GETSADINFO:
229                 case XFRM_MSG_GETSPDINFO:
230                         table = netlink_get_flags;
231                         break;
232                 }
233                 break;
234         }
235
236         printflags_ex(flags, "NLM_F_???", netlink_flags, table, NULL);
237 }
238
239 static int
240 print_nlmsghdr(struct tcb *tcp,
241                const int fd,
242                int family,
243                const struct nlmsghdr *const nlmsghdr)
244 {
245         /* print the whole structure regardless of its nlmsg_len */
246
247         tprintf("{len=%u, type=", nlmsghdr->nlmsg_len);
248
249         const int hdr_family = (nlmsghdr->nlmsg_type < NLMSG_MIN_TYPE)
250                                ? NL_FAMILY_DEFAULT
251                                : (family != NL_FAMILY_DEFAULT
252                                   ? family : get_fd_nl_family(tcp, fd));
253
254         decode_nlmsg_type(nlmsghdr->nlmsg_type, hdr_family);
255
256         tprints(", flags=");
257         decode_nlmsg_flags(nlmsghdr->nlmsg_flags,
258                            nlmsghdr->nlmsg_type, hdr_family);
259
260         tprintf(", seq=%u, pid=%u}", nlmsghdr->nlmsg_seq,
261                 nlmsghdr->nlmsg_pid);
262
263         return family != NL_FAMILY_DEFAULT ? family : hdr_family;
264 }
265
266 static void
267 decode_nlmsghdr_with_payload(struct tcb *const tcp,
268                              const int fd,
269                              int family,
270                              const struct nlmsghdr *const nlmsghdr,
271                              const kernel_ulong_t addr,
272                              const kernel_ulong_t len);
273
274 static void
275 decode_nlmsgerr(struct tcb *const tcp,
276                 const int fd,
277                 const int family,
278                 kernel_ulong_t addr,
279                 kernel_ulong_t len)
280 {
281         struct nlmsgerr err;
282
283         if (len < sizeof(err.error)) {
284                 printstrn(tcp, addr, len);
285                 return;
286         }
287
288         if (umove_or_printaddr(tcp, addr, &err.error))
289                 return;
290
291         tprints("{error=");
292         if (err.error < 0 && (unsigned) -err.error < nerrnos) {
293                 tprintf("-%s", errnoent[-err.error]);
294         } else {
295                 tprintf("%d", err.error);
296         }
297
298         addr += offsetof(struct nlmsgerr, msg);
299         len -= offsetof(struct nlmsgerr, msg);
300
301         if (len) {
302                 tprints(", msg=");
303                 if (fetch_nlmsghdr(tcp, &err.msg, addr, len)) {
304                         decode_nlmsghdr_with_payload(tcp, fd, family,
305                                                      &err.msg, addr, len);
306                 }
307         }
308
309         tprints("}");
310 }
311
312 static const netlink_decoder_t netlink_decoders[] = {
313         [NETLINK_SOCK_DIAG] = decode_netlink_sock_diag
314 };
315
316 static void
317 decode_payload(struct tcb *const tcp,
318                const int fd,
319                const int family,
320                const struct nlmsghdr *const nlmsghdr,
321                const kernel_ulong_t addr,
322                const kernel_ulong_t len)
323 {
324         if (nlmsghdr->nlmsg_type == NLMSG_ERROR) {
325                 decode_nlmsgerr(tcp, fd, family, addr, len);
326                 return;
327         }
328
329         if ((unsigned int) family < ARRAY_SIZE(netlink_decoders)
330             && netlink_decoders[family]
331             && netlink_decoders[family](tcp, nlmsghdr, addr, len)) {
332                 return;
333         }
334
335         if (nlmsghdr->nlmsg_type == NLMSG_DONE && len == sizeof(int)) {
336                 int num;
337
338                 if (!umove_or_printaddr(tcp, addr, &num))
339                         tprintf("%d", num);
340                 return;
341         }
342
343         printstrn(tcp, addr, len);
344 }
345
346 static void
347 decode_nlmsghdr_with_payload(struct tcb *const tcp,
348                              const int fd,
349                              int family,
350                              const struct nlmsghdr *const nlmsghdr,
351                              const kernel_ulong_t addr,
352                              const kernel_ulong_t len)
353 {
354         const unsigned int nlmsg_len =
355                 nlmsghdr->nlmsg_len > len ? len : nlmsghdr->nlmsg_len;
356
357         if (nlmsg_len > NLMSG_HDRLEN)
358                 tprints("{");
359
360         family = print_nlmsghdr(tcp, fd, family, nlmsghdr);
361
362         if (nlmsg_len > NLMSG_HDRLEN) {
363                 tprints(", ");
364                 decode_payload(tcp, fd, family, nlmsghdr, addr + NLMSG_HDRLEN,
365                                                      nlmsg_len - NLMSG_HDRLEN);
366                 tprints("}");
367         }
368 }
369
370 void
371 decode_netlink(struct tcb *const tcp,
372                const int fd,
373                kernel_ulong_t addr,
374                kernel_ulong_t len)
375 {
376         struct nlmsghdr nlmsghdr;
377         bool print_array = false;
378         unsigned int elt;
379
380         for (elt = 0; fetch_nlmsghdr(tcp, &nlmsghdr, addr, len); elt++) {
381                 if (abbrev(tcp) && elt == max_strlen) {
382                         tprints("...");
383                         break;
384                 }
385
386                 unsigned int nlmsg_len = NLMSG_ALIGN(nlmsghdr.nlmsg_len);
387                 kernel_ulong_t next_addr = 0;
388                 kernel_ulong_t next_len = 0;
389
390                 if (nlmsghdr.nlmsg_len >= NLMSG_HDRLEN) {
391                         next_len = (len >= nlmsg_len) ? len - nlmsg_len : 0;
392
393                         if (next_len && addr + nlmsg_len > addr)
394                                 next_addr = addr + nlmsg_len;
395                 }
396
397                 if (!print_array && next_addr) {
398                         tprints("[");
399                         print_array = true;
400                 }
401
402                 decode_nlmsghdr_with_payload(tcp, fd, NL_FAMILY_DEFAULT,
403                                              &nlmsghdr, addr, len);
404
405                 if (!next_addr)
406                         break;
407
408                 tprints(", ");
409                 addr = next_addr;
410                 len = next_len;
411         }
412
413         if (print_array) {
414                 tprints("]");
415         }
416 }