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>
26 /********** Constants definitions. **********/
29 * TOMOYO uses this hash only when appending a string into the string
30 * table. Frequency of appending strings is very low. So we don't need
31 * large (e.g. 64k) hash size. 256 will be sufficient.
33 #define TOMOYO_HASH_BITS 8
34 #define TOMOYO_MAX_HASH (1u<<TOMOYO_HASH_BITS)
37 * This is the max length of a token.
39 * A token consists of only ASCII printable characters.
40 * Non printable characters in a token is represented in \ooo style
41 * octal string. Thus, \ itself is represented as \\.
43 #define TOMOYO_MAX_PATHNAME_LEN 4000
45 /* Profile number is an integer between 0 and 255. */
46 #define TOMOYO_MAX_PROFILES 256
48 enum tomoyo_mode_index {
49 TOMOYO_CONFIG_DISABLED,
50 TOMOYO_CONFIG_LEARNING,
51 TOMOYO_CONFIG_PERMISSIVE,
52 TOMOYO_CONFIG_ENFORCING
55 /* Keywords for ACLs. */
56 #define TOMOYO_KEYWORD_ALIAS "alias "
57 #define TOMOYO_KEYWORD_ALLOW_MOUNT "allow_mount "
58 #define TOMOYO_KEYWORD_ALLOW_READ "allow_read "
59 #define TOMOYO_KEYWORD_DELETE "delete "
60 #define TOMOYO_KEYWORD_DENY_REWRITE "deny_rewrite "
61 #define TOMOYO_KEYWORD_FILE_PATTERN "file_pattern "
62 #define TOMOYO_KEYWORD_INITIALIZE_DOMAIN "initialize_domain "
63 #define TOMOYO_KEYWORD_KEEP_DOMAIN "keep_domain "
64 #define TOMOYO_KEYWORD_NO_INITIALIZE_DOMAIN "no_initialize_domain "
65 #define TOMOYO_KEYWORD_NO_KEEP_DOMAIN "no_keep_domain "
66 #define TOMOYO_KEYWORD_PATH_GROUP "path_group "
67 #define TOMOYO_KEYWORD_NUMBER_GROUP "number_group "
68 #define TOMOYO_KEYWORD_SELECT "select "
69 #define TOMOYO_KEYWORD_USE_PROFILE "use_profile "
70 #define TOMOYO_KEYWORD_IGNORE_GLOBAL_ALLOW_READ "ignore_global_allow_read"
71 /* A domain definition starts with <kernel>. */
72 #define TOMOYO_ROOT_NAME "<kernel>"
73 #define TOMOYO_ROOT_NAME_LEN (sizeof(TOMOYO_ROOT_NAME) - 1)
75 /* Value type definition. */
76 #define TOMOYO_VALUE_TYPE_INVALID 0
77 #define TOMOYO_VALUE_TYPE_DECIMAL 1
78 #define TOMOYO_VALUE_TYPE_OCTAL 2
79 #define TOMOYO_VALUE_TYPE_HEXADECIMAL 3
81 /* Index numbers for Access Controls. */
82 enum tomoyo_mac_index {
83 TOMOYO_MAC_FOR_FILE, /* domain_policy.conf */
84 TOMOYO_MAX_ACCEPT_ENTRY,
86 TOMOYO_MAX_CONTROL_INDEX
89 /* Index numbers for Access Controls. */
90 enum tomoyo_acl_entry_type_index {
92 TOMOYO_TYPE_PATH2_ACL,
93 TOMOYO_TYPE_PATH_NUMBER_ACL,
94 TOMOYO_TYPE_PATH_NUMBER3_ACL,
95 TOMOYO_TYPE_MOUNT_ACL,
98 /* Index numbers for File Controls. */
101 * TOMOYO_TYPE_READ_WRITE is special. TOMOYO_TYPE_READ_WRITE is automatically
102 * set if both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are set.
103 * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically set if
104 * TOMOYO_TYPE_READ_WRITE is set.
105 * TOMOYO_TYPE_READ_WRITE is automatically cleared if either TOMOYO_TYPE_READ
106 * or TOMOYO_TYPE_WRITE is cleared.
107 * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically cleared if
108 * TOMOYO_TYPE_READ_WRITE is cleared.
111 enum tomoyo_path_acl_index {
112 TOMOYO_TYPE_READ_WRITE,
118 TOMOYO_TYPE_TRUNCATE,
123 TOMOYO_MAX_PATH_OPERATION
126 enum tomoyo_path_number3_acl_index {
129 TOMOYO_MAX_PATH_NUMBER3_OPERATION
132 enum tomoyo_path2_acl_index {
135 TOMOYO_TYPE_PIVOT_ROOT,
136 TOMOYO_MAX_PATH2_OPERATION
139 enum tomoyo_path_number_acl_index {
148 TOMOYO_MAX_PATH_NUMBER_OPERATION
151 enum tomoyo_securityfs_interface_index {
153 TOMOYO_EXCEPTIONPOLICY,
154 TOMOYO_DOMAIN_STATUS,
155 TOMOYO_PROCESS_STATUS,
164 #define TOMOYO_RETRY_REQUEST 1 /* Retry this request. */
166 /********** Structure definitions. **********/
169 * tomoyo_page_buffer is a structure which is used for holding a pathname
170 * obtained from "struct dentry" and "struct vfsmount" pair.
171 * As of now, it is 4096 bytes. If users complain that 4096 bytes is too small
172 * (because TOMOYO escapes non ASCII printable characters using \ooo format),
173 * we will make the buffer larger.
175 struct tomoyo_page_buffer {
180 * tomoyo_request_info is a structure which is used for holding
182 * (1) Domain information of current process.
183 * (2) How many retries are made for this request.
184 * (3) Profile number used for this request.
185 * (4) Access control mode of the profile.
187 struct tomoyo_request_info {
188 struct tomoyo_domain_info *domain;
191 u8 mode; /* One of tomoyo_mode_index . */
195 * tomoyo_path_info is a structure which is used for holding a string data
197 * This structure has several fields for supporting pattern matching.
199 * (1) "name" is the '\0' terminated string data.
200 * (2) "hash" is full_name_hash(name, strlen(name)).
201 * This allows tomoyo_pathcmp() to compare by hash before actually compare
203 * (3) "const_len" is the length of the initial segment of "name" which
204 * consists entirely of non wildcard characters. In other words, the length
205 * which we can compare two strings using strncmp().
206 * (4) "is_dir" is a bool which is true if "name" ends with "/",
208 * TOMOYO distinguishes directory and non-directory. A directory ends with
209 * "/" and non-directory does not end with "/".
210 * (5) "is_patterned" is a bool which is true if "name" contains wildcard
211 * characters, false otherwise. This allows TOMOYO to use "hash" and
212 * strcmp() for string comparison if "is_patterned" is false.
214 struct tomoyo_path_info {
216 u32 hash; /* = full_name_hash(name, strlen(name)) */
217 u16 const_len; /* = tomoyo_const_part_length(name) */
218 bool is_dir; /* = tomoyo_strendswith(name, "/") */
219 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
223 * tomoyo_name_entry is a structure which is used for linking
224 * "struct tomoyo_path_info" into tomoyo_name_list .
226 struct tomoyo_name_entry {
227 struct list_head list;
229 struct tomoyo_path_info entry;
233 * tomoyo_path_info_with_data is a structure which is used for holding a
234 * pathname obtained from "struct dentry" and "struct vfsmount" pair.
236 * "struct tomoyo_path_info_with_data" consists of "struct tomoyo_path_info"
237 * and buffer for the pathname, while "struct tomoyo_page_buffer" consists of
238 * buffer for the pathname only.
240 * "struct tomoyo_path_info_with_data" is intended to allow TOMOYO to release
241 * both "struct tomoyo_path_info" and buffer for the pathname by single kfree()
242 * so that we don't need to return two pointers to the caller. If the caller
243 * puts "struct tomoyo_path_info" on stack memory, we will be able to remove
244 * "struct tomoyo_path_info_with_data".
246 struct tomoyo_path_info_with_data {
247 /* Keep "head" first, for this pointer is passed to kfree(). */
248 struct tomoyo_path_info head;
249 char barrier1[16]; /* Safeguard for overrun. */
250 char body[TOMOYO_MAX_PATHNAME_LEN];
251 char barrier2[16]; /* Safeguard for overrun. */
254 struct tomoyo_name_union {
255 const struct tomoyo_path_info *filename;
256 struct tomoyo_path_group *group;
260 struct tomoyo_number_union {
261 unsigned long values[2];
262 struct tomoyo_number_group *group;
268 /* Structure for "path_group" directive. */
269 struct tomoyo_path_group {
270 struct list_head list;
271 const struct tomoyo_path_info *group_name;
272 struct list_head member_list;
276 /* Structure for "number_group" directive. */
277 struct tomoyo_number_group {
278 struct list_head list;
279 const struct tomoyo_path_info *group_name;
280 struct list_head member_list;
284 /* Structure for "path_group" directive. */
285 struct tomoyo_path_group_member {
286 struct list_head list;
288 const struct tomoyo_path_info *member_name;
291 /* Structure for "number_group" directive. */
292 struct tomoyo_number_group_member {
293 struct list_head list;
295 struct tomoyo_number_union number;
299 * tomoyo_acl_info is a structure which is used for holding
301 * (1) "list" which is linked to the ->acl_info_list of
302 * "struct tomoyo_domain_info"
303 * (2) "type" which tells type of the entry (either
304 * "struct tomoyo_path_acl" or "struct tomoyo_path2_acl").
306 * Packing "struct tomoyo_acl_info" allows
307 * "struct tomoyo_path_acl" to embed "u8" + "u16" and
308 * "struct tomoyo_path2_acl" to embed "u8"
309 * without enlarging their structure size.
311 struct tomoyo_acl_info {
312 struct list_head list;
317 * tomoyo_domain_info is a structure which is used for holding permissions
318 * (e.g. "allow_read /lib/libc-2.5.so") given to each domain.
319 * It has following fields.
321 * (1) "list" which is linked to tomoyo_domain_list .
322 * (2) "acl_info_list" which is linked to "struct tomoyo_acl_info".
323 * (3) "domainname" which holds the name of the domain.
324 * (4) "profile" which remembers profile number assigned to this domain.
325 * (5) "is_deleted" is a bool which is true if this domain is marked as
326 * "deleted", false otherwise.
327 * (6) "quota_warned" is a bool which is used for suppressing warning message
328 * when learning mode learned too much entries.
329 * (7) "ignore_global_allow_read" is a bool which is true if this domain
330 * should ignore "allow_read" directive in exception policy.
331 * (8) "transition_failed" is a bool which is set to true when this domain was
332 * unable to create a new domain at tomoyo_find_next_domain() because the
333 * name of the domain to be created was too long or it could not allocate
334 * memory. If set to true, more than one process continued execve()
335 * without domain transition.
336 * (9) "users" is an atomic_t that holds how many "struct cred"->security
337 * are referring this "struct tomoyo_domain_info". If is_deleted == true
338 * and users == 0, this struct will be kfree()d upon next garbage
341 * A domain's lifecycle is an analogy of files on / directory.
342 * Multiple domains with the same domainname cannot be created (as with
343 * creating files with the same filename fails with -EEXIST).
344 * If a process reached a domain, that process can reside in that domain after
345 * that domain is marked as "deleted" (as with a process can access an already
346 * open()ed file after that file was unlink()ed).
348 struct tomoyo_domain_info {
349 struct list_head list;
350 struct list_head acl_info_list;
351 /* Name of this domain. Never NULL. */
352 const struct tomoyo_path_info *domainname;
353 u8 profile; /* Profile number to use. */
354 bool is_deleted; /* Delete flag. */
355 bool quota_warned; /* Quota warnning flag. */
356 bool ignore_global_allow_read; /* Ignore "allow_read" flag. */
357 bool transition_failed; /* Domain transition failed flag. */
358 atomic_t users; /* Number of referring credentials. */
362 * tomoyo_path_acl is a structure which is used for holding an
363 * entry with one pathname operation (e.g. open(), mkdir()).
364 * It has following fields.
366 * (1) "head" which is a "struct tomoyo_acl_info".
367 * (2) "perm" which is a bitmask of permitted operations.
368 * (3) "name" is the pathname.
370 * Directives held by this structure are "allow_read/write", "allow_execute",
371 * "allow_read", "allow_write", "allow_unlink", "allow_rmdir",
372 * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_chroot" and
375 struct tomoyo_path_acl {
376 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
378 struct tomoyo_name_union name;
382 * tomoyo_path_number_acl is a structure which is used for holding an
383 * entry with one pathname and one number operation.
384 * It has following fields.
386 * (1) "head" which is a "struct tomoyo_acl_info".
387 * (2) "perm" which is a bitmask of permitted operations.
388 * (3) "name" is the pathname.
389 * (4) "number" is the numeric value.
391 * Directives held by this structure are "allow_create", "allow_mkdir",
392 * "allow_ioctl", "allow_mkfifo", "allow_mksock", "allow_chmod", "allow_chown"
396 struct tomoyo_path_number_acl {
397 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
399 struct tomoyo_name_union name;
400 struct tomoyo_number_union number;
404 * tomoyo_path_number3_acl is a structure which is used for holding an
405 * entry with one pathname and three numbers operation.
406 * It has following fields.
408 * (1) "head" which is a "struct tomoyo_acl_info".
409 * (2) "perm" which is a bitmask of permitted operations.
410 * (3) "mode" is the create mode.
411 * (4) "major" is the major number of device node.
412 * (5) "minor" is the minor number of device node.
414 * Directives held by this structure are "allow_mkchar", "allow_mkblock".
417 struct tomoyo_path_number3_acl {
418 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER3_ACL */
420 struct tomoyo_name_union name;
421 struct tomoyo_number_union mode;
422 struct tomoyo_number_union major;
423 struct tomoyo_number_union minor;
427 * tomoyo_path2_acl is a structure which is used for holding an
428 * entry with two pathnames operation (i.e. link(), rename() and pivot_root()).
429 * It has following fields.
431 * (1) "head" which is a "struct tomoyo_acl_info".
432 * (2) "perm" which is a bitmask of permitted operations.
433 * (3) "name1" is the source/old pathname.
434 * (4) "name2" is the destination/new pathname.
436 * Directives held by this structure are "allow_rename", "allow_link" and
437 * "allow_pivot_root".
439 struct tomoyo_path2_acl {
440 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
442 struct tomoyo_name_union name1;
443 struct tomoyo_name_union name2;
447 * tomoyo_mount_acl is a structure which is used for holding an
448 * entry for mount operation.
449 * It has following fields.
451 * (1) "head" which is a "struct tomoyo_acl_info".
452 * (2) "is_deleted" is boolean.
453 * (3) "dev_name" is the device name.
454 * (4) "dir_name" is the mount point.
455 * (5) "flags" is the mount flags.
457 * Directives held by this structure are "allow_rename", "allow_link" and
458 * "allow_pivot_root".
460 struct tomoyo_mount_acl {
461 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
463 struct tomoyo_name_union dev_name;
464 struct tomoyo_name_union dir_name;
465 struct tomoyo_name_union fs_type;
466 struct tomoyo_number_union flags;
470 * tomoyo_io_buffer is a structure which is used for reading and modifying
471 * configuration via /sys/kernel/security/tomoyo/ interface.
472 * It has many fields. ->read_var1 , ->read_var2 , ->write_var1 are used as
475 * Since the content of /sys/kernel/security/tomoyo/domain_policy is a list of
476 * "struct tomoyo_domain_info" entries and each "struct tomoyo_domain_info"
477 * entry has a list of "struct tomoyo_acl_info", we need two cursors when
478 * reading (one is for traversing tomoyo_domain_list and the other is for
479 * traversing "struct tomoyo_acl_info"->acl_info_list ).
481 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
482 * "select ", TOMOYO seeks the cursor ->read_var1 and ->write_var1 to the
483 * domain with the domainname specified by the rest of that line (NULL is set
485 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
486 * "delete ", TOMOYO deletes an entry or a domain specified by the rest of that
487 * line (->write_var1 is set to NULL if a domain was deleted).
488 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
489 * neither "select " nor "delete ", an entry or a domain specified by that line
492 struct tomoyo_io_buffer {
493 int (*read) (struct tomoyo_io_buffer *);
494 int (*write) (struct tomoyo_io_buffer *);
495 int (*poll) (struct file *file, poll_table *wait);
496 /* Exclusive lock for this structure. */
498 /* Index returned by tomoyo_read_lock(). */
500 /* The position currently reading from. */
501 struct list_head *read_var1;
502 /* Extra variables for reading. */
503 struct list_head *read_var2;
504 /* The position currently writing to. */
505 struct tomoyo_domain_info *write_var1;
506 /* The step for reading. */
508 /* Buffer for reading. */
510 /* EOF flag for reading. */
512 /* Read domain ACL of specified PID? */
513 bool read_single_domain;
514 /* Extra variable for reading. */
516 /* Bytes available for reading. */
518 /* Size of read buffer. */
520 /* Buffer for writing. */
522 /* Bytes available for writing. */
524 /* Size of write buffer. */
526 /* Type of this interface. */
531 * tomoyo_globally_readable_file_entry is a structure which is used for holding
532 * "allow_read" entries.
533 * It has following fields.
535 * (1) "list" which is linked to tomoyo_globally_readable_list .
536 * (2) "filename" is a pathname which is allowed to open(O_RDONLY).
537 * (3) "is_deleted" is a bool which is true if marked as deleted, false
540 struct tomoyo_globally_readable_file_entry {
541 struct list_head list;
542 const struct tomoyo_path_info *filename;
547 * tomoyo_pattern_entry is a structure which is used for holding
548 * "tomoyo_pattern_list" entries.
549 * It has following fields.
551 * (1) "list" which is linked to tomoyo_pattern_list .
552 * (2) "pattern" is a pathname pattern which is used for converting pathnames
553 * to pathname patterns during learning mode.
554 * (3) "is_deleted" is a bool which is true if marked as deleted, false
557 struct tomoyo_pattern_entry {
558 struct list_head list;
559 const struct tomoyo_path_info *pattern;
564 * tomoyo_no_rewrite_entry is a structure which is used for holding
565 * "deny_rewrite" entries.
566 * It has following fields.
568 * (1) "list" which is linked to tomoyo_no_rewrite_list .
569 * (2) "pattern" is a pathname which is by default not permitted to modify
570 * already existing content.
571 * (3) "is_deleted" is a bool which is true if marked as deleted, false
574 struct tomoyo_no_rewrite_entry {
575 struct list_head list;
576 const struct tomoyo_path_info *pattern;
581 * tomoyo_domain_initializer_entry is a structure which is used for holding
582 * "initialize_domain" and "no_initialize_domain" entries.
583 * It has following fields.
585 * (1) "list" which is linked to tomoyo_domain_initializer_list .
586 * (2) "domainname" which is "a domainname" or "the last component of a
587 * domainname". This field is NULL if "from" clause is not specified.
588 * (3) "program" which is a program's pathname.
589 * (4) "is_deleted" is a bool which is true if marked as deleted, false
591 * (5) "is_not" is a bool which is true if "no_initialize_domain", false
593 * (6) "is_last_name" is a bool which is true if "domainname" is "the last
594 * component of a domainname", false otherwise.
596 struct tomoyo_domain_initializer_entry {
597 struct list_head list;
598 const struct tomoyo_path_info *domainname; /* This may be NULL */
599 const struct tomoyo_path_info *program;
601 bool is_not; /* True if this entry is "no_initialize_domain". */
602 /* True if the domainname is tomoyo_get_last_name(). */
607 * tomoyo_domain_keeper_entry is a structure which is used for holding
608 * "keep_domain" and "no_keep_domain" entries.
609 * It has following fields.
611 * (1) "list" which is linked to tomoyo_domain_keeper_list .
612 * (2) "domainname" which is "a domainname" or "the last component of a
614 * (3) "program" which is a program's pathname.
615 * This field is NULL if "from" clause is not specified.
616 * (4) "is_deleted" is a bool which is true if marked as deleted, false
618 * (5) "is_not" is a bool which is true if "no_initialize_domain", false
620 * (6) "is_last_name" is a bool which is true if "domainname" is "the last
621 * component of a domainname", false otherwise.
623 struct tomoyo_domain_keeper_entry {
624 struct list_head list;
625 const struct tomoyo_path_info *domainname;
626 const struct tomoyo_path_info *program; /* This may be NULL */
628 bool is_not; /* True if this entry is "no_keep_domain". */
629 /* True if the domainname is tomoyo_get_last_name(). */
634 * tomoyo_alias_entry is a structure which is used for holding "alias" entries.
635 * It has following fields.
637 * (1) "list" which is linked to tomoyo_alias_list .
638 * (2) "original_name" which is a dereferenced pathname.
639 * (3) "aliased_name" which is a symlink's pathname.
640 * (4) "is_deleted" is a bool which is true if marked as deleted, false
643 struct tomoyo_alias_entry {
644 struct list_head list;
645 const struct tomoyo_path_info *original_name;
646 const struct tomoyo_path_info *aliased_name;
651 * tomoyo_policy_manager_entry is a structure which is used for holding list of
652 * domainnames or programs which are permitted to modify configuration via
653 * /sys/kernel/security/tomoyo/ interface.
654 * It has following fields.
656 * (1) "list" which is linked to tomoyo_policy_manager_list .
657 * (2) "manager" is a domainname or a program's pathname.
658 * (3) "is_domain" is a bool which is true if "manager" is a domainname, false
660 * (4) "is_deleted" is a bool which is true if marked as deleted, false
663 struct tomoyo_policy_manager_entry {
664 struct list_head list;
665 /* A path to program or a domainname. */
666 const struct tomoyo_path_info *manager;
667 bool is_domain; /* True if manager is a domainname. */
668 bool is_deleted; /* True if this entry is deleted. */
671 /********** Function prototypes. **********/
673 extern asmlinkage long sys_getpid(void);
674 extern asmlinkage long sys_getppid(void);
676 /* Check whether the given name matches the given name_union. */
677 bool tomoyo_compare_name_union(const struct tomoyo_path_info *name,
678 const struct tomoyo_name_union *ptr);
679 /* Check whether the given number matches the given number_union. */
680 bool tomoyo_compare_number_union(const unsigned long value,
681 const struct tomoyo_number_union *ptr);
682 /* Transactional sprintf() for policy dump. */
683 bool tomoyo_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
684 __attribute__ ((format(printf, 2, 3)));
685 /* Check whether the domainname is correct. */
686 bool tomoyo_is_correct_domain(const unsigned char *domainname);
687 /* Check whether the token is correct. */
688 bool tomoyo_is_correct_path(const char *filename, const s8 start_type,
689 const s8 pattern_type, const s8 end_type);
690 /* Check whether the token can be a domainname. */
691 bool tomoyo_is_domain_def(const unsigned char *buffer);
692 bool tomoyo_parse_name_union(const char *filename,
693 struct tomoyo_name_union *ptr);
694 /* Check whether the given filename matches the given path_group. */
695 bool tomoyo_path_matches_group(const struct tomoyo_path_info *pathname,
696 const struct tomoyo_path_group *group,
697 const bool may_use_pattern);
698 /* Check whether the given value matches the given number_group. */
699 bool tomoyo_number_matches_group(const unsigned long min,
700 const unsigned long max,
701 const struct tomoyo_number_group *group);
702 /* Check whether the given filename matches the given pattern. */
703 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
704 const struct tomoyo_path_info *pattern);
706 bool tomoyo_print_number_union(struct tomoyo_io_buffer *head,
707 const struct tomoyo_number_union *ptr);
708 bool tomoyo_parse_number_union(char *data, struct tomoyo_number_union *num);
710 /* Read "alias" entry in exception policy. */
711 bool tomoyo_read_alias_policy(struct tomoyo_io_buffer *head);
713 * Read "initialize_domain" and "no_initialize_domain" entry
714 * in exception policy.
716 bool tomoyo_read_domain_initializer_policy(struct tomoyo_io_buffer *head);
717 /* Read "keep_domain" and "no_keep_domain" entry in exception policy. */
718 bool tomoyo_read_domain_keeper_policy(struct tomoyo_io_buffer *head);
719 /* Read "file_pattern" entry in exception policy. */
720 bool tomoyo_read_file_pattern(struct tomoyo_io_buffer *head);
721 /* Read "path_group" entry in exception policy. */
722 bool tomoyo_read_path_group_policy(struct tomoyo_io_buffer *head);
723 /* Read "number_group" entry in exception policy. */
724 bool tomoyo_read_number_group_policy(struct tomoyo_io_buffer *head);
725 /* Read "allow_read" entry in exception policy. */
726 bool tomoyo_read_globally_readable_policy(struct tomoyo_io_buffer *head);
727 /* Read "deny_rewrite" entry in exception policy. */
728 bool tomoyo_read_no_rewrite_policy(struct tomoyo_io_buffer *head);
729 /* Tokenize a line. */
730 bool tomoyo_tokenize(char *buffer, char *w[], size_t size);
731 /* Write domain policy violation warning message to console? */
732 bool tomoyo_verbose_mode(const struct tomoyo_domain_info *domain);
733 /* Convert double path operation to operation name. */
734 const char *tomoyo_path22keyword(const u8 operation);
735 const char *tomoyo_path_number2keyword(const u8 operation);
736 const char *tomoyo_path_number32keyword(const u8 operation);
737 /* Get the last component of the given domainname. */
738 const char *tomoyo_get_last_name(const struct tomoyo_domain_info *domain);
739 /* Convert single path operation to operation name. */
740 const char *tomoyo_path2keyword(const u8 operation);
741 /* Fill "struct tomoyo_request_info". */
742 int tomoyo_init_request_info(struct tomoyo_request_info *r,
743 struct tomoyo_domain_info *domain);
744 /* Check permission for mount operation. */
745 int tomoyo_mount_permission(char *dev_name, struct path *path, char *type,
746 unsigned long flags, void *data_page);
747 /* Create "alias" entry in exception policy. */
748 int tomoyo_write_alias_policy(char *data, const bool is_delete);
750 * Create "initialize_domain" and "no_initialize_domain" entry
751 * in exception policy.
753 int tomoyo_write_domain_initializer_policy(char *data, const bool is_not,
754 const bool is_delete);
755 /* Create "keep_domain" and "no_keep_domain" entry in exception policy. */
756 int tomoyo_write_domain_keeper_policy(char *data, const bool is_not,
757 const bool is_delete);
759 * Create "allow_read/write", "allow_execute", "allow_read", "allow_write",
760 * "allow_create", "allow_unlink", "allow_mkdir", "allow_rmdir",
761 * "allow_mkfifo", "allow_mksock", "allow_mkblock", "allow_mkchar",
762 * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_rename" and
763 * "allow_link" entry in domain policy.
765 int tomoyo_write_file_policy(char *data, struct tomoyo_domain_info *domain,
766 const bool is_delete);
767 /* Create "allow_read" entry in exception policy. */
768 int tomoyo_write_globally_readable_policy(char *data, const bool is_delete);
769 /* Create "allow_mount" entry in domain policy. */
770 int tomoyo_write_mount_policy(char *data, struct tomoyo_domain_info *domain,
771 const bool is_delete);
772 /* Create "deny_rewrite" entry in exception policy. */
773 int tomoyo_write_no_rewrite_policy(char *data, const bool is_delete);
774 /* Create "file_pattern" entry in exception policy. */
775 int tomoyo_write_pattern_policy(char *data, const bool is_delete);
776 /* Create "path_group" entry in exception policy. */
777 int tomoyo_write_path_group_policy(char *data, const bool is_delete);
778 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
779 __attribute__ ((format(printf, 2, 3)));
780 /* Create "number_group" entry in exception policy. */
781 int tomoyo_write_number_group_policy(char *data, const bool is_delete);
782 /* Find a domain by the given name. */
783 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
784 /* Find or create a domain by the given name. */
785 struct tomoyo_domain_info *tomoyo_find_or_assign_new_domain(const char *
788 /* Allocate memory for "struct tomoyo_path_group". */
789 struct tomoyo_path_group *tomoyo_get_path_group(const char *group_name);
790 struct tomoyo_number_group *tomoyo_get_number_group(const char *group_name);
792 /* Check mode for specified functionality. */
793 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
795 /* Fill in "struct tomoyo_path_info" members. */
796 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
797 /* Run policy loader when /sbin/init starts. */
798 void tomoyo_load_policy(const char *filename);
800 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
802 /* Convert binary string to ascii string. */
803 int tomoyo_encode(char *buffer, int buflen, const char *str);
805 /* Returns realpath(3) of the given pathname but ignores chroot'ed root. */
806 int tomoyo_realpath_from_path2(struct path *path, char *newname,
810 * Returns realpath(3) of the given pathname but ignores chroot'ed root.
811 * These functions use kzalloc(), so the caller must call kfree()
812 * if these functions didn't return NULL.
814 char *tomoyo_realpath(const char *pathname);
816 * Same with tomoyo_realpath() except that it doesn't follow the final symlink.
818 char *tomoyo_realpath_nofollow(const char *pathname);
819 /* Same with tomoyo_realpath() except that the pathname is already solved. */
820 char *tomoyo_realpath_from_path(struct path *path);
821 /* Get patterned pathname. */
822 const char *tomoyo_file_pattern(const struct tomoyo_path_info *filename);
824 /* Check memory quota. */
825 bool tomoyo_memory_ok(void *ptr);
826 void *tomoyo_commit_ok(void *data, const unsigned int size);
829 * Keep the given name on the RAM.
830 * The RAM is shared, so NEVER try to modify or kfree() the returned name.
832 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
834 /* Check for memory usage. */
835 int tomoyo_read_memory_counter(struct tomoyo_io_buffer *head);
837 /* Set memory quota. */
838 int tomoyo_write_memory_quota(struct tomoyo_io_buffer *head);
840 /* Initialize realpath related code. */
841 void __init tomoyo_realpath_init(void);
842 int tomoyo_check_exec_perm(struct tomoyo_domain_info *domain,
843 const struct tomoyo_path_info *filename);
844 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
845 struct path *path, const int flag);
846 int tomoyo_path_number_perm(const u8 operation, struct path *path,
847 unsigned long number);
848 int tomoyo_path_number3_perm(const u8 operation, struct path *path,
849 const unsigned int mode, unsigned int dev);
850 int tomoyo_path_perm(const u8 operation, struct path *path);
851 int tomoyo_path2_perm(const u8 operation, struct path *path1,
853 int tomoyo_find_next_domain(struct linux_binprm *bprm);
855 void tomoyo_print_ulong(char *buffer, const int buffer_len,
856 const unsigned long value, const u8 type);
858 /* Drop refcount on tomoyo_name_union. */
859 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
861 /* Run garbage collector. */
862 void tomoyo_run_gc(void);
864 void tomoyo_memory_free(void *ptr);
866 /********** External variable definitions. **********/
869 extern struct srcu_struct tomoyo_ss;
871 /* The list for "struct tomoyo_domain_info". */
872 extern struct list_head tomoyo_domain_list;
874 extern struct list_head tomoyo_path_group_list;
875 extern struct list_head tomoyo_number_group_list;
876 extern struct list_head tomoyo_domain_initializer_list;
877 extern struct list_head tomoyo_domain_keeper_list;
878 extern struct list_head tomoyo_alias_list;
879 extern struct list_head tomoyo_globally_readable_list;
880 extern struct list_head tomoyo_pattern_list;
881 extern struct list_head tomoyo_no_rewrite_list;
882 extern struct list_head tomoyo_policy_manager_list;
883 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
885 /* Lock for protecting policy. */
886 extern struct mutex tomoyo_policy_lock;
888 /* Has /sbin/init started? */
889 extern bool tomoyo_policy_loaded;
891 /* The kernel's domain. */
892 extern struct tomoyo_domain_info tomoyo_kernel_domain;
894 extern unsigned int tomoyo_quota_for_query;
895 extern unsigned int tomoyo_query_memory_size;
897 /********** Inlined functions. **********/
899 static inline int tomoyo_read_lock(void)
901 return srcu_read_lock(&tomoyo_ss);
904 static inline void tomoyo_read_unlock(int idx)
906 srcu_read_unlock(&tomoyo_ss, idx);
909 /* strcmp() for "struct tomoyo_path_info" structure. */
910 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
911 const struct tomoyo_path_info *b)
913 return a->hash != b->hash || strcmp(a->name, b->name);
917 * tomoyo_is_valid - Check whether the character is a valid char.
919 * @c: The character to check.
921 * Returns true if @c is a valid character, false otherwise.
923 static inline bool tomoyo_is_valid(const unsigned char c)
925 return c > ' ' && c < 127;
929 * tomoyo_is_invalid - Check whether the character is an invalid char.
931 * @c: The character to check.
933 * Returns true if @c is an invalid character, false otherwise.
935 static inline bool tomoyo_is_invalid(const unsigned char c)
937 return c && (c <= ' ' || c >= 127);
940 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
943 struct tomoyo_name_entry *ptr =
944 container_of(name, struct tomoyo_name_entry, entry);
945 atomic_dec(&ptr->users);
949 static inline void tomoyo_put_path_group(struct tomoyo_path_group *group)
952 atomic_dec(&group->users);
955 static inline void tomoyo_put_number_group(struct tomoyo_number_group *group)
958 atomic_dec(&group->users);
961 static inline struct tomoyo_domain_info *tomoyo_domain(void)
963 return current_cred()->security;
966 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
969 return task_cred_xxx(task, security);
972 static inline bool tomoyo_is_same_acl_head(const struct tomoyo_acl_info *p1,
973 const struct tomoyo_acl_info *p2)
975 return p1->type == p2->type;
978 static inline bool tomoyo_is_same_name_union
979 (const struct tomoyo_name_union *p1, const struct tomoyo_name_union *p2)
981 return p1->filename == p2->filename && p1->group == p2->group &&
982 p1->is_group == p2->is_group;
985 static inline bool tomoyo_is_same_number_union
986 (const struct tomoyo_number_union *p1, const struct tomoyo_number_union *p2)
988 return p1->values[0] == p2->values[0] && p1->values[1] == p2->values[1]
989 && p1->group == p2->group && p1->min_type == p2->min_type &&
990 p1->max_type == p2->max_type && p1->is_group == p2->is_group;
993 static inline bool tomoyo_is_same_path_acl(const struct tomoyo_path_acl *p1,
994 const struct tomoyo_path_acl *p2)
996 return tomoyo_is_same_acl_head(&p1->head, &p2->head) &&
997 tomoyo_is_same_name_union(&p1->name, &p2->name);
1000 static inline bool tomoyo_is_same_path_number3_acl
1001 (const struct tomoyo_path_number3_acl *p1,
1002 const struct tomoyo_path_number3_acl *p2)
1004 return tomoyo_is_same_acl_head(&p1->head, &p2->head)
1005 && tomoyo_is_same_name_union(&p1->name, &p2->name)
1006 && tomoyo_is_same_number_union(&p1->mode, &p2->mode)
1007 && tomoyo_is_same_number_union(&p1->major, &p2->major)
1008 && tomoyo_is_same_number_union(&p1->minor, &p2->minor);
1012 static inline bool tomoyo_is_same_path2_acl(const struct tomoyo_path2_acl *p1,
1013 const struct tomoyo_path2_acl *p2)
1015 return tomoyo_is_same_acl_head(&p1->head, &p2->head) &&
1016 tomoyo_is_same_name_union(&p1->name1, &p2->name1) &&
1017 tomoyo_is_same_name_union(&p1->name2, &p2->name2);
1020 static inline bool tomoyo_is_same_path_number_acl
1021 (const struct tomoyo_path_number_acl *p1,
1022 const struct tomoyo_path_number_acl *p2)
1024 return tomoyo_is_same_acl_head(&p1->head, &p2->head)
1025 && tomoyo_is_same_name_union(&p1->name, &p2->name)
1026 && tomoyo_is_same_number_union(&p1->number, &p2->number);
1029 static inline bool tomoyo_is_same_mount_acl(const struct tomoyo_mount_acl *p1,
1030 const struct tomoyo_mount_acl *p2)
1032 return tomoyo_is_same_acl_head(&p1->head, &p2->head) &&
1033 tomoyo_is_same_name_union(&p1->dev_name, &p2->dev_name) &&
1034 tomoyo_is_same_name_union(&p1->dir_name, &p2->dir_name) &&
1035 tomoyo_is_same_name_union(&p1->fs_type, &p2->fs_type) &&
1036 tomoyo_is_same_number_union(&p1->flags, &p2->flags);
1039 static inline bool tomoyo_is_same_domain_initializer_entry
1040 (const struct tomoyo_domain_initializer_entry *p1,
1041 const struct tomoyo_domain_initializer_entry *p2)
1043 return p1->is_not == p2->is_not && p1->is_last_name == p2->is_last_name
1044 && p1->domainname == p2->domainname
1045 && p1->program == p2->program;
1048 static inline bool tomoyo_is_same_domain_keeper_entry
1049 (const struct tomoyo_domain_keeper_entry *p1,
1050 const struct tomoyo_domain_keeper_entry *p2)
1052 return p1->is_not == p2->is_not && p1->is_last_name == p2->is_last_name
1053 && p1->domainname == p2->domainname
1054 && p1->program == p2->program;
1057 static inline bool tomoyo_is_same_alias_entry
1058 (const struct tomoyo_alias_entry *p1, const struct tomoyo_alias_entry *p2)
1060 return p1->original_name == p2->original_name &&
1061 p1->aliased_name == p2->aliased_name;
1065 * list_for_each_cookie - iterate over a list with cookie.
1066 * @pos: the &struct list_head to use as a loop cursor.
1067 * @cookie: the &struct list_head to use as a cookie.
1068 * @head: the head for your list.
1070 * Same with list_for_each_rcu() except that this primitive uses @cookie
1071 * so that we can continue iteration.
1072 * @cookie must be NULL when iteration starts, and @cookie will become
1073 * NULL when iteration finishes.
1075 #define list_for_each_cookie(pos, cookie, head) \
1076 for (({ if (!cookie) \
1077 cookie = head; }), \
1078 pos = rcu_dereference((cookie)->next); \
1079 prefetch(pos->next), pos != (head) || ((cookie) = NULL); \
1080 (cookie) = pos, pos = rcu_dereference(pos->next))
1082 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */