Configuring Inbound Authentication for a Service Provider

1. Expand the SAML2 Web SSO Configuration and click Configure.
2. Select one of the following modes:
   
   • Manual configuration
   • Metadata file configuration
   • URL configuration

Manual configuration

1. Select Manual Configuration and fill in the form that appears.
   
2. Click Register.

The following points should be taken into consideration when filling the above New Service Provider form. 

Metadata file configuration

This option allows you to provide the configuration data required for configuring SAML2, by uploading a metadata .xml file instead of having to manually enter the values. This enables faster entry of configuration data and allows the user to use the same metadata XML file for multiple instances of entity configuration. 

1. Select Metadata File Configuration.
   
2. Click Choose File, and select the .xml file containing the metadata for the service provider SAML configuration. 
   

3. Click Upload. 

    Click here to view a sample of the metadata configuration file

   Service provider metadata file

   <EntityDescriptor
   xmlns="urn:oasis:names:tc:SAML:2.0:metadata"
   entityID="sample.com">
   <SPSSODescriptor
   AuthnRequestsSigned="false"
   WantAssertionsSigned="false"
   protocolSupportEnumeration= "urn:oasis:names:tc:SAML:2.0:protocol">
   <KeyDescriptor use="signing">
   <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#">
   <X509Data>
   <X509Certificate>
   
   
   MIIC+jCCAmOgAwIBAgIJAParOnPwEkKjMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYD
   VQQGEwJMSzEQMA4GA1UECBMHV2VzdGVybjEQMA4GA1UEBxMHQ29sb21ibzEWMBQG
   A1UEChMNU29mdHdhcmUgVmlldzERMA8GA1UECxMIVHJhaW5pbmcxLDAqBgNVBAMT
   I1NvZnR3YXJlIFZpZXcgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTEwMDcxMDA2
   MzMwM1oXDTI0MDMxODA2MzMwM1owdjELMAkGA1UEBhMCTEsxEDAOBgNVBAgTB1dl
   c3Rlcm4xEDAOBgNVBAcTB0NvbG9tYm8xFjAUBgNVBAoTDVNvZnR3YXJlIFZpZXcx
   ETAPBgNVBAsTCFRyYWluaW5nMRgwFgYDVQQDEw9NeSBUZXN0IFNlcnZpY2UwgZ8w
   DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAN6bi0llFz+R+93nLLK5BmnuF48tbODp
   MBH7yGZ1/ESVUZoYm0GaPzg/ai3rX3r8BEr4TUrhhpKUKBpFxZvb2q+yREIeDEkD
   bHJuyVdS6hvtfa89WMJtwc7gwYYkY8AoVJ94gU54GP2B6XyNpgDTXPd0d3aH/Zt6
   69xGAVoe/0iPAgMBAAGjezB5MAkGA1UdEwQCMAAwHQYDVR0OBBYEFNAwSamhuJSw
   XG0SJnWdIVF1PkW9MB8GA1UdIwQYMBaAFNa3YmhDO7BOwbUqmYU1k/U6p/UUMCwG
   CWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTANBgkq
   hkiG9w0BAQUFAAOBgQBwwC5H+U0a+ps4tDCicHQfC2SXRTgF7PlAu2rLfmJ7jyoD
   X+lFEoWDUoE5qkTpMjsR1q/+2j9eTyi9xGj5sby4yFvmXf8jS5L6zMkkezSb6QAv
   tSHcLfefKeidq6NDBJ8DhWHi/zvC9YbT0KkCToEgvCTBpRZgdSFxTJcUksqoFA==
   
   
   </X509Certificate>
   </X509Data>
   </KeyInfo>
   </KeyDescriptor>
   <KeyDescriptor use="encryption">
   <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#">
   <X509Data>
   <X509Certificate>
   
   
   MIIC+jCCAmOgAwIBAgIJAParOnPwEkKjMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYD
   VQQGEwJMSzEQMA4GA1UECBMHV2VzdGVybjEQMA4GA1UEBxMHQ29sb21ibzEWMBQG
   A1UEChMNU29mdHdhcmUgVmlldzERMA8GA1UECxMIVHJhaW5pbmcxLDAqBgNVBAMT
   I1NvZnR3YXJlIFZpZXcgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTEwMDcxMDA2
   MzMwM1oXDTI0MDMxODA2MzMwM1owdjELMAkGA1UEBhMCTEsxEDAOBgNVBAgTB1dl
   c3Rlcm4xEDAOBgNVBAcTB0NvbG9tYm8xFjAUBgNVBAoTDVNvZnR3YXJlIFZpZXcx
   ETAPBgNVBAsTCFRyYWluaW5nMRgwFgYDVQQDEw9NeSBUZXN0IFNlcnZpY2UwgZ8w
   DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAN6bi0llFz+R+93nLLK5BmnuF48tbODp
   MBH7yGZ1/ESVUZoYm0GaPzg/ai3rX3r8BEr4TUrhhpKUKBpFxZvb2q+yREIeDEkD
   bHJuyVdS6hvtfa89WMJtwc7gwYYkY8AoVJ94gU54GP2B6XyNpgDTXPd0d3aH/Zt6
   69xGAVoe/0iPAgMBAAGjezB5MAkGA1UdEwQCMAAwHQYDVR0OBBYEFNAwSamhuJSw
   XG0SJnWdIVF1PkW9MB8GA1UdIwQYMBaAFNa3YmhDO7BOwbUqmYU1k/U6p/UUMCwG
   CWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTANBgkq
   hkiG9w0BAQUFAAOBgQBwwC5H+U0a+ps4tDCicHQfC2SXRTgF7PlAu2rLfmJ7jyoD
   X+lFEoWDUoE5qkTpMjsR1q/+2j9eTyi9xGj5sby4yFvmXf8jS5L6zMkkezSb6QAv
   tSHcLfefKeidq6NDBJ8DhWHi/zvC9YbT0KkCToEgvCTBpRZgdSFxTJcUksqoFA==
   
   
   </X509Certificate>
   </X509Data>
   </KeyInfo>
   <EncryptionMethod Algorithm= "https://www.w3.org/2001/04/xmlenc#aes128-cbc">
   <KeySize xmlns="https://www.w3.org/2001/04/xmlenc#">128</KeySize>
   </EncryptionMethod>
   </KeyDescriptor>
   <SingleLogoutService
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
   Location="https:/sample.com:3443/federation/SPSloRedirect/metaAlias/sp"
   ResponseLocation="https://sample.com:3443/
   federation/SPSloRedirect/metaAlias/sp"/>
   <SingleLogoutService
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"
   Location="https://sample.com:3443/federation/SPSloSoap/metaAlias/sp"/>
   <ManageNameIDService
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
   Location="https://sample.com:3443/federation/SPMniRedirect/metaAlias/sp" 
   ResponseLocation="https://sample.com:3443/federation/SPMniRedirect/metaAlias/sp"/>
   <ManageNameIDService
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"
   Location="https:/sample.com:3443/federation/SPMniSoap/metaAlias/sp"
   ResponseLocation="https://sample.com:3443/federation/SPMniSoap/metaAlias/sp"/>
   <NameIDFormat>
   urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
   </NameIDFormat>
   <NameIDFormat>
   urn:oasis:names:tc:SAML:2.0:nameid-format:transient
   </NameIDFormat>
   <AssertionConsumerService
   isDefault="true"
   index="0"
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"
   Location="https://sample.com:3443/federation/Consumer/metaAlias/sp"/>
   <AssertionConsumerService
   index="1"
   Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
   Location="https://sample.com:3443/federation/Consumer/metaAlias/sp"/>
   </SPSSODescriptor>
   </EntityDescriptor>

