core-lightning/hsmd/hsm_wire.csv

1	# Clients should not give a bad request but not the HSM's decision to crash.
2	msgtype,hsmstatus_client_bad_request,1000
3	msgdata,hsmstatus_client_bad_request,id,node_id,
4	msgdata,hsmstatus_client_bad_request,description,wirestring,
5	msgdata,hsmstatus_client_bad_request,len,u16,
6	msgdata,hsmstatus_client_bad_request,msg,u8,len
7	#include <bitcoin/chainparams.h>
8	# Start the HSM.
9	msgtype,hsm_init,11
10	msgdata,hsm_init,bip32_key_version,bip32_key_version,
11	msgdata,hsm_init,dev_force_privkey,?privkey,
12	msgdata,hsm_init,dev_force_bip32_seed,?secret,
13	msgdata,hsm_init,dev_force_channel_secrets,?secrets,
14	msgdata,hsm_init,dev_force_channel_secrets_shaseed,?sha256,
15	#include <common/bip32.h>
16	msgtype,hsm_init_reply,111
17	msgdata,hsm_init_reply,node_id,node_id,
18	msgdata,hsm_init_reply,bip32,ext_key,
19	# Get a new HSM FD, with the specified capabilities
20	msgtype,hsm_client_hsmfd,9
21	# Which identity to use for requests
22	msgdata,hsm_client_hsmfd,id,node_id,
23	# Database id for this client, if any.
24	msgdata,hsm_client_hsmfd,dbid,u64,
25	msgdata,hsm_client_hsmfd,capabilities,u64,
26	# No content, just an fd.
27	msgtype,hsm_client_hsmfd_reply,109
28	#include <common/derive_basepoints.h>
29	# Get the basepoints and funding key for this specific channel.
30	msgtype,hsm_get_channel_basepoints,10
31	msgdata,hsm_get_channel_basepoints,peerid,node_id,
32	msgdata,hsm_get_channel_basepoints,dbid,u64,
33	msgtype,hsm_get_channel_basepoints_reply,110
34	msgdata,hsm_get_channel_basepoints_reply,basepoints,basepoints,
35	msgdata,hsm_get_channel_basepoints_reply,funding_pubkey,pubkey,
36	# Return signature for a funding tx.
37	#include <common/utxo.h>
38	# FIXME: This should also take their commit sig & details, to verify.
39	msgtype,hsm_sign_funding,4
40	msgdata,hsm_sign_funding,satoshi_out,amount_sat,
41	msgdata,hsm_sign_funding,change_out,amount_sat,
42	msgdata,hsm_sign_funding,change_keyindex,u32,
43	msgdata,hsm_sign_funding,our_pubkey,pubkey,
44	msgdata,hsm_sign_funding,their_pubkey,pubkey,
45	msgdata,hsm_sign_funding,num_inputs,u16,
46	msgdata,hsm_sign_funding,inputs,utxo,num_inputs
47	msgtype,hsm_sign_funding_reply,104
48	msgdata,hsm_sign_funding_reply,tx,bitcoin_tx,
49	# Master asks the HSM to sign a node_announcement
50	msgtype,hsm_node_announcement_sig_req,6
51	msgdata,hsm_node_announcement_sig_req,annlen,u16,
52	msgdata,hsm_node_announcement_sig_req,announcement,u8,annlen
53	msgtype,hsm_node_announcement_sig_reply,106
54	msgdata,hsm_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
55	# Sign a withdrawal request
56	msgtype,hsm_sign_withdrawal,7
57	msgdata,hsm_sign_withdrawal,satoshi_out,amount_sat,
58	msgdata,hsm_sign_withdrawal,change_out,amount_sat,
59	msgdata,hsm_sign_withdrawal,change_keyindex,u32,
60	msgdata,hsm_sign_withdrawal,scriptpubkey_len,u16,
61	msgdata,hsm_sign_withdrawal,scriptpubkey,u8,scriptpubkey_len
62	msgdata,hsm_sign_withdrawal,num_inputs,u16,
63	msgdata,hsm_sign_withdrawal,inputs,utxo,num_inputs
64	msgtype,hsm_sign_withdrawal_reply,107
65	msgdata,hsm_sign_withdrawal_reply,tx,bitcoin_tx,
66	# Sign an invoice
67	msgtype,hsm_sign_invoice,8
68	msgdata,hsm_sign_invoice,len,u16,
69	msgdata,hsm_sign_invoice,u5bytes,u8,len
70	msgdata,hsm_sign_invoice,hrplen,u16,
71	msgdata,hsm_sign_invoice,hrp,u8,hrplen
72	msgtype,hsm_sign_invoice_reply,108
73	msgdata,hsm_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
74	# Give me ECDH(node-id-secret,point)
75	msgtype,hsm_ecdh_req,1
76	msgdata,hsm_ecdh_req,point,pubkey,
77	msgtype,hsm_ecdh_resp,100
78	msgdata,hsm_ecdh_resp,ss,secret,
79	msgtype,hsm_cannouncement_sig_req,2
80	msgdata,hsm_cannouncement_sig_req,calen,u16,
81	msgdata,hsm_cannouncement_sig_req,ca,u8,calen
82	msgtype,hsm_cannouncement_sig_reply,102
83	msgdata,hsm_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
84	msgdata,hsm_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
85	msgtype,hsm_cupdate_sig_req,3
86	msgdata,hsm_cupdate_sig_req,culen,u16,
87	msgdata,hsm_cupdate_sig_req,cu,u8,culen
88	msgtype,hsm_cupdate_sig_reply,103
89	msgdata,hsm_cupdate_sig_reply,culen,u16,
90	msgdata,hsm_cupdate_sig_reply,cu,u8,culen
91	# Master asks HSM to sign a commitment transaction.
92	msgtype,hsm_sign_commitment_tx,5
93	msgdata,hsm_sign_commitment_tx,peer_id,node_id,
94	msgdata,hsm_sign_commitment_tx,channel_dbid,u64,
95	msgdata,hsm_sign_commitment_tx,tx,bitcoin_tx,
96	msgdata,hsm_sign_commitment_tx,remote_funding_key,pubkey,
97	msgdata,hsm_sign_commitment_tx,funding_amount,amount_sat,
98	msgtype,hsm_sign_commitment_tx_reply,105
99	msgdata,hsm_sign_commitment_tx_reply,sig,bitcoin_signature,
100	# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
101	# of keys is derived differently...
102	# FIXME: Have master tell hsmd the keyindex, so it can validate output!
103	msgtype,hsm_sign_delayed_payment_to_us,12
104	msgdata,hsm_sign_delayed_payment_to_us,commit_num,u64,
105	msgdata,hsm_sign_delayed_payment_to_us,tx,bitcoin_tx,
106	msgdata,hsm_sign_delayed_payment_to_us,wscript_len,u16,
107	msgdata,hsm_sign_delayed_payment_to_us,wscript,u8,wscript_len
108	msgdata,hsm_sign_delayed_payment_to_us,input_amount,amount_sat,
109	msgtype,hsm_sign_remote_htlc_to_us,13
110	msgdata,hsm_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
111	msgdata,hsm_sign_remote_htlc_to_us,tx,bitcoin_tx,
112	msgdata,hsm_sign_remote_htlc_to_us,wscript_len,u16,
113	msgdata,hsm_sign_remote_htlc_to_us,wscript,u8,wscript_len
114	msgdata,hsm_sign_remote_htlc_to_us,input_amount,amount_sat,
115	msgtype,hsm_sign_penalty_to_us,14
116	msgdata,hsm_sign_penalty_to_us,revocation_secret,secret,
117	msgdata,hsm_sign_penalty_to_us,tx,bitcoin_tx,
118	msgdata,hsm_sign_penalty_to_us,wscript_len,u16,
119	msgdata,hsm_sign_penalty_to_us,wscript,u8,wscript_len
120	msgdata,hsm_sign_penalty_to_us,input_amount,amount_sat,
121	# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
122	msgtype,hsm_sign_local_htlc_tx,16
123	msgdata,hsm_sign_local_htlc_tx,commit_num,u64,
124	msgdata,hsm_sign_local_htlc_tx,tx,bitcoin_tx,
125	msgdata,hsm_sign_local_htlc_tx,wscript_len,u16,
126	msgdata,hsm_sign_local_htlc_tx,wscript,u8,wscript_len
127	msgdata,hsm_sign_local_htlc_tx,input_amount,amount_sat,
128	# Openingd/channeld asks HSM to sign the other sides' commitment tx.
129	msgtype,hsm_sign_remote_commitment_tx,19
130	msgdata,hsm_sign_remote_commitment_tx,tx,bitcoin_tx,
131	msgdata,hsm_sign_remote_commitment_tx,remote_funding_key,pubkey,
132	msgdata,hsm_sign_remote_commitment_tx,funding_amount,amount_sat,
133	# channeld asks HSM to sign remote HTLC tx.
134	msgtype,hsm_sign_remote_htlc_tx,20
135	msgdata,hsm_sign_remote_htlc_tx,tx,bitcoin_tx,
136	msgdata,hsm_sign_remote_htlc_tx,len,u16,
137	msgdata,hsm_sign_remote_htlc_tx,wscript,u8,len
138	msgdata,hsm_sign_remote_htlc_tx,amounts_satoshi,amount_sat,
139	msgdata,hsm_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
140	# closingd asks HSM to sign mutual close tx.
141	msgtype,hsm_sign_mutual_close_tx,21
142	msgdata,hsm_sign_mutual_close_tx,tx,bitcoin_tx,
143	msgdata,hsm_sign_mutual_close_tx,remote_funding_key,pubkey,
144	msgdata,hsm_sign_mutual_close_tx,funding,amount_sat,
145	# Reply for all the above requests.
146	msgtype,hsm_sign_tx_reply,112
147	msgdata,hsm_sign_tx_reply,sig,bitcoin_signature,
148	# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
149	msgtype,hsm_get_per_commitment_point,18
150	msgdata,hsm_get_per_commitment_point,n,u64,
151	msgtype,hsm_get_per_commitment_point_reply,118
152	msgdata,hsm_get_per_commitment_point_reply,per_commitment_point,pubkey,
153	msgdata,hsm_get_per_commitment_point_reply,old_commitment_secret,?secret,
154	# master -> hsmd: do you have a memleak?
155	msgtype,hsm_dev_memleak,33
156	msgtype,hsm_dev_memleak_reply,133
157	msgdata,hsm_dev_memleak_reply,leak,bool,
158	# channeld asks to check if claimed future commitment_secret is correct.
159	msgtype,hsm_check_future_secret,22
160	msgdata,hsm_check_future_secret,n,u64,
161	msgdata,hsm_check_future_secret,commitment_secret,secret,
162	msgtype,hsm_check_future_secret_reply,122
163	msgdata,hsm_check_future_secret_reply,correct,bool,