CertificateSigningRequestSpec

case class CertificateSigningRequestSpec(extra: Optional[Map[String, Vector[String]]], groups: Optional[Vector[String]], request: Chunk[Byte], signerName: String, uid: Optional[String], usages: Optional[Vector[String]], username: Optional[String])

CertificateSigningRequestSpec contains the certificate request.

CertificateSigningRequestSpec contains the certificate request.

Value Params
extra

extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

groups

groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

request

request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.

signerName

signerName indicates the requested signer, and is a qualified name. List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. Well-known Kubernetes signers are:

  1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager.
  2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.
  3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers Custom signerNames can also be specified. The signer defines:
  4. Trust distribution: how trust (CA bundles) are distributed.
  5. Permitted subjects: and behavior when a disallowed subject is requested.
  6. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested.
  7. Required, permitted, or forbidden key usages / extended key usages.
  8. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin.
  9. Whether or not requests for CA certificates are allowed.
uid

uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

usages

usages specifies a set of key usages requested in the issued certificate. Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"

username

username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getExtra: IO[K8sFailure, Map[String, Vector[String]]]

extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getGroups: IO[K8sFailure, Vector[String]]

groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getRequest: IO[K8sFailure, Chunk[Byte]]

request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.

request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.

This effect always succeeds, it is safe to use the field request directly.

def getSignerName: IO[K8sFailure, String]

signerName indicates the requested signer, and is a qualified name.

signerName indicates the requested signer, and is a qualified name.

List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector.

Well-known Kubernetes signers are:

  1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager.
  2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.
  3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager.

More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers

Custom signerNames can also be specified. The signer defines:

  1. Trust distribution: how trust (CA bundles) are distributed.
  2. Permitted subjects: and behavior when a disallowed subject is requested.
  3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested.
  4. Required, permitted, or forbidden key usages / extended key usages.
  5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin.
  6. Whether or not requests for CA certificates are allowed.

This effect always succeeds, it is safe to use the field signerName directly.

def getUid: IO[K8sFailure, String]

uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getUsages: IO[K8sFailure, Vector[String]]

usages specifies a set of key usages requested in the issued certificate.

usages specifies a set of key usages requested in the issued certificate.

Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth".

Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth".

Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getUsername: IO[K8sFailure, String]

username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product