PodCertificateRequest certificates.k8s.io/v1beta1

Fields

apiVersion: certificates.k8s.io/v1beta1

kind: PodCertificateRequest

metadata (ObjectMeta)

metadata contains the object metadata.

spec (PodCertificateRequestSpec)

spec contains the details about the certificate being requested.

status (PodCertificateRequestStatus)

status contains the issued certificate, and a standard set of conditions.

PodCertificateRequestSpec

PodCertificateRequestSpec describes the certificate request. All fields are immutable after creation.

nodeName (string)

nodeName is the name of the node the pod is assigned to.

nodeUID (string)

nodeUID is the UID of the node the pod is assigned to.

podName (string)

podName is the name of the pod into which the certificate will be mounted.

podUID (string)

podUID is the UID of the pod into which the certificate will be mounted.

serviceAccountName (string)

serviceAccountName is the name of the service account the pod is running as.

serviceAccountUID (string)

serviceAccountUID is the UID of the service account the pod is running as.

signerName (string)

signerName indicates the requested signer.

All signer names beginning with kubernetes.io are reserved for use by the Kubernetes project. There is currently one well-known signer documented by the Kubernetes project, kubernetes.io/kube-apiserver-client-pod, which will issue client certificates understood by kube-apiserver. It is currently unimplemented.

stubPKCS10Request (string)

A PKCS#10 certificate signing request (DER-serialized) generated by Kubelet using the subject private key.

Most signer implementations will ignore the contents of the CSR except to extract the subject public key. The API server automatically verifies the CSR signature during admission, so the signer does not need to repeat the verification. CSRs generated by kubelet are completely empty.

The subject public key must be one of RSA3072, RSA4096, ECDSAP256, ECDSAP384, ECDSAP521, or ED25519. Note that this list may be expanded in the future.

Signer implementations do not need to support all key types supported by kube-apiserver and kubelet. If a signer does not support the key type used for a given PodCertificateRequest, it must deny the request by setting a status.conditions entry with a type of "Denied" and a reason of "UnsupportedKeyType". It may also suggest a key type that it does support in the message field.

maxExpirationSeconds (integer)

maxExpirationSeconds is the maximum lifetime permitted for the certificate.

If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).

The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.

pkixPublicKey (string)

The PKIX-serialized public key the signer will issue the certificate to.

The key must be one of RSA3072, RSA4096, ECDSAP256, ECDSAP384, ECDSAP521, or ED25519. Note that this list may be expanded in the future.

Signer implementations do not need to support all key types supported by kube-apiserver and kubelet. If a signer does not support the key type used for a given PodCertificateRequest, it must deny the request by setting a status.conditions entry with a type of "Denied" and a reason of "UnsupportedKeyType". It may also suggest a key type that it does support in the message field.

Deprecated: This field is replaced by StubPKCS10Request. If StubPKCS10Request is set, this field must be empty. Signer implementations should extract the public key from the StubPKCS10Request field.

proofOfPossession (string)

A proof that the requesting kubelet holds the private key corresponding to pkixPublicKey.

It is contructed by signing the ASCII bytes of the pod's UID using pkixPublicKey.

kube-apiserver validates the proof of possession during creation of the PodCertificateRequest.

If the key is an RSA key, then the signature is over the ASCII bytes of the pod UID, using RSASSA-PSS from RFC 8017 (as implemented by the golang function crypto/rsa.SignPSS with nil options).

If the key is an ECDSA key, then the signature is as described by SEC 1, Version 2.0 (as implemented by the golang library function crypto/ecdsa.SignASN1)

If the key is an ED25519 key, the the signature is as described by the ED25519 Specification (as implemented by the golang library crypto/ed25519.Sign).

Deprecated: This field is replaced by StubPKCS10Request. If StubPKCS10Request is set, this field must be empty.

unverifiedUserAnnotations (map[string]string)

unverifiedUserAnnotations allow pod authors to pass additional information to the signer implementation. Kubernetes does not restrict or validate this metadata in any way.

Entries are subject to the same validation as object metadata annotations, with the addition that all keys must be domain-prefixed. No restrictions are placed on values, except an overall size limitation on the entire field.

Signers should document the keys and values they support. Signers should deny requests that contain keys they do not recognize.

PodCertificateRequestStatus

PodCertificateRequestStatus describes the status of the request, and holds the certificate data if the request is issued.

beginRefreshAt (Time)

beginRefreshAt is the time at which the kubelet should begin trying to refresh the certificate. This field is set via the /status subresource, and must be set at the same time as certificateChain. Once populated, this field is immutable.

This field is only a hint. Kubelet may start refreshing before or after this time if necessary.

certificateChain (string)

certificateChain is populated with an issued certificate by the signer. This field is set via the /status subresource. Once populated, this field is immutable.

If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty.

Validation requirements:

1. certificateChain must consist of one or more PEM-formatted certificates.
2. Each entry must be a valid PEM-wrapped, DER-encoded ASN.1 Certificate as described in section 4 of RFC5280.

If more than one block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes. When projecting the chain into a pod volume, kubelet will drop any data in-between the PEM blocks, as well as any PEM block headers.

conditions ([]Condition)

conditions applied to the request.

The types "Issued", "Denied", and "Failed" have special handling. At most one of these conditions may be present, and they must have status "True".

If the request is denied with Reason=UnsupportedKeyType, the signer may suggest a key type that will work in the message field.

notAfter (Time)

notAfter is the time at which the certificate expires. The value must be the same as the notAfter value in the leaf certificate in certificateChain. This field is set via the /status subresource. Once populated, it is immutable. The signer must set this field at the same time it sets certificateChain.

notBefore (Time)

notBefore is the time at which the certificate becomes valid. The value must be the same as the notBefore value in the leaf certificate in certificateChain. This field is set via the /status subresource. Once populated, it is immutable. The signer must set this field at the same time it sets certificateChain.

PodCertificateRequestList

PodCertificateRequestList is a collection of PodCertificateRequest objects

apiVersion: certificates.k8s.io/v1beta1

kind: PodCertificateRequestList

metadata (ListMeta)

metadata contains the list metadata.

items ([]PodCertificateRequest)

items is a collection of PodCertificateRequest objects