Shield is a cloud native role-based authorization aware reverse-proxy service. With Shield, you can assign roles to users or groups of users to configure policies that determine whether a particular user has the ability to perform a certain action on a given resource.

Discover why users choose Shield as their authorization proxy

• Policy Management: Policies help you assign various roles to users/groups that determine their access to various resources
• Group Management: Group is nothing but another word for team. Shield provides APIs to add/remove users to/from a group, fetch list of users in a group along with their roles in the group, and fetch list of groups a user is part of.
• Activity Logs: Shield has APIs that store and retrieve all the access related logs. You can see who added/removed a user to/from group in these logs.
• Reverse Proxy: In addition to configuring access management, you can also use Shield as a reverse proxy to directly protect your endpoints by configuring appropriate permissions for them.
• Google IAP: Shield also utilizes Google IAP as an authentication mechanism. So if your services are behind a Google IAP, Shield will seemlessly integrate with it.
• Runtime: Shield can run inside containers or VMs in a fully managed runtime environment like Kubernetes. Shield also depends on a Postgres server to store data.

• Guides provide guidance on how to use Shield and configure it to your needs
• Concepts descibe the primary concepts and architecture behind Shield
• Reference contains the list of all the APIs that Shield exposes
• Contributing contains resources for anyone who wants to contribute to Shield

Shield is developed with

• node.js - Javascript runtime
• docker - container engine runs on top of operating system
• hapi - Web application framework
• casbin - Access control library
• typeorm - Database agnostic sql query builder

In order to install this project locally, you can follow the instructions below:

$ git clone [email protected]:odpf/shield.git
$ cd shield
$ npm install
$ docker-compose up

Please refer guides section to know more about proxies.

If application is running successfully click me will open success message on a browser.

Note - before docker-compose up command run docker daemon locally.

Once running, you can find the Shield API documentation on this link

Development of Shield happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Shield.

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Shield.

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

This project exists thanks to all the contributors.

Shield is Apache Licensed