util

package
v1.6.0-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2021 License: Apache-2.0 Imports: 13 Imported by: 14

Documentation

Index

Constants

View Source 
const (
	// IssuerACME is the name of the ACME issuer
	IssuerACME string = "acme"
	// IssuerCA is the name of the simple issuer
	IssuerCA string = "ca"
	// IssuerVault is the name of the Vault issuer
	IssuerVault string = "vault"
	// IssuerSelfSigned is a self signing issuer
	IssuerSelfSigned string = "selfsigned"
	// IssuerVenafi uses Venafi Trust Protection Platform and Venafi Cloud
	IssuerVenafi string = "venafi"
)

Variables

View Source 
var Clock clock.Clock = clock.RealClock{}

Clock is defined as a package var so it can be stubbed out during tests.

Functions

func CertificateHasCondition 

func CertificateHasCondition(crt *cmapi.Certificate, c cmapi.CertificateCondition) bool

CertificateHasCondition will return true if the given Certificate has a condition matching the provided CertificateCondition. Only the Type and Status field will be used in the comparison, meaning that this function will return 'true' even if the Reason, Message and LastTransitionTime fields do not match.

func CertificateHasConditionWithObservedGeneration added in v1.5.1 

func CertificateHasConditionWithObservedGeneration(crt *cmapi.Certificate, c cmapi.CertificateCondition) bool

CertificateHasConditionWithObservedGeneration will return true if the given Certificate has a condition matching the provided CertificateCondition with a ObservedGeneration that is bigger or equal to the ObservedGeneration of the provided CertificateCondition. Only the Type, Status and ObservedGeneration field will be used in the comparison, meaning that this function will return 'true' even if the Reason, Message and LastTransitionTime fields do not match.

func CertificateRequestHasCondition added in v0.9.0 

func CertificateRequestHasCondition(cr *cmapi.CertificateRequest, c cmapi.CertificateRequestCondition) bool

CertificateRequestHasCondition will return true if the given CertificateRequest has a condition matching the provided CertificateRequestCondition. Only the Type and Status field will be used in the comparison, meaning that this function will return 'true' even if the Reason, Message and LastTransitionTime fields do not match.

func CertificateRequestHasInvalidRequest added in v0.13.0 

func CertificateRequestHasInvalidRequest(cr *cmapi.CertificateRequest) bool

This returns with true if the CertificateRequest contains an InvalidRequest condition, and returns false otherwise.

func CertificateRequestInvalidRequestMessage added in v0.13.0 

func CertificateRequestInvalidRequestMessage(cr *cmapi.CertificateRequest) string

This returns with the message if the CertificateRequest contains an InvalidRequest condition, and returns "" otherwise.

func CertificateRequestIsApproved added in v1.3.0 

func CertificateRequestIsApproved(cr *cmapi.CertificateRequest) bool

CertificateRequestIsApproved returns true if the CertificateRequest is approved via an Approved condition of status `True`, returns false otherwise.

func CertificateRequestIsDenied added in v1.3.0 

func CertificateRequestIsDenied(cr *cmapi.CertificateRequest) bool

CertificateRequestIsDenied returns true if the CertificateRequest is denied via a Denied condition of status `True`, returns false otherwise.

func CertificateRequestReadyReason added in v0.10.0 

func CertificateRequestReadyReason(cr *cmapi.CertificateRequest) string

This returns the status reason of a CertificateRequest. The order of reason hierarchy is 'Failed' -> 'Ready' -> 'Pending' -> ”

func ComputeName added in v1.0.0 

func ComputeName(prefix string, obj interface{}) (string, error)

func DNSSafeShortenTo52Characters added in v1.0.0 

func DNSSafeShortenTo52Characters(in string) string

func DefaultCertDuration added in v0.10.0 

func DefaultCertDuration(d *metav1.Duration) time.Duration

DefaultCertDuration returns d.Duration if set, otherwise returns cert-manager's default certificate duration (90 days).

func ExtKeyUsageStrings added in v0.12.0 

func ExtKeyUsageStrings(usage []x509.ExtKeyUsage) []cmapi.KeyUsage

ExtKeyUsageStrings returns the cmapi.KeyUsage and "unknown" if not found

func ExtKeyUsageType added in v0.10.0 

func ExtKeyUsageType(usage cmapi.KeyUsage) (x509.ExtKeyUsage, bool)

ExtKeyUsageType returns the relevant x509.ExtKeyUsage or false if not found

func ExtKeyUsageTypeKube added in v1.4.0 

func ExtKeyUsageTypeKube(usage certificatesv1.KeyUsage) (x509.ExtKeyUsage, bool)

ExtKeyUsageTypeKube returns the relevant x509.KeyUsage or false if not found

func GetCertificateCondition added in v0.15.0 

func GetCertificateCondition(crt *cmapi.Certificate, conditionType cmapi.CertificateConditionType) *cmapi.CertificateCondition

func GetCertificateRequestCondition added in v0.15.0 

func GetCertificateRequestCondition(req *cmapi.CertificateRequest, conditionType cmapi.CertificateRequestConditionType) *cmapi.CertificateRequestCondition

func IssuerHasCondition 

func IssuerHasCondition(i cmapi.GenericIssuer, c cmapi.IssuerCondition) bool

IssuerHasCondition will return true if the given GenericIssuer has a condition matching the provided IssuerCondition. Only the Type and Status field will be used in the comparison, meaning that this function will return 'true' even if the Reason, Message and LastTransitionTime fields do not match.

func IssuerKind added in v0.10.0 

func IssuerKind(ref cmmeta.ObjectReference) string

IssuerKind returns the kind of issuer for a certificate.

func KeyUsageStrings added in v0.12.0 

func KeyUsageStrings(usage x509.KeyUsage) []cmapi.KeyUsage

KeyUsageStrings returns the cmapi.KeyUsage and "unknown" if not found

func KeyUsageType added in v0.10.0 

func KeyUsageType(usage cmapi.KeyUsage) (x509.KeyUsage, bool)

KeyUsageType returns the relevant x509.KeyUsage or false if not found

func KeyUsageTypeKube added in v1.4.0 

func KeyUsageTypeKube(usage certificatesv1.KeyUsage) (x509.KeyUsage, bool)

KeyUsageTypeKube returns the relevant x509.KeyUsage or false if not found

func KubeExtKeyUsageStrings added in v1.5.1 

func KubeExtKeyUsageStrings(usage []x509.ExtKeyUsage) []certificatesv1.KeyUsage

ExtKeyUsageStrings returns the certificatesv1.KeyUsage and "unknown" if not found

func KubeKeyUsageStrings added in v1.5.1 

func KubeKeyUsageStrings(usage x509.KeyUsage) []certificatesv1.KeyUsage

KubeKeyUsageStrings returns the certificatesv1.KeyUsage and "unknown" if not found

func NameForIssuer 

func NameForIssuer(i cmapi.GenericIssuer) (string, error)

NameForIssuer determines the name of the Issuer implementation given an Issuer resource.

func RemoveCertificateCondition added in v0.15.0 

func RemoveCertificateCondition(crt *cmapi.Certificate, conditionType cmapi.CertificateConditionType)

RemoveCertificateCondition will remove any condition with this condition type

func SetCertificateCondition 

func SetCertificateCondition(crt *cmapi.Certificate, observedGeneration int64, conditionType cmapi.CertificateConditionType,
	status cmmeta.ConditionStatus, reason, message string)

SetCertificateCondition will set a 'condition' on the given Certificate.

  • If no condition of the same type already exists, the condition will be inserted with the LastTransitionTime set to the current time.
  • If a condition of the same type and state already exists, the condition will be updated but the LastTransitionTime will not be modified.
  • If a condition of the same type and different state already exists, the condition will be updated with the LastTransitionTime set to the current time.

The given ObservedGeneration will always set on the condition, whether the lastTransitionTime is modified or not.

func SetCertificateRequestCondition added in v0.9.0 

func SetCertificateRequestCondition(cr *cmapi.CertificateRequest, conditionType cmapi.CertificateRequestConditionType, status cmmeta.ConditionStatus, reason, message string)

SetCertificateRequestCondition will set a 'condition' on the given CertificateRequest.

  • If no condition of the same type already exists, the condition will be inserted with the LastTransitionTime set to the current time.
  • If a condition of the same type and state already exists, the condition will be updated but the LastTransitionTime will not be modified.
  • If a condition of the same type and different state already exists, the condition will be updated and the LastTransitionTime set to the current time.

func SetIssuerCondition 

func SetIssuerCondition(i cmapi.GenericIssuer, observedGeneration int64, conditionType cmapi.IssuerConditionType, status cmmeta.ConditionStatus, reason, message string)

SetIssuerCondition will set a 'condition' on the given GenericIssuer.

  • If no condition of the same type already exists, the condition will be inserted with the LastTransitionTime set to the current time.
  • If a condition of the same type and state already exists, the condition will be updated but the LastTransitionTime will not be modified.
  • If a condition of the same type and different state already exists, the condition will be updated and the LastTransitionTime set to the current time.

This function works with both Issuer and ClusterIssuer resources.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.