1814893 - Remove unnecessary informational console log messages from OpenPGP code

Status: VERIFIED FIXED

(MailNews Core :: Security: OpenPGP, defect)

Description

[Kai Engert [:KaiE:]]

We have a few leftover console log/debug statements from OpenPGP development, we should remove everything that isn't related to reporting a failure.

Comment 1

[Kai Engert [:KaiE:]]

In order to remove statements that are purely informational, but keep statements that are useful when diagnosing failures, I suggest:

Use Thunderbird OpenPGP feature, look at the console, and use the logged messages to identify code that can be removed.

Please keep log/debug statements that aren't reached during normal OpenPGP usage.

Comment 2

[Kai Engert [:KaiE:]]

I suggest to keep the following, and move them to debug:

• the otr and rnp and gpgme shared libraries that are loaded. Because we are loading them dynamically, and because they could be loaded from the wrong location, I consider it very very useful to be able to ask users to provide this information to developers in failure scenarios.
• when loading the openpgp secret keyring, we currently print information about how many keys were loaded. We don't need to log that. However, we should continue to log information if any non-encrypted secret keys were found (that's a bad inconsistent state, and users should be able to discover that)

Comment 3

[Magnus Melin [:mkmelin] (away until Aug 10)]

Related to this we should rework EnigmailLog to just use logging like other modules does, so that logging is prefixed and can be set to higher level when needed.

Comment 4

[Magnus Melin [:mkmelin] (away until Aug 10)]

Will have to go through this file by file and clean up.
Much can simply be dropped. The "where am I" statements are not generally useful, but statements on some statuses are.
Production code should not have console.debug. For modules, where debug info is warranted we can add a logger where necessary.

Comment 5

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up PgpMimeHandler.sys.mjs. r=kaie

Comment 6

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - clean up MimeTree.sys.mjs. r=kaie

Comment 7

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - clean up enigmailKeyManager.js. r=kaie

Comment 8

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - clean up enigmailMessengerOverlay.js. r=kaie

Comment 9

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - clean up enigmailMsgHdrViewOverlay.js. r=kaie

Comment 10

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - clean up enigmailMsgComposeOverlay.js. r=kaie

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/8fe166095d3c
Clean up PgpMimeHandler.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/750d169f67ed
clean up MimeTree.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/1b3bdef8542a
clean up enigmailKeyManager.js. r=kaie

Comment 12

[Magnus Melin [:mkmelin] (away until Aug 10)]

Much more to be done here.

Comment 13

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up filters.sys.mjs. r=kaie

Comment 14

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up armor.sys.mjs. r=kaie

Comment 15

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up persistentCrypto.sys.mjs. r=kaie

Comment 16

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up mimeEncrypt.sys.mjs. r=kaie

Comment 17

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up fixExchangeMsg.sys.mjs. r=kaie

Comment 18

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up keyserver.sys.mjs. r=kaie

Comment 19

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up encryption.sys.mjs. r=kaie

Comment 20

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up sqliteDb.sys.mjs. r=kaie

Comment 21

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up core.sys.mjs. r=kaie

Comment 22

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up wkdLookup.sys.mjs. r=kaie

Comment 23

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up decryption.sys.mjs. r=kaie

Comment 24

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up mimeVerify.sys.mjs. r=kaie

Comment 25

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up RNPCryptoAPI.sys.mjs. r=kaie

Comment 26

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up GnuPGCryptoAPI.sys.mjs. r=kaie

Comment 27

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up masterpass.sys.mjs. r=kaie

Comment 28

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up uris.sys.mjs. r=kaie

Comment 29

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up funcs.sys.mjs. r=kaie

Comment 30

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up keyObj.sys.mjs. r=kaie

Comment 31

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up mimeDecrypt.sys.mjs. r=kaie

Comment 32

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up key.sys.mjs. r=kaie

Comment 33

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up keyRing.sys.mjs. r=kaie

Comment 34

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Clean up windows.sys.mjs. r=kaie

This contained mostly junk that was not used.

Comment 35

[Magnus Melin [:mkmelin] (away until Aug 10)]

Attachment: Bug 1814893 - Remove EnigmailLog - log.sys.mjs. r=kaie

