PlatSec Class Reference

class PlatSec

Class containing Platform Security related methods

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 &)
Private Member Functions
UIMPORT_C TIntEmitDiagnostic(TPlatSecDiagnostic &, const char *)
Public Member Enumerations
enumTConfigSetting { EPlatSecEnforcement, EPlatSecDiagnotics, EPlatSecProcessIsolation, EPlatSecEnforceSysBin, EPlatSecLocked }

Member Functions Documentation

CapabilityCheckFail(TInt, TCapability, const char *)

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

Parameters

TInt aHandle
TCapability aCapability
const char * aContextText

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

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

Parameters

TInt aHandle
const TCapabilitySet & aMissingCaps
const char * aContextText

CapabilityCheckFail(RMessagePtr2, TCapability, const char *)

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

Parameters

RMessagePtr2 aMessage
TCapability aCapability
const char * aContextText

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

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

Parameters

RMessagePtr2 aMessage
const TCapabilitySet & aMissingCaps
const char * aContextText

CapabilityCheckFail(TInt, TCapability)

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

Parameters

TInt aHandle
TCapability aCapability

CapabilityCheckFail(TInt, const TCapabilitySet &)

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

Parameters

TInt aHandle
const TCapabilitySet & aMissingCaps

CapabilityCheckFail(RMessagePtr2, TCapability)

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

Parameters

RMessagePtr2 aMessage
TCapability aCapability

CapabilityCheckFail(RMessagePtr2, const TCapabilitySet &)

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

Parameters

RMessagePtr2 aMessage
const TCapabilitySet & aMissingCaps

ConfigSetting(TConfigSetting)

IMPORT_C TIntConfigSetting(TConfigSettingaSetting)[static]

A test function to return the state of a given Platform Security configuration setting. 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.

TConfigSetting

Test

Parameters

TConfigSetting aSettingAn enumerated value representing the required setting

CreatorCapabilityCheckFail(TCapability, const char *)

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

Parameters

TCapability aCapability
const char * aContextText

CreatorCapabilityCheckFail(const TCapabilitySet &, const char *)

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

Parameters

const TCapabilitySet & aMissingCaps
const char * aContextText

CreatorCapabilityCheckFail(TCapability)

TInt CreatorCapabilityCheckFail(TCapabilityaCapability)[static, inline]

Parameters

TCapability aCapability

CreatorCapabilityCheckFail(const TCapabilitySet &)

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

Parameters

const TCapabilitySet & aMissingCaps

CreatorPolicyCheckFail(const SSecurityInfo &, const char *)

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

Parameters

const SSecurityInfo & aMissingCaps
const char * aContextText

CreatorPolicyCheckFail(const SSecurityInfo &)

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

Parameters

const SSecurityInfo & aMissingCaps

EmitDiagnostic(TPlatSecDiagnostic &, const char *)

UIMPORT_C TIntEmitDiagnostic(TPlatSecDiagnostic &aDiagnostic,
const char *aContextText
)[private, static]

Parameters

TPlatSecDiagnostic & aDiagnostic
const char * aContextText

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().

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

Parameters

TCapability aCapabilityThe capability to test

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

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

Parameters

const TDesC8 & aImporterName
const TDesC8 & aFileName
const SCapabilitySet & aMissingCaps

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

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

Parameters

RProcess aLoadingProcess
const TDesC8 & aFileName
const SCapabilitySet & aMissingCaps

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

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

Parameters

TInt aHandle
const SSecurityInfo & aMissing
const char * aContextText

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

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

Parameters

RMessagePtr2 aMessage
const SSecurityInfo & aMissingCaps
const char * aContextText

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

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

Parameters

RSessionBase aSession
const SSecurityInfo & aMissingCaps
const char * aContextText

PolicyCheckFail(TInt, const SSecurityInfo &)

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

Parameters

TInt aHandle
const SSecurityInfo & aMissing

PolicyCheckFail(RMessagePtr2, const SSecurityInfo &)

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

Parameters

RMessagePtr2 aMessage
const SSecurityInfo & aMissingCaps

Member Enumerations Documentation

Enum TConfigSetting

An enumeration used with PlatSecSetting() PlatSecSetting()

Test

Enumerators

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