xmlsecurity/inc/certificatechooser.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <com/sun/star/uno/Sequence.hxx>
  23 #include <vcl/weld.hxx>
  24 #include <unotools/resmgr.hxx>
  25 #include <unordered_map>
  26
  27 namespace com::sun::star {
  28     namespace security { class XCertificate; }
  29     namespace xml::crypto {
  30         class XSecurityEnvironment;
  31     }
  32 }
  33
  34 namespace com::sun::star::xml::crypto { class XXMLSecurityContext; }
  35
  36 class SfxViewShell;
  37
  38 struct CertificateChooserUserData
  39 {
  40     css::uno::Reference<css::security::XCertificate> xCertificate;
  41     css::uno::Reference<css::xml::crypto::XXMLSecurityContext> xSecurityContext;
  42     css::uno::Reference<css::xml::crypto::XSecurityEnvironment> xSecurityEnvironment;
  43 };
  44
  45 enum class CertificateChooserUserAction
  46 {
  47     Sign,
  48     SelectSign, // Select signing certificate
  49     Encrypt
  50 };
  51
  52 class CertificateChooser final : public weld::GenericDialogController
  53 {
  54 private:
  55     std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > mxSecurityContexts;
  56     std::vector<std::shared_ptr<CertificateChooserUserData>> mvUserData;
  57
  58     bool                    mbInitialized;
  59     CertificateChooserUserAction const meAction;
  60     SfxViewShell* m_pViewShell;
  61     OUString                msPreferredKey;
  62     css::uno::Reference<css::security::XCertificate> mxEncryptToSelf;
  63
  64     std::unique_ptr<weld::Label>    m_xFTSign;
  65     std::unique_ptr<weld::Label>    m_xFTEncrypt;
  66     std::unique_ptr<weld::Label>    m_xFTLoadedCerts;
  67     std::unique_ptr<weld::TreeView> m_xCertLB;
  68     std::unique_ptr<weld::Button>   m_xViewBtn;
  69     std::unique_ptr<weld::Button>   m_xOKBtn;
  70     std::unique_ptr<weld::Label>    m_xFTDescription;
  71     std::unique_ptr<weld::Entry>    m_xDescriptionED;
  72     std::unique_ptr<weld::Entry>    m_xSearchBox;
  73     std::unique_ptr<weld::Button>   m_xReloadBtn;
  74
  75     std::unordered_map<css::uno::Reference< css::xml::crypto::XXMLSecurityContext>,
  76         css::uno::Sequence< css::uno::Reference< css::security::XCertificate > > > xMemCerts;
  77
  78     DECL_LINK(ReloadButtonHdl, weld::Button&, void);
  79     DECL_LINK(ViewButtonHdl, weld::Button&, void);
  80     DECL_LINK(CertificateHighlightHdl, weld::TreeView&, void);
  81     DECL_LINK(CertificateSelectHdl, weld::TreeView&, bool);
  82     DECL_LINK(SearchModifyHdl, weld::Entry&, void);
  83
  84     void ImplShowCertificateDetails();
  85     void ImplInitialize(bool mbSearch = false);
  86     void ImplReloadCertificates();
  87     static void HandleOneUsageBit(OUString& string, int& bits, int bit, TranslateId name);
  88
  89 public:
  90     CertificateChooser(weld::Window* pParent,
  91                        SfxViewShell* pViewShell,
  92                        std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > && rxSecurityContexts,
  93                        CertificateChooserUserAction eAction);
  94     virtual ~CertificateChooser() override;
  95
  96     static std::shared_ptr<CertificateChooser> getInstance(weld::Window* _pParent,
  97                         SfxViewShell* pViewShell,
  98                         std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > && rxSecurityContexts,
  99                         CertificateChooserUserAction eAction) {
 100         // Don't reuse CertificateChooser instances
 101         // Reusing the same instance will, in the following case, lead to a
 102         // crash. It appears that the CertificateChooser is getting disposed
 103         // somewhere as mpDialogImpl in its base class ends up being null:
 104         // 1. Create an empty Writer document and add a digital signature
 105         //    in the Digital Signatures dialog
 106         // 2. File > Save As the document, check the "Encrypt with GPG key"
 107         //    checkbox, press Encrypt, and crash in Dialog::ImplStartExecute()
 108         return std::make_shared<CertificateChooser>(_pParent, pViewShell, std::move(rxSecurityContexts), eAction);
 109     }
 110
 111     void BeforeRun();
 112     short run() override;
 113
 114     css::uno::Sequence<css::uno::Reference< css::security::XCertificate > > GetSelectedCertificates();
 115     css::uno::Reference< css::xml::crypto::XXMLSecurityContext > GetSelectedSecurityContext() const;
 116     /// Gets the description string provided when selecting the certificate.
 117     OUString GetDescription() const;
 118
 119     /// Returns the usage string of the selected certificate, if any.
 120     OUString GetUsageText();
 121
 122     static OUString UsageInClearText(int bits);
 123 };
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */