Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document SSO authentication and Backup command #173

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Document SSO authentication and Backup command #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion documentation/pages/personal/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
17 changes: 16 additions & 1 deletion documentation/pages/personal/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<Callout type="warning" emoji="⚠️">
SSO authentication is not supported yet.
Confidential SSO (using Nitro Enclaves) and Password-Less authentication are not supported yet.
</Callout>

### 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)
Expand Down
20 changes: 20 additions & 0 deletions documentation/pages/personal/backup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-<timestamp>.db
dcli backup

# You can specify the directory and filename
dcli backup --filename <filename> --directory <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