Skip to content

Commit 3b3bbec

Browse files
committed
Update documentation
1 parent 9ff1912 commit 3b3bbec

File tree

1 file changed

+43
-42
lines changed

1 file changed

+43
-42
lines changed

README.md

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,37 @@ Springboot 2.0.x oauth2 JWT
33

44
Sample Spring Boot 2.0.x OAuth2 JWT Authorization Server (JPA, Hibernate, PostgreSQL, Dockerize).
55

6-
If you feel happy give a star to this repository.
6+
You can use this project to boostraping Authorization your own Application.
7+
8+
If you feel happy **give a star** to this repository.
79

810
## Features
911

1012
* OAuth2.0 Authorization Server
1113
* OAuth2.0 Resource Server
12-
* [Liquibase](https://www.liquibase.org/)
13-
* [Gradle 4.10.2](https://gradle.org/install/)
14-
* Docker
15-
* JWT Token RSA
16-
* Sample File Upload (Using Oauth2 Resource Server)
14+
* We use [Liquibase](https://www.liquibase.org/)
15+
* We use [Gradle 4.10.2](https://gradle.org/install/)
16+
* We use Docker, to simplify understanding application flow.
17+
* We use JWT Token RSA, production ready.
18+
* File upload API (Using Oauth2 Resource Server)
19+
20+
## Oauth2 user credential
21+
22+
| User | Password | authorized grant types |
23+
|-----------------|-----------------|--------------------------------------------------- |
24+
| server-server | server-server | client_credentials |
25+
| external-server | external-server | client_credentials |
26+
| android-client | android-client | password,refresh_token,implicit,authorization_code |
27+
28+
## Customer credential
29+
30+
| User | Password |
31+
|-----------------|-----------------|
32+
| customer_one | customer_one |
33+
| customer_two | customer_two |
34+
| customer_bad | customer_bad |
1735

18-
## Running On Docker
36+
## How to Running On Docker
1937

2038
For running on Docker instance, it's really simple.
2139

@@ -24,7 +42,7 @@ For running on Docker instance, it's really simple.
2442

2543
## Testing Apps
2644

27-
Login server-server
45+
**server-server login**
2846

2947
```bash
3048
curl --request POST \
@@ -46,7 +64,7 @@ the result will be like
4664
}
4765
```
4866

49-
Login customer (end user for your apps)
67+
**Customer Login (end user for your apps)**
5068

5169
```bash
5270
curl --request POST \
@@ -69,7 +87,7 @@ the result will be like
6987
}
7088
```
7189

72-
Customer Check Oauth2 Token
90+
**Customer Check Oauth2 Token**
7391

7492
```bash
7593
curl --request POST \
@@ -105,7 +123,7 @@ the result will be like
105123
}
106124
```
107125

108-
Customer Refresh Oauth2 Token
126+
**Customer Refresh Oauth2 Token**
109127

110128
```bash
111129
curl --request POST \
@@ -114,7 +132,7 @@ curl --request POST \
114132
--data 'grant_type=refresh_token&token={{YOUR_ACCESS_TOKEN}}&refresh_token={{YOUR_REFRESH_TOKEN}}'
115133
```
116134

117-
Access Customer Profile
135+
**Access Customer Profile**
118136

119137
```bash
120138
curl --request GET \
@@ -130,7 +148,7 @@ the result will be like
130148
}
131149
```
132150

133-
File Upload
151+
**File Upload**
134152

135153
```bash
136154
curl --request POST \
@@ -147,37 +165,37 @@ First clone this repo. To build the sources you need to have [Gradle 4x](https:/
147165

148166
After the clone, create database
149167

150-
- For Authorization Server
168+
- For **Authorization Server**
151169

152170
```bash
153171
su - postgres
154172
createdb auth_server
155173
```
156174

157-
- For Resource Server
175+
- For **Resource Server**
158176

159177
```bash
160178
su - postgres
161179
createdb file_server
162180
```
163181

164-
After create database, build the entire project.
182+
After **create database**, build the entire project.
165183

166-
For Authorization Server
184+
For **Authorization Server**
167185

168186
```bash
169187
cd authorization_server
170188
gradle build
171189
```
172190

173-
For Resource Server
191+
For **Resource Server**
174192

175193
```bash
176194
cd resource_server
177195
gradle build
178196
```
179197

180-
Generate RSA KeyStore
198+
**Generate RSA KeyStore**
181199

182200
```bash
183201
keytool -genkey -alias jwt -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore jwt.p12 -keypass odenktools123 -validity 3650
@@ -187,30 +205,13 @@ keytool -genkey -alias jwt -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore
187205
keytool -list -rfc --keystore jwt.p12 | openssl x509 -inform pem -pubkey
188206
```
189207

190-
## Oauth2 user credential
191-
192-
User : server-server
193-
194-
Password : server-server
195-
196-
User : android-client
197-
198-
Password : android-client
199-
200-
User : external-server
201-
202-
Password : external-server
203-
204-
205-
## Customer credential
206-
207-
User : customer_one
208-
209-
Password : customer_one
210-
211-
## Todos
208+
## Todo List
212209

213-
- [] Admin UI for manage users and customers credentials
210+
- [x] Oauth2.0 JWT Token
211+
- [x] Remote Token
212+
- [ ] Client Registration API
213+
- [ ] Admin UI for manage **Oauth2 user credential** and **customers**
214+
- [ ] Custom authorization scope
214215

215216
## References
216217

0 commit comments

Comments
 (0)