Secure Session Response - 0xAE

Request frame: Secure Session Control - 0x2E

Description

This frame type is output as a response to a Secure Session Control - 0x2E attempt. It indicates whether the Secure Session operation was successful or not.

Format

The following table provides the contents of the frame. For details on frame structure, see API frame format.

Offset Size Frame Field Description
0 8-bit Start Delimiter Indicates the start of an API frame.
1 16-bit Length Number of bytes between the length and checksum.
3 8-bit Frame type

Secure Session Response - 0xAE

4 8-bit Response type

The type of response to correlate with the preceding request:

0x00 - Login response

0x01 - Logout response

0x02 - Server Termination

5 64-bit 64-bit source address

The 64-bit IEEE address of the responding device.

13 8-bit Status

Typical statuses:

0x00 - SRP operation was successful

0x01 - Invalid Password - SRP verification failed due to mismatched M1 and M2 values

0x02 - Session request was rejected as there are too many active sessions on the server already

0x03 - Session options or timeout are invalid

0x05 - Timed out waiting for the other node to respond

0x06 - Could not allocate memory needed for authentication

0x07 - A request to terminate a session in progress has been made

0x08 - There is no password set on the server

0x09 - There was no initial response from the server

0x0A - Data within the frame is not valid or formatted incorrectly

Atypical statuses:

0x80 - Server received a packet that was intended for a client or vice-versa

0x81 - Received an SRP packet we were not expecting

0x82 - Offset for a split value (A/B) came out of order

0x83 - Unrecognized or invalid SRP frame type

0x84 - Authentication protocol version is not supported

0xFF - An undefined error occurred

EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).

Examples

Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.

Secure Session Login attempt

A client attempted to log into a Secure Session server.

The following Secure Session Response - 0xAE is emitted as a response:

7E 00 0B AE 00 00 13 A2 00 12 34 56 78 00 88
Frame type Response type 64-bit source Status
0x2E 0x00 0x0013A200
12345678
0x00
Response Login
success