Class PodCertificateRequestSpec
- java.lang.Object
-
- io.fabric8.kubernetes.api.model.certificates.v1beta1.PodCertificateRequestSpec
-
- All Implemented Interfaces:
Editable<PodCertificateRequestSpecBuilder>,KubernetesResource,Serializable
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator") public class PodCertificateRequestSpec extends Object implements Editable<PodCertificateRequestSpecBuilder>, KubernetesResource
PodCertificateRequestSpec describes the certificate request. All fields are immutable after creation.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PodCertificateRequestSpec()No args constructor for use in serializationPodCertificateRequestSpec(Integer maxExpirationSeconds, String nodeName, String nodeUID, String pkixPublicKey, String podName, String podUID, String proofOfPossession, String serviceAccountName, String serviceAccountUID, String signerName, String stubPKCS10Request, Map<String,String> unverifiedUserAnnotations)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PodCertificateRequestSpecBuilderedit()Map<String,Object>getAdditionalProperties()IntegergetMaxExpirationSeconds()maxExpirationSeconds is the maximum lifetime permitted for the certificate.StringgetNodeName()nodeName is the name of the node the pod is assigned to.StringgetNodeUID()nodeUID is the UID of the node the pod is assigned to.StringgetPkixPublicKey()The PKIX-serialized public key the signer will issue the certificate to.StringgetPodName()podName is the name of the pod into which the certificate will be mounted.StringgetPodUID()podUID is the UID of the pod into which the certificate will be mounted.StringgetProofOfPossession()A proof that the requesting kubelet holds the private key corresponding to pkixPublicKey.StringgetServiceAccountName()serviceAccountName is the name of the service account the pod is running as.StringgetServiceAccountUID()serviceAccountUID is the UID of the service account the pod is running as.StringgetSignerName()signerName indicates the requested signer.StringgetStubPKCS10Request()A PKCS#10 certificate signing request (DER-serialized) generated by Kubelet using the subject private key.Map<String,String>getUnverifiedUserAnnotations()unverifiedUserAnnotations allow pod authors to pass additional information to the signer implementation.voidsetAdditionalProperties(Map<String,Object> additionalProperties)voidsetAdditionalProperty(String name, Object value)voidsetMaxExpirationSeconds(Integer maxExpirationSeconds)maxExpirationSeconds is the maximum lifetime permitted for the certificate.voidsetNodeName(String nodeName)nodeName is the name of the node the pod is assigned to.voidsetNodeUID(String nodeUID)nodeUID is the UID of the node the pod is assigned to.voidsetPkixPublicKey(String pkixPublicKey)The PKIX-serialized public key the signer will issue the certificate to.voidsetPodName(String podName)podName is the name of the pod into which the certificate will be mounted.voidsetPodUID(String podUID)podUID is the UID of the pod into which the certificate will be mounted.voidsetProofOfPossession(String proofOfPossession)A proof that the requesting kubelet holds the private key corresponding to pkixPublicKey.voidsetServiceAccountName(String serviceAccountName)serviceAccountName is the name of the service account the pod is running as.voidsetServiceAccountUID(String serviceAccountUID)serviceAccountUID is the UID of the service account the pod is running as.voidsetSignerName(String signerName)signerName indicates the requested signer.voidsetStubPKCS10Request(String stubPKCS10Request)A PKCS#10 certificate signing request (DER-serialized) generated by Kubelet using the subject private key.voidsetUnverifiedUserAnnotations(Map<String,String> unverifiedUserAnnotations)unverifiedUserAnnotations allow pod authors to pass additional information to the signer implementation.PodCertificateRequestSpecBuildertoBuilder()
-
-
-
Constructor Detail
-
PodCertificateRequestSpec
public PodCertificateRequestSpec()
No args constructor for use in serialization
-
PodCertificateRequestSpec
public PodCertificateRequestSpec(Integer maxExpirationSeconds, String nodeName, String nodeUID, String pkixPublicKey, String podName, String podUID, String proofOfPossession, String serviceAccountName, String serviceAccountUID, String signerName, String stubPKCS10Request, Map<String,String> unverifiedUserAnnotations)
-
-
Method Detail
-
getMaxExpirationSeconds
public Integer getMaxExpirationSeconds()
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.
-
setMaxExpirationSeconds
public void setMaxExpirationSeconds(Integer 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.
-
getNodeName
public String getNodeName()
nodeName is the name of the node the pod is assigned to.
-
setNodeName
public void setNodeName(String nodeName)
nodeName is the name of the node the pod is assigned to.
-
getNodeUID
public String getNodeUID()
nodeUID is the UID of the node the pod is assigned to.
-
setNodeUID
public void setNodeUID(String nodeUID)
nodeUID is the UID of the node the pod is assigned to.
-
getPkixPublicKey
public String getPkixPublicKey()
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.
-
setPkixPublicKey
public void setPkixPublicKey(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.
-
getPodName
public String getPodName()
podName is the name of the pod into which the certificate will be mounted.
-
setPodName
public void setPodName(String podName)
podName is the name of the pod into which the certificate will be mounted.
-
getPodUID
public String getPodUID()
podUID is the UID of the pod into which the certificate will be mounted.
-
setPodUID
public void setPodUID(String podUID)
podUID is the UID of the pod into which the certificate will be mounted.
-
getProofOfPossession
public String getProofOfPossession()
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](https://www.secg.org/sec1-v2.pdf) (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](https://ed25519.cr.yp.to/) (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.
-
setProofOfPossession
public void setProofOfPossession(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](https://www.secg.org/sec1-v2.pdf) (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](https://ed25519.cr.yp.to/) (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.
-
getServiceAccountName
public String getServiceAccountName()
serviceAccountName is the name of the service account the pod is running as.
-
setServiceAccountName
public void setServiceAccountName(String serviceAccountName)
serviceAccountName is the name of the service account the pod is running as.
-
getServiceAccountUID
public String getServiceAccountUID()
serviceAccountUID is the UID of the service account the pod is running as.
-
setServiceAccountUID
public void setServiceAccountUID(String serviceAccountUID)
serviceAccountUID is the UID of the service account the pod is running as.
-
getSignerName
public String getSignerName()
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.
-
setSignerName
public void setSignerName(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.
-
getStubPKCS10Request
public String getStubPKCS10Request()
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.
-
setStubPKCS10Request
public void setStubPKCS10Request(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.
-
getUnverifiedUserAnnotations
public Map<String,String> getUnverifiedUserAnnotations()
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.
-
setUnverifiedUserAnnotations
public void setUnverifiedUserAnnotations(Map<String,String> 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.
-
edit
public PodCertificateRequestSpecBuilder edit()
- Specified by:
editin interfaceEditable<PodCertificateRequestSpecBuilder>
-
toBuilder
public PodCertificateRequestSpecBuilder toBuilder()
-
-