natplugins/natptraversalcontroller/src/cnattraversalconfig.cpp
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "cnattraversalconfig.h"
       
    20 #include "nattraversallog.h"
       
    21 #include <unsafprotocolscrkeys.h>
       
    22 #include <e32svr.h>
       
    23 #include <in_sock.h>
       
    24 
       
    25 const TInt KDefaultUDPRefreshInterval = 28;
       
    26 const TInt KDefaultTCPRefreshInterval = 1200;
       
    27 const TInt KDefaultSTUNRetransmitTimer = 250; // milliseconds
       
    28 
       
    29 
       
    30 // -----------------------------------------------------------------------------
       
    31 // CNATTraversalConfig::NewL
       
    32 // -----------------------------------------------------------------------------
       
    33 //
       
    34 CNATTraversalConfig* CNATTraversalConfig::NewL(
       
    35     TUint32 aIapId,
       
    36     const TDesC8& aDomain)
       
    37     {
       
    38     CNATTraversalConfig* self = CNATTraversalConfig::NewLC(aIapId,aDomain);
       
    39     CleanupStack::Pop(self);
       
    40     return self;
       
    41     }
       
    42 
       
    43 // -----------------------------------------------------------------------------
       
    44 // CNATTraversalConfig::NewLC
       
    45 // -----------------------------------------------------------------------------
       
    46 //
       
    47 CNATTraversalConfig* CNATTraversalConfig::NewLC(
       
    48     TUint32 aIapId,
       
    49     const TDesC8& aDomain)
       
    50     {
       
    51     CNATTraversalConfig* self = new(ELeave)CNATTraversalConfig(aIapId);
       
    52     CleanupStack::PushL(self);
       
    53     self->ConstructL(aDomain);
       
    54     return self;
       
    55     }
       
    56 
       
    57 // -----------------------------------------------------------------------------
       
    58 // CNATTraversalConfig::CNATTraversalConfig
       
    59 // -----------------------------------------------------------------------------
       
    60 //
       
    61 CNATTraversalConfig::CNATTraversalConfig(TUint32 aIapId)
       
    62  : iIapId(aIapId),
       
    63    iUDPRefreshInterval(KDefaultUDPRefreshInterval),
       
    64    iTCPRefreshInterval(KDefaultTCPRefreshInterval),
       
    65    iSTUNRetransmitTimer(KDefaultSTUNRetransmitTimer),
       
    66    iCRLFRefreshEnabled(EUndefined),
       
    67    iSharedSecretNotSupported(EFalse),
       
    68    iBindingRequestFailed(EFalse)
       
    69     {
       
    70     }
       
    71 
       
    72 // -----------------------------------------------------------------------------
       
    73 // CNATTraversalConfig::ConstructL
       
    74 // -----------------------------------------------------------------------------
       
    75 //
       
    76 void CNATTraversalConfig::ConstructL(const TDesC8& aDomain)
       
    77     {
       
    78     __ASSERT_ALWAYS(aDomain.Length() > 0, User::Leave(KErrArgument));
       
    79 
       
    80     iCenRep = CRepository::NewL(KCRUidUNSAFProtocols);
       
    81 
       
    82     // Read domain settings first.
       
    83     // This way IAP specific timers override the domain specific values.
       
    84     ReadDomainSettingsL(*iCenRep,aDomain);
       
    85     ReadIapSettingsL(*iCenRep,iIapId);
       
    86 
       
    87     iDomain = aDomain.AllocL();
       
    88 
       
    89     NATTRAVERSAL_INTLOG("CNATTraversalConfig::IAP",iIapId)
       
    90     NATTRAVERSAL_STRLOG("CNATTraversalConfig::Domain",*iDomain)
       
    91     NATTRAVERSAL_STRLOG("CNATTraversalConfig::STUNServer",*iSTUNServer)
       
    92     NATTRAVERSAL_STRLOG("CNATTraversalConfig::STUNUsername",*iUsername)
       
    93     NATTRAVERSAL_STRLOG("CNATTraversalConfig::STUNPassword",*iPassword)
       
    94     NATTRAVERSAL_INTLOG("CNATTraversalConfig::STUNServerPort",iSTUNServerPort)
       
    95     NATTRAVERSAL_INTLOG("CNATTraversalConfig::UDPRefresh",iUDPRefreshInterval)
       
    96     NATTRAVERSAL_INTLOG("CNATTraversalConfig::TCPRefresh",iTCPRefreshInterval)
       
    97     NATTRAVERSAL_INTLOG("CNATTraversalConfig::STUNRetransmit",iSTUNRetransmitTimer)
       
    98     NATTRAVERSAL_INTLOG("CNATTraversalConfig::CRLFRefresh",iCRLFRefreshEnabled)
       
    99     NATTRAVERSAL_INTLOG("CNATTraversalConfig::LastBindingReqFailed",iBindingRequestFailed)
       
   100     }
       
   101 
       
   102 // -----------------------------------------------------------------------------
       
   103 // CNATTraversalConfig::~CNATTraversalConfig
       
   104 // -----------------------------------------------------------------------------
       
   105 //
       
   106 CNATTraversalConfig::~CNATTraversalConfig()
       
   107     {
       
   108     delete iSTUNServer;
       
   109     delete iDomain;
       
   110     delete iUsername;
       
   111     delete iPassword;
       
   112     if (iDomainKey)
       
   113         {
       
   114         // Remove settings added during runtime
       
   115         if (iCenRep)
       
   116             {
       
   117             iCenRep->Delete(
       
   118                 KUNSAFProtocolsDomainSharedSecretNotSupported|iDomainKey);
       
   119             iCenRep->Delete(
       
   120                 KUNSAFProtocolsDomainBindingRequestFailed|iDomainKey);
       
   121             }
       
   122         }
       
   123     delete iCenRep;
       
   124     }
       
   125 
       
   126 // -----------------------------------------------------------------------------
       
   127 // CNATTraversalConfig::IapId
       
   128 // -----------------------------------------------------------------------------
       
   129 //
       
   130 TUint32 CNATTraversalConfig::IapId() const
       
   131     {
       
   132     return iIapId;
       
   133     }
       
   134 
       
   135 // -----------------------------------------------------------------------------
       
   136 // CNATTraversalConfig::Domain
       
   137 // -----------------------------------------------------------------------------
       
   138 //
       
   139 const TDesC8& CNATTraversalConfig::Domain() const
       
   140     {
       
   141     return *iDomain;
       
   142     }
       
   143 
       
   144 // -----------------------------------------------------------------------------
       
   145 // CNATTraversalConfig::STUNServer
       
   146 // -----------------------------------------------------------------------------
       
   147 //
       
   148 const TDesC8& CNATTraversalConfig::STUNServer() const
       
   149     {
       
   150     return *iSTUNServer;
       
   151     }
       
   152 
       
   153 // -----------------------------------------------------------------------------
       
   154 // CNATTraversalConfig::STUNServerPort
       
   155 // -----------------------------------------------------------------------------
       
   156 //
       
   157 TUint CNATTraversalConfig::STUNServerPort() const
       
   158     {
       
   159     return iSTUNServerPort;
       
   160     }
       
   161 
       
   162 // -----------------------------------------------------------------------------
       
   163 // CNATTraversalConfig::UDPRefreshInterval
       
   164 // -----------------------------------------------------------------------------
       
   165 //
       
   166 TInt CNATTraversalConfig::UDPRefreshInterval() const
       
   167     {
       
   168     return iUDPRefreshInterval;
       
   169     }
       
   170 
       
   171 // -----------------------------------------------------------------------------
       
   172 // CNATTraversalConfig::TCPRefreshInterval
       
   173 // -----------------------------------------------------------------------------
       
   174 //
       
   175 TInt CNATTraversalConfig::TCPRefreshInterval() const
       
   176     {
       
   177     return iTCPRefreshInterval;
       
   178     }
       
   179 
       
   180 // -----------------------------------------------------------------------------
       
   181 // CNATTraversalConfig::STUNRetransmitTimer
       
   182 // -----------------------------------------------------------------------------
       
   183 //
       
   184 TInt CNATTraversalConfig::STUNRetransmitTimer() const
       
   185     {
       
   186     return iSTUNRetransmitTimer;
       
   187     }
       
   188 
       
   189 // -----------------------------------------------------------------------------
       
   190 // CNATTraversalConfig::CRLFRefreshEnabledToProxy
       
   191 // If CRLF refresh is not specified in central repository, the default value is
       
   192 // "enabled" for TCP and "disabled" for UDP.
       
   193 // -----------------------------------------------------------------------------
       
   194 //
       
   195 TBool CNATTraversalConfig::CRLFRefreshEnabledToProxy(TUint aProtocol) const
       
   196 	{
       
   197 	if ( aProtocol == KProtocolInetTcp )
       
   198 		{
       
   199 		return iCRLFRefreshEnabled != EDisabled;
       
   200 		}
       
   201 
       
   202 	return iCRLFRefreshEnabled == EEnabled;
       
   203 	}
       
   204 
       
   205 // -----------------------------------------------------------------------------
       
   206 // CNATTraversalConfig::CRLFRefreshEnabledToProxyValue
       
   207 // -----------------------------------------------------------------------------
       
   208 //
       
   209 CNATTraversalConfig::TRefreshValue
       
   210 CNATTraversalConfig::CRLFRefreshEnabledToProxyValue() const
       
   211     {
       
   212     return iCRLFRefreshEnabled;
       
   213     }
       
   214 
       
   215 // -----------------------------------------------------------------------------
       
   216 // CNATTraversalConfig::SharedSecretNotSupported
       
   217 // -----------------------------------------------------------------------------
       
   218 //
       
   219 TBool CNATTraversalConfig::SharedSecretNotSupported() const
       
   220     {
       
   221     return iSharedSecretNotSupported;
       
   222     }
       
   223 
       
   224 // -----------------------------------------------------------------------------
       
   225 // CNATTraversalConfig::Username
       
   226 // -----------------------------------------------------------------------------
       
   227 //
       
   228 const TDesC8& CNATTraversalConfig::Username() const
       
   229     {
       
   230     return *iUsername;
       
   231     }
       
   232 
       
   233 // -----------------------------------------------------------------------------
       
   234 // CNATTraversalConfig::Password
       
   235 // -----------------------------------------------------------------------------
       
   236 //
       
   237 const TDesC8& CNATTraversalConfig::Password() const
       
   238     {
       
   239     return *iPassword;
       
   240     }
       
   241 
       
   242 // -----------------------------------------------------------------------------
       
   243 // CNATTraversalConfig::SetSharedSecretNotSupportedL
       
   244 // -----------------------------------------------------------------------------
       
   245 //
       
   246 void CNATTraversalConfig::SetSharedSecretNotSupportedL(TBool aNotSupported)
       
   247     {
       
   248     WriteL(KUNSAFProtocolsDomainSharedSecretNotSupported,aNotSupported);
       
   249     iSharedSecretNotSupported = aNotSupported;
       
   250     }
       
   251 
       
   252 // -----------------------------------------------------------------------------
       
   253 // CNATTraversalConfig::BindingRequestFailed
       
   254 // -----------------------------------------------------------------------------
       
   255 //
       
   256 TBool CNATTraversalConfig::BindingRequestFailed() const
       
   257     {
       
   258     return iBindingRequestFailed;
       
   259     }
       
   260 
       
   261 // -----------------------------------------------------------------------------
       
   262 // CNATTraversalConfig::SetBindingRequestFailedL
       
   263 // -----------------------------------------------------------------------------
       
   264 //
       
   265 void CNATTraversalConfig::SetBindingRequestFailedL(TBool aFailed)
       
   266     {
       
   267     WriteL(KUNSAFProtocolsDomainBindingRequestFailed,aFailed);
       
   268     iBindingRequestFailed = aFailed;
       
   269     }
       
   270 
       
   271 // -----------------------------------------------------------------------------
       
   272 // CNATTraversalConfig::ReadDomainSettingsL
       
   273 // -----------------------------------------------------------------------------
       
   274 //
       
   275 void CNATTraversalConfig::ReadDomainSettingsL(
       
   276     CRepository& aRepository,
       
   277     const TDesC8& aDomain)
       
   278     {
       
   279     RArray<TUint32> keys;
       
   280     CleanupClosePushL(keys);
       
   281     TInt err = aRepository.FindEqL(KUNSAFProtocolsDomainMask,
       
   282                                    KUNSAFProtocolsFieldTypeMask,
       
   283                                    aDomain,
       
   284                                    keys);
       
   285     if (err == KErrNone && keys.Count() == 1)
       
   286         {
       
   287         TUint32 key = (KUNSAFProtocolsDomainMask^(keys[0]));
       
   288         key |= KUNSAFProtocolsDomainTableMask;
       
   289         // Server
       
   290         TBuf8<1> tmp;
       
   291         TInt actualLength = 0;
       
   292         TInt status =
       
   293             aRepository.Get(KUNSAFProtocolsSTUNServerMask|key,tmp,actualLength);
       
   294         if ((status == KErrNone || status == KErrOverflow) &&
       
   295             (actualLength > 0))
       
   296             {
       
   297             iSTUNServer = HBufC8::NewL(actualLength);
       
   298             TPtr8 ptr(iSTUNServer->Des());
       
   299             User::LeaveIfError(
       
   300                 aRepository.Get(KUNSAFProtocolsSTUNServerMask|key,ptr));
       
   301             }
       
   302         else
       
   303             {
       
   304             iSTUNServer = KNullDesC8().AllocL();
       
   305             }
       
   306         // Username
       
   307         actualLength = 0;
       
   308         status = aRepository.Get(KUNSAFProtocolsSTUNUsernameMask|key,
       
   309                                  tmp,actualLength);
       
   310         if ((status == KErrNone || status == KErrOverflow) &&
       
   311             (actualLength > 0))
       
   312             {
       
   313             iUsername = HBufC8::NewL(actualLength);
       
   314             TPtr8 ptr(iUsername->Des());
       
   315             User::LeaveIfError(
       
   316                 aRepository.Get(KUNSAFProtocolsSTUNUsernameMask|key,ptr));
       
   317             }
       
   318         else
       
   319             {
       
   320             iUsername = KNullDesC8().AllocL();
       
   321             }
       
   322         // Password
       
   323         actualLength = 0;
       
   324         status = aRepository.Get(KUNSAFProtocolsSTUNPasswordMask|key,
       
   325                                  tmp,actualLength);
       
   326         if ((status == KErrNone || status == KErrOverflow) &&
       
   327             (actualLength > 0))
       
   328             {
       
   329             iPassword = HBufC8::NewL(actualLength);
       
   330             TPtr8 ptr(iPassword->Des());
       
   331             User::LeaveIfError(
       
   332                 aRepository.Get(KUNSAFProtocolsSTUNPasswordMask|key,ptr));
       
   333             }
       
   334         else
       
   335             {
       
   336             iPassword = KNullDesC8().AllocL();
       
   337             }
       
   338         // Server port
       
   339         TInt tmpPort = 0;
       
   340         if (Read(aRepository,KUNSAFProtocolsSTUNServerPortMask|key,tmpPort))
       
   341             {
       
   342             iSTUNServerPort = static_cast<TUint>(tmpPort);
       
   343             }
       
   344         // UDP refresh interval
       
   345         Read(aRepository,KUNSAFProtocolsDomainIntervalUDPMask|key,
       
   346              iUDPRefreshInterval);
       
   347         // TCP refresh interval
       
   348         Read(aRepository,KUNSAFProtocolsDomainIntervalTCPMask|key,
       
   349              iTCPRefreshInterval);
       
   350 		// CRLF refresh enabled
       
   351 		ReadCRLFRefreshEnabled(aRepository, key);
       
   352         // Shared secret support
       
   353         ReadBoolValue(aRepository,
       
   354                       KUNSAFProtocolsDomainSharedSecretNotSupported|key,
       
   355                       iSharedSecretNotSupported);
       
   356         // Latest binding request status
       
   357         ReadBoolValue(aRepository,
       
   358                       KUNSAFProtocolsDomainBindingRequestFailed|key,
       
   359                       iBindingRequestFailed);
       
   360         iDomainKey = key;
       
   361         }
       
   362     else
       
   363         {
       
   364         iSTUNServer = KNullDesC8().AllocL();
       
   365         iUsername = KNullDesC8().AllocL();
       
   366         iPassword = KNullDesC8().AllocL();
       
   367         }
       
   368     CleanupStack::PopAndDestroy(&keys);
       
   369     }
       
   370 
       
   371 // -----------------------------------------------------------------------------
       
   372 // CNATTraversalConfig::ReadIapSettingsL
       
   373 // -----------------------------------------------------------------------------
       
   374 //
       
   375 void CNATTraversalConfig::ReadIapSettingsL(
       
   376     CRepository& aRepository,
       
   377     TUint32 aIapId)
       
   378     {
       
   379     RArray<TUint32> keys;
       
   380     CleanupClosePushL(keys);
       
   381     TInt err = aRepository.FindEqL(KUNSAFProtocolsIAPIdMask,
       
   382                                    KUNSAFProtocolsFieldTypeMask,
       
   383                                    static_cast<TInt>(aIapId),
       
   384                                    keys);
       
   385     if (err == KErrNone && keys.Count() == 1)
       
   386         {
       
   387         TUint32 key = (KUNSAFProtocolsIAPIdMask^(keys[0]));
       
   388         key |= KUNSAFProtocolsIAPTableMask;
       
   389         // UDP refresh interval
       
   390         Read(aRepository,KUNSAFProtocolsIntervalUDPMask|key,
       
   391              iUDPRefreshInterval);
       
   392         // TCP refresh interval
       
   393         Read(aRepository,KUNSAFProtocolsIntervalTCPMask|key,
       
   394              iTCPRefreshInterval);
       
   395         // Retransmit interval
       
   396         Read(aRepository,KUNSAFProtocolsSTUNRetransmitTimerMask|key,
       
   397              iSTUNRetransmitTimer);
       
   398         }
       
   399     CleanupStack::PopAndDestroy(&keys);
       
   400     }
       
   401 
       
   402 // -----------------------------------------------------------------------------
       
   403 // CNATTraversalConfig::ReadCRLFRefreshEnabled
       
   404 // -----------------------------------------------------------------------------
       
   405 //
       
   406 void CNATTraversalConfig::ReadCRLFRefreshEnabled(CRepository& aRepository,
       
   407     											 const TUint32 aKey)
       
   408 	{
       
   409 	TInt value( 0 );
       
   410 	if ( Read( aRepository,
       
   411 			   KUNSAFProtocolsDomainEnableCRLFRefresh | aKey,
       
   412 			   value ) )
       
   413 		{
       
   414 		if ( value )
       
   415 			{
       
   416 			iCRLFRefreshEnabled	= EEnabled;
       
   417 			}
       
   418 		else
       
   419 			{
       
   420 			iCRLFRefreshEnabled	= EDisabled;
       
   421 			}
       
   422 		}
       
   423 	}
       
   424 
       
   425 // -----------------------------------------------------------------------------
       
   426 // CNATTraversalConfig::ReadBoolValue
       
   427 // -----------------------------------------------------------------------------
       
   428 //
       
   429 void CNATTraversalConfig::ReadBoolValue(
       
   430     CRepository& aRepository,
       
   431     const TUint32& aKey,
       
   432     TBool& aKeyValue) const
       
   433     {
       
   434     TInt tmp = 0;
       
   435     Read(aRepository,aKey,tmp);
       
   436     aKeyValue = (tmp != 0);
       
   437     }
       
   438 
       
   439 // -----------------------------------------------------------------------------
       
   440 // CNATTraversalConfig::Read
       
   441 // -----------------------------------------------------------------------------
       
   442 //
       
   443 TBool CNATTraversalConfig::Read(
       
   444     CRepository& aRepository,
       
   445     const TUint32& aKey,
       
   446     TInt& aKeyValue) const
       
   447     {
       
   448     TBool found = EFalse;
       
   449     TInt tmp;
       
   450     if (aRepository.Get(aKey,tmp) == KErrNone)
       
   451         {
       
   452         aKeyValue = tmp;
       
   453         found = ETrue;
       
   454         }
       
   455     return found;
       
   456     }
       
   457 
       
   458 // -----------------------------------------------------------------------------
       
   459 // CNATTraversalConfig::WriteL
       
   460 // -----------------------------------------------------------------------------
       
   461 //
       
   462 void CNATTraversalConfig::WriteL(
       
   463     TUint32 aFieldMask,
       
   464     TBool aValue)
       
   465     {
       
   466     User::LeaveIfError(
       
   467         iCenRep->StartTransaction(
       
   468             CRepository::EConcurrentReadWriteTransaction));
       
   469     iCenRep->CleanupCancelTransactionPushL();
       
   470 
       
   471     if (!iDomainKey)
       
   472         {
       
   473         // No domain settings. Create a new key and value.
       
   474         iDomainKey = CreateNewKeyL(*iCenRep, KUNSAFProtocolsDomainMask,
       
   475                                    KUNSAFProtocolsDomainTableMask);
       
   476         User::LeaveIfError(
       
   477             iCenRep->Create(iDomainKey|KUNSAFProtocolsDomainMask,*iDomain));
       
   478         User::LeaveIfError(
       
   479             iCenRep->Create(iDomainKey|aFieldMask,aValue));
       
   480         }
       
   481     else
       
   482         {
       
   483         TUint32 key = (aFieldMask|iDomainKey);
       
   484         TInt tmp = 0;
       
   485         if (iCenRep->Get(key,tmp) == KErrNone)
       
   486             {
       
   487             // Update existing value
       
   488             User::LeaveIfError(iCenRep->Set(key,aValue));
       
   489             }
       
   490         else
       
   491             {
       
   492             // Create new value
       
   493             User::LeaveIfError(iCenRep->Create(key,aValue));
       
   494             }
       
   495         }
       
   496 
       
   497     TUint32 dummy;
       
   498     User::LeaveIfError(iCenRep->CommitTransaction(dummy));
       
   499     CleanupStack::Pop(1); // transaction
       
   500     }
       
   501 
       
   502 // -----------------------------------------------------------------------------
       
   503 // CNATTraversalConfig::CreateNewKeyL
       
   504 // -----------------------------------------------------------------------------
       
   505 //
       
   506 TUint32 CNATTraversalConfig::CreateNewKeyL(
       
   507     CRepository& aRepository,
       
   508     TUint32 aKey,
       
   509     TUint32 aTable) const
       
   510     {
       
   511     TUint32 newKey = 0;
       
   512     RArray<TUint32> keys;
       
   513     CleanupClosePushL( keys );
       
   514     TInt err = aRepository.FindL( aKey,
       
   515                                   KUNSAFProtocolsFieldTypeMask,
       
   516                                   keys );
       
   517     TInt keyCount = keys.Count();
       
   518     if ( err == KErrNotFound )
       
   519         {
       
   520         newKey = 1;
       
   521         }
       
   522     else
       
   523         {
       
   524         User::LeaveIfError( err );
       
   525         if ( keyCount == 0 )
       
   526             {
       
   527             newKey = 1;
       
   528             }
       
   529         else
       
   530             {
       
   531             // Find the biggest key and increment it by one
       
   532             keys.SortUnsigned();
       
   533             TUint32 maxKey = aKey^keys[ keyCount - 1 ];
       
   534             newKey = maxKey + 1;
       
   535             }
       
   536         }
       
   537     newKey |= aTable;
       
   538     CleanupStack::PopAndDestroy( &keys );
       
   539     return newKey;
       
   540     }