Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossary

  • Adapter (platform adapter): the plugin that publishes to one platform, such as Gmail, installed from its own repository. See Managing adapters.
  • Administrator: a credential holding every scope.
  • Audit event: a record of a change or login. See Audit log.
  • Category: what an adapter publishes, such as email (--cat-id).
  • Credential: a username and password that logs in to the REST API’s admin endpoints, with its own scopes. See Credentials and access.
  • Ephemeral key pool: the client public keys and server key pairs each linked account holds, up to 256 of each; each pair is used once, with an identity key, by a payload or a token check. See Security model.
  • Gateway client: a phone number that relays SMS to the Publisher, such as an Android phone running Deku SMS. See Connecting a relay.
  • Identity key: one of the server’s 256 long-term X25519 keys, used in every gRPC request and payload, and alone for offline payloads.
  • Linked account: a user’s account on a platform, authorized once while online. The Publisher stores its token encrypted.
  • MSISDN: a phone number in international format, such as +237600000000.
  • OAuth2: linking through the platform’s consent page, as for Gmail.
  • Offline payload: content sent without a linked account, published through RelaySMS Mail. See Offline publishing.
  • Payload: the encrypted content the RelaySMS app sends by SMS; one carrying an attachment arrives in several segments.
  • PLMN: a mobile network, identified by its MCC (country code) and MNC (network code). See How suggest works.
  • PNBA (phone number-based authentication): linking with a code sent to the user’s phone, as for Telegram.
  • Protocol: how an adapter links accounts, such as oauth2 (--proto-id). For a payload, how it reached the Publisher, such as https (the REST API); see Offline publishing.
  • Redirect URI: where an OAuth2 platform sends the user back after they authorize. See Redirect URIs.
  • rmail: the name of the RelaySMS Mail adapter. See RelaySMS Mail.
  • Scope: a permission a credential holds, such as gc:write. See Scopes.
  • Sender hash: the keyed hash that replaces a sender’s phone number before anything is stored.
  • Token: what the Publisher stores for a linked account to act on the platform, encrypted.
  • Web session: a REST API login kept in a cookie, for a web client.