Package emu.grasscutter.auth

Class DefaultAuthentication

java.lang.Object

emu.grasscutter.auth.DefaultAuthentication

All Implemented Interfaces:

AuthenticationSystem

public final class DefaultAuthentication
extends Object
implements AuthenticationSystem

The default Grasscutter authentication implementation. Allows all users to access any account.

Nested Class Summary

Nested classes/interfaces inherited from interface emu.grasscutter.auth.AuthenticationSystem

AuthenticationSystem.AuthenticationRequest

Constructor Summary

Constructors

Constructor	Description
DefaultAuthentication()

Method Summary

Modifier and Type	Method	Description
void	createAccount(String username, String password)	Called when a user requests to make an account.
ExternalAuthenticator	getExternalAuthenticator()	This is the authenticator used for handling external authentication requests.
OAuthAuthenticator	getOAuthAuthenticator()	This is the authenticator used for handling OAuth authentication requests.
Authenticator<LoginResultJson>	getPasswordAuthenticator()	This is the authenticator used for password authentication.
Authenticator<ComboTokenResJson>	getSessionKeyAuthenticator()	This is the authenticator used for session authentication.
Authenticator<LoginResultJson>	getTokenAuthenticator()	This is the authenticator used for token authentication.
void	resetPassword(String username)	Called when a user requests to reset their password.
Account	verifyUser(String details)	Called by plugins to internally verify a user's identity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAuthentication

public DefaultAuthentication()

Method Details

createAccount

public void createAccount(String username,
 String password)

Description copied from interface: AuthenticationSystem

Called when a user requests to make an account.

Specified by:

createAccount in interface AuthenticationSystem

Parameters:

username - The provided username.

password - The provided password. (SHA-256'ed)

resetPassword

public void resetPassword(String username)

Description copied from interface: AuthenticationSystem

Called when a user requests to reset their password.

Specified by:

resetPassword in interface AuthenticationSystem

Parameters:

username - The username of the account to reset.

verifyUser

public Account verifyUser(String details)

Description copied from interface: AuthenticationSystem

Called by plugins to internally verify a user's identity.

Specified by:

verifyUser in interface AuthenticationSystem

Parameters:

details - A unique identifier to identify the user. (For example: a JWT token)

Returns:

The user's account if the verification was successful, null if the user was unable to be verified.

getPasswordAuthenticator

public Authenticator<LoginResultJson> getPasswordAuthenticator()

Description copied from interface: AuthenticationSystem

This is the authenticator used for password authentication.

Specified by:

getPasswordAuthenticator in interface AuthenticationSystem

Returns:

An authenticator.

getTokenAuthenticator

public Authenticator<LoginResultJson> getTokenAuthenticator()

Description copied from interface: AuthenticationSystem

This is the authenticator used for token authentication.

Specified by:

getTokenAuthenticator in interface AuthenticationSystem

Returns:

An authenticator.

getSessionKeyAuthenticator

public Authenticator<ComboTokenResJson> getSessionKeyAuthenticator()

Description copied from interface: AuthenticationSystem

This is the authenticator used for session authentication.

Specified by:

getSessionKeyAuthenticator in interface AuthenticationSystem

Returns:

An authenticator.

getExternalAuthenticator

public ExternalAuthenticator getExternalAuthenticator()

Description copied from interface: AuthenticationSystem

This is the authenticator used for handling external authentication requests.

Specified by:

getExternalAuthenticator in interface AuthenticationSystem

Returns:

An authenticator.

getOAuthAuthenticator

public OAuthAuthenticator getOAuthAuthenticator()

Description copied from interface: AuthenticationSystem

This is the authenticator used for handling OAuth authentication requests.

Specified by:

getOAuthAuthenticator in interface AuthenticationSystem

Returns:

An authenticator.