2 * security/tomoyo/common.h
4 * Header file for TOMOYO.
6 * Copyright (C) 2005-2011 NTT DATA CORPORATION
9 #ifndef _SECURITY_TOMOYO_COMMON_H
10 #define _SECURITY_TOMOYO_COMMON_H
12 #include <linux/ctype.h>
13 #include <linux/string.h>
15 #include <linux/file.h>
16 #include <linux/kmod.h>
18 #include <linux/sched.h>
19 #include <linux/namei.h>
20 #include <linux/mount.h>
21 #include <linux/list.h>
22 #include <linux/cred.h>
23 #include <linux/poll.h>
24 #include <linux/binfmts.h>
25 #include <linux/highmem.h>
26 #include <linux/net.h>
27 #include <linux/inet.h>
29 #include <linux/in6.h>
32 #include <net/af_unix.h>
37 /********** Constants definitions. **********/
40 * TOMOYO uses this hash only when appending a string into the string
41 * table. Frequency of appending strings is very low. So we don't need
42 * large (e.g. 64k) hash size. 256 will be sufficient.
44 #define TOMOYO_HASH_BITS 8
45 #define TOMOYO_MAX_HASH (1u<<TOMOYO_HASH_BITS)
48 * TOMOYO checks only SOCK_STREAM, SOCK_DGRAM, SOCK_RAW, SOCK_SEQPACKET.
49 * Therefore, we don't need SOCK_MAX.
51 #define TOMOYO_SOCK_MAX 6
53 #define TOMOYO_EXEC_TMPSIZE 4096
55 /* Garbage collector is trying to kfree() this element. */
56 #define TOMOYO_GC_IN_PROGRESS -1
58 /* Profile number is an integer between 0 and 255. */
59 #define TOMOYO_MAX_PROFILES 256
61 /* Group number is an integer between 0 and 255. */
62 #define TOMOYO_MAX_ACL_GROUPS 256
64 /* Index numbers for "struct tomoyo_condition". */
65 enum tomoyo_conditions_index {
66 TOMOYO_TASK_UID, /* current_uid() */
67 TOMOYO_TASK_EUID, /* current_euid() */
68 TOMOYO_TASK_SUID, /* current_suid() */
69 TOMOYO_TASK_FSUID, /* current_fsuid() */
70 TOMOYO_TASK_GID, /* current_gid() */
71 TOMOYO_TASK_EGID, /* current_egid() */
72 TOMOYO_TASK_SGID, /* current_sgid() */
73 TOMOYO_TASK_FSGID, /* current_fsgid() */
74 TOMOYO_TASK_PID, /* sys_getpid() */
75 TOMOYO_TASK_PPID, /* sys_getppid() */
76 TOMOYO_EXEC_ARGC, /* "struct linux_binprm *"->argc */
77 TOMOYO_EXEC_ENVC, /* "struct linux_binprm *"->envc */
78 TOMOYO_TYPE_IS_SOCKET, /* S_IFSOCK */
79 TOMOYO_TYPE_IS_SYMLINK, /* S_IFLNK */
80 TOMOYO_TYPE_IS_FILE, /* S_IFREG */
81 TOMOYO_TYPE_IS_BLOCK_DEV, /* S_IFBLK */
82 TOMOYO_TYPE_IS_DIRECTORY, /* S_IFDIR */
83 TOMOYO_TYPE_IS_CHAR_DEV, /* S_IFCHR */
84 TOMOYO_TYPE_IS_FIFO, /* S_IFIFO */
85 TOMOYO_MODE_SETUID, /* S_ISUID */
86 TOMOYO_MODE_SETGID, /* S_ISGID */
87 TOMOYO_MODE_STICKY, /* S_ISVTX */
88 TOMOYO_MODE_OWNER_READ, /* S_IRUSR */
89 TOMOYO_MODE_OWNER_WRITE, /* S_IWUSR */
90 TOMOYO_MODE_OWNER_EXECUTE, /* S_IXUSR */
91 TOMOYO_MODE_GROUP_READ, /* S_IRGRP */
92 TOMOYO_MODE_GROUP_WRITE, /* S_IWGRP */
93 TOMOYO_MODE_GROUP_EXECUTE, /* S_IXGRP */
94 TOMOYO_MODE_OTHERS_READ, /* S_IROTH */
95 TOMOYO_MODE_OTHERS_WRITE, /* S_IWOTH */
96 TOMOYO_MODE_OTHERS_EXECUTE, /* S_IXOTH */
98 TOMOYO_SYMLINK_TARGET,
106 TOMOYO_PATH1_DEV_MAJOR,
107 TOMOYO_PATH1_DEV_MINOR,
115 TOMOYO_PATH2_DEV_MAJOR,
116 TOMOYO_PATH2_DEV_MINOR,
117 TOMOYO_PATH1_PARENT_UID,
118 TOMOYO_PATH1_PARENT_GID,
119 TOMOYO_PATH1_PARENT_INO,
120 TOMOYO_PATH1_PARENT_PERM,
121 TOMOYO_PATH2_PARENT_UID,
122 TOMOYO_PATH2_PARENT_GID,
123 TOMOYO_PATH2_PARENT_INO,
124 TOMOYO_PATH2_PARENT_PERM,
125 TOMOYO_MAX_CONDITION_KEYWORD,
133 /* Index numbers for stat(). */
134 enum tomoyo_path_stat_index {
135 /* Do not change this order. */
143 /* Index numbers for operation mode. */
144 enum tomoyo_mode_index {
145 TOMOYO_CONFIG_DISABLED,
146 TOMOYO_CONFIG_LEARNING,
147 TOMOYO_CONFIG_PERMISSIVE,
148 TOMOYO_CONFIG_ENFORCING,
149 TOMOYO_CONFIG_MAX_MODE,
150 TOMOYO_CONFIG_WANT_REJECT_LOG = 64,
151 TOMOYO_CONFIG_WANT_GRANT_LOG = 128,
152 TOMOYO_CONFIG_USE_DEFAULT = 255,
155 /* Index numbers for entry type. */
156 enum tomoyo_policy_id {
158 TOMOYO_ID_ADDRESS_GROUP,
159 TOMOYO_ID_PATH_GROUP,
160 TOMOYO_ID_NUMBER_GROUP,
161 TOMOYO_ID_TRANSITION_CONTROL,
162 TOMOYO_ID_AGGREGATOR,
171 /* Index numbers for domain's attributes. */
172 enum tomoyo_domain_info_flags_index {
173 /* Quota warnning flag. */
174 TOMOYO_DIF_QUOTA_WARNED,
176 * This domain was unable to create a new domain at
177 * tomoyo_find_next_domain() because the name of the domain to be
178 * created was too long or it could not allocate memory.
179 * More than one process continued execve() without domain transition.
181 TOMOYO_DIF_TRANSITION_FAILED,
182 TOMOYO_MAX_DOMAIN_INFO_FLAGS
185 /* Index numbers for audit type. */
186 enum tomoyo_grant_log {
187 /* Follow profile's configuration. */
188 TOMOYO_GRANTLOG_AUTO,
189 /* Do not generate grant log. */
191 /* Generate grant_log. */
195 /* Index numbers for group entries. */
196 enum tomoyo_group_id {
199 TOMOYO_ADDRESS_GROUP,
203 /* Index numbers for type of numeric values. */
204 enum tomoyo_value_type {
205 TOMOYO_VALUE_TYPE_INVALID,
206 TOMOYO_VALUE_TYPE_DECIMAL,
207 TOMOYO_VALUE_TYPE_OCTAL,
208 TOMOYO_VALUE_TYPE_HEXADECIMAL,
211 /* Index numbers for domain transition control keywords. */
212 enum tomoyo_transition_type {
213 /* Do not change this order, */
214 TOMOYO_TRANSITION_CONTROL_NO_RESET,
215 TOMOYO_TRANSITION_CONTROL_RESET,
216 TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
217 TOMOYO_TRANSITION_CONTROL_INITIALIZE,
218 TOMOYO_TRANSITION_CONTROL_NO_KEEP,
219 TOMOYO_TRANSITION_CONTROL_KEEP,
220 TOMOYO_MAX_TRANSITION_TYPE
223 /* Index numbers for Access Controls. */
224 enum tomoyo_acl_entry_type_index {
225 TOMOYO_TYPE_PATH_ACL,
226 TOMOYO_TYPE_PATH2_ACL,
227 TOMOYO_TYPE_PATH_NUMBER_ACL,
228 TOMOYO_TYPE_MKDEV_ACL,
229 TOMOYO_TYPE_MOUNT_ACL,
230 TOMOYO_TYPE_INET_ACL,
231 TOMOYO_TYPE_UNIX_ACL,
233 TOMOYO_TYPE_MANUAL_TASK_ACL,
236 /* Index numbers for access controls with one pathname. */
237 enum tomoyo_path_acl_index {
245 TOMOYO_TYPE_TRUNCATE,
249 TOMOYO_MAX_PATH_OPERATION
252 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
253 enum tomoyo_memory_stat_type {
254 TOMOYO_MEMORY_POLICY,
257 TOMOYO_MAX_MEMORY_STAT
260 enum tomoyo_mkdev_acl_index {
263 TOMOYO_MAX_MKDEV_OPERATION
266 /* Index numbers for socket operations. */
267 enum tomoyo_network_acl_index {
268 TOMOYO_NETWORK_BIND, /* bind() operation. */
269 TOMOYO_NETWORK_LISTEN, /* listen() operation. */
270 TOMOYO_NETWORK_CONNECT, /* connect() operation. */
271 TOMOYO_NETWORK_SEND, /* send() operation. */
272 TOMOYO_MAX_NETWORK_OPERATION
275 /* Index numbers for access controls with two pathnames. */
276 enum tomoyo_path2_acl_index {
279 TOMOYO_TYPE_PIVOT_ROOT,
280 TOMOYO_MAX_PATH2_OPERATION
283 /* Index numbers for access controls with one pathname and one number. */
284 enum tomoyo_path_number_acl_index {
293 TOMOYO_MAX_PATH_NUMBER_OPERATION
296 /* Index numbers for /sys/kernel/security/tomoyo/ interfaces. */
297 enum tomoyo_securityfs_interface_index {
299 TOMOYO_EXCEPTIONPOLICY,
300 TOMOYO_PROCESS_STATUS,
309 /* Index numbers for special mount operations. */
310 enum tomoyo_special_mount {
311 TOMOYO_MOUNT_BIND, /* mount --bind /source /dest */
312 TOMOYO_MOUNT_MOVE, /* mount --move /old /new */
313 TOMOYO_MOUNT_REMOUNT, /* mount -o remount /dir */
314 TOMOYO_MOUNT_MAKE_UNBINDABLE, /* mount --make-unbindable /dir */
315 TOMOYO_MOUNT_MAKE_PRIVATE, /* mount --make-private /dir */
316 TOMOYO_MOUNT_MAKE_SLAVE, /* mount --make-slave /dir */
317 TOMOYO_MOUNT_MAKE_SHARED, /* mount --make-shared /dir */
318 TOMOYO_MAX_SPECIAL_MOUNT
321 /* Index numbers for functionality. */
322 enum tomoyo_mac_index {
323 TOMOYO_MAC_FILE_EXECUTE,
324 TOMOYO_MAC_FILE_OPEN,
325 TOMOYO_MAC_FILE_CREATE,
326 TOMOYO_MAC_FILE_UNLINK,
327 TOMOYO_MAC_FILE_GETATTR,
328 TOMOYO_MAC_FILE_MKDIR,
329 TOMOYO_MAC_FILE_RMDIR,
330 TOMOYO_MAC_FILE_MKFIFO,
331 TOMOYO_MAC_FILE_MKSOCK,
332 TOMOYO_MAC_FILE_TRUNCATE,
333 TOMOYO_MAC_FILE_SYMLINK,
334 TOMOYO_MAC_FILE_MKBLOCK,
335 TOMOYO_MAC_FILE_MKCHAR,
336 TOMOYO_MAC_FILE_LINK,
337 TOMOYO_MAC_FILE_RENAME,
338 TOMOYO_MAC_FILE_CHMOD,
339 TOMOYO_MAC_FILE_CHOWN,
340 TOMOYO_MAC_FILE_CHGRP,
341 TOMOYO_MAC_FILE_IOCTL,
342 TOMOYO_MAC_FILE_CHROOT,
343 TOMOYO_MAC_FILE_MOUNT,
344 TOMOYO_MAC_FILE_UMOUNT,
345 TOMOYO_MAC_FILE_PIVOT_ROOT,
346 TOMOYO_MAC_NETWORK_INET_STREAM_BIND,
347 TOMOYO_MAC_NETWORK_INET_STREAM_LISTEN,
348 TOMOYO_MAC_NETWORK_INET_STREAM_CONNECT,
349 TOMOYO_MAC_NETWORK_INET_DGRAM_BIND,
350 TOMOYO_MAC_NETWORK_INET_DGRAM_SEND,
351 TOMOYO_MAC_NETWORK_INET_RAW_BIND,
352 TOMOYO_MAC_NETWORK_INET_RAW_SEND,
353 TOMOYO_MAC_NETWORK_UNIX_STREAM_BIND,
354 TOMOYO_MAC_NETWORK_UNIX_STREAM_LISTEN,
355 TOMOYO_MAC_NETWORK_UNIX_STREAM_CONNECT,
356 TOMOYO_MAC_NETWORK_UNIX_DGRAM_BIND,
357 TOMOYO_MAC_NETWORK_UNIX_DGRAM_SEND,
358 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_BIND,
359 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_LISTEN,
360 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_CONNECT,
365 /* Index numbers for category of functionality. */
366 enum tomoyo_mac_category_index {
367 TOMOYO_MAC_CATEGORY_FILE,
368 TOMOYO_MAC_CATEGORY_NETWORK,
369 TOMOYO_MAC_CATEGORY_MISC,
370 TOMOYO_MAX_MAC_CATEGORY_INDEX
374 * Retry this request. Returned by tomoyo_supervisor() if policy violation has
375 * occurred in enforcing mode and the userspace daemon decided to retry.
377 * We must choose a positive value in order to distinguish "granted" (which is
378 * 0) and "rejected" (which is a negative value) and "retry".
380 #define TOMOYO_RETRY_REQUEST 1
382 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
383 enum tomoyo_policy_stat_type {
384 /* Do not change this order. */
385 TOMOYO_STAT_POLICY_UPDATES,
386 TOMOYO_STAT_POLICY_LEARNING, /* == TOMOYO_CONFIG_LEARNING */
387 TOMOYO_STAT_POLICY_PERMISSIVE, /* == TOMOYO_CONFIG_PERMISSIVE */
388 TOMOYO_STAT_POLICY_ENFORCING, /* == TOMOYO_CONFIG_ENFORCING */
389 TOMOYO_MAX_POLICY_STAT
392 /* Index numbers for profile's PREFERENCE values. */
393 enum tomoyo_pref_index {
394 TOMOYO_PREF_MAX_AUDIT_LOG,
395 TOMOYO_PREF_MAX_LEARNING_ENTRY,
399 /********** Structure definitions. **********/
401 /* Common header for holding ACL entries. */
402 struct tomoyo_acl_head {
403 struct list_head list;
404 s8 is_deleted; /* true or false or TOMOYO_GC_IN_PROGRESS */
407 /* Common header for shared entries. */
408 struct tomoyo_shared_acl_head {
409 struct list_head list;
413 struct tomoyo_policy_namespace;
415 /* Structure for request info. */
416 struct tomoyo_request_info {
418 * For holding parameters specific to operations which deal files.
419 * NULL if not dealing files.
421 struct tomoyo_obj_info *obj;
423 * For holding parameters specific to execve() request.
424 * NULL if not dealing do_execve().
426 struct tomoyo_execve *ee;
427 struct tomoyo_domain_info *domain;
428 /* For holding parameters. */
431 const struct tomoyo_path_info *filename;
432 /* For using wildcards at tomoyo_find_next_domain(). */
433 const struct tomoyo_path_info *matched_path;
434 /* One of values in "enum tomoyo_path_acl_index". */
438 const struct tomoyo_path_info *filename1;
439 const struct tomoyo_path_info *filename2;
440 /* One of values in "enum tomoyo_path2_acl_index". */
444 const struct tomoyo_path_info *filename;
448 /* One of values in "enum tomoyo_mkdev_acl_index". */
452 const struct tomoyo_path_info *filename;
453 unsigned long number;
456 * "enum tomoyo_path_number_acl_index".
461 const struct tomoyo_path_info *name;
464 const __be32 *address;
466 /* One of values smaller than TOMOYO_SOCK_MAX. */
468 /* One of values in "enum tomoyo_network_acl_index". */
473 const struct tomoyo_path_info *address;
474 /* One of values smaller than TOMOYO_SOCK_MAX. */
476 /* One of values in "enum tomoyo_network_acl_index". */
480 const struct tomoyo_path_info *type;
481 const struct tomoyo_path_info *dir;
482 const struct tomoyo_path_info *dev;
487 const struct tomoyo_path_info *domainname;
490 struct tomoyo_acl_info *matched_acl;
495 u8 mode; /* One of tomoyo_mode_index . */
499 /* Structure for holding a token. */
500 struct tomoyo_path_info {
502 u32 hash; /* = full_name_hash(name, strlen(name)) */
503 u16 const_len; /* = tomoyo_const_part_length(name) */
504 bool is_dir; /* = tomoyo_strendswith(name, "/") */
505 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
508 /* Structure for holding string data. */
510 struct tomoyo_shared_acl_head head;
511 struct tomoyo_path_info entry;
514 /* Structure for holding a word. */
515 struct tomoyo_name_union {
516 /* Either @filename or @group is NULL. */
517 const struct tomoyo_path_info *filename;
518 struct tomoyo_group *group;
521 /* Structure for holding a number. */
522 struct tomoyo_number_union {
523 unsigned long values[2];
524 struct tomoyo_group *group; /* Maybe NULL. */
525 /* One of values in "enum tomoyo_value_type". */
529 /* Structure for holding an IP address. */
530 struct tomoyo_ipaddr_union {
531 struct in6_addr ip[2]; /* Big endian. */
532 struct tomoyo_group *group; /* Pointer to address group. */
533 bool is_ipv6; /* Valid only if @group == NULL. */
536 /* Structure for "path_group"/"number_group"/"address_group" directive. */
537 struct tomoyo_group {
538 struct tomoyo_shared_acl_head head;
539 const struct tomoyo_path_info *group_name;
540 struct list_head member_list;
543 /* Structure for "path_group" directive. */
544 struct tomoyo_path_group {
545 struct tomoyo_acl_head head;
546 const struct tomoyo_path_info *member_name;
549 /* Structure for "number_group" directive. */
550 struct tomoyo_number_group {
551 struct tomoyo_acl_head head;
552 struct tomoyo_number_union number;
555 /* Structure for "address_group" directive. */
556 struct tomoyo_address_group {
557 struct tomoyo_acl_head head;
558 /* Structure for holding an IP address. */
559 struct tomoyo_ipaddr_union address;
562 /* Subset of "struct stat". Used by conditional ACL and audit logs. */
563 struct tomoyo_mini_stat {
572 /* Structure for dumping argv[] and envp[] of "struct linux_binprm". */
573 struct tomoyo_page_dump {
574 struct page *page; /* Previously dumped page. */
575 char *data; /* Contents of "page". Size is PAGE_SIZE. */
578 /* Structure for attribute checks in addition to pathname checks. */
579 struct tomoyo_obj_info {
581 * True if tomoyo_get_attributes() was already called, false otherwise.
584 /* True if @stat[] is valid. */
585 bool stat_valid[TOMOYO_MAX_PATH_STAT];
586 /* First pathname. Initialized with { NULL, NULL } if no path. */
588 /* Second pathname. Initialized with { NULL, NULL } if no path. */
591 * Information on @path1, @path1's parent directory, @path2, @path2's
594 struct tomoyo_mini_stat stat[TOMOYO_MAX_PATH_STAT];
596 * Content of symbolic link to be created. NULL for operations other
599 struct tomoyo_path_info *symlink_target;
602 /* Structure for argv[]. */
605 const struct tomoyo_path_info *value;
609 /* Structure for envp[]. */
611 const struct tomoyo_path_info *name;
612 const struct tomoyo_path_info *value;
616 /* Structure for execve() operation. */
617 struct tomoyo_execve {
618 struct tomoyo_request_info r;
619 struct tomoyo_obj_info obj;
620 struct linux_binprm *bprm;
621 const struct tomoyo_path_info *transition;
622 /* For dumping argv[] and envp[]. */
623 struct tomoyo_page_dump dump;
624 /* For temporary use. */
625 char *tmp; /* Size is TOMOYO_EXEC_TMPSIZE bytes */
628 /* Structure for entries which follows "struct tomoyo_condition". */
629 struct tomoyo_condition_element {
631 * Left hand operand. A "struct tomoyo_argv" for TOMOYO_ARGV_ENTRY, a
632 * "struct tomoyo_envp" for TOMOYO_ENVP_ENTRY is attached to the tail
633 * of the array of this struct.
637 * Right hand operand. A "struct tomoyo_number_union" for
638 * TOMOYO_NUMBER_UNION, a "struct tomoyo_name_union" for
639 * TOMOYO_NAME_UNION is attached to the tail of the array of this
643 /* Equation operator. True if equals or overlaps, false otherwise. */
647 /* Structure for optional arguments. */
648 struct tomoyo_condition {
649 struct tomoyo_shared_acl_head head;
650 u32 size; /* Memory size allocated for this entry. */
651 u16 condc; /* Number of conditions in this struct. */
652 u16 numbers_count; /* Number of "struct tomoyo_number_union values". */
653 u16 names_count; /* Number of "struct tomoyo_name_union names". */
654 u16 argc; /* Number of "struct tomoyo_argv". */
655 u16 envc; /* Number of "struct tomoyo_envp". */
656 u8 grant_log; /* One of values in "enum tomoyo_grant_log". */
657 const struct tomoyo_path_info *transit; /* Maybe NULL. */
659 * struct tomoyo_condition_element condition[condc];
660 * struct tomoyo_number_union values[numbers_count];
661 * struct tomoyo_name_union names[names_count];
662 * struct tomoyo_argv argv[argc];
663 * struct tomoyo_envp envp[envc];
667 /* Common header for individual entries. */
668 struct tomoyo_acl_info {
669 struct list_head list;
670 struct tomoyo_condition *cond; /* Maybe NULL. */
671 s8 is_deleted; /* true or false or TOMOYO_GC_IN_PROGRESS */
672 u8 type; /* One of values in "enum tomoyo_acl_entry_type_index". */
675 /* Structure for domain information. */
676 struct tomoyo_domain_info {
677 struct list_head list;
678 struct list_head acl_info_list;
679 /* Name of this domain. Never NULL. */
680 const struct tomoyo_path_info *domainname;
681 /* Namespace for this domain. Never NULL. */
682 struct tomoyo_policy_namespace *ns;
683 u8 profile; /* Profile number to use. */
684 u8 group; /* Group number to use. */
685 bool is_deleted; /* Delete flag. */
686 bool flags[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
687 atomic_t users; /* Number of referring credentials. */
691 * Structure for "task manual_domain_transition" directive.
693 struct tomoyo_task_acl {
694 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MANUAL_TASK_ACL */
695 /* Pointer to domainname. */
696 const struct tomoyo_path_info *domainname;
700 * Structure for "file execute", "file read", "file write", "file append",
701 * "file unlink", "file getattr", "file rmdir", "file truncate",
702 * "file symlink", "file chroot" and "file unmount" directive.
704 struct tomoyo_path_acl {
705 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
706 u16 perm; /* Bitmask of values in "enum tomoyo_path_acl_index". */
707 struct tomoyo_name_union name;
711 * Structure for "file create", "file mkdir", "file mkfifo", "file mksock",
712 * "file ioctl", "file chmod", "file chown" and "file chgrp" directive.
714 struct tomoyo_path_number_acl {
715 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
716 /* Bitmask of values in "enum tomoyo_path_number_acl_index". */
718 struct tomoyo_name_union name;
719 struct tomoyo_number_union number;
722 /* Structure for "file mkblock" and "file mkchar" directive. */
723 struct tomoyo_mkdev_acl {
724 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
725 u8 perm; /* Bitmask of values in "enum tomoyo_mkdev_acl_index". */
726 struct tomoyo_name_union name;
727 struct tomoyo_number_union mode;
728 struct tomoyo_number_union major;
729 struct tomoyo_number_union minor;
733 * Structure for "file rename", "file link" and "file pivot_root" directive.
735 struct tomoyo_path2_acl {
736 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
737 u8 perm; /* Bitmask of values in "enum tomoyo_path2_acl_index". */
738 struct tomoyo_name_union name1;
739 struct tomoyo_name_union name2;
742 /* Structure for "file mount" directive. */
743 struct tomoyo_mount_acl {
744 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
745 struct tomoyo_name_union dev_name;
746 struct tomoyo_name_union dir_name;
747 struct tomoyo_name_union fs_type;
748 struct tomoyo_number_union flags;
751 /* Structure for "misc env" directive in domain policy. */
752 struct tomoyo_env_acl {
753 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_ENV_ACL */
754 const struct tomoyo_path_info *env; /* environment variable */
757 /* Structure for "network inet" directive. */
758 struct tomoyo_inet_acl {
759 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_INET_ACL */
761 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
762 struct tomoyo_ipaddr_union address;
763 struct tomoyo_number_union port;
766 /* Structure for "network unix" directive. */
767 struct tomoyo_unix_acl {
768 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_UNIX_ACL */
770 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
771 struct tomoyo_name_union name;
774 /* Structure for holding a line from /sys/kernel/security/tomoyo/ interface. */
775 struct tomoyo_acl_param {
777 struct list_head *list;
778 struct tomoyo_policy_namespace *ns;
782 #define TOMOYO_MAX_IO_READ_QUEUE 64
785 * Structure for reading/writing policy via /sys/kernel/security/tomoyo
788 struct tomoyo_io_buffer {
789 void (*read) (struct tomoyo_io_buffer *);
790 int (*write) (struct tomoyo_io_buffer *);
791 unsigned int (*poll) (struct file *file, poll_table *wait);
792 /* Exclusive lock for this structure. */
794 char __user *read_user_buf;
795 size_t read_user_buf_avail;
797 struct list_head *ns;
798 struct list_head *domain;
799 struct list_head *group;
800 struct list_head *acl;
803 unsigned int query_index;
811 bool print_this_domain_only;
812 bool print_transition_related_only;
813 bool print_cond_part;
814 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
817 struct tomoyo_policy_namespace *ns;
818 /* The position currently writing to. */
819 struct tomoyo_domain_info *domain;
820 /* Bytes available for writing. */
824 /* Buffer for reading. */
826 /* Size of read buffer. */
828 /* Buffer for writing. */
830 /* Size of write buffer. */
831 size_t writebuf_size;
832 /* Type of this interface. */
833 enum tomoyo_securityfs_interface_index type;
834 /* Users counter protected by tomoyo_io_buffer_list_lock. */
836 /* List for telling GC not to kfree() elements. */
837 struct list_head list;
841 * Structure for "initialize_domain"/"no_initialize_domain"/"keep_domain"/
842 * "no_keep_domain" keyword.
844 struct tomoyo_transition_control {
845 struct tomoyo_acl_head head;
846 u8 type; /* One of values in "enum tomoyo_transition_type". */
847 /* True if the domainname is tomoyo_get_last_name(). */
849 const struct tomoyo_path_info *domainname; /* Maybe NULL */
850 const struct tomoyo_path_info *program; /* Maybe NULL */
853 /* Structure for "aggregator" keyword. */
854 struct tomoyo_aggregator {
855 struct tomoyo_acl_head head;
856 const struct tomoyo_path_info *original_name;
857 const struct tomoyo_path_info *aggregated_name;
860 /* Structure for policy manager. */
861 struct tomoyo_manager {
862 struct tomoyo_acl_head head;
863 /* A path to program or a domainname. */
864 const struct tomoyo_path_info *manager;
867 struct tomoyo_preference {
868 unsigned int learning_max_entry;
869 bool enforcing_verbose;
870 bool learning_verbose;
871 bool permissive_verbose;
874 /* Structure for /sys/kernel/security/tomnoyo/profile interface. */
875 struct tomoyo_profile {
876 const struct tomoyo_path_info *comment;
877 struct tomoyo_preference *learning;
878 struct tomoyo_preference *permissive;
879 struct tomoyo_preference *enforcing;
880 struct tomoyo_preference preference;
882 u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
883 unsigned int pref[TOMOYO_MAX_PREF];
886 /* Structure for representing YYYY/MM/DD hh/mm/ss. */
896 /* Structure for policy namespace. */
897 struct tomoyo_policy_namespace {
898 /* Profile table. Memory is allocated as needed. */
899 struct tomoyo_profile *profile_ptr[TOMOYO_MAX_PROFILES];
900 /* List of "struct tomoyo_group". */
901 struct list_head group_list[TOMOYO_MAX_GROUP];
902 /* List of policy. */
903 struct list_head policy_list[TOMOYO_MAX_POLICY];
904 /* The global ACL referred by "use_group" keyword. */
905 struct list_head acl_group[TOMOYO_MAX_ACL_GROUPS];
906 /* List for connecting to tomoyo_namespace_list list. */
907 struct list_head namespace_list;
908 /* Profile version. Currently only 20110903 is defined. */
909 unsigned int profile_version;
910 /* Name of this namespace (e.g. "<kernel>", "</usr/sbin/httpd>" ). */
914 /********** Function prototypes. **********/
916 bool tomoyo_address_matches_group(const bool is_ipv6, const __be32 *address,
917 const struct tomoyo_group *group);
918 bool tomoyo_compare_number_union(const unsigned long value,
919 const struct tomoyo_number_union *ptr);
920 bool tomoyo_condition(struct tomoyo_request_info *r,
921 const struct tomoyo_condition *cond);
922 bool tomoyo_correct_domain(const unsigned char *domainname);
923 bool tomoyo_correct_path(const char *filename);
924 bool tomoyo_correct_word(const char *string);
925 bool tomoyo_domain_def(const unsigned char *buffer);
926 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
927 bool tomoyo_dump_page(struct linux_binprm *bprm, unsigned long pos,
928 struct tomoyo_page_dump *dump);
929 bool tomoyo_memory_ok(void *ptr);
930 bool tomoyo_number_matches_group(const unsigned long min,
931 const unsigned long max,
932 const struct tomoyo_group *group);
933 bool tomoyo_parse_ipaddr_union(struct tomoyo_acl_param *param,
934 struct tomoyo_ipaddr_union *ptr);
935 bool tomoyo_parse_name_union(struct tomoyo_acl_param *param,
936 struct tomoyo_name_union *ptr);
937 bool tomoyo_parse_number_union(struct tomoyo_acl_param *param,
938 struct tomoyo_number_union *ptr);
939 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
940 const struct tomoyo_path_info *pattern);
941 bool tomoyo_permstr(const char *string, const char *keyword);
942 bool tomoyo_str_starts(char **src, const char *find);
943 char *tomoyo_encode(const char *str);
944 char *tomoyo_encode2(const char *str, int str_len);
945 char *tomoyo_init_log(struct tomoyo_request_info *r, int len, const char *fmt,
947 char *tomoyo_read_token(struct tomoyo_acl_param *param);
948 char *tomoyo_realpath_from_path(struct path *path);
949 char *tomoyo_realpath_nofollow(const char *pathname);
950 const char *tomoyo_get_exe(void);
951 const char *tomoyo_yesno(const unsigned int value);
952 const struct tomoyo_path_info *tomoyo_compare_name_union
953 (const struct tomoyo_path_info *name, const struct tomoyo_name_union *ptr);
954 const struct tomoyo_path_info *tomoyo_get_domainname
955 (struct tomoyo_acl_param *param);
956 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
957 const struct tomoyo_path_info *tomoyo_path_matches_group
958 (const struct tomoyo_path_info *pathname, const struct tomoyo_group *group);
959 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
960 struct path *path, const int flag);
961 int tomoyo_close_control(struct tomoyo_io_buffer *head);
962 int tomoyo_env_perm(struct tomoyo_request_info *r, const char *env);
963 int tomoyo_execute_permission(struct tomoyo_request_info *r,
964 const struct tomoyo_path_info *filename);
965 int tomoyo_find_next_domain(struct linux_binprm *bprm);
966 int tomoyo_get_mode(const struct tomoyo_policy_namespace *ns, const u8 profile,
968 int tomoyo_init_request_info(struct tomoyo_request_info *r,
969 struct tomoyo_domain_info *domain,
971 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
972 const unsigned int mode, unsigned int dev);
973 int tomoyo_mount_permission(const char *dev_name, struct path *path,
974 const char *type, unsigned long flags,
976 int tomoyo_open_control(const u8 type, struct file *file);
977 int tomoyo_path2_perm(const u8 operation, struct path *path1,
979 int tomoyo_path_number_perm(const u8 operation, struct path *path,
980 unsigned long number);
981 int tomoyo_path_perm(const u8 operation, struct path *path,
983 unsigned int tomoyo_poll_control(struct file *file, poll_table *wait);
984 unsigned int tomoyo_poll_log(struct file *file, poll_table *wait);
985 int tomoyo_socket_bind_permission(struct socket *sock, struct sockaddr *addr,
987 int tomoyo_socket_connect_permission(struct socket *sock,
988 struct sockaddr *addr, int addr_len);
989 int tomoyo_socket_listen_permission(struct socket *sock);
990 int tomoyo_socket_sendmsg_permission(struct socket *sock, struct msghdr *msg,
992 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
994 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
995 struct tomoyo_acl_param *param,
996 bool (*check_duplicate)
997 (const struct tomoyo_acl_info *,
998 const struct tomoyo_acl_info *),
999 bool (*merge_duplicate)
1000 (struct tomoyo_acl_info *, struct tomoyo_acl_info *,
1002 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
1003 struct tomoyo_acl_param *param,
1004 bool (*check_duplicate)
1005 (const struct tomoyo_acl_head *,
1006 const struct tomoyo_acl_head *));
1007 int tomoyo_write_aggregator(struct tomoyo_acl_param *param);
1008 int tomoyo_write_file(struct tomoyo_acl_param *param);
1009 int tomoyo_write_group(struct tomoyo_acl_param *param, const u8 type);
1010 int tomoyo_write_misc(struct tomoyo_acl_param *param);
1011 int tomoyo_write_inet_network(struct tomoyo_acl_param *param);
1012 int tomoyo_write_transition_control(struct tomoyo_acl_param *param,
1014 int tomoyo_write_unix_network(struct tomoyo_acl_param *param);
1015 ssize_t tomoyo_read_control(struct tomoyo_io_buffer *head, char __user *buffer,
1016 const int buffer_len);
1017 ssize_t tomoyo_write_control(struct tomoyo_io_buffer *head,
1018 const char __user *buffer, const int buffer_len);
1019 struct tomoyo_condition *tomoyo_get_condition(struct tomoyo_acl_param *param);
1020 struct tomoyo_domain_info *tomoyo_assign_domain(const char *domainname,
1021 const bool transit);
1022 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
1023 struct tomoyo_group *tomoyo_get_group(struct tomoyo_acl_param *param,
1025 struct tomoyo_policy_namespace *tomoyo_assign_namespace
1026 (const char *domainname);
1027 struct tomoyo_profile *tomoyo_profile(const struct tomoyo_policy_namespace *ns,
1029 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
1031 u8 tomoyo_parse_ulong(unsigned long *result, char **str);
1032 void *tomoyo_commit_ok(void *data, const unsigned int size);
1033 void __init tomoyo_load_builtin_policy(void);
1034 void __init tomoyo_mm_init(void);
1035 void tomoyo_check_acl(struct tomoyo_request_info *r,
1036 bool (*check_entry) (struct tomoyo_request_info *,
1037 const struct tomoyo_acl_info *));
1038 void tomoyo_check_profile(void);
1039 void tomoyo_convert_time(time_t time, struct tomoyo_time *stamp);
1040 void tomoyo_del_condition(struct list_head *element);
1041 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
1042 void tomoyo_get_attributes(struct tomoyo_obj_info *obj);
1043 void tomoyo_init_policy_namespace(struct tomoyo_policy_namespace *ns);
1044 void tomoyo_load_policy(const char *filename);
1045 void tomoyo_normalize_line(unsigned char *buffer);
1046 void tomoyo_notify_gc(struct tomoyo_io_buffer *head, const bool is_register);
1047 void tomoyo_print_ip(char *buf, const unsigned int size,
1048 const struct tomoyo_ipaddr_union *ptr);
1049 void tomoyo_print_ulong(char *buffer, const int buffer_len,
1050 const unsigned long value, const u8 type);
1051 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
1052 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
1053 void tomoyo_read_log(struct tomoyo_io_buffer *head);
1054 void tomoyo_update_stat(const u8 index);
1055 void tomoyo_warn_oom(const char *function);
1056 void tomoyo_write_log(struct tomoyo_request_info *r, const char *fmt, ...)
1058 void tomoyo_write_log2(struct tomoyo_request_info *r, int len, const char *fmt,
1061 /********** External variable definitions. **********/
1063 extern bool tomoyo_policy_loaded;
1064 extern const char * const tomoyo_condition_keyword
1065 [TOMOYO_MAX_CONDITION_KEYWORD];
1066 extern const char * const tomoyo_dif[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
1067 extern const char * const tomoyo_mac_keywords[TOMOYO_MAX_MAC_INDEX
1068 + TOMOYO_MAX_MAC_CATEGORY_INDEX];
1069 extern const char * const tomoyo_mode[TOMOYO_CONFIG_MAX_MODE];
1070 extern const char * const tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
1071 extern const char * const tomoyo_proto_keyword[TOMOYO_SOCK_MAX];
1072 extern const char * const tomoyo_socket_keyword[TOMOYO_MAX_NETWORK_OPERATION];
1073 extern const u8 tomoyo_index2category[TOMOYO_MAX_MAC_INDEX];
1074 extern const u8 tomoyo_pn2mac[TOMOYO_MAX_PATH_NUMBER_OPERATION];
1075 extern const u8 tomoyo_pnnn2mac[TOMOYO_MAX_MKDEV_OPERATION];
1076 extern const u8 tomoyo_pp2mac[TOMOYO_MAX_PATH2_OPERATION];
1077 extern struct list_head tomoyo_condition_list;
1078 extern struct list_head tomoyo_domain_list;
1079 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
1080 extern struct list_head tomoyo_namespace_list;
1081 extern struct mutex tomoyo_policy_lock;
1082 extern struct srcu_struct tomoyo_ss;
1083 extern struct tomoyo_domain_info tomoyo_kernel_domain;
1084 extern struct tomoyo_policy_namespace tomoyo_kernel_namespace;
1085 extern unsigned int tomoyo_memory_quota[TOMOYO_MAX_MEMORY_STAT];
1086 extern unsigned int tomoyo_memory_used[TOMOYO_MAX_MEMORY_STAT];
1088 /********** Inlined functions. **********/
1091 * tomoyo_read_lock - Take lock for protecting policy.
1093 * Returns index number for tomoyo_read_unlock().
1095 static inline int tomoyo_read_lock(void)
1097 return srcu_read_lock(&tomoyo_ss);
1101 * tomoyo_read_unlock - Release lock for protecting policy.
1103 * @idx: Index number returned by tomoyo_read_lock().
1107 static inline void tomoyo_read_unlock(int idx)
1109 srcu_read_unlock(&tomoyo_ss, idx);
1113 * tomoyo_sys_getppid - Copy of getppid().
1115 * Returns parent process's PID.
1117 * Alpha does not have getppid() defined. To be able to build this module on
1118 * Alpha, I have to copy getppid() from kernel/timer.c.
1120 static inline pid_t tomoyo_sys_getppid(void)
1124 pid = task_tgid_vnr(rcu_dereference(current->real_parent));
1130 * tomoyo_sys_getpid - Copy of getpid().
1132 * Returns current thread's PID.
1134 * Alpha does not have getpid() defined. To be able to build this module on
1135 * Alpha, I have to copy getpid() from kernel/timer.c.
1137 static inline pid_t tomoyo_sys_getpid(void)
1139 return task_tgid_vnr(current);
1143 * tomoyo_pathcmp - strcmp() for "struct tomoyo_path_info" structure.
1145 * @a: Pointer to "struct tomoyo_path_info".
1146 * @b: Pointer to "struct tomoyo_path_info".
1148 * Returns true if @a == @b, false otherwise.
1150 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
1151 const struct tomoyo_path_info *b)
1153 return a->hash != b->hash || strcmp(a->name, b->name);
1157 * tomoyo_put_name - Drop reference on "struct tomoyo_name".
1159 * @name: Pointer to "struct tomoyo_path_info". Maybe NULL.
1163 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
1166 struct tomoyo_name *ptr =
1167 container_of(name, typeof(*ptr), entry);
1168 atomic_dec(&ptr->head.users);
1173 * tomoyo_put_condition - Drop reference on "struct tomoyo_condition".
1175 * @cond: Pointer to "struct tomoyo_condition". Maybe NULL.
1179 static inline void tomoyo_put_condition(struct tomoyo_condition *cond)
1182 atomic_dec(&cond->head.users);
1186 * tomoyo_put_group - Drop reference on "struct tomoyo_group".
1188 * @group: Pointer to "struct tomoyo_group". Maybe NULL.
1192 static inline void tomoyo_put_group(struct tomoyo_group *group)
1195 atomic_dec(&group->head.users);
1199 * tomoyo_domain - Get "struct tomoyo_domain_info" for current thread.
1201 * Returns pointer to "struct tomoyo_domain_info" for current thread.
1203 static inline struct tomoyo_domain_info *tomoyo_domain(void)
1205 return current_cred()->security;
1209 * tomoyo_real_domain - Get "struct tomoyo_domain_info" for specified thread.
1211 * @task: Pointer to "struct task_struct".
1213 * Returns pointer to "struct tomoyo_security" for specified thread.
1215 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
1218 return task_cred_xxx(task, security);
1222 * tomoyo_same_name_union - Check for duplicated "struct tomoyo_name_union" entry.
1224 * @a: Pointer to "struct tomoyo_name_union".
1225 * @b: Pointer to "struct tomoyo_name_union".
1227 * Returns true if @a == @b, false otherwise.
1229 static inline bool tomoyo_same_name_union
1230 (const struct tomoyo_name_union *a, const struct tomoyo_name_union *b)
1232 return a->filename == b->filename && a->group == b->group;
1236 * tomoyo_same_number_union - Check for duplicated "struct tomoyo_number_union" entry.
1238 * @a: Pointer to "struct tomoyo_number_union".
1239 * @b: Pointer to "struct tomoyo_number_union".
1241 * Returns true if @a == @b, false otherwise.
1243 static inline bool tomoyo_same_number_union
1244 (const struct tomoyo_number_union *a, const struct tomoyo_number_union *b)
1246 return a->values[0] == b->values[0] && a->values[1] == b->values[1] &&
1247 a->group == b->group && a->value_type[0] == b->value_type[0] &&
1248 a->value_type[1] == b->value_type[1];
1252 * tomoyo_same_ipaddr_union - Check for duplicated "struct tomoyo_ipaddr_union" entry.
1254 * @a: Pointer to "struct tomoyo_ipaddr_union".
1255 * @b: Pointer to "struct tomoyo_ipaddr_union".
1257 * Returns true if @a == @b, false otherwise.
1259 static inline bool tomoyo_same_ipaddr_union
1260 (const struct tomoyo_ipaddr_union *a, const struct tomoyo_ipaddr_union *b)
1262 return !memcmp(a->ip, b->ip, sizeof(a->ip)) && a->group == b->group &&
1263 a->is_ipv6 == b->is_ipv6;
1267 * tomoyo_current_namespace - Get "struct tomoyo_policy_namespace" for current thread.
1269 * Returns pointer to "struct tomoyo_policy_namespace" for current thread.
1271 static inline struct tomoyo_policy_namespace *tomoyo_current_namespace(void)
1273 return tomoyo_domain()->ns;
1276 #if defined(CONFIG_SLOB)
1279 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1281 * @size: Size to be rounded up.
1285 * Since SLOB does not round up, this function simply returns @size.
1287 static inline int tomoyo_round2(size_t size)
1295 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1297 * @size: Size to be rounded up.
1299 * Returns rounded size.
1301 * Strictly speaking, SLAB may be able to allocate (e.g.) 96 bytes instead of
1304 static inline int tomoyo_round2(size_t size)
1306 #if PAGE_SIZE == 4096
1313 while (size > bsize)
1321 * list_for_each_cookie - iterate over a list with cookie.
1322 * @pos: the &struct list_head to use as a loop cursor.
1323 * @head: the head for your list.
1325 #define list_for_each_cookie(pos, head) \
1327 pos = srcu_dereference((head)->next, &tomoyo_ss); \
1328 for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
1330 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */