Class V1beta1PodCertificateRequestSpec

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

Inheritance

object

V1beta1PodCertificateRequestSpec

Implements

IEquatable<V1beta1PodCertificateRequestSpec>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: k8s.Models

Assembly: KubernetesClient.dll

Syntax

public record V1beta1PodCertificateRequestSpec : IEquatable<V1beta1PodCertificateRequestSpec>

Constructors

V1beta1PodCertificateRequestSpec()

Declaration

public V1beta1PodCertificateRequestSpec()

V1beta1PodCertificateRequestSpec(V1beta1PodCertificateRequestSpec)

Declaration

protected V1beta1PodCertificateRequestSpec(V1beta1PodCertificateRequestSpec original)

Parameters

Type	Name	Description
V1beta1PodCertificateRequestSpec	original

Properties

EqualityContract

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

MaxExpirationSeconds

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.

Declaration

[JsonPropertyName("maxExpirationSeconds")]
public int? MaxExpirationSeconds { get; set; }

Property Value

Type	Description
int?

NodeName

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

Declaration

[JsonPropertyName("nodeName")]
public string NodeName { get; set; }

Property Value

Type	Description
string

NodeUID

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

Declaration

[JsonPropertyName("nodeUID")]
public string NodeUID { get; set; }

Property Value

Type	Description
string

PkixPublicKey

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.

Declaration

[JsonPropertyName("pkixPublicKey")]
public byte[] PkixPublicKey { get; set; }

Property Value

Type	Description
byte[]

PodName

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

Declaration

[JsonPropertyName("podName")]
public string PodName { get; set; }

Property Value

Type	Description
string

PodUID

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

Declaration

[JsonPropertyName("podUID")]
public string PodUID { get; set; }

Property Value

Type	Description
string

ProofOfPossession

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.

Declaration

[JsonPropertyName("proofOfPossession")]
public byte[] ProofOfPossession { get; set; }

Property Value

Type	Description
byte[]

ServiceAccountName

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

Declaration

[JsonPropertyName("serviceAccountName")]
public string ServiceAccountName { get; set; }

Property Value

Type	Description
string

ServiceAccountUID

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

Declaration

[JsonPropertyName("serviceAccountUID")]
public string ServiceAccountUID { get; set; }

Property Value

Type	Description
string

SignerName

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.

Declaration

[JsonPropertyName("signerName")]
public string SignerName { get; set; }

Property Value

Type	Description
string

StubPKCS10Request

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.

Declaration

[JsonPropertyName("stubPKCS10Request")]
public byte[] StubPKCS10Request { get; set; }

Property Value

Type	Description
byte[]

UnverifiedUserAnnotations

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.

Declaration

[JsonPropertyName("unverifiedUserAnnotations")]
public IDictionary<string, string> UnverifiedUserAnnotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Methods

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

Equals(V1beta1PodCertificateRequestSpec?)

Declaration

public virtual bool Equals(V1beta1PodCertificateRequestSpec? other)

Parameters

Type	Name	Description
V1beta1PodCertificateRequestSpec	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Operators

operator ==(V1beta1PodCertificateRequestSpec?, V1beta1PodCertificateRequestSpec?)

Declaration

public static bool operator ==(V1beta1PodCertificateRequestSpec? left, V1beta1PodCertificateRequestSpec? right)

Parameters

Type	Name	Description
V1beta1PodCertificateRequestSpec	left
V1beta1PodCertificateRequestSpec	right

Returns

Type	Description
bool

operator !=(V1beta1PodCertificateRequestSpec?, V1beta1PodCertificateRequestSpec?)

Declaration

public static bool operator !=(V1beta1PodCertificateRequestSpec? left, V1beta1PodCertificateRequestSpec? right)

Parameters

Type	Name	Description
V1beta1PodCertificateRequestSpec	left
V1beta1PodCertificateRequestSpec	right

Returns

Type	Description
bool

Implements

IEquatable<T>