CCMSAuthenticatedData Class Reference

class CCMSAuthenticatedData : public CCMSSequence

AuthenticatedData type module

ASN.1 Definition:

AuthenticatedData ::= SEQUENCE { version CMSVersion, originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL, recipientInfos RecipientInfos, macAlgorithm MessageAuthenticationCodeAlgorithm, digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL, encapContentInfo EncapsulatedContentInfo, authenticatedAttributes [2] IMPLICIT AuthAttributes OPTIONAL, mac MessageAuthenticationCode, unauthenticatedAttributes [3] IMPLICIT UnauthAttributes OPTIONAL }

AuthAttributes ::= SET SIZE (1..MAX) OF Attribute UnauthAttributes ::= SET SIZE (1..MAX) OF Attribute

RecipientInfos ::= SET OF RecipientInfo

MessageAuthenticationCode ::= OCTET STRING

MessageAuthenticationCodeAlgorithm ::= AlgorithmIdentifier DigestAlgorithmIdentifier ::= AlgorithmIdentifier

cms.lib
Since
3.0

Inherits from

Public Member Functions
~CCMSAuthenticatedData ()
IMPORT_C const CArrayPtr < CCMSAttribute > * AuthenticatedAttributes ()
void DecodeL (const TDesC8 &)
IMPORT_C const CCMSX509AlgorithmIdentifier * DigestAlgorithm ()
IMPORT_C const CCMSEncapsulatedContentInfo & EncapContentInfo ()
CASN1EncBase * EncoderLC ()
IMPORT_C const TDesC8 & Mac ()
IMPORT_C const CCMSX509AlgorithmIdentifier & MacAlgorithm ()
IMPORT_C CCMSAuthenticatedData * NewLC ()
IMPORT_C CCMSAuthenticatedData * NewLC ( CArrayPtr < CCMSRecipientInfo > *, CCMSX509AlgorithmIdentifier *, CCMSEncapsulatedContentInfo *, const TDesC8 &)
IMPORT_C const CCMSOriginatorInfo * OriginatorInfo ()
IMPORT_C const CArrayPtr < CCMSRecipientInfo > & RecipientInfos ()
IMPORT_C void SetAuthenticatedAttributesL ( CArrayPtr < CCMSAttribute > *)
IMPORT_C void SetDigestAlgorithmL ( CCMSX509AlgorithmIdentifier *)
IMPORT_C void SetEncapContentInfoL ( CCMSEncapsulatedContentInfo *)
IMPORT_C void SetMacAlgorithmL ( CCMSX509AlgorithmIdentifier *)
IMPORT_C void SetMacL (const TDesC8 &)
IMPORT_C void SetOriginatorInfoL ( CCMSOriginatorInfo *)
IMPORT_C void SetRecipientInfosL ( CArrayPtr < CCMSRecipientInfo > *)
IMPORT_C void SetUnauthenticatedAttributesL ( CArrayPtr < CCMSAttribute > *)
IMPORT_C void SetVersion ( TInt )
IMPORT_C const CArrayPtr < CCMSAttribute > * UnauthenticatedAttributes ()
IMPORT_C TInt Version ()
Protected Member Functions
CCMSAuthenticatedData ()
IMPORT_C void ConstructL ()
IMPORT_C void ConstructL ( CArrayPtr < CCMSRecipientInfo > *, CCMSX509AlgorithmIdentifier *, CCMSEncapsulatedContentInfo *, const TDesC8 &)
Private Member Functions
CArrayPtrFlat < CCMSAttribute > * DecodeAttributesL ( TASN1DecGeneric *)
NONSHARABLE_CLASS (CAuthenticatedDataData)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCMSSequence::CCMSSequence()
CCMSSequence::CreateDerEncodingL(CASN1EncBase *)
CCMSSequence::DecodeSequenceLC(const TDesC8 &)
CCMSSequence::DecodeSequenceLC(const TDesC8 &,TInt,TInt)
CCMSSequence::EncodeL(HBufC8 *&)const
Private Attributes
CAuthenticatedDataData * iData
MCMSAuthenticatedDataExtension * iReserved

Constructor & Destructor Documentation

CCMSAuthenticatedData()

IMPORT_C CCMSAuthenticatedData ( ) [protected]

C++ default constructor.

~CCMSAuthenticatedData()

~CCMSAuthenticatedData ( ) [virtual]

Destructor.

Member Functions Documentation

AuthenticatedAttributes()

IMPORT_C const CArrayPtr < CCMSAttribute > * AuthenticatedAttributes ( ) const
Getter for authenticatedAttributes
Since
3.0

ConstructL()

IMPORT_C void ConstructL ( ) [protected]

Protected construction to allow derivation

ConstructL(CArrayPtr< CCMSRecipientInfo > *, CCMSX509AlgorithmIdentifier *, CCMSEncapsulatedContentInfo *, const TDesC8 &)

IMPORT_C void ConstructL ( CArrayPtr < CCMSRecipientInfo > * aRecipientInfos,
CCMSX509AlgorithmIdentifier * aMacAlgorithm,
CCMSEncapsulatedContentInfo * aEncapContentInfo,
const TDesC8 & aMac
) [protected]

Protected construction to allow derivation

Parameters

CArrayPtr < CCMSRecipientInfo > * aRecipientInfos
CCMSX509AlgorithmIdentifier * aMacAlgorithm
CCMSEncapsulatedContentInfo * aEncapContentInfo
const TDesC8 & aMac

DecodeAttributesL(TASN1DecGeneric *)

CArrayPtrFlat < CCMSAttribute > * DecodeAttributesL ( TASN1DecGeneric * aAttributesDec ) [private]

Decodes an attribute sequence.

Parameters

TASN1DecGeneric * aAttributesDec

DecodeL(const TDesC8 &)

void DecodeL ( const TDesC8 & aRawData )
From MCMSModule
Since
3.0

Parameters

const TDesC8 & aRawData raw-data to be parsed in this instance

DigestAlgorithm()

IMPORT_C const CCMSX509AlgorithmIdentifier * DigestAlgorithm ( ) const
Getter for digestAlgorithm
Since
3.0

EncapContentInfo()

IMPORT_C const CCMSEncapsulatedContentInfo & EncapContentInfo ( ) const
Getter for encapContentInfo
Since
3.0

EncoderLC()

CASN1EncBase * EncoderLC ( ) const
From MCMSModule
Since
3.0

Mac()

IMPORT_C const TDesC8 & Mac ( ) const
Getter for mac
Since
3.0

MacAlgorithm()

IMPORT_C const CCMSX509AlgorithmIdentifier & MacAlgorithm ( ) const
Getter for macAlgorithm.
Since
3.0

NONSHARABLE_CLASS(CAuthenticatedDataData)

NONSHARABLE_CLASS ( CAuthenticatedDataData ) [private, inline]

Container for the actual data

Parameters

CAuthenticatedDataData

NewLC()

IMPORT_C CCMSAuthenticatedData * NewLC ( ) [static]

Two-phased constructor. NOTE: Encrypt will leave with KErrArgument if valid parameters are not set.

NewLC(CArrayPtr< CCMSRecipientInfo > *, CCMSX509AlgorithmIdentifier *, CCMSEncapsulatedContentInfo *, const TDesC8 &)

IMPORT_C CCMSAuthenticatedData * NewLC ( CArrayPtr < CCMSRecipientInfo > * aRecipientInfos,
CCMSX509AlgorithmIdentifier * aMacAlgorithm,
CCMSEncapsulatedContentInfo * aEncapContentInfo,
const TDesC8 & aMac
) [static]

Two-phased constructor. Takes ownership of all parameters, except aMac which is copied. Leaves newly created instance in CleanupStack

Parameters

CArrayPtr < CCMSRecipientInfo > * aRecipientInfos
CCMSX509AlgorithmIdentifier * aMacAlgorithm
CCMSEncapsulatedContentInfo * aEncapContentInfo
const TDesC8 & aMac

OriginatorInfo()

IMPORT_C const CCMSOriginatorInfo * OriginatorInfo ( ) const
Getter for originatorInfo
Since
3.0

