From 7ca75261326677623324dc56b28f9eab28b0a7f6 Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Fri, 12 May 2023 10:24:02 +0200 Subject: [PATCH] lnrpc: update description for VerifyMessage Fixes #3596. --- lnrpc/lightning.proto | 6 ++++-- lnrpc/lightning.swagger.json | 2 +- lnrpc/lightning_grpc.pb.go | 12 ++++++++---- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index c0dda1b9e..4241044c8 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -101,8 +101,10 @@ service Lightning { rpc SignMessage (SignMessageRequest) returns (SignMessageResponse); /* lncli: `verifymessage` - VerifyMessage verifies a signature over a msg. The signature must be - zbase32 encoded and signed by an active node in the resident node's + VerifyMessage verifies a signature over a message and recovers the signer's + public key. The signature is only deemed valid if the recovered public key + corresponds to a node key in the public Lightning network. The signature + must be zbase32 encoded and signed by an active node in the resident node's channel database. In addition to returning the validity of the signature, VerifyMessage also returns the recovered pubkey from the signature. */ diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 96617142e..4cef13ebb 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -2740,7 +2740,7 @@ }, "/v1/verifymessage": { "post": { - "summary": "lncli: `verifymessage`\nVerifyMessage verifies a signature over a msg. The signature must be\nzbase32 encoded and signed by an active node in the resident node's\nchannel database. In addition to returning the validity of the signature,\nVerifyMessage also returns the recovered pubkey from the signature.", + "summary": "lncli: `verifymessage`\nVerifyMessage verifies a signature over a message and recovers the signer's\npublic key. The signature is only deemed valid if the recovered public key\ncorresponds to a node key in the public Lightning network. The signature\nmust be zbase32 encoded and signed by an active node in the resident node's\nchannel database. In addition to returning the validity of the signature,\nVerifyMessage also returns the recovered pubkey from the signature.", "operationId": "Lightning_VerifyMessage", "responses": { "200": { diff --git a/lnrpc/lightning_grpc.pb.go b/lnrpc/lightning_grpc.pb.go index 6b85fb3c2..229cb64c4 100644 --- a/lnrpc/lightning_grpc.pb.go +++ b/lnrpc/lightning_grpc.pb.go @@ -73,8 +73,10 @@ type LightningClient interface { // only the message digest and signature are needed for verification. SignMessage(ctx context.Context, in *SignMessageRequest, opts ...grpc.CallOption) (*SignMessageResponse, error) // lncli: `verifymessage` - // VerifyMessage verifies a signature over a msg. The signature must be - // zbase32 encoded and signed by an active node in the resident node's + // VerifyMessage verifies a signature over a message and recovers the signer's + // public key. The signature is only deemed valid if the recovered public key + // corresponds to a node key in the public Lightning network. The signature + // must be zbase32 encoded and signed by an active node in the resident node's // channel database. In addition to returning the validity of the signature, // VerifyMessage also returns the recovered pubkey from the signature. VerifyMessage(ctx context.Context, in *VerifyMessageRequest, opts ...grpc.CallOption) (*VerifyMessageResponse, error) @@ -1375,8 +1377,10 @@ type LightningServer interface { // only the message digest and signature are needed for verification. SignMessage(context.Context, *SignMessageRequest) (*SignMessageResponse, error) // lncli: `verifymessage` - // VerifyMessage verifies a signature over a msg. The signature must be - // zbase32 encoded and signed by an active node in the resident node's + // VerifyMessage verifies a signature over a message and recovers the signer's + // public key. The signature is only deemed valid if the recovered public key + // corresponds to a node key in the public Lightning network. The signature + // must be zbase32 encoded and signed by an active node in the resident node's // channel database. In addition to returning the validity of the signature, // VerifyMessage also returns the recovered pubkey from the signature. VerifyMessage(context.Context, *VerifyMessageRequest) (*VerifyMessageResponse, error)