Commit 5c3cbf3a authored by Stuart John Watson's avatar Stuart John Watson

updated README

parent ad10bb5c
SUCS Game Server Auth System v2
===============================
imranh@sucs.org
ripp_@sucs.org
What is it?
-----------
An authentication system to ensure only SUCS members and plus whoever we want
An authentication system to ensure only SUCS members and plus whoever we want
can connect and play games on the game server.
How's it work?
--------------
It's written in php and it's done in the style of a SPA. If a member wishes
to connect to a game, they visit games.sucs.org, enter their SUCS username +
It's written in php and it's done in the style of a SPA. If a member wishes
to connect to a game, they visit games.sucs.org, enter their SUCS username +
password, and they are then granted access to the server.
The page uses a HTTP Refresh: header with a timeout of 30 seconds to keep them
logged in. this timeout can be fiddeled with in index.php and in
gameauth-task.php
The page uses AJAX to keep them logged in (or a HTTP Refresh header if
javascript is disabled)
The timeout can be fiddeled with in index.php, refresh.js and gameauth-task.php
Every time the page is accessed, the member's entry in a sqlite db is updated
and a hole poked in the firewall on the game server for their IP (if there's
not already a hole there)
Every time the page is accessed (or AJAX posted to endpoint.php), the member's
entry in a sqlite db is updated and a hole poked in the firewall on the game
server for their IP (if there's not already a hole there)
How to add new game information?
--------------------------------
See the file in games for an idea of how it works.
How does it know when a user times out?
---------------------------------------
......@@ -42,8 +47,8 @@ disconnects, it won't affect the other user.
What if we want to open the server to the world for a special event?
--------------------------------------------------------------------
Currently we are restricting this to only allow Swansea University students,
rename the uni.deny file in /home/game-server to uni.allow to allow SUCS +
Swansea Univerity students and rename it back to uni.deny only allow SUCS
rename the uni.deny file in /home/game-server to uni.allow to allow SUCS +
Swansea Univerity students and rename it back to uni.deny only allow SUCS
members.
Why was it rewritten?
......@@ -52,4 +57,4 @@ The old system didn't work.
What is wrong with Apache LDAP Auth?
------------------------------------
It doesn't give us the ability to customise the login form.
\ No newline at end of file
It doesn't give us the ability to customise the login form.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment