TBTServiceSecurity Class Reference

#include <btsecurity.h>

Link against: bluetooth.lib

class TBTServiceSecurity

Detailed Description

The security settings of a bluetooth service.

Contains information regarding the service UID and the access requirements.

Constructor & Destructor Documentation

TBTServiceSecurity ( const TBTServiceSecurity & )

IMPORT_CTBTServiceSecurity(const TBTServiceSecurity &aService)

Copy constructor

TBTServiceSecurity ( )

IMPORT_CTBTServiceSecurity()

Default constructor. Sets all member data to 0.

Member Function Documentation

AuthenticationRequired ( )

IMPORT_C TBoolAuthenticationRequired()const

Getter - return whether authentication is required for this service. DeprecatedThe TBTServiceSecurity::MitmProtection function should be used instead.

Returns: EAuthenticate if authentication is required, zero otherwise

AuthorisationRequired ( )

IMPORT_C TBoolAuthorisationRequired()const

Getter - return whether authorisation is required for this service

This function is only appropriate for when the Bluetooth v2.0 and earlier authentication specification function is used. Once migrated to the new MITM level setting this function will not return a useful result, the MitmProtection function should be used instead.

See also: TBTServiceSecurity::MitmProtection

Returns: EAuthorise if authorisation is required, zero otherwise

Denied ( )

IMPORT_C TBoolDenied()const

Getter - return whether denied for this service.

Returns: EDenied if denied, zero otherwise

EncryptionRequired ( )

IMPORT_C TBoolEncryptionRequired()const

Getter - return whether encryption is required for this service.

Returns: EEncrypt if encryption is required, zero otherwise

MitmProtection ( )

IMPORT_C TBluetoothMitmProtectionMitmProtection()const

Getter - return the level of Man-in-the-middle protection required this service.

Returns: The level of Man-in-the-Middle protection required for authentication.

PasskeyMinLength ( )

IMPORT_C TUintPasskeyMinLength()const

Getter - return minimal passkey length requirement

Returns: 0 - no passkey length requirement. 1..16

SetAuthentication ( TBool )

IMPORT_C voidSetAuthentication(TBoolaPreference)

Sets whether or not any connections to this service need to 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 (a process known as pairing). If authentication fails, the connection will not be permitted.

For Bluetooth v2.1 and onward this has slightly changed in that pin code entry is not neccessary to generate a link key. Because of this, this API has been deprecated, users of this API are encouraged to migrate to the alterative SetAuthentication method which specifies the level of Man-in-the-Middle protection required for the service.

See also: TBTServiceSecurity::SetAuthentication(TBluetoothMitmProtection aPreference)

Deprecated

The TBTServiceSecurity::SetAuthentication(TBluetoothMitmProtection) function should be used instead.

ParameterDescription
aPreferenceif aPreference = EFalse then the Bluetooth stack will not perform pairing on Bluetooth v2.0 and earlier connections.

SetAuthentication ( TBluetoothMitmProtection )

IMPORT_C voidSetAuthentication(TBluetoothMitmProtectionaPreference)

Sets the level of authentication needed for any connections to this service.

Authentication involves the comparison of a stored link key. If no link key has been generated and stored or one has been stored but is of an insufficient level of authentication then pairing will be performed.

For Bluetooth v2.0 and earlier pairing involves the user entering the same pin code for both devices involved in the connection to this service.

For Bluetooth v2.1 and onward pairing can be performed in one of four ways. Some of which involve the user of the Symbian OS device, some of which do not. The pairing performed is dependant on a number of factors including the input and output capabilities of the devices and the level of authentication (Man-in-the-Middle protection) required.

If authentication fails, or succeeds but with an insufficient level of Man-in-the-Middle protection, the connection will not be permitted.

ParameterDescription
aPreferenceThe level of Man-in-the-Middle protection required for authentication.

SetAuthorisation ( TBool )

IMPORT_C voidSetAuthorisation(TBoolaPreference)

Sets whether or not any connections to this service need to be authorised.

A dialog will be presented to the user alerting them of 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. Note: it should not be assumed that the UI will support the setting up of trust for remote devices.

SetDenied ( TBool )

IMPORT_C voidSetDenied(TBoolaPreference)

Sets whether or not connections to this service are being denied to all but specified devices.

See also: per device overrides - service can be reached by only selected devices using this method

SetEncryption ( TBool )

IMPORT_C voidSetEncryption(TBoolaPreference)

Sets whether or not any connections to this service need to be encrypted.

Authentication must precede encryption, therefore it is recommended that SetAuthentication(ETrue) is also called. If encryption fails, the connection will not be permitted.

SetPasskeyMinLength ( TUint )

IMPORT_C TIntSetPasskeyMinLength(TUintaPasskeyMinLength)

Sets the minimum of passkey length for connection.

SetUid ( TUid )

IMPORT_C voidSetUid(TUidaUid)

Set Uid of the service - used opaquely by Bluetooth system.

When a security procedure is initiated the Uid may be given to the notifier framework. The notifier can then use the Uid to produce a displayable string detailing the service to which the security procudure pertains.

ParameterDescription
aUidThe uid of the service. This is not the Bluetooth UUID, but is a Symbian-allocated Uid.

Uid ( )

IMPORT_C TUidUid()const

Getter - return Uid for this service.

Returns: Uid