6f9067
% container-signature(5) Container signature format
6f9067
% Miloslav Trmač
6f9067
% March 2017
6f9067
6f9067
# Container signature format
6f9067
6f9067
This document describes the format of container signatures,
6f9067
as implemented by the `github.com/containers/image/signature` package.
6f9067
6f9067
Most users should be able to consume these signatures by using the `github.com/containers/image/signature` package
6f9067
(preferably through the higher-level `signature.PolicyContext` interface)
6f9067
without having to care about the details of the format described below.
6f9067
This documentation exists primarily for maintainers of the package
6f9067
and to allow independent reimplementations.
6f9067
6f9067
## High-level overview
6f9067
6f9067
The signature provides an end-to-end authenticated claim that a container image
6f9067
has been approved by a specific party (e.g. the creator of the image as their work,
6f9067
an automated build system as a result of an automated build,
6f9067
a company IT department approving the image for production) under a specified _identity_
6f9067
(e.g. an OS base image / specific application, with a specific version).
6f9067
6f9067
A container signature consists of a cryptographic signature which identifies
6f9067
and authenticates who signed the image, and carries as a signed payload a JSON document.
6f9067
The JSON document identifies the image being signed, claims a specific identity of the
6f9067
image and if applicable, contains other information about the image.
6f9067
6f9067
The signatures do not modify the container image (the layers, configuration, manifest, …);
6f9067
e.g. their presence does not change the manifest digest used to identify the image in
6f9067
docker/distribution servers; rather, the signatures are associated with an immutable image.
6f9067
An image can have any number of signatures so signature distribution systems SHOULD support
6f9067
associating more than one signature with an image.
6f9067
6f9067
## The cryptographic signature
6f9067
6f9067
As distributed, the container signature is a blob which contains a cryptographic signature
6f9067
in an industry-standard format, carrying a signed JSON payload (i.e. the blob contains both the
6f9067
JSON document and a signature of the JSON document; it is not a “detached signature” with
6f9067
independent blobs containing the JSON document and a cryptographic signature).
6f9067
6f9067
Currently the only defined cryptographic signature format is an OpenPGP signature (RFC 4880),
6f9067
but others may be added in the future.  (The blob does not contain metadata identifying the
6f9067
cryptographic signature format. It is expected that most formats are sufficiently self-describing
6f9067
that this is not necessary and the configured expected public key provides another indication
6f9067
of the expected cryptographic signature format. Such metadata may be added in the future for
6f9067
newly added cryptographic signature formats, if necessary.)
6f9067
6f9067
Consumers of container signatures SHOULD verify the cryptographic signature
6f9067
against one or more trusted public keys
6f9067
(e.g. defined in a [policy.json signature verification policy file](policy.json.md))
6f9067
before parsing or processing the JSON payload in _any_ way,
6f9067
in particular they SHOULD stop processing the container signature
6f9067
if the cryptographic signature verification fails, without even starting to process the JSON payload.
6f9067
6f9067
(Consumers MAY extract identification of the signing key and other metadata from the cryptographic signature,
6f9067
and the JSON payload, without verifying the signature, if the purpose is to allow managing the signature blobs,
6f9067
e.g. to list the authors and image identities of signatures associated with a single container image;
6f9067
if so, they SHOULD design the output of such processing to minimize the risk of users considering the output trusted
6f9067
or in any way usable for making policy decisions about the image.)
6f9067
6f9067
### OpenPGP signature verification
6f9067
6f9067
When verifying a cryptographic signature in the OpenPGP format,
6f9067
the consumer MUST verify at least the following aspects of the signature
6f9067
(like the `github.com/containers/image/signature` package does):
6f9067
6f9067
- The blob MUST be a “Signed Message” as defined RFC 4880 section 11.3.
6f9067
  (e.g. it MUST NOT be an unsigned “Literal Message”, or any other non-signature format).
6f9067
- The signature MUST have been made by an expected key trusted for the purpose (and the specific container image).
6f9067
- The signature MUST be correctly formed and pass the cryptographic validation.
6f9067
- The signature MUST correctly authenticate the included JSON payload
6f9067
  (in particular, the parsing of the JSON payload MUST NOT start before the complete payload has been cryptographically authenticated).
6f9067
- The signature MUST NOT be expired.
6f9067
6f9067
The consumer SHOULD have tests for its verification code which verify that signatures failing any of the above are rejected.
6f9067
6f9067
## JSON processing and forward compatibility
6f9067
6f9067
The payload of the cryptographic signature is a JSON document (RFC 7159).
6f9067
Consumers SHOULD parse it very strictly,
6f9067
refusing any signature which violates the expected format (e.g. missing members, incorrect member types)
6f9067
or can be interpreted ambiguously (e.g. a duplicated member in a JSON object).
6f9067
6f9067
Any violations of the JSON format or of other requirements in this document MAY be accepted if the JSON document can be recognized
6f9067
to have been created by a known-incorrect implementation (see [`optional.creator`](#optionalcreator) below)
6f9067
and if the semantics of the invalid document, as created by such an implementation, is clear.
6f9067
6f9067
The top-level value of the JSON document MUST be a JSON object with exactly two members, `critical` and `optional`,
6f9067
each a JSON object.
6f9067
6f9067
The `critical` object MUST contain a `type` member identifying the document as a container signature
6f9067
(as defined [below](#criticaltype))
6f9067
and signature consumers MUST reject signatures which do not have this member or in which this member does not have the expected value.
6f9067
6f9067
To ensure forward compatibility (allowing older signature consumers to correctly
6f9067
accept or reject signatures created at a later date, with possible extensions to this format),
6f9067
consumers MUST reject the signature if the `critical` object, or _any_ of its subobjects,
6f9067
contain _any_ member or data value which is unrecognized, unsupported, invalid, or in any other way unexpected.
6f9067
At a minimum, this includes unrecognized members in a JSON object, or incorrect types of expected members.
6f9067
6f9067
For the same reason, consumers SHOULD accept any members with unrecognized names in the `optional` object,
6f9067
and MAY accept signatures where the object member is recognized but unsupported, or the value of the member is unsupported.
6f9067
Consumers still SHOULD reject signatures where a member of an `optional` object is supported but the value is recognized as invalid.
6f9067
6f9067
## JSON data format
6f9067
6f9067
An example of the full format follows, with detailed description below.
6f9067
To reiterate, consumers of the signature SHOULD perform successful cryptographic verification,
6f9067
and MUST reject unexpected data in the `critical` object, or in the top-level object, as described above.
6f9067
6f9067
```json
6f9067
{
6f9067
    "critical": {
6f9067
        "type": "atomic container signature",
6f9067
        "image": {
6f9067
            "docker-manifest-digest": "sha256:817a12c32a39bbe394944ba49de563e085f1d3c5266eb8e9723256bc4448680e"
6f9067
        },
6f9067
        "identity": {
6f9067
            "docker-reference": "docker.io/library/busybox:latest"
6f9067
        }
6f9067
    },
6f9067
    "optional": {
6f9067
        "creator": "some software package v1.0.1-35",
6f9067
        "timestamp": 1483228800,
6f9067
    }
6f9067
}
6f9067
```
6f9067
6f9067
### `critical`
6f9067
6f9067
This MUST be a JSON object which contains data critical to correctly evaluating the validity of a signature.
6f9067
6f9067
Consumers MUST reject any signature where the `critical` object contains any unrecognized, unsupported, invalid or in any other way unexpected member or data.
6f9067
6f9067
### `critical.type`
6f9067
6f9067
This MUST be a string with a string value exactly equal to `atomic container signature` (three words, including the spaces).
6f9067
6f9067
Signature consumers MUST reject signatures which do not have this member or this member does not have exactly the expected value.
6f9067
6f9067
(The consumers MAY support signatures with a different value of the `type` member, if any is defined in the future;
6f9067
if so, the rest of the JSON document is interpreted according to rules defining that value of `critical.type`,
6f9067
not by this document.)
6f9067
6f9067
### `critical.image`
6f9067
6f9067
This MUST be a JSON object which identifies the container image this signature applies to.
6f9067
6f9067
Consumers MUST reject any signature where the `critical.image` object contains any unrecognized, unsupported, invalid or in any other way unexpected member or data.
6f9067
6f9067
(Currently only the `docker-manifest-digest` way of identifying a container image is defined;
6f9067
alternatives to this may be defined in the future,
6f9067
but existing consumers are required to reject signatures which use formats they do not support.)
6f9067
6f9067
### `critical.image.docker-manifest-digest`
6f9067
6f9067
This MUST be a JSON string, in the `github.com/opencontainers/go-digest.Digest` string format.
6f9067
6f9067
The value of this member MUST match the manifest of the signed container image, as implemented in the docker/distribution manifest addressing system.
6f9067
6f9067
The consumer of the signature SHOULD verify the manifest digest against a fully verified signature before processing the contents of the image manifest in any other way
6f9067
(e.g. parsing the manifest further or downloading layers of the image).
6f9067
6f9067
Implementation notes:
6f9067
* A single container image manifest may have several valid manifest digest values, using different algorithms.
6f9067
* For “signed” [docker/distribution schema 1](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-1.md) manifests,
6f9067
the manifest digest applies to the payload of the JSON web signature, not to the raw manifest blob.
6f9067
6f9067
### `critical.identity`
6f9067
6f9067
This MUST be a JSON object which identifies the claimed identity of the image (usually the purpose of the image, or the application, along with a version information),
6f9067
as asserted by the author of the signature.
6f9067
6f9067
Consumers MUST reject any signature where the `critical.identity` object contains any unrecognized, unsupported, invalid or in any other way unexpected member or data.
6f9067
6f9067
(Currently only the `docker-reference` way of claiming an image identity/purpose is defined;
6f9067
alternatives to this may be defined in the future,
6f9067
but existing consumers are required to reject signatures which use formats they do not support.)
6f9067
6f9067
### `critical.identity.docker-reference`
6f9067
6f9067
This MUST be a JSON string, in the `github.com/docker/distribution/reference` string format,
6f9067
and using the same normalization semantics (where e.g. `busybox:latest` is equivalent to `docker.io/library/busybox:latest`).
6f9067
If the normalization semantics allows multiple string representations of the claimed identity with equivalent meaning,
6f9067
the `critical.identity.docker-reference` member SHOULD use the fully explicit form (including the full host name and namespaces).
6f9067
6f9067
The value of this member MUST match the image identity/purpose expected by the consumer of the image signature and the image
6f9067
(again, accounting for the `docker/distribution/reference` normalization semantics).
6f9067
6f9067
In the most common case, this means that the `critical.identity.docker-reference` value must be equal to the docker/distribution reference used to refer to or download the image.
6f9067
However, depending on the specific application, users or system administrators may accept less specific matches
6f9067
(e.g. ignoring the tag value in the signature when pulling the `:latest` tag or when referencing an image by digest),
6f9067
or they may require `critical.identity.docker-reference` values with a completely different namespace to the reference used to refer to/download the image
6f9067
(e.g. requiring a `critical.identity.docker-reference` value which identifies the image as coming from a supplier when fetching it from a company-internal mirror of approved images).
6f9067
The software performing this verification SHOULD allow the users to define such a policy using the [policy.json signature verification policy file format](policy.json.md).
6f9067
6f9067
The `critical.identity.docker-reference` value SHOULD contain either a tag or digest;
6f9067
in most cases, it SHOULD use a tag rather than a digest.  (See also the default [`matchRepoDigestOrExact` matching semantics in `policy.json`](policy.json.md#signedby).)
6f9067
6f9067
### `optional`
6f9067
6f9067
This MUST be a JSON object.
6f9067
6f9067
Consumers SHOULD accept any members with unrecognized names in the `optional` object,
6f9067
and MAY accept a signature where the object member is recognized but unsupported, or the value of the member is valid but unsupported.
6f9067
Consumers still SHOULD reject any signature where a member of an `optional` object is supported but the value is recognized as invalid.
6f9067
6f9067
### `optional.creator`
6f9067
6f9067
If present, this MUST be a JSON string, identifying the name and version of the software which has created the signature.
6f9067
6f9067
The contents of this string is not defined in detail; however each implementation creating container signatures:
6f9067
6f9067
- SHOULD define the contents to unambiguously define the software in practice (e.g. it SHOULD contain the name of the software, not only the version number)
6f9067
- SHOULD use a build and versioning process which ensures that the contents of this string (e.g. an included version number)
6f9067
  changes whenever the format or semantics of the generated signature changes in any way;
6f9067
  it SHOULD not be possible for two implementations which use a different format or semantics to have the same `optional.creator` value
6f9067
- SHOULD use a format which is reasonably easy to parse in software (perhaps using a regexp),
6f9067
  and which makes it easy enough to recognize a range of versions of a specific implementation
6f9067
  (e.g. the version of the implementation SHOULD NOT be only a git hash, because they don’t have an easily defined ordering;
6f9067
  the string should contain a version number, or at least a date of the commit).
6f9067
6f9067
Consumers of container signatures MAY recognize specific values or sets of values of `optional.creator`
6f9067
(perhaps augmented with `optional.timestamp`),
6f9067
and MAY change their processing of the signature based on these values
6f9067
(usually to acommodate violations of this specification in past versions of the signing software which cannot be fixed retroactively),
6f9067
as long as the semantics of the invalid document, as created by such an implementation, is clear.
6f9067
6f9067
If consumers of signatures do change their behavior based on the `optional.creator` value,
6f9067
they SHOULD take care that the way they process the signatures is not inconsistent with
6f9067
strictly validating signature consumers.
6f9067
(I.e. it is acceptable for a consumer to accept a signature based on a specific `optional.creator` value
6f9067
if other implementations would completely reject the signature,
6f9067
but it would be very undesirable for the two kinds of implementations to accept the signature in different
6f9067
and inconsistent situations.)
6f9067
6f9067
### `optional.timestamp`
6f9067
6f9067
If present, this MUST be a JSON number, which is representable as a 64-bit integer, and identifies the time when the signature was created
6f9067
as the number of seconds since the UNIX epoch (Jan 1 1970 00:00 UTC).