Mithril

Mithril – authentication and role management service.

Mithril is a precious Silvery metal, very lightweight but capable of providing extreme strength in alloys.

Mithril is known for:

1. Implementing OAuth2 flow (e.g. issuing or revoking tokens);
2. Token verification service;
3. Role management;
4. Client management.

Mithril consists of two main parts:

• REST API back-end,
• Management UI.

Mithril by itself does not have any authorization tools, but you have two options to integrate with it:

• Use a Annon API Gateway that allows to configure Access Control Layer over your API;
• Write your own authorization plug that will resolve token scopes via Mithrill's API.

Specification

• This project uses API Blueprint for REST API specs, you can find their source in apiary.apib file.

• API docs or apiary.apib.

• Entity-relation diagram

• oAuth Sequence

Installation

Heroku One-click deployment

Mithril can be deployed by one button click on Heroku, by-default instance will fit in free tier and you will be able to change it later:

Docker container

Official Docker containers can be found on Docker Hub:

• nebo15/mithril_api,
• nebo15/mithril-web.

Dependencies

• PostgreSQL 9.6 is used as storage back-end.

Configuration

See ENVIRONMENT.md.

License

See LICENSE.md.