PlatSec Class Reference

#include <e32cmn.h>

Link against: elocl.lib

class PlatSec
Public Member Enumerations
enumTConfigSetting { EPlatSecEnforcement, EPlatSecDiagnotics, EPlatSecProcessIsolation, EPlatSecEnforceSysBin, EPlatSecLocked }
Public Member Functions
TInt CapabilityCheckFail(TInt, TCapability, const char *)
TInt CapabilityCheckFail(TInt, const TCapabilitySet &, const char *)
TInt CapabilityCheckFail(RMessagePtr2, TCapability, const char *)
TInt CapabilityCheckFail(RMessagePtr2, const TCapabilitySet &, const char *)
TInt CapabilityCheckFail(TInt, TCapability)
TInt CapabilityCheckFail(TInt, const TCapabilitySet &)
TInt CapabilityCheckFail(RMessagePtr2, TCapability)
TInt CapabilityCheckFail(RMessagePtr2, const TCapabilitySet &)
IMPORT_C TIntConfigSetting(TConfigSetting)
TInt CreatorCapabilityCheckFail(TCapability, const char *)
TInt CreatorCapabilityCheckFail(const TCapabilitySet &, const char *)
TInt CreatorCapabilityCheckFail(TCapability)
TInt CreatorCapabilityCheckFail(const TCapabilitySet &)
TInt CreatorPolicyCheckFail(const SSecurityInfo &, const char *)
TInt CreatorPolicyCheckFail(const SSecurityInfo &)
UIMPORT_C TIntEmitDiagnostic()
IMPORT_C TBoolIsCapabilityEnforced(TCapability)
TInt LoaderCapabilityViolation(const TDesC8 &, const TDesC8 &, const SCapabilitySet &)
TInt LoaderCapabilityViolation(RProcess, const TDesC8 &, const SCapabilitySet &)
TInt PolicyCheckFail(TInt, const SSecurityInfo &, const char *)
TInt PolicyCheckFail(RMessagePtr2, const SSecurityInfo &, const char *)
TInt PolicyCheckFail(RSessionBase, const SSecurityInfo &, const char *)
TInt PolicyCheckFail(TInt, const SSecurityInfo &)
TInt PolicyCheckFail(RMessagePtr2, const SSecurityInfo &)

Detailed Description

Class containing Platform Security related methods

Member Enumeration Documentation

Enum TConfigSetting

An enumeration used with PlatSecSetting()

See also: PlatSecSetting()

Test
EnumeratorValueDescription
EPlatSecEnforcement

Used to request the value of the PlatSecEnforcement setting

EPlatSecDiagnotics

Used to request the value of the PlatSecDiagnotics setting

EPlatSecProcessIsolation

Used to request the value of the PlatSecProcessIsolation setting

EPlatSecEnforceSysBin

Used to request the value of the PlatSecEnforceSysBin setting

EPlatSecLocked

Used to request the value of the PlatSecLocked setting

Member Function Documentation

CapabilityCheckFail ( TInt, TCapability, const char * )

TInt CapabilityCheckFail(TIntaHandle,
TCapabilityaCapability,
const char *aContextText
)[static, inline]

CapabilityCheckFail ( TInt, const TCapabilitySet &, const char * )

TInt CapabilityCheckFail(TIntaHandle,
const TCapabilitySet &aMissingCaps,
const char *aContextText
)[static, inline]

CapabilityCheckFail ( RMessagePtr2, TCapability, const char * )

TInt CapabilityCheckFail(RMessagePtr2aMessage,
TCapabilityaCapability,
const char *aContextText
)[static, inline]

CapabilityCheckFail ( RMessagePtr2, const TCapabilitySet &, const char * )

TInt CapabilityCheckFail(RMessagePtr2aMessage,
const TCapabilitySet &aMissingCaps,
const char *aContextText
)[static, inline]

CapabilityCheckFail ( TInt, TCapability )

TInt CapabilityCheckFail(TIntaHandle,
TCapabilityaCapability
)[static, inline]

CapabilityCheckFail ( TInt, const TCapabilitySet & )

TInt CapabilityCheckFail(TIntaHandle,
const TCapabilitySet &aMissingCaps
)[static, inline]

CapabilityCheckFail ( RMessagePtr2, TCapability )

TInt CapabilityCheckFail(RMessagePtr2aMessage,
TCapabilityaCapability
)[static, inline]

CapabilityCheckFail ( RMessagePtr2, const TCapabilitySet & )

TInt CapabilityCheckFail(RMessagePtr2aMessage,
const TCapabilitySet &aMissingCaps
)[static, inline]

ConfigSetting ( TConfigSetting )

IMPORT_C TIntConfigSetting(TConfigSettingaSetting)[static]

A test function to return the state of a given Platform Security configuration setting.

See also: TConfigSetting

Test
ParameterDescription
aSettingAn enumerated value representing the required setting

Returns: A value representing the setting. 0 represents 'OFF', 1 represents 'ON' Other values may be returned for some settings, these exceptions are documented in the description for individual enumerations of TConfigSetting.

CreatorCapabilityCheckFail ( TCapability, const char * )

TInt CreatorCapabilityCheckFail(TCapabilityaCapability,
const char *aContextText
)[static, inline]

CreatorCapabilityCheckFail ( const TCapabilitySet &, const char * )

TInt CreatorCapabilityCheckFail(const TCapabilitySet &aMissingCaps,
const char *aContextText
)[static, inline]

CreatorCapabilityCheckFail ( TCapability )

TInt CreatorCapabilityCheckFail(TCapabilityaCapability)[static, inline]

CreatorCapabilityCheckFail ( const TCapabilitySet & )

TInt CreatorCapabilityCheckFail(const TCapabilitySet &aMissingCaps)[static, inline]

CreatorPolicyCheckFail ( const SSecurityInfo &, const char * )

TInt CreatorPolicyCheckFail(const SSecurityInfo &aMissingCaps,
const char *aContextText
)[static, inline]

CreatorPolicyCheckFail ( const SSecurityInfo & )

TInt CreatorPolicyCheckFail(const SSecurityInfo &aMissingCaps)[static, inline]

EmitDiagnostic ( )

UIMPORT_C TIntEmitDiagnostic()[static]

IsCapabilityEnforced ( TCapability )

IMPORT_C TBoolIsCapabilityEnforced(TCapabilityaCapability)[static]

Tests whether a given Platform Security capability is enforced by the system.

Capabilities may not be enforced for several reasons:
  1. The capability has been explicitly disabled on this system by use of the PlatSecDisabledCaps configuration parameter

  2. Platform Security checks have been globally disabled by use of the EPlatSecEnforcement configuration parameter

  3. The capability value is unknown. I.e. Is not part of the set of supported capabilities. See TCapabilitySet::SetAllSupported().

ParameterDescription
aCapabilityThe capability to test

Returns: A non-zero value if the capability is enforced, zero if it is not.

LoaderCapabilityViolation ( const TDesC8 &, const TDesC8 &, const SCapabilitySet & )

TInt LoaderCapabilityViolation(const TDesC8 &aImporterName,
const TDesC8 &aFileName,
const SCapabilitySet &aMissingCaps
)[static, inline]

LoaderCapabilityViolation ( RProcess, const TDesC8 &, const SCapabilitySet & )

TInt LoaderCapabilityViolation(RProcessaLoadingProcess,
const TDesC8 &aFileName,
const SCapabilitySet &aMissingCaps
)[static, inline]

PolicyCheckFail ( TInt, const SSecurityInfo &, const char * )

TInt PolicyCheckFail(TIntaHandle,
const SSecurityInfo &aMissing,
const char *aContextText
)[static, inline]

PolicyCheckFail ( RMessagePtr2, const SSecurityInfo &, const char * )

TInt PolicyCheckFail(RMessagePtr2aMessage,
const SSecurityInfo &aMissingCaps,
const char *aContextText
)[static, inline]

PolicyCheckFail ( RSessionBase, const SSecurityInfo &, const char * )

TInt PolicyCheckFail(RSessionBaseaSession,
const SSecurityInfo &aMissingCaps,
const char *aContextText
)[static, inline]

PolicyCheckFail ( TInt, const SSecurityInfo & )

TInt PolicyCheckFail(TIntaHandle,
const SSecurityInfo &aMissing
)[static, inline]

PolicyCheckFail ( RMessagePtr2, const SSecurityInfo & )

TInt PolicyCheckFail(RMessagePtr2aMessage,
const SSecurityInfo &aMissingCaps
)[static, inline]