Skip to content

Add a tip about needing server and client usage in intra-cluster TLS certificates #1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 20, 2024
Merged

Add a tip about needing server and client usage in intra-cluster TLS certificates #1688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
555aa3a
Add a tip about needing server and client usage in intra-cluster TLS …
nick-giles-neo Jun 19, 2024
58a2f5c
Apply review suggestions
nick-giles-neo Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions modules/ROOT/pages/clustering/setup/encryption.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,25 @@ The generation of xref:security/ssl-framework.adoc#term-ssl-cryptographic-object
It generally requires having a PKI with a xref:security/ssl-framework.adoc#term-ssl-certificate-authority[Certificate Authority (CA)] within the organization and they should be able to advise here.
Note that the information in this manual relating to the PKI is mainly for illustrative purposes.

[TIP]
====
If setting up intra-cluster encryption as part of a cluster configuration, ensure that the certificates used on the cluster endpoint support server and client usage.
This is because when connecting between the Neo4j servers for clustering, each server uses its own certificate to authenticate as a client on the connection to another server.

This could be verified from within the certificate details:

----
openssl x509 -in public.crt -noout -text
----
We should see that the X509v3 Extended Key Usage section shows both the usages listed:

----
X509v3 Extended Key Usage:
TLS Web Server Authentication, TLS Web Client Authentication
----
====


When the certificates and private keys are obtained they can be installed on each of the servers.
Each server has a certificate of its own, signed by a CA, and the corresponding private key.
The certificate of the CA is installed into the `trusted` directory, and any certificate signed by the CA is thus trusted.
Expand Down
18 changes: 18 additions & 0 deletions modules/ROOT/pages/security/ssl-framework.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,24 @@ If the same certificates are used across all instances of the cluster, make sure
Multi-host and wildcard certificates are also supported.
====

[TIP]
====
If setting up intra-cluster encryption as part of a cluster configuration, ensure that the certificates used on the cluster endpoint support server and client usage.
This is because when connecting between the Neo4j servers for clustering, each server uses its own certificate to authenticate as a client on the connection to another server.

This could be verified from within the certificate details:

----
openssl x509 -in public.crt -noout -text
----
We should see that the X509v3 Extended Key Usage section shows both the usages listed:

----
X509v3 Extended Key Usage:
TLS Web Server Authentication, TLS Web Client Authentication
----
====

==== Transformations

Neo4j requires all SSL certificates to be in the `PEM` format.
Expand Down