From 8338d26c5b9849a2c1c3f5308f4485cafb427fc7 Mon Sep 17 00:00:00 2001 From: Andreas Falk Date: Tue, 4 Jun 2019 23:25:51 +0200 Subject: [PATCH] update readme docs --- README.md | 18 +++++++++++------- intro-labs/reactive-playground/README.md | 2 +- lab-1/README.md | 6 ------ lab-1/complete-library-server/README.md | 8 ++------ lab-1/initial-library-server/README.md | 4 ++-- lab-2/README.md | 12 ++---------- lab-2/complete-library-server/README.md | 8 ++------ lab-3/README.md | 12 ++---------- lab-3/complete-library-server/README.md | 8 ++------ lab-4/README.md | 12 ++---------- lab-4/complete-library-server/README.md | 10 ++-------- lab-5/README.md | 12 ++---------- lab-5/complete-resource-server/README.md | 8 ++------ lab-5/initial-resource-server/README.md | 7 ++----- lab-6/README.md | 12 ++---------- lab-6/complete-oidc-client/README.md | 6 ++---- lab-6/initial-oidc-client/README.md | 6 ++---- 17 files changed, 40 insertions(+), 111 deletions(-) diff --git a/README.md b/README.md index b3ec18b..5b3ca41 100644 --- a/README.md +++ b/README.md @@ -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: @@ -33,7 +37,7 @@ 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 @@ -41,13 +45,13 @@ To start the workshop you need: 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 diff --git a/intro-labs/reactive-playground/README.md b/intro-labs/reactive-playground/README.md index 3c468dc..bb61f3b 100644 --- a/intro-labs/reactive-playground/README.md +++ b/intro-labs/reactive-playground/README.md @@ -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. diff --git a/lab-1/README.md b/lab-1/README.md index d6613be..9267a16 100644 --- a/lab-1/README.md +++ b/lab-1/README.md @@ -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_. diff --git a/lab-1/complete-library-server/README.md b/lab-1/complete-library-server/README.md index de4c75a..e78b9c4 100644 --- a/lab-1/complete-library-server/README.md +++ b/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. diff --git a/lab-1/initial-library-server/README.md b/lab-1/initial-library-server/README.md index 9bc501a..f4a2209 100644 --- a/lab-1/initial-library-server/README.md +++ b/lab-1/initial-library-server/README.md @@ -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) diff --git a/lab-2/README.md b/lab-2/README.md index b318da7..89a7959 100644 --- a/lab-2/README.md +++ b/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 !*** \ No newline at end of file +This contains the completed and initial code of the reactive web application for lab 2 of the workshop. diff --git a/lab-2/complete-library-server/README.md b/lab-2/complete-library-server/README.md index 4c45c97..61307ca 100644 --- a/lab-2/complete-library-server/README.md +++ b/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. diff --git a/lab-3/README.md b/lab-3/README.md index b318da7..2934c79 100644 --- a/lab-3/README.md +++ b/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 !*** \ No newline at end of file +This contains the completed and initial code of the reactive web application for lab 3 of the workshop. diff --git a/lab-3/complete-library-server/README.md b/lab-3/complete-library-server/README.md index 259e271..ca81380 100644 --- a/lab-3/complete-library-server/README.md +++ b/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. diff --git a/lab-4/README.md b/lab-4/README.md index b318da7..8e0a042 100644 --- a/lab-4/README.md +++ b/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 !*** \ No newline at end of file +This contains the completed and initial code of the reactive web application for lab 4 of the workshop. diff --git a/lab-4/complete-library-server/README.md b/lab-4/complete-library-server/README.md index ff5b31b..4126452 100644 --- a/lab-4/complete-library-server/README.md +++ b/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. diff --git a/lab-5/README.md b/lab-5/README.md index b318da7..862a2dc 100644 --- a/lab-5/README.md +++ b/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 !*** \ No newline at end of file +This contains the completed and initial code of the reactive web application for lab 5 of the workshop. diff --git a/lab-5/complete-resource-server/README.md b/lab-5/complete-resource-server/README.md index bd6d993..dedde75 100644 --- a/lab-5/complete-resource-server/README.md +++ b/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. diff --git a/lab-5/initial-resource-server/README.md b/lab-5/initial-resource-server/README.md index 4948e84..7bf64e7 100644 --- a/lab-5/initial-resource-server/README.md +++ b/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 !*** diff --git a/lab-6/README.md b/lab-6/README.md index b318da7..4692257 100644 --- a/lab-6/README.md +++ b/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 !*** \ No newline at end of file +This contains the completed and initial code of the OIDC client for lab 5 of the workshop. diff --git a/lab-6/complete-oidc-client/README.md b/lab-6/complete-oidc-client/README.md index ef6dcfa..75eb2b9 100644 --- a/lab-6/complete-oidc-client/README.md +++ b/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. diff --git a/lab-6/initial-oidc-client/README.md b/lab-6/initial-oidc-client/README.md index e8c5379..78b8341 100644 --- a/lab-6/initial-oidc-client/README.md +++ b/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.