/*

* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#include "btnotifsecuritymanager.h"

#include "btnotifoutgoingpairinghandler.h"

#include "btnotifincomingpairinghandler.h"

#include "btnotifpairnotifier.h"

#include "btnotifclientserver.h"

#include <e32property.h>

#include "btnotifconnectiontracker.h"

#include "btnotifserviceauthorizer.h"

/**  Identification for active object */

enum TPairManActiveRequestId

    {

    ESimplePairingResult,

    EAuthenticationResult,

    ERegistryGetLocalAddress,

    };

// ---------------------------------------------------------------------------

// Tells if two TBTNamelessDevice instances are for the same remote device

// ---------------------------------------------------------------------------

//

TBool CompareDeviceByAddress( const TBTNamelessDevice& aDevA, const TBTNamelessDevice& aDevB )

    {

    return aDevA.Address() == aDevB.Address();

    }

// ---------------------------------------------------------------------------

// Tells if these two instances are for the same remote device

// ---------------------------------------------------------------------------

//

TBool MatchDeviceAddress(const TBTDevAddr* aAddr, const TBTNamelessDevice& aDev)

    {

    return *aAddr == aDev.Address();

    }

// ======== MEMBER FUNCTIONS ========

// ---------------------------------------------------------------------------

// C++ default constructor

// ---------------------------------------------------------------------------

//

CBTNotifSecurityManager::CBTNotifSecurityManager(

        CBTNotifConnectionTracker& aParent,

        CBtDevRepository& aDevRepository)

    : iParent( aParent ), iDevRepository( aDevRepository )

    {

    }

// ---------------------------------------------------------------------------

// Symbian 2nd-phase constructor

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::ConstructL()

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    // Connect to pairing server for authentication & simple pairing 

    // results directly from the BT stack.

    // Pairing server doesn't exist if we run BT 2.0 stack:

    iPairingServ = new (ELeave) RBluetoothPairingServer;

    TInt err = iPairingServ->Connect();

    if ( err)

        {

        delete iPairingServ;

        iPairingServ = NULL;

        }

    else

        {

        User::LeaveIfError( iPairingResult.Open( *iPairingServ ) );

        User::LeaveIfError( iAuthenResult.Open( *iPairingServ ) );

        iSSPResultActive = CBtSimpleActive::NewL( *this, ESimplePairingResult );

        iAuthenResultActive = CBtSimpleActive::NewL( *this, EAuthenticationResult );

        SubscribeSspPairingResult();

        SubscribeAuthenticateResult();

        }

    User::LeaveIfError( iRegistry.Open( iParent.RegistryServerSession() ) );

    // RProperty for accessing the local device address

    User::LeaveIfError( iPropertyLocalAddr.Attach(

            KPropertyUidBluetoothCategory, KPropertyKeyBluetoothGetLocalDeviceAddress) );

    // Initialise paired devices list

    iLocalAddrActive = CBtSimpleActive::NewL( *this, ERegistryGetLocalAddress );

    SubscribeLocalAddress();

    iPairNotifier = CBTNotifPairNotifier::NewL( *this );

    iDevRepository.AddObserverL( this );

    iServiceAuthorizer = CBTNotifServiceAuthorizer::NewL(*this);

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// NewL

// ---------------------------------------------------------------------------

//

CBTNotifSecurityManager* CBTNotifSecurityManager::NewL(

        CBTNotifConnectionTracker& aParent,

        CBtDevRepository& aDevRepository )

    {

    CBTNotifSecurityManager* self = NULL;

    self = new  CBTNotifSecurityManager( aParent, aDevRepository );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

// ---------------------------------------------------------------------------

// Destructor

// ---------------------------------------------------------------------------

//

CBTNotifSecurityManager::~CBTNotifSecurityManager()

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    delete iSSPResultActive;

    delete iAuthenResultActive;

    delete iPairNotifier;

    delete iPairingHandler;

    iPairedDevices.Close();

    iPairingResult.Close();

    iAuthenResult.Close();

    if ( iPairingServ )

        {

        iPairingServ->Close();

        delete iPairingServ;

        }

    iRegistry.Close();

    delete iLocalAddrActive;

    iPropertyLocalAddr.Close();

    if ( !iMessage.IsNull() )

        {

        iMessage.Complete( KErrCancel );

        }

    delete iServiceAuthorizer;

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Initialises the paired devices list.

// If the local address is not available from the P&S key 

// KPropertyKeyBluetoothGetLocalDeviceAddress, then the list may need to be 

// updated once the H/W is switched on. This is so that any registry update 

// from a restore operation can be included in the list, without mistaking the 

// new devices for new pairings.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::SubscribeLocalAddress()

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    // Check that we have the Bluetooth local address. If we don't then initialise anyway, but subscribe for an update.

    // This allows us to refresh our paired devices list to include updates made to the remote devices table of the 

    // Bluetooth registry from a restore operation. We need to include these devices without mistaking them for new 

    // pairings. We look solely at the P&S key for the address to avoid the condition whereby the address has been

    // entered into the reigstry but the Bluetooth Manager server has not begun the restore process yet. The signalling

    // of the P&S key will cause Bluetooth Manager to update the registry with any restored devices before fulfilling

    // any further requests.

    // Subscribe to local address property in case we need an update.

    iPropertyLocalAddr.Subscribe( iLocalAddrActive->iStatus );

    iLocalAddrActive->SetRequestId( ERegistryGetLocalAddress );

    iLocalAddrActive->GoActive();

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Tells whether the local address is available from the P&S key 

// KPropertyKeyBluetoothGetLocalDeviceAddress.

// ---------------------------------------------------------------------------

//

TBool CBTNotifSecurityManager::IsLocalAddressAvailable()

    {

    // Attempt to read address from P&S key.

    TBuf8<KBTDevAddrSize> btAddrDes;

    TInt err = iPropertyLocalAddr.Get( btAddrDes );

    // Is the P&S key defined yet? (if not, stack not up yet)

    if ( err == KErrNone )

        {

        // P&S key defined, is local address set? (if not, H/W not initialised yet)

        if ( btAddrDes.Length() == KBTDevAddrSize )

            {

            TBTDevAddr btAddr = btAddrDes;

            if ( btAddr != TBTDevAddr() )

                {

                return ETrue;

                }

            }

        }

    return EFalse;

    }

// ---------------------------------------------------------------------------

// Handles pairing related requests from BTNotif clients.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::HandleBondingRequestL( const RMessage2& aMessage )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    TInt opcode = aMessage.Function();

    switch( opcode )

        {

        case EBTNotifPairDevice:

            {

            if ( !iMessage.IsNull() )

                {

                User::Leave( KErrServerBusy );

                }

            TBTDevAddrPckgBuf addrPkg;

            aMessage.ReadL( EBTNotifSrvParamSlot, addrPkg );

            BlockDevice(addrPkg(),EFalse);

            UnpairDevice( addrPkg() );

            PairDeviceL( addrPkg(), aMessage.Int2() );

            iMessage = RMessage2( aMessage );

            break;

            }

        case EBTNotifCancelPairDevice:

            {

            // Only the client who requested pairing can cancel it:

            if ( !iMessage.IsNull() && aMessage.Session() == iMessage.Session() )

                {

                iPairingHandler->CancelOutgoingPair();

                iMessage.Complete( KErrCancel );

                }

            aMessage.Complete( KErrNone );

            break;

            }

        default:

            {

            User::Leave( KErrArgument );

            }

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Process a client message related to notifiers.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::HandleNotifierRequestL( const RMessage2& aMessage )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    if(aMessage.Int0() == KBTManAuthNotifierUid.iUid)

        {

        iServiceAuthorizer->StartNotifierL( aMessage );

        }

    else

        {

        iPairNotifier->StartPairingNotifierL( aMessage );

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Returns the RBluetoothPairingServer instance.

// ---------------------------------------------------------------------------

//

RBluetoothPairingServer* CBTNotifSecurityManager::PairingServer()

    {

    return iPairingServ;

    }

// ---------------------------------------------------------------------------

// Access the reference of RSockServ

// ---------------------------------------------------------------------------

//

RSocketServ& CBTNotifSecurityManager::SocketServ()

    {

    return iParent.SocketServerSession();

    }

// ---------------------------------------------------------------------------

// Access the reference of RBTRegSrv

// ---------------------------------------------------------------------------

//

CBtDevRepository& CBTNotifSecurityManager::BTDevRepository()

    {

    return iDevRepository;

    }

// ---------------------------------------------------------------------------

// Access the reference of CBTNotifConnectionTracker

// ---------------------------------------------------------------------------

//

CBTNotifConnectionTracker& CBTNotifSecurityManager::ConnectionTracker()

    {

    return iParent;

    }

// ---------------------------------------------------------------------------

// Deletes the current pairing handler and transfer the responsibility

// to the specified.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::RenewPairingHandler( 

        CBTNotifBasePairingHandler* aPairingHandler )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    delete iPairingHandler;

    iPairingHandler = aPairingHandler;

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Find the session who requested this and completes its request.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::OutgoingPairCompleted( TInt aErr )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    // the meaning of KHCIErrorBase equals KErrNone. Hide this specific BT stack

	// detail from clients:

    if ( !iMessage.IsNull()  )

        {

        iMessage.Complete( (aErr == KHCIErrorBase) ? KErrNone : aErr );

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// A session will be ended, completes the pending request for this session.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::SessionClosed( CSession2* aSession )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    if ( !iMessage.IsNull() && iMessage.Session() == aSession )

        {

        iMessage.Complete( KErrCancel );

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Unpair the device from registry

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::UnpairDevice( const TBTDevAddr& aAddr )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    TIdentityRelation<TBTNamelessDevice> addrComp( CompareDeviceByAddress );

    TBTNamelessDevice dev;

    dev.SetAddress( aAddr );

    // only do unpairing if the we have a link key with it.

    TInt index = iPairedDevices.Find( dev, addrComp );

    if ( index > KErrNotFound )

        {

        dev = iPairedDevices[index];

        TRequestStatus status( KRequestPending );

        // Unpair the device in registry (synchronously)

        iRegistry.UnpairDevice( dev.Address(), status );

        User::WaitForRequest( status );

        if ( status == KErrNone )

            {

            TBTDeviceSecurity security = dev.GlobalSecurity();

            // Clear trust setting so that correct icon will be shown in ui applications.

            security.SetNoAuthenticate(EFalse );

            security.SetNoAuthorise(EFalse );

            dev.SetGlobalSecurity(security);

            dev.DeleteLinkKey();

            if ( dev.IsValidUiCookie() && 

                 ( dev.UiCookie() & EBTUiCookieJustWorksPaired ) )

                {

                // Remove the UI cookie bit for Just Works pairing.

                TInt32 cookie = dev.UiCookie() & ~EBTUiCookieJustWorksPaired;

                dev.SetUiCookie( cookie );

                }

            // modify the device in registry synchronously

            // status.Int() could be -1 if the device is not in registry 

            // which is totally fine for us.

            (void) UpdateRegDevice( dev );

            }

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

void CBTNotifSecurityManager::BlockDevice( const TBTDevAddr& aAddr , TBool aBanned)

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    TIdentityRelation<TBTNamelessDevice> addrComp( CompareDeviceByAddress );

    TBTNamelessDevice dev;

    dev.SetAddress( aAddr );

    TRequestStatus status( KRequestPending );

    // Unpair the device in registry (synchronously)

    iRegistry.GetDevice(dev,status);

    User::WaitForRequest( status ); 

    if(status == KErrNone)

        {

        TBTDeviceSecurity security = dev.GlobalSecurity();

        security.SetBanned(aBanned);

        if ( aBanned )

            {

            security.SetNoAuthorise(EFalse);

            }

        dev.SetGlobalSecurity(security);

        (void)UpdateRegDevice(dev);

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

TInt CBTNotifSecurityManager::AddUiCookieJustWorksPaired( const TBTNamelessDevice& aDev )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    TInt err( KErrNone );

    // There might be UI cookies used by other applications,

    // we should not overwrite them. 

    TInt32 cookie = aDev.IsValidUiCookie() ? aDev.UiCookie() : EBTUiCookieUndefined;

    if ( !( cookie & EBTUiCookieJustWorksPaired ) )

        {

        // Only update the cookie if the wanted one is not in registry yet

        // to keep minimal operations with registry.

        TBTNamelessDevice dev = aDev;		

        cookie |= EBTUiCookieJustWorksPaired;

        dev.SetUiCookie( cookie );

        err = UpdateRegDevice( dev );

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    return err;

    }

// ---------------------------------------------------------------------------

// update a nameless device in registry

// ---------------------------------------------------------------------------

//

TInt CBTNotifSecurityManager::UpdateRegDevice( const TBTNamelessDevice& aDev )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    TRequestStatus status( KRequestPending );

    // update the device in registry synchronously

    iRegistry.ModifyDevice( aDev, status );

    User::WaitForRequest( status );

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    return status.Int();

    }

// ---------------------------------------------------------------------------

// 0000 for outgoing pairing with a headset.

// The placeholder for future extension (pin code passed in for pairing)

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::GetPinCode(

        TBTPinCode& aPin, const TBTDevAddr& aAddr, TInt aMinPinLength )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    if ( iPairingHandler )

        {

        iPairingHandler->GetPinCode( aPin, aAddr, aMinPinLength );

        }

    else

        {

        // make sure not to leave any text as PIN.

        aPin.Zero();

        aPin().iLength = 0;

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    }

// ---------------------------------------------------------------------------

// Ask server class the connection status of the specified device

// ---------------------------------------------------------------------------

//

TBTEngConnectionStatus CBTNotifSecurityManager::ConnectStatus( const TBTDevAddr& aAddr )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    const CBtDevExtension* devExt = iDevRepository.Device(aAddr);

    TBTEngConnectionStatus status = EBTEngNotConnected;

    if ( devExt ) 

        {

        status = devExt->ServiceConnectionStatus();

        }

    BOstraceFunctionExit0( DUMMY_DEVLIST);

    return status;

    }

// ---------------------------------------------------------------------------

// From class MBTNotifPairingAOObserver.

// Checks if there is an authentication result.

// ---------------------------------------------------------------------------

//

void CBTNotifSecurityManager::RequestCompletedL( CBtSimpleActive* aActive, TInt aStatus )

    {

    BOstraceFunctionEntry0( DUMMY_DEVLIST );

    // Check which request is completed.

    switch( aActive->RequestId() )

        {

        case ESimplePairingResult:

            {

            TBTDevAddr tmpAddr = iSimplePairingRemote;

            if (aStatus != KErrServerTerminated)

                {

                SubscribeSspPairingResult();

                }

            HandlePairingResultL( tmpAddr, aStatus );

            break;

            }

        case EAuthenticationResult:

            {

            TBTDevAddr tmpAddr = iAuthenticateRemote;

            if (aStatus != KErrServerTerminated)

                {

                SubscribeAuthenticateResult();

                }

            HandlePairingResultL( tmpAddr, aStatus );