Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/notifications.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2017-03-03 16:05:10 +0300
committerJoas Schilling <coding@schilljs.com>2017-03-29 11:59:17 +0300
commit362ed9b0d71e85371fbd6952650633a3a212d704 (patch)
tree1d9658939d67bd80b6d3de37e5ef470801a8ca7b /docs
parenta6b1645f3a83a99c47249c761c874a5f806e5645 (diff)
Add docs
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/push-v3.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/docs/push-v3.md b/docs/push-v3.md
index dea6be3..b430337 100644
--- a/docs/push-v3.md
+++ b/docs/push-v3.md
@@ -179,9 +179,35 @@ The server replies with the following status codes:
| Status code | Meaning |
| ----------- | ---------------------------------------- |
-| 200 | Push token was deleted from the databse |
+| 200 | Push token was deleted from the database |
| 400 | Public key or device identifier is malformed |
| 403 | Device identifier and device public key didn't match or could not be found |
+## Pushed notifications
+
+The pushed notifications format depends on the service that is used.
+In case of Apple Push Notification Service, the payload of a push notification looks like the following:
+
+```json
+{
+ "aps" : {
+ "alert" : {
+ "loc-key" : "NEW_NOTIFICATION"
+ }
+ },
+ "subject" : "*Encrypted subject*",
+ "signature" : "*Signature*"
+}
+```
+
+| Attribute | Meaning |
+| ----------- | ---------------------------------------- |
+| `aps` | As defined by the [apple documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW1). Since this message can not be encrypted, it contains **no sensitive** content. |
+| `subject` | The subject is encrypted with the device´s *public key*. |
+| `signature` | The signature is a sha512 signature over the encrypted subject using the user´s private key. |
+
+### Verification
+So a device should verify the signature using the user´s public key.
+If the signature is okay, the subject can be decrypted using the device´s private key.