_ Git - rust-lightning/blob - lightning/src/util/message_signing.rs

   1 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   2 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   3 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   4 // You may not use this file except in accordance with one or both of these
   5 // licenses.
   6
   7 //! Lightning message signing and verification lives here. These tools can be used to sign messages using the node's
   8 //! secret so receivers are sure that they come from you. You can also use this to verify that a given message comes
   9 //! from a specific node.
  10 //! Furthermore, these tools can be used to sign / verify messages using ephemeral keys not tied to node's identities.
  11 //!
  12 //! Note this is not part of the specs, but follows lnd's signing and verifying protocol, which can is defined as follows:
  13 //!
  14 //! signature = zbase32(SigRec(sha256d(("Lightning Signed Message:" + msg)))
  15 //! zbase32 from https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
  16 //! SigRec has first byte 31 + recovery id, followed by 64 byte sig.
  17 //!
  18 //! This implementation is compatible with both lnd's and c-lightning's
  19 //!
  20 //! https://lightning.readthedocs.io/lightning-signmessage.7.html
  21 //! https://api.lightning.community/#signmessage
  22
  23 use crate::util::zbase32;
  24 use bitcoin::hashes::{sha256d, Hash};
  25 use bitcoin::secp256k1::recovery::{RecoverableSignature, RecoveryId};
  26 use bitcoin::secp256k1::{Error, Message, PublicKey, Secp256k1, SecretKey};
  27
  28 static LN_MESSAGE_PREFIX: &[u8] = b"Lightning Signed Message:";
  29
  30 fn sigrec_encode(sig_rec: RecoverableSignature) -> Vec<u8> {
  31     let (rid, rsig) = sig_rec.serialize_compact();
  32     let prefix = rid.to_i32() as u8 + 31;
  33
  34     [&[prefix], &rsig[..]].concat()
  35 }
  36
  37 fn sigrec_decode(sig_rec: Vec<u8>) -> Result<RecoverableSignature, Error> {
  38     let rsig = &sig_rec[1..];
  39     let rid = sig_rec[0] as i32 - 31;
  40
  41     match RecoveryId::from_i32(rid) {
  42         Ok(x) => RecoverableSignature::from_compact(rsig, x),
  43         Err(e) => Err(e)
  44     }
  45 }
  46
  47 /// Creates a digital signature of a message given a SecretKey, like the node's secret.
  48 /// A receiver knowing the PublicKey (e.g. the node's id) and the message can be sure that the signature was generated by the caller.
  49 /// Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
  50 pub fn sign(msg: &[u8], sk: SecretKey) -> Result<String, Error> {
  51     let secp_ctx = Secp256k1::signing_only();
  52     let msg_hash = sha256d::Hash::hash(&[LN_MESSAGE_PREFIX, msg].concat());
  53
  54     let sig = secp_ctx.sign_recoverable(&Message::from_slice(&msg_hash)?, &sk);
  55     Ok(zbase32::encode(&sigrec_encode(sig)))
  56 }
  57
  58 /// Recovers the PublicKey of the signer of the message given the message and the signature.
  59 pub fn recover_pk(msg: &[u8], sig: &str) ->  Result<PublicKey, Error> {
  60     let secp_ctx = Secp256k1::verification_only();
  61     let msg_hash = sha256d::Hash::hash(&[LN_MESSAGE_PREFIX, msg].concat());
  62
  63     match zbase32::decode(&sig) {
  64         Ok(sig_rec) => {
  65             match sigrec_decode(sig_rec) {
  66                 Ok(sig) => secp_ctx.recover(&Message::from_slice(&msg_hash)?, &sig),
  67                 Err(e) => Err(e)
  68             }
  69         },
  70         Err(_) => Err(Error::InvalidSignature)
  71     }
  72 }
  73
  74 /// Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
  75 /// and the PublicKey.
  76 pub fn verify(msg: &[u8], sig: &str, pk: PublicKey) -> bool {
  77     match recover_pk(msg, sig) {
  78         Ok(x) => x == pk,
  79         Err(_) => false
  80     }
  81 }
  82
  83 #[cfg(test)]
  84 mod test {
  85     use std::str::FromStr;
  86     use util::message_signing::{sign, recover_pk, verify};
  87     use bitcoin::secp256k1::key::ONE_KEY;
  88     use bitcoin::secp256k1::{PublicKey, Secp256k1};
  89
  90     #[test]
  91     fn test_sign() {
  92         let message = "test message";
  93         let zbase32_sig = sign(message.as_bytes(), ONE_KEY);
  94
  95         assert_eq!(zbase32_sig.unwrap(), "d9tibmnic9t5y41hg7hkakdcra94akas9ku3rmmj4ag9mritc8ok4p5qzefs78c9pqfhpuftqqzhydbdwfg7u6w6wdxcqpqn4sj4e73e")
  96     }
  97
  98     #[test]
  99     fn test_recover_pk() {
 100         let message = "test message";
 101         let sig = "d9tibmnic9t5y41hg7hkakdcra94akas9ku3rmmj4ag9mritc8ok4p5qzefs78c9pqfhpuftqqzhydbdwfg7u6w6wdxcqpqn4sj4e73e";
 102         let pk = recover_pk(message.as_bytes(), sig);
 103
 104         assert_eq!(pk.unwrap(), PublicKey::from_secret_key(&Secp256k1::signing_only(), &ONE_KEY))
 105     }
 106
 107     #[test]
 108     fn test_verify() {
 109         let message = "another message";
 110         let sig = sign(message.as_bytes(), ONE_KEY).unwrap();
 111         let pk = PublicKey::from_secret_key(&Secp256k1::signing_only(), &ONE_KEY);
 112
 113         assert!(verify(message.as_bytes(), &sig, pk))
 114     }
 115
 116     #[test]
 117     fn test_verify_ground_truth_ish() {
 118         // There are no standard tests vectors for Sign/Verify, using the same tests vectors as c-lightning to see if they are compatible.
 119         // Taken from https://github.com/ElementsProject/lightning/blob/1275af6fbb02460c8eb2f00990bb0ef9179ce8f3/tests/test_misc.py#L1925-L1938
 120
 121         let corpus = [
 122             ["@bitconner",
 123              "is this compatible?",
 124              "rbgfioj114mh48d8egqx8o9qxqw4fmhe8jbeeabdioxnjk8z3t1ma1hu1fiswpakgucwwzwo6ofycffbsqusqdimugbh41n1g698hr9t",
 125              "02b80cabdf82638aac86948e4c06e82064f547768dcef977677b9ea931ea75bab5"],
 126             ["@duck1123",
 127              "hi",
 128              "rnrphcjswusbacjnmmmrynh9pqip7sy5cx695h6mfu64iac6qmcmsd8xnsyczwmpqp9shqkth3h4jmkgyqu5z47jfn1q7gpxtaqpx4xg",
 129              "02de60d194e1ca5947b59fe8e2efd6aadeabfb67f2e89e13ae1a799c1e08e4a43b"],
 130             ["@jochemin",
 131              "hi",
 132              "ry8bbsopmduhxy3dr5d9ekfeabdpimfx95kagdem7914wtca79jwamtbw4rxh69hg7n6x9ty8cqk33knbxaqftgxsfsaeprxkn1k48p3",
 133              "022b8ece90ee891cbcdac0c1cc6af46b73c47212d8defbce80265ac81a6b794931"],
 134         ];
 135
 136         for c in &corpus {
 137             assert!(verify(c[1].as_bytes(), c[2], PublicKey::from_str(c[3]).unwrap()))
 138         }
 139     }
 140 }