Skip to content

Commit e9c7970

Browse files
pedroigorpedroigor
committed
Updating federation quickstarts instructions.
1 parent 4e697e7 commit e9c7970

File tree

25 files changed

+442
-97
lines changed

25 files changed

+442
-97
lines changed

‎picketlink-federation-saml-idp-basic/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,10 @@ You configure the security domain by running JBoss CLI commands. For your conven
6262
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
6363
You should see the following result when you run the script:
6464

65-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
66-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
67-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
68-
The batch executed successfully.
69-
{"outcome" => "success"}
65+
The batch executed successfully
66+
{
67+
"outcome" => "success",
68+
}
7069

7170

7271
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-servlet-filter/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6565
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
6666
You should see the following result when you run the script:
6767

68-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
69-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
70-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
71-
The batch executed successfully.
72-
{"outcome" => "success"}
68+
The batch executed successfully
69+
{
70+
"outcome" => "success",
71+
}
72+
7373

7474

7575
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-terms/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6969
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
7070
You should see the following result when you run the script:
7171

72-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
73-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
74-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
75-
The batch executed successfully.
76-
{"outcome" => "success"}
72+
The batch executed successfully
73+
{
74+
"outcome" => "success",
75+
}
76+
7777

7878

7979
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-with-encryption/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6262
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
6363
You should see the following result when you run the script:
6464

65-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
66-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
67-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
68-
The batch executed successfully.
69-
{"outcome" => "success"}
65+
The batch executed successfully
66+
{
67+
"outcome" => "success",
68+
}
69+
7070

7171

7272
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-with-metadata/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6363
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
6464
You should see the following result when you run the script:
6565

66-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
67-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
68-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
69-
The batch executed successfully.
70-
{"outcome" => "success"}
66+
The batch executed successfully
67+
{
68+
"outcome" => "success",
69+
}
70+
7171

7272

7373
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-with-signature/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6262
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
6363
You should see the following result when you run the script:
6464

65-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
66-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
67-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[usersProperties=users.properties,rolesProperties=roles.properties])
68-
The batch executed successfully.
69-
{"outcome" => "success"}
65+
The batch executed successfully
66+
{
67+
"outcome" => "success",
68+
}
69+
7070

7171

7272
Review the Modified Server Configuration

‎picketlink-federation-saml-idp-with-ssl/README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,11 @@ You configure the security domain by running JBoss CLI commands. For your conven
6969
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
7070
You should see the following result when you run the script:
7171

72-
#1 /subsystem=security/security-domain=idp:add(cache-type=default)
73-
#2 /subsystem=security/security-domain=idp/authentication=classic:add
74-
#3 /subsystem=security/security-domain=idp/authentication=classic/login-module=CertificateRoles:add(code=CertificateRoles,flag=optional,module-options=[password-stacking=useFirstPass,securityDomain=idp,verifier=org.jboss.security.auth.certs.AnyCertVerifier])
75-
#4 /subsystem=security/security-domain=idp/authentication=classic/login-module=UsersRoles:add(code=UsersRoles,flag=required,module-options=[password-stacking=useFirstPass,usersProperties=users.properties,rolesProperties=roles.properties])
76-
#5 /subsystem=security/security-domain=idp/jsse=classic:add(keystore={password="change_it",url="${jboss.server.config.dir}/server.keystore"},truststore={"password"="change_it",url="${jboss.server.config.dir}/server.keystore"}, client-auth=true)
77-
#6 The batch executed successfully.
78-
{"outcome" => "success"}
72+
The batch executed successfully
73+
{
74+
"outcome" => "success",
75+
}
76+
7977

8078

8179
Review the Modified Server Configuration

‎picketlink-federation-saml-sp-post-basic/README.md

+52-10
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ Configure Maven
3939

4040
If you have not yet done so, you must [Configure Maven](http://www.jboss.org/jdf/quickstarts/jboss-as-quickstart/#configure_maven) before testing the quickstarts.
4141

42-
Create the Security Domain
42+
Create the Security Domain for JBoss EAP
4343
---------------
4444

4545
These steps assume you are running the server in standalone mode and using the default standalone.xml supplied with the distribution.
4646

47-
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain.cli` script provided in the root directory of this quickstart.
47+
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain-eap.cli` script provided in the root directory of this quickstart.
4848

4949
1. Before you begin, back up your server configuration file
5050
* If it is running, stop the JBoss server.
@@ -55,21 +55,52 @@ You configure the security domain by running JBoss CLI commands. For your conven
5555

5656
For Linux: JBOSS_HOME/bin/standalone.sh
5757
For Windows: JBOSS_HOME\bin\standalone.bat
58-
3. Review the `configure-security-domain.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
58+
3. Review the `configure-security-domain-eap.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
5959

6060
4. Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:
6161

62-
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
62+
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain-eap.cli
63+
64+
You should see the following result when you run the script:
65+
66+
The batch executed successfully
67+
{
68+
"outcome" => "success",
69+
}
70+
71+
72+
Create the Security Domain for WildFly
73+
---------------
74+
75+
These steps assume you are running the server in standalone mode and using the default standalone.xml supplied with the distribution.
76+
77+
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain-wildfly.cli` script provided in the root directory of this quickstart.
78+
79+
1. Before you begin, back up your server configuration file
80+
* If it is running, stop the JBoss server.
81+
* Backup the file: `JBOSS_HOME/standalone/configuration/standalone.xml`
82+
* After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration.
83+
84+
2. Start the JBoss server by typing the following:
85+
86+
For Linux: JBOSS_HOME/bin/standalone.sh
87+
For Windows: JBOSS_HOME\bin\standalone.bat
88+
3. Review the `configure-security-domain-wildfly.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
89+
90+
4. Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:
91+
92+
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain-wildfly.cli
93+
6394
You should see the following result when you run the script:
6495

65-
#1 /subsystem=security/security-domain=sp:add(cache-type=default)
66-
#2 /subsystem=security/security-domain=sp/authentication=classic:add
67-
#3 /subsystem=security/security-domain=sp/authentication=classic/login-module=SAML2LoginModule:add(code=org.picketlink.identity.federation.bindings.jboss.auth.SAML2LoginModule,flag=required)
68-
The batch executed successfully.
69-
{"outcome" => "success"}
96+
The batch executed successfully
97+
{
98+
"outcome" => "success",
99+
}
100+
70101

71102

72-
Review the Modified Server Configuration
103+
Review the Modified Server Configuration for EAP
73104
-----------------------------------
74105

75106
If you want to review and understand newly added XML configuration, stop the JBoss server and open the `JBOSS_HOME/standalone/configuration/standalone.xml` file.
@@ -84,6 +115,17 @@ The following `sp` security-domain was added to the `security` subsystem.
84115

85116
The configuration above defines a security-domain which will be used by the SP to authenticate users based on a SAML Assertion previously issued by a Identity Provider.
86117

118+
Review the Modified Server Configuration for WildFly
119+
-----------------------------------
120+
121+
If you are using Wildfly, the security-domain should have the following configuration:
122+
123+
<security-domain name="sp" cache-type="default">
124+
<authentication>
125+
<login-module code="org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule" flag="required"/>
126+
</authentication>
127+
</security-domain>
128+
87129

88130
SAML SP-Initiated Single Sign-On
89131
-----------------------------------

‎picketlink-federation-saml-sp-post-basic/configure-security-domain.cli ‎picketlink-federation-saml-sp-post-basic/configure-security-domain-eap.cli

File renamed without changes.

‎picketlink-federation-saml-sp-post-basic/configure-security-domain-wildfly.cli

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Batch script to add and configure the quickstart-domain security domain in the JBoss server
2+
3+
# Start batching commands
4+
batch
5+
6+
# Add and configure the security domain, then add the PicketLink SAML2LoginModule. Which wil be used to extract user's information from the SAML Assertion and authenticate the user.
7+
/subsystem=security/security-domain=sp:add(cache-type=default)
8+
/subsystem=security/security-domain=sp/authentication=classic:add
9+
/subsystem=security/security-domain=sp/authentication=classic/login-module=org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule:add(code=org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule,flag=required)
10+
11+
# Run the batch commands
12+
run-batch
13+
14+
# Reload the server configuration
15+
:reload
16+

‎picketlink-federation-saml-sp-post-with-signature/README.md

+52-10
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ Configure Maven
3939

4040
If you have not yet done so, you must [Configure Maven](http://www.jboss.org/jdf/quickstarts/jboss-as-quickstart/#configure_maven) before testing the quickstarts.
4141

42-
Create the Security Domain
42+
Create the Security Domain for JBoss EAP
4343
---------------
4444

4545
These steps assume you are running the server in standalone mode and using the default standalone.xml supplied with the distribution.
4646

47-
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain.cli` script provided in the root directory of this quickstart.
47+
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain-eap.cli` script provided in the root directory of this quickstart.
4848

4949
1. Before you begin, back up your server configuration file
5050
* If it is running, stop the JBoss server.
@@ -55,21 +55,52 @@ You configure the security domain by running JBoss CLI commands. For your conven
5555

5656
For Linux: JBOSS_HOME/bin/standalone.sh
5757
For Windows: JBOSS_HOME\bin\standalone.bat
58-
3. Review the `configure-security-domain.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
58+
3. Review the `configure-security-domain-eap.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
5959

6060
4. Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:
6161

62-
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain.cli
62+
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain-eap.cli
63+
64+
You should see the following result when you run the script:
65+
66+
The batch executed successfully
67+
{
68+
"outcome" => "success",
69+
}
70+
71+
72+
Create the Security Domain for WildFly
73+
---------------
74+
75+
These steps assume you are running the server in standalone mode and using the default standalone.xml supplied with the distribution.
76+
77+
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a `configure-security-domain-wildfly.cli` script provided in the root directory of this quickstart.
78+
79+
1. Before you begin, back up your server configuration file
80+
* If it is running, stop the JBoss server.
81+
* Backup the file: `JBOSS_HOME/standalone/configuration/standalone.xml`
82+
* After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration.
83+
84+
2. Start the JBoss server by typing the following:
85+
86+
For Linux: JBOSS_HOME/bin/standalone.sh
87+
For Windows: JBOSS_HOME\bin\standalone.bat
88+
3. Review the `configure-security-domain-wildfly.cli` file in the root of this quickstart directory. This script adds the `sp` domain to the `security` subsystem in the server configuration and configures authentication access. Comments in the script describe the purpose of each block of commands.
89+
90+
4. Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:
91+
92+
JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-security-domain-wildfly.cli
93+
6394
You should see the following result when you run the script:
6495

65-
#1 /subsystem=security/security-domain=sp:add(cache-type=default)
66-
#2 /subsystem=security/security-domain=sp/authentication=classic:add
67-
#3 /subsystem=security/security-domain=sp/authentication=classic/login-module=SAML2LoginModule:add(code=org.picketlink.identity.federation.bindings.jboss.auth.SAML2LoginModule,flag=required)
68-
The batch executed successfully.
69-
{"outcome" => "success"}
96+
The batch executed successfully
97+
{
98+
"outcome" => "success",
99+
}
100+
70101

71102

72-
Review the Modified Server Configuration
103+
Review the Modified Server Configuration for EAP
73104
-----------------------------------
74105

75106
If you want to review and understand newly added XML configuration, stop the JBoss server and open the `JBOSS_HOME/standalone/configuration/standalone.xml` file.
@@ -84,6 +115,17 @@ The following `sp` security-domain was added to the `security` subsystem.
84115

85116
The configuration above defines a security-domain which will be used by the SP to authenticate users based on a SAML Assertion previously issued by a Identity Provider.
86117

118+
Review the Modified Server Configuration for WildFly
119+
-----------------------------------
120+
121+
If you are using Wildfly, the security-domain should have the following configuration:
122+
123+
<security-domain name="sp" cache-type="default">
124+
<authentication>
125+
<login-module code="org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule" flag="required"/>
126+
</authentication>
127+
</security-domain>
128+
87129

88130
SAML SP-Initiated Single Sign-On
89131
-----------------------------------

‎picketlink-federation-saml-sp-post-with-signature/configure-security-domain.cli ‎picketlink-federation-saml-sp-post-with-signature/configure-security-domain-eap.cli

File renamed without changes.

‎picketlink-federation-saml-sp-post-with-signature/configure-security-domain-wildfly.cli

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Batch script to add and configure the quickstart-domain security domain in the JBoss server
2+
3+
# Start batching commands
4+
batch
5+
6+
# Add and configure the security domain, then add the PicketLink SAML2LoginModule. Which wil be used to extract user's information from the SAML Assertion and authenticate the user.
7+
/subsystem=security/security-domain=sp:add(cache-type=default)
8+
/subsystem=security/security-domain=sp/authentication=classic:add
9+
/subsystem=security/security-domain=sp/authentication=classic/login-module=org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule:add(code=org.picketlink.identity.federation.bindings.wildfly.SAML2LoginModule,flag=required)
10+
11+
# Run the batch commands
12+
run-batch
13+
14+
# Reload the server configuration
15+
:reload
16+

0 commit comments

Comments
 (0)