Compare commits

...
Author SHA1 Message Date
jonah 4a3e1ab486 Add hardware wallets & update security keys 2026-07-24 01:59:06 -05:00
5 changed files with 303 additions and 181 deletions
+1 -1
View File
@@ -167,7 +167,7 @@ Mailbox Mail doesn't accept any cryptocurrencies as a result of their payment pr
#### :material-check:{ .pg-green } Account Security
Mailbox Mail supports [two-factor authentication](https://kb.mailbox.org/en/private/security-and-privacy/how-to-use-two-factor-authentication-2fa/) for their webmail only. You can use either TOTP or a [YubiKey](security-keys.md#yubikey) via the [YubiCloud](https://yubico.com/products/services-software/yubicloud). Web standards such as [WebAuthn](basics/multi-factor-authentication.md#fido-fast-identity-online) are not yet supported.
Mailbox Mail supports [two-factor authentication](https://kb.mailbox.org/en/private/security-and-privacy/how-to-use-two-factor-authentication-2fa/) for their webmail only. You can use either TOTP or a [YubiKey](security-keys.md#yubikey-5) via the [YubiCloud](https://yubico.com/products/services-software/yubicloud). Web standards such as [WebAuthn](basics/multi-factor-authentication.md#fido-fast-identity-online) are not yet supported.
#### :material-information-outline:{ .pg-blue } Data Security
+79
View File
@@ -0,0 +1,79 @@
---
title: Hardware Wallets
icon: material/cash-lock
description: Cryptocurrency hardware wallets secure your private keys against adversaries.
cover: hardware-wallets.webp
---
<small>Protects against the following threat(s):</small>
- [:material-target-account: Targeted Attacks](basics/common-threats.md#attacks-against-specific-individuals){ .pg-red }
- [:material-bug-outline: Passive Attacks](basics/common-threats.md#security-and-privacy){ .pg-orange }
A cryptocurrency **hardware wallet** is a dedicated physical device that stores the private keys used to access and authorize transactions from your cryptocurrency accounts. Unlike a software wallet on a phone or computer, it keeps those keys isolated from internet-connected devices, reducing the risk that malware, phishing, or a compromised operating system can steal them.
## Recommendations
Our top recommendations are full-featured products from the companies we list here, and support all major operating systems (notably including iOS).
### Ledger Nano Gen 5
<div class="admonition recommendation" markdown>
The **Ledger Nano Gen 5** hardware wallet places the private keys, wallet operating system, and cryptocurrency applications inside a certified secure element. Unlike Trezor's devices, it is also a recommended [security key](security-keys.md#ledger) product.
</div>
Ledger runs its *entire* operating system and stores your private keys inside its CC EAL6+ certified secure element. This is a simpler configuration than [Trezor](#trezor-safe-7)'s multi-chip design (described in the next section), but that doesn't necessarily translate to greater or lesser security. In theory, it may provide a smaller attack surface and offer more resistance to offline attacks or some very sophisticated attacks against a running device, but that comes at the cost of Trezor's greater transparency.
Wallet apps installed on Ledger devices are [open-source](https://support.ledger.com/article/11132311094813-zd), as is the companion Ledger Wallet software you install on your computer. However, the Ledger OS/firmware and the secure element implementation are proprietary.
The **Ledger Flex** and **Ledger Stax** are near-identical devices you could also consider. There are no security or software functionality differences between all three of these devices. The Flex and Stax devices have increasingly larger, higher resolution displays; more premium materials; and the Stax has wireless Qi charging.
### Trezor Safe 7
<div class="admonition recommendation" markdown>
The **Trezor Safe 7** is a modern touchscreen hardware wallet notable for using a dual secure element approach to security. It connects via USB-C or with Bluetooth.
</div>
The Safe 7 uses an industry-standard CC EAL6 secure element alongside an open architecture [TROPIC01](https://tropicsquare.com/tropic01) secure element to provide security. It also uses a general-purpose microcontroller unit (MCU), which is not a secure element but allows for better inspectability for developers and researchers.
In this setup, your seed is not stored in either secure element, it is stored *encrypted* in the general-purpose MCU. However, decrypting it requires key material stored by both secure elements. Trezor claims an attacker would need to compromise all three layers to recover the encrypted hardware data. Thus, Trezor's approach balances open-source and transparency in their MCU firmware and the less proven but more open TROPIC01 chip, alongside the more proven CC EAL6+ secure element from a commercial provider.
Trezor devices are not [recommended FIDO2 security keys](security-keys.md), although they do have security key functionality, because Trezor has not sought out certification from the FIDO Alliance to validate their security key software is implemented properly. Some websites/apps will require a key to have some level of FIDO certification, so you may experience compatibility issues using this device for that purpose.
## Budget Picks
Our budget recommendations are generally just as secure as our top recommendations, but neither support iOS. They also have more limited, button-based interfaces instead of touchscreens, making them well-suited for long-term storage, but more inconvenient for frequent use.
### Trezor Safe 3
<div class="admonition recommendation" markdown>
The **Trezor Safe 3** is a simple and inexpensive USB-C only hardware wallet. Like the [Safe 7](#trezor-safe-7), it has open-source firmware and supporting software so that it can be independently inspected.
</div>
The **Trezor Safe 5** is a near-identical device you could also consider. There are no security or software functionality differences between the Safe 3 and Safe 5. However, the Safe 5 has a larger touchscreen for easier navigation, instead of the Safe 3's smaller display and two-button navigation.
The Safe 3/5 devices do **not** use the same dual secure enclave configuration as the Safe 7. Instead, they omit the TROPIC01 to run a single EAL CC6+ secure element, which stores material to unlock the private keys that are stored encrypted on the separate general-purpose MCU.
### Ledger Nano S Plus
<div class="admonition recommendation" markdown>
The **Ledger Nano S Plus** is a small hardware wallet with a two-button interface, recommended by Ledger as a "backup signer" rather than a regular-use device. Compared to the [Nano Gen 5](#ledger-nano-gen-5) it only has USB connectivity, and it has no internal battery, which may provide an improvement in longevity.
</div>
The Nano S Plus lacks NFC connectivity, making it less suitable for [security key](security-keys.md#ledger) functionality on mobile devices, and making it incompatible with Ledger's Recovery Key backup solution. All four Ledger devices we recommend have essentially the same security properties, they only differ in interfaces.
Note we do **not** recommend the similar Ledger Nano X still in production. The Nano X uses an older secure element which is only CC EAL5 certified, while our minimum criteria requires EAL6. There are limited uses for the Nano X compared to all other devices Ledger offers, so it generally does not make sense as a new purchase.
## Criteria
**Please note we are not affiliated with any of the projects we recommend.** In addition to [our standard criteria](about/criteria.md), we have developed a clear set of requirements to allow us to provide objective recommendations. We suggest you familiarize yourself with this list before choosing to use a project, and conduct your own research to ensure it's the right choice for you.
- Must use a secure element which meets Common Criteria EAL6 or higher.
- Must support a [recommended cryptocurrency](cryptocurrency.md).
+41 -35
View File
@@ -11,6 +11,16 @@ cover: multi-factor-authentication.webp
A physical **security key** adds a very strong layer of protection to your online accounts. Compared to [authenticator apps](multi-factor-authentication.md), the [FIDO2](basics/multi-factor-authentication.md#fido-fast-identity-online) security key protocol is immune to phishing, and cannot be compromised without physical possession of the key itself. Many services support FIDO2/WebAuthn as a multifactor authentication option for securing your account, and some services allow you to use a security key as a strong single-factor authenticator with passwordless authentication.
| Product | Price | Connector | Authentication | Android | iOS | Firmware Updates | Backup/Sync | Apps | FIDO Certification
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:
| [**Yubico Security Key**](#yubico-security-key) | $29 USD | NFC + USB-C, USB-A Options | Push Button Only, PIN Optional | NFC, USB | NFC, USB | No[^2] | No | FIDO2 | Level 2
| **YubiKey Bio - FIDO Edition** | $98 USD | USB-C, USB-A Options | Biometric, PIN Fallback | USB Only | USB Only | No[^2] | No | FIDO2 | Level 2
| **[YubiKey 5](#yubikey) NFC** | $58 USD | NFC + USB-C, USB-A Options | Push Button Only, PIN Optional | NFC, USB | NFC, USB | No[^2] | No | FIDO2, OpenPGP, PIV | Level 2
| **YubiKey 5 Nano** | $68 USD | USB-C, USB-A Options | Push Button Only, PIN Optional | USB Only | USB Only | No[^2] | No | FIDO2, OpenPGP, PIV | Level 2
| **[Ledger](#ledger) Nano S Plus** | $59 USD | USB-C Cable | 4-8 Digit PIN | USB Only | **No** | Yes | Both | FIDO2, OpenPGP, [Cryptocurrency](hardware-wallets.md) | Level 1
| **Ledger Nano Gen5, Flex, Stax** | $179 - $399 USD | NFC + USB-C Cable | 4-8 Digit PIN | NFC, USB | NFC Only | Yes | Both | FIDO2, OpenPGP, [Cryptocurrency](hardware-wallets.md) | Level 1
| [**Google Titan Key**](#google-titan-security-key) | $30 - $35 USD | NFC + USB-C, USB-A Options | Push Button Only, PIN Optional | NFC, USB | NFC, USB | No | No | FIDO2 | Level 1
## Yubico Security Key
<div class="admonition recommendation" markdown>
@@ -29,24 +39,15 @@ The **Yubico Security Key** series is the most cost-effective hardware security
</div>
These keys are available in both USB-C and USB-A variants, and both options support NFC for use with a mobile device as well.
Note that despite the name, the [YubiKey **Bio**](https://www.yubico.com/product/yubikey-bio-series/yubikey-c-bio/) series has a limited feature-set nearly identical to the Yubico Security Key series, rather than the full-fledged [YubiKey](#yubikey) series detailed in the next section. It is another option you could consider if you value biometric authentication.
This key provides only basic FIDO2 functionality, but for most people that is all you will need. Some notable features the Security Key series does **not** have include:
Yubico's basic security keys provide only FIDO2 functionality, but for most people that is all you will need. Some notable features the Security Key series does **not** have include:
- [Yubico Authenticator](https://yubico.com/products/yubico-authenticator)
- CCID Smart Card support (PIV-compatible)
- OpenPGP
If you need any of those features, you should consider their higher-end [YubiKey](#yubikey) series instead.
<div class="admonition warning" markdown>
<p class="admonition-title">Warning</p>
The firmware of Yubico's Security Keys is not updatable. If you want features in newer firmware versions, or if there is a vulnerability in the firmware version you are using, you would need to purchase a new key.
</div>
## YubiKey
## YubiKey 5
<div class="admonition recommendation" markdown>
@@ -64,7 +65,7 @@ The **YubiKey** series from Yubico are among the most popular security keys with
</div>
The [comparison table](https://yubico.com/store/compare) shows how the YubiKeys compare to each other and to Yubico's [Security Key](#yubico-security-key) series in terms of features and other specifications. One of the benefits of the YubiKey series is that one key can do almost everything you could expect from a hardware security key. We encourage you to take their [quiz](https://yubico.com/quiz) before purchasing in order to make sure you choose the right security key.
This detailed [comparison table](https://yubico.com/store/compare) has more details about how the YubiKeys compare to each other and to Yubico's [Security Key](#yubico-security-key) series in terms of features and other specifications. One of the benefits of the YubiKey series is that one key can do almost everything you could expect from a hardware security key. We encourage you to take their [quiz](https://yubico.com/quiz) before purchasing in order to make sure you choose the right security key.
YubiKeys can be programmed using the [YubiKey Manager](https://yubico.com/support/download/yubikey-manager) or [YubiKey Personalization Tools](https://yubico.com/support/download/yubikey-personalization-tools). For managing TOTP codes, you can use the [Yubico Authenticator](https://yubico.com/products/yubico-authenticator). All of Yubico's clients are open source.
@@ -77,32 +78,39 @@ The firmware of YubiKey is not updatable. If you want features in newer firmware
</div>
## Nitrokey
## Ledger
<div class="admonition recommendation" markdown>
<figure markdown="span">
![Nitrokey](assets/img/security-keys/nitrokey.jpg){ width="300" }
</figure>
**Nitrokey** has a cost-effective security key capable of FIDO2/WebAuthn and FIDO U2F called the **Nitrokey Passkey**. For support for features such as PIV, OpenPGP, and TOTP and HOTP authentication, you need to purchase one of their other keys like the **Nitrokey 3**. Currently, only the **Nitrokey 3A Mini** has [FIDO Level 1 Certification](https://nitrokey.com/news/2024/nitrokey-3a-mini-receives-official-fido2-certification).
[:octicons-home-16: Homepage](https://nitrokey.com){ .md-button .md-button--primary }
[:octicons-eye-16:](https://nitrokey.com/data-privacy-policy){ .card-link title="Privacy Policy" }
[:octicons-info-16:](https://docs.nitrokey.com){ .card-link title="Documentation" }
</details>
**Ledger** makes a number of [cryptocurrency hardware wallet](hardware-wallets.md) products and an optional, FIDO certified [Security Key](https://support.ledger.com/article/12350325732893-zd) app for those wallets which enables FIDO2 security key functionality. If you need a cryptocurrency wallet anyway, this could be an option to consider for security key functionality as well.
</div>
The [comparison table](https://nitrokey.com/products/nitrokeys#:~:text=The%20Nitrokey%20Family) shows how the different Nitrokey models compare to each other in terms of features and other specifications. Refer to Nitrokey's [documentation](https://docs.nitrokey.com/nitrokeys/features) for more details about the features available on your Nitrokey.
Even if you don't need a cryptocurrency wallet, using Ledger devices as security keys has three key advantages over YubiKey you may wish to consider:
Nitrokey models can be configured using the [Nitrokey app](https://nitrokey.com/download).
1. **Secure PIN authentication.**
<div class="admonition warning" markdown>
<p class="admonition-title">Warning</p>
A 4-8 digit PIN is always required to operate Ledger devices. Additionally, that PIN is entered via the display on the device itself. YubiKey PIN authentication, in contrast, is a software prompt where you enter your PIN on the computer/phone you're using.
Starting with Nitrokey 3, HOTP and TOTP secrets are additionally encrypted at rest. Older Nitrokey devices like Nitrokey Pro 2 and Nitrokey Storage 2 did not encrypt OTP secrets at rest, which makes the OTP secrets on these devices potentially vulnerable to physical attacks.
2. **Firmware updates.**
Both the operating system firmware and the Security Key app software can be updated via the Ledger Wallet app if new security improvements are released.
3. **Backups and sync.**
When setting up your Ledger device you will create a 24-word "seed phrase." Your security key credentials are tied to this seed phrase, meaning that if you lose/break your Ledger device, you can use the same 24-word phrase to set up a new Ledger device, and it will work with your existing accounts.
You can also use the same 24-word phrase to set up multiple Ledger devices simultaneously, and all of them will work with your accounts in a "synced" fashion, instead of needing to register each security key individually.
Some may consider the last two features to be downsides. Firmware updates can add additional attack surface and introduce new bugs at a later time. However, it is worth noting that many non-updatable security keys from various vendors have been recalled due to discovered security flaws which could not be patched. Backups can also be dangerous if your seed phrase is not properly secured, because it could be used by an attacker to create a duplicate security key if it is leaked.
Note that while all of Ledger's current products technically meet our criteria *for security keys*, the Ledger Nano X does **not** meet our separate [criteria for hardware wallets](hardware-wallets.md#criteria) because it uses an older secure element not certified to the same level as their other products. The Ledger Nano X has no advantages over any of their other devices for security key purposes, so we would not recommend purchasing one.
## Google Titan Security Key
<div class="admonition recommendation" markdown>
Google Titan Security Keys are Yubico-manufactured FIDO2 USB/NFC keys very similar to the [Yubico Security Key](#yubico-security-key) lineup. However, Titan security keys use a different secure element than Yubico's, and they run firmware created by Google. There are generally no functional differences between the two options.
</div>
@@ -113,17 +121,15 @@ Starting with Nitrokey 3, HOTP and TOTP secrets are additionally encrypted at re
### Minimum Requirements
- Must use high-quality, tamper-resistant hardware security modules.
- Must support the latest FIDO2 specification.
- Must not allow private key extraction.
- Devices which cost over $35 must support handling OpenPGP and S/MIME.
- Must be [certified](https://fidoalliance.org/certification/fido-certified-products/) by FIDO Alliance for the FIDO2 specification.
- Must have USB-C and NFC connectivity options in product line.
### Best-Case
Our best-case criteria represents what we would like to see from the perfect project in this category. Our recommendations may not include any or all of this functionality, but those which do may rank higher than others on this page.
- Should be available in USB-C form factor.
- Should be available with NFC.
- Should support TOTP secret storage.
- Should support secure firmware updates.
[^1]: Some governments or other organizations may require a key with Level 2 certification, but most people do not have to worry about this distinction.
[^2]: The firmware of Yubico's Security Keys is not updatable. If you want features in newer firmware versions, or if there is a vulnerability in the firmware version you are using, you would need to purchase a new key.
+12 -2
View File
@@ -603,13 +603,23 @@ For encrypting your OS drive, we typically recommend using the encryption tool y
## Hardware
### Hardware Wallets
<div class="grid cards" markdown>
- [Ledger](hardware-wallets.md#ledger-nano-gen-5)
- [Trezor](hardware-wallets.md#trezor-safe-7)
</div>
### Security Keys
<div class="grid cards" markdown>
- ![Yubico logo](assets/img/security-keys/mini/yubico.svg){ .twemoji loading=lazy } [Yubico Security Key](security-keys.md#yubico-security-key)
- ![Yubico logo](assets/img/security-keys/mini/yubico.svg){ .twemoji loading=lazy } [YubiKey](security-keys.md#yubikey)
- ![Nitrokey](assets/img/security-keys/mini/nitrokey.svg){ .twemoji loading=lazy } [Nitrokey](security-keys.md#nitrokey)
- ![Yubico logo](assets/img/security-keys/mini/yubico.svg){ .twemoji loading=lazy } [YubiKey](security-keys.md#yubikey-5)
- [Ledger](security-keys.md#ledger)
- [Google Titan Security Key](security-keys.md#google-titan-security-key)
</div>
+170 -143
View File
@@ -18,25 +18,25 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
docs_dir: !ENV [ BUILD_DOCS_DIR, "docs" ]
site_url: !ENV [ BUILD_SITE_URL, "https://www.privacyguides.org/en/" ]
site_dir: !ENV [ BUILD_SITE_DIR, "site/en" ]
docs_dir: !ENV [BUILD_DOCS_DIR, "docs"]
site_url: !ENV [BUILD_SITE_URL, "https://www.privacyguides.org/en/"]
site_dir: !ENV [BUILD_SITE_DIR, "site/en"]
site_name: Privacy Guides
site_description:
!ENV [
site_description: !ENV [
SITE_DESCRIPTION,
"Privacy Guides is your central privacy and security resource to protect
yourself online.",
yourself online.",
]
edit_uri_template: !ENV [ BUILD_EDIT_URI_TEMPLATE, "blob/main/docs/{path}?plain=1" ]
edit_uri_template:
!ENV [BUILD_EDIT_URI_TEMPLATE, "blob/main/docs/{path}?plain=1"]
extra:
scope: /
homepage: /
generator: false
context: !ENV [ BUILD_CONTEXT, "production" ]
offline: !ENV [ BUILD_OFFLINE, false ]
context: !ENV [BUILD_CONTEXT, "production"]
offline: !ENV [BUILD_OFFLINE, false]
deploy: !ENV DEPLOY_ID
ghost:
base_url: https://www.privacyguides.org
@@ -45,99 +45,124 @@ extra:
content_api_key: da9d77deb3e85ee73925167f3a
privacy_guides:
footer:
intro:
!ENV [
intro: !ENV [
FOOTER_INTRO,
"Privacy Guides is a non-profit, socially motivated website that provides
information for protecting your data security and privacy.",
information for protecting your data security and privacy.",
]
note:
!ENV [
note: !ENV [
FOOTER_NOTE,
"We do not make money from recommending certain products, and we do not use
affiliate links.",
affiliate links.",
]
copyright:
author: !ENV [ FOOTER_COPYRIGHT_AUTHOR, "Privacy Guides and contributors." ]
date: !ENV [ FOOTER_COPYRIGHT_DATE, "2019-2025" ]
author:
!ENV [FOOTER_COPYRIGHT_AUTHOR, "Privacy Guides and contributors."]
date: !ENV [FOOTER_COPYRIGHT_DATE, "2019-2025"]
license:
- fontawesome/brands/creative-commons
- fontawesome/brands/creative-commons-by
- fontawesome/brands/creative-commons-sa
links:
- name: !ENV [ FOOTER_PRIVACY_NOTICE, "Privacy notice." ]
- name: !ENV [FOOTER_PRIVACY_NOTICE, "Privacy notice."]
url: https://www.privacyguides.org/en/privacy/
homepage:
description:
!ENV [
description: !ENV [
HOMEPAGE_DESCRIPTION,
"A socially motivated website which provides information about protecting
your online data privacy and security.",
your online data privacy and security.",
]
hero:
header: !ENV [ HOMEPAGE_HEADER, "The guide to restoring your online privacy." ]
subheader:
!ENV [
header:
!ENV [HOMEPAGE_HEADER, "The guide to restoring your online privacy."]
subheader: !ENV [
HOMEPAGE_SUBHEADER,
"Massive organizations are monitoring your online activities. Privacy
Guides is your central privacy and security resource to protect
yourself online.",
Guides is your central privacy and security resource to protect
yourself online.",
]
buttons:
- name: !ENV [ HOMEPAGE_BUTTON_GET_STARTED_NAME, "Start Your Privacy Journey" ]
title: !ENV [ HOMEPAGE_BUTTON_GET_STARTED_TITLE, "The first step of your privacy journey" ]
link: !ENV [ HOMEPAGE_BUTTON_GET_STARTED_LINK, "basics/why-privacy-matters/" ]
- name:
!ENV [
HOMEPAGE_BUTTON_GET_STARTED_NAME,
"Start Your Privacy Journey",
]
title:
!ENV [
HOMEPAGE_BUTTON_GET_STARTED_TITLE,
"The first step of your privacy journey",
]
link:
!ENV [
HOMEPAGE_BUTTON_GET_STARTED_LINK,
"basics/why-privacy-matters/",
]
class: md-button md-button--primary
- name: !ENV [ HOMEPAGE_BUTTON_TOOLS_NAME, "Recommended Tools" ]
- name: !ENV [HOMEPAGE_BUTTON_TOOLS_NAME, "Recommended Tools"]
title:
!ENV [
HOMEPAGE_BUTTON_TOOLS_TITLE,
"Recommended privacy tools, services, and knowledge",
]
link: !ENV [ HOMEPAGE_BUTTON_TOOLS_LINK, "tools/" ]
link: !ENV [HOMEPAGE_BUTTON_TOOLS_LINK, "tools/"]
class: md-button
cta:
- title: !ENV [ HOMEPAGE_CTA_TITLE, "We need you! Here's how to get involved:" ]
- title:
!ENV [
HOMEPAGE_CTA_TITLE,
"We need you! Here's how to get involved:",
]
links:
- icon: simple/discourse
name: !ENV [ HOMEPAGE_CTA_FORUM_NAME, "Join the forum" ]
name: !ENV [HOMEPAGE_CTA_FORUM_NAME, "Join the forum"]
link: https://discuss.privacyguides.net/
- icon: simple/mastodon
name: !ENV [ HOMEPAGE_CTA_MASTODON_NAME, "Follow us on Mastodon" ]
name: !ENV [HOMEPAGE_CTA_MASTODON_NAME, "Follow us on Mastodon"]
link: https://mastodon.neat.computer/@privacyguides
- icon: simple/github
name: !ENV [ HOMEPAGE_CTA_GITHUB_NAME, "Contribute on GitHub" ]
name: !ENV [HOMEPAGE_CTA_GITHUB_NAME, "Contribute on GitHub"]
link: https://github.com/privacyguides/privacyguides.org
- icon: material/translate
name: !ENV [ HOMEPAGE_CTA_TRANSLATE_NAME, "Help translate" ]
name: !ENV [HOMEPAGE_CTA_TRANSLATE_NAME, "Help translate"]
link: https://crowdin.com/project/privacyguides
- icon: simple/matrix
name: !ENV [ HOMEPAGE_CTA_MATRIX_NAME, "Join the Matrix chat" ]
name: !ENV [HOMEPAGE_CTA_MATRIX_NAME, "Join the Matrix chat"]
link: https://matrix.to/#/#privacyguides:matrix.org
- icon: material/information-outline
name: !ENV [ HOMEPAGE_CTA_ABOUT_NAME, "Learn more about us" ]
link: !ENV [ HOMEPAGE_CTA_ABOUT_LINK, "about/" ]
name: !ENV [HOMEPAGE_CTA_ABOUT_NAME, "Learn more about us"]
link: !ENV [HOMEPAGE_CTA_ABOUT_LINK, "about/"]
- icon: material/hand-coin
name: !ENV [ HOMEPAGE_CTA_DONATE_NAME, "Donate to Privacy Guides" ]
link: !ENV [ HOMEPAGE_CTA_DONATE_LINK, "about/donate/" ]
description:
!ENV [
name: !ENV [HOMEPAGE_CTA_DONATE_NAME, "Donate to Privacy Guides"]
link: !ENV [HOMEPAGE_CTA_DONATE_LINK, "about/donate/"]
description: !ENV [
HOMEPAGE_CTA_DESCRIPTION,
"If you spot an error, think a provider should not be listed, notice a
qualified provider is missing, believe a browser plugin is no
longer the best choice, or uncover any other issue, please let
us know.",
qualified provider is missing, believe a browser plugin is no
longer the best choice, or uncover any other issue, please let
us know.",
]
rss:
- title: !ENV [ HOMEPAGE_RSS_BLOG_TITLE, "Privacy Guides blog feed" ]
- title: !ENV [HOMEPAGE_RSS_BLOG_TITLE, "Privacy Guides blog feed"]
link:
!ENV [
HOMEPAGE_RSS_BLOG_LINK,
"https://www.privacyguides.org/articles/feed_rss_created.xml",
]
- title: !ENV [ HOMEPAGE_RSS_FORUM_TITLE, "Latest Privacy Guides forum topics" ]
link: !ENV [ HOMEPAGE_RSS_FORUM_LINK, "https://discuss.privacyguides.net/latest.rss" ]
- title: !ENV [ HOMEPAGE_RSS_CHANGELOG_TITLE, "Privacy Guides release changelog" ]
- title:
!ENV [
HOMEPAGE_RSS_FORUM_TITLE,
"Latest Privacy Guides forum topics",
]
link:
!ENV [
HOMEPAGE_RSS_FORUM_LINK,
"https://discuss.privacyguides.net/latest.rss",
]
- title:
!ENV [
HOMEPAGE_RSS_CHANGELOG_TITLE,
"Privacy Guides release changelog",
]
link:
!ENV [
HOMEPAGE_RSS_CHANGELOG_LINK,
@@ -145,29 +170,29 @@ extra:
]
translation_notice:
notice: !ENV TRANSLATION_NOTICE
cta: !ENV [ TRANSLATION_NOTICE_CTA, "Visit Crowdin" ]
cta: !ENV [TRANSLATION_NOTICE_CTA, "Visit Crowdin"]
language: !ENV SITE_LANGUAGE_ENGLISH
translation_stylesheet: !ENV [ TRANSLATION_STYLESHEET ]
translation_stylesheet: !ENV [TRANSLATION_STYLESHEET]
social:
- icon: simple/mastodon
link: https://mastodon.neat.computer/@privacyguides
name: !ENV [ SOCIAL_MASTODON, "Mastodon" ]
name: !ENV [SOCIAL_MASTODON, "Mastodon"]
- icon: simple/peertube
link: https://neat.tube/c/privacyguides
name: !ENV [ SOCIAL_PEERTUBE, "PeerTube" ]
name: !ENV [SOCIAL_PEERTUBE, "PeerTube"]
- icon: simple/matrix
link: https://matrix.to/#/#privacyguides:matrix.org
name: !ENV [ SOCIAL_MATRIX, "Matrix" ]
name: !ENV [SOCIAL_MATRIX, "Matrix"]
- icon: simple/discourse
link: https://discuss.privacyguides.net/
name: !ENV [ SOCIAL_FORUM, "Forum" ]
name: !ENV [SOCIAL_FORUM, "Forum"]
- icon: simple/github
link: https://github.com/privacyguides
name: !ENV [ SOCIAL_GITHUB, "GitHub" ]
name: !ENV [SOCIAL_GITHUB, "GitHub"]
- icon: simple/torbrowser
link: http://www.xoe4vn5uwdztif6goazfbmogh6wh5jc4up35bqdflu6bkdc5cas5vjqd.onion/
name: !ENV [ SOCIAL_TOR_SITE, "Hidden service" ]
language_switcher: !ENV [ LANGUAGE_SWITCHER, true ]
name: !ENV [SOCIAL_TOR_SITE, "Hidden service"]
language_switcher: !ENV [LANGUAGE_SWITCHER, true]
alternate:
- name: English
link: /en/
@@ -207,46 +232,53 @@ extra:
icon: https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f1f7-1f1fa.svg
analytics:
feedback:
title: !ENV [ ANALYTICS_FEEDBACK_TITLE, "Was this page helpful?" ]
title: !ENV [ANALYTICS_FEEDBACK_TITLE, "Was this page helpful?"]
ratings:
- icon: material/emoticon-happy-outline
name: !ENV [ ANALYTICS_FEEDBACK_POSITIVE_NAME, "This page was helpful" ]
name: !ENV [ANALYTICS_FEEDBACK_POSITIVE_NAME, "This page was helpful"]
data: 1
note: !ENV [ ANALYTICS_FEEDBACK_POSITIVE_NOTE, "Thanks for your feedback!" ]
note:
!ENV [ANALYTICS_FEEDBACK_POSITIVE_NOTE, "Thanks for your feedback!"]
- icon: material/emoticon-sad-outline
name: !ENV [ ANALYTICS_FEEDBACK_NEGATIVE_NAME, "This page could be improved" ]
name:
!ENV [
ANALYTICS_FEEDBACK_NEGATIVE_NAME,
"This page could be improved",
]
data: 0
note: !ENV [ ANALYTICS_FEEDBACK_NEGATIVE_NOTE, "Thanks for your feedback!" ]
note:
!ENV [ANALYTICS_FEEDBACK_NEGATIVE_NOTE, "Thanks for your feedback!"]
repo_url: !ENV [ BUILD_REPO_URL, "https://github.com/privacyguides/privacyguides.org" ]
repo_url:
!ENV [BUILD_REPO_URL, "https://github.com/privacyguides/privacyguides.org"]
repo_name: ""
theme:
name: material
language: !ENV [ BUILD_THEME_LANGUAGE, "en" ]
language: !ENV [BUILD_THEME_LANGUAGE, "en"]
custom_dir: theme
font:
text: !ENV [ BUILD_THEME_FONT_TEXT, "Public Sans" ]
code: !ENV [ BUILD_THEME_FONT_CODE, "DM Mono" ]
text: !ENV [BUILD_THEME_FONT_TEXT, "Public Sans"]
code: !ENV [BUILD_THEME_FONT_CODE, "DM Mono"]
palette:
- media: "(prefers-color-scheme)"
scheme: default
accent: deep purple
toggle:
icon: material/brightness-auto
name: !ENV [ THEME_DARK, "Switch to dark mode" ]
name: !ENV [THEME_DARK, "Switch to dark mode"]
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: amber
toggle:
icon: material/brightness-2
name: !ENV [ THEME_LIGHT, "Switch to light mode" ]
name: !ENV [THEME_LIGHT, "Switch to light mode"]
- media: "(prefers-color-scheme: light)"
scheme: default
accent: deep purple
toggle:
icon: material/brightness-5
name: !ENV [ THEME_AUTO, "Switch to system theme" ]
name: !ENV [THEME_AUTO, "Switch to system theme"]
favicon: assets/brand/logos/png/favicon-32x32.png
icon:
repo: simple/github
@@ -278,29 +310,29 @@ plugins:
tags: {}
search: {}
privacy:
enabled: !ENV [ BUILD_PRIVACY, true ]
enabled: !ENV [BUILD_PRIVACY, true]
offline:
enabled: !ENV [ BUILD_OFFLINE, false ]
enabled: !ENV [BUILD_OFFLINE, false]
group:
enabled: !ENV [ BUILD_INSIDERS, false ]
enabled: !ENV [BUILD_INSIDERS, false]
plugins:
macros: {}
meta: {}
git-authors:
enabled: !ENV [ GITAUTHORS, PRODUCTION, NETLIFY, false ]
enabled: !ENV [GITAUTHORS, PRODUCTION, NETLIFY, false]
sort_authors_by: contribution
show_contribution: true
fallback_to_empty: true
authorship_threshold_percent: 1
git-revision-date-localized:
enabled: !ENV [ GITREVISIONDATE, PRODUCTION, NETLIFY, false ]
enabled: !ENV [GITREVISIONDATE, PRODUCTION, NETLIFY, false]
exclude:
- index.md
fallback_to_build_date: true
enable_creation_date: true
typeset: {}
social:
cards: !ENV [ CARDS, true ]
cards: !ENV [CARDS, true]
cards_dir: assets/img/social
cards_layout_dir: theme/layouts
cards_layout: page
@@ -313,7 +345,7 @@ markdown_extensions:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.tabbed:
alternate_style: true
pymdownx.arithmatex:
@@ -325,7 +357,7 @@ markdown_extensions:
pymdownx.tilde: {}
pymdownx.snippets:
auto_append:
- !ENV [ BUILD_ABBREVIATIONS, "includes/abbreviations.en.txt" ]
- !ENV [BUILD_ABBREVIATIONS, "includes/abbreviations.en.txt"]
pymdownx.tasklist:
custom_checkbox: true
attr_list: {}
@@ -334,8 +366,8 @@ markdown_extensions:
meta: {}
abbr: {}
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- theme/icons
@@ -345,50 +377,49 @@ markdown_extensions:
toc_depth: 4
nav:
- ? !ENV [ NAV_HOME, "Home" ]
: "index.md"
- ? !ENV [ NAV_KNOWLEDGE_BASE, "Knowledge Base" ]
: - "basics/why-privacy-matters.md"
- !ENV [NAV_HOME, "Home"]: "index.md"
- !ENV [NAV_KNOWLEDGE_BASE, "Knowledge Base"]:
- "basics/why-privacy-matters.md"
- "basics/threat-modeling.md"
- "basics/common-threats.md"
- "basics/common-misconceptions.md"
- "basics/account-creation.md"
- "basics/account-deletion.md"
- ? !ENV [ NAV_TECHNOLOGY_ESSENTIALS, "Technology Essentials" ]
: - "basics/passwords-overview.md"
- !ENV [NAV_TECHNOLOGY_ESSENTIALS, "Technology Essentials"]:
- "basics/passwords-overview.md"
- "basics/multi-factor-authentication.md"
- "basics/hardware.md"
- "basics/email-security.md"
- "basics/vpn-overview.md"
- ? !ENV [ NAV_ADVANCED_TOPICS, "Advanced Topics" ]
: - "advanced/dns-overview.md"
- !ENV [NAV_ADVANCED_TOPICS, "Advanced Topics"]:
- "advanced/dns-overview.md"
- "advanced/tor-overview.md"
- "advanced/payments.md"
- "advanced/communication-network-types.md"
- ? !ENV [ NAV_OPERATING_SYSTEMS, "Operating Systems" ]
: - "os/index.md"
- !ENV [NAV_OPERATING_SYSTEMS, "Operating Systems"]:
- "os/index.md"
- "os/android-overview.md"
- "os/ios-overview.md"
- "os/linux-overview.md"
- "os/macos-overview.md"
- "os/qubes-overview.md"
- ? !ENV [ NAV_OPERATING_SYSTEMS_WINDOWS, "Windows" ]
: - "os/windows/index.md"
- !ENV [NAV_OPERATING_SYSTEMS_WINDOWS, "Windows"]:
- "os/windows/index.md"
- "os/windows/group-policies.md"
- ? !ENV [ NAV_RECOMMENDATIONS, "Recommendations" ]
: - "tools.md"
- ? !ENV [ NAV_SELF_HOSTING, "Self-Hosting" ]
: - "self-hosting/index.md"
- !ENV [NAV_RECOMMENDATIONS, "Recommendations"]:
- "tools.md"
- !ENV [NAV_SELF_HOSTING, "Self-Hosting"]:
- "self-hosting/index.md"
- "self-hosting/dns-filtering.md"
- "self-hosting/email-servers.md"
- "self-hosting/file-management.md"
- ? !ENV [ NAV_INTERNET_BROWSING, "Internet Browsing" ]
: - "tor.md"
- !ENV [NAV_INTERNET_BROWSING, "Internet Browsing"]:
- "tor.md"
- "desktop-browsers.md"
- "mobile-browsers.md"
- "browser-extensions.md"
- ? !ENV [ NAV_PROVIDERS, "Providers" ]
: - "cloud.md"
- !ENV [NAV_PROVIDERS, "Providers"]:
- "cloud.md"
- "data-broker-removals.md"
- "dns.md"
- "email-aliasing.md"
@@ -397,8 +428,8 @@ nav:
- "photo-management.md"
- "search-engines.md"
- "vpn.md"
- ? !ENV [ NAV_SOFTWARE, "Software" ]
: - "ai-chat.md"
- !ENV [NAV_SOFTWARE, "Software"]:
- "ai-chat.md"
- "calendar.md"
- "cryptocurrency.md"
- "data-redaction.md"
@@ -418,24 +449,25 @@ nav:
- "pastebins.md"
- "real-time-communication.md"
- "social-networks.md"
- ? !ENV [ NAV_HARDWARE, "Hardware" ]
: - "mobile-phones.md"
- !ENV [NAV_HARDWARE, "Hardware"]:
- "hardware-wallets.md"
- "mobile-phones.md"
- "security-keys.md"
- ? !ENV [ NAV_OPERATING_SYSTEMS, "Operating Systems" ]
: - ? !ENV [ NAV_ANDROID, "Android" ]
: - "android/index.md"
- !ENV [NAV_OPERATING_SYSTEMS, "Operating Systems"]:
- !ENV [NAV_ANDROID, "Android"]:
- "android/index.md"
- "android/distributions.md"
- "android/general-apps.md"
- "android/obtaining-apps.md"
- "desktop.md"
- "router.md"
- ? !ENV [ NAV_ADVANCED, "Advanced" ]
: - "alternative-networks.md"
- !ENV [NAV_ADVANCED, "Advanced"]:
- "alternative-networks.md"
- "device-integrity.md"
- ? !ENV [ NAV_ACTIVISM, "Activism" ]
: - "activism/index.md"
- ? !ENV [ NAV_ACTIVISM_TOOLBOX, "Activist Toolbox" ]
: - "activism/toolbox/index.md"
- !ENV [NAV_ACTIVISM, "Activism"]:
- "activism/index.md"
- !ENV [NAV_ACTIVISM_TOOLBOX, "Activist Toolbox"]:
- "activism/toolbox/index.md"
- "Check Your Laws":
- "activism/toolbox/tip-know-your-privacy-laws.md"
- "activism/toolbox/tip-report-privacy-violations.md"
@@ -472,48 +504,43 @@ nav:
- "Take Action!":
- "activism/toolbox/tip-engage-boosts-and-contribute.md"
- "activism/toolbox/tip-level-up-assemble-and-organize.md"
- ? !ENV [ NAV_ACTIVISM_LEGAL, "Legal Resources" ]
: - "activism/legal/dpa-directory.md"
- ? !ENV [ NAV_BLOG, "Articles" ]
: !ENV [ ARTICLES_SITE_BASE_URL, "/articles/" ]
- ? !ENV [ NAV_VIDEOS, "Videos" ]
: !ENV [ VIDEOS_SITE_BASE_URL, "/videos/" ]
- ? !ENV [ NAV_NEWS, "News" ]
: !ENV [ NEWS_SITE_BASE_URL, "/news/" ]
- ? !ENV [ NAV_FORUM, "Forum" ]
: !ENV [ NAV_FORUM_LINK, "https://discuss.privacyguides.net/" ]
- ? !ENV [ NAV_WIKI, "Wiki" ]
: !ENV [
- !ENV [NAV_ACTIVISM_LEGAL, "Legal Resources"]:
- "activism/legal/dpa-directory.md"
- !ENV [NAV_BLOG, "Articles"]: !ENV [ARTICLES_SITE_BASE_URL, "/articles/"]
- !ENV [NAV_VIDEOS, "Videos"]: !ENV [VIDEOS_SITE_BASE_URL, "/videos/"]
- !ENV [NAV_NEWS, "News"]: !ENV [NEWS_SITE_BASE_URL, "/news/"]
- !ENV [NAV_FORUM, "Forum"]:
!ENV [NAV_FORUM_LINK, "https://discuss.privacyguides.net/"]
- !ENV [NAV_WIKI, "Wiki"]:
!ENV [
NAV_WIKI_LINK,
"https://discuss.privacyguides.net/c/community-wiki/9411/none",
]
- ? !ENV [ NAV_ABOUT, "About" ]
: - "about.md"
- !ENV [NAV_ABOUT, "About"]:
- "about.md"
- "about/donate.md"
- ? !ENV [ NAV_ABOUT_TEAM_MEMBERS, "Team Members" ]
: https://discuss.privacyguides.net/u?group=team&order=solutions&period=all
- ? !ENV [ NAV_ABOUT_POLICIES, "Policies" ]
: - "about/criteria.md"
- !ENV [NAV_ABOUT_TEAM_MEMBERS, "Team Members"]:
https://discuss.privacyguides.net/u?group=team&order=solutions&period=all
- !ENV [NAV_ABOUT_POLICIES, "Policies"]:
- "about/criteria.md"
- "about/donation-acceptance-policy.md"
- "about/executive-policy.md"
- "privacy.md"
- "about/notices.md"
- ? !ENV [ NAV_COMMUNITY, "Community" ]
: - "about/jobs.md"
- !ENV [NAV_COMMUNITY, "Community"]:
- "about/jobs.md"
- "about/contributors.md"
- ? !ENV [ NAV_ONLINE_SERVICES, "Online Services" ]
: "about/services.md"
- ? !ENV [ NAV_CODE_OF_CONDUCT, "Code of Conduct" ]
: "CODE_OF_CONDUCT.md"
- !ENV [NAV_ONLINE_SERVICES, "Online Services"]: "about/services.md"
- !ENV [NAV_CODE_OF_CONDUCT, "Code of Conduct"]: "CODE_OF_CONDUCT.md"
- "about/statistics.md"
- ? !ENV [ NAV_CONTRIBUTING, "Contributing" ]
: - ? !ENV [ NAV_WRITING_GUIDE, "Writing Guide" ]
: - "meta/writing-style.md"
- !ENV [NAV_CONTRIBUTING, "Contributing"]:
- !ENV [NAV_WRITING_GUIDE, "Writing Guide"]:
- "meta/writing-style.md"
- "meta/admonitions.md"
- "meta/brand.md"
- "meta/translations.md"
- ? !ENV [ NAV_TECHNICAL_GUIDES, "Technical Guides" ]
: - "meta/uploading-images.md"
- !ENV [NAV_TECHNICAL_GUIDES, "Technical Guides"]:
- "meta/uploading-images.md"
- "meta/git-recommendations.md"
- "meta/commit-messages.md"
- "meta/pr-comments.md"