karmanyaahm
/
unified-push-xmpp
forked from genofire/unified-push-xmpp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: first readme message 

wip #9
This commit is contained in:
Geno 2021-09-14 11:17:25 +02:00
parent 05eaff3e20
commit 4a88e1d4a7
2 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md Normal file
View File

@ -0,0 +1,64 @@
# UnifiedPush over XMPP
[UnifiedPush](https://unifiedpush.org/) is an specification how push notifications delivered between application server and application.
This is an implementation of the UnifiedPush specifications to delivere push notification over XMPP.
In this project has following components:
- **Gateway** (also called an Push Provider or [Server](https://unifiedpush.org/spec/server/)) which could be registered as an XMPP Component on an Server
- **Distributor** for Linux using the [D-Bus Specification](https://unifiedpush.org/spec/dbus/) which implement an very small XMPP-Client to recieve the push notifications
## XMPP Messages
### Register
Request for Register
```xml
<iq from="push-distributer@example.org/device" to="up.chat.sum7.eu" type="set" id="register-id">
<register xmlns='unifiedpush.org'>
<token>token-from-distributer-regisration</token>
</register>
</iq>
```
**Responses**
on success:
```xml
<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=public-token</endpoint>
</register>
</iq>
```
on failure:
```xml
<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.
```xml
<message from="up.chat.sum7.eu" to="push-distributer@example.org/device" id="message-id">
<subject>token-from-distributer-regisration</subject>
<body>Here is the Notification content</body>
</message>
```
The message sender `from` should be validated from distributor, for not recieving invalid or manipulated push Messages.
## Wordings
We are using over the complete system three kind of **tokens**:
- **Public Token** which is part of the *Endpoint* and is for using between Gateway and Application-Server
- **External Token** which is used between Gateway and Distributor
- **Internal Token** which is used between Distributor and Application

3
messages/README.md Normal file
View File

@ -0,0 +1,3 @@
# UnifiedPush over XMPP - Messages
Here are the golang `struct` of XMPP stanzes for encoding and decoding needed by UnifiedPush over XMPP gateway and distributor