access_policy.go 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. package cloudflare
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "net/url"
  6. "strconv"
  7. "time"
  8. "github.com/pkg/errors"
  9. )
  10. // AccessPolicy defines a policy for allowing or disallowing access to
  11. // one or more Access applications.
  12. type AccessPolicy struct {
  13. ID string `json:"id,omitempty"`
  14. Precedence int `json:"precedence"`
  15. Decision string `json:"decision"`
  16. CreatedAt *time.Time `json:"created_at"`
  17. UpdatedAt *time.Time `json:"updated_at"`
  18. Name string `json:"name"`
  19. // The include policy works like an OR logical operator. The user must
  20. // satisfy one of the rules.
  21. Include []interface{} `json:"include"`
  22. // The exclude policy works like a NOT logical operator. The user must
  23. // not satisfy all of the rules in exclude.
  24. Exclude []interface{} `json:"exclude"`
  25. // The require policy works like a AND logical operator. The user must
  26. // satisfy all of the rules in require.
  27. Require []interface{} `json:"require"`
  28. }
  29. // AccessPolicyEmail is used for managing access based on the email.
  30. // For example, restrict access to users with the email addresses
  31. // `test@example.com` or `someone@example.com`.
  32. type AccessPolicyEmail struct {
  33. Email struct {
  34. Email string `json:"email"`
  35. } `json:"email"`
  36. }
  37. // AccessPolicyEmailDomain is used for managing access based on an email
  38. // domain domain such as `example.com` instead of individual addresses.
  39. type AccessPolicyEmailDomain struct {
  40. EmailDomain struct {
  41. Domain string `json:"domain"`
  42. } `json:"email_domain"`
  43. }
  44. // AccessPolicyIP is used for managing access based in the IP. It
  45. // accepts individual IPs or CIDRs.
  46. type AccessPolicyIP struct {
  47. IP struct {
  48. IP string `json:"ip"`
  49. } `json:"ip"`
  50. }
  51. // AccessPolicyEveryone is used for managing access to everyone.
  52. type AccessPolicyEveryone struct {
  53. Everyone struct{} `json:"everyone"`
  54. }
  55. // AccessPolicyAccessGroup is used for managing access based on an
  56. // access group.
  57. type AccessPolicyAccessGroup struct {
  58. Group struct {
  59. ID string `json:"id"`
  60. } `json:"group"`
  61. }
  62. // AccessPolicyListResponse represents the response from the list
  63. // access polciies endpoint.
  64. type AccessPolicyListResponse struct {
  65. Result []AccessPolicy `json:"result"`
  66. Response
  67. ResultInfo `json:"result_info"`
  68. }
  69. // AccessPolicyDetailResponse is the API response, containing a single
  70. // access policy.
  71. type AccessPolicyDetailResponse struct {
  72. Success bool `json:"success"`
  73. Errors []string `json:"errors"`
  74. Messages []string `json:"messages"`
  75. Result AccessPolicy `json:"result"`
  76. }
  77. // AccessPolicies returns all access policies for an access application.
  78. //
  79. // API reference: https://api.cloudflare.com/#access-policy-list-access-policies
  80. func (api *API) AccessPolicies(zoneID, applicationID string, pageOpts PaginationOptions) ([]AccessPolicy, ResultInfo, error) {
  81. v := url.Values{}
  82. if pageOpts.PerPage > 0 {
  83. v.Set("per_page", strconv.Itoa(pageOpts.PerPage))
  84. }
  85. if pageOpts.Page > 0 {
  86. v.Set("page", strconv.Itoa(pageOpts.Page))
  87. }
  88. uri := fmt.Sprintf(
  89. "/zones/%s/access/apps/%s/policies",
  90. zoneID,
  91. applicationID,
  92. )
  93. if len(v) > 0 {
  94. uri = uri + "?" + v.Encode()
  95. }
  96. res, err := api.makeRequest("GET", uri, nil)
  97. if err != nil {
  98. return []AccessPolicy{}, ResultInfo{}, errors.Wrap(err, errMakeRequestError)
  99. }
  100. var accessPolicyListResponse AccessPolicyListResponse
  101. err = json.Unmarshal(res, &accessPolicyListResponse)
  102. if err != nil {
  103. return []AccessPolicy{}, ResultInfo{}, errors.Wrap(err, errUnmarshalError)
  104. }
  105. return accessPolicyListResponse.Result, accessPolicyListResponse.ResultInfo, nil
  106. }
  107. // AccessPolicy returns a single policy based on the policy ID.
  108. //
  109. // API reference: https://api.cloudflare.com/#access-policy-access-policy-details
  110. func (api *API) AccessPolicy(zoneID, applicationID, policyID string) (AccessPolicy, error) {
  111. uri := fmt.Sprintf(
  112. "/zones/%s/access/apps/%s/policies/%s",
  113. zoneID,
  114. applicationID,
  115. policyID,
  116. )
  117. res, err := api.makeRequest("GET", uri, nil)
  118. if err != nil {
  119. return AccessPolicy{}, errors.Wrap(err, errMakeRequestError)
  120. }
  121. var accessPolicyDetailResponse AccessPolicyDetailResponse
  122. err = json.Unmarshal(res, &accessPolicyDetailResponse)
  123. if err != nil {
  124. return AccessPolicy{}, errors.Wrap(err, errUnmarshalError)
  125. }
  126. return accessPolicyDetailResponse.Result, nil
  127. }
  128. // CreateAccessPolicy creates a new access policy.
  129. //
  130. // API reference: https://api.cloudflare.com/#access-policy-create-access-policy
  131. func (api *API) CreateAccessPolicy(zoneID, applicationID string, accessPolicy AccessPolicy) (AccessPolicy, error) {
  132. uri := fmt.Sprintf(
  133. "/zones/%s/access/apps/%s/policies",
  134. zoneID,
  135. applicationID,
  136. )
  137. res, err := api.makeRequest("POST", uri, accessPolicy)
  138. if err != nil {
  139. return AccessPolicy{}, errors.Wrap(err, errMakeRequestError)
  140. }
  141. var accessPolicyDetailResponse AccessPolicyDetailResponse
  142. err = json.Unmarshal(res, &accessPolicyDetailResponse)
  143. if err != nil {
  144. return AccessPolicy{}, errors.Wrap(err, errUnmarshalError)
  145. }
  146. return accessPolicyDetailResponse.Result, nil
  147. }
  148. // UpdateAccessPolicy updates an existing access policy.
  149. //
  150. // API reference: https://api.cloudflare.com/#access-policy-update-access-policy
  151. func (api *API) UpdateAccessPolicy(zoneID, applicationID string, accessPolicy AccessPolicy) (AccessPolicy, error) {
  152. if accessPolicy.ID == "" {
  153. return AccessPolicy{}, errors.Errorf("access policy ID cannot be empty")
  154. }
  155. uri := fmt.Sprintf(
  156. "/zones/%s/access/apps/%s/policies/%s",
  157. zoneID,
  158. applicationID,
  159. accessPolicy.ID,
  160. )
  161. res, err := api.makeRequest("PUT", uri, accessPolicy)
  162. if err != nil {
  163. return AccessPolicy{}, errors.Wrap(err, errMakeRequestError)
  164. }
  165. var accessPolicyDetailResponse AccessPolicyDetailResponse
  166. err = json.Unmarshal(res, &accessPolicyDetailResponse)
  167. if err != nil {
  168. return AccessPolicy{}, errors.Wrap(err, errUnmarshalError)
  169. }
  170. return accessPolicyDetailResponse.Result, nil
  171. }
  172. // DeleteAccessPolicy deletes an access policy.
  173. //
  174. // API reference: https://api.cloudflare.com/#access-policy-update-access-policy
  175. func (api *API) DeleteAccessPolicy(zoneID, applicationID, accessPolicyID string) error {
  176. uri := fmt.Sprintf(
  177. "/zones/%s/access/apps/%s/policies/%s",
  178. zoneID,
  179. applicationID,
  180. accessPolicyID,
  181. )
  182. _, err := api.makeRequest("DELETE", uri, nil)
  183. if err != nil {
  184. return errors.Wrap(err, errMakeRequestError)
  185. }
  186. return nil
  187. }