Thursday, March 12, 2015

dj-sso-server and dj-sso-client: Django applications provide SSO feature

Github:
https://github.com/feifangit/dj-sso-server
https://github.com/feifangit/dj-sso-client






dj-sso-server

dj-sso-server is a Django application that provides Single Sign-on feature for your project.

The dj-sso-server application works as a SSO provider , you can use dj-sso-client (https://github.com/feifangit/dj-sso-client) as the SSO client in other projects need SSO.

Installation

Install by command pip install dj-sso-server

The dependent package dj-api-auth (https://github.com/feifangit/dj-api-auth) will be installed automatically.

How it works

  • Based on the dj-api-auth module, we can create an API key with SSO related APIs initially included. All the API communications between dj-sso-server and dj-sso-client are protected by dj-api-auth

  • The API key will also be bind with a host which is used to limit the origin of SSO requests.

  • SSO work flow with dj-sso-client

    1. Firstly, dj-sso-client applies a request key via API reqeusttoken/ on dj-sso-server

    2. The request key in dj-sso-server side will be kept in cache for 5 minutes, so the whole SSO login process should be done in 5 minutes.

    3. With the request key, dj-sso-client redirects user to SSO login page on SSO provider, and get auth token if login success. dj-sso-server will

      • verify the request origin
      • verify request key validity (expired?)
      • save user information in cache
    4. dj-sso-client verifies the auth token with dj-sso-server via API authtoken/, and get a SSOUser object.

    5. dj-sso-server delete the request key from cache once the authtoken/ is called.

  • If there's an already logged-in account on dj-sso-server (say, the project where SSO provider is placed also provides other features, and there's a valid cookies in browser side and valid session on server side), user can select to continue with that logged account.

  • SSO login through dj-sso-server with not affect the login status on dj-sso-server.

Attention

Since request keys are stored in cache waiting for verification or expiration. If you have multiple application process running in your deployment (gunicorn etc.), please use proper cache system that can be shared between processes.

Memcached and Redis are both great for caching, be aware, the Local-memory caching (django.core.cache.backends.locmem.LocMemCache) is a toy for local debugging.

Add dj-sso-server to project

  1. Add djapiauth and djssoserver to INSTALLED_APPS in sttings.py
  2. Assign an URL to the module
# add auth for a browser-oriented view
url(r'^sso/', include("djssoserver.urls"))
#...

Settings


  • SSO_SERVER_USER_TO_JSON_FUNC
    • optional, a path to function receives an user object and return a json string.

    • the default SSO_SERVER_USER_TO_JSON_FUNC function is djssoserver.utility.default_user_to_json

      def default_user_to_json(user):
          return json.dumps(model_to_dict(user, exclude=["password", "user_permissions"]),
              cls=DjangoJSONEncoder)
      


Scan API

In order to discover and manage APIs, after dj-sso-server is added in an accessible urls.py, run command python manage.py reloadentrypoints to collect APIs to database.

Create API key for SSO

  1. From your admin site, create an API key at Single sign-on/SSO credential. All SSO related APIs will assigned to this API Key automatically.
  2. After the API key for SSO is ready, you can assign more APIs for this API key at API Auth/Credential from admin site

Customize SSO login page

You can add styles to your own SSO login page. simply create djsso/ssologin.html under the templates folder. Revamp it by imitating the
original page

SSOUser object

dj-sso-client gets a SSOUser object whatever the User model is used in SSO provider project.

See detail in README file of dj-sso-client (https://github.com/feifangit/dj-sso-client)

DEMO

We have a SSO provider application running on Heroku (https://dj-sso-sample.herokuapp.com/).

Source code: under example folder

To try the demo out, check out the README file of dj-sso-client (https://github.com/feifangit/dj-sso-client)









dj-sso-client

dj-sso-client is the a Django application works as SSO client side of dj-sso-server (https://github.com/feifangit/dj-sso-server)

Installation

pip install dj-sso-client

Add to your project

  • Modify following settings in settings.py of your project

    • AUTHENTICATION_BACKENDS, add djssoclient.authbackend.SSOAuthBackend as the backends
    • AUTH_USER_MODEL, set djssoclient.SSOUser as user model
AUTHENTICATION_BACKENDS = ('djssoclient.authbackend.SSOAuthBackend',)
AUTH_USER_MODEL = 'djssoclient.SSOUser'
  • Add following dj-sso-client settings base on your demand

    • SSO_API_AUTH_SETTING: set API key, SEC key and remote SSO provider URL. This setting is used by underneath dj-api-auth module to proejct API accessing.

      SSO_API_AUTH_SETTING = {
          "apikey": "f4a05287",
          "seckey": "6a4eeaea54d54f51af703e79c6096d51",
          "url": "https://dj-sso-sample.herokuapp.com",
      }
      
    • SSO_REMOTE_URL_PREFIX (optional): SSO path in remote SSO provider. default /sso/

    • SSO_USER_STORAGE``(optional):  SSOUser storage solution, there are 2 storage backends in ``dj-sso-client already. default: SSOUserDBStorage

      • djssoclient.userstorage.SSOUserDBStorage: store user data in database
      • djssoclient.userstorage.SSOUserCacheStorage: store user data in cache. You will get better performance.
    • SSO_SETTING_CACHE (optional): if you selected SSOUserCacheStorage as your user storage backend, and you have more than one cache in settings.py, you can pick up the cache name here. default: default

Attention: SSOUserCacheStorage

The default django.core.cache.backends.locmem.LocMemCache stores data per process. In multi-process production environment (gunicorn on multi-core server), it may cause problem while using SSOUserCacheStorage as your user storage engine.

Please use dedicate cache system (Memcached or Redis) as cache backend to avoid this problem.

SSOUser

SSOUser is the user model to store user data. It can be used as database model class if you selected SSOUserDBStorage to be your user storage engine.

class SSOUser(AbstractBaseUser):
    username = models.CharField(unique=True, max_length=50)
    extras = models.TextField(default="{}")
    ...

extra user attributes : attributes not exists in the SSOUser class. (attributes except username, password, last_login etc.)

All extra user attributes can be access by getattr method or . operator. And they are stored in class member extras in JSON format.

Get your hands dirty

We already have a SSO provider (dj-sso-server) application running on Heroku: http://dj-sso-sample.herokuapp.com/ . Run the example application in folder example/ssoclient/ locally.

The API key using in the example application is binding with localhost:8000, so make sure you're accessing local application by localhost:8000 rather than the 127.0.0.1:8000.

fresh login

  1. make sure you're not logged in on http://dj-sso-sample.herokuapp.com/, you should see please log in with ...
  2. click sso login on local application, you will be redirected to http://dj-sso-sample.herokuapp.com/sso/....
  3. you will see user information after be redirected to local application.
  4. on http://dj-sso-sample.herokuapp.com/ , your status is still not logged-in

login with existing logged account

  1. log in with user name user1 and password 123 on http://dj-sso-sample.herokuapp.com/
  2. click sso login on local application, you will be redirected to http://dj-sso-sample.herokuapp.com/sso/...., but you will see a different login page with fresh login.
  3. select continue with current user? user1
  4. you will be logged in as user1 at local application

switch account

  1. if you select switch account and login with user2/456 from step 3 in previous sample
  2. you will be logged in as user2 at local application
  3. your login status on http://dj-sso-sample.herokuapp.com/ will NOT be changed (still logged in as user1)

TODO

  • example: work as an extra auth method


No comments:

Post a Comment