Thunderbird:OpenPGP: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (typo fixes)
(→‎OpenPGP log: updating logging for tb126+)
 
(14 intermediate revisions by 3 users not shown)
Line 4: Line 4:


== Background ==
== Background ==
Previously, until Thunderbird version 68.x, the Enigmail Add-On provided OpenPGP encrypted messaging, which required the use of external GnuPG software.
Prior to Thunderbird version 78.x, the Enigmail Add-On provided OpenPGP encrypted messaging, which required the use of external GnuPG software.


Soon, Thunderbird will include OpenPGP functionality, and will no longer require the installation of external software.
Thunderbird 78 includes OpenPGP functionality, and no longer requires the installation of external software.


This improvement is necessary, because Enigmail cannot be used with Thunderbird 78, except for key migration purposes.
This improvement is necessary, because Enigmail cannot be used with Thunderbird 78, except to facilitate the migration of existing keys.


If you are a previous user of Enigmail, please read [[Thunderbird:OpenPGP:Migration-From-Enigmail | How does Thunderbird's OpenPGP implementation differ from Enigmail?]]
If you are a previous user of Enigmail, please read [[Thunderbird:OpenPGP:Migration-From-Enigmail | How does Thunderbird's OpenPGP implementation differ from Enigmail?]]


== Development Status ==
== HOWTO and FAQ ==


As of the Thunderbird 78.0 release, the OpenPGP functionality is experimental, and disabled by default.
See Mozilla's support [https://support.mozilla.org/en-US/kb/openpgp-thunderbird-howto-and-faq OpenPGP in Thunderbird - HOWTO and FAQ] knowledge base article.


'''[https://mail.mozilla.org/pipermail/tb-planning/2020-May/007627.html It is hoped to be stable in 78.2] - until then Enigmail users should not attempt to update to 78 until an automatic update occurs.''' 
== Development Status ==


See also our [https://blog.thunderbird.net/2019/10/thunderbird-enigmail-and-openpgp/ initial announcement] and the [[Thunderbird:OpenPGP:2020 | detailed description from October 2019]].
* Thunderbird 78.0 release - OpenPGP functionality is experimental, and disabled by default.
* <strike>'''[https://mail.mozilla.org/pipermail/tb-planning/2020-May/007627.html It is hoped to be stable in 78.2] - until then Enigmail users should not attempt to update to 78 until an automatic update occurs.'''</strike> 
* Thunderbird 78.2.1 release, August 29, 2020 - OpenPGP is enabled by default (mail.openpgp.enable=true), and the enigmail add-on changed to migrate users to OpenPGP https://www.thunderbird.net/en-US/thunderbird/78.2.1/releasenotes/
** See also our [https://blog.thunderbird.net/2019/10/thunderbird-enigmail-and-openpgp/ initial announcement] and the [[Thunderbird:OpenPGP:2020 | detailed description from October 2019]].
* Post Thunderbird 78.3 - fixes and improvements
** Experimental support for [[Thunderbird:OpenPGP:Smartcards | smartcard secret key operations]] (no public key operations) is under development.


See the tb-planning list archive for [https://mail.mozilla.org/pipermail/tb-planning/2019-December/thread.html answers to some commonly asked questions].
See the tb-planning list archive for [https://mail.mozilla.org/pipermail/tb-planning/2019-December/thread.html answers to some commonly asked questions].


A [https://www.youtube.com/watch?v=zwmPwcC2Ie4 presentation] was given about the development of integrated OpenPGP support as part of the [[Thunderbird/2020_Virtual_Summit | Thunderbird Virtual Summit 2020]].
A [https://www.youtube.com/watch?v=zwmPwcC2Ie4 presentation] was given about the development of integrated OpenPGP support as part of the [[Thunderbird/2020_Virtual_Summit | Thunderbird Virtual Summit 2020]].
== Testing ==
'''If you use OpenPGP for non-critical purposes''', then you are welcome to enable it manually and help with testing.
To enable it in Thunderbird 78.0, use the config editor and change the value of preference '''mail.openpgp.enable''' to true, then restart Thunderbird.
If you are running 78.x and have the previous Enigmail Add-on installed, then Enigmail will update to version 2.2.x, which is a minimal release that helps you to migrate the keys and settings to Thunderbird 78.
If you haven't used Enigmail previously, you can enable OpenPGP for an email account in account settings.
If you want to help with testing see the [[#Discussion|discussion area]] below.


== Discussion ==
== Discussion ==
Line 54: Line 47:
If you run into a problem, you may try the following mechanisms to obtain additional information, which may be useful for you, or for the Thunderbird developers when reporting a problem, to analyze the cause.
If you run into a problem, you may try the following mechanisms to obtain additional information, which may be useful for you, or for the Thunderbird developers when reporting a problem, to analyze the cause.


The simplest is to open the Thunderbird Error Console. You can open it from the menu, Tools, Developer Tools, Error Console. Messages shown in red are of particular interest.
=== Error Console ===
The simplest is to open the Thunderbird Error Console. You can open it from the menu Tools→Developer Tools→Error Console. Messages shown in red are of particular interest.
 
=== OpenPGP log ===
 
==== Thunderbird version 126 and up ====
 
To view more logging about OpenPGP related processing
 
* Open Settings > General and search for about:config (Config Editor)
* Use the search box on top to find the <code>openpgp.loglevel</code> preference and set it to the desired level. Use <code>All</code> for maximal verbosity. The default is <code>Warn</code> which will log only errors and warnings.
 
It is not necessary to restart Thunderbird - logging starts immediately.
 
You can view the output at Tools > Developer > Error Console (Ctrl+Shift+J).
To expose timestamps, click the gear icon in top-right of the Error Console, turn on "Show Timestamps".
 
Logs are also available on native console.
 
 
==== Thunderbird version 125 and below ====
 
To view some details about the processing of messages, you may set a preference in Thunderbird:
 
* Open menu Edit→Preferences→General, find the Config Editor.
* Add a new preference of the name <code>temp.openpgp.logDirectory</code> and set it to a string value, which must be the full name of a temporary directory, for example on Linux or macOS you could use value <code>/tmp/</code>.
* Restart Thunderbird.
* Thunderbird will write messages to a file named <code>enigdbug.txt</code> in the set directory.
The log will have a lot of information, most of which is harmless or not interesting. But it may contain clues about the cause of a problem.
 
=== Enigmail 2.2.x Add-on log ===
If you're trying to analyze a problem in the migration process that is performed by the Enigmail 2.2.x Add-on, please set the additional preference <code>extensions.enigmail.logDirectory</code> - it must also be set to a directory, but that must be a different directory than the one for OpenPGP log. For example, create a directory named <code>/tmp/enig22</code> and set <code>extensions.enigmail.logDirectory</code> to string value <code>/tmp/enig22</code>. If you set both variables, then two separate debug log files will be created, both named <code>enigdbug.txt</code>.
 
=== RNP log ===
Advanced users may attempt to view internal error messages produced by the OpenPGP cryptographic engine that Thunderbird uses (the RNP library). To do so:
* Set the environment variable called <code>RNP_LOG_CONSOLE</code>, e.g. in a Linux terminal you could do that using the command <code>export RNP_LOG_CONSOLE=1</code>.
* Then you must start Thunderbird from within that terminal window, to ensure that it will see the environment variable that you have set.
 
== Testing ==
 
If you are running 78.x and have the previous Enigmail Add-on installed, then Enigmail will update to version 2.2.x, which is a minimal release that helps you to migrate the keys and settings to Thunderbird 78.
 
If you haven't used Enigmail previously, you can enable OpenPGP for an email account in account settings.


To view some details about the processing of messages, you may set a preference in Thunderbird. Open preferences, general, find the config editor. Add a new preference of the name temp.openpgp.logDirectory and set it to a string value, which must be the full name of a temporary directory, for example on Linux or macOS you could use value /tmp/ . Once set, Thunderbird will write messages to a file named enigdbug.txt in that directory. The log will have a lot of information, most of which is harmless or not interesting. But it may contain clues about the cause of a problem.
If you want to help with testing see the [[#Discussion|discussion area]] below.


Advanced users may attempt to view internal error messages produced by the OpenPGP cryptographic engine that Thunderbird uses (the RNP library). To do so, you need to set the environment variable called RNP_LOG_CONSOLE, e.g. in a Linux terminal you could do that using the command export RNP_LOG_CONSOLE=1. Then you must start Thunderbird from within that terminal window, to ensure that it will see the environment variable that you have set.
For advanced users: [[Thunderbird:OpenPGP:Test-Builds | testing experimental builds]].


[[category:Thunderbird|*]]
[[category:Thunderbird|*]]
[[Category:Thunderbird_OpenPGP]]

Latest revision as of 11:26, 16 April 2024

Thunderbird and OpenPGP

This page lists resources, discussion venues, and plans related to OpenPGP messaging with Thunderbird.

Background

Prior to Thunderbird version 78.x, the Enigmail Add-On provided OpenPGP encrypted messaging, which required the use of external GnuPG software.

Thunderbird 78 includes OpenPGP functionality, and no longer requires the installation of external software.

This improvement is necessary, because Enigmail cannot be used with Thunderbird 78, except to facilitate the migration of existing keys.

If you are a previous user of Enigmail, please read How does Thunderbird's OpenPGP implementation differ from Enigmail?

HOWTO and FAQ

See Mozilla's support OpenPGP in Thunderbird - HOWTO and FAQ knowledge base article.

Development Status

See the tb-planning list archive for answers to some commonly asked questions.

A presentation was given about the development of integrated OpenPGP support as part of the Thunderbird Virtual Summit 2020.

Discussion

To help with testing, or for help in using Thunderbird's OpenPGP, please post in e2ee topicbox. Or chat at Matrix: #openpgp:mozilla.org

Please report bugs at Bugzilla, product MailNews Core, component Security: OpenPGP. (You need to register an account to access that link.)

To discuss policy aspects of Thunderbird's OpenPGP, please post to the public tb-planning mailing list.

Open issues and TODO list

The best way to see our progress and open issues is run a bugzilla query.

In addition, we have a high level overview of items that have already been worked on, and which are still ToDo (might be outdated).

Debugging / Tracing

If you run into a problem, you may try the following mechanisms to obtain additional information, which may be useful for you, or for the Thunderbird developers when reporting a problem, to analyze the cause.

Error Console

The simplest is to open the Thunderbird Error Console. You can open it from the menu Tools→Developer Tools→Error Console. Messages shown in red are of particular interest.

OpenPGP log

Thunderbird version 126 and up

To view more logging about OpenPGP related processing

  • Open Settings > General and search for about:config (Config Editor)
  • Use the search box on top to find the openpgp.loglevel preference and set it to the desired level. Use All for maximal verbosity. The default is Warn which will log only errors and warnings.

It is not necessary to restart Thunderbird - logging starts immediately.

You can view the output at Tools > Developer > Error Console (Ctrl+Shift+J). To expose timestamps, click the gear icon in top-right of the Error Console, turn on "Show Timestamps".

Logs are also available on native console.


Thunderbird version 125 and below

To view some details about the processing of messages, you may set a preference in Thunderbird:

  • Open menu Edit→Preferences→General, find the Config Editor.
  • Add a new preference of the name temp.openpgp.logDirectory and set it to a string value, which must be the full name of a temporary directory, for example on Linux or macOS you could use value /tmp/.
  • Restart Thunderbird.
  • Thunderbird will write messages to a file named enigdbug.txt in the set directory.

The log will have a lot of information, most of which is harmless or not interesting. But it may contain clues about the cause of a problem.

Enigmail 2.2.x Add-on log

If you're trying to analyze a problem in the migration process that is performed by the Enigmail 2.2.x Add-on, please set the additional preference extensions.enigmail.logDirectory - it must also be set to a directory, but that must be a different directory than the one for OpenPGP log. For example, create a directory named /tmp/enig22 and set extensions.enigmail.logDirectory to string value /tmp/enig22. If you set both variables, then two separate debug log files will be created, both named enigdbug.txt.

RNP log

Advanced users may attempt to view internal error messages produced by the OpenPGP cryptographic engine that Thunderbird uses (the RNP library). To do so:

  • Set the environment variable called RNP_LOG_CONSOLE, e.g. in a Linux terminal you could do that using the command export RNP_LOG_CONSOLE=1.
  • Then you must start Thunderbird from within that terminal window, to ensure that it will see the environment variable that you have set.

Testing

If you are running 78.x and have the previous Enigmail Add-on installed, then Enigmail will update to version 2.2.x, which is a minimal release that helps you to migrate the keys and settings to Thunderbird 78.

If you haven't used Enigmail previously, you can enable OpenPGP for an email account in account settings.

If you want to help with testing see the discussion area below.

For advanced users: testing experimental builds.