Class SQLCoreProvider

java.lang.Object

pro.gravit.launchserver.auth.core.AuthCoreProvider

pro.gravit.launchserver.auth.core.AbstractSQLCoreProvider

pro.gravit.launchserver.auth.core.SQLCoreProvider

All Implemented Interfaces:

AutoCloseable, AuthSupport, AuthSupportExtendedCheckServer, AuthSupportHardware, AuthSupportSudo, Reconfigurable

public class SQLCoreProvider
extends AbstractSQLCoreProvider
implements AuthSupportHardware, AuthSupportExtendedCheckServer

SQL-backed auth provider with hardware-ID tracking and optional TOTP support.

Required configuration fields (in addition to base class)

• hardwareIdColumn – FK column in the user table pointing to the hwids table

Optional configuration fields

• AbstractSQLCoreProvider.totpSecretColumn – when set, the TOTP secret is read from this column and stored on AbstractSQLCoreProvider.SQLUser.totpSecret. When null the column is completely absent from every SELECT query and ResultSet mapping.
• tableHWID – defaults to "hwids"
• tableHWIDLog – defaults to "hwidLog"
• criticalCompareLevel – fuzzy-match threshold, defaults to 1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SQLCoreProvider.SQLUser
static class	SQLCoreProvider.SQLUserHardware	Immutable hardware record (except mutable publicKey and banned).
class	SQLCoreProvider.SQLUserSession	Session with lazy-loaded hardware info.

Nested classes/interfaces inherited from class AbstractSQLCoreProvider

AbstractSQLCoreProvider.ColumnFeature<U,T>

Modifier and Type	Class	Description
static final class	AbstractSQLCoreProvider.ColumnFeature<U extends AbstractSQLCoreProvider.SQLUser, T>	Describes a single optional column in the user table.

Nested classes/interfaces inherited from class AuthCoreProvider

AuthCoreProvider.OAuthAccessTokenExpired, AuthCoreProvider.PasswordVerifyReport

Modifier and Type	Class	Description
static class	AuthCoreProvider.OAuthAccessTokenExpired
static class	AuthCoreProvider.PasswordVerifyReport

Nested classes/interfaces inherited from interface AuthSupportHardware

AuthSupportHardware.HardwareInfoCompareResult

Modifier and Type	Interface	Description
static class	AuthSupportHardware.HardwareInfoCompareResult

Field Summary

Fields

Modifier and Type	Field	Description
double	criticalCompareLevel	Minimum similarity level for a hardware record to be considered a match in getHardwareInfoByData(HardwareReportRequest.HardwareInfo).
String	customCreateHardware
String	customCreateHWIDLog
String	customFindHardwareByData
String	customFindHardwareById
String	customFindHardwareByPublicKey
String	customUpdateHardwarePublicKey
String	customUsersByHwidId
String	hardwareIdColumn	Column in the user table that holds the hardware-ID foreign key (required).
HikariSQLSourceConfig	holder	Hikari connection-pool config (required).
String	tableHWID	Hardware-info table name.
String	tableHWIDLog	Hardware-change audit-log table name.

Fields inherited from class AbstractSQLCoreProvider

accessTokenColumn, codeGenerator, customQueryByLoginSQL, customQueryByUsernameSQL, customQueryByUUIDSQL, customQueryPermissionsByUUIDSQL, customQueryRolesByUserUUID, customUpdateAuthSQL, customUpdateServerIdSQL, expireSeconds, logger, passwordColumn, passwordVerifier, permissionsPermissionColumn, permissionsTable, permissionsUUIDColumn, rolesNameColumn, rolesTable, rolesUUIDColumn, serverIDColumn, table, timeProvider, totpSecretColumn, usernameColumn, uuidColumn, verifier

Modifier and Type	Field	Description
String	accessTokenColumn
protected final dev.samstevens.totp.code.CodeGenerator	codeGenerator
String	customQueryByLoginSQL
String	customQueryByUsernameSQL
String	customQueryByUUIDSQL
String	customQueryPermissionsByUUIDSQL
String	customQueryRolesByUserUUID
String	customUpdateAuthSQL
String	customUpdateServerIdSQL
long	expireSeconds	Session / access-token lifetime in seconds (default: 1 hour).
protected final org.apache.logging.log4j.Logger	logger
String	passwordColumn
PasswordVerifier	passwordVerifier
String	permissionsPermissionColumn
String	permissionsTable
String	permissionsUUIDColumn
String	rolesNameColumn
String	rolesTable
String	rolesUUIDColumn
String	serverIDColumn
String	table
protected final dev.samstevens.totp.time.TimeProvider	timeProvider
String	totpSecretColumn	Optional TOTP secret column in the user table.
String	usernameColumn
String	uuidColumn
protected final dev.samstevens.totp.code.CodeVerifier	verifier

Fields inherited from class AuthCoreProvider

pair, providers, server

Modifier and Type	Field	Description
protected AuthProviderPair	pair
static final pro.gravit.utils.ProviderMap<AuthCoreProvider>	providers
protected LaunchServer	server

Constructor Summary

Constructors

Constructor	Description
SQLCoreProvider()

Method Summary

Modifier and Type	Method	Description
void	addPublicKeyToHardwareInfo(UserHardware hardware, byte[] publicKey)
void	banHardware(UserHardware hardware)
protected void	buildPreparedQueries()	Builds all transient SQL strings.
void	close()
void	connectUserAndHardware(UserSession userSession, UserHardware hardware)
protected SQLCoreProvider.SQLUser	constructUserFromRow(ResultSet set)	Reads all required columns plus hardwareIdColumn, then lets the base class apply every registered optional column (including AbstractSQLCoreProvider.totpSecretColumn when enabled) via the AbstractSQLCoreProvider.ColumnFeature registry.
UserHardware	createHardwareInfo(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo info, byte[] publicKey)
protected SQLCoreProvider.SQLUserSession	createSession(AbstractSQLCoreProvider.SQLUser user)
UserSession	extendedCheckServer(Client client, String username, String serverID)
UserHardware	getHardwareInfoByData(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo info)
UserHardware	getHardwareInfoById(String id)
UserHardware	getHardwareInfoByPublicKey(byte[] publicKey)
SQLSourceConfig	getSQLConfig()
Iterable<User>	getUsersByHardwareInfo(UserHardware hardware)
void	init(LaunchServer server, AuthProviderPair pair)
protected String	makeUserCols()	hardwareIdColumn is a required column for this provider, so it is appended here rather than through the optional registry.
void	unbanHardware(UserHardware hardware)

Methods inherited from class AbstractSQLCoreProvider

applyOptionalColumns, authorize, checkServer, constructUser, executeSingleUpdate, getDetails, getUserByLogin, getUserByUsername, getUserByUUID, getUserSessionByOAuthAccessToken, isPermissionsEnabled, isRolesEnabled, joinServer, loadPermissions, refreshAccessToken, registerColumnFeature, registerOptionalColumns, safeQueryUser, sudo, updateAuth, updateServerID, verifyTotpCode

Modifier and Type	Method	Description
protected final void	applyOptionalColumns(AbstractSQLCoreProvider.SQLUser user, ResultSet set)	Applies all registered optional columns to user from the current row of set.
AuthManager.AuthReport	authorize(String login, AuthResponse.AuthContext context, pro.gravit.launcher.base.request.auth.AuthRequest.AuthPasswordInterface password, boolean minecraftAccess)
User	checkServer(Client client, String username, String serverID)
protected AbstractSQLCoreProvider.SQLUser	constructUser(ResultSet set)	Advances set by one row and delegates to AbstractSQLCoreProvider.constructUserFromRow(ResultSet), or returns null if the result set is empty.
protected int	executeSingleUpdate(String sql, String p1, String p2)	Runs a two-parameter UPDATE and returns the affected-row count.
List<pro.gravit.launcher.base.events.request.GetAvailabilityAuthRequestEvent.AuthAvailabilityDetails>	getDetails(Client client)
User	getUserByLogin(String login)
User	getUserByUsername(String username)
User	getUserByUUID(UUID uuid)
UserSession	getUserSessionByOAuthAccessToken(String accessToken)
boolean	isPermissionsEnabled()
boolean	isRolesEnabled()
boolean	joinServer(Client client, String username, UUID uuid, String accessToken, String serverID)
pro.gravit.launcher.base.ClientPermissions	loadPermissions(String uuid)
AuthManager.AuthReport	refreshAccessToken(String refreshToken, AuthResponse.AuthContext context)
protected final void	registerColumnFeature(AbstractSQLCoreProvider.ColumnFeature<?,?> feature)	Registers one optional column.
protected void	registerOptionalColumns()	Override to declare optional user-table columns.
protected final AbstractSQLCoreProvider.SQLUser	safeQueryUser(String sql, String param)	Executes a single-parameter SELECT and maps the result to a AbstractSQLCoreProvider.SQLUser (with permissions).
AuthManager.AuthReport	sudo(User user, boolean shadow)
protected void	updateAuth(User user, String accessToken)
protected boolean	updateServerID(User user, String serverID)
protected void	verifyTotpCode(AbstractSQLCoreProvider.SQLUser user, String totpCode)

Methods inherited from class AuthCoreProvider

authorize, getCommands, isSupport, registerProviders, verifyAuth

Modifier and Type	Method	Description
AuthManager.AuthReport	authorize(User user, AuthResponse.AuthContext context, pro.gravit.launcher.base.request.auth.AuthRequest.AuthPasswordInterface password, boolean minecraftAccess)
Map<String, pro.gravit.utils.command.Command>	getCommands()	Gets a list of commands available for this object.
<T> T	isSupport(Class<T> clazz)
static void	registerProviders()
void	verifyAuth(AuthResponse.AuthContext context)

Methods inherited from class Object

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

Methods inherited from interface AuthSupportHardware

compareHardwareInfo, normalizeHardwareInfo

Modifier and Type	Method	Description
default AuthSupportHardware.HardwareInfoCompareResult	compareHardwareInfo(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo first, pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo second)
default void	normalizeHardwareInfo(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo hardwareInfo)

Methods inherited from interface Reconfigurable

defaultCommandsMap

Modifier and Type	Method	Description
default Map<String, pro.gravit.utils.command.Command>	defaultCommandsMap()

Field Details

holder

public HikariSQLSourceConfig holder

Hikari connection-pool config (required).

hardwareIdColumn

public String hardwareIdColumn

Column in the user table that holds the hardware-ID foreign key (required). This is a required column for this provider — it is always included in SELECT queries via makeUserCols(), not via the optional registry.

tableHWID

public String tableHWID

Hardware-info table name.

tableHWIDLog

public String tableHWIDLog

Hardware-change audit-log table name.

criticalCompareLevel

public double criticalCompareLevel

Minimum similarity level for a hardware record to be considered a match in getHardwareInfoByData(HardwareReportRequest.HardwareInfo).

customFindHardwareByPublicKey

public String customFindHardwareByPublicKey

customFindHardwareByData

public String customFindHardwareByData

customFindHardwareById

public String customFindHardwareById

customCreateHardware

public String customCreateHardware

customCreateHWIDLog

public String customCreateHWIDLog

customUpdateHardwarePublicKey

public String customUpdateHardwarePublicKey

customUsersByHwidId

public String customUsersByHwidId

Constructor Details

SQLCoreProvider

public SQLCoreProvider()

Method Details

getSQLConfig

public SQLSourceConfig getSQLConfig()

Specified by:

getSQLConfig in class AbstractSQLCoreProvider

init

public void init(LaunchServer server,
 AuthProviderPair pair)

Overrides:

init in class AbstractSQLCoreProvider

makeUserCols

protected String makeUserCols()

hardwareIdColumn is a required column for this provider, so it is appended here rather than through the optional registry. Optional columns (e.g. AbstractSQLCoreProvider.totpSecretColumn) are appended by AbstractSQLCoreProvider automatically after the required set.

Overrides:

makeUserCols in class AbstractSQLCoreProvider

buildPreparedQueries

protected void buildPreparedQueries()

Description copied from class: AbstractSQLCoreProvider

Builds all transient SQL strings. Called once per AbstractSQLCoreProvider.init(LaunchServer, AuthProviderPair) after the optional-column registry is finalised.

Subclasses that need additional SQL should override this and call super.buildPreparedQueries() first.

Overrides:

buildPreparedQueries in class AbstractSQLCoreProvider

constructUserFromRow

protected SQLCoreProvider.SQLUser constructUserFromRow(ResultSet set)
                                                throws SQLException

Reads all required columns plus hardwareIdColumn, then lets the base class apply every registered optional column (including AbstractSQLCoreProvider.totpSecretColumn when enabled) via the AbstractSQLCoreProvider.ColumnFeature registry.

Overrides:

constructUserFromRow in class AbstractSQLCoreProvider

Throws:

SQLException

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractSQLCoreProvider

getHardwareInfoByPublicKey

public UserHardware getHardwareInfoByPublicKey(byte[] publicKey)

Specified by:

getHardwareInfoByPublicKey in interface AuthSupportHardware

getHardwareInfoByData

public UserHardware getHardwareInfoByData(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo info)

Specified by:

getHardwareInfoByData in interface AuthSupportHardware

getHardwareInfoById

public UserHardware getHardwareInfoById(String id)

Specified by:

getHardwareInfoById in interface AuthSupportHardware

createHardwareInfo

public UserHardware createHardwareInfo(pro.gravit.launcher.base.request.secure.HardwareReportRequest.HardwareInfo info,
 byte[] publicKey)

Specified by:

createHardwareInfo in interface AuthSupportHardware

connectUserAndHardware

public void connectUserAndHardware(UserSession userSession,
 UserHardware hardware)

Specified by:

connectUserAndHardware in interface AuthSupportHardware

addPublicKeyToHardwareInfo

public void addPublicKeyToHardwareInfo(UserHardware hardware,
 byte[] publicKey)

Specified by:

addPublicKeyToHardwareInfo in interface AuthSupportHardware

getUsersByHardwareInfo

public Iterable<User> getUsersByHardwareInfo(UserHardware hardware)

Specified by:

getUsersByHardwareInfo in interface AuthSupportHardware

banHardware

public void banHardware(UserHardware hardware)

Specified by:

banHardware in interface AuthSupportHardware

unbanHardware

public void unbanHardware(UserHardware hardware)

Specified by:

unbanHardware in interface AuthSupportHardware

extendedCheckServer

public UserSession extendedCheckServer(Client client,
 String username,
 String serverID)

Specified by:

extendedCheckServer in interface AuthSupportExtendedCheckServer

createSession

protected SQLCoreProvider.SQLUserSession createSession(AbstractSQLCoreProvider.SQLUser user)

Overrides:

createSession in class AbstractSQLCoreProvider