1 /* SPDX-License-Identifier: GPL-2.0 */
3 * security/tomoyo/common.h
5 * Header file for TOMOYO.
7 * Copyright (C) 2005-2011 NTT DATA CORPORATION
10 #ifndef _SECURITY_TOMOYO_COMMON_H
11 #define _SECURITY_TOMOYO_COMMON_H
13 #define pr_fmt(fmt) fmt
15 #include <linux/ctype.h>
16 #include <linux/string.h>
18 #include <linux/file.h>
19 #include <linux/kmod.h>
21 #include <linux/sched.h>
22 #include <linux/namei.h>
23 #include <linux/mount.h>
24 #include <linux/list.h>
25 #include <linux/cred.h>
26 #include <linux/poll.h>
27 #include <linux/binfmts.h>
28 #include <linux/highmem.h>
29 #include <linux/net.h>
30 #include <linux/inet.h>
32 #include <linux/in6.h>
34 #include <linux/lsm_hooks.h>
36 #include <net/af_unix.h>
41 /********** Constants definitions. **********/
44 * TOMOYO uses this hash only when appending a string into the string
45 * table. Frequency of appending strings is very low. So we don't need
46 * large (e.g. 64k) hash size. 256 will be sufficient.
48 #define TOMOYO_HASH_BITS 8
49 #define TOMOYO_MAX_HASH (1u<<TOMOYO_HASH_BITS)
52 * TOMOYO checks only SOCK_STREAM, SOCK_DGRAM, SOCK_RAW, SOCK_SEQPACKET.
53 * Therefore, we don't need SOCK_MAX.
55 #define TOMOYO_SOCK_MAX 6
57 #define TOMOYO_EXEC_TMPSIZE 4096
59 /* Garbage collector is trying to kfree() this element. */
60 #define TOMOYO_GC_IN_PROGRESS -1
62 /* Profile number is an integer between 0 and 255. */
63 #define TOMOYO_MAX_PROFILES 256
65 /* Group number is an integer between 0 and 255. */
66 #define TOMOYO_MAX_ACL_GROUPS 256
68 /* Index numbers for "struct tomoyo_condition". */
69 enum tomoyo_conditions_index {
70 TOMOYO_TASK_UID, /* current_uid() */
71 TOMOYO_TASK_EUID, /* current_euid() */
72 TOMOYO_TASK_SUID, /* current_suid() */
73 TOMOYO_TASK_FSUID, /* current_fsuid() */
74 TOMOYO_TASK_GID, /* current_gid() */
75 TOMOYO_TASK_EGID, /* current_egid() */
76 TOMOYO_TASK_SGID, /* current_sgid() */
77 TOMOYO_TASK_FSGID, /* current_fsgid() */
78 TOMOYO_TASK_PID, /* sys_getpid() */
79 TOMOYO_TASK_PPID, /* sys_getppid() */
80 TOMOYO_EXEC_ARGC, /* "struct linux_binprm *"->argc */
81 TOMOYO_EXEC_ENVC, /* "struct linux_binprm *"->envc */
82 TOMOYO_TYPE_IS_SOCKET, /* S_IFSOCK */
83 TOMOYO_TYPE_IS_SYMLINK, /* S_IFLNK */
84 TOMOYO_TYPE_IS_FILE, /* S_IFREG */
85 TOMOYO_TYPE_IS_BLOCK_DEV, /* S_IFBLK */
86 TOMOYO_TYPE_IS_DIRECTORY, /* S_IFDIR */
87 TOMOYO_TYPE_IS_CHAR_DEV, /* S_IFCHR */
88 TOMOYO_TYPE_IS_FIFO, /* S_IFIFO */
89 TOMOYO_MODE_SETUID, /* S_ISUID */
90 TOMOYO_MODE_SETGID, /* S_ISGID */
91 TOMOYO_MODE_STICKY, /* S_ISVTX */
92 TOMOYO_MODE_OWNER_READ, /* S_IRUSR */
93 TOMOYO_MODE_OWNER_WRITE, /* S_IWUSR */
94 TOMOYO_MODE_OWNER_EXECUTE, /* S_IXUSR */
95 TOMOYO_MODE_GROUP_READ, /* S_IRGRP */
96 TOMOYO_MODE_GROUP_WRITE, /* S_IWGRP */
97 TOMOYO_MODE_GROUP_EXECUTE, /* S_IXGRP */
98 TOMOYO_MODE_OTHERS_READ, /* S_IROTH */
99 TOMOYO_MODE_OTHERS_WRITE, /* S_IWOTH */
100 TOMOYO_MODE_OTHERS_EXECUTE, /* S_IXOTH */
101 TOMOYO_EXEC_REALPATH,
102 TOMOYO_SYMLINK_TARGET,
110 TOMOYO_PATH1_DEV_MAJOR,
111 TOMOYO_PATH1_DEV_MINOR,
119 TOMOYO_PATH2_DEV_MAJOR,
120 TOMOYO_PATH2_DEV_MINOR,
121 TOMOYO_PATH1_PARENT_UID,
122 TOMOYO_PATH1_PARENT_GID,
123 TOMOYO_PATH1_PARENT_INO,
124 TOMOYO_PATH1_PARENT_PERM,
125 TOMOYO_PATH2_PARENT_UID,
126 TOMOYO_PATH2_PARENT_GID,
127 TOMOYO_PATH2_PARENT_INO,
128 TOMOYO_PATH2_PARENT_PERM,
129 TOMOYO_MAX_CONDITION_KEYWORD,
137 /* Index numbers for stat(). */
138 enum tomoyo_path_stat_index {
139 /* Do not change this order. */
147 /* Index numbers for operation mode. */
148 enum tomoyo_mode_index {
149 TOMOYO_CONFIG_DISABLED,
150 TOMOYO_CONFIG_LEARNING,
151 TOMOYO_CONFIG_PERMISSIVE,
152 TOMOYO_CONFIG_ENFORCING,
153 TOMOYO_CONFIG_MAX_MODE,
154 TOMOYO_CONFIG_WANT_REJECT_LOG = 64,
155 TOMOYO_CONFIG_WANT_GRANT_LOG = 128,
156 TOMOYO_CONFIG_USE_DEFAULT = 255,
159 /* Index numbers for entry type. */
160 enum tomoyo_policy_id {
162 TOMOYO_ID_ADDRESS_GROUP,
163 TOMOYO_ID_PATH_GROUP,
164 TOMOYO_ID_NUMBER_GROUP,
165 TOMOYO_ID_TRANSITION_CONTROL,
166 TOMOYO_ID_AGGREGATOR,
175 /* Index numbers for domain's attributes. */
176 enum tomoyo_domain_info_flags_index {
177 /* Quota warnning flag. */
178 TOMOYO_DIF_QUOTA_WARNED,
180 * This domain was unable to create a new domain at
181 * tomoyo_find_next_domain() because the name of the domain to be
182 * created was too long or it could not allocate memory.
183 * More than one process continued execve() without domain transition.
185 TOMOYO_DIF_TRANSITION_FAILED,
186 TOMOYO_MAX_DOMAIN_INFO_FLAGS
189 /* Index numbers for audit type. */
190 enum tomoyo_grant_log {
191 /* Follow profile's configuration. */
192 TOMOYO_GRANTLOG_AUTO,
193 /* Do not generate grant log. */
195 /* Generate grant_log. */
199 /* Index numbers for group entries. */
200 enum tomoyo_group_id {
203 TOMOYO_ADDRESS_GROUP,
207 /* Index numbers for type of numeric values. */
208 enum tomoyo_value_type {
209 TOMOYO_VALUE_TYPE_INVALID,
210 TOMOYO_VALUE_TYPE_DECIMAL,
211 TOMOYO_VALUE_TYPE_OCTAL,
212 TOMOYO_VALUE_TYPE_HEXADECIMAL,
215 /* Index numbers for domain transition control keywords. */
216 enum tomoyo_transition_type {
217 /* Do not change this order, */
218 TOMOYO_TRANSITION_CONTROL_NO_RESET,
219 TOMOYO_TRANSITION_CONTROL_RESET,
220 TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
221 TOMOYO_TRANSITION_CONTROL_INITIALIZE,
222 TOMOYO_TRANSITION_CONTROL_NO_KEEP,
223 TOMOYO_TRANSITION_CONTROL_KEEP,
224 TOMOYO_MAX_TRANSITION_TYPE
227 /* Index numbers for Access Controls. */
228 enum tomoyo_acl_entry_type_index {
229 TOMOYO_TYPE_PATH_ACL,
230 TOMOYO_TYPE_PATH2_ACL,
231 TOMOYO_TYPE_PATH_NUMBER_ACL,
232 TOMOYO_TYPE_MKDEV_ACL,
233 TOMOYO_TYPE_MOUNT_ACL,
234 TOMOYO_TYPE_INET_ACL,
235 TOMOYO_TYPE_UNIX_ACL,
237 TOMOYO_TYPE_MANUAL_TASK_ACL,
240 /* Index numbers for access controls with one pathname. */
241 enum tomoyo_path_acl_index {
249 TOMOYO_TYPE_TRUNCATE,
253 TOMOYO_MAX_PATH_OPERATION
256 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
257 enum tomoyo_memory_stat_type {
258 TOMOYO_MEMORY_POLICY,
261 TOMOYO_MAX_MEMORY_STAT
264 enum tomoyo_mkdev_acl_index {
267 TOMOYO_MAX_MKDEV_OPERATION
270 /* Index numbers for socket operations. */
271 enum tomoyo_network_acl_index {
272 TOMOYO_NETWORK_BIND, /* bind() operation. */
273 TOMOYO_NETWORK_LISTEN, /* listen() operation. */
274 TOMOYO_NETWORK_CONNECT, /* connect() operation. */
275 TOMOYO_NETWORK_SEND, /* send() operation. */
276 TOMOYO_MAX_NETWORK_OPERATION
279 /* Index numbers for access controls with two pathnames. */
280 enum tomoyo_path2_acl_index {
283 TOMOYO_TYPE_PIVOT_ROOT,
284 TOMOYO_MAX_PATH2_OPERATION
287 /* Index numbers for access controls with one pathname and one number. */
288 enum tomoyo_path_number_acl_index {
297 TOMOYO_MAX_PATH_NUMBER_OPERATION
300 /* Index numbers for /sys/kernel/security/tomoyo/ interfaces. */
301 enum tomoyo_securityfs_interface_index {
303 TOMOYO_EXCEPTIONPOLICY,
304 TOMOYO_PROCESS_STATUS,
313 /* Index numbers for special mount operations. */
314 enum tomoyo_special_mount {
315 TOMOYO_MOUNT_BIND, /* mount --bind /source /dest */
316 TOMOYO_MOUNT_MOVE, /* mount --move /old /new */
317 TOMOYO_MOUNT_REMOUNT, /* mount -o remount /dir */
318 TOMOYO_MOUNT_MAKE_UNBINDABLE, /* mount --make-unbindable /dir */
319 TOMOYO_MOUNT_MAKE_PRIVATE, /* mount --make-private /dir */
320 TOMOYO_MOUNT_MAKE_SLAVE, /* mount --make-slave /dir */
321 TOMOYO_MOUNT_MAKE_SHARED, /* mount --make-shared /dir */
322 TOMOYO_MAX_SPECIAL_MOUNT
325 /* Index numbers for functionality. */
326 enum tomoyo_mac_index {
327 TOMOYO_MAC_FILE_EXECUTE,
328 TOMOYO_MAC_FILE_OPEN,
329 TOMOYO_MAC_FILE_CREATE,
330 TOMOYO_MAC_FILE_UNLINK,
331 TOMOYO_MAC_FILE_GETATTR,
332 TOMOYO_MAC_FILE_MKDIR,
333 TOMOYO_MAC_FILE_RMDIR,
334 TOMOYO_MAC_FILE_MKFIFO,
335 TOMOYO_MAC_FILE_MKSOCK,
336 TOMOYO_MAC_FILE_TRUNCATE,
337 TOMOYO_MAC_FILE_SYMLINK,
338 TOMOYO_MAC_FILE_MKBLOCK,
339 TOMOYO_MAC_FILE_MKCHAR,
340 TOMOYO_MAC_FILE_LINK,
341 TOMOYO_MAC_FILE_RENAME,
342 TOMOYO_MAC_FILE_CHMOD,
343 TOMOYO_MAC_FILE_CHOWN,
344 TOMOYO_MAC_FILE_CHGRP,
345 TOMOYO_MAC_FILE_IOCTL,
346 TOMOYO_MAC_FILE_CHROOT,
347 TOMOYO_MAC_FILE_MOUNT,
348 TOMOYO_MAC_FILE_UMOUNT,
349 TOMOYO_MAC_FILE_PIVOT_ROOT,
350 TOMOYO_MAC_NETWORK_INET_STREAM_BIND,
351 TOMOYO_MAC_NETWORK_INET_STREAM_LISTEN,
352 TOMOYO_MAC_NETWORK_INET_STREAM_CONNECT,
353 TOMOYO_MAC_NETWORK_INET_DGRAM_BIND,
354 TOMOYO_MAC_NETWORK_INET_DGRAM_SEND,
355 TOMOYO_MAC_NETWORK_INET_RAW_BIND,
356 TOMOYO_MAC_NETWORK_INET_RAW_SEND,
357 TOMOYO_MAC_NETWORK_UNIX_STREAM_BIND,
358 TOMOYO_MAC_NETWORK_UNIX_STREAM_LISTEN,
359 TOMOYO_MAC_NETWORK_UNIX_STREAM_CONNECT,
360 TOMOYO_MAC_NETWORK_UNIX_DGRAM_BIND,
361 TOMOYO_MAC_NETWORK_UNIX_DGRAM_SEND,
362 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_BIND,
363 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_LISTEN,
364 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_CONNECT,
369 /* Index numbers for category of functionality. */
370 enum tomoyo_mac_category_index {
371 TOMOYO_MAC_CATEGORY_FILE,
372 TOMOYO_MAC_CATEGORY_NETWORK,
373 TOMOYO_MAC_CATEGORY_MISC,
374 TOMOYO_MAX_MAC_CATEGORY_INDEX
378 * Retry this request. Returned by tomoyo_supervisor() if policy violation has
379 * occurred in enforcing mode and the userspace daemon decided to retry.
381 * We must choose a positive value in order to distinguish "granted" (which is
382 * 0) and "rejected" (which is a negative value) and "retry".
384 #define TOMOYO_RETRY_REQUEST 1
386 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
387 enum tomoyo_policy_stat_type {
388 /* Do not change this order. */
389 TOMOYO_STAT_POLICY_UPDATES,
390 TOMOYO_STAT_POLICY_LEARNING, /* == TOMOYO_CONFIG_LEARNING */
391 TOMOYO_STAT_POLICY_PERMISSIVE, /* == TOMOYO_CONFIG_PERMISSIVE */
392 TOMOYO_STAT_POLICY_ENFORCING, /* == TOMOYO_CONFIG_ENFORCING */
393 TOMOYO_MAX_POLICY_STAT
396 /* Index numbers for profile's PREFERENCE values. */
397 enum tomoyo_pref_index {
398 TOMOYO_PREF_MAX_AUDIT_LOG,
399 TOMOYO_PREF_MAX_LEARNING_ENTRY,
403 /********** Structure definitions. **********/
405 /* Common header for holding ACL entries. */
406 struct tomoyo_acl_head {
407 struct list_head list;
408 s8 is_deleted; /* true or false or TOMOYO_GC_IN_PROGRESS */
411 /* Common header for shared entries. */
412 struct tomoyo_shared_acl_head {
413 struct list_head list;
417 struct tomoyo_policy_namespace;
419 /* Structure for request info. */
420 struct tomoyo_request_info {
422 * For holding parameters specific to operations which deal files.
423 * NULL if not dealing files.
425 struct tomoyo_obj_info *obj;
427 * For holding parameters specific to execve() request.
428 * NULL if not dealing execve().
430 struct tomoyo_execve *ee;
431 struct tomoyo_domain_info *domain;
432 /* For holding parameters. */
435 const struct tomoyo_path_info *filename;
436 /* For using wildcards at tomoyo_find_next_domain(). */
437 const struct tomoyo_path_info *matched_path;
438 /* One of values in "enum tomoyo_path_acl_index". */
442 const struct tomoyo_path_info *filename1;
443 const struct tomoyo_path_info *filename2;
444 /* One of values in "enum tomoyo_path2_acl_index". */
448 const struct tomoyo_path_info *filename;
452 /* One of values in "enum tomoyo_mkdev_acl_index". */
456 const struct tomoyo_path_info *filename;
457 unsigned long number;
460 * "enum tomoyo_path_number_acl_index".
465 const struct tomoyo_path_info *name;
468 const __be32 *address;
470 /* One of values smaller than TOMOYO_SOCK_MAX. */
472 /* One of values in "enum tomoyo_network_acl_index". */
477 const struct tomoyo_path_info *address;
478 /* One of values smaller than TOMOYO_SOCK_MAX. */
480 /* One of values in "enum tomoyo_network_acl_index". */
484 const struct tomoyo_path_info *type;
485 const struct tomoyo_path_info *dir;
486 const struct tomoyo_path_info *dev;
491 const struct tomoyo_path_info *domainname;
494 struct tomoyo_acl_info *matched_acl;
499 u8 mode; /* One of tomoyo_mode_index . */
503 /* Structure for holding a token. */
504 struct tomoyo_path_info {
506 u32 hash; /* = full_name_hash(name, strlen(name)) */
507 u16 const_len; /* = tomoyo_const_part_length(name) */
508 bool is_dir; /* = tomoyo_strendswith(name, "/") */
509 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
512 /* Structure for holding string data. */
514 struct tomoyo_shared_acl_head head;
515 struct tomoyo_path_info entry;
518 /* Structure for holding a word. */
519 struct tomoyo_name_union {
520 /* Either @filename or @group is NULL. */
521 const struct tomoyo_path_info *filename;
522 struct tomoyo_group *group;
525 /* Structure for holding a number. */
526 struct tomoyo_number_union {
527 unsigned long values[2];
528 struct tomoyo_group *group; /* Maybe NULL. */
529 /* One of values in "enum tomoyo_value_type". */
533 /* Structure for holding an IP address. */
534 struct tomoyo_ipaddr_union {
535 struct in6_addr ip[2]; /* Big endian. */
536 struct tomoyo_group *group; /* Pointer to address group. */
537 bool is_ipv6; /* Valid only if @group == NULL. */
540 /* Structure for "path_group"/"number_group"/"address_group" directive. */
541 struct tomoyo_group {
542 struct tomoyo_shared_acl_head head;
543 const struct tomoyo_path_info *group_name;
544 struct list_head member_list;
547 /* Structure for "path_group" directive. */
548 struct tomoyo_path_group {
549 struct tomoyo_acl_head head;
550 const struct tomoyo_path_info *member_name;
553 /* Structure for "number_group" directive. */
554 struct tomoyo_number_group {
555 struct tomoyo_acl_head head;
556 struct tomoyo_number_union number;
559 /* Structure for "address_group" directive. */
560 struct tomoyo_address_group {
561 struct tomoyo_acl_head head;
562 /* Structure for holding an IP address. */
563 struct tomoyo_ipaddr_union address;
566 /* Subset of "struct stat". Used by conditional ACL and audit logs. */
567 struct tomoyo_mini_stat {
576 /* Structure for dumping argv[] and envp[] of "struct linux_binprm". */
577 struct tomoyo_page_dump {
578 struct page *page; /* Previously dumped page. */
579 char *data; /* Contents of "page". Size is PAGE_SIZE. */
582 /* Structure for attribute checks in addition to pathname checks. */
583 struct tomoyo_obj_info {
585 * True if tomoyo_get_attributes() was already called, false otherwise.
588 /* True if @stat[] is valid. */
589 bool stat_valid[TOMOYO_MAX_PATH_STAT];
590 /* First pathname. Initialized with { NULL, NULL } if no path. */
592 /* Second pathname. Initialized with { NULL, NULL } if no path. */
595 * Information on @path1, @path1's parent directory, @path2, @path2's
598 struct tomoyo_mini_stat stat[TOMOYO_MAX_PATH_STAT];
600 * Content of symbolic link to be created. NULL for operations other
603 struct tomoyo_path_info *symlink_target;
606 /* Structure for argv[]. */
609 const struct tomoyo_path_info *value;
613 /* Structure for envp[]. */
615 const struct tomoyo_path_info *name;
616 const struct tomoyo_path_info *value;
620 /* Structure for execve() operation. */
621 struct tomoyo_execve {
622 struct tomoyo_request_info r;
623 struct tomoyo_obj_info obj;
624 struct linux_binprm *bprm;
625 const struct tomoyo_path_info *transition;
626 /* For dumping argv[] and envp[]. */
627 struct tomoyo_page_dump dump;
628 /* For temporary use. */
629 char *tmp; /* Size is TOMOYO_EXEC_TMPSIZE bytes */
632 /* Structure for entries which follows "struct tomoyo_condition". */
633 struct tomoyo_condition_element {
635 * Left hand operand. A "struct tomoyo_argv" for TOMOYO_ARGV_ENTRY, a
636 * "struct tomoyo_envp" for TOMOYO_ENVP_ENTRY is attached to the tail
637 * of the array of this struct.
641 * Right hand operand. A "struct tomoyo_number_union" for
642 * TOMOYO_NUMBER_UNION, a "struct tomoyo_name_union" for
643 * TOMOYO_NAME_UNION is attached to the tail of the array of this
647 /* Equation operator. True if equals or overlaps, false otherwise. */
651 /* Structure for optional arguments. */
652 struct tomoyo_condition {
653 struct tomoyo_shared_acl_head head;
654 u32 size; /* Memory size allocated for this entry. */
655 u16 condc; /* Number of conditions in this struct. */
656 u16 numbers_count; /* Number of "struct tomoyo_number_union values". */
657 u16 names_count; /* Number of "struct tomoyo_name_union names". */
658 u16 argc; /* Number of "struct tomoyo_argv". */
659 u16 envc; /* Number of "struct tomoyo_envp". */
660 u8 grant_log; /* One of values in "enum tomoyo_grant_log". */
661 const struct tomoyo_path_info *transit; /* Maybe NULL. */
663 * struct tomoyo_condition_element condition[condc];
664 * struct tomoyo_number_union values[numbers_count];
665 * struct tomoyo_name_union names[names_count];
666 * struct tomoyo_argv argv[argc];
667 * struct tomoyo_envp envp[envc];
671 /* Common header for individual entries. */
672 struct tomoyo_acl_info {
673 struct list_head list;
674 struct tomoyo_condition *cond; /* Maybe NULL. */
675 s8 is_deleted; /* true or false or TOMOYO_GC_IN_PROGRESS */
676 u8 type; /* One of values in "enum tomoyo_acl_entry_type_index". */
679 /* Structure for domain information. */
680 struct tomoyo_domain_info {
681 struct list_head list;
682 struct list_head acl_info_list;
683 /* Name of this domain. Never NULL. */
684 const struct tomoyo_path_info *domainname;
685 /* Namespace for this domain. Never NULL. */
686 struct tomoyo_policy_namespace *ns;
687 /* Group numbers to use. */
688 unsigned long group[TOMOYO_MAX_ACL_GROUPS / BITS_PER_LONG];
689 u8 profile; /* Profile number to use. */
690 bool is_deleted; /* Delete flag. */
691 bool flags[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
692 atomic_t users; /* Number of referring tasks. */
696 * Structure for "task manual_domain_transition" directive.
698 struct tomoyo_task_acl {
699 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MANUAL_TASK_ACL */
700 /* Pointer to domainname. */
701 const struct tomoyo_path_info *domainname;
705 * Structure for "file execute", "file read", "file write", "file append",
706 * "file unlink", "file getattr", "file rmdir", "file truncate",
707 * "file symlink", "file chroot" and "file unmount" directive.
709 struct tomoyo_path_acl {
710 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
711 u16 perm; /* Bitmask of values in "enum tomoyo_path_acl_index". */
712 struct tomoyo_name_union name;
716 * Structure for "file create", "file mkdir", "file mkfifo", "file mksock",
717 * "file ioctl", "file chmod", "file chown" and "file chgrp" directive.
719 struct tomoyo_path_number_acl {
720 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
721 /* Bitmask of values in "enum tomoyo_path_number_acl_index". */
723 struct tomoyo_name_union name;
724 struct tomoyo_number_union number;
727 /* Structure for "file mkblock" and "file mkchar" directive. */
728 struct tomoyo_mkdev_acl {
729 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
730 u8 perm; /* Bitmask of values in "enum tomoyo_mkdev_acl_index". */
731 struct tomoyo_name_union name;
732 struct tomoyo_number_union mode;
733 struct tomoyo_number_union major;
734 struct tomoyo_number_union minor;
738 * Structure for "file rename", "file link" and "file pivot_root" directive.
740 struct tomoyo_path2_acl {
741 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
742 u8 perm; /* Bitmask of values in "enum tomoyo_path2_acl_index". */
743 struct tomoyo_name_union name1;
744 struct tomoyo_name_union name2;
747 /* Structure for "file mount" directive. */
748 struct tomoyo_mount_acl {
749 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
750 struct tomoyo_name_union dev_name;
751 struct tomoyo_name_union dir_name;
752 struct tomoyo_name_union fs_type;
753 struct tomoyo_number_union flags;
756 /* Structure for "misc env" directive in domain policy. */
757 struct tomoyo_env_acl {
758 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_ENV_ACL */
759 const struct tomoyo_path_info *env; /* environment variable */
762 /* Structure for "network inet" directive. */
763 struct tomoyo_inet_acl {
764 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_INET_ACL */
766 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
767 struct tomoyo_ipaddr_union address;
768 struct tomoyo_number_union port;
771 /* Structure for "network unix" directive. */
772 struct tomoyo_unix_acl {
773 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_UNIX_ACL */
775 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
776 struct tomoyo_name_union name;
779 /* Structure for holding a line from /sys/kernel/security/tomoyo/ interface. */
780 struct tomoyo_acl_param {
782 struct list_head *list;
783 struct tomoyo_policy_namespace *ns;
787 #define TOMOYO_MAX_IO_READ_QUEUE 64
790 * Structure for reading/writing policy via /sys/kernel/security/tomoyo
793 struct tomoyo_io_buffer {
794 void (*read)(struct tomoyo_io_buffer *head);
795 int (*write)(struct tomoyo_io_buffer *head);
796 __poll_t (*poll)(struct file *file, poll_table *wait);
797 /* Exclusive lock for this structure. */
799 char __user *read_user_buf;
800 size_t read_user_buf_avail;
802 struct list_head *ns;
803 struct list_head *domain;
804 struct list_head *group;
805 struct list_head *acl;
808 unsigned int query_index;
816 bool print_this_domain_only;
817 bool print_transition_related_only;
818 bool print_cond_part;
819 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
822 struct tomoyo_policy_namespace *ns;
823 /* The position currently writing to. */
824 struct tomoyo_domain_info *domain;
825 /* Bytes available for writing. */
829 /* Buffer for reading. */
831 /* Size of read buffer. */
833 /* Buffer for writing. */
835 /* Size of write buffer. */
836 size_t writebuf_size;
837 /* Type of this interface. */
838 enum tomoyo_securityfs_interface_index type;
839 /* Users counter protected by tomoyo_io_buffer_list_lock. */
841 /* List for telling GC not to kfree() elements. */
842 struct list_head list;
846 * Structure for "initialize_domain"/"no_initialize_domain"/"keep_domain"/
847 * "no_keep_domain" keyword.
849 struct tomoyo_transition_control {
850 struct tomoyo_acl_head head;
851 u8 type; /* One of values in "enum tomoyo_transition_type". */
852 /* True if the domainname is tomoyo_get_last_name(). */
854 const struct tomoyo_path_info *domainname; /* Maybe NULL */
855 const struct tomoyo_path_info *program; /* Maybe NULL */
858 /* Structure for "aggregator" keyword. */
859 struct tomoyo_aggregator {
860 struct tomoyo_acl_head head;
861 const struct tomoyo_path_info *original_name;
862 const struct tomoyo_path_info *aggregated_name;
865 /* Structure for policy manager. */
866 struct tomoyo_manager {
867 struct tomoyo_acl_head head;
868 /* A path to program or a domainname. */
869 const struct tomoyo_path_info *manager;
872 struct tomoyo_preference {
873 unsigned int learning_max_entry;
874 bool enforcing_verbose;
875 bool learning_verbose;
876 bool permissive_verbose;
879 /* Structure for /sys/kernel/security/tomnoyo/profile interface. */
880 struct tomoyo_profile {
881 const struct tomoyo_path_info *comment;
882 struct tomoyo_preference *learning;
883 struct tomoyo_preference *permissive;
884 struct tomoyo_preference *enforcing;
885 struct tomoyo_preference preference;
887 u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
888 unsigned int pref[TOMOYO_MAX_PREF];
891 /* Structure for representing YYYY/MM/DD hh/mm/ss. */
901 /* Structure for policy namespace. */
902 struct tomoyo_policy_namespace {
903 /* Profile table. Memory is allocated as needed. */
904 struct tomoyo_profile *profile_ptr[TOMOYO_MAX_PROFILES];
905 /* List of "struct tomoyo_group". */
906 struct list_head group_list[TOMOYO_MAX_GROUP];
907 /* List of policy. */
908 struct list_head policy_list[TOMOYO_MAX_POLICY];
909 /* The global ACL referred by "use_group" keyword. */
910 struct list_head acl_group[TOMOYO_MAX_ACL_GROUPS];
911 /* List for connecting to tomoyo_namespace_list list. */
912 struct list_head namespace_list;
913 /* Profile version. Currently only 20150505 is defined. */
914 unsigned int profile_version;
915 /* Name of this namespace (e.g. "<kernel>", "</usr/sbin/httpd>" ). */
919 /* Structure for "struct task_struct"->security. */
921 struct tomoyo_domain_info *domain_info;
922 struct tomoyo_domain_info *old_domain_info;
925 /********** Function prototypes. **********/
927 bool tomoyo_address_matches_group(const bool is_ipv6, const __be32 *address,
928 const struct tomoyo_group *group);
929 bool tomoyo_compare_number_union(const unsigned long value,
930 const struct tomoyo_number_union *ptr);
931 bool tomoyo_condition(struct tomoyo_request_info *r,
932 const struct tomoyo_condition *cond);
933 bool tomoyo_correct_domain(const unsigned char *domainname);
934 bool tomoyo_correct_path(const char *filename);
935 bool tomoyo_correct_word(const char *string);
936 bool tomoyo_domain_def(const unsigned char *buffer);
937 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
938 bool tomoyo_dump_page(struct linux_binprm *bprm, unsigned long pos,
939 struct tomoyo_page_dump *dump);
940 bool tomoyo_memory_ok(void *ptr);
941 bool tomoyo_number_matches_group(const unsigned long min,
942 const unsigned long max,
943 const struct tomoyo_group *group);
944 bool tomoyo_parse_ipaddr_union(struct tomoyo_acl_param *param,
945 struct tomoyo_ipaddr_union *ptr);
946 bool tomoyo_parse_name_union(struct tomoyo_acl_param *param,
947 struct tomoyo_name_union *ptr);
948 bool tomoyo_parse_number_union(struct tomoyo_acl_param *param,
949 struct tomoyo_number_union *ptr);
950 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
951 const struct tomoyo_path_info *pattern);
952 bool tomoyo_permstr(const char *string, const char *keyword);
953 bool tomoyo_str_starts(char **src, const char *find);
954 char *tomoyo_encode(const char *str);
955 char *tomoyo_encode2(const char *str, int str_len);
956 char *tomoyo_init_log(struct tomoyo_request_info *r, int len, const char *fmt,
958 char *tomoyo_read_token(struct tomoyo_acl_param *param);
959 char *tomoyo_realpath_from_path(const struct path *path);
960 char *tomoyo_realpath_nofollow(const char *pathname);
961 const char *tomoyo_get_exe(void);
962 const char *tomoyo_yesno(const unsigned int value);
963 const struct tomoyo_path_info *tomoyo_compare_name_union
964 (const struct tomoyo_path_info *name, const struct tomoyo_name_union *ptr);
965 const struct tomoyo_path_info *tomoyo_get_domainname
966 (struct tomoyo_acl_param *param);
967 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
968 const struct tomoyo_path_info *tomoyo_path_matches_group
969 (const struct tomoyo_path_info *pathname, const struct tomoyo_group *group);
970 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
971 const struct path *path, const int flag);
972 void tomoyo_close_control(struct tomoyo_io_buffer *head);
973 int tomoyo_env_perm(struct tomoyo_request_info *r, const char *env);
974 int tomoyo_execute_permission(struct tomoyo_request_info *r,
975 const struct tomoyo_path_info *filename);
976 int tomoyo_find_next_domain(struct linux_binprm *bprm);
977 int tomoyo_get_mode(const struct tomoyo_policy_namespace *ns, const u8 profile,
979 int tomoyo_init_request_info(struct tomoyo_request_info *r,
980 struct tomoyo_domain_info *domain,
982 int tomoyo_mkdev_perm(const u8 operation, const struct path *path,
983 const unsigned int mode, unsigned int dev);
984 int tomoyo_mount_permission(const char *dev_name, const struct path *path,
985 const char *type, unsigned long flags,
987 int tomoyo_open_control(const u8 type, struct file *file);
988 int tomoyo_path2_perm(const u8 operation, const struct path *path1,
989 const struct path *path2);
990 int tomoyo_path_number_perm(const u8 operation, const struct path *path,
991 unsigned long number);
992 int tomoyo_path_perm(const u8 operation, const struct path *path,
994 __poll_t tomoyo_poll_control(struct file *file, poll_table *wait);
995 __poll_t tomoyo_poll_log(struct file *file, poll_table *wait);
996 int tomoyo_socket_bind_permission(struct socket *sock, struct sockaddr *addr,
998 int tomoyo_socket_connect_permission(struct socket *sock,
999 struct sockaddr *addr, int addr_len);
1000 int tomoyo_socket_listen_permission(struct socket *sock);
1001 int tomoyo_socket_sendmsg_permission(struct socket *sock, struct msghdr *msg,
1003 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
1005 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
1006 struct tomoyo_acl_param *param,
1007 bool (*check_duplicate)
1008 (const struct tomoyo_acl_info *,
1009 const struct tomoyo_acl_info *),
1010 bool (*merge_duplicate)
1011 (struct tomoyo_acl_info *, struct tomoyo_acl_info *,
1013 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
1014 struct tomoyo_acl_param *param,
1015 bool (*check_duplicate)
1016 (const struct tomoyo_acl_head *,
1017 const struct tomoyo_acl_head *));
1018 int tomoyo_write_aggregator(struct tomoyo_acl_param *param);
1019 int tomoyo_write_file(struct tomoyo_acl_param *param);
1020 int tomoyo_write_group(struct tomoyo_acl_param *param, const u8 type);
1021 int tomoyo_write_misc(struct tomoyo_acl_param *param);
1022 int tomoyo_write_inet_network(struct tomoyo_acl_param *param);
1023 int tomoyo_write_transition_control(struct tomoyo_acl_param *param,
1025 int tomoyo_write_unix_network(struct tomoyo_acl_param *param);
1026 ssize_t tomoyo_read_control(struct tomoyo_io_buffer *head, char __user *buffer,
1027 const int buffer_len);
1028 ssize_t tomoyo_write_control(struct tomoyo_io_buffer *head,
1029 const char __user *buffer, const int buffer_len);
1030 struct tomoyo_condition *tomoyo_get_condition(struct tomoyo_acl_param *param);
1031 struct tomoyo_domain_info *tomoyo_assign_domain(const char *domainname,
1032 const bool transit);
1033 struct tomoyo_domain_info *tomoyo_domain(void);
1034 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
1035 struct tomoyo_group *tomoyo_get_group(struct tomoyo_acl_param *param,
1037 struct tomoyo_policy_namespace *tomoyo_assign_namespace
1038 (const char *domainname);
1039 struct tomoyo_profile *tomoyo_profile(const struct tomoyo_policy_namespace *ns,
1041 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
1043 u8 tomoyo_parse_ulong(unsigned long *result, char **str);
1044 void *tomoyo_commit_ok(void *data, const unsigned int size);
1045 void __init tomoyo_load_builtin_policy(void);
1046 void __init tomoyo_mm_init(void);
1047 void tomoyo_check_acl(struct tomoyo_request_info *r,
1048 bool (*check_entry)(struct tomoyo_request_info *,
1049 const struct tomoyo_acl_info *));
1050 void tomoyo_check_profile(void);
1051 void tomoyo_convert_time(time64_t time, struct tomoyo_time *stamp);
1052 void tomoyo_del_condition(struct list_head *element);
1053 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
1054 void tomoyo_get_attributes(struct tomoyo_obj_info *obj);
1055 void tomoyo_init_policy_namespace(struct tomoyo_policy_namespace *ns);
1056 void tomoyo_load_policy(const char *filename);
1057 void tomoyo_normalize_line(unsigned char *buffer);
1058 void tomoyo_notify_gc(struct tomoyo_io_buffer *head, const bool is_register);
1059 void tomoyo_print_ip(char *buf, const unsigned int size,
1060 const struct tomoyo_ipaddr_union *ptr);
1061 void tomoyo_print_ulong(char *buffer, const int buffer_len,
1062 const unsigned long value, const u8 type);
1063 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
1064 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
1065 void tomoyo_read_log(struct tomoyo_io_buffer *head);
1066 void tomoyo_update_stat(const u8 index);
1067 void tomoyo_warn_oom(const char *function);
1068 void tomoyo_write_log(struct tomoyo_request_info *r, const char *fmt, ...)
1070 void tomoyo_write_log2(struct tomoyo_request_info *r, int len, const char *fmt,
1073 /********** External variable definitions. **********/
1075 extern bool tomoyo_policy_loaded;
1076 extern int tomoyo_enabled;
1077 extern const char * const tomoyo_condition_keyword
1078 [TOMOYO_MAX_CONDITION_KEYWORD];
1079 extern const char * const tomoyo_dif[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
1080 extern const char * const tomoyo_mac_keywords[TOMOYO_MAX_MAC_INDEX
1081 + TOMOYO_MAX_MAC_CATEGORY_INDEX];
1082 extern const char * const tomoyo_mode[TOMOYO_CONFIG_MAX_MODE];
1083 extern const char * const tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
1084 extern const char * const tomoyo_proto_keyword[TOMOYO_SOCK_MAX];
1085 extern const char * const tomoyo_socket_keyword[TOMOYO_MAX_NETWORK_OPERATION];
1086 extern const u8 tomoyo_index2category[TOMOYO_MAX_MAC_INDEX];
1087 extern const u8 tomoyo_pn2mac[TOMOYO_MAX_PATH_NUMBER_OPERATION];
1088 extern const u8 tomoyo_pnnn2mac[TOMOYO_MAX_MKDEV_OPERATION];
1089 extern const u8 tomoyo_pp2mac[TOMOYO_MAX_PATH2_OPERATION];
1090 extern struct list_head tomoyo_condition_list;
1091 extern struct list_head tomoyo_domain_list;
1092 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
1093 extern struct list_head tomoyo_namespace_list;
1094 extern struct mutex tomoyo_policy_lock;
1095 extern struct srcu_struct tomoyo_ss;
1096 extern struct tomoyo_domain_info tomoyo_kernel_domain;
1097 extern struct tomoyo_policy_namespace tomoyo_kernel_namespace;
1098 extern unsigned int tomoyo_memory_quota[TOMOYO_MAX_MEMORY_STAT];
1099 extern unsigned int tomoyo_memory_used[TOMOYO_MAX_MEMORY_STAT];
1100 extern struct lsm_blob_sizes tomoyo_blob_sizes;
1102 /********** Inlined functions. **********/
1105 * tomoyo_read_lock - Take lock for protecting policy.
1107 * Returns index number for tomoyo_read_unlock().
1109 static inline int tomoyo_read_lock(void)
1111 return srcu_read_lock(&tomoyo_ss);
1115 * tomoyo_read_unlock - Release lock for protecting policy.
1117 * @idx: Index number returned by tomoyo_read_lock().
1121 static inline void tomoyo_read_unlock(int idx)
1123 srcu_read_unlock(&tomoyo_ss, idx);
1127 * tomoyo_sys_getppid - Copy of getppid().
1129 * Returns parent process's PID.
1131 * Alpha does not have getppid() defined. To be able to build this module on
1132 * Alpha, I have to copy getppid() from kernel/timer.c.
1134 static inline pid_t tomoyo_sys_getppid(void)
1139 pid = task_tgid_vnr(rcu_dereference(current->real_parent));
1145 * tomoyo_sys_getpid - Copy of getpid().
1147 * Returns current thread's PID.
1149 * Alpha does not have getpid() defined. To be able to build this module on
1150 * Alpha, I have to copy getpid() from kernel/timer.c.
1152 static inline pid_t tomoyo_sys_getpid(void)
1154 return task_tgid_vnr(current);
1158 * tomoyo_pathcmp - strcmp() for "struct tomoyo_path_info" structure.
1160 * @a: Pointer to "struct tomoyo_path_info".
1161 * @b: Pointer to "struct tomoyo_path_info".
1163 * Returns true if @a == @b, false otherwise.
1165 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
1166 const struct tomoyo_path_info *b)
1168 return a->hash != b->hash || strcmp(a->name, b->name);
1172 * tomoyo_put_name - Drop reference on "struct tomoyo_name".
1174 * @name: Pointer to "struct tomoyo_path_info". Maybe NULL.
1178 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
1181 struct tomoyo_name *ptr =
1182 container_of(name, typeof(*ptr), entry);
1183 atomic_dec(&ptr->head.users);
1188 * tomoyo_put_condition - Drop reference on "struct tomoyo_condition".
1190 * @cond: Pointer to "struct tomoyo_condition". Maybe NULL.
1194 static inline void tomoyo_put_condition(struct tomoyo_condition *cond)
1197 atomic_dec(&cond->head.users);
1201 * tomoyo_put_group - Drop reference on "struct tomoyo_group".
1203 * @group: Pointer to "struct tomoyo_group". Maybe NULL.
1207 static inline void tomoyo_put_group(struct tomoyo_group *group)
1210 atomic_dec(&group->head.users);
1214 * tomoyo_task - Get "struct tomoyo_task" for specified thread.
1216 * @task - Pointer to "struct task_struct".
1218 * Returns pointer to "struct tomoyo_task" for specified thread.
1220 static inline struct tomoyo_task *tomoyo_task(struct task_struct *task)
1222 return task->security + tomoyo_blob_sizes.lbs_task;
1226 * tomoyo_same_name_union - Check for duplicated "struct tomoyo_name_union" entry.
1228 * @a: Pointer to "struct tomoyo_name_union".
1229 * @b: Pointer to "struct tomoyo_name_union".
1231 * Returns true if @a == @b, false otherwise.
1233 static inline bool tomoyo_same_name_union
1234 (const struct tomoyo_name_union *a, const struct tomoyo_name_union *b)
1236 return a->filename == b->filename && a->group == b->group;
1240 * tomoyo_same_number_union - Check for duplicated "struct tomoyo_number_union" entry.
1242 * @a: Pointer to "struct tomoyo_number_union".
1243 * @b: Pointer to "struct tomoyo_number_union".
1245 * Returns true if @a == @b, false otherwise.
1247 static inline bool tomoyo_same_number_union
1248 (const struct tomoyo_number_union *a, const struct tomoyo_number_union *b)
1250 return a->values[0] == b->values[0] && a->values[1] == b->values[1] &&
1251 a->group == b->group && a->value_type[0] == b->value_type[0] &&
1252 a->value_type[1] == b->value_type[1];
1256 * tomoyo_same_ipaddr_union - Check for duplicated "struct tomoyo_ipaddr_union" entry.
1258 * @a: Pointer to "struct tomoyo_ipaddr_union".
1259 * @b: Pointer to "struct tomoyo_ipaddr_union".
1261 * Returns true if @a == @b, false otherwise.
1263 static inline bool tomoyo_same_ipaddr_union
1264 (const struct tomoyo_ipaddr_union *a, const struct tomoyo_ipaddr_union *b)
1266 return !memcmp(a->ip, b->ip, sizeof(a->ip)) && a->group == b->group &&
1267 a->is_ipv6 == b->is_ipv6;
1271 * tomoyo_current_namespace - Get "struct tomoyo_policy_namespace" for current thread.
1273 * Returns pointer to "struct tomoyo_policy_namespace" for current thread.
1275 static inline struct tomoyo_policy_namespace *tomoyo_current_namespace(void)
1277 return tomoyo_domain()->ns;
1280 #if defined(CONFIG_SLOB)
1283 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1285 * @size: Size to be rounded up.
1289 * Since SLOB does not round up, this function simply returns @size.
1291 static inline int tomoyo_round2(size_t size)
1299 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1301 * @size: Size to be rounded up.
1303 * Returns rounded size.
1305 * Strictly speaking, SLAB may be able to allocate (e.g.) 96 bytes instead of
1308 static inline int tomoyo_round2(size_t size)
1310 #if PAGE_SIZE == 4096
1317 while (size > bsize)
1325 * list_for_each_cookie - iterate over a list with cookie.
1326 * @pos: the &struct list_head to use as a loop cursor.
1327 * @head: the head for your list.
1329 #define list_for_each_cookie(pos, head) \
1331 pos = srcu_dereference((head)->next, &tomoyo_ss); \
1332 for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
1334 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */