mirror of
https://github.com/block/buzz.git
synced 2026-10-28 13:01:10 +00:00
This PR implements MVP, iOS-only,
[NIP-PL](8d2d0ff5ad/docs/nips/NIP-PL.md)-compliant
push notifications.
A relay with `BUZZ_PUSH_ENABLED` will send a push notification for any
message that appears in the in-app Notifications tab.
## Enrollment flow
The first time the client first connects to a relay with
`BUZZ_PUSH_ENABLED`:
```mermaid
sequenceDiagram
autonumber
participant App as Buzz iOS app
participant iOS
participant Relay as Buzz relay
participant Attest as Apple App Attest
participant Gateway as Push gateway
App->>Relay: Fetch NIP-11 push capability
Relay-->>App: Push profile, current relay public key, and limits
par
App->>iOS: Request notification permission
iOS-->>App: Permission result
and
App->>iOS: Register for remote notifications
iOS-->>App: Device token
end
App->>Gateway: Request installation challenge
Gateway-->>App: Single-use challenge
App->>Attest: Attest installation transcript
Attest-->>App: Attestation proof
App->>Gateway: Enroll device token and proof
Gateway-->>App: Installation handle
App->>Gateway: Request delegation challenge
Gateway-->>App: Single-use challenge
App->>Attest: Assert relay-key delegation
Attest-->>App: Assertion
App->>Gateway: Create delegation
Gateway-->>App: Opaque endpoint grant
App->>Relay: Publish encrypted push lease and filters
Relay-->>App: Lease acknowledged
```
## Push-time flow
When a notification-eligible event is received by the relay:
```mermaid
%%{init: {
"sequence": {
"actorMargin": 20,
"width": 110,
"messageMargin": 18,
"diagramMarginX": 8,
"wrap": true
}
}}%%
sequenceDiagram
autonumber
participant Relay as Buzz relay
participant Gateway as Push gateway
participant APNs as Apple Push<br/>Notification service
participant iOS
participant NSE as Notification service<br/>extension
Relay->>Gateway: POST /v1/deliveries/apns<br/>opaque endpoint grant, request ID, expiry, NIP-98 authorization
Gateway->>APNs: POST /3/device/{device-token}<br/>topic, request ID, expiry, constant mutable-content payload
APNs-->>Gateway: 200 OK: request accepted
Gateway-->>Relay: 200 OK: accepted status
APNs-->>iOS: Notification: constant reconnect alert<br/>mutable-content = 1
iOS->>NSE: Invoke extension<br/>original notification content
NSE->>Relay: POST /query: subscription filters, limit 10<br/>NIP-98 authorization
Relay-->>NSE: 200 OK: signed Nostr events<br/>kinds 9, 40002, 45001, or 45003
NSE->>iOS: Complete notification: title, body, subtitle<br/>thread ID, exact-message target
```
relay → push gateway → APNs -> NSE -> Notification Center
## Known limitations
The APNs wake payload is intentionally constant and opaque: it contains
no originating community or message identifier, in keeping with the
implemented NIP-PL privacy design.
The Notification Service Extension must therefore reconnect to the relay
and resolve eligible messages after each wake. Around overlapping wakes,
timing boundaries, or resolution windows, notification presentation may
occasionally omit an expected message or display a message more than
once.
This best-effort behavior is deliberately accepted for the current
implementation and will be measured during the internal rollout to
determine whether the user experience is acceptable before any broader
deployment; the implementation does not claim exactly-once presentation.
## Validation
Live end-to-end hardware validation used an internal remotely hosted
development relay and push gateway, the APNs sandbox, and a physical
iPhone 12 mini:
- A second real Buzz client published a uniquely marked message through
the hosted relay.
- The relay matched the message and sent the constant opaque wake
through the hosted gateway. The gateway made an actual APNs request; no
`simctl push` or simulated notification was used.
- The iPhone received the notification on its lock screen. The
Notification Service Extension reconnected to the relay, fetched the
event, verified its ID and signature, and replaced the placeholder
content with the real notification title and body.
- After the app populated its shared presentation cache, a final marked
notification visibly showed the sender display name, sender avatar, and
hashtag-prefixed channel name.
- Tapping a lock-screen notification opened Buzz and exercised the
notification-response path and navigated to the corresponding message.
Final validation with a dogfood-signed artifact and production App
Attest/APNs configuration remains a release step.
## Independent pre-reviews
- **First pass:**
[Carl](buzz://message?channel=18882f4c-289f-41db-942f-81f6f8066da1&id=74ab9a93bb227f3e762568f1cf9fee66d7495b0edc3918735ff787238b9cc585)
found missing transient retries, executor-key rotation suppression,
duplicate installation renewal, and an unauthenticated challenge write
amplifier. These were resolved by [retry-safe
bootstrap](https://github.com/block/buzz/pull/6269/changes/12c66ea62)
and [authenticated renewal plus a cross-replica
quota](https://github.com/block/buzz/pull/6269/changes/8e5ece0bd).
[sol-max](buzz://message?channel=ad83385f-8e9e-4461-9a35-c1bf2e208532&id=d26d53daa4684669e2ed354638241f13f36c3a97027fe8b4dd738aff09038962)
found delegation generation burning and an edited applied migration,
resolved by [exact-generation
revocation](https://github.com/block/buzz/pull/6269/changes/c26d2159d)
and a [forward-only
migration](https://github.com/block/buzz/pull/6269/changes/956c1d099).
[k3-max](buzz://message?channel=5e46055d-a766-4065-ae25-05d1e4aaa6b2&id=d43139138a0b15f806cbdbeeedd8f69d992cadf2e805876db6fdde6a34c7eda1)
found no blockers.
- **Exact-head re-review:**
[Carl](buzz://message?channel=18882f4c-289f-41db-942f-81f6f8066da1&id=a897721673459301b0cf26e8b85a1478d7ebbb56a4621f93d774c98d395b8f68),
[sol-max](buzz://message?channel=ad83385f-8e9e-4461-9a35-c1bf2e208532&id=fb2159f709ec68f74f7b21459acd76da0e8a7c5c0f3d469f99826b0cc2380849),
and
[k3-max](buzz://message?channel=5e46055d-a766-4065-ae25-05d1e4aaa6b2&id=2ce2842910435f562e9d9cc718595848f281b122c94605e523a4b964254b8bfb)
independently returned **NO BLOCKERS** at `7eb3a650b`; k3-max also
revalidated every remediation and the endpoint-specific App Attest
enrollment bound.
---------
Signed-off-by: Tom Brow <tomb@squareup.com>
Signed-off-by: Tom Brow <tomb@block.xyz>
Co-authored-by: Tom Brow <tomb@squareup.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Jordan Mecom <jm@squareup.com>
355 lines
11 KiB
Dart
355 lines
11 KiB
Dart
/// Parsing for `buzz://` deep links.
|
|
///
|
|
/// Mirrors the desktop handler in `desktop/src-tauri/src/deep_link.rs`:
|
|
/// `buzz://message?channel=<uuid>&id=<hex>[&thread=<hex>]` references a
|
|
/// message (optionally inside a thread) in a channel. Required params that
|
|
/// are missing or empty make the link invalid — the caller never sees a
|
|
/// half-formed target.
|
|
library;
|
|
|
|
import '../relay/relay_validation.dart';
|
|
|
|
/// A parsed deep link supported by the app.
|
|
sealed class BuzzDeepLink {
|
|
const BuzzDeepLink();
|
|
}
|
|
|
|
/// A parsed relay invite link.
|
|
///
|
|
/// Canonical share links are `https://<relay>/invite/<code>`. The custom
|
|
/// `buzz://join?relay=<ws(s)://relay>&code=<code>` form is only an installed-app
|
|
/// handoff from the web landing page.
|
|
class InviteDeepLink extends BuzzDeepLink {
|
|
/// Relay URL normalized to the websocket scheme used by the app.
|
|
final String relayUrl;
|
|
|
|
/// Invite code from the link.
|
|
final String code;
|
|
|
|
/// Optional receipt proving acceptance of the relay's current join policy.
|
|
final String? policyReceipt;
|
|
|
|
const InviteDeepLink({
|
|
required this.relayUrl,
|
|
required this.code,
|
|
this.policyReceipt,
|
|
});
|
|
|
|
@override
|
|
bool operator ==(Object other) =>
|
|
other is InviteDeepLink &&
|
|
other.relayUrl == relayUrl &&
|
|
other.code == code &&
|
|
other.policyReceipt == policyReceipt;
|
|
|
|
@override
|
|
int get hashCode => Object.hash(relayUrl, code, policyReceipt);
|
|
|
|
@override
|
|
String toString() =>
|
|
'InviteDeepLink(relay: $relayUrl, code: $code, policyReceipt: $policyReceipt)';
|
|
}
|
|
|
|
/// A parsed channel-only deep link.
|
|
///
|
|
/// Canonical form: `buzz://channel/<channel-uuid>`.
|
|
class ChannelDeepLink extends BuzzDeepLink {
|
|
/// Channel UUID from the sole path segment.
|
|
final String channelId;
|
|
|
|
const ChannelDeepLink({required this.channelId});
|
|
|
|
@override
|
|
bool operator ==(Object other) =>
|
|
other is ChannelDeepLink && other.channelId == channelId;
|
|
|
|
@override
|
|
int get hashCode => channelId.hashCode;
|
|
|
|
@override
|
|
String toString() => 'ChannelDeepLink(channel: $channelId)';
|
|
}
|
|
|
|
/// A parsed `buzz://message` deep link.
|
|
class MessageDeepLink extends BuzzDeepLink {
|
|
/// Local community identifier for notification-originated links.
|
|
/// Canonical shared links omit this because community IDs are device-local.
|
|
final String? communityId;
|
|
|
|
/// Channel UUID from the `channel` query param.
|
|
final String channelId;
|
|
|
|
/// Event ID (hex) from the `id` query param.
|
|
final String messageId;
|
|
|
|
/// Optional thread root event ID from the `thread` query param.
|
|
final String? threadRootId;
|
|
|
|
const MessageDeepLink({
|
|
this.communityId,
|
|
required this.channelId,
|
|
required this.messageId,
|
|
this.threadRootId,
|
|
});
|
|
|
|
@override
|
|
bool operator ==(Object other) =>
|
|
other is MessageDeepLink &&
|
|
other.communityId == communityId &&
|
|
other.channelId == channelId &&
|
|
other.messageId == messageId &&
|
|
other.threadRootId == threadRootId;
|
|
|
|
@override
|
|
int get hashCode =>
|
|
Object.hash(communityId, channelId, messageId, threadRootId);
|
|
|
|
@override
|
|
String toString() =>
|
|
'MessageDeepLink(community: $communityId, channel: $channelId, id: $messageId, '
|
|
'thread: $threadRootId)';
|
|
}
|
|
|
|
/// Build a canonical `buzz://message` link for a channel message.
|
|
///
|
|
/// Mirrors `desktop/src/features/messages/lib/messageLink.ts` so links copied
|
|
/// or shared from mobile round-trip through every client's parser:
|
|
/// `buzz://message?channel=<uuid>&id=<eventId>[&thread=<rootId>]`.
|
|
///
|
|
/// An empty [threadRootId] is treated as "no thread" so callers can pass
|
|
/// through a nullable thread reference without extra checks.
|
|
String buildMessageLink({
|
|
required String channelId,
|
|
required String messageId,
|
|
String? threadRootId,
|
|
}) {
|
|
if (channelId.isEmpty) {
|
|
throw ArgumentError('buildMessageLink: channelId is required');
|
|
}
|
|
if (messageId.isEmpty) {
|
|
throw ArgumentError('buildMessageLink: messageId is required');
|
|
}
|
|
|
|
final params = <String, String>{
|
|
'channel': channelId,
|
|
'id': messageId,
|
|
if (threadRootId != null && threadRootId.isNotEmpty) 'thread': threadRootId,
|
|
};
|
|
return Uri(
|
|
scheme: 'buzz',
|
|
host: 'message',
|
|
queryParameters: params,
|
|
).toString();
|
|
}
|
|
|
|
/// Parse a canonical `buzz://channel/<channel-uuid>` URI.
|
|
///
|
|
/// The channel ID must be the URI's sole non-empty path segment. Query
|
|
/// parameters and fragments are rejected so malformed or ambiguous links never
|
|
/// become navigation targets.
|
|
ChannelDeepLink? parseChannelDeepLink(Uri uri) {
|
|
if (uri.scheme != 'buzz' || uri.host != 'channel') return null;
|
|
if (uri.hasQuery ||
|
|
uri.hasFragment ||
|
|
uri.userInfo.isNotEmpty ||
|
|
uri.hasPort) {
|
|
return null;
|
|
}
|
|
if (uri.pathSegments.length != 1 || uri.pathSegments.single.isEmpty) {
|
|
return null;
|
|
}
|
|
final channelId = uri.pathSegments.single;
|
|
if (!RegExp(
|
|
r'^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$',
|
|
caseSensitive: false,
|
|
).hasMatch(channelId)) {
|
|
return null;
|
|
}
|
|
return ChannelDeepLink(channelId: channelId.toLowerCase());
|
|
}
|
|
|
|
/// Parse a `buzz://message?…` URI into a [MessageDeepLink].
|
|
///
|
|
/// Returns `null` unless the URI exactly matches the canonical message-link
|
|
/// shape: no path, fragment, credentials, duplicate or unknown parameters; a
|
|
/// UUID channel; and 64-character hexadecimal message/thread event IDs.
|
|
MessageDeepLink? parseMessageDeepLink(Uri uri) {
|
|
if (uri.scheme != 'buzz' || uri.host != 'message') return null;
|
|
if (uri.path.isNotEmpty ||
|
|
uri.hasFragment ||
|
|
uri.userInfo.isNotEmpty ||
|
|
uri.hasPort) {
|
|
return null;
|
|
}
|
|
|
|
const allowedParams = {'channel', 'id', 'thread'};
|
|
if (uri.queryParametersAll.keys.any((key) => !allowedParams.contains(key)) ||
|
|
uri.queryParametersAll.values.any((values) => values.length != 1)) {
|
|
return null;
|
|
}
|
|
|
|
final channel = uri.queryParameters['channel'];
|
|
final id = uri.queryParameters['id'];
|
|
final thread = uri.queryParameters['thread'];
|
|
final uuid = RegExp(
|
|
r'^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$',
|
|
caseSensitive: false,
|
|
);
|
|
final eventId = RegExp(r'^[0-9a-f]{64}$', caseSensitive: false);
|
|
if (channel == null ||
|
|
!uuid.hasMatch(channel) ||
|
|
id == null ||
|
|
!eventId.hasMatch(id) ||
|
|
(thread != null && !eventId.hasMatch(thread))) {
|
|
return null;
|
|
}
|
|
|
|
return MessageDeepLink(
|
|
channelId: channel.toLowerCase(),
|
|
messageId: id.toLowerCase(),
|
|
threadRootId: thread?.toLowerCase(),
|
|
);
|
|
}
|
|
|
|
/// Parse canonical HTTPS invite links and `buzz://join` app handoffs.
|
|
///
|
|
/// Accepted forms:
|
|
/// - `https://<relay>/invite/<code>` -> `wss://<relay>` + code
|
|
/// - `http://localhost/invite/<code>` -> `ws://localhost` + code in debug builds
|
|
/// - `buzz://join?relay=<wss://relay>&code=<code>` -> relay + code
|
|
/// - `buzz://join?relay=<ws://localhost>&code=<code>` -> local relay in debug
|
|
///
|
|
/// Rejects credentials, fragments, missing params, nested relay credentials, and
|
|
/// non-invite paths so scanners do not accidentally treat arbitrary URLs as
|
|
/// community admission links.
|
|
InviteDeepLink? parseInviteDeepLink(Uri uri) {
|
|
if (uri.hasFragment || uri.userInfo.isNotEmpty) return null;
|
|
|
|
if (uri.scheme == 'buzz') {
|
|
if (uri.host != 'join') return null;
|
|
final relay = uri.queryParameters['relay'];
|
|
final code = uri.queryParameters['code'];
|
|
if (relay == null || relay.isEmpty || code == null || code.isEmpty) {
|
|
return null;
|
|
}
|
|
final relayUri = Uri.tryParse(relay);
|
|
if (relayUri == null ||
|
|
(relayUri.scheme != 'ws' && relayUri.scheme != 'wss') ||
|
|
relayUri.host.isEmpty ||
|
|
relayUri.userInfo.isNotEmpty ||
|
|
relayUri.hasFragment) {
|
|
return null;
|
|
}
|
|
try {
|
|
validateInviteRelayUri(relayUri);
|
|
} on FormatException {
|
|
return null;
|
|
}
|
|
final normalizedRelay = Uri(
|
|
scheme: relayUri.scheme,
|
|
host: relayUri.host,
|
|
port: relayUri.hasPort ? relayUri.port : null,
|
|
).toString();
|
|
final policyReceipt = uri.queryParameters['policy_receipt'];
|
|
return InviteDeepLink(
|
|
relayUrl: normalizedRelay,
|
|
code: code,
|
|
policyReceipt: policyReceipt == null || policyReceipt.isEmpty
|
|
? null
|
|
: policyReceipt,
|
|
);
|
|
}
|
|
|
|
if (uri.scheme == 'https' || uri.scheme == 'http') {
|
|
if (uri.host.isEmpty) return null;
|
|
final segments = uri.pathSegments;
|
|
if (segments.length != 2 ||
|
|
segments[0] != 'invite' ||
|
|
segments[1].isEmpty) {
|
|
return null;
|
|
}
|
|
final relayScheme = uri.scheme == 'https' ? 'wss' : 'ws';
|
|
final relayUri = Uri(
|
|
scheme: relayScheme,
|
|
host: uri.host,
|
|
port: uri.hasPort ? uri.port : null,
|
|
);
|
|
try {
|
|
validateInviteRelayUri(relayUri);
|
|
} on FormatException {
|
|
return null;
|
|
}
|
|
final relay = Uri(
|
|
scheme: relayScheme,
|
|
host: uri.host,
|
|
port: uri.hasPort ? uri.port : null,
|
|
).toString();
|
|
return InviteDeepLink(relayUrl: relay, code: segments[1]);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/// Parse any supported Buzz deep link.
|
|
BuzzDeepLink? parseBuzzDeepLink(Uri uri) =>
|
|
parseInviteDeepLink(uri) ??
|
|
parseChannelDeepLink(uri) ??
|
|
parseMessageDeepLink(uri);
|
|
|
|
/// A validated Buzz repository, pull request, or issue permalink.
|
|
class EntityDeepLink extends BuzzDeepLink {
|
|
final String type;
|
|
final String owner;
|
|
final String repository;
|
|
final String? eventId;
|
|
|
|
const EntityDeepLink({
|
|
required this.type,
|
|
required this.owner,
|
|
required this.repository,
|
|
this.eventId,
|
|
});
|
|
}
|
|
|
|
/// Parse canonical `buzz://repo|pr|issue` permalinks for inline presentation.
|
|
EntityDeepLink? parseEntityDeepLink(Uri uri) {
|
|
if (uri.scheme != 'buzz' || !{'repo', 'pr', 'issue'}.contains(uri.host)) {
|
|
return null;
|
|
}
|
|
if (uri.path.isNotEmpty ||
|
|
uri.hasFragment ||
|
|
uri.userInfo.isNotEmpty ||
|
|
uri.hasPort) {
|
|
return null;
|
|
}
|
|
final allowed = uri.host == 'repo' ? {'owner', 'd'} : {'id', 'owner', 'd'};
|
|
final queryParameters = uri.queryParametersAll;
|
|
final parameterKeys = queryParameters.keys.toSet();
|
|
if (parameterKeys.difference(allowed).isNotEmpty ||
|
|
allowed.difference(parameterKeys).isNotEmpty ||
|
|
allowed.any((key) => queryParameters[key]?.length != 1)) {
|
|
return null;
|
|
}
|
|
final owner = uri.queryParameters['owner'];
|
|
final repository = uri.queryParameters['d'];
|
|
final eventId = uri.queryParameters['id'];
|
|
final hex = RegExp(r'^[0-9a-f]{64}$', caseSensitive: false);
|
|
final repositoryName = RegExp(r'^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$');
|
|
if (owner == null ||
|
|
!hex.hasMatch(owner) ||
|
|
repository == null ||
|
|
!repositoryName.hasMatch(repository) ||
|
|
repository.contains('..')) {
|
|
return null;
|
|
}
|
|
if (uri.host != 'repo' && (eventId == null || !hex.hasMatch(eventId))) {
|
|
return null;
|
|
}
|
|
return EntityDeepLink(
|
|
type: uri.host,
|
|
owner: owner.toLowerCase(),
|
|
repository: repository,
|
|
eventId: eventId?.toLowerCase(),
|
|
);
|
|
}
|