TOMOYO Linux - ArchWiki

Jump to content
From ArchWiki

Related articles

- AppArmor
- SELinux

TOMOYO Linux is a Mandatory Access Control (MAC) implementation for Linux. It was launched in March 2003 and was sponsored by NTT Data Corporation. TOMOYO Linux focuses on the behaviour of a system, allowing each process to declare behaviours and resources needed to achieve its purpose. It can be used as a system analysis tool as well as an access restriction tool.

The security goal of TOMOYO Linux is to provide "MAC that covers practical requirements for most users and keeps usable for most administrators". TOMOYO Linux is not a tool for just security professionals, but also for average users and administrators.

Note: This article does not aim to be an exhaustive guide and should be used as a supplement to the extensive user documentation provided by the project.
Tip: The TOMOYO Linux 2.x will eventually come closer to reaching feature parity with the 1.x branch, but for those wanting an easy start the 2.x branch is easy to install. The TOMOYO Linux 1.x branch is for those wanting the greatest security, while AKARI is somewhere in between.

## Introduction

TOMOYO Linux attempts to make the system where everything is prearranged in an easy to understand way:

- Make all access requests that will occur at least once during the lifetime of the kernel known in advance.
- Allow the administrator to write a policy that only allows expected and desirable access requests.

Unlike AppArmor, TOMOYO Linux is intended to protect the whole system from attackers exploiting vulnerabilities in applications. TOMOYO Linux addresses this threat by recording the behaviour of all applications in the test environment and then forcing all applications to act within these recorded behaviours in the production environment.

TOMOYO Linux is not for users wanting ready-made policy files supplied by others. It involves creating policy from scratch, aided by the "learning mode" which can automatically generate policy files with necessary and sufficient permissions for a specific system. TOMOYO Linux reports what is happening within the Linux system and can therefore be used as a system analysis tool. It resembles strace and reports what is being executed by each program and what files/networks are accessed.

This table provides a comprehensive comparison of TOMOYO Linux with AppArmor, SELinux and SMACK.

## Branches of development

TOMOYO Linux 1.x is the original branch of development. TOMOYO Linux was first released on 11th November 2005. It was implemented as a patch that can be applied to the Linux kernel and is still in active development. It can coexist with other security modules such as SELinux, SMACK and AppArmor.

TOMOYO Linux 2.x is the Linux mainline kernel branch of development. In June 2009, TOMOYO was merged into the Linux kernel version 2.6.30 and it uses standard Linux Security Module (LSM) hooks. However, the LSM hooks must be extended further in order to port the full MAC functionality of TOMOYO Linux into the Linux kernel. Thus, it does not yet provide equal functionality with the 1.x branch of development. This chart compares the differences between each branch.

AKARI is based on the TOMOYO Linux 1.x branch and is implemented as a Loadable Kernel Module (LKM). It therefore has the advantage of not requiring the user to patch and recompile the kernel. This table provides a comprehensive comparison of AKARI with the TOMOYO Linux 1.x and 2.x branches.

## TOMOYO Linux 1.x

Implementing TOMOYO Linux 1.x using a kernel patched with ccs-patch provides the full functionality obtainable from the TOMOYO Linux project. However, implementation of this branch requires the most hurdles to be overcome, as the kernel must be patched with ccs-patch and subsequently recompiled.

Both a patched kernel and the userspace tools must be installed. A package for ccs-toolsAUR is available on the AUR.

### Initializing configuration

The policy must first be initialized:

    # /usr/lib/ccs/init_policy

The policy files are saved in the `/etc/css/` directory and can be edited by running:

    # ccs-editpolicy

## AKARI

### Limitations of AKARI

If using the TOMOYO Linux project purely for system analysis, then AKARI is the easiest method of achieving this. If using the TOMOYO Linux project for system restriction, it is a minimal effort way to gain most of the functionality of the TOMOYO Linux 1.x branch. However, there are a few limitations that must be considered:

- It depends on the kernel version and configuration provided by the distribution:

      CONFIG_SECURITY=y [required]
      CONFIG_KALLSYMS=y [required]
      CONFIG_PROC_FS=y [required]
      CONFIG_MODULES=y [required]
      CONFIG_SECURITY_PATH=y [optional: for using absolute pathnames]
      CONFIG_SECURITY_NETWORK=y [optional: for providing network restriction]

- The restriction of a few advanced networking operations are limited or unavailable due to the absence of required LSM hooks.
- Restricting use of capabilities is not possible.
- Looking up per-task variables is slower as they are managed outside "struct task_struct" in order to keep KABI unchanged. However, this should not be noticeable for the typical end-user as performance decrease by pathname based permission checking is dominant.

This table provides a comprehensive comparison of AKARI with the TOMOYO Linux 1.x and 2.x branches.

### Installation

Both AKARI and the userspace tools must be installed. A package for akariAUR and a package for ccs-toolsAUR are available on the AUR.

To activate AKARI, set the following kernel parameter:

    init=/usr/bin/ccs-init

### Initializing configuration

The policy must first be initialized:

    # /usr/lib/ccs/init_policy --module_name=akari

The policy files are saved in the `/etc/css/` directory and can be edited by running:

    # ccs-editpolicy

## TOMOYO Linux 2.x

### Limitations of TOMOYO Linux 2.x

The implementation of TOMOYO Linux 2.x into the Linux mainline kernel is not yet complete but is very close to 1.x since 2.5.x. There are a few features that still need to be implemented as compared to the 1.x branch. This chart has a comprehensive comparison of the differences between each branch of development.

### Installation

TOMOYO is supported by all officially supported kernels.

For custom kernels make sure that the following kernel options are set:

    CONFIG_SECURITY=y
    CONFIG_SECURITYFS=y
    CONFIG_SECURITY_NETWORK=y
    CONFIG_SECURITY_PATH=y
    CONFIG_SECURITY_TOMOYO=y
    CONFIG_SECURITY_TOMOYO_POLICY_LOADER="/usr/bin/tomoyo-init"
    CONFIG_SECURITY_TOMOYO_ACTIVATION_TRIGGER="/usr/lib/systemd/systemd"
    CONFIG_LSM="landlock,lockdown,yama,integrity,tomoyo,bpf"

Install the 2.6 branch of the userspace tools with tomoyo-toolsAUR.

### Activation

To activate TOMOYO Linux, set the following kernel parameters to enable the Linux Security Module:

    lsm=landlock,lockdown,yama,integrity,tomoyo,bpf

Note: The `lsm=` kernel parameter sets the initialization order of Linux security modules. The kernel's configured `lsm=` value can be found with `zgrep CONFIG_LSM= /proc/config.gz` and the current value with `cat /sys/kernel/security/lsm`.

- Make sure that `tomoyo` is the first "major" module in the list.[1] Examples of valid values and their order can be found in security/Kconfig.
- `capability` should be omitted from `lsm=` as it will always get included automatically.

TOMOYO will load all saved policies from `/etc/tomoyo/policy/current` when `/usr/lib/systemd/systemd` executes.

Next, check whether the activation was successful. You should have the following lines (or similar) from dmesg:

    # dmesg | grep -A 1 -B 1 TOMOYO

    [    0.003375] Security Framework initialized
    [    0.003387] TOMOYO Linux initialized
    [    0.003396] AppArmor: AppArmor disabled by boot time parameter
    --
    [    6.829798] Calling /usr/bin/tomoyo-init to load policy. Please wait.
    [    6.833709] TOMOYO: 2.5.0
    [    6.833712] Mandatory Access Control activated.

For first time, you may want to auto-save in-memory policies to filesystem when computer goes to shutdown/reboot. If yes, create the following systemd unit:

    /etc/systemd/system/tomoyo-savepolicy.service

    [Unit]
    Description=Tomoyo savepolicy

    [Service]
    Type=oneshot
    ExecStart=/bin/true
    ExecStop=/usr/bin/tomoyo-savepolicy
    StandardInput=tty
    RemainAfterExit=yes

    [Install]
    WantedBy=multi-user.target

Enable `tomoyo-savepolicy.service`.

### Disabling

Remove `tomoyo` from the `lsm=` kernel parameter or remove `lsm=` entirely.

### Initializing configuration

The policy must first be initialized:

    # /usr/lib/tomoyo/init_policy

The policy files are saved in the `/etc/tomoyo/` directory and can be edited by running:

    # tomoyo-editpolicy

By default, tomoyo will start with "Disabled" profile (see profile-table below). You may want to enable learning mode for everybody right now. Just switch profile for `<kernel>` namespace in `/etc/tomoyo/policy/current/domain_policy.conf`:

    <kernel>
    use_profile 1
    use_group 0

If unsure if such wide learning is needed, just ignore this step. You can switch profiles later using tomoyo-editpolicy in "Domain transition editor" by pressing S on any selected domain (domains).

Now, the computer should be restarted.

### Log daemon

For tomoyo exists the log-daemon `tomoyo-auditd`. It is useful for monitoring the behavior of closed-source applications. The initial configuration file is well explained and can be found in `/etc/tomoyo/tools/auditd.conf` whereas the log files can be found in `/var/log/tomoyo/`.

To use it with systemd create the file `/etc/systemd/system/tomoyo-auditd.service` with the content described in chapter 4.6 in the official documentation.

## Usage

It is important to consult the relevant documentation in order to use TOMOYO Linux or AKARI effectively:

- TOMOYO Linux documentation
- AKARI documentation

Run the policy editor to begin editing. If using TOMOYO Linux 1.x or AKARI, then ccs-tools should be used:

    # ccs-editpolicy

If using TOMOYO Linux 2.x, then tomoyo-tools should be used:

    # tomoyo-editpolicy

As the system runs, TOMOYO Linux will create domains and add them to the tree. The access analysis/restriction in TOMOYO Linux is applied via domains. Every process belongs to a single domain and the process will transit to a different domain whenever it executes a program. The name of a domain is a concatenated string expression for the process execution history. For example, the name of the domain which the kernel belongs to is "<kernel>"; the name of domain which `/sbin/init` invoked by the kernel belongs to is "<kernel> /sbin/init"; if `/sbin/init` invokes `/etc/rc.d/rc` then the domain it belongs to is "<kernel> /sbin/init /etc/rc.d/rc". You can suppress or initialize domain transitions as needed.

Profiles can be assigned to each domain. There are four default profiles:

Disabled | Works as if regular kernel.
Learning | Do not reject an access request if it violates policy. Append the request to policy.
Permissive | Do not reject an access request if it violates policy. Do not append the request to policy.
Enforcing | Reject an access request if it violates policy. Do not append the request to policy.

The learning profile can be used to analyse the system or a specific application. Once all of the desired access requests of a domain have been identified, the policy for that domain can be edited as required before selecting the enforcing profile. This can be done for any and all domains from the start of system boot.

## See also

- Wikipedia:Tomoyo Linux
- TOMOYO Linux Home Page
- TOMOYO Linux Wiki
- AKARI Home Page
- AKARI Documentation
- AKARI/TOMOYO functionality comparison table
- TOMOYO Linux 1.8.x : The Official Guide
- TOMOYO Linux 2.6.x : The Official Guide
- TOMOYO Linux Security Goal
- Policy sample
- TOMOYO Linux on the Embedded Linux Wiki
- Presentation slides from PacSec 2007

Categories:

- Access control
- Kernel