Kotlin conversion: SOPGPException

2024-11-22 07:12:04 +01:00 · 2023-10-31 15:27:47 +01:00 · 2023-10-31 15:27:47 +01:00 · 7824ee92c5
commit 7824ee92c5
parent 94b428ef62
4 changed files with 308 additions and 490 deletions
--- a/sop-java/src/main/java/sop/exception/SOPGPException.java
+++ b/sop-java/src/main/java/sop/exception/SOPGPException.java
@ -1,473 +0,0 @@
 // SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
 //
 // SPDX-License-Identifier: Apache-2.0
 package sop.exception;
 public abstract class SOPGPException extends RuntimeException {
    public SOPGPException() {
        super();
    }
    public SOPGPException(String message) {
        super(message);
    }
    public SOPGPException(Throwable e) {
        super(e);
    }
    public SOPGPException(String message, Throwable cause) {
        super(message, cause);
    }
    public abstract int getExitCode();
    /**
     * No acceptable signatures found (sop verify, inline-verify).
     */
    public static class NoSignature extends SOPGPException {
        public static final int EXIT_CODE = 3;
        public NoSignature() {
            this("No verifiable signature found.");
        }
        public NoSignature(String message) {
            super(message);
        }
        public NoSignature(String errorMsg, NoSignature e) {
            super(errorMsg, e);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Asymmetric algorithm unsupported (sop encrypt, sign, inline-sign).
     */
    public static class UnsupportedAsymmetricAlgo extends SOPGPException {
        public static final int EXIT_CODE = 13;
        public UnsupportedAsymmetricAlgo(String message, Throwable e) {
            super(message, e);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Certificate not encryption capable (e,g, expired, revoked, unacceptable usage).
     */
    public static class CertCannotEncrypt extends SOPGPException {
        public static final int EXIT_CODE = 17;
        public CertCannotEncrypt(String message, Throwable cause) {
            super(message, cause);
        }
        public CertCannotEncrypt(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Missing required argument.
     */
    public static class MissingArg extends SOPGPException {
        public static final int EXIT_CODE = 19;
        public MissingArg() {
        }
        public MissingArg(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Incomplete verification instructions (sop decrypt).
     */
    public static class IncompleteVerification extends SOPGPException {
        public static final int EXIT_CODE = 23;
        public IncompleteVerification(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Unable to decrypt (sop decrypt).
     */
    public static class CannotDecrypt extends SOPGPException {
        public static final int EXIT_CODE = 29;
        public CannotDecrypt() {
        }
        public CannotDecrypt(String errorMsg, Throwable e) {
            super(errorMsg, e);
        }
        public CannotDecrypt(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Non-UTF-8 or otherwise unreliable password (sop encrypt).
     */
    public static class PasswordNotHumanReadable extends SOPGPException {
        public static final int EXIT_CODE = 31;
        public PasswordNotHumanReadable() {
            super();
        }
        public PasswordNotHumanReadable(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Unsupported option.
     */
    public static class UnsupportedOption extends SOPGPException {
        public static final int EXIT_CODE = 37;
        public UnsupportedOption(String message) {
            super(message);
        }
        public UnsupportedOption(String message, Throwable cause) {
            super(message, cause);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Invalid data type (no secret key where KEYS expected, etc.).
     */
    public static class BadData extends SOPGPException {
        public static final int EXIT_CODE = 41;
        public BadData(String message) {
            super(message);
        }
        public BadData(Throwable throwable) {
            super(throwable);
        }
        public BadData(String message, Throwable throwable) {
            super(message, throwable);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Non-Text input where text expected.
     */
    public static class ExpectedText extends SOPGPException {
        public static final int EXIT_CODE = 53;
        public ExpectedText() {
            super();
        }
        public ExpectedText(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Output file already exists.
     */
    public static class OutputExists extends SOPGPException {
        public static final int EXIT_CODE = 59;
        public OutputExists(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Input file does not exist.
     */
    public static class MissingInput extends SOPGPException {
        public static final int EXIT_CODE = 61;
        public MissingInput(String message, Throwable cause) {
            super(message, cause);
        }
        public MissingInput(String errorMsg) {
            super(errorMsg);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * A KEYS input is protected (locked) with a password and sop failed to unlock it.
     */
    public static class KeyIsProtected extends SOPGPException {
        public static final int EXIT_CODE = 67;
        public KeyIsProtected() {
            super();
        }
        public KeyIsProtected(String message) {
            super(message);
        }
        public KeyIsProtected(String message, Throwable cause) {
            super(message, cause);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Unsupported subcommand.
     */
    public static class UnsupportedSubcommand extends SOPGPException {
        public static final int EXIT_CODE = 69;
        public UnsupportedSubcommand(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * An indirect parameter is a special designator (it starts with @), but sop does not know how to handle the prefix.
     */
    public static class UnsupportedSpecialPrefix extends SOPGPException {
        public static final int EXIT_CODE = 71;
        public UnsupportedSpecialPrefix(String errorMsg) {
            super(errorMsg);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Exception that gets thrown if a special designator (starting with @) is given, but the filesystem contains
     * a file matching the designator.
     * <p>
     * E.g. <pre>@ENV:FOO</pre> is given, but <pre>./@ENV:FOO</pre> exists on the filesystem.
     */
    public static class AmbiguousInput extends SOPGPException {
        public static final int EXIT_CODE = 73;
        public AmbiguousInput(String message) {
            super(message);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * Key not signature-capable (e.g. expired, revoked, unacceptable usage flags).
     */
    public static class KeyCannotSign extends SOPGPException {
        public static final int EXIT_CODE = 79;
        public KeyCannotSign() {
            super();
        }
        public KeyCannotSign(String message) {
            super(message);
        }
        public KeyCannotSign(String s, Throwable throwable) {
            super(s, throwable);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * User provided incompatible options (e.g. "--as=clearsigned --no-armor").
     */
    public static class IncompatibleOptions extends SOPGPException {
        public static final int EXIT_CODE = 83;
        public IncompatibleOptions() {
            super();
        }
        public IncompatibleOptions(String errorMsg) {
            super(errorMsg);
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
    /**
     * The user provided a subcommand with an unsupported profile ("--profile=XYZ"),
     * or the user tried to list profiles of a subcommand that does not support profiles at all.
     */
    public static class UnsupportedProfile extends SOPGPException {
        public static final int EXIT_CODE = 89;
        private final String subcommand;
        private final String profile;
        /**
         * Create an exception signalling a subcommand that does not support any profiles.
         *
         * @param subcommand subcommand
         */
        public UnsupportedProfile(String subcommand) {
            super("Subcommand '" + subcommand + "' does not support any profiles.");
            this.subcommand = subcommand;
            this.profile = null;
        }
        /**
         * Create an exception signalling a subcommand does not support a specific profile.
         *
         * @param subcommand subcommand
         * @param profile unsupported profile
         */
        public UnsupportedProfile(String subcommand, String profile) {
            super("Subcommand '" + subcommand + "' does not support profile '" + profile + "'.");
            this.subcommand = subcommand;
            this.profile = profile;
        }
        /**
         * Wrap an exception into another instance with a possibly translated error message.
         *
         * @param errorMsg error message
         * @param e exception
         */
        public UnsupportedProfile(String errorMsg, UnsupportedProfile e) {
            super(errorMsg, e);
            this.subcommand = e.getSubcommand();
            this.profile = e.getProfile();
        }
        /**
         * Return the subcommand name.
         *
         * @return subcommand
         */
        public String getSubcommand() {
            return subcommand;
        }
        /**
         * Return the profile name.
         * May return <pre>null</pre>.
         *
         * @return profile name
         */
        public String getProfile() {
            return profile;
        }
        @Override
        public int getExitCode() {
            return EXIT_CODE;
        }
    }
 }
--- a/sop-java/src/main/java/sop/exception/package-info.java
+++ b/sop-java/src/main/java/sop/exception/package-info.java
@ -1,9 +0,0 @@
 // SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
 //
 // SPDX-License-Identifier: Apache-2.0
 /**
 * Stateless OpenPGP Interface for Java.
 * Exception classes.
 */
 package sop.exception;
--- a/sop-java/src/main/java/sop/package-info.java
+++ b/sop-java/src/main/java/sop/package-info.java
@ -1,8 +0,0 @@
 // SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
 //
 // SPDX-License-Identifier: Apache-2.0
 /**
 * Stateless OpenPGP Interface for Java.
 */
 package sop;
--- a/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt
+++ b/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt
@ -0,0 +1,308 @@
 // SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
 //
 // SPDX-License-Identifier: Apache-2.0
 package sop.exception
 abstract class SOPGPException : RuntimeException {
    constructor() : super()
    constructor(message: String) : super(message)
    constructor(cause: Throwable) : super(cause)
    constructor(message: String, cause: Throwable) : super(message, cause)
    abstract fun getExitCode(): Int
    /** No acceptable signatures found (sop verify, inline-verify). */
    class NoSignature : SOPGPException {
        @JvmOverloads
        constructor(message: String = "No verifiable signature found.") : super(message)
        constructor(errorMsg: String, e: NoSignature) : super(errorMsg, e)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 3
        }
    }
    /** Asymmetric algorithm unsupported (sop encrypt, sign, inline-sign). */
    class UnsupportedAsymmetricAlgo(message: String, e: Throwable) : SOPGPException(message, e) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 13
        }
    }
    /** Certificate not encryption capable (e,g, expired, revoked, unacceptable usage). */
    class CertCannotEncrypt : SOPGPException {
        constructor(message: String, cause: Throwable) : super(message, cause)
        constructor(message: String) : super(message)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 17
        }
    }
    /** Missing required argument. */
    class MissingArg : SOPGPException {
        constructor()
        constructor(message: String) : super(message)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 19
        }
    }
    /** Incomplete verification instructions (sop decrypt). */
    class IncompleteVerification(message: String) : SOPGPException(message) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 23
        }
    }
    /** Unable to decrypt (sop decrypt). */
    class CannotDecrypt : SOPGPException {
        constructor()
        constructor(errorMsg: String, e: Throwable) : super(errorMsg, e)
        constructor(message: String) : super(message)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 29
        }
    }
    /** Non-UTF-8 or otherwise unreliable password (sop encrypt). */
    class PasswordNotHumanReadable : SOPGPException {
        constructor() : super()
        constructor(message: String) : super(message)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 31
        }
    }
    /** Unsupported option. */
    class UnsupportedOption : SOPGPException {
        constructor(message: String) : super(message)
        constructor(message: String, cause: Throwable) : super(message, cause)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 37
        }
    }
    /** Invalid data type (no secret key where KEYS expected, etc.). */
    class BadData : SOPGPException {
        constructor(message: String) : super(message)
        constructor(throwable: Throwable) : super(throwable)
        constructor(message: String, throwable: Throwable) : super(message, throwable)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 41
        }
    }
    /** Non-Text input where text expected. */
    class ExpectedText : SOPGPException {
        constructor() : super()
        constructor(message: String) : super(message)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 53
        }
    }
    /** Output file already exists. */
    class OutputExists(message: String) : SOPGPException(message) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 59
        }
    }
    /** Input file does not exist. */
    class MissingInput : SOPGPException {
        constructor(message: String, cause: Throwable) : super(message, cause)
        constructor(errorMsg: String) : super(errorMsg)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 61
        }
    }
    /** A KEYS input is protected (locked) with a password and sop failed to unlock it. */
    class KeyIsProtected : SOPGPException {
        constructor() : super()
        constructor(message: String) : super(message)
        constructor(message: String, cause: Throwable) : super(message, cause)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 67
        }
    }
    /** Unsupported subcommand. */
    class UnsupportedSubcommand(message: String) : SOPGPException(message) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 69
        }
    }
    /**
     * An indirect parameter is a special designator (it starts with @), but sop does not know how
     * to handle the prefix.
     */
    class UnsupportedSpecialPrefix(errorMsg: String) : SOPGPException(errorMsg) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 71
        }
    }
    /**
     * Exception that gets thrown if a special designator (starting with @) is given, but the
     * filesystem contains a file matching the designator.
     *
     * E.g. <pre>@ENV:FOO</pre> is given, but <pre>./@ENV:FOO</pre> exists on the filesystem.
     */
    class AmbiguousInput(message: String) : SOPGPException(message) {
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 73
        }
    }
    /** Key not signature-capable (e.g. expired, revoked, unacceptable usage flags). */
    class KeyCannotSign : SOPGPException {
        constructor() : super()
        constructor(message: String) : super(message)
        constructor(s: String, throwable: Throwable) : super(s, throwable)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 79
        }
    }
    /** User provided incompatible options (e.g. "--as=clearsigned --no-armor"). */
    class IncompatibleOptions : SOPGPException {
        constructor() : super()
        constructor(errorMsg: String) : super(errorMsg)
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 83
        }
    }
    /**
     * The user provided a subcommand with an unsupported profile ("--profile=XYZ"), or the user
     * tried to list profiles of a subcommand that does not support profiles at all.
     */
    class UnsupportedProfile : SOPGPException {
        /**
         * Return the subcommand name.
         *
         * @return subcommand
         */
        val subcommand: String
        /**
         * Return the profile name. May return `null`.
         *
         * @return profile name
         */
        val profile: String?
        /**
         * Create an exception signalling a subcommand that does not support any profiles.
         *
         * @param subcommand subcommand
         */
        constructor(
            subcommand: String
        ) : super("Subcommand '$subcommand' does not support any profiles.") {
            this.subcommand = subcommand
            profile = null
        }
        /**
         * Create an exception signalling a subcommand does not support a specific profile.
         *
         * @param subcommand subcommand
         * @param profile unsupported profile
         */
        constructor(
            subcommand: String,
            profile: String
        ) : super("Subcommand '$subcommand' does not support profile '$profile'.") {
            this.subcommand = subcommand
            this.profile = profile
        }
        /**
         * Wrap an exception into another instance with a possibly translated error message.
         *
         * @param errorMsg error message
         * @param e exception
         */
        constructor(errorMsg: String, e: UnsupportedProfile) : super(errorMsg, e) {
            subcommand = e.subcommand
            profile = e.profile
        }
        override fun getExitCode(): Int = EXIT_CODE
        companion object {
            const val EXIT_CODE = 89
        }
    }
 }