Skip to content

Commit 4cbb328

Browse files
bgalekbgalek
committed
Initial commit
0 parents  commit 4cbb328

21 files changed

+1109
-0
lines changed

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Ignore Gradle project-specific cache directory
2+
.gradle
3+
4+
# Ignore Gradle build output directory
5+
build

‎.travis.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
language: java
2+
3+
jdk:
4+
- openjdk8
5+
- openjdk11
6+
7+
before_script:
8+
- chmod +x gradlew
9+
script:
10+
- ./gradlew check
11+
- ./gradlew jacocoTestReport
12+
after_success:
13+
- bash <(curl -s https://codecov.io/bash)

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# SVG SECURITY
2+
> Simple and lightweight library that helps to validate SVG files in security manners.
3+
4+
![Travis (.org)](https://img.shields.io/travis/bgalek/safe-svg.svg?style=flat-square)
5+
![Codecov](https://img.shields.io/codecov/c/github/bgalek/safe-svg.svg?style=flat-square)
6+
![GitHub Release Date](https://img.shields.io/github/release-date/bgalek/safe-svg.svg?style=flat-square)
7+
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/bgalek/safe-svg.svg?style=flat-square)
8+
9+
It will help you in detecting malicious content inside uploaded SVGs.
10+
11+
## Are you aware that SVG can cause XSS?
12+
13+
Read [https://sekurak.pl/pozwalasz-ladowac-pliki-svg-masz-xss-a/](https://sekurak.pl/pozwalasz-ladowac-pliki-svg-masz-xss-a/) for more details.
14+
15+
## Example
16+
17+
Try to upload this SVG into your application, if it passes through and user can browse this file - probably You are venerable to XSS attack.
18+
19+
```xml
20+
<?xml version="1.0" standalone="no"?>
21+
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
22+
<svg version="1.1" baseProfile="full" xmlns="http://www.w3.org/2000/svg">
23+
<polygon id="triangle" points="0,0 0,50 50,0" fill="#009900" stroke="#004400"/>
24+
<script type="text/javascript">
25+
alert('Hello, world!');
26+
</script>
27+
</svg>
28+
```
29+
30+
## Usage
31+
32+
Add library dependency:
33+
```groovy
34+
compile "com.github.bgalek.security.svg:safe-svg:1.0.0"
35+
```
36+
37+
You can use this library to check uploaded svg files
38+
39+
```java
40+
String svg = "<?xml version=\"1.0\" standalone=\"no\"?>\n" +
41+
"<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n" +
42+
"<svg version=\"1.1\" baseProfile=\"full\" xmlns=\"http://www.w3.org/2000/svg\">\n" +
43+
"<polygon id=\"triangle\" points=\"0,0 0,50 50,0\" fill=\"#009900\" stroke=\"#004400\"/>\n" +
44+
"<script type=\"text/javascript\">\n" +
45+
"alert('Hello, world!');\n" +
46+
"</script>\n" +
47+
"</svg>";
48+
ValidationResult validation = svgSecurityValidator.validate(svg);
49+
if (validation.hasViolations()) {
50+
throw new RuntimeException("this file is suspicious" + validation.getOffendingElements());
51+
}
52+
```

‎build.gradle.kts

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
plugins {
2+
id("pl.allegro.tech.build.axion-release") version "1.10.0"
3+
`java-library`
4+
`maven-publish`
5+
signing
6+
jacoco
7+
}
8+
9+
repositories {
10+
mavenCentral()
11+
}
12+
13+
dependencies {
14+
implementation("com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20181114.1")
15+
testImplementation("org.junit.jupiter:junit-jupiter:5.4.0")
16+
}
17+
18+
group = "com.github.bgalek.security.svg"
19+
version = scmVersion.version
20+
21+
tasks {
22+
jar {
23+
manifest {
24+
attributes(mapOf("Implementation-Title" to project.name, "Implementation-Version" to project.version))
25+
}
26+
}
27+
}
28+
29+
tasks.withType<Test> {
30+
useJUnitPlatform()
31+
testLogging {
32+
events("passed", "skipped", "failed")
33+
}
34+
}
35+
36+
tasks.register<Jar>("sourcesJar") {
37+
from(sourceSets.main.get().allJava)
38+
archiveClassifier.set("sources")
39+
}
40+
41+
tasks.register<Jar>("javadocJar") {
42+
from(tasks.javadoc)
43+
archiveClassifier.set("javadoc")
44+
}
45+
46+
jacoco {
47+
toolVersion = "0.8.2"
48+
reportsDir = file("$buildDir/reports/jacoco")
49+
}
50+
51+
tasks.jacocoTestReport {
52+
reports {
53+
xml.isEnabled = true
54+
xml.destination = file("$buildDir/reports/jacoco/report.xml")
55+
csv.isEnabled = false
56+
html.isEnabled = false
57+
}
58+
}
59+
60+
publishing {
61+
publications {
62+
create<MavenPublication>("sonatype") {
63+
artifactId = "safe-svg"
64+
from(components["java"])
65+
artifact(tasks["sourcesJar"])
66+
artifact(tasks["javadocJar"])
67+
versionMapping {
68+
usage("java-api") {
69+
fromResolutionOf("runtimeClasspath")
70+
}
71+
usage("java-runtime") {
72+
fromResolutionResult()
73+
}
74+
}
75+
pom {
76+
name.set("safe-svg")
77+
description.set("Simple and lightweight library that helps to validate SVG files in security manners.")
78+
url.set("https://github.com/bgalek/safe-svg/")
79+
licenses {
80+
license {
81+
name.set("The Apache License, Version 2.0")
82+
url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
83+
}
84+
}
85+
developers {
86+
developer {
87+
id.set("bgalek")
88+
name.set("Bartosz Gałek")
89+
email.set("[email protected]")
90+
}
91+
}
92+
scm {
93+
connection.set("scm:git:git://github.com/bgalek/safe-svg.git")
94+
developerConnection.set("scm:git:ssh://github.com:bgalek/safe-svg.git")
95+
url.set("https://github.com/bgalek/safe-svg/")
96+
}
97+
}
98+
}
99+
}
100+
repositories {
101+
maven {
102+
credentials {
103+
username = project.properties.get("ossrhUsername") as String?
104+
password = project.properties.get("ossrhPassword") as String?
105+
}
106+
val releasesRepoUrl = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
107+
val snapshotsRepoUrl = uri("https://oss.sonatype.org/content/repositories/snapshots/")
108+
url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
109+
}
110+
}
111+
}
112+
113+
signing {
114+
useGpgCmd()
115+
sign(publishing.publications["sonatype"])
116+
}
117+
118+
tasks.javadoc {
119+
if (JavaVersion.current().isJava9Compatible) {
120+
(options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
121+
}
122+
}

‎gradle/wrapper/gradle-wrapper.jar

53.9 KB
Binary file not shown.

‎gradle/wrapper/gradle-wrapper.properties

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)