TOMOYO: Add ACL group support.
[platform/adaptation/renesas_rcar/renesas_kernel.git] / security / tomoyo / common.h
1 /*
2  * security/tomoyo/common.h
3  *
4  * Header file for TOMOYO.
5  *
6  * Copyright (C) 2005-2010  NTT DATA CORPORATION
7  */
8
9 #ifndef _SECURITY_TOMOYO_COMMON_H
10 #define _SECURITY_TOMOYO_COMMON_H
11
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;
25
26 /********** Constants definitions. **********/
27
28 /*
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.
32  */
33 #define TOMOYO_HASH_BITS  8
34 #define TOMOYO_MAX_HASH (1u<<TOMOYO_HASH_BITS)
35
36 #define TOMOYO_EXEC_TMPSIZE     4096
37
38 /* Profile number is an integer between 0 and 255. */
39 #define TOMOYO_MAX_PROFILES 256
40
41 /* Group number is an integer between 0 and 255. */
42 #define TOMOYO_MAX_ACL_GROUPS 256
43
44 /* Index numbers for operation mode. */
45 enum tomoyo_mode_index {
46         TOMOYO_CONFIG_DISABLED,
47         TOMOYO_CONFIG_LEARNING,
48         TOMOYO_CONFIG_PERMISSIVE,
49         TOMOYO_CONFIG_ENFORCING,
50         TOMOYO_CONFIG_MAX_MODE,
51         TOMOYO_CONFIG_WANT_REJECT_LOG =  64,
52         TOMOYO_CONFIG_WANT_GRANT_LOG  = 128,
53         TOMOYO_CONFIG_USE_DEFAULT     = 255,
54 };
55
56 /* Index numbers for entry type. */
57 enum tomoyo_policy_id {
58         TOMOYO_ID_GROUP,
59         TOMOYO_ID_PATH_GROUP,
60         TOMOYO_ID_NUMBER_GROUP,
61         TOMOYO_ID_TRANSITION_CONTROL,
62         TOMOYO_ID_AGGREGATOR,
63         TOMOYO_ID_MANAGER,
64         TOMOYO_ID_NAME,
65         TOMOYO_ID_ACL,
66         TOMOYO_ID_DOMAIN,
67         TOMOYO_MAX_POLICY
68 };
69
70 /* Index numbers for group entries. */
71 enum tomoyo_group_id {
72         TOMOYO_PATH_GROUP,
73         TOMOYO_NUMBER_GROUP,
74         TOMOYO_MAX_GROUP
75 };
76
77 /* A domain definition starts with <kernel>. */
78 #define TOMOYO_ROOT_NAME                         "<kernel>"
79 #define TOMOYO_ROOT_NAME_LEN                     (sizeof(TOMOYO_ROOT_NAME) - 1)
80
81 /* Index numbers for type of numeric values. */
82 enum tomoyo_value_type {
83         TOMOYO_VALUE_TYPE_INVALID,
84         TOMOYO_VALUE_TYPE_DECIMAL,
85         TOMOYO_VALUE_TYPE_OCTAL,
86         TOMOYO_VALUE_TYPE_HEXADECIMAL,
87 };
88
89 /* Index numbers for domain transition control keywords. */
90 enum tomoyo_transition_type {
91         /* Do not change this order, */
92         TOMOYO_TRANSITION_CONTROL_NO_INITIALIZE,
93         TOMOYO_TRANSITION_CONTROL_INITIALIZE,
94         TOMOYO_TRANSITION_CONTROL_NO_KEEP,
95         TOMOYO_TRANSITION_CONTROL_KEEP,
96         TOMOYO_MAX_TRANSITION_TYPE
97 };
98
99 /* Index numbers for Access Controls. */
100 enum tomoyo_acl_entry_type_index {
101         TOMOYO_TYPE_PATH_ACL,
102         TOMOYO_TYPE_PATH2_ACL,
103         TOMOYO_TYPE_PATH_NUMBER_ACL,
104         TOMOYO_TYPE_MKDEV_ACL,
105         TOMOYO_TYPE_MOUNT_ACL,
106 };
107
108 /* Index numbers for access controls with one pathname. */
109 enum tomoyo_path_acl_index {
110         TOMOYO_TYPE_EXECUTE,
111         TOMOYO_TYPE_READ,
112         TOMOYO_TYPE_WRITE,
113         TOMOYO_TYPE_APPEND,
114         TOMOYO_TYPE_UNLINK,
115         TOMOYO_TYPE_GETATTR,
116         TOMOYO_TYPE_RMDIR,
117         TOMOYO_TYPE_TRUNCATE,
118         TOMOYO_TYPE_SYMLINK,
119         TOMOYO_TYPE_CHROOT,
120         TOMOYO_TYPE_UMOUNT,
121         TOMOYO_MAX_PATH_OPERATION
122 };
123
124 enum tomoyo_memory_stat_type {
125         TOMOYO_MEMORY_POLICY,
126         TOMOYO_MEMORY_AUDIT,
127         TOMOYO_MEMORY_QUERY,
128         TOMOYO_MAX_MEMORY_STAT
129 };
130
131 enum tomoyo_mkdev_acl_index {
132         TOMOYO_TYPE_MKBLOCK,
133         TOMOYO_TYPE_MKCHAR,
134         TOMOYO_MAX_MKDEV_OPERATION
135 };
136
137 /* Index numbers for access controls with two pathnames. */
138 enum tomoyo_path2_acl_index {
139         TOMOYO_TYPE_LINK,
140         TOMOYO_TYPE_RENAME,
141         TOMOYO_TYPE_PIVOT_ROOT,
142         TOMOYO_MAX_PATH2_OPERATION
143 };
144
145 /* Index numbers for access controls with one pathname and one number. */
146 enum tomoyo_path_number_acl_index {
147         TOMOYO_TYPE_CREATE,
148         TOMOYO_TYPE_MKDIR,
149         TOMOYO_TYPE_MKFIFO,
150         TOMOYO_TYPE_MKSOCK,
151         TOMOYO_TYPE_IOCTL,
152         TOMOYO_TYPE_CHMOD,
153         TOMOYO_TYPE_CHOWN,
154         TOMOYO_TYPE_CHGRP,
155         TOMOYO_MAX_PATH_NUMBER_OPERATION
156 };
157
158 /* Index numbers for /sys/kernel/security/tomoyo/ interfaces. */
159 enum tomoyo_securityfs_interface_index {
160         TOMOYO_DOMAINPOLICY,
161         TOMOYO_EXCEPTIONPOLICY,
162         TOMOYO_DOMAIN_STATUS,
163         TOMOYO_PROCESS_STATUS,
164         TOMOYO_MEMINFO,
165         TOMOYO_SELFDOMAIN,
166         TOMOYO_AUDIT,
167         TOMOYO_VERSION,
168         TOMOYO_PROFILE,
169         TOMOYO_QUERY,
170         TOMOYO_MANAGER
171 };
172
173 /* Index numbers for special mount operations. */
174 enum tomoyo_special_mount {
175         TOMOYO_MOUNT_BIND,            /* mount --bind /source /dest   */
176         TOMOYO_MOUNT_MOVE,            /* mount --move /old /new       */
177         TOMOYO_MOUNT_REMOUNT,         /* mount -o remount /dir        */
178         TOMOYO_MOUNT_MAKE_UNBINDABLE, /* mount --make-unbindable /dir */
179         TOMOYO_MOUNT_MAKE_PRIVATE,    /* mount --make-private /dir    */
180         TOMOYO_MOUNT_MAKE_SLAVE,      /* mount --make-slave /dir      */
181         TOMOYO_MOUNT_MAKE_SHARED,     /* mount --make-shared /dir     */
182         TOMOYO_MAX_SPECIAL_MOUNT
183 };
184
185 /* Index numbers for functionality. */
186 enum tomoyo_mac_index {
187         TOMOYO_MAC_FILE_EXECUTE,
188         TOMOYO_MAC_FILE_OPEN,
189         TOMOYO_MAC_FILE_CREATE,
190         TOMOYO_MAC_FILE_UNLINK,
191         TOMOYO_MAC_FILE_GETATTR,
192         TOMOYO_MAC_FILE_MKDIR,
193         TOMOYO_MAC_FILE_RMDIR,
194         TOMOYO_MAC_FILE_MKFIFO,
195         TOMOYO_MAC_FILE_MKSOCK,
196         TOMOYO_MAC_FILE_TRUNCATE,
197         TOMOYO_MAC_FILE_SYMLINK,
198         TOMOYO_MAC_FILE_MKBLOCK,
199         TOMOYO_MAC_FILE_MKCHAR,
200         TOMOYO_MAC_FILE_LINK,
201         TOMOYO_MAC_FILE_RENAME,
202         TOMOYO_MAC_FILE_CHMOD,
203         TOMOYO_MAC_FILE_CHOWN,
204         TOMOYO_MAC_FILE_CHGRP,
205         TOMOYO_MAC_FILE_IOCTL,
206         TOMOYO_MAC_FILE_CHROOT,
207         TOMOYO_MAC_FILE_MOUNT,
208         TOMOYO_MAC_FILE_UMOUNT,
209         TOMOYO_MAC_FILE_PIVOT_ROOT,
210         TOMOYO_MAX_MAC_INDEX
211 };
212
213 /* Index numbers for category of functionality. */
214 enum tomoyo_mac_category_index {
215         TOMOYO_MAC_CATEGORY_FILE,
216         TOMOYO_MAX_MAC_CATEGORY_INDEX
217 };
218
219 /*
220  * Retry this request. Returned by tomoyo_supervisor() if policy violation has
221  * occurred in enforcing mode and the userspace daemon decided to retry.
222  *
223  * We must choose a positive value in order to distinguish "granted" (which is
224  * 0) and "rejected" (which is a negative value) and "retry".
225  */
226 #define TOMOYO_RETRY_REQUEST 1
227
228 /* Index numbers for profile's PREFERENCE values. */
229 enum tomoyo_pref_index {
230         TOMOYO_PREF_MAX_AUDIT_LOG,
231         TOMOYO_PREF_MAX_LEARNING_ENTRY,
232         TOMOYO_MAX_PREF
233 };
234
235 /********** Structure definitions. **********/
236
237 /* Common header for holding ACL entries. */
238 struct tomoyo_acl_head {
239         struct list_head list;
240         bool is_deleted;
241 } __packed;
242
243 /* Common header for shared entries. */
244 struct tomoyo_shared_acl_head {
245         struct list_head list;
246         atomic_t users;
247 } __packed;
248
249 /* Structure for request info. */
250 struct tomoyo_request_info {
251         struct tomoyo_domain_info *domain;
252         /* For holding parameters. */
253         union {
254                 struct {
255                         const struct tomoyo_path_info *filename;
256                         /* For using wildcards at tomoyo_find_next_domain(). */
257                         const struct tomoyo_path_info *matched_path;
258                         /* One of values in "enum tomoyo_path_acl_index". */
259                         u8 operation;
260                 } path;
261                 struct {
262                         const struct tomoyo_path_info *filename1;
263                         const struct tomoyo_path_info *filename2;
264                         /* One of values in "enum tomoyo_path2_acl_index". */
265                         u8 operation;
266                 } path2;
267                 struct {
268                         const struct tomoyo_path_info *filename;
269                         unsigned int mode;
270                         unsigned int major;
271                         unsigned int minor;
272                         /* One of values in "enum tomoyo_mkdev_acl_index". */
273                         u8 operation;
274                 } mkdev;
275                 struct {
276                         const struct tomoyo_path_info *filename;
277                         unsigned long number;
278                         /*
279                          * One of values in
280                          * "enum tomoyo_path_number_acl_index".
281                          */
282                         u8 operation;
283                 } path_number;
284                 struct {
285                         const struct tomoyo_path_info *type;
286                         const struct tomoyo_path_info *dir;
287                         const struct tomoyo_path_info *dev;
288                         unsigned long flags;
289                         int need_dev;
290                 } mount;
291         } param;
292         u8 param_type;
293         bool granted;
294         u8 retry;
295         u8 profile;
296         u8 mode; /* One of tomoyo_mode_index . */
297         u8 type;
298 };
299
300 /* Structure for holding a token. */
301 struct tomoyo_path_info {
302         const char *name;
303         u32 hash;          /* = full_name_hash(name, strlen(name)) */
304         u16 const_len;     /* = tomoyo_const_part_length(name)     */
305         bool is_dir;       /* = tomoyo_strendswith(name, "/")      */
306         bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
307 };
308
309 /* Structure for holding string data. */
310 struct tomoyo_name {
311         struct tomoyo_shared_acl_head head;
312         struct tomoyo_path_info entry;
313 };
314
315 /* Structure for holding a word. */
316 struct tomoyo_name_union {
317         /* Either @filename or @group is NULL. */
318         const struct tomoyo_path_info *filename;
319         struct tomoyo_group *group;
320 };
321
322 /* Structure for holding a number. */
323 struct tomoyo_number_union {
324         unsigned long values[2];
325         struct tomoyo_group *group; /* Maybe NULL. */
326         /* One of values in "enum tomoyo_value_type". */
327         u8 value_type[2];
328 };
329
330 /* Structure for "path_group"/"number_group" directive. */
331 struct tomoyo_group {
332         struct tomoyo_shared_acl_head head;
333         const struct tomoyo_path_info *group_name;
334         struct list_head member_list;
335 };
336
337 /* Structure for "path_group" directive. */
338 struct tomoyo_path_group {
339         struct tomoyo_acl_head head;
340         const struct tomoyo_path_info *member_name;
341 };
342
343 /* Structure for "number_group" directive. */
344 struct tomoyo_number_group {
345         struct tomoyo_acl_head head;
346         struct tomoyo_number_union number;
347 };
348
349 /* Common header for individual entries. */
350 struct tomoyo_acl_info {
351         struct list_head list;
352         bool is_deleted;
353         u8 type; /* One of values in "enum tomoyo_acl_entry_type_index". */
354 } __packed;
355
356 /* Structure for domain information. */
357 struct tomoyo_domain_info {
358         struct list_head list;
359         struct list_head acl_info_list;
360         /* Name of this domain. Never NULL.          */
361         const struct tomoyo_path_info *domainname;
362         u8 profile;        /* Profile number to use. */
363         u8 group;          /* Group number to use.   */
364         bool is_deleted;   /* Delete flag.           */
365         bool quota_warned; /* Quota warnning flag.   */
366         bool transition_failed; /* Domain transition failed flag. */
367         atomic_t users; /* Number of referring credentials. */
368 };
369
370 /*
371  * Structure for "file execute", "file read", "file write", "file append",
372  * "file unlink", "file getattr", "file rmdir", "file truncate",
373  * "file symlink", "file chroot" and "file unmount" directive.
374  */
375 struct tomoyo_path_acl {
376         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
377         u16 perm; /* Bitmask of values in "enum tomoyo_path_acl_index". */
378         struct tomoyo_name_union name;
379 };
380
381 /*
382  * Structure for "file create", "file mkdir", "file mkfifo", "file mksock",
383  * "file ioctl", "file chmod", "file chown" and "file chgrp" directive.
384  */
385 struct tomoyo_path_number_acl {
386         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
387         /* Bitmask of values in "enum tomoyo_path_number_acl_index". */
388         u8 perm;
389         struct tomoyo_name_union name;
390         struct tomoyo_number_union number;
391 };
392
393 /* Structure for "file mkblock" and "file mkchar" directive. */
394 struct tomoyo_mkdev_acl {
395         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
396         u8 perm; /* Bitmask of values in "enum tomoyo_mkdev_acl_index". */
397         struct tomoyo_name_union name;
398         struct tomoyo_number_union mode;
399         struct tomoyo_number_union major;
400         struct tomoyo_number_union minor;
401 };
402
403 /*
404  * Structure for "file rename", "file link" and "file pivot_root" directive.
405  */
406 struct tomoyo_path2_acl {
407         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
408         u8 perm; /* Bitmask of values in "enum tomoyo_path2_acl_index". */
409         struct tomoyo_name_union name1;
410         struct tomoyo_name_union name2;
411 };
412
413 /* Structure for "file mount" directive. */
414 struct tomoyo_mount_acl {
415         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
416         struct tomoyo_name_union dev_name;
417         struct tomoyo_name_union dir_name;
418         struct tomoyo_name_union fs_type;
419         struct tomoyo_number_union flags;
420 };
421
422 /* Structure for holding a line from /sys/kernel/security/tomoyo/ interface. */
423 struct tomoyo_acl_param {
424         char *data;
425         struct list_head *list;
426         bool is_delete;
427 };
428
429 #define TOMOYO_MAX_IO_READ_QUEUE 64
430
431 /*
432  * Structure for reading/writing policy via /sys/kernel/security/tomoyo
433  * interfaces.
434  */
435 struct tomoyo_io_buffer {
436         void (*read) (struct tomoyo_io_buffer *);
437         int (*write) (struct tomoyo_io_buffer *);
438         int (*poll) (struct file *file, poll_table *wait);
439         /* Exclusive lock for this structure.   */
440         struct mutex io_sem;
441         /* Index returned by tomoyo_read_lock(). */
442         int reader_idx;
443         char __user *read_user_buf;
444         int read_user_buf_avail;
445         struct {
446                 struct list_head *domain;
447                 struct list_head *group;
448                 struct list_head *acl;
449                 int avail;
450                 int step;
451                 int query_index;
452                 u16 index;
453                 u8 acl_group_index;
454                 u8 bit;
455                 u8 w_pos;
456                 bool eof;
457                 bool print_this_domain_only;
458                 bool print_execute_only;
459                 const char *w[TOMOYO_MAX_IO_READ_QUEUE];
460         } r;
461         struct {
462                 /* The position currently writing to.   */
463                 struct tomoyo_domain_info *domain;
464                 /* Bytes available for writing.         */
465                 int avail;
466         } w;
467         /* Buffer for reading.                  */
468         char *read_buf;
469         /* Size of read buffer.                 */
470         int readbuf_size;
471         /* Buffer for writing.                  */
472         char *write_buf;
473         /* Size of write buffer.                */
474         int writebuf_size;
475         /* Type of this interface.              */
476         u8 type;
477 };
478
479 /*
480  * Structure for "initialize_domain"/"no_initialize_domain"/"keep_domain"/
481  * "no_keep_domain" keyword.
482  */
483 struct tomoyo_transition_control {
484         struct tomoyo_acl_head head;
485         u8 type; /* One of values in "enum tomoyo_transition_type".  */
486         /* True if the domainname is tomoyo_get_last_name(). */
487         bool is_last_name;
488         const struct tomoyo_path_info *domainname; /* Maybe NULL */
489         const struct tomoyo_path_info *program;    /* Maybe NULL */
490 };
491
492 /* Structure for "aggregator" keyword. */
493 struct tomoyo_aggregator {
494         struct tomoyo_acl_head head;
495         const struct tomoyo_path_info *original_name;
496         const struct tomoyo_path_info *aggregated_name;
497 };
498
499 /* Structure for policy manager. */
500 struct tomoyo_manager {
501         struct tomoyo_acl_head head;
502         bool is_domain;  /* True if manager is a domainname. */
503         /* A path to program or a domainname. */
504         const struct tomoyo_path_info *manager;
505 };
506
507 struct tomoyo_preference {
508         unsigned int learning_max_entry;
509         bool enforcing_verbose;
510         bool learning_verbose;
511         bool permissive_verbose;
512 };
513
514 /* Structure for /sys/kernel/security/tomnoyo/profile interface. */
515 struct tomoyo_profile {
516         const struct tomoyo_path_info *comment;
517         struct tomoyo_preference *learning;
518         struct tomoyo_preference *permissive;
519         struct tomoyo_preference *enforcing;
520         struct tomoyo_preference preference;
521         u8 default_config;
522         u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
523         unsigned int pref[TOMOYO_MAX_PREF];
524 };
525
526 /* Structure for representing YYYY/MM/DD hh/mm/ss. */
527 struct tomoyo_time {
528         u16 year;
529         u8 month;
530         u8 day;
531         u8 hour;
532         u8 min;
533         u8 sec;
534 };
535
536 /********** Function prototypes. **********/
537
538 bool tomoyo_str_starts(char **src, const char *find);
539 const char *tomoyo_get_exe(void);
540 void tomoyo_normalize_line(unsigned char *buffer);
541 void tomoyo_check_profile(void);
542 int tomoyo_open_control(const u8 type, struct file *file);
543 int tomoyo_close_control(struct tomoyo_io_buffer *head);
544 int tomoyo_poll_control(struct file *file, poll_table *wait);
545 int tomoyo_read_control(struct tomoyo_io_buffer *head, char __user *buffer,
546                         const int buffer_len);
547 int tomoyo_write_control(struct tomoyo_io_buffer *head,
548                          const char __user *buffer, const int buffer_len);
549 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
550 void tomoyo_warn_oom(const char *function);
551 const struct tomoyo_path_info *
552 tomoyo_compare_name_union(const struct tomoyo_path_info *name,
553                           const struct tomoyo_name_union *ptr);
554 bool tomoyo_compare_number_union(const unsigned long value,
555                                  const struct tomoyo_number_union *ptr);
556 int tomoyo_get_mode(const u8 profile, const u8 index);
557 void tomoyo_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
558         __attribute__ ((format(printf, 2, 3)));
559 bool tomoyo_correct_domain(const unsigned char *domainname);
560 bool tomoyo_correct_path(const char *filename);
561 bool tomoyo_correct_word(const char *string);
562 bool tomoyo_domain_def(const unsigned char *buffer);
563 bool tomoyo_parse_name_union(struct tomoyo_acl_param *param,
564                              struct tomoyo_name_union *ptr);
565 const struct tomoyo_path_info *
566 tomoyo_path_matches_group(const struct tomoyo_path_info *pathname,
567                           const struct tomoyo_group *group);
568 bool tomoyo_number_matches_group(const unsigned long min,
569                                  const unsigned long max,
570                                  const struct tomoyo_group *group);
571 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
572                                  const struct tomoyo_path_info *pattern);
573 bool tomoyo_parse_number_union(struct tomoyo_acl_param *param,
574                                struct tomoyo_number_union *ptr);
575 bool tomoyo_tokenize(char *buffer, char *w[], size_t size);
576 bool tomoyo_verbose_mode(const struct tomoyo_domain_info *domain);
577 int tomoyo_init_request_info(struct tomoyo_request_info *r,
578                              struct tomoyo_domain_info *domain,
579                              const u8 index);
580 int tomoyo_mount_permission(char *dev_name, struct path *path,
581                             const char *type, unsigned long flags,
582                             void *data_page);
583 int tomoyo_write_aggregator(struct tomoyo_acl_param *param);
584 int tomoyo_write_transition_control(struct tomoyo_acl_param *param,
585                                     const u8 type);
586 int tomoyo_write_file(struct tomoyo_acl_param *param);
587 int tomoyo_write_group(struct tomoyo_acl_param *param, const u8 type);
588 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
589      __attribute__ ((format(printf, 2, 3)));
590 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
591 struct tomoyo_domain_info *tomoyo_assign_domain(const char *domainname,
592                                                 const u8 profile);
593 struct tomoyo_profile *tomoyo_profile(const u8 profile);
594 struct tomoyo_group *tomoyo_get_group(struct tomoyo_acl_param *param,
595                                       const u8 idx);
596 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
597                                 const u8 index);
598 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
599 void tomoyo_load_policy(const char *filename);
600 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
601 char *tomoyo_encode(const char *str);
602 char *tomoyo_realpath_nofollow(const char *pathname);
603 char *tomoyo_realpath_from_path(struct path *path);
604 bool tomoyo_memory_ok(void *ptr);
605 void *tomoyo_commit_ok(void *data, const unsigned int size);
606 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
607 void tomoyo_read_memory_counter(struct tomoyo_io_buffer *head);
608 int tomoyo_write_memory_quota(struct tomoyo_io_buffer *head);
609 void __init tomoyo_mm_init(void);
610 int tomoyo_path_permission(struct tomoyo_request_info *r, u8 operation,
611                            const struct tomoyo_path_info *filename);
612 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
613                                  struct path *path, const int flag);
614 int tomoyo_path_number_perm(const u8 operation, struct path *path,
615                             unsigned long number);
616 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
617                       const unsigned int mode, unsigned int dev);
618 int tomoyo_path_perm(const u8 operation, struct path *path);
619 int tomoyo_path2_perm(const u8 operation, struct path *path1,
620                       struct path *path2);
621 int tomoyo_find_next_domain(struct linux_binprm *bprm);
622 void tomoyo_print_ulong(char *buffer, const int buffer_len,
623                         const unsigned long value, const u8 type);
624 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
625 void tomoyo_run_gc(void);
626 void tomoyo_memory_free(void *ptr);
627 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
628                          struct tomoyo_acl_param *param,
629                          bool (*check_duplicate) (const struct tomoyo_acl_info
630                                                   *,
631                                                   const struct tomoyo_acl_info
632                                                   *),
633                          bool (*merge_duplicate) (struct tomoyo_acl_info *,
634                                                   struct tomoyo_acl_info *,
635                                                   const bool));
636 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
637                          struct tomoyo_acl_param *param,
638                          bool (*check_duplicate) (const struct tomoyo_acl_head
639                                                   *,
640                                                   const struct tomoyo_acl_head
641                                                   *));
642 void tomoyo_check_acl(struct tomoyo_request_info *r,
643                       bool (*check_entry) (struct tomoyo_request_info *,
644                                            const struct tomoyo_acl_info *));
645 char *tomoyo_read_token(struct tomoyo_acl_param *param);
646 bool tomoyo_permstr(const char *string, const char *keyword);
647
648 const char *tomoyo_yesno(const unsigned int value);
649 void tomoyo_write_log2(struct tomoyo_request_info *r, int len, const char *fmt,
650                        va_list args);
651 void tomoyo_read_log(struct tomoyo_io_buffer *head);
652 int tomoyo_poll_log(struct file *file, poll_table *wait);
653 char *tomoyo_init_log(struct tomoyo_request_info *r, int len, const char *fmt,
654                       va_list args);
655
656 /********** External variable definitions. **********/
657
658 /* Lock for GC. */
659 extern struct srcu_struct tomoyo_ss;
660
661 /* The list for "struct tomoyo_domain_info". */
662 extern struct list_head tomoyo_domain_list;
663
664 extern struct list_head tomoyo_policy_list[TOMOYO_MAX_POLICY];
665 extern struct list_head tomoyo_group_list[TOMOYO_MAX_GROUP];
666 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
667
668 /* Lock for protecting policy. */
669 extern struct mutex tomoyo_policy_lock;
670
671 /* Has /sbin/init started? */
672 extern bool tomoyo_policy_loaded;
673
674 extern struct list_head tomoyo_acl_group[TOMOYO_MAX_ACL_GROUPS];
675
676 /* The kernel's domain. */
677 extern struct tomoyo_domain_info tomoyo_kernel_domain;
678
679 extern const char *tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
680 extern const char *tomoyo_mkdev_keyword[TOMOYO_MAX_MKDEV_OPERATION];
681 extern const char *tomoyo_path2_keyword[TOMOYO_MAX_PATH2_OPERATION];
682 extern const char *tomoyo_path_number_keyword[TOMOYO_MAX_PATH_NUMBER_OPERATION];
683
684 extern const u8 tomoyo_pnnn2mac[TOMOYO_MAX_MKDEV_OPERATION];
685 extern const u8 tomoyo_pp2mac[TOMOYO_MAX_PATH2_OPERATION];
686 extern const u8 tomoyo_pn2mac[TOMOYO_MAX_PATH_NUMBER_OPERATION];
687
688 extern const char * const tomoyo_mode[TOMOYO_CONFIG_MAX_MODE];
689 extern unsigned int tomoyo_memory_quota[TOMOYO_MAX_MEMORY_STAT];
690 extern unsigned int tomoyo_memory_used[TOMOYO_MAX_MEMORY_STAT];
691
692 /********** Inlined functions. **********/
693
694 /**
695  * tomoyo_read_lock - Take lock for protecting policy.
696  *
697  * Returns index number for tomoyo_read_unlock().
698  */
699 static inline int tomoyo_read_lock(void)
700 {
701         return srcu_read_lock(&tomoyo_ss);
702 }
703
704 /**
705  * tomoyo_read_unlock - Release lock for protecting policy.
706  *
707  * @idx: Index number returned by tomoyo_read_lock().
708  *
709  * Returns nothing.
710  */
711 static inline void tomoyo_read_unlock(int idx)
712 {
713         srcu_read_unlock(&tomoyo_ss, idx);
714 }
715
716 /**
717  * tomoyo_pathcmp - strcmp() for "struct tomoyo_path_info" structure.
718  *
719  * @a: Pointer to "struct tomoyo_path_info".
720  * @b: Pointer to "struct tomoyo_path_info".
721  *
722  * Returns true if @a == @b, false otherwise.
723  */
724 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
725                                   const struct tomoyo_path_info *b)
726 {
727         return a->hash != b->hash || strcmp(a->name, b->name);
728 }
729
730 /**
731  * tomoyo_put_name - Drop reference on "struct tomoyo_name".
732  *
733  * @name: Pointer to "struct tomoyo_path_info". Maybe NULL.
734  *
735  * Returns nothing.
736  */
737 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
738 {
739         if (name) {
740                 struct tomoyo_name *ptr =
741                         container_of(name, typeof(*ptr), entry);
742                 atomic_dec(&ptr->head.users);
743         }
744 }
745
746 /**
747  * tomoyo_put_group - Drop reference on "struct tomoyo_group".
748  *
749  * @group: Pointer to "struct tomoyo_group". Maybe NULL.
750  *
751  * Returns nothing.
752  */
753 static inline void tomoyo_put_group(struct tomoyo_group *group)
754 {
755         if (group)
756                 atomic_dec(&group->head.users);
757 }
758
759 /**
760  * tomoyo_domain - Get "struct tomoyo_domain_info" for current thread.
761  *
762  * Returns pointer to "struct tomoyo_domain_info" for current thread.
763  */
764 static inline struct tomoyo_domain_info *tomoyo_domain(void)
765 {
766         return current_cred()->security;
767 }
768
769 /**
770  * tomoyo_real_domain - Get "struct tomoyo_domain_info" for specified thread.
771  *
772  * @task: Pointer to "struct task_struct".
773  *
774  * Returns pointer to "struct tomoyo_security" for specified thread.
775  */
776 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
777                                                             *task)
778 {
779         return task_cred_xxx(task, security);
780 }
781
782 /**
783  * tomoyo_same_name_union - Check for duplicated "struct tomoyo_name_union" entry.
784  *
785  * @a: Pointer to "struct tomoyo_name_union".
786  * @b: Pointer to "struct tomoyo_name_union".
787  *
788  * Returns true if @a == @b, false otherwise.
789  */
790 static inline bool tomoyo_same_name_union
791 (const struct tomoyo_name_union *a, const struct tomoyo_name_union *b)
792 {
793         return a->filename == b->filename && a->group == b->group;
794 }
795
796 /**
797  * tomoyo_same_number_union - Check for duplicated "struct tomoyo_number_union" entry.
798  *
799  * @a: Pointer to "struct tomoyo_number_union".
800  * @b: Pointer to "struct tomoyo_number_union".
801  *
802  * Returns true if @a == @b, false otherwise.
803  */
804 static inline bool tomoyo_same_number_union
805 (const struct tomoyo_number_union *a, const struct tomoyo_number_union *b)
806 {
807         return a->values[0] == b->values[0] && a->values[1] == b->values[1] &&
808                 a->group == b->group && a->value_type[0] == b->value_type[0] &&
809                 a->value_type[1] == b->value_type[1];
810 }
811
812 #if defined(CONFIG_SLOB)
813
814 /**
815  * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
816  *
817  * @size: Size to be rounded up.
818  *
819  * Returns @size.
820  *
821  * Since SLOB does not round up, this function simply returns @size.
822  */
823 static inline int tomoyo_round2(size_t size)
824 {
825         return size;
826 }
827
828 #else
829
830 /**
831  * tomoyo_round2 - Round up to power of 2 for calculating memory usage.
832  *
833  * @size: Size to be rounded up.
834  *
835  * Returns rounded size.
836  *
837  * Strictly speaking, SLAB may be able to allocate (e.g.) 96 bytes instead of
838  * (e.g.) 128 bytes.
839  */
840 static inline int tomoyo_round2(size_t size)
841 {
842 #if PAGE_SIZE == 4096
843         size_t bsize = 32;
844 #else
845         size_t bsize = 64;
846 #endif
847         if (!size)
848                 return 0;
849         while (size > bsize)
850                 bsize <<= 1;
851         return bsize;
852 }
853
854 #endif
855
856 /**
857  * list_for_each_cookie - iterate over a list with cookie.
858  * @pos:        the &struct list_head to use as a loop cursor.
859  * @head:       the head for your list.
860  */
861 #define list_for_each_cookie(pos, head)                                 \
862         if (!pos)                                                       \
863                 pos =  srcu_dereference((head)->next, &tomoyo_ss);      \
864         for ( ; pos != (head); pos = srcu_dereference(pos->next, &tomoyo_ss))
865
866 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */