ipappprotocols_plat/srtp_api/inc/srtpmasterkey.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 0 307788aac0a8
permissions -rw-r--r--
This release addresses the following issues: 1. The crash bug fix when receiving file 2. Now the sending is based on MSRP messages, there is no longer file receiving or sending. Client sends data as MSRP was designed. 3. Soma MSRP stack was created so that the client told the correct session-id, Symbian stack generated it by itself. This is not allowed, it was changed so that clients tell the session-id (same as used in SIP INVITE). 4. Unnecessary division of data to chunks removed when there is no need to interrupt sending. The message is sent in as few chunks as possible. 5. Stack can now receive files and chunks with ?unlimited? size. Old stack wrote the incoming data to memory and did not utilize disk space until the end of chunk was reached (large chunks from another client crashed it). 6. Now when writing the incoming data to file, it will take into account the byte-range header values. So, this complies with the RFC4975 requirements that stack must be able to handle chunks that come in any sequence. 7. Some buffering changes to outgoing/incoming data. 8. The outgoing data is now checked that it does not contain the created transaction-id before sending the data. 9. MSRP success reports are now implemented and tested against servers. 10. Progress report system fixed so progress is now visible on client (all the way to 100%). 11. Message Cancel receiving / Cancel sending now corrected and made to work as rfc4975 requires. (termination from sender and error code from receiver when cancelling). 12. Bug correction related to messages received not belonging to any session, old stack implementation did send error response, but after response was written it did give the buffer to client anyway. Now corrected.

/*
* Copyright (c) 2004 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:    SRTP Master key class.
*
*/




#ifndef __SRTP_MASTER_KEY_H__
#define __SRTP_MASTER_KEY_H__

// INCLUDES
#include <e32def.h>
#include <e32des8.h>
#include <e32base.h>
#include "srtpdef.h"


// STRUCT CLASSES

/**
* Contains an SRTP master key.
*/
class CSRTPMasterKey : public CBase
    {
    public: // constructor
    
        /**
        * Two-phased constructor.
        * CSRTPCryptoContext takes the ownership of MasterKey and MasterSalt 
        * @param aKey  The master key value. Local copy is made.
        * @param aMKI  The master key identifier value. Local copy is made.
        *   			MKI key is optional so if there is no MKI key then 
        *				gives empty string "".
        * @param aN_E  The bit length of the encryption key
        * @param aN_A  The bit length of the authentication key
        * @leave KErrNone if success, system-wide error code otherwise
        */
        IMPORT_C static CSRTPMasterKey* NewL( const TDesC8& aKey, 
                       const TDesC8& aMKI, 
                       TUint aN_E = KSRTPDefSessionEncryptionKeyLength, 
                       TUint aN_A = KSRTPDefSessionAuthenticationKeyLength );

        /**
        * Two-phased constructor.
        * CSRTPCryptoContext takes the ownership of MasterKey and MasterSalt 
        * @param aKey  The master key value. Local copy is made.
        * @param aMKI  The master key identifier value. Local copy is made.
        * @param aN_E  The bit length of the encryption key
        * @param aN_A  The bit length of the authentication key
        * @leave KErrNone if success, system-wide error code otherwise
        */
        IMPORT_C static CSRTPMasterKey* NewLC( const TDesC8& aKey, 
                       const TDesC8& aMKI, 
                       TUint aN_E = KSRTPDefSessionEncryptionKeyLength, 
                       TUint aN_A = KSRTPDefSessionAuthenticationKeyLength );
        
        /**
        * Destructor
        */
        ~CSRTPMasterKey();

        /*
		* Gets current master key value        
        * @return current master key value
        */                                
        IMPORT_C  const TDesC8& MasterKey() const;
        
        /*
		* Gets current MKI
        * @return current MKI
        */                                
        IMPORT_C  const TDesC8& MKI() const;
                            
        /*
		* Gets current encryption key length
        * @return encryption key length
        */                                
        IMPORT_C  TUint EncrKeyLength() const;

        /*
		* Gets current authorization key length
        * @return authorization key length
        */                                
        IMPORT_C  TUint AuthKeyLength() const;

   
        /*
		* Check the validity of the whole SRTPMasterKey
        * @return validity of this SRTPMasterKey
        */
        IMPORT_C  TBool Valid() const;                         
        
    private: //methods
    
        CSRTPMasterKey( TUint aN_E, TUint aN_A );	              
        
        void ConstructL (  const TDesC8& aKey, 
                           const TDesC8& aMKI );
    
      
        /* assignment operator */
         const CSRTPMasterKey& operator=(const CSRTPMasterKey& aKey);      
       
    private: //data
        
        /**
        * The master key value.
        * The length of the key is determined by the Size() function.
        */
        HBufC8 *iKey;

        /**
        * The master key identifier value
        */
        HBufC8* iMKI;

        /**
        * The bit length of the encryption key
        */
        TUint iN_E;

        /**
        * The bit length of the authentication key
        */
        TUint iN_A;

        friend class CSRTPCryptoContext;
 	#ifdef EUNIT_TESTING
        friend class UT_CSRTPMasterKey;
    #endif 
    };


#endif // __SRTP_MASTER_KEY_H__