Skip to content

Emphasize the use of --expand-commands when using encrypted private key #3011

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

Open
renetapopova wants to merge 3 commits into
base: dev
Choose a base branch
from
+10 −9
Open

Emphasize the use of --expand-commands when using encrypted private key #3011

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fddbd63
Emphasize the use of --expand-commands when using encrypted private key
renetapopova Apr 23, 2026
c0882f1
Apply suggestion from @renetapopova
renetapopova Apr 24, 2026
6dc494e
Apply suggestion from @renetapopova
renetapopova Apr 24, 2026
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: 10 additions & 9 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 @@ -1056,7 +1056,13 @@ dbms.ssl.policy.cluster.private_key_password=<password>
dbms.ssl.policy.backup.private_key_password=<password>
----

If hardcoding of clear text private key password is not feasible due to security constraints, it can be set up to use dynamic password pickup by following these steps:
If hardcoding of clear text private key password is not feasible due to security constraints, it can be set up to use dynamic password pickup.

[IMPORTANT]
====
Using a dynamic command requires Neo4j to be started with the `--expand-commands` option.
For more information, see xref:configuration/command-expansion.adoc[Command expansion].
====

. Create a file containing the `cleartext` password for the private key password and encrypt it with the certificate (assuming private key for cert has password set and certificate is in `pwd`):
+
Expand Down Expand Up @@ -1084,15 +1090,10 @@ To adjust paths to cert and encrypted password file, use full paths:
+
[source]
----
dbms.ssl.policy.bolt.private_key_password=$(base64 -w 0 certificate.crt | openssl aes-256-cbc -a -d -in password.enc -pass stdin)
dbms.ssl.policy.bolt.private_key_password=$(bash -lc 'base64 -w 0 /path/to/certificate.crt | openssl aes-256-cbc -a -d -in /path/to/password.enc -pass stdin'
----

[NOTE]
====
Using a dynamic command requires Neo4j to be started with the `--expand-commands` option.
For more information, see xref:configuration/command-expansion.adoc[Command expansion].
====

+
This example uses `bolt` in `dbms.ssl.policy.bolt.private_key_password`, but depending on what you are trying to do, it can be any of `bolt`, `https`, `cluster`, or `backup`.
==== Using specific cipher

There are cases where Neo4j Enterprise requires the use of specific ciphers for encryptions.
Expand Down