Class TBTServiceSecurity

class TBTServiceSecurity;

Description

The security settings of a bluetooth service.

Contains information regarding the service UID and the access requirements.

Members

Defined in TBTServiceSecurity:

• AuthenticationRequired()constGetter - return whether authentication is required for this service.
• AuthorisationRequired()constGetter - return whether authorisation is required for this service
• Denied()constGetter - return whether denied for this service.
• EncryptionRequired()constGetter - return whether encryption is required for this service.
• MitmProtection()constGetter - return the level of Man-in-the-middle protection required this service.
• PasskeyMinLength()constGetter - return minimal passkey length requirement
• SetAuthentication(TBluetoothMitmProtection)Sets the level of authentication needed for any connections to this service.
• SetAuthentication(TBool)Sets whether or not any connections to this service need to be authenticated.
• SetAuthorisation(TBool)Sets whether or not any connections to this service need to be authorised.
• SetDenied(TBool)Sets whether or not connections to this service are being denied to all but spec...
• SetEncryption(TBool)Sets whether or not any connections to this service need to be encrypted.
• SetPasskeyMinLength(TUint)Sets the minimum of passkey length for connection.
• SetUid(TUid)Set Uid of the service - used opaquely by Bluetooth system.
• TBTServiceSecurity()Default constructor. Sets all member data to 0.
• TBTServiceSecurity(const TBTServiceSecurity &)Copy constructor
• Uid()constGetter - return Uid for this service.

IMPORT_C TBTServiceSecurity(const TBTServiceSecurity &aService);

Description

Copy constructor

Parameters

IMPORT_C TBTServiceSecurity();

Description

Default constructor. Sets all member data to 0.

IMPORT_C void SetUid(TUid aUid);

Description

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.

Parameters

IMPORT_C void SetAuthentication(TBool aPreference);

Description

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.

Parameters

See also:

• TBTServiceSecurity::SetAuthentication(TBluetoothMitmProtection)Sets the level of authentication needed for any connections to this service.

IMPORT_C void SetAuthorisation(TBool aPreference);

Description

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.

Parameters

IMPORT_C void SetEncryption(TBool aPreference);

Description

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.

Parameters

IMPORT_C void SetDenied(TBool aPreference);

Description

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

Parameters

IMPORT_C void SetAuthentication(TBluetoothMitmProtection aPreference);

Description

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.

Parameters

IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);

Description

Sets the minimum of passkey length for connection.

Parameters

Return value

IMPORT_C TBool AuthorisationRequired() const;

Description

Getter - return whether authorisation is required for this service

Return value

IMPORT_C TBool EncryptionRequired() const;

Description

Getter - return whether encryption is required for this service.

Return value

IMPORT_C TBool AuthenticationRequired() const;

Description

Getter - return whether authentication is required for this service.

Return value

IMPORT_C TBool Denied() const;

Description

Getter - return whether denied for this service.

Return value

IMPORT_C TUint PasskeyMinLength() const;

Description

Getter - return minimal passkey length requirement

Return value

IMPORT_C TUid Uid() const;

Description

Getter - return Uid for this service.

Return value

IMPORT_C TBluetoothMitmProtection MitmProtection() const;

Description

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

Return value