karmanyaahm
/
unified-push-xmpp
forked from genofire/unified-push-xmpp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
32 Commits 4 Branches 0 Tags 131 KiB
Go 96.6%
Python 2.7%
Shell 0.7%
Go to file
Karmanyaah Malhotra 5d34dfb506 Update storage lib references 2021-09-15 21:44:49 -05:00
distributor Update storage lib references 2021-09-15 21:44:49 -05:00
gateway docs: fix typos 2021-09-16 01:04:43 +02:00
messages docs: token definition 2021-09-14 22:14:25 +02:00
.gitignore first xmpp tries 2021-09-09 23:12:29 +02:00
README.md docs: fix typos 2021-09-16 01:04:43 +02:00

README.md

UnifiedPush over XMPP

UnifiedPush is an specification how push notifications delieveries between application server and application. This is an implementation of the UnifiedPush specifications to delievere push notification over XMPP.

In this project has following components:

  • Gateway (also called an Push Provider or Server) which could be registered as an XMPP Component on an Server
  • Distributor for Linux using the D-Bus Specification which implement an very small XMPP-Client to receive the push notifications

XMPP Messages

Register

Request for Register

<iq from="push-distributer@example.org/device" to="up.chat.sum7.eu" type="set" id="register-id">
  <register xmlns='unifiedpush.org'>
    <token>pubic-token</token>
  </register>
</iq>

Responses

on success:

<iq from="push-distributer@example.org/device" to="up.chat.sum7.eu" type="result" id="register-id">
  <register xmlns='unifiedpush.org'>
    <endpoint>https://an-endpoint-for-application-server.localhost/UP?token=endpoint-token</endpoint>
  </register>
</iq>

on failure:

<iq from="push-distributer@example.org/device" to="up.chat.sum7.eu" type="error" id="register-id">
  <register xmlns='unifiedpush.org'>
    <error>a reason of failure</error>
  </register>
</iq>

Unregister

TODO

Notification

For the push notification it-self the origin <message/> is used with following Position of Token and Content.

<message from="up.chat.sum7.eu" to="push-distributer@example.org/device" id="message-id">
  <subject>public-token</subject>
  <body>Here is the Notification content</body>
</message>

The message sender from should be validated from distributor, for not receiving invalid or manipulated push Messages.

Wordings

We are using over the complete system three kind of tokens:

  • Endpoint Token which is part of the Endpoint and is for using between Gateway and Application-Server
  • Public Token which is used between Gateway and Distributor
  • App Token which is used between Distributor and Application