安卓>> push-relay>> 返回
项目作者： threema-ch

项目描述 ：
Relay service for Threema Web push notifications.
高级语言： Rust
项目地址: git://github.com/threema-ch/push-relay.git
创建时间： 2017-02-07T17:17:10Z
项目社区：https://github.com/threema-ch/push-relay
开源协议：Other
下载


Push Relay

CI
License

This server accepts push requests via HTTP and relays those requests to the appropriate push backends.

Supported backends:

  • Apple APNs
  • Google FCM
  • Huawei HMS
  • Threema Gateway

Request Format

  • POST request to /push
  • Request body must use application/x-www-form-urlencoded encoding

Request keys:

  • type: apns, fcm, hms or threema-gateway
  • token: The device push token (not provided when using Threema Gateway)
    • for FCM: The token itself as received from the OS
    • for iOS: The hex encoded token (without bundle id or encryption key appended)
  • session: SHA256 hash of public permanent key of the initiator
  • version: Threema Web protocol version
  • affiliation (optional): An identifier for affiliating consecutive pushes
  • ttl (optional): The lifespan of a push message, defaults to 90 seconds
  • collapse_key: (optional) A parameter identifying a group of push messages that can be
    collapsed.
  • bundleid (APNs only): The bundle id to use
  • endpoint (APNs only): Either p (production) or s (sandbox)
  • appid (HMS only): Can be used to differentiate between multiple configs
  • identity (Threema Gateway only): The Threema ID of the user.
  • public_key (Threema Gateway only): Public key associated to the Threema ID of the user.

Examples:

  1. curl -X POST -H "Origin: https://localhost" localhost:3000/push \
  2.     -d "type=apns&token=asdf&session=123deadbeef&version=3&bundleid=com.example.app&endpoint=s"
  3. curl -X POST -H "Origin: https://localhost" localhost:3000/push \
  4.     -d "type=fcm&token=asdf&session=123deadbeef&version=3"
  5. curl -X POST -H "Origin: https://localhost" localhost:3000/push \
  6.     -d "type=hms&appid=123456&token=asdf&session=123deadbeef&version=3"
  7. curl -X POST -H "Origin: https://localhost" localhost:3000/push \
  8.     -d "type=threema-gateway&session=123deadbeef&version=3&identity=ECHOECHO&public_key=0000000000000000000000000000000000000000000000000000000000000000"

Possible response codes:

  • HTTP 204 (No Content): Request was processed successfully
  • HTTP 400 (Bad Request): Invalid or missing POST parameters (including expired push tokens)
  • HTTP 500 (Internal Server Error): Processing of push request failed on the Push Relay server
  • HTTP 502 (Bad Gateway): Processing of push request failed on the APNs, FCM, HMS or Threema Gateway server

Push Payload

The payload format looks like this:

  • wcs: Webclient session (sha256 hash of the public permanent key of the
    initiator), string
  • wca: An optional identifier for affiliating consecutive pushes, string or null
  • wct: Unix epoch timestamp of the request in seconds, i64
  • wcv: Protocol version, u16

APNs

The APNs message contains a key “3mw” containing the payload data as specified
above.

FCM / HMS / Threema Gateway

The FCM, HMS and Threema Gateway messages contain the payload data as specified above.

Running

You need the Rust compiler. First, create a config.toml file that looks like this:

  1. [fcm]
  2. service_account_key_base64 = "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQo="
  3. project_id = 12345654321
  4. max_retries = 6
  6. [apns]
  7. keyfile = "your-keyfile.p8"
  8. key_id = "AB123456XY"
  9. team_id = "CD987654YZ"

To support HMS as well, you need to add one or more named HMS config sections.
The name should correspond to the App ID (and currently matches the Client ID).

  1. [hms.app-id-1]
  2. client_id = "your-client-id"
  3. client_secret = "your-client-secret"
  5. [hms.app-id-2]
  6. client_id = "your-client-id"
  7. client_secret = "your-client-secret"

To support Threema Gateway, the following config sections need to be added.
Note: The apps only support messages sent from *3MAPUSH.

  1. [threema_gateway]
  2. base_url = "https://msgapi.threema.ch"
  3. identity = "*3MAPUSH"
  4. secret = "secret-for-*3MAPUSH"
  5. private_key_file = "private-key-file-for-*3MAPUSH"

If you want to log the pushes to InfluxDB, add the following section:

  1. [influxdb]
  2. connection_string = "http://127.0.0.1:8086"
  3. user = "foo"
  4. pass = "bar"
  5. db = "baz"

Then simply run

  1. export RUST_LOG=push_relay=debug,hyper=info,a2=info,tower=debug
  2. cargo run

…to build and start the server in debug mode.

Deployment

  • Always create a build in release mode: cargo build --release
  • Use a reverse proxy with proper TLS termination (e.g. Nginx)
  • Set RUST_LOG=info env variable

Testing

To run tests:

  1. cargo test

Linting

To run lints:

  1. $ rustup component add clippy
  2. $ cargo clean && cargo clippy --all-targets

License

Licensed under either of

at your option.