Class TBTServiceSecurity

TBTServiceSecurity

Support

Supported from 6.1

Description

Security settings of a Bluetooth service.

Contains information regarding the:

• Service UID: a unique identifier allowing the security manager to identify the service

• Protocol ID: the ID of the protocol layer below the service. For most Bluetooth services, this is RFCOMM. The ID is specified as a Bluetooth socket level option constant, e.g. KSolBtRFCOMM.

• Channel ID: the channel (or port) on which the service is running. For most Bluetooth services, this is the RFCOMM DLCI.

• Access requirements: whether an incoming service is required to meet authentication, authorisation, or encryption requirements.

Defined in TBTServiceSecurity:
AuthenticationRequired(), AuthorisationRequired(), ChannelID(), Denied(), EncryptionRequired(), ProtocolID(), SetAuthentication(), SetAuthorisation(), SetChannelID(), SetDenied(), SetEncryption(), SetProtocolID(), SetUid(), TBTServiceSecurity(), Uid()

See also:

• Bluetooth socket level options

TBTServiceSecurity();

Description

Default constructor.

TBTServiceSecurity(TUid aUid, TInt aProtocolID, TInt aChannelID);

Description

Constructor with service UID, and protocol and channel IDs.

Parameters

TUid aUid Service UID TInt aProtocolID Protocol ID TInt aChannelID Channel ID

TBTServiceSecurity(const TBTServiceSecurity& aService);

Description

Copy constructor.

Parameters

const TBTServiceSecurity& aService Object to be copied

TBool AuthenticationRequired() const;

Description

Gets whether an incoming service must perform authentication.

Return value

TBool True if authentication required

TBool AuthorisationRequired() const;

Description

Gets whether an incoming service must be authorised.

Return value

TBool True if authorisation required

TInt ChannelID() const;

Description

Gets the channel ID set.

Return value

TInt The channel ID

TBool Denied() const;

Description

Gets whether all access requests to this service will be denied by the Security Manager.

Return value

TBool True if denial set

TBool EncryptionRequired() const;

Description

Gets whether any incoming connections must be encrypted.

Return value

TBool True if encryption required

TInt ProtocolID() const;

Description

Gets the protocol ID set.

Return value

TInt The protocol ID

TUid Uid() const;

Description

Gets the service UID.

Return value

TUid The service UID

void SetAuthentication(TBool aPreference);

Description

Sets that any connections to this service must be authenticated.

Authentication involves the comparison of a stored link key. If no link key has been generated and stored (e.g. the remote device has never been authenticated before), then the user will be asked to enter a pin code.

If authentication fails, the connection will not be permitted.

Parameters

TBool aPreference Set to true if authentication is required

void SetAuthorisation(TBool aPreference);

Description

Sets that any connections to this service must be authorised by the user.

After this setting is made, when a remote device attempts to connect to this service, a dialog will appear on the local machine alerting the user to the connection.

This will occur for every connection to this service, unless the user has explicitly expressed their trust for the remote device during a previous connection. It should not be assumed that the UI will support the setting up of trust for remote devices.

Parameters

TBool aPreference Set to true if authorisation is required

void SetEncryption(TBool aPreference);

Description

Sets that any connections to this service must be encrypted.

Authentication must precede encryption, therefore it is recommended that authentication is also set.

If encryption fails, the connection will not be permitted.

Parameters

TBool aPreference Set to true if encryption is required

void SetChannelID(TInt aChannelID);

Description

Sets the channel ID.

Parameters

TInt aChannelID The channel ID to use

void SetDenied(TBool aPreference);

Description

Sets whether any access to this service is allowed.

Parameters

TBool aPreference Set to true to deny any access to this service

void SetProtocolID(TInt aProtocolID);

Description

Sets the protocol ID.

Parameters

TInt aProtocolID The protocol ID to use

void SetUid(TUid aUid);

Description

Sets the service UID.

Parameters

TUid aUid UID to use