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>
25 /********** Constants definitions. **********/
28 * TOMOYO uses this hash only when appending a string into the string
29 * table. Frequency of appending strings is very low. So we don't need
30 * large (e.g. 64k) hash size. 256 will be sufficient.
32 #define TOMOYO_HASH_BITS 8
33 #define TOMOYO_MAX_HASH (1u<<TOMOYO_HASH_BITS)
36 * This is the max length of a token.
38 * A token consists of only ASCII printable characters.
39 * Non printable characters in a token is represented in \ooo style
40 * octal string. Thus, \ itself is represented as \\.
42 #define TOMOYO_MAX_PATHNAME_LEN 4000
44 /* Profile number is an integer between 0 and 255. */
45 #define TOMOYO_MAX_PROFILES 256
47 enum tomoyo_mode_index
{
48 TOMOYO_CONFIG_DISABLED
,
49 TOMOYO_CONFIG_LEARNING
,
50 TOMOYO_CONFIG_PERMISSIVE
,
51 TOMOYO_CONFIG_ENFORCING
54 /* Keywords for ACLs. */
55 #define TOMOYO_KEYWORD_ALIAS "alias "
56 #define TOMOYO_KEYWORD_ALLOW_READ "allow_read "
57 #define TOMOYO_KEYWORD_DELETE "delete "
58 #define TOMOYO_KEYWORD_DENY_REWRITE "deny_rewrite "
59 #define TOMOYO_KEYWORD_FILE_PATTERN "file_pattern "
60 #define TOMOYO_KEYWORD_INITIALIZE_DOMAIN "initialize_domain "
61 #define TOMOYO_KEYWORD_KEEP_DOMAIN "keep_domain "
62 #define TOMOYO_KEYWORD_NO_INITIALIZE_DOMAIN "no_initialize_domain "
63 #define TOMOYO_KEYWORD_NO_KEEP_DOMAIN "no_keep_domain "
64 #define TOMOYO_KEYWORD_PATH_GROUP "path_group "
65 #define TOMOYO_KEYWORD_NUMBER_GROUP "number_group "
66 #define TOMOYO_KEYWORD_SELECT "select "
67 #define TOMOYO_KEYWORD_USE_PROFILE "use_profile "
68 #define TOMOYO_KEYWORD_IGNORE_GLOBAL_ALLOW_READ "ignore_global_allow_read"
69 /* A domain definition starts with <kernel>. */
70 #define TOMOYO_ROOT_NAME "<kernel>"
71 #define TOMOYO_ROOT_NAME_LEN (sizeof(TOMOYO_ROOT_NAME) - 1)
73 /* Value type definition. */
74 #define TOMOYO_VALUE_TYPE_INVALID 0
75 #define TOMOYO_VALUE_TYPE_DECIMAL 1
76 #define TOMOYO_VALUE_TYPE_OCTAL 2
77 #define TOMOYO_VALUE_TYPE_HEXADECIMAL 3
79 /* Index numbers for Access Controls. */
80 enum tomoyo_mac_index
{
81 TOMOYO_MAC_FOR_FILE
, /* domain_policy.conf */
82 TOMOYO_MAX_ACCEPT_ENTRY
,
84 TOMOYO_MAX_CONTROL_INDEX
87 /* Index numbers for Access Controls. */
88 enum tomoyo_acl_entry_type_index
{
90 TOMOYO_TYPE_PATH2_ACL
,
93 /* Index numbers for File Controls. */
96 * TYPE_READ_WRITE_ACL is special. TYPE_READ_WRITE_ACL is automatically set
97 * if both TYPE_READ_ACL and TYPE_WRITE_ACL are set. Both TYPE_READ_ACL and
98 * TYPE_WRITE_ACL are automatically set if TYPE_READ_WRITE_ACL is set.
99 * TYPE_READ_WRITE_ACL is automatically cleared if either TYPE_READ_ACL or
100 * TYPE_WRITE_ACL is cleared. Both TYPE_READ_ACL and TYPE_WRITE_ACL are
101 * automatically cleared if TYPE_READ_WRITE_ACL is cleared.
104 enum tomoyo_path_acl_index
{
105 TOMOYO_TYPE_READ_WRITE
,
117 TOMOYO_TYPE_TRUNCATE
,
127 TOMOYO_MAX_PATH_OPERATION
130 enum tomoyo_path2_acl_index
{
133 TOMOYO_TYPE_PIVOT_ROOT
,
134 TOMOYO_MAX_PATH2_OPERATION
137 enum tomoyo_securityfs_interface_index
{
139 TOMOYO_EXCEPTIONPOLICY
,
140 TOMOYO_DOMAIN_STATUS
,
141 TOMOYO_PROCESS_STATUS
,
149 /********** Structure definitions. **********/
152 * tomoyo_page_buffer is a structure which is used for holding a pathname
153 * obtained from "struct dentry" and "struct vfsmount" pair.
154 * As of now, it is 4096 bytes. If users complain that 4096 bytes is too small
155 * (because TOMOYO escapes non ASCII printable characters using \ooo format),
156 * we will make the buffer larger.
158 struct tomoyo_page_buffer
{
163 * tomoyo_request_info is a structure which is used for holding
165 * (1) Domain information of current process.
166 * (2) Access control mode of the profile.
168 struct tomoyo_request_info
{
169 struct tomoyo_domain_info
*domain
;
170 u8 mode
; /* One of tomoyo_mode_index . */
174 * tomoyo_path_info is a structure which is used for holding a string data
176 * This structure has several fields for supporting pattern matching.
178 * (1) "name" is the '\0' terminated string data.
179 * (2) "hash" is full_name_hash(name, strlen(name)).
180 * This allows tomoyo_pathcmp() to compare by hash before actually compare
182 * (3) "const_len" is the length of the initial segment of "name" which
183 * consists entirely of non wildcard characters. In other words, the length
184 * which we can compare two strings using strncmp().
185 * (4) "is_dir" is a bool which is true if "name" ends with "/",
187 * TOMOYO distinguishes directory and non-directory. A directory ends with
188 * "/" and non-directory does not end with "/".
189 * (5) "is_patterned" is a bool which is true if "name" contains wildcard
190 * characters, false otherwise. This allows TOMOYO to use "hash" and
191 * strcmp() for string comparison if "is_patterned" is false.
193 struct tomoyo_path_info
{
195 u32 hash
; /* = full_name_hash(name, strlen(name)) */
196 u16 const_len
; /* = tomoyo_const_part_length(name) */
197 bool is_dir
; /* = tomoyo_strendswith(name, "/") */
198 bool is_patterned
; /* = tomoyo_path_contains_pattern(name) */
202 * tomoyo_name_entry is a structure which is used for linking
203 * "struct tomoyo_path_info" into tomoyo_name_list .
205 struct tomoyo_name_entry
{
206 struct list_head list
;
208 struct tomoyo_path_info entry
;
212 * tomoyo_path_info_with_data is a structure which is used for holding a
213 * pathname obtained from "struct dentry" and "struct vfsmount" pair.
215 * "struct tomoyo_path_info_with_data" consists of "struct tomoyo_path_info"
216 * and buffer for the pathname, while "struct tomoyo_page_buffer" consists of
217 * buffer for the pathname only.
219 * "struct tomoyo_path_info_with_data" is intended to allow TOMOYO to release
220 * both "struct tomoyo_path_info" and buffer for the pathname by single kfree()
221 * so that we don't need to return two pointers to the caller. If the caller
222 * puts "struct tomoyo_path_info" on stack memory, we will be able to remove
223 * "struct tomoyo_path_info_with_data".
225 struct tomoyo_path_info_with_data
{
226 /* Keep "head" first, for this pointer is passed to kfree(). */
227 struct tomoyo_path_info head
;
228 char barrier1
[16]; /* Safeguard for overrun. */
229 char body
[TOMOYO_MAX_PATHNAME_LEN
];
230 char barrier2
[16]; /* Safeguard for overrun. */
233 struct tomoyo_name_union
{
234 const struct tomoyo_path_info
*filename
;
235 struct tomoyo_path_group
*group
;
239 struct tomoyo_number_union
{
240 unsigned long values
[2];
241 struct tomoyo_number_group
*group
;
247 /* Structure for "path_group" directive. */
248 struct tomoyo_path_group
{
249 struct list_head list
;
250 const struct tomoyo_path_info
*group_name
;
251 struct list_head member_list
;
255 /* Structure for "number_group" directive. */
256 struct tomoyo_number_group
{
257 struct list_head list
;
258 const struct tomoyo_path_info
*group_name
;
259 struct list_head member_list
;
263 /* Structure for "path_group" directive. */
264 struct tomoyo_path_group_member
{
265 struct list_head list
;
267 const struct tomoyo_path_info
*member_name
;
270 /* Structure for "number_group" directive. */
271 struct tomoyo_number_group_member
{
272 struct list_head list
;
274 struct tomoyo_number_union number
;
278 * tomoyo_acl_info is a structure which is used for holding
280 * (1) "list" which is linked to the ->acl_info_list of
281 * "struct tomoyo_domain_info"
282 * (2) "type" which tells type of the entry (either
283 * "struct tomoyo_path_acl" or "struct tomoyo_path2_acl").
285 * Packing "struct tomoyo_acl_info" allows
286 * "struct tomoyo_path_acl" to embed "u8" + "u16" and
287 * "struct tomoyo_path2_acl" to embed "u8"
288 * without enlarging their structure size.
290 struct tomoyo_acl_info
{
291 struct list_head list
;
296 * tomoyo_domain_info is a structure which is used for holding permissions
297 * (e.g. "allow_read /lib/libc-2.5.so") given to each domain.
298 * It has following fields.
300 * (1) "list" which is linked to tomoyo_domain_list .
301 * (2) "acl_info_list" which is linked to "struct tomoyo_acl_info".
302 * (3) "domainname" which holds the name of the domain.
303 * (4) "profile" which remembers profile number assigned to this domain.
304 * (5) "is_deleted" is a bool which is true if this domain is marked as
305 * "deleted", false otherwise.
306 * (6) "quota_warned" is a bool which is used for suppressing warning message
307 * when learning mode learned too much entries.
308 * (7) "ignore_global_allow_read" is a bool which is true if this domain
309 * should ignore "allow_read" directive in exception policy.
310 * (8) "transition_failed" is a bool which is set to true when this domain was
311 * unable to create a new domain at tomoyo_find_next_domain() because the
312 * name of the domain to be created was too long or it could not allocate
313 * memory. If set to true, more than one process continued execve()
314 * without domain transition.
315 * (9) "users" is an atomic_t that holds how many "struct cred"->security
316 * are referring this "struct tomoyo_domain_info". If is_deleted == true
317 * and users == 0, this struct will be kfree()d upon next garbage
320 * A domain's lifecycle is an analogy of files on / directory.
321 * Multiple domains with the same domainname cannot be created (as with
322 * creating files with the same filename fails with -EEXIST).
323 * If a process reached a domain, that process can reside in that domain after
324 * that domain is marked as "deleted" (as with a process can access an already
325 * open()ed file after that file was unlink()ed).
327 struct tomoyo_domain_info
{
328 struct list_head list
;
329 struct list_head acl_info_list
;
330 /* Name of this domain. Never NULL. */
331 const struct tomoyo_path_info
*domainname
;
332 u8 profile
; /* Profile number to use. */
333 bool is_deleted
; /* Delete flag. */
334 bool quota_warned
; /* Quota warnning flag. */
335 bool ignore_global_allow_read
; /* Ignore "allow_read" flag. */
336 bool transition_failed
; /* Domain transition failed flag. */
337 atomic_t users
; /* Number of referring credentials. */
341 * tomoyo_path_acl is a structure which is used for holding an
342 * entry with one pathname operation (e.g. open(), mkdir()).
343 * It has following fields.
345 * (1) "head" which is a "struct tomoyo_acl_info".
346 * (2) "perm" which is a bitmask of permitted operations.
347 * (3) "name" is the pathname.
349 * Directives held by this structure are "allow_read/write", "allow_execute",
350 * "allow_read", "allow_write", "allow_create", "allow_unlink", "allow_mkdir",
351 * "allow_rmdir", "allow_mkfifo", "allow_mksock", "allow_mkblock",
352 * "allow_mkchar", "allow_truncate", "allow_symlink", "allow_rewrite",
353 * "allow_ioctl", "allow_chmod", "allow_chown", "allow_chgrp", "allow_chroot",
354 * "allow_mount" and "allow_unmount".
356 struct tomoyo_path_acl
{
357 struct tomoyo_acl_info head
; /* type = TOMOYO_TYPE_PATH_ACL */
360 struct tomoyo_name_union name
;
364 * tomoyo_path2_acl is a structure which is used for holding an
365 * entry with two pathnames operation (i.e. link(), rename() and pivot_root()).
366 * It has following fields.
368 * (1) "head" which is a "struct tomoyo_acl_info".
369 * (2) "perm" which is a bitmask of permitted operations.
370 * (3) "name1" is the source/old pathname.
371 * (4) "name2" is the destination/new pathname.
373 * Directives held by this structure are "allow_rename", "allow_link" and
374 * "allow_pivot_root".
376 struct tomoyo_path2_acl
{
377 struct tomoyo_acl_info head
; /* type = TOMOYO_TYPE_PATH2_ACL */
379 struct tomoyo_name_union name1
;
380 struct tomoyo_name_union name2
;
384 * tomoyo_io_buffer is a structure which is used for reading and modifying
385 * configuration via /sys/kernel/security/tomoyo/ interface.
386 * It has many fields. ->read_var1 , ->read_var2 , ->write_var1 are used as
389 * Since the content of /sys/kernel/security/tomoyo/domain_policy is a list of
390 * "struct tomoyo_domain_info" entries and each "struct tomoyo_domain_info"
391 * entry has a list of "struct tomoyo_acl_info", we need two cursors when
392 * reading (one is for traversing tomoyo_domain_list and the other is for
393 * traversing "struct tomoyo_acl_info"->acl_info_list ).
395 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
396 * "select ", TOMOYO seeks the cursor ->read_var1 and ->write_var1 to the
397 * domain with the domainname specified by the rest of that line (NULL is set
399 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
400 * "delete ", TOMOYO deletes an entry or a domain specified by the rest of that
401 * line (->write_var1 is set to NULL if a domain was deleted).
402 * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
403 * neither "select " nor "delete ", an entry or a domain specified by that line
406 struct tomoyo_io_buffer
{
407 int (*read
) (struct tomoyo_io_buffer
*);
408 int (*write
) (struct tomoyo_io_buffer
*);
409 /* Exclusive lock for this structure. */
411 /* Index returned by tomoyo_read_lock(). */
413 /* The position currently reading from. */
414 struct list_head
*read_var1
;
415 /* Extra variables for reading. */
416 struct list_head
*read_var2
;
417 /* The position currently writing to. */
418 struct tomoyo_domain_info
*write_var1
;
419 /* The step for reading. */
421 /* Buffer for reading. */
423 /* EOF flag for reading. */
425 /* Read domain ACL of specified PID? */
426 bool read_single_domain
;
427 /* Extra variable for reading. */
429 /* Bytes available for reading. */
431 /* Size of read buffer. */
433 /* Buffer for writing. */
435 /* Bytes available for writing. */
437 /* Size of write buffer. */
442 * tomoyo_globally_readable_file_entry is a structure which is used for holding
443 * "allow_read" entries.
444 * It has following fields.
446 * (1) "list" which is linked to tomoyo_globally_readable_list .
447 * (2) "filename" is a pathname which is allowed to open(O_RDONLY).
448 * (3) "is_deleted" is a bool which is true if marked as deleted, false
451 struct tomoyo_globally_readable_file_entry
{
452 struct list_head list
;
453 const struct tomoyo_path_info
*filename
;
458 * tomoyo_pattern_entry is a structure which is used for holding
459 * "tomoyo_pattern_list" entries.
460 * It has following fields.
462 * (1) "list" which is linked to tomoyo_pattern_list .
463 * (2) "pattern" is a pathname pattern which is used for converting pathnames
464 * to pathname patterns during learning mode.
465 * (3) "is_deleted" is a bool which is true if marked as deleted, false
468 struct tomoyo_pattern_entry
{
469 struct list_head list
;
470 const struct tomoyo_path_info
*pattern
;
475 * tomoyo_no_rewrite_entry is a structure which is used for holding
476 * "deny_rewrite" entries.
477 * It has following fields.
479 * (1) "list" which is linked to tomoyo_no_rewrite_list .
480 * (2) "pattern" is a pathname which is by default not permitted to modify
481 * already existing content.
482 * (3) "is_deleted" is a bool which is true if marked as deleted, false
485 struct tomoyo_no_rewrite_entry
{
486 struct list_head list
;
487 const struct tomoyo_path_info
*pattern
;
492 * tomoyo_domain_initializer_entry is a structure which is used for holding
493 * "initialize_domain" and "no_initialize_domain" entries.
494 * It has following fields.
496 * (1) "list" which is linked to tomoyo_domain_initializer_list .
497 * (2) "domainname" which is "a domainname" or "the last component of a
498 * domainname". This field is NULL if "from" clause is not specified.
499 * (3) "program" which is a program's pathname.
500 * (4) "is_deleted" is a bool which is true if marked as deleted, false
502 * (5) "is_not" is a bool which is true if "no_initialize_domain", false
504 * (6) "is_last_name" is a bool which is true if "domainname" is "the last
505 * component of a domainname", false otherwise.
507 struct tomoyo_domain_initializer_entry
{
508 struct list_head list
;
509 const struct tomoyo_path_info
*domainname
; /* This may be NULL */
510 const struct tomoyo_path_info
*program
;
512 bool is_not
; /* True if this entry is "no_initialize_domain". */
513 /* True if the domainname is tomoyo_get_last_name(). */
518 * tomoyo_domain_keeper_entry is a structure which is used for holding
519 * "keep_domain" and "no_keep_domain" entries.
520 * It has following fields.
522 * (1) "list" which is linked to tomoyo_domain_keeper_list .
523 * (2) "domainname" which is "a domainname" or "the last component of a
525 * (3) "program" which is a program's pathname.
526 * This field is NULL if "from" clause is not specified.
527 * (4) "is_deleted" is a bool which is true if marked as deleted, false
529 * (5) "is_not" is a bool which is true if "no_initialize_domain", false
531 * (6) "is_last_name" is a bool which is true if "domainname" is "the last
532 * component of a domainname", false otherwise.
534 struct tomoyo_domain_keeper_entry
{
535 struct list_head list
;
536 const struct tomoyo_path_info
*domainname
;
537 const struct tomoyo_path_info
*program
; /* This may be NULL */
539 bool is_not
; /* True if this entry is "no_keep_domain". */
540 /* True if the domainname is tomoyo_get_last_name(). */
545 * tomoyo_alias_entry is a structure which is used for holding "alias" entries.
546 * It has following fields.
548 * (1) "list" which is linked to tomoyo_alias_list .
549 * (2) "original_name" which is a dereferenced pathname.
550 * (3) "aliased_name" which is a symlink's pathname.
551 * (4) "is_deleted" is a bool which is true if marked as deleted, false
554 struct tomoyo_alias_entry
{
555 struct list_head list
;
556 const struct tomoyo_path_info
*original_name
;
557 const struct tomoyo_path_info
*aliased_name
;
562 * tomoyo_policy_manager_entry is a structure which is used for holding list of
563 * domainnames or programs which are permitted to modify configuration via
564 * /sys/kernel/security/tomoyo/ interface.
565 * It has following fields.
567 * (1) "list" which is linked to tomoyo_policy_manager_list .
568 * (2) "manager" is a domainname or a program's pathname.
569 * (3) "is_domain" is a bool which is true if "manager" is a domainname, false
571 * (4) "is_deleted" is a bool which is true if marked as deleted, false
574 struct tomoyo_policy_manager_entry
{
575 struct list_head list
;
576 /* A path to program or a domainname. */
577 const struct tomoyo_path_info
*manager
;
578 bool is_domain
; /* True if manager is a domainname. */
579 bool is_deleted
; /* True if this entry is deleted. */
582 /********** Function prototypes. **********/
584 /* Check whether the given name matches the given name_union. */
585 bool tomoyo_compare_name_union(const struct tomoyo_path_info
*name
,
586 const struct tomoyo_name_union
*ptr
);
587 /* Check whether the domain has too many ACL entries to hold. */
588 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info
*r
);
589 /* Transactional sprintf() for policy dump. */
590 bool tomoyo_io_printf(struct tomoyo_io_buffer
*head
, const char *fmt
, ...)
591 __attribute__ ((format(printf
, 2, 3)));
592 /* Check whether the domainname is correct. */
593 bool tomoyo_is_correct_domain(const unsigned char *domainname
);
594 /* Check whether the token is correct. */
595 bool tomoyo_is_correct_path(const char *filename
, const s8 start_type
,
596 const s8 pattern_type
, const s8 end_type
);
597 /* Check whether the token can be a domainname. */
598 bool tomoyo_is_domain_def(const unsigned char *buffer
);
599 bool tomoyo_parse_name_union(const char *filename
,
600 struct tomoyo_name_union
*ptr
);
601 /* Check whether the given filename matches the given path_group. */
602 bool tomoyo_path_matches_group(const struct tomoyo_path_info
*pathname
,
603 const struct tomoyo_path_group
*group
,
604 const bool may_use_pattern
);
605 /* Check whether the given value matches the given number_group. */
606 bool tomoyo_number_matches_group(const unsigned long min
,
607 const unsigned long max
,
608 const struct tomoyo_number_group
*group
);
609 /* Check whether the given filename matches the given pattern. */
610 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info
*filename
,
611 const struct tomoyo_path_info
*pattern
);
613 bool tomoyo_print_number_union(struct tomoyo_io_buffer
*head
,
614 const struct tomoyo_number_union
*ptr
);
615 bool tomoyo_parse_number_union(char *data
, struct tomoyo_number_union
*num
);
617 /* Read "alias" entry in exception policy. */
618 bool tomoyo_read_alias_policy(struct tomoyo_io_buffer
*head
);
620 * Read "initialize_domain" and "no_initialize_domain" entry
621 * in exception policy.
623 bool tomoyo_read_domain_initializer_policy(struct tomoyo_io_buffer
*head
);
624 /* Read "keep_domain" and "no_keep_domain" entry in exception policy. */
625 bool tomoyo_read_domain_keeper_policy(struct tomoyo_io_buffer
*head
);
626 /* Read "file_pattern" entry in exception policy. */
627 bool tomoyo_read_file_pattern(struct tomoyo_io_buffer
*head
);
628 /* Read "path_group" entry in exception policy. */
629 bool tomoyo_read_path_group_policy(struct tomoyo_io_buffer
*head
);
630 /* Read "number_group" entry in exception policy. */
631 bool tomoyo_read_number_group_policy(struct tomoyo_io_buffer
*head
);
632 /* Read "allow_read" entry in exception policy. */
633 bool tomoyo_read_globally_readable_policy(struct tomoyo_io_buffer
*head
);
634 /* Read "deny_rewrite" entry in exception policy. */
635 bool tomoyo_read_no_rewrite_policy(struct tomoyo_io_buffer
*head
);
636 /* Tokenize a line. */
637 bool tomoyo_tokenize(char *buffer
, char *w
[], size_t size
);
638 /* Write domain policy violation warning message to console? */
639 bool tomoyo_verbose_mode(const struct tomoyo_domain_info
*domain
);
640 /* Convert double path operation to operation name. */
641 const char *tomoyo_path22keyword(const u8 operation
);
642 /* Get the last component of the given domainname. */
643 const char *tomoyo_get_last_name(const struct tomoyo_domain_info
*domain
);
644 /* Convert single path operation to operation name. */
645 const char *tomoyo_path2keyword(const u8 operation
);
646 /* Create "alias" entry in exception policy. */
647 int tomoyo_write_alias_policy(char *data
, const bool is_delete
);
649 * Create "initialize_domain" and "no_initialize_domain" entry
650 * in exception policy.
652 int tomoyo_write_domain_initializer_policy(char *data
, const bool is_not
,
653 const bool is_delete
);
654 /* Create "keep_domain" and "no_keep_domain" entry in exception policy. */
655 int tomoyo_write_domain_keeper_policy(char *data
, const bool is_not
,
656 const bool is_delete
);
658 * Create "allow_read/write", "allow_execute", "allow_read", "allow_write",
659 * "allow_create", "allow_unlink", "allow_mkdir", "allow_rmdir",
660 * "allow_mkfifo", "allow_mksock", "allow_mkblock", "allow_mkchar",
661 * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_rename" and
662 * "allow_link" entry in domain policy.
664 int tomoyo_write_file_policy(char *data
, struct tomoyo_domain_info
*domain
,
665 const bool is_delete
);
666 /* Create "allow_read" entry in exception policy. */
667 int tomoyo_write_globally_readable_policy(char *data
, const bool is_delete
);
668 /* Create "deny_rewrite" entry in exception policy. */
669 int tomoyo_write_no_rewrite_policy(char *data
, const bool is_delete
);
670 /* Create "file_pattern" entry in exception policy. */
671 int tomoyo_write_pattern_policy(char *data
, const bool is_delete
);
672 /* Create "path_group" entry in exception policy. */
673 int tomoyo_write_path_group_policy(char *data
, const bool is_delete
);
674 /* Create "number_group" entry in exception policy. */
675 int tomoyo_write_number_group_policy(char *data
, const bool is_delete
);
676 /* Find a domain by the given name. */
677 struct tomoyo_domain_info
*tomoyo_find_domain(const char *domainname
);
678 /* Find or create a domain by the given name. */
679 struct tomoyo_domain_info
*tomoyo_find_or_assign_new_domain(const char *
683 /* Allocate memory for "struct tomoyo_path_group". */
684 struct tomoyo_path_group
*tomoyo_get_path_group(const char *group_name
);
685 struct tomoyo_number_group
*tomoyo_get_number_group(const char *group_name
);
687 /* Check mode for specified functionality. */
688 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info
*domain
,
690 /* Fill in "struct tomoyo_path_info" members. */
691 void tomoyo_fill_path_info(struct tomoyo_path_info
*ptr
);
692 /* Run policy loader when /sbin/init starts. */
693 void tomoyo_load_policy(const char *filename
);
695 void tomoyo_put_number_union(struct tomoyo_number_union
*ptr
);
697 /* Convert binary string to ascii string. */
698 int tomoyo_encode(char *buffer
, int buflen
, const char *str
);
700 /* Returns realpath(3) of the given pathname but ignores chroot'ed root. */
701 int tomoyo_realpath_from_path2(struct path
*path
, char *newname
,
705 * Returns realpath(3) of the given pathname but ignores chroot'ed root.
706 * These functions use kzalloc(), so the caller must call kfree()
707 * if these functions didn't return NULL.
709 char *tomoyo_realpath(const char *pathname
);
711 * Same with tomoyo_realpath() except that it doesn't follow the final symlink.
713 char *tomoyo_realpath_nofollow(const char *pathname
);
714 /* Same with tomoyo_realpath() except that the pathname is already solved. */
715 char *tomoyo_realpath_from_path(struct path
*path
);
717 /* Check memory quota. */
718 bool tomoyo_memory_ok(void *ptr
);
719 void *tomoyo_commit_ok(void *data
, const unsigned int size
);
722 * Keep the given name on the RAM.
723 * The RAM is shared, so NEVER try to modify or kfree() the returned name.
725 const struct tomoyo_path_info
*tomoyo_get_name(const char *name
);
727 /* Check for memory usage. */
728 int tomoyo_read_memory_counter(struct tomoyo_io_buffer
*head
);
730 /* Set memory quota. */
731 int tomoyo_write_memory_quota(struct tomoyo_io_buffer
*head
);
733 /* Initialize realpath related code. */
734 void __init
tomoyo_realpath_init(void);
735 int tomoyo_check_exec_perm(struct tomoyo_domain_info
*domain
,
736 const struct tomoyo_path_info
*filename
);
737 int tomoyo_check_open_permission(struct tomoyo_domain_info
*domain
,
738 struct path
*path
, const int flag
);
739 int tomoyo_path_perm(const u8 operation
, struct path
*path
);
740 int tomoyo_path2_perm(const u8 operation
, struct path
*path1
,
742 int tomoyo_find_next_domain(struct linux_binprm
*bprm
);
744 /* Drop refcount on tomoyo_name_union. */
745 void tomoyo_put_name_union(struct tomoyo_name_union
*ptr
);
747 /* Run garbage collector. */
748 void tomoyo_run_gc(void);
750 void tomoyo_memory_free(void *ptr
);
752 /********** External variable definitions. **********/
755 extern struct srcu_struct tomoyo_ss
;
757 /* The list for "struct tomoyo_domain_info". */
758 extern struct list_head tomoyo_domain_list
;
760 extern struct list_head tomoyo_path_group_list
;
761 extern struct list_head tomoyo_number_group_list
;
762 extern struct list_head tomoyo_domain_initializer_list
;
763 extern struct list_head tomoyo_domain_keeper_list
;
764 extern struct list_head tomoyo_alias_list
;
765 extern struct list_head tomoyo_globally_readable_list
;
766 extern struct list_head tomoyo_pattern_list
;
767 extern struct list_head tomoyo_no_rewrite_list
;
768 extern struct list_head tomoyo_policy_manager_list
;
769 extern struct list_head tomoyo_name_list
[TOMOYO_MAX_HASH
];
771 /* Lock for protecting policy. */
772 extern struct mutex tomoyo_policy_lock
;
774 /* Has /sbin/init started? */
775 extern bool tomoyo_policy_loaded
;
777 /* The kernel's domain. */
778 extern struct tomoyo_domain_info tomoyo_kernel_domain
;
780 /********** Inlined functions. **********/
782 static inline int tomoyo_read_lock(void)
784 return srcu_read_lock(&tomoyo_ss
);
787 static inline void tomoyo_read_unlock(int idx
)
789 srcu_read_unlock(&tomoyo_ss
, idx
);
792 /* strcmp() for "struct tomoyo_path_info" structure. */
793 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info
*a
,
794 const struct tomoyo_path_info
*b
)
796 return a
->hash
!= b
->hash
|| strcmp(a
->name
, b
->name
);
800 * tomoyo_is_valid - Check whether the character is a valid char.
802 * @c: The character to check.
804 * Returns true if @c is a valid character, false otherwise.
806 static inline bool tomoyo_is_valid(const unsigned char c
)
808 return c
> ' ' && c
< 127;
812 * tomoyo_is_invalid - Check whether the character is an invalid char.
814 * @c: The character to check.
816 * Returns true if @c is an invalid character, false otherwise.
818 static inline bool tomoyo_is_invalid(const unsigned char c
)
820 return c
&& (c
<= ' ' || c
>= 127);
823 static inline void tomoyo_put_name(const struct tomoyo_path_info
*name
)
826 struct tomoyo_name_entry
*ptr
=
827 container_of(name
, struct tomoyo_name_entry
, entry
);
828 atomic_dec(&ptr
->users
);
832 static inline void tomoyo_put_path_group(struct tomoyo_path_group
*group
)
835 atomic_dec(&group
->users
);
838 static inline void tomoyo_put_number_group(struct tomoyo_number_group
*group
)
841 atomic_dec(&group
->users
);
844 static inline struct tomoyo_domain_info
*tomoyo_domain(void)
846 return current_cred()->security
;
849 static inline struct tomoyo_domain_info
*tomoyo_real_domain(struct task_struct
852 return task_cred_xxx(task
, security
);
855 static inline bool tomoyo_is_same_acl_head(const struct tomoyo_acl_info
*p1
,
856 const struct tomoyo_acl_info
*p2
)
858 return p1
->type
== p2
->type
;
861 static inline bool tomoyo_is_same_name_union
862 (const struct tomoyo_name_union
*p1
, const struct tomoyo_name_union
*p2
)
864 return p1
->filename
== p2
->filename
&& p1
->group
== p2
->group
&&
865 p1
->is_group
== p2
->is_group
;
868 static inline bool tomoyo_is_same_number_union
869 (const struct tomoyo_number_union
*p1
, const struct tomoyo_number_union
*p2
)
871 return p1
->values
[0] == p2
->values
[0] && p1
->values
[1] == p2
->values
[1]
872 && p1
->group
== p2
->group
&& p1
->min_type
== p2
->min_type
&&
873 p1
->max_type
== p2
->max_type
&& p1
->is_group
== p2
->is_group
;
876 static inline bool tomoyo_is_same_path_acl(const struct tomoyo_path_acl
*p1
,
877 const struct tomoyo_path_acl
*p2
)
879 return tomoyo_is_same_acl_head(&p1
->head
, &p2
->head
) &&
880 tomoyo_is_same_name_union(&p1
->name
, &p2
->name
);
883 static inline bool tomoyo_is_same_path2_acl(const struct tomoyo_path2_acl
*p1
,
884 const struct tomoyo_path2_acl
*p2
)
886 return tomoyo_is_same_acl_head(&p1
->head
, &p2
->head
) &&
887 tomoyo_is_same_name_union(&p1
->name1
, &p2
->name1
) &&
888 tomoyo_is_same_name_union(&p1
->name2
, &p2
->name2
);
891 static inline bool tomoyo_is_same_domain_initializer_entry
892 (const struct tomoyo_domain_initializer_entry
*p1
,
893 const struct tomoyo_domain_initializer_entry
*p2
)
895 return p1
->is_not
== p2
->is_not
&& p1
->is_last_name
== p2
->is_last_name
896 && p1
->domainname
== p2
->domainname
897 && p1
->program
== p2
->program
;
900 static inline bool tomoyo_is_same_domain_keeper_entry
901 (const struct tomoyo_domain_keeper_entry
*p1
,
902 const struct tomoyo_domain_keeper_entry
*p2
)
904 return p1
->is_not
== p2
->is_not
&& p1
->is_last_name
== p2
->is_last_name
905 && p1
->domainname
== p2
->domainname
906 && p1
->program
== p2
->program
;
909 static inline bool tomoyo_is_same_alias_entry
910 (const struct tomoyo_alias_entry
*p1
, const struct tomoyo_alias_entry
*p2
)
912 return p1
->original_name
== p2
->original_name
&&
913 p1
->aliased_name
== p2
->aliased_name
;
917 * list_for_each_cookie - iterate over a list with cookie.
918 * @pos: the &struct list_head to use as a loop cursor.
919 * @cookie: the &struct list_head to use as a cookie.
920 * @head: the head for your list.
922 * Same with list_for_each_rcu() except that this primitive uses @cookie
923 * so that we can continue iteration.
924 * @cookie must be NULL when iteration starts, and @cookie will become
925 * NULL when iteration finishes.
927 #define list_for_each_cookie(pos, cookie, head) \
928 for (({ if (!cookie) \
930 pos = rcu_dereference((cookie)->next); \
931 prefetch(pos->next), pos != (head) || ((cookie) = NULL); \
932 (cookie) = pos, pos = rcu_dereference(pos->next))
934 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */