utils.go 24 KB

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