Authentication Module - ForgeEssentials/ForgeEssentials GitHub Wiki

Last updated for forgeessentials-1.7.10-1.4.0-beta1

The AuthModule is a module to provide security measures to a ForgeEssentials server. This module can force players to register on the server, login, and be unable to do ANYTHING until they do so. This module was designed with the fact that the Minecraft Authorization Services go offline quite often, and thus we have included a feature where the module can detect such a disturbance, and automatically switch the server to offline mode until the servers come back on.

CONFIGURATION
The configuration file can be found in ./ForgeEssentials/AuthLogin.cfg

When this Module is enabled anyone logging in who has not registered or not logged in will be unable to do anything other then using the commands /auth login and /auth register.

B:allowOfflineReg=false
This option is by default set for servers that are in online mode. That means that the server uses the Minecraft Authorization Services to ensure that the players logging in using their Minecraft accounts. Setting this property to true will allow players to register their usernames even if the server is in offline mode.

B:autoEnable=true
If this is set to true, then the AuthModule will check the Minecraft Authorization Service. When the authorization service goes down, the module will turn itself on and set the server to offline mode. When the Authorization Services come back on, the Module will turn itself off and return the server to online mode. If this property is set to false, the AuthModule will never check the status of the Minecraft Authorization Services, and never enable or disable itself automatically.

I:checkInterval=10
How often the server should check if the Minecraft Authorization Service is online, in minutes.

B:forceEnable=false
If this is set to false, the Module will only be enabled if/when the server is in offline mode. If this is set to true, then this module will be enabled at all times regardless if the server is in online or offline mode.

S:salt=############# This property property will automatically be set with an auto-generated salt to be used when encryption passwords. Setting this property and reloading the server will change the salt. Once the salt has been generated, it will never be auto-generated again unless this entire property line is deleted.

COMMANDS

Command Usage	Permission Node	Description
/auth help	fe.auth	Shows the player help for the command
/auth register <password>	fe.auth	Registers the player with the supplied password
/auth login <password>	fe.auth	Allows the player to login if they supply the correct password for their username
/auth changepass <oldpass> <newpass>	fe.auth	Allows the player to change their password
/auth setpass <player> <password>	fe.auth.admin	Sets the named players password to the one supplied
/auth kick <player>	fe.auth.admin	Forces the named player to login again
/auth unregister <player>	fe.auth.admin	Forces the named player to register again
/vip add <player>	fe.auth.vipcmd	Adds a player to the VIP list
/vip remove <player>	fe.auth.vipcmd	Removes a player from the VIP list