Comment 36

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/d4e6d66ec915
clean up enigmailMessengerOverlay.js. r=kaie
https://hg.mozilla.org/comm-central/rev/d4aa74dc993e
clean up enigmailMsgHdrViewOverlay.js. r=kaie
https://hg.mozilla.org/comm-central/rev/66f9d9e76038
clean up enigmailMsgComposeOverlay.js. r=kaie
https://hg.mozilla.org/comm-central/rev/5b696105dc8f
Clean up filters.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/c128b2f2b44f
Clean up armor.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/8555f96335ed
Clean up persistentCrypto.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/acdde191fb28
Clean up mimeEncrypt.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/c10b96ea3e40
Clean up fixExchangeMsg.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/8bed76c89289
Clean up keyserver.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/3433aa6df14e
Clean up encryption.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/4b173ca88133
Clean up sqliteDb.sys.mjs. r=kaie

Comment 37

[Kai Engert [:KaiE:]]

When changing the way logging works, it's necessary to update the documentation at https://wiki.mozilla.org/Thunderbird:OpenPGP

It should say which versions use the old style logging, it should explain how to use the new style logging and in which version the new style logging works.

Comment 38

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/86863b5bcee6
Clean up core.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/9aa17750272e
Clean up wkdLookup.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/b60f8dccecec
Clean up decryption.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/8a025aa44cac
Clean up mimeVerify.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/144df9430204
Clean up RNPCryptoAPI.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/43a9526c42ab
Clean up GnuPGCryptoAPI.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/81dbe861d484
Clean up masterpass.sys.mjs. r=kaie

Comment 39

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/1a49b59f74d2
Clean up uris.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/fe465edf66f1
Clean up funcs.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/bd04b3e29b10
Clean up keyObj.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/b620b01cef24
Clean up mimeDecrypt.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/56cba65c08ef
Clean up key.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/284322e2cdae
Clean up keyRing.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/89298dbdd5d9
Clean up windows.sys.mjs. r=kaie
https://hg.mozilla.org/comm-central/rev/6bb711e3fc88
Remove EnigmailLog - log.sys.mjs. r=kaie

Comment 40

[Magnus Melin [:mkmelin] (away until Aug 10)]

I updated https://wiki.mozilla.org/Thunderbird:OpenPGP#OpenPGP_log "Thunderbird version 126 and up".
Heather, please check if you want to clarify anything there.

We should land the patches from comment 39 on beta as well. After that I can post a message about this change to the e2ee list.

Comment 41

[Magnus Melin [:mkmelin] (away until Aug 10)]

Comment on attachment 9394959 [details]
Bug 1814893 - Clean up uris.sys.mjs. r=kaie

[Approval Request Comment]
User impact if declined: The patches from https://bugzilla.mozilla.org/show_bug.cgi?id=1814893#c39 should land on beta to get a consistent beta logging story.
Testing completed (on c-c, etc.): c-c
Risk to taking this patch (and alternatives if risky): without uplift, there's a mix of old style and new style logging which would be slightly messy.

Comment 42

[Wayne Mery (:wsmwk)]

Comment on attachment 9394959 [details]
Bug 1814893 - Clean up uris.sys.mjs. r=kaie

[Triage Comment]
Approve for beta

User impact if declined: The patches from https://bugzilla.mozilla.org/show_bug.cgi?id=1814893#c39 should land on beta to get a consistent beta logging story.

Comment 43

[Rob Lemley [:rjl]]

Thunderbird 126.0b2:
https://hg.mozilla.org/releases/comm-beta/rev/e95dc5101ff2
https://hg.mozilla.org/releases/comm-beta/rev/ef64f573b15e
https://hg.mozilla.org/releases/comm-beta/rev/9a31298a7052
https://hg.mozilla.org/releases/comm-beta/rev/b5ecb56c7bf1
https://hg.mozilla.org/releases/comm-beta/rev/5cf6685f08ac
https://hg.mozilla.org/releases/comm-beta/rev/5e883cd9b932
https://hg.mozilla.org/releases/comm-beta/rev/be69efa9305a
https://hg.mozilla.org/releases/comm-beta/rev/b73ec06c98f9

Comment 44

[Vlad Lucaci, Thunderbird QA (:vlucaci)]

Hello!

Is there anything QA can do here to verify that this issue is resolved?
If yes, could you please provide us with STR of what to verify?

Thank you in advance!

Comment 45

[Magnus Melin [:mkmelin] (away until Aug 10)]

Not sure this requires verification, but to do it, see the instructions at https://wiki.mozilla.org/Thunderbird:OpenPGP#OpenPGP_log
Then interact with an OpenPGP message and see that logs are logged in the error console.

Comment 46

[Vlad Lucaci, Thunderbird QA (:vlucaci)]

Thank you for leading me to the OpenPGP_log instructions.

Confirming this issue as verified fixed on macOS 14, Ubuntu 22 and Windows 11 with 126.0b2(20240429201016).