svl/source/passwordcontainer/passwordcontainer.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_SVL_SOURCE_PASSWORDCONTAINER_PASSWORDCONTAINER_HXX
  20 #define INCLUDED_SVL_SOURCE_PASSWORDCONTAINER_PASSWORDCONTAINER_HXX
  21
  22 #include <vector>
  23 #include <map>
  24 #include <com/sun/star/task/XPasswordContainer2.hpp>
  25 #include <com/sun/star/task/PasswordRequestMode.hpp>
  26 #include <com/sun/star/lang/XServiceInfo.hpp>
  27 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  28 #include <com/sun/star/lang/XEventListener.hpp>
  29 #include <com/sun/star/lang/XComponent.hpp>
  30 #include <cppuhelper/implbase.hxx>
  31 #include <cppuhelper/typeprovider.hxx>
  32 #include <cppuhelper/queryinterface.hxx>
  33 #include <cppuhelper/factory.hxx>
  34
  35 #include <tools/stream.hxx>
  36 #include <unotools/configitem.hxx>
  37 #include <ucbhelper/interactionrequest.hxx>
  38
  39 #include <rtl/ref.hxx>
  40 #include <osl/mutex.hxx>
  41
  42 #include "syscreds.hxx"
  43
  44 #define MEMORY_RECORD         0
  45 #define PERSISTENT_RECORD     1
  46
  47
  48 class NamePassRecord
  49 {
  50     OUString                                       m_aName;
  51
  52     // there are two lists of passwords, memory passwords and persistent passwords
  53     bool                                                  m_bHasMemPass;
  54     ::std::vector< OUString >                      m_aMemPass;
  55
  56     // persistent passwords are encrypted in one string
  57     bool                                                  m_bHasPersPass;
  58     OUString                                       m_aPersPass;
  59
  60     void InitArrays( bool bHasMemoryList, const ::std::vector< OUString >& aMemoryList,
  61                      bool bHasPersistentList, const OUString& aPersistentList )
  62     {
  63         m_bHasMemPass = bHasMemoryList;
  64         if ( bHasMemoryList )
  65             m_aMemPass = aMemoryList;
  66
  67         m_bHasPersPass = bHasPersistentList;
  68         if ( bHasPersistentList )
  69             m_aPersPass = aPersistentList;
  70     }
  71
  72 public:
  73
  74     NamePassRecord( const OUString& aName )
  75         : m_aName( aName )
  76         , m_bHasMemPass( false )
  77         , m_bHasPersPass( false )
  78     {
  79     }
  80
  81     NamePassRecord( const OUString& aName, const OUString& aPersistentList )
  82         : m_aName( aName )
  83         , m_bHasMemPass( false )
  84         , m_bHasPersPass( true )
  85         , m_aPersPass( aPersistentList )
  86     {
  87     }
  88
  89     NamePassRecord( const NamePassRecord& aRecord )
  90         : m_aName( aRecord.m_aName )
  91         , m_bHasMemPass( false )
  92         , m_bHasPersPass( false )
  93     {
  94         InitArrays( aRecord.m_bHasMemPass, aRecord.m_aMemPass, aRecord.m_bHasPersPass, aRecord.m_aPersPass );
  95     }
  96
  97     NamePassRecord& operator=( const NamePassRecord& aRecord )
  98     {
  99         if (this != &aRecord)
 100         {
 101             m_aName = aRecord.m_aName;
 102
 103             m_aMemPass.clear();
 104             m_aPersPass.clear();
 105             InitArrays( aRecord.m_bHasMemPass, aRecord.m_aMemPass, aRecord.m_bHasPersPass, aRecord.m_aPersPass );
 106         }
 107         return *this;
 108     }
 109
 110     const OUString& GetUserName() const
 111     {
 112         return m_aName;
 113     }
 114
 115     bool HasPasswords( sal_Int8 nStatus ) const
 116     {
 117         if ( nStatus == MEMORY_RECORD )
 118             return m_bHasMemPass;
 119         if ( nStatus == PERSISTENT_RECORD )
 120             return m_bHasPersPass;
 121
 122         return false;
 123     }
 124
 125     ::std::vector< OUString > GetMemPasswords() const
 126     {
 127         if ( m_bHasMemPass )
 128             return m_aMemPass;
 129
 130         return ::std::vector< OUString >();
 131     }
 132
 133     OUString GetPersPasswords() const
 134     {
 135         if ( m_bHasPersPass )
 136             return m_aPersPass;
 137
 138         return OUString();
 139     }
 140
 141     void SetMemPasswords( const ::std::vector< OUString >& aMemList )
 142     {
 143         m_aMemPass = aMemList;
 144         m_bHasMemPass = true;
 145     }
 146
 147     void SetPersPasswords( const OUString& aPersList )
 148     {
 149         m_aPersPass = aPersList;
 150         m_bHasPersPass = true;
 151     }
 152
 153     void RemovePasswords( sal_Int8 nStatus )
 154     {
 155         if ( nStatus == MEMORY_RECORD )
 156         {
 157             m_bHasMemPass = false;
 158             m_aMemPass.clear();
 159         }
 160         else if ( nStatus == PERSISTENT_RECORD )
 161         {
 162             m_bHasPersPass = false;
 163             m_aPersPass.clear();
 164         }
 165     }
 166
 167 };
 168
 169
 170 typedef ::std::pair< const OUString, ::std::vector< NamePassRecord > > PairUrlRecord;
 171 typedef ::std::map< OUString, ::std::vector< NamePassRecord > > PassMap;
 172
 173
 174 class PasswordContainer;
 175
 176 class StorageItem
 177     : public ::utl::ConfigItem
 178 {
 179 private:
 180     PasswordContainer*     mainCont;
 181     bool                   hasEncoded;
 182     OUString        mEncoded;
 183
 184     virtual void            ImplCommit() override;
 185
 186 public:
 187     StorageItem( PasswordContainer* point, const OUString& path ) :
 188         ConfigItem( path, ConfigItemMode::NONE ),
 189         mainCont( point ),
 190         hasEncoded( false )
 191     {
 192         css::uno::Sequence< OUString > aNode { path + "/Store" };
 193         EnableNotification( aNode );
 194     }
 195
 196     PassMap getInfo();
 197     void update( const OUString& url, const NamePassRecord& rec );
 198     void remove( const OUString& url, const OUString& rec );
 199     void clear();
 200
 201     bool getEncodedMP( OUString& aResult );
 202     void setEncodedMP( const OUString& aResult, bool bAcceptEnmpty = false );
 203     void setUseStorage( bool bUse );
 204     bool useStorage();
 205
 206     virtual void            Notify( const css::uno::Sequence< OUString >& aPropertyNames ) override;
 207 };
 208
 209
 210 class PasswordContainer : public ::cppu::WeakImplHelper<
 211         css::task::XPasswordContainer2,
 212         css::lang::XServiceInfo,
 213         css::lang::XEventListener >
 214 {
 215 private:
 216     PassMap      m_aContainer;
 217     std::unique_ptr<StorageItem> m_pStorageFile;
 218     ::osl::Mutex mMutex;
 219     OUString m_aMasterPasswd; // master password is set when the string is not empty
 220     css::uno::Reference< css::lang::XComponent > mComponent;
 221     SysCredentialsConfig mUrlContainer;
 222
 223     /// @throws css::uno::RuntimeException
 224     css::uno::Sequence< css::task::UserRecord > CopyToUserRecordSequence(
 225                                         const ::std::vector< NamePassRecord >& original,
 226                                         const css::uno::Reference< css::task::XInteractionHandler >& Handler );
 227
 228     css::task::UserRecord CopyToUserRecord(
 229                                         const NamePassRecord& aRecord,
 230                                         bool& io_bTryToDecode,
 231                                         const css::uno::Reference< css::task::XInteractionHandler >& aHandler );
 232
 233     /// @throws css::uno::RuntimeException
 234     css::uno::Sequence< css::task::UserRecord > FindUsr(
 235                                         const ::std::vector< NamePassRecord >& userlist,
 236                                         const OUString& name,
 237                                         const css::uno::Reference< css::task::XInteractionHandler >& Handler );
 238 /// @throws css::uno::RuntimeException
 239 bool createUrlRecord(
 240     const PassMap::iterator & rIter,
 241     bool bName,
 242     const OUString & aName,
 243     const css::uno::Reference< css::task::XInteractionHandler >& aHandler,
 244     css::task::UrlRecord & rRec  );
 245
 246 /// @throws css::uno::RuntimeException
 247 css::task::UrlRecord find(
 248     const OUString& aURL,
 249     const OUString& aName,
 250     bool bName, // only needed to support empty user names
 251     const css::uno::Reference< css::task::XInteractionHandler >& aHandler  );
 252
 253     static OUString GetDefaultMasterPassword();
 254
 255     static OUString RequestPasswordFromUser(
 256                     css::task::PasswordRequestMode aRMode,
 257                     const css::uno::Reference< css::task::XInteractionHandler >& xHandler );
 258
 259     /// @throws css::uno::RuntimeException
 260     OUString const & GetMasterPassword( const css::uno::Reference< css::task::XInteractionHandler >& Handler );
 261
 262     /// @throws css::uno::RuntimeException
 263     void UpdateVector( const OUString& url, ::std::vector< NamePassRecord >& toUpdate, NamePassRecord const & rec, bool writeFile );
 264
 265     /// @throws css::uno::RuntimeException
 266     void PrivateAdd( const OUString& aUrl,
 267                               const OUString& aUserName,
 268                               const css::uno::Sequence< OUString >& aPasswords,
 269                               char  aMode,
 270                               const css::uno::Reference< css::task::XInteractionHandler >& Handler );
 271
 272     /// @throws css::uno::RuntimeException
 273     static ::std::vector< OUString > DecodePasswords( const OUString& aLine, const OUString& aMasterPassword, css::task::PasswordRequestMode mode );
 274
 275     /// @throws css::uno::RuntimeException
 276     static OUString EncodePasswords(const std::vector< OUString >& lines, const OUString& aMasterPassword );
 277
 278 public:
 279     PasswordContainer( const css::uno::Reference< css::lang::XMultiServiceFactory >& );
 280     virtual ~PasswordContainer() override;
 281
 282     virtual void SAL_CALL add( const OUString& aUrl,
 283                                const OUString& aUserName,
 284                                const css::uno::Sequence< OUString >& aPasswords,
 285                                const css::uno::Reference< css::task::XInteractionHandler >& Handler  ) override;
 286
 287     virtual void SAL_CALL addPersistent( const OUString& aUrl,
 288                                             const OUString& aUserName,
 289                                          const css::uno::Sequence< OUString >& aPasswords,
 290                                           const css::uno::Reference< css::task::XInteractionHandler >& Handler  ) override;
 291
 292     virtual css::task::UrlRecord SAL_CALL
 293                             find( const OUString& aUrl,
 294                                   const css::uno::Reference< css::task::XInteractionHandler >& Handler  ) override;
 295
 296     virtual css::task::UrlRecord SAL_CALL
 297                             findForName( const OUString& aUrl,
 298                                          const OUString& aUserName,
 299                                          const css::uno::Reference< css::task::XInteractionHandler >& Handler  ) override;
 300
 301     virtual void SAL_CALL remove( const OUString& aUrl,
 302                                   const OUString& aUserName ) override;
 303
 304     virtual void SAL_CALL removePersistent( const OUString& aUrl,
 305                                             const OUString& aUserName ) override;
 306
 307     virtual void SAL_CALL removeAllPersistent() override;
 308
 309     virtual css::uno::Sequence< css::task::UrlRecord > SAL_CALL
 310                             getAllPersistent( const css::uno::Reference< css::task::XInteractionHandler >& Handler ) override;
 311
 312
 313     // provide factory
 314     /// @throws css::uno::RuntimeException
 315     static OUString impl_getStaticImplementationName( );
 316     /// @throws css::uno::RuntimeException
 317     static css::uno::Sequence< OUString >
 318                     impl_getStaticSupportedServiceNames(  );
 319     /// @throws css::uno::RuntimeException
 320     static css::uno::Reference< css::lang::XSingleServiceFactory >
 321                     impl_createFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& ServiceManager );
 322     /// @throws css::uno::RuntimeException
 323     static css::uno::Reference< css::uno::XInterface > SAL_CALL
 324                     impl_createInstance( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager );
 325
 326     // XServiceInfo
 327     virtual OUString SAL_CALL    getImplementationName(  ) override;
 328     virtual sal_Bool SAL_CALL            supportsService( const OUString& ServiceName ) override;
 329
 330     virtual css::uno::Sequence< OUString > SAL_CALL
 331                                         getSupportedServiceNames(  ) override;
 332
 333     // XEventListener
 334     virtual void SAL_CALL        disposing( const css::lang::EventObject& Source ) override;
 335
 336     // XMasterPasswordHandling
 337     virtual sal_Bool SAL_CALL authorizateWithMasterPassword( const css::uno::Reference< css::task::XInteractionHandler >& xHandler ) override;
 338     virtual sal_Bool SAL_CALL changeMasterPassword( const css::uno::Reference< css::task::XInteractionHandler >& xHandler ) override;
 339     virtual void SAL_CALL removeMasterPassword() override;
 340     virtual sal_Bool SAL_CALL hasMasterPassword(  ) override;
 341     virtual sal_Bool SAL_CALL allowPersistentStoring( sal_Bool bAllow ) override;
 342     virtual sal_Bool SAL_CALL isPersistentStoringAllowed(  ) override;
 343
 344     // XMasterPasswordHandling2
 345     virtual sal_Bool SAL_CALL useDefaultMasterPassword( const css::uno::Reference< css::task::XInteractionHandler >& xHandler ) override;
 346     virtual sal_Bool SAL_CALL isDefaultMasterPasswordUsed(  ) override;
 347
 348     // XUrlContainer
 349     virtual void SAL_CALL addUrl( const OUString& Url, sal_Bool MakePersistent ) override;
 350     virtual OUString SAL_CALL findUrl( const OUString& Url ) override;
 351     virtual void SAL_CALL removeUrl( const OUString& Url ) override;
 352     virtual css::uno::Sequence< OUString > SAL_CALL getUrls( sal_Bool OnlyPersistent ) override;
 353
 354     void            Notify();
 355 };
 356
 357
 358 class MasterPasswordRequest_Impl : public ucbhelper::InteractionRequest
 359 {
 360     ::rtl::Reference< ucbhelper::InteractionSupplyAuthentication > m_xAuthSupplier;
 361
 362 public:
 363     MasterPasswordRequest_Impl( css::task::PasswordRequestMode Mode );
 364
 365     const ::rtl::Reference< ucbhelper::InteractionSupplyAuthentication > &
 366     getAuthenticationSupplier() const { return m_xAuthSupplier; }
 367
 368 };
 369
 370
 371 #endif
 372
 373 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */