Skip to content

fix: Reissue the certificates if their validity period differs from the expected one #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ldmonster merged 1 commit into from
Jan 19, 2026
Merged

fix: Reissue the certificates if their validity period differs from the expected one #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions common-hooks/tls-certificate/internal_tls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ func GenSelfSignedTLS(conf GenSelfSignedTLSHookConf) func(ctx context.Context, i
// 2.2) save new common ca in values
// 2.3) mark certificates to regenerate
if useCommonCA {
auth, err = getCommonCA(input, conf.CommonCAPath(), caOutdatedDuration)
auth, err = getCommonCA(input, conf.CommonCAPath(), caExpiryDuration, caOutdatedDuration)
if err != nil {
commonCACanonicalName := conf.CommonCACanonicalName

Expand Down Expand Up @@ -320,7 +320,7 @@ func GenSelfSignedTLS(conf GenSelfSignedTLSHookConf) func(ctx context.Context, i

// update certificate if less than 6 month left. We create certificate for 10 years, so it looks acceptable
// and we don't need to create Crontab schedule
caOutdated, err := isOutdatedCA(cert.CA, caOutdatedDuration)
caOutdated, err := isOutdatedCA(cert.CA, caExpiryDuration, caOutdatedDuration)
if err != nil {
input.Logger.Warn("is outdated ca", log.Err(err))
}
Expand All @@ -332,7 +332,7 @@ func GenSelfSignedTLS(conf GenSelfSignedTLSHookConf) func(ctx context.Context, i
caOutdated = true
}

certOutdated, err := isIrrelevantCert(cert.Cert, sans, certOutdatedDuration)
certOutdated, err := isIrrelevantCert(cert.Cert, sans, certExpiryDuration, certOutdatedDuration)
if err != nil {
input.Logger.Warn("is irrelevant cert", log.Err(err))
}
Expand Down Expand Up @@ -384,7 +384,7 @@ func convCertToValues(cert *certificate.Certificate) CertValues {
var ErrCertificateIsNotFound = errors.New("certificate is not found")
var ErrCAIsInvalidOrOutdated = errors.New("ca is invalid or outdated")

func getCommonCA(input *pkg.HookInput, valKey string, caOutdatedDuration time.Duration) (*certificate.Authority, error) {
func getCommonCA(input *pkg.HookInput, valKey string, caExpiryDuration, caOutdatedDuration time.Duration) (*certificate.Authority, error) {
auth := new(certificate.Authority)

ca, ok := input.Values.GetOk(valKey)
Expand All @@ -397,7 +397,7 @@ func getCommonCA(input *pkg.HookInput, valKey string, caOutdatedDuration time.Du
return nil, err
}

outdated, err := isOutdatedCA(auth.Cert, caOutdatedDuration)
outdated, err := isOutdatedCA(auth.Cert, caExpiryDuration, caOutdatedDuration)
if err != nil {
input.Logger.Error("is outdated ca", log.Err(err))

Expand Down Expand Up @@ -446,12 +446,16 @@ func generateNewSelfSignedTLS(input SelfSignedCertValues) (*certificate.Certific
}

// check certificate duration and SANs list
func isIrrelevantCert(certData []byte, desiredSANSs []string, certOutdatedDuration time.Duration) (bool, error) {
func isIrrelevantCert(certData []byte, desiredSANSs []string, certExpiryDuration, certOutdatedDuration time.Duration) (bool, error) {
cert, err := certificate.ParseCertificate(certData)
if err != nil {
return false, fmt.Errorf("parse certificate: %w", err)
}

if cert.NotAfter.Sub(cert.NotBefore) != certExpiryDuration {
return true, nil
}

if time.Until(cert.NotAfter) < certOutdatedDuration {
return true, nil
}
Expand Down Expand Up @@ -483,7 +487,7 @@ func isIrrelevantCert(certData []byte, desiredSANSs []string, certOutdatedDurati
return false, nil
}

func isOutdatedCA(ca []byte, caOutdatedDuration time.Duration) (bool, error) {
func isOutdatedCA(ca []byte, caExpiryDuration, caOutdatedDuration time.Duration) (bool, error) {
// Issue a new certificate if there is no CA in the secret.
// Without CA it is not possible to validate the certificate.
if len(ca) == 0 {
Expand All @@ -495,6 +499,10 @@ func isOutdatedCA(ca []byte, caOutdatedDuration time.Duration) (bool, error) {
return false, fmt.Errorf("parse certificate: %w", err)
}

if cert.NotAfter.Sub(cert.NotBefore) != caExpiryDuration {
return true, nil
}

if time.Until(cert.NotAfter) < caOutdatedDuration {
return true, nil
}
Expand Down
202 changes: 202 additions & 0 deletions common-hooks/tls-certificate/internal_tls_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,4 +445,206 @@ func Test_GenSelfSignedTLS(t *testing.T) {
err := tlscertificate.GenSelfSignedTLS(config)(context.Background(), input)
assert.NoError(t, err)
})

t.Run("wrong ca expiry duration in snapshot", func(t *testing.T) {
dc := mock.NewDependencyContainerMock(t)

snapshots := mock.NewSnapshotsMock(t)
snapshots.GetMock.When(tlscertificate.InternalTLSSnapshotKey).Then(
[]pkg.Snapshot{
mock.NewSnapshotMock(t).UnmarshalToMock.Set(func(v any) error {
ca, err := certificate.GenerateCA(
"cert-name",
certificate.WithKeyAlgo("ecdsa"),
certificate.WithKeySize(256),
certificate.WithCAExpiry((24*time.Hour)*365*10))

assert.NoError(t, err)

cert, err := certificate.GenerateSelfSignedCert(
"cert-name",
ca,
certificate.WithSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"example-webhook.d8-example-module.svc.cluster.local",
"example-webhook.d8-example-module.svc.127.0.0.1.sslip.io",
}...),
certificate.WithKeyAlgo("ecdsa"),
certificate.WithKeySize(256),
certificate.WithSigningDefaultExpiry((24*time.Hour)*365*10),
certificate.WithSigningDefaultUsage([]string{
"signing",
"key encipherment",
"requestheader-client",
}),
)

assert.NoError(t, err)

value := v.(*certificate.Certificate)
*value = *cert

return nil
}),
},
)

values := mock.NewOutputPatchableValuesCollectorMock(t)

values.GetMock.When("global.discovery.clusterDomain").Then(gjson.Result{Type: gjson.String, Str: "cluster.local"})
values.GetMock.When("global.modules.publicDomainTemplate").Then(gjson.Result{Type: gjson.String, Str: "%s.127.0.0.1.sslip.io"})

values.SetMock.Set(func(path string, v any) {
assert.Equal(t, "d8-example-module.internal.webhookCert", path)

values, ok := v.(tlscertificate.CertValues)
assert.True(t, ok)

assert.NotEmpty(t, values.CA)
assert.NotEmpty(t, values.Crt)
assert.NotEmpty(t, values.Key)

ca, err := certificate.ParseCertificate([]byte(values.CA))
assert.NoError(t, err)
assert.Equal(t, ca.NotAfter.Sub(ca.NotBefore), (24*time.Hour)*365)

cert, err := certificate.ParseCertificate([]byte(values.Crt))
assert.NoError(t, err)

assert.Equal(t, []string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"example-webhook.d8-example-module.svc.cluster.local",
"example-webhook.d8-example-module.svc.127.0.0.1.sslip.io",
}, cert.DNSNames)
})

var input = &pkg.HookInput{
Snapshots: snapshots,
Values: values,
DC: dc,
Logger: log.NewNop(),
}

config := tlscertificate.GenSelfSignedTLSHookConf{
CN: "cert-name",
TLSSecretName: "secret-webhook-cert",
Namespace: "some-namespace",
SANs: tlscertificate.DefaultSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"%CLUSTER_DOMAIN%://example-webhook.d8-example-module.svc",
"%PUBLIC_DOMAIN%://example-webhook.d8-example-module.svc",
}),
FullValuesPathPrefix: "d8-example-module.internal.webhookCert",
CAExpiryDuration: (24 * time.Hour) * 365,
}

err := tlscertificate.GenSelfSignedTLS(config)(context.Background(), input)
assert.NoError(t, err)
})

t.Run("wrong certificate expiry duration in snapshot", func(t *testing.T) {
dc := mock.NewDependencyContainerMock(t)

snapshots := mock.NewSnapshotsMock(t)
snapshots.GetMock.When(tlscertificate.InternalTLSSnapshotKey).Then(
[]pkg.Snapshot{
mock.NewSnapshotMock(t).UnmarshalToMock.Set(func(v any) error {
ca, err := certificate.GenerateCA(
"cert-name",
certificate.WithKeyAlgo("ecdsa"),
certificate.WithKeySize(256),
certificate.WithCAExpiry((24*time.Hour)*365*10))

assert.NoError(t, err)

cert, err := certificate.GenerateSelfSignedCert(
"cert-name",
ca,
certificate.WithSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"example-webhook.d8-example-module.svc.cluster.local",
"example-webhook.d8-example-module.svc.127.0.0.1.sslip.io",
}...),
certificate.WithKeyAlgo("ecdsa"),
certificate.WithKeySize(256),
certificate.WithSigningDefaultExpiry((24*time.Hour)*365*10),
certificate.WithSigningDefaultUsage([]string{
"signing",
"key encipherment",
"requestheader-client",
}),
)

assert.NoError(t, err)

value := v.(*certificate.Certificate)
*value = *cert

return nil
}),
},
)

values := mock.NewOutputPatchableValuesCollectorMock(t)

values.GetMock.When("global.discovery.clusterDomain").Then(gjson.Result{Type: gjson.String, Str: "cluster.local"})
values.GetMock.When("global.modules.publicDomainTemplate").Then(gjson.Result{Type: gjson.String, Str: "%s.127.0.0.1.sslip.io"})

values.SetMock.Set(func(path string, v any) {
assert.Equal(t, "d8-example-module.internal.webhookCert", path)

values, ok := v.(tlscertificate.CertValues)
assert.True(t, ok)

assert.NotEmpty(t, values.CA)
assert.NotEmpty(t, values.Crt)
assert.NotEmpty(t, values.Key)

cert, err := certificate.ParseCertificate([]byte(values.Crt))
assert.NoError(t, err)

assert.Equal(t, []string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"example-webhook.d8-example-module.svc.cluster.local",
"example-webhook.d8-example-module.svc.127.0.0.1.sslip.io",
}, cert.DNSNames)

assert.Equal(t, cert.NotAfter.Sub(cert.NotBefore), (24*time.Hour)*365)
})

var input = &pkg.HookInput{
Snapshots: snapshots,
Values: values,
DC: dc,
Logger: log.NewNop(),
}

config := tlscertificate.GenSelfSignedTLSHookConf{
CN: "cert-name",
TLSSecretName: "secret-webhook-cert",
Namespace: "some-namespace",
SANs: tlscertificate.DefaultSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"%CLUSTER_DOMAIN%://example-webhook.d8-example-module.svc",
"%PUBLIC_DOMAIN%://example-webhook.d8-example-module.svc",
}),
FullValuesPathPrefix: "d8-example-module.internal.webhookCert",
CertExpiryDuration: (24 * time.Hour) * 365,
}

err := tlscertificate.GenSelfSignedTLS(config)(context.Background(), input)
assert.NoError(t, err)
})
}