1/*
2 * Copyright (c) 2013 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_PROC_UUID_POLICY_H
30#define _SYS_PROC_UUID_POLICY_H
31
32#include <sys/cdefs.h>
33#include <sys/param.h>
34#include <sys/types.h>
35#include <stdint.h>
36#include <uuid/uuid.h>
37
38__BEGIN_DECLS
39
40/*
41 * The proc_uuid_policy subsystem allows a privileged client to
42 * upload policies to the kernel keyed by Mach-O executable
43 * UUID. In-kernel clients can query this policy table cheaply
44 * to determine if a resource or process should by governed
45 * by the policy flags. During early boot, the policy table
46 * may be empty or sparse, which in-kernel clients should
47 * have a specified behavior for.
48 */
49
50#define PROC_UUID_POLICY_OPERATION_CLEAR 0x00000000
51#define PROC_UUID_POLICY_OPERATION_ADD 0x00000001
52#define PROC_UUID_POLICY_OPERATION_REMOVE 0x00000002
53
54/* The namespace of flags are managed by in-kernel clients */
55#define PROC_UUID_POLICY_FLAGS_NONE 0x00000000
56#define PROC_UUID_NO_CELLULAR 0x00000001
57#define PROC_UUID_NECP_APP_POLICY 0x00000002
58#define PROC_UUID_ALT_DYLD_POLICY 0x00000004
59
60/* To be removed, replaced by PROC_UUID_NECP_APP_POLICY */
61#define PROC_UUID_FLOW_DIVERT 0x00000002
62
63#ifdef BSD_KERNEL_PRIVATE
64/*
65 * Look up a policy indexed by UUID.
66 *
67 * Paramaters:
68 * uuid UUID to look up, must be not the zero-uuid
69 * flags Flags that have been associated with the UUID on successful
70 * lookup.
71 * gencount The generation count of the internal policy table representation.
72 *
73 * Initial lookups by an in-kernel subsystem should pass 0 for flags/gencount.
74 * Subsequent lookups for the same UUID with the same flags and gencount passed
75 * in can short-circuit the lookup if the generation count has not changed.
76 *
77 * Return:
78 * 0 Success, UUID was found, flags and gencount are returned
79 * EINVAL Bad UUID or other pointer parameter
80 * ENOENT UUID not found
81 *
82 */
83extern int proc_uuid_policy_lookup(uuid_t uuid, uint32_t *flags, int32_t *gencount);
84
85extern void proc_uuid_policy_init(void);
86
87extern int proc_uuid_policy_kernel(uint32_t operation, uuid_t uuid, uint32_t flags);
88#endif /* BSD_KERNEL_PRIVATE */
89
90#ifndef KERNEL
91/*
92 * Upload a policy indexed by UUID.
93 *
94 * Parameters:
95 * operation CLEAR Clear specified flags for all entries.
96 * Entries are removed if they have no remaining flags.
97 * ADD Add the specified UUID and flags to the policy table.
98 * Flags are ORed with existing entries for the UUID.
99 * REMOVE Mask out flags in the entry for the specified UUID.
100 * Entry is removed if it has no remaining flags.
101 * uuid Pointer to UUID for Mach-O executable
102 * uuidlen sizeof(uuid_t)
103 * flags Flags to be stored in the policy table. See operation notes above.
104 *
105 * Return:
106 * 0 Success, operation completed without error.
107 * -1 Failure, errno can contain:
108 * ENOENT REMOVE operation specified a UUID not in the policy table.
109 * EPERM Call is not privileged to call this system call
110 * EINVAL Invalid parameter
111 * ERANGE Invalid uuidlen
112 * ENOMEM Too many entries exist
113 */
114extern int proc_uuid_policy(uint32_t operation, uuid_t uuid, size_t uuidlen, uint32_t flags);
115#endif /* !KERNEL */
116
117__END_DECLS
118
119#endif /*_SYS_PROC_UUID_POLICY_H */
120