mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-20 15:43:13 +09:00
Add Player Auth plugin (#368)
Add authentication plugin that does a simple challenge response protocol to verify that the player trying to log in is who they claim to be. The process goes as follows: 1. A player code is generated for a player that wants to log in and is displayed in-game. 2. The player code is input into the web interface and the master generates a verification code as a challenge back along with a token. 3. The player inputs the verification code in-game and is logged in to the web interface in doing so. To do the actual login the web interface polls a verify endpoint every 2 seconds until the code has either been verified or expired. The challenge comes from being unable to control the verification code and having to input it as a player logging into one of the servers in order to login. Some additional steps are taken in order to increase the difficulty for an attacker to subvert the challenge: - The login process must be started from in-game. - Generated codes are only valid for a limited timespan which is configurable and 2 minutes by default. - The verification code comes with a token that only works with one player code and verification code combo and must be provided to pass validation.
This commit is contained in:
1 parent
f07082b52d
commit
72d0994ca6
17 files changed
+1346
-3
No files matched your search
@@ -0,0 +1,42 @@
|
||||
Clusterio Player Auth Plugin
|
||||
============================
|
||||
|
||||
Plugin authenticating logged in players to the web interface.
|
||||
Authentication is achieved by a simple challenge response mechanism
|
||||
where players have to log into one of the Factorio server in the cluster
|
||||
and open a dialog that presents a code, this code is input into the
|
||||
login form on the web interface which gives back a second code. Once
|
||||
the player enters the second code into the dialog in-game the web
|
||||
interface is authenticated.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Run the following commands in the folder Clusterio is installed to:
|
||||
|
||||
npm install @clusterio/plugin-player_auth
|
||||
npx clusteriomaster plugin add @clusterio/plugin-player_auth
|
||||
|
||||
Substitute clusteriomaster with clusterioslave or clusterioctl if this a
|
||||
dedicate slave or ctl installation respectively.
|
||||
|
||||
|
||||
Master Configuration
|
||||
--------------------
|
||||
|
||||
#### player_auth.code_length
|
||||
|
||||
Length in character of the generated challenge codes that need to be
|
||||
input between the web interface login form and the in-game Factorio
|
||||
login dialog.
|
||||
|
||||
Defaults to `6`.
|
||||
|
||||
#### player_auth.code_timeout
|
||||
|
||||
Time in seconds the first code generated stays valid. The login must be
|
||||
completed in less than this time starting from when the login dialog is
|
||||
opened in-game.
|
||||
|
||||
Defaults to `120`.
|
||||
Reference in new issue
Block a user