Browse Source
* q1 release additions & extras * saml samples addition * safari app extension note * invitation validitypull/357/head
fred_the_tech_writer
5 years ago
committed by
GitHub
33 changed files with 412 additions and 55 deletions
@ -1,20 +1,28 @@
@@ -1,20 +1,28 @@
|
||||
--- |
||||
layout: article |
||||
title: Installing the Bitwarden Safari App Extension |
||||
title: Bitwarden Safari App Extension |
||||
categories: [features] |
||||
featured: false |
||||
popular: false |
||||
tags: [browser, safari] |
||||
--- |
||||
|
||||
The new Safari App Extension is now packaged with the Bitwarden Desktop App. This is the recommended development path from Apple for Safari App Extensions. |
||||
## Get the Extension |
||||
|
||||
Bitwarden's Safari App Extension is packaged with the Bitwarden Desktop App available on the App Store, as recommended by from Apple regarding Safari App Extensions. |
||||
|
||||
Download the Bitwarden Safari App Extension (within the Bitwarden Desktop App) |
||||
[https://vault.bitwarden.com/download/?app=desktop&platform=macos](https://vault.bitwarden.com/download/?app=desktop&platform=macos) |
||||
{% callout warning %} |
||||
Due to changes by Apple, Safari now limits Safari App Extension use to only those obtained through Mac App Store downloads. As of Q1 2021, users will not be able to use a Bitwarden Safari App Extension obtained through a `.dmg` installation from [bitwarden.com/download](https://bitwarden.com/download){:target="\_blank"} or any other non-App Store source. |
||||
|
||||
You can also use the App Store version of the Bitwarden Desktop App. |
||||
|
||||
Be sure to run the desktop application once. If the extension still does not appear, it may just need to be enabled. In Safari, check under Preferences > Extensions. |
||||
To read community conversation on the topic, refer to the following Apple Developer Forum threads ([Thread #1](https://developer.apple.com/forums/thread/659029){:target="\_blank"}, [Thread #2](https://developer.apple.com/forums/thread/667859){:target="\_blank"}). |
||||
{% endcallout %} |
||||
|
||||
For developer detail on Safari App Extensions, click [here](https://developer.apple.com/documentation/safariservices/safari_app_extensions). |
||||
|
||||
## Enable the Extension |
||||
|
||||
Before enabling the Safari App Extension, run the Desktop Application at least one. In Safari: |
||||
|
||||
1. Open the **Preferences** window. |
||||
2. Navigate to the **Extensions** page. |
||||
3. Check the **Bitwarden** checkbox, and select **Turn on** in the confirmation dialog. |
||||
|
||||
@ -0,0 +1,68 @@
@@ -0,0 +1,68 @@
|
||||
--- |
||||
layout: article |
||||
title: Encrypted Exports |
||||
categories: [import-export] |
||||
featured: true |
||||
popular: false |
||||
tags: [import] |
||||
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-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.** |
||||
{% endcallout %} |
||||
|
||||
An Encrypted Export of the following plaintext login item: |
||||
``` |
||||
{ |
||||
... |
||||
"login": { |
||||
"username": "mylogin", |
||||
"password": "mypassword", |
||||
"totp": "otpauth://totp/my-secret-key" |
||||
}, |
||||
... |
||||
``` |
||||
|
||||
Will look something like: |
||||
``` |
||||
{ |
||||
... |
||||
"login": { |
||||
"username": "9.dZwQ+b9Zasp98dnfp[g|dHZZ1p19783bn1KzkEsA=l52bcWB/w9unvCt2zE/kCwdpiubAOf104os}", |
||||
"password": "1o8y3oqsp8n8986HmW7qA=oiCZo872b3dbp0nzT/Pw=|A2lgso87bfDBCys049ano278ebdmTe4:", |
||||
"totp": "2CIUxtpo870B)*^GW2ta/xb0IYyepO(*&G(&BB84LZ5ByZxu0E9hTTs6PHg0=8q5DHEPU&bp9&*bns3EYgETXpiu9898sxO78l" |
||||
}, |
||||
... |
||||
``` |
||||
|
||||
## Create an Encrypted Export |
||||
|
||||
Downloading an Encrypted Export follows the same procedure as downloading a plaintext `.csv` or `.json` export: |
||||
|
||||
1. In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select **Tools** from the top navigation bar. |
||||
3. Select **Export Vault** from the left-hand Tools menu. |
||||
4. On the Export Vault page: |
||||
- Select **.json (Encrypted)** from the **File Format** dropdown. |
||||
- Enter your **Master Password**. |
||||
5. Select the **Export Vault** button to download your Vault Export. You will be prompted to specify a location for download. |
||||
|
||||
For help downloading an Encrypted Export from any other client application, see [Export Vault Data]({% link _articles/account/export-your-data.md %}). |
||||
|
||||
## Import an Encrypted Export |
||||
|
||||
Importing an Encrypted Export following the same procedure as importing a plaintext `.csv` or `.json` file: |
||||
|
||||
1. In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}, select **Tools** from the top navigation bar. |
||||
2. Select **Import Data** from the left-hand Tools menu. |
||||
3. Select **Bitwarden (json)** as the format of your file to import. |
||||
|
||||
{% callout success %}There is no import option specifically for Encrypted Exports. A handler will determine that the `.json` file is encrypted and decrypt using your account encryption key.{% endcallout %} |
||||
5. Select the **Browse** button and add your file. |
||||
6. Select the **Import Data** button to complete your import. |
||||
|
||||
{% callout warning %} |
||||
Importing data multiple times will create duplicates. |
||||
{% endcallout %} |
||||
@ -0,0 +1,25 @@
@@ -0,0 +1,25 @@
|
||||
--- |
||||
layout: article |
||||
title: Auth0 SAML Implementation |
||||
categories: [] |
||||
featured: false |
||||
popular: false |
||||
hidden: true |
||||
tags: [sso, saml, aws] |
||||
order: |
||||
--- |
||||
This article contains sample configurations for Bitwarden **Login with SSO** (SAML 2.0) implementations with Auth0. |
||||
|
||||
Use this as reference material for the [Configure Login with SSO (SAML 2.0)]({% link _articles/login-with-sso/configure-sso-saml.md%}) article. |
||||
|
||||
## Azure Single Sign-on Portal |
||||
|
||||
The following is a sample SAML 2.0 implementation with Bitwarden in the Auth0 Portal: |
||||
|
||||
{% image sso/cheatsheets/saml-auth0/saml-auth01.png %} |
||||
|
||||
## Bitwarden Business Portal |
||||
|
||||
The following is a sample SAML 2.0 implementation with Auth0 in the Bitwarden Business Portal: |
||||
|
||||
{% image sso/cheatsheets/saml-auth0/saml-auth02.png %} |
||||
@ -0,0 +1,27 @@
@@ -0,0 +1,27 @@
|
||||
--- |
||||
layout: article |
||||
title: AWS SAML Implementation |
||||
categories: [] |
||||
featured: false |
||||
popular: false |
||||
hidden: true |
||||
tags: [sso, saml, aws] |
||||
order: |
||||
--- |
||||
This article contains sample configurations for Bitwarden **Login with SSO** (SAML 2.0) implementations with Amazon Web Service (AWS). |
||||
|
||||
Use this as reference material for the [Configure Login with SSO (SAML 2.0)]({% link _articles/login-with-sso/configure-sso-saml.md %}) article. |
||||
|
||||
## AWS Single Sign-on Portal |
||||
|
||||
The following is a sample SAML 2.0 implementation with Bitwarden in the AWS Console: |
||||
|
||||
{% image sso/cheatsheets/saml-aws/saml-aws1.png %} |
||||
|
||||
{% image sso/cheatsheets/saml-aws/saml-aws2.png %} |
||||
|
||||
## Bitwarden Business Portal |
||||
|
||||
The following is a sample SAML 2.0 implementation with AWS in the Bitwarden Business Portal: |
||||
|
||||
{% image sso/cheatsheets/saml-aws/saml-aws3.png %} |
||||
@ -1,16 +1,28 @@
@@ -1,16 +1,28 @@
|
||||
--- |
||||
layout: article |
||||
title: Help translate Bitwarden to other languages |
||||
title: Localization |
||||
categories: [miscellaneous] |
||||
featured: false |
||||
popular: false |
||||
tags: [localize, l10n, translate, i18n, internationalization, language] |
||||
--- |
||||
|
||||
Localizing Bitwarden does not require any programming knowledge. We use a translation tool called [Crowdin](https://crowdin.com) to help manage our localization efforts across many different languages. |
||||
## Change App Language |
||||
|
||||
If you are interested in translating a Bitwarden application into another language (or make a translation correction), please register an account at Crowdin and join our projects here: <https://crowdin.com/projects/kspearrin> |
||||
In the [Web Vault](https://vault.bitwarden.com){:target="\_blank"} and Desktop App, Bitwarden will default to American English. You can manually change the language by navigating to **Settings** → **Options** and selecting your language from the **Language** dropdown. |
||||
|
||||
If the language that you are interested in translating into is not already listed, create a new account on Crowdin, join the project and contact the project owner (<https://crowdin.com/profile/tgreer>). |
||||
Bitwarden Browser Extensions will dynamically change to use the language set by your Web Browser. |
||||
- [Learn how to change Chrome's language](https://support.google.com/chrome/answer/173424?co=GENIE.Platform%3DDesktop&hl=en){:target="\_blank"} |
||||
- [Learn how to change Firefox's language](https://support.mozilla.org/en-US/kb/use-firefox-another-language){:target="\_blank"} |
||||
|
||||
You can read Crowdin's getting started guide for translators here: <https://support.crowdin.com/crowdin-intro/> |
||||
Bitwarden Mobile Apps will dynamically change use the language set by your Operating System. |
||||
|
||||
### Don't See Your Language? |
||||
|
||||
If your language isn't listed in the Web Vault or Desktop App, or if your Browser Extension or Mobile App isn't dynamically using your language, **we want your help!** |
||||
|
||||
Bitwarden uses a translation tool called [Crowdin](https://crowdin.com){:target="\_blank"} to manage our localization effort across many different languages (**no programming knowledge required**). |
||||
- To contribute to or make corrections to an existing translation, [join our project](https://crowdin.com/projects/kspearrin){:target="\_blank"}. |
||||
- To start translating Bitwarden to a new language, join our project and contact the [Project Owner](https://crowdin.com/profile/tgreer){:target="\_blank"}. |
||||
|
||||
Read [Crowdin's Getting Started Guide](https://support.crowdin.com/crowdin-intro/){:target="\_blank"}. |
||||
|
||||
@ -0,0 +1,123 @@
@@ -0,0 +1,123 @@
|
||||
--- |
||||
layout: article |
||||
title: Emergency Access |
||||
categories: [security] |
||||
featured: true |
||||
popular: false |
||||
hidden: false |
||||
tags: [] |
||||
order: 06 |
||||
--- |
||||
|
||||
Emergency Access enables users to designate and manage trusted emergency contacts, who may request access to their Vault with a configurable level of permissions. |
||||
|
||||
## How it Works |
||||
|
||||
Emergency Access uses public key exchange and encryption/decryption to allow users to give a [trusted emergency contact](#trusted-emergency-contacts) permission to [access Vault data](#user-access) in a Zero Knowledge/Zero Trust environment: |
||||
|
||||
1. A Bitwarden user (the *grantor*) [invites another Bitwarden user](#invite-a-trusted-emergency-contact) to become a trusted emergency contact (the *grantee*). The invitation (valid for only 5 days) specifies a [user access level](#user-access) and includes a request for the grantee's public key. |
||||
2. Grantee is notified of invitation via email and [accepts the invitation](#accept-an-invitation) to become a trusted emergency contact. On acceptance, the grantee's public key is stored with the invite. |
||||
3. Grantor is notified of acceptance via email and [confirms the grantee](#confirm-an-accepted-invitation) as their trusted emergency contact. On confirmation, the grantor's Master Key is encrypted using the grantee's public key and stored once encrypted. Grantee is notified of confirmation. |
||||
4. An emergency occurs, resulting in grantee requiring access to grantor's Vault. Grantee [submits a request for emergency access](#initiate-emergency-access). |
||||
5. Grantor is notification of request via email. The grantor may [manually approve the request](#manually-approve-emergency-access) at any time, otherwise the request is bound by a grantor-specified wait time. When the request is approved or the wait time lapses, the public-key-encrypted Master Key is delivered to grantee for decryption with grantee's private key. |
||||
|
||||
4. Depending on the specified [user access level](#user-access), the grantee will either: |
||||
- Obtain view/read access to items in the grantor's Vault (**View**). |
||||
- Be prompted to create a new Master Password for the grantor's Vault (**Takeover**). |
||||
|
||||
### Trusted Emergency Contacts |
||||
|
||||
Emergency Access relies on public key exchange within Bitwarden, therefore trusted emergency contacts must be existing Bitwarden users, or will be prompted to create a Bitwarden account before they can accept an invitation. |
||||
|
||||
There is no limit to the number of trusted emergency contacts a user can have. |
||||
|
||||
### User Access |
||||
|
||||
Trusted emergency contacts can be granted one of the following user access levels: |
||||
- **View**: When an emergency access request is granted, this user is granted view/read access to all items in your personal Vault. |
||||
|
||||
{% callout success %}As a grantor, you may revoke access to a grantee with **View** access at any time.{% endcallout %} |
||||
- **Takeover**: When an emergency access request is granted, this user can create a Master Password for permanent read/write access to your Vault (this will **replace** your previous Master Password). |
||||
|
||||
## Using Emergency Access |
||||
|
||||
The following sections will walk you through establishing a trusted emergency contact, and executing on emergency access: |
||||
|
||||
### Invite a Trusted Emergency Contact |
||||
|
||||
As a grantor, complete the following steps to invite a trusted emergency contact for your Vault: |
||||
|
||||
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}. |
||||
2. Select **Settings** from the top navigation bar. |
||||
3. Select **Emergency Access** from the left-hand Settings menu. |
||||
4. Select the {% icon fa-plus %} **Add emergency contact** button. In the Invite Emergency Contact window: |
||||
|
||||
{% image /features/emergency-access/ea-invite.png Add emergency contact%} |
||||
- Enter the **Email** of your trusted emergency contact. Trusted emergency contacts must have Bitwarden accounts of their own. |
||||
- Set a **User Access** level for the trusted emergency contact ([View-only or Takeover](#user-access)). |
||||
- Set a **Wait Time** for Vault access. Wait Time dictates how long your trusted emergency contact must wait to access your Vault after initiating an emergency access request. |
||||
5. Select the **Save** button to send the invitation. |
||||
|
||||
{% callout info %} |
||||
Emergency Contact invitations are only valid for 5 days. |
||||
{% endcallout %} |
||||
|
||||
### Accept an Invitation |
||||
|
||||
As a grantee, complete the following steps to accept an invitation to become a trusted emergency contact: |
||||
|
||||
1. In the received email invitation, select the **Become emergency contact** button in the email to open an Emergency Access acceptance page in your Browser: |
||||
|
||||
{% image /features/emergency-access/ea-invitation.png Emergency access invitation %} |
||||
2. Log in to your Bitwarden account to accept the invitation. If you don't already have a Bitwarden account, you'll need to create one. |
||||
|
||||
### Confirm an Accepted Invitation |
||||
|
||||
As a grantor, complete the following steps to confirm an accepted invitation: |
||||
|
||||
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}. |
||||
2. Select **Settings** from the top navigation bar. |
||||
3. Select **Emergency Access** from the left-hand Settings menu. |
||||
|
||||
In the **Trusted emergency contacts** section, the invited user should appear with an `Accepted` status card. |
||||
4. Hovering over the user, select the gear icon and select **Confirm** from the dropdown menu. |
||||
|
||||
{% image /features/emergency-access/ea-confirm.png %} |
||||
|
||||
To ensure the integrity of your encryption keys, verify the displayed fingerprint phrase with the grantee before completing confirmation. |
||||
|
||||
### Initiate Emergency Access |
||||
|
||||
As a grantee, complete the following steps to initiate an emergency access request: |
||||
|
||||
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}. |
||||
2. Select **Settings** from the top navigation bar. |
||||
3. Select **Emergency Access** from the left-hand Settings menu. |
||||
4. In the **Designated as emergency contact** section, select the grantor whose Vault you wish to access. |
||||
5. In the Request Access window, select the **Request Access** button. |
||||
|
||||
{% image /features/emergency-access/ea-request.png Request Access%} |
||||
You will be provided access to the grantor's Vault after the configured Wait Time, or when the grantor [manually approves](#manually-approve-emergency-access) the emergency access request. |
||||
|
||||
### Manually Approve Emergency Access |
||||
|
||||
As a grantor, you may manually approve an emergency access request as an alternative to the configured Wait Time. Complete the following steps to manually approve emergency access: |
||||
|
||||
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}. |
||||
2. Select **Settings** from the top navigation bar. |
||||
3. Select **Emergency Access** from the left-hand Settings menu. |
||||
4. Hovering over the user with the `Emergency Access Initiated` status card, select the gear icon. |
||||
5. From the gear dropdown, select **Approve**. |
||||
6. In the confirmation dialog box, select **Approve**. |
||||
|
||||
### Access Grantee's Vault |
||||
|
||||
As the grantee, complete the following steps to access the grantor's Vault once your request has been approved (manually or through lapsed wait time): |
||||
|
||||
1. Log in to the [Web Vault](https://vault.bitwarden.com){:target="\_blank"}. |
||||
2. Select **Settings** from the top navigation bar. |
||||
3. Select **Emergency Access** from the left-hand Settings menu. |
||||
4. In the **Designated as emergency contact** section, hover over the grantor the grantor whose Vault you wish to access, and select the gear icon. |
||||
5. Select the option from the dropdown that corresponds with your [assigned access](#user-access): |
||||
- **View** - Selecting this option will display the grantor's Vault items on this screen. |
||||
- **Takeover** - Selecting this option will open the Takeover dialog box. Enter and confirm a new master password for the grantor's account. Once saved, log in to Bitwarden as normal, entering the the grantor's email address and the created Master Password. |
||||
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 430 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 131 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 118 KiB |
Loading…
Reference in new issue