From f93ace70143f5b1f4d3a9defaf85d92adfbb9a60 Mon Sep 17 00:00:00 2001 From: Corentin Mors Date: Thu, 17 Aug 2023 16:45:36 +0200 Subject: [PATCH] Document SSO authentication and Backup command --- documentation/pages/personal/_meta.json | 3 ++- .../pages/personal/authentication.mdx | 17 +++++++++++++++- documentation/pages/personal/backup.mdx | 20 +++++++++++++++++++ 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 documentation/pages/personal/backup.mdx diff --git a/documentation/pages/personal/_meta.json b/documentation/pages/personal/_meta.json index 0e219e45..4ba83e29 100644 --- a/documentation/pages/personal/_meta.json +++ b/documentation/pages/personal/_meta.json @@ -3,5 +3,6 @@ "authentication": "Authentication", "devices": "Managing your Devices", "vault": "Accessing your Vault", - "secrets": "Load secrets" + "secrets": "Load secrets", + "backup": "Backup your local Vault" } diff --git a/documentation/pages/personal/authentication.mdx b/documentation/pages/personal/authentication.mdx index 1065097b..e3f19aeb 100644 --- a/documentation/pages/personal/authentication.mdx +++ b/documentation/pages/personal/authentication.mdx @@ -11,10 +11,25 @@ dcli sync Authenticating to your personal vault requires your email. You will be then asked to validate a second factor to register the CLI to your account. +## Supported primary authentication methods + +- Master Password +- SSO (self-hosted only) + - SSO authentication is not supported yet. + Confidential SSO (using Nitro Enclaves) and Password-Less authentication are not supported yet. +### Requirements for SSO authentication + +You must have: + +- the [latest Chrome browser](https://support.google.com/chrome/answer/95346) installed on your machine +- a visual interface to be able to authenticate in the browser +- a machine that has a keychain (macOS, Windows, Linux with libsecret installed for instance) + +The CLI will open a new **incognito** tab to authenticate you to your SSO provider. + ## Supported 2FA methods - Email code validation (default) diff --git a/documentation/pages/personal/backup.mdx b/documentation/pages/personal/backup.mdx new file mode 100644 index 00000000..575c481a --- /dev/null +++ b/documentation/pages/personal/backup.mdx @@ -0,0 +1,20 @@ +# Backup your local Vault + +By using the `backup` command, you can backup your local vault to a given directory and filename. +The command will perform a sync prior to the backup to ensure that the latest data is pulled from the Dashlane servers. + +The backup is a [sqlite3](https://www.sqlite.org/index.html) database file containing all your secrets encrypted by your master password. + +```bash +# By default the backup file is stored in the current directory and named dashlane-backup-.db +dcli backup + +# You can specify the directory and filename +dcli backup --filename --directory +``` + +The database is composed of 3 tables: + +- `device`: contains the current device information and configuration (including your device secrets) +- `transactions`: contains all the transactions that composed your vault (the type determines if the transaction is a password, a note, a credit card, etc.) +- `syncUpdates`: contains the sync updates when the data was pulled from the Dashlane servers