bitwarden_sdk.go 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  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 bitwarden
  13. import (
  14. "bytes"
  15. "context"
  16. "encoding/json"
  17. "fmt"
  18. "io"
  19. "net/http"
  20. "strings"
  21. "sigs.k8s.io/controller-runtime/pkg/client"
  22. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  23. )
  24. // Defined Header Keys.
  25. const (
  26. WardenHeaderAccessToken = "Warden-Access-Token"
  27. WardenHeaderAPIURL = "Warden-Api-Url"
  28. WardenHeaderIdentityURL = "Warden-Identity-Url"
  29. restAPIURL = "/rest/api/1/secret"
  30. )
  31. type SecretResponse struct {
  32. CreationDate string `json:"creationDate"`
  33. ID string `json:"id"`
  34. Key string `json:"key"`
  35. Note string `json:"note"`
  36. OrganizationID string `json:"organizationId"`
  37. ProjectID *string `json:"projectId,omitempty"`
  38. RevisionDate string `json:"revisionDate"`
  39. Value string `json:"value"`
  40. }
  41. type SecretsDeleteResponse struct {
  42. Data []SecretDeleteResponse `json:"data"`
  43. }
  44. type SecretDeleteResponse struct {
  45. Error *string `json:"error,omitempty"`
  46. ID string `json:"id"`
  47. }
  48. type SecretIdentifiersResponse struct {
  49. Data []SecretIdentifierResponse `json:"data"`
  50. }
  51. type SecretIdentifierResponse struct {
  52. ID string `json:"id"`
  53. Key string `json:"key"`
  54. OrganizationID string `json:"organizationId"`
  55. }
  56. type SecretCreateRequest struct {
  57. Key string `json:"key"`
  58. Note string `json:"note"`
  59. // Organization where the secret will be created
  60. OrganizationID string `json:"organizationId"`
  61. // IDs of the projects that this secret will belong to
  62. ProjectIDS []string `json:"projectIds,omitempty"`
  63. Value string `json:"value"`
  64. }
  65. type SecretPutRequest struct {
  66. ID string `json:"id"`
  67. Key string `json:"key"`
  68. Note string `json:"note"`
  69. // Organization where the secret will be created
  70. OrganizationID string `json:"organizationId"`
  71. // IDs of the projects that this secret will belong to
  72. ProjectIDS []string `json:"projectIds,omitempty"`
  73. Value string `json:"value"`
  74. }
  75. // Client for the bitwarden SDK.
  76. type Client interface {
  77. GetSecret(ctx context.Context, id string) (*SecretResponse, error)
  78. DeleteSecret(ctx context.Context, ids []string) (*SecretsDeleteResponse, error)
  79. CreateSecret(ctx context.Context, secret SecretCreateRequest) (*SecretResponse, error)
  80. UpdateSecret(ctx context.Context, secret SecretPutRequest) (*SecretResponse, error)
  81. ListSecrets(ctx context.Context, organizationID string) (*SecretIdentifiersResponse, error)
  82. }
  83. // SdkClient creates a client to talk to the bitwarden SDK server.
  84. type SdkClient struct {
  85. apiURL string
  86. identityURL string
  87. token string
  88. bitwardenSdkServerURL string
  89. client *http.Client
  90. }
  91. func NewSdkClient(ctx context.Context, c client.Client, storeKind, namespace string, provider *esv1.BitwardenSecretsManagerProvider, token string) (*SdkClient, error) {
  92. httpsClient, err := newHTTPSClient(ctx, c, storeKind, namespace, provider)
  93. if err != nil {
  94. return nil, fmt.Errorf("error creating https client: %w", err)
  95. }
  96. return &SdkClient{
  97. apiURL: strings.TrimSuffix(provider.APIURL, "/"),
  98. identityURL: strings.TrimSuffix(provider.IdentityURL, "/"),
  99. bitwardenSdkServerURL: provider.BitwardenServerSDKURL,
  100. token: token,
  101. client: httpsClient,
  102. }, nil
  103. }
  104. func (s *SdkClient) GetSecret(ctx context.Context, id string) (*SecretResponse, error) {
  105. body := struct {
  106. ID string `json:"id"`
  107. }{
  108. ID: id,
  109. }
  110. secretResp := &SecretResponse{}
  111. if err := s.performHTTPRequestOperation(ctx, params{
  112. method: http.MethodGet,
  113. url: s.bitwardenSdkServerURL + restAPIURL,
  114. body: body,
  115. result: &secretResp,
  116. }); err != nil {
  117. return nil, fmt.Errorf("failed to get secret: %w", err)
  118. }
  119. return secretResp, nil
  120. }
  121. func (s *SdkClient) DeleteSecret(ctx context.Context, ids []string) (*SecretsDeleteResponse, error) {
  122. body := struct {
  123. IDs []string `json:"ids"`
  124. }{
  125. IDs: ids,
  126. }
  127. secretResp := &SecretsDeleteResponse{}
  128. if err := s.performHTTPRequestOperation(ctx, params{
  129. method: http.MethodDelete,
  130. url: s.bitwardenSdkServerURL + restAPIURL,
  131. body: body,
  132. result: &secretResp,
  133. }); err != nil {
  134. return nil, fmt.Errorf("failed to delete secret: %w", err)
  135. }
  136. return secretResp, nil
  137. }
  138. func (s *SdkClient) CreateSecret(ctx context.Context, createReq SecretCreateRequest) (*SecretResponse, error) {
  139. secretResp := &SecretResponse{}
  140. if err := s.performHTTPRequestOperation(ctx, params{
  141. method: http.MethodPost,
  142. url: s.bitwardenSdkServerURL + restAPIURL,
  143. body: createReq,
  144. result: &secretResp,
  145. }); err != nil {
  146. return nil, fmt.Errorf("failed to create secret: %w", err)
  147. }
  148. return secretResp, nil
  149. }
  150. func (s *SdkClient) UpdateSecret(ctx context.Context, putReq SecretPutRequest) (*SecretResponse, error) {
  151. secretResp := &SecretResponse{}
  152. if err := s.performHTTPRequestOperation(ctx, params{
  153. method: http.MethodPut,
  154. url: s.bitwardenSdkServerURL + restAPIURL,
  155. body: putReq,
  156. result: &secretResp,
  157. }); err != nil {
  158. return nil, fmt.Errorf("failed to update secret: %w", err)
  159. }
  160. return secretResp, nil
  161. }
  162. func (s *SdkClient) ListSecrets(ctx context.Context, organizationID string) (*SecretIdentifiersResponse, error) {
  163. body := struct {
  164. ID string `json:"organizationID"`
  165. }{
  166. ID: organizationID,
  167. }
  168. secretResp := &SecretIdentifiersResponse{}
  169. if err := s.performHTTPRequestOperation(ctx, params{
  170. method: http.MethodGet,
  171. url: s.bitwardenSdkServerURL + "/rest/api/1/secrets",
  172. body: body,
  173. result: &secretResp,
  174. }); err != nil {
  175. return nil, fmt.Errorf("failed to list secrets: %w", err)
  176. }
  177. return secretResp, nil
  178. }
  179. func (s *SdkClient) constructSdkRequest(ctx context.Context, method, url string, body []byte) (*http.Request, error) {
  180. req, err := http.NewRequestWithContext(ctx, method, url, bytes.NewBuffer(body))
  181. if err != nil {
  182. return nil, fmt.Errorf("failed to construct request: %w", err)
  183. }
  184. req.Header.Set(WardenHeaderAccessToken, s.token)
  185. req.Header.Set(WardenHeaderAPIURL, s.apiURL)
  186. req.Header.Set(WardenHeaderIdentityURL, s.identityURL)
  187. return req, nil
  188. }
  189. type params struct {
  190. method string
  191. url string
  192. body any
  193. result any
  194. }
  195. func (s *SdkClient) performHTTPRequestOperation(ctx context.Context, params params) error {
  196. data, err := json.Marshal(params.body)
  197. if err != nil {
  198. return fmt.Errorf("failed to marshal body: %w", err)
  199. }
  200. req, err := s.constructSdkRequest(ctx, params.method, params.url, data)
  201. if err != nil {
  202. return fmt.Errorf("failed to construct request: %w", err)
  203. }
  204. resp, err := s.client.Do(req)
  205. if err != nil {
  206. return fmt.Errorf("failed to do request: %w", err)
  207. }
  208. defer func() {
  209. _ = resp.Body.Close()
  210. }()
  211. if resp.StatusCode != http.StatusOK {
  212. content, _ := io.ReadAll(resp.Body)
  213. return fmt.Errorf("failed to perform http request, got response: %s with status code %d", string(content), resp.StatusCode)
  214. }
  215. decoder := json.NewDecoder(resp.Body)
  216. if err := decoder.Decode(&params.result); err != nil {
  217. return fmt.Errorf("failed to decode response: %w", err)
  218. }
  219. return nil
  220. }