https://github.com/masterkale/goonauth2
REST API for verifying forum membership
https://github.com/masterkale/goonauth2
Last synced: about 1 year ago
JSON representation
REST API for verifying forum membership
- Host: GitHub
- URL: https://github.com/masterkale/goonauth2
- Owner: MasterKale
- Created: 2016-03-12T03:33:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T06:37:15.000Z (over 3 years ago)
- Last Synced: 2025-03-28T16:04:53.395Z (about 1 year ago)
- Language: Python
- Size: 97.7 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GoonAuth2
GoonAuth2 is a REST API service that can be used to authorize membership in the Something Is Awful internet forum.
## Requirements
- Pipenv
- Python3 (v3.6+)
- Redis (v5.0.0+)
## Installation
Install dependencies with **Pipenv** via the included **Pipfile**:
```sh
$> pipenv install
```
A few environment variables can be set within a **.env** file (placed in the root of this project) to customize functionality:
- `REDIS_URL`
- **String** in the following format: `redis://[username]:[password]@[hostname]:6379`
- **Default:** "" (will attempt to connect to localhost:6379 without a username or password)
- `HASH_LIFESPAN_MINS`
- **Number** of minutes a hash is good for
- **Default:** 5
The only things stored in the database are short-lived `key:value` pairs that automatically expire in `HASH_LIFESPAN_MINS * 60` seconds.
The following values will also need to be set so that the server can access SA profiles:
- `COOKIE_SESSIONID`
- `COOKIE_SESSIONHASH`
- `COOKIE_BBUSERID`
- `COOKIE_BBPASSWORD`.
These four values need to be taken from an existing logged-in user's cookies:
Once everything is in place, you can start the server using `gunicorn`:
```sh
$> pipenv run start-prod
```
## Usage
### 1. Generate a validation hash
POST to `/v1/generate_hash/` with a JSON-encoded payload containing a `username` value equal to the user's username.
The returned payload will contain a `hash` key with a random 32-character alphanumeric value:
```json
{
"hash": "hMPAtkx6xIEtVfqqP0X9bvEG8lU4Yypb"
}
```
The hash will expire after **5 minutes** but can easily be re-generated after expiration by re-submitting the above request.
### 2. Update the user's profile with the hash
Direct the user to save the above hash to a publicly-viewable section of their profile:
Wherever they save it, it needs to be visible when they navigate to `http://forums.somethingisawful.com/member.php?action=getinfo&username=`.
### 3. Validate the user
Once the hash is in-place, POST a request to `/v1/validate_user/` with a JSON-encoded payload containing a `username` value equal to the user's username.
The returned payload will contain a `validated` key with a `boolean` value of whether or not the hash was detected :
```json
{
"validated": true
}
```