2 * security/tomoyo/common.h
4 * Header file for TOMOYO.
6 * Copyright (C) 2005-2010 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 group entries. */
183 enum tomoyo_group_id {
186 TOMOYO_ADDRESS_GROUP,
190 /* Index numbers for type of numeric values. */
191 enum tomoyo_value_type {
192 TOMOYO_VALUE_TYPE_INVALID,
193 TOMOYO_VALUE_TYPE_DECIMAL,
194 TOMOYO_VALUE_TYPE_OCTAL,
195 TOMOYO_VALUE_TYPE_HEXADECIMAL,
198 /* Index numbers for domain transition control keywords. */
199 enum tomoyo_transition_type {
200 /* Do not change this order, */
201 TOMOYO_TRANSITION_CONTROL_NO_RESET,
202 TOMOYO_TRANSITION_CONTROL_RESET,
203 TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
204 TOMOYO_TRANSITION_CONTROL_INITIALIZE,
205 TOMOYO_TRANSITION_CONTROL_NO_KEEP,
206 TOMOYO_TRANSITION_CONTROL_KEEP,
207 TOMOYO_MAX_TRANSITION_TYPE
210 /* Index numbers for Access Controls. */
211 enum tomoyo_acl_entry_type_index {
212 TOMOYO_TYPE_PATH_ACL,
213 TOMOYO_TYPE_PATH2_ACL,
214 TOMOYO_TYPE_PATH_NUMBER_ACL,
215 TOMOYO_TYPE_MKDEV_ACL,
216 TOMOYO_TYPE_MOUNT_ACL,
217 TOMOYO_TYPE_INET_ACL,
218 TOMOYO_TYPE_UNIX_ACL,
222 /* Index numbers for access controls with one pathname. */
223 enum tomoyo_path_acl_index {
231 TOMOYO_TYPE_TRUNCATE,
235 TOMOYO_MAX_PATH_OPERATION
238 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
239 enum tomoyo_memory_stat_type {
240 TOMOYO_MEMORY_POLICY,
243 TOMOYO_MAX_MEMORY_STAT
246 enum tomoyo_mkdev_acl_index {
249 TOMOYO_MAX_MKDEV_OPERATION
252 /* Index numbers for socket operations. */
253 enum tomoyo_network_acl_index {
254 TOMOYO_NETWORK_BIND, /* bind() operation. */
255 TOMOYO_NETWORK_LISTEN, /* listen() operation. */
256 TOMOYO_NETWORK_CONNECT, /* connect() operation. */
257 TOMOYO_NETWORK_SEND, /* send() operation. */
258 TOMOYO_MAX_NETWORK_OPERATION
261 /* Index numbers for access controls with two pathnames. */
262 enum tomoyo_path2_acl_index {
265 TOMOYO_TYPE_PIVOT_ROOT,
266 TOMOYO_MAX_PATH2_OPERATION
269 /* Index numbers for access controls with one pathname and one number. */
270 enum tomoyo_path_number_acl_index {
279 TOMOYO_MAX_PATH_NUMBER_OPERATION
282 /* Index numbers for /sys/kernel/security/tomoyo/ interfaces. */
283 enum tomoyo_securityfs_interface_index {
285 TOMOYO_EXCEPTIONPOLICY,
286 TOMOYO_PROCESS_STATUS,
296 /* Index numbers for special mount operations. */
297 enum tomoyo_special_mount {
298 TOMOYO_MOUNT_BIND, /* mount --bind /source /dest */
299 TOMOYO_MOUNT_MOVE, /* mount --move /old /new */
300 TOMOYO_MOUNT_REMOUNT, /* mount -o remount /dir */
301 TOMOYO_MOUNT_MAKE_UNBINDABLE, /* mount --make-unbindable /dir */
302 TOMOYO_MOUNT_MAKE_PRIVATE, /* mount --make-private /dir */
303 TOMOYO_MOUNT_MAKE_SLAVE, /* mount --make-slave /dir */
304 TOMOYO_MOUNT_MAKE_SHARED, /* mount --make-shared /dir */
305 TOMOYO_MAX_SPECIAL_MOUNT
308 /* Index numbers for functionality. */
309 enum tomoyo_mac_index {
310 TOMOYO_MAC_FILE_EXECUTE,
311 TOMOYO_MAC_FILE_OPEN,
312 TOMOYO_MAC_FILE_CREATE,
313 TOMOYO_MAC_FILE_UNLINK,
314 TOMOYO_MAC_FILE_GETATTR,
315 TOMOYO_MAC_FILE_MKDIR,
316 TOMOYO_MAC_FILE_RMDIR,
317 TOMOYO_MAC_FILE_MKFIFO,
318 TOMOYO_MAC_FILE_MKSOCK,
319 TOMOYO_MAC_FILE_TRUNCATE,
320 TOMOYO_MAC_FILE_SYMLINK,
321 TOMOYO_MAC_FILE_MKBLOCK,
322 TOMOYO_MAC_FILE_MKCHAR,
323 TOMOYO_MAC_FILE_LINK,
324 TOMOYO_MAC_FILE_RENAME,
325 TOMOYO_MAC_FILE_CHMOD,
326 TOMOYO_MAC_FILE_CHOWN,
327 TOMOYO_MAC_FILE_CHGRP,
328 TOMOYO_MAC_FILE_IOCTL,
329 TOMOYO_MAC_FILE_CHROOT,
330 TOMOYO_MAC_FILE_MOUNT,
331 TOMOYO_MAC_FILE_UMOUNT,
332 TOMOYO_MAC_FILE_PIVOT_ROOT,
333 TOMOYO_MAC_NETWORK_INET_STREAM_BIND,
334 TOMOYO_MAC_NETWORK_INET_STREAM_LISTEN,
335 TOMOYO_MAC_NETWORK_INET_STREAM_CONNECT,
336 TOMOYO_MAC_NETWORK_INET_DGRAM_BIND,
337 TOMOYO_MAC_NETWORK_INET_DGRAM_SEND,
338 TOMOYO_MAC_NETWORK_INET_RAW_BIND,
339 TOMOYO_MAC_NETWORK_INET_RAW_SEND,
340 TOMOYO_MAC_NETWORK_UNIX_STREAM_BIND,
341 TOMOYO_MAC_NETWORK_UNIX_STREAM_LISTEN,
342 TOMOYO_MAC_NETWORK_UNIX_STREAM_CONNECT,
343 TOMOYO_MAC_NETWORK_UNIX_DGRAM_BIND,
344 TOMOYO_MAC_NETWORK_UNIX_DGRAM_SEND,
345 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_BIND,
346 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_LISTEN,
347 TOMOYO_MAC_NETWORK_UNIX_SEQPACKET_CONNECT,
352 /* Index numbers for category of functionality. */
353 enum tomoyo_mac_category_index {
354 TOMOYO_MAC_CATEGORY_FILE,
355 TOMOYO_MAC_CATEGORY_NETWORK,
356 TOMOYO_MAC_CATEGORY_MISC,
357 TOMOYO_MAX_MAC_CATEGORY_INDEX
361 * Retry this request. Returned by tomoyo_supervisor() if policy violation has
362 * occurred in enforcing mode and the userspace daemon decided to retry.
364 * We must choose a positive value in order to distinguish "granted" (which is
365 * 0) and "rejected" (which is a negative value) and "retry".
367 #define TOMOYO_RETRY_REQUEST 1
369 /* Index numbers for /sys/kernel/security/tomoyo/stat interface. */
370 enum tomoyo_policy_stat_type {
371 /* Do not change this order. */
372 TOMOYO_STAT_POLICY_UPDATES,
373 TOMOYO_STAT_POLICY_LEARNING, /* == TOMOYO_CONFIG_LEARNING */
374 TOMOYO_STAT_POLICY_PERMISSIVE, /* == TOMOYO_CONFIG_PERMISSIVE */
375 TOMOYO_STAT_POLICY_ENFORCING, /* == TOMOYO_CONFIG_ENFORCING */
376 TOMOYO_MAX_POLICY_STAT
379 /* Index numbers for profile's PREFERENCE values. */
380 enum tomoyo_pref_index {
381 TOMOYO_PREF_MAX_AUDIT_LOG,
382 TOMOYO_PREF_MAX_LEARNING_ENTRY,
386 /********** Structure definitions. **********/
388 /* Common header for holding ACL entries. */
389 struct tomoyo_acl_head {
390 struct list_head list;
394 /* Common header for shared entries. */
395 struct tomoyo_shared_acl_head {
396 struct list_head list;
400 struct tomoyo_policy_namespace;
402 /* Structure for request info. */
403 struct tomoyo_request_info {
405 * For holding parameters specific to operations which deal files.
406 * NULL if not dealing files.
408 struct tomoyo_obj_info *obj;
410 * For holding parameters specific to execve() request.
411 * NULL if not dealing do_execve().
413 struct tomoyo_execve *ee;
414 struct tomoyo_domain_info *domain;
415 /* For holding parameters. */
418 const struct tomoyo_path_info *filename;
419 /* For using wildcards at tomoyo_find_next_domain(). */
420 const struct tomoyo_path_info *matched_path;
421 /* One of values in "enum tomoyo_path_acl_index". */
425 const struct tomoyo_path_info *filename1;
426 const struct tomoyo_path_info *filename2;
427 /* One of values in "enum tomoyo_path2_acl_index". */
431 const struct tomoyo_path_info *filename;
435 /* One of values in "enum tomoyo_mkdev_acl_index". */
439 const struct tomoyo_path_info *filename;
440 unsigned long number;
443 * "enum tomoyo_path_number_acl_index".
448 const struct tomoyo_path_info *name;
451 const __be32 *address;
453 /* One of values smaller than TOMOYO_SOCK_MAX. */
455 /* One of values in "enum tomoyo_network_acl_index". */
460 const struct tomoyo_path_info *address;
461 /* One of values smaller than TOMOYO_SOCK_MAX. */
463 /* One of values in "enum tomoyo_network_acl_index". */
467 const struct tomoyo_path_info *type;
468 const struct tomoyo_path_info *dir;
469 const struct tomoyo_path_info *dev;
478 u8 mode; /* One of tomoyo_mode_index . */
482 /* Structure for holding a token. */
483 struct tomoyo_path_info {
485 u32 hash; /* = full_name_hash(name, strlen(name)) */
486 u16 const_len; /* = tomoyo_const_part_length(name) */
487 bool is_dir; /* = tomoyo_strendswith(name, "/") */
488 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
491 /* Structure for holding string data. */
493 struct tomoyo_shared_acl_head head;
494 struct tomoyo_path_info entry;
497 /* Structure for holding a word. */
498 struct tomoyo_name_union {
499 /* Either @filename or @group is NULL. */
500 const struct tomoyo_path_info *filename;
501 struct tomoyo_group *group;
504 /* Structure for holding a number. */
505 struct tomoyo_number_union {
506 unsigned long values[2];
507 struct tomoyo_group *group; /* Maybe NULL. */
508 /* One of values in "enum tomoyo_value_type". */
512 /* Structure for holding an IP address. */
513 struct tomoyo_ipaddr_union {
514 struct in6_addr ip[2]; /* Big endian. */
515 struct tomoyo_group *group; /* Pointer to address group. */
516 bool is_ipv6; /* Valid only if @group == NULL. */
519 /* Structure for "path_group"/"number_group"/"address_group" directive. */
520 struct tomoyo_group {
521 struct tomoyo_shared_acl_head head;
522 const struct tomoyo_path_info *group_name;
523 struct list_head member_list;
526 /* Structure for "path_group" directive. */
527 struct tomoyo_path_group {
528 struct tomoyo_acl_head head;
529 const struct tomoyo_path_info *member_name;
532 /* Structure for "number_group" directive. */
533 struct tomoyo_number_group {
534 struct tomoyo_acl_head head;
535 struct tomoyo_number_union number;
538 /* Structure for "address_group" directive. */
539 struct tomoyo_address_group {
540 struct tomoyo_acl_head head;
541 /* Structure for holding an IP address. */
542 struct tomoyo_ipaddr_union address;
545 /* Subset of "struct stat". Used by conditional ACL and audit logs. */
546 struct tomoyo_mini_stat {
555 /* Structure for dumping argv[] and envp[] of "struct linux_binprm". */
556 struct tomoyo_page_dump {
557 struct page *page; /* Previously dumped page. */
558 char *data; /* Contents of "page". Size is PAGE_SIZE. */
561 /* Structure for attribute checks in addition to pathname checks. */
562 struct tomoyo_obj_info {
564 * True if tomoyo_get_attributes() was already called, false otherwise.
567 /* True if @stat[] is valid. */
568 bool stat_valid[TOMOYO_MAX_PATH_STAT];
569 /* First pathname. Initialized with { NULL, NULL } if no path. */
571 /* Second pathname. Initialized with { NULL, NULL } if no path. */
574 * Information on @path1, @path1's parent directory, @path2, @path2's
577 struct tomoyo_mini_stat stat[TOMOYO_MAX_PATH_STAT];
579 * Content of symbolic link to be created. NULL for operations other
582 struct tomoyo_path_info *symlink_target;
585 /* Structure for argv[]. */
588 const struct tomoyo_path_info *value;
592 /* Structure for envp[]. */
594 const struct tomoyo_path_info *name;
595 const struct tomoyo_path_info *value;
599 /* Structure for execve() operation. */
600 struct tomoyo_execve {
601 struct tomoyo_request_info r;
602 struct tomoyo_obj_info obj;
603 struct linux_binprm *bprm;
604 /* For dumping argv[] and envp[]. */
605 struct tomoyo_page_dump dump;
606 /* For temporary use. */
607 char *tmp; /* Size is TOMOYO_EXEC_TMPSIZE bytes */
610 /* Structure for entries which follows "struct tomoyo_condition". */
611 struct tomoyo_condition_element {
613 * Left hand operand. A "struct tomoyo_argv" for TOMOYO_ARGV_ENTRY, a
614 * "struct tomoyo_envp" for TOMOYO_ENVP_ENTRY is attached to the tail
615 * of the array of this struct.
619 * Right hand operand. A "struct tomoyo_number_union" for
620 * TOMOYO_NUMBER_UNION, a "struct tomoyo_name_union" for
621 * TOMOYO_NAME_UNION is attached to the tail of the array of this
625 /* Equation operator. True if equals or overlaps, false otherwise. */
629 /* Structure for optional arguments. */
630 struct tomoyo_condition {
631 struct tomoyo_shared_acl_head head;
632 u32 size; /* Memory size allocated for this entry. */
633 u16 condc; /* Number of conditions in this struct. */
634 u16 numbers_count; /* Number of "struct tomoyo_number_union values". */
635 u16 names_count; /* Number of "struct tomoyo_name_union names". */
636 u16 argc; /* Number of "struct tomoyo_argv". */
637 u16 envc; /* Number of "struct tomoyo_envp". */
639 * struct tomoyo_condition_element condition[condc];
640 * struct tomoyo_number_union values[numbers_count];
641 * struct tomoyo_name_union names[names_count];
642 * struct tomoyo_argv argv[argc];
643 * struct tomoyo_envp envp[envc];
647 /* Common header for individual entries. */
648 struct tomoyo_acl_info {
649 struct list_head list;
650 struct tomoyo_condition *cond; /* Maybe NULL. */
652 u8 type; /* One of values in "enum tomoyo_acl_entry_type_index". */
655 /* Structure for domain information. */
656 struct tomoyo_domain_info {
657 struct list_head list;
658 struct list_head acl_info_list;
659 /* Name of this domain. Never NULL. */
660 const struct tomoyo_path_info *domainname;
661 /* Namespace for this domain. Never NULL. */
662 struct tomoyo_policy_namespace *ns;
663 u8 profile; /* Profile number to use. */
664 u8 group; /* Group number to use. */
665 bool is_deleted; /* Delete flag. */
666 bool flags[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
667 atomic_t users; /* Number of referring credentials. */
671 * Structure for "file execute", "file read", "file write", "file append",
672 * "file unlink", "file getattr", "file rmdir", "file truncate",
673 * "file symlink", "file chroot" and "file unmount" directive.
675 struct tomoyo_path_acl {
676 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
677 u16 perm; /* Bitmask of values in "enum tomoyo_path_acl_index". */
678 struct tomoyo_name_union name;
682 * Structure for "file create", "file mkdir", "file mkfifo", "file mksock",
683 * "file ioctl", "file chmod", "file chown" and "file chgrp" directive.
685 struct tomoyo_path_number_acl {
686 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
687 /* Bitmask of values in "enum tomoyo_path_number_acl_index". */
689 struct tomoyo_name_union name;
690 struct tomoyo_number_union number;
693 /* Structure for "file mkblock" and "file mkchar" directive. */
694 struct tomoyo_mkdev_acl {
695 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
696 u8 perm; /* Bitmask of values in "enum tomoyo_mkdev_acl_index". */
697 struct tomoyo_name_union name;
698 struct tomoyo_number_union mode;
699 struct tomoyo_number_union major;
700 struct tomoyo_number_union minor;
704 * Structure for "file rename", "file link" and "file pivot_root" directive.
706 struct tomoyo_path2_acl {
707 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
708 u8 perm; /* Bitmask of values in "enum tomoyo_path2_acl_index". */
709 struct tomoyo_name_union name1;
710 struct tomoyo_name_union name2;
713 /* Structure for "file mount" directive. */
714 struct tomoyo_mount_acl {
715 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
716 struct tomoyo_name_union dev_name;
717 struct tomoyo_name_union dir_name;
718 struct tomoyo_name_union fs_type;
719 struct tomoyo_number_union flags;
722 /* Structure for "misc env" directive in domain policy. */
723 struct tomoyo_env_acl {
724 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_ENV_ACL */
725 const struct tomoyo_path_info *env; /* environment variable */
728 /* Structure for "network inet" directive. */
729 struct tomoyo_inet_acl {
730 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_INET_ACL */
732 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
733 struct tomoyo_ipaddr_union address;
734 struct tomoyo_number_union port;
737 /* Structure for "network unix" directive. */
738 struct tomoyo_unix_acl {
739 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_UNIX_ACL */
741 u8 perm; /* Bitmask of values in "enum tomoyo_network_acl_index" */
742 struct tomoyo_name_union name;
745 /* Structure for holding a line from /sys/kernel/security/tomoyo/ interface. */
746 struct tomoyo_acl_param {
748 struct list_head *list;
749 struct tomoyo_policy_namespace *ns;
753 #define TOMOYO_MAX_IO_READ_QUEUE 64
756 * Structure for reading/writing policy via /sys/kernel/security/tomoyo
759 struct tomoyo_io_buffer {
760 void (*read) (struct tomoyo_io_buffer *);
761 int (*write) (struct tomoyo_io_buffer *);
762 int (*poll) (struct file *file, poll_table *wait);
763 /* Exclusive lock for this structure. */
765 char __user *read_user_buf;
766 size_t read_user_buf_avail;
768 struct list_head *ns;
769 struct list_head *domain;
770 struct list_head *group;
771 struct list_head *acl;
774 unsigned int query_index;
782 bool print_this_domain_only;
783 bool print_transition_related_only;
784 bool print_cond_part;
785 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
788 struct tomoyo_policy_namespace *ns;
789 /* The position currently writing to. */
790 struct tomoyo_domain_info *domain;
791 /* Bytes available for writing. */
795 /* Buffer for reading. */
797 /* Size of read buffer. */
799 /* Buffer for writing. */
801 /* Size of write buffer. */
802 size_t writebuf_size;
803 /* Type of this interface. */
804 enum tomoyo_securityfs_interface_index type;
805 /* Users counter protected by tomoyo_io_buffer_list_lock. */
807 /* List for telling GC not to kfree() elements. */
808 struct list_head list;
812 * Structure for "initialize_domain"/"no_initialize_domain"/"keep_domain"/
813 * "no_keep_domain" keyword.
815 struct tomoyo_transition_control {
816 struct tomoyo_acl_head head;
817 u8 type; /* One of values in "enum tomoyo_transition_type". */
818 /* True if the domainname is tomoyo_get_last_name(). */
820 const struct tomoyo_path_info *domainname; /* Maybe NULL */
821 const struct tomoyo_path_info *program; /* Maybe NULL */
824 /* Structure for "aggregator" keyword. */
825 struct tomoyo_aggregator {
826 struct tomoyo_acl_head head;
827 const struct tomoyo_path_info *original_name;
828 const struct tomoyo_path_info *aggregated_name;
831 /* Structure for policy manager. */
832 struct tomoyo_manager {
833 struct tomoyo_acl_head head;
834 bool is_domain; /* True if manager is a domainname. */
835 /* A path to program or a domainname. */
836 const struct tomoyo_path_info *manager;
839 struct tomoyo_preference {
840 unsigned int learning_max_entry;
841 bool enforcing_verbose;
842 bool learning_verbose;
843 bool permissive_verbose;
846 /* Structure for /sys/kernel/security/tomnoyo/profile interface. */
847 struct tomoyo_profile {
848 const struct tomoyo_path_info *comment;
849 struct tomoyo_preference *learning;
850 struct tomoyo_preference *permissive;
851 struct tomoyo_preference *enforcing;
852 struct tomoyo_preference preference;
854 u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
855 unsigned int pref[TOMOYO_MAX_PREF];
858 /* Structure for representing YYYY/MM/DD hh/mm/ss. */
868 /* Structure for policy namespace. */
869 struct tomoyo_policy_namespace {
870 /* Profile table. Memory is allocated as needed. */
871 struct tomoyo_profile *profile_ptr[TOMOYO_MAX_PROFILES];
872 /* List of "struct tomoyo_group". */
873 struct list_head group_list[TOMOYO_MAX_GROUP];
874 /* List of policy. */
875 struct list_head policy_list[TOMOYO_MAX_POLICY];
876 /* The global ACL referred by "use_group" keyword. */
877 struct list_head acl_group[TOMOYO_MAX_ACL_GROUPS];
878 /* List for connecting to tomoyo_namespace_list list. */
879 struct list_head namespace_list;
880 /* Profile version. Currently only 20100903 is defined. */
881 unsigned int profile_version;
882 /* Name of this namespace (e.g. "<kernel>", "</usr/sbin/httpd>" ). */
886 /********** Function prototypes. **********/
888 bool tomoyo_address_matches_group(const bool is_ipv6, const __be32 *address,
889 const struct tomoyo_group *group);
890 bool tomoyo_compare_number_union(const unsigned long value,
891 const struct tomoyo_number_union *ptr);
892 bool tomoyo_condition(struct tomoyo_request_info *r,
893 const struct tomoyo_condition *cond);
894 bool tomoyo_correct_domain(const unsigned char *domainname);
895 bool tomoyo_correct_path(const char *filename);
896 bool tomoyo_correct_word(const char *string);
897 bool tomoyo_domain_def(const unsigned char *buffer);
898 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
899 bool tomoyo_dump_page(struct linux_binprm *bprm, unsigned long pos,
900 struct tomoyo_page_dump *dump);
901 bool tomoyo_memory_ok(void *ptr);
902 bool tomoyo_number_matches_group(const unsigned long min,
903 const unsigned long max,
904 const struct tomoyo_group *group);
905 bool tomoyo_parse_ipaddr_union(struct tomoyo_acl_param *param,
906 struct tomoyo_ipaddr_union *ptr);
907 bool tomoyo_parse_name_union(struct tomoyo_acl_param *param,
908 struct tomoyo_name_union *ptr);
909 bool tomoyo_parse_number_union(struct tomoyo_acl_param *param,
910 struct tomoyo_number_union *ptr);
911 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
912 const struct tomoyo_path_info *pattern);
913 bool tomoyo_permstr(const char *string, const char *keyword);
914 bool tomoyo_str_starts(char **src, const char *find);
915 char *tomoyo_encode(const char *str);
916 char *tomoyo_encode2(const char *str, int str_len);
917 char *tomoyo_init_log(struct tomoyo_request_info *r, int len, const char *fmt,
919 char *tomoyo_read_token(struct tomoyo_acl_param *param);
920 char *tomoyo_realpath_from_path(struct path *path);
921 char *tomoyo_realpath_nofollow(const char *pathname);
922 const char *tomoyo_get_exe(void);
923 const char *tomoyo_yesno(const unsigned int value);
924 const struct tomoyo_path_info *tomoyo_compare_name_union
925 (const struct tomoyo_path_info *name, const struct tomoyo_name_union *ptr);
926 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
927 const struct tomoyo_path_info *tomoyo_path_matches_group
928 (const struct tomoyo_path_info *pathname, const struct tomoyo_group *group);
929 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
930 struct path *path, const int flag);
931 int tomoyo_close_control(struct tomoyo_io_buffer *head);
932 int tomoyo_env_perm(struct tomoyo_request_info *r, const char *env);
933 int tomoyo_find_next_domain(struct linux_binprm *bprm);
934 int tomoyo_get_mode(const struct tomoyo_policy_namespace *ns, const u8 profile,
936 int tomoyo_init_request_info(struct tomoyo_request_info *r,
937 struct tomoyo_domain_info *domain,
939 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
940 const unsigned int mode, unsigned int dev);
941 int tomoyo_mount_permission(char *dev_name, struct path *path,
942 const char *type, unsigned long flags,
944 int tomoyo_open_control(const u8 type, struct file *file);
945 int tomoyo_path2_perm(const u8 operation, struct path *path1,
947 int tomoyo_path_number_perm(const u8 operation, struct path *path,
948 unsigned long number);
949 int tomoyo_path_perm(const u8 operation, struct path *path,
951 int tomoyo_path_permission(struct tomoyo_request_info *r, u8 operation,
952 const struct tomoyo_path_info *filename);
953 int tomoyo_poll_control(struct file *file, poll_table *wait);
954 int tomoyo_poll_log(struct file *file, poll_table *wait);
955 int tomoyo_socket_bind_permission(struct socket *sock, struct sockaddr *addr,
957 int tomoyo_socket_connect_permission(struct socket *sock,
958 struct sockaddr *addr, int addr_len);
959 int tomoyo_socket_listen_permission(struct socket *sock);
960 int tomoyo_socket_sendmsg_permission(struct socket *sock, struct msghdr *msg,
962 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
964 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
965 struct tomoyo_acl_param *param,
966 bool (*check_duplicate)
967 (const struct tomoyo_acl_info *,
968 const struct tomoyo_acl_info *),
969 bool (*merge_duplicate)
970 (struct tomoyo_acl_info *, struct tomoyo_acl_info *,
972 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
973 struct tomoyo_acl_param *param,
974 bool (*check_duplicate)
975 (const struct tomoyo_acl_head *,
976 const struct tomoyo_acl_head *));
977 int tomoyo_write_aggregator(struct tomoyo_acl_param *param);
978 int tomoyo_write_file(struct tomoyo_acl_param *param);
979 int tomoyo_write_group(struct tomoyo_acl_param *param, const u8 type);
980 int tomoyo_write_misc(struct tomoyo_acl_param *param);
981 int tomoyo_write_inet_network(struct tomoyo_acl_param *param);
982 int tomoyo_write_transition_control(struct tomoyo_acl_param *param,
984 int tomoyo_write_unix_network(struct tomoyo_acl_param *param);
985 ssize_t tomoyo_read_control(struct tomoyo_io_buffer *head, char __user *buffer,
986 const int buffer_len);
987 ssize_t tomoyo_write_control(struct tomoyo_io_buffer *head,
988 const char __user *buffer, const int buffer_len);
989 struct tomoyo_condition *tomoyo_get_condition(struct tomoyo_acl_param *param);
990 struct tomoyo_domain_info *tomoyo_assign_domain(const char *domainname,
992 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
993 struct tomoyo_group *tomoyo_get_group(struct tomoyo_acl_param *param,
995 struct tomoyo_policy_namespace *tomoyo_assign_namespace
996 (const char *domainname);
997 struct tomoyo_profile *tomoyo_profile(const struct tomoyo_policy_namespace *ns,
999 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
1001 u8 tomoyo_parse_ulong(unsigned long *result, char **str);
1002 void *tomoyo_commit_ok(void *data, const unsigned int size);
1003 void __init tomoyo_load_builtin_policy(void);
1004 void __init tomoyo_mm_init(void);
1005 void tomoyo_check_acl(struct tomoyo_request_info *r,
1006 bool (*check_entry) (struct tomoyo_request_info *,
1007 const struct tomoyo_acl_info *));
1008 void tomoyo_check_profile(void);
1009 void tomoyo_convert_time(time_t time, struct tomoyo_time *stamp);
1010 void tomoyo_del_condition(struct list_head *element);
1011 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
1012 void tomoyo_get_attributes(struct tomoyo_obj_info *obj);
1013 void tomoyo_init_policy_namespace(struct tomoyo_policy_namespace *ns);
1014 void tomoyo_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
1016 void tomoyo_load_policy(const char *filename);
1017 void tomoyo_memory_free(void *ptr);
1018 void tomoyo_normalize_line(unsigned char *buffer);
1019 void tomoyo_notify_gc(struct tomoyo_io_buffer *head, const bool is_register);
1020 void tomoyo_print_ip(char *buf, const unsigned int size,
1021 const struct tomoyo_ipaddr_union *ptr);
1022 void tomoyo_print_ulong(char *buffer, const int buffer_len,
1023 const unsigned long value, const u8 type);
1024 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
1025 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
1026 void tomoyo_read_log(struct tomoyo_io_buffer *head);
1027 void tomoyo_update_stat(const u8 index);
1028 void tomoyo_warn_oom(const char *function);
1029 void tomoyo_write_log(struct tomoyo_request_info *r, const char *fmt, ...)
1031 void tomoyo_write_log2(struct tomoyo_request_info *r, int len, const char *fmt,
1034 /********** External variable definitions. **********/
1036 extern bool tomoyo_policy_loaded;
1037 extern const char * const tomoyo_condition_keyword
1038 [TOMOYO_MAX_CONDITION_KEYWORD];
1039 extern const char * const tomoyo_dif[TOMOYO_MAX_DOMAIN_INFO_FLAGS];
1040 extern const char * const tomoyo_mac_keywords[TOMOYO_MAX_MAC_INDEX
1041 + TOMOYO_MAX_MAC_CATEGORY_INDEX];
1042 extern const char * const tomoyo_mode[TOMOYO_CONFIG_MAX_MODE];
1043 extern const char * const tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
1044 extern const char * const tomoyo_proto_keyword[TOMOYO_SOCK_MAX];
1045 extern const char * const tomoyo_socket_keyword[TOMOYO_MAX_NETWORK_OPERATION];
1046 extern const u8 tomoyo_index2category[TOMOYO_MAX_MAC_INDEX];
1047 extern const u8 tomoyo_pn2mac[TOMOYO_MAX_PATH_NUMBER_OPERATION];
1048 extern const u8 tomoyo_pnnn2mac[TOMOYO_MAX_MKDEV_OPERATION];
1049 extern const u8 tomoyo_pp2mac[TOMOYO_MAX_PATH2_OPERATION];
1050 extern struct list_head tomoyo_condition_list;
1051 extern struct list_head tomoyo_domain_list;
1052 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
1053 extern struct list_head tomoyo_namespace_list;
1054 extern struct mutex tomoyo_policy_lock;
1055 extern struct srcu_struct tomoyo_ss;
1056 extern struct tomoyo_domain_info tomoyo_kernel_domain;
1057 extern struct tomoyo_policy_namespace tomoyo_kernel_namespace;
1058 extern unsigned int tomoyo_memory_quota[TOMOYO_MAX_MEMORY_STAT];
1059 extern unsigned int tomoyo_memory_used[TOMOYO_MAX_MEMORY_STAT];
1061 /********** Inlined functions. **********/
1064 * tomoyo_read_lock - Take lock for protecting policy.
1066 * Returns index number for tomoyo_read_unlock().
1068 static inline int tomoyo_read_lock(void)
1070 return srcu_read_lock(&tomoyo_ss);
1074 * tomoyo_read_unlock - Release lock for protecting policy.
1076 * @idx: Index number returned by tomoyo_read_lock().
1080 static inline void tomoyo_read_unlock(int idx)
1082 srcu_read_unlock(&tomoyo_ss, idx);
1086 * tomoyo_sys_getppid - Copy of getppid().
1088 * Returns parent process's PID.
1090 * Alpha does not have getppid() defined. To be able to build this module on
1091 * Alpha, I have to copy getppid() from kernel/timer.c.
1093 static inline pid_t tomoyo_sys_getppid(void)
1097 pid = task_tgid_vnr(current->real_parent);
1103 * tomoyo_sys_getpid - Copy of getpid().
1105 * Returns current thread's PID.
1107 * Alpha does not have getpid() defined. To be able to build this module on
1108 * Alpha, I have to copy getpid() from kernel/timer.c.
1110 static inline pid_t tomoyo_sys_getpid(void)
1112 return task_tgid_vnr(current);
1116 * tomoyo_pathcmp - strcmp() for "struct tomoyo_path_info" structure.
1118 * @a: Pointer to "struct tomoyo_path_info".
1119 * @b: Pointer to "struct tomoyo_path_info".
1121 * Returns true if @a == @b, false otherwise.
1123 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
1124 const struct tomoyo_path_info *b)
1126 return a->hash != b->hash || strcmp(a->name, b->name);
1130 * tomoyo_put_name - Drop reference on "struct tomoyo_name".
1132 * @name: Pointer to "struct tomoyo_path_info". Maybe NULL.
1136 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
1139 struct tomoyo_name *ptr =
1140 container_of(name, typeof(*ptr), entry);
1141 atomic_dec(&ptr->head.users);
1146 * tomoyo_put_condition - Drop reference on "struct tomoyo_condition".
1148 * @cond: Pointer to "struct tomoyo_condition". Maybe NULL.
1152 static inline void tomoyo_put_condition(struct tomoyo_condition *cond)
1155 atomic_dec(&cond->head.users);
1159 * tomoyo_put_group - Drop reference on "struct tomoyo_group".
1161 * @group: Pointer to "struct tomoyo_group". Maybe NULL.
1165 static inline void tomoyo_put_group(struct tomoyo_group *group)
1168 atomic_dec(&group->head.users);
1172 * tomoyo_domain - Get "struct tomoyo_domain_info" for current thread.
1174 * Returns pointer to "struct tomoyo_domain_info" for current thread.
1176 static inline struct tomoyo_domain_info *tomoyo_domain(void)
1178 return current_cred()->security;
1182 * tomoyo_real_domain - Get "struct tomoyo_domain_info" for specified thread.
1184 * @task: Pointer to "struct task_struct".
1186 * Returns pointer to "struct tomoyo_security" for specified thread.
1188 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
1191 return task_cred_xxx(task, security);
1195 * tomoyo_same_name_union - Check for duplicated "struct tomoyo_name_union" entry.
1197 * @a: Pointer to "struct tomoyo_name_union".
1198 * @b: Pointer to "struct tomoyo_name_union".
1200 * Returns true if @a == @b, false otherwise.
1202 static inline bool tomoyo_same_name_union
1203 (const struct tomoyo_name_union *a, const struct tomoyo_name_union *b)
1205 return a->filename == b->filename && a->group == b->group;
1209 * tomoyo_same_number_union - Check for duplicated "struct tomoyo_number_union" entry.
1211 * @a: Pointer to "struct tomoyo_number_union".
1212 * @b: Pointer to "struct tomoyo_number_union".
1214 * Returns true if @a == @b, false otherwise.
1216 static inline bool tomoyo_same_number_union
1217 (const struct tomoyo_number_union *a, const struct tomoyo_number_union *b)
1219 return a->values[0] == b->values[0] && a->values[1] == b->values[1] &&
1220 a->group == b->group && a->value_type[0] == b->value_type[0] &&
1221 a->value_type[1] == b->value_type[1];
1225 * tomoyo_same_ipaddr_union - Check for duplicated "struct tomoyo_ipaddr_union" entry.
1227 * @a: Pointer to "struct tomoyo_ipaddr_union".
1228 * @b: Pointer to "struct tomoyo_ipaddr_union".
1230 * Returns true if @a == @b, false otherwise.
1232 static inline bool tomoyo_same_ipaddr_union
1233 (const struct tomoyo_ipaddr_union *a, const struct tomoyo_ipaddr_union *b)
1235 return !memcmp(a->ip, b->ip, sizeof(a->ip)) && a->group == b->group &&
1236 a->is_ipv6 == b->is_ipv6;
1240 * tomoyo_current_namespace - Get "struct tomoyo_policy_namespace" for current thread.
1242 * Returns pointer to "struct tomoyo_policy_namespace" for current thread.
1244 static inline struct tomoyo_policy_namespace *tomoyo_current_namespace(void)
1246 return tomoyo_domain()->ns;
1249 #if defined(CONFIG_SLOB)
1252 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1254 * @size: Size to be rounded up.
1258 * Since SLOB does not round up, this function simply returns @size.
1260 static inline int tomoyo_round2(size_t size)
1268 * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
1270 * @size: Size to be rounded up.
1272 * Returns rounded size.
1274 * Strictly speaking, SLAB may be able to allocate (e.g.) 96 bytes instead of
1277 static inline int tomoyo_round2(size_t size)
1279 #if PAGE_SIZE == 4096
1286 while (size > bsize)
1294 * list_for_each_cookie - iterate over a list with cookie.
1295 * @pos: the &struct list_head to use as a loop cursor.
1296 * @head: the head for your list.
1298 #define list_for_each_cookie(pos, head) \
1300 pos = srcu_dereference((head)->next, &tomoyo_ss); \
1301 for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
1303 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */