utils.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package utils
  14. import (
  15. "bytes"
  16. "context"
  17. "crypto/sha3"
  18. "crypto/x509"
  19. "encoding/base64"
  20. "encoding/json"
  21. "encoding/pem"
  22. "errors"
  23. "fmt"
  24. "maps"
  25. "net"
  26. "net/url"
  27. "reflect"
  28. "regexp"
  29. "slices"
  30. "sort"
  31. "strconv"
  32. "strings"
  33. tpl "text/template"
  34. "time"
  35. "unicode"
  36. "github.com/go-logr/logr"
  37. corev1 "k8s.io/api/core/v1"
  38. discoveryv1 "k8s.io/api/discovery/v1"
  39. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  40. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  41. "sigs.k8s.io/controller-runtime/pkg/client"
  42. "sigs.k8s.io/controller-runtime/pkg/event"
  43. "sigs.k8s.io/controller-runtime/pkg/predicate"
  44. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  45. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  46. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  47. "github.com/external-secrets/external-secrets/pkg/template/v2"
  48. "github.com/external-secrets/external-secrets/pkg/utils/resolvers"
  49. )
  50. const (
  51. errParse = "unable to parse transform template: %s"
  52. errExecute = "unable to execute transform template: %s"
  53. )
  54. var (
  55. errAddressesNotReady = errors.New("addresses not ready")
  56. errEndpointSlicesNotReady = errors.New("endpointSlice objects not ready")
  57. errKeyNotFound = errors.New("key not found")
  58. unicodeRegex = regexp.MustCompile(`_U([0-9a-fA-F]{4,5})_`)
  59. )
  60. // JSONMarshal takes an interface and returns a new escaped and encoded byte slice.
  61. func JSONMarshal(t any) ([]byte, error) {
  62. buffer := &bytes.Buffer{}
  63. encoder := json.NewEncoder(buffer)
  64. encoder.SetEscapeHTML(false)
  65. err := encoder.Encode(t)
  66. return bytes.TrimRight(buffer.Bytes(), "\n"), err
  67. }
  68. // MergeByteMap merges map of byte slices.
  69. func MergeByteMap(dst, src map[string][]byte) map[string][]byte {
  70. for k, v := range src {
  71. dst[k] = v
  72. }
  73. return dst
  74. }
  75. func RewriteMap(operations []esv1.ExternalSecretRewrite, in map[string][]byte) (map[string][]byte, error) {
  76. out := in
  77. var err error
  78. for i, op := range operations {
  79. out, err = handleRewriteOperation(op, out)
  80. if err != nil {
  81. return nil, fmt.Errorf("failed rewrite operation[%v]: %w", i, err)
  82. }
  83. }
  84. return out, nil
  85. }
  86. func handleRewriteOperation(op esv1.ExternalSecretRewrite, in map[string][]byte) (map[string][]byte, error) {
  87. switch {
  88. case op.Merge != nil:
  89. return RewriteMerge(*op.Merge, in)
  90. case op.Regexp != nil:
  91. return RewriteRegexp(*op.Regexp, in)
  92. case op.Transform != nil:
  93. return RewriteTransform(*op.Transform, in)
  94. default:
  95. return in, nil
  96. }
  97. }
  98. // RewriteMerge merges input values according to the operation's strategy and conflict policy.
  99. func RewriteMerge(operation esv1.ExternalSecretRewriteMerge, in map[string][]byte) (map[string][]byte, error) {
  100. var out map[string][]byte
  101. mergedMap, conflicts, err := merge(operation, in)
  102. if err != nil {
  103. return nil, err
  104. }
  105. if operation.ConflictPolicy != esv1.ExternalSecretRewriteMergeConflictPolicyIgnore {
  106. if len(conflicts) > 0 {
  107. return nil, fmt.Errorf("merge failed with conflicts: %v", strings.Join(conflicts, ", "))
  108. }
  109. }
  110. switch operation.Strategy {
  111. case esv1.ExternalSecretRewriteMergeStrategyExtract, "":
  112. out = make(map[string][]byte)
  113. for k, v := range mergedMap {
  114. byteValue, err := GetByteValue(v)
  115. if err != nil {
  116. return nil, fmt.Errorf("merge failed with failed to convert value to []byte: %w", err)
  117. }
  118. out[k] = byteValue
  119. }
  120. case esv1.ExternalSecretRewriteMergeStrategyJSON:
  121. out = make(map[string][]byte)
  122. if operation.Into == "" {
  123. return nil, fmt.Errorf("merge failed with missing 'into' field")
  124. }
  125. mergedBytes, err := JSONMarshal(mergedMap)
  126. if err != nil {
  127. return nil, fmt.Errorf("merge failed with failed to marshal merged map: %w", err)
  128. }
  129. maps.Copy(out, in)
  130. out[operation.Into] = mergedBytes
  131. }
  132. return out, nil
  133. }
  134. // merge merges the input maps and returns the merged map and a list of conflicting keys.
  135. func merge(operation esv1.ExternalSecretRewriteMerge, in map[string][]byte) (map[string]any, []string, error) {
  136. mergedMap := make(map[string]any)
  137. conflicts := make([]string, 0)
  138. // sort keys with priority keys at the end in their specified order
  139. keys := sortKeysWithPriority(operation, in)
  140. for _, key := range keys {
  141. value, exists := in[key]
  142. if !exists {
  143. return nil, nil, fmt.Errorf("merge failed with key %q not found in input map", key)
  144. }
  145. var jsonMap map[string]any
  146. if err := json.Unmarshal(value, &jsonMap); err != nil {
  147. return nil, nil, fmt.Errorf("merge failed with failed to unmarshal JSON: %w", err)
  148. }
  149. for k, v := range jsonMap {
  150. if _, conflict := mergedMap[k]; conflict {
  151. conflicts = append(conflicts, k)
  152. }
  153. mergedMap[k] = v
  154. }
  155. }
  156. return mergedMap, conflicts, nil
  157. }
  158. // sortKeysWithPriority sorts keys with priority keys at the end in their specified order.
  159. // Non-priority keys are sorted alphabetically and placed before priority keys.
  160. func sortKeysWithPriority(operation esv1.ExternalSecretRewriteMerge, in map[string][]byte) []string {
  161. keys := make([]string, 0, len(in))
  162. for k := range in {
  163. if !slices.Contains(operation.Priority, k) {
  164. keys = append(keys, k)
  165. }
  166. }
  167. sort.Strings(keys)
  168. keys = append(keys, operation.Priority...)
  169. return keys
  170. }
  171. // RewriteRegexp rewrites a single Regexp Rewrite Operation.
  172. func RewriteRegexp(operation esv1.ExternalSecretRewriteRegexp, in map[string][]byte) (map[string][]byte, error) {
  173. out := make(map[string][]byte)
  174. re, err := regexp.Compile(operation.Source)
  175. if err != nil {
  176. return nil, fmt.Errorf("regexp failed with failed to compile: %w", err)
  177. }
  178. for key, value := range in {
  179. newKey := re.ReplaceAllString(key, operation.Target)
  180. out[newKey] = value
  181. }
  182. return out, nil
  183. }
  184. // RewriteTransform applies string transformation on each secret key name to rewrite.
  185. func RewriteTransform(operation esv1.ExternalSecretRewriteTransform, in map[string][]byte) (map[string][]byte, error) {
  186. out := make(map[string][]byte)
  187. for key, value := range in {
  188. data := map[string][]byte{
  189. "value": []byte(key),
  190. }
  191. result, err := transform(operation.Template, data)
  192. if err != nil {
  193. return nil, fmt.Errorf("transform failed with failed to transform key: %w", err)
  194. }
  195. newKey := string(result)
  196. out[newKey] = value
  197. }
  198. return out, nil
  199. }
  200. func transform(val string, data map[string][]byte) ([]byte, error) {
  201. strValData := make(map[string]string, len(data))
  202. for k := range data {
  203. strValData[k] = string(data[k])
  204. }
  205. t, err := tpl.New("transform").
  206. Funcs(template.FuncMap()).
  207. Parse(val)
  208. if err != nil {
  209. return nil, fmt.Errorf(errParse, err)
  210. }
  211. buf := bytes.NewBuffer(nil)
  212. err = t.Execute(buf, strValData)
  213. if err != nil {
  214. return nil, fmt.Errorf(errExecute, err)
  215. }
  216. return buf.Bytes(), nil
  217. }
  218. // DecodeMap decodes values from a secretMap.
  219. func DecodeMap(strategy esv1.ExternalSecretDecodingStrategy, in map[string][]byte) (map[string][]byte, error) {
  220. out := make(map[string][]byte, len(in))
  221. for k, v := range in {
  222. val, err := Decode(strategy, v)
  223. if err != nil {
  224. return nil, fmt.Errorf("failure decoding key %v: %w", k, err)
  225. }
  226. out[k] = val
  227. }
  228. return out, nil
  229. }
  230. func Decode(strategy esv1.ExternalSecretDecodingStrategy, in []byte) ([]byte, error) {
  231. switch strategy {
  232. case esv1.ExternalSecretDecodeBase64:
  233. out, err := base64.StdEncoding.DecodeString(string(in))
  234. if err != nil {
  235. return nil, err
  236. }
  237. return out, nil
  238. case esv1.ExternalSecretDecodeBase64URL:
  239. out, err := base64.URLEncoding.DecodeString(string(in))
  240. if err != nil {
  241. return nil, err
  242. }
  243. return out, nil
  244. case esv1.ExternalSecretDecodeNone:
  245. return in, nil
  246. // default when stored version is v1alpha1
  247. case "":
  248. return in, nil
  249. case esv1.ExternalSecretDecodeAuto:
  250. out, err := Decode(esv1.ExternalSecretDecodeBase64, in)
  251. if err != nil {
  252. out, err := Decode(esv1.ExternalSecretDecodeBase64URL, in)
  253. if err != nil {
  254. return Decode(esv1.ExternalSecretDecodeNone, in)
  255. }
  256. return out, nil
  257. }
  258. return out, nil
  259. default:
  260. return nil, fmt.Errorf("decoding strategy %v is not supported", strategy)
  261. }
  262. }
  263. // ValidateKeys checks if the keys in the secret map are valid keys for a Kubernetes secret.
  264. func ValidateKeys(log logr.Logger, in map[string][]byte) error {
  265. for key := range in {
  266. keyLength := len(key)
  267. if keyLength == 0 {
  268. delete(in, key)
  269. log.V(1).Info("key was deleted from the secret output because it did not exist upstream", "key", key)
  270. continue
  271. }
  272. if keyLength > 253 {
  273. return fmt.Errorf("key has length %d but max is 253: (following is truncated): %s", keyLength, key[:253])
  274. }
  275. for _, c := range key {
  276. if !unicode.IsLetter(c) && !unicode.IsNumber(c) && c != '-' && c != '.' && c != '_' {
  277. return fmt.Errorf("key has invalid character %c, only alphanumeric, '-', '.' and '_' are allowed: %s", c, key)
  278. }
  279. }
  280. }
  281. return nil
  282. }
  283. // ConvertKeys converts a secret map into a valid key.
  284. // Replaces any non-alphanumeric characters depending on convert strategy.
  285. func ConvertKeys(strategy esv1.ExternalSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error) {
  286. out := make(map[string][]byte, len(in))
  287. for k, v := range in {
  288. key := convert(strategy, k)
  289. if _, exists := out[key]; exists {
  290. return nil, fmt.Errorf("secret name collision during conversion: %s", key)
  291. }
  292. out[key] = v
  293. }
  294. return out, nil
  295. }
  296. func convert(strategy esv1.ExternalSecretConversionStrategy, str string) string {
  297. rs := []rune(str)
  298. newName := make([]string, len(rs))
  299. for rk, rv := range rs {
  300. if !unicode.IsNumber(rv) &&
  301. !unicode.IsLetter(rv) &&
  302. rv != '-' &&
  303. rv != '.' &&
  304. rv != '_' {
  305. switch strategy {
  306. case esv1.ExternalSecretConversionDefault:
  307. newName[rk] = "_"
  308. case esv1.ExternalSecretConversionUnicode:
  309. newName[rk] = fmt.Sprintf("_U%04x_", rv)
  310. default:
  311. newName[rk] = string(rv)
  312. }
  313. } else {
  314. newName[rk] = string(rv)
  315. }
  316. }
  317. return strings.Join(newName, "")
  318. }
  319. // ReverseKeys reverses a secret map into a valid key map as expected by push secrets.
  320. // Replaces the unicode encoded representation characters back to the actual unicode character depending on convert strategy.
  321. func ReverseKeys(strategy esv1alpha1.PushSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error) {
  322. out := make(map[string][]byte, len(in))
  323. for k, v := range in {
  324. key := reverse(strategy, k)
  325. if _, exists := out[key]; exists {
  326. return nil, fmt.Errorf("secret name collision during conversion: %s", key)
  327. }
  328. out[key] = v
  329. }
  330. return out, nil
  331. }
  332. func reverse(strategy esv1alpha1.PushSecretConversionStrategy, str string) string {
  333. switch strategy {
  334. case esv1alpha1.PushSecretConversionReverseUnicode:
  335. matches := unicodeRegex.FindAllStringSubmatchIndex(str, -1)
  336. for i := len(matches) - 1; i >= 0; i-- {
  337. match := matches[i]
  338. start := match[0]
  339. end := match[1]
  340. unicodeHex := str[match[2]:match[3]]
  341. unicodeInt, err := strconv.ParseInt(unicodeHex, 16, 32)
  342. if err != nil {
  343. continue // Skip invalid unicode representations
  344. }
  345. unicodeChar := fmt.Sprintf("%c", unicodeInt)
  346. str = str[:start] + unicodeChar + str[end:]
  347. }
  348. return str
  349. case esv1alpha1.PushSecretConversionNone:
  350. return str
  351. default:
  352. return str
  353. }
  354. }
  355. // MergeStringMap performs a deep clone from src to dest.
  356. func MergeStringMap(dest, src map[string]string) {
  357. for k, v := range src {
  358. dest[k] = v
  359. }
  360. }
  361. var (
  362. ErrUnexpectedKey = errors.New("unexpected key in data")
  363. ErrSecretType = errors.New("can not handle secret value with type")
  364. )
  365. func GetByteValueFromMap(data map[string]any, key string) ([]byte, error) {
  366. v, ok := data[key]
  367. if !ok {
  368. return nil, fmt.Errorf("%w: %s", ErrUnexpectedKey, key)
  369. }
  370. return GetByteValue(v)
  371. }
  372. func GetByteValue(v any) ([]byte, error) {
  373. switch t := v.(type) {
  374. case string:
  375. return []byte(t), nil
  376. case map[string]any:
  377. return json.Marshal(t)
  378. case []string:
  379. return []byte(strings.Join(t, "\n")), nil
  380. case json.RawMessage:
  381. return t, nil
  382. case []byte:
  383. return t, nil
  384. // also covers int and float32 due to json.Marshal
  385. case float64:
  386. return []byte(strconv.FormatFloat(t, 'f', -1, 64)), nil
  387. case json.Number:
  388. return []byte(t.String()), nil
  389. case []any:
  390. return json.Marshal(t)
  391. case bool:
  392. return []byte(strconv.FormatBool(t)), nil
  393. case nil:
  394. return []byte(nil), nil
  395. default:
  396. return nil, fmt.Errorf("%w: %T", ErrSecretType, t)
  397. }
  398. }
  399. // IsNil checks if an Interface is nil.
  400. func IsNil(i any) bool {
  401. if i == nil {
  402. return true
  403. }
  404. value := reflect.ValueOf(i)
  405. if value.Type().Kind() == reflect.Ptr {
  406. return value.IsNil()
  407. }
  408. return false
  409. }
  410. // ObjectHash calculates sha3 sum of the data contained in the secret.
  411. func ObjectHash(object any) string {
  412. textualVersion := fmt.Sprintf("%+v", object)
  413. return fmt.Sprintf("%x", sha3.Sum224([]byte(textualVersion)))
  414. }
  415. func ErrorContains(out error, want string) bool {
  416. if out == nil {
  417. return want == ""
  418. }
  419. if want == "" {
  420. return false
  421. }
  422. return strings.Contains(out.Error(), want)
  423. }
  424. var (
  425. errNamespaceNotAllowed = errors.New("namespace should either be empty or match the namespace of the SecretStore for a namespaced SecretStore")
  426. errRequireNamespace = errors.New("cluster scope requires namespace")
  427. )
  428. // ValidateSecretSelector just checks if the namespace field is present/absent
  429. // depending on the secret store type.
  430. // We MUST NOT check the name or key property here. It MAY be defaulted by the provider.
  431. func ValidateSecretSelector(store esv1.GenericStore, ref esmeta.SecretKeySelector) error {
  432. clusterScope := store.GetObjectKind().GroupVersionKind().Kind == esv1.ClusterSecretStoreKind
  433. if clusterScope && ref.Namespace == nil {
  434. return errRequireNamespace
  435. }
  436. if !clusterScope && ref.Namespace != nil && *ref.Namespace != store.GetNamespace() {
  437. return errNamespaceNotAllowed
  438. }
  439. return nil
  440. }
  441. // ValidateReferentSecretSelector allows
  442. // cluster scoped store without namespace
  443. // this should replace above ValidateServiceAccountSelector once all providers
  444. // support referent auth.
  445. func ValidateReferentSecretSelector(store esv1.GenericStore, ref esmeta.SecretKeySelector) error {
  446. clusterScope := store.GetObjectKind().GroupVersionKind().Kind == esv1.ClusterSecretStoreKind
  447. if !clusterScope && ref.Namespace != nil && *ref.Namespace != store.GetNamespace() {
  448. return errNamespaceNotAllowed
  449. }
  450. return nil
  451. }
  452. // ValidateServiceAccountSelector just checks if the namespace field is present/absent
  453. // depending on the secret store type.
  454. // We MUST NOT check the name or key property here. It MAY be defaulted by the provider.
  455. func ValidateServiceAccountSelector(store esv1.GenericStore, ref esmeta.ServiceAccountSelector) error {
  456. clusterScope := store.GetObjectKind().GroupVersionKind().Kind == esv1.ClusterSecretStoreKind
  457. if clusterScope && ref.Namespace == nil {
  458. return errRequireNamespace
  459. }
  460. if !clusterScope && ref.Namespace != nil && *ref.Namespace != store.GetNamespace() {
  461. return errNamespaceNotAllowed
  462. }
  463. return nil
  464. }
  465. // ValidateReferentServiceAccountSelector allows
  466. // cluster scoped store without namespace
  467. // this should replace above ValidateServiceAccountSelector once all providers
  468. // support referent auth.
  469. func ValidateReferentServiceAccountSelector(store esv1.GenericStore, ref esmeta.ServiceAccountSelector) error {
  470. clusterScope := store.GetObjectKind().GroupVersionKind().Kind == esv1.ClusterSecretStoreKind
  471. if !clusterScope && ref.Namespace != nil && *ref.Namespace != store.GetNamespace() {
  472. return errNamespaceNotAllowed
  473. }
  474. return nil
  475. }
  476. func NetworkValidate(endpoint string, timeout time.Duration) error {
  477. hostname, err := url.Parse(endpoint)
  478. if err != nil {
  479. return fmt.Errorf("could not parse url: %w", err)
  480. }
  481. host := hostname.Hostname()
  482. port := hostname.Port()
  483. if port == "" {
  484. port = "443"
  485. }
  486. url := fmt.Sprintf("%v:%v", host, port)
  487. conn, err := net.DialTimeout("tcp", url, timeout)
  488. if err != nil {
  489. return fmt.Errorf("error accessing external store: %w", err)
  490. }
  491. defer func() {
  492. _ = conn.Close()
  493. }()
  494. return nil
  495. }
  496. func Deref[V any](v *V) V {
  497. if v == nil {
  498. // Create zero value
  499. var res V
  500. return res
  501. }
  502. return *v
  503. }
  504. func Ptr[T any](i T) *T {
  505. return &i
  506. }
  507. func ConvertToType[T any](obj any) (T, error) {
  508. var v T
  509. data, err := json.Marshal(obj)
  510. if err != nil {
  511. return v, fmt.Errorf("failed to marshal object: %w", err)
  512. }
  513. if err = json.Unmarshal(data, &v); err != nil {
  514. return v, fmt.Errorf("failed to unmarshal object: %w", err)
  515. }
  516. return v, nil
  517. }
  518. // FetchValueFromMetadata fetches a key from a metadata if it exists. It will recursively look in
  519. // embedded values as well. Must be a unique key, otherwise it will just return the first
  520. // occurrence.
  521. func FetchValueFromMetadata[T any](key string, data *apiextensionsv1.JSON, def T) (t T, _ error) {
  522. if data == nil {
  523. return def, nil
  524. }
  525. m := map[string]any{}
  526. if err := json.Unmarshal(data.Raw, &m); err != nil {
  527. return t, fmt.Errorf("failed to parse JSON raw data: %w", err)
  528. }
  529. v, err := dig[T](key, m)
  530. if err != nil {
  531. if errors.Is(err, errKeyNotFound) {
  532. return def, nil
  533. }
  534. }
  535. return v, nil
  536. }
  537. func dig[T any](key string, data map[string]any) (t T, _ error) {
  538. if v, ok := data[key]; ok {
  539. c, k := v.(T)
  540. if !k {
  541. return t, fmt.Errorf("failed to convert value to the desired type; was: %T", v)
  542. }
  543. return c, nil
  544. }
  545. for _, v := range data {
  546. if ty, ok := v.(map[string]any); ok {
  547. return dig[T](key, ty)
  548. }
  549. }
  550. return t, errKeyNotFound
  551. }
  552. func CompareStringAndByteSlices(valueString *string, valueByte []byte) bool {
  553. if valueString == nil {
  554. return false
  555. }
  556. return bytes.Equal(valueByte, []byte(*valueString))
  557. }
  558. func ExtractSecretData(data esv1.PushSecretData, secret *corev1.Secret) ([]byte, error) {
  559. var (
  560. err error
  561. value []byte
  562. ok bool
  563. )
  564. if data.GetSecretKey() == "" {
  565. decodedMap := make(map[string]string)
  566. for k, v := range secret.Data {
  567. decodedMap[k] = string(v)
  568. }
  569. value, err = JSONMarshal(decodedMap)
  570. if err != nil {
  571. return nil, fmt.Errorf("failed to marshal secret data: %w", err)
  572. }
  573. } else {
  574. value, ok = secret.Data[data.GetSecretKey()]
  575. if !ok {
  576. return nil, fmt.Errorf("failed to find secret key in secret with key: %s", data.GetSecretKey())
  577. }
  578. }
  579. return value, nil
  580. }
  581. // CreateCertOpts contains options for a cert pool creation.
  582. type CreateCertOpts struct {
  583. CABundle []byte
  584. CAProvider *esv1.CAProvider
  585. StoreKind string
  586. Namespace string
  587. Client client.Client
  588. }
  589. // FetchCACertFromSource creates a CertPool using either a CABundle directly, or
  590. // a ConfigMap / Secret.
  591. func FetchCACertFromSource(ctx context.Context, opts CreateCertOpts) ([]byte, error) {
  592. if len(opts.CABundle) == 0 && opts.CAProvider == nil {
  593. return nil, nil
  594. }
  595. if len(opts.CABundle) > 0 {
  596. pem, err := base64decode(opts.CABundle)
  597. if err != nil {
  598. return nil, fmt.Errorf("failed to decode ca bundle: %w", err)
  599. }
  600. return pem, nil
  601. }
  602. if opts.CAProvider != nil &&
  603. opts.StoreKind == esv1.ClusterSecretStoreKind &&
  604. opts.CAProvider.Namespace == nil {
  605. return nil, errors.New("missing namespace on caProvider secret")
  606. }
  607. switch opts.CAProvider.Type {
  608. case esv1.CAProviderTypeSecret:
  609. cert, err := getCertFromSecret(ctx, opts.Client, opts.CAProvider, opts.StoreKind, opts.Namespace)
  610. if err != nil {
  611. return nil, fmt.Errorf("failed to get cert from secret: %w", err)
  612. }
  613. return cert, nil
  614. case esv1.CAProviderTypeConfigMap:
  615. cert, err := getCertFromConfigMap(ctx, opts.Namespace, opts.Client, opts.CAProvider)
  616. if err != nil {
  617. return nil, fmt.Errorf("failed to get cert from configmap: %w", err)
  618. }
  619. return cert, nil
  620. }
  621. return nil, fmt.Errorf("unsupported CA provider type: %s", opts.CAProvider.Type)
  622. }
  623. // GetTargetNamespaces extracts namespaces based on selectors.
  624. func GetTargetNamespaces(ctx context.Context, cl client.Client, namespaceList []string, lbs []*metav1.LabelSelector) ([]corev1.Namespace, error) {
  625. // make sure we don't alter the passed in slice.
  626. selectors := make([]*metav1.LabelSelector, 0, len(namespaceList)+len(lbs))
  627. for _, ns := range namespaceList {
  628. selectors = append(selectors, &metav1.LabelSelector{
  629. MatchLabels: map[string]string{
  630. "kubernetes.io/metadata.name": ns,
  631. },
  632. })
  633. }
  634. selectors = append(selectors, lbs...)
  635. var namespaces []corev1.Namespace
  636. namespaceSet := make(map[string]struct{})
  637. for _, selector := range selectors {
  638. labelSelector, err := metav1.LabelSelectorAsSelector(selector)
  639. if err != nil {
  640. return nil, fmt.Errorf("failed to convert label selector %s: %w", selector, err)
  641. }
  642. var nl corev1.NamespaceList
  643. err = cl.List(ctx, &nl, &client.ListOptions{LabelSelector: labelSelector})
  644. if err != nil {
  645. return nil, fmt.Errorf("failed to list namespaces by label selector %s: %w", selector, err)
  646. }
  647. for _, n := range nl.Items {
  648. if _, exist := namespaceSet[n.Name]; exist {
  649. continue
  650. }
  651. namespaceSet[n.Name] = struct{}{}
  652. namespaces = append(namespaces, n)
  653. }
  654. }
  655. return namespaces, nil
  656. }
  657. // NamespacePredicate can be used to watch for new or updated or deleted namespaces.
  658. func NamespacePredicate() predicate.Predicate {
  659. return predicate.Funcs{
  660. CreateFunc: func(e event.CreateEvent) bool {
  661. return true
  662. },
  663. UpdateFunc: func(e event.UpdateEvent) bool {
  664. if e.ObjectOld == nil || e.ObjectNew == nil {
  665. return false
  666. }
  667. return !reflect.DeepEqual(e.ObjectOld.GetLabels(), e.ObjectNew.GetLabels())
  668. },
  669. DeleteFunc: func(deleteEvent event.DeleteEvent) bool {
  670. return true
  671. },
  672. }
  673. }
  674. func base64decode(cert []byte) ([]byte, error) {
  675. if c, err := parseCertificateBytes(cert); err == nil {
  676. return c, nil
  677. }
  678. // try decoding and test for validity again...
  679. certificate, err := Decode(esv1.ExternalSecretDecodeAuto, cert)
  680. if err != nil {
  681. return nil, fmt.Errorf("failed to decode base64: %w", err)
  682. }
  683. return parseCertificateBytes(certificate)
  684. }
  685. func parseCertificateBytes(certBytes []byte) ([]byte, error) {
  686. block, _ := pem.Decode(certBytes)
  687. if block == nil {
  688. return nil, errors.New("failed to parse the new certificate, not valid pem data")
  689. }
  690. if _, err := x509.ParseCertificate(block.Bytes); err != nil {
  691. return nil, fmt.Errorf("failed to validate certificate: %w", err)
  692. }
  693. return certBytes, nil
  694. }
  695. func getCertFromSecret(ctx context.Context, c client.Client, provider *esv1.CAProvider, storeKind, namespace string) ([]byte, error) {
  696. secretRef := esmeta.SecretKeySelector{
  697. Name: provider.Name,
  698. Key: provider.Key,
  699. }
  700. if provider.Namespace != nil {
  701. secretRef.Namespace = provider.Namespace
  702. }
  703. cert, err := resolvers.SecretKeyRef(ctx, c, storeKind, namespace, &secretRef)
  704. if err != nil {
  705. return nil, fmt.Errorf("failed to resolve secret key ref: %w", err)
  706. }
  707. return []byte(cert), nil
  708. }
  709. func getCertFromConfigMap(ctx context.Context, namespace string, c client.Client, provider *esv1.CAProvider) ([]byte, error) {
  710. objKey := client.ObjectKey{
  711. Name: provider.Name,
  712. Namespace: namespace,
  713. }
  714. if provider.Namespace != nil {
  715. objKey.Namespace = *provider.Namespace
  716. }
  717. configMapRef := &corev1.ConfigMap{}
  718. err := c.Get(ctx, objKey, configMapRef)
  719. if err != nil {
  720. return nil, fmt.Errorf("failed to get caProvider secret %s: %w", objKey.Name, err)
  721. }
  722. val, ok := configMapRef.Data[provider.Key]
  723. if !ok {
  724. return nil, fmt.Errorf("failed to get caProvider configMap %s -> %s", objKey.Name, provider.Key)
  725. }
  726. return []byte(val), nil
  727. }
  728. func CheckEndpointSlicesReady(ctx context.Context, c client.Client, svcName, svcNamespace string) error {
  729. var sliceList discoveryv1.EndpointSliceList
  730. err := c.List(ctx, &sliceList,
  731. client.InNamespace(svcNamespace),
  732. client.MatchingLabels{"kubernetes.io/service-name": svcName},
  733. )
  734. if err != nil {
  735. return err
  736. }
  737. if len(sliceList.Items) == 0 {
  738. return errEndpointSlicesNotReady
  739. }
  740. readyAddresses := 0
  741. for _, slice := range sliceList.Items {
  742. for _, ep := range slice.Endpoints {
  743. if ep.Conditions.Ready != nil && *ep.Conditions.Ready {
  744. readyAddresses += len(ep.Addresses)
  745. }
  746. }
  747. }
  748. if readyAddresses == 0 {
  749. return errAddressesNotReady
  750. }
  751. return nil
  752. }