|
| 1 | +// |
| 2 | +// DISCLAIMER |
| 3 | +// |
| 4 | +// Copyright 2018 ArangoDB GmbH, Cologne, Germany |
| 5 | +// |
| 6 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | +// you may not use this file except in compliance with the License. |
| 8 | +// You may obtain a copy of the License at |
| 9 | +// |
| 10 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +// |
| 12 | +// Unless required by applicable law or agreed to in writing, software |
| 13 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | +// See the License for the specific language governing permissions and |
| 16 | +// limitations under the License. |
| 17 | +// |
| 18 | +// Copyright holder is ArangoDB GmbH, Cologne, Germany |
| 19 | +// |
| 20 | +// Author Ewout Prangsma |
| 21 | +// |
| 22 | + |
| 23 | +package resources |
| 24 | + |
| 25 | +import ( |
| 26 | + "crypto/sha256" |
| 27 | + "encoding/hex" |
| 28 | + "fmt" |
| 29 | + "sort" |
| 30 | + "strings" |
| 31 | + |
| 32 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 33 | + |
| 34 | + api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1alpha" |
| 35 | + "github.com/arangodb/kube-arangodb/pkg/util/k8sutil" |
| 36 | +) |
| 37 | + |
| 38 | +// ValidateSecretHashes checks the hash of used secrets |
| 39 | +// against the stored ones. |
| 40 | +// If a hash is different, the deployment is marked |
| 41 | +// with a SecretChangedCondition and the operator will no |
| 42 | +// touch it until this is resolved. |
| 43 | +func (r *Resources) ValidateSecretHashes() error { |
| 44 | + // validate performs a secret hash comparison for a single secret. |
| 45 | + // Return true if all is good, false when the SecretChanged condition |
| 46 | + // must be set. |
| 47 | + validate := func(secretName string, expectedHashRef *string, status *api.DeploymentStatus) (bool, error) { |
| 48 | + log := r.log.With().Str("secret-name", secretName).Logger() |
| 49 | + expectedHash := *expectedHashRef |
| 50 | + hash, err := r.getSecretHash(secretName) |
| 51 | + if expectedHash == "" { |
| 52 | + // No hash set yet, try to fill it |
| 53 | + if k8sutil.IsNotFound(err) { |
| 54 | + // Secret does not (yet) exists, do nothing |
| 55 | + return true, nil |
| 56 | + } |
| 57 | + if err != nil { |
| 58 | + log.Warn().Err(err).Msg("Failed to get secret") |
| 59 | + return true, nil // Since we do not yet have a hash, we let this go with only a warning. |
| 60 | + } |
| 61 | + // Hash fetched succesfully, store it |
| 62 | + *expectedHashRef = hash |
| 63 | + if r.context.UpdateStatus(*status); err != nil { |
| 64 | + log.Debug().Msg("Failed to save secret hash") |
| 65 | + return true, maskAny(err) |
| 66 | + } |
| 67 | + return true, nil |
| 68 | + } |
| 69 | + // Hash is set, it must match the current hash |
| 70 | + if err != nil { |
| 71 | + // Fetching error failed for other reason. |
| 72 | + log.Debug().Err(err).Msg("Failed to fetch secret hash") |
| 73 | + // This is not good, return false so SecretsChanged condition will be set. |
| 74 | + return false, nil |
| 75 | + } |
| 76 | + if hash != expectedHash { |
| 77 | + // Oops, hash has changed |
| 78 | + log.Error().Msg("Secret has changed. You must revert it to the original value!") |
| 79 | + // This is not good, return false so SecretsChanged condition will be set. |
| 80 | + return false, nil |
| 81 | + } |
| 82 | + // All good |
| 83 | + return true, nil |
| 84 | + } |
| 85 | + |
| 86 | + spec := r.context.GetSpec() |
| 87 | + log := r.log |
| 88 | + var badSecretNames []string |
| 89 | + status := r.context.GetStatus() |
| 90 | + if status.SecretHashes == nil { |
| 91 | + status.SecretHashes = &api.SecretHashes{} |
| 92 | + } |
| 93 | + hashes := status.SecretHashes |
| 94 | + if spec.IsAuthenticated() { |
| 95 | + secretName := spec.Authentication.GetJWTSecretName() |
| 96 | + if hashOK, err := validate(secretName, &hashes.AuthJWT, &status); err != nil { |
| 97 | + return maskAny(err) |
| 98 | + } else if !hashOK { |
| 99 | + badSecretNames = append(badSecretNames, secretName) |
| 100 | + } |
| 101 | + } |
| 102 | + if spec.RocksDB.IsEncrypted() { |
| 103 | + secretName := spec.RocksDB.Encryption.GetKeySecretName() |
| 104 | + if hashOK, err := validate(secretName, &hashes.RocksDBEncryptionKey, &status); err != nil { |
| 105 | + return maskAny(err) |
| 106 | + } else if !hashOK { |
| 107 | + badSecretNames = append(badSecretNames, secretName) |
| 108 | + } |
| 109 | + } |
| 110 | + if spec.IsSecure() { |
| 111 | + secretName := spec.TLS.GetCASecretName() |
| 112 | + if hashOK, err := validate(secretName, &hashes.TLSCA, &status); err != nil { |
| 113 | + return maskAny(err) |
| 114 | + } else if !hashOK { |
| 115 | + badSecretNames = append(badSecretNames, secretName) |
| 116 | + } |
| 117 | + } |
| 118 | + if spec.Sync.IsEnabled() { |
| 119 | + secretName := spec.Sync.TLS.GetCASecretName() |
| 120 | + if hashOK, err := validate(secretName, &hashes.SyncTLSCA, &status); err != nil { |
| 121 | + return maskAny(err) |
| 122 | + } else if !hashOK { |
| 123 | + badSecretNames = append(badSecretNames, secretName) |
| 124 | + } |
| 125 | + } |
| 126 | + |
| 127 | + if len(badSecretNames) > 0 { |
| 128 | + // We have invalid hashes, set the SecretsChanged condition |
| 129 | + if status.Conditions.Update(api.ConditionTypeSecretsChanged, true, |
| 130 | + "Secrets have changed", fmt.Sprintf("Found %d changed secrets", len(badSecretNames))) { |
| 131 | + log.Warn().Msgf("Found %d changed secrets. Settings SecretsChanged condition", len(badSecretNames)) |
| 132 | + if err := r.context.UpdateStatus(status); err != nil { |
| 133 | + log.Error().Err(err).Msg("Failed to save SecretsChanged condition") |
| 134 | + return maskAny(err) |
| 135 | + } |
| 136 | + // Add an event about this |
| 137 | + r.context.CreateEvent(k8sutil.NewSecretsChangedEvent(badSecretNames, r.context.GetAPIObject())) |
| 138 | + } |
| 139 | + } else { |
| 140 | + // All good, we van remove the SecretsChanged condition |
| 141 | + if status.Conditions.Remove(api.ConditionTypeSecretsChanged) { |
| 142 | + log.Warn().Msg("Resetting SecretsChanged condition") |
| 143 | + if err := r.context.UpdateStatus(status); err != nil { |
| 144 | + log.Error().Err(err).Msg("Failed to save SecretsChanged condition") |
| 145 | + return maskAny(err) |
| 146 | + } |
| 147 | + // Add an event about this |
| 148 | + r.context.CreateEvent(k8sutil.NewSecretsRestoredEvent(r.context.GetAPIObject())) |
| 149 | + } |
| 150 | + } |
| 151 | + |
| 152 | + return nil |
| 153 | +} |
| 154 | + |
| 155 | +// getSecretHash fetches a secret with given name and returns a hash over its value. |
| 156 | +func (r *Resources) getSecretHash(secretName string) (string, error) { |
| 157 | + kubecli := r.context.GetKubeCli() |
| 158 | + ns := r.context.GetNamespace() |
| 159 | + s, err := kubecli.CoreV1().Secrets(ns).Get(secretName, metav1.GetOptions{}) |
| 160 | + if err != nil { |
| 161 | + return "", maskAny(err) |
| 162 | + } |
| 163 | + // Create hash of value |
| 164 | + rows := make([]string, 0, len(s.Data)) |
| 165 | + for k, v := range s.Data { |
| 166 | + rows = append(rows, k+"="+hex.EncodeToString(v)) |
| 167 | + } |
| 168 | + // Sort so we're not detecting order differences |
| 169 | + sort.Strings(rows) |
| 170 | + data := strings.Join(rows, "\n") |
| 171 | + rawHash := sha256.Sum256([]byte(data)) |
| 172 | + hash := fmt.Sprintf("%0x", rawHash) |
| 173 | + return hash, nil |
| 174 | +} |
0 commit comments