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