supertokens-core README

The project's README from github.com/supertokens/supertokens-core. As one markdown file: README.md.

SuperTokens banner

Open-Source auth provider

chat on Discord Docker pull stats

Add secure login and session management to your apps. SDKs available for popular languages and front-end frameworks e.g. Node.js, Go, Python, React.js, React Native, Vanilla JS, etc.

Architecture Diagram Supertokens architecture is optimized to add secure authentication for your users without compromising on user and developer experience

Three building blocks of SuperTokens architecture

  1. Frontend SDK: Manages session tokens and renders login UI widgets
  2. Backend SDK: Provides APIs for sign-up, sign-in, signout, session refreshing, etc. Your Frontend will talk to these APIs
  3. SuperTokens Core: The HTTP service for the core auth logic and database operations. This service is used by the Backend SDK

Features

Click here to get started

Learn more

If you like our project, please :star2: this repository! For feedback, feel free to join our Discord, or create an issue on this repo

🚀 What is SuperTokens?

SuperTokens is an open-core alternative to proprietary login providers like Auth0 or AWS Cognito. We are different because we offer:

Philosophy

Authentication directly affects the UX, dev experience, and security of any app. We believe that current solutions cannot optimize for all three "pillars", leading to many applications hand-rolling their own auth. This not only leads to security issues but is also a massive time drain.

We want to change that - we believe the only way is to provide a solution that has the right level of abstraction gives you maximum control, is secure, and is simple to use - just like if you build it yourself, from scratch (minus the time to learn, build, and maintain).

We also believe in the principle of least vendor lock-in. Your having full control of your user's data means that you can switch away from SuperTokens without forcing your existing users to logout, reset their passwords, or in the worst case, sign up again.

Click here to see the demo app.

Documentation

The docs can be seen on our website.

There is more information about SuperTokens on the GitHub wiki section.

🏗️ Architecture

Please find an architecture diagram here

For more information, please visit our GitHub wiki section.

☕ Why Java?

⌨️ User Management Dashboard

Oversee your users with the SuperTokens User Management Dashboard

List users

List all the users who have signed up to your application.

List SuperTokens users

Manage users

Manage users by modifying or deleting their sessions, metadata, roles and account info.

Manage users

🔥 SuperTokens vs others

Please find a detailed comparison chart on our website

🛠️ Building from source

Please see our wiki for instructions.

👥 Community

If you think this is a project you could use in the future, please :star2: this repository!

Contributors (across all SuperTokens repositories)


Rishabh Poddar

Advait Ruia

Bhumil Sarvaiya

Joel Coutinho

Rakesh UP

Mufassir Kazi

Nemi Shah

Rohit Bhatia

Madhu Mahadevan

Aidar Nugmanoff

Arnav Dewan

NkxxkN

LordChadiwala

Luiz Soares

Sudipto Ghosh

Fabricio20

metallicmonkey

Vidhyanshu Jain

Domenico Luciani

Enzo Batrov

Eloïse Isautier

Ákos Resch

Chotu Chaudhary

Tomáš Horáček

Sam Bauch

Alexey Tylindus

Gus Fune

chenkaiC4

Marek Dulowski

Piyushh Bhutoria

Eric Dobbertin

Kyle Dodson

Ralph Lawrence

Christopher Kapic

Hanzyusuf

Mihály Lengyel

Cerino O. Ligutom III

nadilas

Vasile Catana

Jay Mistry

Jacob Marshall

miketromba

Oleg Vdovenko

Siddharth

xuatz

Yoway Buorn

Ronit Panda

Anugrah Singhal

Jeremy Eastham

Assaf Yacobi

Sattvik Chakravarthy

Olivier Pichon

Siddhant Varma

renyijiu

Isaiah Thomason

Utsav Barnwal

Saurabh Ghatnekar

supertokens-core (supertokens/supertokens-core)

Searching Database…

Что это такое?SuperTokens — это open-source провайдер аутентификации для добавления в ваши приложения безопасного входа и управления сессиями. Это open-core альтернатива проприетарным решениям вроде Auth0, Firebase Auth и AWS Cognito.
Этот репозиторий — вся система аутентификации или только её часть?Только часть: это SuperTokens Core — HTTP-сервис, в котором находится основная логика аутентификации и работа с базой данных. Полная настройка также предполагает frontend SDK и backend SDK, которые общаются с этим сервисом.
Как его запустить?Скачайте бинарник или Docker-образ — JDK входит в комплект поставки — и запустите как любой другой HTTP-микросервис. Сборка из исходников описана в вики проекта.
Что нужно добавить в моё приложение, чтобы подключиться к нему?Backend SDK (Node.js, Go, Python и другие) плюс frontend SDK (React.js, React Native, Vanilla JS и другие) — на фронтенде обрабатываются токены сессий и интерфейс входа, а бэкенд общается с ядром.
Это правда бесплатно, или есть подвох?Ядро бесплатно навсегда, без ограничений на число пользователей. Это open-core проект, поэтому поверх существуют корпоративные дополнения вроде Enterprise SSO, но сам сервис ничего не стоит.
Где окажутся данные моих пользователей?На вашей собственной инфраструктуре: ядро разворачивается локально (on-premises) с вашей базой данных, поэтому вы полностью контролируете данные пользователей и можете уйти в любой момент, не заставляя пользователей выходить из системы или регистрироваться заново.
Какие способы входа поддерживаются из коробки?Вход без пароля (passwordless), вход через соцсети, вход по email и паролю, по телефону и паролю, а также управление сессиями, многофакторная аутентификация, мультитенантность с Enterprise SSO, роли пользователей и аутентификация в микросервисах.
Почему ядро написано на Java и не будет ли оно тяжёлым?Команда выбрала Java из-за зрелой экосистемы и сильной системы типов, а JDK поставляется вместе с бинарником, поэтому вам не нужно его настраивать. Потребление памяти остаётся низким, потому что проверка сессий выполняется в backend SDK без обращения к ядру — один инстанс обслуживает несколько десятков тысяч пользователей. Также планируется поддержка GraalVM, которая снизит расход памяти на 95%.
Могу ли я как-то управлять зарегистрировавшимися пользователями?Да — User Management Dashboard позволяет посмотреть список всех пользователей, зарегистрировавшихся в вашем приложении, и управлять ими: изменять или удалять их сессии, метаданные, роли и данные аккаунта.
Чтобы попробовать его, мне придётся заменить всю свою систему аутентификации?Нет. Возможности намеренно разделены: можно использовать только вход, только управление сессиями или и то и другое. Более того, SuperTokens даже предлагает интеграции управления сессиями вместе с другими провайдерами входа, например Auth0.
Size
819.5 MB
Stars
15.3K
Age
6y
Commits · 90 Days