secure_session.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef XBEE_SECURE_SESSION_H
#define XBEE_SECURE_SESSION_H

#include "xbee/platform.h"
#include "xbee/device.h"
#include "wpan/types.h"

XBEE_BEGIN_DECLS

#define XBEE_CMD_ATSA_REMOTE_AT                 (1<<1)

#define XBEE_CMD_ATSA_SERIAL_DATA               (1<<2)

#define XBEE_FRAME_SECURE_SESSION_REQ           0x2E

typedef XBEE_PACKED(xbee_header_secure_session_req_t, {
    uint8_t     frame_type;

    addr64      remote_addr_be;

    uint8_t     options;

    uint16_t    timeout_be;

    // header followed by variable-length password
}) xbee_header_secure_session_req_t;

#define XBEE_SS_REQ_OPT_CLIENT_LOGIN            (0)

#define XBEE_SS_REQ_OPT_CLIENT_LOGOUT           (1<<0)

#define XBEE_SS_REQ_OPT_SERVER_TERMINATION      (1<<1)

#define XBEE_SS_REQ_OPT_TIMEOUT_FIXED           (0)

#define XBEE_SS_REQ_OPT_TIMEOUT_INTER_PACKET    (1<<2)

#define XBEE_SS_REQ_TIMEOUT_UNITS_PER_SEC       10

#define XBEE_SS_REQ_TIMEOUT_MAX (30 * 60 * XBEE_SS_REQ_TIMEOUT_UNITS_PER_SEC)

#define XBEE_SS_REQ_TIMEOUT_YIELDING            0x0000

int xbee_secure_session_request(xbee_dev_t *xbee,
                                const addr64 *dest_be,
                                uint8_t options,
                                uint16_t timeout_ds,
                                const char *password);


#define XBEE_FRAME_SECURE_SESSION_RESP          0xAE

typedef XBEE_PACKED(xbee_frame_secure_session_resp_t, {
    uint8_t     frame_type;

    uint8_t     type;

    addr64      remote_addr_be;

    uint8_t     status;

}) xbee_frame_secure_session_resp_t;

#define XBEE_SS_RESP_TYPE_LOGIN                 0x00

#define XBEE_SS_RESP_TYPE_LOGOUT                0x01

#define XBEE_SS_RESP_STATUS_SUCCESS             0x00

#define XBEE_SS_RESP_STATUS_INVALID_PW          0x01

#define XBEE_SS_RESP_STATUS_BUSY                0x02

#define XBEE_SS_RESP_STATUS_INVALID_ARG         0x03

#define XBEE_SS_RESP_STATUS_NO_SESSION          0x04

#define XBEE_SS_RESP_STATUS_TIMEOUT             0x05

#define XBEE_SS_RESP_STATUS_NO_MEMORY           0x06

#define XBEE_SS_RESP_STATUS_IN_PROGRESS         0x07

#define XBEE_SS_RESP_STATUS_NO_PASSWORD         0x08

#define XBEE_SS_RESP_STATUS_NO_RESPONSE         0x09

#define XBEE_SS_RESP_STATUS_BAD_FRAME           0x0A

#define XBEE_SS_RESP_STATUS_SRP_WRONG_WAY       0x80

#define XBEE_SS_RESP_STATUS_SRP_UNEXPECTED      0x81

#define XBEE_SS_RESP_STATUS_SRP_MISORDERED      0x82

#define XBEE_SS_RESP_STATUS_SRP_BAD_FRAME       0x83

#define XBEE_SS_RESP_STATUS_SRP_BAD_PROTOCOL    0x84

#define XBEE_SS_RESP_STATUS_UNDEFINED           0xFF

int xbee_frame_dump_secure_session_resp(xbee_dev_t *xbee,
                                        const void FAR *payload,
                                        uint16_t length,
                                        void FAR *context);

#define XBEE_FRAME_DUMP_SS_RESP \
    { XBEE_FRAME_SECURE_SESSION_RESP, 0, \
      xbee_frame_dump_secure_session_resp, NULL }

#define XBEE_MODEM_STATUS_IS_SS(code)         \
    (code >= XBEE_MODEM_STATUS_SS_ESTABLISHED \
     && code <= XBEE_MODEM_STATUS_SS_AUTH_FAILED)

typedef XBEE_PACKED(xbee_frame_xms_ss_established_t, {
    uint8_t     frame_type;

    uint8_t     status_code;

    addr64      remote_addr_be;

    uint8_t     options;

    uint16_t    timeout_be;
}) xbee_frame_xms_ss_established_t;

typedef XBEE_PACKED(xbee_frame_xms_ss_ended_t, {
    uint8_t     frame_type;

    uint8_t     status_code;

    addr64      remote_addr_be;

    uint8_t     reason;
}) xbee_frame_xms_ss_ended_t;

#define XBEE_SS_END_REASON_REMOTE_TERM          0x00
#define XBEE_SS_END_REASON_TIMED_OUT            0x01
#define XBEE_SS_END_REASON_BAD_ENCRYPT_CTR      0x02
#define XBEE_SS_END_REASON_ENCRYPT_CTR_OVERFLOW 0x03
#define XBEE_SS_END_REASON_REMOTE_NO_MEMORY     0x04

typedef XBEE_PACKED(xbee_frame_xms_ss_auth_failed_t, {
    uint8_t     frame_type;

    uint8_t     status_code;

    addr64      remote_addr_be;

    uint8_t     error;
}) xbee_frame_xms_ss_auth_failed_t;

int xbee_frame_dump_ext_mod_status_ss(xbee_dev_t *xbee,
                                      const void FAR *payload,
                                      uint16_t length,
                                      void FAR *context);

XBEE_END_DECLS

#endif // XBEE_SECURE_SESSION_H