Webpush requests #1613

p1gp1g · 2025-08-27T09:29:38Z

This PR is based on #1612

It adds a WebPush push provider and do the web push requests

It doesn't contain the VAPID authorization yet (as the proposed implementation was using extras, that may be dropped)

epoberezkin · 2025-08-29T09:32:10Z

src/Simplex/Messaging/Notifications/Server/Env.hs

+  logDebug "New WP Client requested"
+  manager <- newManager tlsManagerSettings
+  let c = wpPushProviderClient manager
+  atomically $ TM.insert PPWebPush c pushClients


I don't think it'll work, even if the user can only use one push provider, all users can use different push providers, so the server should store in the map all of them, and either the key should be different or push provider should include endpoint (which is probably better, as endpoint is also part of token definition)

so what would happen is that it would be pushing to a random push server

It includes a single pusher but this pusher will request different URL based on the WPDeviceToken

src/Simplex/Messaging/Crypto.hs

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

epoberezkin · 2025-08-29T11:13:02Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+wpPushProviderClient :: Manager -> PushProviderClient
+wpPushProviderClient mg tkn pn = do
+      e <- endpoint tkn
+      r <- liftPPWPError $ parseUrlThrow $ B.unpack e.endpoint


this parsing needs to happen when token is received, and converted to type that doesn't require parsing at a point of sending notification

epoberezkin · 2025-08-29T11:40:31Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+wpEncrypt auth uaPubKS clearT = do
+  salt :: B.ByteString <- liftIO $ getRandomBytes 16
+  asPrivK <- liftIO $ ECDH.generatePrivate $ ECC.getCurveByName ECC.SEC_p256r1
+  uaPubK <- point uaPubKS


this is effectively parsing, should be done in type parser, not here.

epoberezkin · 2025-08-29T11:55:05Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+
+wpPushProviderClient :: Manager -> PushProviderClient
+wpPushProviderClient mg tkn pn = do
+      e <- endpoint tkn


that also should not be failing

epoberezkin · 2025-08-29T11:56:25Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+        , requestBody = RequestBodyBS encBody
+        , redirectCount = 0
+      }
+      _ <- liftPPWPError $ httpNoBody req mg


this doesn't seem to use TLS

see comment above

epoberezkin · 2025-08-29T12:15:03Z

src/Simplex/Messaging/Notifications/Server/Env.hs

+newWPPushClient :: NtfPushServer -> IO PushProviderClient
+newWPPushClient NtfPushServer {pushClients} = do
+  logDebug "New WP Client requested"
+  manager <- newManager tlsManagerSettings


need to use the same CA store that we use for APNS

TODO: validate if it uses default system store, most likely it does not.

It uses the default store:

ghci> man <- liftIO $ newManager tlsManagerSettings ghci> let req = "https://perdu.com" { proxy = Nothing } ghci> httpLbs req man Response {responseStatus = Status {statusCode = 200, statusMessage = "OK"}, responseVersion = HTTP/1.1, responseHeaders = [("Date","Thu, 04 Sep 2025 09:10:39 GMT"),("Content-Type","text/html"),("Content-Length","163"),("Connection","keep-alive"),("last-modified","Thu, 02 Jun 2016 06:01:08 GMT"),("etag","\"cc-5344555136fe9-gzip\""),("accept-ranges","bytes"),("Cache-Control","max-age=600"),("expires","Thu, 04 Sep 2025 09:20:39 GMT"),("vary","Accept-Encoding,User-Agent"),("Content-Encoding","gzip"),("Server","cloudflare"),("Nel","{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"),("cf-cache-status","DYNAMIC"),("Report-To","{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=IRxVE2a4P4b%2B9cRuL60q5q%2FHNbSTK7p%2FJcnjIl968IImjzem1ecVR9wcJyVY0bdIgpiFUAzHUvMXa0EJ%2FupmKHozM1qBUmD2jqFhUwdELqttVlE%3D\"}]}"),("CF-RAY","979c5ae08ed73e9e-MRS"),("alt-svc","h3=\":443\"; ma=86400")], responseBody = "<html><head><title>Vous Etes Perdu ?</title></head><body><h1>Perdu sur l'Internet ?</h1><h2>Pas de panique, on va vous aider</h2><strong><pre> * <----- vous êtes ici</pre></strong></body></html>\n", responseCookieJar = CJ {expose = []}, responseClose' = ResponseClose, responseOriginalRequest = Request { host = "perdu.com" port = 443 secure = True requestHeaders = [] path = "/" queryString = "" method = "GET" proxy = Nothing rawBody = False redirectCount = 10 responseTimeout = ResponseTimeoutDefault requestVersion = HTTP/1.1 proxySecureMode = ProxySecureWithConnect } } ghci> let req = "https://untrusted-root.badssl.com/" { proxy = Nothing } <interactive>:31:5: warning: [GHC-63397] [-Wname-shadowing] This binding for ‘req’ shadows the existing binding defined at <interactive>:19:5 ghci> httpLbs req man *** Exception: HttpExceptionRequest Request { host = "untrusted-root.badssl.com" port = 443 secure = True requestHeaders = [] path = "/" queryString = "" method = "GET" proxy = Nothing rawBody = False redirectCount = 10 responseTimeout = ResponseTimeoutDefault requestVersion = HTTP/1.1 proxySecureMode = ProxySecureWithConnect } (InternalException (HandshakeFailed (Error_Protocol "certificate has unknown CA" UnknownCa))) ghci>

tlsManagerSettings loads certificates from /etc/ssl /system/etc/security/cacerts and /usr/local/share/certs ; if no CA are available, all requests fail

simplexmq.cabal

src/Simplex/Messaging/Agent/Client.hs

epoberezkin · 2025-08-31T11:15:54Z

src/Simplex/Messaging/Agent/Store/AgentStore.hs

@@ -1382,7 +1382,8 @@ deleteCommand db cmdId =
  DB.execute db "DELETE FROM commands WHERE command_id = ?" (Only cmdId)

 createNtfToken :: DB.Connection -> NtfToken -> IO ()
-createNtfToken db NtfToken {deviceToken = DeviceToken provider token, ntfServer = srv@ProtocolServer {host, port}, ntfTokenId, ntfPubKey, ntfPrivKey, ntfDhKeys = (ntfDhPubKey, ntfDhPrivKey), ntfDhSecret, ntfTknStatus, ntfTknAction, ntfMode} = do
+createNtfToken db NtfToken {deviceToken, ntfServer = srv@ProtocolServer {host, port}, ntfTokenId, ntfPubKey, ntfPrivKey, ntfDhKeys = (ntfDhPubKey, ntfDhPrivKey), ntfDhSecret, ntfTknStatus, ntfTknAction, ntfMode} = do
+  let (provider, token) = deviceTokenFields deviceToken


we most likely need to add fields for webpush tokens to the table.

epoberezkin · 2025-08-31T11:17:14Z

src/Simplex/Messaging/Crypto.hs

+  | -- | unable to decode ecc key
+    CryptoInvalidECCKey CE.CryptoError


Suggested change

| -- | unable to decode ecc key

CryptoInvalidECCKey CE.CryptoError

This error is not necessary as it would be a parsing error.

epoberezkin · 2025-08-31T11:30:54Z

src/Simplex/Messaging/Notifications/Protocol.hs

+data DeviceToken
+  = APNSDeviceToken PushProvider ByteString
+  | WPDeviceToken WPEndpoint


Proposed type for DeviceToken is

data DeviceToken = APNSDeviceToken APNSProvider ByteString | WPDeviceToken WPProvider WPTokenParams newtype WPProvider = WPP (ProtocolServer 'WebPush) -- so we can add params if needed data APNSProvider = PPApnsDev -- provider for Apple development environment | PPApnsProd -- production environment, including TestFlight | PPApnsTest data WPTokenParams = WPTokenParams { wpPath :: ByteString, -- parser should validate it's a valid type and possibly it should be wpAuth :: ByteString, -- if we enforce size constraints, should also be in parser. wpKey :: ECC.Point -- or another correct type that is needed for encryption, so it fails in parser and not there }

General approach is to parse early, to the most narrow type that is applicable at the point of parsing, and not at the point of using it.

epoberezkin · 2025-08-31T11:33:07Z

src/Simplex/Messaging/Notifications/Protocol.hs

@@ -377,6 +378,7 @@ data PushProvider
  | PPApnsProd -- production environment, including TestFlight
  | PPApnsTest -- used for tests, to use APNS mock server
  | PPApnsNull -- used to test servers from the client - does not communicate with APNS
+  | PPWebPush -- used for webpush (FCM, UnifiedPush, potentially desktop)
  deriving (Eq, Ord, Show)


Proposed type for push provider (it's needed as a key for the connected client), but it probably is not needed during parsing of DeviceToken:

data PushProvider = PPAPNS APNSProvider | PPWP WPProvider

epoberezkin · 2025-08-31T11:34:21Z

src/Simplex/Messaging/Notifications/Protocol.hs

+        pure $ APNSDeviceToken pp t
+
+-- | Returns fields for the device token (pushProvider, token)
+deviceTokenFields :: DeviceToken -> (PushProvider, ByteString)


this function seems unnecessary, as it's better to store components as separate fields and split/combine when saving to the database.

epoberezkin · 2025-08-31T11:36:49Z

src/Simplex/Messaging/Notifications/Server/Push/APNS.hs

@@ -256,7 +257,8 @@ data APNSErrorResponse = APNSErrorResponse {reason :: Text}
 $(JQ.deriveFromJSON defaultJSON ''APNSErrorResponse)

 apnsPushProviderClient :: APNSPushClient -> PushProviderClient
-apnsPushProviderClient c@APNSPushClient {nonceDrg, apnsCfg} tkn@NtfTknRec {token = DeviceToken _ tknStr} pn = do
+apnsPushProviderClient c@APNSPushClient {nonceDrg, apnsCfg} tkn@NtfTknRec {token} pn = do


this function needs to change to accept token components - APNSProvider and ByteString (token), so it does not fail on incorrect provider type. PPInvalidPusher error most likely is not necessary - it's not a real runtime error.

epoberezkin · 2025-08-31T11:39:30Z

Added all (I think:) comments. I probably need to make a change on top with different types.

epoberezkin · 2025-09-16T18:09:07Z

replaced with #1642

epoberezkin · 2025-09-16T19:34:49Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+-- | Elliptic-Curve-Point-to-Octet-String Conversion without compression
+-- | as required by RFC8291
+-- | https://www.secg.org/sec1-v2.pdf#subsubsection.2.3.3
+uncompressEncode :: ECC.Point -> BL.ByteString


uncompressEncode / uncompressDecode should be defined as Encoding (or StrEncoding if it's not a binary format) for some newtype, e.g.

newtype WPKey = WPKey ECC.Point

This type can then be used as part of the token, to parse earlier

epoberezkin · 2025-09-16T19:37:45Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+                                     encodeBigInt y
+uncompressEncode ECC.PointO = "\0"
+
+uncompressDecode :: BL.ByteString -> ExceptT CE.CryptoError IO ECC.Point


there is no reason for it to be IO, it needs to evaluate to Either

epoberezkin · 2025-09-16T19:37:55Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+    w64 :: Integer -> Bin.Word64
+    w64 = fromIntegral
+
+decodeBigInt :: BL.ByteString -> ExceptT CE.CryptoError IO Integer


there is no reason for it to be IO, it needs to evaluate to Either

epoberezkin · 2025-09-16T19:38:47Z

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs

+  where
+    shift i w = Bits.shiftL (fromIntegral w) (64*i)
+
+encodePN :: PushNotification -> BL.ByteString


this looks like the usual JSON encoding, we should use generated ToJSON instance adding selectors to the type

epoberezkin · 2025-09-16T19:44:01Z

src/Simplex/Messaging/Notifications/Protocol.hs

      hexStringP =
        A.takeWhile (`B.elem` "0123456789abcdef") >>= \s ->
          if even (B.length s) then pure s else fail "odd number of hex characters"

 instance ToJSON DeviceToken where
-  toEncoding (DeviceToken pp t) = J.pairs $ "pushProvider" .= decodeLatin1 (strEncode pp) <> "token" .= decodeLatin1 t
-  toJSON (DeviceToken pp t) = J.object ["pushProvider" .= decodeLatin1 (strEncode pp), "token" .= decodeLatin1 t]
+  toEncoding token = case token of


why do we need JSON encodings for the token? If we do, then we need to use derived ToJSON/FromJson instances.

Possibly, it is only needed for webpush tokens?

Move generic push functions to Push.hs

e90c15b

p1gp1g requested review from epoberezkin and spaced4ndy as code owners August 27, 2025 09:29

p1gp1g mentioned this pull request Aug 27, 2025

Feat: Add push provider for webpush #1606

Open

p1gp1g force-pushed the webpush_requests branch from 23d86fe to 2099a1a Compare August 27, 2025 10:14

p1gp1g added 8 commits August 27, 2025 12:46

Fix move push

c08c379

Rename APNSDeviceToken

e7e7c9b

Add WPDeviceToken

64269c2

Prepare webpush requests

a24024c

Use content of push notif with web push

2205a1f

Lint liftPPWPError

1295b28

Encrypt wp notifications

720fb40

Fix Urgency case

9d30af4

p1gp1g force-pushed the webpush_requests branch from 2099a1a to 9d30af4 Compare August 27, 2025 10:47

epoberezkin reviewed Aug 29, 2025

View reviewed changes

Merge branch 'unified-push' into webpush_requests

4a39c4a

epoberezkin reviewed Aug 29, 2025

View reviewed changes

src/Simplex/Messaging/Crypto.hs Show resolved Hide resolved

epoberezkin reviewed Aug 29, 2025

View reviewed changes

src/Simplex/Messaging/Notifications/Server/Push/WebPush.hs Show resolved Hide resolved

epoberezkin reviewed Aug 29, 2025

View reviewed changes

epoberezkin reviewed Aug 31, 2025

View reviewed changes

simplexmq.cabal Show resolved Hide resolved

epoberezkin reviewed Aug 31, 2025

View reviewed changes

simplexmq.cabal Show resolved Hide resolved

epoberezkin reviewed Aug 31, 2025

View reviewed changes

src/Simplex/Messaging/Agent/Client.hs Show resolved Hide resolved

epoberezkin reviewed Aug 31, 2025

View reviewed changes

epoberezkin closed this Sep 16, 2025

epoberezkin mentioned this pull request Sep 16, 2025

ntf server: webpush requests #1642

Open

epoberezkin reviewed Sep 16, 2025

View reviewed changes

		\| -- \| unable to decode ecc key
		CryptoInvalidECCKey CE.CryptoError

Uh oh!

Webpush requests #1613

Webpush requests #1613

Uh oh!

Conversation

p1gp1g commented Aug 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epoberezkin Aug 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epoberezkin commented Aug 31, 2025

Uh oh!

epoberezkin commented Sep 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

epoberezkin Aug 31, 2025 •

edited

Loading