jrc-auth

Microservice managing everything related to user authentication for JrC. Implemented as an API served over HTTP(S).

Setup

The API is implemented using django-restframework with Redis as a key/value-store.

Local setup

• git clone [email protected]:juniorconsulting/jrc-auth.git
• cd jrc-auth && virtualenv env && source env/bin/activate && sudo pip install -r requirements.txt
• cp jrc_auth/settings/example_local.py jrc_auth/settings/local.py
• Update local.py. If postgres run:
  • psql
  • CREATE DATABASE mydb
  • CREATE USER myuser WITH PASSWORD 'password';
  • GRANT ALL PRIVILEGES ON DATABASE mydb TO myuser;
  • \q
• python manage.py migrate
• python manage.py createsuperuser
• Install Redis
• redis-server
• python manage.py runserver

Production environment

jrc-auth is running on the jrc-services droplet. It is controlled using supervisor and is running under the jrcauth user.

For now, deployment is not automated, so the procedure is as follows:

• SSH to jrc-services.
• sudo su - jrcauth
• Pull new changes, migrate and install/update dependencies as necessary.

Endpoints

/users

GET

Returns a list of all users if authenticated as superuser, only yourself if otherwise.

POST

Registers a new user.

Payload

{
    'username': '<username_here>',
    'email': '<JrC_email_here>'
}

/login

POST

Returns a token if username/password was valid, error message otherwise.

Payload

{
    'username': '<username_here>',
    'password': '<password_here>'
}

/check-token

POST

Validates a token, returns userid on success, error message on failure.

Payload

{
    'token': '<token_here>'
}

/logout

POST

Logs out the user.

Payload

{
    'token': '<token_here>'
}