Skip to content

Commit 1696ac7

Browse files
committed
made recommended edits to ssl pages
1 parent 5a338f7 commit 1696ac7

File tree

2 files changed

+10
-29
lines changed

2 files changed

+10
-29
lines changed

modules/ROOT/pages/security/ssl-fips-compatibility.adoc

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,17 @@
66

77
Federal Information Processing Standards (FIPS) 140 is a U.S. government standard established by the National Institute of Standards and Technology (NIST) which is used to accredit cryptographic modules such as those used in TLS network encryption. While FIPS 140 compliance is primarily required for federal agencies and their contractors, it also is used in the healthcare sector under regulations like the Health Insurance Portability and Accountability Act (HIPAA) to protect patient data.
88

9-
For more information see:
10-
11-
* https://cloudsecurityalliance.org/blog/2023/03/23/what-is-fips-140-and-what-does-it-mean-to-be-fips-compliant
12-
* https://csrc.nist.gov/pubs/fips/140-2/upd2/final
13-
14-
This is a guide to help configure Neo4j to use TLS / SSL encryption in a FIPS compatible way.
9+
This is a guide to help configure Neo4j to use TLS / SSL encryption in a FIPS-compatible way.
1510
It is supplementary to the xref:security/ssl-framework.adoc[] documentation, as many of the configuration processes and requirements are the same.
1611

17-
// . Enable a FIPS certified cryptographic provider
18-
// . Generate SSL certificate and private key xref:security/ssl-framework.adoc#ssl-certificates[instructions]
19-
// . Configure Neo4j to use SSL for all network connections xref:security/ssl-framework.adoc#ssl-configuration[]
20-
// . Setup a non-native authentication provider, for example LDAP or SSO. xref:authentication-authorization/index.adoc[]
21-
// . verify?
22-
2312

2413
== Prerequisites
2514

26-
* Verify that the machine running Neo4j has FIPS compatible hardware and operating system.
15+
* Verify that the machine running Neo4j has FIPS-compatible hardware and operating system.
2716
Only xref:installation/requirements.adoc#deployment-requirements-software[Linux operating systems] are supported for Neo4j FIPS compatibility at this time.
2817
* Neo4j Enterprise 5.23.0 or later.
2918
* Install and configure a non-native authentication provider, for example LDAP or SSO. See xref:authentication-authorization/index.adoc[].
30-
// * Follow the xref:security/checklist.adoc[] to ensure good security practices.
19+
3120

3221
== Enable FIPS SSL Provider (Docker)
3322

@@ -102,7 +91,7 @@ dnf install -y apr
10291

10392
=== Install OpenSSL
10493

105-
Instructions on how to build and install a FIPS compatible OpenSSL are out of scope for this document. Installation steps can differ depending on operating system, and other security requirements you might have for OpenSSL.
94+
Instructions on how to build and install a FIPS-compatible OpenSSL are out of scope for this document. Installation steps can differ depending on operating system, and other security requirements you might have for OpenSSL.
10695

10796
In general:
10897

@@ -112,14 +101,6 @@ In general:
112101
+
113102
See: https://docs.openssl.org/master/man7/fips_module/
114103

115-
OpenSSL documentation can be found at:
116-
117-
* https://openssl-library.org/
118-
119-
and on the project's Github page:
120-
121-
* https://github.com/openssl/openssl
122-
123104

124105
=== Install correct `netty-tcnative` library
125106

@@ -166,16 +147,16 @@ unzip -d /tmp <NEO4J_LIB>/netty-tcnative/netty-tcnative-*-linux-$(arch)-fedora.j
166147
ldd /tmp/META-INF/native/libnetty_tcnative_linux_$(arch).so
167148
rm -rf /tmp/META-INF
168149
----
169-
The `ldd` command will show a list of library dependencies and where they will be loaded from on the local machine.
170-
** If any dependencies are missing, they must be installed or Neo4j will fail to run.
150+
The `ldd` command shows a list of library dependencies and where they are loaded from on the local machine.
151+
** If any dependencies are missing, they must be installed, or Neo4j will fail to run.
171152
** The `libssl.so` and `libcrypto.so` libraries listed must be the ones installed with OpenSSL in the previous steps.
172153
+
173-
. Copy the verified jar to _<NEO4J_LIB>_.
154+
. Copy the verified JAR file to _<NEO4J_LIB>_.
174155
+
175156
[NOTE]
176157
====
177-
Only copy *one* of the jars, otherwise Neo4j will not be able to resolve dependencies at runtime.
178-
The error, if this happens, will contain a message like:
158+
Only copy *one* of the JAR files. Otherwise Neo4j will not be able to resolve dependencies at runtime.
159+
In case of this error, you will get a message like:
179160
[source]
180161
----
181162
"Failed to load any of the given libraries: [netty_tcnative_linux_x86_64, netty_tcnative_linux_x86_64_fedora, netty_tcnative_x86_64, netty_tcnative]".

modules/ROOT/pages/security/ssl-framework.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Each version of Neo4j ships with a version of Netty, and Netty requires a specif
2020

2121
Follow these steps to use OpenSSL:
2222

23-
* Install a suitable `netty-tcnative` dependency into the `plugins/` folder of Neo4j.
23+
* Install a suitable `netty-tcnative` dependency into the `plugins/` directory of Neo4j.
2424
** Dependencies can be downloaded from https://netty.io/wiki/forked-tomcat-native.html.
2525
** Which `netty-tcnative` version you need depends upon the Neo4j version.
2626
For versioning details, see the <<table, Netty support per Neo4j version>> table.

0 commit comments

Comments
 (0)