Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zce/oauth2-example
oauth2 server & client example
https://github.com/zce/oauth2-example
oauth2 oauth2-client oauth2-server
Last synced: 9 days ago
JSON representation
oauth2 server & client example
- Host: GitHub
- URL: https://github.com/zce/oauth2-example
- Owner: zce
- Created: 2019-05-19T03:52:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-30T23:52:10.000Z (over 1 year ago)
- Last Synced: 2024-10-12T08:50:06.643Z (25 days ago)
- Topics: oauth2, oauth2-client, oauth2-server
- Language: JavaScript
- Size: 197 KB
- Stars: 6
- Watchers: 3
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# oauth2-example
> oauth2-server example
## Usage
```shell
# install dependencies
$ yarn # or npm i
```
> Client: http://localhost:4000
> Server: http://localhost:3000
Visit client
## Models
### User
```js
{
id: objectId().str,
slug: 'admin',
username: 'admin',
password: 'wanglei',
nickname: 'Administrator',
email: '[email protected]',
mobile: '13266668888',
status: 'activated',
scope: ''
}
```
### Scope
```js
{
id: objectId().str,
scope: 'posts:update',
default: false
}
```
### Client
```js
{
id: objectId().str,
name: 'OAuth2 Client',
website_url: 'https://github.com/zce/oauth2-example',
privacy_url: 'https://github.com/zce/oauth2-example',
key: 'oauth2-client', // client_id
secret: 'f657d916-0ad9-4b65-9976-3fe796bbdea0', // client_secret
redirects: ['http://localhost:4000/login/callback'], // redirect_uris
grants: ['authorization_code', 'password', 'refresh_token', 'client_credentials'],
scope: 'all',
user_id: 1
}
```
### AccessToken
```js
{
id: objectId().str,
token: 'faee0258-b0a2-4d38-b12b-e0a9932a6b94', // access_token
expires: new Date('2019-05-30 00:00'), // expires_at
scope: 'posts:read',
user_id: 1,
client_id: 1
}
```
### RefreshToken
```js
{
id: objectId().str,
token: 'cba19635-3bb4-47b1-87f6-8d0ff26b43f2', // refresh_token
expires: new Date('2019-05-30 00:00'), // expires_at
scope: 'posts:read',
user_id: 1,
client_id: 1
}
```
### AuthorizationCode
```js
{
id: objectId().str,
code: '4023348b5bc4', // authorization_code
expires: new Date('2019-05-30 00:00'), // expires_at
redirect: 'http://localhost:4000/login/callback', // redirect_uri
scope: 'posts:read',
user_id: 1,
client_id: 1
}
```
## Grant Types
### Authorization Code
应用站点：FooApp
授权站点：AuthApp
1. 用户在 FooApp 上点击 AuthApp 授权登录链接，例如：
http://localhost:3000/oauth/authorize?client_id=oauth2-example-client&redirect_uri=http://localhost:4000/login/callback&response_type=code&scope=posts:read
2. 用户进入 AuthApp 页面进行授权，如果当前用户还没有在 AuthApp 登录，则需要先跳转到 AuthApp 登录
http://localhost:3000/account/login?redirect=%2Foauth%2Fauthorize%3Fclient_id%3Doauth2-example-client%26redirect_uri%3Dhttp%3A%2F%2Flocalhost%3A4000%2Flogin%2Fcallback%26response_type%3Dcode%26scope%3Dposts%3Aread