Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 4.9 KB

PRIVACY.md

File metadata and controls

113 lines (83 loc) · 4.9 KB
Raw

Privacy

Twake is available on Android, iOS and as a web version. Desktop versions for Windows, Linux and macOS may follow.

Matrix

Twake uses the Matrix protocol. This means that Twake is just a client that can be connected to any compatible matrix server. The respective data protection agreement of the server selected by the user then applies.

For convenience, one or more servers are set as default that the Twake developers consider trustworthy. The developers of Twake do not guarantee their trustworthiness. Before the first communication, users are informed which server they are connecting to.

More information is available at: https://matrix.org

Database

Twake caches some data received from the server in a local database on the device of the user.

More information is available at: https://pub.dev/packages/hive

Encryption

All communication of substantive content between Twake and any server is done in secure way, using transport encryption to protect it.

Twake is able to use End-To-End-Encryption as a tech preview.

App Permissions

The permissions are the same on Android and iOS but may differ in the name. This are the Android Permissions:

Internet Access

Twake needs to have internet access to communicate with the Matrix Server.

Vibrate

Twake uses vibration for local notifications. More informations about this are at the used package: https://pub.dev/packages/flutter_local_notifications

Record Audio

Twake can send voice messages in a chat and therefore needs to have the permission to record audio.

Write External Storage

The user is able to save received files and therefore app needs this permission.

Read External Storage

The user is able to send files from the device's file system.

Location

Twake makes it possible to share the current location via the chat. When the user shares their location, Twake uses the device location service and sends the geo-data via Matrix.

Push Notifications

Twake uses the Firebase Cloud Messaging/Apple Push Notification service for push notifications on Android and iOS. This takes place in the following steps:

  1. The matrix server sends the push notification to the Twake Push Gateway
  2. The Twake Push Gateway forwards the message in a different format to Firebase Cloud Messaging/Apple Push Notification
  3. Firebase Cloud Messaging/Apple Push Notification waits until the user's device is online again
  4. The device receives the push notification from Firebase Cloud Messaging/Apple Push Notification and displays it as a notification

The source code of the push gateway can be viewed here: https://github.com/matrix-org/sygnal

event_id_only is used as the format for the push notification. A typical push notification therefore only contains:

  • Event ID
  • Room ID
  • Unread Count
  • Information about the device that is to receive the message

A typical push notification could look like this:

{
  "notification": {
    "event_id": "$3957tyerfgewrf384",
    "room_id": "!slw48wfj34rtnrf:example.com",
    "counts": {
      "unread": 2,
      "missed_calls": 1
    },
    "devices": [
      {
        "app_id": "app.twake.android.chat",
        "pushkey": "V2h5IG9uIGVhcnRoIGRpZCB5b3UgZGVjb2RlIHRoaXM/",
        "pushkey_ts": 12345678,
        "data": {},
        "tweaks": {
          "sound": "bing"
        }
      }
    ]
  }
}

Twake sets the event_id_only flag at the Matrix Server. This server is then responsible to send the correct data.

Stories

Twake supports stories which is a feature similar to WhatsApp status or Instagram stories. However it is just a different GUI for the same room-related communication. More information about the feature can be found here:

https://github.com/krillefear/matrix-doc/blob/main/proposals/3588-stories-as-rooms.md

Stories are basically:

  • End to end encrypted rooms
  • Read-only rooms with only one admin who can post stuff (while there is no technical limitation to have multiple admins)

By default:

  • The user has to invite all contacts manually to a story room
  • The user can only invite contacts (matrix users the user shares a DM room with) to the story room
  • The story room is created when the first story is posted
  • User can mute and leave story rooms

The user is informed in the app that in theory all contacts can see each other in the story room. The user must give consent here. However the user is at any time able to create a group chat and invite all of their contacts to this chat in any matrix client which has the same result.