akeyless_api.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package akeyless
  13. import (
  14. "context"
  15. "encoding/base64"
  16. "encoding/json"
  17. "errors"
  18. "fmt"
  19. "io"
  20. "os"
  21. "strings"
  22. aws_cloud_id "github.com/akeylesslabs/akeyless-go-cloud-id/cloudprovider/aws"
  23. azure_cloud_id "github.com/akeylesslabs/akeyless-go-cloud-id/cloudprovider/azure"
  24. gcp_cloud_id "github.com/akeylesslabs/akeyless-go-cloud-id/cloudprovider/gcp"
  25. "github.com/akeylesslabs/akeyless-go/v3"
  26. authenticationv1 "k8s.io/api/authentication/v1"
  27. corev1 "k8s.io/api/core/v1"
  28. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  29. "k8s.io/apimachinery/pkg/types"
  30. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  31. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  32. )
  33. var apiErr akeyless.GenericOpenAPIError
  34. const DefServiceAccountFile = "/var/run/secrets/kubernetes.io/serviceaccount/token"
  35. func (a *akeylessBase) GetToken(accessID, accType, accTypeParam string, k8sAuth *esv1beta1.AkeylessKubernetesAuth) (string, error) {
  36. ctx := context.Background()
  37. authBody := akeyless.NewAuthWithDefaults()
  38. authBody.AccessId = akeyless.PtrString(accessID)
  39. if accType == "api_key" || accType == "access_key" {
  40. authBody.AccessKey = akeyless.PtrString(accTypeParam)
  41. } else if accType == "k8s" {
  42. jwtString, err := a.getK8SServiceAccountJWT(ctx, k8sAuth)
  43. if err != nil {
  44. return "", fmt.Errorf("failed to read JWT with Kubernetes Auth from %v. error: %w", DefServiceAccountFile, err)
  45. }
  46. jwtStringBase64 := base64.StdEncoding.EncodeToString([]byte(jwtString))
  47. K8SAuthConfigName := accTypeParam
  48. authBody.AccessType = akeyless.PtrString(accType)
  49. authBody.K8sServiceAccountToken = akeyless.PtrString(jwtStringBase64)
  50. authBody.K8sAuthConfigName = akeyless.PtrString(K8SAuthConfigName)
  51. } else {
  52. cloudID, err := a.getCloudID(accType, accTypeParam)
  53. if err != nil {
  54. return "", errors.New("Require Cloud ID " + err.Error())
  55. }
  56. authBody.AccessType = akeyless.PtrString(accType)
  57. authBody.CloudId = akeyless.PtrString(cloudID)
  58. }
  59. authOut, res, err := a.RestAPI.Auth(ctx).Body(*authBody).Execute()
  60. if err != nil {
  61. if errors.As(err, &apiErr) {
  62. return "", fmt.Errorf("authentication failed: %v", string(apiErr.Body()))
  63. }
  64. return "", fmt.Errorf("authentication failed: %w", err)
  65. }
  66. defer res.Body.Close()
  67. token := authOut.GetToken()
  68. return token, nil
  69. }
  70. func (a *akeylessBase) GetSecretByType(ctx context.Context, secretName, token string, version int32) (string, error) {
  71. item, err := a.DescribeItem(ctx, secretName, token)
  72. if err != nil {
  73. return "", err
  74. }
  75. secretType := item.GetItemType()
  76. switch secretType {
  77. case "STATIC_SECRET":
  78. return a.GetStaticSecret(ctx, secretName, token, version)
  79. case "DYNAMIC_SECRET":
  80. return a.GetDynamicSecrets(ctx, secretName, token)
  81. case "ROTATED_SECRET":
  82. return a.GetRotatedSecrets(ctx, secretName, token, version)
  83. case "CERTIFICATE":
  84. return a.GetCertificate(ctx, secretName, token, version)
  85. default:
  86. return "", fmt.Errorf("invalid item type: %v", secretType)
  87. }
  88. }
  89. func (a *akeylessBase) DescribeItem(ctx context.Context, itemName, token string) (*akeyless.Item, error) {
  90. body := akeyless.DescribeItem{
  91. Name: itemName,
  92. }
  93. if strings.HasPrefix(token, "u-") {
  94. body.UidToken = &token
  95. } else {
  96. body.Token = &token
  97. }
  98. gsvOut, res, err := a.RestAPI.DescribeItem(ctx).Body(body).Execute()
  99. if err != nil {
  100. if errors.As(err, &apiErr) {
  101. var item *Item
  102. err = json.Unmarshal(apiErr.Body(), &item)
  103. if err != nil {
  104. return nil, fmt.Errorf("can't describe item: %v, error: %v", itemName, string(apiErr.Body()))
  105. }
  106. } else {
  107. return nil, fmt.Errorf("can't describe item: %w", err)
  108. }
  109. }
  110. defer res.Body.Close()
  111. return &gsvOut, nil
  112. }
  113. func (a *akeylessBase) GetCertificate(ctx context.Context, certificateName, token string, version int32) (string, error) {
  114. body := akeyless.GetCertificateValue{
  115. Name: certificateName,
  116. Version: &version,
  117. }
  118. if strings.HasPrefix(token, "u-") {
  119. body.UidToken = &token
  120. } else {
  121. body.Token = &token
  122. }
  123. gcvOut, res, err := a.RestAPI.GetCertificateValue(ctx).Body(body).Execute()
  124. if err != nil {
  125. if errors.As(err, &apiErr) {
  126. return "", fmt.Errorf("can't get certificate value: %v", string(apiErr.Body()))
  127. }
  128. return "", fmt.Errorf("can't get certificate value: %w", err)
  129. }
  130. defer res.Body.Close()
  131. out, err := json.Marshal(gcvOut)
  132. if err != nil {
  133. return "", fmt.Errorf("can't marshal certificate value: %w", err)
  134. }
  135. return string(out), nil
  136. }
  137. func (a *akeylessBase) GetRotatedSecrets(ctx context.Context, secretName, token string, version int32) (string, error) {
  138. body := akeyless.GetRotatedSecretValue{
  139. Names: secretName,
  140. Version: &version,
  141. }
  142. if strings.HasPrefix(token, "u-") {
  143. body.UidToken = &token
  144. } else {
  145. body.Token = &token
  146. }
  147. gsvOut, res, err := a.RestAPI.GetRotatedSecretValue(ctx).Body(body).Execute()
  148. if err != nil {
  149. if errors.As(err, &apiErr) {
  150. return "", fmt.Errorf("can't get rotated secret value: %v", string(apiErr.Body()))
  151. }
  152. return "", fmt.Errorf("can't get rotated secret value: %w", err)
  153. }
  154. defer res.Body.Close()
  155. valI, ok := gsvOut["value"]
  156. if ok {
  157. val, convert := valI.(map[string]interface{})
  158. if !convert {
  159. return "", fmt.Errorf("failure converting key from gsvOut")
  160. }
  161. if _, ok := val["payload"]; ok {
  162. return fmt.Sprintf("%v", val["payload"]), nil
  163. } else if _, ok := val["target_value"]; ok {
  164. out, err := json.Marshal(val["target_value"])
  165. if err != nil {
  166. return "", fmt.Errorf("can't marshal rotated secret value: %w", err)
  167. }
  168. return string(out), nil
  169. } else {
  170. out, err := json.Marshal(val)
  171. if err != nil {
  172. return "", fmt.Errorf("can't marshal rotated secret value: %w", err)
  173. }
  174. return string(out), nil
  175. }
  176. }
  177. out, err := json.Marshal(gsvOut)
  178. if err != nil {
  179. return "", fmt.Errorf("can't marshal rotated secret value: %w", err)
  180. }
  181. return string(out), nil
  182. }
  183. func (a *akeylessBase) GetDynamicSecrets(ctx context.Context, secretName, token string) (string, error) {
  184. body := akeyless.GetDynamicSecretValue{
  185. Name: secretName,
  186. }
  187. if strings.HasPrefix(token, "u-") {
  188. body.UidToken = &token
  189. } else {
  190. body.Token = &token
  191. }
  192. gsvOut, res, err := a.RestAPI.GetDynamicSecretValue(ctx).Body(body).Execute()
  193. if err != nil {
  194. if errors.As(err, &apiErr) {
  195. return "", fmt.Errorf("can't get dynamic secret value: %v", string(apiErr.Body()))
  196. }
  197. return "", fmt.Errorf("can't get dynamic secret value: %w", err)
  198. }
  199. defer res.Body.Close()
  200. out, err := json.Marshal(gsvOut)
  201. if err != nil {
  202. return "", fmt.Errorf("can't marshal dynamic secret value: %w", err)
  203. }
  204. return string(out), nil
  205. }
  206. func (a *akeylessBase) GetStaticSecret(ctx context.Context, secretName, token string, version int32) (string, error) {
  207. gsvBody := akeyless.GetSecretValue{
  208. Names: []string{secretName},
  209. Version: &version,
  210. }
  211. if strings.HasPrefix(token, "u-") {
  212. gsvBody.UidToken = &token
  213. } else {
  214. gsvBody.Token = &token
  215. }
  216. gsvOut, res, err := a.RestAPI.GetSecretValue(ctx).Body(gsvBody).Execute()
  217. if err != nil {
  218. if errors.As(err, &apiErr) {
  219. return "", fmt.Errorf("can't get secret value: %v", string(apiErr.Body()))
  220. }
  221. return "", fmt.Errorf("can't get secret value: %w", err)
  222. }
  223. defer res.Body.Close()
  224. val, ok := gsvOut[secretName]
  225. if !ok {
  226. return "", fmt.Errorf("can't get secret: %v", secretName)
  227. }
  228. return val, nil
  229. }
  230. func (a *akeylessBase) getCloudID(provider, accTypeParam string) (string, error) {
  231. var cloudID string
  232. var err error
  233. switch provider {
  234. case "azure_ad":
  235. cloudID, err = azure_cloud_id.GetCloudId(accTypeParam)
  236. case "aws_iam":
  237. cloudID, err = aws_cloud_id.GetCloudId()
  238. case "gcp":
  239. cloudID, err = gcp_cloud_id.GetCloudID(accTypeParam)
  240. default:
  241. return "", fmt.Errorf("unable to determine provider: %s", provider)
  242. }
  243. return cloudID, err
  244. }
  245. func (a *akeylessBase) ListSecrets(ctx context.Context, path, tag, token string) ([]string, error) {
  246. secretTypes := &[]string{"static-secret", "dynamic-secret", "rotated-secret"}
  247. MinimalView := true
  248. if tag != "" {
  249. MinimalView = false
  250. }
  251. gsvBody := akeyless.ListItems{
  252. Filter: &path,
  253. Type: secretTypes,
  254. MinimalView: &MinimalView,
  255. Tag: &tag,
  256. }
  257. if strings.HasPrefix(token, "u-") {
  258. gsvBody.UidToken = &token
  259. } else {
  260. gsvBody.Token = &token
  261. }
  262. lipOut, res, err := a.RestAPI.ListItems(ctx).Body(gsvBody).Execute()
  263. if err != nil {
  264. if errors.As(err, &apiErr) {
  265. return nil, fmt.Errorf("can't get secrets list: %v", string(apiErr.Body()))
  266. }
  267. return nil, fmt.Errorf("error on get secrets list: %w", err)
  268. }
  269. defer res.Body.Close()
  270. if lipOut.Items == nil {
  271. return nil, nil
  272. }
  273. listNames := make([]string, 0)
  274. for _, v := range *lipOut.Items {
  275. if path == "" || strings.HasPrefix(*v.ItemName, path) {
  276. listNames = append(listNames, *v.ItemName)
  277. }
  278. }
  279. return listNames, nil
  280. }
  281. func (a *akeylessBase) getK8SServiceAccountJWT(ctx context.Context, kubernetesAuth *esv1beta1.AkeylessKubernetesAuth) (string, error) {
  282. if kubernetesAuth != nil {
  283. if kubernetesAuth.ServiceAccountRef != nil {
  284. // Kubernetes <v1.24 fetch token via ServiceAccount.Secrets[]
  285. jwt, err := a.getJWTFromServiceAccount(ctx, kubernetesAuth.ServiceAccountRef)
  286. if jwt != "" {
  287. return jwt, err
  288. }
  289. // Kubernetes >=v1.24: fetch token via TokenRequest API
  290. jwt, err = a.getJWTfromServiceAccountToken(ctx, *kubernetesAuth.ServiceAccountRef, nil, 600)
  291. if err != nil {
  292. return "", err
  293. }
  294. return jwt, nil
  295. } else if kubernetesAuth.SecretRef != nil {
  296. tokenRef := kubernetesAuth.SecretRef
  297. if tokenRef.Key == "" {
  298. tokenRef = kubernetesAuth.SecretRef.DeepCopy()
  299. tokenRef.Key = "token"
  300. }
  301. jwt, err := a.secretKeyRef(ctx, tokenRef)
  302. if err != nil {
  303. return "", err
  304. }
  305. return jwt, nil
  306. }
  307. }
  308. return readK8SServiceAccountJWT()
  309. }
  310. func (a *akeylessBase) getJWTFromServiceAccount(ctx context.Context, serviceAccountRef *esmeta.ServiceAccountSelector) (string, error) {
  311. serviceAccount := &corev1.ServiceAccount{}
  312. ref := types.NamespacedName{
  313. Namespace: a.namespace,
  314. Name: serviceAccountRef.Name,
  315. }
  316. if (a.storeKind == esv1beta1.ClusterSecretStoreKind) &&
  317. (serviceAccountRef.Namespace != nil) {
  318. ref.Namespace = *serviceAccountRef.Namespace
  319. }
  320. err := a.kube.Get(ctx, ref, serviceAccount)
  321. if err != nil {
  322. return "", fmt.Errorf(errGetKubeSA, ref.Name, err)
  323. }
  324. if len(serviceAccount.Secrets) == 0 {
  325. return "", fmt.Errorf(errGetKubeSASecrets, ref.Name)
  326. }
  327. for _, tokenRef := range serviceAccount.Secrets {
  328. retval, err := a.secretKeyRef(ctx, &esmeta.SecretKeySelector{
  329. Name: tokenRef.Name,
  330. Namespace: &ref.Namespace,
  331. Key: "token",
  332. })
  333. if err != nil {
  334. continue
  335. }
  336. return retval, nil
  337. }
  338. return "", fmt.Errorf(errGetKubeSANoToken, ref.Name)
  339. }
  340. func (a *akeylessBase) secretKeyRef(ctx context.Context, secretRef *esmeta.SecretKeySelector) (string, error) {
  341. secret := &corev1.Secret{}
  342. ref := types.NamespacedName{
  343. Namespace: a.namespace,
  344. Name: secretRef.Name,
  345. }
  346. if (a.storeKind == esv1beta1.ClusterSecretStoreKind) &&
  347. (secretRef.Namespace != nil) {
  348. ref.Namespace = *secretRef.Namespace
  349. }
  350. err := a.kube.Get(ctx, ref, secret)
  351. if err != nil {
  352. return "", fmt.Errorf(errGetKubeSecret, ref.Name, err)
  353. }
  354. keyBytes, ok := secret.Data[secretRef.Key]
  355. if !ok {
  356. return "", fmt.Errorf(errSecretKeyFmt, secretRef.Key)
  357. }
  358. value := string(keyBytes)
  359. valueStr := strings.TrimSpace(value)
  360. return valueStr, nil
  361. }
  362. func (a *akeylessBase) getJWTfromServiceAccountToken(ctx context.Context, serviceAccountRef esmeta.ServiceAccountSelector, additionalAud []string, expirationSeconds int64) (string, error) {
  363. audiences := serviceAccountRef.Audiences
  364. if len(additionalAud) > 0 {
  365. audiences = append(audiences, additionalAud...)
  366. }
  367. tokenRequest := &authenticationv1.TokenRequest{
  368. ObjectMeta: metav1.ObjectMeta{
  369. Namespace: a.namespace,
  370. },
  371. Spec: authenticationv1.TokenRequestSpec{
  372. Audiences: audiences,
  373. ExpirationSeconds: &expirationSeconds,
  374. },
  375. }
  376. if (a.storeKind == esv1beta1.ClusterSecretStoreKind) &&
  377. (serviceAccountRef.Namespace != nil) {
  378. tokenRequest.Namespace = *serviceAccountRef.Namespace
  379. }
  380. tokenResponse, err := a.corev1.ServiceAccounts(tokenRequest.Namespace).CreateToken(ctx, serviceAccountRef.Name, tokenRequest, metav1.CreateOptions{})
  381. if err != nil {
  382. return "", fmt.Errorf(errGetKubeSATokenRequest, serviceAccountRef.Name, err)
  383. }
  384. return tokenResponse.Status.Token, nil
  385. }
  386. // readK8SServiceAccountJWT reads the JWT data for the Agent to submit to Akeyless Gateway.
  387. func readK8SServiceAccountJWT() (string, error) {
  388. data, err := os.Open(DefServiceAccountFile)
  389. if err != nil {
  390. return "", err
  391. }
  392. defer data.Close()
  393. contentBytes, err := io.ReadAll(data)
  394. if err != nil {
  395. return "", err
  396. }
  397. jwt := strings.TrimSpace(string(contentBytes))
  398. return jwt, nil
  399. }