keyvault.go 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  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 keyvault implements a provider for Azure Key Vault secrets, allowing
  14. // External Secrets to read from and write to Azure Key Vault.
  15. package keyvault
  16. import (
  17. "context"
  18. "crypto/x509"
  19. b64 "encoding/base64"
  20. "encoding/json"
  21. "encoding/pem"
  22. "errors"
  23. "fmt"
  24. "os"
  25. "path"
  26. "path/filepath"
  27. "regexp"
  28. "strings"
  29. "time"
  30. "github.com/Azure/azure-sdk-for-go/sdk/azcore"
  31. "github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azcertificates"
  32. "github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys"
  33. "github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azsecrets"
  34. "github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault"
  35. "github.com/Azure/go-autorest/autorest"
  36. "github.com/Azure/go-autorest/autorest/adal"
  37. "github.com/Azure/go-autorest/autorest/azure"
  38. kvauth "github.com/Azure/go-autorest/autorest/azure/auth"
  39. "github.com/Azure/go-autorest/autorest/date"
  40. "github.com/AzureAD/microsoft-authentication-library-for-go/apps/confidential"
  41. "github.com/lestrrat-go/jwx/v2/jwk"
  42. "github.com/tidwall/gjson"
  43. "golang.org/x/crypto/sha3"
  44. authv1 "k8s.io/api/authentication/v1"
  45. corev1 "k8s.io/api/core/v1"
  46. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  47. "k8s.io/apimachinery/pkg/types"
  48. "k8s.io/client-go/kubernetes"
  49. kcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
  50. pointer "k8s.io/utils/ptr"
  51. "sigs.k8s.io/controller-runtime/pkg/client"
  52. ctrlcfg "sigs.k8s.io/controller-runtime/pkg/client/config"
  53. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  54. gopkcs12 "software.sslmate.com/src/go-pkcs12"
  55. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  56. "github.com/external-secrets/external-secrets/pkg/constants"
  57. "github.com/external-secrets/external-secrets/pkg/esutils"
  58. "github.com/external-secrets/external-secrets/pkg/esutils/metadata"
  59. "github.com/external-secrets/external-secrets/pkg/esutils/resolvers"
  60. "github.com/external-secrets/external-secrets/pkg/metrics"
  61. )
  62. const (
  63. defaultObjType = "secret"
  64. objectTypeCert = "cert"
  65. objectTypeKey = "key"
  66. // AzureDefaultAudience is the default audience used for Azure AD token exchange.
  67. AzureDefaultAudience = "api://AzureADTokenExchange"
  68. // AnnotationClientID is the annotation key for Azure Workload Identity client ID.
  69. AnnotationClientID = "azure.workload.identity/client-id"
  70. // AnnotationTenantID is the annotation key for Azure Workload Identity tenant ID.
  71. AnnotationTenantID = "azure.workload.identity/tenant-id"
  72. managerLabel = "external-secrets"
  73. managedBy = "managed-by"
  74. errUnexpectedStoreSpec = "unexpected store spec"
  75. errMissingAuthType = "cannot initialize Azure Client: no valid authType was specified"
  76. errPropNotExist = "property %s does not exist in key %s"
  77. errTagNotExist = "tag %s does not exist"
  78. errUnknownObjectType = "unknown Azure Keyvault object Type for %s"
  79. errUnmarshalJSONData = "error unmarshalling json data: %w"
  80. errDataFromCert = "cannot get use dataFrom to get certificate secret"
  81. errDataFromKey = "cannot get use dataFrom to get key secret"
  82. errMissingTenant = "missing tenantID in store config"
  83. errMissingClient = "missing clientID: either serviceAccountRef or service account annotation '%s' is missing"
  84. errMissingSecretRef = "missing secretRef in provider config"
  85. errMissingClientIDSecret = "missing accessKeyID/secretAccessKey in store config"
  86. errInvalidClientCredentials = "both clientSecret and clientCredentials set"
  87. errMultipleClientID = "multiple clientID found. Check secretRef and serviceAccountRef"
  88. errMultipleTenantID = "multiple tenantID found. Check secretRef, 'spec.provider.azurekv.tenantId', and serviceAccountRef"
  89. errInvalidStore = "invalid store"
  90. errInvalidStoreSpec = "invalid store spec"
  91. errInvalidStoreProv = "invalid store provider"
  92. errInvalidAzureProv = "invalid azure keyvault provider"
  93. errInvalidSecRefClientID = "invalid AuthSecretRef.ClientID: %w"
  94. errInvalidSecRefClientSecret = "invalid AuthSecretRef.ClientSecret: %w"
  95. errInvalidSARef = "invalid ServiceAccountRef: %w"
  96. errMissingWorkloadEnvVars = "missing environment variables. AZURE_CLIENT_ID, AZURE_TENANT_ID and AZURE_FEDERATED_TOKEN_FILE must be set"
  97. errReadTokenFile = "unable to read token file %s: %w"
  98. )
  99. // https://github.com/external-secrets/external-secrets/issues/644
  100. var _ esv1.SecretsClient = &Azure{}
  101. var _ esv1.Provider = &Azure{}
  102. // SecretClient is an interface to keyvault.BaseClient.
  103. type SecretClient interface {
  104. GetKey(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string) (result keyvault.KeyBundle, err error)
  105. GetSecret(ctx context.Context, vaultBaseURL string, secretName string, secretVersion string) (result keyvault.SecretBundle, err error)
  106. GetSecretsComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result keyvault.SecretListResultIterator, err error)
  107. GetCertificate(ctx context.Context, vaultBaseURL string, certificateName string, certificateVersion string) (result keyvault.CertificateBundle, err error)
  108. SetSecret(ctx context.Context, vaultBaseURL string, secretName string, parameters keyvault.SecretSetParameters) (result keyvault.SecretBundle, err error)
  109. ImportKey(ctx context.Context, vaultBaseURL string, keyName string, parameters keyvault.KeyImportParameters) (result keyvault.KeyBundle, err error)
  110. ImportCertificate(ctx context.Context, vaultBaseURL string, certificateName string, parameters keyvault.CertificateImportParameters) (result keyvault.CertificateBundle, err error)
  111. DeleteCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result keyvault.DeletedCertificateBundle, err error)
  112. DeleteKey(ctx context.Context, vaultBaseURL string, keyName string) (result keyvault.DeletedKeyBundle, err error)
  113. DeleteSecret(ctx context.Context, vaultBaseURL string, secretName string) (result keyvault.DeletedSecretBundle, err error)
  114. }
  115. // Azure implements the External Secrets provider for Azure Key Vault.
  116. type Azure struct {
  117. crClient client.Client
  118. kubeClient kcorev1.CoreV1Interface
  119. store esv1.GenericStore
  120. provider *esv1.AzureKVProvider
  121. namespace string
  122. // Legacy go-autorest client
  123. baseClient SecretClient
  124. // New Azure SDK clients (used when UseAzureSDK is true)
  125. secretsClient *azsecrets.Client
  126. keysClient *azkeys.Client
  127. certsClient *azcertificates.Client
  128. }
  129. // PushSecretMetadataSpec defines metadata for pushing secrets to Azure Key Vault,
  130. // including expiration date and tags.
  131. type PushSecretMetadataSpec struct {
  132. ExpirationDate string `json:"expirationDate,omitempty"`
  133. Tags map[string]string `json:"tags,omitempty"`
  134. }
  135. func init() {
  136. esv1.Register(&Azure{}, &esv1.SecretStoreProvider{
  137. AzureKV: &esv1.AzureKVProvider{},
  138. }, esv1.MaintenanceStatusMaintained)
  139. }
  140. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  141. func (a *Azure) Capabilities() esv1.SecretStoreCapabilities {
  142. return esv1.SecretStoreReadWrite
  143. }
  144. // NewClient constructs a new secrets client based on the provided store.
  145. func (a *Azure) NewClient(ctx context.Context, store esv1.GenericStore, kube client.Client, namespace string) (esv1.SecretsClient, error) {
  146. return newClient(ctx, store, kube, namespace)
  147. }
  148. func newClient(ctx context.Context, store esv1.GenericStore, kube client.Client, namespace string) (esv1.SecretsClient, error) {
  149. provider, err := getProvider(store)
  150. if err != nil {
  151. return nil, err
  152. }
  153. cfg, err := ctrlcfg.GetConfig()
  154. if err != nil {
  155. return nil, err
  156. }
  157. kubeClient, err := kubernetes.NewForConfig(cfg)
  158. if err != nil {
  159. return nil, err
  160. }
  161. az := &Azure{
  162. crClient: kube,
  163. kubeClient: kubeClient.CoreV1(),
  164. store: store,
  165. namespace: namespace,
  166. provider: provider,
  167. }
  168. // allow SecretStore controller validation to pass
  169. // when using referent namespace.
  170. if store.GetKind() == esv1.ClusterSecretStoreKind &&
  171. namespace == "" &&
  172. isReferentSpec(provider) {
  173. return az, nil
  174. }
  175. // Check if the new Azure SDK should be used
  176. if provider.UseAzureSDK != nil && *provider.UseAzureSDK {
  177. err = initializeNewAzureSDK(ctx, az)
  178. } else {
  179. err = initializeLegacyClient(ctx, az)
  180. }
  181. return az, err
  182. }
  183. // initializeLegacyClient sets up the Azure Key Vault client using the legacy go-autorest SDK.
  184. func initializeLegacyClient(ctx context.Context, az *Azure) error {
  185. var authorizer autorest.Authorizer
  186. var err error
  187. switch *az.provider.AuthType {
  188. case esv1.AzureManagedIdentity:
  189. authorizer, err = az.authorizerForManagedIdentity()
  190. case esv1.AzureServicePrincipal:
  191. authorizer, err = az.authorizerForServicePrincipal(ctx)
  192. case esv1.AzureWorkloadIdentity:
  193. authorizer, err = az.authorizerForWorkloadIdentity(ctx, NewTokenProvider)
  194. default:
  195. return errors.New(errMissingAuthType)
  196. }
  197. if err != nil {
  198. return err
  199. }
  200. cl := keyvault.New()
  201. cl.Authorizer = authorizer
  202. az.baseClient = &cl
  203. return nil
  204. }
  205. // initializeNewAzureSDK sets up the Azure Key Vault client using the new azcore-based SDK.
  206. func initializeNewAzureSDK(ctx context.Context, az *Azure) error {
  207. // Get cloud configuration
  208. cloudConfig, err := getCloudConfiguration(az.provider)
  209. if err != nil {
  210. return fmt.Errorf("failed to get cloud configuration: %w", err)
  211. }
  212. // Build credential based on auth type
  213. var credential azcore.TokenCredential
  214. switch *az.provider.AuthType {
  215. case esv1.AzureManagedIdentity:
  216. credential, err = buildManagedIdentityCredential(az, cloudConfig)
  217. case esv1.AzureServicePrincipal:
  218. credential, err = buildServicePrincipalCredential(ctx, az, cloudConfig)
  219. case esv1.AzureWorkloadIdentity:
  220. credential, err = buildWorkloadIdentityCredential(ctx, az, cloudConfig)
  221. default:
  222. return errors.New(errMissingAuthType)
  223. }
  224. if err != nil {
  225. return err
  226. }
  227. // Create Azure SDK clients and store them directly
  228. az.secretsClient, err = azsecrets.NewClient(*az.provider.VaultURL, credential, &azsecrets.ClientOptions{
  229. ClientOptions: azcore.ClientOptions{Cloud: cloudConfig},
  230. })
  231. if err != nil {
  232. return fmt.Errorf("failed to create secrets client: %w", err)
  233. }
  234. az.keysClient, err = azkeys.NewClient(*az.provider.VaultURL, credential, &azkeys.ClientOptions{
  235. ClientOptions: azcore.ClientOptions{Cloud: cloudConfig},
  236. })
  237. if err != nil {
  238. return fmt.Errorf("failed to create keys client: %w", err)
  239. }
  240. az.certsClient, err = azcertificates.NewClient(*az.provider.VaultURL, credential, &azcertificates.ClientOptions{
  241. ClientOptions: azcore.ClientOptions{Cloud: cloudConfig},
  242. })
  243. if err != nil {
  244. return fmt.Errorf("failed to create certificates client: %w", err)
  245. }
  246. return nil
  247. }
  248. // useNewSDK returns true if the new Azure SDK should be used.
  249. func (a *Azure) useNewSDK() bool {
  250. return a.provider.UseAzureSDK != nil && *a.provider.UseAzureSDK
  251. }
  252. func getProvider(store esv1.GenericStore) (*esv1.AzureKVProvider, error) {
  253. spc := store.GetSpec()
  254. if spc == nil || spc.Provider.AzureKV == nil {
  255. return nil, errors.New(errUnexpectedStoreSpec)
  256. }
  257. return spc.Provider.AzureKV, nil
  258. }
  259. // ValidateStore validates the Azure Key Vault provider configuration.
  260. func (a *Azure) ValidateStore(store esv1.GenericStore) (admission.Warnings, error) {
  261. if store == nil {
  262. return nil, errors.New(errInvalidStore)
  263. }
  264. spc := store.GetSpec()
  265. if spc == nil {
  266. return nil, errors.New(errInvalidStoreSpec)
  267. }
  268. if spc.Provider == nil {
  269. return nil, errors.New(errInvalidStoreProv)
  270. }
  271. p := spc.Provider.AzureKV
  272. if p == nil {
  273. return nil, errors.New(errInvalidAzureProv)
  274. }
  275. if p.AuthSecretRef != nil {
  276. if p.AuthSecretRef.ClientID != nil {
  277. if err := esutils.ValidateReferentSecretSelector(store, *p.AuthSecretRef.ClientID); err != nil {
  278. return nil, fmt.Errorf(errInvalidSecRefClientID, err)
  279. }
  280. }
  281. if p.AuthSecretRef.ClientSecret != nil {
  282. if err := esutils.ValidateReferentSecretSelector(store, *p.AuthSecretRef.ClientSecret); err != nil {
  283. return nil, fmt.Errorf(errInvalidSecRefClientSecret, err)
  284. }
  285. }
  286. }
  287. if p.ServiceAccountRef != nil {
  288. if err := esutils.ValidateReferentServiceAccountSelector(store, *p.ServiceAccountRef); err != nil {
  289. return nil, fmt.Errorf(errInvalidSARef, err)
  290. }
  291. }
  292. // Validate Azure Stack Cloud configuration
  293. if p.EnvironmentType == esv1.AzureEnvironmentAzureStackCloud {
  294. // Azure Stack requires custom cloud config
  295. if p.CustomCloudConfig == nil {
  296. return nil, errors.New("CustomCloudConfig is required when EnvironmentType is AzureStackCloud")
  297. }
  298. // Azure Stack requires new SDK
  299. if p.UseAzureSDK == nil || !*p.UseAzureSDK {
  300. return nil, errors.New("AzureStackCloud environment requires UseAzureSDK to be set to true - the legacy SDK does not support custom clouds")
  301. }
  302. // Validate required fields
  303. if p.CustomCloudConfig.ActiveDirectoryEndpoint == "" {
  304. return nil, errors.New("activeDirectoryEndpoint is required in CustomCloudConfig")
  305. }
  306. } else if p.CustomCloudConfig != nil {
  307. // CustomCloudConfig should only be used with AzureStackCloud
  308. return nil, errors.New("CustomCloudConfig should only be specified when EnvironmentType is AzureStackCloud")
  309. }
  310. return nil, nil
  311. }
  312. func canDelete(tags map[string]*string, err error) (bool, error) {
  313. aerr := &autorest.DetailedError{}
  314. conv := errors.As(err, aerr)
  315. if err != nil && !conv {
  316. return false, fmt.Errorf("could not parse error: %w", err)
  317. }
  318. if conv && aerr.StatusCode != 404 { // Secret is already deleted, nothing to do.
  319. return false, fmt.Errorf("unexpected api error: %w", err)
  320. }
  321. if aerr.StatusCode == 404 {
  322. return false, nil
  323. }
  324. manager, ok := tags[managedBy]
  325. if !ok || manager == nil || *manager != managerLabel {
  326. return false, errors.New("not managed by external-secrets")
  327. }
  328. return true, nil
  329. }
  330. func (a *Azure) deleteKeyVaultKey(ctx context.Context, keyName string) error {
  331. value, err := a.baseClient.GetKey(ctx, *a.provider.VaultURL, keyName, "")
  332. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetKey, err)
  333. ok, err := canDelete(value.Tags, err)
  334. if err != nil {
  335. return fmt.Errorf("error getting key %v: %w", keyName, err)
  336. }
  337. if ok {
  338. _, err = a.baseClient.DeleteKey(ctx, *a.provider.VaultURL, keyName)
  339. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVDeleteKey, err)
  340. if err != nil {
  341. return fmt.Errorf("error deleting key %v: %w", keyName, err)
  342. }
  343. }
  344. return nil
  345. }
  346. func (a *Azure) deleteKeyVaultSecret(ctx context.Context, secretName string) error {
  347. value, err := a.baseClient.GetSecret(ctx, *a.provider.VaultURL, secretName, "")
  348. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  349. ok, err := canDelete(value.Tags, err)
  350. if err != nil {
  351. return fmt.Errorf("error getting secret %v: %w", secretName, err)
  352. }
  353. if ok {
  354. _, err = a.baseClient.DeleteSecret(ctx, *a.provider.VaultURL, secretName)
  355. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVDeleteSecret, err)
  356. if err != nil {
  357. return fmt.Errorf("error deleting secret %v: %w", secretName, err)
  358. }
  359. }
  360. return nil
  361. }
  362. func (a *Azure) deleteKeyVaultCertificate(ctx context.Context, certName string) error {
  363. value, err := a.baseClient.GetCertificate(ctx, *a.provider.VaultURL, certName, "")
  364. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetCertificate, err)
  365. ok, err := canDelete(value.Tags, err)
  366. if err != nil {
  367. return fmt.Errorf("error getting certificate %v: %w", certName, err)
  368. }
  369. if ok {
  370. _, err = a.baseClient.DeleteCertificate(ctx, *a.provider.VaultURL, certName)
  371. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVDeleteCertificate, err)
  372. if err != nil {
  373. return fmt.Errorf("error deleting certificate %v: %w", certName, err)
  374. }
  375. }
  376. return nil
  377. }
  378. // DeleteSecret deletes a secret from Azure Key Vault.
  379. func (a *Azure) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
  380. objectType, secretName := getObjType(esv1.ExternalSecretDataRemoteRef{Key: remoteRef.GetRemoteKey()})
  381. switch objectType {
  382. case defaultObjType:
  383. if a.useNewSDK() {
  384. return a.deleteKeyVaultSecretWithNewSDK(ctx, secretName)
  385. }
  386. return a.deleteKeyVaultSecret(ctx, secretName)
  387. case objectTypeCert:
  388. if a.useNewSDK() {
  389. return a.deleteKeyVaultCertificateWithNewSDK(ctx, secretName)
  390. }
  391. return a.deleteKeyVaultCertificate(ctx, secretName)
  392. case objectTypeKey:
  393. if a.useNewSDK() {
  394. return a.deleteKeyVaultKeyWithNewSDK(ctx, secretName)
  395. }
  396. return a.deleteKeyVaultKey(ctx, secretName)
  397. default:
  398. return fmt.Errorf("secret type '%v' is not supported", objectType)
  399. }
  400. }
  401. // SecretExists checks if a secret exists in Azure Key Vault.
  402. func (a *Azure) SecretExists(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) (bool, error) {
  403. if a.useNewSDK() {
  404. return a.secretExistsWithNewSDK(ctx, remoteRef)
  405. }
  406. objectType, secretName := getObjType(esv1.ExternalSecretDataRemoteRef{Key: remoteRef.GetRemoteKey()})
  407. var err error
  408. switch objectType {
  409. case defaultObjType:
  410. _, err = a.baseClient.GetSecret(ctx, *a.provider.VaultURL, secretName, "")
  411. case objectTypeCert:
  412. _, err = a.baseClient.GetCertificate(ctx, *a.provider.VaultURL, secretName, "")
  413. case objectTypeKey:
  414. _, err = a.baseClient.GetKey(ctx, *a.provider.VaultURL, secretName, "")
  415. default:
  416. errMsg := fmt.Sprintf("secret type '%v' is not supported", objectType)
  417. return false, errors.New(errMsg)
  418. }
  419. err = parseError(err)
  420. if err != nil {
  421. var noSecretErr esv1.NoSecretError
  422. if errors.As(err, &noSecretErr) {
  423. return false, nil
  424. }
  425. return false, err
  426. }
  427. return true, nil
  428. }
  429. func getCertificateFromValue(value []byte) (*x509.Certificate, error) {
  430. // 1st: try decode pkcs12
  431. _, localCert, err := gopkcs12.Decode(value, "")
  432. if err == nil {
  433. return localCert, nil
  434. }
  435. // 2nd: try decode pkcs12 with chain
  436. _, localCert, _, err = gopkcs12.DecodeChain(value, "")
  437. if err == nil {
  438. return localCert, nil
  439. }
  440. // 3rd: try DER
  441. localCert, err = x509.ParseCertificate(value)
  442. if err == nil {
  443. return localCert, nil
  444. }
  445. // 4th: parse PEM blocks
  446. for {
  447. block, rest := pem.Decode(value)
  448. value = rest
  449. if block == nil {
  450. break
  451. }
  452. cert, err := x509.ParseCertificate(block.Bytes)
  453. if err == nil {
  454. return cert, nil
  455. }
  456. }
  457. return nil, errors.New("could not parse certificate value as PKCS#12, DER or PEM")
  458. }
  459. func getKeyFromValue(value []byte) (any, error) {
  460. val := value
  461. pemBlock, _ := pem.Decode(value)
  462. // if a private key regular expression doesn't match, we should consider this key to be symmetric
  463. if pemBlock == nil {
  464. return val, nil
  465. }
  466. val = pemBlock.Bytes
  467. switch pemBlock.Type {
  468. case "PRIVATE KEY":
  469. return x509.ParsePKCS8PrivateKey(val)
  470. case "RSA PRIVATE KEY":
  471. return x509.ParsePKCS1PrivateKey(val)
  472. case "EC PRIVATE KEY":
  473. return x509.ParseECPrivateKey(val)
  474. default:
  475. return nil, fmt.Errorf("key type %v is not supported", pemBlock.Type)
  476. }
  477. }
  478. func canCreate(tags map[string]*string, err error) (bool, error) {
  479. aerr := &autorest.DetailedError{}
  480. conv := errors.As(err, aerr)
  481. if err != nil && !conv {
  482. return false, fmt.Errorf("could not parse error: %w", err)
  483. }
  484. if conv && aerr.StatusCode != 404 {
  485. return false, fmt.Errorf("unexpected api error: %w", err)
  486. }
  487. if err == nil {
  488. manager, ok := tags[managedBy]
  489. if !ok || manager == nil || *manager != managerLabel {
  490. return false, errors.New("not managed by external-secrets")
  491. }
  492. }
  493. return true, nil
  494. }
  495. func (a *Azure) setKeyVaultSecret(ctx context.Context, secretName string, value []byte, expires *date.UnixTime, tags map[string]string) error {
  496. secret, err := a.baseClient.GetSecret(ctx, *a.provider.VaultURL, secretName, "")
  497. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  498. ok, err := canCreate(secret.Tags, err)
  499. if err != nil {
  500. return fmt.Errorf("cannot get secret %v: %w", secretName, err)
  501. }
  502. if !ok {
  503. return nil
  504. }
  505. val := string(value)
  506. if secret.Value != nil && val == *secret.Value {
  507. if secret.Attributes != nil {
  508. if (secret.Attributes.Expires == nil && expires == nil) ||
  509. (secret.Attributes.Expires != nil && expires != nil && *secret.Attributes.Expires == *expires) {
  510. return nil
  511. }
  512. }
  513. }
  514. secretParams := keyvault.SecretSetParameters{
  515. Value: &val,
  516. Tags: map[string]*string{
  517. managedBy: pointer.To(managerLabel),
  518. },
  519. SecretAttributes: &keyvault.SecretAttributes{
  520. Enabled: pointer.To(true),
  521. },
  522. }
  523. for k, v := range tags {
  524. secretParams.Tags[k] = &v
  525. }
  526. if expires != nil {
  527. secretParams.SecretAttributes.Expires = expires
  528. }
  529. _, err = a.baseClient.SetSecret(ctx, *a.provider.VaultURL, secretName, secretParams)
  530. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  531. if err != nil {
  532. return fmt.Errorf("could not set secret %v: %w", secretName, err)
  533. }
  534. return nil
  535. }
  536. func (a *Azure) setKeyVaultCertificate(ctx context.Context, secretName string, value []byte, tags map[string]string) error {
  537. val := b64.StdEncoding.EncodeToString(value)
  538. localCert, err := getCertificateFromValue(value)
  539. if err != nil {
  540. return fmt.Errorf("value from secret is not a valid certificate: %w", err)
  541. }
  542. cert, err := a.baseClient.GetCertificate(ctx, *a.provider.VaultURL, secretName, "")
  543. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetCertificate, err)
  544. ok, err := canCreate(cert.Tags, err)
  545. if err != nil {
  546. return fmt.Errorf("cannot get certificate %v: %w", secretName, err)
  547. }
  548. if !ok {
  549. return nil
  550. }
  551. b512 := sha3.Sum512(localCert.Raw)
  552. if cert.Cer != nil && b512 == sha3.Sum512(*cert.Cer) {
  553. return nil
  554. }
  555. params := keyvault.CertificateImportParameters{
  556. Base64EncodedCertificate: &val,
  557. Tags: map[string]*string{
  558. managedBy: pointer.To(managerLabel),
  559. },
  560. }
  561. for k, v := range tags {
  562. params.Tags[k] = &v
  563. }
  564. _, err = a.baseClient.ImportCertificate(ctx, *a.provider.VaultURL, secretName, params)
  565. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVImportCertificate, err)
  566. if err != nil {
  567. return fmt.Errorf("could not import certificate %v: %w", secretName, err)
  568. }
  569. return nil
  570. }
  571. func equalKeys(newKey, oldKey keyvault.JSONWebKey) bool {
  572. // checks for everything except KeyID and KeyOps
  573. rsaCheck := newKey.E != nil && oldKey.E != nil && *newKey.E == *oldKey.E &&
  574. newKey.N != nil && oldKey.N != nil && *newKey.N == *oldKey.N
  575. symmetricCheck := newKey.Crv == oldKey.Crv &&
  576. newKey.T != nil && oldKey.T != nil && *newKey.T == *oldKey.T &&
  577. newKey.X != nil && oldKey.X != nil && *newKey.X == *oldKey.X &&
  578. newKey.Y != nil && oldKey.Y != nil && *newKey.Y == *oldKey.Y
  579. return newKey.Kty == oldKey.Kty && (rsaCheck || symmetricCheck)
  580. }
  581. func (a *Azure) setKeyVaultKey(ctx context.Context, secretName string, value []byte, tags map[string]string) error {
  582. key, err := getKeyFromValue(value)
  583. if err != nil {
  584. return fmt.Errorf("could not load private key %v: %w", secretName, err)
  585. }
  586. jwKey, err := jwk.FromRaw(key)
  587. if err != nil {
  588. return fmt.Errorf("failed to generate a JWK from secret %v content: %w", secretName, err)
  589. }
  590. buf, err := json.Marshal(jwKey)
  591. if err != nil {
  592. return fmt.Errorf("error parsing key: %w", err)
  593. }
  594. azkey := keyvault.JSONWebKey{}
  595. err = json.Unmarshal(buf, &azkey)
  596. if err != nil {
  597. return fmt.Errorf("error unmarshalling key: %w", err)
  598. }
  599. keyFromVault, err := a.baseClient.GetKey(ctx, *a.provider.VaultURL, secretName, "")
  600. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetKey, err)
  601. ok, err := canCreate(keyFromVault.Tags, err)
  602. if err != nil {
  603. return fmt.Errorf("cannot get key %v: %w", secretName, err)
  604. }
  605. if !ok {
  606. return nil
  607. }
  608. if keyFromVault.Key != nil && equalKeys(azkey, *keyFromVault.Key) {
  609. return nil
  610. }
  611. params := keyvault.KeyImportParameters{
  612. Key: &azkey,
  613. KeyAttributes: &keyvault.KeyAttributes{},
  614. Tags: map[string]*string{
  615. managedBy: pointer.To(managerLabel),
  616. },
  617. }
  618. for k, v := range tags {
  619. params.Tags[k] = &v
  620. }
  621. _, err = a.baseClient.ImportKey(ctx, *a.provider.VaultURL, secretName, params)
  622. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVImportKey, err)
  623. if err != nil {
  624. return fmt.Errorf("could not import key %v: %w", secretName, err)
  625. }
  626. return nil
  627. }
  628. func getSecretKey(secret *corev1.Secret, data esv1.PushSecretData) ([]byte, error) {
  629. if data.GetSecretKey() != "" {
  630. return secret.Data[data.GetSecretKey()], nil
  631. }
  632. // Must convert secret values to string, otherwise data will be sent as base64 to Vault
  633. secretStringVal := make(map[string]string)
  634. for k, v := range secret.Data {
  635. secretStringVal[k] = string(v)
  636. }
  637. value, err := esutils.JSONMarshal(secretStringVal)
  638. if err != nil {
  639. return nil, fmt.Errorf("failed to serialize secret content as JSON: %w", err)
  640. }
  641. return value, nil
  642. }
  643. // PushSecret stores secrets into a Key vault instance.
  644. func (a *Azure) PushSecret(ctx context.Context, secret *corev1.Secret, data esv1.PushSecretData) error {
  645. var (
  646. value []byte
  647. err error
  648. expires *date.UnixTime
  649. tags map[string]string
  650. )
  651. if value, err = getSecretKey(secret, data); err != nil {
  652. return err
  653. }
  654. metadata, err := metadata.ParseMetadataParameters[PushSecretMetadataSpec](data.GetMetadata())
  655. if err != nil {
  656. return fmt.Errorf("failed to parse push secret metadata: %w", err)
  657. }
  658. if metadata != nil && metadata.Spec.ExpirationDate != "" {
  659. t, err := time.Parse(time.RFC3339, metadata.Spec.ExpirationDate)
  660. if err != nil {
  661. return fmt.Errorf("error parsing expiration date in metadata: %w. Expected format: YYYY-MM-DDTHH:MM:SSZ (RFC3339). Example: 2024-12-31T20:00:00Z", err)
  662. }
  663. unixTime := date.UnixTime(t)
  664. expires = &unixTime
  665. }
  666. if metadata != nil && metadata.Spec.Tags != nil {
  667. if _, exists := metadata.Spec.Tags[managedBy]; exists {
  668. return fmt.Errorf("error parsing tags in metadata: Cannot specify a '%s' tag", managedBy)
  669. }
  670. tags = metadata.Spec.Tags
  671. }
  672. objectType, secretName := getObjType(esv1.ExternalSecretDataRemoteRef{Key: data.GetRemoteKey()})
  673. switch objectType {
  674. case defaultObjType:
  675. if a.useNewSDK() {
  676. return a.setKeyVaultSecretWithNewSDK(ctx, secretName, value, nil, tags)
  677. }
  678. return a.setKeyVaultSecret(ctx, secretName, value, expires, tags)
  679. case objectTypeCert:
  680. if a.useNewSDK() {
  681. return a.setKeyVaultCertificateWithNewSDK(ctx, secretName, value, tags)
  682. }
  683. return a.setKeyVaultCertificate(ctx, secretName, value, tags)
  684. case objectTypeKey:
  685. if a.useNewSDK() {
  686. return a.setKeyVaultKeyWithNewSDK(ctx, secretName, value, tags)
  687. }
  688. return a.setKeyVaultKey(ctx, secretName, value, tags)
  689. default:
  690. return fmt.Errorf("secret type %v not supported", objectType)
  691. }
  692. }
  693. // GetAllSecrets implements store.Client.GetAllSecrets Interface.
  694. // Retrieves a map[string][]byte with the secret names as key and the secret itself as the calue.
  695. func (a *Azure) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  696. if a.useNewSDK() {
  697. return a.getAllSecretsWithNewSDK(ctx, ref)
  698. }
  699. return a.getAllSecretsWithLegacySDK(ctx, ref)
  700. }
  701. func (a *Azure) getAllSecretsWithLegacySDK(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  702. basicClient := a.baseClient
  703. secretsMap := make(map[string][]byte)
  704. checkTags := len(ref.Tags) > 0
  705. checkName := ref.Name != nil && ref.Name.RegExp != ""
  706. secretListIter, err := basicClient.GetSecretsComplete(ctx, *a.provider.VaultURL, nil)
  707. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecrets, err)
  708. err = parseError(err)
  709. if err != nil {
  710. return nil, err
  711. }
  712. for secretListIter.NotDone() {
  713. secret := secretListIter.Value()
  714. ok, secretName := isValidSecret(checkTags, checkName, ref, secret)
  715. if !ok {
  716. err = secretListIter.Next()
  717. if err != nil {
  718. return nil, err
  719. }
  720. continue
  721. }
  722. secretResp, err := basicClient.GetSecret(ctx, *a.provider.VaultURL, secretName, "")
  723. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  724. err = parseError(err)
  725. if err != nil {
  726. return nil, err
  727. }
  728. secretValue := *secretResp.Value
  729. secretsMap[secretName] = []byte(secretValue)
  730. err = secretListIter.Next()
  731. if err != nil {
  732. return nil, err
  733. }
  734. }
  735. return secretsMap, nil
  736. }
  737. // Retrieves a tag value if specified and all tags in JSON format if not.
  738. func getSecretTag(tags map[string]*string, property string) ([]byte, error) {
  739. if property == "" {
  740. secretTagsData := make(map[string]string)
  741. for k, v := range tags {
  742. secretTagsData[k] = *v
  743. }
  744. return json.Marshal(secretTagsData)
  745. }
  746. if val, exist := tags[property]; exist {
  747. return []byte(*val), nil
  748. }
  749. idx := strings.Index(property, ".")
  750. if idx < 0 {
  751. return nil, fmt.Errorf(errTagNotExist, property)
  752. }
  753. if idx > 0 {
  754. tagName := property[0:idx]
  755. if val, exist := tags[tagName]; exist {
  756. key := strings.Replace(property, tagName+".", "", 1)
  757. return getProperty(*val, key, property)
  758. }
  759. }
  760. return nil, fmt.Errorf(errTagNotExist, property)
  761. }
  762. // Retrieves a property value if specified and the secret value if not.
  763. func getProperty(secret, property, key string) ([]byte, error) {
  764. if property == "" {
  765. return []byte(secret), nil
  766. }
  767. res := gjson.Get(secret, property)
  768. if !res.Exists() {
  769. idx := strings.Index(property, ".")
  770. if idx < 0 {
  771. return nil, fmt.Errorf(errPropNotExist, property, key)
  772. }
  773. escaped := strings.ReplaceAll(property, ".", "\\.")
  774. jValue := gjson.Get(secret, escaped)
  775. if jValue.Exists() {
  776. return []byte(jValue.String()), nil
  777. }
  778. return nil, fmt.Errorf(errPropNotExist, property, key)
  779. }
  780. return []byte(res.String()), nil
  781. }
  782. func parseError(err error) error {
  783. aerr := autorest.DetailedError{}
  784. if errors.As(err, &aerr) && aerr.StatusCode == 404 {
  785. return esv1.NoSecretError{}
  786. }
  787. return err
  788. }
  789. // GetSecret implements store.Client.GetSecret Interface.
  790. // Retrieves a secret/Key/Certificate/Tag with the secret name defined in ref.Name
  791. // The Object Type is defined as a prefix in the ref.Name , if no prefix is defined , we assume a secret is required.
  792. func (a *Azure) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  793. if a.useNewSDK() {
  794. return a.getSecretWithNewSDK(ctx, ref)
  795. }
  796. return a.getSecretWithLegacySDK(ctx, ref)
  797. }
  798. // returns a SecretBundle with the tags values.
  799. func (a *Azure) getSecretTags(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string]*string, error) {
  800. if a.useNewSDK() {
  801. return a.getSecretTagsWithNewSDK(ctx, ref)
  802. }
  803. return a.getSecretTagsWithLegacySDK(ctx, ref)
  804. }
  805. func (a *Azure) getSecretTagsWithLegacySDK(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string]*string, error) {
  806. _, secretName := getObjType(ref)
  807. secretResp, err := a.baseClient.GetSecret(ctx, *a.provider.VaultURL, secretName, ref.Version)
  808. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  809. err = parseError(err)
  810. if err != nil {
  811. return nil, err
  812. }
  813. secretTagsData := make(map[string]*string)
  814. for tagname, tagval := range secretResp.Tags {
  815. name := secretName + "_" + tagname
  816. kv := make(map[string]string)
  817. err = json.Unmarshal([]byte(*tagval), &kv)
  818. // if the tagvalue is not in JSON format then we added to secretTagsData we added as it is
  819. if err != nil {
  820. secretTagsData[name] = tagval
  821. } else {
  822. for k, v := range kv {
  823. value := v
  824. secretTagsData[name+"_"+k] = &value
  825. }
  826. }
  827. }
  828. return secretTagsData, nil
  829. }
  830. // GetSecretMap returns a map of secret values from Azure KeyVault by fetching the secret with
  831. // the given name and parsing it as a JSON object. If MetadataPolicy is set to Fetch, it will
  832. // return the secret tags instead.
  833. func (a *Azure) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  834. objectType, secretName := getObjType(ref)
  835. switch objectType {
  836. case defaultObjType:
  837. data, err := a.GetSecret(ctx, ref)
  838. if err != nil {
  839. return nil, err
  840. }
  841. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  842. tags, _ := a.getSecretTags(ctx, ref)
  843. return getSecretMapProperties(tags, ref.Key, ref.Property), nil
  844. }
  845. return getSecretMapMap(data)
  846. case objectTypeCert:
  847. return nil, errors.New(errDataFromCert)
  848. case objectTypeKey:
  849. return nil, errors.New(errDataFromKey)
  850. }
  851. return nil, fmt.Errorf(errUnknownObjectType, secretName)
  852. }
  853. func getSecretMapMap(data []byte) (map[string][]byte, error) {
  854. kv := make(map[string]json.RawMessage)
  855. err := json.Unmarshal(data, &kv)
  856. if err != nil {
  857. return nil, fmt.Errorf(errUnmarshalJSONData, err)
  858. }
  859. secretData := make(map[string][]byte)
  860. for k, v := range kv {
  861. var strVal string
  862. err = json.Unmarshal(v, &strVal)
  863. if err == nil {
  864. secretData[k] = []byte(strVal)
  865. } else {
  866. secretData[k] = v
  867. }
  868. }
  869. return secretData, nil
  870. }
  871. func getSecretMapProperties(tags map[string]*string, key, property string) map[string][]byte {
  872. tagByteArray := make(map[string][]byte)
  873. if property != "" {
  874. keyPropertyName := key + "_" + property
  875. singleTag, _ := getSecretTag(tags, keyPropertyName)
  876. tagByteArray[keyPropertyName] = singleTag
  877. return tagByteArray
  878. }
  879. for k, v := range tags {
  880. tagByteArray[k] = []byte(*v)
  881. }
  882. return tagByteArray
  883. }
  884. func (a *Azure) authorizerForWorkloadIdentity(ctx context.Context, tokenProvider tokenProviderFunc) (autorest.Authorizer, error) {
  885. aadEndpoint := AadEndpointForType(a.provider.EnvironmentType)
  886. kvResource := kvResourceForProviderConfig(a.provider.EnvironmentType)
  887. // If no serviceAccountRef was provided
  888. // we expect certain env vars to be present.
  889. // They are set by the azure workload identity webhook
  890. // by adding the label `azure.workload.identity/use: "true"` to the external-secrets pod
  891. if a.provider.ServiceAccountRef == nil {
  892. clientID := os.Getenv("AZURE_CLIENT_ID")
  893. tenantID := os.Getenv("AZURE_TENANT_ID")
  894. tokenFilePath := os.Getenv("AZURE_FEDERATED_TOKEN_FILE")
  895. if clientID == "" || tenantID == "" || tokenFilePath == "" {
  896. return nil, errors.New(errMissingWorkloadEnvVars)
  897. }
  898. token, err := os.ReadFile(filepath.Clean(tokenFilePath))
  899. if err != nil {
  900. return nil, fmt.Errorf(errReadTokenFile, tokenFilePath, err)
  901. }
  902. tp, err := tokenProvider(ctx, string(token), clientID, tenantID, aadEndpoint, kvResource)
  903. if err != nil {
  904. return nil, err
  905. }
  906. return autorest.NewBearerAuthorizer(tp), nil
  907. }
  908. ns := a.namespace
  909. if a.store.GetKind() == esv1.ClusterSecretStoreKind && a.provider.ServiceAccountRef.Namespace != nil {
  910. ns = *a.provider.ServiceAccountRef.Namespace
  911. }
  912. var sa corev1.ServiceAccount
  913. err := a.crClient.Get(ctx, types.NamespacedName{
  914. Name: a.provider.ServiceAccountRef.Name,
  915. Namespace: ns,
  916. }, &sa)
  917. if err != nil {
  918. return nil, err
  919. }
  920. // Extract clientID
  921. var clientID string
  922. // First check if AuthSecretRef is set and clientID can be fetched from there
  923. if a.provider.AuthSecretRef != nil {
  924. if a.provider.AuthSecretRef.ClientID == nil {
  925. return nil, errors.New(errMissingClientIDSecret)
  926. }
  927. clientID, err = resolvers.SecretKeyRef(
  928. ctx,
  929. a.crClient,
  930. a.store.GetKind(),
  931. a.namespace, a.provider.AuthSecretRef.ClientID)
  932. if err != nil {
  933. return nil, err
  934. }
  935. }
  936. // If AuthSecretRef is not set, use default (Service Account) implementation
  937. // Try to get clientID from Annotations
  938. if len(sa.ObjectMeta.Annotations) > 0 {
  939. if val, found := sa.ObjectMeta.Annotations[AnnotationClientID]; found {
  940. // If clientID is defined in both Annotations and AuthSecretRef, return an error
  941. if clientID != "" {
  942. return nil, errors.New(errMultipleClientID)
  943. }
  944. clientID = val
  945. }
  946. }
  947. // Return an error if clientID is still empty
  948. if clientID == "" {
  949. return nil, fmt.Errorf(errMissingClient, AnnotationClientID)
  950. }
  951. // Extract tenantID
  952. var tenantID string
  953. // First check if AuthSecretRef is set and tenantID can be fetched from there
  954. if a.provider.AuthSecretRef != nil {
  955. // We may want to set tenantID explicitly in the `spec.provider.azurekv` section of the SecretStore object
  956. // So that is okay if it is not there
  957. if a.provider.AuthSecretRef.TenantID != nil {
  958. tenantID, err = resolvers.SecretKeyRef(
  959. ctx,
  960. a.crClient,
  961. a.store.GetKind(),
  962. a.namespace, a.provider.AuthSecretRef.TenantID)
  963. if err != nil {
  964. return nil, err
  965. }
  966. }
  967. }
  968. // Check if spec.provider.azurekv.tenantID is set
  969. if tenantID == "" && a.provider.TenantID != nil {
  970. tenantID = *a.provider.TenantID
  971. }
  972. // Try to get tenantID from Annotations first. Default implementation.
  973. if len(sa.ObjectMeta.Annotations) > 0 {
  974. if val, found := sa.ObjectMeta.Annotations[AnnotationTenantID]; found {
  975. // If tenantID is defined in both Annotations and AuthSecretRef, return an error
  976. if tenantID != "" {
  977. return nil, errors.New(errMultipleTenantID)
  978. }
  979. tenantID = val
  980. }
  981. }
  982. // Fallback: use the AZURE_TENANT_ID env var which is set by the azure workload identity webhook
  983. // https://azure.github.io/azure-workload-identity/docs/topics/service-account-labels-and-annotations.html#service-account
  984. if tenantID == "" {
  985. tenantID = os.Getenv("AZURE_TENANT_ID")
  986. }
  987. // Return an error if tenantID is still empty
  988. if tenantID == "" {
  989. return nil, errors.New(errMissingTenant)
  990. }
  991. audiences := []string{AzureDefaultAudience}
  992. if len(a.provider.ServiceAccountRef.Audiences) > 0 {
  993. audiences = append(audiences, a.provider.ServiceAccountRef.Audiences...)
  994. }
  995. token, err := FetchSAToken(ctx, ns, a.provider.ServiceAccountRef.Name, audiences, a.kubeClient)
  996. if err != nil {
  997. return nil, err
  998. }
  999. tp, err := tokenProvider(ctx, token, clientID, tenantID, aadEndpoint, kvResource)
  1000. if err != nil {
  1001. return nil, err
  1002. }
  1003. return autorest.NewBearerAuthorizer(tp), nil
  1004. }
  1005. // FetchSAToken retrieves a service account token from Kubernetes with the specified audiences.
  1006. // It takes the service account namespace, name, audience list, and Kubernetes client interface.
  1007. // Returns the token string or an error if the token creation fails.
  1008. func FetchSAToken(ctx context.Context, ns, name string, audiences []string, kubeClient kcorev1.CoreV1Interface) (string, error) {
  1009. token, err := kubeClient.ServiceAccounts(ns).CreateToken(ctx, name, &authv1.TokenRequest{
  1010. Spec: authv1.TokenRequestSpec{
  1011. Audiences: audiences,
  1012. },
  1013. }, metav1.CreateOptions{})
  1014. if err != nil {
  1015. return "", err
  1016. }
  1017. return token.Status.Token, nil
  1018. }
  1019. // tokenProvider satisfies the adal.OAuthTokenProvider interface.
  1020. type tokenProvider struct {
  1021. accessToken string
  1022. }
  1023. type tokenProviderFunc func(ctx context.Context, token, clientID, tenantID, aadEndpoint, kvResource string) (adal.OAuthTokenProvider, error)
  1024. // NewTokenProvider creates a new Azure OAuth token provider for authentication.
  1025. func NewTokenProvider(ctx context.Context, token, clientID, tenantID, aadEndpoint, kvResource string) (adal.OAuthTokenProvider, error) {
  1026. cred := confidential.NewCredFromAssertionCallback(func(_ context.Context, _ confidential.AssertionRequestOptions) (string, error) {
  1027. return token, nil
  1028. })
  1029. cClient, err := confidential.New(fmt.Sprintf("%s%s", aadEndpoint, tenantID), clientID, cred)
  1030. if err != nil {
  1031. return nil, err
  1032. }
  1033. scope := kvResource
  1034. // .default needs to be added to the scope
  1035. if !strings.Contains(kvResource, ".default") {
  1036. scope = fmt.Sprintf("%s/.default", kvResource)
  1037. }
  1038. authRes, err := cClient.AcquireTokenByCredential(ctx, []string{
  1039. scope,
  1040. })
  1041. if err != nil {
  1042. return nil, err
  1043. }
  1044. return &tokenProvider{
  1045. accessToken: authRes.AccessToken,
  1046. }, nil
  1047. }
  1048. func (t *tokenProvider) OAuthToken() string {
  1049. return t.accessToken
  1050. }
  1051. func (a *Azure) authorizerForManagedIdentity() (autorest.Authorizer, error) {
  1052. msiConfig := kvauth.NewMSIConfig()
  1053. msiConfig.Resource = kvResourceForProviderConfig(a.provider.EnvironmentType)
  1054. if a.provider.IdentityID != nil {
  1055. msiConfig.ClientID = *a.provider.IdentityID
  1056. }
  1057. return msiConfig.Authorizer()
  1058. }
  1059. func (a *Azure) authorizerForServicePrincipal(ctx context.Context) (autorest.Authorizer, error) {
  1060. if a.provider.TenantID == nil {
  1061. return nil, errors.New(errMissingTenant)
  1062. }
  1063. if a.provider.AuthSecretRef == nil {
  1064. return nil, errors.New(errMissingSecretRef)
  1065. }
  1066. if a.provider.AuthSecretRef.ClientID == nil || (a.provider.AuthSecretRef.ClientSecret == nil && a.provider.AuthSecretRef.ClientCertificate == nil) {
  1067. return nil, errors.New(errMissingClientIDSecret)
  1068. }
  1069. if a.provider.AuthSecretRef.ClientSecret != nil && a.provider.AuthSecretRef.ClientCertificate != nil {
  1070. return nil, errors.New(errInvalidClientCredentials)
  1071. }
  1072. return a.getAuthorizerFromCredentials(ctx)
  1073. }
  1074. func (a *Azure) getAuthorizerFromCredentials(ctx context.Context) (autorest.Authorizer, error) {
  1075. clientID, err := resolvers.SecretKeyRef(
  1076. ctx,
  1077. a.crClient,
  1078. a.store.GetKind(),
  1079. a.namespace, a.provider.AuthSecretRef.ClientID,
  1080. )
  1081. if err != nil {
  1082. return nil, err
  1083. }
  1084. if a.provider.AuthSecretRef.ClientSecret != nil {
  1085. clientSecret, err := resolvers.SecretKeyRef(
  1086. ctx,
  1087. a.crClient,
  1088. a.store.GetKind(),
  1089. a.namespace, a.provider.AuthSecretRef.ClientSecret,
  1090. )
  1091. if err != nil {
  1092. return nil, err
  1093. }
  1094. return getAuthorizerForClientSecret(
  1095. clientID,
  1096. clientSecret,
  1097. *a.provider.TenantID,
  1098. a.provider.EnvironmentType,
  1099. )
  1100. }
  1101. clientCertificate, err := resolvers.SecretKeyRef(
  1102. ctx,
  1103. a.crClient,
  1104. a.store.GetKind(),
  1105. a.namespace, a.provider.AuthSecretRef.ClientCertificate,
  1106. )
  1107. if err != nil {
  1108. return nil, err
  1109. }
  1110. return getAuthorizerForClientCertificate(
  1111. clientID,
  1112. []byte(clientCertificate),
  1113. *a.provider.TenantID,
  1114. a.provider.EnvironmentType,
  1115. )
  1116. }
  1117. func getAuthorizerForClientSecret(clientID, clientSecret, tenantID string, environmentType esv1.AzureEnvironmentType) (autorest.Authorizer, error) {
  1118. clientCredentialsConfig := kvauth.NewClientCredentialsConfig(clientID, clientSecret, tenantID)
  1119. clientCredentialsConfig.Resource = kvResourceForProviderConfig(environmentType)
  1120. clientCredentialsConfig.AADEndpoint = AadEndpointForType(environmentType)
  1121. return clientCredentialsConfig.Authorizer()
  1122. }
  1123. func getAuthorizerForClientCertificate(clientID string, certificateBytes []byte, tenantID string, environmentType esv1.AzureEnvironmentType) (autorest.Authorizer, error) {
  1124. clientCertificateConfig := NewClientInMemoryCertificateConfig(clientID, certificateBytes, tenantID)
  1125. clientCertificateConfig.Resource = kvResourceForProviderConfig(environmentType)
  1126. clientCertificateConfig.AADEndpoint = AadEndpointForType(environmentType)
  1127. return clientCertificateConfig.Authorizer()
  1128. }
  1129. // Close closes the Azure Key Vault provider.
  1130. func (a *Azure) Close(_ context.Context) error {
  1131. return nil
  1132. }
  1133. // Validate validates the Azure Key Vault provider configuration.
  1134. func (a *Azure) Validate() (esv1.ValidationResult, error) {
  1135. if a.store.GetKind() == esv1.ClusterSecretStoreKind && isReferentSpec(a.provider) {
  1136. return esv1.ValidationResultUnknown, nil
  1137. }
  1138. return esv1.ValidationResultReady, nil
  1139. }
  1140. func isReferentSpec(prov *esv1.AzureKVProvider) bool {
  1141. if prov.AuthSecretRef != nil &&
  1142. ((prov.AuthSecretRef.ClientID != nil &&
  1143. prov.AuthSecretRef.ClientID.Namespace == nil) ||
  1144. (prov.AuthSecretRef.ClientSecret != nil &&
  1145. prov.AuthSecretRef.ClientSecret.Namespace == nil)) {
  1146. return true
  1147. }
  1148. if prov.ServiceAccountRef != nil &&
  1149. prov.ServiceAccountRef.Namespace == nil {
  1150. return true
  1151. }
  1152. return false
  1153. }
  1154. // AadEndpointForType returns the Azure Active Directory endpoint for the specified Azure environment type.
  1155. func AadEndpointForType(t esv1.AzureEnvironmentType) string {
  1156. switch t {
  1157. case esv1.AzureEnvironmentPublicCloud:
  1158. return azure.PublicCloud.ActiveDirectoryEndpoint
  1159. case esv1.AzureEnvironmentChinaCloud:
  1160. return azure.ChinaCloud.ActiveDirectoryEndpoint
  1161. case esv1.AzureEnvironmentUSGovernmentCloud:
  1162. return azure.USGovernmentCloud.ActiveDirectoryEndpoint
  1163. case esv1.AzureEnvironmentGermanCloud:
  1164. return azure.GermanCloud.ActiveDirectoryEndpoint
  1165. case esv1.AzureEnvironmentAzureStackCloud:
  1166. // Azure Stack Cloud requires custom configuration and new SDK
  1167. // Return empty string to indicate it's not supported in old SDK
  1168. return ""
  1169. default:
  1170. return azure.PublicCloud.ActiveDirectoryEndpoint
  1171. }
  1172. }
  1173. // ServiceManagementEndpointForType returns the service management endpoint for the specified Azure environment type.
  1174. func ServiceManagementEndpointForType(t esv1.AzureEnvironmentType) string {
  1175. switch t {
  1176. case esv1.AzureEnvironmentPublicCloud:
  1177. return azure.PublicCloud.ServiceManagementEndpoint
  1178. case esv1.AzureEnvironmentChinaCloud:
  1179. return azure.ChinaCloud.ServiceManagementEndpoint
  1180. case esv1.AzureEnvironmentUSGovernmentCloud:
  1181. return azure.USGovernmentCloud.ServiceManagementEndpoint
  1182. case esv1.AzureEnvironmentGermanCloud:
  1183. return azure.GermanCloud.ServiceManagementEndpoint
  1184. case esv1.AzureEnvironmentAzureStackCloud:
  1185. // Azure Stack Cloud requires custom configuration and new SDK
  1186. // Return empty string to indicate it's not supported in old SDK
  1187. return ""
  1188. default:
  1189. return azure.PublicCloud.ServiceManagementEndpoint
  1190. }
  1191. }
  1192. func kvResourceForProviderConfig(t esv1.AzureEnvironmentType) string {
  1193. var res string
  1194. switch t {
  1195. case esv1.AzureEnvironmentPublicCloud:
  1196. res = azure.PublicCloud.KeyVaultEndpoint
  1197. case esv1.AzureEnvironmentChinaCloud:
  1198. res = azure.ChinaCloud.KeyVaultEndpoint
  1199. case esv1.AzureEnvironmentUSGovernmentCloud:
  1200. res = azure.USGovernmentCloud.KeyVaultEndpoint
  1201. case esv1.AzureEnvironmentGermanCloud:
  1202. res = azure.GermanCloud.KeyVaultEndpoint
  1203. case esv1.AzureEnvironmentAzureStackCloud:
  1204. // Azure Stack Cloud requires custom configuration and new SDK
  1205. // Return empty string to indicate it's not supported in old SDK
  1206. res = ""
  1207. default:
  1208. res = azure.PublicCloud.KeyVaultEndpoint
  1209. }
  1210. return strings.TrimSuffix(res, "/")
  1211. }
  1212. func getObjType(ref esv1.ExternalSecretDataRemoteRef) (string, string) {
  1213. objectType := defaultObjType
  1214. secretName := ref.Key
  1215. nameSplitted := strings.Split(secretName, "/")
  1216. if len(nameSplitted) > 1 {
  1217. objectType = nameSplitted[0]
  1218. secretName = nameSplitted[1]
  1219. // TODO: later tokens can be used to read the secret tags
  1220. }
  1221. return objectType, secretName
  1222. }
  1223. func isValidSecret(checkTags, checkName bool, ref esv1.ExternalSecretFind, secret keyvault.SecretItem) (bool, string) {
  1224. if secret.ID == nil || !*secret.Attributes.Enabled {
  1225. return false, ""
  1226. }
  1227. if checkTags && !okByTags(ref, secret) {
  1228. return false, ""
  1229. }
  1230. secretName := path.Base(*secret.ID)
  1231. if checkName && !okByName(ref, secretName) {
  1232. return false, ""
  1233. }
  1234. return true, secretName
  1235. }
  1236. func okByName(ref esv1.ExternalSecretFind, secretName string) bool {
  1237. matches, _ := regexp.MatchString(ref.Name.RegExp, secretName)
  1238. return matches
  1239. }
  1240. func okByTags(ref esv1.ExternalSecretFind, secret keyvault.SecretItem) bool {
  1241. tagsFound := true
  1242. for k, v := range ref.Tags {
  1243. if val, ok := secret.Tags[k]; !ok || *val != v {
  1244. tagsFound = false
  1245. break
  1246. }
  1247. }
  1248. return tagsFound
  1249. }
  1250. // GetSecret implementation using legacy go-autorest SDK.
  1251. func (a *Azure) getSecretWithLegacySDK(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  1252. objectType, secretName := getObjType(ref)
  1253. switch objectType {
  1254. case defaultObjType:
  1255. // returns a SecretBundle with the secret value
  1256. // https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault#SecretBundle
  1257. secretResp, err := a.baseClient.GetSecret(ctx, *a.provider.VaultURL, secretName, ref.Version)
  1258. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetSecret, err)
  1259. err = parseError(err)
  1260. if err != nil {
  1261. return nil, err
  1262. }
  1263. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  1264. return getSecretTag(secretResp.Tags, ref.Property)
  1265. }
  1266. return getProperty(*secretResp.Value, ref.Property, ref.Key)
  1267. case objectTypeCert:
  1268. // returns a CertBundle. We return CER contents of x509 certificate
  1269. // see: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault#CertificateBundle
  1270. certResp, err := a.baseClient.GetCertificate(ctx, *a.provider.VaultURL, secretName, ref.Version)
  1271. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetCertificate, err)
  1272. err = parseError(err)
  1273. if err != nil {
  1274. return nil, err
  1275. }
  1276. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  1277. return getSecretTag(certResp.Tags, ref.Property)
  1278. }
  1279. return *certResp.Cer, nil
  1280. case objectTypeKey:
  1281. // returns a KeyBundle
  1282. // https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault#KeyBundle
  1283. keyResp, err := a.baseClient.GetKey(ctx, *a.provider.VaultURL, secretName, ref.Version)
  1284. metrics.ObserveAPICall(constants.ProviderAzureKV, constants.CallAzureKVGetKey, err)
  1285. err = parseError(err)
  1286. if err != nil {
  1287. return nil, err
  1288. }
  1289. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  1290. return getSecretTag(keyResp.Tags, ref.Property)
  1291. }
  1292. keyBytes, err := json.Marshal(keyResp.Key)
  1293. if err != nil {
  1294. return nil, fmt.Errorf("failed to marshal key: %w", err)
  1295. }
  1296. return getProperty(string(keyBytes), ref.Property, ref.Key)
  1297. }
  1298. return nil, fmt.Errorf(errUnknownObjectType, secretName)
  1299. }