Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ory/kratos
The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor Auth, SMS, SAML, TOTP, and more. Written in Go, cloud native, headless, API-first. Available as a service on Ory Network and for self-hosters.
https://github.com/ory/kratos
hacktoberfest identity identity-management login profile-management registration user user-management user-profile user-profiles users
Last synced: 3 days ago
JSON representation
The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor Auth, SMS, SAML, TOTP, and more. Written in Go, cloud native, headless, API-first. Available as a service on Ory Network and for self-hosters.
- Host: GitHub
- URL: https://github.com/ory/kratos
- Owner: ory
- License: apache-2.0
- Created: 2018-05-29T16:09:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T09:45:53.000Z (about 1 month ago)
- Last Synced: 2024-10-29T09:52:34.159Z (about 1 month ago)
- Topics: hacktoberfest, identity, identity-management, login, profile-management, registration, user, user-management, user-profile, user-profiles, users
- Language: Go
- Homepage: https://www.ory.sh/?utm_source=github&utm_medium=banner&utm_campaign=kratos
- Size: 85 MB
- Stars: 11,222
- Watchers: 113
- Forks: 961
- Open Issues: 256
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-go - ory/kratos - gen identity server (think Auth0, Okta, Firebase) with Ory-hardened authentication, MFA, FIDO2, TOTP, WebAuthn, profile management, identity schemas, social sign in, registration, account recovery, passwordless. Golang, headless, API-only - without templating or theming headaches. Available as a cloud service.|8,671| (Popular)
- awesome-tools - ory/kratos - Next-gen identity server (think Auth0, Okta, Firebase) with Ory-hardened authentication. (Authentication)
- awesome-github-repos - ory/kratos - The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor A (Go)
- awesome-repositories - ory/kratos - The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor A (Go)
- awesome-starts - ory/kratos - Next-gen identity server (think Auth0, Okta, Firebase) with Ory-hardened authentication, MFA, FIDO2, profile management, identity schemas, social sign in, registration, account recovery, service-to-service and IoT auth. Can work as an OAuth2 / OpenID Connect Provider. Golang, headless, API-only - without templating or theming headaches. (Go)
- awesome-starred - ory/kratos - Next-gen identity server (think Auth0, Okta, Firebase) with Ory-hardened authentication, PassKeys, MFA, FIDO2, TOTP, WebAuthn, profile management, identity schemas, social sign in, registration, accou (hacktoberfest)
- awesome-auth - Ory Kratos - API-first Identity and User Management system built for cloud applications. (Authentication / <a name="authN-golang"></a>Golang)
- awesome-iam - Kratos - User login, user registration, 2FA and profile management. (Account Management)
- StarryDivineSky - ory/kratos
- awesome - ory/kratos - The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor Auth, SMS, SAML, TOTP, and more. Written in Go, cloud native, headless, API-first. Available as a service on Ory Network and for self-hosters. (Go)
- awesome - ory/kratos - The most scalable and customizable identity server on the market. Replace your Homegrown, Auth0, Okta, Firebase with better UX and DX. Has all the tablestakes: Passkeys, Social Sign In, Multi-Factor Auth, SMS, SAML, TOTP, and more. Written in Go, cloud native, headless, API-first. Available as a service on Ory Network and for self-hosters. (Go)
README
Chat |
Discussions |
Newsletter
Guide |
API Docs |
Code Docs
Support this project!
Work in Open Source, Ory is hiring!
---
>
Ory Kratos is _the_ developer-friendly, security-hardened and battle-tested
Identity, User Management and Authentication system for the Cloud. Finally, it
is no longer necessary to implement User Login for the umpteenth time!
## Ory Kratos on the Ory Network
The [Ory Network](https://www.ory.sh/cloud) is the fastest, most secure and
worry-free way to use Ory's Services. **Ory Identities** is powered by the Ory
Kratos open source identity server, and it's fully API-compatible.
The Ory Network provides the infrastructure for modern end-to-end security:
- **Identity & credential management scaling to billions of users and devices**
- **Registration, Login and Account management flows for passkey, biometric,
social, SSO and multi-factor authentication**
- **Pre-built login, registration and account management pages and components**
- OAuth2 and OpenID provider for single sign on, API access and
machine-to-machine authorization
- Low-latency permission checks based on Google's Zanzibar model and with
built-in support for the Ory Permission Language
It's fully managed, highly available, developer & compliance-friendly!
- GDPR-friendly secure storage with data locality
- Cloud-native APIs, compatible with Ory's Open Source servers
- Comprehensive admin tools with the web-based Ory Console and the Ory Command
Line Interface (CLI)
- Extensive documentation, straightforward examples and easy-to-follow guides
- Fair, usage-based [pricing](https://www.ory.sh/pricing)
Sign up for a
[**free developer account**](https://console.ory.sh/registration?utm_source=github&utm_medium=banner&utm_campaign=kratos-readme)
today!
## Ory Network Hybrid Support Plan
Ory offers a support plan for Ory Network Hybrid, including Ory on private cloud
deployments. If you have a self-hosted solution and would like help, consider a
support plan! The team at Ory has years of experience in cloud computing. Ory's
offering is the only official program for qualified support from the
maintainers. For more information see the
**[website](https://www.ory.sh/support/)** or
**[book a meeting](https://www.ory.sh/contact/)**!
### Quickstart
Install the [Ory CLI](https://www.ory.sh/docs/guides/cli/installation) and
create a new project to get started with Ory Identities right away:
```
# If you don't have Ory CLI installed yet:
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory
sudo mv ./ory /usr/local/bin/
# Sign up
ory auth
# Create project
ory create project
```
**Table of Contents**
- [Ory Kratos on the Ory Network](#ory-kratos-on-the-ory-network)
- [Quickstart](#quickstart)
- [What is Ory Kratos?](#what-is-ory-kratos)
- [Who is using it?](#who-is-using-it)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Ecosystem](#ecosystem)
- [Ory Kratos: Identity and User Infrastructure and Management](#ory-kratos-identity-and-user-infrastructure-and-management)
- [Ory Hydra: OAuth2 & OpenID Connect Server](#ory-hydra-oauth2--openid-connect-server)
- [Ory Oathkeeper: Identity & Access Proxy](#ory-oathkeeper-identity--access-proxy)
- [Ory Keto: Access Control Policies as a Server](#ory-keto-access-control-policies-as-a-server)
- [Security](#security)
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
- [Telemetry](#telemetry)
- [Documentation](#documentation)
- [Guide](#guide)
- [HTTP API documentation](#http-api-documentation)
- [Upgrading and Changelog](#upgrading-and-changelog)
- [Command line documentation](#command-line-documentation)
- [Develop](#develop)
- [Dependencies](#dependencies)
- [Install from source](#install-from-source)
- [Formatting Code](#formatting-code)
- [Running Tests](#running-tests)
- [Short Tests](#short-tests)
- [Regular Tests](#regular-tests)
- [Updating Test Fixtures](#updating-test-fixtures)
- [End-to-End Tests](#end-to-end-tests)
- [Build Docker](#build-docker)
- [Documentation Tests](#documentation-tests)
- [Preview API documentation](#preview-api-documentation)
## What is Ory Kratos?
Ory Kratos is an API-first Identity and User Management system that is built
according to
[cloud architecture best practices](https://www.ory.sh/docs/ecosystem/software-architecture-philosophy).
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](https://tools.ietf.org/html/rfc6238) and
[IETF RFC 4226](https://tools.ietf.org/html/rfc4226) - better known as
[Google Authenticator](https://en.wikipedia.org/wiki/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 MFA 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](https://www.ory.sh/kratos/docs/) to learn more
about Ory Krato's background, feature set, and differentiation from other
products.
### Who is using it?
The Ory community stands on the shoulders of individuals, companies, and
maintainers. The Ory team thanks everyone involved - from submitting bug reports
and feature requests, to contributing patches and documentation. The Ory
community counts more than 33.000 members and is growing rapidly. The Ory stack
protects 60.000.000.000+ API requests every month with over 400.000+ active
service nodes. None of this would have been possible without each and everyone
of you!
The following list represents companies that have accompanied us along the way
and that have made outstanding contributions to our ecosystem. _If you think
that your company deserves a spot here, reach out to
[email protected] now_!
Type
Name
Logo
Website
Adopter *
Raspberry PI Foundation
raspberrypi.org
Adopter *
Kyma Project
kyma-project.io
Adopter *
Tulip
tulip.com
Adopter *
Cashdeck / All My Funds
cashdeck.com.au
Adopter *
Hootsuite
hootsuite.com
Adopter *
Segment
segment.com
Adopter *
Arduino
arduino.cc
Adopter *
DataDetect
unifiedglobalarchiving.com/data-detect/
Adopter *
Sainsbury's
sainsburys.co.uk
Adopter *
Contraste
contraste.com
Adopter *
Reyah
reyah.eu
Adopter *
Zero
getzero.dev
Adopter *
Padis
padis.io
Adopter *
Cloudbear
cloudbear.eu
Adopter *
Security Onion Solutions
securityonionsolutions.com
Adopter *
Factly
factlylabs.com
Adopter *
Nortal
nortal.com
Adopter *
OrderMyGear
ordermygear.com
Adopter *
Spiri.bo
spiri.bo
Adopter *
Strivacity
strivacity.com
Adopter *
Hanko
hanko.io
Adopter *
Rabbit
rabbit.co.th
Adopter *
inMusic
inmusicbrands.com
Adopter *
Buhta
buhta.com
Adopter *
Connctd
connctd.com
Adopter *
Paralus
paralus.io
Adopter *
TIER IV
tier4.jp
Adopter *
R2Devops
r2devops.io
Adopter *
LunaSec
lunasec.io
Adopter *
Serlo
serlo.org
Adopter *
dyrector.io
dyrector.io
Adopter *
Stackspin
stackspin.net
Adopter *
Amplitude
amplitude.com
Adopter *
Pinniped
pinniped.dev
Adopter *
Pvotal
pvotal.tech
Many thanks to all individual contributors
\* Uses one of Ory's major projects in production.
## Getting Started
To get started with some easy examples, head over to the
[Get Started Documentation](https://www.ory.sh/docs/guides/protect-page-login/).
### Installation
Head over to the
[Ory Developer Documentation](https://www.ory.sh/kratos/docs/install) to learn
how to install Ory Kratos on Linux, macOS, Windows, and Docker and how to build
Ory Kratos from source.
## Ecosystem
We build Ory on several guiding principles when it comes to our architecture
design:
- Minimal dependencies
- Runs everywhere
- Scales without effort
- Minimize room for human and network errors
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: Identity and User Infrastructure and Management
[Ory Kratos](https://github.com/ory/kratos) is an API-first Identity and User
Management system that is built according to
[cloud architecture best practices](https://www.ory.sh/docs/next/ecosystem/software-architecture-philosophy).
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: OAuth2 & OpenID Connect Server
[Ory Hydra](https://github.com/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: Identity & Access Proxy
[Ory Oathkeeper](https://github.com/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: Access Control Policies as a Server
[Ory Keto](https://github.com/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.
## Security
Running identity infrastructure requires
[attention and knowledge of threat models](https://www.ory.sh/kratos/docs/concepts/security).
### Disclosing vulnerabilities
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](https://www.ory.sh/.well-known/security.txt).
## Telemetry
Ory's services collect summarized, anonymized data that can optionally be turned
off. Click [here](https://www.ory.sh/docs/ecosystem/sqa) to learn more.
## Documentation
### Guide
The Guide is available [here](https://www.ory.sh/kratos/docs).
### HTTP API documentation
The HTTP API is documented [here](https://www.ory.sh/kratos/docs/sdk/api).
### Upgrading and Changelog
New releases might introduce breaking changes. To help you identify and
incorporate those changes, we document these changes in the
[CHANGELOG.md](./CHANGELOG.md). For upgrading, please visit the
[upgrade guide](https://www.ory.sh/kratos/docs/guides/upgrade).
### Command line documentation
Run kratos -h or
kratos help.
### Develop
We encourage all contributions and encourage you to read our
[contribution guidelines](./CONTRIBUTING.md)
#### Dependencies
You need Go 1.16+ 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.
#### Install from source
make install
#### Formatting Code
You can format all code using make format. Our
CI checks if your code is properly formatted.
#### Running Tests
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
Short tests run fairly quickly. You can either test all of the code at once
```shell script
go test -short -tags sqlite ./...
```
or test just a specific module:
```shell script
cd client; go test -tags sqlite -short .
```
##### Regular Tests
Regular tests require a database set up. Our test suite is able to work with
docker directly (using [ory/dockertest](https://github.com/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 test
Please 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:
```shell script
make test-resetdb
export TEST_DATABASE_MYSQL='mysql://root:secret@(127.0.0.1:3444)/mysql?parseTime=true'
export TEST_DATABASE_POSTGRESQL='postgres://postgres:[email protected]:3445/kratos?sslmode=disable'
export TEST_DATABASE_COCKROACHDB='cockroach://[email protected]:3446/defaultdb?sslmode=disable'
```
Then you can run `go test` as often as you'd like:
```shell script
go test -tags sqlite ./...
# or in a module:
cd client; go test -tags sqlite .
```
##### Updating Test Fixtures
Some tests use fixtures. If payloads change, you can update them with:
```
make test-update-snapshots
```
This will only update the snapshots of the short tests. To update all snapshots,
run:
```bash
UPDATE_SNAPSHOTS=true go test -p 4 -tags sqlite ./...
```
You can also run this command from a sub folder.
##### End-to-End Tests
We use [Cypress](https://www.cypress.io) to run our e2e tests.
⚠️ To run Cypress on ARM based Mac's, at the moment it is
[necessary to install Rosetta 2](https://www.cypress.io/blog/2021/01/20/running-cypress-on-the-apple-m1-silicon-arm-architecture-using-rosetta-2/).
To install, use the command -
`softwareupdate --install-rosetta --agree-to-license`
The simplest way to develop e2e tests is:
./test/e2e/run.sh --dev sqlite
You can run all tests (with databases) using:
make test-e2e
For more details, run:
./test/e2e/run.sh
**Run only a singular test**
Add `.only` to the test you would like to run.
For example:
```ts
it.only('invalid remote recovery email template', () => {
...
})
```
**Run a subset of tests**
This will require editing the `cypress.json` file located in the `test/e2e/`
folder.
Add the `testFiles` option and specify the test to run inside the
`cypress/integration` folder. As an example we will add only the `network`
tests.
```json
"testFiles": ["profiles/network/*"],
```
Now start the tests again using the run script or makefile.
#### Build Docker
You can build a development Docker Image using:
make docker
#### Preview API documentation
- update the SDK including the OpenAPI specification:
make sdk
- run preview server for API documentation: make
docs/api
- run preview server for swagger documentation: make
docs/swagger