xmlsecurity/inc/documentsignaturehelper.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/Reference.h>
  23 #include <rtl/ustring.hxx>
  24 #include <svl/sigstruct.hxx>
  25
  26 #include <vector>
  27
  28 namespace com::sun::star {
  29     namespace io { class XStream; }
  30     namespace embed { class XStorage; }
  31 }
  32
  33 namespace com::sun::star::xml::sax { class XDocumentHandler; }
  34
  35 enum class DocumentSignatureMode
  36 {
  37     Content,
  38     Macros,
  39 };
  40
  41 enum class DocumentSignatureAlgorithm
  42 {
  43     OOo2,
  44     OOo3_0,
  45     OOo3_2
  46 };
  47
  48 struct SignatureStreamHelper
  49 {
  50     css::uno::Reference < css::embed::XStorage >    xSignatureStorage;
  51     css::uno::Reference < css::io::XStream >        xSignatureStream;
  52     /// If this is embed::StorageFormats::OFOPXML, then it's expected that xSignatureStream is an empty reference.
  53     sal_Int32 nStorageFormat;
  54
  55     SignatureStreamHelper()
  56         : nStorageFormat(0)
  57     {
  58     }
  59 };
  60
  61 namespace DocumentSignatureHelper
  62 {
  63     SignatureStreamHelper OpenSignatureStream(
  64         const css::uno::Reference < css::embed::XStorage >& rxStore, sal_Int32 nOpenMode,
  65         DocumentSignatureMode eDocSigMode );
  66
  67     std::vector< OUString > CreateElementList(
  68         const css::uno::Reference < css::embed::XStorage >& rxStore,
  69         DocumentSignatureMode eMode,
  70         const DocumentSignatureAlgorithm mode);
  71
  72     bool isODFPre_1_2(std::u16string_view sODFVersion);
  73     bool isOOo3_2_Signature(const SignatureInformation & sigInfo);
  74
  75     DocumentSignatureAlgorithm getDocumentAlgorithm(
  76         std::u16string_view sODFVersion, const SignatureInformation & sigInfo);
  77
  78     bool CanSignWithGPG(const css::uno::Reference < css::embed::XStorage >& rxStore,
  79                         std::u16string_view sOdfVersion);
  80
  81     bool checkIfAllFilesAreSigned( const ::std::vector< OUString > & sElementList,
  82         const SignatureInformation & sigInfo, const DocumentSignatureAlgorithm alg);
  83
  84     bool equalsReferenceUriManifestPath(
  85         std::u16string_view rUri, std::u16string_view rPath);
  86
  87     OUString GetDocumentContentSignatureDefaultStreamName();
  88     OUString GetScriptingContentSignatureDefaultStreamName();
  89     OUString GetPackageSignatureDefaultStreamName();
  90
  91     /// In case the storage is OOXML, prepend a leading '/' and append content type to the element URIs.
  92     void AppendContentTypes(const css::uno::Reference<css::embed::XStorage>& xStorage, std::vector<OUString>& rElements);
  93
  94     void writeDigestMethod(
  95         const css::uno::Reference<css::xml::sax::XDocumentHandler>& xDocumentHandler);
  96     void writeSignedProperties(
  97         const css::uno::Reference<css::xml::sax::XDocumentHandler>& xDocumentHandler,
  98         const SignatureInformation& signatureInfo,
  99         const OUString& sDate,
 100         const bool bWriteSignatureLineData);
 101 };
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */