Rainbow

  This page is monitored by the OLPC team.

  For Developers

english | español

HowTo [ID# 196696]  +/-

Translate this page with Google -español -български -中文（中国大陆） -中文（臺灣） -hrvatski -čeština -dansk -Nederlands -suomi -français -Deutsch -Ελληνικά -हिन्दी -italiano -日本語 -한국어 -norsk -polski -português -română -русский -svenska

Introduction

git :: sources :: rainbow-0.8.1.tar.bz2

Rainbow implements the isolation shell implicitly described in the Bitfrost security specification. This means that it isolates activities (and eventually system services) that it is asked to run from one another and the rest of the system.

Rainbow implements this isolation by generating a new uid (and perhaps a new gid) for each program it is asked to run. Running each activity as a separate user means that standard Unix access checks can be used as the primary 'gate' to control the visibility of activity-driven side-effects like reading from or writing to files or devices or signalling other processes.

Contributions are welcome.

For Activity Developers

When the user asks Sugar to start your activity, Rainbow is the software which actually asks the Linux kernel to do the 'starting'. However, in order to achieve the security goals described in Bitfrost, it places some restrictions on your software. You can find out more about these restrictions in the low-level activity api documentation. (In the future, the Sugar almanac may also contain some similar information).

Disabling Rainbow for Testing

Sugar's use of Rainbow can be trivially disabled by running

rm /etc/olpc-security

as root. It can be re-enabled by running

touch /etc/olpc-security

also as root.

Design

Rainbow has been implemented according to three designs to date.

0.8-series

The 0.8 series is designed as an "exec-wrapper". The "rainbow-run" wrapper is receives control from the shell, performs any requested isolation steps, then hands control over to isolated program. This way, rainbow can be used from freedesktop.org .desktop launcher files, from the command-line, and from custom graphical shells like Sugar with equal ease.

0.7-series

The 0.7 series was designed as a privileged dbus daemon. Sugar calls into this daemon when it wants to launch activities. An advantage of having a daemon is that the daemon can cache the results of expensive computations like python module loading. The problem with the daemon is that it consumes extra memory and that its caching behavior can cause many frustrating bugs.

0.6-series

The first implementation of rainbow (and of olpc-update) used a containerization technology called VServer to implement extensive isolation including network and CPU usage limits. Unfortunately, these early implementations revealed fundamental race conditions in the custom vserver patches provided to OLPC and the OLPC kernel team was unwilling to support the patches. Michael Stone created a new design outline, written up in rainbow.txt which explained how Bitfrost could be approached without vserver and vserver was removed from the kernel.

Installation

0.8-series

The basic idea is to install rainbow, either

from a distro package:

• Fedora >= 10: yum install rainbow
• Ubuntu: Bernie's PPA contains some basic rainbow packages which you can install.
• Other: Install rainbow from source or help others by packaging it for your distro!

from source:

RAINBOW=rainbow-0.8.2
wget http://dev.laptop.org/~mstone/releases/SOURCES/$RAINBOW.tar.bz2
tar xf $RAINBOW.tar.bz2 && cd $RAINBOW
make -f Makefile.build build
sudo make -f Makefile.build install

from a unified builder or image:

like sugar-jhbuild or Sugar on a Stick (SoaS). (nb: future work)

FINALLY:

Next, in order for rainbow to function, you may need to inject its users and groups into the system by running:

sudo /bin/sed -i -e s/^passwd:/passwd:\ rainbow/ /etc/nsswitch.conf
sudo /bin/sed -i -e s/^group:/group:\ rainbow/ /etc/nsswitch.conf

Congratulations. You are now ready to test rainbow.

Testing

Rainbow is easy to test in chroots, for example, those created by mock. See test-rainbow and, in particular,this small multi-user test script.

To test it on a regular system, you might install it, then run something like:

 sudo rainbow-run -q -s /var/spool/rainbow/2 -c / -f 0 -f 1 -f 2 -u `whoami` -i nice -- /bin/bash

This will drop you into an isolated bash session in which you can play.

NB: If you want to isolate graphical software, then you're going to need to use a helper program like rainbow-sugarize to provide an X cookie, access to the D-Bus session bus, etc.

Obviously, please contribute more automated tests, helpers, and bug reports!

Next Steps

Accessibility to Developers

Debian packaging + cli interface + pristine-root + automated testing

code: see the 'integration' branches of rainbow and nss-rainbow and the 'master' branch of test-rainbow

P_NETWORK

See Isolation LSM, http://lkml.org/lkml/2009/1/7/18, http://lkml.org/lkml/2009/1/7/613, and http://lxc.sourceforge.net.

P_DOCUMENT*

See Olpcfs and Journal reloaded, other thoughts welcome.

P_X

-- we'll start by trying out XSECURITY (i.e. by making activities untrusted clients) and see where that leaves us. Then on to XACE as per previous discussion

-- unfortunately, it seems (c.f. ssh man page) that most apps break when you treat them as untrusted clients. Hmm.

Demo Ideas

• (paraphrase): "The insight behind Rainbow is that the problem of isolating an operator from his/her programs is similar to the problem of isolating users of a shared server from one another and from root." -- C. Scott Ananian
• "I see the cool parts [of Rainbow] as (1) per-instance isolation, (2) isolation without virtualization, and (3) isolation using the uid mechanisms. All three are unique and impressive." -- Ben Schwartz

(NB: Actually, lots of other people have played with these ideas. plash is a compelling example.)

Ideas:

• Give people an isolated Terminal to play in.
• Show off rlimits with a fork-bomb.
• Show off filesystem protections -- rm -rf, restriction of readable dirs, etc.

Items of Historical Interest

• README - A description of the original scope and design of Rainbow.
• Notes - Notes on design and hurdles in developing Rainbow.
• Rainbow/DataStore Access - thoughts on datastore access mechanisms, superseded by Olpcfs.
• "Why not SELinux?"
• "Bitfrost Compliance for Update.1" announcement mail
• #2732, #2906, #4184 - influential tickets in the history of rainbow