2 * Copyright (c) 1999-2005 Apple Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS 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 APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
21 * 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,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/filedesc.h>
36 #include <sys/mount.h>
38 #include <sys/socket.h>
39 #include <sys/socketvar.h>
40 #include <sys/protosw.h>
41 #include <sys/domain.h>
43 #include <sys/systm.h>
45 #include <sys/vnode.h>
47 #include <netinet/in.h>
48 #include <netinet/in_pcb.h>
50 #include <security/audit/audit.h>
51 #include <security/audit/audit_private.h>
54 * Calls to manipulate elements of the audit record structure from system
55 * call code. Macro wrappers will prevent this functions from being entered
56 * if auditing is disabled, avoiding the function call cost. We check the
57 * thread audit record pointer anyway, as the audit condition could change,
58 * and pre-selection may not have allocated an audit record for this event.
60 * XXXAUDIT: Should we assert, in each case, that this field of the record
61 * hasn't already been filled in?
64 audit_arg_addr(void *addr)
66 struct kaudit_record *ar;
72 ar->k_ar.ar_arg_addr = addr;
73 ARG_SET_VALID(ar, ARG_ADDR);
77 audit_arg_exit(int status, int retval)
79 struct kaudit_record *ar;
85 ar->k_ar.ar_arg_exitstatus = status;
86 ar->k_ar.ar_arg_exitretval = retval;
87 ARG_SET_VALID(ar, ARG_EXIT);
91 audit_arg_len(int len)
93 struct kaudit_record *ar;
99 ar->k_ar.ar_arg_len = len;
100 ARG_SET_VALID(ar, ARG_LEN);
106 struct kaudit_record *ar;
112 ar->k_ar.ar_arg_fd = fd;
113 ARG_SET_VALID(ar, ARG_FD);
117 audit_arg_fflags(int fflags)
119 struct kaudit_record *ar;
125 ar->k_ar.ar_arg_fflags = fflags;
126 ARG_SET_VALID(ar, ARG_FFLAGS);
130 audit_arg_gid(gid_t gid)
132 struct kaudit_record *ar;
138 ar->k_ar.ar_arg_gid = gid;
139 ARG_SET_VALID(ar, ARG_GID);
143 audit_arg_uid(uid_t uid)
145 struct kaudit_record *ar;
151 ar->k_ar.ar_arg_uid = uid;
152 ARG_SET_VALID(ar, ARG_UID);
156 audit_arg_egid(gid_t egid)
158 struct kaudit_record *ar;
164 ar->k_ar.ar_arg_egid = egid;
165 ARG_SET_VALID(ar, ARG_EGID);
169 audit_arg_euid(uid_t euid)
171 struct kaudit_record *ar;
177 ar->k_ar.ar_arg_euid = euid;
178 ARG_SET_VALID(ar, ARG_EUID);
182 audit_arg_rgid(gid_t rgid)
184 struct kaudit_record *ar;
190 ar->k_ar.ar_arg_rgid = rgid;
191 ARG_SET_VALID(ar, ARG_RGID);
195 audit_arg_ruid(uid_t ruid)
197 struct kaudit_record *ar;
203 ar->k_ar.ar_arg_ruid = ruid;
204 ARG_SET_VALID(ar, ARG_RUID);
208 audit_arg_sgid(gid_t sgid)
210 struct kaudit_record *ar;
216 ar->k_ar.ar_arg_sgid = sgid;
217 ARG_SET_VALID(ar, ARG_SGID);
221 audit_arg_suid(uid_t suid)
223 struct kaudit_record *ar;
229 ar->k_ar.ar_arg_suid = suid;
230 ARG_SET_VALID(ar, ARG_SUID);
234 audit_arg_groupset(gid_t *gidset, u_int gidset_size)
237 struct kaudit_record *ar;
243 for (i = 0; i < gidset_size; i++)
244 ar->k_ar.ar_arg_groups.gidset[i] = gidset[i];
245 ar->k_ar.ar_arg_groups.gidset_size = gidset_size;
246 ARG_SET_VALID(ar, ARG_GROUPSET);
250 audit_arg_login(char *login)
252 struct kaudit_record *ar;
258 strlcpy(ar->k_ar.ar_arg_login, login, MAXLOGNAME);
259 ARG_SET_VALID(ar, ARG_LOGIN);
263 audit_arg_ctlname(int *name, int namelen)
265 struct kaudit_record *ar;
271 bcopy(name, &ar->k_ar.ar_arg_ctlname, namelen * sizeof(int));
272 ar->k_ar.ar_arg_len = namelen;
273 ARG_SET_VALID(ar, ARG_CTLNAME | ARG_LEN);
277 audit_arg_mask(int mask)
279 struct kaudit_record *ar;
285 ar->k_ar.ar_arg_mask = mask;
286 ARG_SET_VALID(ar, ARG_MASK);
290 audit_arg_mode(mode_t mode)
292 struct kaudit_record *ar;
298 ar->k_ar.ar_arg_mode = mode;
299 ARG_SET_VALID(ar, ARG_MODE);
303 audit_arg_dev(int dev)
305 struct kaudit_record *ar;
311 ar->k_ar.ar_arg_dev = dev;
312 ARG_SET_VALID(ar, ARG_DEV);
316 audit_arg_value(long value)
318 struct kaudit_record *ar;
324 ar->k_ar.ar_arg_value = value;
325 ARG_SET_VALID(ar, ARG_VALUE);
329 audit_arg_owner(uid_t uid, gid_t gid)
331 struct kaudit_record *ar;
337 ar->k_ar.ar_arg_uid = uid;
338 ar->k_ar.ar_arg_gid = gid;
339 ARG_SET_VALID(ar, ARG_UID | ARG_GID);
343 audit_arg_pid(pid_t pid)
345 struct kaudit_record *ar;
351 ar->k_ar.ar_arg_pid = pid;
352 ARG_SET_VALID(ar, ARG_PID);
356 audit_arg_process(struct proc *p)
358 struct kaudit_record *ar;
360 KASSERT(p != NULL, ("audit_arg_process: p == NULL"));
362 PROC_LOCK_ASSERT(p, MA_OWNED);
368 ar->k_ar.ar_arg_auid = p->p_ucred->cr_audit.ai_auid;
369 ar->k_ar.ar_arg_euid = p->p_ucred->cr_uid;
370 ar->k_ar.ar_arg_egid = p->p_ucred->cr_groups[0];
371 ar->k_ar.ar_arg_ruid = p->p_ucred->cr_ruid;
372 ar->k_ar.ar_arg_rgid = p->p_ucred->cr_rgid;
373 ar->k_ar.ar_arg_asid = p->p_ucred->cr_audit.ai_asid;
374 ar->k_ar.ar_arg_termid_addr = p->p_ucred->cr_audit.ai_termid;
375 ar->k_ar.ar_arg_pid = p->p_pid;
376 ARG_SET_VALID(ar, ARG_AUID | ARG_EUID | ARG_EGID | ARG_RUID |
377 ARG_RGID | ARG_ASID | ARG_TERMID_ADDR | ARG_PID | ARG_PROCESS);
381 audit_arg_signum(u_int signum)
383 struct kaudit_record *ar;
389 ar->k_ar.ar_arg_signum = signum;
390 ARG_SET_VALID(ar, ARG_SIGNUM);
394 audit_arg_socket(int sodomain, int sotype, int soprotocol)
396 struct kaudit_record *ar;
402 ar->k_ar.ar_arg_sockinfo.so_domain = sodomain;
403 ar->k_ar.ar_arg_sockinfo.so_type = sotype;
404 ar->k_ar.ar_arg_sockinfo.so_protocol = soprotocol;
405 ARG_SET_VALID(ar, ARG_SOCKINFO);
409 audit_arg_sockaddr(struct thread *td, struct sockaddr *sa)
411 struct kaudit_record *ar;
413 KASSERT(td != NULL, ("audit_arg_sockaddr: td == NULL"));
414 KASSERT(sa != NULL, ("audit_arg_sockaddr: sa == NULL"));
420 bcopy(sa, &ar->k_ar.ar_arg_sockaddr, sa->sa_len);
421 switch (sa->sa_family) {
423 ARG_SET_VALID(ar, ARG_SADDRINET);
427 ARG_SET_VALID(ar, ARG_SADDRINET6);
431 audit_arg_upath(td, ((struct sockaddr_un *)sa)->sun_path,
433 ARG_SET_VALID(ar, ARG_SADDRUNIX);
435 /* XXXAUDIT: default:? */
440 audit_arg_auid(uid_t auid)
442 struct kaudit_record *ar;
448 ar->k_ar.ar_arg_auid = auid;
449 ARG_SET_VALID(ar, ARG_AUID);
453 audit_arg_auditinfo(struct auditinfo *au_info)
455 struct kaudit_record *ar;
461 ar->k_ar.ar_arg_auid = au_info->ai_auid;
462 ar->k_ar.ar_arg_asid = au_info->ai_asid;
463 ar->k_ar.ar_arg_amask.am_success = au_info->ai_mask.am_success;
464 ar->k_ar.ar_arg_amask.am_failure = au_info->ai_mask.am_failure;
465 ar->k_ar.ar_arg_termid.port = au_info->ai_termid.port;
466 ar->k_ar.ar_arg_termid.machine = au_info->ai_termid.machine;
467 ARG_SET_VALID(ar, ARG_AUID | ARG_ASID | ARG_AMASK | ARG_TERMID);
471 audit_arg_auditinfo_addr(struct auditinfo_addr *au_info)
473 struct kaudit_record *ar;
479 ar->k_ar.ar_arg_auid = au_info->ai_auid;
480 ar->k_ar.ar_arg_asid = au_info->ai_asid;
481 ar->k_ar.ar_arg_amask.am_success = au_info->ai_mask.am_success;
482 ar->k_ar.ar_arg_amask.am_failure = au_info->ai_mask.am_failure;
483 ar->k_ar.ar_arg_termid_addr.at_type = au_info->ai_termid.at_type;
484 ar->k_ar.ar_arg_termid_addr.at_port = au_info->ai_termid.at_port;
485 ar->k_ar.ar_arg_termid_addr.at_addr[0] = au_info->ai_termid.at_addr[0];
486 ar->k_ar.ar_arg_termid_addr.at_addr[1] = au_info->ai_termid.at_addr[1];
487 ar->k_ar.ar_arg_termid_addr.at_addr[2] = au_info->ai_termid.at_addr[2];
488 ar->k_ar.ar_arg_termid_addr.at_addr[3] = au_info->ai_termid.at_addr[3];
489 ARG_SET_VALID(ar, ARG_AUID | ARG_ASID | ARG_AMASK | ARG_TERMID_ADDR);
493 audit_arg_text(char *text)
495 struct kaudit_record *ar;
497 KASSERT(text != NULL, ("audit_arg_text: text == NULL"));
503 /* Invalidate the text string */
504 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_TEXT);
506 if (ar->k_ar.ar_arg_text == NULL)
507 ar->k_ar.ar_arg_text = malloc(MAXPATHLEN, M_AUDITTEXT,
510 strncpy(ar->k_ar.ar_arg_text, text, MAXPATHLEN);
511 ARG_SET_VALID(ar, ARG_TEXT);
515 audit_arg_cmd(int cmd)
517 struct kaudit_record *ar;
523 ar->k_ar.ar_arg_cmd = cmd;
524 ARG_SET_VALID(ar, ARG_CMD);
528 audit_arg_svipc_cmd(int cmd)
530 struct kaudit_record *ar;
536 ar->k_ar.ar_arg_svipc_cmd = cmd;
537 ARG_SET_VALID(ar, ARG_SVIPC_CMD);
541 audit_arg_svipc_perm(struct ipc_perm *perm)
543 struct kaudit_record *ar;
549 bcopy(perm, &ar->k_ar.ar_arg_svipc_perm,
550 sizeof(ar->k_ar.ar_arg_svipc_perm));
551 ARG_SET_VALID(ar, ARG_SVIPC_PERM);
555 audit_arg_svipc_id(int id)
557 struct kaudit_record *ar;
563 ar->k_ar.ar_arg_svipc_id = id;
564 ARG_SET_VALID(ar, ARG_SVIPC_ID);
568 audit_arg_svipc_addr(void * addr)
570 struct kaudit_record *ar;
576 ar->k_ar.ar_arg_svipc_addr = addr;
577 ARG_SET_VALID(ar, ARG_SVIPC_ADDR);
581 audit_arg_posix_ipc_perm(uid_t uid, gid_t gid, mode_t mode)
583 struct kaudit_record *ar;
589 ar->k_ar.ar_arg_pipc_perm.pipc_uid = uid;
590 ar->k_ar.ar_arg_pipc_perm.pipc_gid = gid;
591 ar->k_ar.ar_arg_pipc_perm.pipc_mode = mode;
592 ARG_SET_VALID(ar, ARG_POSIX_IPC_PERM);
596 audit_arg_auditon(union auditon_udata *udata)
598 struct kaudit_record *ar;
604 bcopy((void *)udata, &ar->k_ar.ar_arg_auditon,
605 sizeof(ar->k_ar.ar_arg_auditon));
606 ARG_SET_VALID(ar, ARG_AUDITON);
610 * Audit information about a file, either the file's vnode info, or its
611 * socket address info.
614 audit_arg_file(struct proc *p, struct file *fp)
616 struct kaudit_record *ar;
626 switch (fp->f_type) {
630 * XXXAUDIT: Only possibly to record as first vnode?
633 vfslocked = VFS_LOCK_GIANT(vp->v_mount);
634 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
635 audit_arg_vnode(vp, ARG_VNODE1);
637 VFS_UNLOCK_GIANT(vfslocked);
641 so = (struct socket *)fp->f_data;
642 if (INP_CHECK_SOCKAF(so, PF_INET)) {
644 ar->k_ar.ar_arg_sockinfo.so_type =
646 ar->k_ar.ar_arg_sockinfo.so_domain =
648 ar->k_ar.ar_arg_sockinfo.so_protocol =
649 so->so_proto->pr_protocol;
651 pcb = (struct inpcb *)so->so_pcb;
653 ar->k_ar.ar_arg_sockinfo.so_raddr =
654 pcb->inp_faddr.s_addr;
655 ar->k_ar.ar_arg_sockinfo.so_laddr =
656 pcb->inp_laddr.s_addr;
657 ar->k_ar.ar_arg_sockinfo.so_rport =
659 ar->k_ar.ar_arg_sockinfo.so_lport =
662 ARG_SET_VALID(ar, ARG_SOCKINFO);
667 /* XXXAUDIT: else? */
673 * Store a path as given by the user process for auditing into the audit
674 * record stored on the user thread. This function will allocate the memory
675 * to store the path info if not already available. This memory will be
676 * freed when the audit record is freed.
678 * XXXAUDIT: Possibly assert that the memory isn't already allocated?
681 audit_arg_upath(struct thread *td, char *upath, u_int64_t flag)
683 struct kaudit_record *ar;
686 KASSERT(td != NULL, ("audit_arg_upath: td == NULL"));
687 KASSERT(upath != NULL, ("audit_arg_upath: upath == NULL"));
693 KASSERT((flag == ARG_UPATH1) || (flag == ARG_UPATH2),
694 ("audit_arg_upath: flag %llu", (unsigned long long)flag));
695 KASSERT((flag != ARG_UPATH1) || (flag != ARG_UPATH2),
696 ("audit_arg_upath: flag %llu", (unsigned long long)flag));
698 if (flag == ARG_UPATH1)
699 pathp = &ar->k_ar.ar_arg_upath1;
701 pathp = &ar->k_ar.ar_arg_upath2;
704 *pathp = malloc(MAXPATHLEN, M_AUDITPATH, M_WAITOK);
706 audit_canon_path(td, upath, *pathp);
708 ARG_SET_VALID(ar, flag);
712 * Function to save the path and vnode attr information into the audit
715 * It is assumed that the caller will hold any vnode locks necessary to
716 * perform a VOP_GETATTR() on the passed vnode.
718 * XXX: The attr code is very similar to vfs_vnops.c:vn_stat(), but always
719 * provides access to the generation number as we need that to construct the
722 * XXX: We should accept the process argument from the caller, since it's
723 * very likely they already have a reference.
725 * XXX: Error handling in this function is poor.
727 * XXXAUDIT: Possibly KASSERT the path pointer is NULL?
730 audit_arg_vnode(struct vnode *vp, u_int64_t flags)
732 struct kaudit_record *ar;
735 struct vnode_au_info *vnp;
737 KASSERT(vp != NULL, ("audit_arg_vnode: vp == NULL"));
738 KASSERT((flags == ARG_VNODE1) || (flags == ARG_VNODE2),
739 ("audit_arg_vnode: flags %jd", (intmax_t)flags));
742 * Assume that if the caller is calling audit_arg_vnode() on a
743 * non-MPSAFE vnode, then it will have acquired Giant.
745 VFS_ASSERT_GIANT(vp->v_mount);
746 ASSERT_VOP_LOCKED(vp, "audit_arg_vnode");
753 * XXXAUDIT: The below clears, and then resets the flags for valid
754 * arguments. Ideally, either the new vnode is used, or the old one
757 if (flags & ARG_VNODE1) {
758 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_VNODE1);
759 vnp = &ar->k_ar.ar_arg_vnode1;
761 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_VNODE2);
762 vnp = &ar->k_ar.ar_arg_vnode2;
765 error = VOP_GETATTR(vp, &vattr, curthread->td_ucred);
767 /* XXX: How to handle this case? */
771 vnp->vn_mode = vattr.va_mode;
772 vnp->vn_uid = vattr.va_uid;
773 vnp->vn_gid = vattr.va_gid;
774 vnp->vn_dev = vattr.va_rdev;
775 vnp->vn_fsid = vattr.va_fsid;
776 vnp->vn_fileid = vattr.va_fileid;
777 vnp->vn_gen = vattr.va_gen;
778 if (flags & ARG_VNODE1)
779 ARG_SET_VALID(ar, ARG_VNODE1);
781 ARG_SET_VALID(ar, ARG_VNODE2);
785 * Audit the argument strings passed to exec.
788 audit_arg_argv(char *argv, int argc, int length)
790 struct kaudit_record *ar;
799 ar->k_ar.ar_arg_argv = malloc(length, M_AUDITTEXT, M_WAITOK);
800 bcopy(argv, ar->k_ar.ar_arg_argv, length);
801 ar->k_ar.ar_arg_argc = argc;
802 ARG_SET_VALID(ar, ARG_ARGV);
806 * Audit the environment strings passed to exec.
809 audit_arg_envv(char *envv, int envc, int length)
811 struct kaudit_record *ar;
820 ar->k_ar.ar_arg_envv = malloc(length, M_AUDITTEXT, M_WAITOK);
821 bcopy(envv, ar->k_ar.ar_arg_envv, length);
822 ar->k_ar.ar_arg_envc = envc;
823 ARG_SET_VALID(ar, ARG_ENVV);
827 * The close() system call uses it's own audit call to capture the path/vnode
828 * information because those pieces are not easily obtained within the system
832 audit_sysclose(struct thread *td, int fd)
834 struct kaudit_record *ar;
839 KASSERT(td != NULL, ("audit_sysclose: td == NULL"));
847 if (getvnode(td->td_proc->p_fd, fd, &fp) != 0)
851 vfslocked = VFS_LOCK_GIANT(vp->v_mount);
852 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
853 audit_arg_vnode(vp, ARG_VNODE1);
855 VFS_UNLOCK_GIANT(vfslocked);