DXE-2891 Merge pull request #189 from akamai/release/v7.1.0

## 7.1.0 (July 25, 2023)

### FEATURES/ENHANCEMENTS:

* APPSEC
  * Added Bot Management API Support
    * Challenge Injection Rules - read, update
    * Add `CreateSecurityPolicyWithDefaultProtections` method to the `SecurityPolicy` interface to support creating a security policy with all available protections enabled.
  * Update marshaling of PII learning setting

### Deprecations

* Challenge Interceptions Rules has been deprecated
* Deprecate the following interfaces used to maintain individual policy protections:
  * `ApiConstraintsProtection`
  * `IPGeoProtection`
  * `MalwareProtection`
  * `NetworkLayerProtection`
  * `RateProtection`
  * `ReputationProtection`
  * `SlowPostProtection`
  * `WAFProtection`
* Deprecate the `CreateSecurityPolicy` method of the `SecurityPolicy` interface.

Author: mgwoj

CHANGELOG.md

@@ -1,5 +1,29 @@
 # EDGEGRID GOLANG RELEASE NOTES
 
+## 7.1.0 (July 25, 2023)
+
+### FEATURES/ENHANCEMENTS:
+
+* APPSEC
+  * Added Bot Management API Support
+    * Challenge Injection Rules - read, update
+    * Add `CreateSecurityPolicyWithDefaultProtections` method to the `SecurityPolicy` interface to support creating a security policy with all available protections enabled.
+  * Update marshaling of PII learning setting
+
+### Deprecations
+
+* Challenge Interceptions Rules has been deprecated
+* Deprecate the following interfaces used to maintain individual policy protections:
+  * `ApiConstraintsProtection`
+  * `IPGeoProtection`
+  * `MalwareProtection`
+  * `NetworkLayerProtection`
+  * `RateProtection`
+  * `ReputationProtection`
+  * `SlowPostProtection`
+  * `WAFProtection`
+* Deprecate the `CreateSecurityPolicy` method of the `SecurityPolicy` interface.
+
 ## 7.0.0 (June 20, 2023)
 
 ### BREAKING CHANGES:

pkg/appsec/api_constraints_protection.go

@@ -10,13 +10,16 @@ import (
 
 type (
 	// The ApiConstraintsProtection interface supports retrieving and updating API request constraints protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	ApiConstraintsProtection interface {
 		// GetAPIConstraintsProtection retrieves the current API constraints protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		GetAPIConstraintsProtection(ctx context.Context, params GetAPIConstraintsProtectionRequest) (*GetAPIConstraintsProtectionResponse, error)
 
 		// UpdateAPIConstraintsProtection updates the API constraints protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
 		UpdateAPIConstraintsProtection(ctx context.Context, params UpdateAPIConstraintsProtectionRequest) (*UpdateAPIConstraintsProtectionResponse, error)

pkg/appsec/export_configuration.go

@@ -507,7 +507,7 @@ type (
 		} `json:"prefetch"`
 		PragmaHeader *GetAdvancedSettingsPragmaResponse `json:"pragmaHeader,omitempty"`
 		RequestBody  *RequestBody                       `json:"requestBody,omitempty"`
-		PIILearning  bool                               `json:"piiLearning"`
+		PIILearning  *PIILearningexp                    `json:"piiLearning,omitempty"`
 	}
 
 	// CustomDenyListexp is returned as part of GetExportConfigurationResponse.
@@ -677,6 +677,11 @@ type (
 		EnablePathMatch bool `json:"enabled"`
 	}
 
+	// PIILearningexp contains the PIILearning setting
+	PIILearningexp struct {
+		EnablePIILearning bool `json:"enabled"`
+	}
+
 	// RequestBody is returned as part of GetExportConfigurationResponse.
 	RequestBody struct {
 		RequestBodyInspectionLimitInKB string `json:"requestBodyInspectionLimitInKB"`
@@ -774,6 +779,7 @@ type (
 		CustomDenyActions          []map[string]interface{} `json:"customDenyActions,omitempty"`
 		ServeAlternateActions      []map[string]interface{} `json:"serveAlternateActions,omitempty"`
 		ChallengeInterceptionRules map[string]interface{}   `json:"challengeInterceptionRules,omitempty"`
+		ChallengeInjectionRules    map[string]interface{}   `json:"challengeInjectionRules,omitempty"`
 	}
 
 	// BotManagement is returned as part of GetExportConfigurationResponse

pkg/appsec/ip_geo_protection.go

@@ -10,19 +10,22 @@ import (
 
 type (
 	// The IPGeoProtection interface supports retrieving and updating IPGeo protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	IPGeoProtection interface {
 		// GetIPGeoProtections retrieves the current IPGeo protection protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
-		// Deprecated: this method will be removed in a future release. Use GetIPGeoProtection instead.
 		GetIPGeoProtections(ctx context.Context, params GetIPGeoProtectionsRequest) (*GetIPGeoProtectionsResponse, error)
 
 		// GetIPGeoProtection retrieves the current IPGeo protection protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		GetIPGeoProtection(ctx context.Context, params GetIPGeoProtectionRequest) (*GetIPGeoProtectionResponse, error)
 
 		// UpdateIPGeoProtection updates the IPGeo protection protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
 		UpdateIPGeoProtection(ctx context.Context, params UpdateIPGeoProtectionRequest) (*UpdateIPGeoProtectionResponse, error)

pkg/appsec/malware_protection.go

@@ -10,13 +10,16 @@ import (
 
 type (
 	// The MalwareProtection interface supports retrieving and updating malware protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	MalwareProtection interface {
 		// GetMalwareProtection retrieves the current malware protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-malware
 		GetMalwareProtection(ctx context.Context, params GetMalwareProtectionRequest) (*GetMalwareProtectionResponse, error)
 
 		// UpdateMalwareProtection updates the malware protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-malware
 		UpdateMalwareProtection(ctx context.Context, params UpdateMalwareProtectionRequest) (*UpdateMalwareProtectionResponse, error)

pkg/appsec/mocks.go

@@ -1261,6 +1261,14 @@ func (m *Mock) CreateSecurityPolicy(ctx context.Context, req CreateSecurityPolic
 	return args.Get(0).(*CreateSecurityPolicyResponse), args.Error(1)
 }
 
+func (m *Mock) CreateSecurityPolicyWithDefaultProtections(ctx context.Context, req CreateSecurityPolicyWithDefaultProtectionsRequest) (*CreateSecurityPolicyResponse, error) {
+	args := m.Called(ctx, req)
+	if args.Get(0) == nil {
+		return nil, args.Error(1)
+	}
+	return args.Get(0).(*CreateSecurityPolicyResponse), args.Error(1)
+}
+
 func (m *Mock) CreateReputationProfile(ctx context.Context, req CreateReputationProfileRequest) (*CreateReputationProfileResponse, error) {
 	args := m.Called(ctx, req)
 	if args.Get(0) == nil {

pkg/appsec/network_layer_protection.go

@@ -10,27 +10,30 @@ import (
 
 type (
 	// The NetworkLayerProtection interface supports retrieving and updating network layer protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	NetworkLayerProtection interface {
 		// GetNetworkLayerProtections retrieves the current network layer protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
-		// Deprecated: this method will be removed in a future release. Use GetNetworkLayerProtection instead.
 		GetNetworkLayerProtections(ctx context.Context, params GetNetworkLayerProtectionsRequest) (*GetNetworkLayerProtectionsResponse, error)
 
 		// GetNetworkLayerProtection retrieves the current network layer protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		GetNetworkLayerProtection(ctx context.Context, params GetNetworkLayerProtectionRequest) (*GetNetworkLayerProtectionResponse, error)
 
 		// UpdateNetworkLayerProtection updates the network layer protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
 		UpdateNetworkLayerProtection(ctx context.Context, params UpdateNetworkLayerProtectionRequest) (*UpdateNetworkLayerProtectionResponse, error)
 
 		// RemoveNetworkLayerProtection removes network layer protection for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
-		// Deprecated: this method will be removed in a future release. Use UpdateNetworkLayerProtection instead.
 		RemoveNetworkLayerProtection(ctx context.Context, params RemoveNetworkLayerProtectionRequest) (*RemoveNetworkLayerProtectionResponse, error)
 	}
 

pkg/appsec/rate_protection.go

@@ -10,19 +10,22 @@ import (
 
 type (
 	// The RateProtection interface supports retrieving and updating rate protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	RateProtection interface {
 		// GetRateProtections retrieves the current rate protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
-		// Deprecated: this method will be removed in a future release. Use GetRateProtection instead.
 		GetRateProtections(ctx context.Context, params GetRateProtectionsRequest) (*GetRateProtectionsResponse, error)
 
 		// GetRateProtection retrieves the current rate protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		GetRateProtection(ctx context.Context, params GetRateProtectionRequest) (*GetRateProtectionResponse, error)
 
 		// UpdateRateProtection updates the rate protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
 		UpdateRateProtection(ctx context.Context, params UpdateRateProtectionRequest) (*UpdateRateProtectionResponse, error)

pkg/appsec/reputation_protection.go

@@ -10,27 +10,31 @@ import (
 
 type (
 	// The ReputationProtection interface supports retrieving and updating reputation protection for a configuration and policy.
+	// Deprecated: this interface will be removed in a future release. Use the SecurityPolicy interface instead.
 	ReputationProtection interface {
 		// GetReputationProtections retrieves the current reputation protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		// Deprecated: this method will be removed in a future release. Use GetReputationProtection instead.
 		GetReputationProtections(ctx context.Context, params GetReputationProtectionsRequest) (*GetReputationProtectionsResponse, error)
 
 		// GetReputationProtection retrieves the current reputation protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the GetPolicyProtections method of the PolicyProtections interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/get-policy-protections
 		GetReputationProtection(ctx context.Context, params GetReputationProtectionRequest) (*GetReputationProtectionResponse, error)
 
 		// UpdateReputationProtection updates the reputation protection setting for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
 		UpdateReputationProtection(ctx context.Context, params UpdateReputationProtectionRequest) (*UpdateReputationProtectionResponse, error)
 
 		// RemoveReputationProtection removes reputation protection for a configuration and policy.
+		// Deprecated: this method will be removed in a future release. Use the CreateSecurityPolicyWithDefaultProtections method of the SecurityPolicy interface instead.
 		//
 		// See: https://techdocs.akamai.com/application-security/reference/put-policy-protections
-		// Deprecated: this method will be removed in a future release. Use UpdateReputationProtection instead.
 		RemoveReputationProtection(ctx context.Context, params RemoveReputationProtectionRequest) (*RemoveReputationProtectionResponse, error)
 	}