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;
361 KASSERT(p != NULL, ("audit_arg_process: p == NULL"));
363 PROC_LOCK_ASSERT(p, MA_OWNED);
370 ar->k_ar.ar_arg_auid = cred->cr_audit.ai_auid;
371 ar->k_ar.ar_arg_euid = cred->cr_uid;
372 ar->k_ar.ar_arg_egid = cred->cr_groups[0];
373 ar->k_ar.ar_arg_ruid = cred->cr_ruid;
374 ar->k_ar.ar_arg_rgid = cred->cr_rgid;
375 ar->k_ar.ar_arg_asid = cred->cr_audit.ai_asid;
376 ar->k_ar.ar_arg_termid_addr = cred->cr_audit.ai_termid;
377 ar->k_ar.ar_arg_pid = p->p_pid;
378 ARG_SET_VALID(ar, ARG_AUID | ARG_EUID | ARG_EGID | ARG_RUID |
379 ARG_RGID | ARG_ASID | ARG_TERMID_ADDR | ARG_PID | ARG_PROCESS);
383 audit_arg_signum(u_int signum)
385 struct kaudit_record *ar;
391 ar->k_ar.ar_arg_signum = signum;
392 ARG_SET_VALID(ar, ARG_SIGNUM);
396 audit_arg_socket(int sodomain, int sotype, int soprotocol)
398 struct kaudit_record *ar;
404 ar->k_ar.ar_arg_sockinfo.so_domain = sodomain;
405 ar->k_ar.ar_arg_sockinfo.so_type = sotype;
406 ar->k_ar.ar_arg_sockinfo.so_protocol = soprotocol;
407 ARG_SET_VALID(ar, ARG_SOCKINFO);
411 audit_arg_sockaddr(struct thread *td, struct sockaddr *sa)
413 struct kaudit_record *ar;
415 KASSERT(td != NULL, ("audit_arg_sockaddr: td == NULL"));
416 KASSERT(sa != NULL, ("audit_arg_sockaddr: sa == NULL"));
422 bcopy(sa, &ar->k_ar.ar_arg_sockaddr, sa->sa_len);
423 switch (sa->sa_family) {
425 ARG_SET_VALID(ar, ARG_SADDRINET);
429 ARG_SET_VALID(ar, ARG_SADDRINET6);
433 audit_arg_upath(td, ((struct sockaddr_un *)sa)->sun_path,
435 ARG_SET_VALID(ar, ARG_SADDRUNIX);
437 /* XXXAUDIT: default:? */
442 audit_arg_auid(uid_t auid)
444 struct kaudit_record *ar;
450 ar->k_ar.ar_arg_auid = auid;
451 ARG_SET_VALID(ar, ARG_AUID);
455 audit_arg_auditinfo(struct auditinfo *au_info)
457 struct kaudit_record *ar;
463 ar->k_ar.ar_arg_auid = au_info->ai_auid;
464 ar->k_ar.ar_arg_asid = au_info->ai_asid;
465 ar->k_ar.ar_arg_amask.am_success = au_info->ai_mask.am_success;
466 ar->k_ar.ar_arg_amask.am_failure = au_info->ai_mask.am_failure;
467 ar->k_ar.ar_arg_termid.port = au_info->ai_termid.port;
468 ar->k_ar.ar_arg_termid.machine = au_info->ai_termid.machine;
469 ARG_SET_VALID(ar, ARG_AUID | ARG_ASID | ARG_AMASK | ARG_TERMID);
473 audit_arg_auditinfo_addr(struct auditinfo_addr *au_info)
475 struct kaudit_record *ar;
481 ar->k_ar.ar_arg_auid = au_info->ai_auid;
482 ar->k_ar.ar_arg_asid = au_info->ai_asid;
483 ar->k_ar.ar_arg_amask.am_success = au_info->ai_mask.am_success;
484 ar->k_ar.ar_arg_amask.am_failure = au_info->ai_mask.am_failure;
485 ar->k_ar.ar_arg_termid_addr.at_type = au_info->ai_termid.at_type;
486 ar->k_ar.ar_arg_termid_addr.at_port = au_info->ai_termid.at_port;
487 ar->k_ar.ar_arg_termid_addr.at_addr[0] = au_info->ai_termid.at_addr[0];
488 ar->k_ar.ar_arg_termid_addr.at_addr[1] = au_info->ai_termid.at_addr[1];
489 ar->k_ar.ar_arg_termid_addr.at_addr[2] = au_info->ai_termid.at_addr[2];
490 ar->k_ar.ar_arg_termid_addr.at_addr[3] = au_info->ai_termid.at_addr[3];
491 ARG_SET_VALID(ar, ARG_AUID | ARG_ASID | ARG_AMASK | ARG_TERMID_ADDR);
495 audit_arg_text(char *text)
497 struct kaudit_record *ar;
499 KASSERT(text != NULL, ("audit_arg_text: text == NULL"));
505 /* Invalidate the text string */
506 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_TEXT);
508 if (ar->k_ar.ar_arg_text == NULL)
509 ar->k_ar.ar_arg_text = malloc(MAXPATHLEN, M_AUDITTEXT,
512 strncpy(ar->k_ar.ar_arg_text, text, MAXPATHLEN);
513 ARG_SET_VALID(ar, ARG_TEXT);
517 audit_arg_cmd(int cmd)
519 struct kaudit_record *ar;
525 ar->k_ar.ar_arg_cmd = cmd;
526 ARG_SET_VALID(ar, ARG_CMD);
530 audit_arg_svipc_cmd(int cmd)
532 struct kaudit_record *ar;
538 ar->k_ar.ar_arg_svipc_cmd = cmd;
539 ARG_SET_VALID(ar, ARG_SVIPC_CMD);
543 audit_arg_svipc_perm(struct ipc_perm *perm)
545 struct kaudit_record *ar;
551 bcopy(perm, &ar->k_ar.ar_arg_svipc_perm,
552 sizeof(ar->k_ar.ar_arg_svipc_perm));
553 ARG_SET_VALID(ar, ARG_SVIPC_PERM);
557 audit_arg_svipc_id(int id)
559 struct kaudit_record *ar;
565 ar->k_ar.ar_arg_svipc_id = id;
566 ARG_SET_VALID(ar, ARG_SVIPC_ID);
570 audit_arg_svipc_addr(void * addr)
572 struct kaudit_record *ar;
578 ar->k_ar.ar_arg_svipc_addr = addr;
579 ARG_SET_VALID(ar, ARG_SVIPC_ADDR);
583 audit_arg_posix_ipc_perm(uid_t uid, gid_t gid, mode_t mode)
585 struct kaudit_record *ar;
591 ar->k_ar.ar_arg_pipc_perm.pipc_uid = uid;
592 ar->k_ar.ar_arg_pipc_perm.pipc_gid = gid;
593 ar->k_ar.ar_arg_pipc_perm.pipc_mode = mode;
594 ARG_SET_VALID(ar, ARG_POSIX_IPC_PERM);
598 audit_arg_auditon(union auditon_udata *udata)
600 struct kaudit_record *ar;
606 bcopy((void *)udata, &ar->k_ar.ar_arg_auditon,
607 sizeof(ar->k_ar.ar_arg_auditon));
608 ARG_SET_VALID(ar, ARG_AUDITON);
612 * Audit information about a file, either the file's vnode info, or its
613 * socket address info.
616 audit_arg_file(struct proc *p, struct file *fp)
618 struct kaudit_record *ar;
628 switch (fp->f_type) {
632 * XXXAUDIT: Only possibly to record as first vnode?
635 vfslocked = VFS_LOCK_GIANT(vp->v_mount);
636 vn_lock(vp, LK_SHARED | LK_RETRY, curthread);
637 audit_arg_vnode(vp, ARG_VNODE1);
638 VOP_UNLOCK(vp, 0, curthread);
639 VFS_UNLOCK_GIANT(vfslocked);
643 so = (struct socket *)fp->f_data;
644 if (INP_CHECK_SOCKAF(so, PF_INET)) {
646 ar->k_ar.ar_arg_sockinfo.so_type =
648 ar->k_ar.ar_arg_sockinfo.so_domain =
650 ar->k_ar.ar_arg_sockinfo.so_protocol =
651 so->so_proto->pr_protocol;
653 pcb = (struct inpcb *)so->so_pcb;
655 ar->k_ar.ar_arg_sockinfo.so_raddr =
656 pcb->inp_faddr.s_addr;
657 ar->k_ar.ar_arg_sockinfo.so_laddr =
658 pcb->inp_laddr.s_addr;
659 ar->k_ar.ar_arg_sockinfo.so_rport =
661 ar->k_ar.ar_arg_sockinfo.so_lport =
664 ARG_SET_VALID(ar, ARG_SOCKINFO);
669 /* XXXAUDIT: else? */
675 * Store a path as given by the user process for auditing into the audit
676 * record stored on the user thread. This function will allocate the memory
677 * to store the path info if not already available. This memory will be
678 * freed when the audit record is freed.
680 * XXXAUDIT: Possibly assert that the memory isn't already allocated?
683 audit_arg_upath(struct thread *td, char *upath, u_int64_t flag)
685 struct kaudit_record *ar;
688 KASSERT(td != NULL, ("audit_arg_upath: td == NULL"));
689 KASSERT(upath != NULL, ("audit_arg_upath: upath == NULL"));
695 KASSERT((flag == ARG_UPATH1) || (flag == ARG_UPATH2),
696 ("audit_arg_upath: flag %llu", (unsigned long long)flag));
697 KASSERT((flag != ARG_UPATH1) || (flag != ARG_UPATH2),
698 ("audit_arg_upath: flag %llu", (unsigned long long)flag));
700 if (flag == ARG_UPATH1)
701 pathp = &ar->k_ar.ar_arg_upath1;
703 pathp = &ar->k_ar.ar_arg_upath2;
706 *pathp = malloc(MAXPATHLEN, M_AUDITPATH, M_WAITOK);
708 audit_canon_path(td, upath, *pathp);
710 ARG_SET_VALID(ar, flag);
714 * Function to save the path and vnode attr information into the audit
717 * It is assumed that the caller will hold any vnode locks necessary to
718 * perform a VOP_GETATTR() on the passed vnode.
720 * XXX: The attr code is very similar to vfs_vnops.c:vn_stat(), but always
721 * provides access to the generation number as we need that to construct the
724 * XXX: We should accept the process argument from the caller, since it's
725 * very likely they already have a reference.
727 * XXX: Error handling in this function is poor.
729 * XXXAUDIT: Possibly KASSERT the path pointer is NULL?
732 audit_arg_vnode(struct vnode *vp, u_int64_t flags)
734 struct kaudit_record *ar;
737 struct vnode_au_info *vnp;
739 KASSERT(vp != NULL, ("audit_arg_vnode: vp == NULL"));
740 KASSERT((flags == ARG_VNODE1) || (flags == ARG_VNODE2),
741 ("audit_arg_vnode: flags %jd", (intmax_t)flags));
744 * Assume that if the caller is calling audit_arg_vnode() on a
745 * non-MPSAFE vnode, then it will have acquired Giant.
747 VFS_ASSERT_GIANT(vp->v_mount);
748 ASSERT_VOP_LOCKED(vp, "audit_arg_vnode");
755 * XXXAUDIT: The below clears, and then resets the flags for valid
756 * arguments. Ideally, either the new vnode is used, or the old one
759 if (flags & ARG_VNODE1) {
760 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_VNODE1);
761 vnp = &ar->k_ar.ar_arg_vnode1;
763 ar->k_ar.ar_valid_arg &= (ARG_ALL ^ ARG_VNODE2);
764 vnp = &ar->k_ar.ar_arg_vnode2;
767 error = VOP_GETATTR(vp, &vattr, curthread->td_ucred, curthread);
769 /* XXX: How to handle this case? */
773 vnp->vn_mode = vattr.va_mode;
774 vnp->vn_uid = vattr.va_uid;
775 vnp->vn_gid = vattr.va_gid;
776 vnp->vn_dev = vattr.va_rdev;
777 vnp->vn_fsid = vattr.va_fsid;
778 vnp->vn_fileid = vattr.va_fileid;
779 vnp->vn_gen = vattr.va_gen;
780 if (flags & ARG_VNODE1)
781 ARG_SET_VALID(ar, ARG_VNODE1);
783 ARG_SET_VALID(ar, ARG_VNODE2);
787 * Audit the argument strings passed to exec.
790 audit_arg_argv(char *argv, int argc, int length)
792 struct kaudit_record *ar;
801 ar->k_ar.ar_arg_argv = malloc(length, M_AUDITTEXT, M_WAITOK);
802 bcopy(argv, ar->k_ar.ar_arg_argv, length);
803 ar->k_ar.ar_arg_argc = argc;
804 ARG_SET_VALID(ar, ARG_ARGV);
808 * Audit the environment strings passed to exec.
811 audit_arg_envv(char *envv, int envc, int length)
813 struct kaudit_record *ar;
822 ar->k_ar.ar_arg_envv = malloc(length, M_AUDITTEXT, M_WAITOK);
823 bcopy(envv, ar->k_ar.ar_arg_envv, length);
824 ar->k_ar.ar_arg_envc = envc;
825 ARG_SET_VALID(ar, ARG_ENVV);
829 * The close() system call uses it's own audit call to capture the path/vnode
830 * information because those pieces are not easily obtained within the system
834 audit_sysclose(struct thread *td, int fd)
836 struct kaudit_record *ar;
841 KASSERT(td != NULL, ("audit_sysclose: td == NULL"));
849 if (getvnode(td->td_proc->p_fd, fd, &fp) != 0)
853 vfslocked = VFS_LOCK_GIANT(vp->v_mount);
854 vn_lock(vp, LK_SHARED | LK_RETRY, td);
855 audit_arg_vnode(vp, ARG_VNODE1);
856 VOP_UNLOCK(vp, 0, td);
857 VFS_UNLOCK_GIANT(vfslocked);