remove kses from API docs, it is not used any more

This commit is contained in:
Ralf Becker 2014-01-19 09:42:35 +00:00
parent 156000a5d5
commit 9d34d4ae2c
8 changed files with 0 additions and 796 deletions

View File

@ -1,15 +0,0 @@
kses AUTHORS
============
* Ulf Harnhammar <metaur at users dot sourceforge dot net>
main coder, project leader
* Richard R. Vasquez, Jr. (contact him at http://www.chaos.org/contact/)
coder (object-oriented kses)
* Simon Cornelius P. Umacob <simoncpu at users dot sourceforge dot net>
tester
Thanks to a lot of people who posted to the Bugtraq and Webappsec mailing lists
about XSS or HTML filters. They gave us some valuable insights.

View File

@ -1,340 +0,0 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

View File

@ -1,118 +0,0 @@
kses ChangeLog
==============
* 0.2.1
0.2.1 was released on the 29th of September 2003.
It has the following changes:
- There is now an additional version of kses, using the object-oriented
paradigm. Thanks a lot to Richard R. Vasquez, Jr., who created it! Anyone
who wants to make functional programming, logical programming or spaghetti
programming versions of kses as well (or any other programming paradigm that
you like), go ahead! All the people who like old procedural programming for
web applications shouldn't despair, though, as both versions will be
maintained with each release.
- kses now has some new attribute value checks: minlen, minval and valueless.
See docs/attribute-value-checks for an explanation.
- For some reason, the Opera developers decided to make chr(173) a whitespace
character in URL protocols, both when it occurs raw and in an entity. kses
now handles this.
- The URL protocol whitelisting system now decodes entities before removing
NULLs and whitespaces.
* 0.2.0
0.2.0 was released on the 25th of July 2003.
It has the following changes:
- kses now supports checking of attribute values, and not just element names
and attribute names. The attribute value checks that exist so far are
'maxlen' (checks how long attribute values are, to avoid Buffer Overflows)
and 'maxval' (checks how big an integer value is, to avoid Denial of Service
attacks).
Buffer Overflows could both be a problem for WWW clients and different
servers on the Internet that an HTML document links to. One example is
<frame src="ftp://ftp.v1ct1m.com/AAAAAA..thousands_of_A's...">.
Denial of Service attacks can take the form of too big sizes of iframes or
other things. One example is <iframe src="http://some.web.server/"
width="20000" height="2000">, which makes some client machines completely
overloaded.
- kses' old feature of removing "javascript:" from attribute values has been
improved. It now has a whole system for white listing of URL protocols, so
you can specify that it's acceptable with http:, https:, ftp: and gopher:,
but no other protocols in attribute values. The system tries pretty hard to
do the right thing with whitespace, upper/lower case, HTML entities
("jav&#97;script:") and repeated entries ("javascript:javascript:alert(57)").
- kses now supports both HTML and XHTML code, by allowing " /" at the end of
tags.
- kses now removes Netscape 4's JavaScript entities, having the form
"&{alert(57)};". They don't even seem to work on all versions of Netscape 4,
but for completeness' sake it seemed like a good feature to add.
- A bug with NULLs in javascript: URLs was fixed.
(Reported by Simon Cornelius P. Umacob - thanks!)
- As a nice side effect of the white listing of URL protocols, kses now also
normalizes all HTML entities in documents. It will change HTML code with bad
entities to the right form, for example "AT&T" will be converted to
"AT&amp;T" and "<a href='lyrics.php?band=ladytron&lyrics=playgirl'>" will be
converted to "<a href='lyrics.php?band=ladytron&amp;lyrics=playgirl'>".
"&#000058;" will be converted to "&#58;", "&#XYZZY;" will be converted to
"&amp;#XYZZY;", "&auml!;" will be converted to "&amp;auml!;" and so on.
As shown above, it will process HTML entities that it doesn't understand.
It will also deal with too big numbers in numeric HTML entities, which is
helpful as many browsers seem to wrap them around at 2 ** 32, so the
characters 58, 58 + (2 ** 32), 58 + (2 ** 64) etcetera are all colons to the
web browser.
- You can now use upper case letters in your $allowed_html array, in element
names, attribute names and attribute value check names. Version 0.1.0
required everything in that array to be in lower case, but that's not
necessary any more. You can also use upper case letters in
$allowed_protocols.
- The "Really malformed thing" bug from the TODO file was fixed.
It used to convert this string:
x > 5 <a href="blah">
to:
x &gt; 5 &lt;a href=&quot;blah&quot;&gt;
and now it converts it to:
x &gt; 5 <a href="blah">
- The "Weird malformed thing" bug from the TODO file was fixed.
It used to convert this string:
<a href="5 href=6>
to:
<a href="6">
because of the way kses restarts after a parse error in kses_hair(). Now it
converts it to:
<a>
- A problem with slashes in HTML tags was fixed.
- examples/filter.php used to use $SCRIPT_NAME, which doesn't work on
Windows.
(Reported by Simon Cornelius P. Umacob - thanks!)
- kses now allows dashes in attribute names, for things like
<meta http-equiv=..>.
* 0.1.0, first public version
0.1.0 was released on the 9th of June 2003.
It was announced on three security related mailing lists on Friday the 13th
of June (nothing bad happened to it though).

View File

@ -1,203 +0,0 @@
kses 0.2.1 README [kses strips evil scripts!]
=================
* INTRODUCTION *
Welcome to kses - an HTML/XHTML filter written in PHP. It removes all unwanted
HTML elements and attributes, no matter how malformed HTML input you give it.
It also does several checks on attribute values. kses can be used to avoid
Cross-Site Scripting (XSS), Buffer Overflows and Denial of Service attacks,
among other things.
The program is released under the terms of the GNU General Public License. You
should look into what that means, before using kses in your programs. You can
find the full text of the license in the file COPYING.
* FEATURES *
Some of kses' current features are:
* It will only allow the HTML elements and attributes that it was explicitly
told to allow.
* Element and attribute names are case-insensitive (a href vs A HREF).
* It will understand and process whitespace correctly.
* Attribute values can be surrounded with quotes, apostrophes or nothing.
* It will accept valueless attributes with just names and no values (selected).
* It will accept XHTML's closing " /" marks.
* Attribute values that are surrounded with nothing will get quotes to avoid
producing non-W3C conforming HTML
(<a href=http://sourceforge.net/projects/kses> works but isn't valid HTML).
* It handles lots of types of malformed HTML, by interpreting the existing
code the best it can and then rebuilding new code from it. That's a better
approach than trying to process existing code, as you're bound to forget about
some weird special case somewhere. It handles problems like never-ending
quotes and tags gracefully.
* It will remove additional "<" and ">" characters that people may try to
sneak in somewhere.
* It supports checking attribute values for minimum/maximum length and
minimum/maximum value, to protect against Buffer Overflows and Denial of
Service attacks against WWW clients and various servers. You can stop
<iframe src= width= height=> from having too high values for width and height,
for instance.
* It has got a system for whitelisting URL protocols. You can say that
attribute values may only start with http:, https:, ftp: and gopher:, but no
other URL protocols (javascript:, java:, about:, telnet:..). The functions that
do this work handle whitespace, upper/lower case, HTML entities
("jav&#97;script:") and repeated entries ("javascript:javascript:alert(57)").
It also normalizes HTML entities as a nice side effect.
* It removes Netscape 4's JavaScript entities ("&{alert(57)};").
* It handles NULL bytes and Opera's chr(173) whitespace characters.
* There is both a procedural version and an object-oriented version of kses.
* USE IT *
It's very easy to use kses in your own PHP web application! Basic usage looks
like this:
<?php
include 'kses.php';
$allowed = array('b' => array(),
'i' => array(),
'a' => array('href' => 1, 'title' => 1),
'p' => array('align' => 1),
'br' => array());
$val = $_POST['val'];
if (get_magic_quotes_gpc())
$val = stripslashes($val);
# You must strip slashes from magic quotes, or kses will get confused.
$val = kses($val, $allowed); # The filtering takes place here.
# Do something with $val.
?>
This definition of $allowed means that only the elements B, I, A, P and BR are
allowed (along with their closing tags /B, /I, /A, /P and /BR). B, I and BR
may not have any attributes. A may only have the attributes HREF and TITLE,
while P may only have the attribute ALIGN. You can list the elements and
attributes in the array in any mixture of upper and lower case. kses will also
recognize HTML code that uses both lower and upper case.
It's important to select the right allowed attributes, so you won't open up
an XSS hole by mistake. Some important attributes that you mustn't allow
include but are not limited to: 1) style, and 2) all intrinsic events
attributes (onMouseOver and so on, on* really). I'll write more about this in
the documentation that will be distributed with future versions of kses.
It's also important to note that kses' HTML input must be cleaned of all
slashes coming from magic quotes. If the rest of your code requires these
slashes to be present, you can always add them again after calling kses with
a simple addslashes() call.
You should take a look at the documentation in the docs/ directory and the
examples in the examples/ directory, to get more information on how to use
kses. The object-oriented version of kses is also worth checking out, and it's
included in the oop/ directory.
* UPGRADING FROM 0.1.0 OR 0.2.0 TO 0.2.1 *
kses 0.2.1 is backwards compatible with 0.1.0 and 0.2.0, so upgrading should
just be a matter of using a new version of kses.php instead of an old one!
When you're ready to start using 0.2.1's new features, you can read about them
in the files in the docs/ directory. The ChangeLog also summarizes the new
features in this release.
* NEW VERSIONS, MAILING LISTS AND BUG REPORTS *
If you want to download new versions, subscribe to the kses-general mailing
list or even take part in the development of kses, we refer you to its
homepage at http://sourceforge.net/projects/kses . New developers and beta
testers are more than welcome!
If you have any bug reports, suggestions for improvement or simply want to tell
us that you use kses for some project, feel free to post to the kses-general
mailing list. If you have found any security problems (particularly XSS,
naturally) in kses, please contact Ulf privately at metaur at users dot
sourceforge dot net so he can correct it before you or someone else tells the
public about it.
(No, it's not a security problem in kses if some program that uses it allows a
bad attribute, silly. If kses is told to accept the element body with the
attributes style and onLoad, it will accept them, even if that's a really bad
idea, securitywise.)
* OTHER HTML FILTERS *
Here are the other stand-alone, open source HTML filters that we currently know
of:
* XSS filter for PHP4 - the filter from Squirrelmail
PHP
Konstantin Riabitsev
http://www.mricon.com/html/phpfilter.html
* HTML::StripScripts and related CPAN modules
Perl
Nick Cleaton
http://search.cpan.org/perldoc?HTML%3A%3AStripScripts
There are also a lot of HTML filters that were written specifically for some
program. Some of them are better than others.
Please write to the kses-general mailing list if you know of any other
stand-alone, open-source filters.
* DEDICATION *
kses 0.2.1 is dedicated to Mischa the cat.
* MISC *
The kses code is based on an HTML filter that Ulf wrote on his own back in 2002
for the open-source project Gnuheter ( http://savannah.nongnu.org/projects/
gnuheter ). Gnuheter is a fork from PHP-Nuke. The HTML filter has been
improved a lot since then.
To stop people from having sleepless nights, we feel the urgent need to state
that kses doesn't have anything to do with the KDE project, despite having a
name that starts with a K.
In case someone was wondering, Ulf is available for kses-related consulting.
Finally, the name kses comes from the terms XSS and access. It's also a
recursive acronym (every open-source project should have one!) for "kses
strips evil scripts".
// Ulf and the kses gang, September 2003

View File

@ -1,30 +0,0 @@
kses TODO
=========
* remove stuff in between <script>..</script> and <style>..</style>
* more attribute value checks
* more types of hooks
* return array of removed elements and attributes
* give the option of turning unacceptable elements to entities instead of
removing them (and turn unacceptable attributes to their own tag, which is
then turned to entities?) .. perhaps turn to comments as well?
* XHTML tags of the style <br/> instead of <br />
This is related to a small bug with <a href="blah />
Solution: rewrite parser.
* ">" in HTML tags
<img src="blah.gif" alt="x > 5">
Not very important, but..
* lots of testing
* write better documentation
* feedback from users
* create a nice homepage (any volunteers?)

View File

@ -1,68 +0,0 @@
kses attribute value checks
===========================
As you've probably already read in the README file, an $allowed_html array
normally looks like this:
$allowed = array('b' => array(),
'i' => array(),
'a' => array('href' => 1,
'title' => 1),
'p' => array('align' => 1),
'br' => array());
This sets what elements and attributes are allowed.
From kses 0.2.0, you can also perform some checks on the attribute values. You
do it like this:
$allowed = array('b' => array(),
'i' => array(),
'a' => array('href' =>
array('maxlen' => 100),
'title' => 1),
'p' => array('align' => 1),
'font' => array('size' =>
array('maxval' => 20)),
'br' => array());
This means that kses should perform the maxlen check with the value 100 on the
<a href=> value, as well as the maxval check with the value 20 on the <font
size=> value.
The currently implemented checks (with more to come) are 'maxlen', 'maxval',
'minlen', 'minval' and 'valueless'.
'maxlen' checks that the length of the attribute value is not greater than the
given value. It is helpful against Buffer Overflows in WWW clients and various
servers on the Internet. In my example above, it would mean that
"<a href='ftp://ftp.v1ct1m.com/AAAA..thousands_of_A's...'>" wouldn't be
accepted.
Of course, this problem is even worse if you put that long URL in a <frame>
tag instead, so the WWW client will fetch it automatically without a user
having to click it.
'maxval' checks that the attribute value is an integer greater than or equal to
zero, that it doesn't have an unreasonable amount of zeroes or whitespace (to
avoid Buffer Overflows), and that it is not greater than the given value. In
my example above, it would mean that "<font size='20'>" is accepted but
"<font size='21'>" is not. This check helps against Denial of Service attacks
against WWW clients.
One example of this DoS problem is <iframe src="http://some.web.server/"
width="20000" height="2000">, which makes some client machines completely
overloaded.
'minlen' and 'minval' works the same as 'maxlen' and 'maxval', except that they
check for minimum lengths and values instead of maximum ones.
'valueless' checks if an attribute has a value (like <a href="blah">) or not
(<option selected>). If the given value is a "y" or a "Y", the attribute must
not have a value to be accepted. If the given value is an "n" or an "N", the
attribute must have a value. Note that <a href=""> is considered to have a
value, so there's a difference between valueless attributes and attribute
values with the length zero.
You can combine more than one check, by putting one after the other in the
inner array.

View File

@ -1,7 +0,0 @@
kses hooks
==========
Sometimes you want to perform one more action on all data that kses will
filter. There is a special function for that purpose called kses_hook(). kses
calls it from its main function kses(), so if you insert some code in
kses_hook(), it will always be called to change all data that kses sees.

View File

@ -1,15 +0,0 @@
kses whitelisted URL protocols
==============================
From kses 0.2.0, it has a function that checks all attribute values for URL
protocols and only allows the protocols given in a whitelist.
If you call kses the old way with two parameters - a string and an
$allowed_html array - it will take its own default array, which whitelists the
protocols http, https, ftp, news, nntp, telnet, gopher and mailto. Pretty
reasonable, but anyone who wants to change it just calls the kses() function
with a third parameter, like this:
$string = kses($string, $allowed_html, array('http', 'https'));
Note that you shouldn't include any colon after http or other protocol names.