1
0
mirror of https://github.com/bitwarden/help synced 2025-12-11 05:43:20 +00:00

Vault Management (#382)

* Staging: Vault Mgmt (#380)

* Commit #1
- Updated Master Password article, and removed old versions (w/ 
redirects)
- Repurposed Account Encryption Key Article
- Moved Fingerprint Phrase article
- Requisite re-ordering of security articles
- Change "Account Mgmt" title to "Your Vault"
- Slight change to "Import & Export" category title

* - Managing Items
- Favorites & Folders (+images)
- Sync & Search (+images)
- Import Export title change
- Clarification re: Login v. Lock in "Field Guide to Two-step Login"
- Clarifiation re: Org Invite Expiry in managing-users.md
- New link to Acct. Encryption Key in encrypted-export.md

* Commit #3
-Custom Fields
- URIs (+ images)
- File Attachments
- VH Reports
- Required re-ordering

* Commit #4
-BWDC Login recommendation
-VH Reports images
- Added Two-step FAQs, Import FAQs
- FAQ Nav Item depricated, targetting FAQs for each category are now the 
last article within respective categories

* Commit #5
-Edit & move Account/Org Deletion Article
-config.yml to re-order global nav
-encrypted export update

* General FAQs (preliminary edits)

* Features > Misc.

* return forgot-master-password.md & downstream order changes

* delete account warning

* fixed link
This commit is contained in:
fred_the_tech_writer
2021-02-01 08:58:52 -05:00
committed by GitHub
parent fc4684720d
commit aa9e70659a
60 changed files with 797 additions and 619 deletions

View File

@@ -0,0 +1,46 @@
---
layout: article
title: Account Encryption Key
categories: [security]
featured: false
popular: false
tags: [encryption key, account]
order: 04
redirect_from:
- /article/update-encryption-key/
---
Each unique Bitwarden account has an encryption key derived from your Master Password, according to the methods defined in [Encryption]({% link _articles/security/what-encryption-is-used.md %}). This encryption key is used to encrypt all Vault data.
## Rotate your Encryption Key
{% callout warning %}
**Rotating your encryption key is a potentially dangerous operation.** Please read this section thoroughly to understand the full ramifications of doing so.
{% endcallout %}
Rotating your account's encryption key generates a new encryption key that is used to re-encryption all Vault data. After rotating, you should quickly take the following actions to prevent data loss or corruption:
#### Log out of Client Applications
When you rotate an encryption key, you **must immediately** log out of any logged-in sessions on Bitwarden client applications (Desktop App, Browser Extension, Mobile App, etc). Logging out of client applications in this way will shut down sessions using the "stale" (prior-to-rotation) encryption key. After doing so, logging back in as normal will use the new encryption key.
**Making changes in a session with a "stale" encryption key will cause data corruption that will make your data unrecoverable.**
#### Re-download any Encrypted Exports
If you're using [Encrypted Exports]({% link _articles/importing/encrypted-export.md %}) to store long-term secure backups, you should immediately re-download the encrypted export of your Vault data using the new encryption key.
Encrypted Exports use your encryption key to encrypt **and decrypt** your Vault data, meaning that a rotated encryption key will not be able to decrypt an export created with the "stale" (prior-to-rotation) key.
### How to Rotate your Encryption Key
Complete the following steps to rotate your account encryption key:
1. Log in to your [Web Vault](https://vault.bitwarden.com){:target="\_blank"}.
2. Select **Settings** from the top navigation bar.
3. On the **My Account** page, locate the **Change Master Password** section.
4. Enter your **Current Master Password** and create/confirm a **New Master Password**.
{% callout success %}If you don't want to change your Master Password and only rotate your account encryption key, you can enter your current master password in the **New** fields to prevent it from changing.{% endcallout %}
5. Check the **Also rotate my account's encryption key** checkbox and accept the dialog.
6. Select the **Change Master Password** button.

View File

@@ -1,11 +1,11 @@
---
layout: article
title: Unlock with Biometrics
categories: [getting-started]
categories: [account-management]
featured: false
popular: false
tags: [unlock, face id, touch id, hello, windows, mac, ios, android]
order: 06
order: 10
---
Bitwarden can be configured to accept biometrics as a method to unlock your Vault. Biometrics can **only be used to unlock** your Vault, you will still be required to log in to your Vault with your Master Password and any enabled [Two-step Login method]({% link _articles/two-step-login/setup-two-step-login.md %}).
@@ -97,7 +97,7 @@ Complete the following steps to enable Biometric Unlock in your Browser Extensio
4. Check the **Unlock with biometrics** checkbox to activate the integration. You will be prompted by your Desktop App to input your biometric authentication method to complete the setup.
If you've opted to **Require verification for browser integration**, a `Desktop sync verification` dialog box will appear in your Browser Extension and a `Verify browser connection` dialog box will appear in your Desktop Application. Validate that the displayed [account fingerprint]({% link _articles/features/fingerprint-phrase.md %}) matches in both locations. If they match, select the **Approve** button and input your Biometric authentication method.
{% callout success %}In either case, you'll need to redo this "activation" step each time the Desktop App or Browser Extension is restarted.{% endcallout %}
Once Biometric Unlock is enabled, a new button will be presented on the Unlock screen. Selecting the **Unlock biometrics** button will initiate unlock via the Desktop App.

View File

@@ -1,28 +0,0 @@
---
layout: article
title: Change your email
categories: [account-management]
featured: false
popular: false
tags: [account, email]
---
Your email address can only be changed from the [web vault](https://vault.bitwarden.com).
{% callout warning %}
Changing your email address will log you out of all Bitwarden applications.
{% endcallout %}
1. Log in to the web vault at <https://vault.bitwarden.com>
2. Click **Settings** in the top navigation bar
3. Locate the **Change Email** section under **My Account**
4. Type in your master password and the email you want to use
5. Click the **Continue** button
6. Check your email inbox for the verification code from Bitwarden and enter it into the textbox
7. Click the **Change Email** button
8. Log back in to confirm that you can log in using the new email
9. Log out and back in to any other Bitwarden applications that you are using. You will eventually be logged out automatically.
{% callout info %}
If you have not receive the verification code from Bitwarden after a few minutes, please check your spam folder to see if the message got filtered by mistake. Adding "no-reply@bitwarden.com" to your contacts and whitelist the same domain may help to ensure delivery.
{% endcallout %}

View File

@@ -1,32 +0,0 @@
---
layout: article
title: Change your master password
categories: [account-management]
featured: false
popular: false
tags: [password, account]
---
Your master password can only be changed from the [web vault](https://vault.bitwarden.com).
{% callout warning %}
Changing your master password will log you out of all Bitwarden applications.
{% endcallout %}
1. Log in to the web vault at <https://vault.bitwarden.com>
2. Click **Settings** in the top navigation bar
3. Locate the **Change Master Password** section under **My Account**
4. Type in your current password, the new password you want, and then re-type to confirm
5. Click the **Change Master Password** button
6. Log back in to confirm that your new password is working
7. Log out and back in any other Bitwarden applications that you are using. You will eventually be logged out automatically.
## Rotating your account's encryption key
During a password change operation you also have the option to rotate (change) your account's encryption key. Rotating the encryption key is a good idea if you believe that your previous master password was compromised or that your Bitwarden vault's data was stolen from one of your devices.
{% callout warning %}
Rotating your account's encryption key is a sensitive operation, which is why it is not a default option. A key rotation involves generating a new, random encryption key for your account and re-encrypting all vault data using this new key.
Because your account's encryption key changes, any old sessions with a Bitwarden application that you may be logged into with your account will still have the old, incorrect encryption key. If you make any changes to your account's vault data with an old encryption key, that data will become corrupted and unrecoverable. After rotating your account's encryption key it is very important that you completely log out and back in to all Bitwarden applications where you are using that account. Logging out and back in will ensure that your account has downloaded its new encryption key. We will attempt to log you out of all Bitwarden applications automatically, but it may not happen immediately.
{% endcallout %}

View File

@@ -1,28 +1,50 @@
---
layout: article
title: Delete your account
categories: [account-management]
title: Delete your Account or Organization
categories: [plans-and-pricing]
featured: false
popular: false
tags: [account, delete]
order: 08
---
Your account can only be deleted from the [web vault](https://vault.bitwarden.com). Deleting your Bitwarden account permanently deletes your account and all data that is associated with it. Bitwarden does not "soft delete" any data.
Deleting your Bitwarden account or Organization permanently deletes the account or Organization and **all data that is associated with it**. Bitwarden does not "soft delete" any data.
Deleting an account or Organization does not automatically cancel your subscription. If you're leaving Bitwarden, you should cancel your subscription from the **Settings** &rarr; **Premium Membership** or **Organization Settings** &rarr; **Subcription** page first.
If you're locked out of your Vault and deleting your account so that you can create a new one, [Contact Us](https://bitwarden.com/contact/){:target="\_blank"} and we can help transfer your subcription to the new account.
{% callout warning %}
This action is permanent and cannot be undone.
{% endcallout %}
1. Log in to the web vault at <https://vault.bitwarden.com>
2. Click **Settings** in the top navigation bar
3. Click the **Delete Account** button under the **Danger Zone** section of **My Account**
4. Type in your master password and click the **Delete Account**. You will be logged out when the delete completes.
## Delete your Personal Account
## Delete without logging in
### From the Web Vault
You can also delete your account without having to know the password. This is helpful in the event that you forget your password and need to start over.
1. In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select **Settings** from the top navigation bar.
3. On the **My Account** page, scroll down to the **Danger Zone** and select the **Delete Account**.
1. Navigate to <https://vault.bitwarden.com/#/recover-delete>
2. Enter your account's email address
3. Go to your email inbox and click the verification link that was sent to you
4. Confirm the delete
You'll be prompted to enter your Master Password to confirm you have the authority to take this action.
### Without Logging In
In the event that you have lost your Master Password, omplete the following steps to delete your account:
1. Navigate to [vault.bitwarden.com/#/recover-delete](https://vault.bitwarden.com/#/recover-delete).
2. Enter the **Email Address** associated with your account.
3. In your email inbox, open the email to verify that you want to delete this Bitwarden account.
Once deleted, you're free to create a new Bitwarden account with that email address. If you delete a Bitwarden account that has a Premium subscription associated with it, [Contact Us](https://bitwarden.com/contact/){:target="\_blank"} and we'll reapply your existing subscription to the new account.
## Delete your Organization
{% callout info %}
Only the **Owner** of an Organization has the authority to delete the Organization. For more information, see [User Types and Access Controls]({% link _articles/organizations/user-types-access-control.md %}).
{% endcallout %}
1. In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, open your Organization.
2. In the Organization Vault, select the **Settings** tab.
3. On the **My Organization** page, scroll down to the **Danger Zone** and select the **Delete Organization**.
You'll be prompted to enter your Master Password to confirm you have the authority to take this action.

View File

@@ -1,21 +1,27 @@
---
layout: article
title: I forgot my master password
title: I Forgot my Master Password
categories: [account-management]
featured: true
popular: false
tags: [master password, account]
order: 02
---
Unlike most services that you use on the internet, due to the way Bitwarden works there is no way to reset your master password in the event that you forget it. This is because your Bitwarden master password is used for more than just authentication (logging in). Your vault's data is also securely encrypted with your master password, therefore it is impossible to unlock or recover your vault without it.
As described in the [Your Master Password]({% link _articles/account/master-password.md %}) article, Bitwarden has no knowledge of, way to retrieve, or way to reset your Master Password. If you've already lost your Master Password, there is unfortunately no way for the team to recover the account or the data therein. You will need to delete your account and start a new one.
If you have forgotten your master password unfortunately there is no way to fully recover the account. The only option to gain access to the account again is to delete the account so that you can register again and start over. Deleting the account will also delete all of your vault data associated with the account.
{% callout success %}
If you're using any Bitwarden client applications (Mobile Apps, Browser Extensions, etc.) you should check whether any of these sessions are still logged in prior to deleting your account. If a client application is still logged in, [Export Vault Data]({% link _articles/account/export-your-data.md %}) to a file for import into a new account.
{% endcallout %}
## Deleting the account
Complete the following steps to delete your account:
1. Navigate to <https://vault.bitwarden.com/#/recover-delete>
2. Enter your account's email address
3. Go to your email inbox and click the verification link that was sent to you
4. Confirm the delete
{% callout warning%}
This action is permanent and cannot be undone.
{% endcallout %}
You can now register a new account using the same email address.
1. Navigate to [vault.bitwarden.com/#/recover-delete](https://vault.bitwarden.com/#/recover-delete).
2. Enter the **Email Address** associated with your account.
3. In your email inbox, open the email and verify that you want to delete this Bitwarden account.
Once deleted, you're free to create a new Bitwarden account with that email address. If you delete a Bitwarden account that has a Premium subscription associated with it, [Contact Us](https://bitwarden.com/contact/){:target="\_blank"} and we'll reapply your existing subscription to the new account.

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Bitwarden Safari App Extension
categories: [features]
categories: [miscellaneous]
featured: false
popular: false
tags: [browser, safari]

View File

@@ -1,80 +1,93 @@
---
layout: article
title: Managing Items
title: Vault Items
categories: [account-management]
featured: false
popular: false
tags: [account, items, import, delete, trash, clone]
order: 03
---
## About Managing Items
Bitwarden can store 4 types of items in your Vault:
Managing the items in your vault is key to making sure that you secure, have access to, and can share the correct information with friends, family, teams, and colleagues.
- [Logins](#logins)
- [Cards](#cards)
- [Identities](#identities)
- [Secure Notes](#secure-notes)
## Adding items
Effectively managing the items in your Vault is key to making sure that you secure and have seamless access to your information, and can safely share information with friends, family, teams, and colleagues.
Adding items to your Bitwarden vault can be done manually or via import.
## Add a Vault Item
To manually add an item, once youre in your vault - simply click or touch the “+” icon or “Add item” button.
You can add items to your Vault from the Bitwarden [Web Vault](https://vault.bitwarden.com){:target="\_blank"} or any client application. Look for a {% icon fa-plus %} **Add** icon to add an item to your Vault. There are 4 types of items you can add to your Vault.
Youll then be asked to provide details about the item.
All item types can be given:
- A **Name** that makes them easily identifiable to you inside your Vault.
- **Notes** related to the item in a freeform text input.
- **Custom Fields** for inputs like security questions or PINs (for more information, see [Custom Fields]({% link _articles/features/custom-fields.md %})).
{% image /manage-items/add-item.png %}
{% callout success %}
You can also import items into your Vault from a variety of password management solutions. For more information, see [Import Data to your Vault]({% link _articles/importing/import-data.md %}).
{% endcallout %}
The type of item can be:
- Login: A username/password combination usually, with support for custom fields, notes, and TOTP generation for premium and enterprise accounts.
- Card: Saves payment card data that can be automatically filled.
- Identity: Personal/Business information such as name and addresses, date of birth, and even notes.
- Secure Note: Freeform text that will be stored completely encrypted in your vault.
### Logins
## Importing items
Refer to the following screenshot for help understanding all the values available for Login items:
If youre coming from another password manager or **just happen** to have your usernames and passwords in a spreadsheet, you can import them into Bitwarden
{% image /manage-items/login-item.png Add a Login%}
You can find more details about importing items and supported import formats [here.](https://bitwarden.com/help/article/import-data/)
### Cards
### Import FAQs
Refer to the following screenshot for help understanding all the values available for Card items:
### **Q:Why is my import file invalid?**
**A:** Check to make sure the file has content. Most of the time the exported file does not contain any data.
### **Q:Why do I have duplicate entries?**
**A:** The Bitwarden import tool does not perform duplicate entry detection on import. If you run an import on an existing vault, or import multiple times, your data may be duplicated.
### **Q:How do I clean up duplicates?**
**A:** We recommend exporting the data from your vault into a CSV/JSON file and performing a vault purge to delete your data.
{% callout warning %} Performing a vault purge is permanent and cannot be undone. Once the vault has been emptied and the CSV/JSON file has been pruned of any duplicates, simply re-import your data.{% endcallout %}
{% image /manage-items/card-item.png Add a Card%}
## Troubleshooting Import Errors
### Identities
<u>Ciphers[<b>X</b>].Login: The field <b>yyyy</b> exceeds the maximum encrypted value length of <b>zzzz</b> characters.</u>
Refer to the following screenshot for help understanding all the values available for Identity items:
This error occurs whenever an item in your exported file has a large amount of data associated with it, which exceeds the limits allowed for items stored in your Bitwarden vault. You will need to correct this data by removing it, or reducing its size so that the Bitwarden importer will succeed.
{% image /manage-items/identity-item.png Add an Identity %}
You can open the exported file in a text editor or spreadsheet program (such as Excel) to locate it. The offending item can be found at index **X** (as referenced in the error message) in the file. Once you have located the offending item, remove it or update its data, then resave and try the import operation with Bitwarden again.
### Secure Notes
## Cloning an item
Refer to the following screenshot for help understanding all the values available for Secure Note items:
If you wish to recreate an item (either to share with an organization or to simply make a copy of an item, you can now do so - provided you are the owner of the item - with a one-click operation. This copies the item completely and maintains all data.
{% image /manage-items/note-item.png Add a Note%}
Simply select clone under the items action menu:
### Folders and Favorites
{% image /manage-items/item-clone.png %}
Items in your personal Vault can be organized into Folders, or marked as Favorites. For more information, see [Folders]({% link _articles/features/folders.md %}) and [Favorites]({% link _articles/features/favorites.md %}).
{% callout info %}Note - when cloning an item in an organization vault, the user must view the vault from the organization, not the users personal vault {% endcallout %}
## Delete a Vault Item
## Deleting an item
You can delete any Vault items directly from the [Web Vault](https://vault.bitwarden.com){:target="\_blank"} or from any client application:
Deleting an item can also be performed in the items action menu.
- In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select **Delete** from the hover-over {% icon fa-cog %} **Gear** dropdown.
- On Mobile Applications, open the item and tap **Delete** in the {% icon fa-ellipsis-v %} **Menu**.
- On Desktop Applications and Browser Extensions, open the item and select the {% icon fa-trash %} **Delete** icon.
{% image /manage-items/item-delete.png %}
Before an item is deleted, you will be prompted to confirm deletion. Once confirmed, the item will be placed into the Trash.
Once the delete button is selected, you will be prompted to confirm the deletion.
### Items in the Trash
{% image /manage-items/item-trash-confirm.png %}
Deleted items are sent to the Trash, where they remain for 30 days after deletion. Once 30 days have lapsed, the item will be permanently deleted and not recoverable.
Once confirmed, the item will be placed into the trash.
In the Trash, you can **Restore** an item to your Vault or **Permanently Delete** it prior to the 30-day waiting period:
## Items in the trash
{% image /manage-items/item-trash-restore-delete.png The Trash%}
Once an item has been deleted and is in the trash, it will remain there for 30 days. You can alternatively navigate to the trash view in your vault and restore, or permanently delete the item immediately.
## Share a Vault Item
{% image /manage-items/item-trash-restore-delete.png %}
If you're a member of an Organization, you can share a Vault item with the other members of your Organization. For more information, see [Share Items to a Collection]({% link _articles/organizations/share-to-a-collection.md %}).
## Clone a Vault Item
You can clone any Vault item that you have **Ownership** of, if you wish to create a duplicate of the item.
- In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select **Clone** from the hover-over {% icon fa-cog %} **Gear** dropdown.
- On Mobile Applications, open the item and tap **Clone** in the {% icon fa-ellipsis-v %} **Menu**.
- On Desktop Applications and Browser Extensions, open the item and select the {% icon fa-copy %} **Clone Item** option.
{% callout info %}
To clone an item within an Organization, you must clone it from the Organization Vault view, not the Personal Vault view.
{% endcallout %}

View File

@@ -0,0 +1,65 @@
---
layout: article
title: Your Master Password
categories: [account-management]
featured: true
popular: false
tags: [master password, account]
order: 01
redirect_from:
- /article/change-your-master-password/
---
## About Your Master Password
Your Master Password is the primary method for accessing your Vault. It's critically important that your Master Password is:
- **Memorable**: Bitwarden is a Zero Knowledge/Zero Trust solution. This means that the team at Bitwarden, as well as Bitwarden systems themselves, have no knowledge of, way to retrieve, or way to reset your Master Password. **Don't forget your Master Password!** Bitwarden won't be able to reset it or recover your Vault data if you do.
For our technically-inclined users, see the article on [Encryption]({% link _articles/security/what-encryption-is-used.md %}) to find out how we accomplish Zero Trust.
- **Strong**: The longer, more complex, and less common your Master Password is, the safer your Vault data will be. Using something like `password` for your Master Password could let a capable attacker crack your Vault in **less than a second**!
Use Bitwarden's free [**Password Strength Testing Tool**](https://bitwarden.com/password-strength){:target="\_blank"} to test the strength of some Master Passwords you'd consider using.
For our technically-inclined users, learn about the tool we use to calculate password strength, called [zxcvbn](https://dropbox.tech/security/zxcvbn-realistic-password-strength-estimation){:target="\_blank"}.
{% callout success %}
If you're worried about forgetting your Master Password, the team at Bitwarden has a few recommendations for you:
1. **Setup a Master Password Hint**. Once setup, a Master Password Hint can be requested on the Login Screen. The hint will be emailed to you, not displayed on the web page, so as long as your inbox isn't compromised you won't have to worry about prying eyes (that said, we don't recommend using a hint that would give away your Master Password to anyone other than yourself).
2. **Designate a [Trusted Emergency Contact]({% link _articles/security/emergency-access.md %})**. If you have a Premium subscription, you can proactively configure your Vault to grant access in the case of emergency to another Bitwarden user.
{% endcallout %}
## Changing Your Master Password
You can change your Master Password at any time from the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, **provided you know you current Master Password** (if you don't, see [I Forgot My Master Password](#i-forgot-my-master-password)).
1. Log in to your [Web Vault](https://vault.bitwarden.com){:target="\_blank"}.
2. Select the **Settings** tab from the top navigation.
3. On the **My Account** page, scroll down and locate the **Change Master Password** section.
4. Enter your **Current Master Password**.
5. Enter and Confirm your **New Master Password**.
6. Select the **Change Master Password** button.
Completing these steps will log you out of your current session, requiring you to log back in with you new Master Password. Currently logged-in client applications (Mobile Apps, Browser Extensions, etc.) may remain active for up to an hour, however they will eventually also require you to log back in with your new Master Password.
{% callout warning %}
Opting to **rotate account's encryption key** is a potentially dangerous operation. Read the article on [Account Encryption Keys]({% link _articles/account/account-encryption-key.md %}) before doing so to fully understand the ramifications and required follow-up procedures.
{% endcallout %}
## I Forgot My Master Password
As described in the [About Your Master Password](#about-your-master-password) section, Bitwarden has no knowledge of, way to retrieve, or way to reset your Master Password. If you've already lost your Master Password, there is unfortunately no way for the team to recover the account or the data therein. You will need to delete your account and start a new one.
{% callout success %}
If you're using any Bitwarden client applications (Mobile Apps, Browser Extensions, etc.) you should check whether any of these sessions are still logged in prior to deleting your account. If a client application is still logged in, [Export Vault Data]({% link _articles/account/export-your-data.md %}) to a file for import into a new account.
{% endcallout %}
Complete the following steps to delete your account:
1. Navigate to [vault.bitwarden.com/#/recover-delete](https://vault.bitwarden.com/#/recover-delete).
2. Enter the **Email Address** associated with your account.
3. In your email inbox, open the email and verify that you want to delete this Bitwarden account.
Once deleted, you're free to create a new Bitwarden account with that email address. If you delete a Bitwarden account that has a Premium subscription associated with it, [Contact Us](https://bitwarden.com/contact/){:target="\_blank"} and we'll reapply your existing subscription to the new account.

View File

@@ -1,19 +0,0 @@
---
layout: article
title: Updating an old encryption key
categories: [account-management]
featured: false
popular: false
tags: [encryption key, account]
---
You may find a notice in your account regarding the need to update your encryption key. Rest assured that this does **NOT** mean that your account has been compromised or is in danger or being compromised. This notice appears on accounts that registered when Bitwarden was using an older encryption scheme.
Bitwarden has moved to a new encryption key implementation that requires a new key to be generated. This new encryption key allows the use of new features in Bitwarden. Normally we are able to handle these type of updates automatically, however, since Bitwarden has no knowledge of your encryption key you must initiate this update yourself.
Updating your encryption key is simple:
1. Log into the web vault at <https://vault.bitwarden.com>
2. If your encryption key needs to be updated you will find a notice at the top of the page that states so. Click this notification.
3. A page will pop up that explains why you need to update your encryption key. Enter your master password to verify and your encryption key will be updated. Additionally, all of your data will be re-encrypted with this new key.
4. **VERY IMPORTANT:** Log out of and back in to ALL Bitwarden applications that you are using. This will download your new encryption key. Failure to complete this last step may result in data corruption in your vault since you would not be using the correct key.

View File

@@ -5,6 +5,7 @@ categories: [account-management]
featured: false
popular: false
tags: [account, vault, timeout, 2FA, two-step]
order: 13
---
Vault Timeout behavior will determine how your Vault will behave after a customizable period of inactivity. Timeout is configured individually from and for each Bitwarden client application that you use (Mobile, Web, Desktop, Browser Extension, etc.).

View File

@@ -63,6 +63,10 @@ Options include:
For example:
{% callout warning %}
Contrary to the following example, it's generally not recommended to enter your password inline, as this will save it to the history of the shell. Leaving the password out of the initial command will cause Bitwarden to prompt for it, which will not save it.
{% endcallout %}
```
bwdc login bwuser@gmail.com mystrongpassword --method 0 --code 204678
```

View File

@@ -1,12 +1,12 @@
---
layout: article
title: Billing FAQs
categories: [faqs, plans-and-pricing]
categories: [plans-and-pricing]
featured: true
popular: false
hidden: false
tags: []
order: 07
order: 09
---
This article contains Frequently Asked Questions (FAQs) regarding **Plans and Pricing**.

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Hosting FAQs
categories: [faqs, hosting]
categories: [hosting]
featured: true
popular: true
hidden: false

View File

@@ -0,0 +1,44 @@
---
layout: article
title: Import &amp; Export FAQs
categories: [import-export]
featured: true
popular: false
hidden: false
tags: []
order: 09
---
This article contains Frequently Asked Questions (FAQs) regarding **Import &amp; Export**.
#### Q: How do I import my data if I dont see my service on the import options list?
**A:** If we don't have official support for the service you are using, manually condition a `.csv` or `.json` for import into Bitwarden. For more information about how to do this, see [Condition a Bitwarden .csv or .json]({% link _articles/importing/condition-bitwarden-import.md %}).
#### Q: Can I import to Bitwarden from iCloud/Mac Keychain?
**A:** Currently, Apple does not provide an official way to export data from iCloud, Mac Keychain, or Safari.
Here are some third-party programs available to export this data:
- <https://gist.github.com/rmondello/b933231b1fcc83a7db0b>
- <https://github.com/lifepillar/CSVKeychain>
{% callout warning %}
**Disclaimer**: These 3rd party scripts/programs are unsupported by Bitwarden or Apple, and should be used at your own risk.
{% endcallout %}
Once exported from iCloud, Mac Keychain, or Safari, see [Import Data to your Vault]({% link _articles/importing/import-data.md %}).
#### Q: How do I import items directly to Collections?
**A:** To import items directly to Collections, format your import as a Bitwarden `.csv` (for more information, see [Condition a Bitwarden .csv or .json]({% link _articles/importing/condition-bitwarden-import.md %})) and specify Collections to import each item to within the file.
#### Q: Why did importing create duplicate Vault items?
**A:** Every import operation creates every new record as an item in your Vault, regardless of whether matching Vault items already exist in your Vault. Prior to import, we recommend either:
- Editing your import file to only include net-new Vault Items.
- Purging your Vault before an import operation.
Personal Vaults can be purged from the **Settings** &rarr; **My Account** page. Organization Vaults can be purged from the **Organization Settings** &rarr; **My Organization** page.

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Organizations FAQs
categories: [organizations, faqs]
categories: [organizations]
featured: true
popular: false
tags: []
@@ -51,6 +51,10 @@ Paid Organizations (Families, Teams, or Enterprise) automatically include premiu
Alternatively, you can unshare items by moving them to a different Collection with higher Access Control restrictions.
#### Q: How do I hide a password from my Organization's users?
**A:** Use the **Hide Passwords** option in the **Access Control** section when adding new users or editing existing ones in order to hide a given Collection's passwords and hidden fields from them. For more information, see [Access Control](https://bitwarden.com/help/article/user-types-access-control/#access-control).
#### Q: Does an item I share with the Organization stay after I leave?
**A:** It does! When a user shares an item with an Organization, the Organization takes ownership of the item. Even if the user leaves the Organization or deletes their account, that item will remain in the Organization Vault.

View File

@@ -1,13 +1,78 @@
---
layout: article
title: Feature FAQs
categories: [faqs, features]
title: General FAQs
categories: [account-management]
featured: true
popular: true
hidden: false
tags: []
order: 15
redirect_from:
- /article/change-your-email/
---
This article contains Frequently Asked Questions (FAQs) about general Vault Management and Bitwarden functionality.
## Most Asked Questions
#### Q: What do I do if I forgot my Master Password?
**A:** As a Zero Trust solution, Bitwarden and its systems have no knowledge of, way to retrieve, or way to reset your Master Password. If you've already lost your Master Password, there is unfortunately no way for the team to recover the account. For help understanding what to do next, or what to do proactively to protect yourself from such a scenario, refer to the article on [Your Master Password]({% link _articles/account/master-password.md %}).
#### Q: Is there a way for someone to access my Vault items in case of emergency?
**A:** There is! Users with a Premium subscription can proactively setup trusted emergency contacts who can access your Vault in case of emergency. For more information, see [Emergency Access]({% link _articles/security/emergency-access.md %}).
#### Q: How do I change my email address?
**A:** You can change the email address attached to your account from the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}:
1. In the Web Vault, select **Settings** from the top navigation bar.
2. On the **My Account** page, find the **Change Email** section.
3. Enter your current **Master Password** to prove you have the authority to take this action, and specify the **New Email** you'd like to change to.
4. Select the **Change Email** button.
Bitwarden will email a verification code to the specified email address. Check your inbox for the code and enter it into the **Code** text input displayed in your Web Vault to finalize the change.
{% callout success %}If you don't receive the verification code from Bitwarden, check your Spam folder. You can also whitelist `no-reply@bitwarden.com` to help ensure delivery in the future.{% endcallout %}
When you change your email address, you should immediately logout of all Bitwarden client applications you use, and log back in with the new credentials. Sessions using a "stale" email address will eventually be logged out eventually.
#### Q: Why is a Vault item missing from my Mobile App, Desktop App, or Browser Extension?
**A:** Typically, this is because client application's Vault data has fallen behind a Web Vault or other client application's. Performing a Vault Sync should bring everything up to date. For more information, see [Sync Your Vault]({% link _articles/miscellaneous/vault-sync.md %}).
#### Q: What's the safest way to make a backup of my Vault data?
**A:** You can use [Encrypted Exports]({% link _articles/importing/encrypted-export.md %}) to make secure long-term backups of your Vault data that are encrypted with your [Account Encryption Key]({% link _articles/account/account-encryption-key.md %}).
Alternatively, we you can use something like PeaZip to create an encrypted archive of the file after exporting a plaintext file from Bitwarden.
You can learn more about PeaZip here:
- <http://www.peazip.org/>
- <https://github.com/giorgiotani/PeaZip >
{% callout warning %}
**Disclaimer**: PeaZip is a third-party program and is not supported by Bitwarden. These links were shared with you as an alternative for use at your own risk.
{% endcallout %}
#### Q: Can I set Bitwarden to automatically start when my computer starts?
**A:** You can set the Bitwarden Desktop App to automatically open on startup
1. Select the Start (Windows Logo) button, select All apps, and scroll to find the Bitwarden Desktop app/shortcut.
2. Right-click the Bitwarden Desktop app, select More, and then select Open file location.
3. With the file location open, press the Windows logo key + R, type shell:startup, then select OK. This opens the Startup folder.
4. Copy and paste the shortcut to the Bitwarden Desktop app from the file location to the Startup folder.
#### Q: Why am I getting a New Device email?
**A:** Typically this occurs for users that have a setting on their browser which clears their local storage and/or cookies whenever they close the browser or while they are using the browser. There are extensions that perform these actions. If this happens, you lose the indicator which tells our servers that it is an existing device. New device notification messages are not contingent on the IP address, only the device itself. We use local storage in the browser or client to label the device with an id. If that id has never logged in before then you will get an email. If a user clears this local storage, a new id is generated for that device and it will get a new email.
You may need to make an exception for Bitwarden or configure your whitelist to keep the cookie or local storage from being cleared for Bitwarden. This could also happen if you have your browser set to never remember history.
## Other Questions
### Q: How do I change a collection via the CLI?
**A:** In order to change a Collection, you will use a dedicated command (bw edit item-collections).
@@ -30,46 +95,6 @@ When configured, you should see "Enabled" in green text. Double-check under the
One last thing you will want to check is the battery optimization settings on your phone and make sure it is turned off for Bitwarden. Often, Android Battery Optimization will turn off services to save battery and in turn kill the auto-fill services.
### Q: How do I view attachments?
**A:** If you are using the mobile app then you will select an item to view it and then select the "3 dots" menu at the top right of the app window to download and view the attachment.
**A:** Here you can see the ways to attach a file in all other clients: <https://help.bitwarden.com/article/attachments/>
### Q: Can Bitwarden restore my individual vault?
Bitwarden is unable to restore user vaults. We recommend everyone make regular backups (via export) of their vault data. You can learn more about backing up your vault here:
<https://bitwarden.com/help/article/export-your-data/>
### Q: How do I backup my self-hosted server?
**A:** Please see this helpful article regarding backup procedures for your self-hosted server: <https://help.bitwarden.com/article/backup-on-premise/>
### Q: How do I configure custom fields?
**A:** Here is an example of how to configure a Custom Field:
1. Right-click the field you want to fill and select "Inspect". The HTML element will appear highlighted in a console window.
2. Find the element id. You are looking for what comes after id=" ". Copy what is in between the " ". It needs to be exactly the same.
3. Open the website, login into your vault, and edit it.
4. Select "Hidden" and then press the blue "+" icon
5. In the "Name" field paste the element ID
6. In the "Value" field enter your info you want auto-filled.
7. Save.
Now when you auto-fill, the additional field should be there. Please see this help article for more information: <https://help.bitwarden.com/article/custom-fields/>
### Q: How do I import my data if I dont see my service on the import options?
**A:** If we do not have support for the service you are using, then you will have the option of creating a generic CSV to fit our format. We have detailed info on this format and a template file you can use located here, <https://help.bitwarden.com/article/import-data/#generic-csv-format-individual-account>.
You can also generate a dummy JSON export file from Bitwarden to use as a template if you prefer working with JSON.
### Q: How do I delete an item?
**A:** In order to delete an item, you will first need to edit the item and then go to the bottom of the edit page. You can then select Delete. Once deleted, the item will be in the trash. In order to permanently delete, you will need to remove it from the trash.
To learn more about managing items, check out this article: <https://bitwarden.com/help/article/managing-items/>
### Q: Can I use Directory connector to sign into Bitwarden?
**A:** The Directory Connector tool provides the functions to automatically provision and deprovision users, groups, and group associations from your user directory (LDAP, Active Directory, G Suite, Azure AD, or Okta).
@@ -95,9 +120,6 @@ To use an existing identity provider for authentication, youll need to subscr
3. Locate Auto-fill
4. Tap on Auto-fill with Google and turn it off.
### Q: Does Bitwarden have a way for me to let someone into my account if I am unable to log in?
**A:** You can use the Emergency Access feature to establish trusted contacts who may access your Vault in case of emergency. For more information, see [Emergency Access]({% link _articles/security/emergency-access.md%}).
### Q: How can I enable Auto-fill On Page Load?
@@ -105,41 +127,12 @@ To use an existing identity provider for authentication, youll need to subscr
If you do not want to enable autofill when a page loads and still want the ability to autofill easily and quickly then you may want to try using the keyboard shortcuts or one of the other autofill methods shown here: <https://help.bitwarden.com/article/auto-fill-browser/>
### Q: Does Bitwarden have an Encrypted Export File?
**A:** Yes! For more information, see [Encrypted Exports]({% link _articles/importing/encrypted-export.md %}).
Alternatively, we recommend using something like PeaZip to create an encrypted archive of the file after exporting a plaintext file from Bitwarden.
You can learn more about PeaZip here:
- <http://www.peazip.org/>
- <https://github.com/giorgiotani/PeaZip >
{% callout warning %}
Disclaimer: Please note that PeaZip is a third party program and is not supported by Bitwarden. These links were shared with you as an option for you to use at your own risk.
{% endcallout %}
### Q: Can I download Bitwarden on F-Droid? I cannot find it.
**A:** Yes, by adding our official private repo which removes all non-approved libraries: <https://mobileapp.bitwarden.com/fdroid/>
Unfortunately, F-Droid can not compile our app from source as it is based on Xamarin and it is not supported by F-Droid's current compiler methods, so we must use a separate repo.
### Q: How do I rename a folder?
**A:** From your Web Vault, in the left-hand column labeled "Filters", find the folder you would like to change and select it. Once the folder is open you will see a "Pencil" icon next to the name that you just selected. Click that icon and a pop-up will appear allowing you to edit the name.
### Q: I have forgotten my master password, what can I do?
**A:** Please see our article here:
<https://bitwarden.com/help/article/forgot-master-password/>
### Q: How do I hide passwords from users?
**A:** You can enable the hiding of passwords by enabling “hide passwords” on the collection assignment page.
You can learn more about access control here: <https://bitwarden.com/help/article/user-types-access-control>
### Q: How can I see the history of a password that has been changed?
The ability to view the password history of a Login Item is available. You can open the item in question and select the "1" next to Password History near the bottom of the window.
@@ -152,20 +145,6 @@ Clicking on the number will expose the historical password values in plain text
**A:** You can view the history of the Password Generator but please note that is a separate history per app/client. This information is not synchronized between devices.
### Q: Can I export/import from iCloud/Mac Keychain?
**A:** There isn't an official way to export the data from iCloud, Mac Keychain or Safari as Apple doesn't provide this ability.
Here are some third-party programs available to export this data:
- <https://gist.github.com/rmondello/b933231b1fcc83a7db0b>
- <https://github.com/lifepillar/CSVKeychain>
{% callout warning %}
Please note that these 3rd party scripts/programs are unsupported by Bitwarden and Apple and are used at your own risk.
{% endcallout %}
Once you have exported your data, here is a helpful article for importing your data from the two mentioned programs: <https://help.bitwarden.com/article/import-data/>
### Q: How do I enable iOS AutoFill?
**A:** Make sure Bitwarden is set to your AutoFill app by going to your iOS Settings > Passwords & Accounts > AutoFill Passwords > Bitwarden.
@@ -174,39 +153,12 @@ While testing Bitwarden, it is best to only have Bitwarden enabled to avoid any
You can see more about Bitwarden for iOS here: <https://bitwarden.com/help/article/getting-started-ios/>
### Q: Why am I getting a New Device Email Message?
**A:** Typically this occurs for users that have a setting on their browser which clears their local storage and/or cookies whenever they close the browser or while they are using the browser. There are extensions that perform these actions. If this happens, you lose the indicator which tells our servers that it is an existing device. New device notification messages are not contingent on the IP address, only the device itself. We use local storage in the browser or client to label the device with an id. If that id has never logged in before then you will get an email. If a user clears this local storage, a new id is generated for that device and it will get a new email.
You may need to make an exception for Bitwarden or configure your whitelist to keep the cookie or local storage from being cleared for Bitwarden. This could also happen if you have your browser set to never remember history.
### Q: Can I use SMS 2FA?
**A:** We do not support SMS 2FA due to vulnerabilities including SIM hijacking. We also do not recommend SMS 2FA for other accounts unless it is the only available method, as any second factor is recommended over having none.
**Q Do I need premium and families?**
**A:** The legacy Families plan only provided one user premium features, and the other 4 users would need to upgrade to premium individually, or the family organization owner could upgrade them all.
Currently, the Families plan introduced in September 2020, supports premium features for up to 6 users.
### Q: How do I install the Safari Extension?
**A:** The new Safari extension is now packaged with the Bitwarden Desktop App. You can download the latest app here: https://vault.bitwarden.com/download/?app=desktop&platform=macos. You can also use the App Store version.
Be sure to run the application once. If the extension still does not appear, it may just need to be enabled. In Safari, check under Preferences > Extensions
### Q: How can I start Bitwarden when Windows starts?
In order to set Bitwarden Desktop to startup, please follow these steps:
1. Select the Start (Windows Logo) button, select All apps, and scroll to find the Bitwarden Desktop app/shortcut.
2. Right-click the Bitwarden Desktop app, select More, and then select Open file location.
3. With the file location open, press the Windows logo key + R, type shell:startup, then select OK. This opens the Startup folder.
4. Copy and paste the shortcut to the Bitwarden Desktop app from the file location to the Startup folder.
### Q: How do I perform a sync on my application?
**A:** You can find more on vault syncing here: <https://bitwarden.com/help/article/vault-sync/>.
### Q: What is TOTP and how can I use it?
@@ -226,10 +178,6 @@ Whenever you auto-fill a website that has TOTP attached, the code will automatic
**A:** TOTP codes are ***time based*** and use device time for generation. A device with the wrong time will generate incorrect codes. Please check your device's system time and try your TOTP code again.
### Q: Why is U2F Not Supported on my iOS or Android App?
**A:** At this time, due to platform/OS limitations, FIDO U2F cannot be used with all Bitwarden applications. You should enable another two-step login provider so that you can access your account when FIDO U2F cannot be used. We are expanding our U2F capabilities
### Q: How do I use the web browser extension?
**A:** Using the Bitwarden Web Browser Extension is a good way to add your passwords to your vault. Anytime it detects a password field on a website that it doesn't have in its database, it will ask to save.
@@ -248,21 +196,6 @@ More helpful videos from the Bitwarden Community on YouTube:
- <https://youtu.be/TREdS8iq6Qg>
- <https://youtu.be/uF6tzGYaIxg>
### Q: How do I add attachments?
**A:** Support for attachments require:
- A premium individual membership
- An organization that offers attachments in the organization vault
- Being a member of an enterprise organization that gives premium features to its users
If you have a personal premium membership or are a member of an enterprise organization and receive premium features, you can add attachments by:
1. Create the item in which you wish to save the attachment
2. Once the item is saved, click the "Tools" or "Gear" icon, for the vault item, then select "Attachments" from the drop down list, to select the file, and then click save. To access the attachments later, choose the same icon, and attachments, where the files will be listed.
If you are a member of an organization that offers attachments, youll need to create the item *within the organization vault* - and then proceed to edit the item and add the attachment. Please note that personal items within this configuration will not support attachments.
### Q: I am asked for my master password even though I have PIN unlock enabled on iOS / Android
**A:** When you enable PIN unlock, you are prompted if youd like to use your Master Password after an application restarted (closed). If you select yes, if the app is closed or backgrounded, you will be prompted for your Master Password instead of the PIN.
@@ -271,11 +204,3 @@ To reset this:
- Disable PIN Unlock
- Enable PIN Unlock
- Select No when prompted about using the Master Password after application restart.
### Q: How can I import items directly to collections?
**A:** To import items directly to collections, you'll want to format your import into a Bitwarden CSV and provide the collection names you'd like to import to. You can read more about the Bitwarden CSV import here: https://bitwarden.com/help/article/import-data/#generic-csv-format-organization-account
{% callout info %}
Each import will create new records. To prevent duplicates while organizing your data, you will want to use the `Purge Vault` option to clear any existing data before importing it again. The option can be found by logging into the Web Vault (https://vault.bitwarden.com/) and going to Settings > Organizations > {YOUR ORG NAME} > Settings sub-tab (Gears Icon) > My Organization > Danger Zone > Purge Vault.
{% endcallout %}

View File

@@ -1,12 +1,12 @@
---
layout: article
title: Security FAQs
categories: [security, faqs]
categories: [security]
featured: false
popular: false
hidden: false
tags: []
order: 09
order: 11
redirect_from:
- /article/why-should-i-trust-bitwarden/
- /article/what-happens-if-bitwarden-is-hacked/

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Login with SSO FAQs
categories: [faqs, login-with-sso]
categories: [login-with-sso]
featured: true
popular: false
hidden: false

View File

@@ -0,0 +1,20 @@
---
layout: article
title: Two-step Login FAQs
categories: [two-step-login]
featured: true
popular: false
hidden: false
tags: []
order: 09
---
This article contains Frequently Asked Questions (FAQs) regarding **Two-step Login**.
#### Q: Can I use SMS 2FA?
**A:** Bitwarden does not support SMS 2FA due to vulnerabilities, including SIM hijacking. We do not recommend SMS 2FA for other accounts unless it is the only available method. Any second factor is recommended over having none, but most alternatives are safer than SMS 2FA.
#### Q: Is FIDO U2F supported on my iOS or Android App?
**A:** At this time, due to platform/OS limitations, FIDO U2F is **only supported for Web Vaults and Browser Extensions**, however we are currently investigating ways to implement this. In the meantime, we recommend enabling another [Two-step Login Method]({% link _articles/two-step-login/setup-two-step-login.md %}) for use with unsupported client applications.

View File

@@ -1,31 +1,72 @@
---
layout: article
title: Using file attachments
categories: [features]
title: File Attachments
categories: [account-management]
featured: false
popular: false
tags: [attachments, storage, files]
order: 12
---
{% callout info %}Using file attachments requires a premium membership or paid organization account.{% endcallout %}
Files can be attached to Vault items from any Bitwarden client application. An individual file attachment must be 100MB or smaller. By default, users have access to 1GB of encrypted storage for file attachments. Additional storage can be purchased in 1GB increments.
Attaching and managing files can be done from any Bitwarden client application. Any file 100MB or smaller can be attached to an item in your vault.
{% callout info %}
File Attachments are available for Premium users, including members of Paid Organizations (Families, Teams, or Enterprise).
{% endcallout %}
All **premium membership** and **paid organization** accounts include 1GB of encrypted file storage. Additional storage can be purchased in 1GB increments if needed.
## Attach a File
## Web Vault
Complete the following steps to attach a file to a Vault item:
Select the {% icon fa-cog %} options button next to the item in your vault and then select the **Attachments** option. You will then be presented with a list of all attached files for that item as well as options for uploading new attachments.
### From the Web Vault
## Other Applications
1. Hover-over the item you'd like to attach a file to, and select the {% icon fa-cog %} **Gear** icon.
2. Select **Attachments** from the dropdown.
3. In the Attachments dialog box, **Browse...** for your file.
4. Select the **Save** button to finish attaching a file.
After viewing an item in your vault you will see existing attachments listed at the bottom of the page. To upload a new attachment, or to delete existing attachments, edit the item and then select the **Attachments** option.
Once an item has files attached, selecting **Attachments** from the {% icon fa-cog %} **Gear** dropdown will also display a list of files attached to that Vault item.
## Fixing "Old" Attachments
### From Browser Extensions and Desktop Apps
Prior to December 2018 file attachments used a different method of encrypting their data. We have since moved to a newer, better way of encrypting file attachments. Any attachments that use the older encryption method will be labeled with an {% icon fa-exclamation-triangle %} alert icon in your vault listing. You should upgrade these old attachments to the newer method of encryption so that other account-related features can function properly.
1. Open the item you'd like to attach a file to, and select the **Edit** button.
2. Select **Attachments**.
3. On the Attachments page/dialog, **Browse...** for your file.
4. Select the **Save** button to finish attaching a file.
1. Open the page for editing your attachments (see above).
Once an item has files attached, selecting **Attachments** from the **Edit** menu will also display a list of files attached to that Vault item.
### From Mobile Apps
1. Open the item you'd like to attach a file to, and select the {% icon fa-ellipsis-v%} **Menu** button.
2. Select **Attachments**.
3. On the Attachments page, select the **Choose File** button and browse for your file.
4. Select the **Save** button to finish attaching a file.
Once an item has files attached, selecting **Attachments** from the {% icon fa-ellipsis-v%} **Menu** will also display a list of files attached to that Vault item.
## View an Attachment
Viewing an attachment mimics the same procedure used to attach a file. Refer to one of the above sections for help.
## Add Storage Space
By default, users with a Premium subscription have access to 1GB of encrypted storage for file attachments. Additional storage can be purchased in 1GB increments. Complete the following steps to purchase additional storage:
1. In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select the **Settings** tab.
2. From the **Settings** menu, select **Premium Membership**.
3. In the Storage section, select the **Add Storage** button.
4. Using the counter, choose the number of **GB of Storage to Add** and select **Submit**.
Adding storage will result in adjustments to your billing totals and immediately charge your payment method on file. The first change will be prorated for the remainder of the current billing cycle.
{% callout info %}
**A note about attachments created prior to December, 2018:**
Prior to December 2018, File Attachments used a different method of encrypting their data. We have since moved to a newer, better way of encrypting File Attachments. Any attachments that use the older encryption method will be labeled with an {% icon fa-exclamation-triangle %} alert icon in your vault listing. You should upgrade these old attachments to the newer method of encryption so that other account-related features can function properly:
1. Open the page for editing your attachments (see above instructions).
2. Click the **Fix** button next to the old attachment. This process will download the attachment, re-encrypt it using the new encryption method, re-upload the attachment back to your vault, and delete the old version of the attachment.
Once an attachment has successfully been upgraded, the {% icon fa-exclamation-triangle %} alert icon and fix button should disappear.
{% endcallout %}

View File

@@ -1,10 +1,11 @@
---
layout: article
title: Bitwarden Authenticator (TOTP)
categories: [features]
categories: [account-management]
featured: true
popular: false
tags: [autofill, auto-fill, totp, 2fa, two-step login, two factor authentication, authenticator]
order: 11
---
The Bitwarden Authenticator is an alternative solution to dedicated authentication apps like Authy, which you can use to verify your identity for websites and apps that use Two-step Login. The Bitwarden Authenticator generates 6-digit [Time-based One-time Passwords](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) (TOTPs) using SHA-1 and rotates them every 30 seconds.

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Auto-fill logins on Android
categories: [features]
categories: [miscellaneous]
featured: false
popular: false
tags: [android, autofill, auto-fill]
@@ -31,7 +31,7 @@ The Autofill Service is context-sensitive and will appear whenever you encounter
### Inline Autofill
When enabled on an Android 11 or greater device with a supported keyboard, Inline Autofill changes the autofill presentation from a pop-up to a list embedded within the keyboard.
When enabled on an Android 11 or greater device with a supported keyboard, Inline Autofill changes the autofill presentation from a pop-up to a list embedded within the keyboard.
1. Open the Bitwarden Android app.
2. Tap the **{% icon fa-cog %} Settings** page.
@@ -119,4 +119,3 @@ Android has many web browsers. It can be hard to keep up with them all. We have
If auto-fill does not work on your browser, please report it at <https://github.com/bitwarden/mobile/issues> so that we can add support.
{% endcallout %}

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Auto-fill logins using the browser extension
categories: [features]
categories: [miscellaneous]
featured: false
popular: false
tags: [browser, auto-fill, autofill]

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Autofill Identities and Cards
categories: [features]
categories: [miscellaneous]
featured: true
popular: false
tags: [browser, autofill, auto-fill, identity, card, form fill]

View File

@@ -1,7 +1,7 @@
---
layout: article
title: Auto-fill logins on iOS
categories: [features]
categories: [miscellaneous]
featured: true
popular: false
tags: [iOS, Auto-fill, autofill]

View File

@@ -1,60 +1,69 @@
---
layout: article
title: Using custom fields
categories: [features]
title: Custom Fields
categories: [account-management]
featured: false
popular: false
tags: [fields, autofill, custom fields]
order: 08
---
Custom fields allow you to store additional, well structured data fields within your vault entries. These fields could be security questions, PINs, or anything else. Custom fields have a name, a value, and a type (text, hidden, and boolean).
Custom fields, available for any [Vault item type]({% link _articles/account/managing-items.md %}), allow you to store additional well-structured data fields for a Vault item. Custom fields are saved as `Name:Value` pairs, and can be one of three types:
## Using Custom Fields to Auto-fill
- **Text**: Field value stores a freeform input (text, numbers, etc.)
- **Hidden**: Field value stores freeform input that is hidden from view (particularly useful for Organizations using the [Hide Password access control](https://bitwarden.com/help/article/user-types-access-control/#granular-access-control)).
- **Boolean**: Field value stores a boolean value (true/false).
Custom field names are an important identifier. Depending on the name you give your custom field, Bitwarden will attempt to auto-fill the custom field's value for you. If you intend to auto-fill custom fields you should name your field based on an identifier from the webpage form. These names are searched for using the following criteria:
## Auto-fill Custom Fields
- HTML form element's **id** attribute
- then the HTML form element's **name** attribute
- then the HTML form element's corresponding **label** value
- then the HTML form element's **aria-label** attribute
- then the HTML form element's **placeholder** attribute
The **Name** specified for a custom field is critical to successfully setting up auto-fill for custom fields. When naming the custom field, you should use one of the following HTML form element attributes/values:
If one of these matches is found, Bitwarden will auto-fill the custom field's value for you.
1. HTML form element's `id` attribute.
2. HTML form element's `name` attribute.
3. HTML form element's corresponding `label` value.
4. HTML form element's `aria-label` attribute.
5. HTML form element's `placeholder` attribute.
### Here is an example of how to configure a Custom Field using the id attribute:
Bitwarden will search the matched-URI webpage for those HTML form element attributes/values **in the above priority-order**. If a custom field's name matches one of those attributes/values, auto-fill will be available into that HTML form element.
1. Right-click the field you want to fill and select "Inspect". The HTML element will appear highlighted in the console window.
2. Find the element id. You are looking for what comes after id=" ". Copy what is in between the " ".
<img width="80%" src="../../images/features/custom-fields/custom_field.gif">
3. Open the website, login in to your vault and edit it.
4. Select the corresponding type (text, hidden or boolean) and then press the blue "+" icon.
<img width="60%" src="../../images/features/custom-fields/types.png">
5. In the "Name" field paste the element ID.
6. In the "Value" field enter your info you want auto-filled.
7. Save the entry.
### Name to Attribute Matching
## Special name prefixes for auto-filling
Field Name to attribute/value matches is **exact** and **case-insensitive** comparison. For example, if your custom field has the name `PIN`:
When Bitwarden searches a webpage's form elements to match with your custom field's name, an exact, case-insensitive comparison is done. For example, if your custom field has the name "PIN", the following form element's values (from the id, name, label, etc) will match for auto-filling: "pin", "PIN", and "Pin". However, values such as "pin2" or "mypin" will not match.
- **Auto-fill offered** for `pin`, `PiN`, `PIN`, etc.
- **Auto-fill not offered** for `pin2` or `mypin`
There are two special name prefixes that can give you even more control over how your custom field is auto-filled:
### Field Name Prefixing
**CSV**
There are two cases in which you can exercise more control over [name to attribute mapping](#name-to-attribute-mapping) by using prefixes.
Prefixing your custom field's name with `csv=` allows you to specify multiple names to search for and compare when an auto-fill is performed.
#### csv
Example:
Prefixing your custom field's name with `csv=` allows you to specify multiple names to search for and compare to when auto-fill is performed. For example:
`csv=pin,pin2,mypin` will match all of the examples above.
`csv=pin,pin2,mypin` will offer auto-fill for all the above examples.
**Regular Expressions**
#### regex
Prefixing your custom field's name with `regex=` allows you to perform [regular expression](https://regexone.com/){:target="_blank"} comparisons when an auto-fill is performed.
Prefixing your custom field's name with `regex=` allows you to perform [regular expression comparisons](https://regexone.com/){:target="_blank"} when auto-fill is performed. For example:
Example:
`regex=pin` will offer auto-fill for all the above examples.
`regex=pin` will match all of the examples above.
`regex=^first.*name` will offer auto-fill for `firstName`, `First_name`, and `First Name`
Example:
### Example Auto-fill Configuration
`regex=^first.*name` will match "firstName", "First_name", and "First Name".
Follow this procedure to correctly configure a custom field for auto-fill. This example uses Google Chrome for its Developer Tools.
{% image /features/custom-fields/custom_field.gif %}
1. On the webpage that matches the Login item's URI, right-click the field you want to auto-fill to and select **Inspect**.
The HTML element will open and be highlighted in the Developer Console.
2. Find and copy the element `id` (find `id="xxx"`, where `xxx` is the element's `id` value).
3. In the relevant Vault item's **Custom Fields** section, choose the appropriate field type and select the {% icon fa-plus %} **New Custom Field** button:
{% image /features/custom-fields/types.png %}
4. Paste the copied element `id` in the **Name** field.
5. Specify the desired information to be auto-filled (in the above example, a PIN) in the **Value** field.
6. Save the Vault item.

View File

@@ -1,49 +1,45 @@
---
layout: article
title: Using favorites
categories: [features]
title: Favorites
categories: [account-management]
featured: true
popular: false
tags: [favorites, features, tutorial]
order: 07
---
Favorites allow you to quickly access your most used items. Any item can be designated as a Favorite.
Any item can be designated as a **Favorite** allow quick access to your most used items.
This includes items that have been shared with you from an Organization. Marking an Organization item as a Favorite will only pertain to your individual vault. It will not make the item a Favorite for all users of the Organization that it belongs to.
Even items shared from an Organization can be designated a Favorite, however this will only impact how they appear in your Personal Vault (i.e. you won't make that item a Favorite for other users with access to the Organization or Collection).
## Using Favorites
{% callout success %}
Items marked as a **Favorite** will appear at the top of your {% icon fa-lock %} **My Vault** view in Browser Extensions and Mobile Apps, and in the {% icon fa-star %} **Favorites** filter in your Web Vault and Desktop Apps.
{% endcallout %}
**Web Vault**
{% image /favorites/favorite_webvault.gif %}
## Designating Favorites
1. Select the item that you wish to make a Favorite and edit it.
2. On the bottom right corner, click on the **star** icon.
3. Save the item
The Web Vault will have a 'Favorites' filter you can select to see only these items.
Designate any Vault item as a **Favorite** when you initially create it, or at any time by editing the item:
**Desktop Application**
{% image /favorites/favorite_desktop.gif %}
### In the Web Vault
1. Select the item that you wish to make a Favorite and edit it.
2. Click on the checkbox next to Favorite.
3. Save the item
On the Add Item or Edit Item screen, select the {% icon fa-star %} **Star** icon in the bottom-right corner and **Save** the item:
The desktop application will have a 'Favorites' filter you can select to see only these items.
{% image /favorites/favorite_webvault_cropped.gif %}
**Browser Extension**
{% image /favorites/favorite_extension.gif %}
### In Browser Extensions
1. Go to My Vault
2. Select the item that you wish to make a Favorite and edit it.
3. Click on the checkbox next to Favorite.
4. Save the item.
On the Add Item or Edit Item screen, check the **Favorite** checkbox and **Save** the item:
The browser extension will list favorited items at the top of the 'My Vault' tab.
{% image /favorites/favorite_extension_cropped.gif %}
**Mobile Application**
### In Desktop Applications
1. Select the item that you wish to make a favourite and edit it.
2. Toggle **Favorite** under **Miscellaneous**.
3. Save the item.
On the Add Item or Edit Item screen, check the **Favorite** checkbox and **Save** the item:
The mobile application will list favorited items at the top of the 'My Vault' tab.
{% image /favorites/favorite_desktop_cropped.gif %}
### In Mobile Apps
On the Add Item or Edit Item screen, toggle the **Favorite** switch and **Save** the item:
{% image /favorites/favorite_mobile.gif %}

View File

@@ -1,28 +1,33 @@
---
layout: article
title: What is my account's fingerprint phrase?
categories: [features]
title: Account Fingerprint Phrase
categories: [security]
featured: false
popular: false
tags: [fingerprint]
order: 05
---
Every Bitwarden user account has a public "fingerprint phrase" associated with it. Your account's fingerprint phrase is permanent and composed of five random english words that appear in a specific order.
**Example of a fingerprint phrase**
Each Bitwarden account has a public "fingerprint phrase" associated with it. Your account's fingerprint phrase is permanent and composed of five random english words that appear in a specific order, for example:
```
alligator-transfer-laziness-macaroni-blue
```
The fingerprint phrase is an important security feature that assists in uniquely and securely identifying a Bitwarden user account when important encryption-related operations are performed (such as sharing). For example, when adding a new user to an organization you should ask the user to verify their fingerprint phrase via email, over the phone, in person, etc. By verifying the fingerprint phrase with the user outside of Bitwarden, you ensure that end-to-end encryption is securely initiated and that the Bitwarden server you are communicating with (and your connection) has not been maliciously tampered with. If you trust the server you are communicating with (and the connection that you are using), you can choose to ignore fingerprint phrase verification.
## What is my fingerprint phrase used for?
## Where do I find my fingerprint phrase?
Your fingerprint phrase is an important security feature that assists in uniquely and securely identifying a Bitwarden user account when important encryption-related operations are performed (such as sharing).
You can find your account's fingerprint phrase using Bitwarden applications in the following locations:
Some Bitwarden procedures (e.g. adding a new user to an Organization, enabling Biometric Unlock for Browser Extensions) may ask you to verify that the fingerprint phrase matches your own or another user's.
- Web vault: Settings &rarr; My Account
- Desktop apps: Account &rarr; Fingerprint Phrase
- Browser extensions: Settings &rarr; Account &rarr; Fingerprint Phrase
- Mobile: Settings &rarr; Account &rarr; Fingerprint Phrase
- CLI: `bw get fingerprint me`
Validating fingerprint phrases ensures that end-to-end encryption is securely initiated and that the Bitwarden server you are communicating with (and your connection) has not been maliciously tampered with.
## Where can I find my fingerprint phrase?
You can find your account's fingerprint phrase from any Bitwarden client application:
- **Web Vault**: Settings &rarr; My Account
- **Desktop Apps**: Account &rarr; Fingerprint Phrase
- **Browser Extensions**: Settings &rarr; Account &rarr; Fingerprint Phrase
- **Mobile Apps**: Settings &rarr; Account &rarr; Fingerprint Phrase
- **CLI**: Using the command `bw get fingerprint me`

View File

@@ -1,38 +1,48 @@
---
layout: article
title: Organizing your vault with folders
categories: [features]
title: Folders
categories: [account-management]
featured: false
popular: false
tags: [categories, folders, sub-folders]
order: 06
---
Folders are a great way to categorize items in your Bitwarden vault.
Folders are structures used to organize your Personal Vault by gathering together Logins, Cards, Identities, and Secure Notes. Using Folders is a great way to make all Vault items easy to find.
{% callout info %}
An Organization's collection are different than folders. Collections are a way to organize items and control user access within an organization's vault while folders are a way for individual users to organize items within their own personal vault. An individual user may wish to further organize the items being shared with them in their own vault into a personalized folder structure that makes sense just for them.
{% callout success %}
Items added to a Folder will still appear in your Vault when {% icon fa-th %} **All Items** is selected from the Filter menu, and deleting a Folder **will not** delete the items in that Folder.
{% endcallout %}
## Nested folders (sub-folders)
## Create a Folder
Nested folders work by using a naming convention with the forward slash character (`/`) as a delimiter. For example, if I have folders with the names "Work" and "Work/Email", "Email" will be nested as a sub-folder underneath the "Work" folder.
Folders can be created from the [Web Vault](https://vault.bitwarden.com){:target="\_blank"} or any Bitwarden client application.
- From the [Web Vault](https://vault.bitwarden.com){:target="\_blank"} or Desktop Application, select the {% icon fa-plus %} **Add** icon in your **Folders** list.
### Nested folders example
Once created, you can rename a folder at any time using the hover-over {% icon fa-pencil %} **Pencil** icon.
- From a Mobile App or Browser Extension, open the {% icon fa-cogs %} **Settings** menu, tap/select the **Folders** option, and tap/select the {% icon fa-plus %} **Add** icon.
In this example I have the following folders:
Once created, you can rename a folder at any time from the same menu by tapping/selecting an existing folder.
- From the CLI, use the command `bw create folder <foldername>`.
- Personal
- Personal/Email
- Personal/Email/Sub
- Social
- Work
- Work/Clients
- Work/Email
{% image /manage-items/folder-add-all.png Add a folder%}
This would produce a folder structure that looks like this in the web vault (and similarly in other Bitwarden applications):
{% callout info %}
If you're a member of an Organization, **Collections** will be shown below your Folders in the Filters menu.
{% image /manage-items/subfolders.png %}
There are similarities between Folders and Collections. **Folders are only for your Personal Vault and unique to you**, where Collections are shared between members of Organizations.
{% endcallout %}
There is no limit on the depth that you can go with nested folders, though the application interface may begin to "break" if you go too deep.
## Create Nested Folders
If a folder's name contains the forward slash delimiter, yet no "parent" folder exists, its name will be displayed in its entirety. In the example shown above, a folder named "Finance/Banking" would not produce a nested structure. You would need to create a "Finance" folder as well if nesting is desired.
Folders can be "nested" in order to logically organize them within your Vault. There's no limit to the depth with which you can nest Folders, but creating too many levels may interfere with your Vault's interface.
{% callout info %}
Searching inside a "parent" Folder will not include items in Folders nested inside it as potential search results. For more information, see [Search your Vault]({% link _articles/features/searching-vault.md %}).
{% endcallout %}
{% image /manage-items/subfolders.png Nested folders %}
To create a nested Folder, give a new Folder a **Name** that includes the "parent" Folder following by a forward slash (`/`) delimiter, for example `Personal/Email`.
If there is no Folder with the corresponding "parent" name, the Folder won't nest and its title will be displayed in-full.

View File

@@ -1,68 +1,95 @@
---
layout: article
title: Vault Health Reports
categories: [features]
categories: [account-management]
featured: false
popular: false
tags: [account, report, breach, reused, unsecured, weak]
order: 14
---
Bitwarden users with a premium membership can access a variety of reporting tools to evaluate the overall health of their personal Bitwarden vault following these steps:
1. Log in to the web vault at <https://vault.bitwarden.com>.
2. Click **Tools** in the top navigation bar.
3. Locate the **Reports** section.
4. Select the report needed.
Paid organization plans can also access these reports to analyze the items contained in the organizational vault:
1. Log in to the web vault at <https://vault.bitwarden.com>.
2. Click **Settings** in the top navigation bar.
3. Click **Organizations** in the top navigation bar.
4. Locate your Organization and click on it.
5. Click **Tools** in the Organizations navigation bar.
<img src="../../images/features/reports/tools-section.png">
6. Locate the **Reports** section.
7. Select the report needed.
### Available reports in the Bitwarden Vault
**Exposed Passwords Report**
These are passwords that have been uncovered in known data breaches that were released publicly or sold on the dark web.
The report uses a trusted web service to search the first 5 digits of the hash of all your passwords in a database of known leaked passwords. The returned matching list of hashes is then locally compared with the full hash of your passwords. That comparison is only done locally to preserve your [k-anonymity](https://en.wikipedia.org/wiki/K-anonymity){:target="_blank"}.
But why do we use only the first 5 digits of the hash of your passwords? If the report was performed with your actual passwords, it doesn't matter if those were exposed or not, you would be voluntarily leaking it to the service.
And even tough this reports result may not mean your individual account has been compromised, just that you are using a password that has been found in these databases of exposed passwords, you should avoid using leaked and non-unique passwords.
**Reused Passwords Report**
If a service that you use is compromised, reusing the same password elsewhere can allow hackers to easily gain access to more of your online accounts. You should use a unique password for every account or service. The Reused Passwords Report helps you easily identify these offending passwords.
**Weak Passwords Report**
Weak passwords can easily be guessed by hackers and automated tools that are used to crack passwords. Use the Weak Passwords Report to isolate these passwords quickly. The Bitwarden password generator can help you create stronger passwords.
**Unsecured Websites Report**
Using unsecured websites with the http:// scheme can be dangerous. If the website allows, you should always access it using the https:// scheme so that your connection is encrypted.
**Inactive 2FA Report**
Two-factor authentication (2FA) is an important security setting that helps secure your accounts. If the website offers it, you should always enable two-factor authentication. The Inactive 2FA Report locates items in your Bitwarden vault where you have not stored a TOTP authenticator key and then cross-references it with data from [https://twofactorauth.org/](https://twofactorauth.org/){:target="_blank"}.
**Data Breach Report (Individual Vaults Only)**
A “breach” is an incident where a sites data has been illegally accessed by hackers and then released publicly. The Data Breach Report allows you to review the types of data that were compromised in these breaches (email addresses, passwords, credit cards, etc.) and take appropriate action, such as changing passwords.
Vault Health Reports can be used to evaluate the security of your Bitwarden Personal or Organization Vault.
{% callout info %}
If you are self-hosting in order to run the **Data Breach** report in your instance, you will need to buy an HIBP subscription key that will authorize you to make calls to the API. You can find how to purchase this key [here](https://haveibeenpwned.com/API/Key){:target="_blank"}.
Vault Health Reports are available for Premium users, including members of Paid Organizations (Families, Teams, or Enterprise).
{% endcallout %}
Once you have the key you will need to go to your `./bwdata/env/golbal.override.env` file, edit it and REPLACE the placeholders values for the API key:
## View a Report
Complete the following steps to view any Vault Health Report for your **Personal Vault**:
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target-"\_blank"}.
2. Select **Tools** from the top navigation bar.
3. Select a report from the **Reports** section of the left menu.
Complete the following steps to view any Vault Health Reports for your **Organization Vault**:
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target-"\_blank"} and open your Organization.
2. In your Organization, open the **Tools** tab.
{% image /features/reports/tools-section.png Organization Reports %}
3. Select a reports from the **Reports** section of the left menu.
## Available Reports
### Exposed Passwords Report
The **Exposed Passwords Report** identifies passwords that have been uncovered in known data breaches that were released publicly or sold on the dark web by hackers.
This report uses a trusted web service to search the first 5 digits of the hash of all your passwords in a database of known leaked passwords. The returned matching list of hashes is then locally compared with the full hash of your passwords. That comparison is only done locally to preserve your [k-anonymity](https://en.wikipedia.org/wiki/K-anonymity){:target="_blank"}.
Once identified, you should create a new password for offending accounts or services.
{% callout success %}
**Why use the first 5 digits of password hashes?**
If the report was performed with your actual passwords, it doesn't matter if they were exposed or not, you would be voluntarily leaking it to the service. This reports result may not mean your individual account has been compromised, rather that you are using a password that has been found in these databases of exposed passwords, however you should avoid using leaked and non-unique passwords.
{% endcallout %}
### Reused Passwords Report
The **Reused Passwords Report** identifies non-unique passwords in your Vault. Reusing the same password for multiple services can allow hackers to easily gain access to more of your online accounts when one service is breached.
Once identified, you should create a unique password for offending accounts or services.
### Weak Passwords Report
The **Weak Passwords Report** identifies weak passwords that can easily be guessed by hackers and automated tools that are used to crack passwords. The Bitwarden Password Generator can help you create stronger passwords.
Once identified, you should use Bitwarden's Password Generator to create a strong password for offending accounts or services.
### Unsecured Websites Report
The **Unsecured Websites Report** identifies Login items that use unsecured (`http://`) schemes in URIs. It's much safer to use `https://` to encrypt communications with TLS/SSL. To learn more, see [URIs for Vault Items]({% link _articles/features/uri-match-detection.md %}).
Once identified, you should change offending URIs from `http://` to `https://`.
### Inactive 2FA Report
The **Inactive 2FA Report** identifies Login items where:
- Two-factor Authentication (2FA) via TOTP is available from the service
- You have not stored a TOTP Authenticator Key
Two-factor Authentication (2FA) is an important security step that helps secure your accounts. If any website offers it, you should always enable 2FA. Offending items are identified by cross-referencing URI-data with data from [https://twofactorauth.org/](https://twofactorauth.org/){:target="_blank"}.
Once identified, setup 2FA using the `Instructions` hyperlink for each offending item:
{% image /features/reports/inactive-2fa.png %}
### Data Breach Report (*Personal Vaults only*)
The **Data Breach Report** identifies compromised data (email addresses, passwords, credit cards, DoB, etc.) in known breaches, using a service called Have I Been Pwned (HIBP).
A “breach” is defined by HIBP as "an incident where data is inadvertantly exposed in a vulnerable system, usually due to insufficient access controls or security weaknesses in the software". For more information, refer to [HIBP's FAQs documentation](https://haveibeenpwned.com/FAQs){:target="\_blank"}.
{% callout info %}
If you are self-hosting Bitwarden, in order to run the **Data Breach Report** report in your instance you will need to buy an HIBP subscription key that will authorize you to make calls to the API, obtained [here](https://haveibeenpwned.com/API/Key){:target="_blank"}.
Once you have the key, open your `./bwdata/env/golbal.override.env` and REPLACE the placeholders value for `globalSettnigs_hibpApiKey=` with your purchased API key:
```
globalSettings__hibpApiKey=REPLACE
```
For more information, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %}).
{% endcallout %}

View File

@@ -1,71 +1,78 @@
---
layout: article
title: Searching the vault
categories: [features]
title: Search your Vault
categories: [account-management]
featured: false
popular: false
tags: [search, lunr]
order: 05
---
Bitwarden indexes your vault using a [full-text search](https://en.wikipedia.org/wiki/Full-text_search){:target="_blank"} programming library called [Lunr](https://lunrjs.com/){:target="_blank"}. Lunr provides the ability to invoke high-performance search queries against your vault to quickly find what you need with great accuracy.
Bitwarden Vaults can be easily searched to quickly surface relevant Vault items. [Basic search](#basic-search) queries can be made in any Bitwarden client application, and advanced [full-text search](#full-text-search) queries can be made in Web Vaults, Desktop Apps, and Browser Extensions.
## Applications that use full-text search
The potential results available to any search operation is dependent on what is currently opened through the Filter menu or Navigation, for example:
The following Bitwarden applications provide full-text searching capabilities and are applicable to the information this article:
- If {% icon fa-th %} **All Items** is selected, entered search queries will use all possible Vault items as potential results.
- If the **Login** Type is selected, entered search queries will use all Login items as potential results.
- If **My Folder** is selected, entered search queries will use all items in that Folder as potential results (not including items in a nested Folder).
- Web vault
- Desktop applications
- Browser extensions
The placeholder text in the search box will transform to indicate the current search location:
This article **does not** apply to the following Bitwarden applications, which provide only basic search capabilities:
{% image /manage-items/search.png Search a Folder%}
- CLI
- Mobile apps
## Basic Search
## Indexed Fields
Basic search is available in all Bitwarden client applications. Entering a basic search query (e.g. `Github` or `myusername`) will search for the entered string in the following Vault item fields:
The following fields from items in your vault are indexed and are searchable:
- Item Name
- For Login, Username
- For Login, URI
- For Card, Brand or last four digits
- For Identity, Name
- `shortid` - First 8 characters of the item's id.
- `organizationid` - Id of the item's organization (if it belongs to one).
- `name`
- `subtitle` - Login username, card brand + last four, and identity name.
- `notes`
- `fields` - Name and value. Only "text" type field values are included.
- `attachments` - File name
- `login.username`
- `login.uris` - Only the URI's [hostname](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHyperlinkElementUtils/hostname){:target="_blank"} value.
For your convenience, basic search automatically includes leading and trailing [wildcards](#wildcards-and-advanced-search-parameters). For example, searching for `mail` will return Vault items with the name `gmail` as well as `email`.
## Wildcard Searches
## Full-text Search
The asterisk character (`*`) provides the ability to perform wildcard searches in your vault. Examples:
[Full-text search](https://en.wikipedia.org/wiki/Full-text_search){:target="_blank"}, implemented in your Vault using a programming library called [Lunr](https://lunrjs.com/){:target="_blank"}, provides ways to invoke high-performance queries for Vault items. **Full-text search is available in Web Vaults, Desktop Applications, and Browser Extensions.**
- `*bitwarden`
- `bitwarden*`
- `*bitwarden*`
- `*bit*war*den*`
### Construct a Full-text Search
{% callout info %}
The following fields automatically include leading and trailing wildcards while performing normal search queries:
To invoke full-text search, start your search query with a "greater than" (`>`) character.
- `name`
- `subtitle`
- `login.uris`
When constructing a full-text search, an indexed field name should immediately follow the "greater than" (`>`) character. The following fields of Vault items are indexed and searchable:
It is not necessary to provide wildcards if you are searching for information in these fields.
- `shortid`: First 8 characters of the item's ID.
- `organizationid`: ID of the item's Organization (if it belongs to one).
- `name`: Item's designated name.
- `subtitle`: Depending on Item Type; Login Username, Card Brand or last four digits, or Identity Name.
- `notes`: Item's notes.
- `fields`: Name or Value. **Only `Text` type field values are included.**
- `attachments`: Name of the attached file.
- `login.username`: Login item's username.
- `login.uris`: Login item's URI [hostname](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHyperlinkElementUtils/hostname){:target="_blank"} value.
Once a field is specified, search for a value in that field using a colon (`:`) delimiter, for example:
- `>login.username:jsmith` will search for Login items with `jsmith` specified as the **Username**.
- `>name:Turbo Tax` will search for any Vault items with `Turbo Tax` specified as the **Name**.
- `>fields:Security Question` will search for any Vault items with a custom text field with the **Name** `Security Question`.
### Wildcards and Advanced Search Parameters
When constructing a full-text search, you can apply the asterisk (`*`) as a wildcard character for specified search values, for example:
- `>organizationid:*` will search for all Vault items that belong to an Organization.
- `>login.username:*@gmail.com` will search for any Login item **Username** that ends in `@gmail.com`.
{% callout success %}
[Lunr](https://lunrjs.com/){:target="_blank"} provides a variety of advanced query options beyond wildcards, including:
- **Term Presence** using a `+` (*must contain*) or `-` (*must not contain*) prefix.
For example, if you have multiple Gmail accounts, searching `>name:Gmail -Work` **would** return a Vault item with the name `Personal Gmail` but **would not** return a Vault item with the name `Work Gmail`.
- **Fuzzy Matching** using a tilde (`~`) prefix combined with an edit distance integer.
For example, searching `>name:email~1` would return both Vault items with the name `email` **and** Vault items with the name `gmail`.
Learn more about writing advanced search queries using [Lunr's Searching Guide](https://lunrjs.com/guides/searching.html){:target="_blank"}.
{% endcallout %}
## Advanced Searches
Starting your search query with a greater than character (`>`) enables the full power of [Lunr search queries](https://lunrjs.com/guides/searching.html){:target="_blank"}.
### Advanced Search Examples
- `>bitwarden*` - Search all fields for a term that starts with "bitwarden".
- `>notes:something` - Search the notes field for the term "something".
- `>login.username:jsmith` - Search the username field on items of type login for the term "jsmith".
- `>+organizationid:*` - Search for all items that belong to an organization.
- `>-organizationid:*` - Search for all items that *do not* belong to an organization (items that you own).
- `>+foo bar -baz` - Search for items that must contain "foo", might contain "bar" and must not contain "baz".
Learn more about writing advanced search queries using [Lunr's searching guide](https://lunrjs.com/guides/searching.html){:target="_blank"}.

View File

@@ -1,100 +1,94 @@
---
layout: article
title: Match detection for URIs
categories: [features]
title: URIs for Vault Items
categories: [account-management]
featured: false
popular: false
tags: [uri, match detection, autofill]
order: 09
---
A login item stored in your vault can have one or more [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier){:target="_blank"} values associated with it. URIs can relate your login to a website address (URL), server IP address, mobile app package ID, and more. URIs are important values for a login since they determine how the auto-fill functions in Bitwarden will behave.
Any Login item in your Vault can be created with or edited to include one or more URI (Uniform Resource Identifier). A URI can be a website address (i.e. a URL), a Server IP Address, a Mobile App Package ID, and more.
## URI schemes
{% image uri.png Login item URI fields in the Web Vault %}
A well-formed URI also has a "scheme" at the beginning of it. The most common scheme that many of us are familiar with is the `http://` scheme used for a website address.
The scheme can also have special meaning in Bitwarden:
- **`http://`** or **`https://`** tells Bitwarden that this is a website address. Example: `https://www.google.com`
- **`androidapp://`** tells Bitwarden that this is an android application package ID (or package name). Example: `androidapp://com.twitter.android`. Android apps typically follow [reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation){:target="_blank"}.
{% callout info %}
If a URI omits the scheme, `http://` is assumed.
{% callout success %}
Assigning URIs to Login items is **required if you want to leverage auto-fill** functionality in the various Bitwarden client applications.
{% endcallout %}
## Match detection options
## URI Schemes
Each URI for a login item also has an associated "match detection" value. The match detection value determines whether or not Bitwarden will offer the login as an available option when performing an auto-fill.
Well-formed URIs should include a scheme at the beginning, for example the `https://` scheme to securely reference a website address. If no scheme is specified, `http://` is assumed.
While editing a login you can adjust the match detection value for a given URI by selecting the {% icon fa-cog %} **Options** button next to the URI's value.
The following match detection options are available:
{% callout info %}
**Base domain** is the default URI match detection value for all URIs. You can adjust this default value under **Settings** &rarr; **Options**.
{% callout success %}
Most Bitwarden client applications allow you to {% icon fa-share-square %} **Launch** an website or app directly from your Vault. Without a scheme, this functionality will not work properly.
{% endcallout %}
**Base domain**
Schemes include:
The base domain is defined as the second-level domain plus the top-level domain of the given URI. A URI with a value of `https://www.google.com` would have a base domain value of `google.com`.
- `http://` or `https://` reference website addresses (e.g. `https://github.com`)
- `androidapp://` references an Android Application Package ID or Name (e.g. `androidapp://com.twitter.android`)
Example:
## Match Detection Options
- URI base domain value: `https://www.google.com`
- Matches: `http://google.com`, `https://accounts.google.com`, `https://sub.accounts.google.com`, `https://accounts.google.com/page.html`
- Not matches: `https://google.net`, `https://yahoo.com`
Each URI assigned to a Login item has an associated **Match Detection** option. This option determines when and whether Bitwarden will offer the Login as an available option for auto-fill.
**Host**
### Default match detection
The [host](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHyperlinkElementUtils/host){:target="_blank"} is defined as the hostname plus an *optional* port of the given URI. A URI with a value of `https://sub.domain.com:4000` would have a host value of `sub.domain.com:4000`.
Bitwarden Browser Extensions and Mobile Apps can select a **Default match detection** option from the options below (Base domain, Host, Starts with, Regular expression, Exact, or Never) by navigating to {% icon fa-cogs %}**Settings** &rarr; **Options** &rarr; **Default URI Match Detection**. Setting a default option will not preclude you from specifying a match detection option on an item-by-item basis as well.
Example:
By default, Bitwarden will use **Base domain** matching as the default option.
- URI host value: `https://sub.domain.com:4000`
- Matches: `http://sub.domain.com:4000`, `http://sub.domain.com:4000/page.html`
- Not matches: `https://domain.com`, `https://sub.domain.com`, `https://sub2.domain.com`, `https://sub.domain.com:5000`, `http://sub2.sub.domain.com:4000`
**Starts with**
#### Base domain
The "starts with" option requires that the current website/application URI must *start with* the value defined in the URI. A URI with a value of `https://sub.domain.com/path/page.html?query=123` starts with
`https://sub.domain.com/path/`.
Selecting **Base domain** will prompt Bitwarden to offer auto-fill when the top-level domain and second-level domain of a Login's URI value match the detected resource.
Example:
For example, if the URI value `https://google.com` uses base domain match detection:
- URI starts with value: `https://sub.domain.com/path/`
- Matches: `https://sub.domain.com/path/`, `https://sub.domain.com/path/page.html`
- Not matches: `https://sub.domain.com/path` (notice the missing trailing slash), `https://sub.domain.com`, `https://sub.domain.com:4000/path/page.html` (has a port)
- **Auto-fill offered** for `http://google.com` & `https://accounts.google.com`
- **Auto-fill not offered** for `https://google.net` & `http://yahoo.com`
**Regular expression**
#### Host
{% callout warning %}
Regular expressions are an advanced option and can be quite dangerous if used incorrectly. You should not use this option if you do not know exactly what you are doing.
Selecting **Host** will prompt Bitwarden to offer auto-fill when the hostname and (*if specified*) port of the Login's URI value matches the detected resource.
For example, if the URI value `https://sub.domain.com:4000` uses host match detection:
- **Auto-fill offered** for `http://sub.domain.com:4000` & `https://sub.domain.com:4000/page.html`
- **Auto-fill not offered** for `https://domain.com`, `https://sub.domain.com`, `https://sub2.sub.domain.com:4000`, or `https://sub.domain.com:5000`
#### Starts with
Selecting **Starts with** will prompt Bitwarden to offer auto-fill when the detected resource starts with the Login URI value, regardless of what follows it.
For example, if the URI value `https://sub.domain.com/path/` uses starts with match detection:
- **Auto-fill offered** for `https://sub.domain.com/path/` & `https://sub.domain.com/path/page.html`
- **Auto-fill not offered** for `https://sub.domain.com`, `https://sub.domain.com:4000/path/page.html` (interrupted with a port), or `https://sub.domain/com/path` (absent trailing slash)
#### Regular expression
{% callout note %}
Regular expressions are an advanced option and can be quite dangerous if used incorrectly. You should not use this option if you do not know exactly what you're doing.
{% endcallout %}
The regular expression option allows you to write any simple or complex [regular expression](https://en.wikipedia.org/wiki/Regular_expression){:target="_blank"} to match the current website/application URI. All regular expressions are case *insensitive*.
Selecting **Regular expression** will prompt Bitwarden to offer auto-fill when the detected resources matches a specified [regular expression](https://en.wikipedia.org/wiki/Regular_expression){:target="_blank"}. Regular expressions are always *case insensitive*.
Example:
For example, if the URI vault `^https://.*google.com$` uses regular expression match detection:
- URI regex value: `^https://.*google.com$`
- Matches: `https://google.com`, `https://sub.google.com`, `https://sub.sub2.google.com`, `https://malicious-site.com?q=google.com`
- Not matches: `http://google.com` (not https), `https://yahoo.com`
- **Auto-fill offered** for `https://google.com`, `https://sub.google.com`, `https://malicious-site.com?q=google.com`
- **Auto-fill not offered** for `http://google.com` or `https://yahoo.com`
**Exact**
#### Exact
The "exact" option requires that the current website/application URI *exactly* match the value defined in the URI.
Selecting **Exact** will prompt Bitwarden to offer auto-fill when the Login URI value matches the detected resource exactly.
Example:
For example, if the URI value `https://www.google.com/page.html` uses exact match detection:
- URI exact value: `https://www.google.com/page.html`
- Matches: `https://www.google.com/page.html`
- Not matches: `http://www.google.com/page.html` (not https), `https://www.google.com/page.html?query=123`, `https://www.google.com`
- **Auto-fill offered** for `https://www.google.com/page.html`
- **Auto-fill not offered** for `http://www.google.com/page.html`, `https://www.google.com/page.html?query=123`, or `https://www.google.com`
**Never**
#### Never
A URI with match detection set to "Never" will *never* be offered for auto-fill.
Example:
- URI never value: `https://www.google.com`
- Matches: none
- Not matches: `https://www.google.com`, `https://google.com`, `https://sub.google.com/page.html`
Selecting **Never** will prompt Bitwarden to never offer auto-fill for the Login item.

View File

@@ -71,7 +71,7 @@ For the purpose of this tutorial, we'll focus on the Web Vault.
Create the first account by starting at <https://vault.bitwarden.com>. Pick a strong master password and write it down in a safe place.
{% callout warning %}
The Bitwarden security model does not support master password recovery. You can read more in the help article [I forgot my master password]({% link _articles/account/forgot-master-password.md %})
The Bitwarden security model does not support master password recovery. You can read more in the help article regarding [I Forgot my Master Password]({% link _articles/account/master-password.md %}).
{% endcallout %}
{% image organizations/orgstart/1-create-account-user-1.png Create account for user 1 %}

View File

@@ -11,7 +11,9 @@ order: 07
Encrypted Exports provide a secure long-term storage option for Vault data backups. Vault data is encrypted using your account's Encryption Key.
{% callout warning %}
[Rotating your account's encryption key](https://bitwarden.com/help/article/change-your-master-password/#rotating-your-accounts-encryption-key) will render an Encrypted Export impossible to decrypt. **If you rotate your encryption key, replace the old backup with one that uses the new encryption key.**
[Rotating your account's encryption key]({% link _articles/account/account-encryption-key.md %}) will render an Encrypted Export impossible to decrypt. **If you rotate your account encryption key, replace the old backup with one that uses the new encryption key.**
Account Encryption Keys are unique to each Bitwarden user account, so you won't be able to import an Encrypted Export into a different account.
{% endcallout %}
An Encrypted Export of the following plaintext login item:

View File

@@ -5,7 +5,7 @@ categories: [security]
featured: false
popular: false
tags: []
order: 08
order: 10
---
Reference the table below for a list of Bitwarden's subprocessors.

View File

@@ -1,48 +1,63 @@
---
layout: article
title: Syncing your Vault
categories: [miscellaneous]
title: Sync your Vault
categories: [account-management]
featured: false
popular: false
tags: [vault, sync, automatic, FAQ]
order: 04
---
## What is vault syncing?
Adding, editing, or deleting Vault items from any Bitwarden client application will automatically push changes to your Bitwarden server, whether Cloud-hosted or self-hosted.
Vault syncing is purely downloading the latest content from your Bitwarden vault onto your device for access.
In order to pull those changes down to another Bitwarden client application, your Vault will need to Sync.
In some cases, this happens automatically. On iOS and Android apps, Bitwarden leverages push notifications to kick-off a **personal** vault synchronization.
## Automatic Sync
**Organization Vaults** synchronize to devices every 30 minutes, or upon manual sync.
Your personal [Web Vault](https://vault.bitwarden.com){:target="\_blank"} will always remain in-sync. Organization Vaults will automatically sync across users and client applications every 30 minutes.
## When does my vault sync?
Bitwarden client applications (Desktop Applications, Browser Extensions, Mobile Apps, and CLI) will sync automatically on login, and with regularity when unlocked. You can also [Manually Sync](#manual-sync) your Vault to pull changes to a client application immediately.
### Mobile APPS
{% callout success %}
When you install Bitwarden on a new device, simply log in to your existing account to automatically pull down your most up-to-date Vault data.
{% endcallout %}
The Bitwarden mobile apps sync **personal** vaults automatically.
Organization vaults are synchronized once every 30 minutes, or on-demand by navigating to:
**Settings > Sync > Sync Vault now**
## Manual Sync
{% callout info %}Self-hosted users can enable Push notifications powered by the Bitwarden cloud.{% endcallout %}
To manually sync your Vault from a Bitwarden client application:
You can also sync your vault on-demand with the pull down gesture. Navigate to **Settings > Sync > Enable sync on refresh** to enable sync on refresh.
### Sync Browser Extensions
### Browser extensions
Select the {% icon fa-cogs %} **Settings** tab, select the **Sync** option and select the **Sync Vault Now** button.
The Bitwarden browser extensions sync **personal** vaults automatically.
Organization vaults are synchronized once every 30 minutes, or on-demand by navigating to:
**Settings > Sync > Sync Vault now**
### Sync Mobile Apps
### Desktop applications
Open the {% icon fa-cogs %} **Settings** tab, tap the **Sync** option and tap **Sync Vault Now**.
The Bitwarden desktop apps sync **personal** vaults automatically.
Organization vaults are synchronized once every 30 minutes, or on-demand by navigating to: **File > Sync Vault**
Toggle the **Enable sync on refresh** option to allow your Vault to be synced using a pulldown gesture on the {% icon fa-lock %} **My Vault** tab.
### Command-line interface
### Sync Desktop Apps
The Bitwarden CLI client syncs **personal** vaults automatically.
Organization vaults are synchronized once every 30 minutes, or on-demand by running the command: ```bw sync```
Select **File** &rarr; **Sync Vault** from the menu bar.
## Common issues
### Sync the CLI
- Sync failure can occur if your devices time is not correct. Syncing (and all of Bitwarden services) require TLS/SSL, which will fail to connect to a host with invalid timestamps.
Use the `sync` command to manually sync your Vault:
```
bw sync
```
For more information, see [The Bitwarden command-line tool (CLI)]({% link _articles/miscellaneous/cli.md %}).
## Troubleshooting
If Vault Sync is not working properly, investigate the following:
#### Mismatched Timestamp
Sync failure may occur if your device's time is not correct. Bitwarden uses TLS/SSL, which will fail to connect a client application to the server if timestamps are mismatched.
#### VPN or Ad Blocker Interference
In some cases, VPN or Ad Blocker browser extensions may interfere with the connection between client application and server. This issue is typically observed with Bitwarden Browser Extensions.

View File

@@ -5,7 +5,7 @@ categories: [security]
featured: false
popular: false
tags: [icons, website icons, privacy]
order: 07
order: 09
---
*Bitwarden does not collect any information when you download icons for website logins stored in your Bitwarden vault.*

View File

@@ -11,6 +11,8 @@ This article will guide you through the process of inviting or removing users fr
Teams and Enterprise Organizations can sync Bitwarden to an existing user directory to automatically add or remove new users using the **Bitwarden Directory Connector**. For more information, see [About Directory Connector]({% link _articles/directory-connector/directory-sync.md %}}).
Invitations to an Organization will expire after 5 days, at which point the user will need to be re-invited. If you're self-hosting Bitwarden, you can configure the invitation expiration period. For more information, see [Configure Environment Variables]({% link _articles/hosting/environment-variables.md %}).
{% callout info %}
**Free** Organizations and **Families** Organizations have a maximum number of users; 2 and 6 respectively.
@@ -44,6 +46,8 @@ Invited users will receive an email from Bitwarden asking them to join the Organ
{% image organizations/user-accept-updated.png %}
If the user does not answer this invitation, it will expire after 5 days.
### Confirm Invited Users
Once a user has accepted the invitation to join the Organization, you'll need to **Confirm** their acceptance.

View File

@@ -5,7 +5,7 @@ categories: [security]
featured: true
popular: false
tags: [cloud]
order: 04
order: 06
redirect_from:
- /article/where-is-data-stored-cloud/
- /article/where-is-data-stored-computer/

View File

@@ -6,7 +6,7 @@ featured: true
popular: false
hidden: false
tags: []
order: 06
order: 08
---
Emergency Access enables users to designate and manage trusted emergency contacts, who may request access to their Vault with a configurable level of permissions.

View File

@@ -5,7 +5,7 @@ categories: [security]
featured: true
popular: false
tags: [audit]
order: 05
order: 07
---
Bitwarden is a global company with customers located all over the world. Our business is to help customers protect, store, and share their sensitive data. We prioritize protecting the personal data of our customers and their end-users as paramount to our company mission. Bitwarden complies with industry standards, and conducts regular audits shared transparently with our customers and users. Our open source approach puts us in a unique position, where our software is viewed and scrutinized by a globally engaged community.

View File

@@ -38,7 +38,7 @@ Security often involves a tradeoff between protection and convenience, so ultima
Since your Password Manager stores all your logins, we highly recommend that you secure it with Two-step Login. Doing so protects *all* your logins by preventing a malicious actor from accessing your Vault, even if they discover your Master Password.
Enabling Two-step Login will require you to complete a secondary step each time you **Log In**, in addition to entering your Master Password.
Enabling Two-step Login will require you to complete a secondary step each time you **Log In**, in addition to entering your Master Password. You won't need to complete your secondary step to Unlock your Vault.
{% image two-step/field-guide/two-step-login-bitwarden.png Two-step Login to access Bitwarden %}

View File

@@ -1,5 +1,5 @@
---
layout: category
title: Account Management
title: Your Vault
featured: true
---

View File

@@ -1,5 +0,0 @@
---
layout: category
title: FAQs
featured: true
---

View File

@@ -1,5 +0,0 @@
---
layout: category
title: Features
featured: true
---

View File

@@ -1,5 +1,5 @@
---
layout: category
title: Import/Export
title: Import &amp; Export
featured: true
---

View File

@@ -27,8 +27,15 @@ collections:
permalink: /:path/
order:
- getting-started.md
- account-management.md
- import-export.md
- two-step-login.md
- hosting.md
- organizations.md
- directory-connector.md
- login-with-sso.md
- security.md
- plans-and-pricing.md
articles:
output: true
permalink: /article/:name/

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 745 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

BIN
images/uri.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB