Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

r/aws_wafv2: Add missing values to text_transformation argument #20564

Merged
merged 4 commits into from
Aug 19, 2021
Merged

r/aws_wafv2: Add missing values to text_transformation argument #20564

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e676d8
Add all possible text transformation values
Brunhil Aug 13, 2021
1f3652b
Add changelog
Brunhil Aug 13, 2021
499c583
Remove trailing space
Brunhil Aug 13, 2021
2161af1
review fixes
Brunhil Aug 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/20564.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/aws_wafv2: Add missing values to `text_transformation` argument for `aws_wafv2_web_acl` and `aws_wafv2_rule_group` resources
```
15 changes: 15 additions & 0 deletions aws/wafv2_helper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,21 @@ func wafv2TextTransformationSchema() *schema.Schema {
wafv2.TextTransformationTypeLowercase,
wafv2.TextTransformationTypeNone,
wafv2.TextTransformationTypeUrlDecode,
wafv2.TextTransformationTypeBase64Decode,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in (#14601) the aws-go-sdk has added _Values() suffixed const arrays so we can actually replace this whole statement with:

validation.StringInSlice(wafv2.TextTransformationType_Values(), false),

This way the validation will automatically update as we update aws-go-sdk versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! Thanks for this tidbit of info, super slick. Will get this updated shortly!

wafv2.TextTransformationTypeHexDecode,
wafv2.TextTransformationTypeMd5,
wafv2.TextTransformationTypeReplaceComments,
wafv2.TextTransformationTypeEscapeSeqDecode,
wafv2.TextTransformationTypeSqlHexDecode,
wafv2.TextTransformationTypeCssDecode,
wafv2.TextTransformationTypeJsDecode,
wafv2.TextTransformationTypeNormalizePath,
wafv2.TextTransformationTypeNormalizePathWin,
wafv2.TextTransformationTypeRemoveNulls,
wafv2.TextTransformationTypeReplaceNulls,
wafv2.TextTransformationTypeBase64DecodeExt,
wafv2.TextTransformationTypeUrlDecodeUni,
wafv2.TextTransformationTypeUtf8ToUnicode,
}, false),
},
},
Expand Down
4 changes: 3 additions & 1 deletion website/docs/r/wafv2_rule_group.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,9 @@ The `single_query_argument` block supports the following arguments:
The `text_transformation` block supports the following arguments:

* `priority` - (Required) The relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content.
* `type` - (Required) The transformation to apply, you can specify the following types: `NONE`, `COMPRESS_WHITE_SPACE`, `HTML_ENTITY_DECODE`, `LOWERCASE`, `CMD_LINE`, `URL_DECODE`. See the [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.
* `type` - (Required) The transformation to apply, you can specify the following types: `NONE`, `COMPRESS_WHITE_SPACE`, `HTML_ENTITY_DECODE`, `LOWERCASE`, `CMD_LINE`, `URL_DECODE`, `BASE64_DECODE`, `HEX_DECODE`, `MD5`, `REPLACE_COMMENTS`,
`ESCAPE_SEQ_DECODE`, `SQL_HEX_DECODE`, `CSS_DECODE`, `JS_DECODE`, `NORMALIZE_PATH`, `NORMALIZE_PATH_WIN`, `REMOVE_NULLS`, `REPLACE_NULLS`, `BASE64_DECODE_EXT`, `URL_DECODE_UNI`, `UTF8_TO_UNICODE`.
See the [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we are now using on the TextTransformation_Values() function, we should link to the TextTransformation documentation for specific values.

Suggested change
* `type` - (Required) The transformation to apply, you can specify the following types: `NONE`, `COMPRESS_WHITE_SPACE`, `HTML_ENTITY_DECODE`, `LOWERCASE`, `CMD_LINE`, `URL_DECODE`, `BASE64_DECODE`, `HEX_DECODE`, `MD5`, `REPLACE_COMMENTS`,
`ESCAPE_SEQ_DECODE`, `SQL_HEX_DECODE`, `CSS_DECODE`, `JS_DECODE`, `NORMALIZE_PATH`, `NORMALIZE_PATH_WIN`, `REMOVE_NULLS`, `REPLACE_NULLS`, `BASE64_DECODE_EXT`, `URL_DECODE_UNI`, `UTF8_TO_UNICODE`.
See the [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.
* `type` - (Required) The transformation to apply, please refer to the Text Transformation [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.


### Visibility Configuration

Expand Down
5 changes: 4 additions & 1 deletion website/docs/r/wafv2_web_acl.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,10 @@ The `single_query_argument` block supports the following arguments:
The `text_transformation` block supports the following arguments:

* `priority` - (Required) The relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content.
* `type` - (Required) The transformation to apply, you can specify the following types: `NONE`, `COMPRESS_WHITE_SPACE`, `HTML_ENTITY_DECODE`, `LOWERCASE`, `CMD_LINE`, `URL_DECODE`. See the [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.
* `type` - (Required) The transformation to apply, you can specify the following types: `NONE`, `COMPRESS_WHITE_SPACE`, `HTML_ENTITY_DECODE`, `LOWERCASE`, `CMD_LINE`, `URL_DECODE`, `BASE64_DECODE`, `HEX_DECODE`, `MD5`, `REPLACE_COMMENTS`,
`ESCAPE_SEQ_DECODE`, `SQL_HEX_DECODE`, `CSS_DECODE`, `JS_DECODE`, `NORMALIZE_PATH`, `NORMALIZE_PATH_WIN`, `REMOVE_NULLS`, `REPLACE_NULLS`, `BASE64_DECODE_EXT`, `URL_DECODE_UNI`, `UTF8_TO_UNICODE`.
See the [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_TextTransformation.html) for more details.


### Visibility Configuration

Expand Down