Bump version to 24.04.3.4
[LibreOffice.git] / xmlsecurity / inc / certificatechooser.hxx
blobb0cf7c7cdcc4a7c369fad27b2344e41a504144c7
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #pragma once
22 #include <com/sun/star/uno/Sequence.hxx>
23 #include <vcl/weld.hxx>
24 #include <unotools/resmgr.hxx>
25 #include <unotools/useroptions.hxx>
26 #include <unordered_map>
28 namespace com::sun::star {
29 namespace security { class XCertificate; }
30 namespace xml::crypto {
31 class XSecurityEnvironment;
35 namespace com::sun::star::xml::crypto { class XXMLSecurityContext; }
37 struct UserData
39 css::uno::Reference<css::security::XCertificate> xCertificate;
40 css::uno::Reference<css::xml::crypto::XXMLSecurityContext> xSecurityContext;
41 css::uno::Reference<css::xml::crypto::XSecurityEnvironment> xSecurityEnvironment;
44 enum class UserAction
46 Sign,
47 SelectSign, // Select signing certificate
48 Encrypt
51 class CertificateChooser final : public weld::GenericDialogController
53 private:
54 std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > mxSecurityContexts;
55 std::vector<std::shared_ptr<UserData>> mvUserData;
57 bool mbInitialized;
58 UserAction const meAction;
59 OUString msPreferredKey;
60 css::uno::Reference<css::security::XCertificate> mxEncryptToSelf;
62 std::unique_ptr<weld::Label> m_xFTSign;
63 std::unique_ptr<weld::Label> m_xFTEncrypt;
64 std::unique_ptr<weld::TreeView> m_xCertLB;
65 std::unique_ptr<weld::Button> m_xViewBtn;
66 std::unique_ptr<weld::Button> m_xOKBtn;
67 std::unique_ptr<weld::Label> m_xFTDescription;
68 std::unique_ptr<weld::Entry> m_xDescriptionED;
69 std::unique_ptr<weld::Entry> m_xSearchBox;
70 std::unique_ptr<weld::Button> m_xReloadBtn;
72 std::unordered_map<css::uno::Reference< css::xml::crypto::XXMLSecurityContext>,
73 css::uno::Sequence< css::uno::Reference< css::security::XCertificate > > > xMemCerts;
75 DECL_LINK(ReloadButtonHdl, weld::Button&, void);
76 DECL_LINK(ViewButtonHdl, weld::Button&, void);
77 DECL_LINK(CertificateHighlightHdl, weld::TreeView&, void);
78 DECL_LINK(CertificateSelectHdl, weld::TreeView&, bool);
79 DECL_LINK(SearchModifyHdl, weld::Entry&, void);
81 void ImplShowCertificateDetails();
82 void ImplInitialize(bool mbSearch = false);
83 void ImplReloadCertificates();
84 static void HandleOneUsageBit(OUString& string, int& bits, int bit, TranslateId name);
86 public:
87 CertificateChooser(weld::Window* pParent,
88 std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > && rxSecurityContexts,
89 UserAction eAction);
90 virtual ~CertificateChooser() override;
92 static std::unique_ptr<CertificateChooser> getInstance(weld::Window* _pParent,
93 std::vector< css::uno::Reference< css::xml::crypto::XXMLSecurityContext > > && rxSecurityContexts,
94 UserAction eAction) {
95 // Don't reuse CertificateChooser instances
96 // Reusing the same instance will, in the following case, lead to a
97 // crash. It appears that the CertificateChooser is getting disposed
98 // somewhere as mpDialogImpl in its base class ends up being null:
99 // 1. Create an empty Writer document and add a digital signature
100 // in the Digital Signatures dialog
101 // 2. File > Save As the document, check the "Encrypt with GPG key"
102 // checkbox, press Encrypt, and crash in Dialog::ImplStartExecute()
103 return std::make_unique<CertificateChooser>(_pParent, std::move(rxSecurityContexts), eAction);
106 short run() override;
108 css::uno::Sequence<css::uno::Reference< css::security::XCertificate > > GetSelectedCertificates();
109 css::uno::Reference< css::xml::crypto::XXMLSecurityContext > GetSelectedSecurityContext() const;
110 /// Gets the description string provided when selecting the certificate.
111 OUString GetDescription() const;
113 /// Returns the usage string of the selected certificate, if any.
114 OUString GetUsageText();
116 static OUString UsageInClearText(int bits);
119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */