Skip to content

Commit fde8a86

Browse files
authored
Merge pull request #190110 from Rainier-MSFT/patch-129
Consistency updates
2 parents dc453d1 + b64b293 commit fde8a86

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

articles/active-directory/manage-apps/f5-big-ip-headers-easy-button.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To learn about all of the benefits, see the article on [F5 BIG-IP and Azure AD i
2929

3030
## Scenario description
3131

32-
This scenario looks at the classic legacy application using HTTP authorization headers to control access to protected content.
32+
This scenario looks at the classic legacy application using **HTTP authorization headers** to manage access to protected content.
3333

3434
Being legacy, the application lacks modern protocols to support a direct integration with Azure AD. The application can be modernized, but it is costly, requires careful planning, and introduces risk of potential downtime. Instead, an F5 BIG-IP Application Delivery Controller (ADC) is used to bridge the gap between the legacy application and the modern ID control plane, through protocol transitioning.
3535

@@ -96,17 +96,17 @@ There are many methods to configure BIG-IP for this scenario, including two temp
9696
9797
## Register Easy Button
9898

99-
Before a client or service can access Microsoft Graph, it must be [trusted by the Microsoft identity platform.](/azure/active-directory/develop/quickstart-register-app)
99+
Before a client or service can access Microsoft Graph, it must be trusted by the [Microsoft identity platform.](/azure/active-directory/develop/quickstart-register-app)
100100

101-
The Easy Button client must also be registered in Azure AD, before it is allowed to establish a trust between each SAML SP instance of a BIG-IP published application, and Azure AD as the SAML IdP.
101+
This first step creates a tenant app registration that will be used to authorize the **Easy Button** access to Graph. Through these permissions, the BIG-IP will be allowed to push the configurations required to establish a trust between a SAML SP instance for published application, and Azure AD as the SAML IdP.
102102

103103
1. Sign-in to the [Azure AD portal](https://portal.azure.com/) using an account with Application Administrative rights
104104
2. From the left navigation pane, select the **Azure Active Directory** service
105105
3. Under Manage, select **App registrations > New registration**
106106
4. Enter a display name for your application. For example, *F5 BIG-IP Easy Button*
107107
5. Specify who can use the application > **Accounts in this organizational directory only**
108108
6. Select **Register** to complete the initial app registration
109-
7. Navigate to **API permissions** and authorize the following Microsoft Graph permissions:
109+
7. Navigate to **API permissions** and authorize the following Microsoft Graph **Application permissions**:
110110

111111
* Application.Read.All
112112
* Application.ReadWrite.All
@@ -125,7 +125,7 @@ The Easy Button client must also be registered in Azure AD, before it is allowed
125125

126126
## Configure Easy Button
127127

128-
Initiate the **Easy Button** configuration to set up a SAML Service Provider (SP) and Azure AD as an Identity Provider (IdP) for your application.
128+
Initiate the APM's **Guided Configuration** to launch the **Easy Button** Template.
129129

130130
1. Navigate to **Access > Guided Configuration > Microsoft Integration** and select **Azure AD Application**.
131131

@@ -142,7 +142,7 @@ Initiate the **Easy Button** configuration to set up a SAML Service Provider (SP
142142

143143
### Configuration Properties
144144

145-
The **Configuration Properties** tab creates a new application config and SSO object. Consider **Azure Service Account Details** section to be the client application you registered in your Azure AD tenant earlier. These settings allow a BIG-IP to programmatically register a SAML application directly in your tenant, along with the properties you would normally configure manually. Easy Button does this for every BIG-IP APM service being enabled for SHA.
145+
The **Configuration Properties** tab creates a BIG-IP application config and SSO object. Consider the **Azure Service Account Details** section to represent the client you registered in your Azure AD tenant earlier, as an application. These settings allow a BIG-IP's OAuth client to individually register a SAML SP directly in your tenant, along with the SSO properties you would normally configure manually. Easy Button does this for every BIG-IP service being published and enabled for SHA.
146146

147147
Some of these are global settings so can be re-used for publishing more applications, further reducing deployment time and effort.
148148

@@ -158,9 +158,9 @@ Some of these are global settings so can be re-used for publishing more applicat
158158

159159
### Service Provider
160160

161-
The Service Provider settings define the SAML SP properties for the APM instance representing the application protected through SHA.
161+
The Service Provider settings define the properties for the SAML SP instance of the application protected through SHA
162162

163-
1. Enter **Host**. This is usually the FQDN that will be used for the applications external URL
163+
1. Enter **Host**. This is the public FQDN of the application being secured
164164

165165
2. Enter **Entity ID**. This is the identifier Azure AD will use to identify the SAML SP requesting a token
166166

@@ -186,9 +186,7 @@ The optional **Security Settings** specify whether Azure AD should encrypt issue
186186

187187
### Azure Active Directory
188188

189-
This section defines all properties that you would normally use to manually configure a new BIG-IP SAML application within your Azure AD tenant.
190-
191-
The Easy Button wizard provides a set of pre-defined application templates for Oracle PeopleSoft, Oracle E-business Suite, Oracle JD Edwards, SAP ERP, but we’ll use the generic SHA template by selecting **F5 BIG-IP APM Azure AD Integration > Add**.
189+
This section defines all properties that you would normally use to manually configure a new BIG-IP SAML application within your Azure AD tenant. Easy Button provides a set of pre-defined application templates for Oracle PeopleSoft, Oracle E-business Suite, Oracle JD Edwards, SAP ERP as well as generic SHA template for any other apps. For this scenario select **F5 BIG-IP APM Azure AD Integration > Add**.
192190

193191
![Screenshot for Azure configuration add BIG-IP application](./media/f5-big-ip-easy-button-ldap/azure-config-add-app.png)
194192

@@ -263,7 +261,7 @@ A virtual server is a BIG-IP data plane object represented by a virtual IP addre
263261

264262
3. Check **Enable Redirect Port** and then enter **Redirect Port**. It redirects incoming HTTP client traffic to HTTPS
265263

266-
4. Select **Client SSL Profile** to enable the virtual server for HTTPS so that client connections are encrypted over TLS. Select the client SSL profile you created as part of the prerequisites or leave the default if testing
264+
4. The Client SSL Profile enables the virtual server for HTTPS, so that client connections are encrypted over TLS. Select the **Client SSL Profile** you created as part of the prerequisites or leave the default whilst testing
267265

268266
![Screenshot for Virtual server](./media/f5-big-ip-easy-button-ldap/virtual-server.png)
269267

@@ -296,21 +294,19 @@ Enabling SSO allows users to access BIG-IP published services without having to
296294
![Screenshot for SSO and HTTP headers](./media/f5-big-ip-easy-button-header/sso-http-headers.png)
297295

298296
>[!NOTE]
299-
> APM session variables defined within curly brackets are CASE sensitive. If you enter EmployeeID when the Azure AD attribute name is being defined as employeeid, it will cause an attribute mapping failure.
297+
>APM session variables defined within curly brackets are CASE sensitive. For example, if you enter OrclGUID when the Azure AD attribute name is being defined as orclguid, it will cause an attribute mapping failure
300298
301299
### Session Management
302300

303-
The BIG-IPs session management settings are used to define the conditions under which user sessions are terminated or allowed to continue, limits for users and IP addresses, and error pages. Consult [F5 documentation](https://support.f5.com/csp/article/K18390492) for details on these settings.
304-
305-
What isn’t covered there however is Single Log-Out (SLO) functionality, which ensures all sessions between the IdP, the BIG-IP, and the client are terminated after a user has logged out.
301+
The BIG-IPs session management settings are used to define the conditions under which user sessions are terminated or allowed to continue, limits for users and IP addresses, and corresponding user info. Refer to [F5's docs](https://support.f5.com/csp/article/K18390492) for details on these settings.
306302

307-
When the Easy Button wizard deploys a SAML application to Azure AD, it also populates the Logout Url with the APM’s SLO endpoint. That way IdP initiated sign-outs from the MyApps portal also terminate the session between the BIG-IP and a client.
303+
What isn’t covered here however is Single Log-Out (SLO) functionality, which ensures all sessions between the IdP, the BIG-IP, and the user agent are terminated as users sign off. When the Easy Button instantiates a SAML application in your Azure AD tenant, it also populates the Logout Url with the APM’s SLO endpoint. That way IdP initiated sign-outs from the Azure AD MyApps portal also terminate the session between the BIG-IP and a client.
308304

309-
During deployment, the SAML applications federation metadata is also imported, providing the APM the SAML logout endpoint for Azure AD. This helps SP initiated sign-outs also terminate the session between a client and Azure AD. But for this to be truly effective, the APM needs to know exactly when a user signs-out.
305+
Along with this the SAML federation metadata for the published application is also imported from your tenant, providing the APM with the SAML logout endpoint for Azure AD. This ensures SP initiated sign outs terminate the session between a client and Azure AD. But for this to be truly effective, the APM needs to know exactly when a user signs-out of the application.
310306

311-
Consider a scenario where the BIG-IP web portal isn’t used, the user has no way of instructing the APM to sign out. Even if the user signs-out of the application itself, the BIG-IP is technically oblivious to this, so the application session could easily be reinstated through SSO. For this reason, SP initiated sign-out needs careful consideration to ensure sessions are securely terminated when no longer required. One way of achieving this would be to add an SLO function to your applications sign out button, so that it can redirect your client to the Azure AD SAML sign-out endpoint. The SAML sign-out endpoint for your tenant can be found in **App Registrations > Endpoints**.
307+
If the BIG-IP webtop portal is used to access published applications then a sign-out from there would be processed by the APM to also call the Azure AD sign-out endpoint. But consider a scenario where the BIG-IP webtop portal isn’t used, then the user has no way of instructing the APM to sign out. Even if the user signs-out of the application itself, the BIG-IP is technically oblivious to this. So for this reason, SP initiated sign-out needs careful consideration to ensure sessions are securely terminated when no longer required. One way of achieving this would be to add an SLO function to your applications sign out button, so that it can redirect your client to either the Azure AD SAML or BIG-IP sign-out endpoint. The URL for SAML sign-out endpoint for your tenant can be found in **App Registrations > Endpoints**.
312308

313-
If making a change to the app is a no go, then consider having the BIG-IP listen for the apps sign-out call, and upon detecting the request have it trigger SLO. More details on using BIG-IP iRules to achieve this is available in the F5 knowledge article [Configuring automatic session termination (logout) based on a URI-referenced file name](https://support.f5.com/csp/article/K42052145) and [Overview of the Logout URI Include option](https://support.f5.com/csp/article/K12056).
309+
If making a change to the app is a no go, then consider having the BIG-IP listen for the application's sign-out call, and upon detecting the request have it trigger SLO. Refer to our [Oracle PeopleSoft SLO guidance](/azure/active-directory/manage-apps/f5-big-ip-oracle-peoplesoft-easy-button.md#peoplesoft-single-logout) for using BIG-IP irules to achieve this. More details on using BIG-IP iRules to achieve this is available in the F5 knowledge article [Configuring automatic session termination (logout) based on a URI-referenced file name](https://support.f5.com/csp/article/K42052145) and [Overview of the Logout URI Include option](https://support.f5.com/csp/article/K12056).
314310

315311
## Summary
316312

0 commit comments

Comments
 (0)