1/*
2 * Copyright (c) 2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29#ifndef _SYS_GUARDED_H_
30#define _SYS_GUARDED_H_
31
32#include <sys/types.h>
33#include <sys/cdefs.h>
34
35#include <sys/_types/_iovec_t.h>
36#ifdef PRIVATE
37
38__BEGIN_DECLS
39
40#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
41
42#ifndef _GUARDID_T
43#define _GUARDID_T
44typedef __uint64_t guardid_t;
45#endif /* _GUARDID_T */
46
47#if !defined(KERNEL)
48extern int guarded_open_np(const char *path,
49	const guardid_t *guard, u_int guardflags, int flags, ...);
50extern int guarded_open_dprotected_np(const char *path,
51	const guardid_t *guard, u_int guardflags, int flags,
52	int dpclass, int dpflags, ...);
53extern int guarded_kqueue_np(const guardid_t *guard, u_int guardflags);
54extern int guarded_close_np(int fd, const guardid_t *guard);
55extern int change_fdguard_np(int fd, const guardid_t *guard, u_int guardflags,
56	const guardid_t *nguard, u_int nguardflags, int *fdflagsp);
57extern user_ssize_t guarded_write_np(int fd, const guardid_t *guard, user_addr_t cbuf, user_size_t nbyte);
58extern user_ssize_t guarded_pwrite_np(int fd, const guardid_t *guard, user_addr_t buf, user_size_t nbyte, off_t offset);
59extern user_ssize_t guarded_writev_np(int fd, const guardid_t *guard, struct iovec *iovp, u_int iovcnt);
60#endif /* KERNEL */
61
62/*
63 * Guard types.
64 *
65 * GUARD_TYPE_FD: Guarded file descriptor.
66 */
67#define	GUARD_TYPE_FD		0x2
68
69/*
70 * File descriptor guard flavors.
71 */
72
73/* Forbid close(2), and the implicit close() that a dup2(2) may do.
74 * Forces close-on-fork to be set immutably too.
75 */
76#define GUARD_CLOSE		(1u << 0)
77
78/*
79 * Forbid dup(2), dup2(2), and fcntl(2) subcodes F_DUPFD, F_DUPFD_CLOEXEC
80 * on a guarded fd. Also forbids open's of a guarded fd via /dev/fd/
81 * (an implicit dup.)
82 */
83#define GUARD_DUP		(1u << 1)
84
85/*
86 * Forbid sending a guarded fd via a socket
87 */
88#define GUARD_SOCKET_IPC	(1u << 2)
89
90/*
91 * Forbid creating a fileport from a guarded fd
92 */
93#define GUARD_FILEPORT		(1u << 3)
94
95/*
96 * Forbid writes on a guarded fd
97 */
98#define GUARD_WRITE		(1u << 4)
99
100/*
101 * Violating a guard results in an error (EPERM), and potentially
102 * an exception with one or more of the following bits set.
103 */
104enum guard_exception_codes {
105	kGUARD_EXC_CLOSE	= 1u << 0,	/* close of a guarded fd */
106	kGUARD_EXC_DUP	   	= 1u << 1,	/* dup of a guarded fd */
107	kGUARD_EXC_NOCLOEXEC	= 1u << 2,	/* clear close-on-exec */
108	kGUARD_EXC_SOCKET_IPC	= 1u << 3,	/* sendmsg of a guarded fd */
109	kGUARD_EXC_FILEPORT   	= 1u << 4,	/* fileport_makeport .. */
110	kGUARD_EXC_MISMATCH	= 1u << 5,	/* wrong guard for guarded fd */
111	kGUARD_EXC_WRITE   	= 1u << 6	/* write on a guarded fd */
112};
113
114#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
115
116__END_DECLS
117
118#endif /* PRIVATE */
119
120#endif /* !_SYS_GUARDED_H_ */
121