mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-28 01:24:42 +01:00
Code Issues Projects Releases Wiki Activity
8f6afedafe
core-lightning/doc/lightning-checkmessage.7.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

Minor wording
2021-02-07 17:20:23 +01:00
lightning-checkmessage -- Command to check if a signature is from a node
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
=====================================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**checkmessage** *message* *zbase* [*pubkey*]
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
DESCRIPTION
-----------
The **checkmessage** RPC command is the counterpart to
**signmessage**: given a node id (*pubkey*), signature (*zbase*) and a
*message*, it verifies that the signature was generated by that node
for that message (more technically: by someone who knows that node's
secret).
As a special case, if *pubkey* is not specified, we will try every
known node key (as per *listnodes*), and verification succeeds if it
matches for any one of them. Note: this is implemented far more
efficiently than trying each one, so performance is not a concern.
rpc: checkmessage return an error if pubkey is not found Returning an warning message when the pub key is not specified and there is no node in the graph. We try to help people that use core lightning as a signer and nothings else. Changelog-Deprecated: rpc: checkmessage return an error when the pubkey is not specified and it is unknown in the network graph.
2022-05-24 10:17:27 +02:00
On failure, an error is returned and core lightning exit with the following error code:
- -32602: Parameter missed or malformed;
- 1301: *pubkey* not found in the graph.
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
RETURN VALUE
------------
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
rpc: improve error format Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2022-07-12 11:55:02 +02:00
- **verified** (boolean): whether the signature was valid (always *true*)
- **pubkey** (pubkey): the *pubkey* parameter, or the pubkey found by looking for known nodes
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-signmessage(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 03:33:16 +02:00
test: disable schema check of `checkmessage` with deprecated API Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2022-07-13 11:52:42 +02:00
[comment]: # ( SHA256STAMP:733247e44d555f9c480a684ceb30440f4f33daf5755253249b5c7b9269c96e49)
Reference in New Issue Copy Permalink