URL configuration

Metadata for a service provider may be published in a well known location via a URI. This option allows you to provide the configuration data required for configuring SAML2, by providing a URI(Ex: "https://spconfigs.com/sample-sp.xml") instead of having to manually enter the values. This enables faster entry of configuration data and allows the user to use the same metadata XML file for multiple instances of entity configuration. 

1. Select URL Configuration and enter the URL containing the service provider metadata. 
   
2. Click Upload. 
   

OAuth 2.0 has three main phases. They are;  requesting an Authorization Grant,  exchanging the Authorization Grant for an Access Token and accessing the resources using this Access Token.  OpenID Connect is another identity layer on top of OAuth 2.0. OAuth applications can get authentication event information over the IDToken and can get the extra claims of the authenticated user from the OpenID Connect UserInfo endpoint.

To enable OAuth support for your client application, you must first register your application. Follow the instructions below to add a new application.

1. Expand the Inbound Authentication Configuration section and then expand OAuth/OpenID Connect Configuration. Click Configure.

2. Fill in the form that appears. For the Allowed Grant Types you can disable the ones you do not require or wish to block.

   Note: The grant type highlighted below is a custom grant type. This will only appear on the UI if you have configured the JWT grant type. The value specified in the <GrantTypeName> property of the identity.xml file when creating the custom grant type is the value that will appear on the UI. For more information on writing a custom grant type, see Writing a Custom OAuth 2.0 Grant Type.

   
   When filling out the New Application form, the following details should be taken into consideration.

   Field	Notes
   OAuth Version	Selecting OAuth Version as 1.0a removes all the configurable Allowed Grant Types. This is because this version of OAuth does not support grant types.
   Callback Url	This is the exact location in the service provider's application where an access token would be sent. This is a required field (if the grant type is anything other than 'Code' or 'Implicit') and it is important to configure, as it is imperative that the service provider receives the access token. This is necessary for security purposes to ensure that the token is not compromised. Configure multiple callback URLs From IS 5.2.0 onwards, regex based consumer URLs are supported when defining the callback URL. This enables you to configure multiple callback URLs for one application by entering a regex pattern as the value for the callback URL field. For example, if you have two service providers that use the same application, you can now define a regex pattern which will work for both callback URLs instead of having to configure two different applications for the two service providers. Assume the two callback URLs for your two service providers are as follows: https://myapp.com/callback https://testapp:8080/callback To configure the callback URL to work for both of these URLs, set it using a regex pattern as follows: regexp=(https://myapp.com/callback|https://testapp:8000/callback) To send a request with multiple callback URLs, click here. You must have the prefix 'regexp=' before your regex pattern. To define a normal URL, you can specify the callback URL without this prefix. You can also configure a regex pattern that contains dynamic values as seen below regexp=https://mchcon.clance.local\?id=(.*)
   Allowed Grant Types - The following are the grant types that are used to get the access token:
   Code	Entering the user name and password required at the service provider will result in a code being generated. This code can be used to obtain the access token. For more information on this grant type, see this Authorization Code specification.
   Implicit	This is similar to the code grant type, but instead of generating a code, this directly provides the access token. For more information on this grant type, see this Implicit Grant specification.
   Password	This authenticates the user using the password provided and the access token is provided. For more information on this grant type, see this Resource Owner Password Credentials Grant specification.
   Client Credential	This is the grant type for the client key and client secret. If these two items are provided correctly by the service provider, the access token is sent. For more information on this grant type, see this Client Credentials specification.
   Refresh Token	This will enable the user to obtain an access token by using the refresh token once the originally provided access token is used up. For more information on this grant type, see this Refresh Token specification.
   SAML	This uses SAML assertion to obtain the access token. For more information on this grant type, see this SAML2 Bearer specification.
   IWA-NTLM	This is similar to the password grant type, but it is specific to Microsoft Windows users.
   urn:ietf:params:oauth: grant-type:jwt-bearer	This is a custom grant type. It uses a JWT token to obtain the access token. For more information about this grant type, see this JWT specification.
   PKCE Mandatory	Select this if you are using the Code grant type. PKCE is a recommended security measure used to mitigate a code interception attack. See Mitigating Authorization Code Interception Attacks for more information.
   Support PKCE 'Plain' Transform Algorithm	Select this if you are using PKCE.

   

