mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-23 15:00:34 +01:00
e261301301
Being able to back up the hsm_secret is critical, but you cannot do this through a UI, because of course we do not allow such access. People have lost funds because they didn't back up. This allows access to the hsm_secret if you use a password set in the config file. (If it's not set, the command does not work). This is a compromise, of course. Changelog-Added: `exposesecret` command for encouraging hsm_secret backups. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
58 lines
1.6 KiB
JSON
58 lines
1.6 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"rpc": "exposesecret",
|
|
"title": "Command for extracting the hsm_secret file for backup",
|
|
"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."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"passphrase"
|
|
],
|
|
"properties": {
|
|
"passphrase": {
|
|
"type": "string",
|
|
"description": [
|
|
"The passphrase, which must match the `exposesecret-passphrase` configuration parameter."
|
|
]
|
|
},
|
|
"identifier": {
|
|
"type": "string",
|
|
"description": [
|
|
"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."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"identifier",
|
|
"codex32"
|
|
],
|
|
"properties": {
|
|
"identifier": {
|
|
"type": "string",
|
|
"description": [
|
|
"The four-character identifier used in the codex32 output. Redundant, but presented separately for clarity."
|
|
]
|
|
},
|
|
"codex32": {
|
|
"type": "string",
|
|
"description": [
|
|
"The full codex32-encoded (i.e. BIP-93 encoded) HSM secret."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"author": [
|
|
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-hsmtool(8)"
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
]
|
|
}
|