|
| 1 | +======================== |
| 2 | +About Node OAuth2 Server |
| 3 | +======================== |
| 4 | + |
| 5 | +Please read this section carefully to understand the purpose and scope of the Node OAuth2 Server library. |
| 6 | + |
| 7 | +Scope |
| 8 | +===== |
| 9 | + |
| 10 | +The scope of this library is to provide a headless implementation of an OAuth2 server that can be used in a variety of applications. |
| 11 | +It is designed to be flexible and extensible, allowing developers to implement their own models and customize the behavior of the server. |
| 12 | + |
| 13 | + |
| 14 | +Headless |
| 15 | +======== |
| 16 | + |
| 17 | +By headless we mean that the library does not provide a user interface or any specific implementation details for handling user interactions. |
| 18 | +It is purely a backend library that can be integrated into any Node.js application or framework. |
| 19 | + |
| 20 | +The core library is also designed to be framework-agnostic, meaning it does not depend on any specific web framework like Express or Koa. |
| 21 | +For these frameworks, we provide separate adapter libraries that can be used to integrate the OAuth2 server into your application. |
| 22 | + |
| 23 | +Workflows |
| 24 | +========= |
| 25 | + |
| 26 | +The library intends to cover the core OAuth2 workflows, including: |
| 27 | +- Authorization Code Grant |
| 28 | +- Client Credentials Grant |
| 29 | +- Password Grant |
| 30 | +- Refresh Token Grant |
| 31 | + |
| 32 | +While we provide documentation and examples for these workflows, |
| 33 | +it is crucial for developers to understand the OAuth2 specification and how to implement these workflows correctly in their applications. |
| 34 | +This is especially important for security reasons, as OAuth2 is a complex protocol with many potential pitfalls. |
| 35 | + |
| 36 | +We do provide links to standards and readings that can help developers understand the OAuth2 specification and how to implement it securely. |
| 37 | + |
| 38 | +Examples |
| 39 | +======== |
| 40 | + |
| 41 | +We provide generic examples which you can use as foundation. |
| 42 | +However, please make sure you understand the OAuth2 specification and how to implement it correctly in your application. |
0 commit comments