Search or ask Docker

SignatureIdentity

SignatureIdentity schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

SignatureIdentity contains the properties of verified signatures for the image.
DockerReference

Type: string

DockerReference is the Docker image reference associated with the signature. This is an optional field only present in older hashedrecord signatures.
All schema constraints and annotations
{
  "description": "DockerReference is the Docker image reference associated with the signature.\nThis is an optional field only present in older hashedrecord signatures.",
  "type": "string"
}
Error

Type: string

Error contains error information if signature verification failed. Other fields will be empty in this case.
All schema constraints and annotations
{
  "description": "Error contains error information if signature verification failed.\nOther fields will be empty in this case.",
  "type": "string"
}
KnownSigner

Schema: KnownSignerIdentity

KnownSigner is an identifier for a special signer identity that is known to the implementation.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/KnownSignerIdentity",
  "description": "KnownSigner is an identifier for a special signer identity that is known to the implementation."
}
Name

Type: string

Name is a textual description summarizing the type of signature.
All schema constraints and annotations
{
  "description": "Name is a textual description summarizing the type of signature.",
  "type": "string"
}
SignatureType

Schema: SignatureType

SignatureType is the type of signature format. E.g. "bundle-v0.3" or "hashedrecord".
All schema constraints and annotations
{
  "$ref": "#/components/schemas/SignatureType",
  "description": "SignatureType is the type of signature format. E.g. \"bundle-v0.3\" or \"hashedrecord\"."
}
Signer

Schema: SignerIdentity

Signer contains information about the signer certificate used to sign the image.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/SignerIdentity",
  "description": "Signer contains information about the signer certificate used to sign the image."
}
Timestamps

Type: array

Timestamps contains a list of verified signed timestamps for the signature.
Array item

Schema: SignatureTimestamp

All schema constraints and annotations
{
  "description": "Timestamps contains a list of verified signed timestamps for the signature.",
  "items": {
    "$ref": "#/components/schemas/SignatureTimestamp"
  },
  "type": "array"
}
Warnings

Type: array

Warnings contains any warnings that occurred during signature verification. For example, if there was no internet connectivity and cached trust roots were used. Warning does not indicate a failed verification but may point to configuration issues.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Warnings contains any warnings that occurred during signature verification.\nFor example, if there was no internet connectivity and cached trust roots were used.\nWarning does not indicate a failed verification but may point to configuration issues.",
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "SignatureIdentity contains the properties of verified signatures for the image.",
  "properties": {
    "DockerReference": {
      "description": "DockerReference is the Docker image reference associated with the signature.\nThis is an optional field only present in older hashedrecord signatures.",
      "type": "string"
    },
    "Error": {
      "description": "Error contains error information if signature verification failed.\nOther fields will be empty in this case.",
      "type": "string"
    },
    "KnownSigner": {
      "$ref": "#/components/schemas/KnownSignerIdentity",
      "description": "KnownSigner is an identifier for a special signer identity that is known to the implementation."
    },
    "Name": {
      "description": "Name is a textual description summarizing the type of signature.",
      "type": "string"
    },
    "SignatureType": {
      "$ref": "#/components/schemas/SignatureType",
      "description": "SignatureType is the type of signature format. E.g. \"bundle-v0.3\" or \"hashedrecord\"."
    },
    "Signer": {
      "$ref": "#/components/schemas/SignerIdentity",
      "description": "Signer contains information about the signer certificate used to sign the image."
    },
    "Timestamps": {
      "description": "Timestamps contains a list of verified signed timestamps for the signature.",
      "items": {
        "$ref": "#/components/schemas/SignatureTimestamp"
      },
      "type": "array"
    },
    "Warnings": {
      "description": "Warnings contains any warnings that occurred during signature verification.\nFor example, if there was no internet connectivity and cached trust roots were used.\nWarning does not indicate a failed verification but may point to configuration issues.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}