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