Struct dittolive_ditto::identity::SharedKey
source · [−]pub struct SharedKey { /* private fields */ }Expand description
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
sourceimpl SharedKey
impl SharedKey
sourcepub fn new(
ditto_root: Arc<dyn DittoRoot>,
app_id: AppId,
key_der_b64: &str
) -> Result<Self, DittoError>
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 ofDittoRootfor local storageapp_id- The unique UUIDv4 identifying this app; must be shared across all instanceskey_der_b64- A pre-shared key for securing peer-to-peer communication encoded as a Base64 string
Trait Implementations
sourceimpl Identity for SharedKey
impl Identity for SharedKey
sourcefn auth_client(&self) -> Arc<BoxedAuthClient>
fn auth_client(&self) -> Arc<BoxedAuthClient>
Returns a shared reference to the underlying AuthClient
sourcefn ditto_root(&self) -> Arc<dyn DittoRoot>
fn ditto_root(&self) -> Arc<dyn DittoRoot>
Returns the current DittoRoot
sourcefn is_web_valid(&self) -> bool
fn is_web_valid(&self) -> bool
Returns if the curernt web auth token is valid
sourcefn is_x509_valid(&self) -> bool
fn is_x509_valid(&self) -> bool
Returns if the configured x509 certificate is valid
sourcefn auth_url(&self) -> Result<String, DittoError>
fn auth_url(&self) -> Result<String, DittoError>
Returns the configured URL for Auth
sourcefn sync_url(&self) -> Result<String, DittoError>
fn sync_url(&self) -> Result<String, DittoError>
Returns the configured URL for websocket sync
sourcefn authenticator(&self) -> Option<DittoAuthenticator>
fn authenticator(&self) -> Option<DittoAuthenticator>
Returns the underlying DittoAuthenticator if specified
sourcefn make_listener(
&self,
_transports: Arc<RwLock<TransportSync>>
) -> Option<Arc<ValidityListener>>
fn make_listener(
&self,
_transports: Arc<RwLock<TransportSync>>
) -> Option<Arc<ValidityListener>>
Constructs a ValidityListener given a shared reference to the Ditto
Transports Read more
sourcefn is_cloud_sync_enabled(&self) -> bool
fn is_cloud_sync_enabled(&self) -> bool
Indicates if cloud sync should be enabled by default
sourcefn requires_offline_only_license_token(&self) -> bool
fn requires_offline_only_license_token(&self) -> bool
Indicates whether the specific Identity type requires an offline only license token to be set.
Auto Trait Implementations
impl !RefUnwindSafe for SharedKey
impl Send for SharedKey
impl Sync for SharedKey
impl Unpin for SharedKey
impl !UnwindSafe for SharedKey
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more