Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <e32cmn.h>
Link against: euser.lib

Class TSecurityPolicy

class TSecurityPolicy;

Description

Class representing a generic security policy

This class can specify a security policy consisting of either:

  1. A check for between 0 and 7 capabilities

  2. A check for a given Secure ID along with 0-3 capabilities

  3. A check for a given Vendor ID along with 0-3 capabilities

If multiple capabilities are specified, all of them must be present for the security check to succeed ('AND' relation).

The envisaged use case for this class is to specify access rights to an object managed either by the kernel or by a server but in principle owned by a client and usable in a limited way by other clients. For example

In these cases the owning client would pass one (or more) of these objects to the server to specify which security checks should be done on other clients before allowing access to the object.

To pass a TSecurityPolicy object via IPC, a client should obtain a descriptor for the object using TSecurityPolicy::Package()const and send this. When a server receives this descriptor it should read the descriptor contents into a TSecurityPolicyBuf and then TSecurityPolicy::Set(const TDesC8 &) should be used to create a policy object from this.

Because this class has non-default constructors, compilers will not initialise this object at compile time, instead code will be generated to construct the object at run-time. This is wasteful - and Symbian OS DLLs are not permitted to have such uninitialised data. To overcome these problems a set of macros are provided to construct a const object which behaves like a TSecurityPolicy. These are:

_LIT_SECURITY_POLICY_C1 through _LIT_SECURITY_POLICY_C7, _LIT_SECURITY_POLICY_S0 through _LIT_SECURITY_POLICY_S3 and _LIT_SECURITY_POLICY_V0 through _LIT_SECURITY_POLICY_V3.

Also, the macros _LIT_SECURITY_POLICY_PASS and _LIT_SECURITY_POLICY_FAIL are provided in order to allow easy construction of a const object which can be used as a TSecuityPolicy which always passes or always fails, respectively.

If a security policy object is needed to be embedded in another class then the TStaticSecurityPolicy structure can be used. This behaves in the same way as a TSecurityPolicy object but may be initialised at compile time.

Members

Defined in TSecurityPolicy:

See also:


Construction and destruction


TSecurityPolicy()

inline TSecurityPolicy();

Description

Constructs a TSecurityPolicy that will always fail, irrespective of the checked object's attributes.


TSecurityPolicy(TSecPolicyType)

IMPORT_C TSecurityPolicy(TSecPolicyType aType);

Description

Constructs a TSecurityPolicy to either always pass or always fail checks made against it, depending on the value of aType.

Parameters

TSecurityPolicy::TSecPolicyType aType

Must be one of EAlwaysPass or EAlwaysFail

Panic codes

USER

191 if aType is not a valid value


TSecurityPolicy(TCapability,TCapability,TCapability)

IMPORT_C TSecurityPolicy(TCapability aCap1, TCapability aCap2=ECapability_None, TCapability aCap3=ECapability_None);

Description

Construct a TSecurityPolicy object to check up to 3 capabilties.

Parameters

TCapability aCap1

The first capability to add to this policy

TCapability aCap2

An optional second capability to add to this policy

TCapability aCap3

An optional third capability to add to this policy

Panic codes

USER

189 If any of the supplied capabilities are not valid.


TSecurityPolicy(TCapability,TCapability,TCapability,TCapability,TCapability,TCapability,TCapability)

IMPORT_C TSecurityPolicy(TCapability aCap1, TCapability aCap2, TCapability aCap3, TCapability aCap4, TCapability aCap5=ECapability_None, TCapability aCap6=ECapability_None, TCapability aCap7=ECapability_None);

Description

Construct a TSecurityPolicy object to check up to 7 capabilties.

Parameters

TCapability aCap1

The first capability to add to this policy

TCapability aCap2

The second capability to add to this policy

TCapability aCap3

The third capability to add to this policy

TCapability aCap4

The fourth capability to add to this policy

TCapability aCap5

An optional fifth capability to add to this policy

TCapability aCap6

An optional sixth capability to add to this policy

TCapability aCap7

An optional seventh capability to add to this policy

Panic codes

USER

189 If any of the supplied capabilities are not valid.


TSecurityPolicy(TSecureId,TCapability,TCapability,TCapability)

IMPORT_C TSecurityPolicy(TSecureId aSecureId, TCapability aCap1=ECapability_None, TCapability aCap2=ECapability_None, TCapability aCap3=ECapability_None);

Description

Construct a TSecurityPolicy object to check a secure id and up to 3 capabilties.

Parameters

TSecureId aSecureId

The secure id to add to this policy

TCapability aCap1

The first capability to add to this policy

TCapability aCap2

The second capability to add to this policy

TCapability aCap3

The third capability to add to this policy

Panic codes

USER

189 If any of the supplied capabilities are not valid.


TSecurityPolicy(TVendorId,TCapability,TCapability,TCapability)

IMPORT_C TSecurityPolicy(TVendorId aVendorId, TCapability aCap1=ECapability_None, TCapability aCap2=ECapability_None, TCapability aCap3=ECapability_None);

Description

Construct a TSecurityPolicy object to check a vendor id and up to 3 capabilties.

Parameters

TVendorId aVendorId

The vendor id to add to this policy

TCapability aCap1

The first capability to add to this policy

TCapability aCap2

The second capability to add to this policy

TCapability aCap3

The third capability to add to this policy

Panic codes

USER

189 If any of the supplied capabilities are not valid.

[Top]


Member functions


Set(const TDesC8 &)

IMPORT_C TInt Set(const TDesC8 &aDes);

Description

Sets this TSecurityPolicy to a copy of the policy described by the supplied descriptor. Such a descriptor can be obtained from TSecurityPolicy::Package()const.

Parameters

const TDesC8 &aDes

A descriptor representing the state of another TSecurityPolicy.

Return value

TInt

KErrNone, if successful, otherwise one of the other system-wide error codes.

See also:


Package()const

IMPORT_C TPtrC8 Package() const;

Description

Constructs a TPtrC8 wrapping the platform security attributes of this TSecurityPolicy. Such a descriptor is suitable for passing across the client server boundary.

The format of the descriptor is determined by the first byte which specifies the type of this TSecurityPolicy. The first byte is one of the constants specified in the enum TSecurityPolicy::TType.

For TSecurityPolicy objects of types ETypeC3, ETypeS3, ETypePass or ETypeFail the descriptor will contain the following data in the order listed:

    TUint8 iType;         // set to ETypeC3, ETypeS3, ETypePass or ETypeFail
    TUint8 iCaps[3];
    TUint32 iSecureId;

ETypeC3 descriptors will contain capabilities in iCaps but have iSecureId set to ECapability_None. ETypeS3 are similar to ETypeC3 descriptors but will have iSecureId set to the secure ID value of the TSecurityPolicy object. ETypePass and ETypeFail objects will have values of all of the elements of iCaps and iSecureId set to ECapability_None.

For TSecurityPolicy objects of type ETypeV3 the descriptor will contain the following data in the order listed:

    TUint8 iType;      // set to ETypeV3
    TUint8 iCaps[3];   // set to the values of 3 capabilities
    TUint32 iVendorId; // set to the value of the vendor ID of the TSecurityPolicy

For TSecurityPolicy objects of type ETypeC7 the descriptor will contain the following data in the order listed:

    TUint8 iType;          // set to ETypeC7
    TUint8 iCaps[3];       // set to the values of 3 of the objects capabilities
    TUint8 iExtraCaps[4];  // set to the values of 4 of the objects capabilities

Return value

TPtrC8

A TPtrC8 wrapping the platform security attributes of this TSecurityPolicy.

See also:


CheckPolicy(RProcess,const char *)const

inline TBool CheckPolicy(RProcess aProcess, const char *aDiagnostic=0) const;

Description

Checks this policy against the platform security attributes of aProcess.

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

RProcess aProcess

The RProcess object to check against this TSecurityPolicy.

const char *aDiagnostic

A string that will be emitted along with any diagnostic message that may be issued if the policy check fails. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

Return value

TBool

ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of aProcess, EFalse otherwise.

Panic codes

USER

190 if 'this' is an invalid SSecurityInfo object


CheckPolicy(RThread,const char *)const

inline TBool CheckPolicy(RThread aThread, const char *aDiagnostic=0) const;

Description

Checks this policy against the platform security attributes of the process owning aThread.

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

RThread aThread

The thread whose owning process' platform security attributes are to be checked against this TSecurityPolicy.

const char *aDiagnostic

A string that will be emitted along with any diagnostic message that may be issued if the policy check fails. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

Return value

TBool

ETrue if all the requirements of this TSecurityPolicy are met by the platform security parameters of the owning process of aThread, EFalse otherwise.

Panic codes

USER

190 if 'this' is an invalid SSecurityInfo object


CheckPolicy(RMessagePtr2,const char *)const

inline TBool CheckPolicy(RMessagePtr2 aMsgPtr, const char *aDiagnostic=0) const;

Description

Checks this policy against the platform security attributes of the process which sent the given message.

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

RMessagePtr2 aMsgPtr

The RMessagePtr2 object to check against this TSecurityPolicy.

const char *aDiagnostic

A string that will be emitted along with any diagnostic message that may be issued if the policy check fails. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

Return value

TBool

ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of aMsg, EFalse otherwise.

Panic codes

USER

190 if 'this' is an invalid SSecurityInfo object


CheckPolicyCreator(const char *)const

inline TBool CheckPolicyCreator(const char *aDiagnostic=0) const;

Description

Checks this policy against the platform security attributes of this process' creator.

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

const char *aDiagnostic

A string that will be emitted along with any diagnostic message that may be issued if the policy check fails. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

Return value

TBool

ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of this process' creator, EFalse otherwise.

Panic codes

USER

190 if 'this' is an invalid SSecurityInfo object

[Top]


Member enumerations


Enum TSecPolicyType

TSecPolicyType

Description

EAlwaysFail

EAlwaysPass


Enum TType

TType

Description

Constants to specify the type of TSecurityPolicy objects.

ETypeFail

Always fail

ETypePass

Always pass

ETypeC3

Up to 3 capabilities

ETypeC7

Up to 7 capabilities

ETypeS3

Secure ID and up to 3 capabilities

ETypeV3

Vendor ID and up to 3 capabilities