onepassword.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  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 onepassword
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. "net/url"
  18. "slices"
  19. "sort"
  20. "strings"
  21. "time"
  22. "github.com/1Password/connect-sdk-go/connect"
  23. "github.com/1Password/connect-sdk-go/onepassword"
  24. corev1 "k8s.io/api/core/v1"
  25. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  26. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  27. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  28. "github.com/external-secrets/external-secrets/pkg/find"
  29. "github.com/external-secrets/external-secrets/pkg/utils"
  30. "github.com/external-secrets/external-secrets/pkg/utils/metadata"
  31. "github.com/external-secrets/external-secrets/pkg/utils/resolvers"
  32. )
  33. const (
  34. userAgent = "external-secrets"
  35. errOnePasswordStore = "received invalid 1Password SecretStore resource: %w"
  36. errOnePasswordStoreNilSpec = "nil spec"
  37. errOnePasswordStoreNilSpecProvider = "nil spec.provider"
  38. errOnePasswordStoreNilSpecProviderOnePassword = "nil spec.provider.onepassword"
  39. errOnePasswordStoreMissingRefName = "missing: spec.provider.onepassword.auth.secretRef.connectTokenSecretRef.name"
  40. errOnePasswordStoreMissingRefKey = "missing: spec.provider.onepassword.auth.secretRef.connectTokenSecretRef.key"
  41. errOnePasswordStoreAtLeastOneVault = "must be at least one vault: spec.provider.onepassword.vaults"
  42. errOnePasswordStoreInvalidConnectHost = "unable to parse URL: spec.provider.onepassword.connectHost: %w"
  43. errOnePasswordStoreNonUniqueVaultNumbers = "vault order numbers must be unique"
  44. errGetVault = "error finding 1Password Vault: %w"
  45. errGetItem = "error finding 1Password Item: %w"
  46. errUpdateItem = "error updating 1Password Item: %w"
  47. errDocumentNotFound = "error finding 1Password Document: %w"
  48. errTagsNotImplemented = "'find.tags' is not implemented in the 1Password provider"
  49. errVersionNotImplemented = "'remoteRef.version' is not implemented in the 1Password provider"
  50. errCreateItem = "error creating 1Password Item: %w"
  51. errDeleteItem = "error deleting 1Password Item: %w"
  52. // custom error messages.
  53. errKeyNotFoundMsg = "key not found in 1Password Vaults"
  54. errNoVaultsMsg = "no vaults found"
  55. errMetadataVaultNotinProvider = "metadata vault '%s' not in provider vaults"
  56. errExpectedOneItemMsg = "expected one 1Password Item matching"
  57. errExpectedOneFieldMsg = "expected one 1Password ItemField matching"
  58. errExpectedOneFieldMsgF = "%w: '%s' in '%s', got %d"
  59. documentCategory = "DOCUMENT"
  60. fieldPrefix = "field"
  61. filePrefix = "file"
  62. prefixSplitter = "/"
  63. )
  64. // Custom Errors //.
  65. var (
  66. // ErrKeyNotFound is returned when a key is not found in the 1Password Vaults.
  67. ErrKeyNotFound = errors.New(errKeyNotFoundMsg)
  68. // ErrNoVaults is returned when no vaults are found in the 1Password provider.
  69. ErrNoVaults = errors.New(errNoVaultsMsg)
  70. // ErrExpectedOneField is returned when more than 1 field is found in the 1Password Vaults.
  71. ErrExpectedOneField = errors.New(errExpectedOneFieldMsg)
  72. // ErrExpectedOneItem is returned when more than 1 item is found in the 1Password Vaults.
  73. ErrExpectedOneItem = errors.New(errExpectedOneItemMsg)
  74. )
  75. // ProviderOnePassword is a provider for 1Password.
  76. type ProviderOnePassword struct {
  77. vaults map[string]int
  78. client connect.Client
  79. }
  80. type PushSecretMetadataSpec struct {
  81. Tags []string `json:"tags,omitempty"`
  82. Vault string `json:"vault,omitempty"`
  83. }
  84. // https://github.com/external-secrets/external-secrets/issues/644
  85. var (
  86. _ esv1beta1.SecretsClient = &ProviderOnePassword{}
  87. _ esv1beta1.Provider = &ProviderOnePassword{}
  88. )
  89. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  90. func (provider *ProviderOnePassword) Capabilities() esv1beta1.SecretStoreCapabilities {
  91. return esv1beta1.SecretStoreReadOnly
  92. }
  93. // NewClient constructs a 1Password Provider.
  94. func (provider *ProviderOnePassword) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.SecretsClient, error) {
  95. config := store.GetSpec().Provider.OnePassword
  96. token, err := resolvers.SecretKeyRef(
  97. ctx,
  98. kube,
  99. store.GetKind(),
  100. namespace,
  101. &config.Auth.SecretRef.ConnectToken,
  102. )
  103. if err != nil {
  104. return nil, err
  105. }
  106. provider.client = connect.NewClientWithUserAgent(config.ConnectHost, token, userAgent)
  107. provider.vaults = config.Vaults
  108. return provider, nil
  109. }
  110. // ValidateStore checks if the provided store is valid.
  111. func (provider *ProviderOnePassword) ValidateStore(store esv1beta1.GenericStore) (admission.Warnings, error) {
  112. return nil, validateStore(store)
  113. }
  114. func validateStore(store esv1beta1.GenericStore) error {
  115. // check nils
  116. storeSpec := store.GetSpec()
  117. if storeSpec == nil {
  118. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNilSpec))
  119. }
  120. if storeSpec.Provider == nil {
  121. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNilSpecProvider))
  122. }
  123. if storeSpec.Provider.OnePassword == nil {
  124. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNilSpecProviderOnePassword))
  125. }
  126. // check mandatory fields
  127. config := storeSpec.Provider.OnePassword
  128. if config.Auth.SecretRef.ConnectToken.Name == "" {
  129. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreMissingRefName))
  130. }
  131. if config.Auth.SecretRef.ConnectToken.Key == "" {
  132. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreMissingRefKey))
  133. }
  134. // check namespace compared to kind
  135. if err := utils.ValidateSecretSelector(store, config.Auth.SecretRef.ConnectToken); err != nil {
  136. return fmt.Errorf(errOnePasswordStore, err)
  137. }
  138. // check at least one vault
  139. if len(config.Vaults) == 0 {
  140. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreAtLeastOneVault))
  141. }
  142. // ensure vault numbers are unique
  143. if !hasUniqueVaultNumbers(config.Vaults) {
  144. return fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNonUniqueVaultNumbers))
  145. }
  146. // check valid URL
  147. if _, err := url.Parse(config.ConnectHost); err != nil {
  148. return fmt.Errorf(errOnePasswordStore, fmt.Errorf(errOnePasswordStoreInvalidConnectHost, err))
  149. }
  150. return nil
  151. }
  152. func deleteField(fields []*onepassword.ItemField, label string) ([]*onepassword.ItemField, error) {
  153. // This will always iterate over all items
  154. // but its done to ensure that two fields with the same label
  155. // exist resulting in undefined behavior
  156. var (
  157. found bool
  158. fieldsF = make([]*onepassword.ItemField, 0, len(fields))
  159. )
  160. for _, item := range fields {
  161. if item.Label == label {
  162. if found {
  163. return nil, ErrExpectedOneField
  164. }
  165. found = true
  166. continue
  167. }
  168. fieldsF = append(fieldsF, item)
  169. }
  170. return fieldsF, nil
  171. }
  172. func (provider *ProviderOnePassword) DeleteSecret(_ context.Context, ref esv1beta1.PushSecretRemoteRef) error {
  173. providerItem, err := provider.findItem(ref.GetRemoteKey())
  174. if err != nil {
  175. return err
  176. }
  177. providerItem.Fields, err = deleteField(providerItem.Fields, ref.GetProperty())
  178. if err != nil {
  179. return fmt.Errorf(errUpdateItem, err)
  180. }
  181. if len(providerItem.Fields) == 0 && len(providerItem.Files) == 0 && len(providerItem.Sections) == 0 {
  182. // Delete the item if there are no fields, files or sections
  183. if err = provider.client.DeleteItem(providerItem, providerItem.Vault.ID); err != nil {
  184. return fmt.Errorf(errDeleteItem, err)
  185. }
  186. return nil
  187. }
  188. if _, err = provider.client.UpdateItem(providerItem, providerItem.Vault.ID); err != nil {
  189. return fmt.Errorf(errDeleteItem, err)
  190. }
  191. return nil
  192. }
  193. func (provider *ProviderOnePassword) SecretExists(_ context.Context, _ esv1beta1.PushSecretRemoteRef) (bool, error) {
  194. return false, errors.New("not implemented")
  195. }
  196. const (
  197. passwordLabel = "password"
  198. )
  199. // createItem creates a new item in the first vault. If no vaults exist, it returns an error.
  200. func (provider *ProviderOnePassword) createItem(val []byte, ref esv1beta1.PushSecretData) error {
  201. // Get the metadata
  202. metadata, err := metadata.ParseMetadataParameters[PushSecretMetadataSpec](ref.GetMetadata())
  203. if err != nil {
  204. return fmt.Errorf("failed to parse push secret metadata: %w", err)
  205. }
  206. // Check if there is a vault is specified in the metadata
  207. vaultID := ""
  208. if metadata != nil && metadata.Spec.Vault != "" {
  209. // check if metadata.Spec.Vault is in provider.vaults
  210. if _, ok := provider.vaults[metadata.Spec.Vault]; !ok {
  211. return fmt.Errorf(errMetadataVaultNotinProvider, metadata.Spec.Vault)
  212. }
  213. vaultID = metadata.Spec.Vault
  214. } else {
  215. // Get the first vault from the provider
  216. sortedVaults := sortVaults(provider.vaults)
  217. if len(sortedVaults) == 0 {
  218. return ErrNoVaults
  219. }
  220. vaultID = sortedVaults[0]
  221. }
  222. // Get the label
  223. label := ref.GetProperty()
  224. if label == "" {
  225. label = passwordLabel
  226. }
  227. var tags []string
  228. if metadata != nil && metadata.Spec.Tags != nil {
  229. tags = metadata.Spec.Tags
  230. }
  231. // Create the item
  232. item := &onepassword.Item{
  233. Title: ref.GetRemoteKey(),
  234. Category: onepassword.Server,
  235. Vault: onepassword.ItemVault{
  236. ID: vaultID,
  237. },
  238. Fields: []*onepassword.ItemField{
  239. generateNewItemField(label, string(val)),
  240. },
  241. Tags: tags,
  242. }
  243. _, err = provider.client.CreateItem(item, vaultID)
  244. return err
  245. }
  246. // updateFieldValue updates the fields value of an item with the given label.
  247. // If the label does not exist, a new field is created. If the label exists but
  248. // the value is different, the value is updated. If the label exists and the
  249. // value is the same, nothing is done.
  250. func updateFieldValue(fields []*onepassword.ItemField, label, newVal string) ([]*onepassword.ItemField, error) {
  251. // This will always iterate over all items.
  252. // This is done to ensure that two fields with the same label
  253. // exist resulting in undefined behavior.
  254. var (
  255. found bool
  256. index int
  257. )
  258. for i, item := range fields {
  259. if item.Label == label {
  260. if found {
  261. return nil, ErrExpectedOneField
  262. }
  263. found = true
  264. index = i
  265. }
  266. }
  267. if !found {
  268. return append(fields, generateNewItemField(label, newVal)), nil
  269. }
  270. if fields[index].Value != newVal {
  271. fields[index].Value = newVal
  272. }
  273. return fields, nil
  274. }
  275. // generateNewItemField generates a new item field with the given label and value.
  276. func generateNewItemField(label, newVal string) *onepassword.ItemField {
  277. field := &onepassword.ItemField{
  278. Label: label,
  279. Value: newVal,
  280. Type: onepassword.FieldTypeConcealed,
  281. }
  282. return field
  283. }
  284. func (provider *ProviderOnePassword) PushSecret(ctx context.Context, secret *corev1.Secret, ref esv1beta1.PushSecretData) error {
  285. val, ok := secret.Data[ref.GetSecretKey()]
  286. if !ok {
  287. return ErrKeyNotFound
  288. }
  289. title := ref.GetRemoteKey()
  290. providerItem, err := provider.findItem(title)
  291. if errors.Is(err, ErrKeyNotFound) {
  292. if err = provider.createItem(val, ref); err != nil {
  293. return fmt.Errorf(errCreateItem, err)
  294. }
  295. err = provider.waitForFunc(ctx, provider.waitForItemToExist(title))
  296. return err
  297. } else if err != nil {
  298. return err
  299. }
  300. label := ref.GetProperty()
  301. if label == "" {
  302. label = passwordLabel
  303. }
  304. metadata, err := metadata.ParseMetadataParameters[PushSecretMetadataSpec](ref.GetMetadata())
  305. if err != nil {
  306. return fmt.Errorf("failed to parse push secret metadata: %w", err)
  307. }
  308. if metadata != nil && metadata.Spec.Tags != nil {
  309. providerItem.Tags = metadata.Spec.Tags
  310. }
  311. providerItem.Fields, err = updateFieldValue(providerItem.Fields, label, string(val))
  312. if err != nil {
  313. return fmt.Errorf(errUpdateItem, err)
  314. }
  315. if _, err = provider.client.UpdateItem(providerItem, providerItem.Vault.ID); err != nil {
  316. return fmt.Errorf(errUpdateItem, err)
  317. }
  318. if err := provider.waitForFunc(ctx, provider.waitForLabelToBeUpdated(title, label, val)); err != nil {
  319. return fmt.Errorf("failed waiting for label update: %w", err)
  320. }
  321. return nil
  322. }
  323. // Clean property string by removing property prefix if needed.
  324. func getObjType(documentType onepassword.ItemCategory, property string) (string, string) {
  325. if strings.HasPrefix(property, fieldPrefix+prefixSplitter) {
  326. return fieldPrefix, property[6:]
  327. }
  328. if strings.HasPrefix(property, filePrefix+prefixSplitter) {
  329. return filePrefix, property[5:]
  330. }
  331. if documentType == documentCategory {
  332. return filePrefix, property
  333. }
  334. return fieldPrefix, property
  335. }
  336. // GetSecret returns a single secret from the provider.
  337. func (provider *ProviderOnePassword) GetSecret(_ context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  338. if ref.Version != "" {
  339. return nil, errors.New(errVersionNotImplemented)
  340. }
  341. item, err := provider.findItem(ref.Key)
  342. if err != nil {
  343. return nil, err
  344. }
  345. propertyType, property := getObjType(item.Category, ref.Property)
  346. if propertyType == filePrefix {
  347. return provider.getFile(item, property)
  348. }
  349. return provider.getField(item, property)
  350. }
  351. // Validate checks if the client is configured correctly
  352. // to be able to retrieve secrets from the provider.
  353. func (provider *ProviderOnePassword) Validate() (esv1beta1.ValidationResult, error) {
  354. for vaultName := range provider.vaults {
  355. _, err := provider.client.GetVaultByTitle(vaultName)
  356. if err != nil {
  357. return esv1beta1.ValidationResultError, err
  358. }
  359. }
  360. return esv1beta1.ValidationResultReady, nil
  361. }
  362. // GetSecretMap returns multiple k/v pairs from the provider, for dataFrom.extract.
  363. func (provider *ProviderOnePassword) GetSecretMap(_ context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  364. if ref.Version != "" {
  365. return nil, errors.New(errVersionNotImplemented)
  366. }
  367. item, err := provider.findItem(ref.Key)
  368. if err != nil {
  369. return nil, err
  370. }
  371. propertyType, property := getObjType(item.Category, ref.Property)
  372. if propertyType == filePrefix {
  373. return provider.getFiles(item, property)
  374. }
  375. return provider.getFields(item, property)
  376. }
  377. // GetAllSecrets syncs multiple 1Password Items into a single Kubernetes Secret, for dataFrom.find.
  378. func (provider *ProviderOnePassword) GetAllSecrets(_ context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  379. secretData := make(map[string][]byte)
  380. sortedVaults := sortVaults(provider.vaults)
  381. for _, vaultName := range sortedVaults {
  382. vault, err := provider.client.GetVaultByTitle(vaultName)
  383. if err != nil {
  384. return nil, fmt.Errorf(errGetVault, err)
  385. }
  386. if ref.Tags != nil {
  387. err = provider.getAllByTags(vault.ID, ref, secretData)
  388. if err != nil {
  389. return nil, err
  390. }
  391. return secretData, nil
  392. }
  393. err = provider.getAllForVault(vault.ID, ref, secretData)
  394. if err != nil {
  395. return nil, err
  396. }
  397. }
  398. return secretData, nil
  399. }
  400. // Close closes the client connection.
  401. func (provider *ProviderOnePassword) Close(_ context.Context) error {
  402. return nil
  403. }
  404. func (provider *ProviderOnePassword) findItem(name string) (*onepassword.Item, error) {
  405. sortedVaults := sortVaults(provider.vaults)
  406. for _, vaultName := range sortedVaults {
  407. vault, err := provider.client.GetVaultByTitle(vaultName)
  408. if err != nil {
  409. return nil, fmt.Errorf(errGetVault, err)
  410. }
  411. // use GetItemsByTitle instead of GetItemByTitle in order to handle length cases
  412. items, err := provider.client.GetItemsByTitle(name, vault.ID)
  413. if err != nil {
  414. return nil, fmt.Errorf(errGetItem, err)
  415. }
  416. switch {
  417. case len(items) == 1:
  418. return provider.client.GetItemByUUID(items[0].ID, items[0].Vault.ID)
  419. case len(items) > 1:
  420. return nil, fmt.Errorf("%w: '%s', got %d", ErrExpectedOneItem, name, len(items))
  421. }
  422. }
  423. return nil, fmt.Errorf("%w: %s in: %v", ErrKeyNotFound, name, provider.vaults)
  424. }
  425. func (provider *ProviderOnePassword) getField(item *onepassword.Item, property string) ([]byte, error) {
  426. // default to a field labeled "password"
  427. fieldLabel := "password"
  428. if property != "" {
  429. fieldLabel = property
  430. }
  431. if length := countFieldsWithLabel(fieldLabel, item.Fields); length != 1 {
  432. return nil, fmt.Errorf("%w: '%s' in '%s', got %d", ErrExpectedOneField, fieldLabel, item.Title, length)
  433. }
  434. // caution: do not use client.GetValue here because it has undesirable behavior on keys with a dot in them
  435. value := ""
  436. for _, field := range item.Fields {
  437. if field.Label == fieldLabel {
  438. value = field.Value
  439. break
  440. }
  441. }
  442. return []byte(value), nil
  443. }
  444. func (provider *ProviderOnePassword) getFields(item *onepassword.Item, property string) (map[string][]byte, error) {
  445. secretData := make(map[string][]byte)
  446. for _, field := range item.Fields {
  447. if property != "" && field.Label != property {
  448. continue
  449. }
  450. if length := countFieldsWithLabel(field.Label, item.Fields); length != 1 {
  451. return nil, fmt.Errorf(errExpectedOneFieldMsgF, ErrExpectedOneField, field.Label, item.Title, length)
  452. }
  453. // caution: do not use client.GetValue here because it has undesirable behavior on keys with a dot in them
  454. secretData[field.Label] = []byte(field.Value)
  455. }
  456. return secretData, nil
  457. }
  458. func (provider *ProviderOnePassword) getAllFields(item onepassword.Item, ref esv1beta1.ExternalSecretFind, secretData map[string][]byte) error {
  459. i, err := provider.client.GetItemByUUID(item.ID, item.Vault.ID)
  460. if err != nil {
  461. return fmt.Errorf(errGetItem, err)
  462. }
  463. item = *i
  464. for _, field := range item.Fields {
  465. if length := countFieldsWithLabel(field.Label, item.Fields); length != 1 {
  466. return fmt.Errorf(errExpectedOneFieldMsgF, ErrExpectedOneField, field.Label, item.Title, length)
  467. }
  468. if ref.Name != nil {
  469. matcher, err := find.New(*ref.Name)
  470. if err != nil {
  471. return err
  472. }
  473. if !matcher.MatchName(field.Label) {
  474. continue
  475. }
  476. }
  477. if _, ok := secretData[field.Label]; !ok {
  478. secretData[field.Label] = []byte(field.Value)
  479. }
  480. }
  481. return nil
  482. }
  483. func (provider *ProviderOnePassword) getFile(item *onepassword.Item, property string) ([]byte, error) {
  484. for _, file := range item.Files {
  485. // default to the first file when ref.Property is empty
  486. if file.Name == property || property == "" {
  487. contents, err := provider.client.GetFileContent(file)
  488. if err != nil {
  489. return nil, err
  490. }
  491. return contents, nil
  492. }
  493. }
  494. return nil, fmt.Errorf(errDocumentNotFound, fmt.Errorf("'%s', '%s'", item.Title, property))
  495. }
  496. func (provider *ProviderOnePassword) getFiles(item *onepassword.Item, property string) (map[string][]byte, error) {
  497. secretData := make(map[string][]byte)
  498. for _, file := range item.Files {
  499. if property != "" && file.Name != property {
  500. continue
  501. }
  502. contents, err := provider.client.GetFileContent(file)
  503. if err != nil {
  504. return nil, err
  505. }
  506. secretData[file.Name] = contents
  507. }
  508. return secretData, nil
  509. }
  510. func (provider *ProviderOnePassword) getAllFiles(item onepassword.Item, ref esv1beta1.ExternalSecretFind, secretData map[string][]byte) error {
  511. for _, file := range item.Files {
  512. if ref.Name != nil {
  513. matcher, err := find.New(*ref.Name)
  514. if err != nil {
  515. return err
  516. }
  517. if !matcher.MatchName(file.Name) {
  518. continue
  519. }
  520. }
  521. if _, ok := secretData[file.Name]; !ok {
  522. contents, err := provider.client.GetFileContent(file)
  523. if err != nil {
  524. return err
  525. }
  526. secretData[file.Name] = contents
  527. }
  528. }
  529. return nil
  530. }
  531. func (provider *ProviderOnePassword) getAllByTags(vaultID string, ref esv1beta1.ExternalSecretFind, secretData map[string][]byte) error {
  532. items, err := provider.client.GetItems(vaultID)
  533. if err != nil {
  534. return fmt.Errorf(errGetItem, err)
  535. }
  536. for _, item := range items {
  537. if !checkTags(ref.Tags, item.Tags) {
  538. continue
  539. }
  540. // handle files
  541. err = provider.getAllFiles(item, ref, secretData)
  542. if err != nil {
  543. return err
  544. }
  545. // handle fields
  546. err = provider.getAllFields(item, ref, secretData)
  547. if err != nil {
  548. return err
  549. }
  550. }
  551. return nil
  552. }
  553. // checkTags verifies that all elements in source are present in target.
  554. func checkTags(source map[string]string, target []string) bool {
  555. for s := range source {
  556. if !slices.Contains(target, s) {
  557. return false
  558. }
  559. }
  560. return true
  561. }
  562. func (provider *ProviderOnePassword) getAllForVault(vaultID string, ref esv1beta1.ExternalSecretFind, secretData map[string][]byte) error {
  563. items, err := provider.client.GetItems(vaultID)
  564. if err != nil {
  565. return fmt.Errorf(errGetItem, err)
  566. }
  567. for _, item := range items {
  568. if ref.Path != nil && *ref.Path != item.Title {
  569. continue
  570. }
  571. // handle files
  572. err = provider.getAllFiles(item, ref, secretData)
  573. if err != nil {
  574. return err
  575. }
  576. // handle fields
  577. err = provider.getAllFields(item, ref, secretData)
  578. if err != nil {
  579. return err
  580. }
  581. }
  582. return nil
  583. }
  584. // waitForFunc will wait for OnePassword to _actually_ create/update the secret. OnePassword returns immediately after
  585. // the initial create/update which makes the next call for the same item create/update a new item with the same name. Hence, we'll
  586. // wait for the item to exist or be updated on OnePassword's side as well.
  587. // Ideally we could do bulk operations and handle data with one submit, but that would require re-writing the entire
  588. // push secret controller. For now, this is sufficient.
  589. func (provider *ProviderOnePassword) waitForFunc(ctx context.Context, fn func() error) error {
  590. // check every .5 seconds
  591. tick := time.NewTicker(500 * time.Millisecond)
  592. defer tick.Stop()
  593. done, cancel := context.WithTimeout(ctx, 5*time.Second)
  594. defer cancel()
  595. var err error
  596. for {
  597. select {
  598. case <-tick.C:
  599. if err = fn(); err == nil {
  600. return nil
  601. }
  602. case <-done.Done():
  603. return fmt.Errorf("timeout to wait for function to run successfully; last error was: %w", err)
  604. }
  605. }
  606. }
  607. func (provider *ProviderOnePassword) waitForItemToExist(title string) func() error {
  608. return func() error {
  609. _, err := provider.findItem(title)
  610. return err
  611. }
  612. }
  613. func (provider *ProviderOnePassword) waitForLabelToBeUpdated(title, label string, val []byte) func() error {
  614. return func() error {
  615. item, err := provider.findItem(title)
  616. if err != nil {
  617. return err
  618. }
  619. for _, field := range item.Fields {
  620. // we found the label with the right value
  621. if field.Label == label && field.Value == string(val) {
  622. return nil
  623. }
  624. }
  625. return fmt.Errorf("label %s no found on value with title %s", title, label)
  626. }
  627. }
  628. func countFieldsWithLabel(fieldLabel string, fields []*onepassword.ItemField) int {
  629. count := 0
  630. for _, field := range fields {
  631. if field.Label == fieldLabel {
  632. count++
  633. }
  634. }
  635. return count
  636. }
  637. type orderedVault struct {
  638. Name string
  639. Order int
  640. }
  641. type orderedVaultList []orderedVault
  642. func (list orderedVaultList) Len() int { return len(list) }
  643. func (list orderedVaultList) Swap(i, j int) { list[i], list[j] = list[j], list[i] }
  644. func (list orderedVaultList) Less(i, j int) bool { return list[i].Order < list[j].Order }
  645. func sortVaults(vaults map[string]int) []string {
  646. list := make(orderedVaultList, len(vaults))
  647. index := 0
  648. for key, value := range vaults {
  649. list[index] = orderedVault{key, value}
  650. index++
  651. }
  652. sort.Sort(list)
  653. sortedVaults := []string{}
  654. for _, item := range list {
  655. sortedVaults = append(sortedVaults, item.Name)
  656. }
  657. return sortedVaults
  658. }
  659. func hasUniqueVaultNumbers(vaults map[string]int) bool {
  660. unique := make([]int, 0, len(vaults))
  661. tracker := make(map[int]bool)
  662. for _, number := range vaults {
  663. if _, ok := tracker[number]; !ok {
  664. tracker[number] = true
  665. unique = append(unique, number)
  666. }
  667. }
  668. return len(vaults) == len(unique)
  669. }
  670. func init() {
  671. esv1beta1.Register(&ProviderOnePassword{}, &esv1beta1.SecretStoreProvider{
  672. OnePassword: &esv1beta1.OnePasswordProvider{},
  673. })
  674. }