provider.go 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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 implieclient.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package infisical
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. infisicalSdk "github.com/infisical/go-sdk"
  18. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  19. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  20. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  21. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  22. "github.com/external-secrets/external-secrets/pkg/metrics"
  23. "github.com/external-secrets/external-secrets/pkg/provider/infisical/constants"
  24. "github.com/external-secrets/external-secrets/pkg/utils"
  25. "github.com/external-secrets/external-secrets/pkg/utils/resolvers"
  26. )
  27. const (
  28. machineIdentityLoginViaUniversalAuth = "MachineIdentityLoginViaUniversalAuth"
  29. machineIdentityLoginViaAzureAuth = "MachineIdentityLoginViaAzureAuth"
  30. revokeAccessToken = "RevokeAccessToken"
  31. )
  32. type Provider struct {
  33. cancelSdkClient context.CancelFunc
  34. sdkClient infisicalSdk.InfisicalClientInterface
  35. apiScope *InfisicalClientScope
  36. }
  37. type InfisicalClientScope struct {
  38. EnvironmentSlug string
  39. ProjectSlug string
  40. Recursive bool
  41. SecretPath string
  42. ExpandSecretReferences bool
  43. }
  44. // https://github.com/external-secrets/external-secrets/issues/644
  45. var _ esv1.SecretsClient = &Provider{}
  46. var _ esv1.Provider = &Provider{}
  47. func init() {
  48. esv1.Register(&Provider{}, &esv1.SecretStoreProvider{
  49. Infisical: &esv1.InfisicalProvider{},
  50. }, esv1.MaintenanceStatusMaintained)
  51. }
  52. func (p *Provider) Capabilities() esv1.SecretStoreCapabilities {
  53. return esv1.SecretStoreReadOnly
  54. }
  55. func performUniversalAuthLogin(ctx context.Context, store esv1.GenericStore, infisicalSpec *esv1.InfisicalProvider, sdkClient infisicalSdk.InfisicalClientInterface, kube kclient.Client, namespace string) error {
  56. universalAuthCredentials := infisicalSpec.Auth.UniversalAuthCredentials
  57. clientID, err := GetStoreSecretData(ctx, store, kube, namespace, universalAuthCredentials.ClientID)
  58. if err != nil {
  59. return err
  60. }
  61. clientSecret, err := GetStoreSecretData(ctx, store, kube, namespace, universalAuthCredentials.ClientSecret)
  62. if err != nil {
  63. return err
  64. }
  65. _, err = sdkClient.Auth().UniversalAuthLogin(clientID, clientSecret)
  66. metrics.ObserveAPICall(constants.ProviderName, machineIdentityLoginViaUniversalAuth, err)
  67. if err != nil {
  68. return fmt.Errorf("failed to authenticate via universal auth %w", err)
  69. }
  70. return nil
  71. }
  72. func performAzureAuthLogin(ctx context.Context, store esv1.GenericStore, infisicalSpec *esv1.InfisicalProvider, sdkClient infisicalSdk.InfisicalClientInterface, kube kclient.Client, namespace string) error {
  73. azureAuthCredentials := infisicalSpec.Auth.AzureAuthCredentials
  74. identityID, err := GetStoreSecretData(ctx, store, kube, namespace, azureAuthCredentials.IdentityID)
  75. if err != nil {
  76. return fmt.Errorf("failed to get secret data id %w", err)
  77. }
  78. resource := ""
  79. if azureAuthCredentials.Resource.Name != "" {
  80. resource, err = GetStoreSecretData(ctx, store, kube, namespace, azureAuthCredentials.Resource)
  81. if err != nil {
  82. return fmt.Errorf("failed to get secret data resource %w", err)
  83. }
  84. }
  85. _, err = sdkClient.Auth().AzureAuthLogin(identityID, resource)
  86. metrics.ObserveAPICall(constants.ProviderName, machineIdentityLoginViaAzureAuth, err)
  87. if err != nil {
  88. return fmt.Errorf("failed to authenticate via azure auth %w", err)
  89. }
  90. return nil
  91. }
  92. func (p *Provider) NewClient(ctx context.Context, store esv1.GenericStore, kube kclient.Client, namespace string) (esv1.SecretsClient, error) {
  93. storeSpec := store.GetSpec()
  94. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Infisical == nil {
  95. return nil, errors.New("invalid infisical store")
  96. }
  97. infisicalSpec := storeSpec.Provider.Infisical
  98. ctx, cancelSdkClient := context.WithCancel(ctx)
  99. sdkClient := infisicalSdk.NewInfisicalClient(ctx, infisicalSdk.Config{
  100. SiteUrl: infisicalSpec.HostAPI,
  101. })
  102. secretPath := infisicalSpec.SecretsScope.SecretsPath
  103. if secretPath == "" {
  104. secretPath = "/"
  105. }
  106. var loginFn func(ctx context.Context, store esv1.GenericStore, infisicalSpec *esv1.InfisicalProvider, sdkClient infisicalSdk.InfisicalClientInterface, kube kclient.Client, namespace string) error
  107. switch {
  108. case infisicalSpec.Auth.UniversalAuthCredentials != nil:
  109. loginFn = performUniversalAuthLogin
  110. case infisicalSpec.Auth.AzureAuthCredentials != nil:
  111. loginFn = performAzureAuthLogin
  112. default:
  113. cancelSdkClient()
  114. return nil, errors.New("authentication method not found")
  115. }
  116. if err := loginFn(ctx, store, infisicalSpec, sdkClient, kube, namespace); err != nil {
  117. cancelSdkClient()
  118. return nil, err
  119. }
  120. return &Provider{
  121. cancelSdkClient: cancelSdkClient,
  122. sdkClient: sdkClient,
  123. apiScope: &InfisicalClientScope{
  124. EnvironmentSlug: infisicalSpec.SecretsScope.EnvironmentSlug,
  125. ProjectSlug: infisicalSpec.SecretsScope.ProjectSlug,
  126. Recursive: infisicalSpec.SecretsScope.Recursive,
  127. SecretPath: secretPath,
  128. ExpandSecretReferences: infisicalSpec.SecretsScope.ExpandSecretReferences,
  129. },
  130. }, nil
  131. }
  132. func (p *Provider) Close(ctx context.Context) error {
  133. p.cancelSdkClient()
  134. err := p.sdkClient.Auth().RevokeAccessToken()
  135. metrics.ObserveAPICall(constants.ProviderName, revokeAccessToken, err)
  136. return err
  137. }
  138. func GetStoreSecretData(ctx context.Context, store esv1.GenericStore, kube kclient.Client, namespace string, secret esmeta.SecretKeySelector) (string, error) {
  139. secretRef := esmeta.SecretKeySelector{
  140. Name: secret.Name,
  141. Key: secret.Key,
  142. }
  143. if secret.Namespace != nil {
  144. secretRef.Namespace = secret.Namespace
  145. }
  146. secretData, err := resolvers.SecretKeyRef(ctx, kube, store.GetObjectKind().GroupVersionKind().Kind, namespace, &secretRef)
  147. if err != nil {
  148. return "", err
  149. }
  150. return secretData, nil
  151. }
  152. func (p *Provider) ValidateStore(store esv1.GenericStore) (admission.Warnings, error) {
  153. storeSpec := store.GetSpec()
  154. infisicalStoreSpec := storeSpec.Provider.Infisical
  155. if infisicalStoreSpec == nil {
  156. return nil, errors.New("invalid infisical store")
  157. }
  158. if infisicalStoreSpec.SecretsScope.EnvironmentSlug == "" || infisicalStoreSpec.SecretsScope.ProjectSlug == "" {
  159. return nil, errors.New("secretsScope.projectSlug and secretsScope.environmentSlug cannot be empty")
  160. }
  161. if infisicalStoreSpec.Auth.UniversalAuthCredentials != nil {
  162. uaCredential := infisicalStoreSpec.Auth.UniversalAuthCredentials
  163. // to validate reference authentication
  164. err := utils.ValidateReferentSecretSelector(store, uaCredential.ClientID)
  165. if err != nil {
  166. return nil, err
  167. }
  168. err = utils.ValidateReferentSecretSelector(store, uaCredential.ClientSecret)
  169. if err != nil {
  170. return nil, err
  171. }
  172. if uaCredential.ClientID.Key == "" || uaCredential.ClientSecret.Key == "" {
  173. return nil, errors.New("universalAuthCredentials.clientId and universalAuthCredentials.clientSecret cannot be empty")
  174. }
  175. }
  176. return nil, nil
  177. }