lightning-exposesecret -- Command for extracting the hsm_secret file for backup
SYNOPSIS
exposesecret passphrase [identifier]
DESCRIPTION
The exposesecret RPC command allows you to read the HSM secret, and does not work with encrypted hsm secrets. It only operates if the exposesecret-passphrase
has been set in the configuration.
- passphrase (string): The passphrase, which must match the
exposesecret-passphrase
configuration parameter. - identifier (string, optional): A four-character, valid lowercase bech32 string (not 1, i, o or b) to use in the resulting BIP-93 output. If not specified, this is generated from the node alias.
RETURN VALUE
On success, an object is returned, containing:
- identifier (string): The four-character identifier used in the codex32 output. Redundant, but presented separately for clarity.
- codex32 (string): The full codex32-encoded (i.e. BIP-93 encoded) HSM secret.
AUTHOR
Rusty Russell <[email protected]> is mainly responsible.
SEE ALSO
lightning-hsmtool(8)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning
EXAMPLES
Example 1:
Request:
lightning-cli exposesecret -k "passphrase"="test_exposesecret"
{
"id": "example:exposesecret#1",
"method": "exposesecret",
"params": {
"passphrase": "test_exposesecret"
}
}
Response:
{
"identifier": "luea",
"codex32": "cl10lueasd35kw6r5de5kueedxyesqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqanvrktzhlhusz"
}
Example 2:
Request:
lightning-cli exposesecret "test_exposesecret" "cln2"
{
"id": "example:exposesecret#2",
"method": "exposesecret",
"params": [
"test_exposesecret",
"cln2"
]
}
Response:
{
"identifier": "cln2",
"codex32": "cl10cln2sd35kw6r5de5kueedxyesqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqn9lcvcu7cez4s"
}