3. Click Add. The following information is added for your service provider.
   
   • OAuth Client Key - This is the client key of the service provider, which will be checked for authentication by the Identity Server before providing the access token.
   • OAuth Client Secret - This is the client secret of the service provider, which will be checked for authentication by the Identity Server before providing the access token. Click the Show button to view the exact value of this.
   • Actions - 

     • Edit: Click to edit the OAuth/OpenID Connect Configurations

     • Revoke: Click to revoke (deactivate) the OAuth application. This action revokes all tokens issued for this application. In order to activate the application, you have to regenerate the consumer secret. 

     • Regenerate Secret: Click to regenerate the secret key of the OAuth application. 

     • Delete: Click to delete the OAuth/OpenID Connect Configurations.

   Tip: The OAuth client key and client secret are stored in plain text. To encrypt the client secret, access token and refresh token, do the following:

   Open the identity.xml file found in the <IS_HOME>/repository/conf/identity directory and change the <TokenPersistenceProcessor> property as follows:

   <TokenPersistenceProcessor>org.wso2.carbon.identity.oauth.tokenprocessor.EncryptionDecryptionPersistenceProcessor</TokenPersistenceProcessor>

   After updating the configuration, make sure to restart the server for the changes to be applied on WSO2 IS.

   WSO2 Identity Server enables defining OAuth token validity periods for all OAuth service providers as well as for a particular service provider.  

   • To learn how to configure the token validity periods for all service providers, see OAuth Token Validity Period.
     
   • To learn how to configure the token validity periods of each service provider, see Configuring OAuth Token Validity Period for a Service Provider.

