Discourse SSO OIDC Bridge - A Python PyPI package

This Python package contains a Flask application that when deployed can be used as and endpoint for Discourse when setting up it's SSO. It will then be able to wrap a OIDC provider and avoid various limitations of not being setup as a Discourse SSO provider.

This repo was made standing on the shoulders giants who made most of the initial work. Thank you @fmarco76 and @stevenmirabito!

• https://github.com/fmarco76/DiscourseSSO
• https://github.com/ComputerScienceHouse/DiscourseOIDC

I also did some refinements thanks to @greut this Medium article.

Installation

Note that this is only a Flask application, you must use gunicorn or another WSGI compatible webserver to host it and setup TLS etc.

WARNING: Not yet tested with Discourse to function, but I'm working on it!

# NOTE: Currently onnly on PyPI's test servers
pip install --upgrade discourse-sso-oidc-bridge-consideratio

Bridge Configuration

This is the common configuration that, default.py.

OIDC Provider Configuration

You must have a client_id and client_secret from your OIDC issuer. The issuer must also accept redirecting back to <bridge_url>/redirect_uri, which for example could be https://discourse-sso.example.com/redirect_uri.

Development Notes

To make changes and test them

1. Clone the repo

2. Install pipenv using pip.

   pip install pipenv
   

3. Setup a virtual development environment

   pipenv install --dev
   
   # Optionally enter the environment
   pipenv shell
   

4. Run tests

   pipenv run pytest
   

Build and upload a PyPI release

1. Test, build and upload the package

   # Make sure you are up to date with what you have declared to require
   pipenv install --dev
   
   # Update changelog, fix requirements, etc.
   pipenv lock -r > requirements.txt
   
   # Run tests
   pipenv run pytest
   
   # Commit and tag to influence the PyPI version
   # PBR will look for the latest tag and then append development
   # versions based on your git commits since the latest tag.
   git add .
   git commit
   
   
   TAG=$(pipenv run python -c 'from pbr.version import VersionInfo; print(VersionInfo("discourse_sso_oidc_bridge").version_string())')
   git tag -a $TAG -m "Release $TAG"
   
   # Build the package
   pipenv run python setup.py bdist_wheel
   
   # Upload the package to PyPI
   pipenv run twine upload --skip-existing --username consideratio dist/*
   

2. Build, run, and push a Docker image

   # Build and run
   docker build -t consideratio/discourse-sso-oidc-bridge:$TAG .
   docker run --rm -p 8080:8080 consideratio/discourse-sso-oidc-bridge:$TAG
   
   # Build and push
   docker build -t consideratio/discourse-sso-oidc-bridge:$TAG .
   docker push consideratio/discourse-sso-oidc-bridge:$TAG
   

Deployment notes

I have deployed this using a simpler not published Helm chart. I'm happy to open source this as well for a complete solution. But to avoid overworking something that few has interest for it in I'd appreciate if you showed interest in this by emailing me or opening an issue or similar.