Skip to content

Commit 035ab5a

Browse files
committed
SMH. If at first you don't succeed, you know you've been spending too much time fixing Javadoc.
Sigh. Actually fixed the Javadoc this time.
1 parent def1b19 commit 035ab5a

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

src/main/java/org/owasp/esapi/filters/ClickjackFilter.java

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,39 +26,45 @@
2626
import javax.servlet.http.HttpServletResponse;
2727

2828
/**
29-
* The {@code ClickjackFilter} is discussed at
30-
* @{link http://www.owasp.org/index.php/ClickjackFilter_for_Java_EE OWASP Clickjack Filter for JavaEE}
29+
* The {@code ClickjackFilter} is configured as follows:
3130
* <pre>
32-
* <filter>
33-
* <filter-name>ClickjackFilterDeny</filter-name>
34-
* <filter-class>org.owasp.filters.ClickjackFilter</filter-class>
35-
* <init-param>
36-
* <param-name>mode</param-name>
37-
* <param-value>DENY</param-value>
38-
* </init-param>
39-
* </filter>
31+
*
32+
* &lt;filter&gt;
33+
* &lt;filter-name&gt;ClickjackFilterDeny&lt;/filter-name&gt;
34+
* &lt;filter-class&gt;org.owasp.filters.ClickjackFilter&lt;/filter-class&gt;
35+
* &lt;init-param&gt;
36+
* &lt;param-name&gt;mode&lt;/param-name&gt;
37+
* &lt;param-value&gt;DENY&lt;/param-value&gt;
38+
* &lt;/init-param&gt;
39+
* &lt;/filter&gt;
4040
*
41-
* <filter>
42-
* <filter-name>ClickjackFilterSameOrigin</filter-name>
43-
* <filter-class>org.owasp.filters.ClickjackFilter</filter-class>
44-
* <init-param>
45-
* <param-name>mode</param-name>
46-
* <param-value>SAMEORIGIN</param-value>
47-
* </init-param>
48-
* </filter>
41+
* &lt;filter&gt;
42+
* &lt;filter-name&gt;ClickjackFilterSameOrigin&lt;/filter-name&gt;
43+
* &lt;filter-class&gt;org.owasp.filters.ClickjackFilter&lt;/filter-class&gt;
44+
* &lt;init-param&gt;
45+
* &lt;param-name&gt;mode&lt;/param-name&gt;
46+
* &lt;param-value&gt;SAMEORIGIN&lt;/param-value&gt;
47+
* &lt;/init-param&gt;
48+
* &lt;/filter&gt;
4949
*
50-
* <!-- use the Deny version to prevent anyone, including yourself, from framing the page -->
51-
* <filter-mapping>
52-
* <filter-name>ClickjackFilterDeny</filter-name>
53-
* <url-pattern>/*</url-pattern>
54-
* </filter-mapping>
50+
* &lt;!-- use the Deny version to prevent anyone, including yourself, from framing the page --&gt;
51+
* &lt;filter-mapping&gt;
52+
* &lt;filter-name&gt;ClickjackFilterDeny&lt;/filter-name&gt;
53+
* &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
54+
* &lt;/filter-mapping&gt;
5555
*
56-
* <!-- use the SameOrigin version to allow your application to frame, but nobody else
57-
* <filter-mapping>
58-
* <filter-name>ClickjackFilterSameOrigin</filter-name>
59-
* <url-pattern>/*</url-pattern>
60-
* </filter-mapping>
56+
* &lt;!-- use the SameOrigin version to allow your application to frame, but nobody else
57+
* &lt;filter-mapping&gt;
58+
* &lt;filter-name&gt;ClickjackFilterSameOrigin&lt;/filter-name&gt;
59+
* &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
60+
* &lt;/filter-mapping&gt;
6161
* </pre>
62+
*
63+
* @see <a href="https://web.archive.org/web/20131020084831/https://www.owasp.org/index.php/ClickjackFilter_for_Java_EE">
64+
* OWASP - Clickjacking Filter for JavaEE</a>
65+
* @see <a href="https://owasp.org/www-community/attacks/Clickjacking">OWASP - Clickjacking Attack</a>
66+
* @see <a href="https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html">
67+
* OWASP - Clickjacking Defense Cheat Sheet</a>
6268
*/
6369
public class ClickjackFilter implements Filter
6470
{

0 commit comments

Comments
 (0)