RecipientInfos()

IMPORT_C const CArrayPtr < CCMSRecipientInfo > & RecipientInfos ( ) const
Getter for recipientInfos.
Since
3.0

SetAuthenticatedAttributesL(CArrayPtr< CCMSAttribute > *)

IMPORT_C void SetAuthenticatedAttributesL ( CArrayPtr < CCMSAttribute > * aAuthenticatedAttributes )
Setter for authenticatedAttributes. Takes ownership.
Since
3.0

Parameters

CArrayPtr < CCMSAttribute > * aAuthenticatedAttributes array of attributes.

SetDigestAlgorithmL(CCMSX509AlgorithmIdentifier *)

IMPORT_C void SetDigestAlgorithmL ( CCMSX509AlgorithmIdentifier * aDigestAlgorithm )
Setter for digestAlgorithm. Takes ownership.
Since
3.0

Parameters

CCMSX509AlgorithmIdentifier * aDigestAlgorithm DigestAlgorithmIdentifier

SetEncapContentInfoL(CCMSEncapsulatedContentInfo *)

IMPORT_C void SetEncapContentInfoL ( CCMSEncapsulatedContentInfo * aEncapContentInfo )
Setter for encapContentInfo. Takes ownership.
Since
3.0

Parameters

CCMSEncapsulatedContentInfo * aEncapContentInfo EncapsulatedContentInfo. If this parameter is NULL, this method will leave with KErrArgument.

SetMacAlgorithmL(CCMSX509AlgorithmIdentifier *)

IMPORT_C void SetMacAlgorithmL ( CCMSX509AlgorithmIdentifier * aMacAlgorithm )
Setter for macAlgorithm. Takes ownership.
Since
3.0

Parameters

CCMSX509AlgorithmIdentifier * aMacAlgorithm MessageAuthenticationCodeAlgorithm. If this parameter is null, this method leaves with KErrArgument.

SetMacL(const TDesC8 &)

IMPORT_C void SetMacL ( const TDesC8 & aMac )
Setter for mac. Creates a copy.
Since
3.0

Parameters

const TDesC8 & aMac MessageAuthenticationCode

SetOriginatorInfoL(CCMSOriginatorInfo *)

IMPORT_C void SetOriginatorInfoL ( CCMSOriginatorInfo * aOriginatorInfo )
Setter for originatorInfo. Takes ownership.
Since
3.0

Parameters

CCMSOriginatorInfo * aOriginatorInfo OriginatorInfo

SetRecipientInfosL(CArrayPtr< CCMSRecipientInfo > *)

IMPORT_C void SetRecipientInfosL ( CArrayPtr < CCMSRecipientInfo > * aRecipientInfos )
Setter for recipientInfos. Takes ownership.
Since
3.0

Parameters

CArrayPtr < CCMSRecipientInfo > * aRecipientInfos array of RecipientInfos. There must be at least one element in the array, otherwise thois method will leave with KErrArgument

SetUnauthenticatedAttributesL(CArrayPtr< CCMSAttribute > *)

IMPORT_C void SetUnauthenticatedAttributesL ( CArrayPtr < CCMSAttribute > * aUnauthenticatedAttributes )
Setter for unauthenticatedAttributes. Takes ownership.
Since
3.0

Parameters

CArrayPtr < CCMSAttribute > * aUnauthenticatedAttributes

SetVersion(TInt)

IMPORT_C void SetVersion ( TInt aVersion )
Setter for version. Default value is 0.
Since
3.0

Parameters

TInt aVersion CMSVersion value

UnauthenticatedAttributes()

IMPORT_C const CArrayPtr < CCMSAttribute > * UnauthenticatedAttributes ( ) const
Getter for unauthenticatedAttributes
Since
3.0

Version()

IMPORT_C TInt Version ( ) const
Getter for version
Since
3.0

Member Data Documentation

CAuthenticatedDataData * iData

CAuthenticatedDataData * iData [private]

MCMSAuthenticatedDataExtension * iReserved

MCMSAuthenticatedDataExtension * iReserved [private]