aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-20 07:34:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

tools/generate-wire.py: only use 'struct node_id' in announcements.

Browse Source 
Naturally, it's a struct pubkey.  However, those are large, and take
time to marshal, so gossipd treats them as node_id which is a simple
array.  It adds explicit checks at the right points to make sure
they're valid pubkeys.

However, the next commit adds TLV test vectors, which assumes we treat
node_id as a point (thus catch invalid values when parsing).  The best
solution is to restrain our types here to exactly those we've
optimized for.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2019-08-01 15:28:09 +09:30
committed by Christian Decker
parent 00ca52ea07
commit 4b5cd5ff84
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
tools/generate-wire.py
View File

@@ -219,13 +219,14 @@ class Type(FieldSet):
] ]
# Some BOLT types are re-typed based on their field name # Some BOLT types are re-typed based on their field name
# ('fieldname partial', 'original type'): ('true type', 'collapse array?') # ('fieldname partial', 'original type', 'outer type'): ('true type', 'collapse array?')
name_field_map = { name_field_map = {
('txid', 'sha256'): ('bitcoin_txid', False), ('txid', 'sha256'): ('bitcoin_txid', False),
('amt', 'u64'): ('amount_msat', False), ('amt', 'u64'): ('amount_msat', False),
('msat', 'u64'): ('amount_msat', False), ('msat', 'u64'): ('amount_msat', False),
('satoshis', 'u64'): ('amount_sat', False), ('satoshis', 'u64'): ('amount_sat', False),
('node_id', 'pubkey'): ('node_id', False), ('node_id', 'pubkey', 'channel_announcement'): ('node_id', False),
('node_id', 'pubkey', 'node_announcement'): ('node_id', False),
('temporary_channel_id', 'u8'): ('channel_id', True), ('temporary_channel_id', 'u8'): ('channel_id', True),
('secret', 'u8'): ('secret', True), ('secret', 'u8'): ('secret', True),
('preimage', 'u8'): ('preimage', True), ('preimage', 'u8'): ('preimage', True),
@@ -242,7 +243,7 @@ class Type(FieldSet):
} }
@staticmethod @staticmethod
def true_type(type_name, field_name=None): def true_type(type_name, field_name=None, outer_name=None):
""" Returns 'true' type of a given type and a flag if """ Returns 'true' type of a given type and a flag if
we've remapped a variable size/array type to a single struct we've remapped a variable size/array type to a single struct
(an example of this is 'temporary_channel_id' which is specified (an example of this is 'temporary_channel_id' which is specified
@@ -252,8 +253,9 @@ class Type(FieldSet):
type_name = Type.name_remap[type_name] type_name = Type.name_remap[type_name]
if field_name: if field_name:
for (partial, t), true_type in Type.name_field_map.items(): for t, true_type in Type.name_field_map.items():
if partial in field_name and t == type_name: if t[0] in field_name and t[1] == type_name:
if len(t) == 2 or outer_name == t[2]:
return true_type return true_type
return (type_name, False) return (type_name, False)
@@ -407,13 +409,14 @@ class Master(object):
def add_extension_msg(self, name, msg): def add_extension_msg(self, name, msg):
self.extension_msgs[name] = msg self.extension_msgs[name] = msg
def add_type(self, type_name, field_name=None): def add_type(self, type_name, field_name=None, outer_name=None):
optional = False optional = False
if type_name.startswith('?'): if type_name.startswith('?'):
type_name = type_name[1:] type_name = type_name[1:]
optional = True optional = True
# Check for special type name re-mapping # Check for special type name re-mapping
type_name, collapse_original = Type.true_type(type_name, field_name) type_name, collapse_original = Type.true_type(type_name, field_name,
outer_name)
if type_name not in self.types: if type_name not in self.types:
self.types[type_name] = Type(type_name) self.types[type_name] = Type(type_name)
@@ -522,7 +525,7 @@ def main(options, args=None, output=sys.stdout, lines=None):
if not subtype: if not subtype:
raise ValueError('Unknown subtype {} for data.\nat {}:{}' raise ValueError('Unknown subtype {} for data.\nat {}:{}'
.format(tokens[1], ln, line)) .format(tokens[1], ln, line))
type_obj, collapse, optional = master.add_type(tokens[3], tokens[2]) type_obj, collapse, optional = master.add_type(tokens[3], tokens[2], tokens[1])
if optional: if optional:
raise ValueError('Subtypes cannot have optional fields {}.{}\n at {}:{}' raise ValueError('Subtypes cannot have optional fields {}.{}\n at {}:{}'
.format(subtype.name, tokens[2], ln, line)) .format(subtype.name, tokens[2], ln, line))
@@ -540,7 +543,7 @@ def main(options, args=None, output=sys.stdout, lines=None):
comment_set = [] comment_set = []
elif token_type == 'tlvdata': elif token_type == 'tlvdata':
type_obj, collapse, optional = master.add_type(tokens[4], tokens[3]) type_obj, collapse, optional = master.add_type(tokens[4], tokens[3], tokens[1])
if optional: if optional:
raise ValueError('TLV messages cannot have optional fields {}.{}\n at {}:{}' raise ValueError('TLV messages cannot have optional fields {}.{}\n at {}:{}'
.format(tokens[2], tokens[3], ln, line)) .format(tokens[2], tokens[3], ln, line))
@@ -568,7 +571,7 @@ def main(options, args=None, output=sys.stdout, lines=None):
msg = master.find_message(tokens[1]) msg = master.find_message(tokens[1])
if not msg: if not msg:
raise ValueError('Unknown message type {}. {}:{}'.format(tokens[1], ln, line)) raise ValueError('Unknown message type {}. {}:{}'.format(tokens[1], ln, line))
type_obj, collapse, optional = master.add_type(tokens[3], tokens[2]) type_obj, collapse, optional = master.add_type(tokens[3], tokens[2], tokens[1])
# if this is an 'extension' field*, we want to add a new 'message' type # if this is an 'extension' field*, we want to add a new 'message' type
# in the future, extensions will be handled as TLV's # in the future, extensions will be handled as TLV's