ContextQMD
Back to Supertokens Core

Open-Source auth provider

README.md

11.4.423.0 KB
Original Source

Open-Source auth provider

<a href="https://supertokens.io/discord"> </a> <span></span>

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.

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

  • Passwordless Login
  • Social Login
  • Email Password Login
  • Phone Password Login
  • Session Management
  • Multi-Factor Authentication
  • Multi Tenancy / Organization Support (Enterprise SSO)
  • User Roles
  • Microservice Authentication

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:

  • Open source: SuperTokens can be used for free, forever, with no limits on the number of users.
  • An on-premises deployment so that you control 100% of your user data, using your own database.
  • An end-to-end solution with login, sign-ups, user and session management, without all the complexities of OAuth protocols.
  • Ease of implementation and higher security.
  • Extensibility: Anyone can contribute and make SuperTokens better!

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.

  • Please visit our website to see the list of features.
  • We want to make features as decoupled as possible. This means you can use SuperTokens for just login, or just session management, or both. In fact, we also offer session management integrations with other login providers like Auth0.

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?

  • βœ… Whilst running Java can seem difficult, we provide the JDK along with the binary/docker image when distributing it. This makes running SuperTokens just like running any other HTTP microservice.
  • βœ… Java has a very mature ecosystem. This implies that third-party libraries have been battle-tested.
  • βœ… Java's strong type system ensures fewer bugs and easier maintainability. This is especially important when many people are expected to work on the same project.
  • βœ… Our team is most comfortable with Java and hiring great Java developers is relatively easy as well.
  • βœ… One of the biggest criticisms of Java is memory usage. We have three solutions to this:
    • The most frequent auth-related operation is session verification - this happens within the backend SDK (node, python, Go) without contacting the Java core. Therefore, a single instance of the core can handle several 10s of thousands of users fairly easily.
    • We have carefully chosen our dependencies. For eg: we use an embedded tomcat server instead of a higher-level web framework.
    • We also plan on using GraalVM in the future and this can reduce memory usage by 95%!
  • βœ… If you require any modifications to the auth APIs, those would need to be done on the backend SDK level (for example Node, Golang, Python..). So you’d rarely need to directly modify/work with the Java code in this repo.

⌨️ 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.

Manage users

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

πŸ”₯ 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)

<table> <tr> <td align="center"><a href="https://github.com/rishabhpoddar"> <sub><b>Rishabh Poddar</b></sub></a></td> <td align="center"><a href="https://twitter.com/Advait_Ruia"> <sub><b>Advait Ruia</b></sub></a></td> <td align="center"><a href="https://github.com/bhumilsarvaiya"> <sub><b>Bhumil Sarvaiya</b></sub></a></td> <td align="center"><a href="https://github.com/jscyo"> <sub><b>Joel Coutinho</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/RakeshUP"> <sub><b>Rakesh UP</b></sub></a></td> <td align="center"><a href="https://twitter.com/mufassirkazi"> <sub><b>Mufassir Kazi</b></sub></a></td> <td align="center"><a href="https://github.com/nkshah2"> <sub><b>Nemi Shah</b></sub></a></td> <td align="center"><a href="https://github.com/irohitb"> <sub><b>Rohit Bhatia</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/mmaha"> <sub><b>Madhu Mahadevan</b></sub></a></td> <td align="center"><a href="https://github.com/nugmanoff"> <sub><b>Aidar Nugmanoff</b></sub></a></td> <td align="center"><a href="https://github.com/arnxv0"> <sub><b>Arnav Dewan</b></sub></a></td> <td align="center"><a href="https://github.com/NkxxkN"> <sub><b>NkxxkN</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/UbadahJ"> <sub><b>LordChadiwala</b></sub></a></td> <td align="center"><a href="https://github.com/LuizDoPc"> <sub><b>Luiz Soares</b></sub></a></td> <td align="center"><a href="https://github.com/sudiptog81"> <sub><b>Sudipto Ghosh</b></sub></a></td> <td align="center"><a href="https://github.com/Fabricio20"> <sub><b>Fabricio20</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/metallicmonkey"> <sub><b>metallicmonkey</b></sub></a></td> <td align="center"><a href="https://github.com/vidu171"> <sub><b>Vidhyanshu Jain</b></sub></a></td> <td align="center"><a href="https://github.com/dlion"> <sub><b>Domenico Luciani</b></sub></a></td> <td align="center"><a href="https://github.com/EnzoBtv"> <sub><b>Enzo Batrov</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/IsautierEloise"> <sub><b>Eloïse Isautier</b></sub></a></td> <td align="center"><a href="https://github.com/ocReaper"> <sub><b>Ákos Resch</b></sub></a></td> <td align="center"><a href="https://github.com/chotuchaudhary"> <sub><b>Chotu Chaudhary</b></sub></a></td> <td align="center"><a href="https://github.com/heracek"> <sub><b>TomÑő HorÑček</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/sbauch"> <sub><b>Sam Bauch</b></sub></a></td> <td align="center"><a href="https://github.com/mirrorrim"> <sub><b>Alexey Tylindus</b></sub></a></td> <td align="center"><a href="https://github.com/gusfune"> <sub><b>Gus Fune</b></sub></a></td> <td align="center"><a href="https://github.com/chenkaiC4"> <sub><b>chenkaiC4</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/dulowski-marek"> <sub><b>Marek Dulowski</b></sub></a></td> <td align="center"><a href="https://github.com/Piyushhbhutoria"> <sub><b>Piyushh Bhutoria</b></sub></a></td> <td align="center"><a href="https://github.com/aldeed"> <sub><b>Eric Dobbertin</b></sub></a></td> <td align="center"><a href="https://github.com/seniorquico"> <sub><b>Kyle Dodson</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/taijuten"> <sub><b>Ralph Lawrence</b></sub></a></td> <td align="center"><a href="https://github.com/christopher-kapic"> <sub><b>Christopher Kapic</b></sub></a></td> <td align="center"><a href="https://github.com/Hanzyusuf"> <sub><b>Hanzyusuf</b></sub></a></td> <td align="center"><a href="https://github.com/porcellus"> <sub><b>MihÑly Lengyel</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/cerino-ligutom"> <sub><b>Cerino O. Ligutom III</b></sub></a></td> <td align="center"><a href="https://github.com/nadilas"> <sub><b>nadilas</b></sub></a></td> <td align="center"><a href="https://github.com/vasica38"> <sub><b>Vasile Catana</b></sub></a></td> <td align="center"><a href="https://github.com/rossoskull"> <sub><b>Jay Mistry</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/jacobhq"> <sub><b>Jacob Marshall</b></sub></a></td> <td align="center"><a href="https://github.com/miketromba"> <sub><b>miketromba</b></sub></a></td> <td align="center"><a href="https://github.com/olhapi"> <sub><b>Oleg Vdovenko</b></sub></a></td> <td align="center"><a href="https://github.com/siddharthmudgal"> <sub><b>Siddharth</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/xuatz"> <sub><b>xuatz</b></sub></a></td> <td align="center"><a href="https://github.com/yowayb"> <sub><b>Yoway Buorn</b></sub></a></td> <td align="center"><a href="https://github.com/rtpa25"> <sub><b>Ronit Panda</b></sub></a></td> <td align="center"><a href="https://github.com/anugrahsinghal"> <sub><b>Anugrah Singhal</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/JeremyEastham"> <sub><b>Jeremy Eastham</b></sub></a></td> <td align="center"><a href="https://github.com/assafushy"> <sub><b>Assaf Yacobi</b></sub></a></td> <td align="center"><a href="https://github.com/sattvikc"> <sub><b>Sattvik Chakravarthy</b></sub></a></td> <td align="center"><a href="https://github.com/opichon"> <sub><b>Olivier Pichon</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/FuzzySid"> <sub><b>Siddhant Varma</b></sub></a></td> <td align="center"><a href="https://github.com/renyijiu"> <sub><b>renyijiu</b></sub></a></td> <td align="center"><a href="https://github.com/ITenthusiasm"> <sub><b>Isaiah Thomason</b></sub></a></td> <td align="center"><a href="https://github.com/utsavdotpro"> <sub><b>Utsav Barnwal</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/saurabhghatnekar"> <sub><b>Saurabh Ghatnekar</b></sub></a></td> <td align="center"><a href="https://github.com/alisher-aituarov"> <sub><b>Alisher Aituarov</b></sub></a></td> <td align="center"><a href="https://github.com/wallstromsimon"> <sub><b>Simon Kihlberg Wallstrom</b></sub></a></td> <td align="center"><a href="https://github.com/AreebKhan619"> <sub><b>Areeb Khan</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/sublimator"> <sub><b>Nicholas Dudfield</b></sub></a></td> <td align="center"><a href="https://github.com/Qdea"> <sub><b>Qdea</b></sub></a></td> <td align="center"><a href="https://github.com/LukasKnuth"> <sub><b>Lukas Knuth</b></sub></a></td> <td align="center"><a href="https://github.com/melvynhills"> <sub><b>Melvyn Hills</b></sub></a></td> <tr> <td align="center"><a href="https://github.com/mattanimation"> <sub><b>Matt Murray</b></sub></a></td> <td align="center"><a href="https://github.com/constantoine"> <sub><b>Cléo Rebert</b></sub></a></td> <td align="center"><a href="https://github.com/daniil-borovoy"> <sub><b>Daniil Borovoy</b></sub></a></td> <td align="center"><a href="https://github.com/kriskw1999"> <sub><b>Krzysztof Witkowski</b></sub></a></td> </tr> <tr> <td align="center"><a href="https://github.com/Lehoczky"> <sub><b>Lehoczky ZoltÑn</b></sub></a></td> <td align="center"><a href="https://github.com/mavwolverine"> <sub><b>Viraj Kanwade</b></sub></a></td> <td align="center"><a href="https://github.com/anuragmerndev"> <sub><b>Anurag Srivastava</b></sub></a></td> </tr> </table>

πŸ‘©β€πŸ’» Contributing

Please see the CONTRIBUTING.md file for instructions.

πŸ“ License

Β© 2020-2023 SuperTokens Inc and its contributors. All rights reserved.

Portions of this software are licensed as follows:

  • All content that resides under the "ee/" directory of this repository, if that directory exists, is licensed under the license defined in "ee/LICENSE.md".
  • All third-party components incorporated into the SuperTokens Software are licensed under the original license provided by the owner of the applicable component.
  • Content outside of the above-mentioned directories or restrictions above is available under the "Apache 2.0" license as defined in the level "LICENSE.md" file