From b1ee434ddfbd0de5d7af29e92ed9a880c4965c62 Mon Sep 17 00:00:00 2001 From: aram price Date: Mon, 14 Dec 2020 16:23:17 -0800 Subject: [PATCH] Rename in preparation for refactor --- cmd/pinniped-supervisor/main.go | 6 +-- .../symmetric_secret_helper.go | 38 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/cmd/pinniped-supervisor/main.go b/cmd/pinniped-supervisor/main.go index 6c87b43e..53eec937 100644 --- a/cmd/pinniped-supervisor/main.go +++ b/cmd/pinniped-supervisor/main.go @@ -171,7 +171,7 @@ func startControllers( rand.Reader, func(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) { plog.Debug("setting hmac secret", "issuer", parent.Spec.Issuer) - secretCache.SetTokenHMACKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SecretDataKey]) + secretCache.SetTokenHMACKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SymmetricSecretDataKey]) }, ), kubeClient, @@ -189,7 +189,7 @@ func startControllers( rand.Reader, func(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) { plog.Debug("setting state signature key", "issuer", parent.Spec.Issuer) - secretCache.SetStateEncoderHashKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SecretDataKey]) + secretCache.SetStateEncoderHashKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SymmetricSecretDataKey]) }, ), kubeClient, @@ -207,7 +207,7 @@ func startControllers( rand.Reader, func(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) { plog.Debug("setting state encryption key", "issuer", parent.Spec.Issuer) - secretCache.SetStateEncoderBlockKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SecretDataKey]) + secretCache.SetStateEncoderBlockKey(parent.Spec.Issuer, child.Data[symmetricsecrethelper.SymmetricSecretDataKey]) }, ), kubeClient, diff --git a/internal/controller/supervisorconfig/generator/symmetricsecrethelper/symmetric_secret_helper.go b/internal/controller/supervisorconfig/generator/symmetricsecrethelper/symmetric_secret_helper.go index f7baecf3..1d5c790c 100644 --- a/internal/controller/supervisorconfig/generator/symmetricsecrethelper/symmetric_secret_helper.go +++ b/internal/controller/supervisorconfig/generator/symmetricsecrethelper/symmetric_secret_helper.go @@ -18,25 +18,25 @@ import ( ) const ( - // SecretType is corev1.Secret.Type of all corev1.Secret's generated by this helper. - SecretType = "secrets.pinniped.dev/symmetric" - // SecretDataKey is the corev1.Secret.Data key for the symmetric key value generated by this helper. - SecretDataKey = "key" + // SymmetricSecretType is corev1.Secret.Type of all corev1.Secret's generated by this helper. + SymmetricSecretType = "secrets.pinniped.dev/symmetric" + // SymmetricSecretDataKey is the corev1.Secret.Data key for the symmetric key value generated by this helper. + SymmetricSecretDataKey = "key" - // keySize is the default length, in bytes, of generated keys. It is set to 32 since this + // symmetricKeySize is the default length, in bytes, of generated keys. It is set to 32 since this // seems like reasonable entropy for our keys, and a 32-byte key will allow for AES-256 // to be used in our codecs (see dynamiccodec.Codec). - keySize = 32 + symmetricKeySize = 32 ) -type helper struct { +type secretHelper struct { namePrefix string labels map[string]string rand io.Reader notifyFunc func(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) } -var _ generator.SecretHelper = &helper{} +var _ generator.SecretHelper = &secretHelper{} // New returns a SecretHelper that has been parameterized with common symmetric secret generation // knobs. @@ -46,7 +46,7 @@ func New( rand io.Reader, notifyFunc func(parent *configv1alpha1.OIDCProvider, child *corev1.Secret), ) generator.SecretHelper { - return &helper{ + return &secretHelper{ namePrefix: namePrefix, labels: labels, rand: rand, @@ -54,11 +54,11 @@ func New( } } -func (s *helper) Name() string { return s.namePrefix } +func (s *secretHelper) Name() string { return s.namePrefix } // Generate implements SecretHelper.Generate(). -func (s *helper) Generate(parent *configv1alpha1.OIDCProvider) (*corev1.Secret, error) { - key := make([]byte, keySize) +func (s *secretHelper) Generate(parent *configv1alpha1.OIDCProvider) (*corev1.Secret, error) { + key := make([]byte, symmetricKeySize) if _, err := s.rand.Read(key); err != nil { return nil, err } @@ -76,28 +76,28 @@ func (s *helper) Generate(parent *configv1alpha1.OIDCProvider) (*corev1.Secret, }), }, }, - Type: SecretType, + Type: SymmetricSecretType, Data: map[string][]byte{ - SecretDataKey: key, + SymmetricSecretDataKey: key, }, }, nil } // IsValid implements SecretHelper.IsValid(). -func (s *helper) IsValid(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) bool { +func (s *secretHelper) IsValid(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) bool { if !metav1.IsControlledBy(child, parent) { return false } - if child.Type != SecretType { + if child.Type != SymmetricSecretType { return false } - key, ok := child.Data[SecretDataKey] + key, ok := child.Data[SymmetricSecretDataKey] if !ok { return false } - if len(key) != keySize { + if len(key) != symmetricKeySize { return false } @@ -105,6 +105,6 @@ func (s *helper) IsValid(parent *configv1alpha1.OIDCProvider, child *corev1.Secr } // Notify implements SecretHelper.Notify(). -func (s *helper) Notify(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) { +func (s *secretHelper) Notify(parent *configv1alpha1.OIDCProvider, child *corev1.Secret) { s.notifyFunc(parent, child) }