gearnode/judge repository overview

⁠Judge

Judge is an "access management service" inspired by the AWS IAM Service.

⁠Table of content

• Abstract⁠
• Concepts⁠
• Roadmap⁠
• Contributing⁠

⁠Abstract

Judge attempts dealing with access management in a distributed system. Judge is inspired by the AWS IAM Service.

Judge implementation is focus on these values:

• Simple API⁠
• Distributable⁠
• Auditable⁠
• Extendable⁠

⁠Simple API

Jude provide a human readable syntax to execute an access request. An access request can be expressed like this:

• Who: The subject of the action, for example your End-User.
• Able: The effect which can be either "allow" or "deny".
• What: An action the subject attemps to perform.
• Something: An object the subject attemps to target.
• Context: The context containing information about the environment such as the IP Address, request date, the resource owner name or any other information you want to pass along.

⁠Distributable

Jude expose an API through Google gRPC⁠.

Google gRPC is built on top of HTTP/2. HTTP/2 come with many performance improvements:

• binary instead of textual with HTTP/1
• fully multiplexed, instead of ordered and blocking with HTTP/1
• header compression to reduce overhead

HTTP/2 tends to be the new default standard in the web's ecosystem.

Google gRPC implements official support of 11 programming languages (less maintenance for SDKs). Easy extendable (authentication, load balancing, etc.) and distribuable (low latency, etc.). By using Google gRPC Judge API is by design built in for polyglot distributed system.

TODO: explain storage solution

• many database alrady solve the distributable issue.
  • judge interface optimised storage type (now only k/v database).
• inject the storage you want and be free about query optimization.
• maybe provide a dedicated database!

⁠Auditable

• auditable by design
• open catalog
• judge use judge to protect this catalog (example by design)
  • may explain dog fooding

⁠Extendable

⁠Concepts

• Explain ORN
• Explain Policy
• Explain End-User
• Explain Organization
• Explain Access Request

⁠Usage

• mkcert 127.0.0.1

:warning: this project can only be used in your gopath directory. Generate protos are painful and I can't lose time again.

This project use go mod beta feature, so you should set this env var:

export GO111MODULE=on

Start judge server:

bin/judgeserver -tls-crt priv/server.crt -tls-key priv/server.key -tls

TODO:

• running make clean and make result on a mistake with the dependencies (delete or added without any reasons...)

⁠Roadmap

⁠v1alpha2

• apiserver

  • Reflection gRPC API support
  • TLS support
  • Simple CLI interface
  • Policy Management (list,show,create,update,delete)

• judgectl

  • Define CLI interface
  • Policy support

• subject management

  • add / update / remove subject
  • link policy to subject

• groups management

  • add / update remove group
  • link subject with group
  • link policy to group

⁠v1alpha1

• gRPC basic setup
• Policy management via gRPC (list,create,delete,update,show)
• basic storage interface
• gRPC server configurable
• alpha authorize rules define
• alpha orn format define

⁠Contributing

1. Fork it (https://github.com/gearnode/judge/fork⁠)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request