org.asciidoctor.SafeMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asciidoctorj-api Show documentation

API for AsciidoctorJ

There is a newer version: 3.0.0

package org.asciidoctor;

/**
 * 
 * @author lordofthejars
 *
 */
public enum SafeMode {

    /**
     * A safe mode level that disables any of the security features enforced by Asciidoctor (Ruby is still subject to
     * its own restrictions).
     */
    UNSAFE(0),
    /**
     * A safe mode level that closely parallels safe mode in AsciiDoc. This value prevents access to files which reside
     * outside of the parent directory of the source file and disables any macro other than the include::[] macro.
     */
    SAFE(1),
    /**
     * A safe mode level that disallows the document from setting attributes that would affect the rendering of the
     * document, in addition to all the security features of SafeMode::SAFE. For instance, this level disallows changing
     * the backend or the source-highlighter using an attribute defined in the source document. This is the most
     * fundamental level of security for server-side deployments (hence the name).
     */
    SERVER(10),
    /**
     * A safe mode level that disallows the document from attempting to read files from the file system and including
     * the contents of them into the document, in additional to all the security features of SafeMode::SERVER. For
     * instance, this level disallows use of the include::[] macro and the embedding of binary content (data uri),
     * stylesheets and JavaScripts referenced by the document.(Asciidoctor and trusted extensions may still be allowed
     * to embed trusted content into the document).
     *
     * Since Asciidoctor is aiming for wide adoption, this level is the default and is recommended for server-side
     * deployments.
     */
    SECURE(20);

    private int level;

    private SafeMode(int level) {
        this.level = level;
    }

    public int getLevel() {
        return level;
    }

    public static final SafeMode safeMode(int level) {
        switch(level) {
            case 0: return UNSAFE;
            case 1: return SAFE;
            case 10: return SERVER;
            default: return SECURE;
        }
    }

}