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 /* Profile number is an integer between 0 and 255. */
56 #define TOMOYO_MAX_PROFILES 256
58 /* Group number is an integer between 0 and 255. */
59 #define TOMOYO_MAX_ACL_GROUPS 256
61 /* Index numbers for "struct tomoyo_condition". */
62 enum tomoyo_conditions_index {
63 TOMOYO_TASK_UID, /* current_uid() */
64 TOMOYO_TASK_EUID, /* current_euid() */
65 TOMOYO_TASK_SUID, /* current_suid() */
66 TOMOYO_TASK_FSUID, /* current_fsuid() */
67 TOMOYO_TASK_GID, /* current_gid() */
68 TOMOYO_TASK_EGID, /* current_egid() */
69 TOMOYO_TASK_SGID, /* current_sgid() */
70 TOMOYO_TASK_FSGID, /* current_fsgid() */
71 TOMOYO_TASK_PID, /* sys_getpid() */
72 TOMOYO_TASK_PPID, /* sys_getppid() */
73 TOMOYO_EXEC_ARGC, /* "struct linux_binprm *"->argc */
74 TOMOYO_EXEC_ENVC, /* "struct linux_binprm *"->envc */
75 TOMOYO_TYPE_IS_SOCKET, /* S_IFSOCK */
76 TOMOYO_TYPE_IS_SYMLINK, /* S_IFLNK */
77 TOMOYO_TYPE_IS_FILE, /* S_IFREG */
78 TOMOYO_TYPE_IS_BLOCK_DEV, /* S_IFBLK */
79 TOMOYO_TYPE_IS_DIRECTORY, /* S_IFDIR */
80 TOMOYO_TYPE_IS_CHAR_DEV, /* S_IFCHR */
81 TOMOYO_TYPE_IS_FIFO, /* S_IFIFO */
82 TOMOYO_MODE_SETUID, /* S_ISUID */
83 TOMOYO_MODE_SETGID, /* S_ISGID */
84 TOMOYO_MODE_STICKY, /* S_ISVTX */
85 TOMOYO_MODE_OWNER_READ, /* S_IRUSR */
86 TOMOYO_MODE_OWNER_WRITE, /* S_IWUSR */
87 TOMOYO_MODE_OWNER_EXECUTE, /* S_IXUSR */
88 TOMOYO_MODE_GROUP_READ, /* S_IRGRP */
89 TOMOYO_MODE_GROUP_WRITE, /* S_IWGRP */
90 TOMOYO_MODE_GROUP_EXECUTE, /* S_IXGRP */
91 TOMOYO_MODE_OTHERS_READ, /* S_IROTH */
92 TOMOYO_MODE_OTHERS_WRITE, /* S_IWOTH */
93 TOMOYO_MODE_OTHERS_EXECUTE, /* S_IXOTH */
95 TOMOYO_SYMLINK_TARGET,
103 TOMOYO_PATH1_DEV_MAJOR,
104 TOMOYO_PATH1_DEV_MINOR,
112 TOMOYO_PATH2_DEV_MAJOR,
113 TOMOYO_PATH2_DEV_MINOR,
114 TOMOYO_PATH1_PARENT_UID,
115 TOMOYO_PATH1_PARENT_GID,
116 TOMOYO_PATH1_PARENT_INO,
117 TOMOYO_PATH1_PARENT_PERM,
118 TOMOYO_PATH2_PARENT_UID,
119 TOMOYO_PATH2_PARENT_GID,
120 TOMOYO_PATH2_PARENT_INO,
121 TOMOYO_PATH2_PARENT_PERM,
122 TOMOYO_MAX_CONDITION_KEYWORD,
130 /* Index numbers for stat(). */
131 enum tomoyo_path_stat_index {
132 /* Do not change this order. */
140 /* Index numbers for operation mode. */
141 enum tomoyo_mode_index {
142 TOMOYO_CONFIG_DISABLED,
143 TOMOYO_CONFIG_LEARNING,
144 TOMOYO_CONFIG_PERMISSIVE,
145 TOMOYO_CONFIG_ENFORCING,
146 TOMOYO_CONFIG_MAX_MODE,
147 TOMOYO_CONFIG_WANT_REJECT_LOG = 64,
148 TOMOYO_CONFIG_WANT_GRANT_LOG = 128,
149 TOMOYO_CONFIG_USE_DEFAULT = 255,
152 /* Index numbers for entry type. */
153 enum tomoyo_policy_id {
155 TOMOYO_ID_ADDRESS_GROUP,
156 TOMOYO_ID_PATH_GROUP,
157 TOMOYO_ID_NUMBER_GROUP,
158 TOMOYO_ID_TRANSITION_CONTROL,
159 TOMOYO_ID_AGGREGATOR,
168 /* Index numbers for domain's attributes. */
169 enum tomoyo_domain_info_flags_index {
170 /* Quota warnning flag. */
171 TOMOYO_DIF_QUOTA_WARNED,
173 * This domain was unable to create a new domain at
174 * tomoyo_find_next_domain() because the name of the domain to be
175 * created was too long or it could not allocate memory.
176 * More than one process continued execve() without domain transition.
178 TOMOYO_DIF_TRANSITION_FAILED,
179 TOMOYO_MAX_DOMAIN_INFO_FLAGS
182 /* Index numbers for audit type. */
183 enum tomoyo_grant_log {
184 /* Follow profile's configuration. */
185 TOMOYO_GRANTLOG_AUTO,
186 /* Do not generate grant log. */
188 /* Generate grant_log. */
192 /* Index numbers for group entries. */
193 enum tomoyo_group_id {
196 TOMOYO_ADDRESS_GROUP,
200 /* Index numbers for type of numeric values. */
201 enum tomoyo_value_type {
202 TOMOYO_VALUE_TYPE_INVALID,
203 TOMOYO_VALUE_TYPE_DECIMAL,
204 TOMOYO_VALUE_TYPE_OCTAL,
205 TOMOYO_VALUE_TYPE_HEXADECIMAL,
208 /* Index numbers for domain transition control keywords. */
209 enum tomoyo_transition_type {
210 /* Do not change this order, */
211 TOMOYO_TRANSITION_CONTROL_NO_RESET,
212 TOMOYO_TRANSITION_CONTROL_RESET,
213 TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
214 TOMOYO_TRANSITION_CONTROL_INITIALIZE,
215 TOMOYO_TRANSITION_CONTROL_NO_KEEP,
216 TOMOYO_TRANSITION_CONTROL_KEEP,
217 TOMOYO_MAX_TRANSITION_TYPE
220 /* Index numbers for Access Controls. */
221 enum tomoyo_acl_entry_type_index {
222 TOMOYO_TYPE_PATH_ACL,
223 TOMOYO_TYPE_PATH2_ACL,
224 TOMOYO_TYPE_PATH_NUMBER_ACL,
225 TOMOYO_TYPE_MKDEV_ACL,
226 TOMOYO_TYPE_MOUNT_ACL,
227 TOMOYO_TYPE_INET_ACL,
228 TOMOYO_TYPE_UNIX_ACL,
230 TOMOYO_TYPE_MANUAL_TASK_ACL,
233 /* Index numbers for access controls with one pathname. */
234 enum tomoyo_path_acl_index {
242 TOMOYO_TYPE_TRUNCATE,
246 TOMOYO_MAX_PATH_OPERATION
249 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
250 enum tomoyo_memory_stat_type {
251 TOMOYO_MEMORY_POLICY,
254 TOMOYO_MAX_MEMORY_STAT
257 enum tomoyo_mkdev_acl_index {
260 TOMOYO_MAX_MKDEV_OPERATION
263 /* Index numbers for socket operations. */
264 enum tomoyo_network_acl_index {
265 TOMOYO_NETWORK_BIND, /* bind() operation. */
266 TOMOYO_NETWORK_LISTEN, /* listen() operation. */
267 TOMOYO_NETWORK_CONNECT, /* connect() operation. */
268 TOMOYO_NETWORK_SEND, /* send() operation. */
269 TOMOYO_MAX_NETWORK_OPERATION
272 /* Index numbers for access controls with two pathnames. */
273 enum tomoyo_path2_acl_index {
276 TOMOYO_TYPE_PIVOT_ROOT,
277 TOMOYO_MAX_PATH2_OPERATION
280 /* Index numbers for access controls with one pathname and one number. */
281 enum tomoyo_path_number_acl_index {
290 TOMOYO_MAX_PATH_NUMBER_OPERATION
293 /* Index numbers for /sys/kernel/security/tomoyo/ interfaces. */
294 enum tomoyo_securityfs_interface_index {
296 TOMOYO_EXCEPTIONPOLICY,
297 TOMOYO_PROCESS_STATUS,
306 /* Index numbers for special mount operations. */
307 enum tomoyo_special_mount {
308 TOMOYO_MOUNT_BIND, /* mount --bind /source /dest */
309 TOMOYO_MOUNT_MOVE, /* mount --move /old /new */
310 TOMOYO_MOUNT_REMOUNT, /* mount -o remount /dir */
311 TOMOYO_MOUNT_MAKE_UNBINDABLE, /* mount --make-unbindable /dir */
312 TOMOYO_MOUNT_MAKE_PRIVATE, /* mount --make-private /dir */
313 TOMOYO_MOUNT_MAKE_SLAVE, /* mount --make-slave /dir */
314 TOMOYO_MOUNT_MAKE_SHARED, /* mount --make-shared /dir */
315 TOMOYO_MAX_SPECIAL_MOUNT
318 /* Index numbers for functionality. */
319 enum tomoyo_mac_index {
320 TOMOYO_MAC_FILE_EXECUTE,
321 TOMOYO_MAC_FILE_OPEN,
322 TOMOYO_MAC_FILE_CREATE,
323 TOMOYO_MAC_FILE_UNLINK,
324 TOMOYO_MAC_FILE_GETATTR,
325 TOMOYO_MAC_FILE_MKDIR,
326 TOMOYO_MAC_FILE_RMDIR,
327 TOMOYO_MAC_FILE_MKFIFO,
328 TOMOYO_MAC_FILE_MKSOCK,
329 TOMOYO_MAC_FILE_TRUNCATE,
330 TOMOYO_MAC_FILE_SYMLINK,
331 TOMOYO_MAC_FILE_MKBLOCK,
332 TOMOYO_MAC_FILE_MKCHAR,
333 TOMOYO_MAC_FILE_LINK,
334 TOMOYO_MAC_FILE_RENAME,
335 TOMOYO_MAC_FILE_CHMOD,
336 TOMOYO_MAC_FILE_CHOWN,
337 TOMOYO_MAC_FILE_CHGRP,
338 TOMOYO_MAC_FILE_IOCTL,
339 TOMOYO_MAC_FILE_CHROOT,
340 TOMOYO_MAC_FILE_MOUNT,
341 TOMOYO_MAC_FILE_UMOUNT,
342 TOMOYO_MAC_FILE_PIVOT_ROOT,
343 TOMOYO_MAC_NETWORK_INET_STREAM_BIND,
344 TOMOYO_MAC_NETWORK_INET_STREAM_LISTEN,
345 TOMOYO_MAC_NETWORK_INET_STREAM_CONNECT,
346 TOMOYO_MAC_NETWORK_INET_DGRAM_BIND,
347 TOMOYO_MAC_NETWORK_INET_DGRAM_SEND,
348 TOMOYO_MAC_NETWORK_INET_RAW_BIND,
349 TOMOYO_MAC_NETWORK_INET_RAW_SEND,
350 TOMOYO_MAC_NETWORK_UNIX_STREAM_BIND,
351 TOMOYO_MAC_NETWORK_UNIX_STREAM_LISTEN,
352 TOMOYO_MAC_NETWORK_UNIX_STREAM_CONNECT,
353 TOMOYO_MAC_NETWORK_UNIX_DGRAM_BIND,
354 TOMOYO_MAC_NETWORK_UNIX_DGRAM_SEND,
355 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_BIND,
356 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_LISTEN,
357 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_CONNECT,
362 /* Index numbers for category of functionality. */
363 enum tomoyo_mac_category_index {
364 TOMOYO_MAC_CATEGORY_FILE,
365 TOMOYO_MAC_CATEGORY_NETWORK,
366 TOMOYO_MAC_CATEGORY_MISC,
367 TOMOYO_MAX_MAC_CATEGORY_INDEX
371 * Retry this request. Returned by tomoyo_supervisor() if policy violation has
372 * occurred in enforcing mode and the userspace daemon decided to retry.
374 * We must choose a positive value in order to distinguish "granted" (which is
375 * 0) and "rejected" (which is a negative value) and "retry".
377 #define TOMOYO_RETRY_REQUEST 1
379 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
380 enum tomoyo_policy_stat_type {
381 /* Do not change this order. */
382 TOMOYO_STAT_POLICY_UPDATES,
383 TOMOYO_STAT_POLICY_LEARNING, /* == TOMOYO_CONFIG_LEARNING */
384 TOMOYO_STAT_POLICY_PERMISSIVE, /* == TOMOYO_CONFIG_PERMISSIVE */
385 TOMOYO_STAT_POLICY_ENFORCING, /* == TOMOYO_CONFIG_ENFORCING */
386 TOMOYO_MAX_POLICY_STAT
389 /* Index numbers for profile's PREFERENCE values. */
390 enum tomoyo_pref_index {
391 TOMOYO_PREF_MAX_AUDIT_LOG,
392 TOMOYO_PREF_MAX_LEARNING_ENTRY,
396 /********** Structure definitions. **********/
398 /* Common header for holding ACL entries. */
399 struct tomoyo_acl_head {
400 struct list_head list;
404 /* Common header for shared entries. */
405 struct tomoyo_shared_acl_head {
406 struct list_head list;
410 struct tomoyo_policy_namespace;
412 /* Structure for request info. */
413 struct tomoyo_request_info {
415 * For holding parameters specific to operations which deal files.
416 * NULL if not dealing files.
418 struct tomoyo_obj_info *obj;
420 * For holding parameters specific to execve() request.
421 * NULL if not dealing do_execve().
423 struct tomoyo_execve *ee;
424 struct tomoyo_domain_info *domain;
425 /* For holding parameters. */
428 const struct tomoyo_path_info *filename;
429 /* For using wildcards at tomoyo_find_next_domain(). */
430 const struct tomoyo_path_info *matched_path;
431 /* One of values in "enum tomoyo_path_acl_index". */
435 const struct tomoyo_path_info *filename1;
436 const struct tomoyo_path_info *filename2;
437 /* One of values in "enum tomoyo_path2_acl_index". */
441 const struct tomoyo_path_info *filename;
445 /* One of values in "enum tomoyo_mkdev_acl_index". */
449 const struct tomoyo_path_info *filename;
450 unsigned long number;
453 * "enum tomoyo_path_number_acl_index".
458 const struct tomoyo_path_info *name;
461 const __be32 *address;
463 /* One of values smaller than TOMOYO_SOCK_MAX. */
465 /* One of values in "enum tomoyo_network_acl_index". */
470 const struct tomoyo_path_info *address;
471 /* One of values smaller than TOMOYO_SOCK_MAX. */
473 /* One of values in "enum tomoyo_network_acl_index". */
477 const struct tomoyo_path_info *type;
478 const struct tomoyo_path_info *dir;
479 const struct tomoyo_path_info *dev;
484 const struct tomoyo_path_info *domainname;
487 struct tomoyo_acl_info *matched_acl;
492 u8 mode; /* One of tomoyo_mode_index . */
496 /* Structure for holding a token. */
497 struct tomoyo_path_info {
499 u32 hash; /* = full_name_hash(name, strlen(name)) */
500 u16 const_len; /* = tomoyo_const_part_length(name) */
501 bool is_dir; /* = tomoyo_strendswith(name, "/") */
502 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
505 /* Structure for holding string data. */
507 struct tomoyo_shared_acl_head head;
508 struct tomoyo_path_info entry;
511 /* Structure for holding a word. */
512 struct tomoyo_name_union {
513 /* Either @filename or @group is NULL. */
514 const struct tomoyo_path_info *filename;
515 struct tomoyo_group *group;
518 /* Structure for holding a number. */
519 struct tomoyo_number_union {
520 unsigned long values[2];
521 struct tomoyo_group *group; /* Maybe NULL. */
522 /* One of values in "enum tomoyo_value_type". */
526 /* Structure for holding an IP address. */
527 struct tomoyo_ipaddr_union {
528 struct in6_addr ip[2]; /* Big endian. */
529 struct tomoyo_group *group; /* Pointer to address group. */
530 bool is_ipv6; /* Valid only if @group == NULL. */
533 /* Structure for "path_group"/"number_group"/"address_group" directive. */
534 struct tomoyo_group {
535 struct tomoyo_shared_acl_head head;
536 const struct tomoyo_path_info *group_name;
537 struct list_head member_list;
540 /* Structure for "path_group" directive. */
541 struct tomoyo_path_group {
542 struct tomoyo_acl_head head;
543 const struct tomoyo_path_info *member_name;
546 /* Structure for "number_group" directive. */
547 struct tomoyo_number_group {
548 struct tomoyo_acl_head head;
549 struct tomoyo_number_union number;
552 /* Structure for "address_group" directive. */
553 struct tomoyo_address_group {
554 struct tomoyo_acl_head head;
555 /* Structure for holding an IP address. */
556 struct tomoyo_ipaddr_union address;
559 /* Subset of "struct stat". Used by conditional ACL and audit logs. */
560 struct tomoyo_mini_stat {
569 /* Structure for dumping argv[] and envp[] of "struct linux_binprm". */
570 struct tomoyo_page_dump {
571 struct page *page; /* Previously dumped page. */
572 char *data; /* Contents of "page". Size is PAGE_SIZE. */
575 /* Structure for attribute checks in addition to pathname checks. */
576 struct tomoyo_obj_info {
578 * True if tomoyo_get_attributes() was already called, false otherwise.
581 /* True if @stat[] is valid. */
582 bool stat_valid[TOMOYO_MAX_PATH_STAT];
583 /* First pathname. Initialized with { NULL, NULL } if no path. */
585 /* Second pathname. Initialized with { NULL, NULL } if no path. */
588 * Information on @path1, @path1's parent directory, @path2, @path2's
591 struct tomoyo_mini_stat stat[TOMOYO_MAX_PATH_STAT];
593 * Content of symbolic link to be created. NULL for operations other
596 struct tomoyo_path_info *symlink_target;
599 /* Structure for argv[]. */
602 const struct tomoyo_path_info *value;
606 /* Structure for envp[]. */
608 const struct tomoyo_path_info *name;
609 const struct tomoyo_path_info *value;
613 /* Structure for execve() operation. */
614 struct tomoyo_execve {
615 struct tomoyo_request_info r;
616 struct tomoyo_obj_info obj;
617 struct linux_binprm *bprm;
618 const struct tomoyo_path_info *transition;
619 /* For dumping argv[] and envp[]. */
620 struct tomoyo_page_dump dump;
621 /* For temporary use. */
622 char *tmp; /* Size is TOMOYO_EXEC_TMPSIZE bytes */
625 /* Structure for entries which follows "struct tomoyo_condition". */
626 struct tomoyo_condition_element {
628 * Left hand operand. A "struct tomoyo_argv" for TOMOYO_ARGV_ENTRY, a
629 * "struct tomoyo_envp" for TOMOYO_ENVP_ENTRY is attached to the tail
630 * of the array of this struct.
634 * Right hand operand. A "struct tomoyo_number_union" for
635 * TOMOYO_NUMBER_UNION, a "struct tomoyo_name_union" for
636 * TOMOYO_NAME_UNION is attached to the tail of the array of this
640 /* Equation operator. True if equals or overlaps, false otherwise. */
644 /* Structure for optional arguments. */
645 struct tomoyo_condition {
646 struct tomoyo_shared_acl_head head;
647 u32 size; /* Memory size allocated for this entry. */
648 u16 condc; /* Number of conditions in this struct. */
649 u16 numbers_count; /* Number of "struct tomoyo_number_union values". */
650 u16 names_count; /* Number of "struct tomoyo_name_union names". */
651 u16 argc; /* Number of "struct tomoyo_argv". */
652 u16 envc; /* Number of "struct tomoyo_envp". */
653 u8 grant_log; /* One of values in "enum tomoyo_grant_log". */
654 const struct tomoyo_path_info *transit; /* Maybe NULL. */
656 * struct tomoyo_condition_element condition[condc];
657 * struct tomoyo_number_union values[numbers_count];
658 * struct tomoyo_name_union names[names_count];
659 * struct tomoyo_argv argv[argc];
660 * struct tomoyo_envp envp[envc];
664 /* Common header for individual entries. */
665 struct tomoyo_acl_info {
666 struct list_head list;
667 struct tomoyo_condition *cond; /* Maybe NULL. */
669 u8 type; /* One of values in "enum tomoyo_acl_entry_type_index". */
672 /* Structure for domain information. */
673 struct tomoyo_domain_info {
674 struct list_head list;
675 struct list_head acl_info_list;
676 /* Name of this domain. Never NULL. */
677 const struct tomoyo_path_info *domainname;
678 /* Namespace for this domain. Never NULL. */
679 struct tomoyo_policy_namespace *ns;
680 u8 profile; /* Profile number to use. */
681 u8 group; /* Group number to use. */
682 bool is_deleted; /* Delete flag. */
683 bool flags[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
684 atomic_t users; /* Number of referring credentials. */
688 * Structure for "task manual_domain_transition" directive.
690 struct tomoyo_task_acl {
691 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MANUAL_TASK_ACL */
692 /* Pointer to domainname. */
693 const struct tomoyo_path_info *domainname;
697 * Structure for "file execute", "file read", "file write", "file append",
698 * "file unlink", "file getattr", "file rmdir", "file truncate",
699 * "file symlink", "file chroot" and "file unmount" directive.
701 struct tomoyo_path_acl {
702 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
703 u16 perm; /* Bitmask of values in "enum tomoyo_path_acl_index". */
704 struct tomoyo_name_union name;
708 * Structure for "file create", "file mkdir", "file mkfifo", "file mksock",
709 * "file ioctl", "file chmod", "file chown" and "file chgrp" directive.
711 struct tomoyo_path_number_acl {
712 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
713 /* Bitmask of values in "enum tomoyo_path_number_acl_index". */
715 struct tomoyo_name_union name;
716 struct tomoyo_number_union number;
719 /* Structure for "file mkblock" and "file mkchar" directive. */
720 struct tomoyo_mkdev_acl {
721 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
722 u8 perm; /* Bitmask of values in "enum tomoyo_mkdev_acl_index". */
723 struct tomoyo_name_union name;
724 struct tomoyo_number_union mode;
725 struct tomoyo_number_union major;
726 struct tomoyo_number_union minor;
730 * Structure for "file rename", "file link" and "file pivot_root" directive.
732 struct tomoyo_path2_acl {
733 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
734 u8 perm; /* Bitmask of values in "enum tomoyo_path2_acl_index". */
735 struct tomoyo_name_union name1;
736 struct tomoyo_name_union name2;
739 /* Structure for "file mount" directive. */
740 struct tomoyo_mount_acl {
741 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
742 struct tomoyo_name_union dev_name;
743 struct tomoyo_name_union dir_name;
744 struct tomoyo_name_union fs_type;
745 struct tomoyo_number_union flags;
748 /* Structure for "misc env" directive in domain policy. */
749 struct tomoyo_env_acl {
750 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_ENV_ACL */
751 const struct tomoyo_path_info *env; /* environment variable */
754 /* Structure for "network inet" directive. */
755 struct tomoyo_inet_acl {
756 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_INET_ACL */
758 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
759 struct tomoyo_ipaddr_union address;
760 struct tomoyo_number_union port;
763 /* Structure for "network unix" directive. */
764 struct tomoyo_unix_acl {
765 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_UNIX_ACL */
767 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
768 struct tomoyo_name_union name;
771 /* Structure for holding a line from /sys/kernel/security/tomoyo/ interface. */
772 struct tomoyo_acl_param {
774 struct list_head *list;
775 struct tomoyo_policy_namespace *ns;
779 #define TOMOYO_MAX_IO_READ_QUEUE 64
782 * Structure for reading/writing policy via /sys/kernel/security/tomoyo
785 struct tomoyo_io_buffer {
786 void (*read) (struct tomoyo_io_buffer *);
787 int (*write) (struct tomoyo_io_buffer *);
788 int (*poll) (struct file *file, poll_table *wait);
789 /* Exclusive lock for this structure. */
791 char __user *read_user_buf;
792 size_t read_user_buf_avail;
794 struct list_head *ns;
795 struct list_head *domain;
796 struct list_head *group;
797 struct list_head *acl;
800 unsigned int query_index;
808 bool print_this_domain_only;
809 bool print_transition_related_only;
810 bool print_cond_part;
811 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
814 struct tomoyo_policy_namespace *ns;
815 /* The position currently writing to. */
816 struct tomoyo_domain_info *domain;
817 /* Bytes available for writing. */
821 /* Buffer for reading. */
823 /* Size of read buffer. */
825 /* Buffer for writing. */
827 /* Size of write buffer. */
828 size_t writebuf_size;
829 /* Type of this interface. */
830 enum tomoyo_securityfs_interface_index type;
831 /* Users counter protected by tomoyo_io_buffer_list_lock. */
833 /* List for telling GC not to kfree() elements. */
834 struct list_head list;
838 * Structure for "initialize_domain"/"no_initialize_domain"/"keep_domain"/
839 * "no_keep_domain" keyword.
841 struct tomoyo_transition_control {
842 struct tomoyo_acl_head head;
843 u8 type; /* One of values in "enum tomoyo_transition_type". */
844 /* True if the domainname is tomoyo_get_last_name(). */
846 const struct tomoyo_path_info *domainname; /* Maybe NULL */
847 const struct tomoyo_path_info *program; /* Maybe NULL */
850 /* Structure for "aggregator" keyword. */
851 struct tomoyo_aggregator {
852 struct tomoyo_acl_head head;
853 const struct tomoyo_path_info *original_name;
854 const struct tomoyo_path_info *aggregated_name;
857 /* Structure for policy manager. */
858 struct tomoyo_manager {
859 struct tomoyo_acl_head head;
860 bool is_domain; /* True if manager is a domainname. */
861 /* A path to program or a domainname. */
862 const struct tomoyo_path_info *manager;
865 struct tomoyo_preference {
866 unsigned int learning_max_entry;
867 bool enforcing_verbose;
868 bool learning_verbose;
869 bool permissive_verbose;
872 /* Structure for /sys/kernel/security/tomnoyo/profile interface. */
873 struct tomoyo_profile {
874 const struct tomoyo_path_info *comment;
875 struct tomoyo_preference *learning;
876 struct tomoyo_preference *permissive;
877 struct tomoyo_preference *enforcing;
878 struct tomoyo_preference preference;
880 u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
881 unsigned int pref[TOMOYO_MAX_PREF];
884 /* Structure for representing YYYY/MM/DD hh/mm/ss. */
894 /* Structure for policy namespace. */
895 struct tomoyo_policy_namespace {
896 /* Profile table. Memory is allocated as needed. */
897 struct tomoyo_profile *profile_ptr[TOMOYO_MAX_PROFILES];
898 /* List of "struct tomoyo_group". */
899 struct list_head group_list[TOMOYO_MAX_GROUP];
900 /* List of policy. */
901 struct list_head policy_list[TOMOYO_MAX_POLICY];
902 /* The global ACL referred by "use_group" keyword. */
903 struct list_head acl_group[TOMOYO_MAX_ACL_GROUPS];
904 /* List for connecting to tomoyo_namespace_list list. */
905 struct list_head namespace_list;
906 /* Profile version. Currently only 20110903 is defined. */
907 unsigned int profile_version;
908 /* Name of this namespace (e.g. "<kernel>", "</usr/sbin/httpd>" ). */
912 /********** Function prototypes. **********/
914 bool tomoyo_address_matches_group(const bool is_ipv6, const __be32 *address,
915 const struct tomoyo_group *group);
916 bool tomoyo_compare_number_union(const unsigned long value,
917 const struct tomoyo_number_union *ptr);
918 bool tomoyo_condition(struct tomoyo_request_info *r,
919 const struct tomoyo_condition *cond);
920 bool tomoyo_correct_domain(const unsigned char *domainname);
921 bool tomoyo_correct_path(const char *filename);
922 bool tomoyo_correct_word(const char *string);
923 bool tomoyo_domain_def(const unsigned char *buffer);
924 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
925 bool tomoyo_dump_page(struct linux_binprm *bprm, unsigned long pos,
926 struct tomoyo_page_dump *dump);
927 bool tomoyo_memory_ok(void *ptr);
928 bool tomoyo_number_matches_group(const unsigned long min,
929 const unsigned long max,
930 const struct tomoyo_group *group);
931 bool tomoyo_parse_ipaddr_union(struct tomoyo_acl_param *param,
932 struct tomoyo_ipaddr_union *ptr);
933 bool tomoyo_parse_name_union(struct tomoyo_acl_param *param,
934 struct tomoyo_name_union *ptr);
935 bool tomoyo_parse_number_union(struct tomoyo_acl_param *param,
936 struct tomoyo_number_union *ptr);
937 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
938 const struct tomoyo_path_info *pattern);
939 bool tomoyo_permstr(const char *string, const char *keyword);
940 bool tomoyo_str_starts(char **src, const char *find);
941 char *tomoyo_encode(const char *str);
942 char *tomoyo_encode2(const char *str, int str_len);
943 char *tomoyo_init_log(struct tomoyo_request_info *r, int len, const char *fmt,
945 char *tomoyo_read_token(struct tomoyo_acl_param *param);
946 char *tomoyo_realpath_from_path(struct path *path);
947 char *tomoyo_realpath_nofollow(const char *pathname);
948 const char *tomoyo_get_exe(void);
949 const char *tomoyo_yesno(const unsigned int value);
950 const struct tomoyo_path_info *tomoyo_compare_name_union
951 (const struct tomoyo_path_info *name, const struct tomoyo_name_union *ptr);
952 const struct tomoyo_path_info *tomoyo_get_domainname
953 (struct tomoyo_acl_param *param);
954 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
955 const struct tomoyo_path_info *tomoyo_path_matches_group
956 (const struct tomoyo_path_info *pathname, const struct tomoyo_group *group);
957 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
958 struct path *path, const int flag);
959 int tomoyo_close_control(struct tomoyo_io_buffer *head);
960 int tomoyo_env_perm(struct tomoyo_request_info *r, const char *env);
961 int tomoyo_execute_permission(struct tomoyo_request_info *r,
962 const struct tomoyo_path_info *filename);
963 int tomoyo_find_next_domain(struct linux_binprm *bprm);
964 int tomoyo_get_mode(const struct tomoyo_policy_namespace *ns, const u8 profile,
966 int tomoyo_init_request_info(struct tomoyo_request_info *r,
967 struct tomoyo_domain_info *domain,
969 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
970 const unsigned int mode, unsigned int dev);
971 int tomoyo_mount_permission(char *dev_name, struct path *path,
972 const char *type, unsigned long flags,
974 int tomoyo_open_control(const u8 type, struct file *file);
975 int tomoyo_path2_perm(const u8 operation, struct path *path1,
977 int tomoyo_path_number_perm(const u8 operation, struct path *path,
978 unsigned long number);
979 int tomoyo_path_perm(const u8 operation, struct path *path,
981 int tomoyo_path_permission(struct tomoyo_request_info *r, u8 operation,
982 const struct tomoyo_path_info *filename);
983 int tomoyo_poll_control(struct file *file, poll_table *wait);
984 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_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
1046 void tomoyo_load_policy(const char *filename);
1047 void tomoyo_memory_free(void *ptr);
1048 void tomoyo_normalize_line(unsigned char *buffer);
1049 void tomoyo_notify_gc(struct tomoyo_io_buffer *head, const bool is_register);
1050 void tomoyo_print_ip(char *buf, const unsigned int size,
1051 const struct tomoyo_ipaddr_union *ptr);
1052 void tomoyo_print_ulong(char *buffer, const int buffer_len,
1053 const unsigned long value, const u8 type);
1054 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
1055 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
1056 void tomoyo_read_log(struct tomoyo_io_buffer *head);
1057 void tomoyo_update_stat(const u8 index);
1058 void tomoyo_warn_oom(const char *function);
1059 void tomoyo_write_log(struct tomoyo_request_info *r, const char *fmt, ...)
1061 void tomoyo_write_log2(struct tomoyo_request_info *r, int len, const char *fmt,
1064 /********** External variable definitions. **********/
1066 extern bool tomoyo_policy_loaded;
1067 extern const char * const tomoyo_condition_keyword
1068 [TOMOYO_MAX_CONDITION_KEYWORD];
1069 extern const char * const tomoyo_dif[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
1070 extern const char * const tomoyo_mac_keywords[TOMOYO_MAX_MAC_INDEX
1071 + TOMOYO_MAX_MAC_CATEGORY_INDEX];
1072 extern const char * const tomoyo_mode[TOMOYO_CONFIG_MAX_MODE];
1073 extern const char * const tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
1074 extern const char * const tomoyo_proto_keyword[TOMOYO_SOCK_MAX];
1075 extern const char * const tomoyo_socket_keyword[TOMOYO_MAX_NETWORK_OPERATION];
1076 extern const u8 tomoyo_index2category[TOMOYO_MAX_MAC_INDEX];
1077 extern const u8 tomoyo_pn2mac[TOMOYO_MAX_PATH_NUMBER_OPERATION];
1078 extern const u8 tomoyo_pnnn2mac[TOMOYO_MAX_MKDEV_OPERATION];
1079 extern const u8 tomoyo_pp2mac[TOMOYO_MAX_PATH2_OPERATION];
1080 extern struct list_head tomoyo_condition_list;
1081 extern struct list_head tomoyo_domain_list;
1082 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
1083 extern struct list_head tomoyo_namespace_list;
1084 extern struct mutex tomoyo_policy_lock;
1085 extern struct srcu_struct tomoyo_ss;
1086 extern struct tomoyo_domain_info tomoyo_kernel_domain;
1087 extern struct tomoyo_policy_namespace tomoyo_kernel_namespace;
1088 extern unsigned int tomoyo_memory_quota[TOMOYO_MAX_MEMORY_STAT];
1089 extern unsigned int tomoyo_memory_used[TOMOYO_MAX_MEMORY_STAT];
1091 /********** Inlined functions. **********/
1094 * tomoyo_read_lock - Take lock for protecting policy.
1096 * Returns index number for tomoyo_read_unlock().
1098 static inline int tomoyo_read_lock(void)
1100 return srcu_read_lock(&tomoyo_ss);
1104 * tomoyo_read_unlock - Release lock for protecting policy.
1106 * @idx: Index number returned by tomoyo_read_lock().
1110 static inline void tomoyo_read_unlock(int idx)
1112 srcu_read_unlock(&tomoyo_ss, idx);
1116 * tomoyo_sys_getppid - Copy of getppid().
1118 * Returns parent process's PID.
1120 * Alpha does not have getppid() defined. To be able to build this module on
1121 * Alpha, I have to copy getppid() from kernel/timer.c.
1123 static inline pid_t tomoyo_sys_getppid(void)
1127 pid = task_tgid_vnr(current->real_parent);
1133 * tomoyo_sys_getpid - Copy of getpid().
1135 * Returns current thread's PID.
1137 * Alpha does not have getpid() defined. To be able to build this module on
1138 * Alpha, I have to copy getpid() from kernel/timer.c.
1140 static inline pid_t tomoyo_sys_getpid(void)
1142 return task_tgid_vnr(current);
1146 * tomoyo_pathcmp - strcmp() for "struct tomoyo_path_info" structure.
1148 * @a: Pointer to "struct tomoyo_path_info".
1149 * @b: Pointer to "struct tomoyo_path_info".
1151 * Returns true if @a == @b, false otherwise.
1153 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
1154 const struct tomoyo_path_info *b)
1156 return a->hash != b->hash || strcmp(a->name, b->name);
1160 * tomoyo_put_name - Drop reference on "struct tomoyo_name".
1162 * @name: Pointer to "struct tomoyo_path_info". Maybe NULL.
1166 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
1169 struct tomoyo_name *ptr =
1170 container_of(name, typeof(*ptr), entry);
1171 atomic_dec(&ptr->head.users);
1176 * tomoyo_put_condition - Drop reference on "struct tomoyo_condition".
1178 * @cond: Pointer to "struct tomoyo_condition". Maybe NULL.
1182 static inline void tomoyo_put_condition(struct tomoyo_condition *cond)
1185 atomic_dec(&cond->head.users);
1189 * tomoyo_put_group - Drop reference on "struct tomoyo_group".
1191 * @group: Pointer to "struct tomoyo_group". Maybe NULL.
1195 static inline void tomoyo_put_group(struct tomoyo_group *group)
1198 atomic_dec(&group->head.users);
1202 * tomoyo_domain - Get "struct tomoyo_domain_info" for current thread.
1204 * Returns pointer to "struct tomoyo_domain_info" for current thread.
1206 static inline struct tomoyo_domain_info *tomoyo_domain(void)
1208 return current_cred()->security;
1212 * tomoyo_real_domain - Get "struct tomoyo_domain_info" for specified thread.
1214 * @task: Pointer to "struct task_struct".
1216 * Returns pointer to "struct tomoyo_security" for specified thread.
1218 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
1221 return task_cred_xxx(task, security);
1225 * tomoyo_same_name_union - Check for duplicated "struct tomoyo_name_union" entry.
1227 * @a: Pointer to "struct tomoyo_name_union".
1228 * @b: Pointer to "struct tomoyo_name_union".
1230 * Returns true if @a == @b, false otherwise.
1232 static inline bool tomoyo_same_name_union
1233 (const struct tomoyo_name_union *a, const struct tomoyo_name_union *b)
1235 return a->filename == b->filename && a->group == b->group;
1239 * tomoyo_same_number_union - Check for duplicated "struct tomoyo_number_union" entry.
1241 * @a: Pointer to "struct tomoyo_number_union".
1242 * @b: Pointer to "struct tomoyo_number_union".
1244 * Returns true if @a == @b, false otherwise.
1246 static inline bool tomoyo_same_number_union
1247 (const struct tomoyo_number_union *a, const struct tomoyo_number_union *b)
1249 return a->values[0] == b->values[0] && a->values[1] == b->values[1] &&
1250 a->group == b->group && a->value_type[0] == b->value_type[0] &&
1251 a->value_type[1] == b->value_type[1];
1255 * tomoyo_same_ipaddr_union - Check for duplicated "struct tomoyo_ipaddr_union" entry.
1257 * @a: Pointer to "struct tomoyo_ipaddr_union".
1258 * @b: Pointer to "struct tomoyo_ipaddr_union".
1260 * Returns true if @a == @b, false otherwise.
1262 static inline bool tomoyo_same_ipaddr_union
1263 (const struct tomoyo_ipaddr_union *a, const struct tomoyo_ipaddr_union *b)
1265 return !memcmp(a->ip, b->ip, sizeof(a->ip)) && a->group == b->group &&
1266 a->is_ipv6 == b->is_ipv6;
1270 * tomoyo_current_namespace - Get "struct tomoyo_policy_namespace" for current thread.
1272 * Returns pointer to "struct tomoyo_policy_namespace" for current thread.
1274 static inline struct tomoyo_policy_namespace *tomoyo_current_namespace(void)
1276 return tomoyo_domain()->ns;
1279 #if defined(CONFIG_SLOB)
1282 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1284 * @size: Size to be rounded up.
1288 * Since SLOB does not round up, this function simply returns @size.
1290 static inline int tomoyo_round2(size_t size)
1298 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1300 * @size: Size to be rounded up.
1302 * Returns rounded size.
1304 * Strictly speaking, SLAB may be able to allocate (e.g.) 96 bytes instead of
1307 static inline int tomoyo_round2(size_t size)
1309 #if PAGE_SIZE == 4096
1316 while (size > bsize)
1324 * list_for_each_cookie - iterate over a list with cookie.
1325 * @pos: the &struct list_head to use as a loop cursor.
1326 * @head: the head for your list.
1328 #define list_for_each_cookie(pos, head) \
1330 pos = srcu_dereference((head)->next, &tomoyo_ss); \
1331 for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
1333 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */