--- title: Authentication slug: v4-6/security/authentication docTags: createdAt: 2023-07-28T09:10:28.738Z --- This article provides an introduction to Ditto's methods for authentication, as well as step‑by‑step instructions on how to use the online playground authentication mode to initialize Ditto and start prototyping. Ditto's security relies on digital identities for peer-to-peer authentication and access control permissions and privileges. Each instance of Ditto running in your app must prove its identity to other peers before it is allowed to sync. The following table provides an overview of authentication in Ditto: | **Method** | **Use Case** | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `OnlinePlayground`¹ | You're ready to explore and test realtime sync capabilities without the commitment using either a demo app or your own development app. | | `OnlineWithAuthentication` | You've integrated Ditto, integrated a third‑party identity service provider, and are now ready to go into production. | :::hint{type="danger"} ¹Do not use the online playground identity for production-level apps. The online playground is intended for testing and experimentation purposes only. Deploying playground certificates to a live environment could lead to vulnerabilities and security risks. ::: ::::::ExpandableHeading # OnlinePlayground Identity Before you can sync offline, you must first connect to the internet to retrieve your *playground certificate*. Using Ditto's online playground identity, you can sync with other peers that share the same app ID and read and write to collections without the hassle of needing to set up your own authentication. :::hint{type="info"} Each instance of Ditto running in your app is assigned a random universally unique identifier (UUID), which is the string of alphanumeric characters that identify your app across Ditto, as well as all other systems and environments. ::: The *online playground *is an authentication mode that allows you to explore platform features and functionality without the hassle of setting up your own authentication mechanism. :::hint{type="warning"} Before you can sync offline, you must connect to the internet to obtain your playground certificate from the Big Peer. ::: :::hint{type="warning"} Unless you have a specialized use case, such as a government app, you must connect to the internet at least once before you can sync offline with other peers. ::: The playground certificate is an X.509-formatted certificate generated automatically by the Big Peer when a network connection is available. Once you've obtained your playground certificate from the Big Peer, you can go offline and sync with unrestricted platform access for a maximum of one week — reading and writing to all collections and establishing connections with all peers sharing the same app ID. After one week, however, your playground certificate expires and you lose access to the platform, requiring you to reconnect to the internet so the Big Peer can automatically generate a new playground certificate. ## Initializing Ditto and Going Offline To explore Ditto without the commitment, authenticate using the playground identity: :::hint{type="info"} If you want to use Ditto in an air-gapped environment that is entirely offline or on‑premise, contact Ditto Customer Engineering. (See [Support](docId\:hWtjr8xGjry4a7IqLEgHZ)) ::: :::::WorkflowBlock :::WorkflowBlockItem From the portal, create an app and get your access credentials. For instructions, see [Onboarding](docId\:Up5T7Ykh9nwxB6QNGtp4X): Your access credentials consist of an *app ID *and *playground token:* - The app ID is a unique identifier that Ditto uses to recognize your app: - The Big Peer uses the app ID to identify your app before issuing your playground certificate. - Peers that share the same app ID will automatically form a mesh network, using any transports available on their respective devices. . - The playground token is a passphrase that Small Peers use to authenticate your digital identity with the Big Peer. Once authenticated, the Big Peer issues a unique JSON Web Token (JWT) to establish and ensure persistence of connection between Small Peers and the Big Peer. As long as the playground token remains active, your connection persists. ::: ::::WorkflowBlockItem In the top-most scope of the codebase of your app, set up and initialize Ditto and configure your app to use the online playground for testing. :::CodeblockTabs ```swift DittoLogger.minimumLogLevel = .debug let ditto = Ditto(identity: .onlinePlayground( appID: "REPLACE_ME_WITH_YOUR_APP_ID", token: "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN" )) do { try ditto.startSync() } catch (let err) { print(err.localizedDescription) } ``` ```kotlin try { val androidDependencies = DefaultAndroidDittoDependencies(context) val identity = DittoIdentity.OnlinePlayground( androidDependencies, appId = "REPLACE_ME_WITH_YOUR_APP_ID", token = "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN" ) DittoLogger.minimumLogLevel = DittoLogLevel.DEBUG ditto = Ditto(androidDependencies, identity) ditto.startSync() } catch (e: DittoError) { Log.e("Ditto error", e.message!!) } ``` ```javascript import { init, Ditto, Logger } from "@dittolive/ditto" Logger.minimumLogLevel = 'Debug' const identity: Identity = { type: 'onlinePlayground', appID: 'REPLACE_ME_WITH_YOUR_APP_ID', token: 'REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN' } const path = './your-ditto-application-data-path' const ditto = new Ditto(identity, path) ditto.startSync() ``` ```nodejs import { init, Ditto, Logger } from "@dittolive/ditto" Logger.minimumLogLevel = 'Debug' const identity: Identity = { type: 'onlinePlayground', appID: 'REPLACE_ME_WITH_YOUR_APP_ID', token: 'REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN' } const path = './your-ditto-application-data-path' const ditto = new Ditto(identity, path) ditto.startSync() ``` ```java DittoDependencies androidDependencies = new DefaultAndroidDittoDependencies(this.context); DittoLogger.setMinimumLogLevel(DittoLogLevel.DEBUG); DittoIdentity identity = new DittoIdentity.OnlinePlayground(androidDependencies, "REPLACE_ME_WITH_YOUR_APP_ID", "YOUR_PLAYGROUND_TOKEN_HERE"); Ditto ditto = new Ditto(androidDependencies, identity); try { ditto.startSync(); } catch(DittoError e) { //handle error } ``` ```csharp try { DittoLogger.SetMinimumLogLevel(DittoLogLevel.Debug); var ditto = new Ditto(DittoIdentity.OnlinePlayground("REPLACE_ME_WITH_YOUR_APP_ID", "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN", true), path); ditto.StartSync(); } catch (DittoException ex) { Console.WriteLine($"Ditto Error {ex.Message}"); } ``` ```cpp auto identity = Identity::OnlinePlayground("REPLACE_ME_WITH_YOUR_APP_ID", "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN", true); try { Ditto ditto = Ditto(identity, dir); ditto.set_minimum_log_level(LogLevel::debug); ditto.start_sync(); } catch (const DittoError &err) { } ``` ```rust let ditto = Ditto::builder() // creates a `ditto_data` folder in the directory containing the executing process .with_root(Arc::new(PersistentRoot::from_current_exe()?)) .with_identity(|ditto_root| { // Provided as an env var, may also be provided as hardcoded string let app_id = AppId::from_env("REPLACE_ME_WITH_YOUR_APP_ID")?; let shared_token = std::env::var("REPLACE_ME_WITH_A_SHARED_TOKEN").unwrap(); let enable_cloud_sync = true; let custom_auth_url = None; OnlinePlayground::new( ditto_root, app_id, shared_token, enable_cloud_sync, custom_auth_url, ) })? .with_minimum_log_level(LogLevel::Debug) .build()?; ditto.start_sync()?; ``` ```curl # not supported by HTTP API ``` ::: :::: ::::: :::::: ::::ExpandableHeading # OnlineWithAuthentication Identity Ditto **does not come with an identity provider**. Using "Online With Authentication" requires that you have your own identity provider already set up. Each app can use multiple identity providers. The "Online With Authentication" identity type is geared towards apps that will be deployed in real-world settings. "Online With Authentication" identity types are: - for apps that need to integrate with existing permissions - for apps that need to integrate with existing authentication systems :::hint{type="info"} Ditto does not provide identity access services. Therefore, in order to use `OnlineWithAuthentication` for authentication in your production‑ready app, you must first integrate a third-party identity provider for login authentication and authorization. For more information, see *Platform Manual *> [Security](docId\:h1jMwiwXXn4M-ZSyLzfDx). ::: ## API[​](https://deploy-preview-643--shiny-croquembouche-15669a.netlify.app/ios/common/security/authentication#api) To see fully working examples, see the [code samples on GitHub](https://github.com/getditto/examples-permission). ### Creating Your Client Create the ditto client with the `onlineWithAuthentication` identity. This identity requires an authentication handler `authHandler`. :::hint{type="warning"} You must refresh the auth token when it expires. You can do that by implementing `authenticationExpiringSoon`. If you do not implement this, then sync will stop when the token expires. ::: :::CodeblockTabs ```swift struct AuthDelegate: DittoAuthenticationDelegate { func authenticationRequired(authenticator: DittoAuthenticator) { print("Login request.") } func authenticationExpiringSoon(authenticator: DittoAuthenticator, secondsRemaining: Int64) { print("Auth token expiring in \(secondsRemaining)") } } let identity = DittoIdentity.onlineWithAuthentication( appID: "REPLACE_ME_WITH_YOUR_APP_ID", authenticationDelegate: AuthDelegate() ) let ditto = Ditto(identity: identity) try! ditto.startSync() ``` ```kotlin class AuthCallback: DittoAuthenticationCallback { override fun authenticationRequired(authenticator: DittoAuthenticator) { println("Login request.") } override fun authenticationExpiringSoon( authenticator: DittoAuthenticator, secondsRemaining: Long ) { println("Auth token expiring in $secondsRemaining seconds") } } val androidDependencies = AndroidDittoDependencies(context) val identity = DittoIdentity.OnlineWithAuthentication( androidDependencies, "REPLACE_ME_WITH_YOUR_APP_ID", AuthCallback() ) val ditto = Ditto(androidDependencies, identity) try { ditto.startSync() } catch(e: DittoError) { Log.e("Ditto error", e.message!!) } ``` ```none ``` ```csharp class AuthDelegate : IDittoAuthenticationDelegate { public async void AuthenticationRequired(DittoAuthenticator authenticator) { System.Console.WriteLine($"Login request"); } public async void AuthenticationExpiringSoon(DittoAuthenticator authenticator, long secondsRemaining) { System.Console.WriteLine($"Auth token expiring in {secondsRemaining} seconds"); } } var identity = DittoIdentity.OnlineWithAuthentication( "REPLACE_ME_WITH_YOUR_APP_ID", new AuthDelegate()); try { var ditto = new Ditto(identity); ditto.StartSync(); } catch (DittoException ex) { System.Console.WriteLine($"Ditto Error {ex.Message}"); } ``` ::: ## Login Login takes two parameters: the first is **token**. The token can be any string value. Most auth services use a [JWT (JSON Web Token)](https://jwt.io/), but you can send any token you want from the client. For example, during testing you may want to create a secret code for development use. This string will be sent in a POST request to the HTTP route. The second parameter is **provider**, this provider must be a string value matching the name of one of your configured authentication webhooks. If you have multiple authentication webhooks, you can select which webhook your application should use by changing the provider. ![](https://api.archbee.com/api/optimize/qoRkNxW5fJ81r_NqVpc8C/yt92BS9FKsDn_tvNQJjEy_image.png) :::CodeblockTabs ```swift ditto.auth.login(accessToken, provider: "my-auth") { clientInfo, err in print("Login request completed. Error? \(err)") } ``` ```kotlin ditto.auth.login(accessToken, "my-auth", err -> { System.out.println("Login request completed. Error? " + err.toString()); }); ``` ```csharp var res = await authenticator.Login(accessToken, "my-auth"); System.Console.WriteLine($"Login request completed. Error? {res}"); ``` ::: ### When should you call ditto.auth.login?[​](https://deploy-preview-643--shiny-croquembouche-15669a.netlify.app/ios/common/security/authentication#when-should-you-call-dittoauthlogin) If you have already implemented the callbacks mentioned earlier, you don't need to take further action. Ditto will automatically attempt to refresh whenever possible. However, if you know specific times when the app will be online, you may choose to call this function manually. For an example implementation of authentication for Android, see the Ditto open-source demo chat app's "[authentication](https://github.com/getditto/demoapp-chat/tree/authentication)" branch in the getditto GitHub repository. ## Logout Logout will stop sync, shut down all replication sessions, and remove any cached authentication credentials. Note that this does not remove any data from the store. If you wish to delete data from the store then use the optional **cleanupFn** parameter to perform any required cleanup. The **cleanupFn** is an optional function that will be called with the relevant Ditto instance as the sole argument that allows you to perform any required cleanup of the store as part of the logout process. :::CodeblockTabs ```swift ditto.auth.logout(cleanup: { ditto in ditto.store.collection("cars").findAll().evict() }) ``` ```csharp ditto.Auth.Logout((Ditto ditto) => { ditto.Store.Collection("cars").FindAll().evict(); }); ``` ::: ## Tutorial - **This section will require knowledge of writing server-side HTTP endpoints and handlers.** The server side sample code is written in JavaScript (NodeJS with an [Express](https://expressjs.com/)-like API), however you can use any framework or language of your choosing. - **We will use Auth0 in this tutorial.** But you can use any third-party identity provider. Each app can use multiple identity providers. - In this tutorial, you'll build a simple application so users can log in with a a third-party provider using [Auth0](https://auth0.com/). We assume that you have already completed the Auth0 tutorial on their documentation before starting this tutorial. - For the full application code in JavaScript and Swift, see the [code samples on GitHub](https://github.com/getditto/examples-permission). ### Configure Ditto​ To use an "Online With Authentication" identity, go to your app in the [portal](https://portal.ditto.live/) and find the **Authentication Mode & Webhook Settings** section. Ensure that **"With Authentication"** is selected like so: ![](https://api.archbee.com/api/optimize/qoRkNxW5fJ81r_NqVpc8C/SRYeApsqOMaGa1WW5MLXk_image.png) Below, a section called **Authentication Webhooks** will be editable. Once your Authentication Webhook Endpoint(s) is deployed and ready, you can register it in the portal. Add a **Name** and **URL**. - Provide a unique - The URL parameter is the fully qualified URL of the webhook that you deploy yourself. Please include https\:// at the beginning of your URL. You can use our example webhook to just get started. This webhook is a server deployed on a third-party server and is just for testing. This server will always authorize all clients with full read and write permissions. You can use this URL to test your application. However, you should not use this URL in production. This Replit simply authenticates everyone for 7 days of offline usage. [https://alloweveryonewebhook.tester28.repl.co/auth](https://alloweveryonewebhook.tester28.repl.co/auth) Once configured, you should see a webhook that looks like this in your portal app settings: ![](https://api.archbee.com/api/optimize/qoRkNxW5fJ81r_NqVpc8C/5fBTWHaPPWKpb4j17vtYJ_image.png) ### Configure Auth0[​](https://deploy-preview-643--shiny-croquembouche-15669a.netlify.app/ios/common/security/authentication#configure-auth0) The second step is to configure Auth0. Follow these steps: 1. Create a new Auth0 application. 2. Configure the allowed callbacks and origins for your application. Make sure to add the callback URL for your application. 3. Configure the allowed grant types for your application. For this tutorial, we will use the "Authorization Code" grant type. 4. Create a new API in Auth0. This will represent the API that your application will access. Next, you need to configure Ditto. Follow the steps that were outlined earlier in this article. Now that you have configured Auth0 and Ditto, you can start integrating them into your application. **If you already have an Auth0 account...**[​](https://deploy-preview-643--shiny-croquembouche-15669a.netlify.app/ios/common/security/authentication#if-you-already-have-an-auth0-account) ...log in, skip the next section, and proceed to the part titled ***Register your app with Auth0***. **If you don't have an Auth0 account yet...**[​](https://deploy-preview-643--shiny-croquembouche-15669a.netlify.app/ios/common/security/authentication#if-you-dont-have-an-auth0-account-yet) ...you can [sign up for one here](https://auth0.com/signup) - it's free. **Register your app with Auth0** 1. In the menu on the left side of the Auth0 dashboard, click on **Applications.** This will expand the **Applications** menu. Select the first item in that menu, which also has the name **Applications.** You will now be on the **Applications** page. It lists all the applications that you have registered so that Auth0 can handle their login/logout processes. 2. Create a new registration for your app. Do this by clicking the Create application button near the top right of the page. ![](https://api.archbee.com/api/optimize/qoRkNxW5fJ81r_NqVpc8C/SkheYdFdJ8qjFdUvAUKMs_image.png) You can follow the prompts and instructions on the Auth0 site for more details. From the Auth0 portal you will need to retrieve the following information for your Android app: - Domain - Client ID You can store these as String resources in your app. On the Auth0 portal, you will need to build your callback URL and logout URL. Again, see the Auth0 website for details on how to do this. ### References [Auth0 Tutorial](https://auth0.com/blog/get-started-with-android-authentication-using-kotlin-part-1/) [Auth0 Website - Android Getting Started / Onboarding](https://manage.auth0.com/dashboard/us/dev-voiik8orqv6m487g/onboarding) ### Integrating Auth0 with Ditto Assuming you have a login button in the HTML: ```javascript ``` We attach a **login** function to the button. ```javascript import createAuth0Client from '@auth0/auth0-spa-js'; // OR for React import { useAuth0 } from '@auth0/auth0-react'; // configure your auth0 client... async function login () { await auth0.loginWithRedirect({ redirect_uri: window.location.origin }); startDitto() } ``` We can then create a **startDitto** function that gets the access token and starts a new Ditto instance, and passes the token to your server route you created in the previous section. :::hint{type="info"} The provider name given to the Ditto Client must match a provider name in the portal (e.g., **replit-auth**). If you have multiple providers, ensure you specify the provider name that you want your app to use. ::: ```javascript import createAuth0Client from '@auth0/auth0-spa-js'; // OR for React import { useAuth0 } from '@auth0/auth0-react'; import { init, Ditto } from "@dittolive/ditto" // configure your auth0 client... let ditto (async () => { await init() // you need to call this at least once before using any of the Ditto API function startDitto () { let token = await auth0.getAccessTokenSilently(); const authHandler = { authenticationRequired: async function(authenticator) { await authenticator.login(token, "replit-auth"); console.log("Login request completed."); }, authenticationExpiringSoon: function(authenticator, secondsRemaining) { console.log(`Auth token expiring in ${secondsRemaining} seconds`) await authenticator.login(token, "replit-auth"); console.log("Login request completed."); } } const identity = { type: 'onlineWithAuthentication', appID: 'REPLACE_ME_WITH_YOUR_APP_ID', authHandler } ditto = new Ditto(identity, '/persistence/file/path') ditto.startSync() } async function login () { await auth0.loginWithRedirect({ redirect_uri: window.location.origin }); startDitto() } })() ``` To demonstrate that this Ditto client has been authenticated, let's display the number of cars in the collection, and a button to add one item to it: :::CodeblockTabs JSX ```javascript

Cars: {numberOfCars}

``` ::: Once we start the ditto instance, we can create a **liveQuery** and create a button that adds items to a collection: ```javascript let subscription = ditto.store.collection('cars').find("state == 'FOR_SALE'").subscribe() let liveQuery = ditto.store.collection('cars').find("name == 'Toyota'").observeLocal((cars) => { numberOfCars = cars.length }) function addItem () { ditto.store.collection('cars').upsert({ "name": 'Toyota', "state": 'FOR_SALE' }) } ``` **Log out** ```javascript let loggedIn = false if (auth0.isAuthenticated()) { loggedIn = true } ``` ```javascript if (loggedIn) { // render the logout button } else { } ``` And then we can write the logout function and attach it to the button. We also recommend calling **ditto.auth.logout** with a callback function that evicts any data from the local database. ```javascript function onLogoutClick() { ditto.auth.logout(() => { ditto.store.collection('cars').findAll().evict() }) await auth0.logout({ returnTo: window.location.origin }) } ``` To make this usable for real-world applications, you can retrieve the user's profile details such as email, username, and full name. See the official Auth0 documentation for your platform to add that functionality to your application Yay! You now have a fully functioning **onlineWithAuthentication** app. Build and run it on a device. For a full application example, see the [example application on GitHub](https://github.com/getditto/examples-permission) ## Server The authentication webhook needs to handle an **HTTP POST** request. Each client that will need to authenticate will send a payload to this webhook. The following section requires that you have knowledge of writing server side HTTP endpoints and responding with a JSON payload. Code samples of server side code are written with a NodeJS / Express syntax. You can use any language or framework on the server side. ### Incoming POST body​ When your client device wants to authenticate using your webhook, your server will receive an HTTP post with a JSON payload that looks like: ```curl { "appID": "YOUR_APP_ID_HERE", // the appID "provider": "my-auth", // this is the "Name" of the "Authentication Webhook" "token": "eyJhbGciOiJI..." // this is what each device will send to authenticate } ``` Your can introspect these values by parsing out the request body: :::CodeblockTabs ```swift let express = require('express') let cors = require('cors') let body = require('body-parser') let app = express() app.use(cors()) app.use(body.json()) let app = express() app.post('/', (req, res) => { const appID = req.body.appID const provider = req.body.provider const token = req.body.token }) ``` ```javascript let express = require('express') let cors = require('cors') let body = require('body-parser') let app = express() app.use(cors()) app.use(body.json()) let app = express() app.post('/', (req, res) => { const appID = req.body.appID const provider = req.body.provider const token = req.body.token }) ``` ::: Generally, you will want to check the token for some sort of validity. Let's assume you have some sort of library or logic to parse and validate the token is for a specific user. You can also use the clientInfo key in your JSON response to pass information back to client. :::CodeblockTabs ```swift app.post('/', async (req, res) => { const token = req.body.token; try { // The token that your server receives from ditto is always a string let parsedToken = JSON.parse(token) let payload = getDittoPermissions(parsedToken) res.json(payload) } catch (err) { res.json({ "authenticate": err, "clientInfo": err.message }) } }) ``` ```javascript app.post('/', async (req, res) => { const token = req.body.token; try { // The token that your server receives from ditto is always a string let parsedToken = JSON.parse(token) let payload = getDittoPermissions(parsedToken) res.json(payload) } catch (err) { res.json({ "authenticate": err, "clientInfo": err.message }) } }) ``` ::: As a simple example, let's grant full read & write permissions to all collections and all documents. :::CodeblockTabs ```swift app.post('/', async (req, res) => { const token = req.body.token; try { let payload = { "authenticate": true, "expirationSeconds": 28800, "userID": "123abc", "permissions": { "read": { "everything": true, "queriesByCollection": {} }, "write": { "everything": true, "queriesByCollection": {} } } } res.json(payload) } catch (err) { res.json({ "authenticate": err, "clientInfo": err.message }) } }) ``` ```javascript app.post('/', async (req, res) => { const token = req.body.token; try { let payload = { "authenticate": true, "expirationSeconds": 28800, "userID": "123abc", "permissions": { "read": { "everything": true, "queriesByCollection": {} }, "write": { "everything": true, "queriesByCollection": {} } } } res.json(payload) } catch (err) { res.json({ "authenticate": err, "clientInfo": err.message }) } }) ``` ::: For more information on how to design your app's permissions, see Access Control Permissions. ### Deploy your server​ Now, the portal will attempt to reach this server. That means you must deploy it somewhere that this HTTP request is accessible. For testing, you can use a quick-deploy service such as Glitch. :::hint{type="info"} Please be sure that this endpoint is not behind a firewall or VPN. If you cannot get around this requirement [contact us](mailto\:support@ditto.live). ::: ::::