A python library to make friends of TPMs and Clouds.
- Executive summary Keylime slides: doc/keylime-elevator-slides.pptx
- See ACSAC 2016 paper in doc directory: doc/tci-acm.pdf
- Presentation on keylime: doc/llsrc-keylime-acsac-v6.pptx
- Details about Keylime REST API: doc/keylime RESTful API.docx
Errata from the ACSAC Paper
We discovered a typo in Figure 5 of the published ACSAC paper. The final interaction between the Tenant and Cloud Verifier showed an HMAC of the node's ID using the key K_e. This should be using K_b. The paper in this repository and the ACSAC presentation have been updated to correct this typo.
Table of Contents
- Making sure your TPM is ready for keylime
- Additional Reading
Note: The TPM 4720 tools require v1.0 of the OpenSSL development library, and will not compile with the newer v1.1 version! On more recent operating systems (such as Ubuntu 18+ and Fedora 27+), you will need to update the installer to specify v1.0 instead (e.g.,
compat-openssl10-devel for RPMs or
libssl1.0-dev for APT).
keylime requires Python 2.7.10 or newer for proper TLS support.
Installation can be performed via an automated shell script,
following command line options are available:
Usage: ./installer.sh [option...] Options: -k Download Keylime (stub installer mode) -o Use OpenSSL instead of CFSSL -t Create tarball with keylime_node -s Install TPM 4720 in socket mode (vs. chardev) -p PATH Use PATH as Keylime path -h This help info
Note that CFSSL is required if you want to support revocation.
Keylime requires Python 2.7.10 or newer for proper TLS support. This is newer than some LTS distributions like Ubuntu 14.04 or CentOS 7. See google for instructions on how to get a newer Python onto those platforms.
The following python packages are required:
The latter of these are usually available as distro packages.
apt-get install -y python-dev python-setuptools python-tornado python-m2crypto python-zmq
yum install -y python-devel python-setuptools python-tornado python-m2crypto python-zmq
TPM utility prerequisites
You also need a patched version of tpm4720 the IBM software TPM emulator and utilities. This is available at https://github.com/mit-ll/tpm4720-keylime. See README.md in that project for detailed instructions on how to build and install it.
The brief synopsis of a quick build/install is:
apt-get -y install build-essential libssl-dev libtool automake
yum install -y openssl-devel libtool gcc automake
then clone, build, and install with:
git clone https://github.com/mit-ll/tpm4720-keylime.git cd tpm4720-keylime/libtpm ./comp-chardev.sh sudo make install
To ensure that you have the patched version installed ensure that you have
encaik utility in your path.
You're finally ready to install keylime!
sudo python setup.py install
To run on OSX 10.11+
You need to build m2crypto from source with
brew install openssl git clone https://gitlab.com/m2crypto/m2crypto.git python setup.py build build_ext --openssl=/usr/local/opt/openssl/ sudo -E python setup.py install build_ext --openssl=/usr/local/opt/openssl/
If you want to support revocation, you also need to have cfssl installed and in your
path on the tenant node. It can be obtained from https://github.com/cloudflare/cfssl. You
will also need to set ca_implementation to "cfssl" instead of "openssl" in
Making sure your TPM is ready for keylime
The above instructions for installing tpm4720 will be configured to talk to /dev/tpm0. If this device is not on your system, then you may need to build/install TPM support for your kernel. You can use:
dmesg | grep -i tpm
to see if the kernel is initializing the TPM driver during boot. If you have the /dev/tpm0 device, you next need to get it into the right state. The kernel driver reports status on the TPM in /sys. You can locate the folder with relevant info from the driver using:
sudo find /sys -name tpm0
Several results may be returned, but the duplicates are just symlinks to one location. Go to one of the returned paths, for example, /sys/class/misc/tpm0. Now change to the device directory. Here you can find some information from the TPM like the current pcr values and sometimes the public EK is available. It will also report two important state values: active and enabled. To use keylime, both of these must be 1. If they are not, you may need to reboot into the BIOS to enable and activate the TPM. If you need to both enable and activate, then you must enable first, reboot, then activate and finally reboot again. It is also possible that you may need to assert physical presence (see manual for your system on how to do this) in order to accomplish these actions in your BIOS.
If your system shows enabled and activated, you can next check the "owned" status in the /sys directory. Keylime can take a system that is not owned (i.e., owned = 0) and take control of it. Keylime can also take a system that is already owned, provided that you know the owner password and that keylime or another trusted computing system that relies upon tpm4720 previously took ownership. If you know the owner password, you can set the option tpm_ownerpassword in keylime.conf to this known value.
keylime puts its configuration in
/etc/keylime.conf. It will also take an alternate
location for the config in the environment var
This file is documented with comments and should be self-explanatory.
Keylime has three major component services that run: the registrar, verifier, and the node:
The registrar is a simple HTTPS service that accepts TPM public keys. It then presents an interface to obtain these public keys for checking quotes.
The verifier is the most important component in keylime. It does initial and periodic checks of system integrity and supports bootstrapping a cryptographic key securely with the node. The verifier uses mutual TLS for its control interface.
By default, the verifier will create appropriate TLS certificates for itself in
/var/lib/keylime/cv_ca/. The registrar and tenant will use this as well. If you use the generated TLS certificates then all the processes need to run as root to allow reading of private key files in
The node is the target of bootstrapping and integrity measurements. It puts its stuff into
To run a basic test, run
the node starts up properly, then you can proceed.
To kick everything off you need to tell keylime to provision a machine. This can be done either with the keylime tenant or webapp.
Provisioning with keylime_tenant
keylime_tenant utility can be used to provision your node.
As an example, the following command tells keylime to provision a new node
at 127.0.0.1 with UUID D432FBB3-D2F1-4A97-9EF7-75BD81C00000 and talk to a
cloud verifier at 127.0.0.1. Finally it will encrypt a file called filetosend
and send it to the node allowing it to decrypt it only if the configured TPM
/etc/keylime.conf) is satisfied:
keylime_tenant -c add -t 127.0.0.1 -v 127.0.0.1 -u D432FBB3-D2F1-4A97-9EF7-75BD81C00000 -f filetosend
To stop keylime from requesting attestations:
keylime_tenant -c delete -t 127.0.0.1 -u D432FBB3-D2F1-4A97-9EF7-75BD81C00000
For additional advanced options for the tenant utility run:
Provisioning with keylime_webapp
There is also a WebApp GUI interface for the tenant, available by
keylime_webapp. Next, simply navigate to the WebApp in
your web browser (https://localhost/webapp/ by default, as specified in
Note that the webapp must be run on the same machine as the tenant, since it
uses its keys for TLS authentication (in
Using keylime CA
A simple certificate authority is available to use with keylime. You can interact
with it using
keylime_tenant. Options for configuring the
keylime_ca creates are in
NOTE: This CA functionality is different than the TLS support for talking to
the verifier or registrar (though it uses some of the same config options
/etc/keylime.conf). This CA is for the cloud nodes you provision and
you can use keylime to bootstrap the private keys into nodes.
To initialize a new certificate authority run:
keylime_ca --command init
This will create a certificate authority in
/var/lib/keylime/ca and requires
root access to write to the directory. Use
-d to point it to another directory
not necessarily requiring root.
You can create certificates under this ca using:
keylime_ca --command create --name certname.host.com
This will create a certificate signed by the CA in
works here to have it use a different CA directory).
To obtain a zip file of the certificate, public key, and private key for a cert use:
keylime_ca --command pkg --name certname.host.com
This will zip the above files and place them in /var/lib/keylime/ca/certname.host.com-pkg.zip. The private key will be protected by the key that you were prompted with.
You may wonder why this is in keylime at all? Well, you can tell
automatically create a key and then provision a node with it. Use the --cert
keylime_tenant to do this. This takes in the directory of the CA:
keylime_tenant -c add -t 127.0.0.1 -u D432FBB3-D2F1-4A97-9EF7-75BD81C00000 --cert /var/lib/keylime/ca
If you also have the option extract_payload_zip in
/etc/keylime.conf set to
the cloud node, then it will automatically extract the zip containing an unprotected
private key, public key, certificate and CA certificate to
If the cloud verifier option
revocation_notifier is set to
the CV will sign a revocation message and send it over 0mq to any subscribers. The
keylime CA supports listening to these notifications and will generate an updated
CRL. To enable this feature, run:
keylime_ca -c listen
The revocation key will be automatically created by the tenant the first time you use the CA with keylime. Currently the CRL is only written back to the CA directory, unless IPsec configuration is being used (see Additional Reading).
- Bundling a portable Cloud Node - Create portable tarball of Cloud Node, for usage on systems without python and other dependencies.
- Xen vTPM setup notes - Guidance on getting Xen set up with vTPM support for Keylime.
- IPsec Configurations
- Demo files - Some pre-packaged demos to show off what Keylime can do.
- Stubbed TPM/vTPM notes - Explains how to use Keylime with canned/simulated TPM behavior (useful for testing).
- IMA stub service - Allows you to test IMA and keylime on a machine without a TPM. Service keeps emulated TPM synchronized with IMA.
Copyright (c) 2015 Massachusetts Institute of Technology.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DISTRIBUTION STATEMENT A. Approved for public release: distribution unlimited.
This material is based upon work supported by the Assistant Secretary of Defense for Research and Engineering under Air Force Contract No. FA8721-05-C-0002 and/or FA8702-15-D-0001. Any opinions, findings, conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the Assistant Secretary of Defense for Research and Engineering.
Delivered to the US Government with Unlimited Rights, as defined in DFARS Part 252.227-7013 or 7014 (Feb 2014). Notwithstanding any copyright notice, U.S. Government rights in this work are defined by DFARS 252.227-7013 or DFARS 252.227-7014 as detailed above. Use of this work other than as specifically authorized by the U.S. Government may violate any copyrights that exist in this work.