Home | History | Annotate | Download | only in html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
      2 <!--NewPage-->
      3 <HTML>
      4 <HEAD>
      5 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
      6 <TITLE>
      7 CssSchema (OWASP Java HTML Sanitizer)
      8 </TITLE>
      9 
     10 
     11 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
     12 
     13 <SCRIPT type="text/javascript">
     14 function windowTitle()
     15 {
     16     if (location.href.indexOf('is-external=true') == -1) {
     17         parent.document.title="CssSchema (OWASP Java HTML Sanitizer)";
     18     }
     19 }
     20 </SCRIPT>
     21 <NOSCRIPT>
     22 </NOSCRIPT>
     23 
     24 </HEAD>
     25 
     26 <BODY BGCOLOR="white" onload="windowTitle();">
     27 <HR>
     28 
     29 
     30 <!-- ========= START OF TOP NAVBAR ======= -->
     31 <A NAME="navbar_top"><!-- --></A>
     32 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
     33 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
     34 <TR>
     35 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
     36 <A NAME="navbar_top_firstrow"><!-- --></A>
     37 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
     38   <TR ALIGN="center" VALIGN="top">
     39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
     40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
     41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
     42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CssSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
     43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
     44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
     45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
     46   </TR>
     47 </TABLE>
     48 </TD>
     49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
     50 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM>
     51 </TD>
     52 </TR>
     53 
     54 <TR>
     55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     56 &nbsp;<A HREF="../../../org/owasp/html/AttributePolicy.Util.html" title="class in org.owasp.html"><B>PREV CLASS</B></A>&nbsp;
     57 &nbsp;<A HREF="../../../org/owasp/html/ElementPolicy.html" title="interface in org.owasp.html"><B>NEXT CLASS</B></A></FONT></TD>
     58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     59   <A HREF="../../../index.html?org/owasp/html/CssSchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     60 &nbsp;<A HREF="CssSchema.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
     61 &nbsp;<SCRIPT type="text/javascript">
     62   <!--
     63   if(window==top) {
     64     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
     65   }
     66   //-->
     67 </SCRIPT>
     68 <NOSCRIPT>
     69   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
     70 </NOSCRIPT>
     71 
     72 
     73 </FONT></TD>
     74 </TR>
     75 <TR>
     76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     77   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
     78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     79 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     80 </TR>
     81 </TABLE>
     82 <A NAME="skip-navbar_top"></A>
     83 <!-- ========= END OF TOP NAVBAR ========= -->
     84 
     85 <HR>
     86 <!-- ======== START OF CLASS DATA ======== -->
     87 <H2>
     88 <FONT SIZE="-1">
     89 org.owasp.html</FONT>
     90 <BR>
     91 Class CssSchema</H2>
     92 <PRE>
     93 java.lang.Object
     94   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.owasp.html.CssSchema</B>
     95 </PRE>
     96 <HR>
     97 <DL>
     98 <DT><PRE>public final class <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.44"><B>CssSchema</B></A><DT>extends java.lang.Object</DL>
     99 </PRE>
    100 
    101 <P>
    102 Describes the kinds of tokens a CSS property's value can safely contain.
    103 <P>
    104 
    105 <P>
    106 <HR>
    107 
    108 <P>
    109 <!-- =========== FIELD SUMMARY =========== -->
    110 
    111 <A NAME="field_summary"><!-- --></A>
    112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    114 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    115 <B>Field Summary</B></FONT></TH>
    116 </TR>
    117 <TR BGCOLOR="white" CLASS="TableRowColor">
    118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    119 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A></CODE></FONT></TD>
    120 <TD><CODE><B><A HREF="../../../org/owasp/html/CssSchema.html#DEFAULT">DEFAULT</A></B></CODE>
    121 
    122 <BR>
    123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A schema that includes only those properties on the default schema
    124  white-list.</TD>
    125 </TR>
    126 </TABLE>
    127 &nbsp;
    128 <!-- ========== METHOD SUMMARY =========== -->
    129 
    130 <A NAME="method_summary"><!-- --></A>
    131 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    132 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    133 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    134 <B>Method Summary</B></FONT></TH>
    135 </TR>
    136 <TR BGCOLOR="white" CLASS="TableRowColor">
    137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    138 <CODE>&nbsp;java.util.Set&lt;java.lang.String&gt;</CODE></FONT></TD>
    139 <TD><CODE><B><A HREF="../../../org/owasp/html/CssSchema.html#allowedProperties()">allowedProperties</A></B>()</CODE>
    140 
    141 <BR>
    142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The set of CSS properties allowed by this schema.</TD>
    143 </TR>
    144 <TR BGCOLOR="white" CLASS="TableRowColor">
    145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    146 <CODE>static&nbsp;void</CODE></FONT></TD>
    147 <TD><CODE><B><A HREF="../../../org/owasp/html/CssSchema.html#main(java.lang.String...)">main</A></B>(java.lang.String...&nbsp;argv)</CODE>
    148 
    149 <BR>
    150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps key and literal list to stdout for easy examination.</TD>
    151 </TR>
    152 <TR BGCOLOR="white" CLASS="TableRowColor">
    153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    154 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A></CODE></FONT></TD>
    155 <TD><CODE><B><A HREF="../../../org/owasp/html/CssSchema.html#union(org.owasp.html.CssSchema...)">union</A></B>(<A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A>...&nbsp;cssSchemas)</CODE>
    156 
    157 <BR>
    158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A schema that represents the union of the input schemas.</TD>
    159 </TR>
    160 <TR BGCOLOR="white" CLASS="TableRowColor">
    161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    162 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A></CODE></FONT></TD>
    163 <TD><CODE><B><A HREF="../../../org/owasp/html/CssSchema.html#withProperties(java.lang.Iterable)">withProperties</A></B>(java.lang.Iterable&lt;? extends java.lang.String&gt;&nbsp;propertyNames)</CODE>
    164 
    165 <BR>
    166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A schema that includes all and only the named properties.</TD>
    167 </TR>
    168 </TABLE>
    169 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    171 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    172 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
    173 </TR>
    174 <TR BGCOLOR="white" CLASS="TableRowColor">
    175 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
    176 </TR>
    177 </TABLE>
    178 &nbsp;
    179 <P>
    180 
    181 <!-- ============ FIELD DETAIL =========== -->
    182 
    183 <A NAME="field_detail"><!-- --></A>
    184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    186 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    187 <B>Field Detail</B></FONT></TH>
    188 </TR>
    189 </TABLE>
    190 
    191 <A NAME="DEFAULT"><!-- --></A><H3>
    192 DEFAULT</H3>
    193 <PRE>
    194 public static final <A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A> <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.901"><B>DEFAULT</B></A></PRE>
    195 <DL>
    196 <DD>A schema that includes only those properties on the default schema
    197  white-list.
    198 <P>
    199 <DL>
    200 </DL>
    201 </DL>
    202 
    203 <!-- ============ METHOD DETAIL ========== -->
    204 
    205 <A NAME="method_detail"><!-- --></A>
    206 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    207 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    208 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    209 <B>Method Detail</B></FONT></TH>
    210 </TR>
    211 </TABLE>
    212 
    213 <A NAME="withProperties(java.lang.Iterable)"><!-- --></A><H3>
    214 withProperties</H3>
    215 <PRE>
    216 public static <A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A> <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.91"><B>withProperties</B></A>(java.lang.Iterable&lt;? extends java.lang.String&gt;&nbsp;propertyNames)</PRE>
    217 <DL>
    218 <DD>A schema that includes all and only the named properties.
    219 <P>
    220 <DD><DL>
    221 <DT><B>Parameters:</B><DD><CODE>propertyNames</CODE> - a series of lower-case CSS property names that appear
    222     in the built-in CSS definitions.  It is an error to mention an unknown
    223     property name.  This class's <code>main</code> method will dump a list of
    224     known property names when run with zero arguments.</DL>
    225 </DD>
    226 </DL>
    227 <HR>
    228 
    229 <A NAME="union(org.owasp.html.CssSchema...)"><!-- --></A><H3>
    230 union</H3>
    231 <PRE>
    232 public static <A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A> <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.109"><B>union</B></A>(<A HREF="../../../org/owasp/html/CssSchema.html" title="class in org.owasp.html">CssSchema</A>...&nbsp;cssSchemas)</PRE>
    233 <DL>
    234 <DD>A schema that represents the union of the input schemas.
    235 <P>
    236 <DD><DL>
    237 
    238 <DT><B>Returns:</B><DD>A schema that allows all and only CSS properties that are allowed
    239     by at least one of the inputs.</DL>
    240 </DD>
    241 </DL>
    242 <HR>
    243 
    244 <A NAME="allowedProperties()"><!-- --></A><H3>
    245 allowedProperties</H3>
    246 <PRE>
    247 public java.util.Set&lt;java.lang.String&gt; <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.123"><B>allowedProperties</B></A>()</PRE>
    248 <DL>
    249 <DD>The set of CSS properties allowed by this schema.
    250 <P>
    251 <DD><DL>
    252 
    253 <DT><B>Returns:</B><DD>an immutable set.</DL>
    254 </DD>
    255 </DL>
    256 <HR>
    257 
    258 <A NAME="main(java.lang.String...)"><!-- --></A><H3>
    259 main</H3>
    260 <PRE>
    261 public static void <A HREF="../../../src-html/org/owasp/html/CssSchema.html#line.905"><B>main</B></A>(java.lang.String...&nbsp;argv)</PRE>
    262 <DL>
    263 <DD>Dumps key and literal list to stdout for easy examination.
    264 <P>
    265 <DD><DL>
    266 </DL>
    267 </DD>
    268 </DL>
    269 <!-- ========= END OF CLASS DATA ========= -->
    270 <HR>
    271 
    272 
    273 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    274 <A NAME="navbar_bottom"><!-- --></A>
    275 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    276 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    277 <TR>
    278 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    279 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    280 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    281   <TR ALIGN="center" VALIGN="top">
    282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    284   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CssSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    287   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    288   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    289   </TR>
    290 </TABLE>
    291 </TD>
    292 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    293 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM>
    294 </TD>
    295 </TR>
    296 
    297 <TR>
    298 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    299 &nbsp;<A HREF="../../../org/owasp/html/AttributePolicy.Util.html" title="class in org.owasp.html"><B>PREV CLASS</B></A>&nbsp;
    300 &nbsp;<A HREF="../../../org/owasp/html/ElementPolicy.html" title="interface in org.owasp.html"><B>NEXT CLASS</B></A></FONT></TD>
    301 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    302   <A HREF="../../../index.html?org/owasp/html/CssSchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    303 &nbsp;<A HREF="CssSchema.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    304 &nbsp;<SCRIPT type="text/javascript">
    305   <!--
    306   if(window==top) {
    307     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    308   }
    309   //-->
    310 </SCRIPT>
    311 <NOSCRIPT>
    312   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    313 </NOSCRIPT>
    314 
    315 
    316 </FONT></TD>
    317 </TR>
    318 <TR>
    319 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    320   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    321 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    322 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    323 </TR>
    324 </TABLE>
    325 <A NAME="skip-navbar_bottom"></A>
    326 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    327 
    328 <HR>
    329 
    330 </BODY>
    331 </HTML>
    332