ImageSignature [image.openshift.io/v1] - Image APIs | API reference

Specification
API endpoints
- /apis/image.openshift.io/v1/imagesignatures
- /apis/image.openshift.io/v1/imagesignatures/{name}

Description

ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required

type
content

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`conditions`	`array`	Conditions represent the latest available observations of a signature’s current state.
`conditions[]`	`object`	SignatureCondition describes an image signature condition of particular kind at particular probe time.
`content`	`string`	Required: An opaque binary string which is an image’s signature.
`created`	`Time`	If specified, it is the time of signature’s creation.
`imageIdentity`	`string`	A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").
`issuedBy`	`object`	SignatureIssuer holds information about an issuer of signing certificate or key.
`issuedTo`	`object`	SignatureSubject holds information about a person or entity who created the signature.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta_v3`
`signedClaims`	`object (string)`	Contains claims from the signature.
`type`	`string`	Required: Describes a type of stored blob.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

conditions

array

Conditions represent the latest available observations of a signature’s current state.

conditions[]

object

SignatureCondition describes an image signature condition of particular kind at particular probe time.

content

string

Required: An opaque binary string which is an image’s signature.

created

Time

If specified, it is the time of signature’s creation.

imageIdentity

string

A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").

issuedBy

object

SignatureIssuer holds information about an issuer of signing certificate or key.

issuedTo

object

SignatureSubject holds information about a person or entity who created the signature.

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v3

signedClaims

object (string)

Contains claims from the signature.

type

string

Required: Describes a type of stored blob.

.conditions

Description: Conditions represent the latest available observations of a signature’s current state.
Type: array

.conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type

object

Required

type
status

Property Type Description

Property	Type	Description
`lastProbeTime`	`Time`	Last time the condition was checked.
`lastTransitionTime`	`Time`	Last time the condition transit from one status to another.
`message`	`string`	Human readable message indicating details about last transition.
`reason`	`string`	(brief) reason for the condition’s last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of signature condition, Complete or Failed.

lastProbeTime

Time

Last time the condition was checked.

lastTransitionTime

Time

Last time the condition transit from one status to another.

message

string

Human readable message indicating details about last transition.

reason

string

(brief) reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of signature condition, Complete or Failed.

.issuedBy

Description: SignatureIssuer holds information about an issuer of signing certificate or key.
Type: object

Property Type Description

Property	Type	Description
`commonName`	`string`	Common name (e.g. openshift-signing-service).
`organization`	`string`	Organization name.

commonName

string

Common name (e.g. openshift-signing-service).

organization

string

Organization name.

.issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type

object

Required

publicKeyID

Property Type Description

Property	Type	Description
`commonName`	`string`	Common name (e.g. openshift-signing-service).
`organization`	`string`	Organization name.
`publicKeyID`	`string`	If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

commonName

string

Common name (e.g. openshift-signing-service).

organization

string

Organization name.

publicKeyID

string

If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

API endpoints

The following API endpoints are available:

/apis/image.openshift.io/v1/imagesignatures
- POST: create an ImageSignature
/apis/image.openshift.io/v1/imagesignatures/{name}
- DELETE: delete an ImageSignature

/apis/image.openshift.io/v1/imagesignatures

Table 1. Global query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create an ImageSignature

Table 2. Body parameters
Parameter	Type	Description
`body`	`ImageSignature` schema

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ImageSignature` schema
201 - Created	`ImageSignature` schema
202 - Accepted	`ImageSignature` schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/imagesignatures/{name}

Table 4. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ImageSignature

Table 5. Global query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`pretty`	`string`	If 'true', then the output is pretty printed.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

HTTP method: DELETE
Description: delete an ImageSignature

Table 6. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions` schema

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty