TSecurityPolicy Class Reference

#include <e32cmn.h>

class TSecurityPolicy

Detailed 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
  • Publish and Subscribe properties

  • DBMS databases

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 Package() and send this. When a server receives this descriptor it should read the descriptor contents into a TSecurityPolicyBuf and then Set() 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.

See also: TStaticSecurityPolicy TSecurityPolicyBuf _LIT_SECURITY_POLICY_PASS _LIT_SECURITY_POLICY_FAIL _LIT_SECURITY_POLICY_C1 _LIT_SECURITY_POLICY_C2 _LIT_SECURITY_POLICY_C3 _LIT_SECURITY_POLICY_C4 _LIT_SECURITY_POLICY_C5 _LIT_SECURITY_POLICY_C6 _LIT_SECURITY_POLICY_C7 _LIT_SECURITY_POLICY_S0 _LIT_SECURITY_POLICY_S1 _LIT_SECURITY_POLICY_S2 _LIT_SECURITY_POLICY_S3 _LIT_SECURITY_POLICY_V0 _LIT_SECURITY_POLICY_V1 _LIT_SECURITY_POLICY_V2 _LIT_SECURITY_POLICY_V3

Member Attribute Documentation

iExtraCaps

TUint8 iExtraCaps

iSecureId

TUint32 iSecureId

iVendorId

TUint32 iVendorId

Member Enumeration Documentation

Enum TSecPolicyType

EnumeratorValueDescription
EAlwaysFail0
EAlwaysPass1

Enum TType

Constants to specify the type of TSecurityPolicy objects.

EnumeratorValueDescription
ETypeFail0

Always fail

ETypePass1

Always pass

ETypeC32

Up to 3 capabilities

ETypeC73

Up to 7 capabilities

ETypeS34

Secure ID and up to 3 capabilities

ETypeV35

Vendor ID and up to 3 capabilities

ETypeLimit

The number of possible TSecurityPolicy types This is intended for internal Symbian use only.

Constructor & Destructor Documentation

TSecurityPolicy ( )

TSecurityPolicy()[inline]

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

TSecurityPolicy ( TSecPolicyType )

IMPORT_CTSecurityPolicy(TSecPolicyTypeaType)
Constructs a TSecurityPolicy to either always pass or always fail checks made against it, depending on the value of aType.
Parameters
aTypeMust be one of EAlwaysPass or EAlwaysFail
Panic Codes
USER191 if aType is not a valid value

TSecurityPolicy ( TCapability, TCapability, TCapability )

IMPORT_CTSecurityPolicy(TCapabilityaCap1,
TCapabilityaCap2 = ECapability_None,
TCapabilityaCap3 = ECapability_None
)
Construct a TSecurityPolicy object to check up to 3 capabilties.
Parameters
aCap1The first capability to add to this policy
aCap2An optional second capability to add to this policy
aCap3An optional third capability to add to this policy
Panic Codes
USER189 If any of the supplied capabilities are not valid.

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

IMPORT_CTSecurityPolicy(TCapabilityaCap1,
TCapabilityaCap2,
TCapabilityaCap3,
TCapabilityaCap4,
TCapabilityaCap5 = ECapability_None,
TCapabilityaCap6 = ECapability_None,
TCapabilityaCap7 = ECapability_None
)
Construct a TSecurityPolicy object to check up to 7 capabilties.
Parameters
aCap1The first capability to add to this policy
aCap2The second capability to add to this policy
aCap3The third capability to add to this policy
aCap4The fourth capability to add to this policy
aCap5An optional fifth capability to add to this policy
aCap6An optional sixth capability to add to this policy
aCap7An optional seventh capability to add to this policy
Panic Codes
USER189 If any of the supplied capabilities are not valid.

TSecurityPolicy ( TSecureId, TCapability, TCapability, TCapability )

IMPORT_CTSecurityPolicy(TSecureIdaSecureId,
TCapabilityaCap1 = ECapability_None,
TCapabilityaCap2 = ECapability_None,
TCapabilityaCap3 = ECapability_None
)
Construct a TSecurityPolicy object to check a secure id and up to 3 capabilties.
Parameters
aSecureIdThe secure id to add to this policy
aCap1The first capability to add to this policy
aCap2The second capability to add to this policy
aCap3The third capability to add to this policy
Panic Codes
USER189 If any of the supplied capabilities are not valid.

TSecurityPolicy ( TVendorId, TCapability, TCapability, TCapability )

IMPORT_CTSecurityPolicy(TVendorIdaVendorId,
TCapabilityaCap1 = ECapability_None,
TCapabilityaCap2 = ECapability_None,
TCapabilityaCap3 = ECapability_None
)
Construct a TSecurityPolicy object to check a vendor id and up to 3 capabilties.
Parameters
aVendorIdThe vendor id to add to this policy
aCap1The first capability to add to this policy
aCap2The second capability to add to this policy
aCap3The third capability to add to this policy
Panic Codes
USER189 If any of the supplied capabilities are not valid.

Member Function Documentation

CheckPolicy ( RProcess, const char * )

TBool CheckPolicy(RProcessaProcess,
const char *aDiagnostic = 0
)const [inline]

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
aProcessThe RProcess object to check against this TSecurityPolicy.
aDiagnosticA 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
ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of aProcess, EFalse otherwise.
Panic Codes
USER190 if 'this' is an invalid

CheckPolicy ( RThread, const char * )

TBool CheckPolicy(RThreadaThread,
const char *aDiagnostic = 0
)const [inline]

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
aThreadThe thread whose owning process' platform security attributes are to be checked against this TSecurityPolicy.
aDiagnosticA 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
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
USER190 if 'this' is an invalid

CheckPolicy ( RMessagePtr2, const char * )

TBool CheckPolicy(RMessagePtr2aMsgPtr,
const char *aDiagnostic = 0
)const [inline]

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
aMsgPtrThe RMessagePtr2 object to check against this TSecurityPolicy.
aDiagnosticA 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
ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of aMsg, EFalse otherwise.
Panic Codes
USER190 if 'this' is an invalid

CheckPolicy ( RMessagePtr2, TSecurityInfo &, const char * )

TBool CheckPolicy(RMessagePtr2aMsgPtr,
TSecurityInfo &aMissing,
const char *aDiagnostic = 0
)const [inline]

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
aMsgPtrThe RMessagePtr2 object to check against this TSecurityPolicy.
aMissingA TSecurityInfo object which this method fills with any capabilities or IDs it finds to be missing.
aDiagnosticA 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
ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of aMsg, EFalse otherwise.
Panic Codes
USER190 if 'this' is an invalid

CheckPolicy ( RSessionBase )

TInt CheckPolicy(RSessionBaseaSession)const

CheckPolicy ( const SSecurityInfo &, SSecurityInfo & )

TBool CheckPolicy(const SSecurityInfo &aSecInfo,
SSecurityInfo &aMissing
)const [protected]
Checks this policy against the supplied SSecurityInfo.
Parameters
aSecInfoThe SSecurityInfo object to check against this TSecurityPolicy.
aMissingA SSecurityInfo object which this method fills with any capabilities or IDs it finds to be missing. This is designed to help generating diagnostic messages.
Return Value
ETrue if all the requirements of this TSecurityPolicy are met, EFalse
Panic Codes
USER190 if aSecInfo is an invalid

CheckPolicyCreator ( const char * )

TBool CheckPolicyCreator(const char *aDiagnostic = 0)const [inline]

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
aDiagnosticA 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
ETrue if all the requirements of this TSecurityPolicy are met by the platform security attributes of this process' creator, EFalse otherwise.
Panic Codes
USER190 if 'this' is an invalid

Package ( )

IMPORT_C TPtrC8Package()const

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

See also: TSecurityPolicy::TType TSecurityPolicy::Set()

Return Value
A TPtrC8 wrapping the platform security attributes of this TSecurityPolicy.

Set ( const TDesC8 & )

IMPORT_C TIntSet(const TDesC8 &aDes)

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

See also: TSecurityPolicy::Package()

Parameters
aDesA descriptor representing the state of another TSecurityPolicy.
Return Value
KErrNone, if successful, otherwise one of the other system-wide error codes.

Validate ( )

TBool Validate()const

Checks that this object is in a valid state

Return Value
A non-zero value if this object is valid, zero otherwise.