Skip to content

Commit c0f0ad3

Browse files
authored
Merge pull request #6040 from ashanthamara/patch-2
Add documentation regarding the configuration to use the truststore for self signed certificates when invoking actions
2 parents 36e9175 + 72e6a1f commit c0f0ad3

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

en/includes/guides/service-extensions/in-flow-extensions/custom-authentication.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,28 @@ The following are some troubleshooting steps that you may take to resolve issues
174174
2. Confirm that the request and response payloads conform to the expected formats as defined by the [REST API contract]({{base_path}}/references/service-extensions/in-flow-extensions/custom-authentication/api-contract).
175175
3. Use diagnostic logs to capture detailed information during the troubleshooting process. For more information refer to the [troubleshooting guide here]({{base_path}}/guides/service-extensions/understanding-service-extensions/#troubleshooting).
176176

177+
{% if product_name == "WSO2 Identity Server" %}
178+
4. If your external service uses a self-signed certificate, ensure the certificate is imported into the WSO2 Carbon truststore. By default, {{product_name}} uses the WSO2 Carbon truststore at `<IS_HOME>/repository/resources/security/client-truststore.jks`.
179+
180+
{% if is_version <= "7.2.0" %}
181+
Add the following configuration to the `deployment.toml` file and restart the server:
182+
183+
```toml
184+
[actions.http_client]
185+
use_carbon_truststore = true
186+
```
187+
188+
{% if is_version == "7.1.0" %}
189+
!!! note
190+
This configuration is available from the update level: **`7.1.0.60`**.
191+
{% elif is_version == "7.2.0" %}
192+
!!! note
193+
This configuration is available from the update level: **`7.2.0.19`**.
194+
{% endif %}
195+
196+
{% endif %}
197+
{% endif %}
198+
177199
## Custom authentication API deep dive
178200

179201
This section delves into the specifics of the custom authentication API, providing a detailed look at the requests {{product_name}} sends to your external authentication service and the responses it expects. Understanding these interactions is crucial for successfully implementing and integrating your custom authenticator.
@@ -669,6 +691,7 @@ Content-Type: application/json
669691
Currently, the <code>errorMessage</code> or <code>errorDescription</code> from the external service’s <code>ERROR</code> response isn't directly included in the error response sent back to the application.
670692

671693
{% if (product_name == "WSO2 Identity Server" and is_version > "7.2.0" ) %}
694+
672695
## Custom authentication with app-native authentication
673696

674697
You can configure custom authentication services in app-native authentication flows, which authenticate users through API-based mechanisms instead of redirecting them to a web browser.

en/includes/guides/service-extensions/pre-flow-extensions/setting-up-actions.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,25 @@ Try these troubleshooting steps to resolve issues.
133133
1. Check that your external service runs without errors and responds to requests from {{product_name}}.
134134

135135
2. Confirm that the request and response payloads conform to the expected formats as defined by the REST API contract.
136+
137+
{% if product_name == "WSO2 Identity Server" %}
138+
3. If your external service uses a self-signed certificate, ensure the certificate is imported into the WSO2 Carbon truststore. By default, {{product_name}} uses the WSO2 Carbon truststore at `<IS_HOME>/repository/resources/security/client-truststore.jks`.
139+
140+
{% if is_version <= "7.2.0" %}
141+
Add the following configuration to the `deployment.toml` file and restart the server:
142+
143+
```toml
144+
[actions.http_client]
145+
use_carbon_truststore = true
146+
```
147+
148+
{% if is_version == "7.1.0" %}
149+
!!! note
150+
This configuration is available from the update level: **`7.1.0.60`**.
151+
{% elif is_version == "7.2.0" %}
152+
!!! note
153+
This configuration is available from the update level: **`7.2.0.19`**.
154+
{% endif %}
155+
156+
{% endif %}
157+
{% endif %}

0 commit comments

Comments
 (0)