kprobes: Make functions static
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / security / tomoyo / common.h
blob04454cb7b24a534e84c8873a8babeb9614a8da60
1 /*
2 * security/tomoyo/common.h
4 * Header file for TOMOYO.
6 * Copyright (C) 2005-2010 NTT DATA CORPORATION
7 */
9 #ifndef _SECURITY_TOMOYO_COMMON_H
10 #define _SECURITY_TOMOYO_COMMON_H
12 #include <linux/ctype.h>
13 #include <linux/string.h>
14 #include <linux/mm.h>
15 #include <linux/file.h>
16 #include <linux/kmod.h>
17 #include <linux/fs.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 struct linux_binprm;
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)
36 #define TOMOYO_EXEC_TMPSIZE 4096
38 /* Profile number is an integer between 0 and 255. */
39 #define TOMOYO_MAX_PROFILES 256
41 enum tomoyo_mode_index {
42 TOMOYO_CONFIG_DISABLED,
43 TOMOYO_CONFIG_LEARNING,
44 TOMOYO_CONFIG_PERMISSIVE,
45 TOMOYO_CONFIG_ENFORCING,
46 TOMOYO_CONFIG_USE_DEFAULT = 255
49 enum tomoyo_policy_id {
50 TOMOYO_ID_GROUP,
51 TOMOYO_ID_PATH_GROUP,
52 TOMOYO_ID_NUMBER_GROUP,
53 TOMOYO_ID_TRANSITION_CONTROL,
54 TOMOYO_ID_AGGREGATOR,
55 TOMOYO_ID_GLOBALLY_READABLE,
56 TOMOYO_ID_PATTERN,
57 TOMOYO_ID_NO_REWRITE,
58 TOMOYO_ID_MANAGER,
59 TOMOYO_ID_NAME,
60 TOMOYO_ID_ACL,
61 TOMOYO_ID_DOMAIN,
62 TOMOYO_MAX_POLICY
65 enum tomoyo_group_id {
66 TOMOYO_PATH_GROUP,
67 TOMOYO_NUMBER_GROUP,
68 TOMOYO_MAX_GROUP
71 /* Keywords for ACLs. */
72 #define TOMOYO_KEYWORD_AGGREGATOR "aggregator "
73 #define TOMOYO_KEYWORD_ALLOW_MOUNT "allow_mount "
74 #define TOMOYO_KEYWORD_ALLOW_READ "allow_read "
75 #define TOMOYO_KEYWORD_DELETE "delete "
76 #define TOMOYO_KEYWORD_DENY_REWRITE "deny_rewrite "
77 #define TOMOYO_KEYWORD_FILE_PATTERN "file_pattern "
78 #define TOMOYO_KEYWORD_INITIALIZE_DOMAIN "initialize_domain "
79 #define TOMOYO_KEYWORD_KEEP_DOMAIN "keep_domain "
80 #define TOMOYO_KEYWORD_NO_INITIALIZE_DOMAIN "no_initialize_domain "
81 #define TOMOYO_KEYWORD_NO_KEEP_DOMAIN "no_keep_domain "
82 #define TOMOYO_KEYWORD_PATH_GROUP "path_group "
83 #define TOMOYO_KEYWORD_NUMBER_GROUP "number_group "
84 #define TOMOYO_KEYWORD_SELECT "select "
85 #define TOMOYO_KEYWORD_USE_PROFILE "use_profile "
86 #define TOMOYO_KEYWORD_IGNORE_GLOBAL_ALLOW_READ "ignore_global_allow_read"
87 #define TOMOYO_KEYWORD_QUOTA_EXCEEDED "quota_exceeded"
88 #define TOMOYO_KEYWORD_TRANSITION_FAILED "transition_failed"
89 /* A domain definition starts with <kernel>. */
90 #define TOMOYO_ROOT_NAME "<kernel>"
91 #define TOMOYO_ROOT_NAME_LEN (sizeof(TOMOYO_ROOT_NAME) - 1)
93 /* Value type definition. */
94 #define TOMOYO_VALUE_TYPE_INVALID 0
95 #define TOMOYO_VALUE_TYPE_DECIMAL 1
96 #define TOMOYO_VALUE_TYPE_OCTAL 2
97 #define TOMOYO_VALUE_TYPE_HEXADECIMAL 3
99 enum tomoyo_transition_type {
100 /* Do not change this order, */
101 TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
102 TOMOYO_TRANSITION_CONTROL_INITIALIZE,
103 TOMOYO_TRANSITION_CONTROL_NO_KEEP,
104 TOMOYO_TRANSITION_CONTROL_KEEP,
105 TOMOYO_MAX_TRANSITION_TYPE
108 /* Index numbers for Access Controls. */
109 enum tomoyo_acl_entry_type_index {
110 TOMOYO_TYPE_PATH_ACL,
111 TOMOYO_TYPE_PATH2_ACL,
112 TOMOYO_TYPE_PATH_NUMBER_ACL,
113 TOMOYO_TYPE_MKDEV_ACL,
114 TOMOYO_TYPE_MOUNT_ACL,
117 /* Index numbers for File Controls. */
120 * TOMOYO_TYPE_READ_WRITE is special. TOMOYO_TYPE_READ_WRITE is automatically
121 * set if both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are set.
122 * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically set if
123 * TOMOYO_TYPE_READ_WRITE is set.
124 * TOMOYO_TYPE_READ_WRITE is automatically cleared if either TOMOYO_TYPE_READ
125 * or TOMOYO_TYPE_WRITE is cleared.
126 * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically cleared if
127 * TOMOYO_TYPE_READ_WRITE is cleared.
130 enum tomoyo_path_acl_index {
131 TOMOYO_TYPE_READ_WRITE,
132 TOMOYO_TYPE_EXECUTE,
133 TOMOYO_TYPE_READ,
134 TOMOYO_TYPE_WRITE,
135 TOMOYO_TYPE_UNLINK,
136 TOMOYO_TYPE_RMDIR,
137 TOMOYO_TYPE_TRUNCATE,
138 TOMOYO_TYPE_SYMLINK,
139 TOMOYO_TYPE_REWRITE,
140 TOMOYO_TYPE_CHROOT,
141 TOMOYO_TYPE_UMOUNT,
142 TOMOYO_MAX_PATH_OPERATION
145 #define TOMOYO_RW_MASK ((1 << TOMOYO_TYPE_READ) | (1 << TOMOYO_TYPE_WRITE))
147 enum tomoyo_mkdev_acl_index {
148 TOMOYO_TYPE_MKBLOCK,
149 TOMOYO_TYPE_MKCHAR,
150 TOMOYO_MAX_MKDEV_OPERATION
153 enum tomoyo_path2_acl_index {
154 TOMOYO_TYPE_LINK,
155 TOMOYO_TYPE_RENAME,
156 TOMOYO_TYPE_PIVOT_ROOT,
157 TOMOYO_MAX_PATH2_OPERATION
160 enum tomoyo_path_number_acl_index {
161 TOMOYO_TYPE_CREATE,
162 TOMOYO_TYPE_MKDIR,
163 TOMOYO_TYPE_MKFIFO,
164 TOMOYO_TYPE_MKSOCK,
165 TOMOYO_TYPE_IOCTL,
166 TOMOYO_TYPE_CHMOD,
167 TOMOYO_TYPE_CHOWN,
168 TOMOYO_TYPE_CHGRP,
169 TOMOYO_MAX_PATH_NUMBER_OPERATION
172 enum tomoyo_securityfs_interface_index {
173 TOMOYO_DOMAINPOLICY,
174 TOMOYO_EXCEPTIONPOLICY,
175 TOMOYO_DOMAIN_STATUS,
176 TOMOYO_PROCESS_STATUS,
177 TOMOYO_MEMINFO,
178 TOMOYO_SELFDOMAIN,
179 TOMOYO_VERSION,
180 TOMOYO_PROFILE,
181 TOMOYO_QUERY,
182 TOMOYO_MANAGER
185 enum tomoyo_mac_index {
186 TOMOYO_MAC_FILE_EXECUTE,
187 TOMOYO_MAC_FILE_OPEN,
188 TOMOYO_MAC_FILE_CREATE,
189 TOMOYO_MAC_FILE_UNLINK,
190 TOMOYO_MAC_FILE_MKDIR,
191 TOMOYO_MAC_FILE_RMDIR,
192 TOMOYO_MAC_FILE_MKFIFO,
193 TOMOYO_MAC_FILE_MKSOCK,
194 TOMOYO_MAC_FILE_TRUNCATE,
195 TOMOYO_MAC_FILE_SYMLINK,
196 TOMOYO_MAC_FILE_REWRITE,
197 TOMOYO_MAC_FILE_MKBLOCK,
198 TOMOYO_MAC_FILE_MKCHAR,
199 TOMOYO_MAC_FILE_LINK,
200 TOMOYO_MAC_FILE_RENAME,
201 TOMOYO_MAC_FILE_CHMOD,
202 TOMOYO_MAC_FILE_CHOWN,
203 TOMOYO_MAC_FILE_CHGRP,
204 TOMOYO_MAC_FILE_IOCTL,
205 TOMOYO_MAC_FILE_CHROOT,
206 TOMOYO_MAC_FILE_MOUNT,
207 TOMOYO_MAC_FILE_UMOUNT,
208 TOMOYO_MAC_FILE_PIVOT_ROOT,
209 TOMOYO_MAX_MAC_INDEX
212 enum tomoyo_mac_category_index {
213 TOMOYO_MAC_CATEGORY_FILE,
214 TOMOYO_MAX_MAC_CATEGORY_INDEX
217 #define TOMOYO_RETRY_REQUEST 1 /* Retry this request. */
219 /********** Structure definitions. **********/
222 * tomoyo_acl_head is a structure which is used for holding elements not in
223 * domain policy.
224 * It has following fields.
226 * (1) "list" which is linked to tomoyo_policy_list[] .
227 * (2) "is_deleted" is a bool which is true if marked as deleted, false
228 * otherwise.
230 struct tomoyo_acl_head {
231 struct list_head list;
232 bool is_deleted;
233 } __packed;
236 * tomoyo_request_info is a structure which is used for holding
238 * (1) Domain information of current process.
239 * (2) How many retries are made for this request.
240 * (3) Profile number used for this request.
241 * (4) Access control mode of the profile.
243 struct tomoyo_request_info {
244 struct tomoyo_domain_info *domain;
245 /* For holding parameters. */
246 union {
247 struct {
248 const struct tomoyo_path_info *filename;
249 /* For using wildcards at tomoyo_find_next_domain(). */
250 const struct tomoyo_path_info *matched_path;
251 u8 operation;
252 } path;
253 struct {
254 const struct tomoyo_path_info *filename1;
255 const struct tomoyo_path_info *filename2;
256 u8 operation;
257 } path2;
258 struct {
259 const struct tomoyo_path_info *filename;
260 unsigned int mode;
261 unsigned int major;
262 unsigned int minor;
263 u8 operation;
264 } mkdev;
265 struct {
266 const struct tomoyo_path_info *filename;
267 unsigned long number;
268 u8 operation;
269 } path_number;
270 struct {
271 const struct tomoyo_path_info *type;
272 const struct tomoyo_path_info *dir;
273 const struct tomoyo_path_info *dev;
274 unsigned long flags;
275 int need_dev;
276 } mount;
277 } param;
278 u8 param_type;
279 bool granted;
280 u8 retry;
281 u8 profile;
282 u8 mode; /* One of tomoyo_mode_index . */
283 u8 type;
287 * tomoyo_path_info is a structure which is used for holding a string data
288 * used by TOMOYO.
289 * This structure has several fields for supporting pattern matching.
291 * (1) "name" is the '\0' terminated string data.
292 * (2) "hash" is full_name_hash(name, strlen(name)).
293 * This allows tomoyo_pathcmp() to compare by hash before actually compare
294 * using strcmp().
295 * (3) "const_len" is the length of the initial segment of "name" which
296 * consists entirely of non wildcard characters. In other words, the length
297 * which we can compare two strings using strncmp().
298 * (4) "is_dir" is a bool which is true if "name" ends with "/",
299 * false otherwise.
300 * TOMOYO distinguishes directory and non-directory. A directory ends with
301 * "/" and non-directory does not end with "/".
302 * (5) "is_patterned" is a bool which is true if "name" contains wildcard
303 * characters, false otherwise. This allows TOMOYO to use "hash" and
304 * strcmp() for string comparison if "is_patterned" is false.
306 struct tomoyo_path_info {
307 const char *name;
308 u32 hash; /* = full_name_hash(name, strlen(name)) */
309 u16 const_len; /* = tomoyo_const_part_length(name) */
310 bool is_dir; /* = tomoyo_strendswith(name, "/") */
311 bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
315 * tomoyo_name is a structure which is used for linking
316 * "struct tomoyo_path_info" into tomoyo_name_list .
318 struct tomoyo_name {
319 struct list_head list;
320 atomic_t users;
321 struct tomoyo_path_info entry;
324 struct tomoyo_name_union {
325 const struct tomoyo_path_info *filename;
326 struct tomoyo_group *group;
327 u8 is_group;
330 struct tomoyo_number_union {
331 unsigned long values[2];
332 struct tomoyo_group *group;
333 u8 min_type;
334 u8 max_type;
335 u8 is_group;
338 /* Structure for "path_group"/"number_group" directive. */
339 struct tomoyo_group {
340 struct list_head list;
341 const struct tomoyo_path_info *group_name;
342 struct list_head member_list;
343 atomic_t users;
346 /* Structure for "path_group" directive. */
347 struct tomoyo_path_group {
348 struct tomoyo_acl_head head;
349 const struct tomoyo_path_info *member_name;
352 /* Structure for "number_group" directive. */
353 struct tomoyo_number_group {
354 struct tomoyo_acl_head head;
355 struct tomoyo_number_union number;
359 * tomoyo_acl_info is a structure which is used for holding
361 * (1) "list" which is linked to the ->acl_info_list of
362 * "struct tomoyo_domain_info"
363 * (2) "is_deleted" is a bool which is true if this domain is marked as
364 * "deleted", false otherwise.
365 * (3) "type" which tells type of the entry.
367 * Packing "struct tomoyo_acl_info" allows
368 * "struct tomoyo_path_acl" to embed "u16" and "struct tomoyo_path2_acl"
369 * "struct tomoyo_path_number_acl" "struct tomoyo_mkdev_acl" to embed
370 * "u8" without enlarging their structure size.
372 struct tomoyo_acl_info {
373 struct list_head list;
374 bool is_deleted;
375 u8 type; /* = one of values in "enum tomoyo_acl_entry_type_index". */
376 } __packed;
379 * tomoyo_domain_info is a structure which is used for holding permissions
380 * (e.g. "allow_read /lib/libc-2.5.so") given to each domain.
381 * It has following fields.
383 * (1) "list" which is linked to tomoyo_domain_list .
384 * (2) "acl_info_list" which is linked to "struct tomoyo_acl_info".
385 * (3) "domainname" which holds the name of the domain.
386 * (4) "profile" which remembers profile number assigned to this domain.
387 * (5) "is_deleted" is a bool which is true if this domain is marked as
388 * "deleted", false otherwise.
389 * (6) "quota_warned" is a bool which is used for suppressing warning message
390 * when learning mode learned too much entries.
391 * (7) "ignore_global_allow_read" is a bool which is true if this domain
392 * should ignore "allow_read" directive in exception policy.
393 * (8) "transition_failed" is a bool which is set to true when this domain was
394 * unable to create a new domain at tomoyo_find_next_domain() because the
395 * name of the domain to be created was too long or it could not allocate
396 * memory. If set to true, more than one process continued execve()
397 * without domain transition.
398 * (9) "users" is an atomic_t that holds how many "struct cred"->security
399 * are referring this "struct tomoyo_domain_info". If is_deleted == true
400 * and users == 0, this struct will be kfree()d upon next garbage
401 * collection.
403 * A domain's lifecycle is an analogy of files on / directory.
404 * Multiple domains with the same domainname cannot be created (as with
405 * creating files with the same filename fails with -EEXIST).
406 * If a process reached a domain, that process can reside in that domain after
407 * that domain is marked as "deleted" (as with a process can access an already
408 * open()ed file after that file was unlink()ed).
410 struct tomoyo_domain_info {
411 struct list_head list;
412 struct list_head acl_info_list;
413 /* Name of this domain. Never NULL. */
414 const struct tomoyo_path_info *domainname;
415 u8 profile; /* Profile number to use. */
416 bool is_deleted; /* Delete flag. */
417 bool quota_warned; /* Quota warnning flag. */
418 bool ignore_global_allow_read; /* Ignore "allow_read" flag. */
419 bool transition_failed; /* Domain transition failed flag. */
420 atomic_t users; /* Number of referring credentials. */
424 * tomoyo_path_acl is a structure which is used for holding an
425 * entry with one pathname operation (e.g. open(), mkdir()).
426 * It has following fields.
428 * (1) "head" which is a "struct tomoyo_acl_info".
429 * (2) "perm" which is a bitmask of permitted operations.
430 * (3) "name" is the pathname.
432 * Directives held by this structure are "allow_read/write", "allow_execute",
433 * "allow_read", "allow_write", "allow_unlink", "allow_rmdir",
434 * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_chroot" and
435 * "allow_unmount".
437 struct tomoyo_path_acl {
438 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
439 u16 perm;
440 struct tomoyo_name_union name;
444 * tomoyo_path_number_acl is a structure which is used for holding an
445 * entry with one pathname and one number operation.
446 * It has following fields.
448 * (1) "head" which is a "struct tomoyo_acl_info".
449 * (2) "perm" which is a bitmask of permitted operations.
450 * (3) "name" is the pathname.
451 * (4) "number" is the numeric value.
453 * Directives held by this structure are "allow_create", "allow_mkdir",
454 * "allow_ioctl", "allow_mkfifo", "allow_mksock", "allow_chmod", "allow_chown"
455 * and "allow_chgrp".
458 struct tomoyo_path_number_acl {
459 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
460 u8 perm;
461 struct tomoyo_name_union name;
462 struct tomoyo_number_union number;
466 * tomoyo_mkdev_acl is a structure which is used for holding an
467 * entry with one pathname and three numbers operation.
468 * It has following fields.
470 * (1) "head" which is a "struct tomoyo_acl_info".
471 * (2) "perm" which is a bitmask of permitted operations.
472 * (3) "mode" is the create mode.
473 * (4) "major" is the major number of device node.
474 * (5) "minor" is the minor number of device node.
476 * Directives held by this structure are "allow_mkchar", "allow_mkblock".
479 struct tomoyo_mkdev_acl {
480 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
481 u8 perm;
482 struct tomoyo_name_union name;
483 struct tomoyo_number_union mode;
484 struct tomoyo_number_union major;
485 struct tomoyo_number_union minor;
489 * tomoyo_path2_acl is a structure which is used for holding an
490 * entry with two pathnames operation (i.e. link(), rename() and pivot_root()).
491 * It has following fields.
493 * (1) "head" which is a "struct tomoyo_acl_info".
494 * (2) "perm" which is a bitmask of permitted operations.
495 * (3) "name1" is the source/old pathname.
496 * (4) "name2" is the destination/new pathname.
498 * Directives held by this structure are "allow_rename", "allow_link" and
499 * "allow_pivot_root".
501 struct tomoyo_path2_acl {
502 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
503 u8 perm;
504 struct tomoyo_name_union name1;
505 struct tomoyo_name_union name2;
509 * tomoyo_mount_acl is a structure which is used for holding an
510 * entry for mount operation.
511 * It has following fields.
513 * (1) "head" which is a "struct tomoyo_acl_info".
514 * (2) "dev_name" is the device name.
515 * (3) "dir_name" is the mount point.
516 * (4) "fs_type" is the filesystem type.
517 * (5) "flags" is the mount flags.
519 * Directive held by this structure is "allow_mount".
521 struct tomoyo_mount_acl {
522 struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
523 struct tomoyo_name_union dev_name;
524 struct tomoyo_name_union dir_name;
525 struct tomoyo_name_union fs_type;
526 struct tomoyo_number_union flags;
529 #define TOMOYO_MAX_IO_READ_QUEUE 32
532 * Structure for reading/writing policy via /sys/kernel/security/tomoyo
533 * interfaces.
535 struct tomoyo_io_buffer {
536 void (*read) (struct tomoyo_io_buffer *);
537 int (*write) (struct tomoyo_io_buffer *);
538 int (*poll) (struct file *file, poll_table *wait);
539 /* Exclusive lock for this structure. */
540 struct mutex io_sem;
541 /* Index returned by tomoyo_read_lock(). */
542 int reader_idx;
543 char __user *read_user_buf;
544 int read_user_buf_avail;
545 struct {
546 struct list_head *domain;
547 struct list_head *group;
548 struct list_head *acl;
549 int avail;
550 int step;
551 int query_index;
552 u16 index;
553 u8 bit;
554 u8 w_pos;
555 bool eof;
556 bool print_this_domain_only;
557 bool print_execute_only;
558 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
559 } r;
560 /* The position currently writing to. */
561 struct tomoyo_domain_info *write_var1;
562 /* Buffer for reading. */
563 char *read_buf;
564 /* Size of read buffer. */
565 int readbuf_size;
566 /* Buffer for writing. */
567 char *write_buf;
568 /* Bytes available for writing. */
569 int write_avail;
570 /* Size of write buffer. */
571 int writebuf_size;
572 /* Type of this interface. */
573 u8 type;
577 * tomoyo_readable_file is a structure which is used for holding
578 * "allow_read" entries.
579 * It has following fields.
581 * (1) "head" is "struct tomoyo_acl_head".
582 * (2) "filename" is a pathname which is allowed to open(O_RDONLY).
584 struct tomoyo_readable_file {
585 struct tomoyo_acl_head head;
586 const struct tomoyo_path_info *filename;
590 * tomoyo_no_pattern is a structure which is used for holding
591 * "file_pattern" entries.
592 * It has following fields.
594 * (1) "head" is "struct tomoyo_acl_head".
595 * (2) "pattern" is a pathname pattern which is used for converting pathnames
596 * to pathname patterns during learning mode.
598 struct tomoyo_no_pattern {
599 struct tomoyo_acl_head head;
600 const struct tomoyo_path_info *pattern;
604 * tomoyo_no_rewrite is a structure which is used for holding
605 * "deny_rewrite" entries.
606 * It has following fields.
608 * (1) "head" is "struct tomoyo_acl_head".
609 * (2) "pattern" is a pathname which is by default not permitted to modify
610 * already existing content.
612 struct tomoyo_no_rewrite {
613 struct tomoyo_acl_head head;
614 const struct tomoyo_path_info *pattern;
618 * tomoyo_transition_control is a structure which is used for holding
619 * "initialize_domain"/"no_initialize_domain"/"keep_domain"/"no_keep_domain"
620 * entries.
621 * It has following fields.
623 * (1) "head" is "struct tomoyo_acl_head".
624 * (2) "type" is type of this entry.
625 * (3) "is_last_name" is a bool which is true if "domainname" is "the last
626 * component of a domainname", false otherwise.
627 * (4) "domainname" which is "a domainname" or "the last component of a
628 * domainname".
629 * (5) "program" which is a program's pathname.
631 struct tomoyo_transition_control {
632 struct tomoyo_acl_head head;
633 u8 type; /* One of values in "enum tomoyo_transition_type". */
634 /* True if the domainname is tomoyo_get_last_name(). */
635 bool is_last_name;
636 const struct tomoyo_path_info *domainname; /* Maybe NULL */
637 const struct tomoyo_path_info *program; /* Maybe NULL */
641 * tomoyo_aggregator is a structure which is used for holding
642 * "aggregator" entries.
643 * It has following fields.
645 * (1) "head" is "struct tomoyo_acl_head".
646 * (2) "original_name" which is originally requested name.
647 * (3) "aggregated_name" which is name to rewrite.
649 struct tomoyo_aggregator {
650 struct tomoyo_acl_head head;
651 const struct tomoyo_path_info *original_name;
652 const struct tomoyo_path_info *aggregated_name;
656 * tomoyo_manager is a structure which is used for holding list of
657 * domainnames or programs which are permitted to modify configuration via
658 * /sys/kernel/security/tomoyo/ interface.
659 * It has following fields.
661 * (1) "head" is "struct tomoyo_acl_head".
662 * (2) "is_domain" is a bool which is true if "manager" is a domainname, false
663 * otherwise.
664 * (3) "manager" is a domainname or a program's pathname.
666 struct tomoyo_manager {
667 struct tomoyo_acl_head head;
668 bool is_domain; /* True if manager is a domainname. */
669 /* A path to program or a domainname. */
670 const struct tomoyo_path_info *manager;
673 struct tomoyo_preference {
674 unsigned int learning_max_entry;
675 bool enforcing_verbose;
676 bool learning_verbose;
677 bool permissive_verbose;
680 struct tomoyo_profile {
681 const struct tomoyo_path_info *comment;
682 struct tomoyo_preference *learning;
683 struct tomoyo_preference *permissive;
684 struct tomoyo_preference *enforcing;
685 struct tomoyo_preference preference;
686 u8 default_config;
687 u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
690 /********** Function prototypes. **********/
692 extern asmlinkage long sys_getpid(void);
693 extern asmlinkage long sys_getppid(void);
695 /* Check whether the given string starts with the given keyword. */
696 bool tomoyo_str_starts(char **src, const char *find);
697 /* Get tomoyo_realpath() of current process. */
698 const char *tomoyo_get_exe(void);
699 /* Format string. */
700 void tomoyo_normalize_line(unsigned char *buffer);
701 /* Print warning or error message on console. */
702 void tomoyo_warn_log(struct tomoyo_request_info *r, const char *fmt, ...)
703 __attribute__ ((format(printf, 2, 3)));
704 /* Check all profiles currently assigned to domains are defined. */
705 void tomoyo_check_profile(void);
706 /* Open operation for /sys/kernel/security/tomoyo/ interface. */
707 int tomoyo_open_control(const u8 type, struct file *file);
708 /* Close /sys/kernel/security/tomoyo/ interface. */
709 int tomoyo_close_control(struct file *file);
710 /* Poll operation for /sys/kernel/security/tomoyo/ interface. */
711 int tomoyo_poll_control(struct file *file, poll_table *wait);
712 /* Read operation for /sys/kernel/security/tomoyo/ interface. */
713 int tomoyo_read_control(struct file *file, char __user *buffer,
714 const int buffer_len);
715 /* Write operation for /sys/kernel/security/tomoyo/ interface. */
716 int tomoyo_write_control(struct file *file, const char __user *buffer,
717 const int buffer_len);
718 /* Check whether the domain has too many ACL entries to hold. */
719 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
720 /* Print out of memory warning message. */
721 void tomoyo_warn_oom(const char *function);
722 /* Check whether the given name matches the given name_union. */
723 const struct tomoyo_path_info *
724 tomoyo_compare_name_union(const struct tomoyo_path_info *name,
725 const struct tomoyo_name_union *ptr);
726 /* Check whether the given number matches the given number_union. */
727 bool tomoyo_compare_number_union(const unsigned long value,
728 const struct tomoyo_number_union *ptr);
729 int tomoyo_get_mode(const u8 profile, const u8 index);
730 void tomoyo_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
731 __attribute__ ((format(printf, 2, 3)));
732 /* Check whether the domainname is correct. */
733 bool tomoyo_correct_domain(const unsigned char *domainname);
734 /* Check whether the token is correct. */
735 bool tomoyo_correct_path(const char *filename);
736 bool tomoyo_correct_word(const char *string);
737 /* Check whether the token can be a domainname. */
738 bool tomoyo_domain_def(const unsigned char *buffer);
739 bool tomoyo_parse_name_union(const char *filename,
740 struct tomoyo_name_union *ptr);
741 /* Check whether the given filename matches the given path_group. */
742 const struct tomoyo_path_info *
743 tomoyo_path_matches_group(const struct tomoyo_path_info *pathname,
744 const struct tomoyo_group *group);
745 /* Check whether the given value matches the given number_group. */
746 bool tomoyo_number_matches_group(const unsigned long min,
747 const unsigned long max,
748 const struct tomoyo_group *group);
749 /* Check whether the given filename matches the given pattern. */
750 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
751 const struct tomoyo_path_info *pattern);
753 bool tomoyo_parse_number_union(char *data, struct tomoyo_number_union *num);
754 /* Tokenize a line. */
755 bool tomoyo_tokenize(char *buffer, char *w[], size_t size);
756 /* Write domain policy violation warning message to console? */
757 bool tomoyo_verbose_mode(const struct tomoyo_domain_info *domain);
758 /* Fill "struct tomoyo_request_info". */
759 int tomoyo_init_request_info(struct tomoyo_request_info *r,
760 struct tomoyo_domain_info *domain,
761 const u8 index);
762 /* Check permission for mount operation. */
763 int tomoyo_mount_permission(char *dev_name, struct path *path, char *type,
764 unsigned long flags, void *data_page);
765 /* Create "aggregator" entry in exception policy. */
766 int tomoyo_write_aggregator(char *data, const bool is_delete);
767 int tomoyo_write_transition_control(char *data, const bool is_delete,
768 const u8 type);
770 * Create "allow_read/write", "allow_execute", "allow_read", "allow_write",
771 * "allow_create", "allow_unlink", "allow_mkdir", "allow_rmdir",
772 * "allow_mkfifo", "allow_mksock", "allow_mkblock", "allow_mkchar",
773 * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_rename" and
774 * "allow_link" entry in domain policy.
776 int tomoyo_write_file(char *data, struct tomoyo_domain_info *domain,
777 const bool is_delete);
778 /* Create "allow_read" entry in exception policy. */
779 int tomoyo_write_globally_readable(char *data, const bool is_delete);
780 /* Create "allow_mount" entry in domain policy. */
781 int tomoyo_write_mount(char *data, struct tomoyo_domain_info *domain,
782 const bool is_delete);
783 /* Create "deny_rewrite" entry in exception policy. */
784 int tomoyo_write_no_rewrite(char *data, const bool is_delete);
785 /* Create "file_pattern" entry in exception policy. */
786 int tomoyo_write_pattern(char *data, const bool is_delete);
787 /* Create "path_group"/"number_group" entry in exception policy. */
788 int tomoyo_write_group(char *data, const bool is_delete, const u8 type);
789 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
790 __attribute__ ((format(printf, 2, 3)));
791 /* Find a domain by the given name. */
792 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
793 /* Find or create a domain by the given name. */
794 struct tomoyo_domain_info *tomoyo_assign_domain(const char *domainname,
795 const u8 profile);
796 struct tomoyo_profile *tomoyo_profile(const u8 profile);
798 * Allocate memory for "struct tomoyo_path_group"/"struct tomoyo_number_group".
800 struct tomoyo_group *tomoyo_get_group(const char *group_name, const u8 type);
802 /* Check mode for specified functionality. */
803 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
804 const u8 index);
805 /* Fill in "struct tomoyo_path_info" members. */
806 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
807 /* Run policy loader when /sbin/init starts. */
808 void tomoyo_load_policy(const char *filename);
810 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
812 /* Convert binary string to ascii string. */
813 char *tomoyo_encode(const char *str);
816 * Returns realpath(3) of the given pathname except that
817 * ignores chroot'ed root and does not follow the final symlink.
819 char *tomoyo_realpath_nofollow(const char *pathname);
821 * Returns realpath(3) of the given pathname except that
822 * ignores chroot'ed root and the pathname is already solved.
824 char *tomoyo_realpath_from_path(struct path *path);
825 /* Get patterned pathname. */
826 const char *tomoyo_pattern(const struct tomoyo_path_info *filename);
828 /* Check memory quota. */
829 bool tomoyo_memory_ok(void *ptr);
830 void *tomoyo_commit_ok(void *data, const unsigned int size);
833 * Keep the given name on the RAM.
834 * The RAM is shared, so NEVER try to modify or kfree() the returned name.
836 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
838 /* Check for memory usage. */
839 void tomoyo_read_memory_counter(struct tomoyo_io_buffer *head);
841 /* Set memory quota. */
842 int tomoyo_write_memory_quota(struct tomoyo_io_buffer *head);
844 /* Initialize mm related code. */
845 void __init tomoyo_mm_init(void);
846 int tomoyo_path_permission(struct tomoyo_request_info *r, u8 operation,
847 const struct tomoyo_path_info *filename);
848 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
849 struct path *path, const int flag);
850 int tomoyo_path_number_perm(const u8 operation, struct path *path,
851 unsigned long number);
852 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
853 const unsigned int mode, unsigned int dev);
854 int tomoyo_path_perm(const u8 operation, struct path *path);
855 int tomoyo_path2_perm(const u8 operation, struct path *path1,
856 struct path *path2);
857 int tomoyo_find_next_domain(struct linux_binprm *bprm);
859 void tomoyo_print_ulong(char *buffer, const int buffer_len,
860 const unsigned long value, const u8 type);
862 /* Drop refcount on tomoyo_name_union. */
863 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
865 /* Run garbage collector. */
866 void tomoyo_run_gc(void);
868 void tomoyo_memory_free(void *ptr);
870 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
871 bool is_delete, struct tomoyo_domain_info *domain,
872 bool (*check_duplicate) (const struct tomoyo_acl_info
874 const struct tomoyo_acl_info
876 bool (*merge_duplicate) (struct tomoyo_acl_info *,
877 struct tomoyo_acl_info *,
878 const bool));
879 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
880 bool is_delete, struct list_head *list,
881 bool (*check_duplicate) (const struct tomoyo_acl_head
883 const struct tomoyo_acl_head
884 *));
885 void tomoyo_check_acl(struct tomoyo_request_info *r,
886 bool (*check_entry) (struct tomoyo_request_info *,
887 const struct tomoyo_acl_info *));
889 /********** External variable definitions. **********/
891 /* Lock for GC. */
892 extern struct srcu_struct tomoyo_ss;
894 /* The list for "struct tomoyo_domain_info". */
895 extern struct list_head tomoyo_domain_list;
897 extern struct list_head tomoyo_policy_list[TOMOYO_MAX_POLICY];
898 extern struct list_head tomoyo_group_list[TOMOYO_MAX_GROUP];
899 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
901 /* Lock for protecting policy. */
902 extern struct mutex tomoyo_policy_lock;
904 /* Has /sbin/init started? */
905 extern bool tomoyo_policy_loaded;
907 /* The kernel's domain. */
908 extern struct tomoyo_domain_info tomoyo_kernel_domain;
910 extern const char *tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
911 extern const char *tomoyo_mkdev_keyword[TOMOYO_MAX_MKDEV_OPERATION];
912 extern const char *tomoyo_path2_keyword[TOMOYO_MAX_PATH2_OPERATION];
913 extern const char *tomoyo_path_number_keyword[TOMOYO_MAX_PATH_NUMBER_OPERATION];
915 extern unsigned int tomoyo_quota_for_query;
916 extern unsigned int tomoyo_query_memory_size;
918 /********** Inlined functions. **********/
920 static inline int tomoyo_read_lock(void)
922 return srcu_read_lock(&tomoyo_ss);
925 static inline void tomoyo_read_unlock(int idx)
927 srcu_read_unlock(&tomoyo_ss, idx);
930 /* strcmp() for "struct tomoyo_path_info" structure. */
931 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
932 const struct tomoyo_path_info *b)
934 return a->hash != b->hash || strcmp(a->name, b->name);
938 * tomoyo_valid - Check whether the character is a valid char.
940 * @c: The character to check.
942 * Returns true if @c is a valid character, false otherwise.
944 static inline bool tomoyo_valid(const unsigned char c)
946 return c > ' ' && c < 127;
950 * tomoyo_invalid - Check whether the character is an invalid char.
952 * @c: The character to check.
954 * Returns true if @c is an invalid character, false otherwise.
956 static inline bool tomoyo_invalid(const unsigned char c)
958 return c && (c <= ' ' || c >= 127);
961 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
963 if (name) {
964 struct tomoyo_name *ptr =
965 container_of(name, typeof(*ptr), entry);
966 atomic_dec(&ptr->users);
970 static inline void tomoyo_put_group(struct tomoyo_group *group)
972 if (group)
973 atomic_dec(&group->users);
976 static inline struct tomoyo_domain_info *tomoyo_domain(void)
978 return current_cred()->security;
981 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
982 *task)
984 return task_cred_xxx(task, security);
987 static inline bool tomoyo_same_acl_head(const struct tomoyo_acl_info *p1,
988 const struct tomoyo_acl_info *p2)
990 return p1->type == p2->type;
993 static inline bool tomoyo_same_name_union
994 (const struct tomoyo_name_union *p1, const struct tomoyo_name_union *p2)
996 return p1->filename == p2->filename && p1->group == p2->group &&
997 p1->is_group == p2->is_group;
1000 static inline bool tomoyo_same_number_union
1001 (const struct tomoyo_number_union *p1, const struct tomoyo_number_union *p2)
1003 return p1->values[0] == p2->values[0] && p1->values[1] == p2->values[1]
1004 && p1->group == p2->group && p1->min_type == p2->min_type &&
1005 p1->max_type == p2->max_type && p1->is_group == p2->is_group;
1009 * list_for_each_cookie - iterate over a list with cookie.
1010 * @pos: the &struct list_head to use as a loop cursor.
1011 * @head: the head for your list.
1013 #define list_for_each_cookie(pos, head) \
1014 if (!pos) \
1015 pos = srcu_dereference((head)->next, &tomoyo_ss); \
1016 for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
1018 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */