office-gobmx/xmlsecurity/inc/documentsignaturemanager.hxx
Miklos Vajna 0de900cec7 cool#9992 lok doc sign, hash extract: time for getCommandValues('Signature')
The final goal of this API is to give time & hash information about the
PDF signature, so once a 3rd-party produces the PKCS#7 signature, that
can be added to the document and the actual PDF sign can be re-run with
the same parameters.

This commit continues the replacement of XCertificate with
svl::crypto::SigningContext up to the point that the timestamp used in
svl/ can be exposed on the LOK API.

This is done by updating DocumentSignatureManager::add(),
PDFSignatureHelper::SetX509Certificate(),
vcl::filter::PDFDocument::Sign() and finally the svl::crypto::Signing
ctor to work with the signing context instead of an XCertificate
directly.

Time reporting works now, so add a test for that. The digest part still
needs doing.

Change-Id: I83f1274cd420b67194b7caf12b1027e623d4f7fe
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/176404
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
2024-11-11 21:54:23 +01:00

152 lines
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 "xmlsecuritydllapi.h"
#include <memory>
#include <svl/sigstruct.hxx>
#include "xmlsignaturehelper.hxx"
#include "documentsignaturehelper.hxx"
#include <com/sun/star/xml/crypto/XSEInitializer.hpp>
#include <unotools/tempfile.hxx>
namespace com::sun::star
{
namespace beans
{
struct PropertyValue;
}
namespace embed
{
class XStorage;
}
namespace frame
{
class XModel;
}
namespace graphic
{
class XGraphic;
}
namespace uno
{
class XComponentContext;
}
}
namespace svl::crypto
{
class SigningContext;
}
class PDFSignatureHelper;
class Xmlsec;
/// Manages signatures (addition, removal), used by DigitalSignaturesDialog.
class XMLSECURITY_DLLPUBLIC DocumentSignatureManager
{
private:
css::uno::Reference<css::uno::XComponentContext> mxContext;
css::uno::Reference<css::embed::XStorage> mxStore;
XMLSignatureHelper maSignatureHelper;
std::unique_ptr<PDFSignatureHelper> mpPDFSignatureHelper;
SignatureInformations maCurrentSignatureInformations;
DocumentSignatureMode const meSignatureMode;
css::uno::Sequence<css::uno::Sequence<css::beans::PropertyValue>> m_manifest;
css::uno::Reference<css::io::XStream> mxSignatureStream;
css::uno::Reference<css::io::XStream> mxScriptingSignatureStream;
css::uno::Reference<css::frame::XModel> mxModel;
rtl::Reference<utl::TempFileFastService> mxTempSignatureStream;
/// Storage containing all OOXML signatures, unused for ODF.
css::uno::Reference<css::embed::XStorage> mxTempSignatureStorage;
css::uno::Reference<css::xml::crypto::XSEInitializer> mxSEInitializer;
css::uno::Reference<css::xml::crypto::XXMLSecurityContext> mxSecurityContext;
css::uno::Reference<css::xml::crypto::XSEInitializer> mxGpgSEInitializer;
css::uno::Reference<css::xml::crypto::XXMLSecurityContext> mxGpgSecurityContext;
std::shared_ptr<Xmlsec> mpXmlsecLibrary;
public:
DocumentSignatureManager(const css::uno::Reference<css::uno::XComponentContext>& xContext,
DocumentSignatureMode eMode);
~DocumentSignatureManager();
/**
* Checks if a particular stream is a valid xml stream. Those are treated
* differently when they are signed (c14n transformation)
*/
bool isXML(std::u16string_view rURI);
bool readManifest();
SignatureStreamHelper ImplOpenSignatureStream(sal_Int32 nStreamOpenMode, bool bTempStream);
/// Add a new signature, using xCert as a signing certificate, and rDescription as description.
bool add(svl::crypto::SigningContext& rSigningContext,
const css::uno::Reference<css::xml::crypto::XXMLSecurityContext>& xSecurityContext,
const OUString& rDescription, sal_Int32& nSecurityId, bool bAdESCompliant,
const OUString& rSignatureLineId = OUString(),
const css::uno::Reference<css::graphic::XGraphic>& xValidGraphic
= css::uno::Reference<css::graphic::XGraphic>(),
const css::uno::Reference<css::graphic::XGraphic>& xInvalidGraphic
= css::uno::Reference<css::graphic::XGraphic>());
/// Remove signature at nPosition.
void remove(sal_uInt16 nPosition);
/// Read signatures from either a temp stream or the real storage.
void read(bool bUseTempStream, bool bCacheLastSignature = true);
/// Write signatures back to the persistent storage.
void write(bool bXAdESCompliantIfODF);
/// Lazy creation of PDF helper.
PDFSignatureHelper& getPDFSignatureHelper();
#if 0
// Checks if the document is a kind where it is relevant to distinguish between using XAdES or not
bool IsXAdESRelevant();
#endif
/// Attempts to initialize the platform-specific crypto.
bool init();
/// Get the security environment.
css::uno::Reference<css::xml::crypto::XSecurityEnvironment> getSecurityEnvironment();
css::uno::Reference<css::xml::crypto::XSecurityEnvironment> getGpgSecurityEnvironment();
css::uno::Reference<css::xml::crypto::XXMLSecurityContext> const& getSecurityContext() const;
css::uno::Reference<css::xml::crypto::XXMLSecurityContext> const& getGpgSecurityContext() const;
void setStore(const css::uno::Reference<css::embed::XStorage>& xStore) { mxStore = xStore; }
XMLSignatureHelper& getSignatureHelper() { return maSignatureHelper; }
bool hasPDFSignatureHelper() const { return bool(mpPDFSignatureHelper); }
void setSignatureStream(const css::uno::Reference<css::io::XStream>& xSignatureStream)
{
mxSignatureStream = xSignatureStream;
}
const css::uno::Reference<css::io::XStream>& getSignatureStream() const
{
return mxSignatureStream;
}
void setScriptingSignatureStream(
const css::uno::Reference<css::io::XStream>& xScriptingSignatureStream)
{
mxScriptingSignatureStream = xScriptingSignatureStream;
}
void setModel(const css::uno::Reference<css::frame::XModel>& xModel);
const css::uno::Reference<css::embed::XStorage>& getStore() const { return mxStore; }
DocumentSignatureMode getSignatureMode() const { return meSignatureMode; }
SignatureInformations& getCurrentSignatureInformations()
{
return maCurrentSignatureInformations;
}
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */