in-toto provides a framework to protect the integrity of the software supply chain. It does so by verifying that each task in the chain is carried out as planned, by authorized personnel only, and that the product is not tampered with in transit.
in-toto requires a project owner to create a layout. A layout lists the sequence of steps of the software supply chain, and the functionaries authorized to perform these steps. When a functionary performs a step in-toto gathers information about the used command and the related files and stores it in a link metadata file. As a consequence link files provide the required evidence to establish a continuous chain that can be validated against the steps defined in the layout.
The layout, signed by the project owners, together with the links, signed by the designated functionaries, are released as part of the final product, and can be validated manually or via automated tooling in, e.g. a package manager.
- Python in version 2.7 - crypto libraries require header files
- OpenSSL - crypto libraries require header files
- git - version control system
- pip - package installer tool
It is strongly recommended to install in-toto in an isolated Python environment. For easy setup instructions visit the docs for virtualenv and the convenient vitualenvwrapper.
pip install in-totoThe in-toto software supply chain layout consists of the following parts:
- expiration date
- readme (an optional description of the supply chain)
- functionary keys (public keys, used to verify link metadata signatures)
- signatures (one or more layout signatures created with the project owner key(s))
- software supply chain steps
correspond to steps carried out by a functionary as part of the software supply chain. The steps defined in the layout list the functionaries who are authorized to carry out the step (by key id). Steps require a unique name to associate them (upon verification) with link metadata that is created when a functionary carries out the step using the
in-tototools. Additionally, steps must have material and product rules which define the files a step is supposed to operate on. Material and product rules are described in the section below. - inspections define commands to be run during the verification process and can also list material and product rules.
Take a look at the demo layout creation example for further information on how to create an in-toto layout. Or try our experimental layout creation web tool.
A software supply chain usually operates on a set of files, such as source code, executables, packages, or the like. in-toto calls these files artifacts. A material is an artifact that will be used when a step or inspection is carried out. Likewise, a product is an artifact that results from carrying out a step.
The in-toto layout provides a simple rule language to authorize or enforce the artifacts of a step and to chain them together. This adds the following guarantees for any given step or inspection:
- Only artifacts authorized by the project owner are created, modified or deleted,
- each defined creation, modification or deletion is enforced, and also
- restricted to the scope of its definition, which chains subsequent steps and inspections together.
Note that it is up to you to properly secure your supply chain, by authorizing, enforcing and chaining materials and products using any and usually multiple of the following rules:
CREATE <pattern>DELETE <pattern>MODIFY <pattern>ALLOW <pattern>DISALLOW <pattern>REQUIRE <file>MATCH <pattern> [IN <source-path-prefix>] WITH (MATERIALS|PRODUCTS) [IN <destination-path-prefix>] FROM <step>
Rule arguments specified as <pattern> allow for Unix shell-style wildcards as implemented by Python's fnmatch.
To learn more about the different rule types, their guarantees and how they are applied take a look at the Artifact Rules section of the in-toto specification.
in-toto-run is used to execute a step in the software supply chain. This can
be anything relevant to the project such as tagging a release with git,
running a test, or building a binary. The relevant step name and command are
passed as arguments, along with materials, which are files required for that
step's command to execute, and products which are files expected as a result
of the execution of that command. These, and other relevant details
pertaining to the step are stored in a link file, which is signed using the
functionary's key.
If materials are not passed to the command, the link file generated just
doesn't record them. Similarly, if the execution of a command via
in-toto-run doesn't result in any products, they're not recorded in the link
file. Any files that are modified or used in any way during the execution of
the command are not recorded in the link file unless explicitly passed as
artifacts. Conversely, any materials or products passed to the command are
recorded in the link file even if they're not part of the execution
of the command.
See this simple usage example from the demo application
for more details.
For a detailed list of all the command line arguments, run in-toto-run --help
or look at the code documentation.
in-toto-record works similar to in-toto-run but can be used for
multi-part software supply chain steps, i.e. steps that are not carried out
by a single command. Use in-toto-record start ... to create a
preliminary link file that only records the materials, then run the
commands of that step or edit files manually and finally use
in-toto-record stop ... to record the products and generate the actual
link metadata file. For a detailed list of all command line arguments and their usage,
run in-toto-record start --help or in-toto-record stop --help, or look at
the code documentation.
In order to verify the final product with in-toto, the verifier must have access to the layout, the *.link files,
and the project owner's public key(s).
Use in-toto-verify on the final product to verify that
- the layout was signed with the project owner's private key(s),
- has not expired,
- each step was performed and signed by the authorized functionary,
- the functionaries used the commands, they were supposed to use,
- materials and products of each step were in place as defined by the rules, and
- run the defined inspections
For a detailed list of all command line arguments and their usage, run
in-toto-verify --help or look at the
code documentation.
in-toto-sign is a metadata signature helper tool to add, replace, and
verify signatures within in-toto Link or Layout metadata, with options to:
- replace (default) or add signature(s), with layout metadata able to be signed by multiple keys at once while link metadata can only be signed by one key at a time
- write signed metadata to a specified path (if no output path is specified,
layout metadata is written to the path of the input file while link metadata
is written to
<name>.<keyid prefix>.link) - verify signatures
This tool is intended to sign layouts created by the layout web wizard, but also serves well to re-sign test and demo data. For example, it can be used if metadata formats or signing routines change.
For a detailed list of all command line arguments and their usage, run
in-toto-sign --help or look at the
code documentation.
Settings can be configured in in_toto.settings, via prefixed environment variables or in RCfiles in one of the following
paths: /etc/in_toto/config, /etc/in_totorc, ~/.config/in_toto/config,
~/.config/in_toto, ~/.in_toto/config, ~/.in_totorc, .in_totorc.
A setting in an RCfile in the current working directory overrides
the same
setting in an RCfile in the user's home directory, which overrides the
same setting in an environment variable, which overrides the same setting
in in_toto.settings.
Setting names are restricted to the below listed settings (case sensitive). Also, setting values that contain colons are parsed as list.
ARTIFACT_EXCLUDE_PATTERNS Specifies a list of glob patterns that can be used to
exclude files from being recorded as materials or products. See runlib
docs for more details.
ARTIFACT_BASE_PATH If set, material and product paths passed to
in-toto-run are searched relative to the set base path. Also, the base
path is stripped from the paths written to the resulting link metadata
file.
# Bash style environment variable export
export IN_TOTO_ARTIFACT_BASE_PATH='/home/user/project'
export IN_TOTO_ARTIFACT_EXCLUDE_PATTERNS='*.link:.gitignore'# E.g in rcfile ~/.in_totorc
[in-toto settings]
ARTIFACT_BASE_PATH=/home/user/project
ARTIFACT_EXCLUDE_PATTERNS=*.link:.gitignore
You can try in-toto by running the demo application. The demo basically outlines three users viz., Alice (project owner), Bob (functionary) and Carl (functionary) and how in-toto helps to specify a project layout and verify that the layout has been followed in a correct manner.
You can read more about how in-toto works by taking a look at the specification.
Security issues can be reported by emailing justincappos@gmail.com.
At a minimum, the report must contain the following:
- Description of the vulnerability.
- Steps to reproduce the issue.
Optionally, reports that are emailed can be encrypted with PGP. You should use PGP key fingerprint E9C0 59EC 0D32 64FA B35F 94AD 465B F9F6 F8EB 475A.
Please do not use the GitHub issue tracker to submit vulnerability reports. The issue tracker is intended for bug reports and to make feature requests.
Development of in-toto occurs on the "develop" branch of this repository. Contributions can be made by submitting GitHub Pull Requests. Take a look at our development guidelines for detailed instructions. Submitted code should follow our style guidelines and must be unit tested.
Contributors must also indicate acceptance of the Developer Certificate of
Origin (DCO) by appending a Signed-off-by: Your Name <example@domain.com> to each git commit message (see git commit --signoff).
This project is managed by Prof. Justin Cappos and other members of the Secure Systems Lab at NYU and the NJIT Cybersecurity Research Center.
This research was supported by the Defense Advanced Research Projects Agency (DARPA) and the Air Force Research Laboratory (AFRL). Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of DARPA and AFRL. The United States Government is authorized to reproduce and distribute reprints notwithstanding any copyright notice herein.