include/unotools/securityoptions.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 #ifndef INCLUDED_unotools_SECURITYOPTIONS_HXX
  20 #define INCLUDED_unotools_SECURITYOPTIONS_HXX
  21
  22 #include "unotools/unotoolsdllapi.h"
  23 #include <sal/types.h>
  24 #include <osl/mutex.hxx>
  25 #include <com/sun/star/uno/Sequence.h>
  26 #include <rtl/ustring.hxx>
  27 #include <unotools/options.hxx>
  28
  29 /*-************************************************************************************************************//**
  30     @short          forward declaration to our private date container implementation
  31     @descr          We use these class as internal member to support small memory requirements.
  32                     You can create the container if it is neccessary. The class which use these mechanism
  33                     is faster and smaller then a complete implementation!
  34 *//*-*************************************************************************************************************/
  35
  36 class SvtSecurityOptions_Impl;
  37
  38 /*-************************************************************************************************************//**
  39     @descr          These values present modes to handle StarOffice basic scripts.
  40                     see GetBasicMode/SetBasicMode() for further information
  41 *//*-*************************************************************************************************************/
  42
  43 enum EBasicSecurityMode
  44 {
  45     eNEVER_EXECUTE  = 0,
  46     eFROM_LIST      = 1,
  47     eALWAYS_EXECUTE = 2
  48 };
  49
  50 /*-************************************************************************************************************//**
  51     @short          collect information about security features
  52     @descr          -
  53
  54     @implements     -
  55     @base           -
  56
  57     @ATTENTION      This class is partially threadsafe.
  58
  59     @devstatus      ready to use
  60 *//*-*************************************************************************************************************/
  61
  62 class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail::Options
  63 {
  64     public:
  65
  66         enum EOption
  67         {
  68             E_SECUREURLS,
  69             E_BASICMODE,                    // xmlsec05 depricated
  70             E_EXECUTEPLUGINS,               // xmlsec05 depricated
  71             E_WARNING,                      // xmlsec05 depricated
  72             E_CONFIRMATION,                 // xmlsec05 depricated
  73             E_DOCWARN_SAVEORSEND,
  74             E_DOCWARN_SIGNING,
  75             E_DOCWARN_PRINT,
  76             E_DOCWARN_CREATEPDF,
  77             E_DOCWARN_REMOVEPERSONALINFO,
  78             E_DOCWARN_RECOMMENDPASSWORD,
  79             E_MACRO_SECLEVEL,
  80             E_MACRO_TRUSTEDAUTHORS,
  81             E_MACRO_DISABLE,
  82             E_CTRLCLICK_HYPERLINK
  83         };
  84
  85         enum MacroAction
  86         {
  87             MA_DONTRUN = 0,
  88             MA_CONFIRM,
  89             MA_RUN
  90         };
  91
  92         typedef ::com::sun::star::uno::Sequence< OUString > Certificate;
  93
  94         /*
  95         // MT: Doesn't work for sequence...
  96         struct Certificate
  97         {
  98             OUString SubjectName;
  99             OUString SerialNumber;
 100             OUString RawData;
 101         };
 102         */
 103
 104     public:
 105         /*-****************************************************************************************************//**
 106             @short      standard constructor and destructor
 107             @descr      This will initialize an instance with default values.
 108                         We implement these class with a refcount mechanism! Every instance of this class increase it
 109                         at create and decrease it at delete time - but all instances use the same data container!
 110                         He is implemented as a static member ...
 111
 112             @seealso    member m_nRefCount
 113             @seealso    member m_pDataContainer
 114
 115             @param      -
 116             @return     -
 117
 118             @onerror    -
 119         *//*-*****************************************************************************************************/
 120
 121          SvtSecurityOptions();
 122         virtual ~SvtSecurityOptions();
 123
 124         /*-****************************************************************************************************//**
 125             @short      returns readonly state
 126             @descr      It can be called to get information about the readonly state of a provided item.
 127             @seealso    -
 128
 129             @param      "eOption", specify, which item is queried
 130             @return     <TRUE/> if item is readonly; <FALSE/> otherwise
 131
 132             @onerror    No error should occurre!
 133         *//*-*****************************************************************************************************/
 134
 135         sal_Bool IsReadOnly( EOption eOption ) const ;
 136
 137         /*-****************************************************************************************************//**
 138             @short      interface methods to get and set value of config key "org.openoffice.Office.Common/Security/Scripting/SecureURL"
 139             @descr      These value displays the list of all trustworthy URLs.
 140                         zB.:    file:/                  => All scripts from the local file system including a LAN;
 141                                 private:explorer        => Scripts from the Explorer;
 142                                 private:help            => Scripts in the help system;
 143                                 private:newmenu         => Scripts that are executed by the commands File-New and AutoPilot;
 144                                 private:schedule        => Scripts of  the scheduler;
 145                                 private:searchfolder    => Scripts of the searchfolder;
 146                                 private:user            => Scripts that are entered in the URL field.
 147             @seealso    -
 148
 149             @param      "seqURLList", new values to set it in configuration.
 150             @return     The values which represent current state of internal variable.
 151
 152             @onerror    No error should occurre!
 153         *//*-*****************************************************************************************************/
 154
 155         ::com::sun::star::uno::Sequence< OUString >  GetSecureURLs(                                                                      ) const ;
 156         void                                                SetSecureURLs( const ::com::sun::star::uno::Sequence< OUString >& seqURLList )       ;
 157
 158         /*-****************************************************************************************************//**
 159             @short      interface methods to get and set value of config key "org.openoffice.Office.Common/Security/Scripting/StarOfficeBasic"
 160             @descr      These value determines how StarOffice Basic scripts should be handled.
 161                         It exist 3 different modes:
 162                             0 = never execute
 163                             1 = from list
 164                             2 = always execute
 165
 166             @ATTENTION  These methods don't check for valid or invalid values!
 167                         Our configuration server can do it ... but these implementation don't get any notifications
 168                         about wrong commits ...!
 169                         => If you set an invalid value - nothing will be changed. The information will lost.
 170
 171             @seealso    enum EBasicSecurityMode
 172
 173             @param      "eMode" to set new mode ... Value must defined as an enum of type EBasicSecurityMode!
 174             @return     An enum value, which present current mode.
 175
 176             @onerror    No error should occurre!
 177         *//*-*****************************************************************************************************/
 178
 179         sal_Int32           GetMacroSecurityLevel       (                   ) const ;
 180         void                SetMacroSecurityLevel       ( sal_Int32 _nLevel )       ;
 181
 182         sal_Bool            IsMacroDisabled             (                   ) const ;
 183
 184         /*-****************************************************************************************************//**
 185             @short      special method to check an URL and his referer corresponding to ouer internal security cessation
 186             @descr      Give us an URL and his referer and we will say you if these url can be scripted or not!
 187
 188             @seealso    -
 189
 190             @param      "sURL" reference to URL for checking
 191             @param      "sReferer" reference to referer which whish to run script by given URL
 192             @return     sal_True if URL is secure or security is obsolete(!) or sal_False otherwise.
 193
 194             @onerror    No error should occurre!
 195         *//*-*****************************************************************************************************/
 196
 197         sal_Bool IsSecureURL(   const   OUString&    sURL        ,
 198                                 const   OUString&    sReferer    ) const ;
 199
 200         ::com::sun::star::uno::Sequence< Certificate >  GetTrustedAuthors       (                                                                   ) const ;
 201         void                                            SetTrustedAuthors       ( const ::com::sun::star::uno::Sequence< Certificate >& rAuthors    )       ;
 202
 203         // for bool options only!
 204         bool        IsOptionSet     ( EOption eOption                   ) const ;
 205         bool        SetOption       ( EOption eOption, bool bValue      )       ;
 206         bool        IsOptionEnabled ( EOption eOption                   ) const ;
 207
 208         // xmlsec05 depricated methods
 209         sal_Bool    IsExecutePlugins() const;
 210         void        SetExecutePlugins( sal_Bool bSet );
 211         EBasicSecurityMode  GetBasicMode(                           ) const ;
 212         void                SetBasicMode( EBasicSecurityMode eMode  )       ;
 213         sal_Bool IsWarningEnabled() const;
 214         void SetWarningEnabled( sal_Bool bSet );
 215         sal_Bool IsConfirmationEnabled() const;
 216         void SetConfirmationEnabled( sal_Bool bSet );
 217
 218     //-------------------------------------------------------------------------------------------------------------
 219     //  private methods
 220     //-------------------------------------------------------------------------------------------------------------
 221
 222     private:
 223
 224         /*-****************************************************************************************************//**
 225             @short      return a reference to a static mutex
 226             @descr      These class is partially threadsafe (for de-/initialization only).
 227                         All access methods are'nt safe!
 228                         We create a static mutex only for one ime and use at different times.
 229
 230             @seealso    -
 231
 232             @param      -
 233             @return     A reference to a static mutex member.
 234
 235             @onerror    -
 236         *//*-*****************************************************************************************************/
 237
 238         UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex();
 239
 240     //-------------------------------------------------------------------------------------------------------------
 241     //  private member
 242     //-------------------------------------------------------------------------------------------------------------
 243
 244     private:
 245
 246         /*Attention
 247
 248             Don't initialize these static member in these header!
 249             a) Double dfined symbols will be detected ...
 250             b) and unresolved externals exist at linking time.
 251             Do it in your source only.
 252          */
 253
 254         static SvtSecurityOptions_Impl* m_pDataContainer    ;   /// impl. data container as dynamic pointer for smaller memory requirements!
 255         static sal_Int32                m_nRefCount         ;   /// internal ref count mechanism
 256
 257 };      // class SvtSecurityOptions
 258
 259 #endif  // #ifndef INCLUDED_unotools_SECURITYOPTIONS_HXX
 260
 261 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */