cert_manager.rs

use kube::CustomResource;
use serde::{Serialize, Deserialize};
use std::collections::BTreeMap;

/// Desired state of the Certificate resource.
#[derive(CustomResource, Serialize, Deserialize, Clone, Debug)]
#[kube(group = "cert-manager.io", version = "v1", kind = "Certificate", plural = "certificates")]
#[kube(namespaced)]
#[kube(status = "CertificateStatus")]
#[kube(schema = "disabled")]
pub struct CertificateSpec {
    /// AdditionalOutputFormats defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option on both the controller and webhook components.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub additionalOutputFormats: Vec<CertificateAdditionalOutputFormats>,
    /// CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4
    pub commonName: Option<String>,
    /// DNSNames is a list of DNS subjectAltNames to be set on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub dnsNames: Vec<String>,
    /// The requested 'duration' (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2/3 through its duration or `renewBefore` period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
    pub duration: Option<String>,
    /// EmailAddresses is a list of email subjectAltNames to be set on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub emailAddresses: Vec<String>,
    /// EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest
    pub encodeUsagesInRequest: Option<bool>,
    /// IPAddresses is a list of IP address subjectAltNames to be set on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub ipAddresses: Vec<String>,
    /// IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `usages`.
    pub isCA: Option<bool>,
    /// IssuerRef is a reference to the issuer for this certificate. If the `kind` field is not set, or set to `Issuer`, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the `kind` field is set to `ClusterIssuer`, a ClusterIssuer with the provided name will be used. The `name` field in this stanza is required at all times.
    pub issuerRef: CertificateIssuerRef,
    /// Keystores configures additional keystore output formats stored in the `secretName` Secret resource.
    pub keystores: Option<CertificateKeystores>,
    /// Options to control private keys used for the Certificate.
    pub privateKey: Option<CertificatePrivateKey>,
    /// How long before the currently issued certificate's expiry cert-manager should renew the certificate. The default is 2/3 of the issued certificate's duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
    pub renewBefore: Option<String>,
    /// revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`.
    pub revisionHistoryLimit: Option<i32>,
    /// SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.
    pub secretName: String,
    /// SecretTemplate defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.
    pub secretTemplate: Option<CertificateSecretTemplate>,
    /// Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).
    pub subject: Option<CertificateSubject>,
    /// URIs is a list of URI subjectAltNames to be set on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub uris: Vec<String>,
    /// Usages is the set of x509 usages that are requested for the certificate. Defaults to `digital signature` and `key encipherment` if not specified.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub usages: Vec<String>,
}

/// CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateAdditionalOutputFormats {
    /// Type is the name of the format type that should be written to the Certificate's target Secret.
    pub r#type: String,
}

/// IssuerRef is a reference to the issuer for this certificate. If the `kind` field is not set, or set to `Issuer`, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the `kind` field is set to `ClusterIssuer`, a ClusterIssuer with the provided name will be used. The `name` field in this stanza is required at all times.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateIssuerRef {
    /// Group of the resource being referred to.
    pub group: Option<String>,
    /// Kind of the resource being referred to.
    pub kind: Option<String>,
    /// Name of the resource being referred to.
    pub name: String,
}

/// Keystores configures additional keystore output formats stored in the `secretName` Secret resource.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateKeystores {
    /// JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource.
    pub jks: Option<CertificateKeystoresJks>,
    /// PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource.
    pub pkcs12: Option<CertificateKeystoresPkcs12>,
}

/// JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateKeystoresJks {
    /// Create enables JKS keystore creation for the Certificate. If true, a file named `keystore.jks` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will only be updated upon re-issuance. A file named `truststore.jks` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority
    pub create: bool,
    /// PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.
    pub passwordSecretRef: CertificateKeystoresJksPasswordSecretRef,
}

/// PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateKeystoresJksPasswordSecretRef {
    /// The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
    pub key: Option<String>,
    /// Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    pub name: String,
}

/// PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateKeystoresPkcs12 {
    /// Create enables PKCS12 keystore creation for the Certificate. If true, a file named `keystore.p12` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will only be updated upon re-issuance. A file named `truststore.p12` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority
    pub create: bool,
    /// PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.
    pub passwordSecretRef: CertificateKeystoresPkcs12PasswordSecretRef,
}

/// PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateKeystoresPkcs12PasswordSecretRef {
    /// The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
    pub key: Option<String>,
    /// Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    pub name: String,
}

/// Options to control private keys used for the Certificate.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificatePrivateKey {
    /// Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `RSA`,`Ed25519` or `ECDSA` If `algorithm` is specified and `size` is not provided, key size of 256 will be used for `ECDSA` key algorithm and key size of 2048 will be used for `RSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm.
    pub algorithm: Option<String>,
    /// The private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. If provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and PKCS#8, respectively. Defaults to `PKCS1` if not specified.
    pub encoding: Option<String>,
    /// RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target `spec.secretName`. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to Always, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is 'Never' for backward compatibility.
    pub rotationPolicy: Option<String>,
    /// Size is the key bit size of the corresponding private key for this certificate. If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed.
    pub size: Option<i64>,
}

/// SecretTemplate defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateSecretTemplate {
    /// Annotations is a key value map to be copied to the target Kubernetes Secret.
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub annotations: BTreeMap<String, String>,
    /// Labels is a key value map to be copied to the target Kubernetes Secret.
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub labels: BTreeMap<String, String>,
}

/// Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateSubject {
    /// Countries to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub countries: Vec<String>,
    /// Cities to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub localities: Vec<String>,
    /// Organizational Units to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub organizationalUnits: Vec<String>,
    /// Organizations to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub organizations: Vec<String>,
    /// Postal codes to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub postalCodes: Vec<String>,
    /// State/Provinces to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub provinces: Vec<String>,
    /// Serial number to be used on the Certificate.
    pub serialNumber: Option<String>,
    /// Street addresses to be used on the Certificate.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub streetAddresses: Vec<String>,
}

/// Status of the Certificate. This is set and managed automatically.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateStatus {
    /// List of status conditions to indicate the status of certificates. Known condition types are `Ready` and `Issuing`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub conditions: Vec<CertificateStatusConditions>,
    /// LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time.
    pub lastFailureTime: Option<String>,
    /// The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the `Issuing` condition is set to `True`. It will automatically unset this field when the Issuing condition is not set or False.
    pub nextPrivateKeySecretName: Option<String>,
    /// The expiration time of the certificate stored in the secret named by this resource in `spec.secretName`.
    pub notAfter: Option<String>,
    /// The time after which the certificate stored in the secret named by this resource in spec.secretName is valid.
    pub notBefore: Option<String>,
    /// RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled.
    pub renewalTime: Option<String>,
    /// The current 'revision' of the certificate as issued. 
 When a CertificateRequest resource is created, it will have the `cert-manager.io/certificate-revision` set to one greater than the current value of this field. 
 Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. 
 Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision's issuance by checking if the revision value in the annotation is greater than this field.
    pub revision: Option<i64>,
}

/// CertificateCondition contains condition information for an Certificate.
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct CertificateStatusConditions {
    /// LastTransitionTime is the timestamp corresponding to the last status change of this condition.
    pub lastTransitionTime: Option<String>,
    /// Message is a human readable description of the details of the last transition, complementing reason.
    pub message: Option<String>,
    /// If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate.
    pub observedGeneration: Option<i64>,
    /// Reason is a brief machine readable explanation for the condition's last transition.
    pub reason: Option<String>,
    /// Status of the condition, one of (`True`, `False`, `Unknown`).
    pub status: String,
    /// Type of the condition, known values are (`Ready`, `Issuing`).
    pub r#type: String,
}