client_test.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985
  1. /*
  2. Copyright © The ESO Authors
  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 keepersecurity
  14. import (
  15. "context"
  16. "errors"
  17. "fmt"
  18. "reflect"
  19. "testing"
  20. ksm "github.com/keeper-security/secrets-manager-go/core"
  21. corev1 "k8s.io/api/core/v1"
  22. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  23. "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  24. "github.com/external-secrets/external-secrets/providers/v1/keepersecurity/fake"
  25. testingfake "github.com/external-secrets/external-secrets/runtime/testing/fake"
  26. )
  27. const (
  28. folderID = "a8ekf031k"
  29. validExistingRecord = "record0/login"
  30. invalidRecord = "record5/login"
  31. outputRecord0 = "{\"title\":\"record0\",\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"value\":[\"foo\"]},{\"type\":\"password\",\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host0\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}],\"files\":null}"
  32. outputRecord1 = "{\"title\":\"record1\",\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"value\":[\"foo\"]},{\"type\":\"password\",\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host1\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}],\"files\":null}"
  33. outputRecord2 = "{\"title\":\"record2\",\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"value\":[\"foo\"]},{\"type\":\"password\",\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host2\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}],\"files\":null}"
  34. outputRecordWithLabels = "{\"title\":\"recordWithLabels\",\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"label\":\"username\",\"value\":[\"foo\"]},{\"type\":\"password\",\"label\":\"pass\",\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host0\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}],\"files\":null}"
  35. record0 = "record0"
  36. record1 = "record1"
  37. record2 = "record2"
  38. recordWithLabels = "recordWithLabels"
  39. LoginKey = "login"
  40. PasswordKey = "password"
  41. HostKeyFormat = "host%d"
  42. RecordNameFormat = "record%d"
  43. UsernameLabel = "username"
  44. PassLabel = "pass"
  45. )
  46. func TestClientDeleteSecret(t *testing.T) {
  47. type fields struct {
  48. ksmClient SecurityClient
  49. folderID string
  50. }
  51. type args struct {
  52. ctx context.Context
  53. remoteRef esv1.PushSecretRemoteRef
  54. }
  55. tests := []struct {
  56. name string
  57. fields fields
  58. args args
  59. wantErr bool
  60. }{
  61. {
  62. name: "Delete valid secret",
  63. fields: fields{
  64. ksmClient: &fake.MockKeeperClient{
  65. DeleteSecretsFn: func(recrecordUids []string) (map[string]string, error) {
  66. return map[string]string{
  67. record0: record0,
  68. }, nil
  69. },
  70. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  71. return generateRecords()[:1], nil
  72. },
  73. },
  74. folderID: folderID,
  75. },
  76. args: args{
  77. context.Background(),
  78. &v1alpha1.PushSecretRemoteRef{
  79. RemoteKey: validExistingRecord,
  80. },
  81. },
  82. wantErr: false,
  83. },
  84. {
  85. name: "Delete secret with multiple matches by Name",
  86. fields: fields{
  87. ksmClient: &fake.MockKeeperClient{
  88. DeleteSecretsFn: func(recrecordUids []string) (map[string]string, error) {
  89. return map[string]string{
  90. record0: record0,
  91. }, nil
  92. },
  93. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  94. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  95. },
  96. },
  97. folderID: folderID,
  98. },
  99. args: args{
  100. context.Background(),
  101. &v1alpha1.PushSecretRemoteRef{
  102. RemoteKey: validExistingRecord,
  103. },
  104. },
  105. wantErr: true,
  106. },
  107. {
  108. name: "Delete non existing secret",
  109. fields: fields{
  110. ksmClient: &fake.MockKeeperClient{
  111. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  112. return nil, errors.New("failed")
  113. },
  114. },
  115. folderID: folderID,
  116. },
  117. args: args{
  118. context.Background(),
  119. &v1alpha1.PushSecretRemoteRef{
  120. RemoteKey: invalidRecord,
  121. },
  122. },
  123. wantErr: true,
  124. },
  125. }
  126. for _, tt := range tests {
  127. t.Run(tt.name, func(t *testing.T) {
  128. c := &Client{
  129. ksmClient: tt.fields.ksmClient,
  130. folderID: tt.fields.folderID,
  131. }
  132. if err := c.DeleteSecret(tt.args.ctx, tt.args.remoteRef); (err != nil) != tt.wantErr {
  133. t.Errorf("DeleteSecret() error = %v, wantErr %v", err, tt.wantErr)
  134. }
  135. })
  136. }
  137. }
  138. func TestClientGetAllSecrets(t *testing.T) {
  139. type fields struct {
  140. ksmClient SecurityClient
  141. folderID string
  142. }
  143. type args struct {
  144. ctx context.Context
  145. ref esv1.ExternalSecretFind
  146. }
  147. var path = "path_to_fail"
  148. tests := []struct {
  149. name string
  150. fields fields
  151. args args
  152. want map[string][]byte
  153. wantErr bool
  154. }{
  155. {
  156. name: "Tags not Implemented",
  157. fields: fields{
  158. ksmClient: &fake.MockKeeperClient{},
  159. folderID: folderID,
  160. },
  161. args: args{
  162. ctx: context.Background(),
  163. ref: esv1.ExternalSecretFind{
  164. Tags: map[string]string{
  165. "xxx": "yyy",
  166. },
  167. },
  168. },
  169. wantErr: true,
  170. },
  171. {
  172. name: "Path not Implemented",
  173. fields: fields{
  174. ksmClient: &fake.MockKeeperClient{},
  175. folderID: folderID,
  176. },
  177. args: args{
  178. ctx: context.Background(),
  179. ref: esv1.ExternalSecretFind{
  180. Path: &path,
  181. },
  182. },
  183. wantErr: true,
  184. },
  185. {
  186. name: "Get secrets with matching regex",
  187. fields: fields{
  188. ksmClient: &fake.MockKeeperClient{
  189. GetSecretsFn: func(strings []string) ([]*ksm.Record, error) {
  190. return generateRecords(), nil
  191. },
  192. },
  193. folderID: folderID,
  194. },
  195. args: args{
  196. ctx: context.Background(),
  197. ref: esv1.ExternalSecretFind{
  198. Name: &esv1.FindName{
  199. RegExp: "record",
  200. },
  201. },
  202. },
  203. want: map[string][]byte{
  204. record0: []byte(outputRecord0),
  205. record1: []byte(outputRecord1),
  206. record2: []byte(outputRecord2),
  207. },
  208. wantErr: false,
  209. },
  210. {
  211. name: "Get 1 secret with matching regex",
  212. fields: fields{
  213. ksmClient: &fake.MockKeeperClient{
  214. GetSecretsFn: func(strings []string) ([]*ksm.Record, error) {
  215. return generateRecords(), nil
  216. },
  217. },
  218. folderID: folderID,
  219. },
  220. args: args{
  221. ctx: context.Background(),
  222. ref: esv1.ExternalSecretFind{
  223. Name: &esv1.FindName{
  224. RegExp: record0,
  225. },
  226. },
  227. },
  228. want: map[string][]byte{
  229. record0: []byte(outputRecord0),
  230. },
  231. wantErr: false,
  232. },
  233. {
  234. name: "Get secrets with labels using matching regex",
  235. fields: fields{
  236. ksmClient: &fake.MockKeeperClient{
  237. GetSecretsFn: func(strings []string) ([]*ksm.Record, error) {
  238. return []*ksm.Record{generateRecordWithLabels()}, nil
  239. },
  240. },
  241. folderID: folderID,
  242. },
  243. args: args{
  244. ctx: context.Background(),
  245. ref: esv1.ExternalSecretFind{
  246. Name: &esv1.FindName{
  247. RegExp: recordWithLabels,
  248. },
  249. },
  250. },
  251. want: map[string][]byte{
  252. recordWithLabels: []byte(outputRecordWithLabels),
  253. },
  254. wantErr: false,
  255. },
  256. }
  257. for _, tt := range tests {
  258. t.Run(tt.name, func(t *testing.T) {
  259. c := &Client{
  260. ksmClient: tt.fields.ksmClient,
  261. folderID: tt.fields.folderID,
  262. }
  263. got, err := c.GetAllSecrets(tt.args.ctx, tt.args.ref)
  264. if (err != nil) != tt.wantErr {
  265. t.Errorf("GetAllSecrets() error = %v, wantErr %v", err, tt.wantErr)
  266. return
  267. }
  268. if !reflect.DeepEqual(got, tt.want) {
  269. t.Errorf("GetAllSecrets() got = %v, want %v", got, tt.want)
  270. }
  271. })
  272. }
  273. }
  274. func TestClientGetSecret(t *testing.T) {
  275. type fields struct {
  276. ksmClient SecurityClient
  277. folderID string
  278. getByTitleFallback bool
  279. }
  280. type args struct {
  281. ctx context.Context
  282. ref esv1.ExternalSecretDataRemoteRef
  283. }
  284. tests := []struct {
  285. name string
  286. fields fields
  287. args args
  288. want []byte
  289. wantErr bool
  290. }{
  291. {
  292. name: "Get Secret with a property (no label)",
  293. fields: fields{
  294. ksmClient: &fake.MockKeeperClient{
  295. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  296. return []*ksm.Record{generateRecords()[0]}, nil
  297. },
  298. },
  299. folderID: folderID,
  300. getByTitleFallback: false,
  301. },
  302. args: args{
  303. ctx: context.Background(),
  304. ref: esv1.ExternalSecretDataRemoteRef{
  305. Key: record0,
  306. Property: LoginKey,
  307. },
  308. },
  309. want: []byte("foo"),
  310. wantErr: false,
  311. },
  312. {
  313. name: "Get Secret without property (no label)",
  314. fields: fields{
  315. ksmClient: &fake.MockKeeperClient{
  316. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  317. return []*ksm.Record{generateRecords()[0]}, nil
  318. },
  319. },
  320. folderID: folderID,
  321. getByTitleFallback: false,
  322. },
  323. args: args{
  324. ctx: context.Background(),
  325. ref: esv1.ExternalSecretDataRemoteRef{
  326. Key: record0,
  327. },
  328. },
  329. want: []byte(outputRecord0),
  330. wantErr: false,
  331. },
  332. {
  333. name: "Get Secret with a property using label",
  334. fields: fields{
  335. ksmClient: &fake.MockKeeperClient{
  336. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  337. return []*ksm.Record{generateRecordWithLabels()}, nil
  338. },
  339. },
  340. folderID: folderID,
  341. getByTitleFallback: false,
  342. },
  343. args: args{
  344. ctx: context.Background(),
  345. ref: esv1.ExternalSecretDataRemoteRef{
  346. Key: recordWithLabels,
  347. Property: UsernameLabel,
  348. },
  349. },
  350. want: []byte("foo"),
  351. wantErr: false,
  352. },
  353. {
  354. name: "Get Secret with a property using type when label exists",
  355. fields: fields{
  356. ksmClient: &fake.MockKeeperClient{
  357. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  358. return []*ksm.Record{generateRecordWithLabels()}, nil
  359. },
  360. },
  361. folderID: folderID,
  362. getByTitleFallback: false,
  363. },
  364. args: args{
  365. ctx: context.Background(),
  366. ref: esv1.ExternalSecretDataRemoteRef{
  367. Key: recordWithLabels,
  368. Property: LoginKey, // Try to access by type when label exists
  369. },
  370. },
  371. wantErr: true, // Should fail because label takes precedence
  372. },
  373. {
  374. name: "Get Secret without property (with labels)",
  375. fields: fields{
  376. ksmClient: &fake.MockKeeperClient{
  377. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  378. return []*ksm.Record{generateRecordWithLabels()}, nil
  379. },
  380. },
  381. folderID: folderID,
  382. getByTitleFallback: false,
  383. },
  384. args: args{
  385. ctx: context.Background(),
  386. ref: esv1.ExternalSecretDataRemoteRef{
  387. Key: recordWithLabels,
  388. },
  389. },
  390. want: []byte(outputRecordWithLabels),
  391. wantErr: false,
  392. },
  393. {
  394. name: "Get secret with multiple matches by ID",
  395. fields: fields{
  396. ksmClient: &fake.MockKeeperClient{
  397. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  398. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  399. },
  400. },
  401. folderID: folderID,
  402. getByTitleFallback: false,
  403. },
  404. args: args{
  405. ctx: context.Background(),
  406. ref: esv1.ExternalSecretDataRemoteRef{
  407. Key: record0,
  408. },
  409. },
  410. want: []byte(outputRecord0),
  411. wantErr: false,
  412. },
  413. {
  414. name: "Get secret by ID",
  415. fields: fields{
  416. ksmClient: &fake.MockKeeperClient{
  417. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  418. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  419. },
  420. },
  421. folderID: folderID,
  422. getByTitleFallback: false,
  423. },
  424. args: args{
  425. ctx: context.Background(),
  426. ref: esv1.ExternalSecretDataRemoteRef{
  427. Key: record0,
  428. },
  429. },
  430. want: []byte(outputRecord0),
  431. wantErr: false,
  432. },
  433. {
  434. name: "Get secret by ID (with fallback)",
  435. fields: fields{
  436. ksmClient: &fake.MockKeeperClient{
  437. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  438. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  439. },
  440. },
  441. folderID: folderID,
  442. getByTitleFallback: true,
  443. },
  444. args: args{
  445. ctx: context.Background(),
  446. ref: esv1.ExternalSecretDataRemoteRef{
  447. Key: record0,
  448. },
  449. },
  450. want: []byte(outputRecord0),
  451. wantErr: false,
  452. },
  453. {
  454. name: "Get non existing secret with client error",
  455. fields: fields{
  456. ksmClient: &fake.MockKeeperClient{
  457. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  458. return nil, errors.New("not found")
  459. },
  460. },
  461. folderID: folderID,
  462. getByTitleFallback: false,
  463. },
  464. args: args{
  465. ctx: context.Background(),
  466. ref: esv1.ExternalSecretDataRemoteRef{
  467. Key: "record5",
  468. },
  469. },
  470. wantErr: true,
  471. },
  472. {
  473. name: "Get non existing secret",
  474. fields: fields{
  475. ksmClient: &fake.MockKeeperClient{
  476. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  477. return []*ksm.Record{}, nil
  478. },
  479. },
  480. folderID: folderID,
  481. getByTitleFallback: false,
  482. },
  483. args: args{
  484. ctx: context.Background(),
  485. ref: esv1.ExternalSecretDataRemoteRef{
  486. Key: "record5",
  487. },
  488. },
  489. wantErr: true,
  490. },
  491. {
  492. name: "Get non existing secret with fallback",
  493. fields: fields{
  494. ksmClient: &fake.MockKeeperClient{
  495. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  496. return []*ksm.Record{}, nil
  497. },
  498. GetSecretsByTitleFn: func(recordTitle string) ([]*ksm.Record, error) {
  499. return []*ksm.Record{}, nil
  500. },
  501. },
  502. folderID: folderID,
  503. getByTitleFallback: true,
  504. },
  505. args: args{
  506. ctx: context.Background(),
  507. ref: esv1.ExternalSecretDataRemoteRef{
  508. Key: "record5",
  509. },
  510. },
  511. wantErr: true,
  512. },
  513. {
  514. name: "Get valid secret with non existing property",
  515. fields: fields{
  516. ksmClient: &fake.MockKeeperClient{
  517. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  518. return []*ksm.Record{generateRecords()[0]}, nil
  519. },
  520. },
  521. folderID: folderID,
  522. getByTitleFallback: false,
  523. },
  524. args: args{
  525. ctx: context.Background(),
  526. ref: esv1.ExternalSecretDataRemoteRef{
  527. Key: record0,
  528. Property: "invalid",
  529. },
  530. },
  531. wantErr: true,
  532. },
  533. {
  534. name: "Get secret by name",
  535. fields: fields{
  536. ksmClient: &fake.MockKeeperClient{
  537. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  538. // Return empty list to trigger name lookup
  539. return []*ksm.Record{}, nil
  540. },
  541. GetSecretsByTitleFn: func(recordTitle string) ([]*ksm.Record, error) {
  542. return []*ksm.Record{generateRecords()[0]}, nil
  543. },
  544. },
  545. folderID: folderID,
  546. getByTitleFallback: true,
  547. },
  548. args: args{
  549. ctx: context.Background(),
  550. ref: esv1.ExternalSecretDataRemoteRef{
  551. Key: record0,
  552. },
  553. },
  554. want: []byte(outputRecord0),
  555. wantErr: false,
  556. },
  557. {
  558. name: "Get secret by name with multiple matches",
  559. fields: fields{
  560. ksmClient: &fake.MockKeeperClient{
  561. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  562. // Return empty list to trigger name lookup
  563. return []*ksm.Record{}, nil
  564. },
  565. GetSecretsByTitleFn: func(recordTitle string) ([]*ksm.Record, error) {
  566. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  567. },
  568. },
  569. folderID: folderID,
  570. getByTitleFallback: true,
  571. },
  572. args: args{
  573. ctx: context.Background(),
  574. ref: esv1.ExternalSecretDataRemoteRef{
  575. Key: record0,
  576. },
  577. },
  578. wantErr: true,
  579. },
  580. }
  581. for _, tt := range tests {
  582. t.Run(tt.name, func(t *testing.T) {
  583. c := &Client{
  584. ksmClient: tt.fields.ksmClient,
  585. folderID: tt.fields.folderID,
  586. getByTitleFallback: tt.fields.getByTitleFallback,
  587. }
  588. got, err := c.GetSecret(tt.args.ctx, tt.args.ref)
  589. if (err != nil) != tt.wantErr {
  590. t.Errorf("GetSecret() error = %v, wantErr %v", err, tt.wantErr)
  591. return
  592. }
  593. if !reflect.DeepEqual(got, tt.want) {
  594. t.Errorf("GetSecret() got = %v, want %v", got, tt.want)
  595. }
  596. })
  597. }
  598. }
  599. func TestClientGetSecretMap(t *testing.T) {
  600. type fields struct {
  601. ksmClient SecurityClient
  602. folderID string
  603. }
  604. type args struct {
  605. ctx context.Context
  606. ref esv1.ExternalSecretDataRemoteRef
  607. }
  608. tests := []struct {
  609. name string
  610. fields fields
  611. args args
  612. want map[string][]byte
  613. wantErr bool
  614. }{
  615. {
  616. name: "Get Secret with valid property (no label)",
  617. fields: fields{
  618. ksmClient: &fake.MockKeeperClient{
  619. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  620. return []*ksm.Record{generateRecords()[0]}, nil
  621. },
  622. },
  623. folderID: folderID,
  624. },
  625. args: args{
  626. ctx: context.Background(),
  627. ref: esv1.ExternalSecretDataRemoteRef{
  628. Key: record0,
  629. Property: LoginKey,
  630. },
  631. },
  632. want: map[string][]byte{
  633. LoginKey: []byte("foo"),
  634. },
  635. wantErr: false,
  636. },
  637. {
  638. name: "Get Secret without property (no label)",
  639. fields: fields{
  640. ksmClient: &fake.MockKeeperClient{
  641. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  642. return []*ksm.Record{generateRecords()[0]}, nil
  643. },
  644. },
  645. folderID: folderID,
  646. },
  647. args: args{
  648. ctx: context.Background(),
  649. ref: esv1.ExternalSecretDataRemoteRef{
  650. Key: record0,
  651. },
  652. },
  653. want: map[string][]byte{
  654. LoginKey: []byte("foo"),
  655. PasswordKey: []byte("bar"),
  656. fmt.Sprintf(HostKeyFormat, 0): []byte("{\"hostName\":\"mysql\",\"port\":\"3306\"}"),
  657. },
  658. wantErr: false,
  659. },
  660. {
  661. name: "Get Secret with valid property using label",
  662. fields: fields{
  663. ksmClient: &fake.MockKeeperClient{
  664. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  665. return []*ksm.Record{generateRecordWithLabels()}, nil
  666. },
  667. },
  668. folderID: folderID,
  669. },
  670. args: args{
  671. ctx: context.Background(),
  672. ref: esv1.ExternalSecretDataRemoteRef{
  673. Key: recordWithLabels,
  674. Property: UsernameLabel,
  675. },
  676. },
  677. want: map[string][]byte{
  678. UsernameLabel: []byte("foo"),
  679. },
  680. wantErr: false,
  681. },
  682. {
  683. name: "Get Secret without property (with labels)",
  684. fields: fields{
  685. ksmClient: &fake.MockKeeperClient{
  686. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  687. return []*ksm.Record{generateRecordWithLabels()}, nil
  688. },
  689. },
  690. folderID: folderID,
  691. },
  692. args: args{
  693. ctx: context.Background(),
  694. ref: esv1.ExternalSecretDataRemoteRef{
  695. Key: recordWithLabels,
  696. },
  697. },
  698. want: map[string][]byte{
  699. UsernameLabel: []byte("foo"),
  700. PassLabel: []byte("bar"),
  701. fmt.Sprintf(HostKeyFormat, 0): []byte("{\"hostName\":\"mysql\",\"port\":\"3306\"}"),
  702. },
  703. wantErr: false,
  704. },
  705. {
  706. name: "Get non existing secret",
  707. fields: fields{
  708. ksmClient: &fake.MockKeeperClient{
  709. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  710. return nil, errors.New(errKeeperSecurityNoSecretsFound)
  711. },
  712. },
  713. folderID: folderID,
  714. },
  715. args: args{
  716. ctx: context.Background(),
  717. ref: esv1.ExternalSecretDataRemoteRef{
  718. Key: "record5",
  719. },
  720. },
  721. wantErr: true,
  722. },
  723. {
  724. name: "Get Secret with invalid property",
  725. fields: fields{
  726. ksmClient: &fake.MockKeeperClient{
  727. GetSecretsFn: func(filter []string) ([]*ksm.Record, error) {
  728. return []*ksm.Record{generateRecords()[0]}, nil
  729. },
  730. },
  731. folderID: folderID,
  732. },
  733. args: args{
  734. ctx: context.Background(),
  735. ref: esv1.ExternalSecretDataRemoteRef{
  736. Key: record0,
  737. Property: "invalid",
  738. },
  739. },
  740. wantErr: true,
  741. },
  742. }
  743. for _, tt := range tests {
  744. t.Run(tt.name, func(t *testing.T) {
  745. c := &Client{
  746. ksmClient: tt.fields.ksmClient,
  747. folderID: tt.fields.folderID,
  748. }
  749. got, err := c.GetSecretMap(tt.args.ctx, tt.args.ref)
  750. if (err != nil) != tt.wantErr {
  751. t.Errorf("GetSecretMap() error = %v, wantErr %v", err, tt.wantErr)
  752. return
  753. }
  754. if !reflect.DeepEqual(got, tt.want) {
  755. t.Errorf("GetSecretMap() got = %v, want %v", got, tt.want)
  756. }
  757. })
  758. }
  759. }
  760. func TestClientPushSecret(t *testing.T) {
  761. secretKey := "secret-key"
  762. type fields struct {
  763. ksmClient SecurityClient
  764. folderID string
  765. }
  766. type args struct {
  767. value []byte
  768. data testingfake.PushSecretData
  769. }
  770. tests := []struct {
  771. name string
  772. fields fields
  773. args args
  774. wantErr bool
  775. }{
  776. {
  777. name: "Invalid remote ref",
  778. fields: fields{
  779. ksmClient: &fake.MockKeeperClient{},
  780. folderID: folderID,
  781. },
  782. args: args{
  783. data: testingfake.PushSecretData{
  784. SecretKey: secretKey,
  785. RemoteKey: record0,
  786. },
  787. value: []byte("foo"),
  788. },
  789. wantErr: true,
  790. },
  791. {
  792. name: "Push new valid secret",
  793. fields: fields{
  794. ksmClient: &fake.MockKeeperClient{
  795. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  796. return generateRecords()[0:0], nil
  797. },
  798. CreateSecretWithRecordDataFn: func(recUID, folderUid string, recordData *ksm.RecordCreate) (string, error) {
  799. return "record5", nil
  800. },
  801. },
  802. folderID: folderID,
  803. },
  804. args: args{
  805. data: testingfake.PushSecretData{
  806. SecretKey: secretKey,
  807. RemoteKey: invalidRecord,
  808. },
  809. value: []byte("foo"),
  810. },
  811. wantErr: false,
  812. },
  813. {
  814. name: "Push existing valid secret",
  815. fields: fields{
  816. ksmClient: &fake.MockKeeperClient{
  817. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  818. return generateRecords()[0:1], nil
  819. },
  820. SaveFn: func(record *ksm.Record) error {
  821. return nil
  822. },
  823. },
  824. folderID: folderID,
  825. },
  826. args: args{
  827. data: testingfake.PushSecretData{
  828. SecretKey: secretKey,
  829. RemoteKey: validExistingRecord,
  830. },
  831. value: []byte("foo2"),
  832. },
  833. wantErr: false,
  834. },
  835. {
  836. name: "Unable to push new valid secret with multiple matches by Name",
  837. fields: fields{
  838. ksmClient: &fake.MockKeeperClient{
  839. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  840. return []*ksm.Record{generateRecords()[0], generateRecords()[0]}, nil
  841. },
  842. },
  843. folderID: folderID,
  844. },
  845. args: args{
  846. data: testingfake.PushSecretData{
  847. SecretKey: secretKey,
  848. RemoteKey: validExistingRecord,
  849. },
  850. value: []byte("foo"),
  851. },
  852. wantErr: true,
  853. },
  854. {
  855. name: "Unable to push new valid secret",
  856. fields: fields{
  857. ksmClient: &fake.MockKeeperClient{
  858. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  859. return nil, errors.New("NotFound")
  860. },
  861. CreateSecretWithRecordDataFn: func(recUID, folderUID string, recordData *ksm.RecordCreate) (string, error) {
  862. return "", errors.New("Unable to push")
  863. },
  864. },
  865. folderID: folderID,
  866. },
  867. args: args{
  868. data: testingfake.PushSecretData{
  869. SecretKey: secretKey,
  870. RemoteKey: invalidRecord,
  871. },
  872. value: []byte("foo"),
  873. },
  874. wantErr: true,
  875. },
  876. {
  877. name: "Unable to save existing valid secret",
  878. fields: fields{
  879. ksmClient: &fake.MockKeeperClient{
  880. GetSecretByTitleFn: func(recordTitle string) (*ksm.Record, error) {
  881. return generateRecords()[0], nil
  882. },
  883. GetSecretsByTitleFn: func(recordTitle string) (records []*ksm.Record, err error) {
  884. return generateRecords()[0:1], nil
  885. },
  886. SaveFn: func(record *ksm.Record) error {
  887. return errors.New("Unable to save")
  888. },
  889. },
  890. folderID: folderID,
  891. },
  892. args: args{
  893. data: testingfake.PushSecretData{
  894. SecretKey: secretKey,
  895. RemoteKey: validExistingRecord,
  896. },
  897. value: []byte("foo2"),
  898. },
  899. wantErr: true,
  900. },
  901. }
  902. for _, tt := range tests {
  903. t.Run(tt.name, func(t *testing.T) {
  904. c := &Client{
  905. ksmClient: tt.fields.ksmClient,
  906. folderID: tt.fields.folderID,
  907. }
  908. s := &corev1.Secret{Data: map[string][]byte{secretKey: tt.args.value}}
  909. if err := c.PushSecret(context.Background(), s, tt.args.data); (err != nil) != tt.wantErr {
  910. t.Errorf("PushSecret() error = %v, wantErr %v", err, tt.wantErr)
  911. }
  912. })
  913. }
  914. }
  915. func generateRecords() []*ksm.Record {
  916. records := make([]*ksm.Record, 0, 3)
  917. for i := range 3 {
  918. var record ksm.Record
  919. if i == 0 {
  920. record = ksm.Record{
  921. Uid: fmt.Sprintf(RecordNameFormat, i),
  922. RecordDict: map[string]any{
  923. "type": externalSecretType,
  924. "folderUID": folderID,
  925. },
  926. }
  927. } else {
  928. record = ksm.Record{
  929. Uid: fmt.Sprintf(RecordNameFormat, i),
  930. RecordDict: map[string]any{
  931. "type": LoginType,
  932. "folderUID": folderID,
  933. },
  934. }
  935. }
  936. sec := fmt.Sprintf(
  937. "{\"title\":\"record%d\",\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"value\":[\"foo\"]},{\"type\":\"password\",\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host%d\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}]}",
  938. i,
  939. i,
  940. )
  941. record.SetTitle(fmt.Sprintf(RecordNameFormat, i))
  942. record.SetStandardFieldValue(LoginKey, "foo")
  943. record.SetStandardFieldValue(PasswordKey, "bar")
  944. record.RawJson = sec
  945. records = append(records, &record)
  946. }
  947. return records
  948. }
  949. func generateRecordWithLabels() *ksm.Record {
  950. record := ksm.Record{
  951. Uid: recordWithLabels,
  952. RecordDict: map[string]any{
  953. "type": externalSecretType,
  954. "folderUID": folderID,
  955. },
  956. }
  957. // Fields with labels - using label as key
  958. sec := fmt.Sprintf(
  959. "{\"title\":%q,\"type\":\"login\",\"fields\":[{\"type\":\"login\",\"label\":%q,\"value\":[\"foo\"]},{\"type\":\"password\",\"label\":%q,\"value\":[\"bar\"]}],\"custom\":[{\"type\":\"host\",\"label\":\"host0\",\"value\":[{\"hostName\":\"mysql\",\"port\":\"3306\"}]}]}",
  960. recordWithLabels,
  961. UsernameLabel,
  962. PassLabel,
  963. )
  964. record.SetTitle(recordWithLabels)
  965. record.SetStandardFieldValue(LoginKey, "foo")
  966. record.SetStandardFieldValue(PasswordKey, "bar")
  967. record.RawJson = sec
  968. return &record
  969. }