uui/source/passwordcontainer.cxx

   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
  20 #include "comphelper/processfactory.hxx"
  21 #include "cppuhelper/factory.hxx"
  22
  23 #include "com/sun/star/lang/XMultiServiceFactory.hpp"
  24 #include "com/sun/star/task/NoMasterException.hpp"
  25 #include "com/sun/star/task/PasswordContainer.hpp"
  26 #include "com/sun/star/task/XInteractionHandler2.hpp"
  27 #include "com/sun/star/ucb/AuthenticationRequest.hpp"
  28 #include "com/sun/star/ucb/URLAuthenticationRequest.hpp"
  29 #include "com/sun/star/ucb/XInteractionSupplyAuthentication.hpp"
  30 #include "com/sun/star/ucb/XInteractionSupplyAuthentication2.hpp"
  31
  32 #include "passwordcontainer.hxx"
  33
  34 using namespace com::sun::star;
  35
  36 namespace {
  37
  38 //=========================================================================
  39 bool fillContinuation(
  40     bool bUseSystemCredentials,
  41     const ucb::AuthenticationRequest & rRequest,
  42     const task::UrlRecord & aRec,
  43     const uno::Reference< ucb::XInteractionSupplyAuthentication > &
  44         xSupplyAuthentication,
  45     const uno::Reference< ucb::XInteractionSupplyAuthentication2 > &
  46         xSupplyAuthentication2,
  47     bool bCanUseSystemCredentials,
  48     bool bCheckForEqualPasswords )
  49 {
  50     if ( bUseSystemCredentials )
  51     {
  52         // "use system creds" record found.
  53         // Wants client that we use it?
  54         if ( xSupplyAuthentication2.is() && bCanUseSystemCredentials )
  55         {
  56             xSupplyAuthentication2->setUseSystemCredentials( sal_True );
  57             return true;
  58         }
  59         return false;
  60     }
  61     else if (aRec.UserList.getLength() != 0)
  62     {
  63         if (aRec.UserList[0].Passwords.getLength() == 0)
  64         {
  65             // Password sequence can be empty, for instance if master
  66             // password was not given (e.g. master pw dialog canceled)
  67             // pw container does not throw NoMasterException in this case.
  68             // bug???
  69             return false;
  70         }
  71
  72         // "user/pass" record found.
  73         if (!bCheckForEqualPasswords || !rRequest.HasPassword
  74             || rRequest.Password != aRec.UserList[0].Passwords[0]) // failed login attempt?
  75         {
  76             if (xSupplyAuthentication->canSetUserName())
  77                 xSupplyAuthentication->
  78                     setUserName(aRec.UserList[0].UserName.getStr());
  79
  80             if (xSupplyAuthentication->canSetPassword())
  81                 xSupplyAuthentication->
  82                     setPassword(aRec.UserList[0].Passwords[0].getStr());
  83             if (aRec.UserList[0].Passwords.getLength() > 1)
  84             {
  85                 if (rRequest.HasRealm)
  86                 {
  87                     if (xSupplyAuthentication->canSetRealm())
  88                         xSupplyAuthentication->
  89                             setRealm(aRec.UserList[0].Passwords[1].
  90                                 getStr());
  91                 }
  92                 else if (xSupplyAuthentication->canSetAccount())
  93                     xSupplyAuthentication->
  94                         setAccount(aRec.UserList[0].Passwords[1].
  95                             getStr());
  96             }
  97
  98             if ( xSupplyAuthentication2.is() && bCanUseSystemCredentials )
  99                 xSupplyAuthentication2->setUseSystemCredentials( sal_False );
 100
 101             return true;
 102         }
 103     }
 104     return false;
 105 }
 106
 107 } // namespace
 108
 109 namespace uui {
 110
 111 //=========================================================================
 112 PasswordContainerHelper::PasswordContainerHelper(
 113     uno::Reference< uno::XComponentContext > const & xContext ):
 114     m_xPasswordContainer(task::PasswordContainer::create(xContext))
 115 {}
 116
 117 //=========================================================================
 118 bool PasswordContainerHelper::handleAuthenticationRequest(
 119     ucb::AuthenticationRequest const & rRequest,
 120     uno::Reference< ucb::XInteractionSupplyAuthentication > const &
 121         xSupplyAuthentication,
 122     OUString const & rURL,
 123     uno::Reference< task::XInteractionHandler2 > const & xIH )
 124         SAL_THROW((uno::RuntimeException))
 125 {
 126     uno::Reference< task::XInteractionHandler > xIH1(xIH, uno::UNO_QUERY);
 127
 128     // Is continuation even a XInteractionSupplyAuthentication2, which
 129     // is derived from XInteractionSupplyAuthentication?
 130     uno::Reference< ucb::XInteractionSupplyAuthentication2 >
 131         xSupplyAuthentication2(xSupplyAuthentication, uno::UNO_QUERY);
 132
 133     sal_Bool bCanUseSystemCredentials = sal_False;
 134     if (xSupplyAuthentication2.is())
 135     {
 136         sal_Bool bDefaultUseSystemCredentials;
 137         bCanUseSystemCredentials
 138             =  xSupplyAuthentication2->canUseSystemCredentials(
 139                 bDefaultUseSystemCredentials );
 140     }
 141
 142     if ( bCanUseSystemCredentials )
 143     {
 144         // Runtime / Persistent info avail for current auth request?
 145
 146         OUString aResult = m_xPasswordContainer->findUrl(
 147             rURL.isEmpty() ? rRequest.ServerName : rURL );
 148         if ( !aResult.isEmpty() )
 149         {
 150             if ( fillContinuation( true,
 151                                    rRequest,
 152                                    task::UrlRecord(),
 153                                    xSupplyAuthentication,
 154                                    xSupplyAuthentication2,
 155                                    bCanUseSystemCredentials,
 156                                    false ) )
 157             {
 158                 return true;
 159             }
 160         }
 161     }
 162
 163     // m_xPasswordContainer works with userName passwdSequences pairs:
 164     if (rRequest.HasUserName && rRequest.HasPassword)
 165     {
 166         try
 167         {
 168             if (rRequest.UserName.isEmpty())
 169             {
 170                 task::UrlRecord aRec;
 171                 if ( !rURL.isEmpty() )
 172                     aRec = m_xPasswordContainer->find(rURL, xIH1);
 173
 174                 if ( aRec.UserList.getLength() == 0 )
 175                 {
 176                     // compat: try server name.
 177                     aRec = m_xPasswordContainer->find(rRequest.ServerName, xIH1);
 178                 }
 179
 180                 if ( fillContinuation( false,
 181                                        rRequest,
 182                                        aRec,
 183                                        xSupplyAuthentication,
 184                                        xSupplyAuthentication2,
 185                                        bCanUseSystemCredentials,
 186                                        false ) )
 187                 {
 188                     return true;
 189                 }
 190             }
 191             else
 192             {
 193                 task::UrlRecord aRec;
 194                 if ( !rURL.isEmpty() )
 195                     aRec = m_xPasswordContainer->findForName(
 196                         rURL, rRequest.UserName, xIH1);
 197
 198                 if ( aRec.UserList.getLength() == 0 )
 199                 {
 200                     // compat: try server name.
 201                     aRec = m_xPasswordContainer->findForName(
 202                         rRequest.ServerName, rRequest.UserName, xIH1);
 203                 }
 204
 205                 if ( fillContinuation( false,
 206                                        rRequest,
 207                                        aRec,
 208                                        xSupplyAuthentication,
 209                                        xSupplyAuthentication2,
 210                                        bCanUseSystemCredentials,
 211                                        true ) )
 212                 {
 213                     return true;
 214                 }
 215             }
 216         }
 217         catch (task::NoMasterException const &)
 218         {} // user did not enter master password
 219     }
 220     return false;
 221 }
 222
 223 //=========================================================================
 224 bool PasswordContainerHelper::addRecord(
 225     OUString const & rURL,
 226     OUString const & rUsername,
 227     uno::Sequence< OUString > const & rPasswords,
 228     uno::Reference< task::XInteractionHandler2 > const & xIH,
 229     bool bPersist )
 230         SAL_THROW((uno::RuntimeException))
 231 {
 232     uno::Reference< task::XInteractionHandler > xIH1(xIH, uno::UNO_QUERY);
 233
 234     try
 235     {
 236         if ( !rUsername.isEmpty() )
 237         {
 238             OSL_ENSURE( m_xPasswordContainer.is(),
 239                         "Got no XPasswordContainer!" );
 240             if ( !m_xPasswordContainer.is() )
 241                 return false;
 242
 243             if ( bPersist )
 244             {
 245                 // If persistent storing of passwords is not yet
 246                 // allowed, enable it.
 247                 if ( !m_xPasswordContainer->isPersistentStoringAllowed() )
 248                     m_xPasswordContainer->allowPersistentStoring( sal_True );
 249
 250                 m_xPasswordContainer->addPersistent( rURL,
 251                                                      rUsername,
 252                                                      rPasswords,
 253                                                      xIH1 );
 254             }
 255             else
 256                 m_xPasswordContainer->add( rURL,
 257                                            rUsername,
 258                                            rPasswords,
 259                                            xIH1 );
 260         }
 261         else
 262         {
 263             m_xPasswordContainer->addUrl( rURL, bPersist );
 264         }
 265     }
 266     catch ( task::NoMasterException const & )
 267     {
 268         // user did not enter master password
 269         return false;
 270     }
 271     return true;
 272 }
 273
 274 //=========================================================================
 275 //=========================================================================
 276 //=========================================================================
 277
 278 PasswordContainerInteractionHandler::PasswordContainerInteractionHandler(
 279     const uno::Reference< uno::XComponentContext >& xContext )
 280 : m_aPwContainerHelper( xContext )
 281 {
 282 }
 283
 284 //=========================================================================
 285 // virtual
 286 PasswordContainerInteractionHandler::~PasswordContainerInteractionHandler()
 287 {
 288 }
 289
 290 //=========================================================================
 291 //
 292 // XServiceInfo methods.
 293 //
 294 //=========================================================================
 295
 296 // virtual
 297 OUString SAL_CALL
 298 PasswordContainerInteractionHandler::getImplementationName()
 299     throw ( uno::RuntimeException )
 300 {
 301     return getImplementationName_Static();
 302 }
 303
 304 //=========================================================================
 305 // virtual
 306 sal_Bool SAL_CALL
 307 PasswordContainerInteractionHandler::supportsService(
 308         const OUString& ServiceName )
 309     throw ( uno::RuntimeException )
 310 {
 311     uno::Sequence< OUString > aSNL = getSupportedServiceNames();
 312     const OUString * pArray = aSNL.getConstArray();
 313     for ( sal_Int32 i = 0; i < aSNL.getLength(); i++ )
 314     {
 315         if ( pArray[ i ] == ServiceName )
 316             return sal_True;
 317     }
 318     return sal_False;
 319 }
 320
 321 //=========================================================================
 322 // virtual
 323 uno::Sequence< OUString > SAL_CALL
 324 PasswordContainerInteractionHandler::getSupportedServiceNames()
 325     throw ( uno::RuntimeException )
 326 {
 327     return getSupportedServiceNames_Static();
 328 }
 329
 330 //=========================================================================
 331 // static
 332 OUString
 333 PasswordContainerInteractionHandler::getImplementationName_Static()
 334 {
 335     return OUString( "com.sun.star.comp.uui.PasswordContainerInteractionHandler" );
 336 }
 337
 338 //=========================================================================
 339 // static
 340 uno::Sequence< OUString >
 341 PasswordContainerInteractionHandler::getSupportedServiceNames_Static()
 342 {
 343     uno::Sequence< OUString > aSNS( 1 );
 344     aSNS.getArray()[ 0 ] = OUString(
 345                           "com.sun.star.task.PasswordContainerInteractionHandler" );
 346     return aSNS;
 347 }
 348
 349 //=========================================================================
 350 //
 351 // XInteractionHandler2 methods.
 352 //
 353 //=========================================================================
 354
 355 // virtual
 356 void SAL_CALL
 357 PasswordContainerInteractionHandler::handle(
 358         const uno::Reference< task::XInteractionRequest >& rRequest )
 359     throw ( uno::RuntimeException )
 360 {
 361     handleInteractionRequest( rRequest );
 362 }
 363
 364 // virtual
 365 sal_Bool SAL_CALL
 366 PasswordContainerInteractionHandler::handleInteractionRequest(
 367         const uno::Reference< task::XInteractionRequest >& rRequest )
 368     throw ( uno::RuntimeException )
 369 {
 370     if ( !rRequest.is() )
 371         return false;
 372
 373     uno::Any aAnyRequest( rRequest->getRequest() );
 374
 375     ucb::AuthenticationRequest aAuthenticationRequest;
 376     if ( !( aAnyRequest >>= aAuthenticationRequest ) )
 377         return false;
 378
 379     OUString aURL;
 380     ucb::URLAuthenticationRequest aURLAuthenticationRequest;
 381     if ( aAnyRequest >>= aURLAuthenticationRequest )
 382         aURL = aURLAuthenticationRequest.URL;
 383
 384     uno::Sequence< uno::Reference< task::XInteractionContinuation > >
 385         rContinuations = rRequest->getContinuations();
 386
 387     uno::Reference< ucb::XInteractionSupplyAuthentication >
 388         xSupplyAuthentication;
 389
 390     for ( sal_Int32 i = 0; i < rContinuations.getLength(); ++i )
 391     {
 392         xSupplyAuthentication
 393             = uno::Reference< ucb::XInteractionSupplyAuthentication >(
 394                 rContinuations[i], uno::UNO_QUERY );
 395         if( xSupplyAuthentication.is() )
 396             break;
 397     }
 398
 399     if ( !xSupplyAuthentication.is() )
 400         return false;
 401
 402     // Try to obtain credentials from password container.
 403     if ( m_aPwContainerHelper.
 404              handleAuthenticationRequest( aAuthenticationRequest,
 405                                           xSupplyAuthentication,
 406                                           aURL,
 407                                           // @@@ FIXME: this not able to
 408                                           // handle master pw request!
 409                                           // master pw request is never
 410                                           // solvable without UI!
 411                                           this ) )
 412     {
 413         // successfully handled
 414         xSupplyAuthentication->select();
 415         return true;
 416     }
 417     return false;
 418 }
 419
 420 //=========================================================================
 421 //
 422 // Service factory implementation.
 423 //
 424 //=========================================================================
 425
 426 static uno::Reference< uno::XInterface > SAL_CALL
 427 PasswordContainerInteractionHandler_CreateInstance(
 428         const uno::Reference< lang::XMultiServiceFactory> & rSMgr )
 429     throw( uno::Exception )
 430 {
 431     lang::XServiceInfo * pX = static_cast< lang::XServiceInfo * >(
 432         new PasswordContainerInteractionHandler( comphelper::getComponentContext(rSMgr) ) );
 433     return uno::Reference< uno::XInterface >::query( pX );
 434 }
 435
 436 //=========================================================================
 437 // static
 438 uno::Reference< lang::XSingleServiceFactory >
 439 PasswordContainerInteractionHandler::createServiceFactory(
 440     const uno::Reference< lang::XMultiServiceFactory >& rxServiceMgr )
 441 {
 442     return uno::Reference< lang::XSingleServiceFactory >(
 443         cppu::createOneInstanceFactory(
 444             rxServiceMgr,
 445             PasswordContainerInteractionHandler::getImplementationName_Static(),
 446             PasswordContainerInteractionHandler_CreateInstance,
 447             PasswordContainerInteractionHandler::getSupportedServiceNames_Static() ) );
 448 }
 449
 450 } // namespace uui
 451
 452 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */