ORY Kratos is the first and only cloud native Identity and User Management System in the world. Finally, it is no longer necessary to implement a User Login process for the umpteenth time!
Table of Contents
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: Allow end-users to create and sign into accounts (we call them identities) using Username / Email and password combinations, Social Sign In ("Sign in with Google, GitHub"), Passwordless flows, and others.
- Multi-Factor Authentication (MFA/2FA): Support protocols such as TOTP (RFC 6238 and IETF RFC 4226 - better known as Google Authenticator)
- Account Verification: Verify that an E-Mail address, phone number, or physical address actually belong to that identity.
- Account Recovery: Recover access using "Forgot Password" flows, Security Codes (in case of MKFA device loss), and others.
- Profile and Account Management: Update passwords, personal details, email addresses, linked social profiles using secure flows.
- Admin APIs: Import, update, delete identities.
We highly recommend reading the ORY Kratos introduction docs to learn more about ORY Krato's background, feature set, and differentiation from other products.
To get started, head over to the ORY Kratos Documentation.
The ORY Kratos Quickstart teaches you ORY Kratos basics and sets up an example based on Docker Compose in less than five minutes.
Head over to the ORY Developer Documentation to learn how to install ORY Kratos on Linux, macOS, Windows, and Docker and how to build ORY Kratos from source.
The ORY Security Console is a visual admin interface for managing ORY Kratos, ORY Oathkeeper, and ORY Keto.
ORY Oathkeeper is a BeyondCorp/Zero Trust Identity & Access Proxy (IAP) built on top of OAuth2 and ORY Kratos.
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.
Running identity infrastructure requires attention and knowledge of thread models.
If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub and send us an email to hi@ory.am instead.
Ory's services collect summarized, anonymized data that 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 kratos -h or kratos help.
We encourage all contributions and encourage you to read our contribution guidelines
You need Go 1.13+ with GO111MODULE=on and (for the test suites):
- Docker and Docker Compose
- Makefile
- NodeJS / npm
It is possible to develop ORY Kratos on Windows, but please be aware that all guides assume a Unix shell like bash or zsh.
When cloning ORY Kratos, run make tools. It will download several required dependencies. If you haven't run the command
in a while it's probably a good idea to run it again.
You can format all code using make format. Our CI checks if your code is properly formatted.
There are three types of tests you can run:
- Short tests (do not require a SQL database like PostgreSQL)
- Regular tests (do require PostgreSQL, MySQL, CockroachDB)
- End to end tests (do require databases and will use a test browser)
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:
cd client; go test -tags sqlite -short .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 Makefile instead. Using dockertest can bloat the number of Docker Images on your system and are quite slow. Instead we recommend doing:
make testPlease be aware that make test recreates the databases every time you run make test. This can be annoying if
you are trying to fix something very specific and need the database tests all the time. In that case we
suggest that you initialize the databases with:
make resetdb
export TEST_DATABASE_MYSQL='mysql://root:secret@(127.0.0.1:3444)/mysql?parseTime=true'
export TEST_DATABASE_POSTGRESQL='postgres://postgres:secret@127.0.0.1:3445/kratos?sslmode=disable'
export TEST_DATABASE_COCKROACHDB='cockroach://root@127.0.0.1:3446/defaultdb?sslmode=disable'Then you can run go test as often as you'd like:
go test -tags sqlite ./...
# or in a module:
cd client; go test -tags sqlite .You can build a development Docker Image using:
make docker