net.sourceforge.plantuml.security.SFile Maven / Gradle / Ivy
Show all versions of plantuml-epl Show documentation
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this EPL license.
*
* The generated images can then be used without any reference to the EPL license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.security;
import java.awt.image.BufferedImage;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Method;
import java.net.URI;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import javax.imageio.stream.ImageInputStream;
import javax.swing.ImageIcon;
import net.sourceforge.plantuml.log.Logme;
/**
* Secure replacement for java.io.File.
*
* This class should be used instead of java.io.File. There are few exceptions
* (mainly in the Swing part and in the ANT task)
*
* This class does some control access and in secure mode hide the real path of
* file, so that it cannot be printed to end users.
*
*/
public class SFile implements Comparable {
public static String separator = File.separator;
public static String pathSeparator = File.pathSeparator;
public static char separatorChar = File.separatorChar;
private final File internal;
@Override
public String toString() {
if (SecurityUtils.getSecurityProfile() == SecurityProfile.INTERNET
|| SecurityUtils.getSecurityProfile() == SecurityProfile.ALLOWLIST)
return super.toString();
try {
return internal.getCanonicalPath();
} catch (IOException e) {
return internal.getAbsolutePath();
}
}
public SFile(String nameOrPath) {
this(new File(nameOrPath));
}
public SFile(String dirname, String name) {
this(new File(dirname, name));
}
public SFile(SFile basedir, String name) {
this(new File(basedir.internal, name));
}
public SFile(URI uri) {
this(new File(uri));
}
private SFile(File internal) {
this.internal = internal;
}
public static SFile fromFile(File internal) {
if (internal == null)
return null;
return new SFile(internal);
}
public SFile file(String name) {
return new SFile(this, name);
}
public boolean exists() {
if (internal != null && isFileOk())
return internal.exists();
return false;
}
public SFile getCanonicalFile() throws IOException {
return new SFile(internal.getCanonicalFile());
}
public boolean isAbsolute() {
return internal != null && internal.isAbsolute();
}
public boolean isDirectory() {
return internal != null && internal.exists() && internal.isDirectory();
}
public String getName() {
return internal.getName();
}
public boolean isFile() {
return internal != null && internal.isFile();
}
public long lastModified() {
return internal.lastModified();
}
public int compareTo(SFile other) {
return this.internal.compareTo(other.internal);
}
public String getPath() {
return internal.getPath();
}
public long length() {
return internal.length();
}
public boolean canWrite() {
return internal.canWrite();
}
public void setWritable(boolean b) {
internal.setWritable(b);
}
public void delete() {
internal.delete();
}
public Collection listFiles() {
final File[] tmp = internal.listFiles();
if (tmp == null)
return Collections.emptyList();
final List result = new ArrayList<>(tmp.length);
for (File f : tmp)
result.add(new SFile(f));
return Collections.unmodifiableCollection(result);
}
public String[] list() {
return internal.list();
}
public SFile getAbsoluteFile() {
return new SFile(internal.getAbsoluteFile());
}
public SFile getParentFile() {
return new SFile(internal.getParentFile());
}
@Override
public int hashCode() {
return internal.hashCode();
}
@Override
public boolean equals(Object obj) {
return internal.equals(((SFile) obj).internal);
}
public String getAbsolutePath() {
return internal.getAbsolutePath();
}
public String getPrintablePath() {
if (SecurityUtils.getSecurityProfile() == SecurityProfile.UNSECURE) {
try {
return internal.getCanonicalPath();
} catch (IOException e) {
Logme.error(e);
}
}
return "";
}
public boolean canRead() {
return internal.canRead();
}
public void deleteOnExit() {
internal.deleteOnExit();
}
public void mkdirs() {
internal.mkdirs();
}
public static SFile createTempFile(String prefix, String suffix) throws IOException {
return new SFile(File.createTempFile(prefix, suffix));
}
public URI toURI() {
return internal.toURI();
}
public boolean renameTo(SFile dest) {
return internal.renameTo(dest.internal);
}
/**
* Check SecurityProfile to see if this file can be open.
*/
public boolean isFileOk() {
// ::comment when __CORE__
if (SecurityUtils.getSecurityProfile() == SecurityProfile.SANDBOX)
// In SANDBOX, we cannot read any files
return false;
// In any case SFile should not access the security folders
// (the files must be handled internally)
try {
if (isDenied())
return false;
} catch (IOException e) {
return false;
}
// Files in "plantuml.include.path" and "plantuml.allowlist.path" are ok.
if (isInAllowList(SecurityUtils.getPath(SecurityUtils.PATHS_INCLUDES)))
return true;
if (isInAllowList(SecurityUtils.getPath(SecurityUtils.ALLOWLIST_LOCAL_PATHS)))
return true;
if (SecurityUtils.getSecurityProfile() == SecurityProfile.INTERNET)
return false;
if (SecurityUtils.getSecurityProfile() == SecurityProfile.ALLOWLIST)
return false;
if (SecurityUtils.getSecurityProfile() != SecurityProfile.UNSECURE) {
// For UNSECURE, we did not do those checks
final String path = getCleanPathSecure();
if (path.startsWith("/etc/") || path.startsWith("/dev/") || path.startsWith("/boot/")
|| path.startsWith("/proc/") || path.startsWith("/sys/"))
return false;
if (path.startsWith("//"))
return false;
}
return true;
}
private boolean isInAllowList(List allowlist) {
final String path = getCleanPathSecure();
for (SFile allow : allowlist)
if (path.startsWith(allow.getCleanPathSecure()))
// File directory is in the allowlist
return true;
return false;
}
/**
* Checks, if the SFile is inside the folder (-structure) of the security area.
*
* @return true, if the file is not allowed to read/write
* @throws IOException If an I/O error occurs, which is possible because the
* check the pathname may require filesystem queries
*/
// ::comment when __CORE__
private boolean isDenied() throws IOException {
SFile securityPath = SecurityUtils.getSecurityPath();
if (securityPath == null)
return false;
return getSanitizedPath().startsWith(securityPath.getSanitizedPath());
}
/**
* Returns a sanitized, canonical and normalized Path to a file.
*
* @return the Path
* @throws IOException If an I/O error occurs, which is possible because the
* construction of the canonical pathname may require
* filesystem queries
* @see #getCleanPathSecure()
* @see File#getCanonicalPath()
* @see Path#normalize()
*/
private Path getSanitizedPath() throws IOException {
return Paths.get(new File(getCleanPathSecure()).getCanonicalPath()).normalize();
}
private String getCleanPathSecure() {
String result = internal.getAbsolutePath();
result = result.replace("\0", "");
result = result.replace("\\\\", "/");
return result;
}
// Reading
// http://forum.plantuml.net/9048/img-tag-for-sequence-diagram-participants-does-always-render
public BufferedImage readRasterImageFromFile() {
// https://www.experts-exchange.com/questions/26171948/Why-are-ImageIO-read-images-losing-their-transparency.html
// https://stackoverflow.com/questions/18743790/can-java-load-images-with-transparency
if (isFileOk())
try {
// ::comment when __CORE__
if (internal.getName().endsWith(".webp"))
return readWebp();
else
return SecurityUtils.readRasterImage(new ImageIcon(this.getAbsolutePath()));
} catch (Exception e) {
Logme.error(e);
}
return null;
}
// ::comment when __CORE__
private BufferedImage readWebp() throws IOException {
try (InputStream is = openFile()) {
final int riff = read32(is);
if (riff != 0x46464952)
return null;
final int len1 = read32(is);
final int webp = read32(is);
if (webp != 0x50424557)
return null;
final int vp8_ = read32(is);
if (vp8_ != 0x20385056)
return null;
final int len2 = read32(is);
if (len1 != len2 + 12)
return null;
return getBufferedImageFromWebpButHeader(is);
}
}
private int read32(InputStream is) throws IOException {
return (is.read() << 0) + (is.read() << 8) + (is.read() << 16) + (is.read() << 24);
}
public static BufferedImage getBufferedImageFromWebpButHeader(InputStream is) {
if (is == null)
return null;
try {
final Class clVP8Decoder = Class.forName("net.sourceforge.plantuml.webp.VP8Decoder");
final Object vp8Decoder = clVP8Decoder.getDeclaredConstructor().newInstance();
// final VP8Decoder vp8Decoder = new VP8Decoder();
final Method decodeFrame = clVP8Decoder.getMethod("decodeFrame", ImageInputStream.class);
final ImageInputStream iis = SImageIO.createImageInputStream(is);
decodeFrame.invoke(vp8Decoder, iis);
// vp8Decoder.decodeFrame(iis);
iis.close();
final Object frame = clVP8Decoder.getMethod("getFrame").invoke(vp8Decoder);
return (BufferedImage) frame.getClass().getMethod("getBufferedImage").invoke(frame);
// final VP8Frame frame = vp8Decoder.getFrame();
// return frame.getBufferedImage();
} catch (Exception e) {
Logme.error(e);
return null;
}
}
public BufferedReader openBufferedReader() {
if (isFileOk()) {
try {
return new BufferedReader(new FileReader(internal));
} catch (FileNotFoundException e) {
Logme.error(e);
}
}
return null;
}
public File conv() {
return internal;
}
public InputStream openFile() {
if (isFileOk())
try {
return new BufferedInputStream(new FileInputStream(internal));
} catch (FileNotFoundException e) {
Logme.error(e);
}
return null;
}
// ::comment when __CORE__
// Writing
public BufferedOutputStream createBufferedOutputStream() throws FileNotFoundException {
return new BufferedOutputStream(new FileOutputStream(internal));
}
public PrintWriter createPrintWriter() throws FileNotFoundException {
return new PrintWriter(internal);
}
public PrintWriter createPrintWriter(String charset) throws FileNotFoundException, UnsupportedEncodingException {
return new PrintWriter(internal, charset);
}
public FileOutputStream createFileOutputStream() throws FileNotFoundException {
return new FileOutputStream(internal);
}
public FileOutputStream createFileOutputStream(boolean append) throws FileNotFoundException {
return new FileOutputStream(internal, append);
}
public PrintStream createPrintStream() throws FileNotFoundException {
return new PrintStream(internal);
}
public PrintStream createPrintStream(String charset) throws FileNotFoundException, UnsupportedEncodingException {
return new PrintStream(internal, charset);
}
public PrintStream createPrintStream(Charset charset) throws FileNotFoundException, UnsupportedEncodingException {
return new PrintStream(internal, charset.name());
}
}