Skip to content

Commit cee3a15

Browse files
committed
doc: change encrypted-hsm to hsm-passphrase
1 parent 6d48966 commit cee3a15

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

doc/lightningd-config.5.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -293,14 +293,29 @@ authenticate with username `user` and password `pass`, and then use the
293293
database `db_name`. The database must exist, but the schema will be managed
294294
automatically by `lightningd`.
295295

296-
* **encrypted-hsm**
297-
298-
If set, you will be prompted to enter a password used to encrypt the `hsm_secret`.
299-
Note that once you encrypt the `hsm_secret` this option will be mandatory for
300-
`lightningd` to start.
301-
If there is no `hsm_secret` yet, `lightningd` will create a new encrypted secret.
302-
If you have an unencrypted `hsm_secret` you want to encrypt on-disk, or vice versa,
303-
see lightning-hsmtool(8).
296+
* **hsm-passphrase**
297+
298+
If set, you will be prompted to enter a passphrase for your HSM secret.
299+
This option supports both legacy 32-byte `hsm_secret` files (where the passphrase
300+
encrypts the secret) and new BIP39 mnemonic-based secrets (where the passphrase
301+
is used as additional entropy during seed derivation according to the BIP39 standard).
302+
303+
Note that once you set a passphrase, this option will be mandatory for
304+
`lightningd` to start. If there is no HSM secret yet, `lightningd` will create
305+
a new mnemonic-based secret that will be secured with your passphrase following
306+
BIP39 specifications.
307+
308+
For legacy users: If you have an existing encrypted `hsm_secret` that was created
309+
with the deprecated `encrypted-hsm` option, this will continue to work seamlessly.
310+
311+
For new mnemonic-based secrets: The passphrase becomes part of the seed derivation
312+
process as specified in BIP39, providing an additional factor of security. The
313+
mnemonic words alone are not sufficient to derive the seed without the passphrase.
314+
315+
If you have an unencrypted legacy `hsm_secret` you want to encrypt, or need to
316+
manage your HSM secrets, see lightning-hsmtool(8).
317+
318+
(Note: This option replaces the deprecated `encrypted-hsm` option.)
304319

305320

306321
* **grpc-host**=*HOST* [plugin `cln-grpc`]

0 commit comments

Comments
 (0)