RemoteSigning.pm

filter: Statementstmt 88.8% 16 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 6 / 6 Podpod n/a totaltotal 91.6% 22 / 24 CC 1 SCAR 0.5
CC
1
Cov
89%
BEGIN
1.3
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« Message.pm ↑ Summary WalletConnect.pm »
1 package Net::Nostr::RemoteSigning;
2  
3 2 ▶use strictures 2;
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 2 ▶use Net::Nostr::_ConstructorArgs ();
Subroutine BEGIN: called CC=1 SCAR=0.0
6 2 ▶use Net::Nostr::_URI qw(parse_uri_query validate_relay_url);
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 2 ▶use Carp qw(croak);
Subroutine BEGIN: called CC=1 SCAR=0.0
9 2 ▶use JSON ();
Subroutine BEGIN: called CC=1 SCAR=0.0
10 0 ▶use Net::Nostr::Event;
Subroutine BEGIN: called CC=1 SCAR=2.6
11 use URI ();
12  
13 my $HEX64 = qr/\A[0-9a-f]{64}\z/;
14  
15 ###############################################################################
16 # Bunker URI (remote-signer initiated)
17 ###############################################################################
18  
19 sub parse_bunker_uri {
20 my ($class, $uri) = @_;
21 my ($pubkey, @query) = parse_uri_query(
22 $uri,
23 label => 'URI',
24 scheme => 'bunker',
25 );
26 $pubkey = lc $pubkey;
27 croak "bunker:// URI remote_signer_pubkey must be 64-char lowercase hex"
28 unless $pubkey =~ $HEX64;
29  
30 my (@relays, $secret);
31 while (@query) {
32 my ($key, $val) = splice @query, 0, 2;
33 if ($key eq 'relay') { push @relays, $val }
34 elsif ($key eq 'secret') { $secret = $val }
35 }
36  
37 croak "URI must contain at least one relay parameter" unless @relays;
38 @relays = map { validate_relay_url($_, label => 'relay URL') } @relays;
39  
40 return Net::Nostr::RemoteSigning::BunkerConnection->new(
41 remote_signer_pubkey => $pubkey,
42 relays => \@relays,
43 secret => $secret,
44 );
45 }
46  
47 sub create_bunker_uri {
48 my $class = shift;
49 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
50 croak "remote_signer_pubkey is required" unless defined $args{remote_signer_pubkey};
51 croak "remote_signer_pubkey must be 64-char lowercase hex" unless $args{remote_signer_pubkey} =~ $HEX64;
52 croak "relay is required" unless defined $args{relay};
53  
54 my @relays = ref $args{relay} eq 'ARRAY' ? @{$args{relay}} : ($args{relay});
55 croak "relay is required" unless @relays;
56 @relays = map { validate_relay_url($_, label => 'relay URL') } @relays;
57  
58 my $uri = URI->new("bunker://$args{remote_signer_pubkey}");
59 my @params;
60 for my $r (@relays) {
61 push @params, relay => $r;
62 }
63 push @params, secret => $args{secret} if defined $args{secret};
64  
65 $uri->query_form(@params);
66 return $uri->as_string;
67 }
68  
69 ###############################################################################
70 # Nostrconnect URI (client initiated)
71 ###############################################################################
72  
73 sub parse_nostrconnect_uri {
74 my ($class, $uri) = @_;
75 my ($pubkey, @query) = parse_uri_query(
76 $uri,
77 label => 'URI',
78 scheme => 'nostrconnect',
79 );
80 $pubkey = lc $pubkey;
81 croak "nostrconnect:// URI client_pubkey must be 64-char lowercase hex"
82 unless $pubkey =~ $HEX64;
83  
84 my (@relays, $secret, $perms, $name, $url, $image);
85 while (@query) {
86 my ($key, $val) = splice @query, 0, 2;
87 if ($key eq 'relay') { push @relays, $val }
88 elsif ($key eq 'secret') { $secret = $val }
89 elsif ($key eq 'perms') { $perms = $val }
90 elsif ($key eq 'name') { $name = $val }
91 elsif ($key eq 'url') { $url = $val }
92 elsif ($key eq 'image') { $image = $val }
93 }
94  
95 croak "URI must contain at least one relay parameter" unless @relays;
96 @relays = map { validate_relay_url($_, label => 'relay URL') } @relays;
97 croak "URI must contain a secret parameter" unless defined $secret;
98  
99 return Net::Nostr::RemoteSigning::NostrConnect->new(
100 client_pubkey => $pubkey,
101 relays => \@relays,
102 secret => $secret,
103 perms => $perms,
104 name => $name,
105 url => $url,
106 image => $image,
107 );
108 }
109  
110 sub create_nostrconnect_uri {
111 my $class = shift;
112 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
113 croak "client_pubkey is required" unless defined $args{client_pubkey};
114 croak "client_pubkey must be 64-char lowercase hex" unless $args{client_pubkey} =~ $HEX64;
115 croak "relay is required" unless defined $args{relay};
116 croak "secret is required" unless defined $args{secret};
117  
118 my @relays = ref $args{relay} eq 'ARRAY' ? @{$args{relay}} : ($args{relay});
119 croak "relay is required" unless @relays;
120 @relays = map { validate_relay_url($_, label => 'relay URL') } @relays;
121  
122 my $uri = URI->new("nostrconnect://$args{client_pubkey}");
123 my @params;
124 for my $r (@relays) {
125 push @params, relay => $r;
126 }
127 push @params, secret => $args{secret};
128 push @params, perms => $args{perms} if defined $args{perms};
129 push @params, name => $args{name} if defined $args{name};
130 push @params, url => $args{url} if defined $args{url};
131 push @params, image => $args{image} if defined $args{image};
132  
133 $uri->query_form(@params);
134 return $uri->as_string;
135 }
136  
137 ###############################################################################
138 # Request payload
139 ###############################################################################
140  
141 sub request {
142 my $class = shift;
143 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
144 croak "request requires 'method'" unless defined $args{method};
145 croak "request requires 'params'" unless defined $args{params};
146  
147 my $id = $args{id} // _generate_id();
148  
149 return JSON->new->utf8->canonical->encode({
150 id => $id,
151 method => $args{method},
152 params => $args{params},
153 });
154 }
155  
156 ###############################################################################
157 # Request event (kind 24133)
158 ###############################################################################
159  
160 sub request_event {
161 my $class = shift;
162 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
163 croak "request_event requires 'method'" unless defined $args{method};
164 croak "request_event requires 'params'" unless defined $args{params};
165 croak "request_event requires 'remote_signer_pubkey'" unless defined $args{remote_signer_pubkey};
166 croak "remote_signer_pubkey must be 64-char lowercase hex" unless $args{remote_signer_pubkey} =~ $HEX64;
167  
168 my $content = $class->request(
169 id => $args{id},
170 method => $args{method},
171 params => $args{params},
172 );
173  
174 croak "request_event requires 'pubkey'" unless defined $args{pubkey};
175 croak "pubkey must be 64-char lowercase hex" unless $args{pubkey} =~ $HEX64;
176  
177 return Net::Nostr::Event->new(
178 kind => 24133,
179 pubkey => $args{pubkey},
180 content => $content,
181 tags => [['p', $args{remote_signer_pubkey}]],
182 );
183 }
184  
185 ###############################################################################
186 # Response payload
187 ###############################################################################
188  
189 sub response {
190 my $class = shift;
191 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
192 croak "response requires 'id'" unless defined $args{id};
193  
194 my %data = (id => $args{id});
195 $data{result} = $args{result} if exists $args{result};
196 $data{error} = $args{error} if exists $args{error};
197  
198 return JSON->new->utf8->canonical->encode(\%data);
199 }
200  
201 ###############################################################################
202 # Response event (kind 24133)
203 ###############################################################################
204  
205 sub response_event {
206 my $class = shift;
207 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
208  
209 my $content = $class->response(
210 id => $args{id},
211 result => $args{result},
212 (exists $args{error} ? (error => $args{error}) : ()),
213 );
214  
215 my @tags;
216 if (defined $args{client_pubkey}) {
217 croak "client_pubkey must be 64-char lowercase hex" unless $args{client_pubkey} =~ $HEX64;
218 push @tags, ['p', $args{client_pubkey}];
219 }
220  
221 croak "response_event requires 'pubkey'" unless defined $args{pubkey};
222 croak "pubkey must be 64-char lowercase hex" unless $args{pubkey} =~ $HEX64;
223  
224 return Net::Nostr::Event->new(
225 kind => 24133,
226 pubkey => $args{pubkey},
227 content => $content,
228 tags => \@tags,
229 );
230 }
231  
232 ###############################################################################
233 # Parse request/response
234 ###############################################################################
235  
236 sub parse_request {
237 my ($class, $json) = @_;
238 my $data = JSON->new->utf8->decode($json);
239  
240 return Net::Nostr::RemoteSigning::Request->new(
241 id => $data->{id},
242 method => $data->{method},
243 params => $data->{params},
244 );
245 }
246  
247 sub parse_response {
248 my ($class, $json) = @_;
249 my $data = JSON->new->utf8->decode($json);
250  
251 return Net::Nostr::RemoteSigning::Response->new(
252 id => $data->{id},
253 result => $data->{result},
254 error => $data->{error},
255 );
256 }
257  
258 ###############################################################################
259 # Permissions parsing
260 ###############################################################################
261  
262 sub parse_permissions {
263 my ($class, $perms_str) = @_;
264 return () unless defined $perms_str && length $perms_str;
265  
266 my @perms;
267 for my $perm (split /,/, $perms_str) {
268 my ($method, $param) = split /:/, $perm, 2;
269 push @perms, { method => $method, param => $param };
270 }
271 return @perms;
272 }
273  
274 ###############################################################################
275 # Validation
276 ###############################################################################
277  
278 sub validate_request {
279 my ($class, $event) = @_;
280 croak "request MUST be kind 24133" unless $event->kind == 24133;
281  
282 my $has_p = grep { $_->[0] eq 'p' } @{$event->tags};
283 croak "request SHOULD include a p tag" unless $has_p;
284  
285 return 1;
286 }
287  
288 sub validate_response {
289 my ($class, $event) = @_;
290 croak "response MUST be kind 24133" unless $event->kind == 24133;
291 return 1;
292 }
293  
294 sub validate_connect_response {
295 my ($class, $resp, $expected_secret) = @_;
296  
297 if (defined $expected_secret) {
298 croak "connect response secret does not match"
299 unless defined $resp->result && $resp->result eq $expected_secret;
300 }
301  
302 return 1;
303 }
304  
305 ###############################################################################
306 # switch_relays response parsing
307 ###############################################################################
308  
309 sub parse_switch_relays {
310 my ($class, $result) = @_;
311 return undef unless defined $result && $result ne 'null';
312 return JSON->new->utf8->decode($result);
313 }
314  
315 ###############################################################################
316 # NIP-05 metadata parsing
317 ###############################################################################
318  
319 sub parse_nip05_metadata {
320 my ($class, $json) = @_;
321 my $data = JSON->new->utf8->decode($json);
322  
323 croak "NIP-05 response must contain names._ field"
324 unless $data->{names} && defined $data->{names}{'_'};
325  
326 my $nip46 = $data->{nip46} // {};
327  
328 return Net::Nostr::RemoteSigning::Nip05Metadata->new(
329 pubkey => $data->{names}{'_'},
330 relays => $nip46->{relays} // [],
331 nostrconnect_url => $nip46->{nostrconnect_url},
332 );
333 }
334  
335 ###############################################################################
336 # Discovery event (NIP-89 kind 31990)
337 ###############################################################################
338  
339 sub parse_discovery_event {
340 my ($class, $event) = @_;
341 croak "discovery event MUST be kind 31990" unless $event->kind == 31990;
342  
343 my $has_k = grep { @$_ >= 2 && $_->[0] eq 'k' && $_->[1] eq '24133' } @{$event->tags};
344 croak "discovery event MUST have k tag with value 24133" unless $has_k;
345  
346 my @relays;
347 my $nostrconnect_url;
348 for my $tag (@{$event->tags}) {
349 next unless @$tag >= 2;
350 if ($tag->[0] eq 'relay') {
351 push @relays, $tag->[1];
352 } elsif ($tag->[0] eq 'nostrconnect_url') {
353 $nostrconnect_url = $tag->[1];
354 }
355 }
356  
357 return Net::Nostr::RemoteSigning::Discovery->new(
358 pubkey => $event->pubkey,
359 relays => \@relays,
360 nostrconnect_url => $nostrconnect_url,
361 );
362 }
363  
364 sub discovery_event {
365 my $class = shift;
366 my %args = Net::Nostr::_ConstructorArgs::normalize(@_);
367  
368 my @tags = (['k', '24133']);
369  
370 if ($args{relays} && @{$args{relays}}) {
371 for my $r (@{$args{relays}}) {
372 push @tags, ['relay', $r];
373 }
374 }
375  
376 push @tags, ['nostrconnect_url', $args{nostrconnect_url}]
377 if defined $args{nostrconnect_url};
378  
379 croak "discovery_event requires 'pubkey'" unless defined $args{pubkey};
380 croak "pubkey must be 64-char lowercase hex" unless $args{pubkey} =~ $HEX64;
381  
382 return Net::Nostr::Event->new(
383 kind => 31990,
384 pubkey => $args{pubkey},
385 content => '',
386 tags => \@tags,
387 );
388 }
389  
390 sub _generate_id {
391 my @chars = ('a'..'z', '0'..'9');
392 return join '', map { $chars[rand @chars] } 1..16;
393 }
394  
395 ###############################################################################
396 # Inner classes
397 ###############################################################################
398  
399 {
400 package Net::Nostr::RemoteSigning::BunkerConnection;
401 use Carp qw(croak);
402 use Class::Tiny qw(remote_signer_pubkey secret);
403 sub new {
404 my $class = shift;
405 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
406 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
407 $known{relays} = ();
408 my @unknown = grep { !exists $known{$_} } keys %$self;
409 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
410 $self->{relays} = [@{$self->{relays}}] if ref $self->{relays} eq 'ARRAY';
411 return $self;
412 }
413 sub relays {
414 my $self = shift;
415 croak "relays is read-only" if @_;
416 return defined $self->{relays} ? [@{$self->{relays}}] : undef;
417 }
418 }
419  
420 {
421 package Net::Nostr::RemoteSigning::NostrConnect;
422 use Carp qw(croak);
423 use Class::Tiny qw(client_pubkey secret perms name url image);
424 sub new {
425 my $class = shift;
426 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
427 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
428 $known{relays} = ();
429 my @unknown = grep { !exists $known{$_} } keys %$self;
430 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
431 $self->{relays} = [@{$self->{relays}}] if ref $self->{relays} eq 'ARRAY';
432 return $self;
433 }
434 sub relays {
435 my $self = shift;
436 croak "relays is read-only" if @_;
437 return defined $self->{relays} ? [@{$self->{relays}}] : undef;
438 }
439 }
440  
441 {
442 package Net::Nostr::RemoteSigning::Nip05Metadata;
443 use Carp qw(croak);
444 use Class::Tiny qw(pubkey nostrconnect_url);
445 sub new {
446 my $class = shift;
447 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
448 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
449 $known{relays} = ();
450 my @unknown = grep { !exists $known{$_} } keys %$self;
451 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
452 $self->{relays} = [@{$self->{relays}}] if ref $self->{relays} eq 'ARRAY';
453 return $self;
454 }
455 sub relays {
456 my $self = shift;
457 croak "relays is read-only" if @_;
458 return defined $self->{relays} ? [@{$self->{relays}}] : undef;
459 }
460 }
461  
462 {
463 package Net::Nostr::RemoteSigning::Discovery;
464 use Carp qw(croak);
465 use Class::Tiny qw(pubkey nostrconnect_url);
466 sub new {
467 my $class = shift;
468 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
469 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
470 $known{relays} = ();
471 my @unknown = grep { !exists $known{$_} } keys %$self;
472 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
473 $self->{relays} = [@{$self->{relays}}] if ref $self->{relays} eq 'ARRAY';
474 return $self;
475 }
476 sub relays {
477 my $self = shift;
478 croak "relays is read-only" if @_;
479 return defined $self->{relays} ? [@{$self->{relays}}] : undef;
480 }
481 }
482  
483 {
484 package Net::Nostr::RemoteSigning::Request;
485 use Carp qw(croak);
486 use Class::Tiny qw(id method);
487 sub new {
488 my $class = shift;
489 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
490 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
491 $known{params} = ();
492 my @unknown = grep { !exists $known{$_} } keys %$self;
493 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
494 croak "id is required" unless defined $self->{id};
495 croak "method is required" unless defined $self->{method};
496 croak "params is required" unless defined $self->{params};
497 croak "params must be an arrayref" unless ref($self->{params}) eq 'ARRAY';
498 $self->{params} = [@{$self->{params}}];
499 return $self;
500 }
501 sub params {
502 my $self = shift;
503 croak "params is read-only" if @_;
504 return [@{$self->{params}}];
505 }
506 }
507  
508 {
509 package Net::Nostr::RemoteSigning::Response;
510 use Carp qw(croak);
511 use Class::Tiny qw(id result error);
512 sub new {
513 my $class = shift;
514 my $self = bless { Net::Nostr::_ConstructorArgs::normalize(@_) }, $class;
515 my %known; @known{Class::Tiny->get_all_attributes_for($class)} = ();
516 my @unknown = grep { !exists $known{$_} } keys %$self;
517 croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown;
518 croak "id is required" unless defined $self->{id};
519 return $self;
520 }
521  
522 sub is_error {
523 my ($self) = @_;
524 return defined $self->error && !(defined $self->result && $self->result eq 'auth_url');
525 }
526  
527 sub is_auth_challenge {
528 my ($self) = @_;
529 return defined $self->result && $self->result eq 'auth_url';
530 }
531  
532 sub auth_url {
533 my ($self) = @_;
534 return $self->is_auth_challenge ? $self->error : undef;
535 }
536 }
537  
538 1;
539  
540 __END__
« Message.pm ↑ Summary WalletConnect.pm »