onepassword.go 23 KB

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