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