diff --git a/web/donate/paypal-summary.org b/web/donate/paypal-summary.org index 2437003..5e5038f 100644 --- a/web/donate/paypal-summary.org +++ b/web/donate/paypal-summary.org @@ -25,7 +25,9 @@ | | 03 | 1762 | 110 | 50 | 3 | 2267 | 123 | | | 1652 | 54 | 1740 | 0 | 1.2321 | 0.8749 | 131.15 | 3446 | | | 04 | 1763 | 104 | 35 | 2 | 735 | 44 | | | 1659 | 38 | 572 | 0 | 1.2079 | 0.8796 | 132.12 | 2269 | | | 05 | 1638 | 98 | 35 | 2 | 797 | 47 | | | 1540 | 38 | 641 | 0 | 1.1699 | 0.8768 | 127.33 | 2219 | - | | | | | | | | | | | 0 | 0 | 0 | 0 | | | | 0 | + | | 06 | 2025 | 117 | 65 | 4 | 795 | 46 | 15000 | 820 | 1908 | 69 | 642 | 110 | 1.1658 | 0.88605 | 129.04 | 2729 | + | | 07 | 1587 | 104 | 55 | 3 | 705 | 42 | | | 1483 | 58 | 567 | 0 | 1.1684 | 0.8907 | 129.79 | 2108 | + | | 08 | 1213 | 82 | 39 | 2 | 680 | 40 | 8100 | 460 | 1131 | 41 | 553 | 59 | 1.1571 | 0.8934 | 128.54 | 1784 | #+TBLFM: $11=$3-$4::$12=($5-$6)/$16;%.0f::$13=($7-$8)/$15;%.0f::$14=($9-$10)/$17;%.0f::$18=$11+$12+$13+$14 #+HTML:

@@ -60,3 +62,7 @@ Taken from the ZIP file found at [[https://www.ecb.europa.eu/stats/policy_and_ex | 2018-Mar-29 | 1.2321 | 0.8749 | 131.15 | | 2018-Apr-30 | 1.2079 | 0.8796 | 132.12 | | 2018-May-31 | 1.1699 | 0.8768 | 127.33 | +| 2018-Jun-29 | 1.1658 | 0.88605 | 129.04 | +| 2018-Jul-30 | 1.1684 | 0.8907 | 129.79 | +| 2018-Aug-31 | 1.1571 | 0.8934 | 128.54 | +| | | | | ----------------------------------------------------------------------- Summary of changes: web/donate/kudos.org | 3 +++ web/donate/paypal-summary.org | 8 +++++++- 2 files changed, 10 insertions(+), 1 deletion(-) hooks/post-receive -- The GnuPG website and other docs http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 13 11:14:41 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Thu, 13 Sep 2018 11:14:41 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-31-g4bc8476 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via 4bc8476bd340a1c43052b4a3285a1dde582c0296 (commit) via c2e2bc6fdf92c70d18286ef9393e2376c359ea0e (commit) via 78d93a44aaccd10ccb97c51fb3083f1dadfaab4b (commit) via bdc87bbcff9345e142c1b645cce7bc76b52cee63 (commit) via 1bc390e66c7a8933bab3d0962d0e05b948ea802d (commit) via e5a3717ab023f71b28c8d4caefdad0c72845020a (commit) from a0671ccbb477e31d25547532004fa6fd16a29f78 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 4bc8476bd340a1c43052b4a3285a1dde582c0296 Merge: a0671cc c2e2bc6 Author: Andre Heinecke Date: Thu Sep 13 11:14:30 2018 +0200 Merge branch 'STABLE-BRANCH-2-3' commit c2e2bc6fdf92c70d18286ef9393e2376c359ea0e Author: Andre Heinecke Date: Thu Sep 13 11:12:46 2018 +0200 Add disable async encryption as hidden option * src/mail.cpp (Mail::check_inline_response): Look at opt.sync_enc again. * src/main.c (read_options): Read hidden _syncEnc value to disable async encryption. -- This might be useful for support when for someone encryption crashes in the async form. diff --git a/src/mail.cpp b/src/mail.cpp index 328989d..b06311f 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -3050,22 +3050,16 @@ Mail::setWindowEnabled_o (bool value) bool Mail::check_inline_response () { -#if 0 // Should be fixed - -/* Async sending might lead to crashes when the send invocation is done. - * For now we treat every mail as an inline response to disable async - * encryption. :-( For more details see: T3838 */ - + /* Async sending is known to cause instabilities. So we keep + a hidden option to disable it. */ if (opt.sync_enc) { m_async_crypt_disabled = true; return m_async_crypt_disabled; } -#endif m_async_crypt_disabled = false; - LPDISPATCH attachments = get_oom_object (m_mailitem, "Attachments"); if (attachments) { diff --git a/src/main.c b/src/main.c index 43a34f4..8b08030 100644 --- a/src/main.c +++ b/src/main.c @@ -283,7 +283,6 @@ read_options (void) opt.automation = get_conf_bool ("automation", 1); opt.autosecure = get_conf_bool ("autosecure", 1); opt.autotrust = get_conf_bool ("autotrust", 0); - opt.sync_enc = get_conf_bool ("syncEnc", 0); opt.smime_html_warn_shown = get_conf_bool ("smimeHtmlWarnShown", 0); if (!opt.automation) @@ -294,6 +293,9 @@ read_options (void) opt.autoresolve = 0; opt.autotrust = 0; } + + /* Hidden options */ + opt.sync_enc = get_conf_bool ("_syncEnc", 0); } commit 78d93a44aaccd10ccb97c51fb3083f1dadfaab4b Author: Andre Heinecke Date: Thu Sep 13 11:07:56 2018 +0200 Disable async encryption for mails with attachs * src/mail.cpp (check_inline_response): Disable async crypt if mail has attachments. * src/windowmessage.cpp (CRYPTO_DONE): Clarify that the fallback to MAPI is a very very last resort. -- This commit sacrifices usability (async encryption) for stability. We now use the old sync crypt code when attachments are added to a crypto mail to avoid errors that occured for some attachments. As there does not appear to be a detectable pattern or value for which attachments the write in the second send fails we block async crypt for all attachments. GnuPG-Bug-Id: T4131 diff --git a/src/mail.cpp b/src/mail.cpp index 720ec3f..328989d 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -3064,6 +3064,61 @@ Mail::check_inline_response () #endif m_async_crypt_disabled = false; + + + LPDISPATCH attachments = get_oom_object (m_mailitem, "Attachments"); + if (attachments) + { + /* This is horrible. But. For some kinds of attachments (we + got reports about Office attachments the write in the + send event triggered by our crypto done code fails with + an exception. There does not appear to be a detectable + pattern when this happens. + As we can't be sure and do not know for which attachments + this really happens we do not use async crypt for any + mails with attachments. :-/ + Better be save (not crash) instead of nice (async). + + TODO: Figure this out. + + The log goes like this. We pass the send event. That triggers + a write, which we pass. And then that fails. So it looks like + moving to Outbox fails. Because we can save as much as we + like before that. + + Using the IMessage::SubmitMessage MAPI interface works, but + as it is unstable in our current implementation we do not + want to use it. + + mailitem-events.cpp:Invoke: Passing send event for mime-encrypted message 12B7C6E0. + application-events.cpp:Invoke: Unhandled Event: f002 + mailitem-events.cpp:Invoke: Write : 0ED4D058 + mailitem-events.cpp:Invoke: Passing write event. + oomhelp.cpp:invoke_oom_method_with_parms_type: Method 'Send' invokation failed: 0x80020009 + oomhelp.cpp:dump_excepinfo: Exception: + wCode: 0x1000 + wReserved: 0x0 + source: Microsoft Outlook + desc: The operation failed. The messaging interfaces have returned an unknown error. If the problem persists, restart Outlook. + help: null + helpCtx: 0x0 + deferredFill: 00000000 + scode: 0x80040119 + */ + + int count = get_oom_int (attachments, "Count"); + gpgol_release (attachments); + + if (count) + { + m_async_crypt_disabled = true; + log_debug ("%s:%s: Detected attachments. " + "Disabling async crypt due to T4131.", + SRCNAME, __func__); + return m_async_crypt_disabled; + } + } + LPDISPATCH app = GpgolAddin::get_instance ()->get_application (); if (!app) { diff --git a/src/windowmessages.cpp b/src/windowmessages.cpp index 9991eba..bb349b5 100644 --- a/src/windowmessages.cpp +++ b/src/windowmessages.cpp @@ -168,8 +168,14 @@ gpgol_window_proc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) if (invoke_oom_method (mail->item (), "Send", NULL)) { log_error ("%s:%s: Send failed for %p. " - "Trying SubmitMessage instead.", + "Trying SubmitMessage instead.\n" + "This will likely crash.", SRCNAME, __func__, mail); + + /* What we do here is similar to the T3656 workaround + in mailitem-events.cpp. In our tests this works but + is unstable. So we only use it as a very very last + resort. */ auto mail_message = get_oom_base_message (mail->item()); if (!mail_message) { commit bdc87bbcff9345e142c1b645cce7bc76b52cee63 Author: Andre Heinecke Date: Thu Sep 13 10:29:55 2018 +0200 Add more mimetypes in infer_content_type * src/mimemaker.cpp (infer_content_type): Add more mime types. diff --git a/src/mimemaker.cpp b/src/mimemaker.cpp index 216acdf..7adb25b 100644 --- a/src/mimemaker.cpp +++ b/src/mimemaker.cpp @@ -582,6 +582,11 @@ infer_content_type (const char * /*data*/, size_t /*datalen*/, { 1, "deb", "application/x-debian-package" }, { 1, "dl", "video/dl" }, { 1, "doc", "application/msword" }, + { 1, "docx", "application/vnd.openxmlformats-officedocument.wordprocessingml.document" }, + { 1, "dot", "application/msword" }, + { 1, "dotx", "application/vnd.openxmlformats-officedocument.wordprocessingml.template" }, + { 1, "docm", "application/application/vnd.ms-word.document.macroEnabled.12" }, + { 1, "dotm", "application/vnd.ms-word.template.macroEnabled.12" }, { 1, "dv", "video/dv" }, { 1, "dvi", "application/x-dvi" }, { 1, "eml", "message/rfc822" }, @@ -640,6 +645,15 @@ infer_content_type (const char * /*data*/, size_t /*datalen*/, { 1, "png", "image/png" }, { 1, "pps", "application/vnd.ms-powerpoint" }, { 1, "ppt", "application/vnd.ms-powerpoint" }, + { 1, "pot", "application/vnd.ms-powerpoint" }, + { 1, "ppa", "application/vnd.ms-powerpoint" }, + { 1, "pptx", "application/vnd.openxmlformats-officedocument.presentationml.presentation" }, + { 1, "potx", "application/vnd.openxmlformats-officedocument.presentationml.template" }, + { 1, "ppsx", "application/vnd.openxmlformats-officedocument.presentationml.slideshow" }, + { 1, "ppam", "application/vnd.ms-powerpoint.addin.macroEnabled.12" }, + { 1, "pptm", "application/vnd.ms-powerpoint.presentation.macroEnabled.12" }, + { 1, "potm", "application/vnd.ms-powerpoint.template.macroEnabled.12" }, + { 1, "ppsm", "application/vnd.ms-powerpoint.slideshow.macroEnabled.12" }, { 1, "prf", "application/pics-rules" }, { 1, "ps", "application/postscript" }, { 1, "qt", "video/quicktime" }, @@ -668,7 +682,14 @@ infer_content_type (const char * /*data*/, size_t /*datalen*/, { 0, "xhtml", "application/xhtml+xml" }, { 1, "xlb", "application/vnd.ms-excel" }, { 1, "xls", "application/vnd.ms-excel" }, + { 1, "xlsx", "application/vnd.ms-excel" }, { 1, "xlt", "application/vnd.ms-excel" }, + { 1, "xla", "application/vnd.ms-excel" }, + { 1, "xltx", "application/vnd.openxmlformats-officedocument.spreadsheetml.template" }, + { 1, "xlsm", "application/vnd.ms-excel.sheet.macroEnabled.12" }, + { 1, "xltm", "application/vnd.ms-excel.template.macroEnabled.12" }, + { 1, "xlam", "application/vnd.ms-excel.addin.macroEnabled.12" }, + { 1, "xlsb", "application/application/vnd.ms-excel.sheet.binary.macroEnabled.12" }, { 0, "xml", "application/xml" }, { 0, "xsl", "application/xml" }, { 0, "xul", "application/vnd.mozilla.xul+xml" }, commit 1bc390e66c7a8933bab3d0962d0e05b948ea802d Author: Andre Heinecke Date: Fri Sep 7 10:28:11 2018 +0200 Fix encoding of last line * src/mimedataprovider.cpp (get_body, get_html_body): Don't append raw undecoded data anymore. (MimeDataProvider::finalize): New. Parse the last unfinished data. * src/parsecontroller.cpp (ParseController::parse): Call finalize. -- Before this a quoted printable line without a line feed at the end would not be decoded. Leading to a broken display. (cherry picked from commit a0671ccbb477e31d25547532004fa6fd16a29f78) diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index e869cc5..ba49428 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -1030,37 +1030,29 @@ MimeDataProvider::create_attachment() /* TODO handle encoding */ } -const std::string &MimeDataProvider::get_body () +void MimeDataProvider::finalize () { - if (m_rawbuf.size()) + if (m_rawbuf.size ()) { - /* If there was some data left in the rawbuf this could - mean that some plaintext was not finished with a linefeed. - In that case we append it to the bodies. */ - m_body += m_rawbuf; - m_html_body += m_rawbuf; - m_rawbuf.clear(); + m_rawbuf += "\r\n"; + size_t not_taken = collect_input_lines (m_rawbuf.c_str(), + m_rawbuf.size()); + m_rawbuf.erase (0, m_rawbuf.size() - not_taken); + if (m_rawbuf.size ()) + { + log_error ("%s:%s: Collect left data in buffer.\n", + SRCNAME, __func__); + } } +} + +const std::string &MimeDataProvider::get_body () +{ return m_body; } const std::string &MimeDataProvider::get_html_body () { - if (!m_has_html_body) - { - /* Don't do the last line handling if we don't - have html */ - return m_html_body; - } - if (m_rawbuf.size()) - { - /* If there was some data left in the rawbuf this could - mean that some plaintext was not finished with a linefeed. - In that case we append it to the bodies. */ - m_body += m_rawbuf; - m_html_body += m_rawbuf; - m_rawbuf.clear(); - } return m_html_body; } diff --git a/src/mimedataprovider.h b/src/mimedataprovider.h index 4841d73..40e1c18 100644 --- a/src/mimedataprovider.h +++ b/src/mimedataprovider.h @@ -118,6 +118,9 @@ public: const std::string &get_body_charset() const; void set_has_html_body(bool value) {m_has_html_body = value;} + + /* Finalize the bodys */ + void finalize (); private: #ifdef HAVE_W32_SYSTEM /* Collect the data from mapi. */ diff --git a/src/parsecontroller.cpp b/src/parsecontroller.cpp index df5b8fe..82d10e7 100644 --- a/src/parsecontroller.cpp +++ b/src/parsecontroller.cpp @@ -519,6 +519,11 @@ ParseController::parse() } TRACEPOINT; + if (m_outputprovider) + { + m_outputprovider->finalize (); + } + return; } commit e5a3717ab023f71b28c8d4caefdad0c72845020a Author: Andre Heinecke Date: Fri Sep 7 09:56:35 2018 +0200 Fix a possible crash when reactivating gpgol * src/gpgoladdin.cpp (GpgolAddin::invalidateRibbons) (GpgolAddin::addRibbon): New. (g_ribbon_uis): Removed. -- This keeps the ribbon ui in a member variable so that they are cleared out when the GpgolAddin class is remvoved on unload. Fixes a potential crash when a user would activate gpgol after deactivating it in the same outlook session and stale ribbon ui pointers would be accessed. (cherry picked from commit 50c514d6bd6026076f5f467b7d8523dff2ce97aa) diff --git a/src/gpgoladdin.cpp b/src/gpgoladdin.cpp index e331b86..03baf95 100644 --- a/src/gpgoladdin.cpp +++ b/src/gpgoladdin.cpp @@ -63,8 +63,6 @@ ULONG addinLocks = 0; bool can_unload = false; -static std::list g_ribbon_uis; - static GpgolAddin * addin_instance = NULL; /* This is the main entry point for the addin @@ -791,7 +789,7 @@ GpgolRibbonExtender::Invoke (DISPID dispid, REFIID riid, LCID lcid, case ID_ON_LOAD: { - g_ribbon_uis.push_back (parms->rgvarg[0].pdispVal); + GpgolAddin::get_instance ()->addRibbon (parms->rgvarg[0].pdispVal); return S_OK; } case ID_CMD_OPEN_OPTIONS: @@ -1102,16 +1100,10 @@ GpgolRibbonExtender::GetCustomUI (BSTR RibbonID, BSTR * RibbonXml) Updated. Sadly we don't know which ribbon_ui needs updates so we have to invalidate everything. */ -void gpgoladdin_invalidate_ui () +void +gpgoladdin_invalidate_ui () { - std::list::iterator it; - - for (it = g_ribbon_uis.begin(); it != g_ribbon_uis.end(); ++it) - { - log_debug ("%s:%s: Invalidating ribbon: %p", - SRCNAME, __func__, *it); - invoke_oom_method (*it, "Invalidate", NULL); - } + GpgolAddin::get_instance ()->invalidateRibbons(); } GpgolAddin * @@ -1130,6 +1122,27 @@ GpgolAddin::get_instance () } void +GpgolAddin::invalidateRibbons() +{ + /* This can only be done in the main thread so no + need for locking or copying here. */ + for (const auto it: m_ribbon_uis) + { + log_debug ("%s:%s: Invalidating ribbon: %p", + SRCNAME, __func__, it); + invoke_oom_method (it, "Invalidate", NULL); + } + log_debug ("%s:%s: Invalidation done.", + SRCNAME, __func__); +} + +void +GpgolAddin::addRibbon (LPDISPATCH disp) +{ + m_ribbon_uis.push_back (disp); +} + +void GpgolAddin::shutdown () { if (m_shutdown) diff --git a/src/gpgoladdin.h b/src/gpgoladdin.h index 1641942..3627a01 100644 --- a/src/gpgoladdin.h +++ b/src/gpgoladdin.h @@ -217,6 +217,12 @@ public: std::shared_ptr get_dispcache () { return m_dispcache; } bool isShutdown() { return m_shutdown; }; + /* Register a ribbon ui component */ + void addRibbon (LPDISPATCH ribbon); + + /* Invalidate the ribbons. */ + void invalidateRibbons (); + private: ULONG m_lRef; GpgolRibbonExtender* m_ribbonExtender; @@ -231,6 +237,7 @@ private: HHOOK m_hook; std::vector m_explorerEventSinks; std::shared_ptr m_dispcache; + std::vector m_ribbon_uis; }; class GpgolAddinFactory: public IClassFactory ----------------------------------------------------------------------- Summary of changes: src/mail.cpp | 63 ++++++++++++++++++++++++++++++++++++++++++++------ src/main.c | 4 +++- src/mimemaker.cpp | 21 +++++++++++++++++ src/windowmessages.cpp | 8 ++++++- 4 files changed, 87 insertions(+), 9 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 13 11:14:47 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Thu, 13 Sep 2018 11:14:47 +0200 Subject: [git] GpgOL - branch, STABLE-BRANCH-2-3, updated. gpgol-2.3.0-16-gc2e2bc6 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, STABLE-BRANCH-2-3 has been updated via c2e2bc6fdf92c70d18286ef9393e2376c359ea0e (commit) via 78d93a44aaccd10ccb97c51fb3083f1dadfaab4b (commit) via bdc87bbcff9345e142c1b645cce7bc76b52cee63 (commit) via 1bc390e66c7a8933bab3d0962d0e05b948ea802d (commit) via e5a3717ab023f71b28c8d4caefdad0c72845020a (commit) from 2da40322c2614a3357eac901f970c96cb1c17dbe (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- ----------------------------------------------------------------------- Summary of changes: src/gpgoladdin.cpp | 37 +++++++++++++++++++--------- src/gpgoladdin.h | 7 ++++++ src/mail.cpp | 63 ++++++++++++++++++++++++++++++++++++++++++------ src/main.c | 4 ++- src/mimedataprovider.cpp | 38 ++++++++++++----------------- src/mimedataprovider.h | 3 +++ src/mimemaker.cpp | 21 ++++++++++++++++ src/parsecontroller.cpp | 5 ++++ src/windowmessages.cpp | 8 +++++- 9 files changed, 142 insertions(+), 44 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Fri Sep 14 01:17:35 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Fri, 14 Sep 2018 01:17:35 +0200 Subject: [git] GnuPG - branch, master, updated. gnupg-2.2.7-214-g60c880b Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The GNU Privacy Guard". The branch, master has been updated via 60c880bda5c9b821fd2968cf89c38c37be3c1a7b (commit) via 2eb481e8cc1c37378cf68a06557c4a7a625d315c (commit) via 64c5c45e2aa4a12d939680b9d51c8b26d61c5e9d (commit) from 69bab1cba07a8259b85a7911c2824724667803a4 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 60c880bda5c9b821fd2968cf89c38c37be3c1a7b Author: NIIBE Yutaka Date: Fri Sep 14 08:11:45 2018 +0900 g10: Fix another memory leak. * g10/skclist.c (enum_secret_keys): Use SK_LIST instead of pubkey_t. -- The use of pubkey_t was wrong. The use is just a list of keys, not with keyblock. With SK_LIST, release_sk_list releases memory by free_public_key. Signed-off-by: NIIBE Yutaka diff --git a/g10/skclist.c b/g10/skclist.c index 11c57e5..c9c41d0 100644 --- a/g10/skclist.c +++ b/g10/skclist.c @@ -337,7 +337,7 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) kbnode_t keyblock; kbnode_t node; getkey_ctx_t ctx; - pubkey_t results; + SK_LIST results; } *c = *context; if (!c) @@ -358,7 +358,7 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) /* Free the context. */ xfree (c->serialno); free_strlist (c->card_list); - pubkeys_free (c->results); + release_sk_list (c->results); release_kbnode (c->keyblock); getkey_end (ctrl, c->ctx); xfree (c); @@ -516,7 +516,7 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) if (c->node->pkt->pkttype == PKT_PUBLIC_KEY || c->node->pkt->pkttype == PKT_PUBLIC_SUBKEY) { - pubkey_t r; + SK_LIST r; /* Skip this candidate if it's already enumerated. */ for (r = c->results; r; r = r->next) @@ -537,7 +537,6 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) } r->pk = sk; - r->keyblock = NULL; r->next = c->results; c->results = r; commit 2eb481e8cc1c37378cf68a06557c4a7a625d315c Author: NIIBE Yutaka Date: Fri Sep 14 08:02:16 2018 +0900 g10: Fix memory leak (more). * g10/skclist.c (enum_secret_keys): Free SERIALNO on update. -- Signed-off-by: NIIBE Yutaka diff --git a/g10/skclist.c b/g10/skclist.c index d233549..11c57e5 100644 --- a/g10/skclist.c +++ b/g10/skclist.c @@ -380,6 +380,8 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) /* Loop over the list of secret keys. */ do { + char *serialno; + name = NULL; keyblock = NULL; switch (c->state) @@ -415,8 +417,6 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) case 4: /* Get next item from card list. */ if (c->sl) { - char *serialno; - err = agent_scd_serialno (&serialno, c->sl->d); if (err) { @@ -444,9 +444,13 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) } else { - if (c->serialno) - /* Select the original card again. */ - agent_scd_serialno (&c->serialno, c->serialno); + serialno = c->serialno; + if (serialno) + { + /* Select the original card again. */ + agent_scd_serialno (&c->serialno, serialno); + xfree (serialno); + } c->state++; } break; commit 64c5c45e2aa4a12d939680b9d51c8b26d61c5e9d Author: NIIBE Yutaka Date: Fri Sep 14 07:55:20 2018 +0900 g10: Fix memory leak in enum_secret_keys. * g10/skclist.c (enum_secret_keys): Don't forget to call free_public_key in the error return paths. -- Reported-by: Philippe Antoine GnuPG-bug-id: 4140 Signed-off-by: NIIBE Yutaka diff --git a/g10/skclist.c b/g10/skclist.c index fd747fb..d233549 100644 --- a/g10/skclist.c +++ b/g10/skclist.c @@ -345,7 +345,11 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) /* Make a new context. */ c = xtrycalloc (1, sizeof *c); if (!c) - return gpg_error_from_syserror (); + { + err = gpg_error_from_syserror (); + free_public_key (sk); + return err; + } *context = c; } @@ -363,7 +367,10 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) } if (c->eof) - return gpg_error (GPG_ERR_EOF); + { + free_public_key (sk); + return gpg_error (GPG_ERR_EOF); + } for (;;) { @@ -475,6 +482,7 @@ enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk) default: /* No more names to check - stop. */ c->eof = 1; + free_public_key (sk); return gpg_error (GPG_ERR_EOF); } } ----------------------------------------------------------------------- Summary of changes: g10/skclist.c | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) hooks/post-receive -- The GNU Privacy Guard http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 15 01:30:17 2018 From: cvs at cvs.gnupg.org (by Ben Kibbey) Date: Sat, 15 Sep 2018 01:30:17 +0200 Subject: [git] Assuan - branch, master, updated. libassuan-2.5.1-6-gafeae64 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "IPC library used by GnuPG". The branch, master has been updated via afeae6496f51d28958fd92b04cc933ee6ceb5b61 (commit) from b270f2ec21b67f5728edae4b2ddf6fe17a0fd25a (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit afeae6496f51d28958fd92b04cc933ee6ceb5b61 Author: Ben Kibbey Date: Fri Sep 14 14:53:00 2018 -0700 Fix OpenBSD build. * configure.ac: Define HAVE_STRUCT_SOCKPEERCRED_PID when found. -- Signed-off-by: Ben Kibbey diff --git a/configure.ac b/configure.ac index d37f07f..dad379a 100644 --- a/configure.ac +++ b/configure.ac @@ -423,7 +423,10 @@ AC_REPLACE_FUNCS(setenv) # # Check for the getsockopt SO_PEERCRED, etc. # -AC_CHECK_MEMBER(struct sockpeercred.pid, [], [], [#include +AC_CHECK_MEMBER(struct sockpeercred.pid, + [AC_DEFINE(HAVE_STRUCT_SOCKPEERCRED_PID, 1, + Define if struct sockpeercred contains the pid member.)], + [], [#include #include ]) # (Open)Solaris ----------------------------------------------------------------------- Summary of changes: configure.ac | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) hooks/post-receive -- IPC library used by GnuPG http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 15 04:14:43 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sat, 15 Sep 2018 04:14:43 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-274-g864ef9b Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 864ef9b40f5f9d0c66a458b6033277938d7d1d50 (commit) from dd7d37ca21684d4d77db4f513c6212776fc6ea82 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 864ef9b40f5f9d0c66a458b6033277938d7d1d50 Author: Ben McGinnes Date: Sat Sep 15 12:10:05 2018 +1000 Python examples: backwards compatibility * lang/python/examples/howto/groups.py: subprocess update * lang/python/examples/howto/export-secret-keys.py: subprocess update Both of these try the nice and easy method of getting the subprocess output available in Python 3, but will fall back to the older Popen method if it doesn't work. Essentially this is to be a little nicer to Python 2.7.15 (even though the examples are filled with warnings that py2 support is not guaranteed with the examples). diff --git a/lang/python/examples/howto/export-secret-keys.py b/lang/python/examples/howto/export-secret-keys.py index f0a791e..7203ded 100755 --- a/lang/python/examples/howto/export-secret-keys.py +++ b/lang/python/examples/howto/export-secret-keys.py @@ -84,7 +84,13 @@ else: if os.path.exists(os.environ["GNUPGHOME"]) is True: hd = os.environ["GNUPGHOME"] else: - hd = subprocess.getoutput(gpgconfcmd) + try: + hd = subprocess.getoutput(gpgconfcmd) + except: + process = subprocess.Popen(gpgconfcmd.split(), + stdout=subprocess.PIPE) + procom = process.communicate() + hd = procom[0].decode().strip() gpgfile = "{0}/{1}.gpg".format(hd, keyfile) ascfile = "{0}/{1}.asc".format(hd, keyfile) diff --git a/lang/python/examples/howto/groups.py b/lang/python/examples/howto/groups.py index b8317b6..154961b 100644 --- a/lang/python/examples/howto/groups.py +++ b/lang/python/examples/howto/groups.py @@ -37,7 +37,12 @@ if sys.platform == "win32": else: gpgconfcmd = "gpgconf --list-options gpg" -lines = subprocess.getoutput(gpgconfcmd).splitlines() +try: + lines = subprocess.getoutput(gpgconfcmd).splitlines() +except: + process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) + procom = process.communicate() + lines = procom[0].decode().splitlines() for i in range(len(lines)): if lines[i].startswith("group") is True: ----------------------------------------------------------------------- Summary of changes: lang/python/examples/howto/export-secret-keys.py | 8 +++++++- lang/python/examples/howto/groups.py | 7 ++++++- 2 files changed, 13 insertions(+), 2 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 15 19:38:41 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sat, 15 Sep 2018 19:38:41 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-276-gd04fb0b Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via d04fb0bf1271c91b88686c947a5b14ffc9b505ef (commit) via 4e8a92ed14ea3da3d92f07d5f62fd325a2adebde (commit) from 864ef9b40f5f9d0c66a458b6033277938d7d1d50 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit d04fb0bf1271c91b88686c947a5b14ffc9b505ef Author: Ben McGinnes Date: Sun Sep 16 03:36:14 2018 +1000 Python bindings: docs * lang/python/docs/GPGMEpythonHOWTOen.org: Fixed a few errors in the newer sections. * Updated code in the examples using secret key exporting and group lines to reflect the Python 2.7 compatibility fixes added. diff --git a/lang/python/docs/GPGMEpythonHOWTOen.org b/lang/python/docs/GPGMEpythonHOWTOen.org index 38d332f..1e5db6d 100644 --- a/lang/python/docs/GPGMEpythonHOWTOen.org +++ b/lang/python/docs/GPGMEpythonHOWTOen.org @@ -316,12 +316,16 @@ both by and in order to create, the bindings (including both the :END: If specifying a selected number of languages to create bindings for, -always leave Python last. Currently the other languages are also -preceding Python of either version when listed alphabetically and so -that just happens by default currently. If Python is set to precede -one of the other languages then it is possible that the errors -described here may interrupt the build process before generating -bindings for those other languages. +try to leave Python last. Currently the majority of the other +language bindings are also preceding Python of either version when +listed alphabetically and so that just happens by default currently. + +If Python is set to precede one of the other languages then it is +possible that the errors described here may interrupt the build +process before generating bindings for those other languages. In +these cases it may be preferable to configure all preferred language +bindings separately with alternative =configure= steps for GPGME using +the =--enable-languages=$LANGUAGE= option. *** Multiple installations @@ -333,7 +337,7 @@ For a veriety of reasons it may be either necessary or just preferable to install the bindings to alternative installed Python versions which meet the requirements of these bindings. -On POSIX systens this will generally be most simply achieved by +On POSIX systems this will generally be most simply achieved by running the manual installation commands (build, build, install) as described in the previous section for each Python installation the bindings need to be installed to. @@ -364,7 +368,7 @@ people who installed Python using the Windows installer files from the The Windows versions of Python are not built using Cygwin, MinGW or Msys2; they're built using Microsoft Visual Studio. Furthermore the version used is /considerably/ more advanced than the version which -MinGWobtained a small number of files from many years ago in order to +MinGW obtained a small number of files from many years ago in order to be able to compile anything at all. Not only that, but there are changes to the version of Visual Studio between some micro releases, though that is is particularly the case with Python 2.7, since it has @@ -414,10 +418,11 @@ GPGME is compiled. CFFI is currently unable to adapt to such a potentially mutable codebase. If there were some means of applying SWIG's dynamic code -generation to produce CFFI API modes of accessing the GPGME libraries -(or the source source code directly), but such a thing does not exist -yet either and it currently appears that work is needed in at least -one of CFFI's dependencies before any of this can be addressed. +generation to produce the Python/CFFI API modes of accessing the GPGME +libraries (or the source source code directly), but such a thing does +not exist yet either and it currently appears that work is needed in +at least one of CFFI's dependencies before any of this can be +addressed. So if you're a massive fan of CFFI; that's great, but if you want this project to switch to CFFI then rather than just insisting that it @@ -463,8 +468,7 @@ retrain developers. This API does not do that. It would not be able to do that and also provide access to the entire C API on which it's built. It does, however, provide a very pythonic interface on top of the direct -bindings and it's this pythonic layer with which this HOWTO deals -with. +bindings and it's this pythonic layer that this HOWTO deals with. ** Context @@ -1062,7 +1066,16 @@ else: if os.path.exists(os.environ["GNUPGHOME"]) is True: hd = os.environ["GNUPGHOME"] else: - hd = subprocess.getoutput(gpgconfcmd) + try: + hd = subprocess.getoutput(gpgconfcmd) + except: + process = subprocess.Popen(gpgconfcmd.split(), + stdout=subprocess.PIPE) + procom = process.communicate() + if sys.version_info[0] == 2: + hd = procom[0].strip() + else: + hd = procom[0].decode().strip() gpgfile = "{0}/{1}.gpg".format(hd, keyfile) ascfile = "{0}/{1}.asc".format(hd, keyfile) @@ -1967,8 +1980,17 @@ information in Python. #+BEGIN_SRC python -i import subprocess +import sys -lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines() +try: + lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines() +except: + process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) + procom = process.communicate() + if sys.version_info[0] == 2: + lines = procom[0].splitlines() + else: + lines = procom[0].decode().splitlines() for i in range(len(lines)): if lines[i].startswith("group") is True: commit 4e8a92ed14ea3da3d92f07d5f62fd325a2adebde Author: Ben McGinnes Date: Sun Sep 16 03:34:36 2018 +1000 Python bindings: examples * lang/python/examples/howto/export-secret-keys.py and groups.py: Updated the backwards compatibility adjustments to account for unicode differences between python 2 and 3. diff --git a/lang/python/examples/howto/export-secret-keys.py b/lang/python/examples/howto/export-secret-keys.py index 7203ded..0f4d8ee 100755 --- a/lang/python/examples/howto/export-secret-keys.py +++ b/lang/python/examples/howto/export-secret-keys.py @@ -90,7 +90,10 @@ else: process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) procom = process.communicate() - hd = procom[0].decode().strip() + if sys.version_info[0] == 2: + hd = procom[0].strip() + else: + hd = procom[0].decode().strip() gpgfile = "{0}/{1}.gpg".format(hd, keyfile) ascfile = "{0}/{1}.asc".format(hd, keyfile) diff --git a/lang/python/examples/howto/groups.py b/lang/python/examples/howto/groups.py index 154961b..7213538 100644 --- a/lang/python/examples/howto/groups.py +++ b/lang/python/examples/howto/groups.py @@ -42,7 +42,10 @@ try: except: process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) procom = process.communicate() - lines = procom[0].decode().splitlines() + if sys.version_info[0] == 2: + lines = procom[0].splitlines() + else: + lines = procom[0].decode().splitlines() for i in range(len(lines)): if lines[i].startswith("group") is True: ----------------------------------------------------------------------- Summary of changes: lang/python/docs/GPGMEpythonHOWTOen.org | 54 +++++++++++++++++------- lang/python/examples/howto/export-secret-keys.py | 5 ++- lang/python/examples/howto/groups.py | 5 ++- 3 files changed, 46 insertions(+), 18 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 15 21:07:49 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sat, 15 Sep 2018 21:07:49 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-279-g93a2ea0 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 93a2ea0207fac0a18a48b671df11dc8575579c39 (commit) via 2e5b0603709855eb1d8a1a3fd51d3245f4301ada (commit) via b19faa26e01df4d78286e013313e5ab25f517d49 (commit) from d04fb0bf1271c91b88686c947a5b14ffc9b505ef (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 93a2ea0207fac0a18a48b671df11dc8575579c39 Author: Ben McGinnes Date: Sun Sep 16 05:02:44 2018 +1000 docs: generated whitespace * doc/gpgme-python-howto.texi: culled whitespace included with the org-mode export. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 3e1abae..51c1bfe 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -66,7 +66,7 @@ Known Issues * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. Fundamentals @@ -126,7 +126,7 @@ Miscellaneous work-arounds Copyright and Licensing -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end detailmenu @@ -391,7 +391,7 @@ they be encountered. * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. @end menu @node Breaking Builds @@ -2121,7 +2121,7 @@ Neomutt mail clients. @chapter Copyright and Licensing @menu -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end menu commit 2e5b0603709855eb1d8a1a3fd51d3245f4301ada Author: Ben McGinnes Date: Sun Sep 16 04:55:33 2018 +1000 Docs: including howto with standard docs * gpgme.spec.in: Added gpgme-python-howto.info build on the grounds that it now deals with certain possible installation issues and end users encountering them would want the docs to hand. * doc/gpgme.texi: updated the copyright year to this year. diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 5c1757d..426ae7a 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -14,7 +14,7 @@ @syncodeindex pg fn @copying -Copyright @copyright{} 2002--2008, 2010, 2012--2017 g10 Code GmbH. +Copyright @copyright{} 2002--2008, 2010, 2012--2018 g10 Code GmbH. @quotation Permission is granted to copy, distribute and/or modify this document diff --git a/gpgme.spec.in b/gpgme.spec.in index ddc0de3..8d9c66a 100644 --- a/gpgme.spec.in +++ b/gpgme.spec.in @@ -38,10 +38,12 @@ make distclean %post /sbin/ldconfig /sbin/install-info %{_infodir}/gpgme.info.gz %{_infodir}/dir +/sbin/install-info %{_infodir}/gpgme-python-howto.info.gz %{_infodir}/dir %preun if [ "$1" = 0 ]; then /sbin/install-info --delete %{_infodir}/gpgme.info.gz %{_infodir}/dir + /sbin/install-info --delete %{_infodir}/gpgme-python-howto.info.gz %{_infodir}/dir fi %postun @@ -57,6 +59,7 @@ fi %{_includedir}/gpgme.h %{_datadir}/aclocal/gpgme.m4 %{_infodir}/gpgme.info* +%{_infodir}/gpgme-python-howto.info* %changelog * Sat Aug 30 2003 Robert Schiele commit b19faa26e01df4d78286e013313e5ab25f517d49 Author: Ben McGinnes Date: Sun Sep 16 04:04:13 2018 +1000 Docs: Python bindings HOWTO * Added doc/gpgme-python-howto.texi: generated from GPGMEpythonHOWTOen.org and then slightly modified so the generated Info file doesn't use camelCase. * doc/Makefile.am: Updated makefile to include the Python HOWTO with gpgme_TEXINFOS and to export the generated files to the webserver along with the main GPGME one. diff --git a/doc/Makefile.am b/doc/Makefile.am index a592f79..a944be6 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -30,7 +30,7 @@ BUILT_SOURCES = defsincdate defs.inc info_TEXINFOS = gpgme.texi -gpgme_TEXINFOS = uiserver.texi lesser.texi gpl.texi +gpgme_TEXINFOS = uiserver.texi gpgme-python-howto.texi lesser.texi gpl.texi gpgme.texi : defs.inc @@ -53,11 +53,14 @@ defs.inc: defsincdate Makefile mkdefsinc $(info_TEXINFOS) $(gpgme_TEXINFOS) >$@ -online: gpgme.html gpgme.pdf +online: gpgme.html gpgme.pdf gpgme-python-howto.html gpgme-python-howto.pdf set -e; \ echo "Uploading current manuals to www.gnupg.org ..."; \ user=werner ; \ (cd gpgme.html && rsync -vr --exclude='.svn' . \ $${user}@ftp.gnupg.org:webspace/manuals/gpgme/ ); \ rsync -v gpgme.pdf $${user}@ftp.gnupg.org:webspace/manuals/ + (cd gpgme-python-howto.html && rsync -vr --exclude='.svn' . \ + $${user}@ftp.gnupg.org:webspace/manuals/gpgme/ ); \ + rsync -v gpgme-python-howto.pdf $${user}@ftp.gnupg.org:webspace/manuals/ diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi new file mode 100644 index 0000000..3e1abae --- /dev/null +++ b/doc/gpgme-python-howto.texi @@ -0,0 +1,2145 @@ +\input texinfo @c -*- texinfo -*- + at c %**start of header + at setfilename gpgme-python-howto.info + at settitle GNU Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO (English) + at documentencoding UTF-8 + at documentlanguage en + at c %**end of header + + at finalout + at titlepage + at title GNU Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO (English) + at author Ben McGinnes + at end titlepage + + at contents + + at ifnottex + at node Top + at top GNU Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO (English) + at end ifnottex + + at menu +* Introduction:: +* GPGME Concepts:: +* GPGME Python bindings installation:: +* Fundamentals:: +* Working with keys:: +* Basic Functions:: +* Creating keys and subkeys:: +* Miscellaneous work-arounds:: +* Copyright and Licensing:: + + at detailmenu +--- The Detailed Node Listing --- + +Introduction + +* Python 2 versus Python 3:: +* Examples:: + +GPGME Concepts + +* A C API:: +* Python bindings:: +* Difference between the Python bindings and other GnuPG Python packages:: + +Difference between the Python bindings and other GnuPG Python packages + +* The python-gnupg package maintained by Vinay Sajip:: +* The gnupg package created and maintained by Isis Lovecruft:: +* The PyME package maintained by Martin Albrecht:: + +GPGME Python bindings installation + +* No PyPI:: +* Requirements:: +* Installation:: +* Known Issues:: + +Installation + +* Installing GPGME:: + +Known Issues + +* Breaking Builds:: +* Multiple installations:: +* Won't Work With Windows:: +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. + +Fundamentals + +* No REST:: +* Context:: + +Working with keys + +* Key selection:: +* Get key:: +* Importing keys:: +* Exporting keys:: + +Key selection + +* Counting keys:: + +Exporting keys + +* Exporting public keys:: +* Exporting secret keys:: + +Basic Functions + +* Encryption:: +* Decryption:: +* Signing text and files:: +* Signature verification:: + +Encryption + +* Encrypting to one key:: +* Encrypting to multiple keys:: + +Signing text and files + +* Signing key selection:: +* Normal or default signing messages or files:: +* Detached signing messages and files:: +* Clearsigning messages or text:: + +Creating keys and subkeys + +* Primary key:: +* Subkeys:: +* User IDs:: +* Key certification:: + +User IDs + +* Adding User IDs:: +* Revokinging User IDs:: + +Miscellaneous work-arounds + +* Group lines:: + +Copyright and Licensing + +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* License GPL compatible:: + + at end detailmenu + at end menu + + at node Introduction + at chapter Introduction + + at multitable {aaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} + at item Version: + at tab 0.1.4 + at item Author: + at tab Ben McGinnes + at item Author GPG Key: + at tab DB4724E6FA4286C92B4E55C4321E4E2373590E5D + at item Language: + at tab Australian English, British English + at item xml:lang: + at tab en-AU, en-GB, en + at end multitable + +This document provides basic instruction in how to use the GPGME +Python bindings to programmatically leverage the GPGME library. + + at menu +* Python 2 versus Python 3:: +* Examples:: + at end menu + + at node Python 2 versus Python 3 + at section Python 2 versus Python 3 + +Though the GPGME Python bindings themselves provide support for both +Python 2 and 3, the focus is unequivocally on Python 3 and +specifically from Python 3.4 and above. As a consequence all the +examples and instructions in this guide use Python 3 code. + +Much of it will work with Python 2, but much of it also deals with +Python 3 byte literals, particularly when reading and writing data. +Developers concentrating on Python 2.7, and possibly even 2.6, will +need to make the appropriate modifications to support the older string +and unicode types as opposed to bytes. + +There are multiple reasons for concentrating on Python 3; some of +which relate to the immediate integration of these bindings, some of +which relate to longer term plans for both GPGME and the python +bindings and some of which relate to the impending EOL period for +Python 2.7. Essentially, though, there is little value in tying the +bindings to a version of the language which is a dead end and the +advantages offered by Python 3 over Python 2 make handling the data +types with which GPGME deals considerably easier. + + at node Examples + at section Examples + +All of the examples found in this document can be found as Python 3 +scripts in the @samp{lang/python/examples/howto} directory. + + at node GPGME Concepts + at chapter GPGME Concepts + + at menu +* A C API:: +* Python bindings:: +* Difference between the Python bindings and other GnuPG Python packages:: + at end menu + + at node A C API + at section A C API + +Unlike many modern APIs with which programmers will be more familiar +with these days, the GPGME API is a C API. The API is intended for +use by C coders who would be able to access its features by including +the @samp{gpgme.h} header file with their own C source code and then access +its functions just as they would any other C headers. + +This is a very effective method of gaining complete access to the API +and in the most efficient manner possible. It does, however, have the +drawback that it cannot be directly used by other languages without +some means of providing an interface to those languages. This is +where the need for bindings in various languages stems. + + at node Python bindings + at section Python bindings + +The Python bindings for GPGME provide a higher level means of +accessing the complete feature set of GPGME itself. It also provides +a more pythonic means of calling these API functions. + +The bindings are generated dynamically with SWIG and the copy of + at samp{gpgme.h} generated when GPGME is compiled. + +This means that a version of the Python bindings is fundamentally tied +to the exact same version of GPGME used to generate that copy of + at samp{gpgme.h}. + + at node Difference between the Python bindings and other GnuPG Python packages + at section Difference between the Python bindings and other GnuPG Python packages + +There have been numerous attempts to add GnuPG support to Python over +the years. Some of the most well known are listed here, along with +what differentiates them. + + at menu +* The python-gnupg package maintained by Vinay Sajip:: +* The gnupg package created and maintained by Isis Lovecruft:: +* The PyME package maintained by Martin Albrecht:: + at end menu + + at node The python-gnupg package maintained by Vinay Sajip + at subsection The python-gnupg package maintained by Vinay Sajip + +This is arguably the most popular means of integrating GPG with +Python. The package utilises the @samp{subprocess} module to implement +wrappers for the @samp{gpg} and @samp{gpg2} executables normally invoked on the +command line (@samp{gpg.exe} and @samp{gpg2.exe} on Windows). + +The popularity of this package stemmed from its ease of use and +capability in providing the most commonly required features. + +Unfortunately it has been beset by a number of security issues in the +past; most of which stemmed from using unsafe methods of accessing the +command line via the @samp{subprocess} calls. While some effort has been +made over the last two to three years (as of 2018) to mitigate this, +particularly by no longer providing shell access through those +subprocess calls, the wrapper is still somewhat limited in the scope +of its GnuPG features coverage. + +The python-gnupg package is available under the MIT license. + + at node The gnupg package created and maintained by Isis Lovecruft + at subsection The gnupg package created and maintained by Isis Lovecruft + +In 2015 Isis Lovecruft from the Tor Project forked and then +re-implemented the python-gnupg package as just gnupg. This new +package also relied on subprocess to call the @samp{gpg} or @samp{gpg2} +binaries, but did so somewhat more securely. + +The naming and version numbering selected for this package, however, +resulted in conflicts with the original python-gnupg and since its +functions were called in a different manner to python-gnupg, the +release of this package also resulted in a great deal of consternation +when people installed what they thought was an upgrade that +subsequently broke the code relying on it. + +The gnupg package is available under the GNU General Public License +version 3.0 (or any later version). + + at node The PyME package maintained by Martin Albrecht + at subsection The PyME package maintained by Martin Albrecht + +This package is the origin of these bindings, though they are somewhat +different now. For details of when and how the PyME package was folded +back into GPGME itself see the @emph{Short History} +document at footnote{@samp{lang/python/docs/Short_History.org} and/or + at samp{lang/python/docs/Short_History.html}.} in the Python bindings + at samp{docs} directory. at footnote{The @samp{lang/python/docs/} directory +in the GPGME source.} + +The PyME package was first released in 2002 and was also the first +attempt to implement a low level binding to GPGME. In doing so it +provided access to considerably more functionality than either the + at samp{python-gnupg} or @samp{gnupg} packages. + +The PyME package is only available for Python 2.6 and 2.7. + +Porting the PyME package to Python 3.4 in 2015 is what resulted in it +being folded into the GPGME project and the current bindings are the +end result of that effort. + +The PyME package is available under the same dual licensing as GPGME +itself: the GNU General Public License version 2.0 (or any later +version) and the GNU Lesser General Public License version 2.1 (or any +later version). + + at node GPGME Python bindings installation + at chapter GPGME Python bindings installation + + at menu +* No PyPI:: +* Requirements:: +* Installation:: +* Known Issues:: + at end menu + + at node No PyPI + at section No PyPI + +Most third-party Python packages and modules are available and +distributed through the Python Package Installer, known as PyPI. + +Due to the nature of what these bindings are and how they work, it is +infeasible to install the GPGME Python bindings in the same way. + +This is because the bindings use SWIG to dynamically generate C +bindings against @samp{gpgme.h} and @samp{gpgme.h} is generated from + at samp{gpgme.h.in} at compile time when GPGME is built from source. Thus to +include a package in PyPI which actually built correctly would require +either statically built libraries for every architecture bundled with +it or a full implementation of C for each architecture. + +See the additional notes regarding @ref{I don't like SWIG Use CFFI instead, , CFFI and SWIG} at the end of this +section for further details. + + at node Requirements + at section Requirements + +The GPGME Python bindings only have three requirements: + + at enumerate + at item +A suitable version of Python 2 or Python 3. With Python 2 that +means Python 2.7 and with Python 3 that means Python 3.4 or higher. + at item + at uref{https://www.swig.org, SWIG}. + at item +GPGME itself. Which also means that all of GPGME's dependencies +must be installed too. + at end enumerate + + at node Installation + at section Installation + +Installing the Python bindings is effectively achieved by compiling +and installing GPGME itself. + +Once SWIG is installed with Python and all the dependencies for GPGME +are installed you only need to confirm that the version(s) of Python +you want the bindings installed for are in your @samp{$PATH}. + +By default GPGME will attempt to install the bindings for the most +recent or highest version number of Python 2 and Python 3 it detects +in @samp{$PATH}. It specifically checks for the @samp{python} and @samp{python3} +executables first and then checks for specific version numbers. + +For Python 2 it checks for these executables in this order: @samp{python}, + at samp{python2} and @samp{python2.7}. + +For Python 3 it checks for these executables in this order: @samp{python3}, + at samp{python3.6}, @samp{python3.5}, @samp{python3.4} and @samp{python3.7}. at footnote{As Python 3.7 is a very recent release, it is not given +priority over 3.6 yet, but will probably be prioritised by the release +of Python 3.7.2.} + + at menu +* Installing GPGME:: + at end menu + + at node Installing GPGME + at subsection Installing GPGME + +See the GPGME @samp{README} file for details of how to install GPGME from +source. + + at node Known Issues + at section Known Issues + +There are a few known issues with the current build process and the +Python bindings. For the most part these are easily addressed should +they be encountered. + + at menu +* Breaking Builds:: +* Multiple installations:: +* Won't Work With Windows:: +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. + at end menu + + at node Breaking Builds + at subsection Breaking Builds + +Occasionally when installing GPGME with the Python bindings included +it may be observed that the @samp{make} portion of that process induces a +large very number of warnings and, eventually errors which end that +part of the build process. Yet following that with @samp{make check} and + at samp{make install} appears to work seamlessly. + +The cause of this is related to the way SWIG needs to be called to +dynamically generate the C bindings for GPGME in the first place. So +the entire process will always produce @samp{lang/python/python2-gpg/} and + at samp{lang/python/python3-gpg/} directories. These should contain the +build output generated during compilation, including the complete +bindings and module installed into @samp{site-packages}. + +Occasionally the errors in the early part or some other conflict +(e.g. not installing as @strong{@emph{root}} or @strong{@emph{su}}) may result in nothing +being installed to the relevant @samp{site-packages} directory and the +build directory missing a lot of expected files. Even when this +occurs, the solution is actually quite simple and will always work. + +That solution is simply to run the following commands as either the + at strong{root} user or prepended with @samp{sudo -H}@footnote{Yes, even if you use virtualenv with everything you do in +Python. If you want to install this module as just your user account +then you will need to manually configure, compile and install the + at emph{entire} GnuPG stack as that user as well. This includes libraries +which are not often installed that way. It can be done and there are +circumstances under which it is worthwhile, but generally only on +POSIX systems which utilise single user mode (some even require it).} in the @samp{lang/python/} +directory: + + at example +/path/to/pythonX.Y setup.py build +/path/to/pythonX.Y setup.py build +/path/to/pythonX.Y setup.py install + at end example + +Yes, the build command does need to be run twice. Yes, you still need +to run the potentially failing or incomplete steps during the + at samp{configure}, @samp{make} and @samp{make install} steps with installing GPGME. +This is because those steps generate a lot of essential files needed, +both by and in order to create, the bindings (including both the + at samp{setup.py} and @samp{gpgme.h} files). + + at enumerate + at item +IMPORTANT Note + + +If specifying a selected number of languages to create bindings for, +try to leave Python last. Currently the majority of the other +language bindings are also preceding Python of either version when +listed alphabetically and so that just happens by default currently. + +If Python is set to precede one of the other languages then it is +possible that the errors described here may interrupt the build +process before generating bindings for those other languages. In +these cases it may be preferable to configure all preferred language +bindings separately with alternative @samp{configure} steps for GPGME using +the @samp{--enable-languages=$LANGUAGE} option. + at end enumerate + + at node Multiple installations + at subsection Multiple installations + +For a veriety of reasons it may be either necessary or just preferable +to install the bindings to alternative installed Python versions which +meet the requirements of these bindings. + +On POSIX systems this will generally be most simply achieved by +running the manual installation commands (build, build, install) as +described in the previous section for each Python installation the +bindings need to be installed to. + +As per the SWIG documentation: the compilers, libraries and runtime +used to build GPGME and the Python Bindings @strong{must} match those used to +compile Python itself, including the version number(s) (at least going +by major version numbers and probably minor numbers too). + +On most POSIX systems, including OS X, this will very likely be the +case in most, if not all, cases. + + at node Won't Work With Windows + at subsection Won't Work With Windows + +There are semi-regular reports of Windows users having considerable +difficulty in installing and using the Python bindings at all. Very +often, possibly even always, these reports come from Cygwin users +and/or MinGW users and/or Msys2 users. Though not all of them have +been confirmed, it appears that these reports have also come from +people who installed Python using the Windows installer files from the + at uref{https://python.org, Python website} (i.e. mostly MSI installers, sometimes self-extracting + at samp{.exe} files). + +The Windows versions of Python are not built using Cygwin, MinGW or +Msys2; they're built using Microsoft Visual Studio. Furthermore the +version used is @emph{considerably} more advanced than the version which +MinGW obtained a small number of files from many years ago in order to +be able to compile anything at all. Not only that, but there are +changes to the version of Visual Studio between some micro releases, +though that is is particularly the case with Python 2.7, since it has +been kept around far longer than it should have been. + +There are two theoretical solutions to this issue: + + at enumerate + at item +Compile and install the GnuPG stack, including GPGME and the +Python bibdings using the same version of Microsoft Visual Studio +used by the Python Foundation to compile the version of Python +installed. + +If there are multiple versions of Python then this will need to be +done with each different version of Visual Studio used. + + at item +Compile and install Python using the same tools used by choice, +such as MinGW or Msys2. + at end enumerate + +Do @strong{not} use the official Windows installer for Python unless +following the first method. + +In this type of situation it may even be for the best to accept that +there are less limitations on permissive software than free software +and simply opt to use a recent version of the Community Edition of +Microsoft Visual Studio to compile and build all of it, no matter +what. + +Investigations into the extent or the limitations of this issue are +ongoing. + + at node I don't like SWIG Use CFFI instead + at subsection I don't like SWIG, Use CFFI instead + +There are many reasons for favouring @uref{https://cffi.readthedocs.io/en/latest/overview.html, CFFI} and proponents of it are +quite happy to repeat these things as if all it would take to switch +from SWIG to CFFI is repeating that list as if it were a new concept. + +The fact is that there are things which Python's CFFI implementation +cannot handle in the GPGME C code. Beyond that there are features of +SWIG which are simply not available with CFFI at all. SWIG generates +the bindings to Python using the @samp{gpgme.h} file, but that file is not +a single version shipped with each release, it too is generated when +GPGME is compiled. + +CFFI is currently unable to adapt to such a potentially mutable +codebase. If there were some means of applying SWIG's dynamic code +generation to produce the Python/CFFI API modes of accessing the GPGME +libraries (or the source source code directly), but such a thing does +not exist yet either and it currently appears that work is needed in +at least one of CFFI's dependencies before any of this can be +addressed. + +So if you're a massive fan of CFFI; that's great, but if you want this +project to switch to CFFI then rather than just insisting that it +should, I'd suggest you volunteer to bring CFFI up to the level this +project needs. + +If you're actually seriously considering doing so, then I'd suggest +taking the @samp{gpgme-tool.c} file in the GPGME @samp{src/} directory and +getting that to work with any of the CFFI API methods (not the ABI +methods, they'll work with pretty much anything). When you start +running into trouble with "ifdefs" then you'll know what sort of +things are lacking. That doesn't even take into account the amount of +work saved via SWIG's code generation techniques either. + + at node Fundamentals + at chapter Fundamentals + +Before we can get to the fun stuff, there are a few matters regarding +GPGME's design which hold true whether you're dealing with the C code +directly or these Python bindings. + + at menu +* No REST:: +* Context:: + at end menu + + at node No REST + at section No REST + +The first part of which is or will be fairly blatantly obvious upon +viewing the first example, but it's worth reiterating anyway. That +being that this API is @emph{@strong{not}} a REST API. Nor indeed could it ever +be one. + +Most, if not all, Python programmers (and not just Python programmers) +know how easy it is to work with a RESTful API. In fact they've +become so popular that many other APIs attempt to emulate REST-like +behaviour as much as they are able. Right down to the use of JSON +formatted output to facilitate the use of their API without having to +retrain developers. + +This API does not do that. It would not be able to do that and also +provide access to the entire C API on which it's built. It does, +however, provide a very pythonic interface on top of the direct +bindings and it's this pythonic layer that this HOWTO deals with. + + at node Context + at section Context + +One of the reasons which prevents this API from being RESTful is that +most operations require more than one instruction to the API to +perform the task. Sure, there are certain functions which can be +performed simultaneously, particularly if the result known or strongly +anticipated (e.g. selecting and encrypting to a key known to be in the +public keybox). + +There are many more, however, which cannot be manipulated so readily: +they must be performed in a specific sequence and the result of one +operation has a direct bearing on the outcome of subsequent +operations. Not merely by generating an error either. + +When dealing with this type of persistent state on the web, full of +both the RESTful and REST-like, it's most commonly referred to as a +session. In GPGME, however, it is called a context and every +operation type has one. + + at node Working with keys + at chapter Working with keys + + at menu +* Key selection:: +* Get key:: +* Importing keys:: +* Exporting keys:: + at end menu + + at node Key selection + at section Key selection + +Selecting keys to encrypt to or to sign with will be a common +occurrence when working with GPGMe and the means available for doing +so are quite simple. + +They do depend on utilising a Context; however once the data is +recorded in another variable, that Context does not need to be the +same one which subsequent operations are performed. + +The easiest way to select a specific key is by searching for that +key's key ID or fingerprint, preferably the full fingerprint without +any spaces in it. A long key ID will probably be okay, but is not +advised and short key IDs are already a problem with some being +generated to match specific patterns. It does not matter whether the +pattern is upper or lower case. + +So this is the best method: + + at example +import gpg + +k = gpg.Context().keylist(pattern="258E88DCBD3CD44D8E7AB43F6ECB6AF0DEADBEEF") +keys = list(k) + at end example + +This is passable and very likely to be common: + + at example +import gpg + +k = gpg.Context().keylist(pattern="0x6ECB6AF0DEADBEEF") +keys = list(k) + at end example + +And this is a really bad idea: + + at example +import gpg + +k = gpg.Context().keylist(pattern="0xDEADBEEF") +keys = list(k) + at end example + +Alternatively it may be that the intention is to create a list of keys +which all match a particular search string. For instance all the +addresses at a particular domain, like this: + + at example +import gpg + +ncsc = gpg.Context().keylist(pattern="ncsc.mil") +nsa = list(ncsc) + at end example + + at menu +* Counting keys:: + at end menu + + at node Counting keys + at subsection Counting keys + +Counting the number of keys in your public keybox (@samp{pubring.kbx}), the +format which has superseded the old keyring format (@samp{pubring.gpg} and + at samp{secring.gpg}), or the number of secret keys is a very simple task. + + at example +import gpg + +c = gpg.Context() +seckeys = c.keylist(pattern=None, secret=True) +pubkeys = c.keylist(pattern=None, secret=False) + +seclist = list(seckeys) +secnum = len(seclist) + +publist = list(pubkeys) +pubnum = len(publist) + +print(""" + Number of secret keys: @{0@} + Number of public keys: @{1@} +""".format(secnum, pubnum)) + at end example + + at node Get key + at section Get key + +An alternative method of getting a single key via its fingerprint is +available directly within a Context with @samp{Context().get_key}. This is +the preferred method of selecting a key in order to modify it, sign or +certify it and for obtaining relevant data about a single key as a +part of other functions; when verifying a signature made by that key, +for instance. + +By default this method will select public keys, but it can select +secret keys as well. + +This first example demonstrates selecting the current key of Werner +Koch, which is due to expire at the end of 2018: + + at example +import gpg + +fingerprint = "80615870F5BAD690333686D0F2AD85AC1E42B367" +key = gpg.Context().get_key(fingerprint) + at end example + +Whereas this example demonstrates selecting the author's current key +with the @samp{secret} key word argument set to @samp{True}: + + at example +import gpg + +fingerprint = "DB4724E6FA4286C92B4E55C4321E4E2373590E5D" +key = gpg.Context().get_key(fingerprint, secret=True) + at end example + +It is, of course, quite possible to select expired, disabled and +revoked keys with this function, but only to effectively display +information about those keys. + +It is also possible to use both unicode or string literals and byte +literals with the fingerprint when getting a key in this way. + + at node Importing keys + at section Importing keys + +Importing keys is possible with the @samp{key_import()} method and takes +one argument which is a bytes literal object containing either the +binary or ASCII armoured key data for one or more keys. + +The following example retrieves one or more keys from the SKS +keyservers via the web using the requests module. Since requests +returns the content as a bytes literal object, we can then use that +directly to import the resulting data into our keybox. + + at example +import gpg +import os.path +import requests + +c = gpg.Context() +url = "https://sks-keyservers.net/pks/lookup" +pattern = input("Enter the pattern to search for key or user IDs: ") +payload = @{ "op": "get", "search": pattern @} + +r = requests.get(url, verify=True, params=payload) +result = c.key_import(r.content) + +if result is not None and hasattr(result, "considered") is False: + print(result) +elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" + The total number of keys considered for import was: @{0@} + + Number of keys revoked: @{1@} + Number of new signatures: @{2@} + Number of new subkeys: @{3@} + Number of new user IDs: @{4@} + Number of new secret keys: @{5@} + Number of unchanged keys: @{6@} + + The key IDs for all considered keys were: +""".format(num_keys, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print("@{0@}\n".format(result.imports[i].fpr)) +else: + pass + at end example + + at strong{NOTE:} When searching for a key ID of any length or a fingerprint +(without spaces), the SKS servers require the the leading @samp{0x} +indicative of hexadecimal be included. Also note that the old short +key IDs (e.g. @samp{0xDEADBEEF}) should no longer be used due to the +relative ease by which such key IDs can be reproduced, as demonstrated +by the Evil32 Project in 2014 (which was subsequently exploited in +2016). + +Here is a variation on the above which checks the constrained +ProtonMail keyserver for ProtonMail public keys. + + at example +import gpg +import requests +import sys + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. +""") + +c = gpg.Context(armor=True) +url = "https://api.protonmail.ch/pks/lookup" +ksearch = [] + +if len(sys.argv) >= 2: + keyterm = sys.argv[1] +else: + keyterm = input("Enter the key ID, UID or search string: ") + +if keyterm.count("@@") == 2 and keyterm.startswith("@@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) +elif keyterm.count("@@") == 1 and keyterm.startswith("@@") is True: + ksearch.append("@{0@}@@protonmail.com".format(keyterm[1:])) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm[1:])) + ksearch.append("@{0@}@@pm.me".format(keyterm[1:])) +elif keyterm.count("@@") == 0: + ksearch.append("@{0@}@@protonmail.com".format(keyterm)) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm)) + ksearch.append("@{0@}@@pm.me".format(keyterm)) +elif keyterm.count("@@") == 2 and keyterm.startswith("@@") is False: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) +elif keyterm.count("@@") > 2: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) +else: + ksearch.append(keyterm) + +for k in ksearch: + payload = @{"op": "get", "search": k@} + try: + r = requests.get(url, verify=True, params=payload) + if r.ok is True: + result = c.key_import(r.content) + elif r.ok is False: + result = r.content + except Exception as e: + result = None + + if result is not None and hasattr(result, "considered") is False: + print("@{0@} for @{1@}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: @{0@} + +With UIDs wholely or partially matching the following string: + + @{1@} + + Number of keys revoked: @{2@} + Number of new signatures: @{3@} + Number of new subkeys: @{4@} + Number of new user IDs: @{5@} +Number of new secret keys: @{6@} + Number of unchanged keys: @{7@} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + print(e) + at end example + +Both the above example, @uref{../examples/howto/pmkey-import.py, pmkey-import.py}, and a version which prompts +for an alternative GnuPG home directory, @uref{../examples/howto/pmkey-import-alt.py, pmkey-import-alt.py}, are +available with the other examples and are executable scripts. + +Note that while the ProtonMail servers are based on the SKS servers, +their server is related more to their API and is not feature complete +by comparison to the servers in the SKS pool. One notable difference +being that the ProtonMail server does not permit non ProtonMail users +to update their own keys, which could be a vector for attacking +ProtonMail users who may not receive a key's revocation if it had been +compromised. + + at node Exporting keys + at section Exporting keys + +Exporting keys remains a reasonably simple task, but has been +separated into three different functions for the OpenPGP cryptographic +engine. Two of those functions are for exporting public keys and the +third is for exporting secret keys. + + at menu +* Exporting public keys:: +* Exporting secret keys:: + at end menu + + at node Exporting public keys + at subsection Exporting public keys + +There are two methods of exporting public keys, both of which are very +similar to the other. The default method, @samp{key_export()}, will export +a public key or keys matching a specified pattern as normal. The +alternative, the @samp{key_export_minimal()} method, will do the same thing +except producing a minimised output with extra signatures and third +party signatures or certifications removed. + + at example +import gpg +import os.path +import sys + +print(""" +This script exports one or more public keys. +""") + +c = gpg.Context(armor=True) + +if len(sys.argv) >= 4: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = sys.argv[3] +elif len(sys.argv) == 3: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = input("Enter the GPG configuration directory path (optional): ") +elif len(sys.argv) == 2: + keyfile = sys.argv[1] + logrus = input("Enter the UID matching the key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") +else: + keyfile = input("Enter the path and filename to save the secret key to: ") + logrus = input("Enter the UID matching the key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + +if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.expanduser(homedir) + else: + pass +elif os.path.exists(homedir) is True: + c.home_dir = homedir +else: + pass + +try: + result = c.key_export(pattern=logrus) +except: + result = c.key_export(pattern=None) + +if result is not None: + with open(keyfile, "wb") as f: + f.write(result) +else: + pass + at end example + +It is important to note that the result will only return @samp{None} when a +pattern has been entered for @samp{logrus}, but it has not matched any +keys. When the search pattern itself is set to @samp{None} this triggers +the exporting of the entire public keybox. + + at example +import gpg +import os.path +import sys + +print(""" +This script exports one or more public keys in minimised form. +""") + +c = gpg.Context(armor=True) + +if len(sys.argv) >= 4: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = sys.argv[3] +elif len(sys.argv) == 3: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = input("Enter the GPG configuration directory path (optional): ") +elif len(sys.argv) == 2: + keyfile = sys.argv[1] + logrus = input("Enter the UID matching the key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") +else: + keyfile = input("Enter the path and filename to save the secret key to: ") + logrus = input("Enter the UID matching the key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + +if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.expanduser(homedir) + else: + pass +elif os.path.exists(homedir) is True: + c.home_dir = homedir +else: + pass + +try: + result = c.key_export_minimal(pattern=logrus) +except: + result = c.key_export_minimal(pattern=None) + +if result is not None: + with open(keyfile, "wb") as f: + f.write(result) +else: + pass + at end example + + at node Exporting secret keys + at subsection Exporting secret keys + +Exporting secret keys is, functionally, very similar to exporting +public keys; save for the invocation of @samp{pinentry} via @samp{gpg-agent} in +order to securely enter the key's passphrase and authorise the export. + +The following example exports the secret key to a file which is then +set with the same permissions as the output files created by the +command line secret key export options. + + at example +import gpg +import os +import os.path +import sys + +print(""" +This script exports one or more secret keys. + +The gpg-agent and pinentry are invoked to authorise the export. +""") + +c = gpg.Context(armor=True) + +if len(sys.argv) >= 4: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = sys.argv[3] +elif len(sys.argv) == 3: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = input("Enter the GPG configuration directory path (optional): ") +elif len(sys.argv) == 2: + keyfile = sys.argv[1] + logrus = input("Enter the UID matching the secret key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") +else: + keyfile = input("Enter the path and filename to save the secret key to: ") + logrus = input("Enter the UID matching the secret key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + +if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.expanduser(homedir) + else: + pass +elif os.path.exists(homedir) is True: + c.home_dir = homedir +else: + pass + +try: + result = c.key_export_secret(pattern=logrus) +except: + result = c.key_export_secret(pattern=None) + +if result is not None: + with open(keyfile, "wb") as f: + f.write(result) + os.chmod(keyfile, 0o600) +else: + pass + at end example + +Alternatively the approach of the following script can be used. This +longer example saves the exported secret key(s) in files in the GnuPG +home directory, in addition to setting the file permissions as only +readable and writable by the user. It also exports the secret key(s) +twice in order to output both GPG binary (@samp{.gpg}) and ASCII armoured +(@samp{.asc}) files. + + at example +import gpg +import os +import os.path +import subprocess +import sys + +print(""" +This script exports one or more secret keys as both ASCII armored and binary +file formats, saved in files within the user's GPG home directory. + +The gpg-agent and pinentry are invoked to authorise the export. +""") + +if sys.platform == "win32": + gpgconfcmd = "gpgconf.exe --list-dirs homedir" +else: + gpgconfcmd = "gpgconf --list-dirs homedir" + +a = gpg.Context(armor=True) +b = gpg.Context() +c = gpg.Context() + +if len(sys.argv) >= 4: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = sys.argv[3] +elif len(sys.argv) == 3: + keyfile = sys.argv[1] + logrus = sys.argv[2] + homedir = input("Enter the GPG configuration directory path (optional): ") +elif len(sys.argv) == 2: + keyfile = sys.argv[1] + logrus = input("Enter the UID matching the secret key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") +else: + keyfile = input("Enter the filename to save the secret key to: ") + logrus = input("Enter the UID matching the secret key(s) to export: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + +if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.expanduser(homedir) + else: + pass +elif os.path.exists(homedir) is True: + c.home_dir = homedir +else: + pass + +if c.home_dir is not None: + if c.home_dir.endswith("/"): + gpgfile = "@{0@}@{1@}.gpg".format(c.home_dir, keyfile) + ascfile = "@{0@}@{1@}.asc".format(c.home_dir, keyfile) + else: + gpgfile = "@{0@}/@{1@}.gpg".format(c.home_dir, keyfile) + ascfile = "@{0@}/@{1@}.asc".format(c.home_dir, keyfile) +else: + if os.path.exists(os.environ["GNUPGHOME"]) is True: + hd = os.environ["GNUPGHOME"] + else: + try: + hd = subprocess.getoutput(gpgconfcmd) + except: + process = subprocess.Popen(gpgconfcmd.split(), + stdout=subprocess.PIPE) + procom = process.communicate() + if sys.version_info[0] == 2: + hd = procom[0].strip() + else: + hd = procom[0].decode().strip() + gpgfile = "@{0@}/@{1@}.gpg".format(hd, keyfile) + ascfile = "@{0@}/@{1@}.asc".format(hd, keyfile) + +try: + a_result = a.key_export_secret(pattern=logrus) + b_result = b.key_export_secret(pattern=logrus) +except: + a_result = a.key_export_secret(pattern=None) + b_result = b.key_export_secret(pattern=None) + +if a_result is not None: + with open(ascfile, "wb") as f: + f.write(a_result) + os.chmod(ascfile, 0o600) +else: + pass + +if b_result is not None: + with open(gpgfile, "wb") as f: + f.write(b_result) + os.chmod(gpgfile, 0o600) +else: + pass + at end example + + at node Basic Functions + at chapter Basic Functions + +The most frequently called features of any cryptographic library will +be the most fundamental tasks for encryption software. In this +section we will look at how to programmatically encrypt data, decrypt +it, sign it and verify signatures. + + at menu +* Encryption:: +* Decryption:: +* Signing text and files:: +* Signature verification:: + at end menu + + at node Encryption + at section Encryption + +Encrypting is very straight forward. In the first example below the +message, @samp{text}, is encrypted to a single recipient's key. In the +second example the message will be encrypted to multiple recipients. + + at menu +* Encrypting to one key:: +* Encrypting to multiple keys:: + at end menu + + at node Encrypting to one key + at subsection Encrypting to one key + +Once the the Context is set the main issues with encrypting data is +essentially reduced to key selection and the keyword arguments +specified in the @samp{gpg.Context().encrypt()} method. + +Those keyword arguments are: @samp{recipients}, a list of keys encrypted to +(covered in greater detail in the following section); @samp{sign}, whether +or not to sign the plaintext data, see subsequent sections on signing +and verifying signatures below (defaults to @samp{True}); @samp{sink}, to write +results or partial results to a secure sink instead of returning it +(defaults to @samp{None}); @samp{passphrase}, only used when utilising symmetric +encryption (defaults to @samp{None}); @samp{always_trust}, used to override the +trust model settings for recipient keys (defaults to @samp{False}); + at samp{add_encrypt_to}, utilises any preconfigured @samp{encrypt-to} or + at samp{default-key} settings in the user's @samp{gpg.conf} file (defaults to + at samp{False}); @samp{prepare}, prepare for encryption (defaults to @samp{False}); + at samp{expect_sign}, prepare for signing (defaults to @samp{False}); @samp{compress}, +compresses the plaintext prior to encryption (defaults to @samp{True}). + + at example +import gpg + +a_key = "0x12345678DEADBEEF" +text = b"""Some text to test with. + +Since the text in this case must be bytes, it is most likely that +the input form will be a separate file which is opened with "rb" +as this is the simplest method of obtaining the correct data format. +""" + +c = gpg.Context(armor=True) +rkey = list(c.keylist(pattern=a_key, secret=False)) +ciphertext, result, sign_result = c.encrypt(text, recipients=rkey, sign=False) + +with open("secret_plans.txt.asc", "wb") as afile: + afile.write(ciphertext) + at end example + +Though this is even more likely to be used like this; with the +plaintext input read from a file, the recipient keys used for +encryption regardless of key trust status and the encrypted output +also encrypted to any preconfigured keys set in the @samp{gpg.conf} file: + + at example +import gpg + +a_key = "0x12345678DEADBEEF" + +with open("secret_plans.txt", "rb") as afile: + text = afile.read() + +c = gpg.Context(armor=True) +rkey = list(c.keylist(pattern=a_key, secret=False)) +ciphertext, result, sign_result = c.encrypt(text, recipients=rkey, sign=True, + always_trust=True, + add_encrypt_to=True) + +with open("secret_plans.txt.asc", "wb") as afile: + afile.write(ciphertext) + at end example + +If the @samp{recipients} paramater is empty then the plaintext is encrypted +symmetrically. If no @samp{passphrase} is supplied as a parameter or via a +callback registered with the @samp{Context()} then an out-of-band prompt +for the passphrase via pinentry will be invoked. + + at node Encrypting to multiple keys + at subsection Encrypting to multiple keys + +Encrypting to multiple keys essentially just expands upon the key +selection process and the recipients from the previous examples. + +The following example encrypts a message (@samp{text}) to everyone with an +email address on the @samp{gnupg.org} domain, at footnote{You probably don't really want to do this. Searching the +keyservers for "gnupg.org" produces over 400 results, the majority of +which aren't actually at the gnupg.org domain, but just included a +comment regarding the project in their key somewhere.} but does @emph{not} encrypt +to a default key or other key which is configured to normally encrypt +to. + + at example +import gpg + +text = b"""Oh look, another test message. + +The same rules apply as with the previous example and more likely +than not, the message will actually be drawn from reading the +contents of a file or, maybe, from entering data at an input() +prompt. + +Since the text in this case must be bytes, it is most likely that +the input form will be a separate file which is opened with "rb" +as this is the simplest method of obtaining the correct data +format. +""" + +c = gpg.Context(armor=True) +rpattern = list(c.keylist(pattern="@@gnupg.org", secret=False)) +logrus = [] + +for i in range(len(rpattern)): + if rpattern[i].can_encrypt == 1: + logrus.append(rpattern[i]) + +ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, + sign=False, always_trust=True) + +with open("secret_plans.txt.asc", "wb") as afile: + afile.write(ciphertext) + at end example + +All it would take to change the above example to sign the message +and also encrypt the message to any configured default keys would +be to change the @samp{c.encrypt} line to this: + + at example +ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, + always_trust=True, + add_encrypt_to=True) + at end example + +The only keyword arguments requiring modification are those for which +the default values are changing. The default value of @samp{sign} is + at samp{True}, the default of @samp{always_trust} is @samp{False}, the default of + at samp{add_encrypt_to} is @samp{False}. + +If @samp{always_trust} is not set to @samp{True} and any of the recipient keys +are not trusted (e.g. not signed or locally signed) then the +encryption will raise an error. It is possible to mitigate this +somewhat with something more like this: + + at example +import gpg + +with open("secret_plans.txt.asc", "rb") as afile: + text = afile.read() + +c = gpg.Context(armor=True) +rpattern = list(c.keylist(pattern="@@gnupg.org", secret=False)) +logrus = [] + +for i in range(len(rpattern)): + if rpattern[i].can_encrypt == 1: + logrus.append(rpattern[i]) + + try: + ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, + add_encrypt_to=True) + except gpg.errors.InvalidRecipients as e: + for i in range(len(e.recipients)): + for n in range(len(logrus)): + if logrus[n].fpr == e.recipients[i].fpr: + logrus.remove(logrus[n]) + else: + pass + try: + ciphertext, result, sign_result = c.encrypt(text, + recipients=logrus, + add_encrypt_to=True) + with open("secret_plans.txt.asc", "wb") as afile: + afile.write(ciphertext) + except: + pass + at end example + +This will attempt to encrypt to all the keys searched for, then remove +invalid recipients if it fails and try again. + + at node Decryption + at section Decryption + +Decrypting something encrypted to a key in one's secret keyring is +fairly straight forward. + +In this example code, however, preconfiguring either @samp{gpg.Context()} +or @samp{gpg.core.Context()} as @samp{c} is unnecessary because there is no need +to modify the Context prior to conducting the decryption and since the +Context is only used once, setting it to @samp{c} simply adds lines for no +gain. + + at example +import gpg + +ciphertext = input("Enter path and filename of encrypted file: ") +newfile = input("Enter path and filename of file to save decrypted data to: ") + +with open(ciphertext, "rb") as cfile: + try: + plaintext, result, verify_result = gpg.Context().decrypt(cfile) + except gpg.errors.GPGMEError as e: + plaintext = None + print(e) + +if plaintext is not None: + with open(newfile, "wb") as nfile: + nfile.write(plaintext) + else: + pass + at end example + +The data available in @samp{plaintext} in this example is the decrypted +content as a byte object, the recipient key IDs and algorithms in + at samp{result} and the results of verifying any signatures of the data in + at samp{verify_result}. + + at node Signing text and files + at section Signing text and files + +The following sections demonstrate how to specify keys to sign with. + + at menu +* Signing key selection:: +* Normal or default signing messages or files:: +* Detached signing messages and files:: +* Clearsigning messages or text:: + at end menu + + at node Signing key selection + at subsection Signing key selection + +By default GPGME and the Python bindings will use the default key +configured for the user invoking the GPGME API. If there is no +default key specified and there is more than one secret key available +it may be necessary to specify the key or keys with which to sign +messages and files. + + at example +import gpg + +logrus = input("Enter the email address or string to match signing keys to: ") +hancock = gpg.Context().keylist(pattern=logrus, secret=True) +sig_src = list(hancock) + at end example + +The signing examples in the following sections include the explicitly +designated @samp{signers} parameter in two of the five examples; once where +the resulting signature would be ASCII armoured and once where it +would not be armoured. + +While it would be possible to enter a key ID or fingerprint here to +match a specific key, it is not possible to enter two fingerprints and +match two keys since the patten expects a string, bytes or None and +not a list. A string with two fingerprints won't match any single +key. + + at node Normal or default signing messages or files + at subsection Normal or default signing messages or files + +The normal or default signing process is essentially the same as is +most often invoked when also encrypting a message or file. So when +the encryption component is not utilised, the result is to produce an +encoded and signed output which may or may not be ASCII armoured and +which may or may not also be compressed. + +By default compression will be used unless GnuPG detects that the +plaintext is already compressed. ASCII armouring will be determined +according to the value of @samp{gpg.Context().armor}. + +The compression algorithm is selected in much the same way as the +symmetric encryption algorithm or the hash digest algorithm is when +multiple keys are involved; from the preferences saved into the key +itself or by comparison with the preferences with all other keys +involved. + + at example +import gpg + +text0 = """Declaration of ... something. + +""" +text = text0.encode() + +c = gpg.Context(armor=True, signers=sig_src) +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL) + +with open("/path/to/statement.txt.asc", "w") as afile: + afile.write(signed_data.decode()) + at end example + +Though everything in this example is accurate, it is more likely that +reading the input data from another file and writing the result to a +new file will be performed more like the way it is done in the next +example. Even if the output format is ASCII armoured. + + at example +import gpg + +with open("/path/to/statement.txt", "rb") as tfile: + text = tfile.read() + +c = gpg.Context() +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL) + +with open("/path/to/statement.txt.sig", "wb") as afile: + afile.write(signed_data) + at end example + + at node Detached signing messages and files + at subsection Detached signing messages and files + +Detached signatures will often be needed in programmatic uses of +GPGME, either for signing files (e.g. tarballs of code releases) or as +a component of message signing (e.g. PGP/MIME encoded email). + + at example +import gpg + +text0 = """Declaration of ... something. + +""" +text = text0.encode() + +c = gpg.Context(armor=True) +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH) + +with open("/path/to/statement.txt.asc", "w") as afile: + afile.write(signed_data.decode()) + at end example + +As with normal signatures, detached signatures are best handled as +byte literals, even when the output is ASCII armoured. + + at example +import gpg + +with open("/path/to/statement.txt", "rb") as tfile: + text = tfile.read() + +c = gpg.Context(signers=sig_src) +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH) + +with open("/path/to/statement.txt.sig", "wb") as afile: + afile.write(signed_data) + at end example + + at node Clearsigning messages or text + at subsection Clearsigning messages or text + +Though PGP/in-line messages are no longer encouraged in favour of +PGP/MIME, there is still sometimes value in utilising in-line +signatures. This is where clear-signed messages or text is of value. + + at example +import gpg + +text0 = """Declaration of ... something. + +""" +text = text0.encode() + +c = gpg.Context() +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR) + +with open("/path/to/statement.txt.asc", "w") as afile: + afile.write(signed_data.decode()) + at end example + +In spite of the appearance of a clear-signed message, the data handled +by GPGME in signing it must still be byte literals. + + at example +import gpg + +with open("/path/to/statement.txt", "rb") as tfile: + text = tfile.read() + +c = gpg.Context() +signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR) + +with open("/path/to/statement.txt.asc", "wb") as afile: + afile.write(signed_data) + at end example + + at node Signature verification + at section Signature verification + +Essentially there are two principal methods of verification of a +signature. The first of these is for use with the normal or default +signing method and for clear-signed messages. The second is for use +with files and data with detached signatures. + +The following example is intended for use with the default signing +method where the file was not ASCII armoured: + + at example +import gpg +import time + +filename = "statement.txt" +gpg_file = "statement.txt.gpg" + +c = gpg.Context() + +try: + data, result = c.verify(open(gpg_file)) + verified = True +except gpg.errors.BadSignatures as e: + verified = False + print(e) + +if verified is True: + for i in range(len(result.signatures)): + sign = result.signatures[i] + print("""Good signature from: +@{0@} +with key @{1@} +made at @{2@} +""".format(c.get_key(sign.fpr).uids[0].uid, sign.fpr, + time.ctime(sign.timestamp))) +else: + pass + at end example + +Whereas this next example, which is almost identical would work with +normal ASCII armoured files and with clear-signed files: + + at example +import gpg +import time + +filename = "statement.txt" +asc_file = "statement.txt.asc" + +c = gpg.Context() + +try: + data, result = c.verify(open(asc_file)) + verified = True +except gpg.errors.BadSignatures as e: + verified = False + print(e) + +if verified is True: + for i in range(len(result.signatures)): + sign = result.signatures[i] + print("""Good signature from: +@{0@} +with key @{1@} +made at @{2@} +""".format(c.get_key(sign.fpr).uids[0].uid, sign.fpr, + time.ctime(sign.timestamp))) +else: + pass + at end example + +In both of the previous examples it is also possible to compare the +original data that was signed against the signed data in @samp{data} to see +if it matches with something like this: + + at example +with open(filename, "rb") as afile: + text = afile.read() + +if text == data: + print("Good signature.") +else: + pass + at end example + +The following two examples, however, deal with detached signatures. +With his method of verification the data that was signed does not get +returned since it is already being explicitly referenced in the first +argument of @samp{c.verify}. So @samp{data} is @samp{None} and only the information +in @samp{result} is available. + + at example +import gpg +import time + +filename = "statement.txt" +sig_file = "statement.txt.sig" + +c = gpg.Context() + +try: + data, result = c.verify(open(filename), open(sig_file)) + verified = True +except gpg.errors.BadSignatures as e: + verified = False + print(e) + +if verified is True: + for i in range(len(result.signatures)): + sign = result.signatures[i] + print("""Good signature from: +@{0@} +with key @{1@} +made at @{2@} +""".format(c.get_key(sign.fpr).uids[0].uid, sign.fpr, + time.ctime(sign.timestamp))) +else: + pass + at end example + + at example +import gpg +import time + +filename = "statement.txt" +asc_file = "statement.txt.asc" + +c = gpg.Context() + +try: + data, result = c.verify(open(filename), open(asc_file)) + verified = True +except gpg.errors.BadSignatures as e: + verified = False + print(e) + +if verified is True: + for i in range(len(result.signatures)): + sign = result.signatures[i] + print("""Good signature from: +@{0@} +with key @{1@} +made at @{2@} +""".format(c.get_key(sign.fpr).uids[0].uid, sign.fpr, + time.ctime(sign.timestamp))) +else: + pass + at end example + + at node Creating keys and subkeys + at chapter Creating keys and subkeys + +The one thing, aside from GnuPG itself, that GPGME depends on, of +course, is the keys themselves. So it is necessary to be able to +generate them and modify them by adding subkeys, revoking or disabling +them, sometimes deleting them and doing the same for user IDs. + +In the following examples a key will be created for the world's +greatest secret agent, Danger Mouse. Since Danger Mouse is a secret +agent he needs to be able to protect information to @samp{SECRET} level +clearance, so his keys will be 3072-bit keys. + +The pre-configured @samp{gpg.conf} file which sets cipher, digest and other +preferences contains the following configuration parameters: + + at example +expert +allow-freeform-uid +allow-secret-key-import +trust-model tofu+pgp +tofu-default-policy unknown +enable-large-rsa +enable-dsa2 +cert-digest-algo SHA512 +default-preference-list TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1 ZLIB BZIP2 ZIP Uncompressed +personal-cipher-preferences TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES +personal-digest-preferences SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1 +personal-compress-preferences ZLIB BZIP2 ZIP Uncompressed + at end example + + at menu +* Primary key:: +* Subkeys:: +* User IDs:: +* Key certification:: + at end menu + + at node Primary key + at section Primary key + +Generating a primary key uses the @samp{create_key} method in a Context. +It contains multiple arguments and keyword arguments, including: + at samp{userid}, @samp{algorithm}, @samp{expires_in}, @samp{expires}, @samp{sign}, @samp{encrypt}, + at samp{certify}, @samp{authenticate}, @samp{passphrase} and @samp{force}. The defaults for +all of those except @samp{userid}, @samp{algorithm}, @samp{expires_in}, @samp{expires} and + at samp{passphrase} is @samp{False}. The defaults for @samp{algorithm} and + at samp{passphrase} is @samp{None}. The default for @samp{expires_in} is @samp{0}. The +default for @samp{expires} is @samp{True}. There is no default for @samp{userid}. + +If @samp{passphrase} is left as @samp{None} then the key will not be generated +with a passphrase, if @samp{passphrase} is set to a string then that will +be the passphrase and if @samp{passphrase} is set to @samp{True} then gpg-agent +will launch pinentry to prompt for a passphrase. For the sake of +convenience, these examples will keep @samp{passphrase} set to @samp{None}. + + at example +import gpg + +c = gpg.Context() + +c.home_dir = "~/.gnupg-dm" +userid = "Danger Mouse " + +dmkey = c.create_key(userid, algorithm="rsa3072", expires_in=31536000, + sign=True, certify=True) + at end example + +One thing to note here is the use of setting the @samp{c.home_dir} +parameter. This enables generating the key or keys in a different +location. In this case to keep the new key data created for this +example in a separate location rather than adding it to existing and +active key store data. As with the default directory, @samp{~/.gnupg}, any +temporary or separate directory needs the permissions set to only +permit access by the directory owner. On posix systems this means +setting the directory permissions to 700. + +The @samp{temp-homedir-config.py} script in the HOWTO examples directory +will create an alternative homedir with these configuration options +already set and the correct directory and file permissions. + +The successful generation of the key can be confirmed via the returned + at samp{GenkeyResult} object, which includes the following data: + + at example +print(""" + Fingerprint: @{0@} + Primary Key: @{1@} + Public Key: @{2@} + Secret Key: @{3@} + Sub Key: @{4@} +User IDs: @{5@} +""".format(dmkey.fpr, dmkey.primary, dmkey.pubkey, dmkey.seckey, dmkey.sub, + dmkey.uid)) + at end example + +Alternatively the information can be confirmed using the command line +program: + + at example +bash-4.4$ gpg --homedir ~/.gnupg-dm -K +~/.gnupg-dm/pubring.kbx +---------------------- +sec rsa3072 2018-03-15 [SC] [expires: 2019-03-15] + 177B7C25DB99745EE2EE13ED026D2F19E99E63AA +uid [ultimate] Danger Mouse + +bash-4.4$ + at end example + +As with generating keys manually, to preconfigure expanded preferences +for the cipher, digest and compression algorithms, the @samp{gpg.conf} file +must contain those details in the home directory in which the new key +is being generated. I used a cut down version of my own @samp{gpg.conf} +file in order to be able to generate this: + + at example +bash-4.4$ gpg --homedir ~/.gnupg-dm --edit-key 177B7C25DB99745EE2EE13ED026D2F19E99E63AA showpref quit +Secret key is available. + +sec rsa3072/026D2F19E99E63AA + created: 2018-03-15 expires: 2019-03-15 usage: SC + trust: ultimate validity: ultimate +[ultimate] (1). Danger Mouse + +[ultimate] (1). Danger Mouse + Cipher: TWOFISH, CAMELLIA256, AES256, CAMELLIA192, AES192, CAMELLIA128, AES, BLOWFISH, IDEA, CAST5, 3DES + Digest: SHA512, SHA384, SHA256, SHA224, RIPEMD160, SHA1 + Compression: ZLIB, BZIP2, ZIP, Uncompressed + Features: MDC, Keyserver no-modify + +bash-4.4$ + at end example + + at node Subkeys + at section Subkeys + +Adding subkeys to a primary key is fairly similar to creating the +primary key with the @samp{create_subkey} method. Most of the arguments +are the same, but not quite all. Instead of the @samp{userid} argument +there is now a @samp{key} argument for selecting which primary key to add +the subkey to. + +In the following example an encryption subkey will be added to the +primary key. Since Danger Mouse is a security conscious secret agent, +this subkey will only be valid for about six months, half the length +of the primary key. + + at example +import gpg + +c = gpg.Context() +c.home_dir = "~/.gnupg-dm" + +key = c.get_key(dmkey.fpr, secret=True) +dmsub = c.create_subkey(key, algorithm="rsa3072", expires_in=15768000, + encrypt=True) + at end example + +As with the primary key, the results here can be checked with: + + at example +print(""" + Fingerprint: @{0@} + Primary Key: @{1@} + Public Key: @{2@} + Secret Key: @{3@} + Sub Key: @{4@} +User IDs: @{5@} +""".format(dmsub.fpr, dmsub.primary, dmsub.pubkey, dmsub.seckey, dmsub.sub, + dmsub.uid)) + at end example + +As well as on the command line with: + + at example +bash-4.4$ gpg --homedir ~/.gnupg-dm -K +~/.gnupg-dm/pubring.kbx +---------------------- +sec rsa3072 2018-03-15 [SC] [expires: 2019-03-15] + 177B7C25DB99745EE2EE13ED026D2F19E99E63AA +uid [ultimate] Danger Mouse +ssb rsa3072 2018-03-15 [E] [expires: 2018-09-13] + +bash-4.4$ + at end example + + at node User IDs + at section User IDs + + at menu +* Adding User IDs:: +* Revokinging User IDs:: + at end menu + + at node Adding User IDs + at subsection Adding User IDs + +By comparison to creating primary keys and subkeys, adding a new user +ID to an existing key is much simpler. The method used to do this is + at samp{key_add_uid} and the only arguments it takes are for the @samp{key} and +the new @samp{uid}. + + at example +import gpg + +c = gpg.Context() +c.home_dir = "~/.gnupg-dm" + +dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA" +key = c.get_key(dmfpr, secret=True) +uid = "Danger Mouse " + +c.key_add_uid(key, uid) + at end example + +Unsurprisingly the result of this is: + + at example +bash-4.4$ gpg --homedir ~/.gnupg-dm -K +~/.gnupg-dm/pubring.kbx +---------------------- +sec rsa3072 2018-03-15 [SC] [expires: 2019-03-15] + 177B7C25DB99745EE2EE13ED026D2F19E99E63AA +uid [ultimate] Danger Mouse +uid [ultimate] Danger Mouse +ssb rsa3072 2018-03-15 [E] [expires: 2018-09-13] + +bash-4.4$ + at end example + + at node Revokinging User IDs + at subsection Revokinging User IDs + +Revoking a user ID is a fairly similar process, except that it uses +the @samp{key_revoke_uid} method. + + at example +import gpg + +c = gpg.Context() +c.home_dir = "~/.gnupg-dm" + +dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA" +key = c.get_key(dmfpr, secret=True) +uid = "Danger Mouse " + +c.key_revoke_uid(key, uid) + at end example + + at node Key certification + at section Key certification + +Since key certification is more frequently referred to as key signing, +the method used to perform this function is @samp{key_sign}. + +The @samp{key_sign} method takes four arguments: @samp{key}, @samp{uids}, + at samp{expires_in} and @samp{local}. The default value of @samp{uids} is @samp{None} and +which results in all user IDs being selected. The default value of +both @samp{expires_in} and @samp{local} is @samp{False}; which results in the +signature never expiring and being able to be exported. + +The @samp{key} is the key being signed rather than the key doing the +signing. To change the key doing the signing refer to the signing key +selection above for signing messages and files. + +If the @samp{uids} value is not @samp{None} then it must either be a string to +match a single user ID or a list of strings to match multiple user +IDs. In this case the matching of those strings must be precise and +it is case sensitive. + +To sign Danger Mouse's key for just the initial user ID with a +signature which will last a little over a month, do this: + + at example +import gpg + +c = gpg.Context() +uid = "Danger Mouse " + +dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA" +key = c.get_key(dmfpr, secret=True) +c.key_sign(key, uids=uid, expires_in=2764800) + at end example + + at node Miscellaneous work-arounds + at chapter Miscellaneous work-arounds + + at menu +* Group lines:: + at end menu + + at node Group lines + at section Group lines + +There is not yet an easy way to access groups configured in the +gpg.conf file from within GPGME. As a consequence these central +groupings of keys cannot be shared amongst multiple programs, such as +MUAs readily. + +The following code, however, provides a work-around for obtaining this +information in Python. + + at example +import subprocess +import sys + +try: + lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines() +except: + process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) + procom = process.communicate() + if sys.version_info[0] == 2: + lines = procom[0].splitlines() + else: + lines = procom[0].decode().splitlines() + +for i in range(len(lines)): + if lines[i].startswith("group") is True: + line = lines[i] + else: + pass + +groups = line.split(":")[-1].replace('"', '').split(',') + +group_lines = [] +group_lists = [] + +for i in range(len(groups)): + group_lines.append(groups[i].split("=")) + group_lists.append(groups[i].split("=")) + +for i in range(len(group_lists)): + group_lists[i][1] = group_lists[i][1].split() + at end example + +The result of that code is that @samp{group_lines} is a list of lists where + at samp{group_lines[i][0]} is the name of the group and @samp{group_lines[i][1]} +is the key IDs of the group as a string. + +The @samp{group_lists} result is very similar in that it is a list of +lists. The first part, @samp{group_lists[i][0]} matches + at samp{group_lines[i][0]} as the name of the group, but @samp{group_lists[i][1]} +is the key IDs of the group as a string. + +A demonstration of using the @samp{groups.py} module is also available in +the form of the executable @samp{mutt-groups.py} script. This second +script reads all the group entries in a user's @samp{gpg.conf} file and +converts them into crypt-hooks suitable for use with the Mutt and +Neomutt mail clients. + + at node Copyright and Licensing + at chapter Copyright and Licensing + + at menu +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* License GPL compatible:: + at end menu + + at node Copyright (C) The GnuPG Project 2018 + at section Copyright (C) The GnuPG Project, 2018 + +Copyright ? The GnuPG Project, 2018. + + at node License GPL compatible + at section License GPL compatible + +This file is free software; as a special exception the author gives +unlimited permission to copy and/or distribute it, with or without +modifications, as long as this notice is preserved. + +This file is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY, to the extent permitted by law; without even the +implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE. + + at bye ----------------------------------------------------------------------- Summary of changes: doc/Makefile.am | 7 +- .../gpgme-python-howto.texi | 1407 ++++++++++---------- doc/gpgme.texi | 2 +- gpgme.spec.in | 3 + 4 files changed, 745 insertions(+), 674 deletions(-) copy lang/python/docs/GPGMEpythonHOWTOen.org => doc/gpgme-python-howto.texi (64%) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 15 22:44:04 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sat, 15 Sep 2018 22:44:04 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-281-g76f7702 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 76f77022848894ee9d8490255cefdd0100248b45 (commit) via 7e9df9b9e33131f5d7c58ad58249f9ae766f1341 (commit) from 93a2ea0207fac0a18a48b671df11dc8575579c39 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 76f77022848894ee9d8490255cefdd0100248b45 Author: Ben McGinnes Date: Sun Sep 16 06:42:35 2018 +1000 docs: python howto texinfo update * doc/gpgme-python-howto.texi: diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 1f9a4b0..21da963 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -66,7 +66,7 @@ Known Issues * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. Fundamentals @@ -126,7 +126,7 @@ Miscellaneous work-arounds Copyright and Licensing -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end detailmenu @@ -390,7 +390,7 @@ they be encountered. * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. @end menu @node Breaking Builds @@ -2125,7 +2125,7 @@ Neomutt mail clients. @chapter Copyright and Licensing @menu -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end menu commit 7e9df9b9e33131f5d7c58ad58249f9ae766f1341 Author: Ben McGinnes Date: Sun Sep 16 06:35:02 2018 +1000 docs: Python howto update * lang/python/docs/GPGMEpythonHOWTOen.org: Added corresponding GPGME version number to table at the start and cut the shortcut from the groups.py example. * doc/gpgme-python-howto.texi: New export of Texinfo file for docs build. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 51c1bfe..1f9a4b0 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -66,7 +66,7 @@ Known Issues * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. Fundamentals @@ -126,7 +126,7 @@ Miscellaneous work-arounds Copyright and Licensing -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end detailmenu @@ -138,6 +138,8 @@ Copyright and Licensing @multitable {aaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item Version: @tab 0.1.4 + at item GPGME Version: + at tab 1.12.0-draft @item Author: @tab Ben McGinnes @item Author GPG Key: @@ -279,12 +281,9 @@ version 3.0 (or any later version). @subsection The PyME package maintained by Martin Albrecht This package is the origin of these bindings, though they are somewhat -different now. For details of when and how the PyME package was folded -back into GPGME itself see the @emph{Short History} -document at footnote{@samp{lang/python/docs/Short_History.org} and/or - at samp{lang/python/docs/Short_History.html}.} in the Python bindings - at samp{docs} directory. at footnote{The @samp{lang/python/docs/} directory -in the GPGME source.} +different now. For details of when and how the PyME package was +folded back into GPGME itself see the @emph{Short History} document at footnote{@samp{Short_History.org} and/or @samp{Short_History.html}.} +in the Python bindings @samp{docs} directory. at footnote{The @samp{lang/python/docs/} directory in the GPGME source.} The PyME package was first released in 2002 and was also the first attempt to implement a low level binding to GPGME. In doing so it @@ -391,7 +390,7 @@ they be encountered. * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. @end menu @node Breaking Builds @@ -2073,8 +2072,13 @@ information in Python. import subprocess import sys +if sys.platform == "win32": + gpgconfcmd = "gpgconf.exe --list-options gpg" +else: + gpgconfcmd = "gpgconf --list-options gpg" + try: - lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines() + lines = subprocess.getoutput(gpgconfcmd).splitlines() except: process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) procom = process.communicate() @@ -2121,7 +2125,7 @@ Neomutt mail clients. @chapter Copyright and Licensing @menu -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. * License GPL compatible:: @end menu diff --git a/lang/python/docs/GPGMEpythonHOWTOen.org b/lang/python/docs/GPGMEpythonHOWTOen.org index 1e5db6d..c9f1421 100644 --- a/lang/python/docs/GPGMEpythonHOWTOen.org +++ b/lang/python/docs/GPGMEpythonHOWTOen.org @@ -16,6 +16,7 @@ :END: | Version: | 0.1.4 | +| GPGME Version: | 1.12.0-draft | | Author: | Ben McGinnes | | Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E2373590E5D | | Language: | Australian English, British English | @@ -1982,8 +1983,13 @@ information in Python. import subprocess import sys +if sys.platform == "win32": + gpgconfcmd = "gpgconf.exe --list-options gpg" +else: + gpgconfcmd = "gpgconf --list-options gpg" + try: - lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines() + lines = subprocess.getoutput(gpgconfcmd).splitlines() except: process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) procom = process.communicate() ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 18 +++++++++++------- lang/python/docs/GPGMEpythonHOWTOen.org | 8 +++++++- 2 files changed, 18 insertions(+), 8 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 16 00:38:46 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 16 Sep 2018 00:38:46 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-282-g766ec0e Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 766ec0e4a36c120ed4ef5463b5fdf8e7ed3b4563 (commit) from 76f77022848894ee9d8490255cefdd0100248b45 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 766ec0e4a36c120ed4ef5463b5fdf8e7ed3b4563 Author: Ben McGinnes Date: Sun Sep 16 08:36:10 2018 +1000 docs: renaming and drafts * lang/python/docs/gpgme-python-howto.org: Renamed file to better fit the rest of the project's docs. * Added a section on the very unofficial drafts I periodically post links to since they're often the easiest way to get a web version in front of someone in a hurry. diff --git a/lang/python/docs/GPGMEpythonHOWTOen.org b/lang/python/docs/gpgme-python-howto.org similarity index 96% rename from lang/python/docs/GPGMEpythonHOWTOen.org rename to lang/python/docs/gpgme-python-howto.org index c9f1421..68538e4 100644 --- a/lang/python/docs/GPGMEpythonHOWTOen.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2047,6 +2047,40 @@ Neomutt mail clients. Copyright ? The GnuPG Project, 2018. +** Draft Editions of this HOWTO + :PROPERTIES: + :CUSTOM_ID: draft-editions + :END: + +Draft editions of this HOWTO may be periodically available directly +from the author at any of the following URLs: + +- [[https://files.au.adversary.org/crypto/gpgme-python-howto.html][GPGME Python Bindings HOWTO draft (XHTML AWS S3 SSL)]] +- [[http://files.au.adversary.org/crypto/gpgme-python-howto.html][GPGME Python Bindings HOWTO draft (XHTML AWS S3 no SSL)]] +- [[https://files.au.adversary.org/crypto/gpgme-python-howto.texi][GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 SSL)]] +- [[http://files.au.adversary.org/crypto/gpgme-python-howto.texi][GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 no SSL)]] +- [[https://files.au.adversary.org/crypto/gpgme-python-howto.info][GPGME Python Bindings HOWTO draft (Info file AWS S3 SSL)]] +- [[http://files.au.adversary.org/crypto/gpgme-python-howto.info][GPGME Python Bindings HOWTO draft (Info file AWS S3 no SSL)]] +- [[https://files.au.adversary.org/crypto/gpgme-python-howto.xml][GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 SSL)]] +- [[http://files.au.adversary.org/crypto/gpgme-python-howto.xml][GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 no SSL)]] + +All of these draft versions are generated from this document via Emacs +[[https://orgmode.org/][Org mode]] and [[https://www.gnu.org/software/texinfo/][GNU Texinfo]]. + +In addition to these there is a significantly less frequently updated +version as a HTML [[https://files.au.adversary.org/crypto/gpgme-python-howto/webhelp/index.html][WebHelp site]] (AWS S3 SSL); generated from DITA XML +source files, which can be found in [[https://dev.gnupg.org/source/gpgme/browse/ben%252Fhowto-dita/][an alternative branch]] of the GPGME +git repository. + +These draft editions are not official documents and the version of +documentation in the master branch or which ships with released +versions is the only official documentation. Nevertheless, these +draft editions may occasionally be of use by providing more accessible +web versions which are updated between releases. They are provided on +the understanding that they may contain errors or may contain content +subject to change prior to an official release. + + ** License GPL compatible :PROPERTIES: :CUSTOM_ID: license ----------------------------------------------------------------------- Summary of changes: ...GMEpythonHOWTOen.org => gpgme-python-howto.org} | 34 ++++++++++++++++++++++ 1 file changed, 34 insertions(+) rename lang/python/docs/{GPGMEpythonHOWTOen.org => gpgme-python-howto.org} (96%) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 16 01:49:37 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 16 Sep 2018 01:49:37 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-283-g91b26b0 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 91b26b0638d9f92f0e90aab1c3750c14d72db301 (commit) from 766ec0e4a36c120ed4ef5463b5fdf8e7ed3b4563 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 91b26b0638d9f92f0e90aab1c3750c14d72db301 Author: Ben McGinnes Date: Sun Sep 16 09:47:05 2018 +1000 docs: whitespace culled * lang/python/docs/gpgme-python-howto.org: Identified and fixed the headings which kept generating lines with trailing whitespace when exporting to Texinfo format and adjusted them to prevent that. diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 68538e4..1f5ceb2 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -17,7 +17,7 @@ | Version: | 0.1.4 | | GPGME Version: | 1.12.0-draft | -| Author: | Ben McGinnes | +| Author: | [[https://gnupg.org/people/index.html#sec-1-5][Ben McGinnes]] | | Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E2373590E5D | | Language: | Australian English, British English | | xml:lang: | en-AU, en-GB, en | @@ -401,7 +401,7 @@ Investigations into the extent or the limitations of this issue are ongoing. -*** I don't like SWIG, Use CFFI instead +*** CFFI is the Best? and GPGME should use it instead of SWIG :PROPERTIES: :CUSTOM_ID: snafu-cffi :END: @@ -438,6 +438,16 @@ running into trouble with "ifdefs" then you'll know what sort of things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. +There's a greater likelihood of turning to Cython to add something to +these bindings at this point than there is of turning to CFFI. Except +that there's little reason to do so when the C code in question either +already exists or could be produced fairly quickly by the far more +expedient means of asking either [[https://gnupg.org/people/index.html#sec-1-1][Werner]], [[https://gnupg.org/people/index.html#sec-1-3][Niibe]] or [[https://gnupg.org/people/index.html#sec-1-6][Andre]] to write +whatever was missing. Perhaps even [[https://gnupg.org/people/index.html#sec-1-4][Jussi]], but there shouldn't be any +need for these bindings to interface directly with his work and for +much the same reasons as we recommend people not call libgcrypt +directly unless they know what they're doing. + * Fundamentals :PROPERTIES: @@ -2033,19 +2043,21 @@ converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. -* Copyright and Licensing +* Copyright, Draft Editions and Licensing :PROPERTIES: :CUSTOM_ID: copyright-and-license :END: -** Copyright (C) The GnuPG Project, 2018 +** Copyright :PROPERTIES: :CUSTOM_ID: copyright :END: Copyright ? The GnuPG Project, 2018. +Copyright (C) The GnuPG Project, 2018. + ** Draft Editions of this HOWTO :PROPERTIES: ----------------------------------------------------------------------- Summary of changes: lang/python/docs/gpgme-python-howto.org | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 16 03:08:23 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 16 Sep 2018 03:08:23 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-285-gfbec29f Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via fbec29fdac7a4f162e73f24dac2a6b205239ef03 (commit) via 2a1b0b88d96b722817f3ac9edf002a54c65084b8 (commit) from 91b26b0638d9f92f0e90aab1c3750c14d72db301 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit fbec29fdac7a4f162e73f24dac2a6b205239ef03 Author: Ben McGinnes Date: Sun Sep 16 11:06:32 2018 +1000 docs: even more edits * doc/gpgme-python-howto.texi: hunting down and killing commas, Oxford or not it can't stay in a heading. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 6e45e47..7b19f72 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -28,7 +28,7 @@ * Basic Functions:: * Creating keys and subkeys:: * Miscellaneous work-arounds:: -* Copyright, Draft Editions and Licensing: Copyright Draft Editions and Licensing. +* Copyright and Licensing:: @detailmenu --- The Detailed Node Listing --- @@ -124,7 +124,7 @@ Miscellaneous work-arounds * Group lines:: -Copyright, Draft Editions and Licensing +Copyright and Licensing * Copyright:: * Draft Editions of this HOWTO:: @@ -2132,8 +2132,8 @@ script reads all the group entries in a user's @samp{gpg.conf} file and converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. - at node Copyright Draft Editions and Licensing - at chapter Copyright, Draft Editions and Licensing + at node Copyright and Licensing + at chapter Copyright and Licensing @menu * Copyright:: diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 69d9c0b..a917f36 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2043,7 +2043,7 @@ converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. -* Copyright, Draft Editions and Licensing +* Copyright and Licensing :PROPERTIES: :CUSTOM_ID: copyright-and-license :END: commit 2a1b0b88d96b722817f3ac9edf002a54c65084b8 Author: Ben McGinnes Date: Sun Sep 16 10:52:30 2018 +1000 docs: more edits * lang/python/docs/gpgme-python-howto.org: more tweaks and edits, along with another build of output formats. * doc/gpgme-python-howto.texi: updated texinfo version for parent docs. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 21da963..6e45e47 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -28,7 +28,7 @@ * Basic Functions:: * Creating keys and subkeys:: * Miscellaneous work-arounds:: -* Copyright and Licensing:: +* Copyright, Draft Editions and Licensing: Copyright Draft Editions and Licensing. @detailmenu --- The Detailed Node Listing --- @@ -66,7 +66,7 @@ Known Issues * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* CFFI is the Best? and GPGME should use it instead of SWIG:: Fundamentals @@ -124,9 +124,10 @@ Miscellaneous work-arounds * Group lines:: -Copyright and Licensing +Copyright, Draft Editions and Licensing -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright:: +* Draft Editions of this HOWTO:: * License GPL compatible:: @end detailmenu @@ -135,13 +136,13 @@ Copyright and Licensing @node Introduction @chapter Introduction - at multitable {aaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} + at multitable {aaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item Version: @tab 0.1.4 @item GPGME Version: @tab 1.12.0-draft @item Author: - at tab Ben McGinnes + at tab @uref{https://gnupg.org/people/index.html#sec-1-5, Ben McGinnes} @item Author GPG Key: @tab DB4724E6FA4286C92B4E55C4321E4E2373590E5D @item Language: @@ -327,7 +328,7 @@ include a package in PyPI which actually built correctly would require either statically built libraries for every architecture bundled with it or a full implementation of C for each architecture. -See the additional notes regarding @ref{I don't like SWIG Use CFFI instead, , CFFI and SWIG} at the end of this +See the additional notes regarding @ref{CFFI is the Best? and GPGME should use it instead of SWIG, , CFFI and SWIG} at the end of this section for further details. @node Requirements @@ -390,7 +391,7 @@ they be encountered. * Breaking Builds:: * Multiple installations:: * Won't Work With Windows:: -* I don't like SWIG, Use CFFI instead: I don't like SWIG Use CFFI instead. +* CFFI is the Best? and GPGME should use it instead of SWIG:: @end menu @node Breaking Builds @@ -526,8 +527,8 @@ what. Investigations into the extent or the limitations of this issue are ongoing. - at node I don't like SWIG Use CFFI instead - at subsection I don't like SWIG, Use CFFI instead + at node CFFI is the Best? and GPGME should use it instead of SWIG + at subsection CFFI is the Best? and GPGME should use it instead of SWIG There are many reasons for favouring @uref{https://cffi.readthedocs.io/en/latest/overview.html, CFFI} and proponents of it are quite happy to repeat these things as if all it would take to switch @@ -561,6 +562,16 @@ running into trouble with "ifdefs" then you'll know what sort of things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. +There's a greater likelihood of turning to Cython to add something to +these bindings at this point than there is of turning to CFFI. Except +that there's little reason to do so when the C code in question either +already exists or could be produced fairly quickly by the far more +expedient means of asking either @uref{https://gnupg.org/people/index.html#sec-1-1, Werner}, @uref{https://gnupg.org/people/index.html#sec-1-3, Niibe} or @uref{https://gnupg.org/people/index.html#sec-1-6, Andre} to write +whatever was missing. Perhaps even @uref{https://gnupg.org/people/index.html#sec-1-4, Jussi}, but there shouldn't be any +need for these bindings to interface directly with his work and for +much the same reasons as we recommend people not call libgcrypt +directly unless they know what they're doing. + @node Fundamentals @chapter Fundamentals @@ -2121,19 +2132,65 @@ script reads all the group entries in a user's @samp{gpg.conf} file and converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. - at node Copyright and Licensing - at chapter Copyright and Licensing + at node Copyright Draft Editions and Licensing + at chapter Copyright, Draft Editions and Licensing @menu -* Copyright (C) The GnuPG Project, 2018: Copyright (C) The GnuPG Project 2018. +* Copyright:: +* Draft Editions of this HOWTO:: * License GPL compatible:: @end menu - at node Copyright (C) The GnuPG Project 2018 - at section Copyright (C) The GnuPG Project, 2018 + at node Copyright + at section Copyright Copyright ? The GnuPG Project, 2018. +Copyright (C) The GnuPG Project, 2018. + + at node Draft Editions of this HOWTO + at section Draft Editions of this HOWTO + +Draft editions of this HOWTO may be periodically available directly +from the author at any of the following URLs: + + at itemize + at item + at uref{https://files.au.adversary.org/crypto/gpgme-python-howto.html, GPGME Python Bindings HOWTO draft (XHTML AWS S3 SSL)} + at item + at uref{http://files.au.adversary.org/crypto/gpgme-python-howto.html, GPGME Python Bindings HOWTO draft (XHTML AWS S3 no SSL)} + at item + at uref{https://files.au.adversary.org/crypto/gpgme-python-howto.texi, GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 SSL)} + at item + at uref{http://files.au.adversary.org/crypto/gpgme-python-howto.texi, GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 no SSL)} + at item + at uref{https://files.au.adversary.org/crypto/gpgme-python-howto.info, GPGME Python Bindings HOWTO draft (Info file AWS S3 SSL)} + at item + at uref{http://files.au.adversary.org/crypto/gpgme-python-howto.info, GPGME Python Bindings HOWTO draft (Info file AWS S3 no SSL)} + at item + at uref{https://files.au.adversary.org/crypto/gpgme-python-howto.xml, GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 SSL)} + at item + at uref{http://files.au.adversary.org/crypto/gpgme-python-howto.xml, GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 no SSL)} + at end itemize + +All of these draft versions are generated from this document via Emacs + at uref{https://orgmode.org/, Org mode} and @uref{https://www.gnu.org/software/texinfo/, GNU Texinfo}. Though it is likely that the specific @uref{https://files.au.adversary.org/crypto/gpgme-python-howto.org, file} + at uref{http://files.au.adversary.org/crypto/gpgme-python-howto.org, version} used will be on the same server with the generated output +formats. + +In addition to these there is a significantly less frequently updated +version as a HTML @uref{https://files.au.adversary.org/crypto/gpgme-python-howto/webhelp/index.html, WebHelp site} (AWS S3 SSL); generated from DITA XML +source files, which can be found in @uref{https://dev.gnupg.org/source/gpgme/browse/ben%252Fhowto-dita/, an alternative branch} of the GPGME +git repository. + +These draft editions are not official documents and the version of +documentation in the master branch or which ships with released +versions is the only official documentation. Nevertheless, these +draft editions may occasionally be of use by providing more accessible +web versions which are updated between releases. They are provided on +the understanding that they may contain errors or may contain content +subject to change prior to an official release. + @node License GPL compatible @section License GPL compatible @@ -2146,4 +2203,4 @@ WITHOUT ANY WARRANTY, to the extent permitted by law; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - at bye + at bye \ No newline at end of file diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 1f5ceb2..69d9c0b 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2077,7 +2077,9 @@ from the author at any of the following URLs: - [[http://files.au.adversary.org/crypto/gpgme-python-howto.xml][GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 no SSL)]] All of these draft versions are generated from this document via Emacs -[[https://orgmode.org/][Org mode]] and [[https://www.gnu.org/software/texinfo/][GNU Texinfo]]. +[[https://orgmode.org/][Org mode]] and [[https://www.gnu.org/software/texinfo/][GNU Texinfo]]. Though it is likely that the specific [[https://files.au.adversary.org/crypto/gpgme-python-howto.org][file]] +[[http://files.au.adversary.org/crypto/gpgme-python-howto.org][version]] used will be on the same server with the generated output +formats. In addition to these there is a significantly less frequently updated version as a HTML [[https://files.au.adversary.org/crypto/gpgme-python-howto/webhelp/index.html][WebHelp site]] (AWS S3 SSL); generated from DITA XML ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 81 ++++++++++++++++++++++++++++----- lang/python/docs/gpgme-python-howto.org | 6 ++- 2 files changed, 73 insertions(+), 14 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Mon Sep 17 06:34:34 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Mon, 17 Sep 2018 06:34:34 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-288-gf4d8380 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via f4d83800d89173e618cceca44b584778217fadb3 (commit) from 44c846345e91413b9d6a1f7b26f59db5b1c32433 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit f4d83800d89173e618cceca44b584778217fadb3 Author: Ben McGinnes Date: Mon Sep 17 14:33:02 2018 +1000 docs: python bindings howto * Tightened up the Cython demonstration. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 2fbac1f..8073a90 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -567,16 +567,6 @@ running into trouble with "ifdefs" then you'll know what sort of things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. -There's a greater likelihood of turning to Cython to add something to -these bindings at this point than there is of turning to CFFI. Except -that there's little reason to do so when the C code in question either -already exists or could be produced fairly quickly by the far more -expedient means of asking either @uref{https://gnupg.org/people/index.html#sec-1-1, Werner}, @uref{https://gnupg.org/people/index.html#sec-1-3, Niibe} or @uref{https://gnupg.org/people/index.html#sec-1-6, Andre} to write -whatever was missing. Perhaps even @uref{https://gnupg.org/people/index.html#sec-1-4, Jussi}, but there shouldn't be any -need for these bindings to interface directly with his work and for -much the same reasons as we recommend people not call libgcrypt -directly unless they know what they're doing. - @node Fundamentals @chapter Fundamentals @@ -2076,9 +2066,10 @@ c.key_sign(key, uids=uid, expires_in=2764800) @node C plus Python plus SWIG plus Cython @section C plus Python plus SWIG plus Cython -In spite of my near facetious commentary in @ref{CFFI is the Best? and GPGME should use it instead of SWIG, , an earlier section}, it is -in fact quite possible to use the GPGME bindings with @uref{http://docs.cython.org/en/latest/index.html, Cython}. In many -cases the benefits may not be obvious since the most computationally +In spite of the apparent incongruence of using Python bindings to a C +interface only to generate more C from the Python; it is in fact quite +possible to use the GPGME bindings with @uref{http://docs.cython.org/en/latest/index.html, Cython}. Though in many cases +the benefits may not be obvious since the most computationally intensive work never leaves the level of the C code with which GPGME itself is interacting with. @@ -2090,9 +2081,9 @@ the @samp{examples/howto/} directory), will take a noticable amount of time to run on most systems where the public keybox or keyring contains a few thousand public keys. -Earlier in the evening I ran that script on my laptop, as I tend to do -periodically and timed it using @samp{time} utility, with the following -results: +Earlier in the evening, prior to starting this section, I ran that +script on my laptop; as I tend to do periodically and timed it using + at samp{time} utility, with the following results: @example bash-4.4$ time keycount.py @@ -2110,10 +2101,10 @@ bash-4.4$ Sometime after that I imported another key and followed it with a little test of Cython. This test was kept fairly basic, essentially -lifting the material from the initial @uref{http://docs.cython.org/en/latest/src/tutorial/cython_tutorial.html#cython-hello-world, Cython Hello World tutorial} to -demonstrate compiling Python code to C. The first step was to take -the example key counting code quoted previously, essentially from the -importing of the @samp{gpg} module to the end of the script: +lifting the material from the @uref{http://docs.cython.org/en/latest/src/tutorial/cython_tutorial.html, Cython Basic Tutorial} to demonstrate +compiling Python code to C. The first step was to take the example +key counting code quoted previously, essentially from the importing of +the @samp{gpg} module to the end of the script: @example import gpg diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 95b1934..0d7f9b4 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -438,16 +438,6 @@ running into trouble with "ifdefs" then you'll know what sort of things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. -There's a greater likelihood of turning to Cython to add something to -these bindings at this point than there is of turning to CFFI. Except -that there's little reason to do so when the C code in question either -already exists or could be produced fairly quickly by the far more -expedient means of asking either [[https://gnupg.org/people/index.html#sec-1-1][Werner]], [[https://gnupg.org/people/index.html#sec-1-3][Niibe]] or [[https://gnupg.org/people/index.html#sec-1-6][Andre]] to write -whatever was missing. Perhaps even [[https://gnupg.org/people/index.html#sec-1-4][Jussi]], but there shouldn't be any -need for these bindings to interface directly with his work and for -much the same reasons as we recommend people not call libgcrypt -directly unless they know what they're doing. - * Fundamentals :PROPERTIES: @@ -1981,9 +1971,10 @@ c.key_sign(key, uids=uid, expires_in=2764800) :CUSTOM_ID: cython :END: -In spite of my near facetious commentary in [[#snafu-cffi][an earlier section]], it is -in fact quite possible to use the GPGME bindings with [[http://docs.cython.org/en/latest/index.html][Cython]]. In many -cases the benefits may not be obvious since the most computationally +In spite of the apparent incongruence of using Python bindings to a C +interface only to generate more C from the Python; it is in fact quite +possible to use the GPGME bindings with [[http://docs.cython.org/en/latest/index.html][Cython]]. Though in many cases +the benefits may not be obvious since the most computationally intensive work never leaves the level of the C code with which GPGME itself is interacting with. @@ -1995,9 +1986,9 @@ the =examples/howto/= directory), will take a noticable amount of time to run on most systems where the public keybox or keyring contains a few thousand public keys. -Earlier in the evening I ran that script on my laptop, as I tend to do -periodically and timed it using =time= utility, with the following -results: +Earlier in the evening, prior to starting this section, I ran that +script on my laptop; as I tend to do periodically and timed it using +=time= utility, with the following results: #+BEGIN_SRC shell bash-4.4$ time keycount.py @@ -2015,10 +2006,10 @@ results: Sometime after that I imported another key and followed it with a little test of Cython. This test was kept fairly basic, essentially -lifting the material from the initial [[http://docs.cython.org/en/latest/src/tutorial/cython_tutorial.html#cython-hello-world][Cython Hello World tutorial]] to -demonstrate compiling Python code to C. The first step was to take -the example key counting code quoted previously, essentially from the -importing of the =gpg= module to the end of the script: +lifting the material from the [[http://docs.cython.org/en/latest/src/tutorial/cython_tutorial.html][Cython Basic Tutorial]] to demonstrate +compiling Python code to C. The first step was to take the example +key counting code quoted previously, essentially from the importing of +the =gpg= module to the end of the script: #+BEGIN_SRC python -i import gpg ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 31 +++++++++++-------------------- lang/python/docs/gpgme-python-howto.org | 31 +++++++++++-------------------- 2 files changed, 22 insertions(+), 40 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 18 00:33:39 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Tue, 18 Sep 2018 00:33:39 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-289-g362caaf Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 362caaf02f3a25b7e626572aa30b87771c2c8f4d (commit) from f4d83800d89173e618cceca44b584778217fadb3 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 362caaf02f3a25b7e626572aa30b87771c2c8f4d Author: Ben McGinnes Date: Tue Sep 18 08:32:30 2018 +1000 docs: python bindings * Updated the Cython example code slightly, along with the corresponding explanation. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 8073a90..7cdce1e 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -2120,8 +2120,9 @@ publist = list(pubkeys) pubnum = len(publist) print(""" - Number of secret keys: @{0@} - Number of public keys: @{1@} + Number of secret keys: @{0@} + Number of public keys: @{1@} + """.format(secnum, pubnum)) @end example @@ -2172,7 +2173,10 @@ On the other hand it ran in nearly half the time; taking 6 minutes and which the CPython script alone took. The @samp{keycount.pyx} and @samp{setup.py} files used to generate this example -have been added to the @samp{examples/howto/advanced/cython/} directory. +have been added to the @samp{examples/howto/advanced/cython/} directory +The example versions include some additional options to annotate the +existing code and to detect Cython's use. The latter comes from the + at uref{http://docs.cython.org/en/latest/src/tutorial/pure.html#magic-attributes-within-the-pxd, Magic Attributes} section of the Cython documentation. @node Miscellaneous work-arounds @chapter Miscellaneous work-arounds diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 0d7f9b4..0836d21 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2025,8 +2025,9 @@ publist = list(pubkeys) pubnum = len(publist) print(""" - Number of secret keys: {0} - Number of public keys: {1} + Number of secret keys: {0} + Number of public keys: {1} + """.format(secnum, pubnum)) #+END_SRC @@ -2077,7 +2078,10 @@ On the other hand it ran in nearly half the time; taking 6 minutes and which the CPython script alone took. The =keycount.pyx= and =setup.py= files used to generate this example -have been added to the =examples/howto/advanced/cython/= directory. +have been added to the =examples/howto/advanced/cython/= directory +The example versions include some additional options to annotate the +existing code and to detect Cython's use. The latter comes from the +[[http://docs.cython.org/en/latest/src/tutorial/pure.html#magic-attributes-within-the-pxd][Magic Attributes]] section of the Cython documentation. * Miscellaneous work-arounds diff --git a/lang/python/examples/howto/advanced/cython/keycount.pyx b/lang/python/examples/howto/advanced/cython/keycount.pyx index f0097db..2aa636d 100755 --- a/lang/python/examples/howto/advanced/cython/keycount.pyx +++ b/lang/python/examples/howto/advanced/cython/keycount.pyx @@ -1,3 +1,6 @@ +from __future__ import absolute_import + +import cython import gpg c = gpg.Context() @@ -10,7 +13,14 @@ secnum = len(seclist) publist = list(pubkeys) pubnum = len(publist) +if cython.compiled is True: + cc = "Powered by Cython compiled C code." +else: + cc = "Powered by Python." + print(""" -Number of secret keys: {0} -Number of public keys: {1} -""".format(secnum, pubnum)) + Number of secret keys: {0} + Number of public keys: {1} + + {2} +""".format(secnum, pubnum, cc)) diff --git a/lang/python/examples/howto/advanced/cython/setup.py b/lang/python/examples/howto/advanced/cython/setup.py index 0d0be01..f8dce03 100644 --- a/lang/python/examples/howto/advanced/cython/setup.py +++ b/lang/python/examples/howto/advanced/cython/setup.py @@ -2,5 +2,5 @@ from distutils.core import setup from Cython.Build import cythonize setup( - ext_modules = cythonize("keycount.pyx") + ext_modules = cythonize("keycount.pyx", annotate=True) ) ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 10 +++++++--- lang/python/docs/gpgme-python-howto.org | 10 +++++++--- lang/python/examples/howto/advanced/cython/keycount.pyx | 16 +++++++++++++--- lang/python/examples/howto/advanced/cython/setup.py | 2 +- 4 files changed, 28 insertions(+), 10 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 18 02:49:17 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Tue, 18 Sep 2018 02:49:17 +0200 Subject: [git] GnuPG - branch, master, updated. gnupg-2.2.7-215-gfe8b633 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The GNU Privacy Guard". The branch, master has been updated via fe8b6339542f3b1228b5fd56fc710ea3b07a3a2b (commit) from 60c880bda5c9b821fd2968cf89c38c37be3c1a7b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit fe8b6339542f3b1228b5fd56fc710ea3b07a3a2b Author: NIIBE Yutaka Date: Tue Sep 18 09:34:00 2018 +0900 g10: Fix memory leak for --card-status. * g10/card-util.c (card_status): Release memory of serial number. Signed-off-by: NIIBE Yutaka diff --git a/g10/card-util.c b/g10/card-util.c index e9c0120..779e9d8 100644 --- a/g10/card-util.c +++ b/g10/card-util.c @@ -674,7 +674,7 @@ card_status (ctrl_t ctrl, estream_t fp, const char *serialno) { int err; strlist_t card_list, sl; - char *serialno0; + char *serialno0, *serialno1; int all_cards = 0; if (serialno == NULL) @@ -700,8 +700,6 @@ card_status (ctrl_t ctrl, estream_t fp, const char *serialno) for (sl = card_list; sl; sl = sl->next) { - char *serialno1; - if (!all_cards && strcmp (serialno, sl->d)) continue; @@ -722,7 +720,8 @@ card_status (ctrl_t ctrl, estream_t fp, const char *serialno) } /* Select the original card again. */ - err = agent_scd_serialno (&serialno0, serialno0); + err = agent_scd_serialno (&serialno1, serialno0); + xfree (serialno1); leave: xfree (serialno0); ----------------------------------------------------------------------- Summary of changes: g10/card-util.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) hooks/post-receive -- The GNU Privacy Guard http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 18 03:03:56 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Tue, 18 Sep 2018 03:03:56 +0200 Subject: [git] GnuPG - branch, STABLE-BRANCH-2-2, updated. gnupg-2.2.10-6-gf5be5c9 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The GNU Privacy Guard". The branch, STABLE-BRANCH-2-2 has been updated via f5be5c9654d879962176285d9d0353874255ce56 (commit) from 0383e7fed7b2a45c7f0ae4c11415c6a9a3a3ddb7 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit f5be5c9654d879962176285d9d0353874255ce56 Author: NIIBE Yutaka Date: Tue Sep 18 10:03:02 2018 +0900 po: Update Japanese translation. -- Signed-off-by: NIIBE Yutaka diff --git a/po/ja.po b/po/ja.po index 881aff6..c891b23 100644 --- a/po/ja.po +++ b/po/ja.po @@ -10,7 +10,7 @@ msgid "" msgstr "" "Project-Id-Version: gnupg 2.2.9\n" "Report-Msgid-Bugs-To: translations at gnupg.org\n" -"PO-Revision-Date: 2018-08-22 17:43+0900\n" +"PO-Revision-Date: 2018-09-18 09:58+0900\n" "Last-Translator: NIIBE Yutaka \n" "Language-Team: none\n" "Language: ja\n" @@ -821,15 +821,13 @@ msgstr "" msgid "unknown debug flag '%s' ignored\n" msgstr "???debug???'%s'????????\n" -#, fuzzy, c-format -#| msgid "waiting for the agent to come up ... (%ds)\n" +#, c-format msgid "waiting for the %s to come up ... (%ds)\n" -msgstr "agent???????%d?????\n" +msgstr "%s ???????%d?????...\n" -#, fuzzy, c-format -#| msgid "connection to agent established\n" +#, c-format msgid "connection to %s established\n" -msgstr "??????????????????\n" +msgstr "%s ????????????\n" #, c-format msgid "no running gpg-agent - starting '%s'\n" @@ -1782,7 +1780,7 @@ msgstr "???????????????" #, c-format msgid "checking for a fresh copy of an expired key via %s\n" -msgstr "" +msgstr "%s ?????????????????????\n" #, c-format msgid "secret key \"%s\" not found: %s\n" @@ -4658,10 +4656,9 @@ msgstr "??????????%d?????????\n" msgid "WARNING: potentially insecure symmetrically encrypted session key\n" msgstr "*??*: ?????????????????????????\n" -#, fuzzy, c-format -#| msgid "Critical signature notation: " +#, c-format msgid "Unknown critical signature notation: " -msgstr "???????????: " +msgstr "??????????????: " #, c-format msgid "subpacket of type %d has critical bit set\n" ----------------------------------------------------------------------- Summary of changes: po/ja.po | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) hooks/post-receive -- The GNU Privacy Guard http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 18 15:06:14 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Tue, 18 Sep 2018 15:06:14 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-9-g48c8f8d Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via 48c8f8ddfc80551db7615e1eb3555c1dc3f6a657 (commit) from 78b679a778ddf37b8952f1808fd8c52cc8163f17 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 48c8f8ddfc80551db7615e1eb3555c1dc3f6a657 Author: Werner Koch Date: Tue Sep 18 14:54:08 2018 +0200 syscfg: Support ARC CPUs and simplify aliasing table. * src/mkheader.c (xmalloc): New. (xstrdup): Implement using xmalloc. (canon_host_triplet): Add supporr for arc CPU. Adjust alias table to also alias *-pc-*. Rename ibm to unknown. Add internal arg. Add unknown vendor hack. (main): New mode to just print the canonicalized form. * src/Makefile.am (lock_obj_pub): s/-(pc|ibm)-/-unknown/. Also rename files accordingly. -- config.sub does no real aliasing and thus we would need to add several vendors to the alising tables despite that this has no technical meanding. Instead we now replace the vendor with "unknown" for the 4-part-"triplets". This change will make maintenace easier. Signed-off-by: Werner Koch diff --git a/src/Makefile.am b/src/Makefile.am index 380ea7c..914768c 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -52,9 +52,9 @@ lock_obj_pub = \ syscfg/lock-obj-pub.arm-apple-darwin.h \ syscfg/lock-obj-pub.hppa-unknown-linux-gnu.h \ syscfg/lock-obj-pub.i386-apple-darwin.h \ - syscfg/lock-obj-pub.i686-pc-gnu.h \ - syscfg/lock-obj-pub.i686-pc-kfreebsd-gnu.h \ - syscfg/lock-obj-pub.i686-pc-linux-gnu.h \ + syscfg/lock-obj-pub.i686-unknown-gnu.h \ + syscfg/lock-obj-pub.i686-unknown-kfreebsd-gnu.h \ + syscfg/lock-obj-pub.i686-unknown-linux-gnu.h \ syscfg/lock-obj-pub.m68k-unknown-linux-gnu.h \ syscfg/lock-obj-pub.mips-unknown-linux-gnu.h \ syscfg/lock-obj-pub.mips64el-unknown-linux-gnuabi64.h \ @@ -66,16 +66,16 @@ lock_obj_pub = \ syscfg/lock-obj-pub.powerpc64le-unknown-linux-gnu.h \ syscfg/lock-obj-pub.powerpc-unknown-linux-gnuspe.h \ syscfg/lock-obj-pub.riscv64-unknown-linux-gnu.h \ - syscfg/lock-obj-pub.s390x-ibm-linux-gnu.h \ + syscfg/lock-obj-pub.s390x-unknown-linux-gnu.h \ syscfg/lock-obj-pub.sh3-unknown-linux-gnu.h \ syscfg/lock-obj-pub.sh4-unknown-linux-gnu.h \ syscfg/lock-obj-pub.sparc-unknown-linux-gnu.h \ syscfg/lock-obj-pub.sparc64-unknown-linux-gnu.h \ syscfg/lock-obj-pub.x86_64-apple-darwin.h \ - syscfg/lock-obj-pub.x86_64-pc-kfreebsd-gnu.h \ - syscfg/lock-obj-pub.x86_64-pc-linux-gnu.h \ - syscfg/lock-obj-pub.x86_64-pc-linux-gnux32.h \ - syscfg/lock-obj-pub.x86_64-pc-linux-musl.h \ + syscfg/lock-obj-pub.x86_64-unknown-kfreebsd-gnu.h \ + syscfg/lock-obj-pub.x86_64-unknown-linux-gnu.h \ + syscfg/lock-obj-pub.x86_64-unknown-linux-gnux32.h \ + syscfg/lock-obj-pub.x86_64-unknown-linux-musl.h \ syscfg/lock-obj-pub.tilegx-unknown-linux-gnu.h \ syscfg/lock-obj-pub.ia64-unknown-linux-gnu.h \ syscfg/lock-obj-pub.mingw32.h diff --git a/src/mkheader.c b/src/mkheader.c index 2fc5fad..7a38a1b 100644 --- a/src/mkheader.c +++ b/src/mkheader.c @@ -51,17 +51,27 @@ xfree (void *a) static char * -xstrdup (const char *string) +xmalloc (size_t n) { char *p; - size_t len = strlen (string) + 1; - p = malloc (len); + p = malloc (n); if (!p) { fputs (PGM ": out of core\n", stderr); exit (1); } + return p; +} + + +static char * +xstrdup (const char *string) +{ + char *p; + size_t len = strlen (string) + 1; + + p = xmalloc (len); memcpy (p, string, len); return p; } @@ -69,23 +79,31 @@ xstrdup (const char *string) /* Return a malloced string with TRIPLET. If TRIPLET has an alias return that instead. In general build-aux/config.sub should do the - aliasing but some returned triplets are anyway identical and thus we - use this function to map it to the canonical form. */ + aliasing but some returned triplets are anyway identical and thus + we use this function to map it to the canonical form. + NO_VENDOR_HACK is for internal use; caller must call with 0. */ static char * -canon_host_triplet (const char *triplet) +canon_host_triplet (const char *triplet, int no_vendor_hack) { struct { const char *name; const char *alias; } tbl[] = { - {"i486-pc-linux-gnu", "i686-pc-linux-gnu" }, + {"i486-pc-linux-gnu", "i686-unknown-linux-gnu" }, {"i586-pc-linux-gnu" }, - {"i486-pc-gnu", "i686-pc-gnu"}, + {"i686-pc-linux-gnu" }, + {"arc-oe-linux-uclibc" }, /* Other CPU but same struct. */ + + {"i486-pc-gnu", "i686-unknown-gnu"}, {"i586-pc-gnu"}, - {"i486-pc-kfreebsd-gnu", "i686-pc-kfreebsd-gnu"}, + {"i686-pc-gnu"}, + + {"i486-pc-kfreebsd-gnu", "i686-unknown-kfreebsd-gnu"}, {"i586-pc-kfreebsd-gnu"}, + {"i686-pc-kfreebsd-gnu"}, - {"x86_64-pc-linux-gnuhardened1", "x86_64-pc-linux-gnu" }, + {"x86_64-pc-linux-gnuhardened1", "x86_64-unknown-linux-gnu" }, + {"x86_64-pc-linux-gnu" }, {"powerpc-unknown-linux-gnuspe", "powerpc-unknown-linux-gnu" }, @@ -98,6 +116,7 @@ canon_host_triplet (const char *triplet) }; int i; const char *lastalias = NULL; + const char *s; for (i=0; tbl[i].name; i++) { @@ -110,6 +129,36 @@ canon_host_triplet (const char *triplet) return xstrdup (lastalias); } } + for (i=0, s=triplet; *s; s++) + if (*s == '-') + i++; + if (i > 2 && !no_vendor_hack) + { + /* We have a 4 part "triplet": CPU-VENDOR-KERNEL-SYSTEM where + * the last two parts replace the OS part of a real triplet. + * The VENDOR part is then in general useless because + * KERNEL-SYSTEM is specific enough. We now do a second pass by + * replacing VENDOR with "unknown". */ + char *p; + char *buf = xmalloc (strlen (triplet) + 7 + 1); + + for (p=buf,s=triplet,i=0; *s; s++) + { + *p++ = *s; + if (*s == '-' && ++i == 1) + { + memcpy (p, "unknown-",8); + p += 8; + for (s++; *s != '-'; s++) + ; + } + } + *p = 0; + p = canon_host_triplet (buf, 1); + xfree (buf); + return p; + } + return xstrdup (triplet); } @@ -558,7 +607,7 @@ write_special (const char *fname, int lnr, const char *tag) int main (int argc, char **argv) { - FILE *fp; + FILE *fp = NULL; char line[LINESIZE]; int lnr = 0; const char *fname, *s; @@ -571,11 +620,22 @@ main (int argc, char **argv) argc--; argv++; } - if (argc != 6) + if (argc == 1) + { + /* Print just the canonicalized host triplet. */ + host_triplet = canon_host_triplet (argv[0], 0); + printf ("%s\n", host_triplet); + goto leave; + } + else if (argc == 6) + ; /* Standard operation. */ + else { fputs ("usage: " PGM " host_os host_triplet template.h config.h" - " version version_number\n", + " version version_number\n" + " " PGM + " host_triplet\n", stderr); return 1; } @@ -586,7 +646,7 @@ main (int argc, char **argv) hdr_version = argv[4]; hdr_version_number = argv[5]; - host_triplet = canon_host_triplet (host_triplet_raw); + host_triplet = canon_host_triplet (host_triplet_raw, 0); srcdir = malloc (strlen (fname) + 2 + 1); if (!srcdir) @@ -677,13 +737,15 @@ main (int argc, char **argv) "End:\n" "*/\n", stdout); + leave: if (ferror (stdout)) { fprintf (stderr, PGM ": error writing to stdout: %s\n", strerror (errno)); return 1; } - fclose (fp); + if (fp) + fclose (fp); xfree (host_triplet); return 0; diff --git a/src/syscfg/lock-obj-pub.i686-pc-gnu.h b/src/syscfg/lock-obj-pub.i686-unknown-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.i686-pc-gnu.h rename to src/syscfg/lock-obj-pub.i686-unknown-gnu.h diff --git a/src/syscfg/lock-obj-pub.i686-pc-kfreebsd-gnu.h b/src/syscfg/lock-obj-pub.i686-unknown-kfreebsd-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.i686-pc-kfreebsd-gnu.h rename to src/syscfg/lock-obj-pub.i686-unknown-kfreebsd-gnu.h diff --git a/src/syscfg/lock-obj-pub.i686-pc-linux-gnu.h b/src/syscfg/lock-obj-pub.i686-unknown-linux-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.i686-pc-linux-gnu.h rename to src/syscfg/lock-obj-pub.i686-unknown-linux-gnu.h diff --git a/src/syscfg/lock-obj-pub.s390x-ibm-linux-gnu.h b/src/syscfg/lock-obj-pub.s390x-unknown-linux-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.s390x-ibm-linux-gnu.h rename to src/syscfg/lock-obj-pub.s390x-unknown-linux-gnu.h diff --git a/src/syscfg/lock-obj-pub.x86_64-pc-kfreebsd-gnu.h b/src/syscfg/lock-obj-pub.x86_64-unknown-kfreebsd-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.x86_64-pc-kfreebsd-gnu.h rename to src/syscfg/lock-obj-pub.x86_64-unknown-kfreebsd-gnu.h diff --git a/src/syscfg/lock-obj-pub.x86_64-pc-linux-gnu.h b/src/syscfg/lock-obj-pub.x86_64-unknown-linux-gnu.h similarity index 100% rename from src/syscfg/lock-obj-pub.x86_64-pc-linux-gnu.h rename to src/syscfg/lock-obj-pub.x86_64-unknown-linux-gnu.h diff --git a/src/syscfg/lock-obj-pub.x86_64-pc-linux-gnux32.h b/src/syscfg/lock-obj-pub.x86_64-unknown-linux-gnux32.h similarity index 100% rename from src/syscfg/lock-obj-pub.x86_64-pc-linux-gnux32.h rename to src/syscfg/lock-obj-pub.x86_64-unknown-linux-gnux32.h diff --git a/src/syscfg/lock-obj-pub.x86_64-pc-linux-musl.h b/src/syscfg/lock-obj-pub.x86_64-unknown-linux-musl.h similarity index 100% rename from src/syscfg/lock-obj-pub.x86_64-pc-linux-musl.h rename to src/syscfg/lock-obj-pub.x86_64-unknown-linux-musl.h ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 16 ++-- src/mkheader.c | 92 ++++++++++++++++++---- ...86-pc-gnu.h => lock-obj-pub.i686-unknown-gnu.h} | 0 ....h => lock-obj-pub.i686-unknown-kfreebsd-gnu.h} | 0 ...gnu.h => lock-obj-pub.i686-unknown-linux-gnu.h} | 0 ...nu.h => lock-obj-pub.s390x-unknown-linux-gnu.h} | 0 ... => lock-obj-pub.x86_64-unknown-kfreebsd-gnu.h} | 0 ...u.h => lock-obj-pub.x86_64-unknown-linux-gnu.h} | 0 ... => lock-obj-pub.x86_64-unknown-linux-gnux32.h} | 0 ....h => lock-obj-pub.x86_64-unknown-linux-musl.h} | 0 10 files changed, 85 insertions(+), 23 deletions(-) rename src/syscfg/{lock-obj-pub.i686-pc-gnu.h => lock-obj-pub.i686-unknown-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.i686-pc-kfreebsd-gnu.h => lock-obj-pub.i686-unknown-kfreebsd-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.i686-pc-linux-gnu.h => lock-obj-pub.i686-unknown-linux-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.s390x-ibm-linux-gnu.h => lock-obj-pub.s390x-unknown-linux-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.x86_64-pc-kfreebsd-gnu.h => lock-obj-pub.x86_64-unknown-kfreebsd-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.x86_64-pc-linux-gnu.h => lock-obj-pub.x86_64-unknown-linux-gnu.h} (100%) rename src/syscfg/{lock-obj-pub.x86_64-pc-linux-gnux32.h => lock-obj-pub.x86_64-unknown-linux-gnux32.h} (100%) rename src/syscfg/{lock-obj-pub.x86_64-pc-linux-musl.h => lock-obj-pub.x86_64-unknown-linux-musl.h} (100%) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Wed Sep 19 04:17:56 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Wed, 19 Sep 2018 04:17:56 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-11-g144f4b3 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via 144f4b3df5200ce056f00e20420cde77eb1f673d (commit) via 5564efac95e9546af948fc13c90584264b322950 (commit) from 48c8f8ddfc80551db7615e1eb3555c1dc3f6a657 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 144f4b3df5200ce056f00e20420cde77eb1f673d Author: NIIBE Yutaka Date: Wed Sep 19 11:14:02 2018 +0900 src: Fix Makefile for BSD make. * src/Makefile.am (BUILT_SOURCES): Add srcdir to err-sources.h and err-codes.h. (CLEANFILES): Move err-sources.h and err-codes.h to... (MAINTAINERCLEANFILES): ... this new target. (gpg_error_LDADD): Remove ./ to generate libgpg-error.la. -- BSD make is not kind enough to mix path and target. Signed-off-by: NIIBE Yutaka diff --git a/src/Makefile.am b/src/Makefile.am index 914768c..925bfdd 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -101,13 +101,14 @@ EXTRA_DIST = mkstrtable.awk err-sources.h.in err-codes.h.in \ gpg-error-config-new.in gpg-error-config-test.sh gpg-error.pc.in \ $(lock_obj_pub) -BUILT_SOURCES = err-sources.h err-codes.h code-to-errno.h code-from-errno.h \ +BUILT_SOURCES = $(srcdir)/err-sources.h $(srcdir)/err-codes.h \ + code-to-errno.h code-from-errno.h \ err-sources-sym.h err-codes-sym.h errnos-sym.h gpg-error.h gpgrt.h \ gpgrt-config gpg-error.def mkw32errmap.map.c tmp_files = _mkerrcodes.h _gpg-error.def.h mkw32errmap.tab.h mkw32errmap.map.c -CLEANFILES = err-sources.h err-codes.h code-to-errno.h code-from-errno.h \ +CLEANFILES = code-to-errno.h code-from-errno.h \ gpg-error.h gpgrt.h gpgrt-config \ mkerrcodes$(EXEEXT_FOR_BUILD) mkerrcodes.h gpg-error.def mkw32errmap.tab.h \ mkw32errmap.map.c err-sources-sym.h err-codes-sym.h errnos-sym.h \ @@ -115,6 +116,8 @@ CLEANFILES = err-sources.h err-codes.h code-to-errno.h code-from-errno.h \ gpg-error-config gpg-error-config-test.log \ $(tmp_files) lock-obj-pub.native.h +MAINTAINERCLEANFILES = $(srcdir)/err-sources.h $(srcdir)/err-codes.h + TESTS = gpg-error-config-test.sh # @@ -215,7 +218,7 @@ libgpg_error_la_LIBADD = $(gpg_error_res) $(intllibs) $(socklibs) $(LIBTHREAD) gpg_error_SOURCES = strsource-sym.c strerror-sym.c gpg-error.c gpg_error_CPPFLAGS = -DPKGDATADIR=\"$(pkgdatadir)\" \ -DLOCALEDIR=\"$(localedir)\" $(extra_cppflags) -gpg_error_LDADD = ./libgpg-error.la $(LTLIBINTL) +gpg_error_LDADD = libgpg-error.la $(LTLIBINTL) # We build err-sources.h and err-codes.h in the source directory. # This is needed because gettext does only look into the source commit 5564efac95e9546af948fc13c90584264b322950 Author: NIIBE Yutaka Date: Wed Sep 19 10:50:12 2018 +0900 Accept pkgconf difference for spaces. * src/gpg-error-config-test.sh (OUTPUT_OLD): Use shell and echo to remove spaces. -- There is an alternative implementation of pkg-conf, named pkgconf. It emits an extra space at the end. Tested on FreeBSD 11.1. Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-test.sh b/src/gpg-error-config-test.sh index 7f97ead..7ed70df 100755 --- a/src/gpg-error-config-test.sh +++ b/src/gpg-error-config-test.sh @@ -29,15 +29,15 @@ failure () { rm -f gpg-error-config-test.log -OUTPUT_OLD=$($PKG_CONFIG_CMD --libs) +OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --libs)) OUTPUT_NEW=$(./gpg-error-config-new --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --libs -OUTPUT_OLD=$($PKG_CONFIG_CMD --cflags) +OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --cflags)) OUTPUT_NEW=$(./gpg-error-config-new --cflags) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --cflags -OUTPUT_OLD=$($PKG_CONFIG_CMD --cflags --libs) +OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --cflags --libs)) OUTPUT_NEW=$(./gpg-error-config-new --cflags --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --cflags --libs ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 9 ++++++--- src/gpg-error-config-test.sh | 6 +++--- 2 files changed, 9 insertions(+), 6 deletions(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Wed Sep 19 10:58:40 2018 From: cvs at cvs.gnupg.org (by Maximilian Krambach) Date: Wed, 19 Sep 2018 10:58:40 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-290-g7f14958 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 7f149586062ebae8114f64078771cb25579f5003 (commit) from 362caaf02f3a25b7e626572aa30b87771c2c8f4d (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 7f149586062ebae8114f64078771cb25579f5003 Author: Maximilian Krambach Date: Wed Sep 19 10:56:36 2018 +0200 js: add configuration option on startup -- * src/index.js: Added an optional configuration object for the startup. * configuration: timeout - the initial check for a connection ran into timeouts on slower testing machines. 500ms for initial startup is not sufficient everywhere. The default timeout was raised to 1000ms, and as an option this timeout can be increased even further. * BrowsertestExtension: Set the initial connection timeouts to 2 seconds, to be able to test on slower machines. diff --git a/lang/js/BrowserTestExtension/tests/KeyImportExport.js b/lang/js/BrowserTestExtension/tests/KeyImportExport.js index f57877f..b3d95bb 100644 --- a/lang/js/BrowserTestExtension/tests/KeyImportExport.js +++ b/lang/js/BrowserTestExtension/tests/KeyImportExport.js @@ -32,7 +32,7 @@ describe('Key importing', function () { let context = null; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; context.Keyring.getKeys({ pattern: fpr }).then( diff --git a/lang/js/BrowserTestExtension/tests/KeyInfos.js b/lang/js/BrowserTestExtension/tests/KeyInfos.js index 553aedb..d122958 100644 --- a/lang/js/BrowserTestExtension/tests/KeyInfos.js +++ b/lang/js/BrowserTestExtension/tests/KeyInfos.js @@ -27,7 +27,7 @@ describe('Key information', function () { let context = null; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/decryptTest.js b/lang/js/BrowserTestExtension/tests/decryptTest.js index 61a3fab..5817eb4 100644 --- a/lang/js/BrowserTestExtension/tests/decryptTest.js +++ b/lang/js/BrowserTestExtension/tests/decryptTest.js @@ -29,7 +29,7 @@ describe('Decryption', function () { const good_fpr = inputvalues.encrypt.good.fingerprint; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout:2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/encryptDecryptTest.js b/lang/js/BrowserTestExtension/tests/encryptDecryptTest.js index c10c5d0..b4e4f3f 100644 --- a/lang/js/BrowserTestExtension/tests/encryptDecryptTest.js +++ b/lang/js/BrowserTestExtension/tests/encryptDecryptTest.js @@ -29,7 +29,7 @@ describe('Encryption and Decryption', function (){ let good_fpr = inputvalues.encrypt.good.fingerprint; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/encryptTest.js b/lang/js/BrowserTestExtension/tests/encryptTest.js index d97b458..1017d71 100644 --- a/lang/js/BrowserTestExtension/tests/encryptTest.js +++ b/lang/js/BrowserTestExtension/tests/encryptTest.js @@ -28,7 +28,7 @@ describe('Encryption', function () { let context = null; const good_fpr = inputvalues.encrypt.good.fingerprint; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/longRunningTests.js b/lang/js/BrowserTestExtension/tests/longRunningTests.js index f28a6e7..534a95a 100644 --- a/lang/js/BrowserTestExtension/tests/longRunningTests.js +++ b/lang/js/BrowserTestExtension/tests/longRunningTests.js @@ -27,7 +27,7 @@ describe('Long running Encryption/Decryption', function () { let context = null; const good_fpr = inputvalues.encrypt.good.fingerprint; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/signTest.js b/lang/js/BrowserTestExtension/tests/signTest.js index bd8db80..1e269e6 100644 --- a/lang/js/BrowserTestExtension/tests/signTest.js +++ b/lang/js/BrowserTestExtension/tests/signTest.js @@ -29,7 +29,7 @@ describe('Signing', function () { const good_fpr = inputvalues.encrypt.good.fingerprint; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/BrowserTestExtension/tests/startup.js b/lang/js/BrowserTestExtension/tests/startup.js index cf5b099..e7c7478 100644 --- a/lang/js/BrowserTestExtension/tests/startup.js +++ b/lang/js/BrowserTestExtension/tests/startup.js @@ -25,7 +25,7 @@ describe('GPGME context', function (){ it('Starting a GpgME instance', function (done){ - let prm = Gpgmejs.init(); + let prm = Gpgmejs.init({ timeout: 2000 }); const input = inputvalues.someInputParameter; prm.then( function (context){ diff --git a/lang/js/BrowserTestExtension/tests/verifyTest.js b/lang/js/BrowserTestExtension/tests/verifyTest.js index 04c7a77..c63f684 100644 --- a/lang/js/BrowserTestExtension/tests/verifyTest.js +++ b/lang/js/BrowserTestExtension/tests/verifyTest.js @@ -28,7 +28,7 @@ describe('Verifying data', function () { let context = null; before(function (done){ - const prm = Gpgmejs.init(); + const prm = Gpgmejs.init({ timeout: 2000 }); prm.then(function (gpgmejs){ context = gpgmejs; done(); diff --git a/lang/js/src/Connection.js b/lang/js/src/Connection.js index 4055da6..d43d55f 100644 --- a/lang/js/src/Connection.js +++ b/lang/js/src/Connection.js @@ -74,11 +74,15 @@ export class Connection{ * Retrieves the information about the backend. * @param {Boolean} details (optional) If set to false, the promise will * just return if a connection was successful. + * @param {Number} timeout (optional) * @returns {Promise|Promise} Details from the * backend * @async */ - checkConnection (details = true){ + checkConnection (details = true, timeout = 1000){ + if (typeof timeout !== 'number' && timeout <= 0) { + timeout = 1000; + } const msg = createMessage('version'); if (details === true) { return this.post(msg); @@ -90,7 +94,7 @@ export class Connection{ new Promise(function (resolve, reject){ setTimeout(function (){ reject(gpgme_error('CONN_TIMEOUT')); - }, 500); + }, timeout); }) ]).then(function (){ // success resolve(true); diff --git a/lang/js/src/index.js b/lang/js/src/index.js index c52460c..b8e4274 100644 --- a/lang/js/src/index.js +++ b/lang/js/src/index.js @@ -31,13 +31,17 @@ import { Connection } from './Connection'; * connection once, and then offers the available functions as method of the * response object. * An unsuccessful attempt will reject as a GPGME_Error. + * @param {Object} config (optional) configuration options + * @param {Number} config.timeout set the timeout for the initial connection + * check. On some machines and operating systems a default timeout of 500 ms is + * too low, so a higher number might be attempted. * @returns {Promise} * @async */ -function init (){ +function init ({ timeout = 500 } = {}){ return new Promise(function (resolve, reject){ const connection = new Connection; - connection.checkConnection(false).then( + connection.checkConnection(false, timeout).then( function (result){ if (result === true) { resolve(new GpgME()); diff --git a/lang/js/unittests.js b/lang/js/unittests.js index de06320..f28be76 100644 --- a/lang/js/unittests.js +++ b/lang/js/unittests.js @@ -34,34 +34,38 @@ import { GPGME_Message, createMessage } from './src/Message'; mocha.setup('bdd'); const expect = chai.expect; chai.config.includeStack = true; +const connectionTimeout = 2000; function unittests (){ describe('Connection testing', function (){ it('Connecting', function (done) { let conn0 = new Connection; - conn0.checkConnection().then(function (answer) { - expect(answer).to.not.be.empty; - expect(answer.gpgme).to.not.be.undefined; - expect(answer.gpgme).to.be.a('string'); - expect(answer.info).to.be.an('Array'); - expect(conn0.disconnect).to.be.a('function'); - expect(conn0.post).to.be.a('function'); - done(); - }); + conn0.checkConnection(true, connectionTimeout).then( + function (answer) { + expect(answer).to.not.be.empty; + expect(answer.gpgme).to.not.be.undefined; + expect(answer.gpgme).to.be.a('string'); + expect(answer.info).to.be.an('Array'); + expect(conn0.disconnect).to.be.a('function'); + expect(conn0.post).to.be.a('function'); + done(); + }); }); it('Disconnecting', function (done) { let conn0 = new Connection; - conn0.checkConnection(false).then(function (answer) { - expect(answer).to.be.true; - conn0.disconnect(); - conn0.checkConnection(false).then(function (result) { - expect(result).to.be.false; - done(); + conn0.checkConnection(false, connectionTimeout).then( + function (answer) { + expect(answer).to.be.true; + conn0.disconnect(); + conn0.checkConnection(false, connectionTimeout).then( + function (result) { + expect(result).to.be.false; + done(); + }); }); - }); }); }); ----------------------------------------------------------------------- Summary of changes: .../BrowserTestExtension/tests/KeyImportExport.js | 2 +- lang/js/BrowserTestExtension/tests/KeyInfos.js | 2 +- lang/js/BrowserTestExtension/tests/decryptTest.js | 2 +- .../tests/encryptDecryptTest.js | 2 +- lang/js/BrowserTestExtension/tests/encryptTest.js | 2 +- .../BrowserTestExtension/tests/longRunningTests.js | 2 +- lang/js/BrowserTestExtension/tests/signTest.js | 2 +- lang/js/BrowserTestExtension/tests/startup.js | 2 +- lang/js/BrowserTestExtension/tests/verifyTest.js | 2 +- lang/js/src/Connection.js | 8 +++-- lang/js/src/index.js | 8 +++-- lang/js/unittests.js | 36 ++++++++++++---------- 12 files changed, 41 insertions(+), 29 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Wed Sep 19 12:01:20 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Wed, 19 Sep 2018 12:01:20 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-291-gc569adb Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via c569adb5e3e3082bd68cdc34a2d349b7c28d3768 (commit) from 7f149586062ebae8114f64078771cb25579f5003 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit c569adb5e3e3082bd68cdc34a2d349b7c28d3768 Author: Werner Koch Date: Wed Sep 19 11:51:31 2018 +0200 json: Remove subkey-algo from createkey command. * src/gpgme-json.c (op_createkey): Remove subkey-algo param. (GPG_AGENT_ALLOWS_KEYGEN_TRHOUGH_BROWSER): Fix typo. * lang/js/src/Keyring.js: Remove subkey-algo support. * lang/js/src/permittedOperations.js: Ditto. -- We do not want to expose details of the protocol's key generation and thus the subkey-algo does not make sense. Right now we support only the default and future-default algorithms. A user can configure them anyway using new-default-key-algo in gpg.conf. Eventually we may officially support a more flexible way of creating special structured OpenPGP keys but right now that is not part of the API. Signed-off-by: Werner Koch diff --git a/AUTHORS b/AUTHORS index e0136ff..64a675e 100644 --- a/AUTHORS +++ b/AUTHORS @@ -25,7 +25,8 @@ List of Copyright holders Copyright (C) 2002 John Goerzen Copyright (C) 2014, 2015 Martin Albrecht Copyright (C) 2015, 2018 Ben McGinnes - Copyright (C) 2015-2016 Bundesamt f?r Sicherheit in der Informationstechnik + Copyright (C) 2015, 2016, 2018 + Bundesamt f?r Sicherheit in der Informationstechnik Copyright (C) 2016 Intevation GmbH diff --git a/lang/js/src/Keyring.js b/lang/js/src/Keyring.js index e223284..eec1711 100644 --- a/lang/js/src/Keyring.js +++ b/lang/js/src/Keyring.js @@ -387,13 +387,11 @@ export class GPGME_Keyring { * values. If ommitted, 'default' is used. * @param {Number} option.expires (optional) Expiration time in seconds * from now. If not set or set to 0, expiration will be 'never' - * @param {String} options.subkey_algo (optional) algorithm of the - * encryption subkey. If ommited the same as algo is used. * * @return {Promise} * @async */ - generateKey ({ userId, algo = 'default', expires= 0, subkey_algo } = {}){ + generateKey ({ userId, algo = 'default', expires= 0 } = {}){ if (typeof userId !== 'string' // eslint-disable-next-line no-use-before-define || (algo && supportedKeyAlgos.indexOf(algo) < 0 ) @@ -402,17 +400,11 @@ export class GPGME_Keyring { return Promise.reject(gpgme_error('PARAM_WRONG')); } // eslint-disable-next-line no-use-before-define - if (subkey_algo && supportedKeyAlgos.indexOf(subkey_algo) < 0){ - return Promise.reject(gpgme_error('PARAM_WRONG')); - } let me = this; return new Promise(function (resolve, reject){ let msg = createMessage('createkey'); msg.setParameter('userid', userId); msg.setParameter('algo', algo); - if (subkey_algo) { - msg.setParameter('subkey-algo',subkey_algo ); - } msg.setParameter('expires', expires); msg.post().then(function (response){ me.getKeys({ diff --git a/lang/js/src/permittedOperations.js b/lang/js/src/permittedOperations.js index c3c72ca..09a1783 100644 --- a/lang/js/src/permittedOperations.js +++ b/lang/js/src/permittedOperations.js @@ -348,9 +348,6 @@ export const permittedOperations = { algo: { allowed: ['string'] }, - 'subkey-algo': { - allowed: ['string'] - }, expires: { allowed: ['number'], } diff --git a/src/gpgme-json.c b/src/gpgme-json.c index 2a8f1d3..b10331b 100644 --- a/src/gpgme-json.c +++ b/src/gpgme-json.c @@ -2973,15 +2973,10 @@ static const char hlp_createkey[] = "userid: The user id. E.g. \"Foo Bar \"\n" "\n" "Optional parameters:\n" - "algo: Algo of the key as string. See doc for gpg --quick-gen-key.\n" - "subkey-algo: Algo of the encryption subkey. If ommited the same as algo\n" - " is used.\n" - " Except for dsa and ed25519 where the according\n" - " elg / cv25519 algo will be used as subkey-algo.\n" - "\n" - " If algo is omitted or default or future-default subkey-algo\n" - " is ignored.\n" - "expires: Seconds from now to expiry as Number. 0 means no expiry.\n" + "algo: Algo of the key as string. See doc for gpg --quick-gen-key.\n" + " Supported values are \"default\" and \"future-default\".\n" + "expires: Seconds from now to expiry as Number. 0 means no expiry.\n" + " The default is to use a standard expiration interval.\n" "\n" "Response on success:\n" "fingerprint: The fingerprint of the created key.\n" @@ -3000,9 +2995,8 @@ op_createkey (cjson_t request, cjson_t result) const char *algo = "default"; const char *userid; gpgme_genkey_result_t res; - char *new_fpr = NULL; -#ifdef GPG_AGENT_ALLOWS_KEYGEN_TRHOUGH_BROWSER +#ifdef GPG_AGENT_ALLOWS_KEYGEN_THROUGH_BROWSER /* GnuPG forbids keygen through the browser socket so for this we create an unrestricted context. See GnuPG-Bug-Id: T4010 for more info */ @@ -3054,79 +3048,10 @@ op_createkey (cjson_t request, cjson_t result) goto leave; } - /* Dup the fpr as the result might become invalid after context reuse. */ - new_fpr = xstrdup (res->fpr); - - if (algo && strcmp ("default", algo) && strcmp ("future-default", algo)) - { - /* We need to add the encryption subkey manually */ - gpgme_ctx_t keylistctx = create_onetime_context (GPGME_PROTOCOL_OpenPGP); - gpgme_key_t new_key = NULL; - char *subkey_algo = NULL; - - j_tmp = cJSON_GetObjectItem (request, "subkey_algo"); - if (j_tmp && cjson_is_string (j_tmp)) - { - subkey_algo = xstrdup (j_tmp->valuestring); - } - - if (!subkey_algo) - { - subkey_algo = strdup (algo); - if (!strncmp ("dsa", subkey_algo, 3)) - { - subkey_algo[0] = 'e'; - subkey_algo[1] = 'l'; - subkey_algo[2] = 'g'; - } - if (!strcmp ("ed25519", subkey_algo)) - { - strcpy (subkey_algo, "cv25519"); - } - } - - err = gpgme_get_key (keylistctx, new_fpr, &new_key, 1); - release_onetime_context (keylistctx); - if (err || !new_key) - { - gpg_error_object (result, err, "Error finding created key: %s", - gpg_strerror (err)); - xfree (subkey_algo); - goto leave; - } - - err = gpgme_op_createsubkey (ctx, new_key, subkey_algo, - 0, expires, flags |= GPGME_CREATE_ENCR); - xfree (subkey_algo); - if (err) - { - /* This can happen for example if the user cancels the - * pinentry to unlock the primary key when adding the - * subkey. To avoid an artifact of a pimary key without - * an encryption capable subkey we delete the created - * key and treat the whole operation as failed. */ - gpgme_error_t err2; - gpg_error_object (result, err, "Error creating subkey: %s", - gpg_strerror (err)); - log_info ("Deleting primary key after keygen failure.\n"); - err2 = gpgme_op_delete_ext (ctx, new_key, GPGME_DELETE_FORCE | - GPGME_DELETE_ALLOW_SECRET); - if (err2) - { - log_error ("Error deleting primary key: %s", - gpg_strerror (err)); - } - gpgme_key_unref (new_key); - goto leave; - } - gpgme_key_unref (new_key); - } - - xjson_AddStringToObject0 (result, "fingerprint", new_fpr); + xjson_AddStringToObject0 (result, "fingerprint", res->fpr); leave: - xfree (new_fpr); -#ifdef GPG_AGENT_ALLOWS_KEYGEN_TRHOUGH_BROWSER +#ifdef GPG_AGENT_ALLOWS_KEYGEN_THROUGH_BROWSER release_context (ctx); #else gpgme_release (ctx); ----------------------------------------------------------------------- Summary of changes: AUTHORS | 3 +- lang/js/src/Keyring.js | 10 +---- lang/js/src/permittedOperations.js | 3 -- src/gpgme-json.c | 89 +++----------------------------------- 4 files changed, 10 insertions(+), 95 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Wed Sep 19 17:54:30 2018 From: cvs at cvs.gnupg.org (by Maximilian Krambach) Date: Wed, 19 Sep 2018 17:54:30 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-292-g34be616 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 34be6163f6c1057e2a87705925a9d0c70e4ecf17 (commit) from c569adb5e3e3082bd68cdc34a2d349b7c28d3768 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 34be6163f6c1057e2a87705925a9d0c70e4ecf17 Author: Maximilian Krambach Date: Wed Sep 19 17:54:59 2018 +0200 js: add 'default-future' as createKey option -- * src/Keyring.js: default-future can be used now for key creation as algo. diff --git a/lang/js/src/Keyring.js b/lang/js/src/Keyring.js index eec1711..9e0a3e5 100644 --- a/lang/js/src/Keyring.js +++ b/lang/js/src/Keyring.js @@ -428,7 +428,7 @@ export class GPGME_Keyring { * documentation for details */ const supportedKeyAlgos = [ - 'default', + 'default', 'default-future', 'rsa', 'rsa2048', 'rsa3072', 'rsa4096', 'dsa', 'dsa2048', 'dsa3072', 'dsa4096', 'elg', 'elg2048', 'elg3072', 'elg4096', ----------------------------------------------------------------------- Summary of changes: lang/js/src/Keyring.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 03:40:26 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Thu, 20 Sep 2018 03:40:26 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-293-g5cb6725 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 5cb67257f2b3b5fcfd3444e366f26a0f2ae09504 (commit) from 34be6163f6c1057e2a87705925a9d0c70e4ecf17 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 5cb67257f2b3b5fcfd3444e366f26a0f2ae09504 Author: Ben McGinnes Date: Thu Sep 20 11:38:20 2018 +1000 docs: python bindings and its special request * Added some material on using the new-ish hkp4py module with GPGME. * Example code will be added later once a couple of little issues are addressed. Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 7cdce1e..85a8dcf 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -28,7 +28,7 @@ * Basic Functions:: * Creating keys and subkeys:: * Advanced or Experimental Use Cases:: -* Miscellaneous work-arounds:: +* Miscellaneous extras and work-arounds:: * Copyright and Licensing:: @detailmenu @@ -125,9 +125,14 @@ Advanced or Experimental Use Cases * C plus Python plus SWIG plus Cython:: -Miscellaneous work-arounds +Miscellaneous extras and work-arounds * Group lines:: +* Keyserver access for Python:: + +Keyserver access for Python + +* Key import format:: Copyright and Licensing @@ -763,7 +768,7 @@ one argument which is a bytes literal object containing either the binary or ASCII armoured key data for one or more keys. The following example retrieves one or more keys from the SKS -keyservers via the web using the requests module. Since requests +keyservers via the web using the requests module. Since requests returns the content as a bytes literal object, we can then use that directly to import the resulting data into our keybox. @@ -811,7 +816,7 @@ else: @strong{NOTE:} When searching for a key ID of any length or a fingerprint (without spaces), the SKS servers require the the leading @samp{0x} -indicative of hexadecimal be included. Also note that the old short +indicative of hexadecimal be included. Also note that the old short key IDs (e.g. @samp{0xDEADBEEF}) should no longer be used due to the relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in @@ -2178,11 +2183,12 @@ The example versions include some additional options to annotate the existing code and to detect Cython's use. The latter comes from the @uref{http://docs.cython.org/en/latest/src/tutorial/pure.html#magic-attributes-within-the-pxd, Magic Attributes} section of the Cython documentation. - at node Miscellaneous work-arounds - at chapter Miscellaneous work-arounds + at node Miscellaneous extras and work-arounds + at chapter Miscellaneous extras and work-arounds @menu * Group lines:: +* Keyserver access for Python:: @end menu @node Group lines @@ -2249,6 +2255,32 @@ script reads all the group entries in a user's @samp{gpg.conf} file and converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. + at node Keyserver access for Python + at section Keyserver access for Python + +The @uref{https://github.com/Selfnet/hkp4py, hkp4py} module by Marcel Fest was originally a port of the old + at uref{https://github.com/dgladkov/python-hkp, python-hkp} module from Python 2 to Python 3 and updated to use the + at uref{http://docs.python-requests.org/en/latest/index.html, requests} module instead. It has since been modified to provide +support for Python 2.7 as well and is available via PyPI. + +Since it rewrites the @samp{hkp} protocol prefix as @samp{http} and @samp{hkps} as + at samp{https}, the module is able to be used even with servers which do not +support the full scope of keyserver functions. It will work quite +readily when incorporated into a @ref{C plus Python plus SWIG plus Cython, , Cython} generated and compiled version +of any code. + + at menu +* Key import format:: + at end menu + + at node Key import format + at subsection Key import format + +The hkp4py module returns key data via requests as string literals +(@samp{r.text}) instead of byte literals (@samp{r.content}). This means that +the retrurned key data must be encoded to UTF-8 when importing that +key material using a @samp{gpg.Context().key_import()} method. + @node Copyright and Licensing @chapter Copyright and Licensing diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 0836d21..53ca3a5 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -642,7 +642,7 @@ one argument which is a bytes literal object containing either the binary or ASCII armoured key data for one or more keys. The following example retrieves one or more keys from the SKS -keyservers via the web using the requests module. Since requests +keyservers via the web using the requests module. Since requests returns the content as a bytes literal object, we can then use that directly to import the resulting data into our keybox. @@ -690,7 +690,7 @@ else: *NOTE:* When searching for a key ID of any length or a fingerprint (without spaces), the SKS servers require the the leading =0x= -indicative of hexadecimal be included. Also note that the old short +indicative of hexadecimal be included. Also note that the old short key IDs (e.g. =0xDEADBEEF=) should no longer be used due to the relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in @@ -2084,7 +2084,7 @@ existing code and to detect Cython's use. The latter comes from the [[http://docs.cython.org/en/latest/src/tutorial/pure.html#magic-attributes-within-the-pxd][Magic Attributes]] section of the Cython documentation. -* Miscellaneous work-arounds +* Miscellaneous extras and work-arounds :PROPERTIES: :CUSTOM_ID: cheats-and-hacks :END: @@ -2157,6 +2157,34 @@ converts them into crypt-hooks suitable for use with the Mutt and Neomutt mail clients. +** Keyserver access for Python + :PROPERTIES: + :CUSTOM_ID: hkp4py + :END: + +The [[https://github.com/Selfnet/hkp4py][hkp4py]] module by Marcel Fest was originally a port of the old +[[https://github.com/dgladkov/python-hkp][python-hkp]] module from Python 2 to Python 3 and updated to use the +[[http://docs.python-requests.org/en/latest/index.html][requests]] module instead. It has since been modified to provide +support for Python 2.7 as well and is available via PyPI. + +Since it rewrites the =hkp= protocol prefix as =http= and =hkps= as +=https=, the module is able to be used even with servers which do not +support the full scope of keyserver functions. It will work quite +readily when incorporated into a [[#cython][Cython]] generated and compiled version +of any code. + + +*** Key import format + :PROPERTIES: + :CUSTOM_ID: hkp4py-strings + :END: + +The hkp4py module returns key data via requests as string literals +(=r.text=) instead of byte literals (=r.content=). This means that +the retrurned key data must be encoded to UTF-8 when importing that +key material using a =gpg.Context().key_import()= method. + + * Copyright and Licensing :PROPERTIES: :CUSTOM_ID: copyright-and-license ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 44 ++++++++++++++++++++++++++++----- lang/python/docs/gpgme-python-howto.org | 34 ++++++++++++++++++++++--- 2 files changed, 69 insertions(+), 9 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 05:00:51 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Thu, 20 Sep 2018 05:00:51 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-14-g4c2601a Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via 4c2601a95f06efd352ad407add71a7ea6bab8152 (commit) via 5731ad6377abcd3d36fd6aa59923a640b25b589b (commit) via 95ab4d037ce2b69754c0542949bf7d9d2467d96b (commit) from 144f4b3df5200ce056f00e20420cde77eb1f673d (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 4c2601a95f06efd352ad407add71a7ea6bab8152 Author: NIIBE Yutaka Date: Thu Sep 20 11:55:40 2018 +0900 gpg-error-config: Fix a variable name for zsh. * src/gpg-error-config-new.in (module_list): Rename from modules. -- For ZSH, "modules" is built-in variable name. Avoid such a use. Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-new.in b/src/gpg-error-config-new.in index ee5c2dc..1a03cf9 100644 --- a/src/gpg-error-config-new.in +++ b/src/gpg-error-config-new.in @@ -432,7 +432,7 @@ else shift fi -modules="" +module_list="" want_var="" want_attr="" want_cflags="" @@ -488,7 +488,7 @@ while test $# -gt 0; do ;; *) # Modules - modules="$modules${modules:+ }$1" + module_list="$module_list${module_list:+ }$1" ;; esac @@ -496,13 +496,13 @@ while test $# -gt 0; do done -if [ -z "$modules" ]; then - modules=${myname%-config} -elif expr match "$modules" "=\|!=\|<\|>\|<=\|>=" >/dev/null; then - modules="${myname%-config} $modules" +if [ -z "$module_list" ]; then + module_list=${myname%-config} +elif expr match "$module_list" "=\|!=\|<\|>\|<=\|>=" >/dev/null; then + module_list="${myname%-config} $module_list" fi -all_required_config_files $modules +all_required_config_files $module_list for p in $PKG_LIST; do read_config_file $p $PKG_CONFIG_PATH commit 5731ad6377abcd3d36fd6aa59923a640b25b589b Author: NIIBE Yutaka Date: Thu Sep 20 11:52:14 2018 +0900 gpg-error-config: Don't use local variables. * src/gpg-error-config-new.in: Use global variables only. -- Since Korn Shell requires different syntax for function to declare local variables, and some OS use Korn Shell as /bin/sh, avoid non-portable use of "local". Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-new.in b/src/gpg-error-config-new.in index 61e0ae1..ee5c2dc 100644 --- a/src/gpg-error-config-new.in +++ b/src/gpg-error-config-new.in @@ -29,9 +29,9 @@ PKG_CONFIG_PATH="$PKG_CONFIG_PATH${PKG_CONFIG_PATH:+:}${datadir}/pkgconfig" # Variables are recorded in the shell variables named "VAR_" # get_var () { - local name=$1 + ___name=$1 - eval echo \$VAR_$name + eval echo \$VAR_$___name } # @@ -40,46 +40,45 @@ get_var () { # Attributes are recorded in the shell variables named "ATTR_" # get_attr () { - local name=$1 + ___name=$1 - eval echo \$ATTR_$name + eval echo \$ATTR_$___name } # Remove ${varname} part in the beginning of a string. remove_var_expr () { - local varname=$1 + ___varname=$1 shift - eval echo \"\${@#\\\$\\\{$varname\\\}}\" + eval echo \"\${@#\\\$\\\{$___varname\\\}}\" } # Given a string, substitute variables. substitute_vars () { - local string="$1" - local line - local varname - local result + __string="$1" + __varname="" + __result="" - while [ -n "$string" ]; do - case "$string" in + while [ -n "$__string" ]; do + case "$__string" in \$\$*) - result="$result\$" - string="${string#\$\$}" + __result="$__result\$" + __string="${__string#\$\$}" ;; \${*}*) - varname="${string#\$\{}" - varname="${varname%%\}*}" - result="$result$(get_var ${varname})" - string=$(remove_var_expr ${varname} ${string}) + __varname="${__string#\$\{}" + __varname="${__varname%%\}*}" + __result="$__result$(get_var $__varname)" + __string=$(remove_var_expr $__varname $__string) ;; *) - result="${result}$(printf %c "$string")" - string="${string#$(printf %c "$string")}" + __result="$__result$(printf %c "$__string")" + __string="${__string#$(printf %c "$__string")}" ;; esac done - echo "$result" + echo "$__result" } # @@ -92,44 +91,44 @@ substitute_vars () { # For KEY: VALUE, value is stored in the shell variable ATTR_*. # read_config_from_stdin () { - local filename=$1 - local line - local varname - local value - local key - local reading_attrs - - while read line; do - if [ -z "$line" ]; then - reading_attrs=yes + _filename=$1 + _line="" + _varname="" + _value="" + _key="" + _reading_attrs="" + + while read _line; do + if [ -z "$_line" ]; then + _reading_attrs=yes continue - elif [ -z "$reading_attrs" ]; then - case "$line" in + elif [ -z "$_reading_attrs" ]; then + case "$_line" in *=*) - varname="${line%%=*}" - value="${line#*=}" - VAR_list="$VAR_list${VAR_list:+ }VAR_$varname" - read VAR_$varname <&2 + echo "Error reading $_filename: $_line" 1>&2 exit 1 ;; esac @@ -139,31 +138,30 @@ EOF2 find_file_in_path () { - local f=$1 - local p=$2 - local IFS=":" # On Windows it should be ";"??? - - for d in $p; do - if [ -r $d/$f ]; then - RESULT="$d/$f" + _f=$1 + _p=$2 + _saved_IFS="$IFS" + _arg="" + IFS=":" # On Windows it should be ";"??? + + for _arg in $_p; do + if [ -r $_arg/$_f ]; then + RESULT="$_arg/$_f" + IFS="$_saved_IFS" return 0 fi done + IFS="$_saved_IFS" RESULT="" return 1 } read_config_file () { - local config_file - local RESULT - - if find_file_in_path $1.pc $2; then - config_file=$RESULT - else + if ! find_file_in_path $1.pc $2; then echo "Can't find $1.pc" 1>&2 exit 1 fi - read_config_from_stdin $config_file < $config_file + read_config_from_stdin $RESULT < $RESULT } cleanup_vars_attrs () { @@ -172,12 +170,12 @@ cleanup_vars_attrs () { } not_listed_yet () { - local m=$1 - local arg + ___m=$1 + ___arg="" shift - for arg; do - if [ $m = $arg ]; then + for ___arg; do + if [ $___m = $___arg ]; then return 1 fi done @@ -186,55 +184,55 @@ not_listed_yet () { } list_only_once () { - local result="" - local arg + __result="" + __arg="" - for arg; do - if not_listed_yet $arg $result; then - result="$result${result:+ }$arg" + for __arg; do + if not_listed_yet $__arg $__result; then + __result="$__result${__result:+ }$__arg" fi done - echo $result + echo $__result } list_only_once_for_libs () { - local result="" - local rev_list="" - local arg + __result="" + __rev_list="" + __arg="" # Scan the list and eliminate duplicates for non-"-lxxx" # the resulted list is in reverse order - for arg; do - case "$arg" in + for __arg; do + case "$__arg" in -l*) # As-is - rev_list="$arg $rev_list" + __rev_list="$__arg${__rev_list:+ }$__rev_list" ;; *) - if not_listed_yet $arg $rev_list; then - rev_list="$arg $rev_list" + if not_listed_yet $__arg $__rev_list; then + __rev_list="$__arg${__rev_list:+ }$__rev_list" fi ;; esac done # Scan again - for arg in $rev_list; do - case "$arg" in + for __arg in $__rev_list; do + case "$__arg" in -l*) - if not_listed_yet $arg $result; then - result="$arg $result" + if not_listed_yet $__arg $__result; then + __result="$__arg${__result:+ }$__result" fi ;; *) # As-is - result="$arg $result" + __result="$__arg${__result:+ }$__result" ;; esac done - echo $result + echo $__result } arg1_is_same () { @@ -253,100 +251,103 @@ arg1_is_great () { # Evaluate comparison between versions in RPM way # eval_compare_version () { - local str1="$1" - local cmp="$2" - local str2="$3" - local char1 char2 - local chunk1 chunk2 - - while [ -n "$str1" -a -n "$str2" ]; do + ___str1="$1" + ___cmp="$2" + ___str2="$3" + ___char1="" + ___char2="" + ___chunk1="" + ___chunk2="" + + while [ -n "$___str1" -a -n "$___str2" ]; do # Trim anything that's not alnum or tilde from the front - str1="$(expr "$str1" : '[^0-9A-Za-z~]*$.*$')" - str2="$(expr "$str2" : '[^0-9A-Za-z~]*$.*$')" + ___str1="$(expr "$___str1" : '[^0-9A-Za-z~]*$.*$')" + ___str2="$(expr "$___str2" : '[^0-9A-Za-z~]*$.*$')" # Get the first character - char1=${str1%${str1#?}} - char2=${str2%${str2#?}} + ___char1=${___str1%${___str1#?}} + ___char2=${___str2%${___str2#?}} - if [ "$char1" = ~ -o "$char2" = ~ ]; then - if [ "$char1" != ~ ]; then - arg1_is_great $cmp + if [ "$___char1" = ~ -o "$___char2" = ~ ]; then + if [ "$___char1" != ~ ]; then + arg1_is_great $___cmp return fi - if [ "$char2" != ~ ]; then - arg1_is_less $cmp + if [ "$___char2" != ~ ]; then + arg1_is_less $___cmp return fi - str1=${str1#~} - str2=${str2#~} + ___str1=${___str1#~} + ___str2=${___str2#~} continue fi - if [ -z "$char1" -o -z "$char2" ]; then + if [ -z "$___char1" -o -z "$___char2" ]; then break fi - case "$char1$char2" in + case "$___char1$___char2" in [0-9][A-Za-z]) - arg1_is_great $cmp + arg1_is_great $___cmp return ;; [A-Za-z][0-9]) - arg1_is_less $cmp + arg1_is_less $___cmp return ;; [0-9][0-9]) - chunk1="$(expr "$str1" : '$[0-9]*$')" - chunk2="$(expr "$str2" : '$[0-9]*$')" + ___chunk1="$(expr "$___str1" : '$[0-9]*$')" + ___chunk2="$(expr "$___str2" : '$[0-9]*$')" ;; [A-Za-z][A-Za-z]) - chunk1="$(expr "$str1" : '$[A-Za-z]*$')" - chunk2="$(expr "$str2" : '$[A-Za-z]*$')" + ___chunk1="$(expr "$___str1" : '$[A-Za-z]*$')" + ___chunk2="$(expr "$___str2" : '$[A-Za-z]*$')" ;; esac # Compare chunks numerically if digits, or lexicographically - if expr "$chunk1" "!=" "$chunk2" >/dev/null; then - if expr "$chunk1" ">" "$chunk2" >/dev/null; then - arg1_is_great $cmp + if expr "$___chunk1" "!=" "$___chunk2" >/dev/null; then + if expr "$___chunk1" ">" "$___chunk2" >/dev/null; then + arg1_is_great $___cmp return else - arg1_is_less $cmp + arg1_is_less $___cmp return fi fi # Remove the chunk - str1="${str1#$chunk1}" - str2="${str2#$chunk2}" + ___str1="${___str1#$___chunk1}" + ___str2="${___str2#$___chunk2}" done # Either STR1, STR2 or both is empty here - if [ -n "$str1" ]; then - case "$str1" in - ~*) arg1_is_less $cmp ;; - *) arg1_is_great $cmp ;; + if [ -n "$___str1" ]; then + case "$___str1" in + ~*) arg1_is_less $___cmp ;; + *) arg1_is_great $___cmp ;; esac - elif [ -n "$str2" ]; then - case "$str2" in - ~*) arg1_is_great $cmp ;; - *) arg1_is_less $cmp ;; + elif [ -n "$___str2" ]; then + case "$___str2" in + ~*) arg1_is_great $___cmp ;; + *) arg1_is_less $___cmp ;; esac else - arg1_is_same $cmp + arg1_is_same $___cmp fi } # # Recursively solve package dependencies # -# Result is in the pkg_list variable +# Result is in the PKG_LIST variable # all_required_config_files () { - local list - local all_list - local new_list - local p pkg cmp ver + all_list="" + new_list="" + p="" + pkg="" + cmp="" list=$* while [ -n "$list" ]; do @@ -373,8 +374,8 @@ all_required_config_files () { all_list="$all_list${all_list:+ }$pkg" new_list="$new_list${new_list:+ }$(get_attr Requires)" cleanup_vars_attrs - pkg= - cmp= + pkg="" + cmp="" fi done if [ -n "$cmp" ]; then @@ -382,7 +383,7 @@ all_required_config_files () { exit 1 elif [ -n "$pkg" ]; then read_config_file $pkg $PKG_CONFIG_PATH - all_list="$all_list $pkg" + all_list="$all_list${all_list:+ }$pkg" new_list="$new_list${new_list:+ }$(get_attr Requires)" cleanup_vars_attrs fi @@ -391,7 +392,7 @@ all_required_config_files () { new_list="" done - pkg_list=$(list_only_once $all_list) + PKG_LIST=$(list_only_once $all_list) } #### end of functions for this script @@ -503,7 +504,7 @@ fi all_required_config_files $modules -for p in $pkg_list; do +for p in $PKG_LIST; do read_config_file $p $PKG_CONFIG_PATH if [ -n "$want_var" ]; then output="$output${output:+$delimiter}$(get_var $want_var)" commit 95ab4d037ce2b69754c0542949bf7d9d2467d96b Author: NIIBE Yutaka Date: Thu Sep 20 10:43:44 2018 +0900 gpg-error-config: Avoid more space char. * src/gpg-error-config-new.in: Don't put more space. Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-new.in b/src/gpg-error-config-new.in index ddf6af2..61e0ae1 100644 --- a/src/gpg-error-config-new.in +++ b/src/gpg-error-config-new.in @@ -108,7 +108,7 @@ read_config_from_stdin () { *=*) varname="${line%%=*}" value="${line#*=}" - VAR_list="$VAR_list VAR_$varname" + VAR_list="$VAR_list${VAR_list:+ }VAR_$varname" read VAR_$varname <"|"<="|">=") cmp=$p ;; *) read_config_file $pkg $PKG_CONFIG_PATH - all_list="$all_list $pkg" + all_list="$all_list${all_list:+ }$pkg" new_list="$new_list${new_list:+ }$(get_attr Requires)" cleanup_vars_attrs pkg=$p @@ -370,7 +370,7 @@ all_required_config_files () { echo "Version mismatch for $pkg $cmp $p: $(get_attr Version)" 1>&2 exit 1 fi - all_list="$all_list $pkg" + all_list="$all_list${all_list:+ }$pkg" new_list="$new_list${new_list:+ }$(get_attr Requires)" cleanup_vars_attrs pkg= ----------------------------------------------------------------------- Summary of changes: src/gpg-error-config-new.in | 291 ++++++++++++++++++++++---------------------- 1 file changed, 146 insertions(+), 145 deletions(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 05:47:35 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Thu, 20 Sep 2018 05:47:35 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-15-ga338801 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via a338801aa4bac9a3551729598bcb0ca41882cdb9 (commit) from 4c2601a95f06efd352ad407add71a7ea6bab8152 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit a338801aa4bac9a3551729598bcb0ca41882cdb9 Author: NIIBE Yutaka Date: Thu Sep 20 12:45:36 2018 +0900 gpg-error-config: Use expr to remove var in expression. * src/gpg-error-config-new.in (remove_var_expr): Use expr. -- For OpenBSD's sh, it results "bad substitusion". Now, we use expr. Tested on OpenBSD 6.2. Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-new.in b/src/gpg-error-config-new.in index 1a03cf9..3b31a68 100644 --- a/src/gpg-error-config-new.in +++ b/src/gpg-error-config-new.in @@ -50,7 +50,7 @@ remove_var_expr () { ___varname=$1 shift - eval echo \"\${@#\\\$\\\{$___varname\\\}}\" + expr "$*" : "\${$___varname}\$.*\$" } # Given a string, substitute variables. ----------------------------------------------------------------------- Summary of changes: src/gpg-error-config-new.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 06:25:45 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Thu, 20 Sep 2018 06:25:45 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-17-g15309d0 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via 15309d0fb4c78f8de9bc5dea7d0f8b7468a957b4 (commit) via d510f38ccbc715faa8e07828bf6acd8e9b9a0658 (commit) from a338801aa4bac9a3551729598bcb0ca41882cdb9 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 15309d0fb4c78f8de9bc5dea7d0f8b7468a957b4 Author: NIIBE Yutaka Date: Thu Sep 20 13:24:57 2018 +0900 src: Fix portability for echo. * src/Makefile.am: Use ECHO_N and ECHO_C. Signed-off-by: NIIBE Yutaka diff --git a/src/Makefile.am b/src/Makefile.am index 925bfdd..360e7f5 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -335,7 +335,7 @@ gpgrt-config: gpg-error-config cp gpg-error-config gpgrt-config gpg-error-config: gpg-error-config-new gpg-error-config-old - @echo -n "Confirm gpg-error-config works... " + @echo $(ECHO_N) "Confirm gpg-error-config works... $(ECHO_C)" @if $(srcdir)/gpg-error-config-test.sh --old-new; then \ echo "good"; \ cp gpg-error-config-new $@; \ commit d510f38ccbc715faa8e07828bf6acd8e9b9a0658 Author: NIIBE Yutaka Date: Thu Sep 20 13:02:06 2018 +0900 gpg-error-config: Remove white space for the output by old. * src/gpg-error-config-test.sh: Remove white spaces at the end or at the beginning. -- Signed-off-by: NIIBE Yutaka diff --git a/src/gpg-error-config-test.sh b/src/gpg-error-config-test.sh index 7ed70df..0501c8d 100755 --- a/src/gpg-error-config-test.sh +++ b/src/gpg-error-config-test.sh @@ -42,35 +42,35 @@ OUTPUT_NEW=$(./gpg-error-config-new --cflags --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --cflags --libs if [ "$PKG_CONFIG_CMD" = ./gpg-error-config-old ]; then - OUTPUT_OLD=$($PKG_CONFIG_CMD --version) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --version)) OUTPUT_NEW=$(./gpg-error-config-new --version) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --version - OUTPUT_OLD=$($PKG_CONFIG_CMD --mt --libs) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --mt --libs)) OUTPUT_NEW=$(./gpg-error-config-new --mt --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --mt --libs - OUTPUT_OLD=$($PKG_CONFIG_CMD --mt --cflags) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --mt --cflags)) OUTPUT_NEW=$(./gpg-error-config-new --mt --cflags) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --mt --cflags - OUTPUT_OLD=$($PKG_CONFIG_CMD --cflags --libs) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --cflags --libs)) OUTPUT_NEW=$(./gpg-error-config-new --cflags --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --cflags --libs - OUTPUT_OLD=$($PKG_CONFIG_CMD --mt --cflags --libs) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --mt --cflags --libs)) OUTPUT_NEW=$(./gpg-error-config-new --mt --cflags --libs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --mt --cflags --libs - OUTPUT_OLD=$($PKG_CONFIG_CMD --variable=mtcflags) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --variable=mtcflags)) OUTPUT_NEW=$(./gpg-error-config-new --variable=mtcflags) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --variable=mtcflags - OUTPUT_OLD=$($PKG_CONFIG_CMD --variable=mtlibs) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --variable=mtlibs)) OUTPUT_NEW=$(./gpg-error-config-new --variable=mtlibs) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --variable=mtlibs - OUTPUT_OLD=$($PKG_CONFIG_CMD --variable=host) + OUTPUT_OLD=$(echo $($PKG_CONFIG_CMD --variable=host)) OUTPUT_NEW=$(./gpg-error-config-new --variable=host) [ "$OUTPUT_OLD" = "$OUTPUT_NEW" ] || failure --variable=host fi ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 2 +- src/gpg-error-config-test.sh | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 12:22:43 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Thu, 20 Sep 2018 12:22:43 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-295-g9f19b3a Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 9f19b3aaecd23a12b2e6692faeefa936e490d343 (commit) via a824f4498ea9bae5dca515c56e2455ec0ce98b50 (commit) from 5cb67257f2b3b5fcfd3444e366f26a0f2ae09504 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 9f19b3aaecd23a12b2e6692faeefa936e490d343 Author: Werner Koch Date: Thu Sep 20 11:58:02 2018 +0200 python: Fix regression in the test suite. * lang/python/tests/Makefile.am (GNUPGHOME): Remove stray backslash. -- Fixes-commit: d09d19fa9fe1e81dd819b32208b4bd09f83e3918 Signed-off-by: Werner Koch diff --git a/lang/python/tests/Makefile.am b/lang/python/tests/Makefile.am index d901285..d26d33d 100644 --- a/lang/python/tests/Makefile.am +++ b/lang/python/tests/Makefile.am @@ -21,7 +21,7 @@ GPG_AGENT = gpg-agent test_srcdir = $(top_srcdir)/tests/gpg -GNUPGHOME=$(abs_builddir) \ +GNUPGHOME=$(abs_builddir) TESTS_ENVIRONMENT = GNUPGHOME=$(GNUPGHOME) \ LC_ALL=C GPG_AGENT_INFO= \ top_srcdir=$(top_srcdir) \ commit a824f4498ea9bae5dca515c56e2455ec0ce98b50 Author: Werner Koch Date: Wed Sep 19 17:28:29 2018 +0200 tests: Don't try using keys from a scmartcard. * tests/gpg/Makefile.am: Disable scdaemon * lang/python/tests/Makefile.am: Ditto. Signed-off-by: Werner Koch diff --git a/lang/python/tests/Makefile.am b/lang/python/tests/Makefile.am index 6297076..d901285 100644 --- a/lang/python/tests/Makefile.am +++ b/lang/python/tests/Makefile.am @@ -119,3 +119,7 @@ gpg.conf: gpg-agent.conf: # This is required for gpg2, which does not support command fd. echo pinentry-program $(abs_top_srcdir)/tests/gpg/pinentry >$@ + echo disable-scdaemon >> $@ + + +# end-of-file diff --git a/tests/gpg/Makefile.am b/tests/gpg/Makefile.am index 392fc89..ba2d1f3 100644 --- a/tests/gpg/Makefile.am +++ b/tests/gpg/Makefile.am @@ -105,5 +105,11 @@ gpg.conf: echo no-force-v3-sigs > ./gpg.conf gpg-agent.conf: -# This is required for gpg2, which does not support command fd. +# This is required for gpg2, which does not support command fd for the +# passphrase. disable-scdaemon is required so that we don't try using +# a key from a smartcard reader (error might be: Unusable secret key) echo pinentry-program $(abs_srcdir)/pinentry > ./gpg-agent.conf + echo disable-scdaemon >> ./gpg-agent.conf + + +# end-of-file ----------------------------------------------------------------------- Summary of changes: lang/python/tests/Makefile.am | 6 +++++- tests/gpg/Makefile.am | 8 +++++++- 2 files changed, 12 insertions(+), 2 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 15:46:05 2018 From: cvs at cvs.gnupg.org (by Maximilian Krambach) Date: Thu, 20 Sep 2018 15:46:05 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-296-gec2d2b7 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via ec2d2b78bc61a730d0d33bd997f386ba381720c5 (commit) from 9f19b3aaecd23a12b2e6692faeefa936e490d343 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit ec2d2b78bc61a730d0d33bd997f386ba381720c5 Author: Maximilian Krambach Date: Thu Sep 20 15:46:03 2018 +0200 js: renamed keygen algo option -- * src/Keyring.js: Confused default-future with future-default * reverts commit 34be6163f6c1057e2a87705925a9d0c70e4ecf17 diff --git a/lang/js/src/Keyring.js b/lang/js/src/Keyring.js index 9e0a3e5..2071c6d 100644 --- a/lang/js/src/Keyring.js +++ b/lang/js/src/Keyring.js @@ -428,7 +428,7 @@ export class GPGME_Keyring { * documentation for details */ const supportedKeyAlgos = [ - 'default', 'default-future', + 'default', 'future-default', 'rsa', 'rsa2048', 'rsa3072', 'rsa4096', 'dsa', 'dsa2048', 'dsa3072', 'dsa4096', 'elg', 'elg2048', 'elg3072', 'elg4096', @@ -436,4 +436,4 @@ const supportedKeyAlgos = [ 'cv25519', 'brainpoolP256r1', 'brainpoolP384r1', 'brainpoolP512r1', 'NIST P-256', 'NIST P-384', 'NIST P-521' -]; \ No newline at end of file +]; ----------------------------------------------------------------------- Summary of changes: lang/js/src/Keyring.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 20 17:54:54 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Thu, 20 Sep 2018 17:54:54 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-298-g6878126 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 6878126b6f53cdf7daeeaf68116dda008564c2fa (commit) via dcdabf5f2ef84e1f304fcc0590ec4bb160354af5 (commit) from ec2d2b78bc61a730d0d33bd997f386ba381720c5 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 6878126b6f53cdf7daeeaf68116dda008564c2fa Author: Werner Koch Date: Thu Sep 20 17:30:48 2018 +0200 python: Fix a couple of syntax errors. * lang/python/tests/t-keylist-from-data.py: Add missing line continuation. * lang/python/tests/t-keylist.py: Ditto. * lang/python/tests/t-quick-key-creation.py: Ditto. * lang/python/tests/t-quick-subkey-creation.py: Ditto. Signed-off-by: Werner Koch diff --git a/lang/python/tests/t-keylist-from-data.py b/lang/python/tests/t-keylist-from-data.py index f82ca84..4fd9ba0 100755 --- a/lang/python/tests/t-keylist-from-data.py +++ b/lang/python/tests/t-keylist-from-data.py @@ -162,18 +162,18 @@ def check_global(key, uids, n_subkeys): assert key.can_sign, "Key unexpectedly unusable for signing" assert key.can_certify, "Key unexpectedly unusable for certifications" assert not key.secret, "Key unexpectedly secret" - assert not key.protocol != gpg.constants.protocol. - OpenPGP, "Key has unexpected protocol: {}".format(key.protocol) - assert not key.issuer_serial, - "Key unexpectedly carries issuer serial: {}".format(key.issuer_serial) - assert not key.issuer_name, - "Key unexpectedly carries issuer name: {}".format(key.issuer_name) - assert not key.chain_id, - "Key unexpectedly carries chain ID: {}".format(key.chain_id) - assert key.owner_trust == gpg.constants.validity.UNKNOWN, - "Key has unexpected owner trust: {}".format(key.owner_trust) - assert len(key.subkeys) - 1 == n_subkeys, - "Key `{}' has unexpected number of subkeys".format(uids[0][0]) + assert not key.protocol != gpg.constants.protocol.OpenPGP, \ + "Key has unexpected protocol: {}".format(key.protocol) + assert not key.issuer_serial, \ + "Key unexpectedly carries issuer serial: {}".format(key.issuer_serial) + assert not key.issuer_name, \ + "Key unexpectedly carries issuer name: {}".format(key.issuer_name) + assert not key.chain_id, \ + "Key unexpectedly carries chain ID: {}".format(key.chain_id) + assert key.owner_trust == gpg.constants.validity.UNKNOWN, \ + "Key has unexpected owner trust: {}".format(key.owner_trust) + assert len(key.subkeys) - 1 == n_subkeys, \ + "Key `{}' has unexpected number of subkeys".format(uids[0][0]) def check_subkey(fpr, which, subkey): @@ -183,49 +183,51 @@ def check_subkey(fpr, which, subkey): assert not subkey.invalid, which + " key unexpectedly invalid" if which == "Primary": - assert not subkey.can_encrypt, - which + " key unexpectedly usable for encryption" - assert subkey.can_sign, - which + " key unexpectedly unusable for signing" - assert subkey.can_certify, - which + " key unexpectedly unusable for certifications" + assert not subkey.can_encrypt, \ + which + " key unexpectedly usable for encryption" + assert subkey.can_sign, \ + which + " key unexpectedly unusable for signing" + assert subkey.can_certify, \ + which + " key unexpectedly unusable for certifications" else: - assert subkey.can_encrypt, - which + " key unexpectedly unusable for encryption" - assert not subkey.can_sign, - which + " key unexpectedly usable for signing" - assert not subkey.can_certify, - which + " key unexpectedly usable for certifications" + assert subkey.can_encrypt, \ + which + " key unexpectedly unusable for encryption" + assert not subkey.can_sign, \ + which + " key unexpectedly usable for signing" + assert not subkey.can_certify, \ + which + " key unexpectedly usable for certifications" assert not subkey.secret, which + " key unexpectedly secret" assert not subkey.is_cardkey, "Public key marked as card key" assert not subkey.card_number, "Public key with card number set" - assert not subkey.pubkey_algo != - (gpg.constants.pk.DSA if which == "Primary" else gpg.constants.pk.ELG_E), - which + " key has unexpected public key algo: {}".format(subkey. - pubkey_algo) - assert subkey.length == 1024, - which + " key has unexpected length: {}".format(subkey.length) - assert fpr.endswith(subkey.keyid), - which + " key has unexpected key ID: {}".format(subkey.keyid) - assert which == "Secondary" or subkey.fpr == fpr, - which + " key has unexpected fingerprint: {}".format(subkey.fpr) - assert not subkey.expires, - which + " key unexpectedly expires: {}".format(subkey.expires) + assert not subkey.pubkey_algo != \ + (gpg.constants.pk.DSA if which == "Primary" + else gpg.constants.pk.ELG_E), \ + which + " key has unexpected public key algo: {}".format(subkey. + pubkey_algo) + assert subkey.length == 1024, \ + which + " key has unexpected length: {}".format(subkey.length) + assert fpr.endswith(subkey.keyid), \ + which + " key has unexpected key ID: {}".format(subkey.keyid) + assert which == "Secondary" or subkey.fpr == fpr, \ + which + " key has unexpected fingerprint: {}".format(subkey.fpr) + assert not subkey.expires, \ + which + " key unexpectedly expires: {}".format(subkey.expires) def check_uid(which, ref, uid): assert not uid.revoked, which + " user ID unexpectedly revoked" assert not uid.invalid, which + " user ID unexpectedly invalid" - assert uid.validity == gpg.constants.validity.UNKNOWN, - which + " user ID has unexpected validity: {}".format(uid.validity) + assert uid.validity == gpg.constants.validity.UNKNOWN, \ + which + " user ID has unexpected validity: {}".format(uid.validity) assert not uid.signatures, which + " user ID unexpectedly signed" - assert uid.name == ref[0], - "Unexpected name in {} user ID: {!r}".format(which.lower(), uid.name) - assert uid.comment == ref[1], - "Unexpected comment in {} user ID: {!r}".format(which.lower(), uid.comment) - assert uid.email == ref[2], - "Unexpected email in {} user ID: {!r}".format(which.lower(), uid.email) + assert uid.name == ref[0], \ + "Unexpected name in {} user ID: {!r}".format(which.lower(), uid.name) + assert uid.comment == ref[1], \ + "Unexpected comment in {} user ID: {!r}".format(which.lower(), + uid.comment) + assert uid.email == ref[2], \ + "Unexpected email in {} user ID: {!r}".format(which.lower(), uid.email) # Export all the data from our keyring... diff --git a/lang/python/tests/t-keylist.py b/lang/python/tests/t-keylist.py index b725fc3..9cbada5 100755 --- a/lang/python/tests/t-keylist.py +++ b/lang/python/tests/t-keylist.py @@ -162,25 +162,25 @@ def check_global(key, uids, n_subkeys): assert key.can_sign, "Key unexpectedly unusable for signing" assert key.can_certify, "Key unexpectedly unusable for certifications" assert not key.secret, "Key unexpectedly secret" - assert not key.protocol != gpg.constants.protocol.OpenPGP, - "Key has unexpected protocol: {}".format(key.protocol) - assert not key.issuer_serial, - "Key unexpectedly carries issuer serial: {}".format(key.issuer_serial) - assert not key.issuer_name, - "Key unexpectedly carries issuer name: {}".format(key.issuer_name) - assert not key.chain_id, - "Key unexpectedly carries chain ID: {}".format(key.chain_id) + assert not key.protocol != gpg.constants.protocol.OpenPGP, \ + "Key has unexpected protocol: {}".format(key.protocol) + assert not key.issuer_serial, \ + "Key unexpectedly carries issuer serial: {}".format(key.issuer_serial) + assert not key.issuer_name, \ + "Key unexpectedly carries issuer name: {}".format(key.issuer_name) + assert not key.chain_id, \ + "Key unexpectedly carries chain ID: {}".format(key.chain_id) # Only key Alfa is trusted - assert key.uids[0].name == 'Alfa Test' or - key.owner_trust == gpg.constants.validity.UNKNOWN, - "Key has unexpected owner trust: {}".format(key.owner_trust) - assert key.uids[0].name != 'Alfa Test' or key.owner_trust == gpg.constants. - validity.ULTIMATE, "Key has unexpected owner trust: {}". - format(key.owner_trust) + assert (key.uids[0].name == 'Alfa Test' + or key.owner_trust == gpg.constants.validity.UNKNOWN), \ + "Key has unexpected owner trust: {}".format(key.owner_trust) + assert (key.uids[0].name != 'Alfa Test' + or key.owner_trust == gpg.constants.validity.ULTIMATE), \ + "Key has unexpected owner trust: {}".format(key.owner_trust) - assert len(key.subkeys) - 1 == n_subkeys, - "Key `{}' has unexpected number of subkeys".format(uids[0][0]) + assert len(key.subkeys) - 1 == n_subkeys, \ + "Key `{}' has unexpected number of subkeys".format(uids[0][0]) def check_subkey(fpr, which, subkey): @@ -207,18 +207,19 @@ def check_subkey(fpr, which, subkey): assert not subkey.secret, which + " key unexpectedly secret" assert not subkey.is_cardkey, "Public key marked as card key" assert not subkey.card_number, "Public key with card number set" - assert not subkey.pubkey_algo != - (gpg.constants.pk.DSA if which == "Primary" else gpg.constants.pk.ELG_E), - which + " key has unexpected public key algo: {}".format(subkey. + assert not subkey.pubkey_algo != \ + (gpg.constants.pk.DSA if which == "Primary" + else gpg.constants.pk.ELG_E), \ + which + " key has unexpected public key algo: {}".format(subkey. pubkey_algo) - assert subkey.length == 1024, - which + " key has unexpected length: {}".format(subkey.length) - assert fpr.endswith(subkey.keyid), - which + " key has unexpected key ID: {}".format(subkey.keyid) - assert which == "Secondary" or subkey.fpr == fpr, - which + " key has unexpected fingerprint: {}".format(subkey.fpr) - assert not subkey.expires, - which + " key unexpectedly expires: {}".format(subkey.expires) + assert subkey.length == 1024, \ + which + " key has unexpected length: {}".format(subkey.length) + assert fpr.endswith(subkey.keyid), \ + which + " key has unexpected key ID: {}".format(subkey.keyid) + assert which == "Secondary" or subkey.fpr == fpr, \ + which + " key has unexpected fingerprint: {}".format(subkey.fpr) + assert not subkey.expires, \ + which + " key unexpectedly expires: {}".format(subkey.expires) def check_uid(which, ref, uid): @@ -227,16 +228,16 @@ def check_uid(which, ref, uid): assert uid.validity == (gpg.constants.validity.UNKNOWN if uid.name.split()[0] not in {'Alfa', 'Alpha', 'Alice'} else - gpg.constants.validity.ULTIMATE), - which + " user ID has unexpectedly validity: {}".format(uid.validity) + gpg.constants.validity.ULTIMATE), \ + which + " user ID has unexpectedly validity: {}".format(uid.validity) assert not uid.signatures, which + " user ID unexpectedly signed" - assert uid.name == ref[0], - "Unexpected name in {} user ID: {!r}".format(which.lower(), uid.name) - assert uid.comment == ref[1], - "Unexpected comment in {} user ID: {!r}".format(which.lower(), - uid.comment) - assert uid.email == ref[2], - "Unexpected email in {} user ID: {!r}".format(which.lower(), uid.email) + assert uid.name == ref[0], \ + "Unexpected name in {} user ID: {!r}".format(which.lower(), uid.name) + assert uid.comment == ref[1], \ + "Unexpected comment in {} user ID: {!r}".\ + format(which.lower(), uid.comment) + assert uid.email == ref[2], \ + "Unexpected email in {} user ID: {!r}".format(which.lower(), uid.email) i = 0 diff --git a/lang/python/tests/t-quick-key-creation.py b/lang/python/tests/t-quick-key-creation.py index 4720928..b3303ff 100755 --- a/lang/python/tests/t-quick-key-creation.py +++ b/lang/python/tests/t-quick-key-creation.py @@ -80,8 +80,11 @@ with support.EphemeralContext() as ctx: "Primary keys expiration time is off" # Check capabilities - for sign, encrypt, certify, authenticate in itertools. - product([False, True], [False, True], [False, True], [False, True]): + for sign, encrypt, certify, authenticate \ + in itertools.product([False, True], + [False, True], + [False, True], + [False, True]): # Filter some out if not (sign or encrypt or certify or authenticate): # This triggers the default capabilities tested before. diff --git a/lang/python/tests/t-quick-subkey-creation.py b/lang/python/tests/t-quick-subkey-creation.py index 30424c1..cdbb71b 100755 --- a/lang/python/tests/t-quick-subkey-creation.py +++ b/lang/python/tests/t-quick-subkey-creation.py @@ -60,8 +60,10 @@ with support.EphemeralContext() as ctx: "subkeys expiration time is off" # Check capabilities - for sign, encrypt, authenticate in itertools. - product([False, True], [False, True], [False, True]): + for sign, encrypt, authenticate \ + in itertools.product([False, True], + [False, True], + [False, True]): # Filter some out if not (sign or encrypt or authenticate): # This triggers the default capabilities tested before. commit dcdabf5f2ef84e1f304fcc0590ec4bb160354af5 Author: Werner Koch Date: Thu Sep 20 17:28:25 2018 +0200 python: Silence a few warnings. * src/gpgme.h.in: Obsolete "class" also for Python. * lang/python/gpgme.i: Silenece a swig warning. Silence a gcc warning. Signed-off-by: Werner Koch diff --git a/lang/python/gpgme.i b/lang/python/gpgme.i index 492326b..f3d14a7 100644 --- a/lang/python/gpgme.i +++ b/lang/python/gpgme.i @@ -21,6 +21,12 @@ %include "cpointer.i" %include "cstring.i" +%{ +/* We use public symbols (eg. "_obsolete_class") which are marked as + * deprecated but we need to keep them. Silence the warning. */ +#pragma GCC diagnostic ignored "-Wdeprecated-declarations" +%} + /* Generate doc strings for all methods. This will generate docstrings of the form @@ -575,7 +581,8 @@ off_t gpgme_data_seek (gpgme_data_t dh, off_t offset, int whence=SEEK_SET); %} /* This is for notations, where we want to hide the length fields, and - the unused bit field block. */ + * the unused bit field block. We silence the warning. */ +%warnfilter(302) _gpgme_sig_notation; struct _gpgme_sig_notation { struct _gpgme_sig_notation *next; diff --git a/src/gpgme.h.in b/src/gpgme.h.in index e4ea466..9c9ea5a 100644 --- a/src/gpgme.h.in +++ b/src/gpgme.h.in @@ -95,6 +95,12 @@ extern "C" { #define _GPGME_DEPRECATED_OUTSIDE_GPGME(a,b) _GPGME_DEPRECATED(a,b) #endif +/* We used to use some symbols which clash with keywords in some + * languages. This macro is used to obsolete them. */ +#if defined(__cplusplus) || defined(SWIGPYTHON) +# define _GPGME_OBSOLETE_SOME_SYMBOLS 1 +#endif + /* Check for a matching _FILE_OFFSET_BITS definition. */ #if @NEED__FILE_OFFSET_BITS@ @@ -640,7 +646,7 @@ struct _gpgme_key_sig gpgme_error_t status; /* Deprecated; use SIG_CLASS instead. */ -#ifdef __cplusplus +#ifdef _GPGME_OBSOLETE_SOME_SYMBOLS unsigned int _obsolete_class _GPGME_DEPRECATED(0,4); #else unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME(0,4); @@ -1466,7 +1472,7 @@ struct _gpgme_new_signature char *fpr; /* Deprecated; use SIG_CLASS instead. */ -#ifdef __cplusplus +#ifdef _GPGME_OBSOLETE_SOME_SYMBOLS unsigned int _obsolete_class_2; #else unsigned int class _GPGME_DEPRECATED_OUTSIDE_GPGME(0,4); ----------------------------------------------------------------------- Summary of changes: lang/python/gpgme.i | 9 ++- lang/python/tests/t-keylist-from-data.py | 90 ++++++++++++++-------------- lang/python/tests/t-keylist.py | 73 +++++++++++----------- lang/python/tests/t-quick-key-creation.py | 7 ++- lang/python/tests/t-quick-subkey-creation.py | 6 +- src/gpgme.h.in | 10 +++- 6 files changed, 108 insertions(+), 87 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Fri Sep 21 14:39:02 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Fri, 21 Sep 2018 14:39:02 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-19-gb371e3c Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via b371e3ca906e6a4db31900d419ddc2b21bed1ea3 (commit) via 3fc4ce49b23a364a1cf255c8e9e259047206e1e8 (commit) from 15309d0fb4c78f8de9bc5dea7d0f8b7468a957b4 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b371e3ca906e6a4db31900d419ddc2b21bed1ea3 Author: Werner Koch Date: Fri Sep 21 14:20:29 2018 +0200 core: Make cross building in mkheader more explicit. * src/mkheader.c (main): Add option --cross. (write_special): Don't use native in cross mode. * src/Makefile.am (mkheader_opts): New. (gpg-error.h): Add MKHEADER_OPTS. -- The old behaviour was that an existing lock-obj-oub.native.h was preferred over one from syscfg even in cross mode. The Makefile tried to get this right by deleting such a file first but when calling mkheader manually for testing this may have not been done. We now allow (and also use by the Makefile) an option --cross to make this explicit. Signed-off-by: Werner Koch diff --git a/src/Makefile.am b/src/Makefile.am index ca04262..c74baae 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -312,8 +312,10 @@ parts_of_gpg_error_h = \ if FORCE_USE_SYSCFG pre_mkheader_cmds = if test -f lock-obj-pub.native.h; \ then rm lock-obj-pub.native.h; fi +mkheader_opts = --cross else pre_mkheader_cmds = : +mkheader_opts = parts_of_gpg_error_h += ./lock-obj-pub.native.h ./lock-obj-pub.native.h: Makefile gen-posix-lock-obj$(EXEEXT) posix-lock-obj.h @@ -325,7 +327,8 @@ endif gpg-error.h: Makefile mkheader$(EXEEXT_FOR_BUILD) $(parts_of_gpg_error_h) \ versioninfo.rc ../config.h $(pre_mkheader_cmds) - ./mkheader$(EXEEXT_FOR_BUILD) $(host_triplet) $(srcdir)/gpg-error.h.in \ + ./mkheader$(EXEEXT_FOR_BUILD) $(mkheader_opts) \ + $(host_triplet) $(srcdir)/gpg-error.h.in \ ../config.h $(PACKAGE_VERSION) $(VERSION_NUMBER) >$@ gpgrt.h: gpg-error.h diff --git a/src/mkheader.c b/src/mkheader.c index 6071a20..9a96b84 100644 --- a/src/mkheader.c +++ b/src/mkheader.c @@ -27,6 +27,7 @@ static char *host_os; /* points into host_triplet. */ static char *srcdir; static const char *hdr_version; static const char *hdr_version_number; +static int cross_building; /* Command line flag. */ /* Values take from the supplied config.h. */ static int have_stdint_h; @@ -611,7 +612,11 @@ write_special (const char *fname, int lnr, const char *tag) } else if (!strcmp (tag, "include:lock-obj")) { - if (try_include_file (fname, lnr, "./lock-obj-pub.native.h", write_line)) + /* If we are not cross compiling and the native file exists we + * prefer that over one from syscfg. */ + if (cross_building + || try_include_file (fname, lnr, + "./lock-obj-pub.native.h", write_line)) include_file (fname, lnr, "syscfg/lock-obj-pub.&.h", write_line); } else @@ -636,6 +641,11 @@ main (int argc, char **argv) { argc--; argv++; } + if (argc && !strcmp (argv[0], "--cross")) + { + cross_building = 1; + argc--; argv++; + } if (argc == 1) { commit 3fc4ce49b23a364a1cf255c8e9e259047206e1e8 Author: Werner Koch Date: Fri Sep 21 14:02:42 2018 +0200 core: Simplify calling convention of mkheader. * src/Makefile.am (gpg-error.h): Remove HOST_OS from mkheader call. * src/mkheader.c (canon_host_triplet): Add return arg r_os. (main): Remove first arg and derive host_os from host_triplet. -- No need to let the caller pass the host_os, we can derive it from the triplet. Signed-off-by: Werner Koch diff --git a/src/Makefile.am b/src/Makefile.am index 360e7f5..ca04262 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -325,7 +325,7 @@ endif gpg-error.h: Makefile mkheader$(EXEEXT_FOR_BUILD) $(parts_of_gpg_error_h) \ versioninfo.rc ../config.h $(pre_mkheader_cmds) - ./mkheader$(EXEEXT_FOR_BUILD) $(host_os) $(host_triplet) $(srcdir)/gpg-error.h.in \ + ./mkheader$(EXEEXT_FOR_BUILD) $(host_triplet) $(srcdir)/gpg-error.h.in \ ../config.h $(PACKAGE_VERSION) $(VERSION_NUMBER) >$@ gpgrt.h: gpg-error.h diff --git a/src/mkheader.c b/src/mkheader.c index 7a38a1b..6071a20 100644 --- a/src/mkheader.c +++ b/src/mkheader.c @@ -22,8 +22,8 @@ #define LINESIZE 1024 -static const char *host_os; -static char *host_triplet; +static char *host_triplet; /* malloced. */ +static char *host_os; /* points into host_triplet. */ static char *srcdir; static const char *hdr_version; static const char *hdr_version_number; @@ -78,12 +78,13 @@ xstrdup (const char *string) /* Return a malloced string with TRIPLET. If TRIPLET has an alias - return that instead. In general build-aux/config.sub should do the - aliasing but some returned triplets are anyway identical and thus - we use this function to map it to the canonical form. - NO_VENDOR_HACK is for internal use; caller must call with 0. */ + * return that instead. In general build-aux/config.sub should do the + * aliasing but some returned triplets are anyway identical and thus + * we use this function to map it to the canonical form. A pointer to + * the OS part of the returned value is stored at R_OS. + * NO_VENDOR_HACK is for internal use; caller must call with 0. */ static char * -canon_host_triplet (const char *triplet, int no_vendor_hack) +canon_host_triplet (const char *triplet, int no_vendor_hack, char **r_os) { struct { const char *name; @@ -117,6 +118,8 @@ canon_host_triplet (const char *triplet, int no_vendor_hack) int i; const char *lastalias = NULL; const char *s; + char *p; + char *result; for (i=0; tbl[i].name; i++) { @@ -126,7 +129,8 @@ canon_host_triplet (const char *triplet, int no_vendor_hack) { if (!lastalias) break; /* Ooops: first entry has no alias. */ - return xstrdup (lastalias); + result = xstrdup (lastalias); + goto leave; } } for (i=0, s=triplet; *s; s++) @@ -139,7 +143,6 @@ canon_host_triplet (const char *triplet, int no_vendor_hack) * The VENDOR part is then in general useless because * KERNEL-SYSTEM is specific enough. We now do a second pass by * replacing VENDOR with "unknown". */ - char *p; char *buf = xmalloc (strlen (triplet) + 7 + 1); for (p=buf,s=triplet,i=0; *s; s++) @@ -154,12 +157,26 @@ canon_host_triplet (const char *triplet, int no_vendor_hack) } } *p = 0; - p = canon_host_triplet (buf, 1); + result = canon_host_triplet (buf, 1, NULL); xfree (buf); - return p; + goto leave; + } + + result = xstrdup (triplet); + leave: + /* Find the OS part. */ + if (r_os) + { + *r_os = result + strlen (result); /* Default to the empty string. */ + for (i=0, p=result; *p; p++) + if (*p == '-' && ++i == 2) + { + *r_os = p+1; + break; + } } - return xstrdup (triplet); + return result; } @@ -176,7 +193,7 @@ parse_config_h (const char *fname) fp = fopen (fname, "r"); if (!fp) { - fprintf (stderr, "%s:%d: can't open file: %s", + fprintf (stderr, "%s:%d: can't open file: %s\n", fname, lnr, strerror (errno)); return 1; } @@ -623,30 +640,28 @@ main (int argc, char **argv) if (argc == 1) { /* Print just the canonicalized host triplet. */ - host_triplet = canon_host_triplet (argv[0], 0); + host_triplet = canon_host_triplet (argv[0], 0, &host_os); printf ("%s\n", host_triplet); goto leave; } - else if (argc == 6) + else if (argc == 5) ; /* Standard operation. */ else { fputs ("usage: " PGM - " host_os host_triplet template.h config.h" - " version version_number\n" + " host_triplet template.h config.h version version_number\n" " " PGM " host_triplet\n", stderr); return 1; } - host_os = argv[0]; - host_triplet_raw = argv[1]; - fname = argv[2]; - config_h = argv[3]; - hdr_version = argv[4]; - hdr_version_number = argv[5]; + host_triplet_raw = argv[0]; + fname = argv[1]; + config_h = argv[2]; + hdr_version = argv[3]; + hdr_version_number = argv[4]; - host_triplet = canon_host_triplet (host_triplet_raw, 0); + host_triplet = canon_host_triplet (host_triplet_raw, 0, &host_os); srcdir = malloc (strlen (fname) + 2 + 1); if (!srcdir) @@ -667,7 +682,7 @@ main (int argc, char **argv) fp = fopen (fname, "r"); if (!fp) { - fprintf (stderr, "%s:%d: can't open file: %s", + fprintf (stderr, "%s:%d: can't open file: %s\n", fname, lnr, strerror (errno)); return 1; } ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 5 +++- src/mkheader.c | 77 ++++++++++++++++++++++++++++++++++++++------------------- 2 files changed, 55 insertions(+), 27 deletions(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Fri Sep 21 14:46:52 2018 From: cvs at cvs.gnupg.org (by Werner Koch) Date: Fri, 21 Sep 2018 14:46:52 +0200 Subject: [git] GPG-ERROR - branch, master, updated. libgpg-error-1.32-20-gf4f0da7 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Error codes used by GnuPG et al.". The branch, master has been updated via f4f0da74f526d7e35cedbc2e93454df6440dbfa5 (commit) from b371e3ca906e6a4db31900d419ddc2b21bed1ea3 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit f4f0da74f526d7e35cedbc2e93454df6440dbfa5 Author: Werner Koch Date: Fri Sep 21 14:37:21 2018 +0200 syscfg: Add support for arc-unknown-linux-gnu * src/mkheader.c (canon_host_triplet): Add to table. -- Note that unknown in the above triplet is actually a wildcard for 4 part triplets. Signed-off-by: Werner Koch diff --git a/src/mkheader.c b/src/mkheader.c index 9a96b84..53ae49c 100644 --- a/src/mkheader.c +++ b/src/mkheader.c @@ -94,7 +94,8 @@ canon_host_triplet (const char *triplet, int no_vendor_hack, char **r_os) {"i486-pc-linux-gnu", "i686-unknown-linux-gnu" }, {"i586-pc-linux-gnu" }, {"i686-pc-linux-gnu" }, - {"arc-oe-linux-uclibc" }, /* Other CPU but same struct. */ + {"arc-oe-linux-gnu" }, /* Other CPU but same struct. */ + {"arc-oe-linux-uclibc" }, /* and uclibc is also the same. */ {"i486-pc-gnu", "i686-unknown-gnu"}, {"i586-pc-gnu"}, ----------------------------------------------------------------------- Summary of changes: src/mkheader.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) hooks/post-receive -- Error codes used by GnuPG et al. http://git.gnupg.org From cvs at cvs.gnupg.org Sat Sep 22 21:43:21 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sat, 22 Sep 2018 21:43:21 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-299-g3622576 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 3622576105ae1924d9b40ce0d09bf9a7accc0ed1 (commit) from 6878126b6f53cdf7daeeaf68116dda008564c2fa (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 3622576105ae1924d9b40ce0d09bf9a7accc0ed1 Author: Ben McGinnes Date: Sun Sep 23 05:37:40 2018 +1000 docs: python bindings howto * Confirmed that updates to the tests have significant'y improved that output. * Updated some of the additional notes for the section on hkp4py. ** This is in anticipation adding at least import examples using that module as well. It may also include adding examples of exporting a key and uploading it to the keyservers. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 85a8dcf..e78c6f8 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -2265,7 +2265,7 @@ support for Python 2.7 as well and is available via PyPI. Since it rewrites the @samp{hkp} protocol prefix as @samp{http} and @samp{hkps} as @samp{https}, the module is able to be used even with servers which do not -support the full scope of keyserver functions. It will work quite +support the full scope of keyserver functions. It also works quite readily when incorporated into a @ref{C plus Python plus SWIG plus Cython, , Cython} generated and compiled version of any code. @@ -2281,6 +2281,23 @@ The hkp4py module returns key data via requests as string literals the retrurned key data must be encoded to UTF-8 when importing that key material using a @samp{gpg.Context().key_import()} method. +For this reason an alternative method has been added to the @samp{search} +function of @samp{hkp4py.KeyServer()} which returns the key in the correct +format as expected by @samp{key_import}. When importing using this module, +it is now possible to import with this: + + at example +for key in keys: + if key.revoked is False: + gpg.Context().key_import(key.key_blob) + else: + pass + at end example + +Without that recent addition it would have been necessary to encode +the contents of each @samp{hkp4py.KeyServer().search()[i].key} in + at samp{hkp4py.KeyServer().search()} before trying to import it. + @node Copyright and Licensing @chapter Copyright and Licensing diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 53ca3a5..4373e0f 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2169,7 +2169,7 @@ support for Python 2.7 as well and is available via PyPI. Since it rewrites the =hkp= protocol prefix as =http= and =hkps= as =https=, the module is able to be used even with servers which do not -support the full scope of keyserver functions. It will work quite +support the full scope of keyserver functions. It also works quite readily when incorporated into a [[#cython][Cython]] generated and compiled version of any code. @@ -2184,6 +2184,24 @@ The hkp4py module returns key data via requests as string literals the retrurned key data must be encoded to UTF-8 when importing that key material using a =gpg.Context().key_import()= method. +For this reason an alternative method has been added to the =search= +function of =hkp4py.KeyServer()= which returns the key in the correct +format as expected by =key_import=. When importing using this module, +it is now possible to import with this: + +#+BEGIN_SRC python -i +for key in keys: + if key.revoked is False: + gpg.Context().key_import(key.key_blob) + else: + pass +#+END_SRC + +Without that recent addition it would have been necessary to encode +the contents of each =hkp4py.KeyServer().search()[i].key= in +=hkp4py.KeyServer().search()= before trying to import it. + + * Copyright and Licensing :PROPERTIES: ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 19 ++++++++++++++++++- lang/python/docs/gpgme-python-howto.org | 20 +++++++++++++++++++- 2 files changed, 37 insertions(+), 2 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 23 00:27:10 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 23 Sep 2018 00:27:10 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-300-g6ed9a77 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 6ed9a77c92c32f77092b36c149185d4359cd6e55 (commit) from 3622576105ae1924d9b40ce0d09bf9a7accc0ed1 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 6ed9a77c92c32f77092b36c149185d4359cd6e55 Author: Ben McGinnes Date: Sun Sep 23 08:18:44 2018 +1000 python bindings: importing from keyservers with hkp4py * added a new example script to search the keyservers and import the results, this time using Marcel Fest's hkp4py module. * Updated the key importing section to match this addition. * Tested with the current version of hkp4py from github. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index e78c6f8..2863d57 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -38,6 +38,7 @@ Introduction * Python 2 versus Python 3:: * Examples:: +* Unofficial Drafts:: GPGME Concepts @@ -167,6 +168,7 @@ Python bindings to programmatically leverage the GPGME library. @menu * Python 2 versus Python 3:: * Examples:: +* Unofficial Drafts:: @end menu @node Python 2 versus Python 3 @@ -198,6 +200,14 @@ types with which GPGME deals considerably easier. All of the examples found in this document can be found as Python 3 scripts in the @samp{lang/python/examples/howto} directory. + at node Unofficial Drafts + at section Unofficial Drafts + +In addition to shipping with each release of GPGME, there is a section +on locations to read or download @ref{Draft Editions of this HOWTO, , draft editions} of this document from +at the end of it. These are unofficial versions produced in between +major releases. + @node GPGME Concepts @chapter GPGME Concepts @@ -780,7 +790,7 @@ import requests c = gpg.Context() url = "https://sks-keyservers.net/pks/lookup" pattern = input("Enter the pattern to search for key or user IDs: ") -payload = @{ "op": "get", "search": pattern @} +payload = @{"op": "get", "search": pattern@} r = requests.get(url, verify=True, params=payload) result = c.key_import(r.content) @@ -822,8 +832,77 @@ relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in 2016). -Here is a variation on the above which checks the constrained -ProtonMail keyserver for ProtonMail public keys. +Performing the same task with the @uref{https://github.com/Selfnet/hkp4py, hkp4py module} (available via PyPI) +is not too much different, but does provide a number of options of +benefit to end users. Not least of which being the ability to perform +some checks on a key before importing it or not. For instance it may +be the policy of a site or project to only import keys which have not +been revoked. The hkp4py module permits such checks prior to the +importing of the keys found. + + at example +import gpg +import hkp4py + +c = gpg.Context() +server = hkp4py.KeyServer("https://hkps.pool.sks-keyservers.net") +pattern = input("Enter the pattern to search for keys or user IDs: ") +results = [] + +try: + keys = server.search(pattern) + print("Found @{0@} key(s).".format(len(keys))) +except Exception as e: + keys = [] + for logrus in pattern.split(): + if logrus.startswith("0x") is True: + key = server.search(logrus) + else: + key = server.search("0x@{0@}".format(logrus)) + keys.append(key[0]) + print("Found @{0@} key(s).".format(len(keys))) + +for key in keys: + import_result = c.key_import(key.key_blob) + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print(result) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: @{0@} + + Number of keys revoked: @{1@} + Number of new signatures: @{2@} + Number of new subkeys: @{3@} + Number of new user IDs: @{4@} +Number of new secret keys: @{5@} + Number of unchanged keys: @{6@} + +The key IDs for all considered keys were: +""".format(num_keys, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + else: + pass + at end example + +Since the hkp4py module handles multiple keys just as effectively as +one (@samp{keys} is a list of responses per matching key), thie above +example is able to do a little bit more with the returned data. + +Here is a variation on the first example above which checks the +constrained ProtonMail keyserver for ProtonMail public keys. @example import gpg diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 4373e0f..58964f3 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -61,6 +61,17 @@ All of the examples found in this document can be found as Python 3 scripts in the =lang/python/examples/howto= directory. +** Unofficial Drafts + :PROPERTIES: + :CUSTOM_ID: unofficial-drafts + :END: + +In addition to shipping with each release of GPGME, there is a section +on locations to read or download [[#draft-editions][draft editions]] of this document from +at the end of it. These are unofficial versions produced in between +major releases. + + * GPGME Concepts :PROPERTIES: :CUSTOM_ID: gpgme-concepts @@ -654,7 +665,7 @@ import requests c = gpg.Context() url = "https://sks-keyservers.net/pks/lookup" pattern = input("Enter the pattern to search for key or user IDs: ") -payload = { "op": "get", "search": pattern } +payload = {"op": "get", "search": pattern} r = requests.get(url, verify=True, params=payload) result = c.key_import(r.content) @@ -696,8 +707,84 @@ relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in 2016). -Here is a variation on the above which checks the constrained -ProtonMail keyserver for ProtonMail public keys. +Performing the same task with the [[https://github.com/Selfnet/hkp4py][hkp4py module]] (available via PyPI) +is not too much different, but does provide a number of options of +benefit to end users. Not least of which being the ability to perform +some checks on a key before importing it or not. For instance it may +be the policy of a site or project to only import keys which have not +been revoked. The hkp4py module permits such checks prior to the +importing of the keys found. + +#+BEGIN_SRC python -i +import gpg +import hkp4py +import sys + +c = gpg.Context() +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") +results = [] + +if len(sys.argv) > 2: + pattern = " ".join(sys.argv[1:]) +elif len(sys.argv) == 2: + pattern = sys.argv[1] +else: + pattern = input("Enter the pattern to search for keys or user IDs: ") + +try: + keys = server.search(pattern) + print("Found {0} key(s).".format(len(keys))) +except Exception as e: + keys = [] + for logrus in pattern.split(): + if logrus.startswith("0x") is True: + key = server.search(logrus) + else: + key = server.search("0x{0}".format(logrus)) + keys.append(key[0]) + print("Found {0} key(s).".format(len(keys))) + +for key in keys: + import_result = c.key_import(key.key_blob) + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print(result) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + + Number of keys revoked: {1} + Number of new signatures: {2} + Number of new subkeys: {3} + Number of new user IDs: {4} +Number of new secret keys: {5} + Number of unchanged keys: {6} + +The key IDs for all considered keys were: +""".format(num_keys, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + else: + pass +#+END_SRC + +Since the hkp4py module handles multiple keys just as effectively as +one (=keys= is a list of responses per matching key), thie above +example is able to do a little bit more with the returned data. + +Here is a variation on the first example above which checks the +constrained ProtonMail keyserver for ProtonMail public keys. #+BEGIN_SRC python -i import gpg diff --git a/lang/python/examples/howto/import-keys-hkp.py b/lang/python/examples/howto/import-keys-hkp.py new file mode 100755 index 0000000..d50e465 --- /dev/null +++ b/lang/python/examples/howto/import-keys-hkp.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, unicode_literals + +import gpg +import hkp4py +import sys + +# Copyright (C) 2018 Ben McGinnes +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU General Public License and the GNU +# Lesser General Public along with this program; if not, see +# . + +print(""" +This script imports one or more public keys from the SKS keyservers. +""") + +c = gpg.Context() +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") +results = [] + +if len(sys.argv) > 2: + pattern = " ".join(sys.argv[1:]) +elif len(sys.argv) == 2: + pattern = sys.argv[1] +else: + pattern = input("Enter the pattern to search for keys or user IDs: ") + +try: + keys = server.search(pattern) + print("Found {0} key(s).".format(len(keys))) +except Exception as e: + keys = [] + for logrus in pattern.split(): + if logrus.startswith("0x") is True: + key = server.search(logrus) + else: + key = server.search("0x{0}".format(logrus)) + keys.append(key[0]) + print("Found {0} key(s).".format(len(keys))) + +for key in keys: + import_result = c.key_import(key.key_blob) + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print(result) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + + Number of keys revoked: {1} + Number of new signatures: {2} + Number of new subkeys: {3} + Number of new user IDs: {4} +Number of new secret keys: {5} + Number of unchanged keys: {6} + +The key IDs for all considered keys were: +""".format(num_keys, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + else: + pass ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 85 +++++++++++++++++++- lang/python/docs/gpgme-python-howto.org | 93 +++++++++++++++++++++- .../howto/{import-keys.py => import-keys-hkp.py} | 69 ++++++++++------ 3 files changed, 217 insertions(+), 30 deletions(-) copy lang/python/examples/howto/{import-keys.py => import-keys-hkp.py} (52%) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 23 03:46:04 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 23 Sep 2018 03:46:04 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-301-gced4bdb Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via ced4bdbbb239c1fe209665b4f5a7aeb9651889ed (commit) from 6ed9a77c92c32f77092b36c149185d4359cd6e55 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit ced4bdbbb239c1fe209665b4f5a7aeb9651889ed Author: Ben McGinnes Date: Sun Sep 23 11:43:34 2018 +1000 examples: python bindings and hkp4py updates * Mostly tightening up the details on the hkp4py example script. * Also fixed a typo in the LGPL boiler plate text included in all the other example scripts for the HOWTO. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 2863d57..7b8b79d 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -843,12 +843,19 @@ importing of the keys found. @example import gpg import hkp4py +import sys c = gpg.Context() -server = hkp4py.KeyServer("https://hkps.pool.sks-keyservers.net") -pattern = input("Enter the pattern to search for keys or user IDs: ") +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") results = [] +if len(sys.argv) > 2: + pattern = " ".join(sys.argv[1:]) +elif len(sys.argv) == 2: + pattern = sys.argv[1] +else: + pattern = input("Enter the pattern to search for keys or user IDs: ") + try: keys = server.search(pattern) print("Found @{0@} key(s).".format(len(keys))) @@ -2377,6 +2384,11 @@ Without that recent addition it would have been necessary to encode the contents of each @samp{hkp4py.KeyServer().search()[i].key} in @samp{hkp4py.KeyServer().search()} before trying to import it. +An example of this is included in the @ref{Importing keys, , Importing Keys} section of this +HOWTO and the corresponding executable version of that example is +available in the @samp{lang/python/examples/howto} directory as normal; the +executable version is the @samp{import-keys-hkp.py} file. + @node Copyright and Licensing @chapter Copyright and Licensing diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 58964f3..b5b9ed4 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -2288,6 +2288,10 @@ Without that recent addition it would have been necessary to encode the contents of each =hkp4py.KeyServer().search()[i].key= in =hkp4py.KeyServer().search()= before trying to import it. +An example of this is included in the [[#howto-import-key][Importing Keys]] section of this +HOWTO and the corresponding executable version of that example is +available in the =lang/python/examples/howto= directory as normal; the +executable version is the =import-keys-hkp.py= file. * Copyright and Licensing diff --git a/lang/python/examples/howto/add-userid.py b/lang/python/examples/howto/add-userid.py index b868979..0c7bb89 100755 --- a/lang/python/examples/howto/add-userid.py +++ b/lang/python/examples/howto/add-userid.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/clear-sign-file.py b/lang/python/examples/howto/clear-sign-file.py index 597bbc5..9d350e2 100755 --- a/lang/python/examples/howto/clear-sign-file.py +++ b/lang/python/examples/howto/clear-sign-file.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/create-key.py b/lang/python/examples/howto/create-key.py index 429ab1f..02d1cb3 100755 --- a/lang/python/examples/howto/create-key.py +++ b/lang/python/examples/howto/create-key.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/decrypt-file.py b/lang/python/examples/howto/decrypt-file.py index 2fe37f2..8eba1f2 100755 --- a/lang/python/examples/howto/decrypt-file.py +++ b/lang/python/examples/howto/decrypt-file.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/detach-sign-file.py b/lang/python/examples/howto/detach-sign-file.py index 99fbe65..a0c5a2a 100755 --- a/lang/python/examples/howto/detach-sign-file.py +++ b/lang/python/examples/howto/detach-sign-file.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/encrypt-file.py b/lang/python/examples/howto/encrypt-file.py index 7c84a6f..8951cb5 100755 --- a/lang/python/examples/howto/encrypt-file.py +++ b/lang/python/examples/howto/encrypt-file.py @@ -21,7 +21,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/encrypt-sign-file.py b/lang/python/examples/howto/encrypt-sign-file.py index a08176b..6610ee0 100755 --- a/lang/python/examples/howto/encrypt-sign-file.py +++ b/lang/python/examples/howto/encrypt-sign-file.py @@ -21,7 +21,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/encrypt-to-group-gullible.py b/lang/python/examples/howto/encrypt-to-group-gullible.py index c96e829..5ba82bc 100755 --- a/lang/python/examples/howto/encrypt-to-group-gullible.py +++ b/lang/python/examples/howto/encrypt-to-group-gullible.py @@ -22,7 +22,7 @@ from groups import group_lists # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/encrypt-to-group-trustno1.py b/lang/python/examples/howto/encrypt-to-group-trustno1.py index da0376b..680c9ea 100755 --- a/lang/python/examples/howto/encrypt-to-group-trustno1.py +++ b/lang/python/examples/howto/encrypt-to-group-trustno1.py @@ -22,7 +22,7 @@ from groups import group_lists # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/encrypt-to-group.py b/lang/python/examples/howto/encrypt-to-group.py index d4cb074..e4ef1b6 100755 --- a/lang/python/examples/howto/encrypt-to-group.py +++ b/lang/python/examples/howto/encrypt-to-group.py @@ -22,7 +22,7 @@ from groups import group_lists # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/export-key.py b/lang/python/examples/howto/export-key.py index 913bfce..80768fe 100755 --- a/lang/python/examples/howto/export-key.py +++ b/lang/python/examples/howto/export-key.py @@ -22,7 +22,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/export-minimised-key.py b/lang/python/examples/howto/export-minimised-key.py index 3889adc..9d5f848 100755 --- a/lang/python/examples/howto/export-minimised-key.py +++ b/lang/python/examples/howto/export-minimised-key.py @@ -22,7 +22,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/export-secret-key.py b/lang/python/examples/howto/export-secret-key.py index e9c53fe..ccc9f45 100755 --- a/lang/python/examples/howto/export-secret-key.py +++ b/lang/python/examples/howto/export-secret-key.py @@ -23,7 +23,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/export-secret-keys.py b/lang/python/examples/howto/export-secret-keys.py index 0f4d8ee..f2f1ccd 100755 --- a/lang/python/examples/howto/export-secret-keys.py +++ b/lang/python/examples/howto/export-secret-keys.py @@ -24,7 +24,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/groups.py b/lang/python/examples/howto/groups.py index 7213538..3d51b25 100644 --- a/lang/python/examples/howto/groups.py +++ b/lang/python/examples/howto/groups.py @@ -17,7 +17,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/import-key.py b/lang/python/examples/howto/import-key.py index 2591378..ab52ba2 100755 --- a/lang/python/examples/howto/import-key.py +++ b/lang/python/examples/howto/import-key.py @@ -24,7 +24,7 @@ del absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/import-keys.py b/lang/python/examples/howto/import-keys.py index bdc15a6..d1a268e 100755 --- a/lang/python/examples/howto/import-keys.py +++ b/lang/python/examples/howto/import-keys.py @@ -22,7 +22,7 @@ import requests # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/keycount.py b/lang/python/examples/howto/keycount.py index 8e25454..af47272 100755 --- a/lang/python/examples/howto/keycount.py +++ b/lang/python/examples/howto/keycount.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/mutt-groups.py b/lang/python/examples/howto/mutt-groups.py index c0b515a..6572a21 100755 --- a/lang/python/examples/howto/mutt-groups.py +++ b/lang/python/examples/howto/mutt-groups.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/pmkey-import-alt.py b/lang/python/examples/howto/pmkey-import-alt.py index 1b260e1..c7822f3 100755 --- a/lang/python/examples/howto/pmkey-import-alt.py +++ b/lang/python/examples/howto/pmkey-import-alt.py @@ -25,7 +25,7 @@ del absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/pmkey-import.py b/lang/python/examples/howto/pmkey-import.py index 66ad8aa..58a01c8 100755 --- a/lang/python/examples/howto/pmkey-import.py +++ b/lang/python/examples/howto/pmkey-import.py @@ -24,7 +24,7 @@ del absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/revoke-userid.py b/lang/python/examples/howto/revoke-userid.py index 7a3d190..be34748 100755 --- a/lang/python/examples/howto/revoke-userid.py +++ b/lang/python/examples/howto/revoke-userid.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/sign-file.py b/lang/python/examples/howto/sign-file.py index 01006df..f680965 100755 --- a/lang/python/examples/howto/sign-file.py +++ b/lang/python/examples/howto/sign-file.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/sign-key.py b/lang/python/examples/howto/sign-key.py index b1afe13..6d32c57 100755 --- a/lang/python/examples/howto/sign-key.py +++ b/lang/python/examples/howto/sign-key.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/symcrypt-file.py b/lang/python/examples/howto/symcrypt-file.py index 785a4d0..bce9286 100755 --- a/lang/python/examples/howto/symcrypt-file.py +++ b/lang/python/examples/howto/symcrypt-file.py @@ -21,7 +21,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/temp-homedir-config.py b/lang/python/examples/howto/temp-homedir-config.py index 1111fe2..98bde36 100755 --- a/lang/python/examples/howto/temp-homedir-config.py +++ b/lang/python/examples/howto/temp-homedir-config.py @@ -22,7 +22,7 @@ import sys # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/verify-signatures.py b/lang/python/examples/howto/verify-signatures.py index 8aafc3b..aa4331c 100755 --- a/lang/python/examples/howto/verify-signatures.py +++ b/lang/python/examples/howto/verify-signatures.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see diff --git a/lang/python/examples/howto/verify-signed-file.py b/lang/python/examples/howto/verify-signed-file.py index 9f8702f..c561fe8 100755 --- a/lang/python/examples/howto/verify-signed-file.py +++ b/lang/python/examples/howto/verify-signed-file.py @@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU -# Lesser General Public Licensefor more details. +# Lesser General Public License for more details. # # You should have received a copy of the GNU General Public License and the GNU # Lesser General Public along with this program; if not, see ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 16 ++++++++++++++-- lang/python/docs/gpgme-python-howto.org | 4 ++++ lang/python/examples/howto/add-userid.py | 2 +- lang/python/examples/howto/clear-sign-file.py | 2 +- lang/python/examples/howto/create-key.py | 2 +- lang/python/examples/howto/decrypt-file.py | 2 +- lang/python/examples/howto/detach-sign-file.py | 2 +- lang/python/examples/howto/encrypt-file.py | 2 +- lang/python/examples/howto/encrypt-sign-file.py | 2 +- lang/python/examples/howto/encrypt-to-group-gullible.py | 2 +- lang/python/examples/howto/encrypt-to-group-trustno1.py | 2 +- lang/python/examples/howto/encrypt-to-group.py | 2 +- lang/python/examples/howto/export-key.py | 2 +- lang/python/examples/howto/export-minimised-key.py | 2 +- lang/python/examples/howto/export-secret-key.py | 2 +- lang/python/examples/howto/export-secret-keys.py | 2 +- lang/python/examples/howto/groups.py | 2 +- lang/python/examples/howto/import-key.py | 2 +- lang/python/examples/howto/import-keys.py | 2 +- lang/python/examples/howto/keycount.py | 2 +- lang/python/examples/howto/mutt-groups.py | 2 +- lang/python/examples/howto/pmkey-import-alt.py | 2 +- lang/python/examples/howto/pmkey-import.py | 2 +- lang/python/examples/howto/revoke-userid.py | 2 +- lang/python/examples/howto/sign-file.py | 2 +- lang/python/examples/howto/sign-key.py | 2 +- lang/python/examples/howto/symcrypt-file.py | 2 +- lang/python/examples/howto/temp-homedir-config.py | 2 +- lang/python/examples/howto/verify-signatures.py | 2 +- lang/python/examples/howto/verify-signed-file.py | 2 +- 30 files changed, 46 insertions(+), 30 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 23 11:39:04 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 23 Sep 2018 11:39:04 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-302-gb12b2cc Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via b12b2cc99621fe32a2d698ce7f091f3225f35bd0 (commit) from ced4bdbbb239c1fe209665b4f5a7aeb9651889ed (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b12b2cc99621fe32a2d698ce7f091f3225f35bd0 Author: Ben McGinnes Date: Sun Sep 23 19:36:54 2018 +1000 docs and examples: python bindings howto * Added more comprehensive examples using hkp4py and added a couple more example scripts for protonmail. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 7b8b79d..2e30597 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -86,6 +86,12 @@ Key selection * Counting keys:: +Importing keys + +* Working with ProtonMail:: +* Importing with HKP for Python:: +* Importing from ProtonMail with HKP for Python:: + Exporting keys * Exporting public keys:: @@ -832,7 +838,125 @@ relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in 2016). -Performing the same task with the @uref{https://github.com/Selfnet/hkp4py, hkp4py module} (available via PyPI) + at menu +* Working with ProtonMail:: +* Importing with HKP for Python:: +* Importing from ProtonMail with HKP for Python:: + at end menu + + at node Working with ProtonMail + at subsection Working with ProtonMail + +Here is a variation on the example above which checks the constrained +ProtonMail keyserver for ProtonMail public keys. + + at example +import gpg +import requests +import sys + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. +""") + +c = gpg.Context(armor=True) +url = "https://api.protonmail.ch/pks/lookup" +ksearch = [] + +if len(sys.argv) >= 2: + keyterm = sys.argv[1] +else: + keyterm = input("Enter the key ID, UID or search string: ") + +if keyterm.count("@@") == 2 and keyterm.startswith("@@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) +elif keyterm.count("@@") == 1 and keyterm.startswith("@@") is True: + ksearch.append("@{0@}@@protonmail.com".format(keyterm[1:])) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm[1:])) + ksearch.append("@{0@}@@pm.me".format(keyterm[1:])) +elif keyterm.count("@@") == 0: + ksearch.append("@{0@}@@protonmail.com".format(keyterm)) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm)) + ksearch.append("@{0@}@@pm.me".format(keyterm)) +elif keyterm.count("@@") == 2 and keyterm.startswith("@@") is False: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) +elif keyterm.count("@@") > 2: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) +else: + ksearch.append(keyterm) + +for k in ksearch: + payload = @{"op": "get", "search": k@} + try: + r = requests.get(url, verify=True, params=payload) + if r.ok is True: + result = c.key_import(r.content) + elif r.ok is False: + result = r.content + except Exception as e: + result = None + + if result is not None and hasattr(result, "considered") is False: + print("@{0@} for @{1@}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: @{0@} + +With UIDs wholely or partially matching the following string: + + @{1@} + + Number of keys revoked: @{2@} + Number of new signatures: @{3@} + Number of new subkeys: @{4@} + Number of new user IDs: @{5@} +Number of new secret keys: @{6@} + Number of unchanged keys: @{7@} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + print(e) + at end example + +Both the above example, @uref{../examples/howto/pmkey-import.py, pmkey-import.py}, and a version which prompts +for an alternative GnuPG home directory, @uref{../examples/howto/pmkey-import-alt.py, pmkey-import-alt.py}, are +available with the other examples and are executable scripts. + +Note that while the ProtonMail servers are based on the SKS servers, +their server is related more to their API and is not feature complete +by comparison to the servers in the SKS pool. One notable difference +being that the ProtonMail server does not permit non ProtonMail users +to update their own keys, which could be a vector for attacking +ProtonMail users who may not receive a key's revocation if it had been +compromised. + + at node Importing with HKP for Python + at subsection Importing with HKP for Python + +Performing the same tasks with the @uref{https://github.com/Selfnet/hkp4py, hkp4py module} (available via PyPI) is not too much different, but does provide a number of options of benefit to end users. Not least of which being the ability to perform some checks on a key before importing it or not. For instance it may @@ -905,69 +1029,278 @@ The key IDs for all considered keys were: @end example Since the hkp4py module handles multiple keys just as effectively as -one (@samp{keys} is a list of responses per matching key), thie above -example is able to do a little bit more with the returned data. +one (@samp{keys} is a list of responses per matching key), the example +above is able to do a little bit more with the returned data before +anything is actually imported. + + at node Importing from ProtonMail with HKP for Python + at subsection Importing from ProtonMail with HKP for Python + +Though this can provide certain benefits even when working with +ProtonMail, the scope is somewhat constrained there due to the +limitations of the ProtonMail keyserver. + +For instance, searching the SKS keyserver pool for the term "gnupg" +produces hundreds of results from any time the word appears in any +part of a user ID. Performing the same search on the ProtonMail +keyserver returns zero results, even though there are at least two +test accounts which include it as part of the username. + +The cause of this discrepancy is the deliberate configuration of that +server by ProtonMail to require an exact match of the full email +address of the ProtonMail user whose key is being requested. +Presumably this is intended to reduce breaches of privacy of their +users as an email address must already be known before a key for that +address can be obtained. -Here is a variation on the first example above which checks the -constrained ProtonMail keyserver for ProtonMail public keys. + at enumerate + at item +Import from ProtonMail via HKP for Python Example no. 1 + + +The following script is avalable with the rest of the examples under +the somewhat less than original name, @samp{pmkey-import-hkp.py}. @example import gpg -import requests +import hkp4py +import os.path import sys print(""" This script searches the ProtonMail key server for the specified key and imports it. + +Usage: pmkey-import-hkp.py [search strings] """) c = gpg.Context(armor=True) -url = "https://api.protonmail.ch/pks/lookup" +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None -if len(sys.argv) >= 2: +if len(sys.argv) > 2: + keyterms = sys.argv[1:] +elif len(sys.argv) == 2: keyterm = sys.argv[1] + keyterms.append(keyterm) +else: + key_term = input("Enter the key ID, UID or search string: ") + keyterms = key_term.split() + +for keyterm in keyterms: + if keyterm.count("@@") == 2 and keyterm.startswith("@@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@@") == 1 and keyterm.startswith("@@") is True: + ksearch.append("@{0@}@@protonmail.com".format(keyterm[1:])) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm[1:])) + ksearch.append("@{0@}@@pm.me".format(keyterm[1:])) + elif keyterm.count("@@") == 0: + ksearch.append("@{0@}@@protonmail.com".format(keyterm)) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm)) + ksearch.append("@{0@}@@pm.me".format(keyterm)) + elif keyterm.count("@@") == 2 and keyterm.startswith("@@") is False: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) + elif keyterm.count("@@") > 2: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) + else: + ksearch.append(keyterm) + +for k in ksearch: + print("Checking for key for: @{0@}".format(k)) + try: + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None + except Exception as e: + import_result = None + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print("@{0@} for @{1@}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: @{0@} + +With UIDs wholely or partially matching the following string: + + @{1@} + + Number of keys revoked: @{2@} + Number of new signatures: @{3@} + Number of new subkeys: @{4@} + Number of new user IDs: @{5@} +Number of new secret keys: @{6@} + Number of unchanged keys: @{7@} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + pass + at end example + + at item +Import from ProtonMail via HKP for Python Example no. 2 + + +Like its counterpart above, this script can also be found with the +rest of the examples, by the name pmkey-import-hkp-alt.py. + +With this script a modicum of effort has been made to treat anything +passed as a @samp{homedir} which either does not exist or which is not a +directory, as also being a pssible user ID to check for. It's not +guaranteed to pick up on all such cases, but it should cover most of +them. + + at example +import gpg +import hkp4py +import os.path +import sys + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. Optionally enables specifying a different GnuPG home directory. + +Usage: pmkey-import-hkp.py [homedir] [search string] + or: pmkey-import-hkp.py [search string] +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] +ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None + +if len(sys.argv) > 3: + homedir = sys.argv[1] + keyterms = sys.argv[2:] +elif len(sys.argv) == 3: + homedir = sys.argv[1] + keyterm = sys.argv[2] + keyterms.append(keyterm) +elif len(sys.argv) == 2: + homedir = "" + keyterm = sys.argv[1] + keyterms.append(keyterm) else: keyterm = input("Enter the key ID, UID or search string: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + keyterms.append(keyterm) -if keyterm.count("@@") == 2 and keyterm.startswith("@@") is True: - ksearch.append(keyterm[1:]) - ksearch.append(keyterm[1:]) - ksearch.append(keyterm[1:]) -elif keyterm.count("@@") == 1 and keyterm.startswith("@@") is True: - ksearch.append("@{0@}@@protonmail.com".format(keyterm[1:])) - ksearch.append("@{0@}@@protonmail.ch".format(keyterm[1:])) - ksearch.append("@{0@}@@pm.me".format(keyterm[1:])) -elif keyterm.count("@@") == 0: - ksearch.append("@{0@}@@protonmail.com".format(keyterm)) - ksearch.append("@{0@}@@protonmail.ch".format(keyterm)) - ksearch.append("@{0@}@@pm.me".format(keyterm)) -elif keyterm.count("@@") == 2 and keyterm.startswith("@@") is False: - uidlist = keyterm.split("@@") - for uid in uidlist: - ksearch.append("@{0@}@@protonmail.com".format(uid)) - ksearch.append("@{0@}@@protonmail.ch".format(uid)) - ksearch.append("@{0@}@@pm.me".format(uid)) -elif keyterm.count("@@") > 2: - uidlist = keyterm.split("@@") - for uid in uidlist: - ksearch.append("@{0@}@@protonmail.com".format(uid)) - ksearch.append("@{0@}@@protonmail.ch".format(uid)) - ksearch.append("@{0@}@@pm.me".format(uid)) +if len(homedir) == 0: + homedir = None + homeless = False + +if homedir is not None: + if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + if os.path.isdir(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.realpath(os.path.expanduser(homedir)) + else: + homeless = True + else: + homeless = True + elif os.path.exists(os.path.realpath(homedir)) is True: + if os.path.isdir(os.path.realpath(homedir)) is True: + c.home_dir = os.path.realpath(homedir) + else: + homeless = True + else: + homeless = True + +# First check to see if the homedir really is a homedir and if not, treat it as +# a search string. +if homeless is True: + keyterms.append(homedir) + c.home_dir = None else: - ksearch.append(keyterm) + pass + +for keyterm in keyterms: + if keyterm.count("@@") == 2 and keyterm.startswith("@@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@@") == 1 and keyterm.startswith("@@") is True: + ksearch.append("@{0@}@@protonmail.com".format(keyterm[1:])) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm[1:])) + ksearch.append("@{0@}@@pm.me".format(keyterm[1:])) + elif keyterm.count("@@") == 0: + ksearch.append("@{0@}@@protonmail.com".format(keyterm)) + ksearch.append("@{0@}@@protonmail.ch".format(keyterm)) + ksearch.append("@{0@}@@pm.me".format(keyterm)) + elif keyterm.count("@@") == 2 and keyterm.startswith("@@") is False: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) + elif keyterm.count("@@") > 2: + uidlist = keyterm.split("@@") + for uid in uidlist: + ksearch.append("@{0@}@@protonmail.com".format(uid)) + ksearch.append("@{0@}@@protonmail.ch".format(uid)) + ksearch.append("@{0@}@@pm.me".format(uid)) + else: + ksearch.append(keyterm) for k in ksearch: - payload = @{"op": "get", "search": k@} + print("Checking for key for: @{0@}".format(k)) try: - r = requests.get(url, verify=True, params=payload) - if r.ok is True: - result = c.key_import(r.content) - elif r.ok is False: - result = r.content + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None except Exception as e: - result = None + import_result = None + results.append(import_result) +for result in results: if result is not None and hasattr(result, "considered") is False: print("@{0@} for @{1@}".format(result.decode(), k)) elif result is not None and hasattr(result, "considered") is True: @@ -999,20 +1332,9 @@ The key IDs for all considered keys were: print(result.imports[i].fpr) print("") elif result is None: - print(e) + pass @end example - -Both the above example, @uref{../examples/howto/pmkey-import.py, pmkey-import.py}, and a version which prompts -for an alternative GnuPG home directory, @uref{../examples/howto/pmkey-import-alt.py, pmkey-import-alt.py}, are -available with the other examples and are executable scripts. - -Note that while the ProtonMail servers are based on the SKS servers, -their server is related more to their API and is not feature complete -by comparison to the servers in the SKS pool. One notable difference -being that the ProtonMail server does not permit non ProtonMail users -to update their own keys, which could be a vector for attacking -ProtonMail users who may not receive a key's revocation if it had been -compromised. + at end enumerate @node Exporting keys @section Exporting keys diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index b5b9ed4..2f6ce73 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -707,7 +707,125 @@ relative ease by which such key IDs can be reproduced, as demonstrated by the Evil32 Project in 2014 (which was subsequently exploited in 2016). -Performing the same task with the [[https://github.com/Selfnet/hkp4py][hkp4py module]] (available via PyPI) + +*** Working with ProtonMail + :PROPERTIES: + :CUSTOM_ID: import-protonmail + :END: + +Here is a variation on the example above which checks the constrained +ProtonMail keyserver for ProtonMail public keys. + +#+BEGIN_SRC python -i +import gpg +import requests +import sys + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. +""") + +c = gpg.Context(armor=True) +url = "https://api.protonmail.ch/pks/lookup" +ksearch = [] + +if len(sys.argv) >= 2: + keyterm = sys.argv[1] +else: + keyterm = input("Enter the key ID, UID or search string: ") + +if keyterm.count("@") == 2 and keyterm.startswith("@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) +elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: + ksearch.append("{0}@protonmail.com".format(keyterm[1:])) + ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) + ksearch.append("{0}@pm.me".format(keyterm[1:])) +elif keyterm.count("@") == 0: + ksearch.append("{0}@protonmail.com".format(keyterm)) + ksearch.append("{0}@protonmail.ch".format(keyterm)) + ksearch.append("{0}@pm.me".format(keyterm)) +elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) +elif keyterm.count("@") > 2: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) +else: + ksearch.append(keyterm) + +for k in ksearch: + payload = {"op": "get", "search": k} + try: + r = requests.get(url, verify=True, params=payload) + if r.ok is True: + result = c.key_import(r.content) + elif r.ok is False: + result = r.content + except Exception as e: + result = None + + if result is not None and hasattr(result, "considered") is False: + print("{0} for {1}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + +With UIDs wholely or partially matching the following string: + + {1} + + Number of keys revoked: {2} + Number of new signatures: {3} + Number of new subkeys: {4} + Number of new user IDs: {5} +Number of new secret keys: {6} + Number of unchanged keys: {7} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + print(e) +#+END_SRC + +Both the above example, [[../examples/howto/pmkey-import.py][pmkey-import.py]], and a version which prompts +for an alternative GnuPG home directory, [[../examples/howto/pmkey-import-alt.py][pmkey-import-alt.py]], are +available with the other examples and are executable scripts. + +Note that while the ProtonMail servers are based on the SKS servers, +their server is related more to their API and is not feature complete +by comparison to the servers in the SKS pool. One notable difference +being that the ProtonMail server does not permit non ProtonMail users +to update their own keys, which could be a vector for attacking +ProtonMail users who may not receive a key's revocation if it had been +compromised. + + +*** Importing with HKP for Python + :PROPERTIES: + :CUSTOM_ID: import-hkp4py + :END: + +Performing the same tasks with the [[https://github.com/Selfnet/hkp4py][hkp4py module]] (available via PyPI) is not too much different, but does provide a number of options of benefit to end users. Not least of which being the ability to perform some checks on a key before importing it or not. For instance it may @@ -780,69 +898,284 @@ The key IDs for all considered keys were: #+END_SRC Since the hkp4py module handles multiple keys just as effectively as -one (=keys= is a list of responses per matching key), thie above -example is able to do a little bit more with the returned data. +one (=keys= is a list of responses per matching key), the example +above is able to do a little bit more with the returned data before +anything is actually imported. + + +*** Importing from ProtonMail with HKP for Python + :PROPERTIES: + :CUSTOM_ID: import-protonmail-hkp4py + :END: + +Though this can provide certain benefits even when working with +ProtonMail, the scope is somewhat constrained there due to the +limitations of the ProtonMail keyserver. + +For instance, searching the SKS keyserver pool for the term "gnupg" +produces hundreds of results from any time the word appears in any +part of a user ID. Performing the same search on the ProtonMail +keyserver returns zero results, even though there are at least two +test accounts which include it as part of the username. + +The cause of this discrepancy is the deliberate configuration of that +server by ProtonMail to require an exact match of the full email +address of the ProtonMail user whose key is being requested. +Presumably this is intended to reduce breaches of privacy of their +users as an email address must already be known before a key for that +address can be obtained. + + +**** Import from ProtonMail via HKP for Python Example no. 1 + :PROPERTIES: + :CUSTOM_ID: import-hkp4py-pm1 + :END: -Here is a variation on the first example above which checks the -constrained ProtonMail keyserver for ProtonMail public keys. +The following script is avalable with the rest of the examples under +the somewhat less than original name, =pmkey-import-hkp.py=. #+BEGIN_SRC python -i import gpg -import requests +import hkp4py +import os.path import sys print(""" This script searches the ProtonMail key server for the specified key and imports it. + +Usage: pmkey-import-hkp.py [search strings] """) c = gpg.Context(armor=True) -url = "https://api.protonmail.ch/pks/lookup" +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None -if len(sys.argv) >= 2: +if len(sys.argv) > 2: + keyterms = sys.argv[1:] +elif len(sys.argv) == 2: keyterm = sys.argv[1] + keyterms.append(keyterm) +else: + key_term = input("Enter the key ID, UID or search string: ") + keyterms = key_term.split() + +for keyterm in keyterms: + if keyterm.count("@") == 2 and keyterm.startswith("@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: + ksearch.append("{0}@protonmail.com".format(keyterm[1:])) + ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) + ksearch.append("{0}@pm.me".format(keyterm[1:])) + elif keyterm.count("@") == 0: + ksearch.append("{0}@protonmail.com".format(keyterm)) + ksearch.append("{0}@protonmail.ch".format(keyterm)) + ksearch.append("{0}@pm.me".format(keyterm)) + elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + elif keyterm.count("@") > 2: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + else: + ksearch.append(keyterm) + +for k in ksearch: + print("Checking for key for: {0}".format(k)) + try: + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None + except Exception as e: + import_result = None + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print("{0} for {1}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + +With UIDs wholely or partially matching the following string: + + {1} + + Number of keys revoked: {2} + Number of new signatures: {3} + Number of new subkeys: {4} + Number of new user IDs: {5} +Number of new secret keys: {6} + Number of unchanged keys: {7} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + pass +#+END_SRC + + +**** Import from ProtonMail via HKP for Python Example no. 2 + :PROPERTIES: + :CUSTOM_ID: import-hkp4py-pm2 + :END: + +Like its counterpart above, this script can also be found with the +rest of the examples, by the name pmkey-import-hkp-alt.py. + +With this script a modicum of effort has been made to treat anything +passed as a =homedir= which either does not exist or which is not a +directory, as also being a pssible user ID to check for. It's not +guaranteed to pick up on all such cases, but it should cover most of +them. + +#+BEGIN_SRC python -i +import gpg +import hkp4py +import os.path +import sys + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. Optionally enables specifying a different GnuPG home directory. + +Usage: pmkey-import-hkp.py [homedir] [search string] + or: pmkey-import-hkp.py [search string] +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] +ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None + +if len(sys.argv) > 3: + homedir = sys.argv[1] + keyterms = sys.argv[2:] +elif len(sys.argv) == 3: + homedir = sys.argv[1] + keyterm = sys.argv[2] + keyterms.append(keyterm) +elif len(sys.argv) == 2: + homedir = "" + keyterm = sys.argv[1] + keyterms.append(keyterm) else: keyterm = input("Enter the key ID, UID or search string: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + keyterms.append(keyterm) -if keyterm.count("@") == 2 and keyterm.startswith("@") is True: - ksearch.append(keyterm[1:]) - ksearch.append(keyterm[1:]) - ksearch.append(keyterm[1:]) -elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: - ksearch.append("{0}@protonmail.com".format(keyterm[1:])) - ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) - ksearch.append("{0}@pm.me".format(keyterm[1:])) -elif keyterm.count("@") == 0: - ksearch.append("{0}@protonmail.com".format(keyterm)) - ksearch.append("{0}@protonmail.ch".format(keyterm)) - ksearch.append("{0}@pm.me".format(keyterm)) -elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: - uidlist = keyterm.split("@") - for uid in uidlist: - ksearch.append("{0}@protonmail.com".format(uid)) - ksearch.append("{0}@protonmail.ch".format(uid)) - ksearch.append("{0}@pm.me".format(uid)) -elif keyterm.count("@") > 2: - uidlist = keyterm.split("@") - for uid in uidlist: - ksearch.append("{0}@protonmail.com".format(uid)) - ksearch.append("{0}@protonmail.ch".format(uid)) - ksearch.append("{0}@pm.me".format(uid)) +if len(homedir) == 0: + homedir = None + homeless = False + +if homedir is not None: + if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + if os.path.isdir(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.realpath(os.path.expanduser(homedir)) + else: + homeless = True + else: + homeless = True + elif os.path.exists(os.path.realpath(homedir)) is True: + if os.path.isdir(os.path.realpath(homedir)) is True: + c.home_dir = os.path.realpath(homedir) + else: + homeless = True + else: + homeless = True + +# First check to see if the homedir really is a homedir and if not, treat it as +# a search string. +if homeless is True: + keyterms.append(homedir) + c.home_dir = None else: - ksearch.append(keyterm) + pass + +for keyterm in keyterms: + if keyterm.count("@") == 2 and keyterm.startswith("@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: + ksearch.append("{0}@protonmail.com".format(keyterm[1:])) + ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) + ksearch.append("{0}@pm.me".format(keyterm[1:])) + elif keyterm.count("@") == 0: + ksearch.append("{0}@protonmail.com".format(keyterm)) + ksearch.append("{0}@protonmail.ch".format(keyterm)) + ksearch.append("{0}@pm.me".format(keyterm)) + elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + elif keyterm.count("@") > 2: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + else: + ksearch.append(keyterm) for k in ksearch: - payload = {"op": "get", "search": k} + print("Checking for key for: {0}".format(k)) try: - r = requests.get(url, verify=True, params=payload) - if r.ok is True: - result = c.key_import(r.content) - elif r.ok is False: - result = r.content + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None except Exception as e: - result = None + import_result = None + results.append(import_result) +for result in results: if result is not None and hasattr(result, "considered") is False: print("{0} for {1}".format(result.decode(), k)) elif result is not None and hasattr(result, "considered") is True: @@ -874,21 +1207,9 @@ The key IDs for all considered keys were: print(result.imports[i].fpr) print("") elif result is None: - print(e) + pass #+END_SRC -Both the above example, [[../examples/howto/pmkey-import.py][pmkey-import.py]], and a version which prompts -for an alternative GnuPG home directory, [[../examples/howto/pmkey-import-alt.py][pmkey-import-alt.py]], are -available with the other examples and are executable scripts. - -Note that while the ProtonMail servers are based on the SKS servers, -their server is related more to their API and is not feature complete -by comparison to the servers in the SKS pool. One notable difference -being that the ProtonMail server does not permit non ProtonMail users -to update their own keys, which could be a vector for attacking -ProtonMail users who may not receive a key's revocation if it had been -compromised. - ** Exporting keys :PROPERTIES: diff --git a/lang/python/examples/howto/pmkey-import-hkp-alt.py b/lang/python/examples/howto/pmkey-import-hkp-alt.py new file mode 100755 index 0000000..61fcd8d --- /dev/null +++ b/lang/python/examples/howto/pmkey-import-hkp-alt.py @@ -0,0 +1,174 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, unicode_literals + +import gpg +import hkp4py +import os.path +import sys + +del absolute_import, division, unicode_literals + +# Copyright (C) 2018 Ben McGinnes +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU General Public License and the GNU +# Lesser General Public along with this program; if not, see +# . + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. Optionally enables specifying a different GnuPG home directory. + +Usage: pmkey-import-hkp.py [homedir] [search string] + or: pmkey-import-hkp.py [search string] +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] +ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None + +if len(sys.argv) > 3: + homedir = sys.argv[1] + keyterms = sys.argv[2:] +elif len(sys.argv) == 3: + homedir = sys.argv[1] + keyterm = sys.argv[2] + keyterms.append(keyterm) +elif len(sys.argv) == 2: + homedir = "" + keyterm = sys.argv[1] + keyterms.append(keyterm) +else: + keyterm = input("Enter the key ID, UID or search string: ") + homedir = input("Enter the GPG configuration directory path (optional): ") + keyterms.append(keyterm) + +if len(homedir) == 0: + homedir = None + homeless = False + +if homedir is not None: + if homedir.startswith("~"): + if os.path.exists(os.path.expanduser(homedir)) is True: + if os.path.isdir(os.path.expanduser(homedir)) is True: + c.home_dir = os.path.realpath(os.path.expanduser(homedir)) + else: + homeless = True + else: + homeless = True + elif os.path.exists(os.path.realpath(homedir)) is True: + if os.path.isdir(os.path.realpath(homedir)) is True: + c.home_dir = os.path.realpath(homedir) + else: + homeless = True + else: + homeless = True + +# First check to see if the homedir really is a homedir and if not, treat it as +# a search string. +if homeless is True: + keyterms.append(homedir) + c.home_dir = None +else: + pass + +for keyterm in keyterms: + if keyterm.count("@") == 2 and keyterm.startswith("@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: + ksearch.append("{0}@protonmail.com".format(keyterm[1:])) + ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) + ksearch.append("{0}@pm.me".format(keyterm[1:])) + elif keyterm.count("@") == 0: + ksearch.append("{0}@protonmail.com".format(keyterm)) + ksearch.append("{0}@protonmail.ch".format(keyterm)) + ksearch.append("{0}@pm.me".format(keyterm)) + elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + elif keyterm.count("@") > 2: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + else: + ksearch.append(keyterm) + +for k in ksearch: + print("Checking for key for: {0}".format(k)) + try: + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None + except Exception as e: + import_result = None + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print("{0} for {1}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + +With UIDs wholely or partially matching the following string: + + {1} + + Number of keys revoked: {2} + Number of new signatures: {3} + Number of new subkeys: {4} + Number of new user IDs: {5} +Number of new secret keys: {6} + Number of unchanged keys: {7} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + pass diff --git a/lang/python/examples/howto/pmkey-import-hkp.py b/lang/python/examples/howto/pmkey-import-hkp.py new file mode 100755 index 0000000..66223a9 --- /dev/null +++ b/lang/python/examples/howto/pmkey-import-hkp.py @@ -0,0 +1,137 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, unicode_literals + +import gpg +import hkp4py +import os.path +import sys + +del absolute_import, division, unicode_literals + +# Copyright (C) 2018 Ben McGinnes +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU General Public License and the GNU +# Lesser General Public along with this program; if not, see +# . + +print(""" +This script searches the ProtonMail key server for the specified key and +imports it. + +Usage: pmkey-import-hkp.py [search strings] +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://api.protonmail.ch") +keyterms = [] +ksearch = [] +allkeys = [] +results = [] +paradox = [] +homeless = None + +if len(sys.argv) > 2: + keyterms = sys.argv[1:] +elif len(sys.argv) == 2: + keyterm = sys.argv[1] + keyterms.append(keyterm) +else: + key_term = input("Enter the key ID, UID or search string: ") + keyterms = key_term.split() + +for keyterm in keyterms: + if keyterm.count("@") == 2 and keyterm.startswith("@") is True: + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + ksearch.append(keyterm[1:]) + elif keyterm.count("@") == 1 and keyterm.startswith("@") is True: + ksearch.append("{0}@protonmail.com".format(keyterm[1:])) + ksearch.append("{0}@protonmail.ch".format(keyterm[1:])) + ksearch.append("{0}@pm.me".format(keyterm[1:])) + elif keyterm.count("@") == 0: + ksearch.append("{0}@protonmail.com".format(keyterm)) + ksearch.append("{0}@protonmail.ch".format(keyterm)) + ksearch.append("{0}@pm.me".format(keyterm)) + elif keyterm.count("@") == 2 and keyterm.startswith("@") is False: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + elif keyterm.count("@") > 2: + uidlist = keyterm.split("@") + for uid in uidlist: + ksearch.append("{0}@protonmail.com".format(uid)) + ksearch.append("{0}@protonmail.ch".format(uid)) + ksearch.append("{0}@pm.me".format(uid)) + else: + ksearch.append(keyterm) + +for k in ksearch: + print("Checking for key for: {0}".format(k)) + try: + keys = server.search(k) + if isinstance(keys, list) is True: + for key in keys: + allkeys.append(key) + try: + import_result = c.key_import(key.key_blob) + except Exception as e: + import_result = c.key_import(key.key) + else: + paradox.append(keys) + import_result = None + except Exception as e: + import_result = None + results.append(import_result) + +for result in results: + if result is not None and hasattr(result, "considered") is False: + print("{0} for {1}".format(result.decode(), k)) + elif result is not None and hasattr(result, "considered") is True: + num_keys = len(result.imports) + new_revs = result.new_revocations + new_sigs = result.new_signatures + new_subs = result.new_sub_keys + new_uids = result.new_user_ids + new_scrt = result.secret_imported + nochange = result.unchanged + print(""" +The total number of keys considered for import was: {0} + +With UIDs wholely or partially matching the following string: + + {1} + + Number of keys revoked: {2} + Number of new signatures: {3} + Number of new subkeys: {4} + Number of new user IDs: {5} +Number of new secret keys: {6} + Number of unchanged keys: {7} + +The key IDs for all considered keys were: +""".format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt, + nochange)) + for i in range(num_keys): + print(result.imports[i].fpr) + print("") + elif result is None: + pass ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 428 ++++++++++++++++++--- lang/python/docs/gpgme-python-howto.org | 427 +++++++++++++++++--- lang/python/examples/howto/pmkey-import-hkp-alt.py | 174 +++++++++ .../{pmkey-import-alt.py => pmkey-import-hkp.py} | 111 +++--- 4 files changed, 980 insertions(+), 160 deletions(-) create mode 100755 lang/python/examples/howto/pmkey-import-hkp-alt.py copy lang/python/examples/howto/{pmkey-import-alt.py => pmkey-import-hkp.py} (54%) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 23 20:28:25 2018 From: cvs at cvs.gnupg.org (by Daniel Kahn Gillmor) Date: Sun, 23 Sep 2018 20:28:25 +0200 Subject: [git] GnuPG - branch, dkg/passphrase-env, created. gnupg-2.2.7-216-g07c1998 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The GNU Privacy Guard". The branch, dkg/passphrase-env has been created at 07c19981da0607dc442fadc4079b1d71fbef8f83 (commit) - Log ----------------------------------------------------------------- commit 07c19981da0607dc442fadc4079b1d71fbef8f83 Author: Daniel Kahn Gillmor Date: Sun Sep 23 14:10:17 2018 -0400 gpg: add --passphrase-env VARNAME to read passphrase from environment * g10/keydb.h: declare set_passphrase_from_environment_variable() * g10/passphrase.c: set_passphrase_from_environment_variable() new function * g10/gpg.c: add new --passphrase-env argument, handle it. -- There are problems or difficulties (to varying degrees) with all of the techniques available for sending a passphrase directly to the GnuPG process when --pinentry-mode=loopback: * Passphrases on the command line often leak into the process table. * Passphrases in a file often leak into the disk. * Using an extra file descriptor to send a passphrase works well on platforms that make it easy to allocate and use extra file descriptors, but is pretty awkward on platforms that don't facilitate this. So this patch adds a new form of passphrase-passing, using an environment variable. In POSIX shell, this looks like (for example): mypass="IUuKctdEhH8' gpg --batch --pinentry-mode=loopback\ --passphrase-env=mypass --decrypt < message.txt Hopefully, this is easier to use than --passphrase-fd on platforms or language toolkits that don't facilitate file descriptor manipulation. Signed-off-by: Daniel Kahn Gillmor diff --git a/doc/gpg.texi b/doc/gpg.texi index 7f55cc7..55e31d2 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -670,7 +670,8 @@ used for no expiration date. If this command is used with @option{--batch}, @option{--pinentry-mode} has been set to @code{loopback}, and one of the passphrase options (@option{--passphrase}, - at option{--passphrase-fd}, or @option{passphrase-file}) is used, the + at option{--passphrase-fd}, @option{--passphrase-env}, or + at option{passphrase-file}) is used, the supplied passphrase is used for the new key and the agent does not ask for it. To create a key without any protection @code{--passphrase ''} may be used. @@ -3172,6 +3173,14 @@ Note that since Version 2.0 this passphrase is only used if the option @option{--batch} has also been given. Since Version 2.1 the @option{--pinentry-mode} also needs to be set to @code{loopback}. + at item --passphrase-env @var{string} + at opindex passphrase-env +Use the value of the environment variable @var{string} as the passphrase. +This can only be used if only one passphrase is supplied. + +This passphrase is only used if the option @option{--batch} has also +been given, and if @option{--pinentry-mode} is set to @code{loopback}. + @item --pinentry-mode @var{mode} @opindex pinentry-mode Set the pinentry mode to @var{mode}. Allowed values for @var{mode} diff --git a/g10/gpg.c b/g10/gpg.c index f04a340..36adbaa 100644 --- a/g10/gpg.c +++ b/g10/gpg.c @@ -257,6 +257,7 @@ enum cmd_and_opt_values oBZ2CompressLevel, oBZ2DecompressLowmem, oPassphrase, + oPassphraseEnv, oPassphraseFD, oPassphraseFile, oPassphraseRepeat, @@ -709,6 +710,7 @@ static ARGPARSE_OPTS opts[] = { ARGPARSE_c (aRebuildKeydbCaches, "rebuild-keydb-caches", "@"), ARGPARSE_s_s (oPassphrase, "passphrase", "@"), + ARGPARSE_s_s (oPassphraseEnv, "passphrase-env", "@"), ARGPARSE_s_i (oPassphraseFD, "passphrase-fd", "@"), ARGPARSE_s_s (oPassphraseFile, "passphrase-file", "@"), ARGPARSE_s_i (oPassphraseRepeat,"passphrase-repeat", "@"), @@ -3151,6 +3153,9 @@ main (int argc, char **argv) case oPassphrase: set_passphrase_from_string(pargs.r.ret_str); break; + case oPassphraseEnv: + set_passphrase_from_environment_variable(pargs.r.ret_str); + break; case oPassphraseFD: pwfd = translate_sys2libc_fd_int (pargs.r.ret_int, 0); break; diff --git a/g10/keydb.h b/g10/keydb.h index 1def2bb..db88df9 100644 --- a/g10/keydb.h +++ b/g10/keydb.h @@ -279,6 +279,7 @@ gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr, unsigned char encode_s2k_iterations (int iterations); int have_static_passphrase(void); const char *get_static_passphrase (void); +void set_passphrase_from_environment_variable(const char *envvar); void set_passphrase_from_string(const char *pass); void read_passphrase_from_fd( int fd ); void passphrase_clear_cache (const char *cacheid); diff --git a/g10/passphrase.c b/g10/passphrase.c index 10574ec..17e2596 100644 --- a/g10/passphrase.c +++ b/g10/passphrase.c @@ -159,6 +159,19 @@ set_passphrase_from_string(const char *pass) strcpy (fd_passwd, pass); } +void +set_passphrase_from_environment_variable(const char *envvar) +{ + const char *val = getenv(envvar); + if (val == NULL) + val = ""; + xfree (fd_passwd); + fd_passwd = xmalloc_secure(strlen(val)+1); + strcpy (fd_passwd, val); + /* clean up sensitive environment variable to avoid accidental + propagation: */ + unsetenv(envvar); +} void read_passphrase_from_fd( int fd ) ----------------------------------------------------------------------- hooks/post-receive -- The GNU Privacy Guard http://git.gnupg.org From cvs at cvs.gnupg.org Mon Sep 24 10:01:48 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Mon, 24 Sep 2018 10:01:48 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-33-g635ff92 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via 635ff920f8c22087d27b62f8a597fe36e9925ff8 (commit) via 9e42f7008b4d089546070cc4de4a461fb96e8e97 (commit) from 4bc8476bd340a1c43052b4a3285a1dde582c0296 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 635ff920f8c22087d27b62f8a597fe36e9925ff8 Author: Andre Heinecke Date: Mon Sep 24 09:38:29 2018 +0200 Start simplification of log categories * src/debug.cpp, src/debug.h: New. Place for log functionality. * src/common.cpp, src/common_indep.c, src/common_indep.h: Move out debugging functions. * src/keycache.cpp, src/mail.cpp, src/main.c, src/mimedataprovider.cpp, src/oomhelp.cpp, src/parsecontroller.cpp: Rename log_mime_parser to log data. diff --git a/src/Makefile.am b/src/Makefile.am index 9abce23..47643fa 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -35,6 +35,7 @@ gpgol_SOURCES = \ common_indep.h common_indep.c \ cpphelp.cpp cpphelp.h \ cryptcontroller.cpp cryptcontroller.h \ + debug.h debug.cpp \ dialogs.h \ dispcache.h dispcache.cpp \ eventsink.h \ diff --git a/src/common.cpp b/src/common.cpp index f3f41af..9fcecbe 100644 --- a/src/common.cpp +++ b/src/common.cpp @@ -459,7 +459,7 @@ get_tmp_outfile (wchar_t *name, HANDLE *outHandle) auto outName = tmpPath + utf8Name; - log_mime_parser("%s:%s: Attachment candidate is %s", + log_data("%s:%s: Attachment candidate is %s", SRCNAME, __func__, outName.c_str ()); int tries = 1; diff --git a/src/common_indep.c b/src/common_indep.c index c0fe91f..aebd10c 100644 --- a/src/common_indep.c +++ b/src/common_indep.c @@ -478,286 +478,3 @@ generate_boundary (char *buffer) return buffer; } - -/* The malloced name of the logfile and the logging stream. If - LOGFILE is NULL, no logging is done. */ -static char *logfile; -static FILE *logfp; - -#ifdef HAVE_W32_SYSTEM - -/* Acquire the mutex for logging. Returns 0 on success. */ -static int -lock_log (void) -{ - int code = WaitForSingleObject (log_mutex, INFINITE); - return code != WAIT_OBJECT_0; -} - -/* Release the mutex for logging. No error return is done because this - is a fatal error anyway and we have no means for proper - notification. */ -static void -unlock_log (void) -{ - ReleaseMutex (log_mutex); -} -#endif - -const char * -get_log_file (void) -{ - return logfile? logfile : ""; -} - -void -set_log_file (const char *name) -{ -#ifdef HAVE_W32_SYSTEM - if (!lock_log ()) - { -#endif - if (logfp) - { - fclose (logfp); - logfp = NULL; - } - xfree (logfile); - if (!name || *name == '\"' || !*name) - logfile = NULL; - else - logfile = xstrdup (name); -#ifdef HAVE_W32_SYSTEM - unlock_log (); - } -#endif -} - -static void -do_log (const char *fmt, va_list a, int w32err, int err, - const void *buf, size_t buflen) -{ - if (!logfile) - return; - -#ifdef HAVE_W32_SYSTEM - if (!opt.enable_debug) - return; - - if (lock_log ()) - return; -#endif - - if (!strcmp (logfile, "stdout")) - { - logfp = stdout; - } - else if (!strcmp (logfile, "stderr")) - { - logfp = stderr; - } - if (!logfp) - logfp = fopen (logfile, "a+"); -#ifdef HAVE_W32_SYSTEM - if (!logfp) - { - unlock_log (); - return; - } - - char time_str[9]; - SYSTEMTIME utc_time; - GetSystemTime (&utc_time); - if (GetTimeFormatA (LOCALE_INVARIANT, - TIME_FORCE24HOURFORMAT | LOCALE_USE_CP_ACP, - &utc_time, - "HH:mm:ss", - time_str, - 9)) - { - fprintf (logfp, "%s/%lu/", - time_str, - (unsigned long)GetCurrentThreadId ()); - } - else - { - fprintf (logfp, "unknown/%lu/", - (unsigned long)GetCurrentThreadId ()); - } -#endif - - if (err == 1) - fputs ("ERROR/", logfp); - vfprintf (logfp, fmt, a); -#ifdef HAVE_W32_SYSTEM - if (w32err) - { - char tmpbuf[256]; - - FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL, w32err, - MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT), - tmpbuf, sizeof (tmpbuf)-1, NULL); - fputs (": ", logfp); - if (*tmpbuf && tmpbuf[strlen (tmpbuf)-1] == '\n') - tmpbuf[strlen (tmpbuf)-1] = 0; - if (*tmpbuf && tmpbuf[strlen (tmpbuf)-1] == '\r') - tmpbuf[strlen (tmpbuf)-1] = 0; - fprintf (logfp, "%s (%d)", tmpbuf, w32err); - } -#endif - if (buf) - { - const unsigned char *p = (const unsigned char*)buf; - - for ( ; buflen; buflen--, p++) - fprintf (logfp, "%02X", *p); - putc ('\n', logfp); - } - else if ( *fmt && fmt[strlen (fmt) - 1] != '\n') - putc ('\n', logfp); - - fflush (logfp); -#ifdef HAVE_W32_SYSTEM - unlock_log (); -#endif -} - -const char * -log_srcname (const char *file) -{ - const char *s = strrchr (file, '/'); - return s? s+1:file; -} - -void -log_debug (const char *fmt, ...) -{ - va_list a; - - va_start (a, fmt); - do_log (fmt, a, 0, 0, NULL, 0); - va_end (a); -} - -void -log_error (const char *fmt, ...) -{ - va_list a; - - va_start (a, fmt); - do_log (fmt, a, 0, 1, NULL, 0); - va_end (a); -} - -void -log_vdebug (const char *fmt, va_list a) -{ - do_log (fmt, a, 0, 0, NULL, 0); -} - -void -log_hexdump (const void *buf, size_t buflen, const char *fmt, ...) -{ - va_list a; - - va_start (a, fmt); - do_log (fmt, a, 0, 2, buf, buflen); - va_end (a); -} - -#ifdef HAVE_W32_SYSTEM -void -log_debug_w32 (int w32err, const char *fmt, ...) -{ - va_list a; - - if (w32err == -1) - w32err = GetLastError (); - - va_start (a, fmt); - do_log (fmt, a, w32err, 0, NULL, 0); - va_end (a); -} - -void -log_error_w32 (int w32err, const char *fmt, ...) -{ - va_list a; - - if (w32err == -1) - w32err = GetLastError (); - - va_start (a, fmt); - do_log (fmt, a, w32err, 1, NULL, 0); - va_end (a); -} - -static void -do_log_window_info (HWND window, int level) -{ - char buf[1024+1]; - char name[200]; - int nname; - char *pname; - DWORD pid; - - if (!window) - return; - - GetWindowThreadProcessId (window, &pid); - if (pid != GetCurrentProcessId ()) - return; - - memset (buf, 0, sizeof (buf)); - GetWindowText (window, buf, sizeof (buf)-1); - nname = GetClassName (window, name, sizeof (name)-1); - if (nname) - pname = name; - else - pname = NULL; - - if (level == -1) - log_debug (" parent=%p/%lu (%s) `%s'", window, (unsigned long)pid, - pname? pname:"", buf); - else - log_debug (" %*shwnd=%p/%lu (%s) `%s'", level*2, "", window, - (unsigned long)pid, pname? pname:"", buf); -} - - -/* Helper to log_window_hierarchy. */ -static HWND -do_log_window_hierarchy (HWND parent, int level) -{ - HWND child; - - child = GetWindow (parent, GW_CHILD); - while (child) - { - do_log_window_info (child, level); - do_log_window_hierarchy (child, level+1); - child = GetNextWindow (child, GW_HWNDNEXT); - } - - return NULL; -} - - -/* Print a debug message using the format string FMT followed by the - window hierarchy of WINDOW. */ -void -log_window_hierarchy (HWND window, const char *fmt, ...) -{ - va_list a; - - va_start (a, fmt); - do_log (fmt, a, 0, 0, NULL, 0); - va_end (a); - if (window) - { - do_log_window_info (window, -1); - do_log_window_hierarchy (window, 0); - } -} - -#endif diff --git a/src/common_indep.h b/src/common_indep.h index c78256f..8df77aa 100644 --- a/src/common_indep.h +++ b/src/common_indep.h @@ -30,6 +30,8 @@ #include "xmalloc.h" +#include "debug.h" + #include "memdbg.h" #ifdef HAVE_W32_SYSTEM @@ -217,27 +219,6 @@ struct b64_state_s }; typedef struct b64_state_s b64_state_t; -/* Bit values used for extra log file verbosity. Value 1 is reserved - to enable debug menu options. - - Note that the high values here are used for compatibility with - old howtos of how to enable debug flags. Based on the old - very split up logging categories. - - Categories are meant to be: - - DBG -> Generally useful information. - DBG_MEMORY -> Very verbose tracing of Releases / Allocs / Refs. - DBG_OOM -> Outlook Object Model events tracing. - DBG_DATA -> Including potentially private data and mime parser logging. - - */ -#define DBG_MEMORY (1<<5) -#define DBG_MIME_PARSER (1<<7) -#define DBG_MIME_DATA (1<<8) -#define DBG_OOM (1<<9) -#define DBG_OOM_EXTRA (1<<10) - size_t qp_decode (char *buffer, size_t length, int *r_slbrk); char *qp_encode (const char *input, size_t length, size_t* outlen); void b64_init (b64_state_t *state); @@ -264,46 +245,6 @@ char *trim_trailing_spaces (char *string); while(*_vptr) { *_vptr=0; _vptr++; } \ } while(0) -#define debug_oom ((opt.enable_debug & DBG_OOM) || \ - (opt.enable_debug & DBG_OOM_EXTRA)) -#define debug_oom_extra (opt.enable_debug & DBG_OOM_EXTRA) -void log_debug (const char *fmt, ...) __attribute__ ((format (printf,1,2))); -void log_error (const char *fmt, ...) __attribute__ ((format (printf,1,2))); -void log_vdebug (const char *fmt, va_list a); -void log_debug_w32 (int w32err, const char *fmt, - ...) __attribute__ ((format (printf,2,3))); -void log_error_w32 (int w32err, const char *fmt, - ...) __attribute__ ((format (printf,2,3))); -void log_hexdump (const void *buf, size_t buflen, const char *fmt, - ...) __attribute__ ((format (printf,3,4))); - -#define log_oom if (opt.enable_debug & DBG_OOM) log_debug -#define log_oom_extra if (opt.enable_debug & DBG_OOM_EXTRA) log_debug -#define log_mime_parser if (opt.enable_debug & DBG_MIME_PARSER) log_debug -#define log_mime_data if (opt.enable_debug & DBG_MIME_DATA) log_debug - -#define gpgol_release(X) \ -{ \ - if (X && opt.enable_debug & DBG_OOM_EXTRA) \ - { \ - log_debug ("%s:%s:%i: Object: %p released ref: %lu \n", \ - SRCNAME, __func__, __LINE__, X, X->Release()); \ - memdbg_released (X); \ - } \ - else if (X) \ - { \ - X->Release(); \ - } \ -} - -const char *log_srcname (const char *s); -#define SRCNAME log_srcname (__FILE__) - -#define TRACEPOINT log_debug ("%s:%s:%d: tracepoint\n", \ - SRCNAME, __func__, __LINE__); - -const char *get_log_file (void); -void set_log_file (const char *name); void set_default_key (const char *name); /*-- Convenience macros. -- */ @@ -369,16 +310,6 @@ _gpgol_stpcpy (char *a, const char *b) #define stpcpy(a,b) _gpgol_stpcpy ((a), (b)) #endif /*!HAVE_STPCPY*/ -#ifdef _WIN64 -#define SIZE_T_FORMAT "%I64u" -#else -# ifdef HAVE_W32_SYSTEM -# define SIZE_T_FORMAT "%u" -# else -# define SIZE_T_FORMAT "%lu" -# endif -#endif - /* The length of the boundary - the buffer needs to be allocated one byte larger. */ #define BOUNDARYSIZE 20 diff --git a/src/debug.cpp b/src/debug.cpp new file mode 100644 index 0000000..7f15550 --- /dev/null +++ b/src/debug.cpp @@ -0,0 +1,303 @@ +/* debug.cpp - Debugging / Log helpers for GpgOL + * Copyright (C) 2018 by by Intevation GmbH + * + * This file is part of GpgOL. + * + * GpgOL is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either version 2.1 + * of the License, or (at your option) any later version. + * + * GpgOL is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, see . + */ + +#include "common_indep.h" + + +/* The malloced name of the logfile and the logging stream. If + LOGFILE is NULL, no logging is done. */ +static char *logfile; +static FILE *logfp; + +#ifdef HAVE_W32_SYSTEM + +/* Acquire the mutex for logging. Returns 0 on success. */ +static int +lock_log (void) +{ + int code = WaitForSingleObject (log_mutex, INFINITE); + return code != WAIT_OBJECT_0; +} + +/* Release the mutex for logging. No error return is done because this + is a fatal error anyway and we have no means for proper + notification. */ +static void +unlock_log (void) +{ + ReleaseMutex (log_mutex); +} +#endif + +const char * +get_log_file (void) +{ + return logfile? logfile : ""; +} + +void +set_log_file (const char *name) +{ +#ifdef HAVE_W32_SYSTEM + if (!lock_log ()) + { +#endif + if (logfp) + { + fclose (logfp); + logfp = NULL; + } + xfree (logfile); + if (!name || *name == '\"' || !*name) + logfile = NULL; + else + logfile = xstrdup (name); +#ifdef HAVE_W32_SYSTEM + unlock_log (); + } +#endif +} + +static void +do_log (const char *fmt, va_list a, int w32err, int err, + const void *buf, size_t buflen) +{ + if (!logfile) + return; + +#ifdef HAVE_W32_SYSTEM + if (!opt.enable_debug) + return; + + if (lock_log ()) + return; +#endif + + if (!strcmp (logfile, "stdout")) + { + logfp = stdout; + } + else if (!strcmp (logfile, "stderr")) + { + logfp = stderr; + } + if (!logfp) + logfp = fopen (logfile, "a+"); +#ifdef HAVE_W32_SYSTEM + if (!logfp) + { + unlock_log (); + return; + } + + char time_str[9]; + SYSTEMTIME utc_time; + GetSystemTime (&utc_time); + if (GetTimeFormatA (LOCALE_INVARIANT, + TIME_FORCE24HOURFORMAT | LOCALE_USE_CP_ACP, + &utc_time, + "HH:mm:ss", + time_str, + 9)) + { + fprintf (logfp, "%s/%lu/", + time_str, + (unsigned long)GetCurrentThreadId ()); + } + else + { + fprintf (logfp, "unknown/%lu/", + (unsigned long)GetCurrentThreadId ()); + } +#endif + + if (err == 1) + fputs ("ERROR/", logfp); + vfprintf (logfp, fmt, a); +#ifdef HAVE_W32_SYSTEM + if (w32err) + { + char tmpbuf[256]; + + FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL, w32err, + MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT), + tmpbuf, sizeof (tmpbuf)-1, NULL); + fputs (": ", logfp); + if (*tmpbuf && tmpbuf[strlen (tmpbuf)-1] == '\n') + tmpbuf[strlen (tmpbuf)-1] = 0; + if (*tmpbuf && tmpbuf[strlen (tmpbuf)-1] == '\r') + tmpbuf[strlen (tmpbuf)-1] = 0; + fprintf (logfp, "%s (%d)", tmpbuf, w32err); + } +#endif + if (buf) + { + const unsigned char *p = (const unsigned char*)buf; + + for ( ; buflen; buflen--, p++) + fprintf (logfp, "%02X", *p); + putc ('\n', logfp); + } + else if ( *fmt && fmt[strlen (fmt) - 1] != '\n') + putc ('\n', logfp); + + fflush (logfp); +#ifdef HAVE_W32_SYSTEM + unlock_log (); +#endif +} + +const char * +log_srcname (const char *file) +{ + const char *s = strrchr (file, '/'); + return s? s+1:file; +} + +void +log_debug (const char *fmt, ...) +{ + va_list a; + + va_start (a, fmt); + do_log (fmt, a, 0, 0, NULL, 0); + va_end (a); +} + +void +log_error (const char *fmt, ...) +{ + va_list a; + + va_start (a, fmt); + do_log (fmt, a, 0, 1, NULL, 0); + va_end (a); +} + +void +log_vdebug (const char *fmt, va_list a) +{ + do_log (fmt, a, 0, 0, NULL, 0); +} + +void +log_hexdump (const void *buf, size_t buflen, const char *fmt, ...) +{ + va_list a; + + va_start (a, fmt); + do_log (fmt, a, 0, 2, buf, buflen); + va_end (a); +} + +#ifdef HAVE_W32_SYSTEM +void +log_debug_w32 (int w32err, const char *fmt, ...) +{ + va_list a; + + if (w32err == -1) + w32err = GetLastError (); + + va_start (a, fmt); + do_log (fmt, a, w32err, 0, NULL, 0); + va_end (a); +} + +void +log_error_w32 (int w32err, const char *fmt, ...) +{ + va_list a; + + if (w32err == -1) + w32err = GetLastError (); + + va_start (a, fmt); + do_log (fmt, a, w32err, 1, NULL, 0); + va_end (a); +} + +static void +do_log_window_info (HWND window, int level) +{ + char buf[1024+1]; + char name[200]; + int nname; + char *pname; + DWORD pid; + + if (!window) + return; + + GetWindowThreadProcessId (window, &pid); + if (pid != GetCurrentProcessId ()) + return; + + memset (buf, 0, sizeof (buf)); + GetWindowText (window, buf, sizeof (buf)-1); + nname = GetClassName (window, name, sizeof (name)-1); + if (nname) + pname = name; + else + pname = NULL; + + if (level == -1) + log_debug (" parent=%p/%lu (%s) `%s'", window, (unsigned long)pid, + pname? pname:"", buf); + else + log_debug (" %*shwnd=%p/%lu (%s) `%s'", level*2, "", window, + (unsigned long)pid, pname? pname:"", buf); +} + + +/* Helper to log_window_hierarchy. */ +static HWND +do_log_window_hierarchy (HWND parent, int level) +{ + HWND child; + + child = GetWindow (parent, GW_CHILD); + while (child) + { + do_log_window_info (child, level); + do_log_window_hierarchy (child, level+1); + child = GetNextWindow (child, GW_HWNDNEXT); + } + + return NULL; +} + + +/* Print a debug message using the format string FMT followed by the + window hierarchy of WINDOW. */ +void +log_window_hierarchy (HWND window, const char *fmt, ...) +{ + va_list a; + + va_start (a, fmt); + do_log (fmt, a, 0, 0, NULL, 0); + va_end (a); + if (window) + { + do_log_window_info (window, -1); + do_log_window_hierarchy (window, 0); + } +} +#endif diff --git a/src/debug.h b/src/debug.h new file mode 100644 index 0000000..36fafdc --- /dev/null +++ b/src/debug.h @@ -0,0 +1,116 @@ +#ifndef DEBUG_H +#define DEBUG_H +/* debug.h - Debugging / Log helpers for GpgOL + * Copyright (C) 2018 by by Intevation GmbH + * + * This file is part of GpgOL. + * + * GpgOL is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either version 2.1 + * of the License, or (at your option) any later version. + * + * GpgOL is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, see . + */ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#ifdef __cplusplus +extern "C" { +#if 0 +} +#endif +#endif + +/* Bit values used for extra log file verbosity. Value 1 is reserved + to enable debug menu options. + + Note that the high values here are used for compatibility with + old howtos of how to enable debug flags. Based on the old + very split up logging categories. + + Categories are meant to be: + + DBG -> Generally useful information. + DBG_MEMORY -> Very verbose tracing of Releases / Allocs / Refs. + DBG_OOM -> Outlook Object Model events tracing. + DBG_DATA -> Including potentially private data and mime parser logging. + + Common values are: + 32 -> Only memory debugging. + 544 -> OOM and Memory. + 800 -> Full debugging. + */ +#define DBG_MEMORY (1<<5) // 32 +#define DBG_MIME_PARSER (1<<7) // 128 Unified as DBG_DATA +#define DBG_MIME_DATA (1<<8) // 256 Unified as DBG_DATA +#define DBG_DATA (DBG_MIME_PARSER | DBG_MIME_DATA) +#define DBG_OOM_VAL (1<<9) // 512 Unified as DBG_OOM +#define DBG_OOM_EXTRA (1<<10)// 1024 Unified as DBG_OOM +#define DBG_OOM (DBG_OOM_VAL | DBG_OOM_EXTRA) + +#define debug_oom ((opt.enable_debug & DBG_OOM) || \ + (opt.enable_debug & DBG_OOM_EXTRA)) +#define debug_oom_extra (opt.enable_debug & DBG_OOM_EXTRA) +void log_debug (const char *fmt, ...) __attribute__ ((format (printf,1,2))); +void log_error (const char *fmt, ...) __attribute__ ((format (printf,1,2))); +void log_vdebug (const char *fmt, va_list a); +void log_debug_w32 (int w32err, const char *fmt, + ...) __attribute__ ((format (printf,2,3))); +void log_error_w32 (int w32err, const char *fmt, + ...) __attribute__ ((format (printf,2,3))); +void log_hexdump (const void *buf, size_t buflen, const char *fmt, + ...) __attribute__ ((format (printf,3,4))); + +#define log_oom if (opt.enable_debug & DBG_OOM) log_debug +#define log_oom_extra if (opt.enable_debug & DBG_OOM) log_debug +#define log_mime_parser if (opt.enable_debug & DBG_DATA) log_debug +#define log_data if (opt.enable_debug & DBG_DATA) log_debug +#define log_mime_data if (opt.enable_debug & DBG_DATA) log_debug + +#define gpgol_release(X) \ +{ \ + if (X && opt.enable_debug & DBG_OOM_EXTRA) \ + { \ + log_debug ("%s:%s:%i: Object: %p released ref: %lu \n", \ + SRCNAME, __func__, __LINE__, X, X->Release()); \ + memdbg_released (X); \ + } \ + else if (X) \ + { \ + X->Release(); \ + } \ +} + +const char *log_srcname (const char *s); +#define SRCNAME log_srcname (__FILE__) + +#define TRACEPOINT log_debug ("%s:%s:%d: tracepoint\n", \ + SRCNAME, __func__, __LINE__); + +const char *get_log_file (void); +void set_log_file (const char *name); + +#ifdef _WIN64 +#define SIZE_T_FORMAT "%I64u" +#else +# ifdef HAVE_W32_SYSTEM +# define SIZE_T_FORMAT "%u" +# else +# define SIZE_T_FORMAT "%lu" +# endif +#endif + +#ifdef __cplusplus +} +#endif + +#endif // DEBUG_H diff --git a/src/keycache.cpp b/src/keycache.cpp index 14afd01..75e317c 100644 --- a/src/keycache.cpp +++ b/src/keycache.cpp @@ -99,7 +99,7 @@ do_update (LPVOID arg) { auto args = std::unique_ptr ((update_arg_t*) arg); - log_mime_parser ("%s:%s updating: \"%s\" with protocol %s", + log_data ("%s:%s updating: \"%s\" with protocol %s", SRCNAME, __func__, args->first.c_str (), to_cstr (args->second)); @@ -146,7 +146,7 @@ do_import (LPVOID arg) const std::string mbox = args->first->m_mbox; - log_mime_parser ("%s:%s importing for: \"%s\" with data \n%s", + log_data ("%s:%s importing for: \"%s\" with data \n%s", SRCNAME, __func__, mbox.c_str (), args->second.c_str ()); auto ctx = std::unique_ptr (GpgME::Context::createForProtocol @@ -397,25 +397,25 @@ public: const auto key = getSKey (addr, proto); if (key.isNull()) { - log_mime_parser ("%s:%s: secret key for %s is null", + log_data ("%s:%s: secret key for %s is null", SRCNAME, __func__, addr); return key; } if (!key.canReallySign()) { - log_mime_parser ("%s:%s: Discarding key for %s because it can't sign", + log_data ("%s:%s: Discarding key for %s because it can't sign", SRCNAME, __func__, addr); return GpgME::Key(); } if (!key.hasSecret()) { - log_mime_parser ("%s:%s: Discarding key for %s because it has no secret", + log_data ("%s:%s: Discarding key for %s because it has no secret", SRCNAME, __func__, addr); return GpgME::Key(); } if (in_de_vs_mode () && !key.isDeVs()) { - log_mime_parser ("%s:%s: signing key for %s is not deVS", + log_data ("%s:%s: signing key for %s is not deVS", SRCNAME, __func__, addr); return GpgME::Key(); } @@ -441,7 +441,7 @@ public: if (!overrides.empty()) { ret.insert (ret.end (), overrides.begin (), overrides.end ()); - log_mime_parser ("%s:%s: Using overides for %s", + log_data ("%s:%s: Using overides for %s", SRCNAME, __func__, recip.c_str ()); continue; } @@ -449,7 +449,7 @@ public: const auto key = getKey (recip.c_str (), proto); if (key.isNull()) { - log_mime_parser ("%s:%s: No key for %s. no internal encryption", + log_data ("%s:%s: No key for %s. no internal encryption", SRCNAME, __func__, recip.c_str ()); return std::vector(); } @@ -457,14 +457,14 @@ public: if (!key.canEncrypt() || key.isRevoked() || key.isExpired() || key.isDisabled() || key.isInvalid()) { - log_mime_parser ("%s:%s: Invalid key for %s. no internal encryption", + log_data ("%s:%s: Invalid key for %s. no internal encryption", SRCNAME, __func__, recip.c_str ()); return std::vector(); } if (in_de_vs_mode () && !key.isDeVs ()) { - log_mime_parser ("%s:%s: key for %s is not deVS", + log_data ("%s:%s: key for %s is not deVS", SRCNAME, __func__, recip.c_str ()); return std::vector(); } @@ -488,7 +488,7 @@ public: } if (!validEnough) { - log_mime_parser ("%s:%s: UID for %s does not have at least marginal trust", + log_data ("%s:%s: UID for %s does not have at least marginal trust", SRCNAME, __func__, recip.c_str ()); return std::vector(); } @@ -525,7 +525,7 @@ public: auto it = m_fpr_map.find (primaryFpr); - log_mime_parser ("%s:%s \"%s\" updated.", + log_data ("%s:%s \"%s\" updated.", SRCNAME, __func__, primaryFpr); if (it == m_fpr_map.end ()) { @@ -807,14 +807,14 @@ do_locate (LPVOID arg) const auto addr = args->m_mbox; - log_mime_parser ("%s:%s searching key for addr: \"%s\"", + log_data ("%s:%s searching key for addr: \"%s\"", SRCNAME, __func__, addr.c_str()); const auto k = GpgME::Key::locate (addr.c_str()); if (!k.isNull ()) { - log_mime_parser ("%s:%s found key for addr: \"%s\":%s", + log_data ("%s:%s found key for addr: \"%s\":%s", SRCNAME, __func__, addr.c_str(), k.primaryFingerprint()); KeyCache::instance ()->setPgpKey (addr, k); @@ -853,7 +853,7 @@ do_locate (LPVOID arg) if (key.isRevoked() || key.isExpired() || key.isDisabled() || key.isInvalid()) { - log_mime_parser ("%s:%s: Skipping invalid S/MIME key", + log_data ("%s:%s: Skipping invalid S/MIME key", SRCNAME, __func__); continue; } @@ -868,7 +868,7 @@ do_locate (LPVOID arg) } if (!candidate.isNull()) { - log_mime_parser ("%s:%s found SMIME key for addr: \"%s\":%s", + log_data ("%s:%s found SMIME key for addr: \"%s\":%s", SRCNAME, __func__, addr.c_str(), candidate.primaryFingerprint()); KeyCache::instance()->setSmimeKey (addr, candidate); @@ -929,14 +929,14 @@ locate_secret (const char *addr, GpgME::Protocol proto) { std::stringstream ss; ss << key; - log_mime_parser ("%s:%s: Skipping invalid secret key %s", + log_data ("%s:%s: Skipping invalid secret key %s", SRCNAME, __func__, ss.str().c_str()); } continue; } if (proto == GpgME::OpenPGP) { - log_mime_parser ("%s:%s found pgp skey for addr: \"%s\":%s", + log_data ("%s:%s found pgp skey for addr: \"%s\":%s", SRCNAME, __func__, mbox.c_str(), key.primaryFingerprint()); KeyCache::instance()->setPgpKeySecret (mbox, key); @@ -944,7 +944,7 @@ locate_secret (const char *addr, GpgME::Protocol proto) } if (proto == GpgME::CMS) { - log_mime_parser ("%s:%s found cms skey for addr: \"%s\":%s", + log_data ("%s:%s found cms skey for addr: \"%s\":%s", SRCNAME, __func__, mbox.c_str (), key.primaryFingerprint()); KeyCache::instance()->setSmimeKeySecret (mbox, key); @@ -959,7 +959,7 @@ do_locate_secret (LPVOID arg) { auto args = std::unique_ptr ((LocateArgs *) arg); - log_mime_parser ("%s:%s searching secret key for addr: \"%s\"", + log_data ("%s:%s searching secret key for addr: \"%s\"", SRCNAME, __func__, args->m_mbox.c_str ()); locate_secret (args->m_mbox.c_str(), GpgME::OpenPGP); diff --git a/src/mail.cpp b/src/mail.cpp index 0e34085..1f48fd2 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -1078,7 +1078,7 @@ Mail::decryptVerify_o () m_parser = std::shared_ptr (new ParseController (cipherstream, m_type)); m_parser->setSender(GpgME::UserID::addrSpecFromString(getSender_o ().c_str())); - log_mime_parser ("%s:%s: Parser for \"%s\" is %p", + log_data ("%s:%s: Parser for \"%s\" is %p", SRCNAME, __func__, getSubject_o ().c_str(), m_parser.get()); gpgol_release (cipherstream); @@ -2957,7 +2957,7 @@ has_crypt_or_empty_body_oom (Mail *mail) } else { - log_mime_parser ("%s:%s: Body found in %p : \"%s\"", + log_data ("%s:%s: Body found in %p : \"%s\"", SRCNAME, __func__, mail, body.c_str ()); } return ret; diff --git a/src/main.c b/src/main.c index a0d7071..987b5fd 100644 --- a/src/main.c +++ b/src/main.c @@ -232,7 +232,7 @@ read_options (void) else if (!strcmp (p, "mime-data")) opt.enable_debug |= DBG_MIME_DATA; else if (!strcmp (p, "oom")) - opt.enable_debug |= DBG_OOM; + opt.enable_debug |= DBG_OOM_VAL; else if (!strcmp (p, "oom-extra")) opt.enable_debug |= DBG_OOM_EXTRA; else @@ -250,12 +250,10 @@ read_options (void) as the option for debuging was not read before. */ free (val); val = NULL; if (opt.enable_debug) - log_debug ("enabled debug flags:%s%s%s%s%s\n", + log_debug ("enabled debug flags:%s%s%s\n", (opt.enable_debug & DBG_MEMORY)? " memory":"", - (opt.enable_debug & DBG_MIME_PARSER)? " mime-parser":"", - (opt.enable_debug & DBG_MIME_DATA)? " mime-data":"", - (opt.enable_debug & DBG_OOM)? " oom":"", - (opt.enable_debug & DBG_OOM_EXTRA)? " oom-extra":"" + (opt.enable_debug & DBG_DATA)? " data":"", + (opt.enable_debug & DBG_OOM)? " oom":"" ); opt.enable_smime = get_conf_bool ("enableSmime", 0); diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index ba49428..f629aca 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -129,7 +129,7 @@ debug_message_event (rfc822parse_event_t event) case RFC822PARSE_EPILOGUE: s= "Epilogue"; break; default: s= "[unknown event]"; break; } - log_mime_parser ("%s: rfc822 event %s\n", SRCNAME, s); + log_data ("%s: rfc822 event %s\n", SRCNAME, s); } /* Returns true if the BER encoded data in BUFFER is CMS signed data. @@ -244,7 +244,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) ctsub = "plain"; } - log_mime_parser ("%s:%s: ctx=%p, ct=`%s/%s'\n", + log_data ("%s:%s: ctx=%p, ct=`%s/%s'\n", SRCNAME, __func__, ctx, ctmain, ctsub); s = rfc822parse_query_parameter (field, "charset", 0); @@ -337,7 +337,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) sig_data has not been set yet). We also do this only while in verify mode because we don't want to write a full MUA. */ ctx->collect_signature = 1; - log_mime_parser ("%s:%s: Collecting signature.", + log_data ("%s:%s: Collecting signature.", SRCNAME, __func__); } else if (ctx->nesting_level == 1 && ctx->is_encrypted @@ -345,7 +345,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) && (ctx->protocol == PROTOCOL_OPENPGP && !strcmp (ctsub, "octet-stream"))) { - log_mime_parser ("%s:%s: Collecting encrypted PGP data.", + log_data ("%s:%s: Collecting encrypted PGP data.", SRCNAME, __func__); ctx->collect_crypto_data = 1; } @@ -358,7 +358,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) && (!strcmp (ctsub, "pkcs7-mime") || !strcmp (ctsub, "x-pkcs7-mime"))) { - log_mime_parser ("%s:%s: Collecting crypted S/MIME data.", + log_data ("%s:%s: Collecting crypted S/MIME data.", SRCNAME, __func__); ctx->collect_crypto_data = 1; } @@ -366,7 +366,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) rfc822parse_release_field (field); /* (Content-type) */ ctx->in_data = 1; - log_mime_parser ("%s:%s: this body: nesting=%d partno=%d is_text=%d" + log_data ("%s:%s: this body: nesting=%d partno=%d is_text=%d" " charset=\"%s\"\n body_seen=%d is_text_attachment=%d", SRCNAME, __func__, ctx->nesting_level, ctx->part_counter, is_text, @@ -406,7 +406,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) ctx->current_attachment = provider->create_attachment(); ctx->collect_body = 0; ctx->collect_html_body = 0; - log_mime_parser ("%s:%s: Collecting attachment.", + log_data ("%s:%s: Collecting attachment.", SRCNAME, __func__); } @@ -509,9 +509,9 @@ MimeDataProvider::MimeDataProvider(LPSTREAM stream, bool no_headers): log_error ("%s:%s called without stream ", SRCNAME, __func__); return; } - log_mime_parser ("%s:%s Collecting data.", SRCNAME, __func__); + log_data ("%s:%s Collecting data.", SRCNAME, __func__); collect_data (stream); - log_mime_parser ("%s:%s Data collected.", SRCNAME, __func__); + log_data ("%s:%s Data collected.", SRCNAME, __func__); gpgol_release (stream); } #endif @@ -519,9 +519,9 @@ MimeDataProvider::MimeDataProvider(LPSTREAM stream, bool no_headers): MimeDataProvider::MimeDataProvider(FILE *stream, bool no_headers): MimeDataProvider(no_headers) { - log_mime_parser ("%s:%s Collecting data from file.", SRCNAME, __func__); + log_data ("%s:%s Collecting data from file.", SRCNAME, __func__); collect_data (stream); - log_mime_parser ("%s:%s Data collected.", SRCNAME, __func__); + log_data ("%s:%s Data collected.", SRCNAME, __func__); } MimeDataProvider::~MimeDataProvider() @@ -558,7 +558,7 @@ MimeDataProvider::isSupported(GpgME::DataProvider::Operation op) const ssize_t MimeDataProvider::read(void *buffer, size_t size) { - log_mime_parser ("%s:%s: Reading: " SIZE_T_FORMAT "Bytes", + log_data ("%s:%s: Reading: " SIZE_T_FORMAT "Bytes", SRCNAME, __func__, size); ssize_t bRead = m_crypto_data.read (buffer, size); if (opt.enable_debug & DBG_MIME_DATA && bRead) @@ -717,7 +717,7 @@ MimeDataProvider::collect_input_lines(const char *input, size_t insize) } else { - log_mime_parser ("%s:%s Collecting ended / failed.", + log_data ("%s:%s Collecting ended / failed.", SRCNAME, __func__); } } @@ -791,11 +791,11 @@ MimeDataProvider::collect_data(LPSTREAM stream) { if (!bRead) { - log_mime_parser ("%s:%s: Input stream at EOF.", + log_data ("%s:%s: Input stream at EOF.", SRCNAME, __func__); break; } - log_mime_parser ("%s:%s: Read %lu bytes.", + log_data ("%s:%s: Read %lu bytes.", SRCNAME, __func__, bRead); allRead += bRead; if (first_read) @@ -849,7 +849,7 @@ MimeDataProvider::collect_data(LPSTREAM stream) /* For S/MIME, Clearsigned, PGP MESSAGES we just pass everything on. Only the Multipart classes need parsing. And the output of course. */ - log_mime_parser ("%s:%s: Just copying data.", + log_data ("%s:%s: Just copying data.", SRCNAME, __func__); m_crypto_data.write ((void*)buf, (size_t) bRead); continue; @@ -865,7 +865,7 @@ MimeDataProvider::collect_data(LPSTREAM stream) SRCNAME, __func__); break; } - log_mime_parser ("%s:%s: Consumed: " SIZE_T_FORMAT " bytes", + log_data ("%s:%s: Consumed: " SIZE_T_FORMAT " bytes", SRCNAME, __func__, m_rawbuf.size() - not_taken); m_rawbuf.erase (0, m_rawbuf.size() - not_taken); } @@ -902,7 +902,7 @@ MimeDataProvider::collect_data(LPSTREAM stream) } if (line.find (':') != std::string::npos) { - log_mime_parser ("%s:%s: Removing comment '%s'.", + log_data ("%s:%s: Removing comment '%s'.", SRCNAME, __func__, line.c_str ()); continue; } @@ -924,7 +924,7 @@ MimeDataProvider::collect_data(FILE *stream) size_t bRead; while ((bRead = fread (buf, 1, BUFSIZE, stream)) > 0) { - log_mime_parser ("%s:%s: Read " SIZE_T_FORMAT " bytes.", + log_data ("%s:%s: Read " SIZE_T_FORMAT " bytes.", SRCNAME, __func__, bRead); if (m_collect_everything) @@ -932,7 +932,7 @@ MimeDataProvider::collect_data(FILE *stream) /* For S/MIME, Clearsigned, PGP MESSAGES we just pass everything on. Only the Multipart classes need parsing. And the output of course. */ - log_mime_parser ("%s:%s: Making verbatim copy" SIZE_T_FORMAT " bytes.", + log_data ("%s:%s: Making verbatim copy" SIZE_T_FORMAT " bytes.", SRCNAME, __func__, bRead); m_crypto_data.write ((void*)buf, bRead); continue; @@ -948,7 +948,7 @@ MimeDataProvider::collect_data(FILE *stream) SRCNAME, __func__); return; } - log_mime_parser ("%s:%s: Consumed: " SIZE_T_FORMAT " bytes", + log_data ("%s:%s: Consumed: " SIZE_T_FORMAT " bytes", SRCNAME, __func__, m_rawbuf.size() - not_taken); m_rawbuf.erase (0, m_rawbuf.size() - not_taken); } @@ -960,7 +960,7 @@ ssize_t MimeDataProvider::write(const void *buffer, size_t bufSize) { /* Writing with collect everything one means that we are outputprovider. In this case for inline messages we want to collect everything. */ - log_mime_parser ("%s:%s: Using complete input as body " SIZE_T_FORMAT " bytes.", + log_data ("%s:%s: Using complete input as body " SIZE_T_FORMAT " bytes.", SRCNAME, __func__, bufSize); m_body += std::string ((const char *) buffer, bufSize); return bufSize; @@ -976,7 +976,7 @@ ssize_t MimeDataProvider::write(const void *buffer, size_t bufSize) SRCNAME, __func__); return bufSize; } - log_mime_parser ("%s:%s: Write Consumed: " SIZE_T_FORMAT " bytes", + log_data ("%s:%s: Write Consumed: " SIZE_T_FORMAT " bytes", SRCNAME, __func__, m_rawbuf.size() - not_taken); m_rawbuf.erase (0, m_rawbuf.size() - not_taken); return bufSize; @@ -997,7 +997,7 @@ MimeDataProvider::signature() const std::shared_ptr MimeDataProvider::create_attachment() { - log_mime_parser ("%s:%s: Creating attachment.", + log_data ("%s:%s: Creating attachment.", SRCNAME, __func__); auto attach = std::shared_ptr (new Attachment()); @@ -1015,7 +1015,7 @@ MimeDataProvider::create_attachment() } else { - log_mime_parser ("%s:%s: Attachment filename: %s", + log_data ("%s:%s: Attachment filename: %s", SRCNAME, __func__, m_mime_ctx->mimestruct_cur->filename); attach->set_display_name (m_mime_ctx->mimestruct_cur->filename); } diff --git a/src/oomhelp.cpp b/src/oomhelp.cpp index 0f832d8..2c162ab 100644 --- a/src/oomhelp.cpp +++ b/src/oomhelp.cpp @@ -1237,7 +1237,7 @@ try_resolve_group (LPDISPATCH addrEntry, if (type != DISTRIBUTION_LIST_ADDRESS_ENTRY_TYPE) { - log_mime_parser ("%s:%s: type of %s is %i", + log_data ("%s:%s: type of %s is %i", SRCNAME, __func__, name.c_str(), type); return false; } diff --git a/src/parsecontroller.cpp b/src/parsecontroller.cpp index 82d10e7..cc2ee33 100644 --- a/src/parsecontroller.cpp +++ b/src/parsecontroller.cpp @@ -83,7 +83,7 @@ ParseController::ParseController(LPSTREAM instream, msgtype_t type): m_block_html (false) { memdbg_ctor ("ParseController"); - log_mime_parser ("%s:%s: Creating parser for stream: %p of type %i" + log_data ("%s:%s: Creating parser for stream: %p of type %i" " expect no headers: %i expect no mime: %i", SRCNAME, __func__, instream, type, expect_no_headers (type), expect_no_mime (type)); @@ -98,7 +98,7 @@ ParseController::ParseController(FILE *instream, msgtype_t type): m_block_html (false) { memdbg_ctor ("ParseController"); - log_mime_parser ("%s:%s: Creating parser for stream: %p of type %i", + log_data ("%s:%s: Creating parser for stream: %p of type %i", SRCNAME, __func__, instream, type); } @@ -649,7 +649,7 @@ ParseController::get_ultimate_keys() s_ultimate_keys.push_back (key); log_debug ("%s:%s: Adding ultimate uid.", SRCNAME, __func__); - log_mime_parser ("%s:%s: Added uid %s.", + log_data ("%s:%s: Added uid %s.", SRCNAME, __func__, uid.id()); break; } commit 9e42f7008b4d089546070cc4de4a461fb96e8e97 Author: Andre Heinecke Date: Mon Sep 24 09:13:53 2018 +0200 Remove obsolete logging categories * src/common_indep.h (DBG_COMMANDS, DBG_IOWORKER), (DBG_IOWORKER_EXTRA, DBG_FILTER, DBG_FILTER_EXTRA): Removed. * src/main.c (read_options): Remove handling of obsolete values. diff --git a/src/common_indep.h b/src/common_indep.h index 7175cf9..c78256f 100644 --- a/src/common_indep.h +++ b/src/common_indep.h @@ -218,21 +218,26 @@ struct b64_state_s typedef struct b64_state_s b64_state_t; /* Bit values used for extra log file verbosity. Value 1 is reserved - to enable debug menu options. */ -#define DBG_IOWORKER (1<<1) -#define DBG_IOWORKER_EXTRA (1<<2) -#define DBG_FILTER (1<<3) -#define DBG_FILTER_EXTRA (1<<4) + to enable debug menu options. + + Note that the high values here are used for compatibility with + old howtos of how to enable debug flags. Based on the old + very split up logging categories. + + Categories are meant to be: + + DBG -> Generally useful information. + DBG_MEMORY -> Very verbose tracing of Releases / Allocs / Refs. + DBG_OOM -> Outlook Object Model events tracing. + DBG_DATA -> Including potentially private data and mime parser logging. + + */ #define DBG_MEMORY (1<<5) -#define DBG_COMMANDS (1<<6) #define DBG_MIME_PARSER (1<<7) #define DBG_MIME_DATA (1<<8) #define DBG_OOM (1<<9) #define DBG_OOM_EXTRA (1<<10) -/* Macros to used in conditionals to enable debug output. */ -#define debug_commands (opt.enable_debug & DBG_COMMANDS) - size_t qp_decode (char *buffer, size_t length, int *r_slbrk); char *qp_encode (const char *input, size_t length, size_t* outlen); void b64_init (b64_state_t *state); diff --git a/src/main.c b/src/main.c index 8b08030..a0d7071 100644 --- a/src/main.c +++ b/src/main.c @@ -225,18 +225,8 @@ read_options (void) } if (isascii (*p) && isdigit (*p)) opt.enable_debug |= strtoul (p, NULL, 0); - else if (!strcmp (p, "ioworker")) - opt.enable_debug |= DBG_IOWORKER; - else if (!strcmp (p, "ioworker-extra")) - opt.enable_debug |= DBG_IOWORKER_EXTRA; - else if (!strcmp (p, "filter")) - opt.enable_debug |= DBG_FILTER; - else if (!strcmp (p, "filter-extra")) - opt.enable_debug |= DBG_FILTER_EXTRA; else if (!strcmp (p, "memory")) opt.enable_debug |= DBG_MEMORY; - else if (!strcmp (p, "commands")) - opt.enable_debug |= DBG_COMMANDS; else if (!strcmp (p, "mime-parser")) opt.enable_debug |= DBG_MIME_PARSER; else if (!strcmp (p, "mime-data")) @@ -260,13 +250,8 @@ read_options (void) as the option for debuging was not read before. */ free (val); val = NULL; if (opt.enable_debug) - log_debug ("enabled debug flags:%s%s%s%s%s%s%s%s%s%s\n", - (opt.enable_debug & DBG_IOWORKER)? " ioworker":"", - (opt.enable_debug & DBG_IOWORKER_EXTRA)? " ioworker-extra":"", - (opt.enable_debug & DBG_FILTER)? " filter":"", - (opt.enable_debug & DBG_FILTER_EXTRA)? " filter-extra":"", + log_debug ("enabled debug flags:%s%s%s%s%s\n", (opt.enable_debug & DBG_MEMORY)? " memory":"", - (opt.enable_debug & DBG_COMMANDS)? " commands":"", (opt.enable_debug & DBG_MIME_PARSER)? " mime-parser":"", (opt.enable_debug & DBG_MIME_DATA)? " mime-data":"", (opt.enable_debug & DBG_OOM)? " oom":"", ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 1 + src/common.cpp | 2 +- src/common_indep.c | 283 ------------------------------------------- src/common_indep.h | 68 +---------- src/debug.cpp | 303 +++++++++++++++++++++++++++++++++++++++++++++++ src/debug.h | 116 ++++++++++++++++++ src/keycache.cpp | 40 +++---- src/mail.cpp | 4 +- src/main.c | 25 +--- src/mimedataprovider.cpp | 50 ++++---- src/oomhelp.cpp | 2 +- src/parsecontroller.cpp | 6 +- 12 files changed, 478 insertions(+), 422 deletions(-) create mode 100644 src/debug.cpp create mode 100644 src/debug.h hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Mon Sep 24 12:04:30 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Mon, 24 Sep 2018 12:04:30 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-40-gb4a65a8 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via b4a65a8eda8fabd73bc2cf7db2d7084194089125 (commit) via 19f8d131b3bb48eb60a4a6d6c01ac5c4c97e35ab (commit) via 98439ec3551084153e52b25f069d7170d1db5e6f (commit) via da75bcaa1fc935aa4a770b41e36ce2ce7a218db3 (commit) via 296a4d74725cab076ba714564754148fa783da0f (commit) via 177b72b8c33a2459e20695e01492573211c150f8 (commit) via 5156d7b1da1fd9463e9442f5e913b6b24c0a7b69 (commit) from 635ff920f8c22087d27b62f8a597fe36e9925ff8 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b4a65a8eda8fabd73bc2cf7db2d7084194089125 Author: Andre Heinecke Date: Mon Sep 24 12:03:33 2018 +0200 Remove obsolete / unused code * src/exechelp.c, src/exechelp.h: Removed. * src/Makefile.am: Update accordingly. -- We use GpgME spawning nowadays. diff --git a/src/Makefile.am b/src/Makefile.am index 47643fa..0993bd5 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -40,7 +40,6 @@ gpgol_SOURCES = \ dispcache.h dispcache.cpp \ eventsink.h \ eventsinks.h \ - exechelp.c exechelp.h \ explorer-events.cpp \ explorers-events.cpp \ filetype.c filetype.h \ diff --git a/src/exechelp.c b/src/exechelp.c deleted file mode 100644 index acae01d..0000000 --- a/src/exechelp.c +++ /dev/null @@ -1,150 +0,0 @@ -/* exechelp.c - fork and exec helpers - * Copyright (C) 2004, 2007, 2014 g10 Code GmbH - * Copyright (C) 2015 by Bundesamt f?r Sicherheit in der Informationstechnik - * Software engineering by Intevation GmbH - * - * This file is part of GpgOL. - * - * GpgOL is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * GpgOL is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA - */ - -#ifdef HAVE_CONFIG_H -#include -#endif - -#include -#include -#include -#include - -#include - -#include - -#include "common.h" -#include "exechelp.h" - -/* Define to 1 do enable debugging. */ -#define DEBUG_W32_SPAWN 0 - - - - -/* Lock a spawning process. The caller needs to provide the address - of a variable to store the lock information and the name or the - process. */ -gpg_error_t -gpgol_lock_spawning (lock_spawn_t *lock) -{ - int waitrc; - int timeout = 5; - - *lock = CreateMutexW (NULL, FALSE, L"spawn_gnupg_uiserver_sentinel"); - if (!*lock) - { - log_error ("failed to create the spawn mutex: rc=%ld", GetLastError ()); - return gpg_error (GPG_ERR_GENERAL); - } - - retry: - waitrc = WaitForSingleObject (*lock, 1000); - if (waitrc == WAIT_OBJECT_0) - return 0; - - if (waitrc == WAIT_TIMEOUT && timeout) - { - timeout--; - goto retry; - } - if (waitrc == WAIT_TIMEOUT) - log_error ("error waiting for the spawn mutex: timeout"); - else - log_error ("error waiting for the spawn mutex: (code=%d) rc=%ld", - waitrc, GetLastError ()); - return gpg_error (GPG_ERR_GENERAL); -} - - -/* Unlock the spawning process. */ -void -gpgol_unlock_spawning (lock_spawn_t *lock) -{ - if (*lock) - { - if (!ReleaseMutex (*lock)) - log_error ("failed to release the spawn mutex: rc=%ld", GetLastError()); - CloseHandle (*lock); - *lock = NULL; - } -} - - -/* Fork and exec the program with /dev/null as stdin, stdout and - stderr. Returns 0 on success or an error code. */ -gpg_error_t -gpgol_spawn_detached (const char *cmdline) -{ - SECURITY_ATTRIBUTES sec_attr; - PROCESS_INFORMATION pi = - { - NULL, /* Returns process handle. */ - 0, /* Returns primary thread handle. */ - 0, /* Returns pid. */ - 0 /* Returns tid. */ - }; - STARTUPINFO si; - int cr_flags; - - log_debug ("gpgol_spawn_detached cmdline=%s", cmdline); - - /* Prepare security attributes. */ - memset (&sec_attr, 0, sizeof sec_attr); - sec_attr.nLength = sizeof sec_attr; - sec_attr.bInheritHandle = FALSE; - - /* Start the process. Note that we can't run the PREEXEC function - because this would change our own environment. */ - memset (&si, 0, sizeof si); - si.cb = sizeof (si); - si.dwFlags = STARTF_USESHOWWINDOW; - si.wShowWindow = DEBUG_W32_SPAWN ? SW_SHOW : SW_MINIMIZE; - - cr_flags = (CREATE_DEFAULT_ERROR_MODE - | GetPriorityClass (GetCurrentProcess ()) - | CREATE_NEW_PROCESS_GROUP - | DETACHED_PROCESS); - - if (!CreateProcess (NULL, /* pgmname; Program to start. */ - (char *) cmdline, /* Command line arguments. */ - &sec_attr, /* Process security attributes. */ - &sec_attr, /* Thread security attributes. */ - TRUE, /* Inherit handles. */ - cr_flags, /* Creation flags. */ - NULL, /* Environment. */ - NULL, /* Use current drive/directory. */ - &si, /* Startup information. */ - &pi /* Returns process information. */ - )) - { - log_error ("CreateProcess failed: %ld\n", GetLastError ()); - return gpg_error (GPG_ERR_GENERAL); - } - - /* Process has been created suspended; resume it now. */ - CloseHandle (pi.hThread); - CloseHandle (pi.hProcess); - - return 0; -} diff --git a/src/exechelp.h b/src/exechelp.h deleted file mode 100644 index 6b62407..0000000 --- a/src/exechelp.h +++ /dev/null @@ -1,51 +0,0 @@ -/* exechelp.h - fork and exec helpers - * Copyright (C) 2004, 2007 g10 Code GmbH - * Copyright (C) 2015 by Bundesamt f?r Sicherheit in der Informationstechnik - * Software engineering by Intevation GmbH - * - * This file is part of GpgOL. - * - * GpgOL is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * GpgOL is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA - */ - -#ifndef GPGOL_EXECHELP_H -#define GPGOL_EXECHELP_H - -#include - -#ifdef __cplusplus -extern "C" { -#if 0 -} -#endif -#endif - -#define lock_spawn_t HANDLE - -gpg_error_t gpgol_lock_spawning (lock_spawn_t *lock); -void gpgol_unlock_spawning (lock_spawn_t *lock); - -/* Fork and exec CMDLINE with /dev/null as stdin, stdout and stderr. - Returns 0 on success or an error code. */ -gpg_error_t gpgol_spawn_detached (const char *cmdline); - -#ifdef __cplusplus -#if 0 -{ -#endif -} -#endif - -#endif /* GPGOL_EXECHELP_H */ commit 19f8d131b3bb48eb60a4a6d6c01ac5c4c97e35ab Author: Andre Heinecke Date: Mon Sep 24 11:50:25 2018 +0200 Add string pseudonyms for debug output * src/debug.cpp (anonstr): New. -- If DBG_DATA is disabled this will pseudonym strings in debug output. diff --git a/src/debug.cpp b/src/debug.cpp index b268e86..de1108d 100644 --- a/src/debug.cpp +++ b/src/debug.cpp @@ -19,6 +19,10 @@ #include "common_indep.h" +#include + +#include +#include /* The malloced name of the logfile and the logging stream. If LOGFILE is NULL, no logging is done. */ @@ -304,3 +308,45 @@ log_window_hierarchy (HWND window, const char *fmt, ...) } } #endif + +GPGRT_LOCK_DEFINE (anon_str_lock); + +/* Weel ok this survives unload but we don't want races + and it makes a bit of sense to keep the strings constant. */ +static std::unordered_map str_map; + +const char *anonstr (const char *data) +{ + static int64_t cnt; + if (opt.enable_debug & DBG_DATA) + { + return data; + } + if (!data) + { + return "gpgol_str_null"; + } + if (!strlen (data)) + { + return "gpgol_str_empty"; + } + + gpgrt_lock_lock (&anon_str_lock); + const std::string strData (data); + auto it = str_map.find (strData); + + if (it == str_map.end ()) + { + const auto anon = std::string ("gpgol_string_") + std::to_string (cnt); + str_map.insert (std::make_pair (strData, anon)); + it = str_map.find (strData); + } + + // As the data is saved in our map we can return + // the c_str as it won't be touched as const. + + gpgrt_lock_unlock (&anon_str_lock); + + TRACEPOINT; + return it->second.c_str(); +} diff --git a/src/debug.h b/src/debug.h index 54a6262..446c587 100644 --- a/src/debug.h +++ b/src/debug.h @@ -71,6 +71,7 @@ void log_error_w32 (int w32err, const char *fmt, void log_hexdump (const void *buf, size_t buflen, const char *fmt, ...) __attribute__ ((format (printf,3,4))); +const char *anonstr (const char *data); #define log_oom if (opt.enable_debug & DBG_OOM) log_debug #define log_data if (opt.enable_debug & DBG_DATA) log_debug #define log_memory if (opt.enable_debug & DBG_MEMORY) log_debug commit 98439ec3551084153e52b25f069d7170d1db5e6f Author: Andre Heinecke Date: Mon Sep 24 11:12:00 2018 +0200 Use unordered_map in memdbg for performance * src/memdbg.cpp: Use unordered_map for faster lookups. -- This code can be queried very often so a performance improvement is nice to have. diff --git a/src/memdbg.cpp b/src/memdbg.cpp index cb39e62..02d8172 100644 --- a/src/memdbg.cpp +++ b/src/memdbg.cpp @@ -27,13 +27,13 @@ #include -#include +#include #include -std::map cppObjs; -std::map olObjs; -std::map olNames; -std::map allocs; +std::unordered_map cppObjs; +std::unordered_map olObjs; +std::unordered_map olNames; +std::unordered_map allocs; GPGRT_LOCK_DEFINE (memdbg_log); commit da75bcaa1fc935aa4a770b41e36ce2ce7a218db3 Author: Andre Heinecke Date: Mon Sep 24 11:00:11 2018 +0200 Replace log_mime_data with log_data * src/mimedataprovider.cpp: Replace log_mime_data with log_data. * src/debug.h: Update log macros diff --git a/src/debug.h b/src/debug.h index b5b5e49..54a6262 100644 --- a/src/debug.h +++ b/src/debug.h @@ -72,10 +72,8 @@ void log_hexdump (const void *buf, size_t buflen, const char *fmt, ...) __attribute__ ((format (printf,3,4))); #define log_oom if (opt.enable_debug & DBG_OOM) log_debug -#define log_oom if (opt.enable_debug & DBG_OOM) log_debug -#define log_mime_parser if (opt.enable_debug & DBG_DATA) log_debug #define log_data if (opt.enable_debug & DBG_DATA) log_debug -#define log_mime_data if (opt.enable_debug & DBG_DATA) log_debug +#define log_memory if (opt.enable_debug & DBG_MEMORY) log_debug #define gpgol_release(X) \ { \ diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index f629aca..16eb230 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -567,12 +567,12 @@ MimeDataProvider::read(void *buffer, size_t size) if (!is_binary (buf)) { - log_mime_data ("%s:%s: Data: \n------\n%s\n------", + log_data ("%s:%s: Data: \n------\n%s\n------", SRCNAME, __func__, buf.c_str()); } else { - log_mime_data ("%s:%s: Hex Data: \n------\n%s\n------", + log_data ("%s:%s: Hex Data: \n------\n%s\n------", SRCNAME, __func__, string_to_hex (buf).c_str ()); } @@ -614,7 +614,7 @@ MimeDataProvider::collect_input_lines(const char *input, size_t insize) pos--; } - log_mime_data ("%s:%s: Parsing line=`%.*s'\n", + log_data ("%s:%s: Parsing line=`%.*s'\n", SRCNAME, __func__, (int)pos, linebuf); /* Check the next state */ if (rfc822parse_insert (m_mime_ctx->msg, @@ -653,7 +653,7 @@ MimeDataProvider::collect_input_lines(const char *input, size_t insize) { m_crypto_data.write ("\r\n", 2); } - log_mime_data ("Writing raw crypto data: %.*s", + log_data ("Writing raw crypto data: %.*s", (int)pos, linebuf); m_crypto_data.write (linebuf, pos); m_mime_ctx->collect_crypto_data = 2; commit 296a4d74725cab076ba714564754148fa783da0f Author: Andre Heinecke Date: Mon Sep 24 10:57:19 2018 +0200 Replace log_oom_extra with log_oom -- diff --git a/src/application-events.cpp b/src/application-events.cpp index 1100934..d882e50 100644 --- a/src/application-events.cpp +++ b/src/application-events.cpp @@ -101,7 +101,7 @@ EVENT_SINK_INVOKE(ApplicationEvents) break; } default: - log_oom_extra ("%s:%s: Unhandled Event: %lx \n", + log_oom ("%s:%s: Unhandled Event: %lx \n", SRCNAME, __func__, dispid); } /* We always return S_OK even on error so that outlook diff --git a/src/debug.h b/src/debug.h index 523b540..b5b5e49 100644 --- a/src/debug.h +++ b/src/debug.h @@ -72,7 +72,7 @@ void log_hexdump (const void *buf, size_t buflen, const char *fmt, ...) __attribute__ ((format (printf,3,4))); #define log_oom if (opt.enable_debug & DBG_OOM) log_debug -#define log_oom_extra if (opt.enable_debug & DBG_OOM) log_debug +#define log_oom if (opt.enable_debug & DBG_OOM) log_debug #define log_mime_parser if (opt.enable_debug & DBG_DATA) log_debug #define log_data if (opt.enable_debug & DBG_DATA) log_debug #define log_mime_data if (opt.enable_debug & DBG_DATA) log_debug diff --git a/src/explorer-events.cpp b/src/explorer-events.cpp index e9dd776..7ccedfd 100644 --- a/src/explorer-events.cpp +++ b/src/explorer-events.cpp @@ -139,7 +139,7 @@ start_watchdog (LPVOID arg) if ((it->second & SelectSeen)) { - log_oom_extra ("%s:%s: Cancel watchdog as we have seen a select %p", + log_oom ("%s:%s: Cancel watchdog as we have seen a select %p", SRCNAME, __func__, explorer); it->second = SelectSeen; } @@ -175,14 +175,14 @@ changeSeen (LPDISPATCH explorer) if (has_selection) { it->second = (state & WatchDogActive) + SelectSeen; - log_oom_extra ("%s:%s: Seen select for %p", + log_oom ("%s:%s: Seen select for %p", SRCNAME, __func__, explorer); } else { if ((it->second & WatchDogActive)) { - log_oom_extra ("%s:%s: Seen unselect for %p but watchdog exists.", + log_oom ("%s:%s: Seen unselect for %p but watchdog exists.", SRCNAME, __func__, explorer); } else @@ -202,14 +202,14 @@ EVENT_SINK_INVOKE(ExplorerEvents) { case SelectionChange: { - log_oom_extra ("%s:%s: Selection change in explorer: %p", + log_oom ("%s:%s: Selection change in explorer: %p", SRCNAME, __func__, this); changeSeen (m_object); break; } case Close: { - log_oom_extra ("%s:%s: Deleting event handler: %p", + log_oom ("%s:%s: Deleting event handler: %p", SRCNAME, __func__, this); GpgolAddin::get_instance ()->unregisterExplorerSink (this); @@ -222,7 +222,7 @@ EVENT_SINK_INVOKE(ExplorerEvents) default: break; #if 0 - log_oom_extra ("%s:%s: Unhandled Event: %lx \n", + log_oom ("%s:%s: Unhandled Event: %lx \n", SRCNAME, __func__, dispid); #endif } diff --git a/src/folder-events.cpp b/src/folder-events.cpp index 8c765c1..5becba2 100644 --- a/src/folder-events.cpp +++ b/src/folder-events.cpp @@ -49,7 +49,7 @@ EVENT_SINK_INVOKE(FolderEvents) { case BeforeItemMove: { - log_oom_extra ("%s:%s: Item Move in folder: %p", + log_oom ("%s:%s: Item Move in folder: %p", SRCNAME, __func__, this); /* Parameters should be @@ -70,7 +70,7 @@ EVENT_SINK_INVOKE(FolderEvents) if (!parms->rgvarg[1].pdispVal) { - log_oom_extra ("%s:%s: Passing delete", + log_oom ("%s:%s: Passing delete", SRCNAME, __func__); break; } @@ -126,7 +126,7 @@ EVENT_SINK_INVOKE(FolderEvents) default: break; #if 0 - log_oom_extra ("%s:%s: Unhandled Event: %lx \n", + log_oom ("%s:%s: Unhandled Event: %lx \n", SRCNAME, __func__, dispid); #endif } diff --git a/src/gpgoladdin.cpp b/src/gpgoladdin.cpp index 75e9cc8..5f12ab8 100644 --- a/src/gpgoladdin.cpp +++ b/src/gpgoladdin.cpp @@ -458,7 +458,7 @@ install_explorer_sinks (LPDISPATCH application) } else { - log_oom_extra ("%s:%s: created sink %p for explorer %i", + log_oom ("%s:%s: created sink %p for explorer %i", SRCNAME, __func__, sink, i); GpgolAddin::get_instance ()->registerExplorerSink (sink); } diff --git a/src/mail.cpp b/src/mail.cpp index 1f48fd2..f9dfe0c 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -155,16 +155,16 @@ Mail::~Mail() while parsing. */ gpgrt_lock_lock (&dtor_lock); memdbg_dtor ("Mail"); - log_oom_extra ("%s:%s: dtor: Mail: %p item: %p", + log_oom ("%s:%s: dtor: Mail: %p item: %p", SRCNAME, __func__, this, m_mailitem); std::map::iterator it; - log_oom_extra ("%s:%s: Detaching event sink", + log_oom ("%s:%s: Detaching event sink", SRCNAME, __func__); detach_MailItemEvents_sink (m_event_sink); gpgol_release(m_event_sink); - log_oom_extra ("%s:%s: Erasing mail", + log_oom ("%s:%s: Erasing mail", SRCNAME, __func__); gpgrt_lock_lock (&mail_map_lock); it = s_mail_map.find(m_mailitem); @@ -185,29 +185,29 @@ Mail::~Mail() gpgrt_lock_unlock (&uid_map_lock); } - log_oom_extra ("%s:%s: releasing mailitem", + log_oom ("%s:%s: releasing mailitem", SRCNAME, __func__); gpgol_release(m_mailitem); xfree (m_cached_html_body); xfree (m_cached_plain_body); if (!m_uuid.empty()) { - log_oom_extra ("%s:%s: destroyed: %p uuid: %s", + log_oom ("%s:%s: destroyed: %p uuid: %s", SRCNAME, __func__, this, m_uuid.c_str()); } else { - log_oom_extra ("%s:%s: non crypto (or sent) mail: %p destroyed", + log_oom ("%s:%s: non crypto (or sent) mail: %p destroyed", SRCNAME, __func__, this); } - log_oom_extra ("%s:%s: nulling shared pointer", + log_oom ("%s:%s: nulling shared pointer", SRCNAME, __func__); m_parser = nullptr; m_crypter = nullptr; releaseCurrentItem(); gpgrt_lock_unlock (&dtor_lock); - log_oom_extra ("%s:%s: returning", + log_oom ("%s:%s: returning", SRCNAME, __func__); } @@ -277,7 +277,7 @@ Mail::preProcessMessage_m () SRCNAME, __func__); return 0; } - log_oom_extra ("%s:%s: GetBaseMessage OK for %p.", + log_oom ("%s:%s: GetBaseMessage OK for %p.", SRCNAME, __func__, m_mailitem); /* Change the message class here. It is important that we change the message class in the before read event @@ -1333,7 +1333,7 @@ void Mail::parsing_done() { TRACEPOINT; - log_oom_extra ("Mail %p Parsing done for parser num %i: %p", + log_oom ("Mail %p Parsing done for parser num %i: %p", this, parsed_count++, m_parser.get()); if (!m_parser) { @@ -1919,13 +1919,13 @@ Mail::close (Mail *mail) dispparams.cArgs = 1; dispparams.cNamedArgs = 0; - log_oom_extra ("%s:%s: Invoking close for: %p", + log_oom ("%s:%s: Invoking close for: %p", SRCNAME, __func__, mail->item()); mail->setCloseTriggered (true); int rc = invoke_oom_method_with_parms (mail->item(), "Close", NULL, &dispparams); - log_oom_extra ("%s:%s: Returned from close", + log_oom ("%s:%s: Returned from close", SRCNAME, __func__); return rc; } @@ -3555,7 +3555,7 @@ Mail::releaseCurrentItem() { return; } - log_oom_extra ("%s:%s: releasing CurrentItem ref %p", + log_oom ("%s:%s: releasing CurrentItem ref %p", SRCNAME, __func__, m_currentItemRef); LPDISPATCH tmp = m_currentItemRef; m_currentItemRef = nullptr; diff --git a/src/mailitem-events.cpp b/src/mailitem-events.cpp index 03296f0..86af6a1 100644 --- a/src/mailitem-events.cpp +++ b/src/mailitem-events.cpp @@ -142,7 +142,7 @@ EVENT_SINK_INVOKE(MailItemEvents) { case Open: { - log_oom_extra ("%s:%s: Open : %p", + log_oom ("%s:%s: Open : %p", SRCNAME, __func__, m_mail); int draft_flags = 0; if (!opt.encrypt_default && !opt.sign_default) @@ -170,7 +170,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case BeforeRead: { - log_oom_extra ("%s:%s: BeforeRead : %p", + log_oom ("%s:%s: BeforeRead : %p", SRCNAME, __func__, m_mail); if (m_mail->preProcessMessage_m ()) { @@ -181,7 +181,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case Read: { - log_oom_extra ("%s:%s: Read : %p", + log_oom ("%s:%s: Read : %p", SRCNAME, __func__, m_mail); if (!m_mail->isCryptoMail ()) { @@ -323,7 +323,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case CustomPropertyChange: { - log_oom_extra ("%s:%s: CustomPropertyChange : %p", + log_oom ("%s:%s: CustomPropertyChange : %p", SRCNAME, __func__, m_mail); /* TODO */ break; @@ -345,7 +345,7 @@ EVENT_SINK_INVOKE(MailItemEvents) If this encryption is successful and we pass the send as then the encrypted data is sent. */ - log_oom_extra ("%s:%s: Send : %p", + log_oom ("%s:%s: Send : %p", SRCNAME, __func__, m_mail); if (!m_mail->needs_crypto_m () && m_mail->cryptState () == Mail::NoCryptMail) { @@ -553,7 +553,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case Write: { - log_oom_extra ("%s:%s: Write : %p", + log_oom ("%s:%s: Write : %p", SRCNAME, __func__, m_mail); /* This is a bit strange. We sometimes get multiple write events without a read in between. When we access the message in @@ -671,7 +671,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case AfterWrite: { - log_oom_extra ("%s:%s: AfterWrite : %p", + log_oom ("%s:%s: AfterWrite : %p", SRCNAME, __func__, m_mail); if (m_mail->cryptState () == Mail::NeedsFirstAfterWrite) { @@ -695,7 +695,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case Close: { - log_oom_extra ("%s:%s: Close : %p", + log_oom ("%s:%s: Close : %p", SRCNAME, __func__, m_mail); if (m_mail->isCryptoMail ()) { @@ -721,7 +721,7 @@ EVENT_SINK_INVOKE(MailItemEvents) return S_OK; } *(parms->rgvarg[0].pboolVal) = VARIANT_TRUE; - log_oom_extra ("%s:%s: Canceling close event.", + log_oom ("%s:%s: Canceling close event.", SRCNAME, __func__); if (Mail::close(m_mail)) { @@ -733,12 +733,12 @@ EVENT_SINK_INVOKE(MailItemEvents) } case Unload: { - log_oom_extra ("%s:%s: Unload : %p", + log_oom ("%s:%s: Unload : %p", SRCNAME, __func__, m_mail); log_debug ("%s:%s: Removing Mail for message: %p.", SRCNAME, __func__, m_object); delete m_mail; - log_oom_extra ("%s:%s: deletion done", + log_oom ("%s:%s: deletion done", SRCNAME, __func__); memdbg_dump (); return S_OK; @@ -751,7 +751,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case Forward: { - log_oom_extra ("%s:%s: %s : %p", + log_oom ("%s:%s: %s : %p", SRCNAME, __func__, is_reply ? "reply" : "forward", m_mail); int draft_flags = 0; if (opt.encrypt_default) @@ -867,7 +867,7 @@ EVENT_SINK_INVOKE(MailItemEvents) Mail::clearLastMail (); } - log_oom_extra ("%s:%s: Reply Forward ReplyAll: %p", + log_oom ("%s:%s: Reply Forward ReplyAll: %p", SRCNAME, __func__, m_mail); if (!opt.reply_crypt) { @@ -900,7 +900,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } case AttachmentRemove: { - log_oom_extra ("%s:%s: AttachmentRemove: %p", + log_oom ("%s:%s: AttachmentRemove: %p", SRCNAME, __func__, m_mail); if (!m_mail->isCryptoMail () || attachRemoveWarnShown || m_mail->attachmentRemoveWarningDisabled ()) @@ -917,7 +917,7 @@ EVENT_SINK_INVOKE(MailItemEvents) } default: - log_oom_extra ("%s:%s: Message:%p Unhandled Event: %lx \n", + log_oom ("%s:%s: Message:%p Unhandled Event: %lx \n", SRCNAME, __func__, m_object, dispid); } return S_OK; diff --git a/src/memdbg.h b/src/memdbg.h index aa4939d..ffbdae9 100644 --- a/src/memdbg.h +++ b/src/memdbg.h @@ -33,7 +33,7 @@ extern "C" { { \ if (X) \ { \ - log_oom_extra ("%s:%s:%i AddRef on %p", \ + log_oom ("%s:%s:%i AddRef on %p", \ SRCNAME, __func__, __LINE__, X); \ _memdbg_addRef (X, __func__); \ } \ diff --git a/src/oomhelp.cpp b/src/oomhelp.cpp index 2c162ab..143f13f 100644 --- a/src/oomhelp.cpp +++ b/src/oomhelp.cpp @@ -1595,7 +1595,7 @@ get_oom_base_message_from_mapi (LPDISPATCH mapi_message) /* The call to GetBaseMessage is pretty much a jump in the dark. So it would not be surprising to get crashes here in the future. */ - log_oom_extra("%s:%s: About to call GetBaseMessage.", + log_oom("%s:%s: About to call GetBaseMessage.", SRCNAME, __func__); hr = secureMessage->GetBaseMessage (&message); memdbg_addRef (message); diff --git a/src/windowmessages.cpp b/src/windowmessages.cpp index d239377..c6e585c 100644 --- a/src/windowmessages.cpp +++ b/src/windowmessages.cpp @@ -536,7 +536,7 @@ void blockInv() { invalidation_blocked++; - log_oom_extra ("%s:%s: Invalidation block count %i", + log_oom ("%s:%s: Invalidation block count %i", SRCNAME, __func__, invalidation_blocked); } @@ -544,7 +544,7 @@ void unblockInv() { invalidation_blocked--; - log_oom_extra ("%s:%s: Invalidation block count %i", + log_oom ("%s:%s: Invalidation block count %i", SRCNAME, __func__, invalidation_blocked); if (invalidation_blocked < 0) commit 177b72b8c33a2459e20695e01492573211c150f8 Author: Andre Heinecke Date: Mon Sep 24 10:56:40 2018 +0200 Add "Supertrace" macros * src/debug.h (TSTART, TRETURN, DBG_SUPERTRACE): New macros for a new super verbose tracing. diff --git a/src/debug.h b/src/debug.h index 36fafdc..523b540 100644 --- a/src/debug.h +++ b/src/debug.h @@ -55,6 +55,7 @@ extern "C" { #define DBG_DATA (DBG_MIME_PARSER | DBG_MIME_DATA) #define DBG_OOM_VAL (1<<9) // 512 Unified as DBG_OOM #define DBG_OOM_EXTRA (1<<10)// 1024 Unified as DBG_OOM +#define DBG_SUPERTRACE (1<<11)// 2048 Very verbose tracing. #define DBG_OOM (DBG_OOM_VAL | DBG_OOM_EXTRA) #define debug_oom ((opt.enable_debug & DBG_OOM) || \ @@ -95,6 +96,13 @@ const char *log_srcname (const char *s); #define TRACEPOINT log_debug ("%s:%s:%d: tracepoint\n", \ SRCNAME, __func__, __LINE__); +#define TSTART if (opt.enable_debug & DBG_SUPERTRACE) \ + log_debug ("%s:%s: enter\n", SRCNAME, __func__); +#define TRETURN(X) if (opt.enable_debug & DBG_SUPERTRACE) \ + log_debug ("%s:%s:%d: return\n", SRCNAME, __func__, \ + __LINE__); \ + return X + const char *get_log_file (void); void set_log_file (const char *name); commit 5156d7b1da1fd9463e9442f5e913b6b24c0a7b69 Author: Andre Heinecke Date: Mon Sep 24 10:02:13 2018 +0200 Log if logging fails * src/debug.cpp (lock_log): Do not wait infinite for log lock. (do_log): Log to debug output if obtaining the log lock failed. -- I do not see how this can fail. But still an infinite wait should be avoided and the failure handled at least with a short note. diff --git a/src/debug.cpp b/src/debug.cpp index 7f15550..b268e86 100644 --- a/src/debug.cpp +++ b/src/debug.cpp @@ -31,7 +31,7 @@ static FILE *logfp; static int lock_log (void) { - int code = WaitForSingleObject (log_mutex, INFINITE); + int code = WaitForSingleObject (log_mutex, 10000); return code != WAIT_OBJECT_0; } @@ -86,7 +86,10 @@ do_log (const char *fmt, va_list a, int w32err, int err, return; if (lock_log ()) - return; + { + OutputDebugStringA ("GpgOL: Failed to log."); + return; + } #endif if (!strcmp (logfile, "stdout")) ----------------------------------------------------------------------- Summary of changes: src/Makefile.am | 1 - src/application-events.cpp | 2 +- src/debug.cpp | 53 +++++++++++++++- src/debug.h | 13 +++- src/exechelp.c | 150 --------------------------------------------- src/exechelp.h | 51 --------------- src/explorer-events.cpp | 12 ++-- src/folder-events.cpp | 6 +- src/gpgoladdin.cpp | 2 +- src/mail.cpp | 26 ++++---- src/mailitem-events.cpp | 30 ++++----- src/memdbg.cpp | 10 +-- src/memdbg.h | 2 +- src/mimedataprovider.cpp | 8 +-- src/oomhelp.cpp | 2 +- src/windowmessages.cpp | 4 +- 16 files changed, 113 insertions(+), 259 deletions(-) delete mode 100644 src/exechelp.c delete mode 100644 src/exechelp.h hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 02:20:12 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Tue, 25 Sep 2018 02:20:12 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-305-gb625258 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via b625258d54782040195cc5ad3b255685af6f6c4e (commit) via 62e4e2cb5edb09183b9f9d448f992fe65cb6db85 (commit) via e9da4d97107b40a48583775df34783f07be5dfdb (commit) from b12b2cc99621fe32a2d698ce7f091f3225f35bd0 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b625258d54782040195cc5ad3b255685af6f6c4e Author: Ben McGinnes Date: Tue Sep 25 10:17:39 2018 +1000 docs: a typographical two-step * Sometimes you really do need or want punctuation in a heading, but ideally without something else generating whitespace and other annoyances to go with it. * Trying a real decimal point instead. Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 69ae959..bc120d6 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -43,7 +43,7 @@ Introduction What's New -* New in GPGME 1.12.0: New in GPGME 1120. +* New in GPGME 1?12?0:: GPGME Concepts @@ -235,11 +235,11 @@ all the other things which spurred the need for adding this section and its subsections. @menu -* New in GPGME 1.12.0: New in GPGME 1120. +* New in GPGME 1?12?0:: @end menu - at node New in GPGME 1120 - at subsection New in GPGME 1.12.0 + at node New in GPGME 1?12?0 + at subsection New in GPGME 1?12?0 There have been quite a number of additions to GPGME and the Python bindings to it since the last release of GPGME with versions 1.11.0 diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 90e133b..b54662c 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -82,7 +82,7 @@ section on other new things, but that's hardly important. Not given all the other things which spurred the need for adding this section and its subsections. -*** New in GPGME 1.12.0 +*** New in GPGME 1?12?0 :PROPERTIES: :CUSTOM_ID: new-stuff-1-12-0 :END: commit 62e4e2cb5edb09183b9f9d448f992fe65cb6db85 Author: Ben McGinnes Date: Tue Sep 25 09:59:31 2018 +1000 docs and examples: python bindings * Woumd up the "what's new" section. * Added an example for sending a key to the keyservers via hkp4py. * Updated the export key code to use a more complete check for the $GNUPGHOME location. * Expanded on the installation and reinstallation troubleshooting section. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 2e13d87..69ae959 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -64,6 +64,10 @@ GPGME Python bindings installation * Installation:: * Known Issues:: +Requirements + +* Recommended Additions:: + Installation * Installing GPGME:: @@ -71,6 +75,7 @@ Installation Known Issues * Breaking Builds:: +* Reinstalling Responsibly:: * Multiple installations:: * Won't Work With Windows:: * CFFI is the Best? and GPGME should use it instead of SWIG:: @@ -101,6 +106,7 @@ Exporting keys * Exporting public keys:: * Exporting secret keys:: +* Sending public keys to the SKS Keyservers:: Basic Functions @@ -445,7 +451,8 @@ The GPGME Python bindings only have three requirements: @enumerate @item A suitable version of Python 2 or Python 3. With Python 2 that -means Python 2.7 and with Python 3 that means Python 3.4 or higher. +means CPython 2.7 and with Python 3 that means CPython 3.4 or +higher. @item @uref{https://www.swig.org, SWIG}. @item @@ -453,6 +460,33 @@ GPGME itself. Which also means that all of GPGME's dependencies must be installed too. @end enumerate + at menu +* Recommended Additions:: + at end menu + + at node Recommended Additions + at subsection Recommended Additions + +Though none of the following are absolute requirements, they are all +recommended for use with the Python bindings. In some cases these +recommendations refer to which version(s) of CPython to use the +bindings with, while others refer to third party modules which provide +a significant advantage in some way. + + at enumerate + at item +If possible, use Python 3 instead of 2. + at item +Favour a more recent version of Python since even 3.4 is due to +reach EOL soon. In production systems and services, Python 3.6 +should be robust enough to be relied on. + at item +If possible add the following Python modules which are not part of +the standard library: @uref{http://docs.python-requests.org/en/latest/index.html, Requests}, @uref{http://cython.org/, Cython} and @uref{https://github.com/Selfnet/hkp4py, hkp4py}. Chances are +quite high that at least the first one and maybe two of those will +already be installed. + at end enumerate + @node Installation @section Installation @@ -495,6 +529,7 @@ they be encountered. @menu * Breaking Builds:: +* Reinstalling Responsibly:: * Multiple installations:: * Won't Work With Windows:: * CFFI is the Best? and GPGME should use it instead of SWIG:: @@ -559,10 +594,34 @@ If Python is set to precede one of the other languages then it is possible that the errors described here may interrupt the build process before generating bindings for those other languages. In these cases it may be preferable to configure all preferred language -howto-export-public-keybindings separately with alternative @samp{configure} steps for GPGME using +bindings separately with alternative @samp{configure} steps for GPGME using the @samp{--enable-languages=$LANGUAGE} option. @end enumerate + at node Reinstalling Responsibly + at subsection Reinstalling Responsibly + +Regardless of whether you're installing for one version of Python or +several, there will come a point where reinstallation is required. +With most Python module installations, the installed files go into the +relevant site-packages directory and are then forgotten about. Then +the module is upgraded, the new files are copied over the old and +that's the end of the matter. + +While the same is true of these bindings, there have been intermittent +issues observed on some platforms which have benefited significantly +from removing all the previous installations of the bindings before +installing the updated versions. + +Removing the previous version(s) is simply a matter of changing to the +relevant @samp{site-packages} directory for the version of Python in +question and removing the @samp{gpg/} directory and any accompanying +egg-info files for that module. + +In most cases this will require root or administration privileges on +the system, but the same is true of installing the module in the first +place. + @node Multiple installations @subsection Multiple installations @@ -1427,6 +1486,7 @@ third is for exporting secret keys. @menu * Exporting public keys:: * Exporting secret keys:: +* Sending public keys to the SKS Keyservers:: @end menu @node Exporting public keys @@ -1586,12 +1646,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass @@ -1656,12 +1730,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass @@ -1712,6 +1800,70 @@ else: pass @end example + at node Sending public keys to the SKS Keyservers + at subsection Sending public keys to the SKS Keyservers + +As with the previous section on importing keys, the @samp{hkp4py} module +adds another option with exporting keys in order to send them to the +public keyservers. + +The following example demonstrates how this may be done. + + at example +import gpg +import hkp4py +import os.path +import sys + +print(""" +This script sends one or more public keys to the SKS keyservers and is +essentially a slight variation on the export-key.py script. +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") + +if len(sys.argv) > 2: + logrus = " ".join(sys.argv[1:]) +elif len(sys.argv) == 2: + logrus = sys.argv[1] +else: + logrus = input("Enter the UID matching the key(s) to send: ") + +if len(logrus) > 0: + try: + export_result = c.key_export(pattern=logrus) + except Exception as e: + print(e) + export_result = None +else: + export_result = c.key_export(pattern=None) + +if export_result is not None: + try: + try: + send_result = server.add(export_result) + except: + send_result = server.add(export_result.decode()) + if send_result is not None: + print(send_result) + else: + pass + except Exception as e: + print(e) +else: + pass + at end example + +An expanded version of this script with additional functions for +specifying an alternative homedir location is in the examples +directory as @samp{send-key-to-keyserver.py}. + +The @samp{hkp4py} module appears to handle both string and byte literal text +data equally well, but the GPGME bindings deal primarily with byte +literal data only and so this script sends in that format first, then +tries the string literal form. + @node Basic Functions @chapter Basic Functions diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 6c599cb..90e133b 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -293,12 +293,34 @@ section for further details. The GPGME Python bindings only have three requirements: 1. A suitable version of Python 2 or Python 3. With Python 2 that - means Python 2.7 and with Python 3 that means Python 3.4 or higher. + means CPython 2.7 and with Python 3 that means CPython 3.4 or + higher. 2. [[https://www.swig.org][SWIG]]. 3. GPGME itself. Which also means that all of GPGME's dependencies must be installed too. +*** Recommended Additions + :PROPERTIES: + :CUSTOM_ID: gpgme-python-recommendations + :END: + +Though none of the following are absolute requirements, they are all +recommended for use with the Python bindings. In some cases these +recommendations refer to which version(s) of CPython to use the +bindings with, while others refer to third party modules which provide +a significant advantage in some way. + +1. If possible, use Python 3 instead of 2. +2. Favour a more recent version of Python since even 3.4 is due to + reach EOL soon. In production systems and services, Python 3.6 + should be robust enough to be relied on. +3. If possible add the following Python modules which are not part of + the standard library: [[http://docs.python-requests.org/en/latest/index.html][Requests]], [[http://cython.org/][Cython]] and [[https://github.com/Selfnet/hkp4py][hkp4py]]. Chances are + quite high that at least the first one and maybe two of those will + already be installed. + + ** Installation :PROPERTIES: :CUSTOM_ID: installation @@ -398,10 +420,37 @@ If Python is set to precede one of the other languages then it is possible that the errors described here may interrupt the build process before generating bindings for those other languages. In these cases it may be preferable to configure all preferred language -howto-export-public-keybindings separately with alternative =configure= steps for GPGME using +bindings separately with alternative =configure= steps for GPGME using the =--enable-languages=$LANGUAGE= option. +*** Reinstalling Responsibly + :PROPERTIES: + :CUSTOM_ID: snafu-lessons-for-the-lazy + :END: + +Regardless of whether you're installing for one version of Python or +several, there will come a point where reinstallation is required. +With most Python module installations, the installed files go into the +relevant site-packages directory and are then forgotten about. Then +the module is upgraded, the new files are copied over the old and +that's the end of the matter. + +While the same is true of these bindings, there have been intermittent +issues observed on some platforms which have benefited significantly +from removing all the previous installations of the bindings before +installing the updated versions. + +Removing the previous version(s) is simply a matter of changing to the +relevant =site-packages= directory for the version of Python in +question and removing the =gpg/= directory and any accompanying +egg-info files for that module. + +In most cases this will require root or administration privileges on +the system, but the same is true of installing the module in the first +place. + + *** Multiple installations :PROPERTIES: :CUSTOM_ID: snafu-the-full-monty @@ -1446,12 +1495,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass @@ -1516,12 +1579,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass @@ -1573,6 +1650,73 @@ else: #+END_SRC +*** Sending public keys to the SKS Keyservers + :PROPERTIES: + :CUSTOM_ID: howto-send-public-key + :END: + +As with the previous section on importing keys, the =hkp4py= module +adds another option with exporting keys in order to send them to the +public keyservers. + +The following example demonstrates how this may be done. + +#+BEGIN_SRC python -i +import gpg +import hkp4py +import os.path +import sys + +print(""" +This script sends one or more public keys to the SKS keyservers and is +essentially a slight variation on the export-key.py script. +""") + +c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") + +if len(sys.argv) > 2: + logrus = " ".join(sys.argv[1:]) +elif len(sys.argv) == 2: + logrus = sys.argv[1] +else: + logrus = input("Enter the UID matching the key(s) to send: ") + +if len(logrus) > 0: + try: + export_result = c.key_export(pattern=logrus) + except Exception as e: + print(e) + export_result = None +else: + export_result = c.key_export(pattern=None) + +if export_result is not None: + try: + try: + send_result = server.add(export_result) + except: + send_result = server.add(export_result.decode()) + if send_result is not None: + print(send_result) + else: + pass + except Exception as e: + print(e) +else: + pass +#+END_SRC + +An expanded version of this script with additional functions for +specifying an alternative homedir location is in the examples +directory as =send-key-to-keyserver.py=. + +The =hkp4py= module appears to handle both string and byte literal text +data equally well, but the GPGME bindings deal primarily with byte +literal data only and so this script sends in that format first, then +tries the string literal form. + + * Basic Functions :PROPERTIES: :CUSTOM_ID: howto-the-basics diff --git a/lang/python/examples/howto/export-key.py b/lang/python/examples/howto/export-key.py index 80768fe..c17f247 100755 --- a/lang/python/examples/howto/export-key.py +++ b/lang/python/examples/howto/export-key.py @@ -51,12 +51,26 @@ else: logrus = input("Enter the UID matching the key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass diff --git a/lang/python/examples/howto/export-minimised-key.py b/lang/python/examples/howto/export-minimised-key.py index 9d5f848..a5a453c 100755 --- a/lang/python/examples/howto/export-minimised-key.py +++ b/lang/python/examples/howto/export-minimised-key.py @@ -51,12 +51,26 @@ else: logrus = input("Enter the UID matching the key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass diff --git a/lang/python/examples/howto/export-secret-key.py b/lang/python/examples/howto/export-secret-key.py index ccc9f45..e7d4e3a 100755 --- a/lang/python/examples/howto/export-secret-key.py +++ b/lang/python/examples/howto/export-secret-key.py @@ -54,12 +54,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass diff --git a/lang/python/examples/howto/export-secret-keys.py b/lang/python/examples/howto/export-secret-keys.py index f2f1ccd..f0fddc6 100755 --- a/lang/python/examples/howto/export-secret-keys.py +++ b/lang/python/examples/howto/export-secret-keys.py @@ -63,12 +63,26 @@ else: logrus = input("Enter the UID matching the secret key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass diff --git a/lang/python/examples/howto/export-key.py b/lang/python/examples/howto/send-key-to-keyserver.py similarity index 53% copy from lang/python/examples/howto/export-key.py copy to lang/python/examples/howto/send-key-to-keyserver.py index 80768fe..3541b19 100755 --- a/lang/python/examples/howto/export-key.py +++ b/lang/python/examples/howto/send-key-to-keyserver.py @@ -4,6 +4,7 @@ from __future__ import absolute_import, division, unicode_literals import gpg +import hkp4py import os.path import sys @@ -29,45 +30,69 @@ import sys # . print(""" -This script exports one or more public keys. +This script sends one or more public keys to the SKS keyservers and is +essentially a slight variation on the export-key.py script. + +The default is to send all keys if there is no pattern or search term. """) c = gpg.Context(armor=True) +server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net") -if len(sys.argv) >= 4: - keyfile = sys.argv[1] - logrus = sys.argv[2] - homedir = sys.argv[3] -elif len(sys.argv) == 3: - keyfile = sys.argv[1] - logrus = sys.argv[2] - homedir = input("Enter the GPG configuration directory path (optional): ") +if len(sys.argv) >= 3: + logrus = sys.argv[1] + homedir = sys.argv[2] elif len(sys.argv) == 2: - keyfile = sys.argv[1] - logrus = input("Enter the UID matching the key(s) to export: ") + logrus = sys.argv[1] homedir = input("Enter the GPG configuration directory path (optional): ") else: - keyfile = input("Enter the path and filename to save the key(s) to: ") logrus = input("Enter the UID matching the key(s) to export: ") homedir = input("Enter the GPG configuration directory path (optional): ") -if homedir.startswith("~"): - if os.path.exists(os.path.expanduser(homedir)) is True: - c.home_dir = os.path.expanduser(homedir) +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if os.path.exists(homedir) is False: + homedir = None +else: + if os.path.isdir(homedir) is False: + homedir = None else: pass -elif os.path.exists(homedir) is True: + +if homedir is not None: c.home_dir = homedir else: pass -try: - result = c.key_export(pattern=logrus) -except: - result = c.key_export(pattern=None) +if len(logrus) > 0: + try: + export_result = c.key_export(pattern=logrus) + except Exception as e: + print(e) + export_result = None +else: + export_result = c.key_export(pattern=None) -if result is not None: - with open(keyfile, "wb") as f: - f.write(result) +if export_result is not None: + try: + try: + send_result = server.add(export_result) + except: + send_result = server.add(export_result.decode()) + if send_result is not None: + print(send_result) + else: + pass + except Exception as e: + print(e) else: pass commit e9da4d97107b40a48583775df34783f07be5dfdb Author: Ben McGinnes Date: Tue Sep 25 04:32:13 2018 +1000 docs: python bindings howto * Added a What's New section to summarise changes since the last release. There have been quite a few and some attention does need to be drawn to some of them. * Confirming certain issues with some platform builds, especially BSD/OSX vs. Linux issues which will need to update the installation troubleshooting guides. diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index 2e30597..2e13d87 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -39,6 +39,11 @@ Introduction * Python 2 versus Python 3:: * Examples:: * Unofficial Drafts:: +* What's New:: + +What's New + +* New in GPGME 1.12.0: New in GPGME 1120. GPGME Concepts @@ -175,6 +180,7 @@ Python bindings to programmatically leverage the GPGME library. * Python 2 versus Python 3:: * Examples:: * Unofficial Drafts:: +* What's New:: @end menu @node Python 2 versus Python 3 @@ -214,6 +220,80 @@ on locations to read or download @ref{Draft Editions of this HOWTO, , draft edit at the end of it. These are unofficial versions produced in between major releases. + at node What's New + at section What's New + +The most obviously new point for those reading this guide is this +section on other new things, but that's hardly important. Not given +all the other things which spurred the need for adding this section +and its subsections. + + at menu +* New in GPGME 1.12.0: New in GPGME 1120. + at end menu + + at node New in GPGME 1120 + at subsection New in GPGME 1.12.0 + +There have been quite a number of additions to GPGME and the Python +bindings to it since the last release of GPGME with versions 1.11.0 +and 1.11.1 in April, 2018. + +The bullet points of new additiions are: + + at itemize + at item +an expanded section on @ref{Installation, , installing} and @ref{Known Issues, , troubleshooting} the Python +bindings. + at item +The release of Python 3.7.0; which appears to be working just fine +with our bindings, in spite of intermittent reports of problems for +many other Python projects with that new release. + at item +In order to fix some other issues, there are certain underlying +functions which are more exposed through the @ref{Context, , gpg.Context()}, but +ongoing documentation ought to clarify that or otherwise provide the +best means of using the bindings. Some additions to @samp{gpg.core} and +the @samp{Context()}, however, were intended (see below). + at item +Continuing work in identifying and confirming the cause of +oft-reported @ref{Won't Work With Windows, , problems installing the Python bindings on Windows}. + at item +GSOC: Google's Surreptitiously Ordered Conscription @dots{} erm @dots{} oh, +right; Google's Summer of Code. Though there were two hopeful +candidates this year; only one ended up involved with the GnuPG +Project directly, the other concentrated on an unrelated third party +project with closer ties to one of the GNU/Linux distributions than +to the GnuPG Project. Thus the Python bindings benefited from GSOC +participant Jacob Adams, who added the key at math{_import} function; building +on prior work by Tobias Mueller. + at item +Several new methods functions were added to the gpg.Context(), +including: @ref{Importing keys, , key at math{_import}}, @ref{Exporting keys, , key at math{_export}}, @ref{Exporting public keys, , key at math{_export}@math{_minimal}} and + at ref{Exporting secret keys, , key at math{_export}@math{_secret}}. + at item +Importing and exporting examples include versions integrated with +Marcel Fest's recently released @uref{https://github.com/Selfnet/hkp4py, HKP for Python} module. Some + at ref{Keyserver access for Python, , additional notes on this module} are included at the end of the HOWTO. + at item +Instructions for dealing with semi-walled garden implementations +like ProtonMail are also included. This is intended to make things +a little easier when communicating with users of ProtonMail's +services and should not be construed as an endorsement of said +service. The GnuPG Project neither favours, nor disfavours +ProtonMail and the majority of this deals with interacting with the +ProtonMail keyserver. + at item +Semi-formalised the location where @ref{Draft Editions of this HOWTO, , draft versions} of this HOWTO may +periodically be accessible. This is both for the reference of +others and testing the publishing of the document itself. + at item +Added a new section for @ref{Advanced or Experimental Use Cases, , advanced or experimental use}. + at item +Began the advanced use cases with @ref{C plus Python plus SWIG plus Cython, , a section} on using the module with + at uref{http://cython.org/, Cython}. + at end itemize + @node GPGME Concepts @chapter GPGME Concepts @@ -479,7 +559,7 @@ If Python is set to precede one of the other languages then it is possible that the errors described here may interrupt the build process before generating bindings for those other languages. In these cases it may be preferable to configure all preferred language -bindings separately with alternative @samp{configure} steps for GPGME using +howto-export-public-keybindings separately with alternative @samp{configure} steps for GPGME using the @samp{--enable-languages=$LANGUAGE} option. @end enumerate @@ -2673,7 +2753,11 @@ support for Python 2.7 as well and is available via PyPI. Since it rewrites the @samp{hkp} protocol prefix as @samp{http} and @samp{hkps} as @samp{https}, the module is able to be used even with servers which do not -support the full scope of keyserver functions. It also works quite +support the full scope of keyserver functions. at footnote{Such as with ProtonMail servers. This also means that +restricted servers which only advertise either HTTP or HTTPS end +points and not HKP or HKPS end points must still be identified as as +HKP or HKPS within the Python Code. The @samp{hkp4py} module will rewrite +these appropriately when the connection is made to the server.} It also works quite readily when incorporated into a @ref{C plus Python plus SWIG plus Cython, , Cython} generated and compiled version of any code. diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 2f6ce73..6c599cb 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -72,6 +72,68 @@ at the end of it. These are unofficial versions produced in between major releases. +** What's New + :PROPERTIES: + :CUSTOM_ID: new-stuff + :END: + +The most obviously new point for those reading this guide is this +section on other new things, but that's hardly important. Not given +all the other things which spurred the need for adding this section +and its subsections. + +*** New in GPGME 1.12.0 + :PROPERTIES: + :CUSTOM_ID: new-stuff-1-12-0 + :END: + +There have been quite a number of additions to GPGME and the Python +bindings to it since the last release of GPGME with versions 1.11.0 +and 1.11.1 in April, 2018. + +The bullet points of new additiions are: + +- an expanded section on [[#installation][installing]] and [[#snafu][troubleshooting]] the Python + bindings. +- The release of Python 3.7.0; which appears to be working just fine + with our bindings, in spite of intermittent reports of problems for + many other Python projects with that new release. +- In order to fix some other issues, there are certain underlying + functions which are more exposed through the [[#howto-get-context][gpg.Context()]], but + ongoing documentation ought to clarify that or otherwise provide the + best means of using the bindings. Some additions to =gpg.core= and + the =Context()=, however, were intended (see below). +- Continuing work in identifying and confirming the cause of + oft-reported [[#snafu-runtime-not-funtime][problems installing the Python bindings on Windows]]. +- GSOC: Google's Surreptitiously Ordered Conscription ... erm ... oh, + right; Google's Summer of Code. Though there were two hopeful + candidates this year; only one ended up involved with the GnuPG + Project directly, the other concentrated on an unrelated third party + project with closer ties to one of the GNU/Linux distributions than + to the GnuPG Project. Thus the Python bindings benefited from GSOC + participant Jacob Adams, who added the key_import function; building + on prior work by Tobias Mueller. +- Several new methods functions were added to the gpg.Context(), + including: [[#howto-import-key][key_import]], [[#howto-export-key][key_export]], [[#howto-export-public-key][key_export_minimal]] and + [[#howto-export-secret-key][key_export_secret]]. +- Importing and exporting examples include versions integrated with + Marcel Fest's recently released [[https://github.com/Selfnet/hkp4py][HKP for Python]] module. Some + [[#hkp4py][additional notes on this module]] are included at the end of the HOWTO. +- Instructions for dealing with semi-walled garden implementations + like ProtonMail are also included. This is intended to make things + a little easier when communicating with users of ProtonMail's + services and should not be construed as an endorsement of said + service. The GnuPG Project neither favours, nor disfavours + ProtonMail and the majority of this deals with interacting with the + ProtonMail keyserver. +- Semi-formalised the location where [[#draft-editions][draft versions]] of this HOWTO may + periodically be accessible. This is both for the reference of + others and testing the publishing of the document itself. +- Added a new section for [[#advanced-use][advanced or experimental use]]. +- Began the advanced use cases with [[#cython][a section]] on using the module with + [[http://cython.org/][Cython]]. + + * GPGME Concepts :PROPERTIES: :CUSTOM_ID: gpgme-concepts @@ -336,7 +398,7 @@ If Python is set to precede one of the other languages then it is possible that the errors described here may interrupt the build process before generating bindings for those other languages. In these cases it may be preferable to configure all preferred language -bindings separately with alternative =configure= steps for GPGME using +howto-export-public-keybindings separately with alternative =configure= steps for GPGME using the =--enable-languages=$LANGUAGE= option. @@ -2577,7 +2639,7 @@ support for Python 2.7 as well and is available via PyPI. Since it rewrites the =hkp= protocol prefix as =http= and =hkps= as =https=, the module is able to be used even with servers which do not -support the full scope of keyserver functions. It also works quite +support the full scope of keyserver functions.[fn:6] It also works quite readily when incorporated into a [[#cython][Cython]] generated and compiled version of any code. @@ -2704,3 +2766,9 @@ POSIX systems which utilise single user mode (some even require it). keyservers for "gnupg.org" produces over 400 results, the majority of which aren't actually at the gnupg.org domain, but just included a comment regarding the project in their key somewhere. + +[fn:6] Such as with ProtonMail servers. This also means that +restricted servers which only advertise either HTTP or HTTPS end +points and not HKP or HKPS end points must still be identified as as +HKP or HKPS within the Python Code. The =hkp4py= module will rewrite +these appropriately when the connection is made to the server. ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 256 ++++++++++++++++++++- lang/python/docs/gpgme-python-howto.org | 232 ++++++++++++++++++- lang/python/examples/howto/export-key.py | 22 +- lang/python/examples/howto/export-minimised-key.py | 22 +- lang/python/examples/howto/export-secret-key.py | 22 +- lang/python/examples/howto/export-secret-keys.py | 22 +- .../{export-key.py => send-key-to-keyserver.py} | 71 ++++-- 7 files changed, 588 insertions(+), 59 deletions(-) copy lang/python/examples/howto/{export-key.py => send-key-to-keyserver.py} (53%) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 08:16:16 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Tue, 25 Sep 2018 08:16:16 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-46-gb1199e9 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via b1199e9388f57044b60b1697e57ca3e267dd90c8 (commit) via cb7ce6e0a1496449c5ed157ad93dff8f78e1bd5f (commit) from e6e52c45b0d51becc2428d0b076ba3de20fce79a (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b1199e9388f57044b60b1697e57ca3e267dd90c8 Merge: e6e52c4 cb7ce6e Author: Andre Heinecke Date: Tue Sep 25 08:16:03 2018 +0200 Merge remote-tracking branch 'dutch-l10n/dutch' commit cb7ce6e0a1496449c5ed157ad93dff8f78e1bd5f Author: Erwin Bronkhorst Date: Wed Sep 19 23:00:54 2018 +0200 Update Dutch translations diff --git a/po/nl.po b/po/nl.po index 16efa62..44fd312 100644 --- a/po/nl.po +++ b/po/nl.po @@ -8,8 +8,8 @@ msgid "" msgstr "" "Project-Id-Version: GpgOL 2.1.1\n" "Report-Msgid-Bugs-To: bug-gpgol at g10code.com\n" -"POT-Creation-Date: 2018-08-30 14:56+0200\n" -"PO-Revision-Date: 2018-08-30 15:00+0100\n" +"POT-Creation-Date: 2018-09-19 22:49+0200\n" +"PO-Revision-Date: 2018-09-19 23:00+0200\n" "Last-Translator: aheinecke \n" "Language-Team: English \n" "Language: nl\n" @@ -17,7 +17,7 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" -"X-Generator: Lokalize 2.0\n" +"X-Generator: Poedit 1.8.11\n" #: src/addin-options.cpp:39 msgid "GnuPG System" @@ -27,7 +27,7 @@ msgstr "GnuPG-systeem" msgid "Enable the S/MIME support" msgstr "S/MIME-ondersteuning inschakelen" -#: src/addin-options.cpp:41 src/addin-options.cpp:149 +#: src/addin-options.cpp:41 src/addin-options.cpp:189 msgid "Configure GpgOL" msgstr "GnuPG configureren" @@ -140,39 +140,127 @@ msgstr "" "Dit kan nodig zijn voor compatibiliteit, maar zou in het algemeen niet meer " "gebruikt moeten worden." +#. TRANSLATORS: Part of address book key configuration dialog. +#. The contacts name follows. +#: src/addin-options.cpp:77 +msgid "Configure key for:" +msgstr "Sleutel configureren voor:" + +#. TRANSLATORS: Part of address book key configuration dialog. +#. An example for a public key follows. +#: src/addin-options.cpp:80 +msgid "Paste a public key export here. It should look like:" +msgstr "" +"Plak hier een ge?xporteerde publieke sleutel. Die zou er zo uit moeten zien:" + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:82 +msgid "Failed to parse any public key." +msgstr "Er kon geen enkele publieke sleutel worden ontleed." + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:84 +msgid "Error" +msgstr "Fout" + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:86 +msgid "Secret key detected." +msgstr "Geheime sleutel gedetecteerd." + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:88 +msgid "" +"You can only configure public keys in Outlook. Import secret keys with " +"Kleopatra." +msgstr "" +"U kunt alleen publieke sleutels in Outlook configureren. Importeer geheime " +"sleutels met Kleopatra." + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:91 +msgid "" +"The key is unusable for Outlook. Please check Kleopatra for more information." +msgstr "" +"De sleutel is onbruikbaar voor Outlook. Raadpleeg Kleopatra voor meer " +"informatie." + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:94 +msgid "Invalid key detected." +msgstr "Ongeldige sleutel gedetecteerd." + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:96 +msgid "Created:" +msgstr "Aangemaakt:" + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:98 +msgid "User Ids:" +msgstr "Gebruikers-id's:" + +#. TRANSLATORS: Part of address book key configuration dialog. %1 is +#. a placeholder for the plual for key / keys. +#: src/addin-options.cpp:101 +msgid "You are about to configure the following %1 for:" +msgstr "U staat op het punt om de volgende %1 te configureren voor:" + +#. TRANSLATORS: Part of address book key configuration dialog. +#. used in a sentence as plural form. +#: src/addin-options.cpp:104 +msgid "keys" +msgstr "sleutels" + +#. TRANSLATORS: Part of address book key configuration dialog. +#. used in a sentence as singular form. +#: src/addin-options.cpp:107 +msgid "key" +msgstr "sleutel" + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:109 +msgid "Continue?" +msgstr "Doorgaan?" + +#. TRANSLATORS: Part of address book key configuration dialog. +#: src/addin-options.cpp:111 +msgid "Confirm keys" +msgstr "Sleutels bevestigen" + #: src/common.cpp:768 msgid "GpgOL Error" msgstr "GpgOL Fout" -#: src/gpgoladdin.cpp:517 src/mail.cpp:2092 src/mail.cpp:2163 +#: src/gpgoladdin.cpp:515 src/mail.cpp:2085 src/mail.cpp:2156 msgid "GpgOL: Encrypted Message" msgstr "GpgOL: Versleuteld bericht" -#: src/gpgoladdin.cpp:518 src/mail.cpp:2093 src/mail.cpp:2164 +#: src/gpgoladdin.cpp:516 src/mail.cpp:2086 src/mail.cpp:2157 msgid "GpgOL: Trusted Sender Address" msgstr "GpgOL: Vertrouwd Afzenderadres" -#: src/gpgoladdin.cpp:846 +#: src/gpgoladdin.cpp:847 msgid "Encrypt the message" msgstr "Het bericht versleutelen" -#: src/gpgoladdin.cpp:848 +#: src/gpgoladdin.cpp:849 msgid "Encrypts the message and all attachments before sending" msgstr "Versleutelt het bericht en alle bijlagen voor verzending" -#: src/gpgoladdin.cpp:850 +#: src/gpgoladdin.cpp:851 msgid "Sign the message" msgstr "Het bericht ondertekenen" -#: src/gpgoladdin.cpp:852 +#: src/gpgoladdin.cpp:853 msgid "Sign the message and all attachments before sending" msgstr "Het bericht en alle bijlagen ondertekenen voor verzending" -#: src/gpgoladdin.cpp:855 +#: src/gpgoladdin.cpp:856 msgid "Sign and encrypt the message" msgstr "Het bericht ondertekenen en versleutelen" -#: src/gpgoladdin.cpp:857 +#: src/gpgoladdin.cpp:858 msgid "" "Encrypting and cryptographically signing a message means that the recipients " "can be sure that no one modified the message and only the recipients can " @@ -182,37 +270,55 @@ msgstr "" "de ontvangers er zeker van kunnen zijn dat niemand het bericht heeft " "aangepast en dat alleen de ontvangers het kunnen lezen" -#: src/gpgoladdin.cpp:861 +#: src/gpgoladdin.cpp:862 msgid "Open the settings dialog for GpgOL" msgstr "Het instellingen-scherm voor GpgOL openen" -#: src/gpgoladdin.cpp:910 src/gpgoladdin.cpp:945 src/gpgoladdin.cpp:1029 -#: src/gpgoladdin.cpp:1031 src/gpgoladdin.cpp:1068 src/gpgoladdin.cpp:1172 -#: src/mail.cpp:910 src/mail.cpp:1216 src/mail.cpp:1285 src/mail.cpp:1869 -#: src/mailitem-events.cpp:840 src/mailitem-events.cpp:859 -#: src/ribbon-callbacks.cpp:691 src/ribbon-callbacks.cpp:702 -#: src/ribbon-callbacks.cpp:754 src/wks-helper.cpp:454 -#: src/cryptcontroller.cpp:308 +#: src/gpgoladdin.cpp:911 src/gpgoladdin.cpp:946 src/gpgoladdin.cpp:1030 +#: src/gpgoladdin.cpp:1032 src/gpgoladdin.cpp:1069 src/gpgoladdin.cpp:1100 +#: src/gpgoladdin.cpp:1225 src/mail.cpp:912 src/mail.cpp:1218 src/mail.cpp:1287 +#: src/mailitem-events.cpp:842 src/mailitem-events.cpp:861 +#: src/ribbon-callbacks.cpp:699 src/ribbon-callbacks.cpp:710 +#: src/ribbon-callbacks.cpp:762 src/wks-helper.cpp:454 +#: src/cryptcontroller.cpp:308 src/cryptcontroller.cpp:435 msgid "GpgOL" msgstr "GpgOL" -#: src/gpgoladdin.cpp:911 src/gpgoladdin.cpp:1032 +#: src/gpgoladdin.cpp:912 src/gpgoladdin.cpp:1033 msgid "Secure" msgstr "Beveiligen" -#: src/gpgoladdin.cpp:912 src/gpgoladdin.cpp:1033 +#: src/gpgoladdin.cpp:913 src/gpgoladdin.cpp:1034 msgid "Sign" msgstr "Ondertekenen" -#: src/gpgoladdin.cpp:913 src/gpgoladdin.cpp:1034 +#: src/gpgoladdin.cpp:914 src/gpgoladdin.cpp:1035 msgid "Encrypt" msgstr "Versleutelen" -#: src/gpgoladdin.cpp:1036 +#: src/gpgoladdin.cpp:1037 msgid "&Print decrypted" msgstr "Ontcijferd afdrukken" -#: src/mail.cpp:367 +#: src/gpgoladdin.cpp:1101 +msgid "OpenPGP Key" +msgstr "OpenPGP-sleutel" + +#. TRANSLATORS: Tooltip caption +#: src/gpgoladdin.cpp:1103 +msgid "Configure the OpenPGP key for this contact." +msgstr "De OpenPGP-sleutel voor dit contact configureren." + +#. TRANSLATORS: Tooltip content +#: src/gpgoladdin.cpp:1105 +msgid "" +"The configured key or keys will be used for this contact even if they are " +"not certified." +msgstr "" +"De geconfigureerde sleutel of sleutels worden gebruikt voor dit contact, ook " +"al zijn ze niet gecertificeerd." + +#: src/mail.cpp:369 msgid "" "Not all attachments were encrypted or signed.\n" "The unsigned / unencrypted attachments are:\n" @@ -222,7 +328,7 @@ msgstr "" "De niet-versleutelde/ondertekende bijlagen zijn:\n" "\n" -#: src/mail.cpp:372 +#: src/mail.cpp:374 msgid "" "Not all attachments were signed.\n" "The unsigned attachments are:\n" @@ -232,7 +338,7 @@ msgstr "" "De niet-ondertekende bijlagen zijn:\n" "\n" -#: src/mail.cpp:377 +#: src/mail.cpp:379 msgid "" "Not all attachments were encrypted.\n" "The unencrypted attachments are:\n" @@ -242,7 +348,7 @@ msgstr "" "De niet-versleutelde bijlagen zijn:\n" "\n" -#: src/mail.cpp:417 +#: src/mail.cpp:419 msgid "" "Note: The attachments may be encrypted or signed on a file level but the " "GpgOL status does not apply to them." @@ -250,11 +356,11 @@ msgstr "" "Let op: De bijlagen zouden op bestands-niveau versleuteld of ondertekend " "kunnen zijn, maar de GpgOL-status is daarop niet van toepassing." -#: src/mail.cpp:420 +#: src/mail.cpp:422 msgid "GpgOL Warning" msgstr "GpgOL Waarschuwing" -#: src/mail.cpp:907 +#: src/mail.cpp:909 #, c-format msgid "" "Crypto operation failed:\n" @@ -263,11 +369,11 @@ msgstr "" "Crypto-bewerking mislukt:\n" "(%s)" -#: src/mail.cpp:1009 +#: src/mail.cpp:1011 msgid "Pubkey directory confirmation" msgstr "Bevestiging van map publieke sleutel" -#: src/mail.cpp:1010 +#: src/mail.cpp:1012 msgid "" "This is a confirmation request to publish your Pubkey in the directory for " "your domain.\n" @@ -281,31 +387,31 @@ msgstr "" "

Als u niet heeft verzocht om uw publieke sleutel in de map van uw " "provider te publiceren, negeer dan dit bericht.

\n" -#: src/mail.cpp:1018 +#: src/mail.cpp:1020 msgid "message" msgstr "bericht" -#: src/mail.cpp:1019 +#: src/mail.cpp:1021 msgid "Please wait while the message is being decrypted / verified..." msgstr "Een moment geduld voordat het bericht is ontcijferd / geverifieerd..." -#: src/mail.cpp:1217 src/mail.cpp:1286 +#: src/mail.cpp:1219 src/mail.cpp:1288 msgid "HTML display disabled." msgstr "Weergave van HTML uitgeschakeld." -#: src/mail.cpp:1218 src/mail.cpp:1287 +#: src/mail.cpp:1220 src/mail.cpp:1289 msgid "HTML content in unsigned S/MIME mails is insecure." msgstr "HTML-inhoud in niet-ondertekende S/MIME e-mail is onveilig." -#: src/mail.cpp:1221 src/mail.cpp:1290 +#: src/mail.cpp:1223 src/mail.cpp:1292 msgid "GpgOL will only show such mails as text." msgstr "GpgOL zal dergelijke e-mailberichten alleen als tekst weergeven." -#: src/mail.cpp:1224 +#: src/mail.cpp:1226 msgid "This message is shown only once." msgstr "Dit bericht wordt eenmalig weergegeven." -#: src/mail.cpp:1293 +#: src/mail.cpp:1295 msgid "" "Please ask the sender to sign the message or\n" "to send it with a plain text alternative." @@ -313,11 +419,11 @@ msgstr "" "Vraag de verzender om het bericht te ondertekenen of\n" " het als platte tekst te versturen." -#: src/mail.cpp:1471 +#: src/mail.cpp:1473 msgid "GpgOL: Oops, G Suite Sync account detected" msgstr "GpgOL: Oeps, G Suite Sync account gevonden" -#: src/mail.cpp:1473 +#: src/mail.cpp:1475 msgid "" "G Suite Sync breaks outgoing crypto mails with attachments.\n" "Using crypto and attachments with G Suite Sync is not supported.\n" @@ -329,97 +435,97 @@ msgstr "" "\n" "Zie: https://dev.gnupg.org/T3545 voor details." -#: src/mail.cpp:2356 +#: src/mail.cpp:2349 msgid "Security Level 4" msgstr "Veiligheidsniveau 4" -#: src/mail.cpp:2360 +#: src/mail.cpp:2353 msgid "Trust Level 4" msgstr "Vertrouwensniveau 4" -#: src/mail.cpp:2364 +#: src/mail.cpp:2357 msgid "Security Level 3" msgstr "Veiligheidsniveau 3" -#: src/mail.cpp:2368 +#: src/mail.cpp:2361 msgid "Trust Level 3" msgstr "Vertrouwensniveau 3" -#: src/mail.cpp:2372 +#: src/mail.cpp:2365 msgid "Security Level 2" msgstr "Veiligheidsniveau 2" -#: src/mail.cpp:2376 +#: src/mail.cpp:2369 msgid "Trust Level 2" msgstr "Vertrouwensniveau 2" -#: src/mail.cpp:2380 +#: src/mail.cpp:2373 msgid "Encrypted" msgstr "Versleuteld" -#: src/mail.cpp:2389 src/mail.cpp:2391 src/ribbon-callbacks.cpp:599 +#: src/mail.cpp:2382 src/mail.cpp:2384 src/ribbon-callbacks.cpp:607 msgid "Insecure" msgstr "Onveilig" -#: src/mail.cpp:2403 +#: src/mail.cpp:2396 msgid "Signed and encrypted message" msgstr "Ondertekend en versleuteld bericht" -#: src/mail.cpp:2407 +#: src/mail.cpp:2400 msgid "Signed message" msgstr "Ondertekend bericht" -#: src/mail.cpp:2411 +#: src/mail.cpp:2404 msgid "Encrypted message" msgstr "Versleuteld bericht" -#: src/mail.cpp:2414 src/ribbon-callbacks.cpp:623 +#: src/mail.cpp:2407 src/ribbon-callbacks.cpp:631 msgid "Insecure message" msgstr "Onveilig bericht" -#: src/mail.cpp:2425 src/mail.cpp:2436 +#: src/mail.cpp:2418 src/mail.cpp:2429 msgid "You cannot be sure who sent, modified and read the message in transit." msgstr "" "Het is niet zeker wie het bericht heeft verzonden of onderweg aangepast of " "gelezen heeft." -#: src/mail.cpp:2428 +#: src/mail.cpp:2421 msgid "The message was signed but the verification failed with:" msgstr "Het bericht is ondertekend, maar de verificatie is mislukt met:" -#: src/mail.cpp:2446 +#: src/mail.cpp:2439 msgid "The encryption was VS-NfD-compliant." msgstr "De versleuteling is conform VS-NfD." -#: src/mail.cpp:2450 +#: src/mail.cpp:2443 msgid "The encryption was not VS-NfD-compliant." msgstr "De versleuteling is niet conform VS-NfD." -#: src/mail.cpp:2454 +#: src/mail.cpp:2447 msgid "You cannot be sure who sent the message because it is not signed." msgstr "" "Het is niet zeker wie dit bericht heeft verzonden omdat het niet is " "ondertekend" -#: src/mail.cpp:2479 +#: src/mail.cpp:2472 msgid "You signed this message." msgstr "U heeft dit bericht ondertekend." -#: src/mail.cpp:2483 +#: src/mail.cpp:2476 msgid "The senders identity was certified by yourself." msgstr "De identiteit van de verzender is door uzelf gecertificeerd." -#: src/mail.cpp:2487 +#: src/mail.cpp:2480 msgid "The sender is allowed to certify identities for you." msgstr "De verzender heeft toestemming om identiteiten voor u te certificeren." -#: src/mail.cpp:2500 +#: src/mail.cpp:2493 msgid "The senders identity was certified by several trusted people." msgstr "" "De identiteit van de verzender is gecertificeerd door verschillende " "vertrouwde mensen." -#: src/mail.cpp:2505 +#: src/mail.cpp:2498 #, c-format msgid "" "The senders identity is certified by the trusted issuer:\n" @@ -429,17 +535,17 @@ msgstr "" "verlener:\n" "'%s'\n" -#: src/mail.cpp:2513 +#: src/mail.cpp:2506 msgid "The mail provider of the recipient served this key." msgstr "De e-mailprovider van de ontvanger heeft deze sleutel aangeboden." -#: src/mail.cpp:2518 +#: src/mail.cpp:2511 msgid "Some trusted people have certified the senders identity." msgstr "" "Enkele vertrouwde personen hebben de identiteit van de verzender " "gecertificeerd." -#: src/mail.cpp:2528 +#: src/mail.cpp:2521 #, c-format msgid "" "The senders address is trusted, because you have established a communication " @@ -450,11 +556,11 @@ msgstr "" "geschiedenis heb opgebouwd met dit adres vanaf %s.\n" "U heeft sindsdien %i berichten versleuteld en %i berichten geverifieerd." -#: src/mail.cpp:2545 +#: src/mail.cpp:2538 msgid "The senders signature was verified for the first time." msgstr "De handtekening van de verzender is voor het eerst geverifieerd." -#: src/mail.cpp:2552 +#: src/mail.cpp:2545 #, c-format msgid "" "The senders address is not trustworthy yet because you only verified %i " @@ -463,70 +569,70 @@ msgstr "" "Het adres van de verzender is nog niet betrouwbaar omdat u nog maar %i " "berichten heeft geverifieerd en %i berichten heeft versleuteld sinds %s." -#: src/mail.cpp:2567 +#: src/mail.cpp:2560 msgid "But the sender address is not trustworthy because:" msgstr "Maar het adres van de verzender is niet betrouwbaar vanwege:" -#: src/mail.cpp:2568 +#: src/mail.cpp:2561 msgid "The sender address is not trustworthy because:" msgstr "Het adres van de verzender is niet betrouwbaar vanwege:" -#: src/mail.cpp:2576 +#: src/mail.cpp:2569 msgid "The signature is invalid: \n" msgstr "De handtekening is ongeldig:\n" -#: src/mail.cpp:2581 +#: src/mail.cpp:2574 msgid "There was an error verifying the signature.\n" msgstr "Fout bij het verifi?ren van de handtekening.\n" -#: src/mail.cpp:2590 +#: src/mail.cpp:2583 msgid "The signature is expired.\n" msgstr "De handtekening is verlopen.\n" -#: src/mail.cpp:2594 +#: src/mail.cpp:2587 msgid "The used key" msgstr "De gebruikte sleutel" -#: src/mail.cpp:2594 +#: src/mail.cpp:2587 msgid "The used certificate" msgstr "Het gebruikte certificaat" -#: src/mail.cpp:2602 +#: src/mail.cpp:2595 msgid "is not available." msgstr "is niet beschikbaar." -#: src/mail.cpp:2606 +#: src/mail.cpp:2599 msgid "is revoked." msgstr "is ingetrokken." -#: src/mail.cpp:2610 +#: src/mail.cpp:2603 msgid "is expired." msgstr "is verlopen." -#: src/mail.cpp:2614 +#: src/mail.cpp:2607 msgid "is not meant for signing." msgstr "is niet bedoeld voor ondertekening." -#: src/mail.cpp:2618 src/mail.cpp:2622 +#: src/mail.cpp:2611 src/mail.cpp:2615 msgid "could not be checked for revocation." msgstr "kan niet worden geverifieerd op intrekking." -#: src/mail.cpp:2627 +#: src/mail.cpp:2620 msgid "is not the same as the key that was used for this address in the past." msgstr "" "is niet dezelfde als de sleutel die in het verleden voor dit adres is " "gebruikt." -#: src/mail.cpp:2633 +#: src/mail.cpp:2626 #, c-format msgid "does not claim the address: \"%s\"." msgstr "claimt het adres: \"%s\" niet." -#: src/mail.cpp:2647 +#: src/mail.cpp:2640 msgid "is not certified by any trustworthy key." msgstr "is niet certificeerd door een betrouwbare sleutel." -#: src/mail.cpp:2651 +#: src/mail.cpp:2644 msgid "" "is not certified by a trustworthy Certificate Authority or the Certificate " "Authority is unknown." @@ -534,56 +640,56 @@ msgstr "" "is niet gecertificeerd door een betrouwbare certificeringsinstantie of de " "certificeringsinstantie is onbekend." -#: src/mail.cpp:2656 +#: src/mail.cpp:2649 msgid "The sender marked this address as revoked." msgstr "De verzender heeft dit adres als ingetrokken gemarkeerd." -#: src/mail.cpp:2660 +#: src/mail.cpp:2653 msgid "is marked as not trustworthy." msgstr "is gemarkeerd als onbetrouwbaar." -#: src/mail.cpp:2670 +#: src/mail.cpp:2663 msgid "The signature is VS-NfD-compliant." msgstr "De handtekening is conform VS-NfD." -#: src/mail.cpp:2674 +#: src/mail.cpp:2667 msgid "The signature is not VS-NfD-compliant." msgstr "De handtekening is niet conform VS-NfD." -#: src/mail.cpp:2682 +#: src/mail.cpp:2675 msgid "The encryption is VS-NfD-compliant." msgstr "De versleuteling is conform VS-NfD." -#: src/mail.cpp:2686 +#: src/mail.cpp:2679 msgid "The encryption is not VS-NfD-compliant." msgstr "De versleuteling is niet conform VS-NfD." -#: src/mail.cpp:2697 +#: src/mail.cpp:2690 msgid "Click here to change the key used for this address." msgstr "Klik hier om de sleutel voor dit adres te wijzigen." -#: src/mail.cpp:2701 +#: src/mail.cpp:2694 msgid "Click here for details about the key." msgstr "Klik hier voor details over de sleutel." -#: src/mail.cpp:2702 +#: src/mail.cpp:2695 msgid "Click here for details about the certificate." msgstr "Klik hier voor details over het certificaat." -#: src/mail.cpp:2706 +#: src/mail.cpp:2699 msgid "Click here to search the key on the configured keyserver." msgstr "Klik hier om de sleutel op de geconfigureerde keyserver te zoeken." -#: src/mail.cpp:2707 +#: src/mail.cpp:2700 msgid "Click here to search the certificate on the configured X509 keyserver." msgstr "" "Klik hier om het certificaat op de geconfigureerde X509 keyserver te zoeken." -#: src/mail.cpp:3029 +#: src/mail.cpp:3026 msgid "GpgOL: Encryption not possible!" msgstr "GpgOL: Versleutelen niet mogelijk!" -#: src/mail.cpp:3031 +#: src/mail.cpp:3028 msgid "" "Outlook returned an error when trying to send the encrypted mail.\n" "\n" @@ -601,11 +707,11 @@ msgstr "" "te gebruiken,\n" "of stap over naar PGP/Inline in de opties van GpgOL." -#: src/mailitem-events.cpp:310 src/mailitem-events.cpp:912 +#: src/mailitem-events.cpp:306 src/mailitem-events.cpp:914 msgid "Sorry, that's not possible, yet" msgstr "Sorry, dat is nog niet mogelijk" -#: src/mailitem-events.cpp:312 +#: src/mailitem-events.cpp:308 #, c-format msgid "" "GpgOL has prevented the change to the \"%s\" property.\n" @@ -627,25 +733,25 @@ msgstr "" "Bijvoorbeeld door met de rechtermuisknop op het bericht te klikken zonder " "dat deze geselecteerd is.\n" -#: src/mailitem-events.cpp:841 +#: src/mailitem-events.cpp:843 msgid "Dangerous reply" msgstr "Gevaarlijke handeling: Beantwoorden" -#: src/mailitem-events.cpp:842 +#: src/mailitem-events.cpp:844 msgid "Dangerous forward" msgstr "Gevaarlijke handeling: Doorsturen" -#: src/mailitem-events.cpp:843 +#: src/mailitem-events.cpp:845 msgid "Unsigned S/MIME mails are not integrity protected." msgstr "Ongetekende S/MAIL e-mailberichten zijn niet beschermd op integriteit." -#: src/mailitem-events.cpp:849 +#: src/mailitem-events.cpp:851 msgid "For security reasons no decrypted contents are included in this reply." msgstr "" "Uit veiligheidsoverwegingen wordt er geen ontsleutelde inhoud ingevoegd in " "dit antwoord." -#: src/mailitem-events.cpp:854 +#: src/mailitem-events.cpp:856 msgid "" "For security reasons no decrypted contents are included in the forwarded " "mail." @@ -653,7 +759,7 @@ msgstr "" "Uit veiligheidsoverwegingen wordt er geen ontsleutelde inhoud ingevoegd in " "deze doorgestuurde e-mail." -#: src/mailitem-events.cpp:909 +#: src/mailitem-events.cpp:911 msgid "" "Attachments are part of the crypto message.\n" "They can't be permanently removed and will be shown again the next time this " @@ -699,11 +805,11 @@ msgstr "" "Gegevens-integriteit is niet beschermd. Ontcijferen kan een " "beveiligingsprobleem zijn. (geen MDC)" -#: src/parsecontroller.cpp:224 src/parsecontroller.cpp:312 +#: src/parsecontroller.cpp:224 src/parsecontroller.cpp:313 msgid "Encrypted message (decryption not possible)" msgstr "Versleuteld bericht (ontcijferen niet mogelijk)" -#: src/parsecontroller.cpp:313 +#: src/parsecontroller.cpp:314 msgid "" "Failed to find GnuPG please ensure that GnuPG or Gpg4win is properly " "installed." @@ -711,11 +817,11 @@ msgstr "" "GnuPG kon niet gevonden worden. Controleer dat GnuPG of Gpg4win correct " "ge?nstalleerd is." -#: src/ribbon-callbacks.cpp:627 +#: src/ribbon-callbacks.cpp:635 msgid "No message selected" msgstr "Geen bericht geselecteerd" -#: src/ribbon-callbacks.cpp:688 +#: src/ribbon-callbacks.cpp:696 #, c-format msgid "" "The message was not cryptographically signed.\n" @@ -726,7 +832,7 @@ msgstr "" "Er is geen aanvullende informatie beschikbaar over of het daadwerkelijk door " "'%s' is verzonden of dat iemand het afzender-adres heeft vervalst." -#: src/ribbon-callbacks.cpp:699 +#: src/ribbon-callbacks.cpp:707 msgid "" "There was an error verifying the signature.\n" "Full details:\n" @@ -734,7 +840,7 @@ msgstr "" "Fout bij het verifi?ren van de handtekening.\n" "Volledige details:\n" -#: src/ribbon-callbacks.cpp:752 +#: src/ribbon-callbacks.cpp:760 msgid "" "Could not find Kleopatra.\n" "Please reinstall Gpg4win with the Kleopatra component enabled." @@ -811,19 +917,19 @@ msgstr "GpgOL: Verzoek bevestigd!" msgid "No recipients for encryption selected." msgstr "Er zijn geen ontvangers voor de versleuteling geselecteerd." -#: src/cryptcontroller.cpp:462 +#: src/cryptcontroller.cpp:479 msgid "Resolving recipients..." msgstr "Ontvangers opzoeken..." -#: src/cryptcontroller.cpp:466 +#: src/cryptcontroller.cpp:483 msgid "Resolving signers..." msgstr "Ondertekenaars opzoeken..." -#: src/cryptcontroller.cpp:1118 +#: src/cryptcontroller.cpp:1135 msgid "Encrypting..." msgstr "Versleutelen..." -#: src/cryptcontroller.cpp:1122 +#: src/cryptcontroller.cpp:1139 msgid "Signing..." msgstr "Ondertekenen..." @@ -1148,9 +1254,6 @@ msgstr "Ondertekenen..." #~ msgid "Error writing to stream" #~ msgstr "Fout bji het schrijven naar de stream" -#~ msgid "I/O-Error" -#~ msgstr "I/O-fout" - #~ msgid "Welcome to GpgOL " #~ msgstr "Welkom bij GpgOL " ----------------------------------------------------------------------- Summary of changes: po/nl.po | 339 +++++++++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 221 insertions(+), 118 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 11:29:48 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Tue, 25 Sep 2018 11:29:48 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-49-g38f9d07 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via 38f9d070bf8e32cff85c85657e9c0c86fbb66e85 (commit) via 38584f4c288307fee7b97875fbc9ce1ec72708b8 (commit) via 7b8bfd88f2f333775c22838b90fa76809ad1372b (commit) from b1199e9388f57044b60b1697e57ca3e267dd90c8 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 38f9d070bf8e32cff85c85657e9c0c86fbb66e85 Author: Andre Heinecke Date: Tue Sep 25 11:27:12 2018 +0200 Fix mlang release after mlang error * src/mlang-charset.cpp (ansi_charset_to_utf8): Fix release. -- In case of errors we may not release the mlang charset anymore because we are now using it cached. This caused crashes and probably hangs. It is a regression from: 59e8a7ee3bcd16275091c9535626e49fc2a6c4af GnuPG-Bug-Id: T4141 diff --git a/src/mlang-charset.cpp b/src/mlang-charset.cpp index 0529856..1e9eea1 100644 --- a/src/mlang-charset.cpp +++ b/src/mlang-charset.cpp @@ -81,7 +81,6 @@ char *ansi_charset_to_utf8 (const char *charset, const char *input, { log_error ("%s:%s: Inlen too long. Bug.", SRCNAME, __func__); - gpgol_release (multilang); return NULL; } @@ -98,7 +97,6 @@ char *ansi_charset_to_utf8 (const char *charset, const char *input, { log_error ("%s:%s: Failed to find charset for: %s", SRCNAME, __func__, charset); - gpgol_release (multilang); return xstrdup (input); } enc = (mime_info.uiInternetEncoding == 0) ? mime_info.uiCodePage : @@ -116,7 +114,6 @@ char *ansi_charset_to_utf8 (const char *charset, const char *input, { log_error ("%s:%s: Failed conversion.", SRCNAME, __func__); - gpgol_release (multilang); return NULL; } buf = (wchar_t*) xmalloc(sizeof(wchar_t) * (wlen + 1)); commit 38584f4c288307fee7b97875fbc9ce1ec72708b8 Author: Andre Heinecke Date: Tue Sep 25 09:50:32 2018 +0200 Fix a tracing regression * src/mapihelp.cpp (mapi_set_attach_hidden): Fix return scope. -- My regexp did not match lines that did not contain an if or an else *sigh* above the return. diff --git a/src/mapihelp.cpp b/src/mapihelp.cpp index 43d701b..f259b98 100644 --- a/src/mapihelp.cpp +++ b/src/mapihelp.cpp @@ -2792,7 +2792,9 @@ mapi_set_attach_hidden (LPATTACH attach) if (SUCCEEDED (hr) && PROP_TYPE (propval->ulPropTag) == PT_BOOLEAN && propval->Value.b) - TRETURN 0;/* Already set to hidden. */ + { + TRETURN 0;/* Already set to hidden. */ + } prop.ulPropTag = PR_ATTACHMENT_HIDDEN; prop.Value.b = TRUE; commit 7b8bfd88f2f333775c22838b90fa76809ad1372b Author: Andre Heinecke Date: Tue Sep 25 09:31:36 2018 +0200 Reduce tracing verbosity a bit -- This removes tracing from very often called functions like message_cb in mimedataprovider or lookup_oom_dispid. diff --git a/src/debug.cpp b/src/debug.cpp index 454de19..13a33bb 100644 --- a/src/debug.cpp +++ b/src/debug.cpp @@ -347,6 +347,5 @@ const char *anonstr (const char *data) gpgrt_lock_unlock (&anon_str_lock); - TRACEPOINT; return it->second.c_str(); } diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index 9f57f17..cf66ddf 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -425,7 +425,6 @@ static int message_cb (void *opaque, rfc822parse_event_t event, rfc822parse_t msg) { - TSTART; int retval = 0; MimeDataProvider *provider = static_cast (opaque); @@ -490,7 +489,7 @@ message_cb (void *opaque, rfc822parse_event_t event, break; } - TRETURN retval; + return retval; } MimeDataProvider::MimeDataProvider(bool no_headers) : @@ -566,8 +565,7 @@ MimeDataProvider::~MimeDataProvider() bool MimeDataProvider::isSupported(GpgME::DataProvider::Operation op) const { - TSTART; - TRETURN op == GpgME::DataProvider::Read || + return op == GpgME::DataProvider::Read || op == GpgME::DataProvider::Seek || op == GpgME::DataProvider::Write || op == GpgME::DataProvider::Release; @@ -1010,8 +1008,7 @@ ssize_t MimeDataProvider::write(const void *buffer, size_t bufSize) off_t MimeDataProvider::seek(off_t offset, int whence) { - TSTART; - TRETURN m_crypto_data.seek (offset, whence); + return m_crypto_data.seek (offset, whence); } GpgME::Data * diff --git a/src/oomhelp.cpp b/src/oomhelp.cpp index 851b7ba..383960c 100644 --- a/src/oomhelp.cpp +++ b/src/oomhelp.cpp @@ -37,13 +37,12 @@ HRESULT gpgol_queryInterface (LPUNKNOWN pObj, REFIID riid, LPVOID FAR *ppvObj) { - TSTART; HRESULT ret = pObj->QueryInterface (riid, ppvObj); if ((opt.enable_debug & DBG_OOM_EXTRA) && *ppvObj) { memdbg_addRef (*ppvObj); } - TRETURN ret; + return ret; } HRESULT @@ -51,7 +50,6 @@ gpgol_openProperty (LPMAPIPROP obj, ULONG ulPropTag, LPCIID lpiid, ULONG ulInterfaceOptions, ULONG ulFlags, LPUNKNOWN FAR * lppUnk) { - TSTART; HRESULT ret = obj->OpenProperty (ulPropTag, lpiid, ulInterfaceOptions, ulFlags, lppUnk); @@ -61,7 +59,7 @@ gpgol_openProperty (LPMAPIPROP obj, ULONG ulPropTag, LPCIID lpiid, log_debug ("%s:%s: OpenProperty on %p prop %lx result %p", SRCNAME, __func__, obj, ulPropTag, *lppUnk); } - TRETURN ret; + return ret; } /* Return a malloced string with the utf-8 encoded name of the object or NULL if not available. */ @@ -117,7 +115,6 @@ get_object_name (LPUNKNOWN obj) DISPID lookup_oom_dispid (LPDISPATCH pDisp, const char *name) { - TSTART; HRESULT hr; DISPID dispid; wchar_t *wname; @@ -142,13 +139,12 @@ lookup_oom_dispid (LPDISPATCH pDisp, const char *name) if (hr != S_OK) dispid = DISPID_UNKNOWN; - TRETURN dispid; + return dispid; } static void init_excepinfo (EXCEPINFO *err) { - TSTART; if (!err) { TRETURN; diff --git a/src/windowmessages.cpp b/src/windowmessages.cpp index d20655b..0b233e9 100644 --- a/src/windowmessages.cpp +++ b/src/windowmessages.cpp @@ -39,7 +39,6 @@ static int invalidation_blocked = 0; LONG_PTR WINAPI gpgol_window_proc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) { - TSTART; // log_debug ("WMG: %x", (unsigned int) message); if (message == WM_USER + 42) { ----------------------------------------------------------------------- Summary of changes: src/debug.cpp | 1 - src/mapihelp.cpp | 4 +++- src/mimedataprovider.cpp | 9 +++------ src/mlang-charset.cpp | 3 --- src/oomhelp.cpp | 10 +++------- src/windowmessages.cpp | 1 - 6 files changed, 9 insertions(+), 19 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 14:11:44 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Tue, 25 Sep 2018 14:11:44 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-52-gdf9b3ca Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via df9b3ca85d7f9702f268cef46c276a89b6e14e4f (commit) via c715ef5d048868786cd9a32018c58aa8225ba6e0 (commit) via 546cdcec1a3506ae0bdddb09dc7dd1492c094c4d (commit) from 38f9d070bf8e32cff85c85657e9c0c86fbb66e85 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit df9b3ca85d7f9702f268cef46c276a89b6e14e4f Author: Andre Heinecke Date: Tue Sep 25 14:07:01 2018 +0200 Further simplyify log level values -- As we only have 4 levels now remove the others and only keep their values around for compatibility. diff --git a/src/debug.h b/src/debug.h index 62ce37b..7b089ce 100644 --- a/src/debug.h +++ b/src/debug.h @@ -49,18 +49,11 @@ extern "C" { 544 -> OOM and Memory. 800 -> Full debugging. */ -#define DBG_MEMORY (1<<5) // 32 -#define DBG_MIME_PARSER (1<<7) // 128 Unified as DBG_DATA -#define DBG_MIME_DATA (1<<8) // 256 Unified as DBG_DATA -#define DBG_DATA (DBG_MIME_PARSER | DBG_MIME_DATA) -#define DBG_OOM_VAL (1<<9) // 512 Unified as DBG_OOM -#define DBG_OOM_EXTRA (1<<10)// 1024 Unified as DBG_OOM -#define DBG_TRACE (1<<11)// 2048 Very verbose tracing. -#define DBG_OOM (DBG_OOM_VAL | DBG_OOM_EXTRA) - -#define debug_oom ((opt.enable_debug & DBG_OOM) || \ - (opt.enable_debug & DBG_OOM_EXTRA)) -#define debug_oom_extra (opt.enable_debug & DBG_OOM_EXTRA) +#define DBG_OOM (1<<1) // 2 +#define DBG_MEMORY (1<<2) // 4 +#define DBG_TRACE (1<<3) // 8 +#define DBG_DATA (1<<4) // 16 + void log_debug (const char *fmt, ...) __attribute__ ((format (printf,1,2))); void log_error (const char *fmt, ...) __attribute__ ((format (printf,1,2))); void log_vdebug (const char *fmt, va_list a); diff --git a/src/eventsink.h b/src/eventsink.h index 12b1b35..c5a58da 100644 --- a/src/eventsink.h +++ b/src/eventsink.h @@ -45,7 +45,7 @@ class subcls : public parentcls \ inline STDMETHODIMP_(ULONG) AddRef (void) \ { \ ++m_ref; \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:" #subcls ":%s: m_ref now %lu", \ SRCNAME,__func__, m_ref); \ return m_ref; \ @@ -53,7 +53,7 @@ class subcls : public parentcls \ inline STDMETHODIMP_(ULONG) Release (void) \ { \ ULONG count = --m_ref; \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:" #subcls ":%s: mref now %lu", \ SRCNAME,__func__,count); \ if (!count) \ @@ -92,7 +92,7 @@ STDMETHODIMP subcls::Invoke (DISPID dispid, REFIID riid, LCID lcid, \ #define EVENT_SINK_DEFAULT_DTOR_CODE(subcls) \ { \ - if (debug_oom) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:" #subcls ":%s: dtor", SRCNAME, __func__); \ if (m_pCP) \ m_pCP->Unadvise(m_cookie); \ @@ -196,7 +196,7 @@ LPDISPATCH install_ ## subcls ## _sink (LPDISPATCH object) \ gpgol_release (sink); \ return NULL; \ } \ - if (debug_oom) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:%s:%s: Advice succeeded", SRCNAME, #subcls, __func__);\ sink->m_cookie = cookie; \ sink->m_pCP = pCP; \ @@ -210,7 +210,7 @@ void detach_ ## subcls ## _sink (LPDISPATCH obj) \ HRESULT hr; \ subcls *sink; \ \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:%s:%s: Called", SRCNAME, #subcls, __func__); \ hr = gpgol_queryInterface (obj, iidcls, (void**)&sink); \ if (hr != S_OK || !sink) \ @@ -221,13 +221,13 @@ void detach_ ## subcls ## _sink (LPDISPATCH obj) \ } \ if (sink->m_pCP) \ { \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:%s:%s: Unadvising", SRCNAME, #subcls, __func__); \ hr = sink->m_pCP->Unadvise (sink->m_cookie); \ if (hr != S_OK) \ log_error ("%s:%s:%s: Unadvice failed: hr=%#lx", \ SRCNAME, #subcls, __func__, hr); \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:%s:%s: Releasing connt point", \ SRCNAME, #subcls, __func__); \ gpgol_release (sink->m_pCP); \ @@ -235,7 +235,7 @@ void detach_ ## subcls ## _sink (LPDISPATCH obj) \ } \ if (sink->m_object) \ { \ - if (debug_oom_extra) \ + if ((opt.enable_debug & DBG_OOM)) \ log_debug ("%s:%s:%s: Releasing actual object", \ SRCNAME, #subcls, __func__); \ gpgol_release (sink->m_object); \ diff --git a/src/keycache.cpp b/src/keycache.cpp index ca2a8a5..b62884b 100644 --- a/src/keycache.cpp +++ b/src/keycache.cpp @@ -926,7 +926,7 @@ locate_secret (const char *addr, GpgME::Protocol proto) if (key.isRevoked() || key.isExpired() || key.isDisabled() || key.isInvalid()) { - if ((opt.enable_debug & DBG_MIME_PARSER)) + if ((opt.enable_debug & DBG_DATA)) { std::stringstream ss; ss << key; diff --git a/src/main.c b/src/main.c index 987b5fd..30f22f7 100644 --- a/src/main.c +++ b/src/main.c @@ -195,6 +195,57 @@ get_conf_bool (const char *name, int defaultVal) return ret; } +static int +dbg_compat (int oldval) +{ + // We broke the debug levels at some point + // This is cmpatibility code with the old + // levels. + +#define DBG_MEMORY_OLD (1<<5) // 32 +#define DBG_MIME_PARSER_OLD (1<<7) // 128 Unified as DBG_DATA +#define DBG_MIME_DATA_OLD (1<<8) // 256 Unified in read_options +#define DBG_OOM_OLD (1<<9) // 512 Unified as DBG_OOM +#define DBG_OOM_EXTRA_OLD (1<<10)// 1024 Unified in read_options + int new_dbg = oldval; + if ((oldval & DBG_MEMORY_OLD)) + { + new_dbg |= DBG_MEMORY; + new_dbg -= DBG_MEMORY_OLD; + } + if ((oldval & DBG_OOM_OLD)) + { + new_dbg |= DBG_OOM; + new_dbg -= DBG_OOM_OLD; + } + if ((oldval & DBG_MIME_PARSER_OLD)) + { + new_dbg |= DBG_DATA; + new_dbg -= DBG_MIME_PARSER_OLD; + } + if ((oldval & DBG_MIME_DATA_OLD)) + { + new_dbg |= DBG_DATA; + new_dbg -= DBG_MIME_DATA_OLD; + } + if ((oldval & DBG_OOM_OLD)) + { + new_dbg |= DBG_OOM; + new_dbg -= DBG_OOM_OLD; + } + if ((oldval & DBG_OOM_EXTRA_OLD)) + { + new_dbg |= DBG_OOM; + new_dbg -= DBG_OOM_EXTRA_OLD; + } +#undef DBG_MEMORY_OLD +#undef DBG_MIME_PARSER_OLD +#undef DBG_MIME_DATA_OLD +#undef DBG_OOM_OLD +#undef DBG_OOM_EXTRA_OLD + return new_dbg; +} + /* Read option settings from the Registry. */ void read_options (void) @@ -224,17 +275,20 @@ read_options (void) pend += strspn (pend, ", \t\n\r\f"); } if (isascii (*p) && isdigit (*p)) - opt.enable_debug |= strtoul (p, NULL, 0); + { + opt.enable_debug |= dbg_compat (strtoul (p, NULL, 0)); + + } else if (!strcmp (p, "memory")) opt.enable_debug |= DBG_MEMORY; else if (!strcmp (p, "mime-parser")) - opt.enable_debug |= DBG_MIME_PARSER; + opt.enable_debug |= DBG_DATA; else if (!strcmp (p, "mime-data")) - opt.enable_debug |= DBG_MIME_DATA; + opt.enable_debug |= DBG_DATA; else if (!strcmp (p, "oom")) - opt.enable_debug |= DBG_OOM_VAL; + opt.enable_debug |= DBG_OOM; else if (!strcmp (p, "oom-extra")) - opt.enable_debug |= DBG_OOM_EXTRA; + opt.enable_debug |= DBG_OOM; else log_debug ("invalid debug flag `%s' ignored", p); } diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index cf66ddf..ad09c62 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -578,7 +578,7 @@ MimeDataProvider::read(void *buffer, size_t size) log_data ("%s:%s: Reading: " SIZE_T_FORMAT "Bytes", SRCNAME, __func__, size); ssize_t bRead = m_crypto_data.read (buffer, size); - if (opt.enable_debug & DBG_MIME_DATA && bRead) + if ((opt.enable_debug & DBG_DATA) && bRead) { std::string buf ((char *)buffer, bRead); diff --git a/src/oomhelp.cpp b/src/oomhelp.cpp index 383960c..2b84b0e 100644 --- a/src/oomhelp.cpp +++ b/src/oomhelp.cpp @@ -38,7 +38,7 @@ HRESULT gpgol_queryInterface (LPUNKNOWN pObj, REFIID riid, LPVOID FAR *ppvObj) { HRESULT ret = pObj->QueryInterface (riid, ppvObj); - if ((opt.enable_debug & DBG_OOM_EXTRA) && *ppvObj) + if ((opt.enable_debug & DBG_MEMORY) && *ppvObj) { memdbg_addRef (*ppvObj); } diff --git a/src/xmalloc.h b/src/xmalloc.h index 5385419..e302a85 100644 --- a/src/xmalloc.h +++ b/src/xmalloc.h @@ -30,7 +30,7 @@ extern "C" { /*-- common.c --*/ #define xmalloc(VAR1) ({void *retval; \ retval = _xmalloc(VAR1); \ - if ((opt.enable_debug & DBG_OOM_EXTRA)) \ + if ((opt.enable_debug & DBG_MEMORY)) \ { \ memdbg_alloc (retval); \ } \ @@ -38,7 +38,7 @@ retval;}) #define xcalloc(VAR1, VAR2) ({void *retval; \ retval = _xcalloc(VAR1, VAR2); \ - if ((opt.enable_debug & DBG_OOM_EXTRA)) \ + if ((opt.enable_debug & DBG_MEMORY)) \ { \ memdbg_alloc (retval);\ } \ @@ -46,7 +46,7 @@ retval;}) #define xrealloc(VAR1, VAR2) ({void *retval; \ retval = _xrealloc (VAR1, VAR2); \ - if ((opt.enable_debug & DBG_OOM_EXTRA)) \ + if ((opt.enable_debug & DBG_MEMORY)) \ { \ memdbg_alloc (retval);\ memdbg_free ((void*)VAR1); \ @@ -55,7 +55,7 @@ retval;}) #define xfree(VAR1) \ { \ - if (VAR1 && (opt.enable_debug & DBG_OOM_EXTRA) && !memdbg_free (VAR1)) \ + if (VAR1 && (opt.enable_debug & DBG_MEMORY) && !memdbg_free (VAR1)) \ log_debug ("%s:%s:%i %p freed here", \ log_srcname (__FILE__), __func__, __LINE__, VAR1); \ _xfree (VAR1); \ @@ -63,7 +63,7 @@ retval;}) #define xstrdup(VAR1) ({char *retval; \ retval = _xstrdup (VAR1); \ - if ((opt.enable_debug & DBG_OOM_EXTRA)) \ + if ((opt.enable_debug & DBG_MEMORY)) \ { \ memdbg_alloc ((void *)retval);\ } \ @@ -71,7 +71,7 @@ retval;}) #define xwcsdup(VAR1) ({wchar_t *retval; \ retval = _xwcsdup (VAR1); \ - if ((opt.enable_debug & DBG_OOM_EXTRA)) \ + if ((opt.enable_debug & DBG_MEMORY)) \ { \ memdbg_alloc ((void *)retval);\ } \ commit c715ef5d048868786cd9a32018c58aa8225ba6e0 Author: Andre Heinecke Date: Tue Sep 25 13:23:13 2018 +0200 Only include conversion strings for DBG_DATA * src/w32-gettext.h: Guard debug output of all strings also with DBG_DATA. -- Otherwise we would have leaked private data if trace and dbg mem was enabled. diff --git a/src/w32-gettext.h b/src/w32-gettext.h index 19a7763..24c3cd0 100644 --- a/src/w32-gettext.h +++ b/src/w32-gettext.h @@ -73,7 +73,7 @@ char *native_to_utf8 (const char *string); #define utf8_to_wchar(VAR1) ({wchar_t *retval; \ retval = _utf8_to_wchar (VAR1); \ - if ((opt.enable_debug & (DBG_TRACE & DBG_MEMORY))) \ + if ((opt.enable_debug & (DBG_TRACE & DBG_DATA & DBG_MEMORY))) \ { \ log_debug ("%s:%s:%i wchar_t alloc %p:%S", \ SRCNAME, __func__, __LINE__, retval, retval); \ @@ -82,7 +82,7 @@ retval;}) #define wchar_to_utf8(VAR1) ({char *retval; \ retval = _wchar_to_utf8 (VAR1); \ - if ((opt.enable_debug & (DBG_TRACE & DBG_MEMORY))) \ + if ((opt.enable_debug & (DBG_TRACE & DBG_DATA & DBG_MEMORY))) \ { \ log_debug ("%s:%s:%i char utf8 alloc %p:%s", \ SRCNAME, __func__, __LINE__, retval, retval); \ commit 546cdcec1a3506ae0bdddb09dc7dd1492c094c4d Author: Andre Heinecke Date: Tue Sep 25 13:22:14 2018 +0200 Add new strings for gpgolconfig and rename * src/addin-options.cpp: Renamed gpgolgui to gpgolconfig. We have more then one GUI application nowadays ;-) * src/addin-options.cpp: Added new strings for debug config. diff --git a/src/addin-options.cpp b/src/addin-options.cpp index 7b56491..ac3cdc7 100644 --- a/src/addin-options.cpp +++ b/src/addin-options.cpp @@ -109,13 +109,42 @@ i18n_noops[] = { N_("Continue?"), /* TRANSLATORS: Part of address book key configuration dialog. */ N_("Confirm keys"), + /* TRANSLATORS: Part of debugging configuration. */ + N_("Enable Logging"), + N_("Default"), + /* TRANSLATORS: Part of debugging configuration. The plus should + mean in the combo box that it is added to the above. */ + N_("+Outlook API calls"), + /* TRANSLATORS: Part of debugging configuration. The plus should + mean in the combo box that it is added to the above. */ + N_("+Memory analysis"), + /* TRANSLATORS: Part of debugging configuration. The plus should + mean in the combo box that it is added to the above. */ + N_("+Call tracing"), + /* TRANSLATORS: Part of debugging configuration. */ + N_("Log File (required):"), + /* TRANSLATORS: Part of debugging configuration. This is a checkbox + to select if even potentially private data should be included in the + debug log. */ + N_("Include Mail contents (decrypted!) and meta information."), + /* TRANSLATORS: Dialog title for the log file selection */ + N_("Select log file"), + /* TRANSLATORS: Part of debugging configuration. */ + N_("Log level:"), + /* TRANSLATORS: Part of debugging configuration. Warning shown + in case the highest log level is selected. Please try to + keep the string ~ the size of the english version as the + warning is shown in line with the combo box to select the + level. */ + N_("Warning: Decreased performance. Huge logs!"), + }; static bool dlg_open; static DWORD WINAPI -open_gpgolgui (LPVOID arg) +open_gpgolconfig (LPVOID arg) { HWND wnd = (HWND) arg; @@ -128,8 +157,8 @@ open_gpgolgui (LPVOID arg) TRACEPOINT; return -1; } - const auto gpgolgui = std::string (gpg4win_dir) + "\\bin\\gpgolgui.exe"; - args.push_back (gpgolgui); + const auto gpgolconfig = std::string (gpg4win_dir) + "\\bin\\gpgolconfig.exe"; + args.push_back (gpgolconfig); args.push_back (std::string ("--hwnd")); args.push_back (std::to_string ((int) (intptr_t) wnd)); @@ -184,11 +213,11 @@ options_dialog_box (HWND parent) if (dlg_open) { - log_debug ("%s:%s: Gpgolgui open. Not launching new dialog.", + log_debug ("%s:%s: Gpgolconfig open. Not launching new dialog.", SRCNAME, __func__); HWND optWindow = FindWindow (nullptr, _("Configure GpgOL")); if (!optWindow) { - log_debug ("%s:%s: Gpgolgui open but could not find window.", + log_debug ("%s:%s: Gpgolconfig open but could not find window.", SRCNAME, __func__); return; } @@ -197,9 +226,9 @@ options_dialog_box (HWND parent) return; } - log_debug ("%s:%s: Launching gpgolgui.", + log_debug ("%s:%s: Launching gpgolconfig.", SRCNAME, __func__); - CloseHandle (CreateThread (NULL, 0, open_gpgolgui, (LPVOID) parent, 0, + CloseHandle (CreateThread (NULL, 0, open_gpgolconfig, (LPVOID) parent, 0, NULL)); } ----------------------------------------------------------------------- Summary of changes: src/addin-options.cpp | 43 ++++++++++++++++++++++++++------ src/debug.h | 17 ++++--------- src/eventsink.h | 16 ++++++------ src/keycache.cpp | 2 +- src/main.c | 64 ++++++++++++++++++++++++++++++++++++++++++++---- src/mimedataprovider.cpp | 2 +- src/oomhelp.cpp | 2 +- src/w32-gettext.h | 4 +-- src/xmalloc.h | 12 ++++----- 9 files changed, 119 insertions(+), 43 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 14:14:40 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Tue, 25 Sep 2018 14:14:40 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-53-gc12a5e1 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via c12a5e1ce493d7a15b7b8a092d96be52822bbe1e (commit) from df9b3ca85d7f9702f268cef46c276a89b6e14e4f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit c12a5e1ce493d7a15b7b8a092d96be52822bbe1e Author: Andre Heinecke Date: Tue Sep 25 14:13:24 2018 +0200 Fix memdbg error for log_file * src/debug.cpp (set_log_file): Do not use memdbg decorated functions. -- The log file is first set in conjunction with reading the debug options. So we do not memdbg the alloc and later get an error when options are read again. This fixes an Error message. diff --git a/src/debug.cpp b/src/debug.cpp index 13a33bb..c453b39 100644 --- a/src/debug.cpp +++ b/src/debug.cpp @@ -67,11 +67,12 @@ set_log_file (const char *name) fclose (logfp); logfp = NULL; } - xfree (logfile); + free (logfile); if (!name || *name == '\"' || !*name) logfile = NULL; else - logfile = xstrdup (name); + logfile = strdup (name); + #ifdef HAVE_W32_SYSTEM unlock_log (); } ----------------------------------------------------------------------- Summary of changes: src/debug.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Tue Sep 25 15:39:14 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Tue, 25 Sep 2018 15:39:14 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-57-ga20d413 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via a20d413e04778f529f885d0ebe7adf7d7077d436 (commit) via 08a048b168bf5cd92c7caf34553da2a7623bfdf0 (commit) from 3078e5a0cd8df98a0bd01882044c121936cf95d5 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit a20d413e04778f529f885d0ebe7adf7d7077d436 Author: Andre Heinecke Date: Tue Sep 25 15:36:58 2018 +0200 Fix potential deadlock in autosecure check * src/mail.cpp (autosecureCheck): Do not wait for the auto secure set to finish. -- This fixes a race that could occur when the addressbook thread and a locator thread were working at the same time that could cause a deadlock in lockDelete. diff --git a/src/mail.cpp b/src/mail.cpp index 56adebf..d3b0f0d 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -3542,8 +3542,8 @@ Mail::autosecureCheck () * to be triggered by the locator threads finishing we * need to actually set the draft info flags in * the ui thread. */ - do_in_ui_thread (ret ? DO_AUTO_SECURE : DONT_AUTO_SECURE, - this); + do_in_ui_thread_async (ret ? DO_AUTO_SECURE : DONT_AUTO_SECURE, + this); TRETURN; } commit 08a048b168bf5cd92c7caf34553da2a7623bfdf0 Author: Andre Heinecke Date: Tue Sep 25 15:36:43 2018 +0200 Update de.po after auto msgfmt -- diff --git a/po/de.po b/po/de.po index 2110878..fd22a0a 100644 --- a/po/de.po +++ b/po/de.po @@ -182,8 +182,8 @@ msgstr "" msgid "" "The key is unusable for Outlook. Please check Kleopatra for more information." msgstr "" -"Dieser Schl?ssel ist f?r Outlook nicht benutzbar. Bitte pr?fen Sie Kleopatra" -" f?r mehr informationen." +"Dieser Schl?ssel ist f?r Outlook nicht benutzbar. Bitte pr?fen Sie Kleopatra " +"f?r mehr informationen." #. TRANSLATORS: Part of address book key configuration dialog. #: src/addin-options.cpp:94 ----------------------------------------------------------------------- Summary of changes: po/de.po | 4 ++-- src/mail.cpp | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 27 01:58:59 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Thu, 27 Sep 2018 01:58:59 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-306-g7c9f49a Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 7c9f49a4991c1ccd0cb582875207b373d4fccf50 (commit) from b625258d54782040195cc5ad3b255685af6f6c4e (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 7c9f49a4991c1ccd0cb582875207b373d4fccf50 Author: Ben McGinnes Date: Thu Sep 27 09:57:50 2018 +1000 examples: python bindings * Fixed homedir specifying logic in several cases. diff --git a/lang/python/examples/howto/export-key.py b/lang/python/examples/howto/export-key.py index c17f247..ff3345a 100755 --- a/lang/python/examples/howto/export-key.py +++ b/lang/python/examples/howto/export-key.py @@ -62,9 +62,9 @@ elif homedir.startswith("~"): else: homedir = os.path.realpath(homedir) -if os.path.exists(homedir) is False: +if homedir is not None and os.path.exists(homedir) is False: homedir = None -else: +elif homedir is not None and os.path.exists(homedir) is True: if os.path.isdir(homedir) is False: homedir = None else: diff --git a/lang/python/examples/howto/export-minimised-key.py b/lang/python/examples/howto/export-minimised-key.py index a5a453c..ffd7524 100755 --- a/lang/python/examples/howto/export-minimised-key.py +++ b/lang/python/examples/howto/export-minimised-key.py @@ -62,9 +62,9 @@ elif homedir.startswith("~"): else: homedir = os.path.realpath(homedir) -if os.path.exists(homedir) is False: +if homedir is not None and os.path.exists(homedir) is False: homedir = None -else: +elif homedir is not None and os.path.exists(homedir) is True: if os.path.isdir(homedir) is False: homedir = None else: diff --git a/lang/python/examples/howto/export-secret-key.py b/lang/python/examples/howto/export-secret-key.py index e7d4e3a..af1aa70 100755 --- a/lang/python/examples/howto/export-secret-key.py +++ b/lang/python/examples/howto/export-secret-key.py @@ -65,9 +65,9 @@ elif homedir.startswith("~"): else: homedir = os.path.realpath(homedir) -if os.path.exists(homedir) is False: +if homedir is not None and os.path.exists(homedir) is False: homedir = None -else: +elif homedir is not None and os.path.exists(homedir) is True: if os.path.isdir(homedir) is False: homedir = None else: diff --git a/lang/python/examples/howto/export-secret-keys.py b/lang/python/examples/howto/export-secret-keys.py index f0fddc6..f4e5008 100755 --- a/lang/python/examples/howto/export-secret-keys.py +++ b/lang/python/examples/howto/export-secret-keys.py @@ -74,9 +74,9 @@ elif homedir.startswith("~"): else: homedir = os.path.realpath(homedir) -if os.path.exists(homedir) is False: +if homedir is not None and os.path.exists(homedir) is False: homedir = None -else: +elif homedir is not None and os.path.exists(homedir) is True: if os.path.isdir(homedir) is False: homedir = None else: diff --git a/lang/python/examples/howto/send-key-to-keyserver.py b/lang/python/examples/howto/send-key-to-keyserver.py index 3541b19..261c8b6 100755 --- a/lang/python/examples/howto/send-key-to-keyserver.py +++ b/lang/python/examples/howto/send-key-to-keyserver.py @@ -60,9 +60,9 @@ elif homedir.startswith("~"): else: homedir = os.path.realpath(homedir) -if os.path.exists(homedir) is False: +if homedir is not None and os.path.exists(homedir) is False: homedir = None -else: +elif homedir is not None and os.path.exists(homedir) is True: if os.path.isdir(homedir) is False: homedir = None else: ----------------------------------------------------------------------- Summary of changes: lang/python/examples/howto/export-key.py | 4 ++-- lang/python/examples/howto/export-minimised-key.py | 4 ++-- lang/python/examples/howto/export-secret-key.py | 4 ++-- lang/python/examples/howto/export-secret-keys.py | 4 ++-- lang/python/examples/howto/send-key-to-keyserver.py | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 27 02:09:19 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Thu, 27 Sep 2018 02:09:19 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-307-gb9aea3b Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via b9aea3b9c2c2762a9ae8d677196f82acc6a1c028 (commit) from 7c9f49a4991c1ccd0cb582875207b373d4fccf50 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b9aea3b9c2c2762a9ae8d677196f82acc6a1c028 Author: Ben McGinnes Date: Thu Sep 27 10:07:08 2018 +1000 tests: python bindings * Fixed the final assertion to look for what will actually be reported in that case instead of something else (i.e. it looks for an IMPORT_ERROR status code). diff --git a/lang/python/tests/t-import.py b/lang/python/tests/t-import.py index 8d8a699..82d3a4e 100755 --- a/lang/python/tests/t-import.py +++ b/lang/python/tests/t-import.py @@ -82,4 +82,4 @@ try: result = c.key_import(b"thisisnotakey") except ValueError: pass -assert result.considered == 0 +assert result == "IMPORT_PROBLEM" ----------------------------------------------------------------------- Summary of changes: lang/python/tests/t-import.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 27 06:08:25 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Thu, 27 Sep 2018 06:08:25 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-308-g1d40d36 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 1d40d360bccb05b4c66313a60a902d04a0d3c9ff (commit) from b9aea3b9c2c2762a9ae8d677196f82acc6a1c028 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 1d40d360bccb05b4c66313a60a902d04a0d3c9ff Author: Ben McGinnes Date: Thu Sep 27 14:06:48 2018 +1000 docs: python bindings installation * lang/python/docs/gpgme-python-howto.org: added a section on installing the bindings to a python virtualenv. diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index b54662c..5524fce 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -561,6 +561,73 @@ things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. +*** Virtualised Environments + :PROPERTIES: + :CUSTOM_ID: snafu-venv + :END: + +It is fairly common practice amongst Python developers to, as much as +possible, use packages like virtualenv to keep various things that are +to be installed from interfering with each other. Given how much of +the GPGME bindings is often at odds with the usual pythonic way of +doing things, it stands to reason that this would be called into +question too. + +As it happens the answer as to whether or not the bindings can be used +with virtualenv, the answer is both yes and no. + +In general we recommend installing to the relevant path and matching +prefix of GPGME itself. Which means that when GPGME, and ideally the +rest of the GnuPG stack, is installed to a prefix like =/usr/local= or +=/opt/local= then the bindings would need to be installed to the main +Python installation and not a virtualised abstraction. Attempts to +separate the two in the past have been known to cause weird and +intermittent errors ranging from minor annoyances to complete failures +in the build process. + +As a consequence we only recommend building with and installing to the +main Python installations within the same prefix as GPGME is installed +to or which are found by GPGME's configuration stage immediately prior +to running the make commands. Which is exactly what the compiling and +installing process of GPGME does by default. + +Once that is done, however, it appears that a copy the compiled module +may be installed into a virtualenv of the same major and minor version +matching the build. Alternatively it is possible to utilise a +=sites.pth= file in the =site-packages/= directory of a viertualenv +installation, which links back to the system installations +corresponding directory in order to import anything installed system +wide. This may or may not be appropriate on a case by case basis. + +Though extensive testing of either of these options is not yet +complete, preliminary testing of them indicates that both are viable +as long as the main installation is complete. Which means that +certain other options normally restricted to virtual environments are +also available, including integration with pythonic test suites +(e.g. [[https://docs.pytest.org/en/latest/index.html][pytest]]) and other large projects. + +That said, it is worth reiterating the warning regarding non-standard +installations. If one were to attempt to install the bindings only to +a virtual environment without somehow also including the full GnuPG +stack (or enough of it as to include GPGME) then it is highly likely +that errors would be encountered at some point and more than a little +likely that the build process itself would break. + +If a degree of separation from the main operating system is still +required in spite of these warnings, then consider other forms of +virtualisation. Either a virtual machine (e.g. [[https://www.virtualbox.org/][VirtualBox]]), a +hardware emulation layer (e.g. [[https://www.qemu.org/][QEMU]]) or an application container +(e.g. [[https://www.docker.com/why-docker][Docker]]). + +Finally it should be noted that the limited tests conducted thus far +have been using the =virtualenv= command in a new directory to create +the virtual python environment. As opposed to the standard =python3 +-m venv= and it is possible that this will make a difference depending +on the system and version of Python in use. Another option is to run +the command =python3 -m virtualenv /path/to/install/virtual/thingy= +instead. + + * Fundamentals :PROPERTIES: :CUSTOM_ID: howto-fund-a-mental ----------------------------------------------------------------------- Summary of changes: lang/python/docs/gpgme-python-howto.org | 67 +++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 27 09:48:38 2018 From: cvs at cvs.gnupg.org (by NIIBE Yutaka) Date: Thu, 27 Sep 2018 09:48:38 +0200 Subject: [git] GnuPG - branch, master, updated. gnupg-2.2.7-216-g0cb6556 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The GNU Privacy Guard". The branch, master has been updated via 0cb65564e022fface5ada4de8e0c2c4c3d0ac8ad (commit) from fe8b6339542f3b1228b5fd56fc710ea3b07a3a2b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 0cb65564e022fface5ada4de8e0c2c4c3d0ac8ad Author: NIIBE Yutaka Date: Thu Sep 27 16:45:27 2018 +0900 g10,scd: Support UIF changing command. * g10/card-util.c (uif, cmdUIF): New. (card_edit): Add call to uif by cmdUIF. * scd/app-openpgp.c (do_getattr): Support UIF-1, UIF-2, and UIF-3. (do_setattr): Likewise. (do_learn_status): Learn UIF-1, UIF-2, and UIF-3. -- GnuPG-bug-id: 4158 Signed-off-by: NIIBE Yutaka diff --git a/g10/card-util.c b/g10/card-util.c index 779e9d8..b95efa8 100644 --- a/g10/card-util.c +++ b/g10/card-util.c @@ -2109,6 +2109,28 @@ kdf_setup (const char *args) leave: agent_release_card_info (&info); } + +static void +uif (int arg_number, const char *arg_rest) +{ + gpg_error_t err; + char name[100]; + unsigned char data[2]; + + snprintf (name, sizeof name, "UIF-%d", arg_number); + if ( !strcmp (arg_rest, "off") ) + data[0] = 0x00; + else if ( !strcmp (arg_rest, "on") ) + data[0] = 0x01; + else if ( !strcmp (arg_rest, "permanent") ) + data[0] = 0x02; + + data[1] = 0x20; + + err = agent_scd_setattr (name, data, 2, NULL); + if (err) + log_error (_("error for setup UIF: %s\n"), gpg_strerror (err)); +} /* Data used by the command parser. This needs to be outside of the function scope to allow readline based command completion. */ @@ -2119,7 +2141,7 @@ enum cmdids cmdNAME, cmdURL, cmdFETCH, cmdLOGIN, cmdLANG, cmdSEX, cmdCAFPR, cmdFORCESIG, cmdGENERATE, cmdPASSWD, cmdPRIVATEDO, cmdWRITECERT, cmdREADCERT, cmdUNBLOCK, cmdFACTORYRESET, cmdKDFSETUP, - cmdKEYATTR, + cmdKEYATTR, cmdUIF, cmdINVCMD }; @@ -2151,10 +2173,11 @@ static struct { "generate", cmdGENERATE, 1, N_("generate new keys")}, { "passwd" , cmdPASSWD, 0, N_("menu to change or unblock the PIN")}, { "verify" , cmdVERIFY, 0, N_("verify the PIN and list all data")}, - { "unblock" , cmdUNBLOCK,0, N_("unblock the PIN using a Reset Code") }, + { "unblock" , cmdUNBLOCK,0, N_("unblock the PIN using a Reset Code")}, { "factory-reset", cmdFACTORYRESET, 1, N_("destroy all keys and data")}, { "kdf-setup", cmdKDFSETUP, 1, N_("setup KDF for PIN authentication")}, { "key-attr", cmdKEYATTR, 1, N_("change the key attribute")}, + { "uif", cmdUIF, 1, N_("change the User Interaction Flag")}, /* Note, that we do not announce these command yet. */ { "privatedo", cmdPRIVATEDO, 0, NULL }, { "readcert", cmdREADCERT, 0, NULL }, @@ -2446,6 +2469,14 @@ card_edit (ctrl_t ctrl, strlist_t commands) key_attr (); break; + case cmdUIF: + if ( arg_number < 1 || arg_number > 3 ) + tty_printf ("usage: uif N [on|off|permanent]\n" + " 1 <= N <= 3\n"); + else + uif (arg_number, arg_rest); + break; + case cmdQUIT: goto leave; diff --git a/scd/app-openpgp.c b/scd/app-openpgp.c index c174525..8df9fab 100644 --- a/scd/app-openpgp.c +++ b/scd/app-openpgp.c @@ -119,8 +119,11 @@ static struct { { 0x0104, 0, 0, 0, 0, 0, 0, 2, "Private DO 4"}, { 0x7F21, 1, 0, 1, 0, 0, 0, 1, "Cardholder certificate"}, /* V3.0 */ - { 0x7F74, 0, 0, 1, 0, 0, 0, 0, "General Feature Management"}, + { 0x7F74, 0, 0x6E, 1, 0, 0, 0, 0, "General Feature Management"}, { 0x00D5, 0, 0, 1, 0, 0, 0, 0, "AES key data"}, + { 0x00D6, 0, 0x6E, 1, 0, 0, 0, 0, "UIF for Signature"}, + { 0x00D7, 0, 0x6E, 1, 0, 0, 0, 0, "UIF for decryption"}, + { 0x00D8, 0, 0x6E, 1, 0, 0, 0, 0, "UIF for authentication"}, { 0x00F9, 0, 0, 1, 0, 0, 0, 0, "KDF data object"}, { 0 } }; @@ -985,6 +988,9 @@ do_getattr (app_t app, ctrl_t ctrl, const char *name) { "PRIVATE-DO-4", 0x0104 }, { "$AUTHKEYID", 0x0000, -3 }, { "$DISPSERIALNO",0x0000, -4 }, + { "UIF-1", 0x00D6, 0 }, + { "UIF-2", 0x00D7, 0 }, + { "UIF-3", 0x00D8, 0 }, { "KDF", 0x00F9 }, { NULL, 0 } }; @@ -1827,6 +1833,9 @@ do_learn_status (app_t app, ctrl_t ctrl, unsigned int flags) do_getattr (app, ctrl, "CA-FPR"); do_getattr (app, ctrl, "CHV-STATUS"); do_getattr (app, ctrl, "SIG-COUNTER"); + do_getattr (app, ctrl, "UIF-1"); + do_getattr (app, ctrl, "UIF-2"); + do_getattr (app, ctrl, "UIF-3"); if (app->app_local->extcap.private_dos) { do_getattr (app, ctrl, "PRIVATE-DO-1"); @@ -2459,6 +2468,9 @@ do_setattr (app_t app, const char *name, { "SM-KEY-MAC", 0x00D2, 3, 0, 1 }, { "KEY-ATTR", 0, 0, 3, 1 }, { "AESKEY", 0x00D5, 3, 0, 1 }, + { "UIF-1", 0x00D6, 3, 0, 1 }, + { "UIF-2", 0x00D7, 3, 0, 1 }, + { "UIF-3", 0x00D8, 3, 0, 1 }, { "KDF", 0x00F9, 3, 4, 1 }, { NULL, 0 } }; @@ -2839,10 +2851,10 @@ do_change_pin (app_t app, ctrl_t ctrl, const char *chvnostr, pincb (pincb_arg, NULL, NULL); /* Dismiss the prompt. */ } else - { + { rc = pin2hash_if_kdf (app, chvno, oldpinvalue, &pinlen0); if (!rc) - rc = pin2hash_if_kdf (app, chvno, pinvalue, &pinlen); + rc = pin2hash_if_kdf (app, chvno, pinvalue, &pinlen); if (!rc) rc = iso7816_change_reference_data (app->slot, 0x80 + chvno, oldpinvalue, pinlen0, ----------------------------------------------------------------------- Summary of changes: g10/card-util.c | 35 +++++++++++++++++++++++++++++++++-- scd/app-openpgp.c | 18 +++++++++++++++--- 2 files changed, 48 insertions(+), 5 deletions(-) hooks/post-receive -- The GNU Privacy Guard http://git.gnupg.org From cvs at cvs.gnupg.org Thu Sep 27 15:25:09 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Thu, 27 Sep 2018 15:25:09 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-310-gce045a1 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via ce045a1ef9c63042fcffb5487b19646d67addba0 (commit) via a047e0f68ef471097e514665249063f267257b19 (commit) from 1d40d360bccb05b4c66313a60a902d04a0d3c9ff (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit ce045a1ef9c63042fcffb5487b19646d67addba0 Author: Ben McGinnes Date: Thu Sep 27 23:23:37 2018 +1000 example: local signatures * lang/python/examples/howto/local-sign-group.py: added the bit where specifying the signing key is actually used for signing rather than just pruning the list of keys to certify. Signed-off-by: Ben McGinnes diff --git a/lang/python/examples/howto/local-sign-group.py b/lang/python/examples/howto/local-sign-group.py index 812042d..0353646 100755 --- a/lang/python/examples/howto/local-sign-group.py +++ b/lang/python/examples/howto/local-sign-group.py @@ -115,12 +115,32 @@ for i in range(len(lines)): defkey_fpr = dline.split(":")[-1].replace('"', '').split(',')[0].upper() enckey_fpr = eline.split(":")[-1].replace('"', '').split(',')[0].upper() +try: + dkey = c.keylist(pattern=defkey_fpr, secret=True) + dk = list(dkey) +except Exception as de: + print(de) + dk = None + print("No valid default key.") + +try: + ekey = c.keylist(pattern=defkey_fpr, secret=True) + ek = list(ekey) +except Exception as ee: + print(ee) + ek = None + print("No valid always encrypt to key.") + if sigkey is not None: - mykey = c.keylist(pattern=sigkey) + mykey = c.keylist(pattern=sigkey, secret=True) mk = list(mykey) mkfpr = mk[0].fpr.upper() + c.signers = mk else: - pass + if dk is None and ek is not None: + c.signers = ek + else: + pass for group in group_lists: if group[0] == clique: commit a047e0f68ef471097e514665249063f267257b19 Author: Ben McGinnes Date: Thu Sep 27 22:45:37 2018 +1000 example: python bindings * lang/python/examples/howto/local-sign-group.py: locally sign every key in a group line except one's own keys. Intended to address the sort of thing one might see on lists like PGPNET or other closed groups amongst activists, journalists, etc. where everyone encrypts to all recipients, but may not sign everyone's keys publicly.. Signed-off-by: Ben McGinnes diff --git a/lang/python/examples/howto/local-sign-group.py b/lang/python/examples/howto/local-sign-group.py new file mode 100755 index 0000000..812042d --- /dev/null +++ b/lang/python/examples/howto/local-sign-group.py @@ -0,0 +1,163 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, unicode_literals + +import gpg +import os.path +import subprocess +import sys + +from groups import group_lists + +# Copyright (C) 2018 Ben McGinnes +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation; either version 2 of the License, or (at your option) any later +# version. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU General Public License and the GNU +# Lesser General Public along with this program; if not, see +# . + +print(""" +This script applies a local signature or certification to every key in a group. + +Usage: local-sign-group.py [signing keyid] [gnupg homedir] +""") + +c = gpg.Context(armor=True) +mkfpr = None +defkey_fpr = None +enckey_fpr = None +to_certify = [] + +if len(sys.argv) >= 4: + clique = sys.argv[1] + sigkey = sys.argv[2] + homedir = sys.argv[3] +elif len(sys.argv) == 3: + clique = sys.argv[1] + sigkey = sys.argv[2] + homedir = input("Enter the GPG configuration directory path (optional): ") +elif len(sys.argv) == 2: + clique = sys.argv[1] + sigkey = input("Enter the key ID to sign with (conditionally optional): ") + homedir = input("Enter the GPG configuration directory path (optional): ") +else: + clique = input("Enter the group matching the key(s) to locally sign: ") + sigkey = input("Enter the key ID to sign with (conditionally optional): ") + homedir = input("Enter the GPG configuration directory path (optional): ") + +if len(homedir) == 0: + homedir = None +elif homedir.startswith("~"): + userdir = os.path.expanduser(homedir) + if os.path.exists(userdir) is True: + homedir = os.path.realpath(userdir) + else: + homedir = None +else: + homedir = os.path.realpath(homedir) + +if homedir is not None and os.path.exists(homedir) is False: + homedir = None +elif homedir is not None and os.path.exists(homedir) is True: + if os.path.isdir(homedir) is False: + homedir = None + else: + pass + +if homedir is not None: + c.home_dir = homedir +else: + pass + +if len(sigkey) == 0: + sigkey = None +else: + pass + +if sys.platform == "win32": + gpgconfcmd = "gpgconf.exe --list-options gpg" +else: + gpgconfcmd = "gpgconf --list-options gpg" + +try: + lines = subprocess.getoutput(gpgconfcmd).splitlines() +except: + process = subprocess.Popen(gpgconfcmd.split(), stdout=subprocess.PIPE) + procom = process.communicate() + if sys.version_info[0] == 2: + lines = procom[0].splitlines() + else: + lines = procom[0].decode().splitlines() + +for i in range(len(lines)): + if lines[i].startswith("default-key") is True: + dline = lines[i] + elif lines[i].startswith("encrypt-to") is True: + eline = lines[i] + else: + pass + +defkey_fpr = dline.split(":")[-1].replace('"', '').split(',')[0].upper() +enckey_fpr = eline.split(":")[-1].replace('"', '').split(',')[0].upper() + +if sigkey is not None: + mykey = c.keylist(pattern=sigkey) + mk = list(mykey) + mkfpr = mk[0].fpr.upper() +else: + pass + +for group in group_lists: + if group[0] == clique: + for logrus in group[1]: + khole = c.keylist(pattern=logrus) + k = list(khole) + to_certify.append(k[0].fpr.upper()) + else: + pass + +if mkfpr is not None: + if to_certify.count(mkfpr) > 0: + for n in range(to_certify.count(mkfpr)): + to_certify.remove(mkfpr) + else: + pass +else: + pass + +if defkey_fpr is not None: + if to_certify.count(defkey_fpr) > 0: + for n in range(to_certify.count(defkey_fpr)): + to_certify.remove(defkey_fpr) + else: + pass +else: + pass + +if enckey_fpr is not None: + if to_certify.count(enckey_fpr) > 0: + for n in range(to_certify.count(enckey_fpr)): + to_certify.remove(enckey_fpr) + else: + pass +else: + pass + +for fpr in to_certify: + key = c.get_key(fpr) + c.key_sign(key, uids=None, expires_in=False, local=True) ----------------------------------------------------------------------- Summary of changes: lang/python/examples/howto/local-sign-group.py | 183 +++++++++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100755 lang/python/examples/howto/local-sign-group.py hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Fri Sep 28 13:50:36 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Fri, 28 Sep 2018 13:50:36 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-64-gd878480 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via d87848059727587be1f660283e0aeb3be16cc382 (commit) via 1182155ba3d186bb4437fef82693ab501277be39 (commit) via 2ccbfc0ace9f50c788d1e630215a5148aef8b9f5 (commit) via b18f00540c1a78d7700f8cf8d48dbfbff3c1b83f (commit) via 13e84a8f612a793f19155779e4cdfc71c7a70d78 (commit) via c186f2832294737ada9de6d23e466c106537676f (commit) via 8785d7e7777d749413432a5d294e4f3cc9588fa4 (commit) from a20d413e04778f529f885d0ebe7adf7d7077d436 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit d87848059727587be1f660283e0aeb3be16cc382 Author: Andre Heinecke Date: Fri Sep 28 13:45:08 2018 +0200 Ignore Content-Id for Cnt-Disp: attachment * src/mimedataprovider.cpp (t2body): Ignore content-id. -- This should hopefully cover all cases where attachments were hidden although they should have been shown. Outlook itself seems to make the difference based on Content-Disposition. According to documentation there are also ATTACH_FLAGS set in case an attachment is hidden due to MHTML embeds. But modifying those did not have an effect. GnuPG-Bug-Id: T4161 diff --git a/src/mimedataprovider.cpp b/src/mimedataprovider.cpp index ad09c62..01841da 100644 --- a/src/mimedataprovider.cpp +++ b/src/mimedataprovider.cpp @@ -189,6 +189,7 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) char *filename = NULL; char *cid = NULL; char *charset = NULL; + bool ignore_cid = false; /* Figure out the encoding. */ ctx->is_qp_encoded = 0; @@ -215,6 +216,14 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) filename = rfc2047_parse (s); s = rfc822parse_query_parameter (field, NULL, 1); + if (s && strstr (s, "attachment")) + { + log_debug ("%s:%s: Found Content-Disposition attachment." + " Ignoring content-id to avoid hiding.", + SRCNAME, __func__); + ignore_cid = true; + } + /* This is a bit of a taste matter how to treat inline attachments. Outlook does not show them inline so we should not put it in the body either as we have @@ -269,13 +278,15 @@ t2body (MimeDataProvider *provider, rfc822parse_t msg) } /* Parse a Content Id header */ - p = rfc822parse_get_field (msg, "Content-Id", -1, &off); - if (p) + if (!ignore_cid) { - cid = xstrdup (p+off); - xfree (p); + p = rfc822parse_get_field (msg, "Content-Id", -1, &off); + if (p) + { + cid = xstrdup (p+off); + xfree (p); + } } - /* Update our idea of the entire MIME structure. */ { mimestruct_item_t ms; commit 1182155ba3d186bb4437fef82693ab501277be39 Author: Andre Heinecke Date: Fri Sep 28 13:43:41 2018 +0200 Improve attachment add debug output * src/mail.cpp (fixup_last_attachment_o): Add a non working experiment. Improve debugging. * src/oomhelp.h (PR_ATTACH_FLAGS_DASL): New. -- The experiment to remove the ATTACH_FLAGS should work in theory and according to documentation. In practice it does not work :-( But maybe we can figure this out later. diff --git a/src/mail.cpp b/src/mail.cpp index bef35de..9e1c8d2 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -643,7 +643,8 @@ copy_attachment_to_file (std::shared_ptr att, HANDLE hFile) /** Sets some meta data on the last attachment added. The meta data is taken from the attachment object. */ static int -fixup_last_attachment_o (LPDISPATCH mail, std::shared_ptr attachment) +fixup_last_attachment_o (LPDISPATCH mail, + std::shared_ptr attachment) { TSTART; /* Currently we only set content id */ @@ -661,9 +662,46 @@ fixup_last_attachment_o (LPDISPATCH mail, std::shared_ptr attachment SRCNAME, __func__); TRETURN 1; } + const std::string cid = attachment->get_content_id (); int ret = put_pa_string (attach, PR_ATTACH_CONTENT_ID_DASL, - attachment->get_content_id ().c_str()); + cid.c_str()); + + log_debug ("%s:%s: Set attachment content id to: '%s'", + SRCNAME, __func__, anonstr (cid.c_str())); + if (ret) + { + log_error ("%s:%s: Failed.", SRCNAME, __func__); + gpgol_release (attach); + } +#if 0 + + The following was an experiement to delete the ATTACH_FLAGS values + so that we are not hiding attachments. + + LPATTACH mapi_attach = (LPATTACH) get_oom_iunknown (attach, "MAPIOBJECT"); + if (mapi_attach) + { + SPropTagArray proparray; + HRESULT hr; + + proparray.cValues = 1; + proparray.aulPropTag[0] = 0x37140003; + hr = mapi_attach->DeleteProps (&proparray, NULL); + if (hr) + { + log_error ("%s:%s: can't delete property attach flags: hr=%#lx\n", + SRCNAME, __func__, hr); + ret = -1; + } + gpgol_release (mapi_attach); + } + else + { + log_error ("%s:%s: Failed to get mapi attachment.", + SRCNAME, __func__); + } +#endif gpgol_release (attach); TRETURN ret; } @@ -730,6 +768,8 @@ add_attachments_o(LPDISPATCH mail, if (!err) { + log_debug ("%s:%s: Added attachment '%s'", + SRCNAME, __func__, anonstr (dispName.c_str())); err = fixup_last_attachment_o (mail, att); } if (err) diff --git a/src/oomhelp.h b/src/oomhelp.h index 043276a..b922333 100644 --- a/src/oomhelp.h +++ b/src/oomhelp.h @@ -129,6 +129,9 @@ DEFINE_OLEGUID(IID_IOleWindow, 0x00000114, 0, 0); "http://schemas.microsoft.com/mapi/proptag/0x370E001F" #define PR_ATTACH_CONTENT_ID_DASL \ "http://schemas.microsoft.com/mapi/proptag/0x3712001F" +#define PR_ATTACH_FLAGS_DASL \ + "http://schemas.microsoft.com/mapi/proptag/0x37140003" + #define PR_TAG_SENDER_SMTP_ADDRESS \ "http://schemas.microsoft.com/mapi/proptag/0x5D01001F" #define PR_TAG_RECEIVED_REPRESENTING_SMTP_ADDRESS \ commit 2ccbfc0ace9f50c788d1e630215a5148aef8b9f5 Author: Andre Heinecke Date: Fri Sep 28 13:35:18 2018 +0200 Fix error message in keycache lookup * src/keycache.cpp (do_update): Fix error / debug output. diff --git a/src/keycache.cpp b/src/keycache.cpp index b62884b..268accf 100644 --- a/src/keycache.cpp +++ b/src/keycache.cpp @@ -129,8 +129,9 @@ do_update (LPVOID arg) } if (err) { - log_debug ("%s:%s Failed to find key for %s err: ", - SRCNAME, __func__, err.asString ()); + log_debug ("%s:%s Failed to find key for %s err: %s", + SRCNAME, __func__, anonstr (args->first.c_str()), + err.asString ()); } KeyCache::instance ()->onUpdateJobDone (args->first.c_str(), newKey); commit b18f00540c1a78d7700f8cf8d48dbfbff3c1b83f Author: Andre Heinecke Date: Fri Sep 28 13:33:42 2018 +0200 Ignore reads when shutdown was triggered * src/gpgoladdin.cpp (GpgolAddin::shutdown): Set state variable at begin of shutdown. * src/mailitem-events.cpp (BeforeRead): Ignore when shutting down. -- This happened when we are closing and closing all mails but there are multiple inspectors around e.g. if the mail is open in Outlook Spy. In that case Outlook tries to read it again immediately after close. diff --git a/src/gpgoladdin.cpp b/src/gpgoladdin.cpp index 5f12ab8..acc1969 100644 --- a/src/gpgoladdin.cpp +++ b/src/gpgoladdin.cpp @@ -1192,6 +1192,7 @@ GpgolAddin::shutdown () return; } + m_shutdown = true; /* Disabling message hook */ UnhookWindowsHookEx (m_hook); @@ -1225,7 +1226,6 @@ GpgolAddin::shutdown () _("GpgOL"), MB_ICONINFORMATION|MB_OK); } - m_shutdown = true; gpgol_release (m_application); m_application = nullptr; diff --git a/src/mailitem-events.cpp b/src/mailitem-events.cpp index b02ad0e..7a741c0 100644 --- a/src/mailitem-events.cpp +++ b/src/mailitem-events.cpp @@ -173,6 +173,13 @@ EVENT_SINK_INVOKE(MailItemEvents) { log_oom ("%s:%s: BeforeRead : %p", SRCNAME, __func__, m_mail); + if (GpgolAddin::get_instance ()->isShutdown()) + { + log_debug ("%s:%s: Ignoring read after shutdown.", + SRCNAME, __func__); + TBREAK; + } + if (m_mail->preProcessMessage_m ()) { log_error ("%s:%s: Pre process message failed.", commit 13e84a8f612a793f19155779e4cdfc71c7a70d78 Author: Andre Heinecke Date: Fri Sep 28 13:32:31 2018 +0200 Fix potential crash in revert * src/revert.cpp (gpgol_mailitem_revert): Bail out if msg class is NULL. -- This happened to me in a weird close scenario where I had multiple outlook spy windows open. diff --git a/src/revert.cpp b/src/revert.cpp index bd0b647..2b5db94 100644 --- a/src/revert.cpp +++ b/src/revert.cpp @@ -96,6 +96,10 @@ gpgol_mailitem_revert (LPDISPATCH mailitem) msgcls = get_pa_string (mailitem, PR_MESSAGE_CLASS_W_DASL); log_debug ("%s:%s: message class is `%s'\n", SRCNAME, __func__, msgcls? msgcls:"[none]"); + if (!msgcls) + { + return -1; + } if ( !( !strncmp (msgcls, "IPM.Note.GpgOL", 14) && (!msgcls[14] || msgcls[14] == '.') ) ) { commit c186f2832294737ada9de6d23e466c106537676f Author: Andre Heinecke Date: Wed Sep 26 15:47:48 2018 +0200 Show signer KeyID and UserID for valid mails * src/mail.cpp (Mail::updateSigFlag_o): Set the flag. (Mail::flagChangeTriggered): New helper to carry the state. (pretty_id): Helper to format a fingerprint / long keyid. * src/mailitem-events.cpp (PropertyChange): Ignore our own changes. -- This has two purposes. If the name of the sender is large or looks like a mail address it is not visible at first glance which key was used to verify as the real mail address might be out of the screen. Additionally this serves as another split between the Verified Sender category and the body to make it even harder to undetectable fake this through HTML. It is never possible to fake it or replace it together with the changed status icon. diff --git a/src/mail.cpp b/src/mail.cpp index d3b0f0d..bef35de 100644 --- a/src/mail.cpp +++ b/src/mail.cpp @@ -104,7 +104,8 @@ Mail::Mail (LPDISPATCH mailitem) : m_first_autosecure_check(true), m_locate_count(0), m_is_about_to_be_moved(false), - m_locate_in_progress(false) + m_locate_in_progress(false), + m_flag_change_triggered(false) { TSTART; if (getMailForItem (mailitem)) @@ -1408,6 +1409,10 @@ Mail::parsing_done() updateCategories_o (); TRACEPOINT; + /* Show the signers uid as a flag */ + updateSigFlag_o (); + TRACEPOINT; + m_block_html = m_parser->shouldBlockHtml (); if (m_block_html) @@ -2238,6 +2243,84 @@ Mail::updateCategories_o () TRETURN; } +static std::string +pretty_id (const char *keyId) +{ + /* Three spaces, four quads and a NULL */ + char buf[20]; + buf[19] = '\0'; + if (!keyId) + { + return std::string ("null"); + } + size_t len = strlen (keyId); + if (!len) + { + return std::string ("empty"); + } + if (len < 16) + { + return std::string (_("Invalid Key")); + } + const char *p = keyId + (len - 16); + int j = 0; + for (size_t i = 0; i < 16; i++) + { + if (i && i % 4 == 0) + { + buf[j++] = ' '; + } + buf[j++] = *(p + i); + } + return std::string (buf); +} + +void +Mail::updateSigFlag_o () +{ + TSTART; + if (isValidSig ()) + { + char *buf; + /* Resolve to the primary fingerprint */ + const auto sigKey = KeyCache::instance ()->getByFpr (m_sig.fingerprint (), + true); + const char *sigFpr; + if (sigKey.isNull()) + { + sigFpr = m_sig.fingerprint (); + } + else + { + sigFpr = sigKey.primaryFingerprint (); + } + + gpgrt_asprintf (&buf, "%s: %s (%s)", _("Signer"), m_uid.email(), + pretty_id (sigFpr).c_str ()); + memdbg_alloc (buf); + log_debug ("%s:%s: Setting signer flag %s", + SRCNAME, __func__, anonstr (buf)); + m_flag_change_triggered = true; + put_oom_string (m_mailitem, "FlagRequest", buf); + m_flag_change_triggered = false; + xfree (buf); + } + else + { + char *flag = get_oom_string (m_mailitem, "FlagRequest"); + if (flag && (strstr (flag, _("Signer")) || strstr (flag, "Signer"))) + { + m_flag_change_triggered = true; + log_debug ("%s:%s: Removing flag containting Signer.", + SRCNAME, __func__); + put_oom_string (m_mailitem, "FlagRequest", ""); + m_flag_change_triggered = false; + } + xfree (flag); + } + TRETURN; +} + bool Mail::isSigned () const { diff --git a/src/mail.h b/src/mail.h index c4f2369..d925dde 100644 --- a/src/mail.h +++ b/src/mail.h @@ -598,7 +598,11 @@ public: /* Gets an additional reference for GetInspector.CurrentItem */ void refCurrentItem (); + /* Check if a flag change was triggered and can be ignored. */ + bool flagChangeTriggered () const { return m_flag_change_triggered; } + private: + void updateSigFlag_o (); void updateCategories_o (); void updateSigstate (); @@ -649,5 +653,6 @@ private: int m_locate_count; /* The number of key locates pending for this mail. */ bool m_is_about_to_be_moved; bool m_locate_in_progress; /* Simplified state variable for locate */ + bool m_flag_change_triggered; /* We trigger a flagrequest change */ }; #endif // MAIL_H diff --git a/src/mailitem-events.cpp b/src/mailitem-events.cpp index 31acc40..b02ad0e 100644 --- a/src/mailitem-events.cpp +++ b/src/mailitem-events.cpp @@ -263,6 +263,14 @@ EVENT_SINK_INVOKE(MailItemEvents) TRETURN S_OK; } } + if (m_mail->flagChangeTriggered () && + (!wcscmp (prop_name, L"FlagStatus") || !wcscmp (prop_name, L"FlagRequest") || + !wcscmp (prop_name, L"FlagIcon") || !wcscmp (prop_name, L"FlagDueBy"))) + { + log_oom ("%s:%s: Message %p propchange: %ls was requested.", + SRCNAME, __func__, m_object, prop_name); + TRETURN S_OK; + } log_oom ("%s:%s: Message %p propchange: %ls.", SRCNAME, __func__, m_object, prop_name); commit 8785d7e7777d749413432a5d294e4f3cc9588fa4 Author: Andre Heinecke Date: Wed Sep 26 15:46:52 2018 +0200 Add sender name and repr name DASL * src/oomhelp.h: Add new defines. -- We do not need them right now but I've used them for experiments. diff --git a/src/oomhelp.h b/src/oomhelp.h index 1882057..043276a 100644 --- a/src/oomhelp.h +++ b/src/oomhelp.h @@ -140,6 +140,11 @@ DEFINE_OLEGUID(IID_IOleWindow, 0x00000114, 0, 0); #define PR_SENT_REPRESENTING_EMAIL_ADDRESS_W_DASL \ "http://schemas.microsoft.com/mapi/proptag/0x0065001F" +#define PR_SENDER_NAME_W_DASL \ + "http://schemas.microsoft.com/mapi/proptag/0x0C1A001F" +#define PR_SENT_REPRESENTING_NAME_W_DASL \ + "http://schemas.microsoft.com/mapi/proptag/0x0042001F" + #define DISTRIBUTION_LIST_ADDRESS_ENTRY_TYPE 11 typedef std::shared_ptr shared_disp_t; ----------------------------------------------------------------------- Summary of changes: src/gpgoladdin.cpp | 2 +- src/keycache.cpp | 5 +- src/mail.cpp | 129 +++++++++++++++++++++++++++++++++++++++++++++-- src/mail.h | 5 ++ src/mailitem-events.cpp | 15 ++++++ src/mimedataprovider.cpp | 21 ++++++-- src/oomhelp.h | 8 +++ src/revert.cpp | 4 ++ 8 files changed, 178 insertions(+), 11 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Fri Sep 28 15:14:53 2018 From: cvs at cvs.gnupg.org (by Andre Heinecke) Date: Fri, 28 Sep 2018 15:14:53 +0200 Subject: [git] GpgOL - branch, master, updated. gpgol-2.3.0-65-g68191e5 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG extension for MS Outlook". The branch, master has been updated via 68191e53049bf88aab4dbbab5427b5d0c90ead05 (commit) from d87848059727587be1f660283e0aeb3be16cc382 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 68191e53049bf88aab4dbbab5427b5d0c90ead05 Author: Andre Heinecke Date: Fri Sep 28 14:40:57 2018 +0200 Fix two encoding issues * src/ribbon-callbacks.cpp (launch_cert_details): Use MessageBoxW. diff --git a/src/ribbon-callbacks.cpp b/src/ribbon-callbacks.cpp index 4587395..2d3604c 100644 --- a/src/ribbon-callbacks.cpp +++ b/src/ribbon-callbacks.cpp @@ -696,9 +696,13 @@ HRESULT launch_cert_details (LPDISPATCH ctrl) gpgrt_asprintf (&buf, _("The message was not cryptographically signed.\n" "There is no additional information available if it " "was actually sent by '%s' or if someone faked the sender address."), mail->getSender_o ().c_str()); - MessageBox (NULL, buf, _("GpgOL"), - MB_ICONINFORMATION|MB_OK); + wchar_t *w_msg = utf8_to_wchar (buf); + wchar_t *w_title = utf8_to_wchar (_("GpgOL")); + MessageBoxW (NULL, w_msg, w_title, + MB_ICONINFORMATION|MB_OK); xfree (buf); + xfree (w_msg); + xfree (w_title); return S_OK; } @@ -756,11 +760,13 @@ HRESULT launch_cert_details (LPDISPATCH ctrl) if (showError) { - MessageBox (NULL, - _("Could not find Kleopatra.\n" - "Please reinstall Gpg4win with the Kleopatra component enabled."), - _("GpgOL"), - MB_ICONINFORMATION|MB_OK); + wchar_t *w_title = utf8_to_wchar (_("GpgOL")); + wchar_t *w_msg = utf8_to_wchar (_("Could not find Kleopatra.\n" + "Please reinstall Gpg4win with the Kleopatra component enabled.")); + MessageBoxW (NULL, w_msg, w_title, + MB_ICONINFORMATION|MB_OK); + xfree (w_title); + xfree (w_msg); } return S_OK; } ----------------------------------------------------------------------- Summary of changes: src/ribbon-callbacks.cpp | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) hooks/post-receive -- GnuPG extension for MS Outlook http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 30 08:37:59 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 30 Sep 2018 08:37:59 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-311-g11403a4 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 11403a46358f9b6e98776974f3c70f211d9adf85 (commit) from ce045a1ef9c63042fcffb5487b19646d67addba0 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 11403a46358f9b6e98776974f3c70f211d9adf85 Author: Ben McGinnes Date: Sun Sep 30 16:28:54 2018 +1000 python bindings: ctx.decrypt * lang/python/src/core.py: Fixed methods of detecting whether verify is a boolean variable or a list. * Added methods of catching the missing keys exceptions. * Still retained PEP8 compliance (which might have been where one or two problems crept in). * Though this is essentially the correct behaviour, it still does not quite fit the otiginal test; so that will also require some adjustment. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/lang/python/src/core.py b/lang/python/src/core.py index f440d92..17ec0ef 100644 --- a/lang/python/src/core.py +++ b/lang/python/src/core.py @@ -366,6 +366,8 @@ class Context(GpgmeWrapper): GPGMEError -- as signaled by the underlying library """ + sink_result = None + verify_sigs = None plaintext = sink if sink else Data() if passphrase is not None: @@ -379,13 +381,29 @@ class Context(GpgmeWrapper): self.set_passphrase_cb(passphrase_cb) try: - if verify: + if verify is not None: + if isinstance(verify, bool) is True: + if verify is False: + verify = True + sink_result = True + else: + pass + elif isinstance(verify, list) is True: + if len(verify) > 0: + verify_sigs = True + else: + pass + else: + verify = True self.op_decrypt_verify(ciphertext, plaintext) else: self.op_decrypt(ciphertext, plaintext) except errors.GPGMEError as e: result = self.op_decrypt_result() - verify_result = self.op_verify_result() if verify else None + if verify is not None and sink_result is None: + verify_result = self.op_verify_result() + else: + verify_result = None # Just raise the error, but attach the results first. e.results = (self.__read__(sink, plaintext), result, verify_result) raise e @@ -396,19 +414,25 @@ class Context(GpgmeWrapper): self.set_passphrase_cb(*old_passphrase_cb[1:]) result = self.op_decrypt_result() - verify_result = self.op_verify_result() if verify else None + + if verify is not None and sink_result is None: + verify_result = self.op_verify_result() + else: + verify_result = None + results = (self.__read__(sink, plaintext), result, verify_result) + if result.unsupported_algorithm: - raise errors.UnsupportedAlgorithm( - result.unsupported_algorithm, results=results) + raise errors.UnsupportedAlgorithm(result.unsupported_algorithm, + results=results) if verify: if any(s.status != errors.NO_ERROR for s in verify_result.signatures): raise errors.BadSignatures(verify_result, results=results) - if not verify: # was: if verify and verify != True: - missing = list() + if verify_sigs is not None: + missing = [] for key in verify: ok = False for subkey in key.subkeys: @@ -423,8 +447,28 @@ class Context(GpgmeWrapper): if not ok: missing.append(key) if missing: - raise errors.MissingSignatures( - verify_result, missing, results=results) + try: + raise errors.MissingSignatures(verify_result, missing, + results=results) + except errors.MissingSignatures as miss_e: + mse = miss_e + mserr = "gpg.errors.MissingSignatures:" + print(mserr, miss_e, "\n") + # # The full details can then be found in mse.results, + # # mse.result, mse.missing if necessary. + # mse_list = [] + # msp = "Missing signatures from: \n".format() + # print(msp) + # for key in mse.missing: + # mse_list.append(key.fpr) + # msl = [] + # msl.append(key.fpr) + # for user in key.uids: + # msl.append(user.name) + # msl.append(user.email) + # # msl.append(user.uid) + # print(" ".join(msl)) + return mse return results ----------------------------------------------------------------------- Summary of changes: lang/python/src/core.py | 62 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 53 insertions(+), 9 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 30 11:34:31 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 30 Sep 2018 11:34:31 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-312-g837a476 Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 837a4760533e80f075cd727f18354904b8a54132 (commit) from 11403a46358f9b6e98776974f3c70f211d9adf85 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 837a4760533e80f075cd727f18354904b8a54132 Author: Ben McGinnes Date: Sun Sep 30 19:32:45 2018 +1000 python bindings: fixing decrypt-verify * lang/python/src/core.py: First restoring the exception to the being just that. * The means to manipulate the error output is temporarily in commented out code, but ought to be added to a proper test later. * In the mean time the original test, with a very slight change, works again. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes diff --git a/lang/python/src/core.py b/lang/python/src/core.py index 17ec0ef..6e92592 100644 --- a/lang/python/src/core.py +++ b/lang/python/src/core.py @@ -450,10 +450,11 @@ class Context(GpgmeWrapper): try: raise errors.MissingSignatures(verify_result, missing, results=results) - except errors.MissingSignatures as miss_e: - mse = miss_e - mserr = "gpg.errors.MissingSignatures:" - print(mserr, miss_e, "\n") + except errors.MissingSignatures as e: + raise e + # mse = e + # mserr = "gpg.errors.MissingSignatures:" + # print(mserr, miss_e, "\n") # # The full details can then be found in mse.results, # # mse.result, mse.missing if necessary. # mse_list = [] @@ -468,7 +469,7 @@ class Context(GpgmeWrapper): # msl.append(user.email) # # msl.append(user.uid) # print(" ".join(msl)) - return mse + # raise mse return results diff --git a/lang/python/tests/t-decrypt-verify.py b/lang/python/tests/t-decrypt-verify.py index fcaa134..991d18c 100755 --- a/lang/python/tests/t-decrypt-verify.py +++ b/lang/python/tests/t-decrypt-verify.py @@ -70,7 +70,7 @@ with gpg.Context() as c: try: c.decrypt( open(support.make_filename("cipher-2.asc")), verify=[alpha, bob]) - except gpg.errors.MissingSignatures as e: + except Exception as e: assert len(e.missing) == 1 assert e.missing[0] == bob else: ----------------------------------------------------------------------- Summary of changes: lang/python/src/core.py | 11 ++++++----- lang/python/tests/t-decrypt-verify.py | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org From cvs at cvs.gnupg.org Sun Sep 30 18:14:15 2018 From: cvs at cvs.gnupg.org (by Ben McGinnes) Date: Sun, 30 Sep 2018 18:14:15 +0200 Subject: [git] GPGME - branch, master, updated. gpgme-1.11.1-313-g76bdfab Message-ID: This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GnuPG Made Easy". The branch, master has been updated via 76bdfabb057f4ffc56beee15b48d8fa836ba7cce (commit) from 837a4760533e80f075cd727f18354904b8a54132 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 76bdfabb057f4ffc56beee15b48d8fa836ba7cce Author: Ben McGinnes Date: Mon Oct 1 02:10:03 2018 +1000 docs: python bindings * Tightened up the docs a little bit, updated the "what's new" section, dropped the "-draft" version in preparation for GPGME 1.12.0's release. * Exported another .texi version (and updated the draft copies to this commit (which ought to be 1.11.1-beta313). Signed-off-by: Ben McGinnes diff --git a/doc/gpgme-python-howto.texi b/doc/gpgme-python-howto.texi index bc120d6..5f33f5d 100644 --- a/doc/gpgme-python-howto.texi +++ b/doc/gpgme-python-howto.texi @@ -79,6 +79,7 @@ Known Issues * Multiple installations:: * Won't Work With Windows:: * CFFI is the Best? and GPGME should use it instead of SWIG:: +* Virtualised Environments:: Fundamentals @@ -168,7 +169,7 @@ Copyright and Licensing @item Version: @tab 0.1.4 @item GPGME Version: - at tab 1.12.0-draft + at tab 1.12.0 @item Author: @tab @uref{https://gnupg.org/people/index.html#sec-1-5, Ben McGinnes} @item Author GPG Key: @@ -292,12 +293,20 @@ ProtonMail keyserver. @item Semi-formalised the location where @ref{Draft Editions of this HOWTO, , draft versions} of this HOWTO may periodically be accessible. This is both for the reference of -others and testing the publishing of the document itself. +others and testing the publishing of the document itself. Renamed +the file at around the same time. @item Added a new section for @ref{Advanced or Experimental Use Cases, , advanced or experimental use}. @item Began the advanced use cases with @ref{C plus Python plus SWIG plus Cython, , a section} on using the module with @uref{http://cython.org/, Cython}. + at item +Added a number of new scripts to the @samp{example/howto/} directory; +some of which may be in advance of their planned sections of the +HOWTO (and some are just there because it seemed like a good idea at +the time). + at item +Cleaned up a lot of things under the hood. @end itemize @node GPGME Concepts @@ -487,6 +496,12 @@ quite high that at least the first one and maybe two of those will already be installed. @end enumerate +Note that, as with Cython, some of the planned additions to the + at ref{Advanced or Experimental Use Cases, , Advanced} section, will bring with them additional requirements. Most +of these will be fairly well known and commonly installed ones, +however, which are in many cases likely to have already been installed +on many systems or be familiar to Python programmers. + @node Installation @section Installation @@ -533,6 +548,7 @@ they be encountered. * Multiple installations:: * Won't Work With Windows:: * CFFI is the Best? and GPGME should use it instead of SWIG:: +* Virtualised Environments:: @end menu @node Breaking Builds @@ -727,6 +743,70 @@ running into trouble with "ifdefs" then you'll know what sort of things are lacking. That doesn't even take into account the amount of work saved via SWIG's code generation techniques either. + at node Virtualised Environments + at subsection Virtualised Environments + +It is fairly common practice amongst Python developers to, as much as +possible, use packages like virtualenv to keep various things that are +to be installed from interfering with each other. Given how much of +the GPGME bindings is often at odds with the usual pythonic way of +doing things, it stands to reason that this would be called into +question too. + +As it happens the answer as to whether or not the bindings can be used +with virtualenv, the answer is both yes and no. + +In general we recommend installing to the relevant path and matching +prefix of GPGME itself. Which means that when GPGME, and ideally the +rest of the GnuPG stack, is installed to a prefix like @samp{/usr/local} or + at samp{/opt/local} then the bindings would need to be installed to the main +Python installation and not a virtualised abstraction. Attempts to +separate the two in the past have been known to cause weird and +intermittent errors ranging from minor annoyances to complete failures +in the build process. + +As a consequence we only recommend building with and installing to the +main Python installations within the same prefix as GPGME is installed +to or which are found by GPGME's configuration stage immediately prior +to running the make commands. Which is exactly what the compiling and +installing process of GPGME does by default. + +Once that is done, however, it appears that a copy the compiled module +may be installed into a virtualenv of the same major and minor version +matching the build. Alternatively it is possible to utilise a + at samp{sites.pth} file in the @samp{site-packages/} directory of a viertualenv +installation, which links back to the system installations +corresponding directory in order to import anything installed system +wide. This may or may not be appropriate on a case by case basis. + +Though extensive testing of either of these options is not yet +complete, preliminary testing of them indicates that both are viable +as long as the main installation is complete. Which means that +certain other options normally restricted to virtual environments are +also available, including integration with pythonic test suites +(e.g. @uref{https://docs.pytest.org/en/latest/index.html, pytest}) and other large projects. + +That said, it is worth reiterating the warning regarding non-standard +installations. If one were to attempt to install the bindings only to +a virtual environment without somehow also including the full GnuPG +stack (or enough of it as to include GPGME) then it is highly likely +that errors would be encountered at some point and more than a little +likely that the build process itself would break. + +If a degree of separation from the main operating system is still +required in spite of these warnings, then consider other forms of +virtualisation. Either a virtual machine (e.g. @uref{https://www.virtualbox.org/, VirtualBox}), a +hardware emulation layer (e.g. @uref{https://www.qemu.org/, QEMU}) or an application container +(e.g. @uref{https://www.docker.com/why-docker, Docker}). + +Finally it should be noted that the limited tests conducted thus far +have been using the @samp{virtualenv} command in a new directory to create +the virtual python environment. As opposed to the standard @samp{python3 +-m venv} and it is possible that this will make a difference depending +on the system and version of Python in use. Another option is to run +the command @samp{python3 -m virtualenv /path/to/install/virtual/thingy} +instead. + @node Fundamentals @chapter Fundamentals @@ -875,6 +955,13 @@ print(""" """.format(secnum, pubnum)) @end example + at strong{NOTE:} The @ref{C plus Python plus SWIG plus Cython, , Cython} introduction in the @ref{Advanced or Experimental Use Cases, , Advanced and Experimental} +section uses this same key counting code with Cython to demonstrate +some areas where Cython can improve performance even with the +bindings. Users with large public keyrings or keyboxes, for instance, +should consider these options if they are comfortable with using +Cython. + @node Get key @section Get key @@ -2826,6 +2913,12 @@ existing code and to detect Cython's use. The latter comes from the @node Miscellaneous extras and work-arounds @chapter Miscellaneous extras and work-arounds +Most of the things in the following sections are here simply because +there was no better place to put them, even though some are only +peripherally related to the GPGME Python bindings. Some are also +workarounds for functions not integrated with GPGME as yet. This is +especially true of the first of these, dealing with @ref{Group lines, , group lines}. + @menu * Group lines:: * Keyserver access for Python:: diff --git a/lang/python/docs/gpgme-python-howto.org b/lang/python/docs/gpgme-python-howto.org index 5524fce..d3695c3 100644 --- a/lang/python/docs/gpgme-python-howto.org +++ b/lang/python/docs/gpgme-python-howto.org @@ -16,7 +16,7 @@ :END: | Version: | 0.1.4 | -| GPGME Version: | 1.12.0-draft | +| GPGME Version: | 1.12.0 | | Author: | [[https://gnupg.org/people/index.html#sec-1-5][Ben McGinnes]] | | Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E2373590E5D | | Language: | Australian English, British English | @@ -128,10 +128,16 @@ The bullet points of new additiions are: ProtonMail keyserver. - Semi-formalised the location where [[#draft-editions][draft versions]] of this HOWTO may periodically be accessible. This is both for the reference of - others and testing the publishing of the document itself. + others and testing the publishing of the document itself. Renamed + the file at around the same time. - Added a new section for [[#advanced-use][advanced or experimental use]]. - Began the advanced use cases with [[#cython][a section]] on using the module with [[http://cython.org/][Cython]]. +- Added a number of new scripts to the =example/howto/= directory; + some of which may be in advance of their planned sections of the + HOWTO (and some are just there because it seemed like a good idea at + the time). +- Cleaned up a lot of things under the hood. * GPGME Concepts @@ -320,6 +326,12 @@ a significant advantage in some way. quite high that at least the first one and maybe two of those will already be installed. +Note that, as with Cython, some of the planned additions to the +[[#advanced-use][Advanced]] section, will bring with them additional requirements. Most +of these will be fairly well known and commonly installed ones, +however, which are in many cases likely to have already been installed +on many systems or be familiar to Python programmers. + ** Installation :PROPERTIES: @@ -777,6 +789,13 @@ print(""" """.format(secnum, pubnum)) #+END_SRC +*NOTE:* The [[#cython][Cython]] introduction in the [[#advanced-use][Advanced and Experimental]] +section uses this same key counting code with Cython to demonstrate +some areas where Cython can improve performance even with the +bindings. Users with large public keyrings or keyboxes, for instance, +should consider these options if they are comfortable with using +Cython. + ** Get key :PROPERTIES: @@ -2770,6 +2789,12 @@ existing code and to detect Cython's use. The latter comes from the :CUSTOM_ID: cheats-and-hacks :END: +Most of the things in the following sections are here simply because +there was no better place to put them, even though some are only +peripherally related to the GPGME Python bindings. Some are also +workarounds for functions not integrated with GPGME as yet. This is +especially true of the first of these, dealing with [[#group-lines][group lines]]. + ** Group lines :PROPERTIES: ----------------------------------------------------------------------- Summary of changes: doc/gpgme-python-howto.texi | 97 ++++++++++++++++++++++++++++++++- lang/python/docs/gpgme-python-howto.org | 29 +++++++++- 2 files changed, 122 insertions(+), 4 deletions(-) hooks/post-receive -- GnuPG Made Easy http://git.gnupg.org