Skip to content

Commit

Permalink
update readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andifalk committed Jun 4, 2019
1 parent e04333b commit 8338d26
Show file tree
Hide file tree
Showing 17 changed files with 40 additions and 111 deletions.
18 changes: 11 additions & 7 deletions README.md
Expand Up @@ -6,6 +6,10 @@

This is a hands-on workshop on securing a reactive Spring Boot 2.x based web application using Spring Security 5.x.

## Presentation

[Presentation Slides (Online)](https://andifalk.github.io/reactive-spring-security-5-workshop)

## Topics

Topics that will be covered by this workshop are:
Expand Down Expand Up @@ -33,21 +37,21 @@ To start the workshop you need:
* A Java IDE ([Eclipse](https://www.eclipse.org/), [STS](https://spring.io/tools), [IntelliJ](https://www.jetbrains.com/idea/), [VS Code](https://code.visualstudio.com/), [NetBeans](https://netbeans.org/), ...)
* To test the RESTful services on the command line [curl](https://curl.haxx.se/download.html) or [httpie](https://httpie.org/) would be helpful to install
* The workshop tutorial documentation ([html](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html) or [pdf](https://github.com/andifalk/reactive-spring-security-5-workshop/raw/master/docs/workshop-tutorial.pdf))
* [The initial reactive application to be made secure](https://github.com/andifalk/reactive-spring-security-5-workshop/tree/master/00-library-server)
* [The initial reactive application to be made secure](https://github.com/andifalk/reactive-spring-security-5-workshop/tree/master/lab-1/initial-library-server)
* The [REST API documentation](https://andifalk.github.io/reactive-spring-security-5-workshop/api-doc.html) of the initial reactive application

## Workshop structure

The workshop is split up into the following parts:

* Basic Security
* [Lab 1: Auto Configuration](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_1_auto_configuration)
* [Lab 2: Customize Authentication](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_2_customize_authentication)
* [Lab 3: Add Authorization](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_3_add_authorization)
* [Lab 4: Security Testing](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_4_security_testing)
* [Lab 1: Auto Configuration](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_lab_1_auto_configuration)
* [Lab 2: Customize Authentication](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_lab_2_customize_authentication)
* [Lab 3: Add Authorization](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_lab_3_add_authorization)
* [Lab 4: Security Testing](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_lab_4_security_testing)
* OAuth 2.0 / OpenID Connect
* [Lab 5: Resource Server](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_5_oauth2_openid_connect)
* [Lab 6: Client](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_5_oauth2_openid_connect)
* [Lab 5: Resource Server](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#resource-server)
* [Lab 6: Client](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#oauth2-login-client)

## License

Expand Down
2 changes: 1 addition & 1 deletion intro-labs/reactive-playground/README.md
Expand Up @@ -4,4 +4,4 @@

This contains a starting point to play around with the reactive stuff.

Just add tests to class _ReactiveTest_ to learn the reactive streams api.
Just execute and add tests to classes _*ReactivePlayground_ to learn the reactive streams api.
6 changes: 0 additions & 6 deletions lab-1/README.md
Expand Up @@ -3,9 +3,3 @@
## Lab 1: Auto configured security

This contains the completed and initial code of the reactive web application for lab 1 of the workshop.

You may continue from here with the [lab 2](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-project _initial-library-server_.

This also includes all finished parts of [lab 2](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub project _complete-library-server_.
8 changes: 2 additions & 6 deletions lab-1/complete-library-server/README.md
@@ -1,9 +1,5 @@
# Spring Security 5 Workshop

## 01 - Library-Server
## 01 - Authentication (Auto-Configuration)

This is the completed code of the reactive web application for step 1 of the workshop.

This includes all finished parts of [step 1](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_1_auto_configuration)

You may continue from here with the [next step](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_step_2_customize_authentication) of the workshop.
This is the completed code of the reactive web application for lab 1 of the workshop.
4 changes: 2 additions & 2 deletions lab-1/initial-library-server/README.md
Expand Up @@ -11,7 +11,7 @@ and an admin user can show, add or remove users.

Please start into the workshop with this initial application.

You find the accompanying workshop tutorial [here](https://andifalk.github.io/reactive-spring-security-5-workshop/)
You find the accompanying workshop tutorial [here](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html)

If you have already read all introductory sections of the tutorial you can directly
start with the [first step in the tutorial](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_1_auto_configuration)
start with the [first step in the tutorial](https://andifalk.github.io/reactive-spring-security-5-workshop/workshop-tutorial.html#_lab_1_auto_configuration)
12 changes: 2 additions & 10 deletions lab-2/README.md
@@ -1,13 +1,5 @@
# Spring Security 5 Workshop

## 05 - OAuth2/OpenID Connect
## 02 - Customized Authentication

This contains the completed and initial code of the reactive web application for step 5 of the workshop.

You may continue from here with the [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-projects _initial-library-server_ and the _initial-oauth2-login-client_.

This also includes all finished parts of [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub projects _oauth2-library-server_ and _oauth2-login-client_

***But please note that this is the last step of the workshop !***
This contains the completed and initial code of the reactive web application for lab 2 of the workshop.
8 changes: 2 additions & 6 deletions lab-2/complete-library-server/README.md
@@ -1,9 +1,5 @@
# Spring Security 5 Workshop

## 02 - Library-Server
## 02 - Customized Authentication

This is the completed code of the reactive web application for step 2 of the workshop.

This includes all finished parts of [step 2](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_2_customize_authentication)

You may continue from here with the [next step](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_3_add_authorization) of the workshop.
This is the completed code of the reactive web application for lab 2 of the workshop.
12 changes: 2 additions & 10 deletions lab-3/README.md
@@ -1,13 +1,5 @@
# Spring Security 5 Workshop

## 05 - OAuth2/OpenID Connect
## 03 - Authorization

This contains the completed and initial code of the reactive web application for step 5 of the workshop.

You may continue from here with the [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-projects _initial-library-server_ and the _initial-oauth2-login-client_.

This also includes all finished parts of [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub projects _oauth2-library-server_ and _oauth2-login-client_

***But please note that this is the last step of the workshop !***
This contains the completed and initial code of the reactive web application for lab 3 of the workshop.
8 changes: 2 additions & 6 deletions lab-3/complete-library-server/README.md
@@ -1,9 +1,5 @@
# Spring Security 5 Workshop

## 03 - Library-Server
## 03 - Authorization

This is the completed code of the reactive web application for step 3 of the workshop.

This includes all finished parts of [step 3](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_3_add_authorization)

You may continue from here with the [next step](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_4_security_testing) of the workshop.
This is the completed code of the reactive web application for lab 3 of the workshop.
12 changes: 2 additions & 10 deletions lab-4/README.md
@@ -1,13 +1,5 @@
# Spring Security 5 Workshop

## 05 - OAuth2/OpenID Connect
## 04 - Security Testing

This contains the completed and initial code of the reactive web application for step 5 of the workshop.

You may continue from here with the [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-projects _initial-library-server_ and the _initial-oauth2-login-client_.

This also includes all finished parts of [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub projects _oauth2-library-server_ and _oauth2-login-client_

***But please note that this is the last step of the workshop !***
This contains the completed and initial code of the reactive web application for lab 4 of the workshop.
10 changes: 2 additions & 8 deletions lab-4/complete-library-server/README.md
@@ -1,11 +1,5 @@
# Spring Security 5 Workshop

## 04 - Library-Server
## 04 - Security Testing

This is the completed code of the reactive web application for step 4 of the workshop.

This includes all finished parts of [step 4](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_4_security_testing)

You may continue from here with the [next step](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_login_client) of the workshop.

***But please note that you have to start with another initial application for this next step !***
This is the completed code of the reactive web application for lab 4 of the workshop.
12 changes: 2 additions & 10 deletions lab-5/README.md
@@ -1,13 +1,5 @@
# Spring Security 5 Workshop

## 05 - OAuth2/OpenID Connect
## 05 - OAuth2/OpenID Connect Resource Server

This contains the completed and initial code of the reactive web application for step 5 of the workshop.

You may continue from here with the [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-projects _initial-library-server_ and the _initial-oauth2-login-client_.

This also includes all finished parts of [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub projects _oauth2-library-server_ and _oauth2-login-client_

***But please note that this is the last step of the workshop !***
This contains the completed and initial code of the reactive web application for lab 5 of the workshop.
8 changes: 2 additions & 6 deletions lab-5/complete-resource-server/README.md
@@ -1,9 +1,5 @@
# Spring Security 5 Workshop

## 05 - Library-Server
## 05 - OAuth2/OpenID Connect Resource Server

This is the completed code of the reactive web application for step 5 of the workshop.

You may continue from here with the [next step](https://andifalk.github.io/spring-security-5-workshop/#_step_5_oauth2_login_client) of the workshop.

***But please note that you have to start with another initial application for this next step !***
This is the completed code of the resource server for lab 5 of the workshop.
7 changes: 2 additions & 5 deletions lab-5/initial-resource-server/README.md
@@ -1,9 +1,6 @@
# Spring Security 5 Workshop

## 04 - Library-Server
## 05 - OAuth2/OpenID Connect Resource Server

This is the completed code of the initially unsecured reactive web application (same as in first step of the workshop).
This is the completed code of the initially unsecured reactive web application (similar to the one in first step of the workshop).

You may continue from here with the [next step](https://andifalk.github.io/spring-security-5-workshop/#_step_5_oauth2_login_client) of the workshop.

***But please note that you have to start with another initial application for this next step !***
12 changes: 2 additions & 10 deletions lab-6/README.md
@@ -1,13 +1,5 @@
# Spring Security 5 Workshop

## 05 - OAuth2/OpenID Connect
## 06 - OAuth2/OpenID Connect Client

This contains the completed and initial code of the reactive web application for step 5 of the workshop.

You may continue from here with the [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop
using the sub-projects _initial-library-server_ and the _initial-oauth2-login-client_.

This also includes all finished parts of [step 5](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect)
in the sub projects _oauth2-library-server_ and _oauth2-login-client_

***But please note that this is the last step of the workshop !***
This contains the completed and initial code of the OIDC client for lab 5 of the workshop.
6 changes: 2 additions & 4 deletions lab-6/complete-oidc-client/README.md
@@ -1,8 +1,6 @@
# Spring Security 5 Workshop

## 05 - Library-Client
## 06 - OAuth2/OpenID Connect Client

This is the completed code of the reactive web application client for step 5 of the workshop.

You may continue from here with the [next step](https://andifalk.github.io/reactive-spring-security-5-workshop/#_step_5_oauth2_openid_connect) of the workshop.
This is the completed code of the OIDC client for lab 5 of the workshop.

6 changes: 2 additions & 4 deletions lab-6/initial-oidc-client/README.md
@@ -1,8 +1,6 @@
# Spring Security 5 Workshop

## 05 - Library-Client
## 06 - OAuth2/OpenID Connect Client

This is the initial code of the reactive web application client for step 5 of the workshop.

You may continue from here with the [next step](https://andifalk.github.io/spring-security-5-workshop/#_step_5_oauth2_login_client) of the workshop.
This is the initial code of the OIDC client for lab 5 of the workshop.

0 comments on commit 8338d26

Please sign in to comment.