office-gobmx/xmlsecurity/inc/documentsignaturehelper.hxx
Miklos Vajna 81d3aefd85 [API CHANGE] XDocumentDigitalSignatures: remove deprecated / unused functions
Some functions were already a stub and only aborted on calling them.
The *Package* functions were added in commit
c9ed2f359a (INTEGRATION: CWS xmlsec08
(1.4.24); FILE MERGED 2005/02/22 13:07:19 mt 1.4.24.1: #i36682# Accept
separate Stream for signatures..., 2005-03-10), but it seems nobody
called them.

This also means that DocumentSignatureMode is now never set to
DocumentSignatureMode::Package, so remove that as well.

It seems to be unlikely that this non-published service was used by
3rd-party code, since it was specific to the needs of sfx2/ code, not
generic functionality that could be useful in other contexts.

Change-Id: Icfed9a0e6568f6eb21f9236901af01f1915bf2f8
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/173313
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2024-09-13 10:27:14 +02:00

103 lines
3.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <com/sun/star/uno/Reference.h>
#include <rtl/ustring.hxx>
#include <svl/sigstruct.hxx>
#include <vector>
namespace com::sun::star {
namespace io { class XStream; }
namespace embed { class XStorage; }
}
namespace com::sun::star::xml::sax { class XDocumentHandler; }
enum class DocumentSignatureMode
{
Content,
Macros,
};
enum class DocumentSignatureAlgorithm
{
OOo2,
OOo3_0,
OOo3_2
};
struct SignatureStreamHelper
{
css::uno::Reference < css::embed::XStorage > xSignatureStorage;
css::uno::Reference < css::io::XStream > xSignatureStream;
/// If this is embed::StorageFormats::OFOPXML, then it's expected that xSignatureStream is an empty reference.
sal_Int32 nStorageFormat;
SignatureStreamHelper()
: nStorageFormat(0)
{
}
};
namespace DocumentSignatureHelper
{
SignatureStreamHelper OpenSignatureStream(
const css::uno::Reference < css::embed::XStorage >& rxStore, sal_Int32 nOpenMode,
DocumentSignatureMode eDocSigMode );
std::vector< OUString > CreateElementList(
const css::uno::Reference < css::embed::XStorage >& rxStore,
DocumentSignatureMode eMode,
const DocumentSignatureAlgorithm mode);
bool isODFPre_1_2(std::u16string_view sODFVersion);
bool isOOo3_2_Signature(const SignatureInformation & sigInfo);
DocumentSignatureAlgorithm getDocumentAlgorithm(
std::u16string_view sODFVersion, const SignatureInformation & sigInfo);
bool CanSignWithGPG(const css::uno::Reference < css::embed::XStorage >& rxStore,
std::u16string_view sOdfVersion);
bool checkIfAllFilesAreSigned( const ::std::vector< OUString > & sElementList,
const SignatureInformation & sigInfo, const DocumentSignatureAlgorithm alg);
bool equalsReferenceUriManifestPath(
std::u16string_view rUri, std::u16string_view rPath);
OUString GetDocumentContentSignatureDefaultStreamName();
OUString GetScriptingContentSignatureDefaultStreamName();
OUString GetPackageSignatureDefaultStreamName();
/// In case the storage is OOXML, prepend a leading '/' and append content type to the element URIs.
void AppendContentTypes(const css::uno::Reference<css::embed::XStorage>& xStorage, std::vector<OUString>& rElements);
void writeDigestMethod(
const css::uno::Reference<css::xml::sax::XDocumentHandler>& xDocumentHandler);
void writeSignedProperties(
const css::uno::Reference<css::xml::sax::XDocumentHandler>& xDocumentHandler,
const SignatureInformation& signatureInfo,
const OUString& sDate,
const bool bWriteSignatureLineData);
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */