Files
libreoffice/sfx2/source/doc/docmacromode.cxx
Stephan Bergmann 1b0402f87c Use varying aElement name
Change-Id: Idc135ef5031a01961cc18d897a734b598bc833f4
2014-05-21 15:30:19 +02:00

442 lines
16 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 .
*/
#include <sfx2/docmacromode.hxx>
#include <sfx2/signaturestate.hxx>
#include <sfx2/docfile.hxx>
#include <com/sun/star/document/MacroExecMode.hpp>
#include <com/sun/star/task/ErrorCodeRequest.hpp>
#include <com/sun/star/task/DocumentMacroConfirmationRequest.hpp>
#include <com/sun/star/task/InteractionClassification.hpp>
#include <com/sun/star/security/DocumentDigitalSignatures.hpp>
#include <com/sun/star/script/XLibraryQueryExecutable.hpp>
#include <comphelper/processfactory.hxx>
#include <framework/interaction.hxx>
#include <osl/file.hxx>
#include <rtl/ref.hxx>
#include <unotools/securityoptions.hxx>
#include <svtools/sfxecode.hxx>
#include <tools/diagnose_ex.h>
#include <tools/urlobj.hxx>
namespace sfx2
{
using ::com::sun::star::uno::Reference;
using ::com::sun::star::task::XInteractionHandler;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::task::XInteractionContinuation;
using ::com::sun::star::task::XInteractionRequest;
using ::com::sun::star::task::DocumentMacroConfirmationRequest;
using ::com::sun::star::task::ErrorCodeRequest;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::security::DocumentDigitalSignatures;
using ::com::sun::star::security::XDocumentDigitalSignatures;
using ::com::sun::star::security::DocumentSignatureInformation;
using ::com::sun::star::embed::XStorage;
using ::com::sun::star::task::InteractionClassification_QUERY;
using ::com::sun::star::document::XEmbeddedScripts;
using ::com::sun::star::uno::UNO_SET_THROW;
using ::com::sun::star::script::XLibraryContainer;
using ::com::sun::star::script::XLibraryQueryExecutable;
using ::com::sun::star::container::XNameAccess;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::UNO_QUERY;
namespace MacroExecMode = ::com::sun::star::document::MacroExecMode;
//= DocumentMacroMode_Data
struct DocumentMacroMode_Data
{
IMacroDocumentAccess& m_rDocumentAccess;
bool m_bMacroDisabledMessageShown;
bool m_bDocMacroDisabledMessageShown;
DocumentMacroMode_Data( IMacroDocumentAccess& rDocumentAccess )
:m_rDocumentAccess( rDocumentAccess )
,m_bMacroDisabledMessageShown( false )
,m_bDocMacroDisabledMessageShown( false )
{
}
};
//= helper
namespace
{
void lcl_showGeneralSfxErrorOnce( const Reference< XInteractionHandler >& rxHandler, const sal_Int32 nSfxErrorCode, bool& rbAlreadyShown )
{
if ( rbAlreadyShown )
return;
ErrorCodeRequest aErrorCodeRequest;
aErrorCodeRequest.ErrCode = nSfxErrorCode;
SfxMedium::CallApproveHandler( rxHandler, makeAny( aErrorCodeRequest ), false );
rbAlreadyShown = true;
}
void lcl_showMacrosDisabledError( const Reference< XInteractionHandler >& rxHandler, bool& rbAlreadyShown )
{
lcl_showGeneralSfxErrorOnce( rxHandler, ERRCODE_SFX_MACROS_SUPPORT_DISABLED, rbAlreadyShown );
}
void lcl_showDocumentMacrosDisabledError( const Reference< XInteractionHandler >& rxHandler, bool& rbAlreadyShown )
{
#ifdef MACOSX
lcl_showGeneralSfxErrorOnce( rxHandler, ERRCODE_SFX_DOCUMENT_MACRO_DISABLED_MAC, rbAlreadyShown );
#else
lcl_showGeneralSfxErrorOnce( rxHandler, ERRCODE_SFX_DOCUMENT_MACRO_DISABLED, rbAlreadyShown );
#endif
}
bool lcl_showMacroWarning( const Reference< XInteractionHandler >& rxHandler,
const OUString& rDocumentLocation )
{
DocumentMacroConfirmationRequest aRequest;
aRequest.DocumentURL = rDocumentLocation;
return SfxMedium::CallApproveHandler( rxHandler, makeAny( aRequest ), true );
}
}
//= DocumentMacroMode
DocumentMacroMode::DocumentMacroMode( IMacroDocumentAccess& rDocumentAccess )
:m_pData( new DocumentMacroMode_Data( rDocumentAccess ) )
{
}
DocumentMacroMode::~DocumentMacroMode()
{
}
bool DocumentMacroMode::allowMacroExecution()
{
m_pData->m_rDocumentAccess.setCurrentMacroExecMode( MacroExecMode::ALWAYS_EXECUTE_NO_WARN );
return true;
}
bool DocumentMacroMode::disallowMacroExecution()
{
m_pData->m_rDocumentAccess.setCurrentMacroExecMode( MacroExecMode::NEVER_EXECUTE );
return false;
}
bool DocumentMacroMode::adjustMacroMode( const Reference< XInteractionHandler >& rxInteraction )
{
sal_uInt16 nMacroExecutionMode = m_pData->m_rDocumentAccess.getCurrentMacroExecMode();
if ( SvtSecurityOptions().IsMacroDisabled() )
{
// no macro should be executed at all
lcl_showMacrosDisabledError( rxInteraction, m_pData->m_bMacroDisabledMessageShown );
return disallowMacroExecution();
}
// get setting from configuration if required
enum AutoConfirmation
{
eNoAutoConfirm,
eAutoConfirmApprove,
eAutoConfirmReject
};
AutoConfirmation eAutoConfirm( eNoAutoConfirm );
if ( ( nMacroExecutionMode == MacroExecMode::USE_CONFIG )
|| ( nMacroExecutionMode == MacroExecMode::USE_CONFIG_REJECT_CONFIRMATION )
|| ( nMacroExecutionMode == MacroExecMode::USE_CONFIG_APPROVE_CONFIRMATION )
)
{
SvtSecurityOptions aOpt;
switch ( aOpt.GetMacroSecurityLevel() )
{
case 3:
nMacroExecutionMode = MacroExecMode::FROM_LIST_NO_WARN;
break;
case 2:
nMacroExecutionMode = MacroExecMode::FROM_LIST_AND_SIGNED_WARN;
break;
case 1:
nMacroExecutionMode = MacroExecMode::ALWAYS_EXECUTE;
break;
case 0:
nMacroExecutionMode = MacroExecMode::ALWAYS_EXECUTE_NO_WARN;
break;
default:
OSL_FAIL( "DocumentMacroMode::adjustMacroMode: unexpected macro security level!" );
nMacroExecutionMode = MacroExecMode::NEVER_EXECUTE;
}
if ( nMacroExecutionMode == MacroExecMode::USE_CONFIG_REJECT_CONFIRMATION )
eAutoConfirm = eAutoConfirmReject;
else if ( nMacroExecutionMode == MacroExecMode::USE_CONFIG_APPROVE_CONFIRMATION )
eAutoConfirm = eAutoConfirmApprove;
}
if ( nMacroExecutionMode == MacroExecMode::NEVER_EXECUTE )
return false;
if ( nMacroExecutionMode == MacroExecMode::ALWAYS_EXECUTE_NO_WARN )
return true;
try
{
OUString sReferrer( m_pData->m_rDocumentAccess.getDocumentLocation() );
// get document location from medium name and check whether it is a trusted one
// the service is created ohne document version, since it is not of interest here
Reference< XDocumentDigitalSignatures > xSignatures(DocumentDigitalSignatures::createDefault(::comphelper::getProcessComponentContext()));
INetURLObject aURLReferer( sReferrer );
OUString aLocation;
if ( aURLReferer.removeSegment() )
aLocation = aURLReferer.GetMainURL( INetURLObject::NO_DECODE );
if ( !aLocation.isEmpty() && xSignatures->isLocationTrusted( aLocation ) )
{
return allowMacroExecution();
}
// at this point it is clear that the document is not in the secure location
if ( nMacroExecutionMode == MacroExecMode::FROM_LIST_NO_WARN )
{
lcl_showDocumentMacrosDisabledError( rxInteraction, m_pData->m_bDocMacroDisabledMessageShown );
return disallowMacroExecution();
}
// check whether the document is signed with trusted certificate
if ( nMacroExecutionMode != MacroExecMode::FROM_LIST )
{
// the trusted macro check will also retrieve the signature state ( small optimization )
bool bHasTrustedMacroSignature = m_pData->m_rDocumentAccess.hasTrustedScriptingSignature( nMacroExecutionMode != MacroExecMode::FROM_LIST_AND_SIGNED_NO_WARN );
sal_uInt16 nSignatureState = m_pData->m_rDocumentAccess.getScriptingSignatureState();
if ( nSignatureState == SIGNATURESTATE_SIGNATURES_BROKEN )
{
// the signature is broken, no macro execution
if ( nMacroExecutionMode != MacroExecMode::FROM_LIST_AND_SIGNED_NO_WARN )
m_pData->m_rDocumentAccess.showBrokenSignatureWarning( rxInteraction );
return disallowMacroExecution();
}
else if ( bHasTrustedMacroSignature )
{
// there is trusted macro signature, allow macro execution
return allowMacroExecution();
}
else if ( nSignatureState == SIGNATURESTATE_SIGNATURES_OK
|| nSignatureState == SIGNATURESTATE_SIGNATURES_NOTVALIDATED )
{
// there is valid signature, but it is not from the trusted author
return disallowMacroExecution();
}
}
// at this point it is clear that the document is neither in secure location nor signed with trusted certificate
if ( ( nMacroExecutionMode == MacroExecMode::FROM_LIST_AND_SIGNED_NO_WARN )
|| ( nMacroExecutionMode == MacroExecMode::FROM_LIST_AND_SIGNED_WARN )
)
{
if ( nMacroExecutionMode == MacroExecMode::FROM_LIST_AND_SIGNED_WARN )
lcl_showDocumentMacrosDisabledError( rxInteraction, m_pData->m_bDocMacroDisabledMessageShown );
return disallowMacroExecution();
}
}
catch ( const Exception& )
{
if ( ( nMacroExecutionMode == MacroExecMode::FROM_LIST_NO_WARN )
|| ( nMacroExecutionMode == MacroExecMode::FROM_LIST_AND_SIGNED_WARN )
|| ( nMacroExecutionMode == MacroExecMode::FROM_LIST_AND_SIGNED_NO_WARN )
)
{
return disallowMacroExecution();
}
}
// conformation is required
bool bSecure = false;
if ( eAutoConfirm == eNoAutoConfirm )
{
OUString sReferrer( m_pData->m_rDocumentAccess.getDocumentLocation() );
OUString aSystemFileURL;
if ( osl::FileBase::getSystemPathFromFileURL( sReferrer, aSystemFileURL ) == osl::FileBase::E_None )
sReferrer = aSystemFileURL;
bSecure = lcl_showMacroWarning( rxInteraction, sReferrer );
}
else
bSecure = ( eAutoConfirm == eAutoConfirmApprove );
return ( bSecure ? allowMacroExecution() : disallowMacroExecution() );
}
bool DocumentMacroMode::isMacroExecutionDisallowed() const
{
return m_pData->m_rDocumentAccess.getCurrentMacroExecMode() == MacroExecMode::NEVER_EXECUTE;
}
bool DocumentMacroMode::containerHasBasicMacros( const Reference< XLibraryContainer >& xContainer )
{
bool bHasMacroLib = false;
try
{
if ( xContainer.is() )
{
// a library container exists; check if it's empty
// if there are libraries except the "Standard" library
// we assume that they are not empty (because they have been created by the user)
if ( !xContainer->hasElements() )
bHasMacroLib = false;
else
{
OUString aStdLibName( "Standard" );
OUString aVBAProject( "VBAProject" );
Sequence< OUString > aElements = xContainer->getElementNames();
if ( aElements.getLength() )
{
sal_Int32 nElements = aElements.getLength();
for( sal_Int32 i = 0; i < nElements; ++i )
{
OUString aElement = aElements[i];
if( aElement == aStdLibName || aElement == aVBAProject )
{
Reference < XNameAccess > xLib;
Any aAny = xContainer->getByName( aElement );
aAny >>= xLib;
if ( xLib.is() && xLib->hasElements() )
return true;
}
else
return true;
}
}
}
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return bHasMacroLib;
}
bool DocumentMacroMode::hasMacroLibrary() const
{
bool bHasMacroLib = false;
#ifndef DISABLE_SCRIPTING
try
{
Reference< XEmbeddedScripts > xScripts( m_pData->m_rDocumentAccess.getEmbeddedDocumentScripts() );
Reference< XLibraryContainer > xContainer;
if ( xScripts.is() )
xContainer.set( xScripts->getBasicLibraries(), UNO_QUERY_THROW );
bHasMacroLib = containerHasBasicMacros( xContainer );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
#endif
return bHasMacroLib;
}
bool DocumentMacroMode::storageHasMacros( const Reference< XStorage >& rxStorage )
{
bool bHasMacros = false;
if ( rxStorage.is() )
{
try
{
const OUString s_sBasicStorageName( OUString::intern( RTL_CONSTASCII_USTRINGPARAM( "Basic" ) ) );
const OUString s_sScriptsStorageName( OUString::intern( RTL_CONSTASCII_USTRINGPARAM( "Scripts" ) ) );
bHasMacros =( ( rxStorage->hasByName( s_sBasicStorageName )
&& rxStorage->isStorageElement( s_sBasicStorageName )
)
|| ( rxStorage->hasByName( s_sScriptsStorageName )
&& rxStorage->isStorageElement( s_sScriptsStorageName )
)
);
}
catch ( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
return bHasMacros;
}
bool DocumentMacroMode::checkMacrosOnLoading( const Reference< XInteractionHandler >& rxInteraction )
{
bool bAllow = false;
if ( SvtSecurityOptions().IsMacroDisabled() )
{
// no macro should be executed at all
bAllow = disallowMacroExecution();
}
else
{
if ( m_pData->m_rDocumentAccess.documentStorageHasMacros() || hasMacroLibrary() )
{
bAllow = adjustMacroMode( rxInteraction );
}
else if ( !isMacroExecutionDisallowed() )
{
// if macros will be added by the user later, the security check is obsolete
bAllow = allowMacroExecution();
}
}
return bAllow;
}
} // namespace sfx2
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */