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