Skip to content

Commit

Permalink
Fix badges and typo in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenmirabito committed Sep 17, 2016
1 parent e3bef3f commit 8e78999
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Flask-pyoidc

![PyPI](https://img.shields.io/pypi/v/flask-pyoidc.svg)
![codecov.io](https://codecov.io/github/its-dirg/Flask-pyoidc/coverage.svg?branch=master)](https://codecov.io/github/its-dirg/Flask-pyoidc?branch=master)
[![PyPI](https://img.shields.io/pypi/v/flask-pyoidc.svg)](https://pypi.python.org/pypi/Flask-pyoidc)
[![codecov.io](https://codecov.io/github/its-dirg/Flask-pyoidc/coverage.svg?branch=master)](https://codecov.io/github/its-dirg/Flask-pyoidc?branch=master)

This repository contains an example of how to use the [pyoidc](https://github.com/rohe/pyoidc)
library to provide simple OpenID Connect authentication (using the ["Code Flow"](http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth).
library to provide simple OpenID Connect authentication (using the ["Code Flow"](http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)).

## Usage

The extension support both static and dynamic provider configuration discovery as well as static
and dynamic client registration. The different modes of provider configuration can be combined in
any way with the different client registration modes.

* Static provider configuration: `OIDCAuthentication(provider_configuration_info=provider_config)`,
where `provider_config` is a dictionary containing the [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
* Dynamic provider configuration: `OIDCAuthentication(issuer=issuer_url)`, where `issuer_url`
Expand All @@ -20,12 +20,10 @@ any way with the different client registration modes.
`client_info` is all the [registered metadata](https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse)
about the client. The `redirect_uris` registered with the provider MUST include
`<flask_url>/redirect_uri`, where `<flask_url>` is the URL for the Flask application.



The application using this extension MUST set the following [builtin configuration values of Flask](http://flask.pocoo.org/docs/0.10/config/#builtin-configuration-values):

* `SERVER_NAME` (MUST be the same as `<flask_url>` if using static client registration
* `SECRET_KEY` (this extension relies on Flask session, which requires `SECRET_KEY`)

Have a look at the example Flask app in [app.py](example/app.py) for an idea of how to use it.
Have a look at the example Flask app in [app.py](example/app.py) for an idea of how to use it.

0 comments on commit 8e78999

Please sign in to comment.