added README.md
Project: http://git-wip-us.apache.org/repos/asf/struts-extras/repo Commit: http://git-wip-us.apache.org/repos/asf/struts-extras/commit/f84e3f23 Tree: http://git-wip-us.apache.org/repos/asf/struts-extras/tree/f84e3f23 Diff: http://git-wip-us.apache.org/repos/asf/struts-extras/diff/f84e3f23 Branch: refs/heads/master Commit: f84e3f2335065533e33de5e8ebea7d82d1125e8b Parents: 00137f7 Author: Stefaan Dutry <stefaan.du...@gmail.com> Authored: Tue Mar 28 19:12:37 2017 +0200 Committer: Stefaan Dutry <stefaan.du...@gmail.com> Committed: Tue Mar 28 19:12:37 2017 +0200 ---------------------------------------------------------------------- README.md | 1 + struts2-custom-results-plugin/README.md | 42 ++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts-extras/blob/f84e3f23/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e5169d4..c1a5cad 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ mostly focused on fixing (if possibe) vulnerabilities in older versions of the f - [Apache Struts 2 Secure Jakarta Multipart parser plugin](struts2-secure-jakarta-multipart-parser-plugin/README.md) - [Apache Struts 2 Secure Jakarta Stream Multipart parser plugin](struts2-secure-jakarta-stream-multipart-parser-plugin/README.md) +- [Apache Struts 2 Custom results plugin](struts2-custom-results-plugin/README.md) ## License http://git-wip-us.apache.org/repos/asf/struts-extras/blob/f84e3f23/struts2-custom-results-plugin/README.md ---------------------------------------------------------------------- diff --git a/struts2-custom-results-plugin/README.md b/struts2-custom-results-plugin/README.md new file mode 100644 index 0000000..f19f2fb --- /dev/null +++ b/struts2-custom-results-plugin/README.md @@ -0,0 +1,42 @@ +# Apache Struts 2 Extras - custom results plugin + +[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) + +This plugin provides additional result types. + +## Supported versions + +This plugin can be used with the Apache Struts versions 2.5.x . + +## Result Type categories + +### SSL offloading support + +These result types are made to support redirecting under the https protocol while being behind a SSL offloading proxy. + +#### Result Types + +##### sslOffloadRedirect + +This Result Type should replace the `redirect` Result Type. +It takes into account 2 ways of detecting the offloading: +- `X-Forwarded-Proto` header (de-facto standard header) +- `proto` attribute of the `Forwarded` header ( [RFC7239](https://tools.ietf.org/html/rfc7239) ) + +##### sslOffloadRedirectAction + +This Result Type should replace the `redirectAction` Result Type. +It takes into account 2 ways of detecting the offloading: +- `X-Forwarded-Proto` header (de-facto standard header) +- `proto` attribute of the `Forwarded` header ( [RFC7239](https://tools.ietf.org/html/rfc7239) ) + +#### struts packages + +##### ssl-offload + +Only thing this package does is defining the result types so that they can be used. + +##### ssl-offload-default + +Merely combines the `struts-default` package and the `ssl-offload` package. +