keto
1.0.0
Many thanks to all individual contributors
* Uses one of Ory's major projects in production.
Head over to the documentation to learn about ways of installing Ory Keto.
We build Ory on several guiding principles when it comes to our architecture design:
Ory's architecture is designed to run best on a Container Orchestration system such as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries are small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) and operating systems (FreeBSD, Linux, macOS, Windows) without system dependencies (Java, Node, Ruby, libxml, ...).
Ory Kratos is an API-first Identity and User Management system that is built according to cloud architecture best practices. It implements core use cases that almost every software application needs to deal with: Self-service Login and Registration, Multi-Factor Authentication (MFA/2FA), Account Recovery and Verification, Profile, and Account Management.
Ory Hydra is an OpenID Certified™ OAuth2 and OpenID Connect Provider which easily connects to any existing identity system by writing a tiny "bridge" application. It gives absolute control over the user interface and user experience flows.
Ory Oathkeeper is a BeyondCorp/Zero Trust
Identity & Access Proxy (IAP) with configurable authentication, authorization,
and request mutation rules for your web services: Authenticate JWT, Access
Tokens, API Keys, mTLS; Check if the contained subject is allowed to perform the
request; Encode resulting content into custom headers (X-User-ID), JSON Web
Tokens and more!
Ory Keto is a policy decision point. It uses a set of access control policies, similar to AWS IAM Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized to perform a certain action on a resource.
If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub. You can find all info for responsible disclosure in our security.txt.
Our services collect summarized, anonymized data which can optionally be turned off. Click here to learn more.
The Guide is available here.
The HTTP API is documented here.
New releases might introduce breaking changes. To help you identify and incorporate those changes, we document these changes in UPGRADE.md and CHANGELOG.md.
Run keto -h or keto help.
We encourage all contributions and recommend you read our contribution guidelines.
You need Go 1.19+ and (for the test suites):
It is possible to develop Ory Keto on Windows, but please be aware that all guides assume a Unix shell like bash or zsh.
make install
You can format all code using make format. Our
CI checks if your code is properly formatted.
There are two types of tests you can run:
Short tests run fairly quickly. You can either test all of the code at once:
go test -short -tags sqlite ./...or test just a specific module:
go test -tags sqlite -short ./internal/check/...Regular tests require a database set up. Our test suite is able to work with docker directly (using ory/dockertest) but we encourage to use the script instead. Using dockertest can bloat the number of Docker Images on your system and starting them on each run is quite slow. Instead we recommend doing:
source ./scripts/test-resetdb.sh
go test -tags sqlite ./...The e2e tests are part of the normal go test. To only run the e2e test, use:
source ./scripts/test-resetdb.sh
go test -tags sqlite ./internal/e2e/...or add the -short tag to only test against sqlite in-memory.
You can build a development Docker Image using:
make docker
