io.rocketbase.commons.config.AuthProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-auth-core Show documentation
There is a newer version: 4.4.1
package io.rocketbase.commons.config;

import io.rocketbase.commons.util.UrlParts;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

import javax.validation.constraints.NotEmpty;

@Data
@ConfigurationProperties(prefix = "auth")
public class AuthProperties {

    @NotEmpty
    private String roleAdmin = "ADMIN";

    @NotEmpty
    private String roleUser = "USER";

    @NotEmpty
    private String tokenSecret = "E*iqzFiW#kSmAo8rO^V8%DRlQ#1f&B$i";

    /**
     * cache time in minutes 

     * 0 means disabled
     */
    private int userCacheTime = 30;

    private String baseUrl = "http://localhost:8080";

    /**
     * prefix for controllers
     */
    private String prefix = "";

    /**
     * should use verify it's email-adress
     */
    private boolean verifyEmail = true;

    /**
     * full qualified url to a custom UI that proceed the verification

     * ?verification=VALUE will get append
     */
    private String verificationUrl = null;

    /**
     * full qualified url to a custom UI that proceed the password reset

     * ?verification=VALUE will get append
     */
    private String passwordResetUrl = null;

    /**
     * full qualified url to a custom UI that proceed the invite reset

     * ?inviteId=VALUE will get append
     */
    private String inviteUrl = null;

    /**
     * full qualified url to a custom UI that proceed the change email

     * ?inviteId=VALUE will get append
     */
    private String changeEmailUrl = null;

    /**
     * full qualified url to a custom UI that proceed the change username

     * ?inviteId=VALUE will get append
     */
    private String changeUsernameUrl = null;

    /**
     * in minutes
     */
    private long passwordResetExpiration = 60;

    /**
     * in minutes
     */
    private long changeEmailExpiration = 60;

    /**
     * in minutes
     */
    private long changeUsernameExpiration = 60;

    /**
     * in minutes - default 7 days
     */
    private long inviteExpiration = 10080;

    /**
     * quick help to configure login spring security

     * endpoints login and oauth
     */
    public String getOauthRestEndpointPaths() {
        return UrlParts.ensureStartsAndEndsWithSlash(prefix) + "auth/oauth2/token";
    }

    /**
     * quick help to configure spring security

     * endpoints like login, forgot password, registration etc
     */
    public String[] getAllPublicRestEndpointPaths() {
        String prefixPath = UrlParts.ensureStartsAndEndsWithSlash(prefix);
        return new String[]{
                getOauthRestEndpointPaths(),
                prefixPath + "auth/login",
                prefixPath + "auth/forgot-password",
                prefixPath + "auth/reset-password",
                prefixPath + "auth/validate",
                prefixPath + "auth/validate/*",
                prefixPath + "auth/register",
                prefixPath + "auth/invite",
                prefixPath + "auth/verify",
                prefixPath + "auth/verify-email"
        };
    }

    /**
     * quick help to configure spring security

     * endpoints for logged in users to interact with their data
     */
    public String[] getAllAuthenticatedRestEndpointPaths() {
        String prefixPath = UrlParts.ensureStartsAndEndsWithSlash(prefix);
        return new String[]{
                prefixPath + "auth/me",
                prefixPath + "auth/refresh",
                prefixPath + "auth/update-profile",
                prefixPath + "auth/change-password",
                prefixPath + "auth/change-username",
                prefixPath + "auth/change-email"
        };
    }

    /**
     * quick help to configure spring security

     * endpoint to crud users (normally only allowed for admins)
     */
    public String[] getApiRestEndpointPaths() {
        String prefixPath = UrlParts.ensureStartsAndEndsWithSlash(prefix);
        return new String[]{
                prefixPath + "api/user",
                prefixPath + "api/user/*"
        };
    }

    /**
     * quick help to configure spring security

     * endpoint to crud invite (normally only allowed for admins)
     */
    public String[] getApiInviteRestEndpointPaths() {
        String prefixPath = UrlParts.ensureStartsAndEndsWithSlash(prefix);
        return new String[]{
                prefixPath + "api/invite",
                prefixPath + "api/invite/*"
        };
    }

    /**
     * quick help to configure spring security

     * endpoint to search for users (normally allowed for all logged in users)
     */
    public String[] getUserSearchRestEndpointPaths() {
        String prefixPath = UrlParts.ensureStartsAndEndsWithSlash(prefix);
        return new String[]{
                prefixPath + "api/user-search",
                prefixPath + "api/user-search/*"
        };
    }

    /**
     * quick help to configure login spring security

     * endpoints login and oauth
     */
    public String getImpersonateEndpointPaths() {
        return UrlParts.ensureStartsAndEndsWithSlash(prefix) + "api/impersonate/*";
    }
}