Struct dittolive_ditto::identity::SharedKey

pub struct SharedKey { /* private fields */ }

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.

Implementations

impl SharedKey

pub fn new(
    ditto_root: Arc<dyn DittoRoot>,
    app_id: AppId,
    key_der_b64: &str
) -> Result<Self, DittoError>

Construct a SharedKey Identity

• ditto_root - An instance of DittoRoot for local storage
• app_id - The unique UUIDv4 identifying this app; must be shared across all instances
• key_der_b64 - A pre-shared key for securing peer-to-peer communication encoded as a Base64 string

Trait Implementations

impl Identity for SharedKey

fn site_id(&self) -> SiteId

Returns the current SiteId identifying the Ditto peer

fn auth_client(&self) -> Arc<BoxedAuthClient>

Returns a shared reference to the underlying AuthClient

fn is_web_valid(&self) -> bool

Returns if the current web auth token is valid

fn is_x509_valid(&self) -> bool

Returns if the configured x509 certificate is valid

fn auth_url(&self) -> Result<String, DittoError>

Returns the configured URL for Auth

fn sync_url(&self) -> Result<String, DittoError>

Returns the configured URL for websocket sync

fn authenticator(&self) -> Option<DittoAuthenticator>

Returns the underlying DittoAuthenticator if specified

fn make_listener(
    &self,
    _transports: Weak<RwLock<TransportSync>>
) -> Option<Arc<ValidityListener>>

Constructs a ValidityListener given a shared reference to the Ditto Transports

fn is_cloud_sync_enabled(&self) -> bool

Indicates if cloud sync should be enabled by default

fn requires_offline_only_license_token(&self) -> bool

Indicates whether the specific Identity type requires an offline only license token to be set.

fn app_id(&self) -> AppId

Returns the current AppId