svtools/source/inc/passwordcontainer.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: passwordcontainer.hxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef INCLUDED_COMPHELPER_PASSWORDCONTAINER_HXX
  31 #define INCLUDED_COMPHELPER_PASSWORDCONTAINER_HXX
  32
  33 #include <list>
  34 #include <vector>
  35 #include <map>
  36 #include <com/sun/star/task/XPasswordContainer.hpp>
  37 #include <com/sun/star/task/XUrlContainer.hpp>
  38 #include <com/sun/star/task/PasswordRequestMode.hpp>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  41 #include <com/sun/star/lang/XEventListener.hpp>
  42 #include <com/sun/star/lang/XComponent.hpp>
  43 #include <com/sun/star/task/XMasterPasswordHandling2.hpp>
  44 #include <cppuhelper/implbase5.hxx>
  45 #include <cppuhelper/typeprovider.hxx>
  46 #include <cppuhelper/queryinterface.hxx>
  47 #include <cppuhelper/factory.hxx>
  48
  49 #include <tools/stream.hxx>
  50 #include <unotools/configitem.hxx>
  51 #include <ucbhelper/interactionrequest.hxx>
  52
  53 #include <rtl/ref.hxx>
  54 #include <osl/mutex.hxx>
  55
  56 #include "syscreds.hxx"
  57
  58 #define MEMORY_RECORD         0
  59 #define PERSISTENT_RECORD     1
  60
  61 //----------------------------------------------------------------------------------
  62
  63 class NamePassRecord
  64 {
  65     ::rtl::OUString                                     m_aName;
  66
  67     // there are two lists of passwords, memory passwords and persistent passwords
  68     sal_Bool                                              m_bHasMemPass;
  69     ::std::vector< ::rtl::OUString >                      m_aMemPass;
  70
  71     // persistent passwords are encrypted in one string
  72     sal_Bool                                              m_bHasPersPass;
  73     ::rtl::OUString                                       m_aPersPass;
  74
  75     void InitArrays( sal_Bool bHasMemoryList, const ::std::vector< ::rtl::OUString >& aMemoryList,
  76                      sal_Bool bHasPersistentList, const ::rtl::OUString& aPersistentList )
  77     {
  78         m_bHasMemPass = bHasMemoryList;
  79         if ( bHasMemoryList )
  80             m_aMemPass = aMemoryList;
  81
  82         m_bHasPersPass = bHasPersistentList;
  83         if ( bHasPersistentList )
  84             m_aPersPass = aPersistentList;
  85     }
  86
  87 public:
  88
  89     NamePassRecord( const ::rtl::OUString& aName )
  90         : m_aName( aName )
  91         , m_bHasMemPass( sal_False )
  92         , m_bHasPersPass( sal_False )
  93     {
  94     }
  95
  96     NamePassRecord( const ::rtl::OUString& aName, const ::std::vector< ::rtl::OUString >& aMemoryList )
  97         : m_aName( aName )
  98         , m_bHasMemPass( sal_True )
  99         , m_aMemPass( aMemoryList )
 100         , m_bHasPersPass( sal_False )
 101     {
 102     }
 103
 104     NamePassRecord( const ::rtl::OUString& aName, const ::rtl::OUString& aPersistentList )
 105         : m_aName( aName )
 106         , m_bHasMemPass( sal_False )
 107         , m_bHasPersPass( sal_True )
 108         , m_aPersPass( aPersistentList )
 109     {
 110     }
 111
 112     NamePassRecord( const ::rtl::OUString& aName,
 113                     sal_Bool bHasMemoryList, const ::std::vector< ::rtl::OUString >& aMemoryList,
 114                     sal_Bool bHasPersistentList, const ::rtl::OUString aPersistentList )
 115         : m_aName( aName )
 116         , m_bHasMemPass( bHasMemoryList )
 117         , m_bHasPersPass( bHasPersistentList )
 118     {
 119         InitArrays( bHasMemoryList, aMemoryList, bHasPersistentList, aPersistentList );
 120     }
 121
 122     NamePassRecord( const NamePassRecord& aRecord )
 123         : m_aName( aRecord.m_aName )
 124         , m_bHasMemPass( sal_False )
 125         , m_bHasPersPass( sal_False )
 126     {
 127         InitArrays( aRecord.m_bHasMemPass, aRecord.m_aMemPass, aRecord.m_bHasPersPass, aRecord.m_aPersPass );
 128     }
 129
 130     NamePassRecord& operator=( const NamePassRecord& aRecord )
 131     {
 132         m_aName = aRecord.m_aName;
 133
 134         m_aMemPass.clear();
 135         m_aPersPass = ::rtl::OUString();
 136         InitArrays( aRecord.m_bHasMemPass, aRecord.m_aMemPass, aRecord.m_bHasPersPass, aRecord.m_aPersPass );
 137
 138         return *this;
 139     }
 140
 141     ::rtl::OUString GetUserName() const
 142     {
 143         return m_aName;
 144     }
 145
 146     sal_Bool HasPasswords( sal_Int8 nStatus ) const
 147     {
 148         if ( nStatus == MEMORY_RECORD )
 149             return m_bHasMemPass;
 150         if ( nStatus == PERSISTENT_RECORD )
 151             return m_bHasPersPass;
 152
 153         return sal_False;
 154     }
 155
 156     ::std::vector< ::rtl::OUString > GetMemPasswords() const
 157     {
 158         if ( m_bHasMemPass )
 159             return m_aMemPass;
 160
 161         return ::std::vector< ::rtl::OUString >();
 162     }
 163
 164     ::rtl::OUString GetPersPasswords() const
 165     {
 166         if ( m_bHasPersPass )
 167             return m_aPersPass;
 168
 169         return ::rtl::OUString();
 170     }
 171
 172     void SetMemPasswords( const ::std::vector< ::rtl::OUString >& aMemList )
 173     {
 174         m_aMemPass = aMemList;
 175         m_bHasMemPass = sal_True;
 176     }
 177
 178     void SetPersPasswords( const ::rtl::OUString& aPersList )
 179     {
 180         m_aPersPass = aPersList;
 181         m_bHasPersPass = sal_True;
 182     }
 183
 184     void RemovePasswords( sal_Int8 nStatus )
 185     {
 186         if ( nStatus == MEMORY_RECORD )
 187         {
 188             m_bHasMemPass = sal_False;
 189             m_aMemPass.clear();
 190         }
 191         else if ( nStatus == PERSISTENT_RECORD )
 192         {
 193             m_bHasPersPass = sal_False;
 194             m_aPersPass = ::rtl::OUString();
 195         }
 196     }
 197
 198 };
 199
 200 //----------------------------------------------------------------------------------
 201
 202 typedef ::std::pair< const ::rtl::OUString, ::std::list< NamePassRecord > > PairUrlRecord;
 203 typedef ::std::map< ::rtl::OUString, ::std::list< NamePassRecord > > PassMap;
 204
 205 //----------------------------------------------------------------------------------
 206
 207 class PasswordContainer;
 208
 209 class StorageItem : public ::utl::ConfigItem {
 210     PasswordContainer*  mainCont;
 211     sal_Bool            hasEncoded;
 212     ::rtl::OUString        mEncoded;
 213 public:
 214     StorageItem( PasswordContainer* point, const ::rtl::OUString& path ) :
 215         ConfigItem( path, CONFIG_MODE_IMMEDIATE_UPDATE ),
 216         mainCont( point ),
 217         hasEncoded( sal_False )
 218     {
 219         ::com::sun::star::uno::Sequence< ::rtl::OUString > aNode( 1 );
 220         *aNode.getArray()  = path;
 221         *aNode.getArray() += ::rtl::OUString::createFromAscii( "/Store" );
 222         EnableNotification( aNode );
 223     }
 224
 225     PassMap getInfo();
 226     void update( const ::rtl::OUString& url, const NamePassRecord& rec );
 227     void remove( const ::rtl::OUString& url, const ::rtl::OUString& rec );
 228     void clear();
 229
 230     sal_Bool getEncodedMP( ::rtl::OUString& aResult );
 231     void setEncodedMP( const ::rtl::OUString& aResult, sal_Bool bAcceptEnmpty = sal_False );
 232     void setUseStorage( sal_Bool bUse );
 233     sal_Bool useStorage();
 234
 235     virtual void            Notify( const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aPropertyNames );
 236     virtual void            Commit();
 237 };
 238
 239 //----------------------------------------------------------------------------------
 240
 241 enum PasswordState {
 242     no_password,
 243     entered,
 244     cancelled
 245 };
 246
 247 class PasswordContainer : public ::cppu::WeakImplHelper5<
 248         ::com::sun::star::task::XPasswordContainer,
 249         ::com::sun::star::task::XMasterPasswordHandling2,
 250         ::com::sun::star::task::XUrlContainer,
 251         ::com::sun::star::lang::XServiceInfo,
 252         ::com::sun::star::lang::XEventListener >
 253 {
 254 private:
 255     PassMap      m_aContainer;
 256     StorageItem* m_pStorageFile;
 257     ::osl::Mutex mMutex;
 258     ::rtl::OUString m_aMasterPasswd; // master password is set when the string is not empty
 259     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent > mComponent;
 260     SysCredentialsConfig mUrlContainer;
 261
 262     ::com::sun::star::uno::Sequence< ::com::sun::star::task::UserRecord > CopyToUserRecordSequence(
 263                                         const ::std::list< NamePassRecord >& original,
 264                                         const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler )
 265                                                         throw(::com::sun::star::uno::RuntimeException);
 266
 267     ::com::sun::star::task::UserRecord CopyToUserRecord(
 268                                         const NamePassRecord& aRecord,
 269                                         sal_Bool& io_bTryToDecode,
 270                                         const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler );
 271
 272     ::com::sun::star::uno::Sequence< ::com::sun::star::task::UserRecord > FindUsr(
 273                                         const ::std::list< NamePassRecord >& userlist,
 274                                         const ::rtl::OUString& name,
 275                                         const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler )
 276                                                         throw(::com::sun::star::uno::RuntimeException);
 277 bool createUrlRecord(
 278     const PassMap::iterator & rIter,
 279     bool bName,
 280     const ::rtl::OUString & aName,
 281     const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler,
 282     ::com::sun::star::task::UrlRecord & rRec  )
 283         throw( ::com::sun::star::uno::RuntimeException );
 284
 285 ::com::sun::star::task::UrlRecord find(
 286     const ::rtl::OUString& aURL,
 287     const ::rtl::OUString& aName,
 288     bool bName, // only needed to support empty user names
 289     const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler  ) throw(::com::sun::star::uno::RuntimeException);
 290
 291     ::rtl::OUString GetDefaultMasterPassword();
 292
 293     ::rtl::OUString RequestPasswordFromUser(
 294                     ::com::sun::star::task::PasswordRequestMode aRMode,
 295                     const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& xHandler );
 296
 297     ::rtl::OUString GetMasterPassword( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler )
 298                                                         throw(::com::sun::star::uno::RuntimeException);
 299
 300     void UpdateVector( const ::rtl::OUString& url, ::std::list< NamePassRecord >& toUpdate, NamePassRecord& rec, sal_Bool writeFile )
 301                                                         throw(::com::sun::star::uno::RuntimeException);
 302
 303     void PrivateAdd( const ::rtl::OUString& aUrl,
 304                               const ::rtl::OUString& aUserName,
 305                               const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aPasswords,
 306                               char  aMode,
 307                               const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler )
 308                                                         throw(::com::sun::star::uno::RuntimeException);
 309
 310     ::std::vector< ::rtl::OUString > DecodePasswords( const ::rtl::OUString& aLine, const ::rtl::OUString& aMasterPassword )
 311                                                         throw(::com::sun::star::uno::RuntimeException);
 312
 313     ::rtl::OUString EncodePasswords( ::std::vector< ::rtl::OUString > lines, const ::rtl::OUString& aMasterPassword )
 314                                                         throw(::com::sun::star::uno::RuntimeException);
 315
 316 public:
 317     PasswordContainer( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& );
 318     ~PasswordContainer();
 319
 320     virtual void SAL_CALL add( const ::rtl::OUString& aUrl,
 321                                const ::rtl::OUString& aUserName,
 322                                const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aPasswords,
 323                                const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler  )
 324                                                         throw(::com::sun::star::uno::RuntimeException);
 325
 326     virtual void SAL_CALL addPersistent( const ::rtl::OUString& aUrl,
 327                                             const ::rtl::OUString& aUserName,
 328                                          const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aPasswords,
 329                                           const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler  )
 330                                                         throw(::com::sun::star::uno::RuntimeException);
 331
 332     virtual ::com::sun::star::task::UrlRecord SAL_CALL
 333                             find( const ::rtl::OUString& aUrl,
 334                                   const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler  )
 335                                                         throw(::com::sun::star::uno::RuntimeException);
 336
 337     virtual ::com::sun::star::task::UrlRecord SAL_CALL
 338                             findForName( const ::rtl::OUString& aUrl,
 339                                          const ::rtl::OUString& aUserName,
 340                                             const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler  )
 341                                                         throw(::com::sun::star::uno::RuntimeException);
 342
 343     virtual void SAL_CALL remove( const ::rtl::OUString& aUrl,
 344                                   const ::rtl::OUString& aUserName )
 345                                                         throw(::com::sun::star::uno::RuntimeException);
 346
 347     virtual void SAL_CALL removePersistent( const ::rtl::OUString& aUrl,
 348                                             const ::rtl::OUString& aUserName )
 349                                                         throw(::com::sun::star::uno::RuntimeException);
 350
 351     virtual void SAL_CALL removeAllPersistent() throw(::com::sun::star::uno::RuntimeException);
 352
 353     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::task::UrlRecord > SAL_CALL
 354                             getAllPersistent( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& Handler ) throw(::com::sun::star::uno::RuntimeException);
 355
 356
 357     // provide factory
 358     static ::rtl::OUString SAL_CALL        impl_getStaticImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
 359     static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 360                     impl_getStaticSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException);
 361     static ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > SAL_CALL
 362                     impl_createFactory( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& ServiceManager ) throw(::com::sun::star::uno::RuntimeException);
 363     static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
 364                     impl_createInstance( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager ) throw( ::com::sun::star::uno::RuntimeException );
 365
 366     // XServiceInfo
 367     virtual ::rtl::OUString    SAL_CALL    getImplementationName(  ) throw(::com::sun::star::uno::RuntimeException);
 368     virtual sal_Bool SAL_CALL            supportsService( const ::rtl::OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException);
 369
 370     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
 371                                         getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException);
 372
 373     // XEventListener
 374     virtual void SAL_CALL        disposing( const ::com::sun::star::lang::EventObject& Source )
 375                                     throw(::com::sun::star::uno::RuntimeException);
 376
 377     // XMasterPasswordHandling
 378     virtual ::sal_Bool SAL_CALL authorizateWithMasterPassword( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& xHandler )
 379         throw (::com::sun::star::uno::RuntimeException);
 380     virtual ::sal_Bool SAL_CALL changeMasterPassword( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& xHandler ) throw (::com::sun::star::uno::RuntimeException);
 381     virtual void SAL_CALL removeMasterPassword() throw (::com::sun::star::uno::RuntimeException);
 382     virtual ::sal_Bool SAL_CALL hasMasterPassword(  ) throw (::com::sun::star::uno::RuntimeException);
 383     virtual ::sal_Bool SAL_CALL allowPersistentStoring( ::sal_Bool bAllow ) throw (::com::sun::star::uno::RuntimeException);
 384     virtual ::sal_Bool SAL_CALL isPersistentStoringAllowed(  ) throw (::com::sun::star::uno::RuntimeException);
 385
 386     // XMasterPasswordHandling2
 387     virtual ::sal_Bool SAL_CALL useDefaultMasterPassword( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& xHandler ) throw (::com::sun::star::uno::RuntimeException);
 388     virtual ::sal_Bool SAL_CALL isDefaultMasterPasswordUsed(  ) throw (::com::sun::star::uno::RuntimeException);
 389
 390     // XUrlContainer
 391     virtual void SAL_CALL addUrl( const ::rtl::OUString& Url, ::sal_Bool MakePersistent ) throw (::com::sun::star::uno::RuntimeException);
 392     virtual ::rtl::OUString SAL_CALL findUrl( const ::rtl::OUString& Url ) throw (::com::sun::star::uno::RuntimeException);
 393     virtual void SAL_CALL removeUrl( const ::rtl::OUString& Url ) throw (::com::sun::star::uno::RuntimeException);
 394     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getUrls( ::sal_Bool OnlyPersistent ) throw (::com::sun::star::uno::RuntimeException);
 395
 396     void            Notify();
 397 };
 398
 399 //----------------------------------------------------------------------------------
 400
 401 class MasterPasswordRequest_Impl : public ucbhelper::InteractionRequest
 402 {
 403     ::rtl::Reference< ucbhelper::InteractionSupplyAuthentication > m_xAuthSupplier;
 404
 405 public:
 406     MasterPasswordRequest_Impl( ::com::sun::star::task::PasswordRequestMode Mode );
 407
 408     const ::rtl::Reference< ucbhelper::InteractionSupplyAuthentication > &
 409     getAuthenticationSupplier() const { return m_xAuthSupplier; }
 410
 411 };
 412
 413 //----------------------------------------------------------------------------------
 414
 415 class RW_SvMemoryStream : public SvMemoryStream {
 416 public:
 417     RW_SvMemoryStream( void* Buf, ULONG Size, StreamMode eMode ):
 418             SvMemoryStream( Buf, Size, eMode){}
 419
 420     RW_SvMemoryStream( ULONG InitSize=512, ULONG Resize=64 ):
 421             SvMemoryStream( InitSize, Resize ){}
 422
 423     ULONG getActualSize(){ return nEndOfData; }
 424 };
 425
 426
 427
 428 #endif // #ifndef INCLUDED_COMPHELPER_PASSWORDCONTAINER_HXX
 429