malachit/boruta-server repository overview

Boruta is a standalone authorization server implementing OAuth 2.0 and Openid Connect specifications. It provides administration tools and a customizable identity provider out of the box to manage authorization, but also a gateway to apply access rules to incoming traffic.

⁠Status

This server is on an ongoing beta stage. Developments are moving fast on master then are keen to be less stable. Tagged versions are said to be more stable and sanity tested.

As far as I know, there are no production deployments of the server. I would be happy to contribute to deployments if ones want to go for it. Reach out, we can discuss the needs of your use case.

⁠Source code

Source code is available on GitHub - https://github.com/malach-it/boruta-server⁠

⁠Implemented specifications and certification

As it, boruta server aim to follow the RFCs from IETF:

• RFC 6749 - The OAuth 2.0 Authorization Framework⁠
• RFC 7662 - OAuth 2.0 Token Introspection⁠
• RFC 7009 - OAuth 2.0 Token Revocation⁠
• RFC 7636 - Proof Key for Code Exchange by OAuth Public Clients⁠
• RFC 7521 - Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants⁠
• RFC 7523 - JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants⁠

And the specifications from the OpenID Foundation:

• OpenID Connect core 1.0⁠
• OpenID Connect Dynamic Client Registration 1.0 incorporating errata set 1⁠

This server has been certified for the Basic, Implicit, and Hybrid OpenID Provider profiles by the OpenID Foundation on October, 18th 2022 for the tagged version 0.1.0

This server has been also certified for the Config and Dynamic OpenID Provider profiles by the OpenID Foundation on May, 16th 2023 for the tagged version 0.2.0

⁠Installation

⁠Run an instance from docker

A docker image is available at malachit/boruta-server on DockerHub⁠, you will need a postgres instance installed on your system with credentials provided as environment variables in .env.*.

1. Fetch the environment file

wget https://raw.githubusercontent.com/malach-it/boruta-server/master/.env.dev

Once done you will be able to launch the server.

docker run --env-file .env.dev -it --network=host malachit/boruta-server:0.4.0

The applications will be available on different ports (depending on the values provided in .env.dev):

• http://localhost:4000⁠ for the authorization server
• http://localhost:4001⁠ for the admin interface
• http://localhost:4002⁠ for the gateway
• http://localhost:4003⁠ for the microgateway

Admin credentials are the one seeded and available in the environment file.