utils.go 26 KB

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