Skip to content

Commit 0b59f57

Browse files
loganjLarry
andcommitted
fix(mobile): reject invalid identity keys before naming
The resolver checked a key only when a collision needed its npub suffix, so a malformed key with a unique name got a normal label. Every fact key, owner key, viewer and candidate is now checked first. Co-authored-by: Larry <627498bd4bd1f281a16431e3c6cce3b5c25b6692798c78672298aefbf2f8f8b5@buzz.block.builderlab.xyz> Signed-off-by: Logan Johnson <[email protected]>
1 parent e88c2f4 commit 0b59f57

2 files changed

Lines changed: 101 additions & 21 deletions

File tree

‎mobile/lib/shared/identity_names/identity_name_policy.dart‎

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ import '../utils/string_utils.dart';
99
const identityNamePolicyVersion = 1;
1010

1111
/// One naming fact for an identity. [pubkey] and [ownerPubkey] must be valid
12-
/// 64-character hex public keys; callers choose names and fallbacks first.
12+
/// 64-character hex public keys (either case); callers choose names and
13+
/// fallbacks first.
1314
@immutable
1415
class NamingIdentity {
1516
final String pubkey;
@@ -85,6 +86,14 @@ String trimIdentityName(String value) {
8586
return value.substring(start, end);
8687
}
8788

89+
final RegExp _hexKey = RegExp(r'^[0-9a-fA-F]{64}$');
90+
91+
void _requireKey(String key, String name) {
92+
if (!_hexKey.hasMatch(key)) {
93+
throw ArgumentError.value(key, name, 'not a 64-character hex public key');
94+
}
95+
}
96+
8897
class _Row {
8998
final String key;
9099
final NamingIdentity identity;
@@ -111,18 +120,34 @@ class _Row {
111120
/// Display policy only: a readable owner or key suffix grants no authority.
112121
/// Implements contextual identity names v1 (see [identityNamePolicyVersion]).
113122
/// Omitting [candidates] selects every supplied fact; an empty set selects
114-
/// none. Throws [ArgumentError] for an invalid public key.
123+
/// none.
124+
///
125+
/// Every supplied key — each fact's [NamingIdentity.pubkey] and
126+
/// [NamingIdentity.ownerPubkey], [viewer], and each candidate — must be a
127+
/// valid public key. The contract leaves invalid keys to the caller, so this
128+
/// throws [ArgumentError] before resolving anything rather than returning a
129+
/// label for a value that is not an identity.
115130
Map<String, ResolvedIdentityName> resolveIdentityNames(
116131
List<NamingIdentity> identities, {
117132
String? viewer,
118133
Iterable<String>? candidates,
119134
}) {
135+
for (final identity in identities) {
136+
_requireKey(identity.pubkey, 'pubkey');
137+
if (identity.ownerPubkey case final owner?) {
138+
_requireKey(owner, 'ownerPubkey');
139+
}
140+
}
141+
if (viewer != null) _requireKey(viewer, 'viewer');
142+
final selected = candidates?.map((key) {
143+
_requireKey(key, 'candidates');
144+
return key.toLowerCase();
145+
}).toSet();
120146
final normalizedViewer = viewer?.toLowerCase();
121147
// Last fact per key: the preferred alias and the owner-lookup name.
122148
final preferred = <String, NamingIdentity>{
123149
for (final identity in identities) identity.pubkey.toLowerCase(): identity,
124150
};
125-
final selected = candidates?.map((key) => key.toLowerCase()).toSet();
126151
// One working row per (key, trimmed name); the last fact supplies metadata.
127152
final aliases = <(String, String), NamingIdentity>{};
128153
for (final identity in identities) {
@@ -152,13 +177,7 @@ Map<String, ResolvedIdentityName> resolveIdentityNames(
152177
}(),
153178
];
154179
final npubs = <String, String>{};
155-
String npubFor(String key) => npubs[key] ??= () {
156-
final npub = fullNpub(key);
157-
if (npub == null || key.length != 64) {
158-
throw ArgumentError.value(key, 'pubkey', 'not a hex public key');
159-
}
160-
return npub;
161-
}();
180+
String npubFor(String key) => npubs[key] ??= fullNpub(key)!;
162181

163182
while (true) {
164183
final groups = <String, List<_Row>>{};

‎mobile/test/shared/identity_names/identity_name_policy_test.dart‎

Lines changed: 72 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,78 @@ void main() {
5252
expect(result[key], const ResolvedIdentityName('\u0085Honey'));
5353
});
5454

55-
test('rejects an invalid public key instead of inventing an identity', () {
56-
expect(
57-
() => resolveIdentityNames(const [
58-
NamingIdentity(pubkey: 'not-a-key', name: 'Honey'),
59-
NamingIdentity(
60-
pubkey:
61-
'1111111111111111111111111111111111111111111111111111111111111111',
62-
name: 'Honey',
55+
group('rejects an invalid key before resolving', () {
56+
const valid =
57+
'1111111111111111111111111111111111111111111111111111111111111111';
58+
59+
test('for a fact that needs no suffix', () {
60+
expect(
61+
() => resolveIdentityNames(const [
62+
NamingIdentity(pubkey: 'not-a-key', name: 'Unique'),
63+
]),
64+
throwsArgumentError,
65+
);
66+
});
67+
68+
test('for a colliding fact', () {
69+
expect(
70+
() => resolveIdentityNames(const [
71+
NamingIdentity(pubkey: 'not-a-key', name: 'Honey'),
72+
NamingIdentity(pubkey: valid, name: 'Honey'),
73+
]),
74+
throwsArgumentError,
75+
);
76+
});
77+
78+
test('for an owner key', () {
79+
expect(
80+
() => resolveIdentityNames(const [
81+
NamingIdentity(
82+
pubkey: valid,
83+
name: 'Scout',
84+
isAgent: true,
85+
ownerPubkey: 'not-a-key',
86+
),
87+
]),
88+
throwsArgumentError,
89+
);
90+
});
91+
92+
test('for the viewer', () {
93+
expect(
94+
() => resolveIdentityNames(const [
95+
NamingIdentity(pubkey: valid, name: 'Honey'),
96+
], viewer: 'not-a-key'),
97+
throwsArgumentError,
98+
);
99+
});
100+
101+
test('for a candidate', () {
102+
expect(
103+
() => resolveIdentityNames(
104+
const [NamingIdentity(pubkey: valid, name: 'Honey')],
105+
candidates: const [valid, 'not-a-key'],
63106
),
64-
]),
65-
throwsArgumentError,
66-
);
107+
throwsArgumentError,
108+
);
109+
});
110+
111+
test('for a 64-character value that is not hex', () {
112+
expect(
113+
() => resolveIdentityNames([
114+
NamingIdentity(pubkey: 'g' * 64, name: 'Unique'),
115+
]),
116+
throwsArgumentError,
117+
);
118+
});
119+
120+
test('but accepts an upper-case hex key', () {
121+
expect(
122+
resolveIdentityNames([
123+
NamingIdentity(pubkey: valid.replaceAll('1', 'A'), name: 'Honey'),
124+
]),
125+
{valid.replaceAll('1', 'a'): const ResolvedIdentityName('Honey')},
126+
);
127+
});
67128
});
68129
}

0 commit comments

Comments
 (0)