Files
buzz/mobile/ios/BuzzPushKit/Sources/BuzzPushKit/BuzzPushNotificationResolver.swift
Logan Johnson 93761e411c fix(mobile): render push notification sender identity as npub (#7494)
🤖

## Summary

When an iOS push notification comes from someone the app has no cached
name for, the notification title showed the first characters of the
sender's raw public key — for example `aa4fc866…`. That fragment is
unreadable and doesn't match how the same person appears anywhere else
in Buzz. This PR changes that title to the compact form of the sender's
npub (npub is the human-readable encoding of a Nostr public key): first
8 and last 4 characters — for example `npub14f8…9nsy`, the same identity
shape used across the desktop and mobile apps.

- Unnamed senders: raw hex fragment → compact npub.
- Named senders: unchanged — a sender the app has a display name for
still titles the notification with that name.
- Unverifiable sender identities (malformed keys, or lookalike strings
that are not literal 64-hex-digit keys) now render a neutral "Someone"
instead of partial raw key material.
- Everything else about the notification is unchanged: body text,
subtitle, thread matching and grouping, deep-link navigation, thread
identifiers, and the internal hex public key the resolver matches on.

The native iOS notification-service package (`BuzzPushKit`) gains a
minimal in-house bech32 codec (bech32 is the checksummed string encoding
npubs use) — checksum-validated, 32-byte keys only, and no new external
dependency. The hex input branch accepts exactly a 64 ASCII hex digit
key before any parsing, so strings that merely parse like hex (for
example a run of `+a` pairs) cannot become a displayed identity; this is
input validation for presentation. Event signature verification is
untouched.

### Related issue

Fixes: N/A. Searched existing issues/PRs for push-notification npub
identity — closest related: none found.

### Testing

At head `3e3f2813b8864b76257ccb50dea3a4b31fa4de0d` (base
`44316ff72f5f7de014c66b01cbf534298a70c249`; 4 files, +321/−4):

- CI `Mobile Swift` lane, at this exact head — all passed: `swift test`
(73 tests, 0 failures), the SwiftPM debug and release builds of
`mobile/ios/BuzzPushKit`, and the unsigned iOS release build.
- Test coverage: npub encoding cross-checked against independent
nostr-rs/NIP-19 vectors; rejection of bad checksums, mixed case, wrong
lengths, invalid alphabet, padding, and non-32-byte payloads; resolver
boundary matrix — hex/npub/invalid sender keys render compact npub or
"Someone" while body, subtitle, sender key, and thread identifier pass
through; named senders keep cached display names.

### Task provenance

Buzz channel: `1f0e4a3d-7e01-4efe-bb16-843b357f85c9`

Task:
buzz://message?channel=1f0e4a3d-7e01-4efe-bb16-843b357f85c9&id=86b34eb4bd84a1472419e9af22636c011c0fe273e3c196f967d7a36996e149b6

---------

Signed-off-by: Logan Johnson <loganj@squareup.com>
Co-authored-by: Larry <627498bd4bd1f281a16431e3c6cce3b5c25b6692798c78672298aefbf2f8f8b5@buzz.block.builderlab.xyz>
2026-09-09 10:31:42 -04:00

655 lines
23 KiB
Swift

import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
/// Content resolved from unread Buzz events for a mutable push notification.
public struct BuzzPushResolution: Decodable, Equatable, Sendable {
public let title: String
public let body: String
public let subtitle: String?
public let threadIdentifier: String?
public let navigationTarget: BuzzPushNavigationTarget?
public let senderPubkey: String?
public let senderAvatarPNG: Data?
public let conversationIdentifier: String?
public let conversationDisplayName: String?
/// Exact verified recipient count for Communication Notifications specialization.
public let conversationRecipientCount: Int?
public init(
title: String,
body: String,
subtitle: String?,
threadIdentifier: String?,
navigationTarget: BuzzPushNavigationTarget? = nil,
senderPubkey: String? = nil,
senderAvatarPNG: Data? = nil,
conversationIdentifier: String? = nil,
conversationDisplayName: String? = nil,
conversationRecipientCount: Int? = nil
) {
self.title = title
self.body = body
self.subtitle = subtitle
self.threadIdentifier = threadIdentifier
self.navigationTarget = navigationTarget
self.senderPubkey = senderPubkey
self.senderAvatarPNG = senderAvatarPNG
self.conversationIdentifier = conversationIdentifier
self.conversationDisplayName = conversationDisplayName
self.conversationRecipientCount = conversationRecipientCount
}
}
/// Resolves the content used to mutate a generic Buzz push notification.
public protocol BuzzPushNotificationResolving {
func resolve(completion: @escaping (BuzzPushResolution?) -> Void)
}
/// Reads configured Buzz communities and resolves their newest unread event.
public final class BuzzPushNotificationResolver: BuzzPushNotificationResolving {
// Verified profiles may carry bounded inline raster avatars. Keep the refresh
// response capped, but large enough to recover the sender name from those
// otherwise valid kind-0 events when the app cache has not been populated.
static let maximumPresentationResponseBytes = 256 * 1_024
private let session: URLSession
private let loadCommunitiesData: () -> Data?
private let loadPresentationCacheData: () -> Data?
private let loadPrivateKey: (String) -> String?
private let now: () -> Date
private let presentationCacheLifetime: TimeInterval
/// Creates a resolver around the notification extension's App Group and Keychain I/O.
public init(
session: URLSession,
loadCommunitiesData: @escaping () -> Data?,
loadPrivateKey: @escaping (String) -> String?,
loadPresentationCacheData: @escaping () -> Data? = { nil },
now: @escaping () -> Date = Date.init,
presentationCacheLifetime: TimeInterval = BuzzPushPresentationCacheStore.freshnessLifetime
) {
self.session = session
self.loadCommunitiesData = loadCommunitiesData
self.loadPresentationCacheData = loadPresentationCacheData
self.loadPrivateKey = loadPrivateKey
self.now = now
self.presentationCacheLifetime = presentationCacheLifetime
}
public func resolve(completion: @escaping (BuzzPushResolution?) -> Void) {
let communities = loadCommunities().filter {
$0.pubkey?.isEmpty == false
&& loadPrivateKey($0.id) != nil
&& !$0.policies.isEmpty
}
guard !communities.isEmpty else {
completion(nil)
return
}
let group = DispatchGroup()
let lock = NSLock()
var candidates: [(VerifiedNostrEvent, PushLeaseCommunity)] = []
for community in communities {
group.enter()
query(community) { candidate in
if let candidate {
lock.lock()
candidates.append(candidate)
lock.unlock()
}
group.leave()
}
}
group.notify(queue: .global(qos: .userInitiated)) {
let newest = candidates.max {
$0.0.createdAt == $1.0.createdAt ? $0.0.id > $1.0.id : $0.0.createdAt < $1.0.createdAt
}
guard let newest else {
completion(nil)
return
}
self.resolvePresentation(event: newest.0, community: newest.1, completion: completion)
}
}
private func query(
_ community: PushLeaseCommunity,
completion: @escaping ((VerifiedNostrEvent, PushLeaseCommunity)?) -> Void
) {
guard let privateKey = loadPrivateKey(community.id), community.pubkey?.isEmpty == false else {
completion(nil)
return
}
guard
!community.policies.isEmpty,
let relayURL = community.relayURL,
let url = URL(string: "/query", relativeTo: relayURL),
let body = try? JSONSerialization.data(
withJSONObject: community.policies.map { $0.filter.queryFilter(since: nil, limit: 10) }
)
else {
completion(nil)
return
}
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.httpBody = body
request.timeoutInterval = 8
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
guard
let auth = try? NostrHTTPAuth.authorizationHeader(
url: url, method: "POST", body: body, privateKeyHex: privateKey
)
else {
completion(nil)
return
}
request.setValue(auth, forHTTPHeaderField: "Authorization")
session.dataTask(with: request) { data, response, _ in
guard let response = response as? HTTPURLResponse, (200..<300).contains(response.statusCode),
let data, let events = try? JSONDecoder().decode([VerifiedNostrEvent].self, from: data)
else {
completion(nil)
return
}
let candidate = Self.newestMessage(
events: events.filter { event in
event.hasValidIDAndSignature()
&& community.policies.contains { policy in
PushLeaseMatcher.matches(event: event, policy: policy)
}
},
community: community
)
completion(candidate.map { ($0, community) })
}.resume()
}
private func resolvePresentation(
event: VerifiedNostrEvent,
community: PushLeaseCommunity,
completion: @escaping (BuzzPushResolution?) -> Void
) {
let snapshot = BuzzPushPresentationCacheSnapshot.decode(loadPresentationCacheData())
let relayOrigin = BuzzPushPresentationCacheStore.canonicalRelayOrigin(community.relayUrl)
let cachedProfile = relayOrigin.flatMap {
snapshot.profile(
communityID: community.id,
relayOrigin: $0,
pubkey: event.pubkey
)
}
let channelID = Self.tagValue("h", in: event)
let relayMetadataPubkey = community.relayMetadataPubkey?.lowercased()
let cachedChannel = channelID.flatMap { channelID in
relayOrigin.flatMap {
snapshot.channel(
communityID: community.id,
relayOrigin: $0,
channelID: channelID
)
}
}.flatMap { channel in
channel.relayMetadataPubkey == relayMetadataPubkey ? channel : nil
}
let timestamp = Int(now().timeIntervalSince1970)
let profileNeedsRefresh = Self.isStale(
cachedAt: cachedProfile?.cachedAt,
now: timestamp,
lifetime: presentationCacheLifetime
)
let membershipNeedsRefresh: Bool = {
guard let cachedChannel else { return true }
if Self.isStale(
cachedAt: cachedChannel.membershipCachedAt,
now: timestamp,
lifetime: presentationCacheLifetime
) {
return true
}
guard let memberCount = cachedChannel.memberCount else { return true }
guard memberCount <= BuzzPushPresentationCacheStore.maximumMembersPerChannel
else { return false }
return cachedChannel.memberDigests?.count != memberCount
}()
let channelNeedsRefresh =
channelID != nil
&& (Self.isStale(
cachedAt: cachedChannel?.cachedAt,
now: timestamp,
lifetime: presentationCacheLifetime
) || membershipNeedsRefresh)
let fallback = Self.makeResolution(
event: event,
community: community,
profile: cachedProfile,
channel: cachedChannel
)
guard profileNeedsRefresh || channelNeedsRefresh else {
completion(fallback)
return
}
refreshPresentation(
event: event,
community: community,
refreshProfile: profileNeedsRefresh,
refreshChannel: channelNeedsRefresh
) { refreshedProfileEvent, refreshedChannelEvent, refreshedMembershipEvent in
let profile =
refreshedProfileEvent.flatMap {
guard
BuzzPushPresentationCacheStore.shouldReplace(
existingCreatedAt: cachedProfile?.eventCreatedAt,
existingID: cachedProfile?.eventID,
candidateCreatedAt: $0.createdAt,
candidateID: $0.id
)
else { return nil }
return Self.ephemeralProfile(
event: $0,
communityID: community.id,
relayOrigin: relayOrigin ?? community.relayUrl,
cached: cachedProfile,
cachedAt: timestamp
)
} ?? cachedProfile
let newerChannelEvent: VerifiedNostrEvent? = refreshedChannelEvent.flatMap { event in
guard
BuzzPushPresentationCacheStore.shouldReplace(
existingCreatedAt: cachedChannel?.eventCreatedAt,
existingID: cachedChannel?.eventID,
candidateCreatedAt: event.createdAt,
candidateID: event.id
)
else { return nil }
return event
}
let newerMembershipEvent: VerifiedNostrEvent? = refreshedMembershipEvent.flatMap { event in
guard
BuzzPushPresentationCacheStore.shouldReplace(
existingCreatedAt: cachedChannel?.membershipEventCreatedAt,
existingID: cachedChannel?.membershipEventID,
candidateCreatedAt: event.createdAt,
candidateID: event.id
)
else { return nil }
return event
}
let channel =
relayMetadataPubkey.flatMap {
Self.ephemeralChannel(
metadataEvent: newerChannelEvent,
membershipEvent: newerMembershipEvent,
cached: cachedChannel,
communityID: community.id,
relayOrigin: relayOrigin ?? community.relayUrl,
relayMetadataPubkey: $0,
cachedAt: timestamp
)
} ?? cachedChannel
completion(
Self.makeResolution(
event: event,
community: community,
profile: profile,
channel: channel
) ?? fallback
)
}
}
private func refreshPresentation(
event: VerifiedNostrEvent,
community: PushLeaseCommunity,
refreshProfile: Bool,
refreshChannel: Bool,
completion:
@escaping (
VerifiedNostrEvent?, VerifiedNostrEvent?, VerifiedNostrEvent?
) -> Void
) {
guard let privateKey = loadPrivateKey(community.id),
let relayURL = community.relayURL,
let url = URL(string: "/query", relativeTo: relayURL)
else {
completion(nil, nil, nil)
return
}
let channelID = Self.tagValue("h", in: event)
let relayMetadataPubkey = community.relayMetadataPubkey?.lowercased()
var filters: [[String: Any]] = []
if refreshProfile {
filters.append(["kinds": [0], "authors": [event.pubkey.lowercased()], "limit": 1])
}
if refreshChannel, let channelID, let relayMetadataPubkey {
filters.append([
"kinds": [39_000],
"authors": [relayMetadataPubkey],
"#d": [channelID],
"limit": 1,
])
filters.append([
"kinds": [39_002],
"authors": [relayMetadataPubkey],
"#d": [channelID],
"limit": 1,
])
}
guard !filters.isEmpty,
let body = try? JSONSerialization.data(withJSONObject: filters)
else {
completion(nil, nil, nil)
return
}
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.httpBody = body
// A verified kind-0 profile may include a bounded inline raster avatar.
// Railway can take longer than one second to return that larger response,
// while three seconds remains a small fraction of the NSE execution budget.
request.timeoutInterval = 3
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
guard
let auth = try? NostrHTTPAuth.authorizationHeader(
url: url,
method: "POST",
body: body,
privateKeyHex: privateKey
)
else {
completion(nil, nil, nil)
return
}
request.setValue(auth, forHTTPHeaderField: "Authorization")
session.downloadTask(with: request) { fileURL, response, _ in
guard let response = response as? HTTPURLResponse,
(200..<300).contains(response.statusCode),
let fileURL,
let values = try? fileURL.resourceValues(forKeys: [.fileSizeKey]),
let fileSize = values.fileSize,
fileSize <= Self.maximumPresentationResponseBytes,
let data = try? Data(contentsOf: fileURL),
let events = try? JSONDecoder().decode([VerifiedNostrEvent].self, from: data)
else {
completion(nil, nil, nil)
return
}
let verified = events.filter { $0.hasValidIDAndSignature() }
let profile =
refreshProfile
? Self.newest(
verified.filter {
$0.kind == 0 && $0.pubkey.lowercased() == event.pubkey.lowercased()
}) : nil
let channel =
refreshChannel
? channelID.flatMap { channelID in
Self.newest(
verified.filter {
$0.kind == 39_000
&& $0.pubkey.lowercased() == relayMetadataPubkey
&& Self.tagValue("d", in: $0) == channelID
})
} : nil
let membership =
refreshChannel
? channelID.flatMap { channelID in
Self.newest(
verified.filter {
$0.kind == 39_002
&& $0.pubkey.lowercased() == relayMetadataPubkey
&& Self.tagValue("d", in: $0) == channelID
})
} : nil
completion(profile, channel, membership)
}.resume()
}
static func decodeResolution(
events: [VerifiedNostrEvent], community: PushLeaseCommunity
) -> (BuzzPushResolution, VerifiedNostrEvent)? {
let event = newestMessage(events: events, community: community)
guard let event else { return nil }
guard
let resolution = makeResolution(
event: event,
community: community,
profile: nil,
channel: nil
)
else { return nil }
return (resolution, event)
}
private static func newestMessage(
events: [VerifiedNostrEvent],
community: PushLeaseCommunity
) -> VerifiedNostrEvent? {
guard let mine = community.pubkey?.lowercased() else { return nil }
return events.filter {
$0.pubkey.lowercased() != mine && [9, 40002, 45001, 45003].contains($0.kind)
}.sorted {
$0.createdAt == $1.createdAt ? $0.id < $1.id : $0.createdAt > $1.createdAt
}.first
}
private static func makeResolution(
event: VerifiedNostrEvent,
community: PushLeaseCommunity,
profile: BuzzPushCachedProfile?,
channel: BuzzPushCachedChannel?
) -> BuzzPushResolution? {
let body = previewBody(event.content)
guard !body.isEmpty else { return nil }
let channelID = tagValue("h", in: event)
let conversationIdentifier = channelID.map {
BuzzPushPresentationIdentity.conversation(communityID: community.id, channelID: $0)
}
let conversation = channel.flatMap {
communicationConversation(event: event, community: community, channel: $0)
}
return BuzzPushResolution(
title: profile?.displayName ?? shortPubkey(event.pubkey),
body: body,
subtitle: community.name,
threadIdentifier: conversationIdentifier ?? community.id,
navigationTarget: channelID.map {
BuzzPushNavigationTarget(
eventID: event.id,
communityID: community.id,
channelID: $0
)
},
senderPubkey: event.pubkey.lowercased(),
senderAvatarPNG: profile?.avatarPNG,
conversationIdentifier: conversationIdentifier,
conversationDisplayName: conversation?.displayName,
conversationRecipientCount: conversation?.recipientCount
)
}
private static func ephemeralProfile(
event: VerifiedNostrEvent,
communityID: String,
relayOrigin: String,
cached: BuzzPushCachedProfile?,
cachedAt: Int
) -> BuzzPushCachedProfile {
let metadata = BuzzPushPresentationCacheStore.profileMetadata(event)
return BuzzPushCachedProfile(
communityID: communityID,
relayOrigin: relayOrigin,
pubkey: event.pubkey.lowercased(),
displayName: metadata.displayName,
pictureHash: metadata.pictureHash,
avatarPNG: cached?.pictureHash == metadata.pictureHash ? cached?.avatarPNG : nil,
eventID: event.id,
eventCreatedAt: event.createdAt,
cachedAt: cachedAt
)
}
private static func ephemeralChannel(
metadataEvent: VerifiedNostrEvent?,
membershipEvent: VerifiedNostrEvent?,
cached: BuzzPushCachedChannel?,
communityID: String,
relayOrigin: String,
relayMetadataPubkey: String,
cachedAt: Int
) -> BuzzPushCachedChannel? {
guard metadataEvent != nil || cached != nil else { return nil }
let channelID = metadataEvent.flatMap { tagValue("d", in: $0) } ?? cached?.channelID
guard let channelID, !channelID.isEmpty,
let eventID = metadataEvent?.id ?? cached?.eventID,
let eventCreatedAt = metadataEvent?.createdAt ?? cached?.eventCreatedAt,
let metadataCachedAt = metadataEvent == nil ? cached?.cachedAt : cachedAt
else { return nil }
let membership = membershipEvent.flatMap {
BuzzPushPresentationCacheStore.normalizedChannelMembership(
$0,
communityID: communityID,
channelID: channelID
)
}
let acceptedMembershipEvent = membership == nil ? nil : membershipEvent
return BuzzPushCachedChannel(
communityID: communityID,
relayOrigin: relayOrigin,
channelID: channelID,
relayMetadataPubkey: relayMetadataPubkey,
displayName: metadataEvent.map {
BuzzPushPresentationCacheStore.normalizedDisplayName(tagValue("name", in: $0))
} ?? cached?.displayName,
channelType: metadataEvent.map {
BuzzPushPresentationCacheStore.normalizedChannelType(tagValue("t", in: $0))
} ?? cached?.channelType,
memberCount: membership?.count ?? cached?.memberCount,
memberDigests: membership?.digests ?? cached?.memberDigests,
membershipEventID: acceptedMembershipEvent?.id ?? cached?.membershipEventID,
membershipEventCreatedAt: acceptedMembershipEvent?.createdAt
?? cached?.membershipEventCreatedAt,
membershipCachedAt: acceptedMembershipEvent == nil
? cached?.membershipCachedAt : cachedAt,
eventID: eventID,
eventCreatedAt: eventCreatedAt,
cachedAt: metadataCachedAt
)
}
private static func communicationConversation(
event: VerifiedNostrEvent,
community: PushLeaseCommunity,
channel: BuzzPushCachedChannel
) -> (displayName: String?, recipientCount: Int)? {
guard let currentUser = community.pubkey?.lowercased(),
let memberCount = channel.memberCount,
let memberDigests = channel.memberDigests,
memberDigests.count == memberCount
else { return nil }
let currentUserDigest = BuzzPushPresentationIdentity.channelMember(
communityID: community.id,
channelID: channel.channelID,
pubkey: currentUser
)
guard memberDigests.contains(currentUserDigest) else { return nil }
let senderDigest = BuzzPushPresentationIdentity.channelMember(
communityID: community.id,
channelID: channel.channelID,
pubkey: event.pubkey
)
let senderIsMember = memberDigests.contains(senderDigest)
let recipientCount = memberCount - (senderIsMember ? 1 : 0)
guard recipientCount > 0 else { return nil }
if channel.channelType == "dm" {
guard memberCount == 2, senderIsMember else { return nil }
return (nil, recipientCount)
}
guard let channelType = channel.channelType,
["stream", "forum"].contains(channelType),
let displayName = channel.displayName
else { return nil }
return (displayName.hasPrefix("#") ? displayName : "#\(displayName)", recipientCount)
}
private static func newest(_ events: [VerifiedNostrEvent]) -> VerifiedNostrEvent? {
events.sorted {
$0.createdAt == $1.createdAt ? $0.id < $1.id : $0.createdAt > $1.createdAt
}.first
}
private static func tagValue(_ name: String, in event: VerifiedNostrEvent) -> String? {
event.tags.first { $0.count >= 2 && $0[0] == name }?[1]
}
private static func isStale(
cachedAt: Int?,
now: Int,
lifetime: TimeInterval
) -> Bool {
guard let cachedAt else { return true }
return TimeInterval(max(0, now - cachedAt)) > lifetime
}
static func previewBody(_ content: String) -> String {
var result = content.replacingOccurrences(
of: #"```[\s\S]*?```"#, with: "[code]", options: .regularExpression)
result = result.replacingOccurrences(of: #"`([^`]*)`"#, with: "$1", options: .regularExpression)
result = result.replacingOccurrences(
of: #"!?\[([^\]]*)\]\([^)]*\)"#, with: "$1", options: .regularExpression)
result = result.replacingOccurrences(
of: #"https?://\S+"#, with: "[link]", options: .regularExpression)
result = result.replacingOccurrences(of: #"\s+"#, with: " ", options: .regularExpression)
.trimmingCharacters(in: .whitespacesAndNewlines)
return result.count > 180
? String(result.prefix(177)).trimmingCharacters(in: .whitespacesAndNewlines) + "…" : result
}
/// Compact sender label for unnamed senders: the first 8 and last 4
/// characters of the sender's full npub, matching the compact npub shape
/// used across Buzz. A key that cannot be encoded as an npub falls back to
/// the neutral "Someone" identity so malformed payloads leak no key
/// material while the notification keeps a useful title.
static func shortPubkey(_ pubkey: String) -> String {
guard let npub = Bech32.canonicalNpub(from: pubkey) else { return "Someone" }
return npub.count > 12
? String(npub.prefix(8)) + "…" + String(npub.suffix(4)) : npub
}
private func loadCommunities() -> [PushLeaseCommunity] {
guard let data = loadCommunitiesData(),
let decoded = try? JSONDecoder().decode(PushLeaseSnapshot.self, from: data)
else { return [] }
return decoded.communities
}
}
extension PushLeaseCommunity {
var relayURL: URL? {
guard var components = URLComponents(string: relayUrl),
components.host?.isEmpty == false,
components.user == nil,
components.password == nil,
components.query == nil,
components.fragment == nil,
components.path.isEmpty || components.path == "/"
else { return nil }
components.scheme =
switch components.scheme?.lowercased() {
case "wss": "https"
case "ws": "http"
case "https": "https"
case "http": "http"
default: nil
}
components.path = ""
return components.url
}
}