BungeeConfigProperties.java

package fr.xephi.authme.bungee.config;

import ch.jalu.configme.Comment;
import ch.jalu.configme.SettingsHolder;
import ch.jalu.configme.properties.Property;

import java.util.List;

import static ch.jalu.configme.properties.PropertyInitializer.newListProperty;
import static ch.jalu.configme.properties.PropertyInitializer.newProperty;

public final class BungeeConfigProperties implements SettingsHolder {

    @Comment("List of servers in the network where AuthMe is installed")
    public static final Property<List<String>> AUTH_SERVERS =
        newListProperty("authServers", "lobby");

    @Comment("Treat every backend as an auth-aware server")
    public static final Property<Boolean> ALL_SERVERS_ARE_AUTH_SERVERS =
        newProperty("allServersAreAuthServers", false);

    @Comment("Allows or not commands to be performed if user is not logged in")
    public static final Property<Boolean> COMMANDS_REQUIRE_AUTH =
        newProperty("commands.requireAuth", true);

    @Comment("List of commands allowed to be performed without being authenticated")
    public static final Property<List<String>> COMMANDS_WHITELIST =
        newListProperty("commands.whitelist", "/login", "/register", "/l", "/reg", "/email",
            "/captcha", "/2fa", "/totp", "/log");

    @Comment("Allows or not user to talk in chat if they are not logged in")
    public static final Property<Boolean> CHAT_REQUIRES_AUTH =
        newProperty("chatRequiresAuth", true);

    @Comment("Kick all players who switch servers without being authenticated")
    public static final Property<Boolean> SERVER_SWITCH_REQUIRES_AUTH =
        newProperty("serverSwitch.requiresAuth", true);

    @Comment("Message shown when an unauthenticated player is blocked from switching servers")
    public static final Property<String> SERVER_SWITCH_KICK_MESSAGE =
        newProperty("serverSwitch.kickMessage", "Authentication required.");

    @Comment("Enable perform.login forwarding when an authenticated player joins an auth server")
    public static final Property<Boolean> AUTOLOGIN =
        newProperty("autoLogin", false);

    @Comment("If enabled, logged-out users will be sent to the unloggedUserServer backend")
    public static final Property<Boolean> ENABLE_SEND_ON_LOGOUT =
        newProperty("sendOnLogout", false);

    @Comment("If sendOnLogout is enabled, logged-out users will be sent to this backend")
    public static final Property<String> SEND_ON_LOGOUT_TARGET =
        newProperty("unloggedUserServer", "");

    @Comment({
        "Server to redirect players to after successful authentication on an auth server.",
        "Leave empty to disable proxy-side login redirect (backend handles it via BUNGEECORD_SERVER)."
    })
    public static final Property<String> LOGIN_SERVER =
        newProperty("loginServer", "");

    @Comment({
        "Shared secret used to sign perform.login messages sent to backend servers.",
        "Generated automatically on first start — copy this value to the Hooks.proxySharedSecret",
        "setting of every backend server running AuthMe."
    })
    public static final Property<String> PROXY_SHARED_SECRET =
        newProperty("proxySharedSecret", "");

    private BungeeConfigProperties() {
    }
}