-
Notifications
You must be signed in to change notification settings - Fork 9
W-18724314 xml threat protection flex #880
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.
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
W-18724314 xml threat protection flex #880
Conversation
@@ -117,6 +117,7 @@ | |||
*** xref:policies-outbound-oauth.adoc[Credential Injection OAuth 2.0] | |||
*** xref:policies-outbound-circuit-breaker.adoc[Circuit Breaker Policy] | |||
*** xref:policies-outbound-upstream-idle-timeout.adoc[Upstream Idle Timeout] | |||
*** xref:policies-included-xml-threat-protection.adoc[XML Threat Protection] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid hard-coding titles unless you're changing them from the H1 text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We hard code them because the policy titles have "Policy" in them and we remove it from the left nav.
|
||
[width="100%", cols="1,3"] | ||
|=== | ||
>s|Policy Name| XML Threat Protection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've never seen this format!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure why, but all of our policies use it.
|
||
== Summary | ||
|
||
Applications processing XML requests are susceptible to attacks characterized by unusual inflation of elements, attributes, and deep nesting levels. Attackers use recursive techniques to consume memory resources. Dramatic increases in the size of the application data often signal a security risk. Use the XML Threat Protection policy to reject unusual requests that exceed the defined expected size. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hard to parse (had to read twice). Suggest "Applications that process..."
|
||
[%header%autowidth.spread,cols="a,a"] | ||
|=== | ||
|Field |Description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a move away from using tables for two-column info.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use this in all of our policies, so I'd rather reformat them as a whole then just this one.
|
||
[%header%autowidth.spread,cols="a,a,a,a"] | ||
|=== | ||
|Parameter | Required or Optional | Default Value | Description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typically, we use "Required" in the column heading and then "Yes" or "No" in the row.
@@ -101,7 +101,7 @@ endif::[] | |||
|
|||
| Upstream Idle Timeout ^| xref:gateway::policies-outbound-upstream-idle-timeout.adoc[✓] ^| | | Sets the maximum duration a stream between Flex Gateway and an upstream service can remain idle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid checkmarks. See CX Table guidelines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar here, I'm willing to move away from this, but can't handle it in this pr.
Writer's Quality Checklist
Before merging your PR, did you: