bitwarden_sdk.go 8.5 KB

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