Permalink
Browse files

Update docs

  • Loading branch information...
1 parent 8f2d699 commit 939e3eab5c3c203bdefaedcc231d7fe649e844c1 @neuroo neuroo committed Jul 19, 2016
Showing with 17 additions and 17 deletions.
  1. +17 −17 README.md
View
34 README.md
@@ -9,7 +9,7 @@ Here's why it's worth checking out:
* **It's convenient:** CSL contains escapers for XSS and SQL injection that are missing from standard libraries like Apache Commons and Java EE. We use fast, easy to invoke static methods with short, intuitive names. We also provide hooks for Expression Language (EL) to make it easy to use within JSPs.
-* **It's small:** CSL has no external dependencies and is a minimalist library. This means it's fast and does not require any configuration besides dropping a JAR in the right location or modifying your build to do it.
+* **It's small:** CSL has no external dependencies and is a minimalist library. This means it's fast and does not require any configuration besides dropping a JAR in the right location or modifying your build to do it.
* **It's free:** CSL is distributed under a BSD-style license. We would appreciate patches be sent back to us but it's not required.
@@ -18,12 +18,12 @@ Users of Coverity Security Advisor get remediation guidance based on escaping ro
## Escape
-The [Escape class](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers) contains several escapers for web content. These escaping functions help remedy common defects (mostly cross-site scripting) that occur when the data is inserted into HTML element, HTML attribute values, URI, JavaScript strings, SQL LIKE clauses, etc. More information are available in the [Escape directory](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers).
+The [Escape class](https://coverity.github.io/coverity-security-library/com/coverity/security/Escape.html) contains several escapers for web content. These escaping functions help remedy common defects (mostly cross-site scripting) that occur when the data is inserted into HTML element, HTML attribute values, URI, JavaScript strings, SQL LIKE clauses, etc. More information are available in the [Escape directory](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers).
-Before using any of these methods, you should understand the context (or nested contexts) in which the data is inserted. [Several mockup examples with explanation](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers/samples/mockup-examples) are available in the repository, and more will be available on [our blog](https://communities.coverity.com/blogs/security).
+Before using any of these methods, you should understand the context (or nested contexts) in which the data is inserted. [Several mockup examples with explanation](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers/samples/mockup-examples) are available in the repository, and more will be available on [our blog](https://communities.coverity.com/blogs/security).
If you want to test the library to understand how it whistands security attacks, our [functional testsuite](https://github.com/coverity/coverity-security-library/tree/develop/coverity-escapers/samples/functional-testsuite) is the right app to build/deploy/test.
-Ready to use it? One last step is to have a look at [the latest javadoc](http://coverity.github.com/coverity-security-library) directly on github.
+Ready to use it? One last step is to have a look at [the latest javadoc](https://coverity.github.io/coverity-security-library) directly on github.
To include this library into your Maven project, add the following:
@@ -54,37 +54,37 @@ or in your Java programs:
```java
import com.coverity.security.Escape;
// ...
-return "<div onclick='alert(\""
+return "<div onclick='alert(\""
+ Escape.html(Escape.jsString(request.getParameter("tainted")))
- + "\")'>"
- + Escape.html(request.getParameter("tainted"))
+ + "\")'>"
+ + Escape.html(request.getParameter("tainted"))
+ "</div>";
```
-To contact the SRL, please email us at <srl@coverity.com>. Fork away, we look forward to your pull requests!
+To contact the SRL, please email us at <sig-srl@synopsys.com>. Fork away, we look forward to your pull requests!
# License
- Copyright (c) 2012, Coverity, Inc.
+ Copyright (c) 2012-2016, Coverity, Inc.
All rights reserved.
- Redistribution and use in source and binary forms, with or without modification,
+ Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
- - Redistributions of source code must retain the above copyright notice, this
+ - Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
- Neither the name of Coverity, Inc. nor the names of its contributors may be used
- to endorse or promote products derived from this software without specific prior
+ to endorse or promote products derived from this software without specific prior
written permission from Coverity, Inc.
-
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND INFRINGEMENT ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+ NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

0 comments on commit 939e3ea

Please sign in to comment.