OcaSecurityManager

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaManager().

This class defines the properties

Name

JavaScript Type

AES70 Type

secureControlData

boolean

OcaBoolean

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role and secureControlData.

class OcaSecurityManager(objectNumber, device)

Manager that collects and controls security settings (including security keys).

  • Must be instantiated in every device that supports secure control and monitoring; otherwise, is optional.

  • May be instantiated at most once in any device.

  • If instantiated, object number must be 2.

OcaSecurityManager.OnsecureControlDataChanged

type: PropertyEvent.<boolean>

This event is emitted when the property secureControlData changes in the remote object. The property secureControlData is described in the AES70 standard as follows. Indicates whether the OCA control data in the system is secured.

OcaSecurityManager.AddPreSharedKey(identity, key)

Adds a pre-shared key (identified by the passed identity) to the device. By having multiple PSKs the device is able to participate in multiple secure systems. Note that adding a PSK over the network will only work if the controller has a secure connection to the device and control security has been turned on. If this is not the case the method will return DeviceError.

Arguments

  • identity (string) –

  • key (Uint8Array) –

Returns

Promise.<void> –

OcaSecurityManager.ChangePreSharedKey(identity, newKey)

Changes the pre-shared key identified by the passed identity. Note that changing a PSK over the network will only work if the controller has a secure connection to the device and control security has been turned on. If this is not the case the method will return DeviceError.

Arguments

  • identity (string) –

  • newKey (Uint8Array) –

Returns

Promise.<void> –

OcaSecurityManager.DeletePreSharedKey(identity)

Deletes a pre-shared key (identified by the passed identity) on the device. After deleting the pre-shared key the device will no longer be able to participate in the secure system that uses the PSK. Note that deleting a PSK over the network will only work if the controller has a secure connection to the device and control security has been turned on. If this is not the case the method will return DeviceError.

Arguments

  • identity (string) –

Returns

Promise.<void> –

OcaSecurityManager.DisableControlSecurity()

Disables security of control data (OCA messages). After calling this method all OCA messages can be sent and received both on insecure and secure connections. The return value indicates whether the operation succeeded. If the operation fails security is not disabled.

Returns

Promise.<void> –

OcaSecurityManager.EnableControlSecurity()

Enables security of control data (OCA messages). After calling this method all OCA messages are sent and received using a secure connection. The return value indicates whether the operation succeeded. If the operation fails security is not enabled.

Returns

Promise.<void> –