WSO2 Identity Server's passive security token service (Passive STS) is used as the WS-Federation implementation. The Passive STS is capable of issuing SAML 1.1 and 2.0 security tokens.

Configuring passive STS

1. See here for details on adding a service provider. 

2. Expand the Inbound Authentication Configuration followed by the WS-Federation (Passive) Configuration section and provide the following values. 

   • Passive STS Realm - This should be an unique identifier for the web app. Provide the same realm name given to the web app you are configuring WS-Federation for.

   • Passive STS WReply URL - Provide the URL of the web app you are configuring WS-Federation for.  This endpoint URL will handle the token response.

     Tip

     If you want to configure an expiration time for the security token, you need to add the following configuration in the <IS_HOME>/repository/conf/carbon.xml file, under the <Server> element:

     <STSTimeToLive>1800000</STSTimeToLive>

     Here, the expiration time should be specified in milliseconds.

     

3. Expand the Claim Configuration section and map the relevant claims. See Configuring Claims for a Service Provider for more information. 
4. Click Update to save changes. 

<STSSignatureAlgorithm>http://www.w3.org/2001/04/xmldsig-more#rsa-sha256</STSSignatureAlgorithm>
<STSDigestAlgorithm>http://www.w3.org/2001/04/xmlenc#sha256</STSDigestAlgorithm>

WSO2 Identity Server's security token service (STS) is used as the WS-Trust implementation. The STS is capable of issuing SAML 1.1 and 2.0 security tokens and has a SOAP/XML API for token issuance. This API can be secured with the UserNameToken or with any other WS-Security mechanism as explained below. 

Securing the Security Token Service

According to the Trust Brokering model defined in the WS-Trust specification, the users should authenticate themselves to the STS before obtaining a token. STS may use this authentication information when constructing the security token. For example, STS may populate the required claims based on the user name provided by the subject. Therefore, the STS service needs to be secured.

STS is configured under the Resident Identity Provider section of the Identity Server Management Console. Follow the instructions below to secure the Security Token Service by logging into the management console.

1. Log in as an admin to access the management console.
2. Configure the Resident Identity Provider. See here for more detailed information on how to do this.
3. In the Resident Identity Provider page, expand the Inbound Authentication Configuration section along with the Security Token Service Configuration section.
4. Click Apply Security Policy.
   

5. Select Yes in the Enable Security? dropdown and select a pre-configured security scenario according to your requirements. In this case, we will use UsernameToken under the Basic Scenarios section. 
   

   You can find further details about the security policy scenarios from the view scenario option.

   

6. Click Next.

   Next steps may vary as per the security scenario that you have chosen under point (5) above. Below, is for UsernameToken scenario.

7. Select ALL-USER-STORE-DOMAINS from the drop-down.

8. In the resulting page, select the role you created, to grant permission to access secured service. In this example, admin role is used. Next, click Finish.

   The Select Domain drop-down lists many domains. The listed User Groups can vary depending on the domain selected.

   
   

9. Click Ok on the confirmation dialog window that appears.
10. Click Update to complete the process.

Now, STS is configured and secured with a username and password. Only the users with the Admin role can consume the service.

The next step is to add a service provider to consume the STS.

Adding a service provider for the STS client

Do the following steps if you are using a Holder of Key subject confirmation method. See Configuring STS for Obtaining Tokens with Holder-Of-Key Subject Confirmation for more information.

1. See Configuring a Service Provider for details on adding a service provider. 
2. Expand the Inbound Authentication Configuration section and the WS-Trust Security Token Service Configuration section. Click Configure.
   

3. In the resulting screen, enter the trusted relying party's endpoint address that is the endpoint address of the Security Token Service. For more information, see Broker Trust Relationship with WSO2 Identity Server and upload the public certificate of the trusted relying party. 

   You need to add the certificate of the relying party to the truststore. For more information on how to create the certificate and add it to the truststore, see here.

   The endpoint must be used as the service URL to which the token gets delivered by the STS client. Then select the public certificate imported. Tokens issued are encrypted using the public certificate of the trusted relying party. Therefore, the consumer who obtains this token, to invoke the RP service won't be able to see the token. 
   

4. Click Update to save the changes made to the service provider.

   Related Topics

   Run the STS client after configuring the service provider. See Running an STS Client to try out a sample STS client.