ドキュメントを開く +

暗号化

通常、Breeze、Apple、Google は配信の途中で通知の本文を見ることができます。暗号化を使うと、スクリプト側で内容を暗号化し、あなたの iPhone だけが復号できます。形式は Bark と互換性があります。

キーを設定する#

アプリで「設定 → 暗号化」を開き、次を選びます。

設定 選択肢
アルゴリズム AES-128、AES-192、AES-256。キーはそれぞれ 16、24、32 文字
モード GCM(推奨)、CBC、ECB
IV GCM は 12 文字、CBC は 16 文字、ECB は不要

アプリでキーを生成してスクリプトにコピーします。それ以外でキーが端末の外に出ることはありません。暗号化したテスト通知を送る、そのまま実行できるコマンドもアプリに表示されます。

暗号化した通知を送る#

  1. パラメーターを JSON で書きます。例:{"title":"Server","body":"Disk usage is above 90%"}。
  2. キーと IV で JSON を暗号化し、Base64 でエンコードします。GCM では、暗号文の末尾に 16 バイトのタグを付けてからエンコードします。
  3. 結果を ciphertext として送ります。通知ごとに IV を変える場合は iv も送ります。
cURL / Bash
KEY='YOUR_32_CHARACTER_KEY'   # AES-256
IV='YOUR_16_CHAR_IV'           # CBC
JSON='{"title":"Server","body":"Disk usage is above 90%"}'

CIPHERTEXT=$(printf '%s' "$JSON" | openssl enc -aes-256-cbc \
  -K "$(printf '%s' "$KEY" | xxd -p -c 256)" \
  -iv "$(printf '%s' "$IV" | xxd -p -c 256)" | base64 | tr -d '\n')

curl https://push.breezelabs.dev/v1/send \
  -H 'Authorization: Bearer YOUR_KEY' \
  --data-urlencode "ciphertext=$CIPHERTEXT" \
  --data-urlencode "iv=$IV"

Python と AES-GCM の場合:

python
import base64, json, os
from cryptography.hazmat.primitives.ciphers.aead import AESGCM

key = b'YOUR_32_CHARACTER_KEY'
iv = os.urandom(6).hex().encode()          # 12 characters, new for every message
payload = json.dumps({'title': 'Server', 'body': 'Disk usage is above 90%'}).encode()
ciphertext = base64.b64encode(AESGCM(key).encrypt(iv, payload, None)).decode()
# Send {"ciphertext": ciphertext, "iv": iv.decode()} to /v1/send

見えたままになるもの#

ciphertext の外に置いたパラメーター(group や sound など)はサービスから見えます。秘密にしたい内容はすべて暗号化する JSON に入れてください。キーや IV が一致しない場合、端末には内容の代わりに「Decryption failed」と表示されます。

暗号化は iPhone で使えます。Android はまだ対応しておらず、HTTP 422 を返します。