firewall_rules.go 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. package cloudflare
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "net/url"
  6. "strconv"
  7. "strings"
  8. "time"
  9. "github.com/pkg/errors"
  10. )
  11. // FirewallRule is the struct of the firewall rule.
  12. type FirewallRule struct {
  13. ID string `json:"id,omitempty"`
  14. Paused bool `json:"paused"`
  15. Description string `json:"description"`
  16. Action string `json:"action"`
  17. Priority interface{} `json:"priority"`
  18. Filter Filter `json:"filter"`
  19. CreatedOn time.Time `json:"created_on,omitempty"`
  20. ModifiedOn time.Time `json:"modified_on,omitempty"`
  21. }
  22. // FirewallRulesDetailResponse is the API response for the firewall
  23. // rules.
  24. type FirewallRulesDetailResponse struct {
  25. Result []FirewallRule `json:"result"`
  26. ResultInfo `json:"result_info"`
  27. Response
  28. }
  29. // FirewallRuleResponse is the API response that is returned
  30. // for requesting a single firewall rule on a zone.
  31. type FirewallRuleResponse struct {
  32. Result FirewallRule `json:"result"`
  33. ResultInfo `json:"result_info"`
  34. Response
  35. }
  36. // FirewallRules returns all firewall rules.
  37. //
  38. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/get/#get-all-rules
  39. func (api *API) FirewallRules(zoneID string, pageOpts PaginationOptions) ([]FirewallRule, error) {
  40. uri := fmt.Sprintf("/zones/%s/firewall/rules", zoneID)
  41. v := url.Values{}
  42. if pageOpts.PerPage > 0 {
  43. v.Set("per_page", strconv.Itoa(pageOpts.PerPage))
  44. }
  45. if pageOpts.Page > 0 {
  46. v.Set("page", strconv.Itoa(pageOpts.Page))
  47. }
  48. if len(v) > 0 {
  49. uri = uri + "?" + v.Encode()
  50. }
  51. res, err := api.makeRequest("GET", uri, nil)
  52. if err != nil {
  53. return []FirewallRule{}, errors.Wrap(err, errMakeRequestError)
  54. }
  55. var firewallDetailResponse FirewallRulesDetailResponse
  56. err = json.Unmarshal(res, &firewallDetailResponse)
  57. if err != nil {
  58. return []FirewallRule{}, errors.Wrap(err, errUnmarshalError)
  59. }
  60. return firewallDetailResponse.Result, nil
  61. }
  62. // FirewallRule returns a single firewall rule based on the ID.
  63. //
  64. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/get/#get-by-rule-id
  65. func (api *API) FirewallRule(zoneID, firewallRuleID string) (FirewallRule, error) {
  66. uri := fmt.Sprintf("/zones/%s/firewall/rules/%s", zoneID, firewallRuleID)
  67. res, err := api.makeRequest("GET", uri, nil)
  68. if err != nil {
  69. return FirewallRule{}, errors.Wrap(err, errMakeRequestError)
  70. }
  71. var firewallRuleResponse FirewallRuleResponse
  72. err = json.Unmarshal(res, &firewallRuleResponse)
  73. if err != nil {
  74. return FirewallRule{}, errors.Wrap(err, errUnmarshalError)
  75. }
  76. return firewallRuleResponse.Result, nil
  77. }
  78. // CreateFirewallRules creates new firewall rules.
  79. //
  80. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/post/
  81. func (api *API) CreateFirewallRules(zoneID string, firewallRules []FirewallRule) ([]FirewallRule, error) {
  82. uri := fmt.Sprintf("/zones/%s/firewall/rules", zoneID)
  83. res, err := api.makeRequest("POST", uri, firewallRules)
  84. if err != nil {
  85. return []FirewallRule{}, errors.Wrap(err, errMakeRequestError)
  86. }
  87. var firewallRulesDetailResponse FirewallRulesDetailResponse
  88. err = json.Unmarshal(res, &firewallRulesDetailResponse)
  89. if err != nil {
  90. return []FirewallRule{}, errors.Wrap(err, errUnmarshalError)
  91. }
  92. return firewallRulesDetailResponse.Result, nil
  93. }
  94. // UpdateFirewallRule updates a single firewall rule.
  95. //
  96. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/put/#update-a-single-rule
  97. func (api *API) UpdateFirewallRule(zoneID string, firewallRule FirewallRule) (FirewallRule, error) {
  98. if firewallRule.ID == "" {
  99. return FirewallRule{}, errors.Errorf("firewall rule ID cannot be empty")
  100. }
  101. uri := fmt.Sprintf("/zones/%s/firewall/rules/%s", zoneID, firewallRule.ID)
  102. res, err := api.makeRequest("PUT", uri, firewallRule)
  103. if err != nil {
  104. return FirewallRule{}, errors.Wrap(err, errMakeRequestError)
  105. }
  106. var firewallRuleResponse FirewallRuleResponse
  107. err = json.Unmarshal(res, &firewallRuleResponse)
  108. if err != nil {
  109. return FirewallRule{}, errors.Wrap(err, errUnmarshalError)
  110. }
  111. return firewallRuleResponse.Result, nil
  112. }
  113. // UpdateFirewallRules updates a single firewall rule.
  114. //
  115. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/put/#update-multiple-rules
  116. func (api *API) UpdateFirewallRules(zoneID string, firewallRules []FirewallRule) ([]FirewallRule, error) {
  117. for _, firewallRule := range firewallRules {
  118. if firewallRule.ID == "" {
  119. return []FirewallRule{}, errors.Errorf("firewall ID cannot be empty")
  120. }
  121. }
  122. uri := fmt.Sprintf("/zones/%s/firewall/rules", zoneID)
  123. res, err := api.makeRequest("PUT", uri, firewallRules)
  124. if err != nil {
  125. return []FirewallRule{}, errors.Wrap(err, errMakeRequestError)
  126. }
  127. var firewallRulesDetailResponse FirewallRulesDetailResponse
  128. err = json.Unmarshal(res, &firewallRulesDetailResponse)
  129. if err != nil {
  130. return []FirewallRule{}, errors.Wrap(err, errUnmarshalError)
  131. }
  132. return firewallRulesDetailResponse.Result, nil
  133. }
  134. // DeleteFirewallRule updates a single firewall rule.
  135. //
  136. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/delete/#delete-a-single-rule
  137. func (api *API) DeleteFirewallRule(zoneID, firewallRuleID string) error {
  138. if firewallRuleID == "" {
  139. return errors.Errorf("firewall rule ID cannot be empty")
  140. }
  141. uri := fmt.Sprintf("/zones/%s/firewall/rules/%s", zoneID, firewallRuleID)
  142. _, err := api.makeRequest("DELETE", uri, nil)
  143. if err != nil {
  144. return errors.Wrap(err, errMakeRequestError)
  145. }
  146. return nil
  147. }
  148. // DeleteFirewallRules updates a single firewall rule.
  149. //
  150. // API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/delete/#delete-multiple-rules
  151. func (api *API) DeleteFirewallRules(zoneID string, firewallRuleIDs []string) error {
  152. ids := strings.Join(firewallRuleIDs, ",")
  153. uri := fmt.Sprintf("/zones/%s/firewall/rules?id=%s", zoneID, ids)
  154. _, err := api.makeRequest("DELETE", uri, nil)
  155. if err != nil {
  156. return errors.Wrap(err, errMakeRequestError)
  157. }
  158. return nil
  159. }