TOMOYO: Make read function to void.
[linux-2.6.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 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
47 };
48
49 /* Keywords for ACLs. */
50 #define TOMOYO_KEYWORD_AGGREGATOR                "aggregator "
51 #define TOMOYO_KEYWORD_ALIAS                     "alias "
52 #define TOMOYO_KEYWORD_ALLOW_MOUNT               "allow_mount "
53 #define TOMOYO_KEYWORD_ALLOW_READ                "allow_read "
54 #define TOMOYO_KEYWORD_DELETE                    "delete "
55 #define TOMOYO_KEYWORD_DENY_REWRITE              "deny_rewrite "
56 #define TOMOYO_KEYWORD_FILE_PATTERN              "file_pattern "
57 #define TOMOYO_KEYWORD_INITIALIZE_DOMAIN         "initialize_domain "
58 #define TOMOYO_KEYWORD_KEEP_DOMAIN               "keep_domain "
59 #define TOMOYO_KEYWORD_NO_INITIALIZE_DOMAIN      "no_initialize_domain "
60 #define TOMOYO_KEYWORD_NO_KEEP_DOMAIN            "no_keep_domain "
61 #define TOMOYO_KEYWORD_PATH_GROUP                "path_group "
62 #define TOMOYO_KEYWORD_NUMBER_GROUP              "number_group "
63 #define TOMOYO_KEYWORD_SELECT                    "select "
64 #define TOMOYO_KEYWORD_USE_PROFILE               "use_profile "
65 #define TOMOYO_KEYWORD_IGNORE_GLOBAL_ALLOW_READ  "ignore_global_allow_read"
66 #define TOMOYO_KEYWORD_QUOTA_EXCEEDED            "quota_exceeded"
67 #define TOMOYO_KEYWORD_TRANSITION_FAILED         "transition_failed"
68 /* A domain definition starts with <kernel>. */
69 #define TOMOYO_ROOT_NAME                         "<kernel>"
70 #define TOMOYO_ROOT_NAME_LEN                     (sizeof(TOMOYO_ROOT_NAME) - 1)
71
72 /* Value type definition. */
73 #define TOMOYO_VALUE_TYPE_INVALID     0
74 #define TOMOYO_VALUE_TYPE_DECIMAL     1
75 #define TOMOYO_VALUE_TYPE_OCTAL       2
76 #define TOMOYO_VALUE_TYPE_HEXADECIMAL 3
77
78 /* Index numbers for Access Controls. */
79 enum tomoyo_acl_entry_type_index {
80         TOMOYO_TYPE_PATH_ACL,
81         TOMOYO_TYPE_PATH2_ACL,
82         TOMOYO_TYPE_PATH_NUMBER_ACL,
83         TOMOYO_TYPE_MKDEV_ACL,
84         TOMOYO_TYPE_MOUNT_ACL,
85 };
86
87 /* Index numbers for File Controls. */
88
89 /*
90  * TOMOYO_TYPE_READ_WRITE is special. TOMOYO_TYPE_READ_WRITE is automatically
91  * set if both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are set.
92  * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically set if
93  * TOMOYO_TYPE_READ_WRITE is set.
94  * TOMOYO_TYPE_READ_WRITE is automatically cleared if either TOMOYO_TYPE_READ
95  * or TOMOYO_TYPE_WRITE is cleared.
96  * Both TOMOYO_TYPE_READ and TOMOYO_TYPE_WRITE are automatically cleared if
97  * TOMOYO_TYPE_READ_WRITE is cleared.
98  */
99
100 enum tomoyo_path_acl_index {
101         TOMOYO_TYPE_READ_WRITE,
102         TOMOYO_TYPE_EXECUTE,
103         TOMOYO_TYPE_READ,
104         TOMOYO_TYPE_WRITE,
105         TOMOYO_TYPE_UNLINK,
106         TOMOYO_TYPE_RMDIR,
107         TOMOYO_TYPE_TRUNCATE,
108         TOMOYO_TYPE_SYMLINK,
109         TOMOYO_TYPE_REWRITE,
110         TOMOYO_TYPE_CHROOT,
111         TOMOYO_TYPE_UMOUNT,
112         TOMOYO_MAX_PATH_OPERATION
113 };
114
115 #define TOMOYO_RW_MASK ((1 << TOMOYO_TYPE_READ) | (1 << TOMOYO_TYPE_WRITE))
116
117 enum tomoyo_mkdev_acl_index {
118         TOMOYO_TYPE_MKBLOCK,
119         TOMOYO_TYPE_MKCHAR,
120         TOMOYO_MAX_MKDEV_OPERATION
121 };
122
123 enum tomoyo_path2_acl_index {
124         TOMOYO_TYPE_LINK,
125         TOMOYO_TYPE_RENAME,
126         TOMOYO_TYPE_PIVOT_ROOT,
127         TOMOYO_MAX_PATH2_OPERATION
128 };
129
130 enum tomoyo_path_number_acl_index {
131         TOMOYO_TYPE_CREATE,
132         TOMOYO_TYPE_MKDIR,
133         TOMOYO_TYPE_MKFIFO,
134         TOMOYO_TYPE_MKSOCK,
135         TOMOYO_TYPE_IOCTL,
136         TOMOYO_TYPE_CHMOD,
137         TOMOYO_TYPE_CHOWN,
138         TOMOYO_TYPE_CHGRP,
139         TOMOYO_MAX_PATH_NUMBER_OPERATION
140 };
141
142 enum tomoyo_securityfs_interface_index {
143         TOMOYO_DOMAINPOLICY,
144         TOMOYO_EXCEPTIONPOLICY,
145         TOMOYO_DOMAIN_STATUS,
146         TOMOYO_PROCESS_STATUS,
147         TOMOYO_MEMINFO,
148         TOMOYO_SELFDOMAIN,
149         TOMOYO_VERSION,
150         TOMOYO_PROFILE,
151         TOMOYO_QUERY,
152         TOMOYO_MANAGER
153 };
154
155 enum tomoyo_mac_index {
156         TOMOYO_MAC_FILE_EXECUTE,
157         TOMOYO_MAC_FILE_OPEN,
158         TOMOYO_MAC_FILE_CREATE,
159         TOMOYO_MAC_FILE_UNLINK,
160         TOMOYO_MAC_FILE_MKDIR,
161         TOMOYO_MAC_FILE_RMDIR,
162         TOMOYO_MAC_FILE_MKFIFO,
163         TOMOYO_MAC_FILE_MKSOCK,
164         TOMOYO_MAC_FILE_TRUNCATE,
165         TOMOYO_MAC_FILE_SYMLINK,
166         TOMOYO_MAC_FILE_REWRITE,
167         TOMOYO_MAC_FILE_MKBLOCK,
168         TOMOYO_MAC_FILE_MKCHAR,
169         TOMOYO_MAC_FILE_LINK,
170         TOMOYO_MAC_FILE_RENAME,
171         TOMOYO_MAC_FILE_CHMOD,
172         TOMOYO_MAC_FILE_CHOWN,
173         TOMOYO_MAC_FILE_CHGRP,
174         TOMOYO_MAC_FILE_IOCTL,
175         TOMOYO_MAC_FILE_CHROOT,
176         TOMOYO_MAC_FILE_MOUNT,
177         TOMOYO_MAC_FILE_UMOUNT,
178         TOMOYO_MAC_FILE_PIVOT_ROOT,
179         TOMOYO_MAX_MAC_INDEX
180 };
181
182 enum tomoyo_mac_category_index {
183         TOMOYO_MAC_CATEGORY_FILE,
184         TOMOYO_MAX_MAC_CATEGORY_INDEX
185 };
186
187 #define TOMOYO_RETRY_REQUEST 1 /* Retry this request. */
188
189 /********** Structure definitions. **********/
190
191 /*
192  * tomoyo_acl_head is a structure which is used for holding elements not in
193  * domain policy.
194  * It has following fields.
195  *
196  *  (1) "list" which is linked to tomoyo_policy_list[] .
197  *  (2) "is_deleted" is a bool which is true if marked as deleted, false
198  *      otherwise.
199  */
200 struct tomoyo_acl_head {
201         struct list_head list;
202         bool is_deleted;
203 } __packed;
204
205 /*
206  * tomoyo_request_info is a structure which is used for holding
207  *
208  * (1) Domain information of current process.
209  * (2) How many retries are made for this request.
210  * (3) Profile number used for this request.
211  * (4) Access control mode of the profile.
212  */
213 struct tomoyo_request_info {
214         struct tomoyo_domain_info *domain;
215         /* For holding parameters. */
216         union {
217                 struct {
218                         const struct tomoyo_path_info *filename;
219                         u8 operation;
220                 } path;
221                 struct {
222                         const struct tomoyo_path_info *filename1;
223                         const struct tomoyo_path_info *filename2;
224                         u8 operation;
225                 } path2;
226                 struct {
227                         const struct tomoyo_path_info *filename;
228                         unsigned int mode;
229                         unsigned int major;
230                         unsigned int minor;
231                         u8 operation;
232                 } mkdev;
233                 struct {
234                         const struct tomoyo_path_info *filename;
235                         unsigned long number;
236                         u8 operation;
237                 } path_number;
238                 struct {
239                         const struct tomoyo_path_info *type;
240                         const struct tomoyo_path_info *dir;
241                         const struct tomoyo_path_info *dev;
242                         unsigned long flags;
243                         int need_dev;
244                 } mount;
245         } param;
246         u8 param_type;
247         bool granted;
248         u8 retry;
249         u8 profile;
250         u8 mode; /* One of tomoyo_mode_index . */
251         u8 type;
252 };
253
254 /*
255  * tomoyo_path_info is a structure which is used for holding a string data
256  * used by TOMOYO.
257  * This structure has several fields for supporting pattern matching.
258  *
259  * (1) "name" is the '\0' terminated string data.
260  * (2) "hash" is full_name_hash(name, strlen(name)).
261  *     This allows tomoyo_pathcmp() to compare by hash before actually compare
262  *     using strcmp().
263  * (3) "const_len" is the length of the initial segment of "name" which
264  *     consists entirely of non wildcard characters. In other words, the length
265  *     which we can compare two strings using strncmp().
266  * (4) "is_dir" is a bool which is true if "name" ends with "/",
267  *     false otherwise.
268  *     TOMOYO distinguishes directory and non-directory. A directory ends with
269  *     "/" and non-directory does not end with "/".
270  * (5) "is_patterned" is a bool which is true if "name" contains wildcard
271  *     characters, false otherwise. This allows TOMOYO to use "hash" and
272  *     strcmp() for string comparison if "is_patterned" is false.
273  */
274 struct tomoyo_path_info {
275         const char *name;
276         u32 hash;          /* = full_name_hash(name, strlen(name)) */
277         u16 const_len;     /* = tomoyo_const_part_length(name)     */
278         bool is_dir;       /* = tomoyo_strendswith(name, "/")      */
279         bool is_patterned; /* = tomoyo_path_contains_pattern(name) */
280 };
281
282 /*
283  * tomoyo_name_entry is a structure which is used for linking
284  * "struct tomoyo_path_info" into tomoyo_name_list .
285  */
286 struct tomoyo_name_entry {
287         struct list_head list;
288         atomic_t users;
289         struct tomoyo_path_info entry;
290 };
291
292 struct tomoyo_name_union {
293         const struct tomoyo_path_info *filename;
294         struct tomoyo_path_group *group;
295         u8 is_group;
296 };
297
298 struct tomoyo_number_union {
299         unsigned long values[2];
300         struct tomoyo_number_group *group;
301         u8 min_type;
302         u8 max_type;
303         u8 is_group;
304 };
305
306 /* Structure for "path_group" directive. */
307 struct tomoyo_path_group {
308         struct list_head list;
309         const struct tomoyo_path_info *group_name;
310         struct list_head member_list;
311         atomic_t users;
312 };
313
314 /* Structure for "number_group" directive. */
315 struct tomoyo_number_group {
316         struct list_head list;
317         const struct tomoyo_path_info *group_name;
318         struct list_head member_list;
319         atomic_t users;
320 };
321
322 /* Structure for "path_group" directive. */
323 struct tomoyo_path_group_member {
324         struct tomoyo_acl_head head;
325         const struct tomoyo_path_info *member_name;
326 };
327
328 /* Structure for "number_group" directive. */
329 struct tomoyo_number_group_member {
330         struct tomoyo_acl_head head;
331         struct tomoyo_number_union number;
332 };
333
334 /*
335  * tomoyo_acl_info is a structure which is used for holding
336  *
337  *  (1) "list" which is linked to the ->acl_info_list of
338  *      "struct tomoyo_domain_info"
339  *  (2) "is_deleted" is a bool which is true if this domain is marked as
340  *      "deleted", false otherwise.
341  *  (3) "type" which tells type of the entry.
342  *
343  * Packing "struct tomoyo_acl_info" allows
344  * "struct tomoyo_path_acl" to embed "u16" and "struct tomoyo_path2_acl"
345  * "struct tomoyo_path_number_acl" "struct tomoyo_mkdev_acl" to embed
346  * "u8" without enlarging their structure size.
347  */
348 struct tomoyo_acl_info {
349         struct list_head list;
350         bool is_deleted;
351         u8 type; /* = one of values in "enum tomoyo_acl_entry_type_index". */
352 } __packed;
353
354 /*
355  * tomoyo_domain_info is a structure which is used for holding permissions
356  * (e.g. "allow_read /lib/libc-2.5.so") given to each domain.
357  * It has following fields.
358  *
359  *  (1) "list" which is linked to tomoyo_domain_list .
360  *  (2) "acl_info_list" which is linked to "struct tomoyo_acl_info".
361  *  (3) "domainname" which holds the name of the domain.
362  *  (4) "profile" which remembers profile number assigned to this domain.
363  *  (5) "is_deleted" is a bool which is true if this domain is marked as
364  *      "deleted", false otherwise.
365  *  (6) "quota_warned" is a bool which is used for suppressing warning message
366  *      when learning mode learned too much entries.
367  *  (7) "ignore_global_allow_read" is a bool which is true if this domain
368  *      should ignore "allow_read" directive in exception policy.
369  *  (8) "transition_failed" is a bool which is set to true when this domain was
370  *      unable to create a new domain at tomoyo_find_next_domain() because the
371  *      name of the domain to be created was too long or it could not allocate
372  *      memory. If set to true, more than one process continued execve()
373  *      without domain transition.
374  *  (9) "users" is an atomic_t that holds how many "struct cred"->security
375  *      are referring this "struct tomoyo_domain_info". If is_deleted == true
376  *      and users == 0, this struct will be kfree()d upon next garbage
377  *      collection.
378  *
379  * A domain's lifecycle is an analogy of files on / directory.
380  * Multiple domains with the same domainname cannot be created (as with
381  * creating files with the same filename fails with -EEXIST).
382  * If a process reached a domain, that process can reside in that domain after
383  * that domain is marked as "deleted" (as with a process can access an already
384  * open()ed file after that file was unlink()ed).
385  */
386 struct tomoyo_domain_info {
387         struct list_head list;
388         struct list_head acl_info_list;
389         /* Name of this domain. Never NULL.          */
390         const struct tomoyo_path_info *domainname;
391         u8 profile;        /* Profile number to use. */
392         bool is_deleted;   /* Delete flag.           */
393         bool quota_warned; /* Quota warnning flag.   */
394         bool ignore_global_allow_read; /* Ignore "allow_read" flag. */
395         bool transition_failed; /* Domain transition failed flag. */
396         atomic_t users; /* Number of referring credentials. */
397 };
398
399 /*
400  * tomoyo_path_acl is a structure which is used for holding an
401  * entry with one pathname operation (e.g. open(), mkdir()).
402  * It has following fields.
403  *
404  *  (1) "head" which is a "struct tomoyo_acl_info".
405  *  (2) "perm" which is a bitmask of permitted operations.
406  *  (3) "name" is the pathname.
407  *
408  * Directives held by this structure are "allow_read/write", "allow_execute",
409  * "allow_read", "allow_write", "allow_unlink", "allow_rmdir",
410  * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_chroot" and
411  * "allow_unmount".
412  */
413 struct tomoyo_path_acl {
414         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_ACL */
415         u16 perm;
416         struct tomoyo_name_union name;
417 };
418
419 /*
420  * tomoyo_path_number_acl is a structure which is used for holding an
421  * entry with one pathname and one number operation.
422  * It has following fields.
423  *
424  *  (1) "head" which is a "struct tomoyo_acl_info".
425  *  (2) "perm" which is a bitmask of permitted operations.
426  *  (3) "name" is the pathname.
427  *  (4) "number" is the numeric value.
428  *
429  * Directives held by this structure are "allow_create", "allow_mkdir",
430  * "allow_ioctl", "allow_mkfifo", "allow_mksock", "allow_chmod", "allow_chown"
431  * and "allow_chgrp".
432  *
433  */
434 struct tomoyo_path_number_acl {
435         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH_NUMBER_ACL */
436         u8 perm;
437         struct tomoyo_name_union name;
438         struct tomoyo_number_union number;
439 };
440
441 /*
442  * tomoyo_mkdev_acl is a structure which is used for holding an
443  * entry with one pathname and three numbers operation.
444  * It has following fields.
445  *
446  *  (1) "head" which is a "struct tomoyo_acl_info".
447  *  (2) "perm" which is a bitmask of permitted operations.
448  *  (3) "mode" is the create mode.
449  *  (4) "major" is the major number of device node.
450  *  (5) "minor" is the minor number of device node.
451  *
452  * Directives held by this structure are "allow_mkchar", "allow_mkblock".
453  *
454  */
455 struct tomoyo_mkdev_acl {
456         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MKDEV_ACL */
457         u8 perm;
458         struct tomoyo_name_union name;
459         struct tomoyo_number_union mode;
460         struct tomoyo_number_union major;
461         struct tomoyo_number_union minor;
462 };
463
464 /*
465  * tomoyo_path2_acl is a structure which is used for holding an
466  * entry with two pathnames operation (i.e. link(), rename() and pivot_root()).
467  * It has following fields.
468  *
469  *  (1) "head" which is a "struct tomoyo_acl_info".
470  *  (2) "perm" which is a bitmask of permitted operations.
471  *  (3) "name1" is the source/old pathname.
472  *  (4) "name2" is the destination/new pathname.
473  *
474  * Directives held by this structure are "allow_rename", "allow_link" and
475  * "allow_pivot_root".
476  */
477 struct tomoyo_path2_acl {
478         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_PATH2_ACL */
479         u8 perm;
480         struct tomoyo_name_union name1;
481         struct tomoyo_name_union name2;
482 };
483
484 /*
485  * tomoyo_mount_acl is a structure which is used for holding an
486  * entry for mount operation.
487  * It has following fields.
488  *
489  *  (1) "head" which is a "struct tomoyo_acl_info".
490  *  (2) "dev_name" is the device name.
491  *  (3) "dir_name" is the mount point.
492  *  (4) "fs_type" is the filesystem type.
493  *  (5) "flags" is the mount flags.
494  *
495  * Directive held by this structure is "allow_mount".
496  */
497 struct tomoyo_mount_acl {
498         struct tomoyo_acl_info head; /* type = TOMOYO_TYPE_MOUNT_ACL */
499         struct tomoyo_name_union dev_name;
500         struct tomoyo_name_union dir_name;
501         struct tomoyo_name_union fs_type;
502         struct tomoyo_number_union flags;
503 };
504
505 /*
506  * tomoyo_io_buffer is a structure which is used for reading and modifying
507  * configuration via /sys/kernel/security/tomoyo/ interface.
508  * It has many fields. ->read_var1 , ->read_var2 , ->write_var1 are used as
509  * cursors.
510  *
511  * Since the content of /sys/kernel/security/tomoyo/domain_policy is a list of
512  * "struct tomoyo_domain_info" entries and each "struct tomoyo_domain_info"
513  * entry has a list of "struct tomoyo_acl_info", we need two cursors when
514  * reading (one is for traversing tomoyo_domain_list and the other is for
515  * traversing "struct tomoyo_acl_info"->acl_info_list ).
516  *
517  * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
518  * "select ", TOMOYO seeks the cursor ->read_var1 and ->write_var1 to the
519  * domain with the domainname specified by the rest of that line (NULL is set
520  * if seek failed).
521  * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
522  * "delete ", TOMOYO deletes an entry or a domain specified by the rest of that
523  * line (->write_var1 is set to NULL if a domain was deleted).
524  * If a line written to /sys/kernel/security/tomoyo/domain_policy starts with
525  * neither "select " nor "delete ", an entry or a domain specified by that line
526  * is appended.
527  */
528 struct tomoyo_io_buffer {
529         void (*read) (struct tomoyo_io_buffer *);
530         int (*write) (struct tomoyo_io_buffer *);
531         int (*poll) (struct file *file, poll_table *wait);
532         /* Exclusive lock for this structure.   */
533         struct mutex io_sem;
534         /* Index returned by tomoyo_read_lock(). */
535         int reader_idx;
536         /* The position currently reading from. */
537         struct list_head *read_var1;
538         /* Extra variables for reading.         */
539         struct list_head *read_var2;
540         /* The position currently writing to.   */
541         struct tomoyo_domain_info *write_var1;
542         /* The step for reading.                */
543         int read_step;
544         /* Buffer for reading.                  */
545         char *read_buf;
546         /* EOF flag for reading.                */
547         bool read_eof;
548         /* Read domain ACL of specified PID?    */
549         bool read_single_domain;
550         /* Extra variable for reading.          */
551         u8 read_bit;
552         /* Bytes available for reading.         */
553         int read_avail;
554         /* Size of read buffer.                 */
555         int readbuf_size;
556         /* Buffer for writing.                  */
557         char *write_buf;
558         /* Bytes available for writing.         */
559         int write_avail;
560         /* Size of write buffer.                */
561         int writebuf_size;
562         /* Type of this interface.              */
563         u8 type;
564 };
565
566 /*
567  * tomoyo_globally_readable_file_entry is a structure which is used for holding
568  * "allow_read" entries.
569  * It has following fields.
570  *
571  *  (1) "head" is "struct tomoyo_acl_head".
572  *  (2) "filename" is a pathname which is allowed to open(O_RDONLY).
573  */
574 struct tomoyo_globally_readable_file_entry {
575         struct tomoyo_acl_head head;
576         const struct tomoyo_path_info *filename;
577 };
578
579 /*
580  * tomoyo_pattern_entry is a structure which is used for holding
581  * "tomoyo_pattern_list" entries.
582  * It has following fields.
583  *
584  *  (1) "head" is "struct tomoyo_acl_head".
585  *  (2) "pattern" is a pathname pattern which is used for converting pathnames
586  *      to pathname patterns during learning mode.
587  */
588 struct tomoyo_pattern_entry {
589         struct tomoyo_acl_head head;
590         const struct tomoyo_path_info *pattern;
591 };
592
593 /*
594  * tomoyo_no_rewrite_entry is a structure which is used for holding
595  * "deny_rewrite" entries.
596  * It has following fields.
597  *
598  *  (1) "head" is "struct tomoyo_acl_head".
599  *  (2) "pattern" is a pathname which is by default not permitted to modify
600  *      already existing content.
601  */
602 struct tomoyo_no_rewrite_entry {
603         struct tomoyo_acl_head head;
604         const struct tomoyo_path_info *pattern;
605 };
606
607 /*
608  * tomoyo_domain_initializer_entry is a structure which is used for holding
609  * "initialize_domain" and "no_initialize_domain" entries.
610  * It has following fields.
611  *
612  *  (1) "head" is "struct tomoyo_acl_head".
613  *  (2) "is_not" is a bool which is true if "no_initialize_domain", false
614  *      otherwise.
615  *  (3) "is_last_name" is a bool which is true if "domainname" is "the last
616  *      component of a domainname", false otherwise.
617  *  (4) "domainname" which is "a domainname" or "the last component of a
618  *      domainname". This field is NULL if "from" clause is not specified.
619  *  (5) "program" which is a program's pathname.
620  */
621 struct tomoyo_domain_initializer_entry {
622         struct tomoyo_acl_head head;
623         bool is_not;       /* True if this entry is "no_initialize_domain".  */
624         /* True if the domainname is tomoyo_get_last_name(). */
625         bool is_last_name;
626         const struct tomoyo_path_info *domainname;    /* This may be NULL */
627         const struct tomoyo_path_info *program;
628 };
629
630 /*
631  * tomoyo_domain_keeper_entry is a structure which is used for holding
632  * "keep_domain" and "no_keep_domain" entries.
633  * It has following fields.
634  *
635  *  (1) "head" is "struct tomoyo_acl_head".
636  *  (2) "is_not" is a bool which is true if "no_initialize_domain", false
637  *      otherwise.
638  *  (3) "is_last_name" is a bool which is true if "domainname" is "the last
639  *      component of a domainname", false otherwise.
640  *  (4) "domainname" which is "a domainname" or "the last component of a
641  *      domainname".
642  *  (5) "program" which is a program's pathname.
643  *      This field is NULL if "from" clause is not specified.
644  */
645 struct tomoyo_domain_keeper_entry {
646         struct tomoyo_acl_head head;
647         bool is_not;       /* True if this entry is "no_keep_domain".        */
648         /* True if the domainname is tomoyo_get_last_name(). */
649         bool is_last_name;
650         const struct tomoyo_path_info *domainname;
651         const struct tomoyo_path_info *program;       /* This may be NULL */
652 };
653
654 /*
655  * tomoyo_aggregator_entry is a structure which is used for holding
656  * "aggregator" entries.
657  * It has following fields.
658  *
659  *  (1) "head" is "struct tomoyo_acl_head".
660  *  (2) "original_name" which is originally requested name.
661  *  (3) "aggregated_name" which is name to rewrite.
662  */
663 struct tomoyo_aggregator_entry {
664         struct tomoyo_acl_head head;
665         const struct tomoyo_path_info *original_name;
666         const struct tomoyo_path_info *aggregated_name;
667 };
668
669 /*
670  * tomoyo_alias_entry is a structure which is used for holding "alias" entries.
671  * It has following fields.
672  *
673  *  (1) "head" is "struct tomoyo_acl_head".
674  *  (2) "original_name" which is a dereferenced pathname.
675  *  (3) "aliased_name" which is a symlink's pathname.
676  */
677 struct tomoyo_alias_entry {
678         struct tomoyo_acl_head head;
679         const struct tomoyo_path_info *original_name;
680         const struct tomoyo_path_info *aliased_name;
681 };
682
683 /*
684  * tomoyo_policy_manager_entry is a structure which is used for holding list of
685  * domainnames or programs which are permitted to modify configuration via
686  * /sys/kernel/security/tomoyo/ interface.
687  * It has following fields.
688  *
689  *  (1) "head" is "struct tomoyo_acl_head".
690  *  (2) "is_domain" is a bool which is true if "manager" is a domainname, false
691  *      otherwise.
692  *  (3) "manager" is a domainname or a program's pathname.
693  */
694 struct tomoyo_policy_manager_entry {
695         struct tomoyo_acl_head head;
696         bool is_domain;  /* True if manager is a domainname. */
697         /* A path to program or a domainname. */
698         const struct tomoyo_path_info *manager;
699 };
700
701 struct tomoyo_preference {
702         unsigned int learning_max_entry;
703         bool enforcing_verbose;
704         bool learning_verbose;
705         bool permissive_verbose;
706 };
707
708 struct tomoyo_profile {
709         const struct tomoyo_path_info *comment;
710         struct tomoyo_preference *learning;
711         struct tomoyo_preference *permissive;
712         struct tomoyo_preference *enforcing;
713         struct tomoyo_preference preference;
714         u8 default_config;
715         u8 config[TOMOYO_MAX_MAC_INDEX + TOMOYO_MAX_MAC_CATEGORY_INDEX];
716 };
717
718 /********** Function prototypes. **********/
719
720 extern asmlinkage long sys_getpid(void);
721 extern asmlinkage long sys_getppid(void);
722
723 /* Check whether the given string starts with the given keyword. */
724 bool tomoyo_str_starts(char **src, const char *find);
725 /* Get tomoyo_realpath() of current process. */
726 const char *tomoyo_get_exe(void);
727 /* Format string. */
728 void tomoyo_normalize_line(unsigned char *buffer);
729 /* Print warning or error message on console. */
730 void tomoyo_warn_log(struct tomoyo_request_info *r, const char *fmt, ...)
731      __attribute__ ((format(printf, 2, 3)));
732 /* Check all profiles currently assigned to domains are defined. */
733 void tomoyo_check_profile(void);
734 /* Open operation for /sys/kernel/security/tomoyo/ interface. */
735 int tomoyo_open_control(const u8 type, struct file *file);
736 /* Close /sys/kernel/security/tomoyo/ interface. */
737 int tomoyo_close_control(struct file *file);
738 /* Read operation for /sys/kernel/security/tomoyo/ interface. */
739 int tomoyo_read_control(struct file *file, char __user *buffer,
740                         const int buffer_len);
741 /* Write operation for /sys/kernel/security/tomoyo/ interface. */
742 int tomoyo_write_control(struct file *file, const char __user *buffer,
743                          const int buffer_len);
744 /* Check whether the domain has too many ACL entries to hold. */
745 bool tomoyo_domain_quota_is_ok(struct tomoyo_request_info *r);
746 /* Print out of memory warning message. */
747 void tomoyo_warn_oom(const char *function);
748 /* Check whether the given name matches the given name_union. */
749 bool tomoyo_compare_name_union(const struct tomoyo_path_info *name,
750                                const struct tomoyo_name_union *ptr);
751 /* Check whether the given number matches the given number_union. */
752 bool tomoyo_compare_number_union(const unsigned long value,
753                                  const struct tomoyo_number_union *ptr);
754 int tomoyo_get_mode(const u8 profile, const u8 index);
755 /* Transactional sprintf() for policy dump. */
756 bool tomoyo_io_printf(struct tomoyo_io_buffer *head, const char *fmt, ...)
757         __attribute__ ((format(printf, 2, 3)));
758 /* Check whether the domainname is correct. */
759 bool tomoyo_correct_domain(const unsigned char *domainname);
760 /* Check whether the token is correct. */
761 bool tomoyo_correct_path(const char *filename);
762 bool tomoyo_correct_word(const char *string);
763 /* Check whether the token can be a domainname. */
764 bool tomoyo_domain_def(const unsigned char *buffer);
765 bool tomoyo_parse_name_union(const char *filename,
766                              struct tomoyo_name_union *ptr);
767 /* Check whether the given filename matches the given path_group. */
768 bool tomoyo_path_matches_group(const struct tomoyo_path_info *pathname,
769                                const struct tomoyo_path_group *group);
770 /* Check whether the given value matches the given number_group. */
771 bool tomoyo_number_matches_group(const unsigned long min,
772                                  const unsigned long max,
773                                  const struct tomoyo_number_group *group);
774 /* Check whether the given filename matches the given pattern. */
775 bool tomoyo_path_matches_pattern(const struct tomoyo_path_info *filename,
776                                  const struct tomoyo_path_info *pattern);
777
778 bool tomoyo_print_number_union(struct tomoyo_io_buffer *head,
779                                const struct tomoyo_number_union *ptr);
780 bool tomoyo_parse_number_union(char *data, struct tomoyo_number_union *num);
781
782 /* Read "aggregator" entry in exception policy. */
783 bool tomoyo_read_aggregator_policy(struct tomoyo_io_buffer *head);
784 /* Read "alias" entry in exception policy. */
785 bool tomoyo_read_alias_policy(struct tomoyo_io_buffer *head);
786 /*
787  * Read "initialize_domain" and "no_initialize_domain" entry
788  * in exception policy.
789  */
790 bool tomoyo_read_domain_initializer_policy(struct tomoyo_io_buffer *head);
791 /* Read "keep_domain" and "no_keep_domain" entry in exception policy. */
792 bool tomoyo_read_domain_keeper_policy(struct tomoyo_io_buffer *head);
793 /* Read "file_pattern" entry in exception policy. */
794 bool tomoyo_read_file_pattern(struct tomoyo_io_buffer *head);
795 /* Read "path_group" entry in exception policy. */
796 bool tomoyo_read_path_group_policy(struct tomoyo_io_buffer *head);
797 /* Read "number_group" entry in exception policy. */
798 bool tomoyo_read_number_group_policy(struct tomoyo_io_buffer *head);
799 /* Read "allow_read" entry in exception policy. */
800 bool tomoyo_read_globally_readable_policy(struct tomoyo_io_buffer *head);
801 /* Read "deny_rewrite" entry in exception policy. */
802 bool tomoyo_read_no_rewrite_policy(struct tomoyo_io_buffer *head);
803 /* Tokenize a line. */
804 bool tomoyo_tokenize(char *buffer, char *w[], size_t size);
805 /* Write domain policy violation warning message to console? */
806 bool tomoyo_verbose_mode(const struct tomoyo_domain_info *domain);
807 /* Get the last component of the given domainname. */
808 const char *tomoyo_get_last_name(const struct tomoyo_domain_info *domain);
809 /* Fill "struct tomoyo_request_info". */
810 int tomoyo_init_request_info(struct tomoyo_request_info *r,
811                              struct tomoyo_domain_info *domain,
812                              const u8 index);
813 /* Check permission for mount operation. */
814 int tomoyo_mount_permission(char *dev_name, struct path *path, char *type,
815                             unsigned long flags, void *data_page);
816 /* Create "aggregator" entry in exception policy. */
817 int tomoyo_write_aggregator_policy(char *data, const bool is_delete);
818 /* Create "alias" entry in exception policy. */
819 int tomoyo_write_alias_policy(char *data, const bool is_delete);
820 /*
821  * Create "initialize_domain" and "no_initialize_domain" entry
822  * in exception policy.
823  */
824 int tomoyo_write_domain_initializer_policy(char *data, const bool is_not,
825                                            const bool is_delete);
826 /* Create "keep_domain" and "no_keep_domain" entry in exception policy. */
827 int tomoyo_write_domain_keeper_policy(char *data, const bool is_not,
828                                       const bool is_delete);
829 /*
830  * Create "allow_read/write", "allow_execute", "allow_read", "allow_write",
831  * "allow_create", "allow_unlink", "allow_mkdir", "allow_rmdir",
832  * "allow_mkfifo", "allow_mksock", "allow_mkblock", "allow_mkchar",
833  * "allow_truncate", "allow_symlink", "allow_rewrite", "allow_rename" and
834  * "allow_link" entry in domain policy.
835  */
836 int tomoyo_write_file_policy(char *data, struct tomoyo_domain_info *domain,
837                              const bool is_delete);
838 /* Create "allow_read" entry in exception policy. */
839 int tomoyo_write_globally_readable_policy(char *data, const bool is_delete);
840 /* Create "allow_mount" entry in domain policy. */
841 int tomoyo_write_mount_policy(char *data, struct tomoyo_domain_info *domain,
842                               const bool is_delete);
843 /* Create "deny_rewrite" entry in exception policy. */
844 int tomoyo_write_no_rewrite_policy(char *data, const bool is_delete);
845 /* Create "file_pattern" entry in exception policy. */
846 int tomoyo_write_pattern_policy(char *data, const bool is_delete);
847 /* Create "path_group" entry in exception policy. */
848 int tomoyo_write_path_group_policy(char *data, const bool is_delete);
849 int tomoyo_supervisor(struct tomoyo_request_info *r, const char *fmt, ...)
850      __attribute__ ((format(printf, 2, 3)));
851 /* Create "number_group" entry in exception policy. */
852 int tomoyo_write_number_group_policy(char *data, const bool is_delete);
853 /* Find a domain by the given name. */
854 struct tomoyo_domain_info *tomoyo_find_domain(const char *domainname);
855 /* Find or create a domain by the given name. */
856 struct tomoyo_domain_info *tomoyo_find_or_assign_new_domain(const char *
857                                                             domainname,
858                                                             const u8 profile);
859 struct tomoyo_profile *tomoyo_profile(const u8 profile);
860 /* Allocate memory for "struct tomoyo_path_group". */
861 struct tomoyo_path_group *tomoyo_get_path_group(const char *group_name);
862 struct tomoyo_number_group *tomoyo_get_number_group(const char *group_name);
863
864 /* Check mode for specified functionality. */
865 unsigned int tomoyo_check_flags(const struct tomoyo_domain_info *domain,
866                                 const u8 index);
867 /* Fill in "struct tomoyo_path_info" members. */
868 void tomoyo_fill_path_info(struct tomoyo_path_info *ptr);
869 /* Run policy loader when /sbin/init starts. */
870 void tomoyo_load_policy(const char *filename);
871
872 void tomoyo_put_number_union(struct tomoyo_number_union *ptr);
873
874 /* Convert binary string to ascii string. */
875 char *tomoyo_encode(const char *str);
876
877 /*
878  * Returns realpath(3) of the given pathname but ignores chroot'ed root.
879  * These functions use kzalloc(), so the caller must call kfree()
880  * if these functions didn't return NULL.
881  */
882 char *tomoyo_realpath(const char *pathname);
883 /*
884  * Same with tomoyo_realpath() except that it doesn't follow the final symlink.
885  */
886 char *tomoyo_realpath_nofollow(const char *pathname);
887 /* Same with tomoyo_realpath() except that the pathname is already solved. */
888 char *tomoyo_realpath_from_path(struct path *path);
889 /* Get patterned pathname. */
890 const char *tomoyo_file_pattern(const struct tomoyo_path_info *filename);
891
892 /* Check memory quota. */
893 bool tomoyo_memory_ok(void *ptr);
894 void *tomoyo_commit_ok(void *data, const unsigned int size);
895
896 /*
897  * Keep the given name on the RAM.
898  * The RAM is shared, so NEVER try to modify or kfree() the returned name.
899  */
900 const struct tomoyo_path_info *tomoyo_get_name(const char *name);
901
902 /* Check for memory usage. */
903 void tomoyo_read_memory_counter(struct tomoyo_io_buffer *head);
904
905 /* Set memory quota. */
906 int tomoyo_write_memory_quota(struct tomoyo_io_buffer *head);
907
908 /* Initialize mm related code. */
909 void __init tomoyo_mm_init(void);
910 int tomoyo_path_permission(struct tomoyo_request_info *r, u8 operation,
911                            const struct tomoyo_path_info *filename);
912 int tomoyo_check_open_permission(struct tomoyo_domain_info *domain,
913                                  struct path *path, const int flag);
914 int tomoyo_path_number_perm(const u8 operation, struct path *path,
915                             unsigned long number);
916 int tomoyo_mkdev_perm(const u8 operation, struct path *path,
917                       const unsigned int mode, unsigned int dev);
918 int tomoyo_path_perm(const u8 operation, struct path *path);
919 int tomoyo_path2_perm(const u8 operation, struct path *path1,
920                       struct path *path2);
921 int tomoyo_find_next_domain(struct linux_binprm *bprm);
922
923 void tomoyo_print_ulong(char *buffer, const int buffer_len,
924                         const unsigned long value, const u8 type);
925
926 /* Drop refcount on tomoyo_name_union. */
927 void tomoyo_put_name_union(struct tomoyo_name_union *ptr);
928
929 /* Run garbage collector. */
930 void tomoyo_run_gc(void);
931
932 void tomoyo_memory_free(void *ptr);
933
934 int tomoyo_update_domain(struct tomoyo_acl_info *new_entry, const int size,
935                          bool is_delete, struct tomoyo_domain_info *domain,
936                          bool (*check_duplicate) (const struct tomoyo_acl_info
937                                                   *,
938                                                   const struct tomoyo_acl_info
939                                                   *),
940                          bool (*merge_duplicate) (struct tomoyo_acl_info *,
941                                                   struct tomoyo_acl_info *,
942                                                   const bool));
943 int tomoyo_update_policy(struct tomoyo_acl_head *new_entry, const int size,
944                          bool is_delete, struct list_head *list,
945                          bool (*check_duplicate) (const struct tomoyo_acl_head
946                                                   *,
947                                                   const struct tomoyo_acl_head
948                                                   *));
949 void tomoyo_check_acl(struct tomoyo_request_info *r,
950                       bool (*check_entry) (const struct tomoyo_request_info *,
951                                            const struct tomoyo_acl_info *));
952
953 /********** External variable definitions. **********/
954
955 /* Lock for GC. */
956 extern struct srcu_struct tomoyo_ss;
957
958 /* The list for "struct tomoyo_domain_info". */
959 extern struct list_head tomoyo_domain_list;
960
961 extern struct list_head tomoyo_path_group_list;
962 extern struct list_head tomoyo_number_group_list;
963 extern struct list_head tomoyo_domain_initializer_list;
964 extern struct list_head tomoyo_domain_keeper_list;
965 extern struct list_head tomoyo_aggregator_list;
966 extern struct list_head tomoyo_alias_list;
967 extern struct list_head tomoyo_globally_readable_list;
968 extern struct list_head tomoyo_pattern_list;
969 extern struct list_head tomoyo_no_rewrite_list;
970 extern struct list_head tomoyo_policy_manager_list;
971 extern struct list_head tomoyo_name_list[TOMOYO_MAX_HASH];
972
973 /* Lock for protecting policy. */
974 extern struct mutex tomoyo_policy_lock;
975
976 /* Has /sbin/init started? */
977 extern bool tomoyo_policy_loaded;
978
979 /* The kernel's domain. */
980 extern struct tomoyo_domain_info tomoyo_kernel_domain;
981
982 extern const char *tomoyo_path_keyword[TOMOYO_MAX_PATH_OPERATION];
983 extern const char *tomoyo_mkdev_keyword[TOMOYO_MAX_MKDEV_OPERATION];
984 extern const char *tomoyo_path2_keyword[TOMOYO_MAX_PATH2_OPERATION];
985 extern const char *tomoyo_path_number_keyword[TOMOYO_MAX_PATH_NUMBER_OPERATION];
986
987 extern unsigned int tomoyo_quota_for_query;
988 extern unsigned int tomoyo_query_memory_size;
989
990 /********** Inlined functions. **********/
991
992 static inline int tomoyo_read_lock(void)
993 {
994         return srcu_read_lock(&tomoyo_ss);
995 }
996
997 static inline void tomoyo_read_unlock(int idx)
998 {
999         srcu_read_unlock(&tomoyo_ss, idx);
1000 }
1001
1002 /* strcmp() for "struct tomoyo_path_info" structure. */
1003 static inline bool tomoyo_pathcmp(const struct tomoyo_path_info *a,
1004                                   const struct tomoyo_path_info *b)
1005 {
1006         return a->hash != b->hash || strcmp(a->name, b->name);
1007 }
1008
1009 /**
1010  * tomoyo_valid - Check whether the character is a valid char.
1011  *
1012  * @c: The character to check.
1013  *
1014  * Returns true if @c is a valid character, false otherwise.
1015  */
1016 static inline bool tomoyo_valid(const unsigned char c)
1017 {
1018         return c > ' ' && c < 127;
1019 }
1020
1021 /**
1022  * tomoyo_invalid - Check whether the character is an invalid char.
1023  *
1024  * @c: The character to check.
1025  *
1026  * Returns true if @c is an invalid character, false otherwise.
1027  */
1028 static inline bool tomoyo_invalid(const unsigned char c)
1029 {
1030         return c && (c <= ' ' || c >= 127);
1031 }
1032
1033 static inline void tomoyo_put_name(const struct tomoyo_path_info *name)
1034 {
1035         if (name) {
1036                 struct tomoyo_name_entry *ptr =
1037                         container_of(name, struct tomoyo_name_entry, entry);
1038                 atomic_dec(&ptr->users);
1039         }
1040 }
1041
1042 static inline void tomoyo_put_path_group(struct tomoyo_path_group *group)
1043 {
1044         if (group)
1045                 atomic_dec(&group->users);
1046 }
1047
1048 static inline void tomoyo_put_number_group(struct tomoyo_number_group *group)
1049 {
1050         if (group)
1051                 atomic_dec(&group->users);
1052 }
1053
1054 static inline struct tomoyo_domain_info *tomoyo_domain(void)
1055 {
1056         return current_cred()->security;
1057 }
1058
1059 static inline struct tomoyo_domain_info *tomoyo_real_domain(struct task_struct
1060                                                             *task)
1061 {
1062         return task_cred_xxx(task, security);
1063 }
1064
1065 static inline bool tomoyo_same_acl_head(const struct tomoyo_acl_info *p1,
1066                                            const struct tomoyo_acl_info *p2)
1067 {
1068         return p1->type == p2->type;
1069 }
1070
1071 static inline bool tomoyo_same_name_union
1072 (const struct tomoyo_name_union *p1, const struct tomoyo_name_union *p2)
1073 {
1074         return p1->filename == p2->filename && p1->group == p2->group &&
1075                 p1->is_group == p2->is_group;
1076 }
1077
1078 static inline bool tomoyo_same_number_union
1079 (const struct tomoyo_number_union *p1, const struct tomoyo_number_union *p2)
1080 {
1081         return p1->values[0] == p2->values[0] && p1->values[1] == p2->values[1]
1082                 && p1->group == p2->group && p1->min_type == p2->min_type &&
1083                 p1->max_type == p2->max_type && p1->is_group == p2->is_group;
1084 }
1085
1086 /**
1087  * list_for_each_cookie - iterate over a list with cookie.
1088  * @pos:        the &struct list_head to use as a loop cursor.
1089  * @cookie:     the &struct list_head to use as a cookie.
1090  * @head:       the head for your list.
1091  *
1092  * Same with list_for_each_rcu() except that this primitive uses @cookie
1093  * so that we can continue iteration.
1094  * @cookie must be NULL when iteration starts, and @cookie will become
1095  * NULL when iteration finishes.
1096  */
1097 #define list_for_each_cookie(pos, cookie, head)                         \
1098         for (({ if (!cookie)                                            \
1099                                      cookie = head; }),                 \
1100                      pos = rcu_dereference((cookie)->next);             \
1101              prefetch(pos->next), pos != (head) || ((cookie) = NULL);   \
1102              (cookie) = pos, pos = rcu_dereference(pos->next))
1103
1104 #endif /* !defined(_SECURITY_TOMOYO_COMMON_H) */