BeryJu / oauth1-test-server

OAuth 1 Server for end-to-end and unit-testing

GNU General Public License v3.0

5 stars 1 forks source link

e2e oauth1 oauth1-server python sso unittest

readme

OAuth1 Test Server

GitHub branch checks state

Based on https://flask-oauthlib.readthedocs.io/en/latest/oauth1.html and https://github.com/lepture/example-oauth1-server

Can be used for e2e testing.

Credentials

By default, a user with the Username example-user is created.

Configuration

OAUTH1_CLIENT_ID: OAuth Client ID
OAUTH1_CLIENT_SECRET: OAuth Client Secret
OAUTH1_REDIRECT_URI: Allowed redirect URI

URLs/API Endpoints

/oauth/request_token: Request Token endpoint, accepts both GET and POST
/oauth/access_token: Access Token endpoint, accepts both GET and POST
/oauth/authorize: Authorize endpoint
/api/me: Returns User information
/api/health: Healthcheck URL

Running

This service is intended to run in a docker container

docker pull ghcr.io/beryju/oauth1-test-server
docke run -d --rm \
    -p 5000:5000 \
    -e OAUTH1_CLIENT_ID=2NVVBip7I5kfl0TwVmGzTphhC98kmXScpZaoz7ET \
    -e OAUTH1_CLIENT_SECRET=wXzb8tGqXNbBQ5juA0ZKuFAmSW7RwOw8uSbdE3MvbrI8wjcbGp \
    -e OAUTH1_REDIRECT_URI=http://localhost.... \
    ghcr.io/beryju/oauth1-test-server:v1.1

Or if you want to use docker-compose, use this in your docker-compose.yaml.

version: '3.5'

services:
  oauth1-test-server:
    image: ghcr.io/beryju/oauth1-test-server:v1.1
    ports:
      - 5000:5000
    environment:
      OAUTH1_CLIENT_ID: 2NVVBip7I5kfl0TwVmGzTphhC98kmXScpZaoz7ET
      OAUTH1_CLIENT_SECRET: wXzb8tGqXNbBQ5juA0ZKuFAmSW7RwOw8uSbdE3MvbrI8wjcbGp
      OAUTH1_REDIRECT_URI: http://localhost....