Module dittolive_ditto::identity

source · [−]
Expand description

Ditto needs an Identity to start syncing with other peers.

The various identity configurations that you can use when initializing a Ditto instance.

  • OfflinePlayground: Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be used for development.
  • OnlineWithAuthentication: Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication server. User permissions are centrally managed.
  • OnlinePlayground: Test a Ditto Cloud app with weak shared token authentication (“Playground mode”). This mode is not secure and must only be used for development.
  • SharedKey: A mode where any device is trusted provided they know the secret key. This is a simplistic authentication model normally only suitable for private apps where users and devices are both trusted.
  • Manual: A Ditto peer identity that was created manually rather than generated by an identity service. This is a text bundle beginning with the line -----BEGIN DITTO IDENTITY-----. To learn how to create and use Manual Identities please refer to Ditto’s online documentation.

Structs

Manual
An identity where devices are manually configured with a x509 certificate bundle
OfflinePlayground
Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be used for development. In this mode, any string can be used as the name of the app.
OnlinePlayground
Test a Ditto Cloud app with a simple shared token (“Playground mode”). This mode offers no security and must only be used for development. Other behavior mirrors the OnlineWithAuthentication identity.
OnlineWithAuthentication
Run Ditto in secure production mode, logging on to Ditto Cloud or an on-premises authentication server. User permissions are centrally managed. Sync will not work until a successful login has occurred.
SharedKey
An identity where any device is trusted provided they know the secret key. This is a simplistic authentication model normally only suitable for private apps where users and devices are both trusted. In this mode, any string may be used as the app id.

Type Definitions

OnlinePlaygroundV2Deprecated