eoSecurity Class Reference

handles EnOcean Security Telegrams More...

#include <eoSecurity.h>

Public Member Functions
eoReturn	ParseTeachIn (eoMessage &msgTi, eoDevice &dev)
eoReturn	CreateTeachIn (eoMessage &msgTi, eoDevice &dev)
eoReturn	Decrypt (const eoMessage &msgSec, eoMessage &msgNonSec, eoDevice &dev)
eoReturn	Encrypt (const eoMessage &msgNonSec, eoMessage &msgSec, eoDevice &dev)
eoReturn	Encrypt (const eoMaintenanceMessage &msgNonSec, eoMaintenanceMessage &msgSec, eoDevice &dev)
eoReturn	Decrypt (const eoMaintenanceMessage &msgSec, eoMaintenanceMessage &msgNonSec, eoDevice &dev)
SEC_RESULT	GetLastError ()

Static Public Member Functions
static void	SetKey (uint8_t key[16], eoSecureInfo &info)

Detailed Description

handles EnOcean Security Telegrams

Allows you to receive and sent secured EnOcean Telegrams. After parsing a secured TeachIN telegram with the ParseTeachIn function the security Information get stored in the eoDevice::secIn field. Using the eoDevice::secIn field Secured Telegrams can be decrypted. Outgoing messages can also be encrypted using the stored Information in the eoDevice::secOut field.

Member Function Documentation

CreateTeachIn()

eoReturn eoSecurity::CreateTeachIn	(	eoMessage &	msgTi,
		eoDevice &	dev
	)

Create the TeachIN Message

Parameters

msgTi	Secure TeachIn message to create
dev	device to store eoSecureInfo to

Returns

Examples:

Security_example.cpp.

Decrypt() [1/2]

eoReturn eoSecurity::Decrypt	(	const eoMessage &	msgSec,
		eoMessage &	msgNonSec,
		eoDevice &	dev
	)

Decrypt data

Parameters

msgSec	Message containing Secured data
msgNonSec	Message containing decrypted data after a success
dev	eoDevice containing eoSecureInfo

Returns

Decrypt() [2/2]

eoReturn eoSecurity::Decrypt	(	const eoMaintenanceMessage &	msgSec,
		eoMaintenanceMessage &	msgNonSec,
		eoDevice &	dev
	)

Decrypts the maintenance Message, using the MaintenanceKey provided by the device

Parameters

msgSec	Message containing encrypted data
msgNonSec	Message containing the decrypted Message after a success
dev	eoDevice containing eoSecureInfo

Returns

Encrypt() [1/2]

eoReturn eoSecurity::Encrypt	(	const eoMessage &	msgNonSec,
		eoMessage &	msgSec,
		eoDevice &	dev
	)

Encrypt data

Parameters

msgSec	Message containing encrypted data after a success
msgNonSec	Message not decrypted Message to encrypt.
dev	eoDevice containing eoSecureInfo

Returns

Examples:

Security_example.cpp.

Encrypt() [2/2]

eoReturn eoSecurity::Encrypt	(	const eoMaintenanceMessage &	msgNonSec,
		eoMaintenanceMessage &	msgSec,
		eoDevice &	dev
	)

Encrypts the maintenance Message, using the MaintenanceKey provided by the device

Parameters

msgSec	Message containing encrypted data after a success
msgNonSec	Message not decrypted Message to encrypt.
dev	eoDevice containing eoSecureInfo

Returns

GetLastError()

SEC_RESULT eoSecurity::GetLastError

(

)

Get last error code

Returns

the last error code

Examples:

Security_example.cpp.

ParseTeachIn()

eoReturn eoSecurity::ParseTeachIn	(	eoMessage &	msgTi,
		eoDevice &	dev
	)

Parse the TeachIN Message

Parameters

msgTi	TeachIn message to parse
dev	device to store eoSecureInfo to

Returns

SetKey()

static void eoSecurity::SetKey ( uint8_t  key[16], eoSecureInfo &  info  )

static

Set the key info for eoSecureInfo, generates subkeys as needed

Parameters

key	aes key to set
info	the eoSecureInfo to update

Returns