akeyless_api.go 13 KB

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