2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2007-2011 Robert N. M. Watson
5 * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/capsicum.h>
35 #include <sys/socket.h>
36 #include <sys/sysctl.h>
40 #include <netinet/in.h>
42 #include <arpa/inet.h>
45 #include <libprocstat.h>
54 protocol_to_string(int domain, int type, int protocol)
92 addr_to_string(struct sockaddr_storage *ss, char *buffer, int buflen)
94 char buffer2[INET6_ADDRSTRLEN];
95 struct sockaddr_in6 *sin6;
96 struct sockaddr_in *sin;
97 struct sockaddr_un *sun;
99 switch (ss->ss_family) {
101 sun = (struct sockaddr_un *)ss;
102 if (strlen(sun->sun_path) == 0)
103 strlcpy(buffer, "-", buflen);
105 strlcpy(buffer, sun->sun_path, buflen);
109 sin = (struct sockaddr_in *)ss;
110 if (sin->sin_addr.s_addr == INADDR_ANY)
111 snprintf(buffer, buflen, "%s:%d", "*",
112 ntohs(sin->sin_port));
113 else if (inet_ntop(AF_INET, &sin->sin_addr, buffer2,
114 sizeof(buffer2)) != NULL)
115 snprintf(buffer, buflen, "%s:%d", buffer2,
116 ntohs(sin->sin_port));
120 sin6 = (struct sockaddr_in6 *)ss;
121 if (inet_ntop(AF_INET6, &sin6->sin6_addr, buffer2,
122 sizeof(buffer2)) != NULL)
123 snprintf(buffer, buflen, "%s.%d", buffer2,
124 ntohs(sin6->sin6_port));
126 strlcpy(buffer, "-", buflen);
130 strlcpy(buffer, "", buflen);
135 static struct cap_desc {
139 /* General file I/O. */
144 { CAP_CREATE, "cr" },
145 { CAP_FEXECVE, "fe" },
147 { CAP_FTRUNCATE, "ft" },
150 { CAP_FCHDIR, "cd" },
151 { CAP_FCHFLAGS, "cf" },
152 { CAP_FCHMOD, "cm" },
153 { CAP_FCHOWN, "cn" },
156 { CAP_FPATHCONF, "fp" },
159 { CAP_FSTATFS, "sf" },
160 { CAP_FUTIMES, "fu" },
161 { CAP_LINKAT_SOURCE, "ls" },
162 { CAP_LINKAT_TARGET, "lt" },
163 { CAP_MKDIRAT, "md" },
164 { CAP_MKFIFOAT, "mf" },
165 { CAP_MKNODAT, "mn" },
166 { CAP_RENAMEAT_SOURCE, "rs" },
167 { CAP_RENAMEAT_TARGET, "rt" },
168 { CAP_SYMLINKAT, "sl" },
169 { CAP_UNLINKAT, "un" },
171 /* Lookups - used to constrain *at() calls. */
172 { CAP_LOOKUP, "lo" },
174 /* Extended attributes. */
175 { CAP_EXTATTR_GET, "eg" },
176 { CAP_EXTATTR_SET, "es" },
177 { CAP_EXTATTR_DELETE, "ed" },
178 { CAP_EXTATTR_LIST, "el" },
180 /* Access Control Lists. */
181 { CAP_ACL_GET, "ag" },
182 { CAP_ACL_SET, "as" },
183 { CAP_ACL_DELETE, "ad" },
184 { CAP_ACL_CHECK, "ac" },
186 /* Socket operations. */
187 { CAP_ACCEPT, "at" },
189 { CAP_CONNECT, "co" },
190 { CAP_GETPEERNAME, "pn" },
191 { CAP_GETSOCKNAME, "sn" },
192 { CAP_GETSOCKOPT, "gs" },
193 { CAP_LISTEN, "ln" },
194 { CAP_PEELOFF, "pf" },
195 { CAP_SETSOCKOPT, "ss" },
196 { CAP_SHUTDOWN, "sh" },
198 /* Mandatory Access Control. */
199 { CAP_MAC_GET, "mg" },
200 { CAP_MAC_SET, "ms" },
202 /* Methods on semaphores. */
203 { CAP_SEM_GETVALUE, "sg" },
204 { CAP_SEM_POST, "sp" },
205 { CAP_SEM_WAIT, "sw" },
207 /* Event monitoring and posting. */
209 { CAP_KQUEUE_EVENT, "ke" },
210 { CAP_KQUEUE_CHANGE, "kc" },
212 /* Strange and powerful rights that should not be given lightly. */
214 { CAP_TTYHOOK, "ty" },
216 /* Process management via process descriptors. */
217 { CAP_PDGETPID, "pg" },
218 { CAP_PDWAIT, "pw" },
219 { CAP_PDKILL, "pk" },
222 * Rights that allow to use bindat(2) and connectat(2) syscalls on a
223 * directory descriptor.
225 { CAP_BINDAT, "ba" },
226 { CAP_CONNECTAT, "ca" },
228 /* Aliases and defines that combine multiple rights. */
229 { CAP_PREAD, "prd" },
230 { CAP_PWRITE, "pwr" },
232 { CAP_MMAP_R, "mmr" },
233 { CAP_MMAP_W, "mmw" },
234 { CAP_MMAP_X, "mmx" },
235 { CAP_MMAP_RW, "mrw" },
236 { CAP_MMAP_RX, "mrx" },
237 { CAP_MMAP_WX, "mwx" },
238 { CAP_MMAP_RWX, "mma" },
243 { CAP_SOCK_CLIENT, "scl" },
244 { CAP_SOCK_SERVER, "ssr" },
246 static const u_int cap_desc_count = nitems(cap_desc);
249 width_capability(cap_rights_t *rightsp)
251 u_int count, i, width;
255 for (i = 0; i < cap_desc_count; i++) {
256 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
257 width += strlen(cap_desc[i].cd_desc);
267 print_capability(cap_rights_t *rightsp, u_int capwidth)
269 u_int count, i, width;
273 for (i = width_capability(rightsp); i < capwidth; i++) {
279 xo_open_list("capabilities");
280 for (i = 0; i < cap_desc_count; i++) {
281 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
282 xo_emit("{D:/%s}{l:capabilities/%s}", count ? "," : "",
283 cap_desc[i].cd_desc);
284 width += strlen(cap_desc[i].cd_desc);
290 xo_close_list("capabilities");
294 procstat_files(struct procstat *procstat, struct kinfo_proc *kipp)
296 struct sockstat sock;
297 struct filestat_list *head;
298 struct filestat *fst;
301 u_int capwidth, width;
303 char src_addr[PATH_MAX];
304 char dst_addr[PATH_MAX];
307 * To print the header in capability mode, we need to know the width
308 * of the widest capability string. Even if we get no processes
309 * back, we will print the header, so we defer aborting due to a lack
310 * of processes until after the header logic.
313 head = procstat_getfiles(procstat, kipp, 0);
315 (procstat_opts & PS_OPT_CAPABILITIES) != 0) {
316 STAILQ_FOREACH(fst, head, next) {
317 width = width_capability(&fst->fs_cap_rights);
318 if (width > capwidth)
321 if (capwidth < strlen("CAPABILITIES"))
322 capwidth = strlen("CAPABILITIES");
325 if ((procstat_opts & PS_OPT_NOHEADER) == 0) {
326 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0)
327 xo_emit("{T:/%5s %-16s %5s %1s %-8s %-*s "
328 "%-3s %-12s}\n", "PID", "COMM", "FD", "T",
329 "FLAGS", capwidth, "CAPABILITIES", "PRO",
332 xo_emit("{T:/%5s %-16s %5s %1s %1s %-8s "
333 "%3s %7s %-3s %-12s}\n", "PID", "COMM", "FD", "T",
334 "V", "FLAGS", "REF", "OFFSET", "PRO", "NAME");
339 xo_emit("{ek:process_id/%5d/%d}", kipp->ki_pid);
340 xo_emit("{e:command/%-16s/%s}", kipp->ki_comm);
341 xo_open_list("files");
342 STAILQ_FOREACH(fst, head, next) {
343 xo_open_instance("files");
344 xo_emit("{dk:process_id/%5d/%d} ", kipp->ki_pid);
345 xo_emit("{d:command/%-16s/%s} ", kipp->ki_comm);
346 if (fst->fs_uflags & PS_FST_UFLAG_CTTY)
347 xo_emit("{P: }{:fd/%s} ", "ctty");
348 else if (fst->fs_uflags & PS_FST_UFLAG_CDIR)
349 xo_emit("{P: }{:fd/%s} ", "cwd");
350 else if (fst->fs_uflags & PS_FST_UFLAG_JAIL)
351 xo_emit("{P: }{:fd/%s} ", "jail");
352 else if (fst->fs_uflags & PS_FST_UFLAG_RDIR)
353 xo_emit("{P: }{:fd/%s} ", "root");
354 else if (fst->fs_uflags & PS_FST_UFLAG_TEXT)
355 xo_emit("{P: }{:fd/%s} ", "text");
356 else if (fst->fs_uflags & PS_FST_UFLAG_TRACE)
357 xo_emit("{:fd/%s} ", "trace");
359 xo_emit("{:fd/%5d} ", fst->fs_fd);
361 switch (fst->fs_type) {
362 case PS_FST_TYPE_VNODE:
364 xo_emit("{eq:fd_type/vnode}");
367 case PS_FST_TYPE_SOCKET:
369 xo_emit("{eq:fd_type/socket}");
372 case PS_FST_TYPE_PIPE:
374 xo_emit("{eq:fd_type/pipe}");
377 case PS_FST_TYPE_FIFO:
379 xo_emit("{eq:fd_type/fifo}");
382 case PS_FST_TYPE_KQUEUE:
384 xo_emit("{eq:fd_type/kqueue}");
387 case PS_FST_TYPE_MQUEUE:
389 xo_emit("{eq:fd_type/mqueue}");
392 case PS_FST_TYPE_SHM:
394 xo_emit("{eq:fd_type/shm}");
397 case PS_FST_TYPE_PTS:
399 xo_emit("{eq:fd_type/pts}");
402 case PS_FST_TYPE_SEM:
404 xo_emit("{eq:fd_type/sem}");
407 case PS_FST_TYPE_PROCDESC:
409 xo_emit("{eq:fd_type/procdesc}");
412 case PS_FST_TYPE_DEV:
414 xo_emit("{eq:fd_type/dev}");
417 case PS_FST_TYPE_NONE:
419 xo_emit("{eq:fd_type/none}");
422 case PS_FST_TYPE_UNKNOWN:
425 xo_emit("{eq:fd_type/unknown}");
428 xo_emit("{d:fd_type/%1s/%s} ", str);
429 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
431 if (fst->fs_type == PS_FST_TYPE_VNODE) {
432 error = procstat_get_vnode_info(procstat, fst,
434 switch (vn.vn_type) {
435 case PS_FST_VTYPE_VREG:
437 xo_emit("{eq:vode_type/regular}");
440 case PS_FST_VTYPE_VDIR:
442 xo_emit("{eq:vode_type/directory}");
445 case PS_FST_VTYPE_VBLK:
447 xo_emit("{eq:vode_type/block}");
450 case PS_FST_VTYPE_VCHR:
452 xo_emit("{eq:vode_type/character}");
455 case PS_FST_VTYPE_VLNK:
457 xo_emit("{eq:vode_type/link}");
460 case PS_FST_VTYPE_VSOCK:
462 xo_emit("{eq:vode_type/socket}");
465 case PS_FST_VTYPE_VFIFO:
467 xo_emit("{eq:vode_type/fifo}");
470 case PS_FST_VTYPE_VBAD:
472 xo_emit("{eq:vode_type/revoked_device}");
475 case PS_FST_VTYPE_VNON:
477 xo_emit("{eq:vode_type/non}");
480 case PS_FST_VTYPE_UNKNOWN:
483 xo_emit("{eq:vode_type/unknown}");
487 xo_emit("{d:vnode_type/%1s/%s} ", str);
490 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_READ ?
492 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_WRITE ?
494 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_APPEND ?
496 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_ASYNC ?
498 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_SYNC ?
500 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_NONBLOCK ?
502 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_DIRECT ?
504 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_HASLOCK ?
507 xo_open_list("fd_flags");
508 if (fst->fs_fflags & PS_FST_FFLAG_READ)
509 xo_emit("{elq:fd_flags/read}");
510 if (fst->fs_fflags & PS_FST_FFLAG_WRITE)
511 xo_emit("{elq:fd_flags/write}");
512 if (fst->fs_fflags & PS_FST_FFLAG_APPEND)
513 xo_emit("{elq:fd_flags/append}");
514 if (fst->fs_fflags & PS_FST_FFLAG_ASYNC)
515 xo_emit("{elq:fd_flags/async}");
516 if (fst->fs_fflags & PS_FST_FFLAG_SYNC)
517 xo_emit("{elq:fd_flags/fsync}");
518 if (fst->fs_fflags & PS_FST_FFLAG_NONBLOCK)
519 xo_emit("{elq:fd_flags/nonblocking}");
520 if (fst->fs_fflags & PS_FST_FFLAG_DIRECT)
521 xo_emit("{elq:fd_flags/direct_io}");
522 if (fst->fs_fflags & PS_FST_FFLAG_HASLOCK)
523 xo_emit("{elq:fd_flags/lock_held}");
524 xo_close_list("fd_flags");
526 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
527 if (fst->fs_ref_count > -1)
528 xo_emit("{:ref_count/%3d/%d} ",
531 xo_emit("{q:ref_count/%3c/%c} ", '-');
532 if (fst->fs_offset > -1)
533 xo_emit("{:offset/%7jd/%jd} ",
534 (intmax_t)fst->fs_offset);
536 xo_emit("{q:offset/%7c/%c} ", '-');
538 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0) {
539 print_capability(&fst->fs_cap_rights, capwidth);
542 switch (fst->fs_type) {
543 case PS_FST_TYPE_SOCKET:
544 error = procstat_get_socket_info(procstat, fst, &sock,
548 xo_emit("{:protocol/%-3s/%s} ",
549 protocol_to_string(sock.dom_family,
550 sock.type, sock.proto));
551 if (sock.proto == IPPROTO_TCP ||
552 sock.proto == IPPROTO_SCTP ||
553 sock.type == SOCK_STREAM) {
554 xo_emit("{:sendq/%u} ", sock.sendq);
555 xo_emit("{:recvq/%u} ", sock.recvq);
558 * While generally we like to print two addresses,
559 * local and peer, for sockets, it turns out to be
560 * more useful to print the first non-nul address for
561 * local sockets, as typically they aren't bound and
562 * connected, and the path strings can get long.
564 if (sock.dom_family == AF_LOCAL) {
565 struct sockaddr_un *sun =
566 (struct sockaddr_un *)&sock.sa_local;
568 if (sun->sun_path[0] != 0)
569 addr_to_string(&sock.sa_local,
570 src_addr, sizeof(src_addr));
572 addr_to_string(&sock.sa_peer,
573 src_addr, sizeof(src_addr));
574 xo_emit("{:path/%s}", src_addr);
576 addr_to_string(&sock.sa_local, src_addr,
578 addr_to_string(&sock.sa_peer, dst_addr,
580 xo_emit("{:path/%s %s}", src_addr, dst_addr);
585 xo_emit("{:protocol/%-3s/%s} ", "-");
586 xo_emit("{:path/%-18s/%s}", fst->fs_path != NULL ?
591 xo_close_instance("files");
593 xo_close_list("files");
594 procstat_freefiles(procstat, head);