diff --git a/404.html b/404.html index 83165bcf..a23beaa6 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -404: This page could not be found

404

This page could not be found.

\ No newline at end of file +404: This page could not be found

404

This page could not be found.

\ No newline at end of file diff --git a/_next/static/OqXtP-0Q9GcoT_UoG7O4M/_buildManifest.js b/_next/static/clhqOoSWt5dpd8tRlLjoA/_buildManifest.js similarity index 100% rename from _next/static/OqXtP-0Q9GcoT_UoG7O4M/_buildManifest.js rename to _next/static/clhqOoSWt5dpd8tRlLjoA/_buildManifest.js diff --git a/_next/static/OqXtP-0Q9GcoT_UoG7O4M/_ssgManifest.js b/_next/static/clhqOoSWt5dpd8tRlLjoA/_ssgManifest.js similarity index 100% rename from _next/static/OqXtP-0Q9GcoT_UoG7O4M/_ssgManifest.js rename to _next/static/clhqOoSWt5dpd8tRlLjoA/_ssgManifest.js diff --git a/business.html b/business.html index 1d495698..cdb720fb 100644 --- a/business.html +++ b/business.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Business
Get Started

Get started with Business Commands

+
Business
Get Started

Get started with Business Commands

Commands related to business use a different authentication than your personal vault.

Commands are calling a server API to perform actions and retrieve data. The first step is to login with the personal account (follow this guide) of a team admin and to generate a set of credentials.

Generate credentials

@@ -29,4 +29,4 @@ 

dcli t credentials list

Revoke credentials

💡
Needs to be authenticated as an admin to use this command.
-
dcli t credentials revoke <DASHLANE_TEAM_ACCESS_KEY>
Backup your local VaultAudit Logs
\ No newline at end of file +
dcli t credentials revoke <DASHLANE_TEAM_ACCESS_KEY>
Backup your local VaultAudit Logs
\ No newline at end of file diff --git a/business/audit-logs.html b/business/audit-logs.html index 67c4afca..cae8b72f 100644 --- a/business/audit-logs.html +++ b/business/audit-logs.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Business
Audit Logs

Audit logs

+
Business
Audit Logs

Audit logs

💡
Needs team credentials to use this command.

Fetching the logs

You can query the audit logs using the logs command. For example:

@@ -89,4 +89,4 @@

dcli t logs --start $last_pull_date >> logs.json

Make sure to replace /path/to/script.sh with the actual path to the script. The other paths in the script are only examples and may not reflect the permissions of your system, you can change them to your needs.

-

Configure your SIEM agent to watch the logs.json file changes.

Get StartedMembers
\ No newline at end of file +

Configure your SIEM agent to watch the logs.json file changes.

Get StartedMembers
\ No newline at end of file diff --git a/business/members.html b/business/members.html index 0a28adcb..cdd20a68 100644 --- a/business/members.html +++ b/business/members.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Business
Members

Listing members

+
Business
Members

Listing members

💡
Needs team credentials to use this command.

Fetching the list of members

Listing team members allows you to access many information about them, such as their email, their role, their 2FA status, their security score, etc.

@@ -28,4 +28,4 @@

The dates will be displayed in the ISO 8601 format.

Note that keys ending with Unix will be converted to human readable dates and renamed to remove the Unix suffix.

Members interface

-
PropertyTypeDescription
membersArray of objectArray of team members
members.userIdnumber | undefinedThe user identifier of the user
members.loginstringUser login (usually email)
members.statusstringMember status
members.joinedDateUnixnumber | nullThe join date of member in Unix time
members.lastUpdateDateUnixnumber | nullLast updated date of member in Unix time
members.isBillingAdminbooleanTrue if user is a billing admin, false otherwise
members.isTeamCaptainbooleanTrue if user is a team captain, false otherwise
members.isGroupManagerbooleanTrue if user is a group manager, false otherwise
members.emailstring | undefinedThe user's account email
members.isAccountCreatedboolean | undefinedIf user account is created
members.invitedDateUnixnumberDate user was invited
members.tokenobjectThe user's invite token
members.token.userIdnumber | undefinedUser identifier associated with the token
members.token.teamIdnumber | undefinedTeam identifier associated with the token
members.token.tokenstring | undefinedValue of the invite token
members.token.isFreshboolean | undefinedTrue if token is not used, false otherwise
members.token.inviteUserIdnumber | undefinedThe user identifier of the inviter
members.revokedDateUnixnumber | nullWhen user's account was revoked in Unix time
members.languagestring | undefinedUser's preferred language
members.nbrPasswordsnumber | nullNumber of passwords stored by user
members.reusednumber | nullNumber of reused passwords
members.reusedDistinctnumber | nullNumber of distinct reused passwords
members.weakPasswordsnumber | nullNumber of weak passwords
members.compromisedPasswordsnumber | nullNumber of compromised passwords
members.averagePasswordStrengthnumber | nullAverage password strength score
members.passwordStrength0_19Countnumber | nullNumber of passwords between 0 to 19 characters
members.passwordStrength20_39Countnumber | nullNumber of passwords between 20 to 39 characters
members.passwordStrength40_59Countnumber | nullNumber of passwords between 40 to 59 characters
members.passwordStrength60_79Countnumber | nullNumber of passwords between 60 to 79 characters
members.passwordStrength80_100Countnumber | nullNumber of passwords between 80 to 100 characters
members.safePasswordsnumber | nullNumber of passwords considered safe
members.namestring | nullUser's name
members.securityIndexnumber | nullSecurity index
members.twoFAInformationobject2FA information for the user
members.twoFAInformation.type'sso' | 'email_token' | 'totp_device_registration' | 'totp_login' | undefined2FA type
members.twoFAInformation.phonestring | nullPhone number for 2FA
members.twoFAInformation.lastUpdateDateUnixnumber | nullLast updated date of 2FA in Unix time
members.hasPublicKeybooleanTrue if user has a public key
billingAdminsArray of stringArray of emails of billing admins
pagenumberCurrent page of results
pagesnumberTotal pages of results
Audit LogsReports
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
PropertyTypeDescription
membersArray of objectArray of team members
members.userIdnumber | undefinedThe user identifier of the user
members.loginstringUser login (usually email)
members.statusstringMember status
members.joinedDateUnixnumber | nullThe join date of member in Unix time
members.lastUpdateDateUnixnumber | nullLast updated date of member in Unix time
members.isBillingAdminbooleanTrue if user is a billing admin, false otherwise
members.isTeamCaptainbooleanTrue if user is a team captain, false otherwise
members.isGroupManagerbooleanTrue if user is a group manager, false otherwise
members.emailstring | undefinedThe user's account email
members.isAccountCreatedboolean | undefinedIf user account is created
members.invitedDateUnixnumberDate user was invited
members.tokenobjectThe user's invite token
members.token.userIdnumber | undefinedUser identifier associated with the token
members.token.teamIdnumber | undefinedTeam identifier associated with the token
members.token.tokenstring | undefinedValue of the invite token
members.token.isFreshboolean | undefinedTrue if token is not used, false otherwise
members.token.inviteUserIdnumber | undefinedThe user identifier of the inviter
members.revokedDateUnixnumber | nullWhen user's account was revoked in Unix time
members.languagestring | undefinedUser's preferred language
members.nbrPasswordsnumber | nullNumber of passwords stored by user
members.reusednumber | nullNumber of reused passwords
members.reusedDistinctnumber | nullNumber of distinct reused passwords
members.weakPasswordsnumber | nullNumber of weak passwords
members.compromisedPasswordsnumber | nullNumber of compromised passwords
members.averagePasswordStrengthnumber | nullAverage password strength score
members.passwordStrength0_19Countnumber | nullNumber of passwords between 0 to 19 characters
members.passwordStrength20_39Countnumber | nullNumber of passwords between 20 to 39 characters
members.passwordStrength40_59Countnumber | nullNumber of passwords between 40 to 59 characters
members.passwordStrength60_79Countnumber | nullNumber of passwords between 60 to 79 characters
members.passwordStrength80_100Countnumber | nullNumber of passwords between 80 to 100 characters
members.safePasswordsnumber | nullNumber of passwords considered safe
members.namestring | nullUser's name
members.securityIndexnumber | nullSecurity index
members.twoFAInformationobject2FA information for the user
members.twoFAInformation.type'sso' | 'email_token' | 'totp_device_registration' | 'totp_login' | undefined2FA type
members.twoFAInformation.phonestring | nullPhone number for 2FA
members.twoFAInformation.lastUpdateDateUnixnumber | nullLast updated date of 2FA in Unix time
members.hasPublicKeybooleanTrue if user has a public key
billingAdminsArray of stringArray of emails of billing admins
pagenumberCurrent page of results
pagesnumberTotal pages of results
Audit LogsReports
\ No newline at end of file diff --git a/business/reports.html b/business/reports.html index 070dfc5f..fb149c4f 100644 --- a/business/reports.html +++ b/business/reports.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Business
Reports

Reports

+
Business
Reports

Reports

💡
Needs team credentials to use this command.

You can get reports on your team about the number of seats provisioned, used and pending. You can also get reports on the aggregated password health history of your team.

Fetch reports

@@ -82,4 +82,4 @@

plt.savefig(file_path) plt.close() - return file_path

MembersLogout
\ No newline at end of file + return file_path
MembersLogout
\ No newline at end of file diff --git a/guides.html b/guides.html index 8eff4bfc..a823f4d1 100644 --- a/guides.html +++ b/guides.html @@ -9,6 +9,6 @@ .dark { --nextra-primary-hue: 204deg; } -
Guides

Our guides in video

+
Guides

Our guides in video

We made a series of videos to help you understand how to use the CLI.

-
InstallGet Started
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
InstallGet Started
\ No newline at end of file diff --git a/index.html b/index.html index 5e053b5c..0d2678f2 100644 --- a/index.html +++ b/index.html @@ -9,10 +9,10 @@ .dark { --nextra-primary-hue: 204deg; } -

Documentation

+

Documentation

⚙️ Setup the CLI💬 Discuss with us👩‍💻 Contribute on Github

Dashlane CLI

Dashlane CLI is a command line interface for Dashlane. It allows you to interact with your Dashlane account, and to manage your passwords, secure notes, secrets and personal data.

Dashlane CLI also allows you to access team admin related features such as accessing your team's member list, Dark Web Insights reports and activity logs.

This documentation is separated in two parts:

-
👤 Personal Commands👔 Business Commands
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
👤 Personal Commands👔 Business Commands
\ No newline at end of file diff --git a/install.html b/install.html index 6c7e87a1..034621ec 100644 --- a/install.html +++ b/install.html @@ -9,11 +9,11 @@ .dark { --nextra-primary-hue: 204deg; } -
Install

Install

+
Install

Install

The Dashlane CLI can be installed in multiple ways. You can either install it using Homebrew (opens in a new tab) on macOS and Linux, manually with Yarn (opens in a new tab) or download the packaged executables for Windows, macOS and Linux on x64 architectures.

You can install the Dashlane CLI using Homebrew (opens in a new tab), a package manager for macOS and Linux.

To install Homebrew, run the following command in your terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then you need to run the following command:

brew install dashlane/tap/dashlane-cli

The CLI is now installed on your machine, it will be updated automatically when a new version is released.

What's next?

IntroductionGuides
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
IntroductionGuides
\ No newline at end of file diff --git a/logout.html b/logout.html index 30e80bd8..696855f2 100644 --- a/logout.html +++ b/logout.html @@ -9,8 +9,8 @@ .dark { --nextra-primary-hue: 204deg; } -
Logout

Logout

+
Logout

Logout

If you want to start fresh with the CLI or use another account, you can logout and reset the local data by running the following command:

dcli logout
ℹ️

This does not perform an account reset, it only resets the local data on the device.

-

A confirmation will be asked, then the local database containing your encrypted data will be wiped and any entry related to the CLI will be removed from the OS keychain.

ReportsTroubleshooting
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +

A confirmation will be asked, then the local database containing your encrypted data will be wiped and any entry related to the CLI will be removed from the OS keychain.

ReportsTroubleshooting
\ No newline at end of file diff --git a/personal.html b/personal.html index 52b8c276..ab2111a7 100644 --- a/personal.html +++ b/personal.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Personal
Get Started

Get started with Personal Commands

+
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
🔑 Authentication🔒 Accessing your vault📱 Manage your devices🔎 Load your secrets🛟 Backup your local vault
GuidesAuthentication
\ No newline at end of file diff --git a/personal/authentication.html b/personal/authentication.html index f2f91e3e..c35cc293 100644 --- a/personal/authentication.html +++ b/personal/authentication.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Personal
Authentication

Authentication

+
Personal
Authentication

Authentication

To start with launch a first manual sync:

dcli sync

Authenticating to your personal vault requires your email. @@ -39,4 +39,4 @@

Options

By default your Master Password will be saved locally in the OS keychain so you don't have to enter it every time. You can disable this behavior with the following command:

-
dcli configure save-master-password false
Get StartedManaging your Devices
Apache 2023 © Dashlane, Inc.
\ No newline at end of file +
dcli configure save-master-password false
Get StartedManaging your Devices
\ No newline at end of file diff --git a/personal/backup.html b/personal/backup.html index 6e26a2f2..1d52ab91 100644 --- a/personal/backup.html +++ b/personal/backup.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
Personal
Backup your local Vault

Backup your local Vault

+
Personal
Backup your local Vault

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 (opens in a new tab) database file containing all your secrets encrypted by your master password.

@@ -23,4 +23,4 @@
  • 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
    • -
    Load secrets into templated filesGet Started
    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file +
    Load secrets into templated filesGet Started
    \ No newline at end of file diff --git a/personal/devices.html b/personal/devices.html index 443aef41..a8025786 100644 --- a/personal/devices.html +++ b/personal/devices.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
    Personal
    Managing your Devices

    Managing your devices

    +
    Personal
    Managing your Devices

    Managing your devices

    List your devices

    dcli devices list

    You'll get a list of all your devices, with their ID, name, and platform.

    @@ -43,4 +43,4 @@

    Please, replace <insert your master password here> with your actual master password.

    ⚠️

    OTP at each login and SSO are not supported for non-interactive devices. We recommend creating a dedicated Dashlane account for your non-interactive devices.

    -

    Once you've set the environment variables, you can use the CLI to retrieve passwords, otp and notes and no interactive prompts will be shown.

    AuthenticationAccessing your Vault

    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file +

    Once you've set the environment variables, you can use the CLI to retrieve passwords, otp and notes and no interactive prompts will be shown.

    AuthenticationAccessing your Vault
    \ No newline at end of file diff --git a/personal/secrets/exec.html b/personal/secrets/exec.html index 7c851177..1ac1bf40 100644 --- a/personal/secrets/exec.html +++ b/personal/secrets/exec.html @@ -9,11 +9,11 @@ .dark { --nextra-primary-hue: 204deg; } -
    Personal
    Load secrets
    Load secrets into environment variables

    Load secrets into environment variables

    +
    Personal
    Load secrets
    Load secrets into environment variables

    Load secrets into environment variables

    The Dashlane CLI allows you to load secrets into environment variables. This is useful for example when you want to use secrets in your applications in development.

    By using secret references in your environment variables, you can load secrets from your Dashlane account into your environment variables and avoid having to store them in plain text in your code.

    Get your secret reference

    Follow the guide in Read secrets references to learn how to get your secret reference.

    It should look like this: dl://<secret_identifier>/<field>?<transformer>

    Export environment variables

    You can now export your secret reference into an environment variable :

    export GITLAB_TOKEN='dl://mygitlabtoken/password'

    Use your secret in your application

    In your code you can for instance read the variable from the env:

    app.js
    const token = process.env.GITLAB_TOKEN;
  
 console.log(token);

    Finally, you can use the dcli exec command to run your application with the environment variables loaded from your Dashlane account.

    dcli exec -- node app.js

    The stdin and stdout of your application will be piped to the terminal. -Every environment variable that starts with dl:// will be replaced by the secret value from your Dashlane account.

    Read secrets referencesLoad secrets into templated files
    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file +Every environment variable that starts with dl:// will be replaced by the secret value from your Dashlane account.

    Read secrets referencesLoad secrets into templated files
    \ No newline at end of file diff --git a/personal/secrets/inject.html b/personal/secrets/inject.html index d66ec397..7ccadc6e 100644 --- a/personal/secrets/inject.html +++ b/personal/secrets/inject.html @@ -9,11 +9,11 @@ .dark { --nextra-primary-hue: 204deg; } -
    Personal
    Load secrets
    Load secrets into templated files

    Load secrets into templated files

    +
    Personal
    Load secrets
    Load secrets into templated files

    Load secrets into templated files

    Using Dashlane CLI you can inject secrets into templated files. This is useful for example to inject secrets into configuration files and avoid storing secrets in your repository.

    Get your secret reference

    Follow the guide in Read secrets references to learn how to get your secret reference.

    It should look like this: dl://<secret_identifier>/<field>?<transformer>

    Use secret references in your config file

    In your template config file, use the secret reference as a placeholder for the value you want to inject.

    The secret reference must be enclosed in double curly braces {{ }}.

    For instance, let's create a template config file for a fictive API:

    config.yaml.template
    api:
     url: https://api.example.com
     port: 443
-    access_token: '{{ dl://<secret_identifier>/<field> }}'

    Inject secrets into your config file

    Use the dcli inject command to inject secrets into your config file.

    Inject secrets into config file
    dcli inject --in config.yaml.template --out config.yaml

    In output file, the secret reference is replaced by the plaintext secret value.

    Dashlane CLI inject secret

    ️🚫

    Make sure to delete the resolved config file if you no longer need it.

    Load secrets into environment variablesBackup your local Vault
    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file + access_token: '{{ dl://<secret_identifier>/<field> }}'

    Inject secrets into your config file

    Use the dcli inject command to inject secrets into your config file.

    Inject secrets into config file
    dcli inject --in config.yaml.template --out config.yaml

    In output file, the secret reference is replaced by the plaintext secret value.

    Dashlane CLI inject secret

    ️🚫

    Make sure to delete the resolved config file if you no longer need it.

    Load secrets into environment variablesBackup your local Vault
    \ No newline at end of file diff --git a/personal/secrets/read.html b/personal/secrets/read.html index 6793c478..f537d179 100644 --- a/personal/secrets/read.html +++ b/personal/secrets/read.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
    Personal
    Load secrets
    Read secrets references

    Read secrets references

    +
    Personal
    Load secrets
    Read secrets references

    Read secrets references

    A secret reference is an URI starting by dl:// that points to a secret stored in your vault.

    You can use a secret reference to securely load a secret from your vault into environment variables, scripts or configuration files.

    @@ -57,4 +57,4 @@

    # Read a specific field of the secret and apply a transformer dcli read dl://<secret_identifier>/<field>?<transformer>

    Note: Accessing a secret with the secret identifier is faster than using the title of the secret as it does not require to decrypt the whole vault.

    -

    Dashlane CLI read otp

    Accessing your VaultLoad secrets into environment variables
    \ No newline at end of file +

    Dashlane CLI read otp

    Accessing your VaultLoad secrets into environment variables
    \ No newline at end of file diff --git a/personal/vault.html b/personal/vault.html index cbe38cb2..b725e290 100644 --- a/personal/vault.html +++ b/personal/vault.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
    Personal
    Accessing your Vault

    Accessing your Vault

    +
    Personal
    Accessing your Vault

    Accessing your Vault

    ℹ️

    For now accessing your vault is read only.

    Get a password

    @@ -62,4 +62,4 @@

    Now, make sure your CLI is synchronized:

    dcli sync

    Once done, you can retrieve the private key from your vault and inject it in your SSH agent:

    -
    dcli n SSH_DEMO_KEY | ssh-add -
    Managing your DevicesRead secrets references

    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file +
    dcli n SSH_DEMO_KEY | ssh-add -
    Managing your DevicesRead secrets references
    \ No newline at end of file diff --git a/troubleshooting.html b/troubleshooting.html index f8ce2ce1..9f1b0079 100644 --- a/troubleshooting.html +++ b/troubleshooting.html @@ -9,7 +9,7 @@ .dark { --nextra-primary-hue: 204deg; } -
    Troubleshooting

    Troubleshooting

    +
    Troubleshooting

    Troubleshooting

    Here are a few common issues and how to fix them.

    Mismatching signatures

    If you are using the CLI in multiple environments, and particularly in an IDE like WebStorm, they may use different @@ -23,4 +23,4 @@

    In NodeJS the list of certificate authorities is hardcoded, read more here: nodejs/node#4175 (opens in a new tab). You can use an environment variable to add custom certs (see documentation (opens in a new tab)):

    export NODE_EXTRA_CA_CERTS="/path/to/cert.pem"
    -

    See the issue #46 (opens in a new tab).

    LogoutDashlane Help Center ↗

    Apache 2023 © Dashlane, Inc.
    \ No newline at end of file +

    See the issue #46 (opens in a new tab).

    LogoutDashlane Help Center ↗
    \ No newline at end of file