Files
buzz/mobile/lib/shared/hosted/browser_auth.dart
Tom Brow db4478e8d2 feat(mobile): organization sign-in for NIP-FI relays (#8700)
Block is turning on NIP-FI enforcement on the Block relay. Desktop gets
organization sign-in in block/buzz-app#1424. Mobile can already attach
NIP-FI assertions, but only for Builderlab-hosted communities, through
the build's single Builderlab account. The dogfood build needs that
account for public hosted communities, so it can't simply be pointed at
the Block tenant.

This adds a separate **organization realm**, configured at build time:

- `BUZZ_ORGANIZATION_URL`: the tenant's HTTPS origin (for example
`https://block.builderlab.xyz`).
- `BUZZ_ORGANIZATION_RELAYS`: the exact relay hosts that trust that
tenant.

The two must be set together. The app refuses to start if they're
malformed, overlap a hosted community, or reuse the hosted origin.
Without them, nothing changes.

For a configured relay:

- The app keeps its own organization session and signs in through the
browser at the tenant's existing login (`/api/goose/v1/auth/login`).
Block SSO happens there.
- It requests assertions from the same `/v1/buzz/identity/assertions`
route that hosted communities use, and attaches them to the relay
socket, HTTP, media, huddle and remote-agent requests.
- Unlike the hosted path, it doesn't require an identity backup before
the first binding. As on desktop, the tenant binds the member's existing
key on first issuance. A key already bound to a different one is refused
before any request is sent.
- When signed out, it connects without an assertion and lets the relay
decide. A bottom banner offers **Sign in**. After sign-in, the relay
reconnects with a fresh assertion. Hosted communities keep their
existing banner and flow.

The tenant accepts only the registered
`xyz.block.buzz.mobile:/auth/callback` return URL, so both realms share
it. Each `BrowserAuth` owner leaves callbacks whose `state` belongs to
another owner's attempt to that owner.

### Before merge

- [ ] Kenny Lopez reviews the visible changes.

### Validation

Added tests (`organization_relay_auth_test.dart`):

- Configuration parsing and exact host matching.
- An assertion is issued for the exact relay and key, then cached.
- A different bound key is refused.
- Signed out connects without an assertion.
- Other relays never receive the assertion.
- The shared callback is routed between the hosted and organization
owners.

Full `mobile-check` and `mobile-test` pass. RunnerTests pass locally
except `testNativeNavigationTitleExpandsAgainAtTop`, which this PR
doesn't touch.

Added tests (`organization_sign_in_test.dart`,
`relay_auth_isolation_test.dart`, `builderlab_account_test.dart`), each
failing without its fix:

- Concurrent account restores at cold start share one adopted account.
- An exchange from a cancelled attempt never changes a newer sign-in.
- Storage failures while clearing the intent or cancelling leave the
busy state.
- An unreadable saved organization session is replaced by signing in
again.
- A stalled organization issuer never delays a hosted relay's assertion.
This test needs `BUZZ_AUTH_DOMAINS` and skips without it. CI's
configured-auth-domains step doesn't list it yet, because that workflow
change needs a token with `workflow` scope.

Added tests also cover a restore after an offline start (the banner
clears once a relay retry restores the session) and the iOS bridge
allowlist (`/auth/native` and tenant login on Builderlab subdomains;
other hosts, paths, ports, userinfo and fragments refused).

Simulator (iPhone 17, iOS 27) with the dogfood defines against the
production Block relay `buzz.block.builderlab.xyz`, on a WARP Mac:

- The app starts with the organization configuration and connects to the
relay while signed out, showing the organization **Sign in** banner.
- **Sign in** opens the system sign-in session for
`block.builderlab.xyz`, and the banner shows **Finishing organization
sign-in…**. Cancelling returns to **Sign in** with no error. Before the
bridge fix, no browser opened and the banner reported that sign-in did
not finish.
- The bottom banners (organization sign-in, hosted reconnect, and the
sign-in recovery row) now sit above Home's floating Search/New bar,
which used to cover **Sign in**. A journey test checks the banner clears
the bar, and fails without the fix.

![Home with the organization sign-in banner above the floating
bar](https://github.com/user-attachments/assets/c6ab74f4-3d88-4fe0-ae16-042a548056fe)
- The simulator run stopped at the system consent prompt (SSO does not
work in the simulator). The app calls were driven through the VM service
(the same `signIn()`/`cancel()` the banner buttons call) because the
simulator could not be tapped.

Device (iPhone 12 mini) against bb-block staging in enforce mode, where
every probe without an assertion gets 401:

- Signed out, the organization banner shows and the app stays
responsive. Cancel at the consent prompt returns to **Sign in**, and
retry works.
- Block SSO through Okta completes, and the relay admits the reconnect
with the assertion.
- After relaunch the app connects, loads channel history, and shows no
banner for over 60 seconds.
- Before the restore fix, 2 of 4 cold starts showed "cannot use this
community with this key" although the session was valid. With it, 8 of 8
cold starts connected.

Known limitation: adding an enforcing organization relay by community
link is tracked in #8791.

The dogfood build enables this in squareup/buzz-releases
(`tomb/dogfood-organization-sign-in`). App Store builds stay unchanged.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Tom Brow <tomb@squareup.com>
Co-authored-by: Tom Brow <tomb@squareup.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-01 07:23:12 -08:00

334 lines
11 KiB
Dart

import '../storage/serial_queue.dart';
import 'dart:async';
import 'dart:convert';
import 'dart:math';
import 'package:app_links/app_links.dart';
import 'package:crypto/crypto.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';
import '../storage/secure_storage.dart';
import 'hosted_environment.dart';
/// Safe to show as a generic retry prompt. Never carries a URL or server text.
enum BrowserAuthFailure { restartLogin, cancelled, unavailable, storage }
class BrowserAuthCode {
const BrowserAuthCode(this.code, this.verifier, this.intent);
final String code;
final String verifier;
final Map<String, String> intent;
}
/// One app-scoped owner per account origin. Subscribe to [codes] and
/// [failures] before [initialize]. Callbacks bypass the community deep-link
/// FIFO. A consumed code is never replayed automatically: exchange failure
/// requires a fresh browser login.
///
/// Every origin shares the one registered [callback], so an owner leaves a
/// callback whose state belongs to another live owner's attempt to that owner.
class BrowserAuth {
BrowserAuth({
FlutterSecureStorage? storage,
Future<String?> Function(Uri)? openBrowser,
DateTime Function()? now,
Uri? origin,
}) : _storage = storage ?? accountSecureStorage,
_openBrowser = openBrowser ?? _openPlatformBrowser,
_now = now ?? DateTime.now,
origin = origin ?? HostedEnvironment.origin {
_owners.add(this);
}
static const callback = 'xyz.block.buzz.mobile:/auth/callback';
static final _owners = <BrowserAuth>{};
/// The account origin this owner signs in to.
final Uri origin;
late final _attemptKey = 'buzz_browser_auth_attempt_v1_${origin.host}';
late final _intentKey = 'buzz_browser_auth_intent_v1_${origin.host}';
static const _channel = MethodChannel('buzz/browser_auth');
final FlutterSecureStorage _storage;
final Future<String?> Function(Uri) _openBrowser;
final DateTime Function() _now;
final _codes = StreamController<BrowserAuthCode>.broadcast();
final _failures = StreamController<BrowserAuthFailure>.broadcast();
Stream<BrowserAuthCode> get codes => _codes.stream;
Stream<BrowserAuthFailure> get failures => _failures.stream;
StreamSubscription<Uri>? _links;
final _queue = SerialQueue();
bool _disposed = false;
bool _initialized = false;
int _generation = 0;
String? _activeState;
String? _consumedCallbackHash;
String? _consumedState;
Future<T> _serial<T>(Future<T> Function() task) {
final result = _queue.run(() {
if (_disposed) throw BrowserAuthFailure.cancelled;
return task();
});
return result;
}
Future<void> initialize() async {
if (_initialized || _disposed) return;
_initialized = true;
final links = AppLinks();
_links = links.uriLinkStream.listen((uri) {
if (uri.scheme == 'xyz.block.buzz.mobile') {
unawaited(receive(uri).catchError((Object _) {}));
}
}, onError: (Object _) => _fail(BrowserAuthFailure.unavailable));
try {
final initial = await links.getInitialLink();
if (initial != null && initial.scheme == 'xyz.block.buzz.mobile') {
await receive(initial);
}
} catch (_) {
_fail(BrowserAuthFailure.unavailable);
}
}
/// Intent is opaque to authentication; callers validate its relay/challenge
/// before acting. Retained separately so missing state never loses navigation.
Future<Map<String, String>?> retainedIntent() => _serial(() async {
try {
final raw = await _storage.read(key: _intentKey);
if (raw == null) return null;
return Map<String, String>.from(jsonDecode(raw) as Map);
} catch (_) {
throw BrowserAuthFailure.storage;
}
});
/// Persist setup intent before remote work or acknowledging key transfer.
Future<void> retainIntent(Map<String, String> intent) => _serial(() async {
final raw = jsonEncode(intent);
if (raw.length > 16384) throw BrowserAuthFailure.storage;
await _storage.write(key: _intentKey, value: raw);
if (await _storage.read(key: _intentKey) != raw) {
throw BrowserAuthFailure.storage;
}
});
Future<void> start(Map<String, String> intent) async {
final generation = ++_generation;
final uri = await _serial(() async {
if (jsonEncode(intent).length > 16384) throw BrowserAuthFailure.storage;
final random = Random.secure();
String secret() => base64UrlEncode(
List.generate(32, (_) => random.nextInt(256)),
).replaceAll('=', '');
final verifier = secret();
final state = secret();
_activeState = state;
final record = jsonEncode({
'verifier': verifier,
'state': state,
'created': _now().toUtc().millisecondsSinceEpoch,
'intent': intent,
});
try {
await _storage.write(key: _intentKey, value: jsonEncode(intent));
await _storage.write(key: _attemptKey, value: record);
if (await _storage.read(key: _attemptKey) != record) {
throw BrowserAuthFailure.storage;
}
} catch (_) {
throw BrowserAuthFailure.storage;
}
return origin.replace(
path: '/api/goose/v1/auth/login',
queryParameters: {
'type': 'cli',
'product': 'buzz',
'returnTo': callback,
'state': state,
'code_challenge': base64UrlEncode(
sha256.convert(ascii.encode(verifier)).bytes,
).replaceAll('=', ''),
'code_challenge_method': 'S256',
},
);
});
if (_disposed || generation != _generation) return;
try {
final result = await _openBrowser(uri);
if (!_disposed && generation == _generation && result != null) {
await receive(Uri.parse(result));
}
} on PlatformException catch (error) {
if (generation == _generation) {
_fail(
error.code == 'cancelled'
? BrowserAuthFailure.cancelled
: BrowserAuthFailure.unavailable,
);
}
} catch (_) {
if (generation == _generation) _fail(BrowserAuthFailure.unavailable);
}
}
Future<void> receive(Uri uri) {
final generation = _generation;
return _serial(() async {
if (generation != _generation) return;
void fail(BrowserAuthFailure failure) {
if (generation == _generation) _fail(failure);
}
// Reject noncanonical destination and duplicate query fields before reading
// secrets. Neither invalid state nor malformed callbacks mutate the session.
final callbackHash = sha256
.convert(utf8.encode(uri.toString()))
.toString();
if (callbackHash == _consumedCallbackHash) return;
final query = uri.queryParametersAll;
if (uri.toString().split('?').first != callback ||
uri.hasFragment ||
query.values.any((v) => v.length != 1) ||
query.keys.any((k) => k != 'state' && k != 'code' && k != 'error')) {
if (_activeState == null) fail(BrowserAuthFailure.restartLogin);
return;
}
try {
final saved = await _storage.read(key: _attemptKey);
if (saved == null) {
if (!await _peerOwns(query['state']?.single)) {
fail(BrowserAuthFailure.restartLogin);
}
return;
}
final record = jsonDecode(saved) as Map<String, dynamic>;
final expectedState = record['state'];
if (expectedState is! String ||
!RegExp(r'^[A-Za-z0-9_-]{43}$').hasMatch(expectedState)) {
throw BrowserAuthFailure.storage;
}
// Another owner's callback never expires this owner's attempt.
if (query['state']?.single != expectedState) {
if (_activeState != expectedState &&
!await _peerOwns(query['state']?.single)) {
fail(BrowserAuthFailure.restartLogin);
}
return;
}
final age =
_now().toUtc().millisecondsSinceEpoch - (record['created'] as int);
if (age < 0 || age > const Duration(minutes: 10).inMilliseconds) {
fail(BrowserAuthFailure.restartLogin);
return;
}
if (generation != _generation) return;
final code = query['code']?.single;
if (query.containsKey('error') ||
code == null ||
code.isEmpty ||
code.length > 4096) {
fail(BrowserAuthFailure.restartLogin);
return;
}
final verifier = record['verifier'] as String;
if (!RegExp(r'^[A-Za-z0-9_-]{43}$').hasMatch(verifier)) {
throw BrowserAuthFailure.storage;
}
final intent = Map<String, String>.from(record['intent'] as Map);
// Claimed before the saved attempt disappears, so a peer checking
// ownership concurrently never sees neither.
_consumedState = expectedState;
await _storage.delete(key: _attemptKey);
if (await _storage.read(key: _attemptKey) != null) {
throw BrowserAuthFailure.storage;
}
_activeState = null;
_consumedCallbackHash = callbackHash;
if (!_disposed && generation == _generation) {
_codes.add(BrowserAuthCode(code, verifier, Map.unmodifiable(intent)));
}
} catch (_) {
fail(BrowserAuthFailure.storage);
}
});
}
Future<void> cancel() async {
++_generation;
_activeState = null;
if (defaultTargetPlatform == TargetPlatform.iOS ||
defaultTargetPlatform == TargetPlatform.android) {
try {
await _channel.invokeMethod<void>('cancel');
} catch (_) {
/* No session may be active. */
}
}
await _delete(_attemptKey);
}
/// Call only after completing or explicitly abandoning the retained intent.
Future<void> clearIntent() => _delete(_intentKey);
Future<void> _delete(String key) => _serial(() async {
try {
await _storage.delete(key: key);
} catch (_) {
throw BrowserAuthFailure.storage;
}
});
/// Whether another live owner has a saved attempt with this state.
Future<bool> _peerOwns(String? state) async {
if (state == null) return false;
for (final peer in _owners.toList()) {
if (identical(peer, this) || peer._disposed) continue;
if (peer._activeState == state || peer._consumedState == state) {
return true;
}
try {
final saved = await peer._storage.read(key: peer._attemptKey);
if (saved != null &&
(jsonDecode(saved) as Map<String, dynamic>)['state'] == state) {
return true;
}
// The peer may have consumed its attempt during the read.
if (peer._consumedState == state) return true;
} catch (_) {
// An unreadable peer attempt is that owner's failure to report.
}
}
return false;
}
void _fail(BrowserAuthFailure failure) {
if (!_disposed) _failures.add(failure);
}
Future<void> dispose() async {
_disposed = true;
_owners.remove(this);
++_generation;
await _links?.cancel();
await _codes.close();
await _failures.close();
}
static Future<String?> _openPlatformBrowser(Uri uri) async {
if (defaultTargetPlatform == TargetPlatform.iOS ||
defaultTargetPlatform == TargetPlatform.android) {
return _channel.invokeMethod<String>('start', {
'url': uri.toString(),
if (kDebugMode &&
const bool.fromEnvironment('BUZZ_DEBUG_PRIVATE_LOGIN'))
'ephemeral': 'true',
});
}
throw BrowserAuthFailure.unavailable;
}
}