Skip to content

Commit 4abf59a

Browse files
authored
document turning on showSSLExceptions (#1950)
* document turning on showSSLExceptions * document turning on showSSLExceptions
1 parent 9bbb2b1 commit 4abf59a

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

distribution/examples/security/ssl-tls/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,12 @@
44
|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
55
| [to-backend](to-backend) | How to secure communication from the API Gateway to a backend server. |
66
| [api-with-tls-pkcs12](api-with-tls-pkcs12) | How to protect APIs deployed on the Gateway with TLS certificates (using a keystore in the PKCS12 format)" |
7-
| [api-with-tls-pem](api-with-tls-pem) | How to protect APIs deployed on the Gateway with TLS certificates (using PEM formatted files for the key and the certificate) |
7+
| [api-with-tls-pem](api-with-tls-pem) | How to protect APIs deployed on the Gateway with TLS certificates (using PEM formatted files for the key and the certificate) |
8+
9+
# SSL/TLS Errors
10+
Depending on your use case for Membrane API Gateway, you may or may not want to set `<ssl showSSLExceptions="false">` (default) or `<ssl showSSLExceptions="true">`.
11+
12+
In case you are setting up your keys and certificates for the first time, or you are searching for TLS misconfigurations,
13+
we advise `<ssl showSSLExceptions="true">`. This is why all examples in this folder have this setting.
14+
15+
But when Membrane API Gateway is directly exposed to the internet on port 443, you most probably want to turn it off because too much "SPAM" is arriving.

distribution/examples/security/ssl-tls/api-with-tls-pem/proxies.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<router>
88

99
<api port="443">
10-
<ssl>
10+
<ssl showSSLExceptions="true">
1111
<!-- Please replace key and certificate for production! -->
1212
<key>
1313
<private location="membrane-key.pem" />

distribution/examples/security/ssl-tls/api-with-tls-pkcs12/proxies.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<router>
88

99
<serviceProxy port="443">
10-
<ssl>
10+
<ssl showSSLExceptions="true">
1111
<!-- Please replace keystore for production! -->
1212
<keystore location="../../../../conf/membrane.p12" password="secret" keyPassword="secret" />
1313
<truststore location="../../../../conf/membrane.p12" password="secret" />

distribution/examples/security/ssl-tls/to-backend/proxies.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<api port="2000">
1010
<target host="api.predic8.de" port="443">
11-
<ssl/>
11+
<ssl showSSLExceptions="true" />
1212
</target>
1313
</api>
1414

0 commit comments

Comments
 (0)