obex.h

Go to the documentation of this file.

/* obex.h - IrDA Object Exchange Protocol handling */
 
/*
 * Copyright 2024-2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_OBEX_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_OBEX_H_

 
#include <zephyr/kernel.h>
#include <string.h>
#include <errno.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/uuid.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_OBEX_MIN_MTU 255

enum __packed bt_obex_rsp_code {
        BT_OBEX_RSP_CODE_CONTINUE = 0x90,
        BT_OBEX_RSP_CODE_OK = 0xa0,
        BT_OBEX_RSP_CODE_SUCCESS = 0xa0,
        BT_OBEX_RSP_CODE_CREATED = 0xa1,
        BT_OBEX_RSP_CODE_ACCEPTED = 0xa2,
        BT_OBEX_RSP_CODE_NON_AUTH_INFO = 0xa3,
        BT_OBEX_RSP_CODE_NO_CONTENT = 0xa4,
        BT_OBEX_RSP_CODE_RESET_CONTENT = 0xa5,
        BT_OBEX_RSP_CODE_PARTIAL_CONTENT = 0xa6,
        BT_OBEX_RSP_CODE_MULTI_CHOICES = 0xb0,
        BT_OBEX_RSP_CODE_MOVED_PERM = 0xb1,
        BT_OBEX_RSP_CODE_MOVED_TEMP = 0xb2,
        BT_OBEX_RSP_CODE_SEE_OTHER = 0xb3,
        BT_OBEX_RSP_CODE_NOT_MODIFIED = 0xb4,
        BT_OBEX_RSP_CODE_USE_PROXY = 0xb5,
        BT_OBEX_RSP_CODE_BAD_REQ = 0xc0,
        BT_OBEX_RSP_CODE_UNAUTH = 0xc1,
        BT_OBEX_RSP_CODE_PAY_REQ = 0xc2,
        BT_OBEX_RSP_CODE_FORBIDDEN = 0xc3,
        BT_OBEX_RSP_CODE_NOT_FOUND = 0xc4,
        BT_OBEX_RSP_CODE_NOT_ALLOW = 0xc5,
        BT_OBEX_RSP_CODE_NOT_ACCEPT = 0xc6,
        BT_OBEX_RSP_CODE_PROXY_AUTH_REQ = 0xc7,
        BT_OBEX_RSP_CODE_REQ_TIMEOUT = 0xc8,
        BT_OBEX_RSP_CODE_CONFLICT = 0xc9,
        BT_OBEX_RSP_CODE_GONE = 0xca,
        BT_OBEX_RSP_CODE_LEN_REQ = 0xcb,
        BT_OBEX_RSP_CODE_PRECON_FAIL = 0xcc,
        BT_OBEX_RSP_CODE_ENTITY_TOO_LARGE = 0xcd,
        BT_OBEX_RSP_CODE_URL_TOO_LARGE = 0xce,
        BT_OBEX_RSP_CODE_UNSUPP_MEDIA_TYPE = 0xcf,
        BT_OBEX_RSP_CODE_INTER_ERROR = 0xd0,
        BT_OBEX_RSP_CODE_NOT_IMPL = 0xd1,
        BT_OBEX_RSP_CODE_BAD_GATEWAY = 0xd2,
        BT_OBEX_RSP_CODE_UNAVAIL = 0xd3,
        BT_OBEX_RSP_CODE_GATEWAY_TIMEOUT = 0xd4,
        BT_OBEX_RSP_CODE_VER_UNSUPP = 0xd5,
        BT_OBEX_RSP_CODE_DB_FULL = 0xe0,
        BT_OBEX_RSP_CODE_DB_LOCK = 0xe1,
};

#if defined(CONFIG_BT_OEBX_RSP_CODE_TO_STR)
const char *bt_obex_rsp_code_to_str(enum bt_obex_rsp_code rsp_code);
#else
static inline const char *bt_obex_rsp_code_to_str(enum bt_obex_rsp_code rsp_code)
{
        ARG_UNUSED(rsp_code);
 
        return "";
}
#endif /* CONFIG_BT_OEBX_RSP_CODE_TO_STR */

enum __packed bt_obex_header_id {
        BT_OBEX_HEADER_ID_COUNT = 0xC0,

        BT_OBEX_HEADER_ID_NAME = 0x01,

        BT_OBEX_HEADER_ID_TYPE = 0x42,

        BT_OBEX_HEADER_ID_LEN = 0xC3,

        BT_OBEX_HEADER_ID_TIME_ISO_8601 = 0x44,

        BT_OBEX_HEADER_ID_TIME = 0xC4,

        BT_OBEX_HEADER_ID_DES = 0x05,

        BT_OBEX_HEADER_ID_TARGET = 0x46,

        BT_OBEX_HEADER_ID_HTTP = 0x47,

        BT_OBEX_HEADER_ID_BODY = 0x48,

        BT_OBEX_HEADER_ID_END_BODY = 0x49,

        BT_OBEX_HEADER_ID_WHO = 0x4A,

        BT_OBEX_HEADER_ID_CONN_ID = 0xCB,

        BT_OBEX_HEADER_ID_APP_PARAM = 0x4C,

        BT_OBEX_HEADER_ID_AUTH_CHALLENGE = 0x4D,

        BT_OBEX_HEADER_ID_AUTH_RSP = 0x4E,

        BT_OBEX_HEADER_ID_CREATE_ID = 0xCF,

        BT_OBEX_HEADER_ID_WAN_UUID = 0x50,

        BT_OBEX_HEADER_ID_OBJECT_CLASS = 0x51,

        BT_OBEX_HEADER_ID_SESSION_PARAM = 0x52,

        BT_OBEX_HEADER_ID_SESSION_SEQ_NUM = 0x93,

        BT_OBEX_HEADER_ID_ACTION_ID = 0x94,

        BT_OBEX_HEADER_ID_DEST_NAME = 0x15,

        BT_OBEX_HEADER_ID_PERM = 0xD6,

        BT_OBEX_HEADER_ID_SRM = 0x97,

        BT_OBEX_HEADER_ID_SRM_PARAM = 0x98,
};

#define BT_OBEX_HDR_LEN 3

#define BT_OBEX_PDU_LEN(mopl) ((mopl) - BT_OBEX_HDR_LEN)

#define BT_OBEX_HDR_LEN_OF_HEADER_BODY 3

#define BT_OBEX_DATA_LEN_OF_HEADER_BODY(len) ((len) - BT_OBEX_HDR_LEN_OF_HEADER_BODY)
 
#define BT_OBEX_SEND_BUF_RESERVE 7
 
struct bt_obex;
struct bt_obex_server;
struct bt_obex_client;

struct bt_obex_server_ops {
        void (*connect)(struct bt_obex_server *server, uint8_t version, uint16_t mopl,
                        struct net_buf *buf);

        void (*disconnect)(struct bt_obex_server *server, struct net_buf *buf);

        void (*put)(struct bt_obex_server *server, bool final, struct net_buf *buf);

        void (*get)(struct bt_obex_server *server, bool final, struct net_buf *buf);

        void (*abort)(struct bt_obex_server *server, struct net_buf *buf);

        void (*setpath)(struct bt_obex_server *server, uint8_t flags, struct net_buf *buf);

        void (*action)(struct bt_obex_server *server, bool final, struct net_buf *buf);
};

struct bt_obex_client_ops {
        void (*connect)(struct bt_obex_client *client, uint8_t rsp_code, uint8_t version,
                        uint16_t mopl, struct net_buf *buf);

        void (*disconnect)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);

        void (*put)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);

        void (*get)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);

        void (*abort)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);

        void (*setpath)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);

        void (*action)(struct bt_obex_client *client, uint8_t rsp_code, struct net_buf *buf);
};

struct bt_obex_transport_ops {
        struct net_buf *(*alloc_buf)(struct bt_obex *obex, struct net_buf_pool *pool);

        int (*send)(struct bt_obex *obex, struct net_buf *buf);

        int (*disconnect)(struct bt_obex *obex);
};

enum __packed bt_obex_state {
        BT_OBEX_DISCONNECTED,
        BT_OBEX_CONNECTING,
        BT_OBEX_CONNECTED,
        BT_OBEX_DISCONNECTING,
};
 
union bt_obex_uuid {
        struct bt_uuid uuid;
        struct bt_uuid_16 u16;
        struct bt_uuid_32 u32;
        struct bt_uuid_128 u128;
};

struct bt_obex_server {
        struct bt_obex *obex;

        const struct bt_uuid_128 *uuid;

        const struct bt_obex_server_ops *ops;

        struct {
                uint16_t mopl;
        } rx;

        struct {
                uint16_t mopl;
        } tx;

        atomic_t _state;

        atomic_t _opcode;

        atomic_t _flags;

        union bt_obex_uuid _target;

        uint32_t _conn_id;

        sys_snode_t _node;
};

struct bt_obex_client {
        struct bt_obex *obex;

        const struct bt_obex_client_ops *ops;

        struct {
                uint16_t mopl;
        } rx;

        struct {
                uint16_t mopl;
        } tx;

        atomic_t _state;

        atomic_t _opcode;

        atomic_t _pre_opcode;

        atomic_t _flags;

        union bt_obex_uuid _target;

        uint32_t _conn_id;

        sys_snode_t _node;
};

struct bt_obex {
        struct {
                uint16_t mtu;
        } rx;

        struct {
                uint16_t mtu;
        } tx;

        const struct bt_obex_transport_ops *_transport_ops;

        atomic_ptr_t _active_client;

        atomic_ptr_t _last_client;

        atomic_ptr_t _active_server;

        sys_slist_t _clients;

        sys_slist_t _servers;
};

int bt_obex_server_register(struct bt_obex_server *server, const struct bt_uuid_128 *uuid);

int bt_obex_server_unregister(struct bt_obex_server *server);

int bt_obex_connect(struct bt_obex_client *client, uint16_t mopl, struct net_buf *buf);

int bt_obex_connect_rsp(struct bt_obex_server *server, uint8_t rsp_code, uint16_t mopl,
                        struct net_buf *buf);

int bt_obex_disconnect(struct bt_obex_client *client, struct net_buf *buf);

int bt_obex_disconnect_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

int bt_obex_put(struct bt_obex_client *client, bool final, struct net_buf *buf);

int bt_obex_put_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

int bt_obex_get(struct bt_obex_client *client, bool final, struct net_buf *buf);

int bt_obex_get_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

int bt_obex_abort(struct bt_obex_client *client, struct net_buf *buf);

int bt_obex_abort_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

enum __packed bt_obex_setpath_flags {
        BT_OBEX_SETPATH_FLAG_BACKUP = BIT(0U),
        BT_OBEX_SETPATH_FLAG_NO_CREATE = BIT(1U),
};

int bt_obex_setpath(struct bt_obex_client *client, uint8_t flags, struct net_buf *buf);

int bt_obex_setpath_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

enum __packed bt_obex_action_id {
        BT_OBEX_ACTION_COPY = 0x00,
        BT_OBEX_ACTION_MOVE_RENAME = 0x01,
        BT_OBEX_ACTION_SET_PERM = 0x02,
};

int bt_obex_action(struct bt_obex_client *client, bool final, struct net_buf *buf);

int bt_obex_action_rsp(struct bt_obex_server *server, uint8_t rsp_code, struct net_buf *buf);

int bt_obex_add_header_count(struct net_buf *buf, uint32_t count);

int bt_obex_add_header_name(struct net_buf *buf, uint16_t len, const uint8_t *name);

int bt_obex_add_header_type(struct net_buf *buf, uint16_t len, const uint8_t *type);

int bt_obex_add_header_len(struct net_buf *buf, uint32_t len);

int bt_obex_add_header_time_iso_8601(struct net_buf *buf, uint16_t len, const uint8_t *t);

int bt_obex_add_header_time(struct net_buf *buf, uint32_t t);

int bt_obex_add_header_description(struct net_buf *buf, uint16_t len, const uint8_t *dec);

int bt_obex_add_header_target(struct net_buf *buf, uint16_t len, const uint8_t *target);

int bt_obex_add_header_http(struct net_buf *buf, uint16_t len, const uint8_t *http);

int bt_obex_add_header_body(struct net_buf *buf, uint16_t len, const uint8_t *body);

int bt_obex_add_header_end_body(struct net_buf *buf, uint16_t len, const uint8_t *body);

static inline int bt_obex_add_header_body_or_end_body(struct net_buf *buf, uint16_t mopl,
                                                      uint16_t len, const uint8_t *body,
                                                      uint16_t *added_len)
{
        uint16_t tx_len;
        int err;
 
        /*
         * OBEX Version 1.5, section 2.2.9 Body, End-of-Body
         * The `body` could be a NULL, so the `len` of the name could 0.
         * In some cases, the object body data is generated on the fly and the end cannot
         * be anticipated, so it is legal to send a zero length End-of-Body header.
         */
        if ((buf == NULL) || ((len != 0) && (body == NULL)) || (added_len == NULL) ||
            (mopl < BT_OBEX_MIN_MTU)) {
                return -EINVAL;
        }
 
        tx_len = BT_OBEX_PDU_LEN(mopl);
        if (tx_len <= buf->len) {
                return -ENOMEM;
        }
 
        *added_len = 0;
 
        tx_len = MIN((tx_len - buf->len), net_buf_tailroom(buf));
        if (tx_len <= BT_OBEX_HDR_LEN_OF_HEADER_BODY) {
                return 0;
        }
 
        tx_len = BT_OBEX_DATA_LEN_OF_HEADER_BODY(tx_len);
        if (tx_len >= len) {
                *added_len = len;
                err = bt_obex_add_header_end_body(buf, len, body);
        } else {
                *added_len = tx_len;
                err = bt_obex_add_header_body(buf, tx_len, body);
        }
 
        return err;
}

int bt_obex_add_header_who(struct net_buf *buf, uint16_t len, const uint8_t *who);

int bt_obex_add_header_conn_id(struct net_buf *buf, uint32_t conn_id);

struct bt_obex_tlv {
        uint8_t type;
        uint8_t data_len;
        const uint8_t *data;
};

int bt_obex_add_header_app_param(struct net_buf *buf, size_t count,
                                 const struct bt_obex_tlv data[]);

#define BT_OBEX_CHALLENGE_TAG_NONCE 0x00
#define BT_OBEX_CHALLENGE_TAG_NONCE_LEN 16

#define BT_OBEX_CHALLENGE_TAG_OPTIONS 0x01
#define BT_OBEX_CHALLENGE_TAG_OPTIONS_LEN 1

#define BT_OBEX_CHALLENGE_TAG_OPTION_REQ_USER_ID BIT(0)
#define BT_OBEX_CHALLENGE_TAG_OPTION_ACCESS_MODE BIT(1)

#define BT_OBEX_CHALLENGE_TAG_REALM 0x02

int bt_obex_add_header_auth_challenge(struct net_buf *buf, size_t count,
                                      const struct bt_obex_tlv data[]);

#define BT_OBEX_RESPONSE_TAG_REQ_DIGEST 0x00
#define BT_OBEX_RESPONSE_TAG_REQ_DIGEST_LEN 16

#define BT_OBEX_RESPONSE_TAG_USER_ID 0x01

#define BT_OBEX_RESPONSE_TAG_NONCE 0x02
#define BT_OBEX_RESPONSE_TAG_NONCE_LEN 16

int bt_obex_add_header_auth_rsp(struct net_buf *buf, size_t count, const struct bt_obex_tlv data[]);

int bt_obex_add_header_creator_id(struct net_buf *buf, uint32_t creator_id);

int bt_obex_add_header_wan_uuid(struct net_buf *buf, uint16_t len, const uint8_t *uuid);

int bt_obex_add_header_obj_class(struct net_buf *buf, uint16_t len, const uint8_t *obj_class);

int bt_obex_add_header_session_param(struct net_buf *buf, uint16_t len,
                                     const uint8_t *session_param);

int bt_obex_add_header_session_seq_number(struct net_buf *buf, uint32_t session_seq_number);

int bt_obex_add_header_action_id(struct net_buf *buf, uint8_t action_id);

int bt_obex_add_header_dest_name(struct net_buf *buf, uint16_t len, const uint8_t *dest_name);

int bt_obex_add_header_perm(struct net_buf *buf, uint32_t perm);

int bt_obex_add_header_srm(struct net_buf *buf, uint8_t srm);

int bt_obex_add_header_srm_param(struct net_buf *buf, uint8_t srm_param);

struct bt_obex_hdr {
        uint8_t id;
        uint16_t len;
        const uint8_t *data;
};

int bt_obex_header_parse(struct net_buf *buf,
                         bool (*func)(struct bt_obex_hdr *hdr, void *user_data), void *user_data);

int bt_obex_get_header_count(struct net_buf *buf, uint32_t *count);

int bt_obex_get_header_name(struct net_buf *buf, uint16_t *len, const uint8_t **name);

int bt_obex_get_header_type(struct net_buf *buf, uint16_t *len, const uint8_t **type);

int bt_obex_get_header_len(struct net_buf *buf, uint32_t *len);

int bt_obex_get_header_time_iso_8601(struct net_buf *buf, uint16_t *len, const uint8_t **t);

int bt_obex_get_header_time(struct net_buf *buf, uint32_t *t);

int bt_obex_get_header_description(struct net_buf *buf, uint16_t *len, const uint8_t **dec);

int bt_obex_get_header_target(struct net_buf *buf, uint16_t *len, const uint8_t **target);

int bt_obex_get_header_http(struct net_buf *buf, uint16_t *len, const uint8_t **http);

int bt_obex_get_header_body(struct net_buf *buf, uint16_t *len, const uint8_t **body);

int bt_obex_get_header_end_body(struct net_buf *buf, uint16_t *len, const uint8_t **body);

int bt_obex_get_header_who(struct net_buf *buf, uint16_t *len, const uint8_t **who);

int bt_obex_get_header_conn_id(struct net_buf *buf, uint32_t *conn_id);

int bt_obex_tlv_parse(uint16_t len, const uint8_t *data,
                      bool (*func)(struct bt_obex_tlv *tlv, void *user_data), void *user_data);

int bt_obex_get_header_app_param(struct net_buf *buf, uint16_t *len, const uint8_t **app_param);

int bt_obex_get_header_auth_challenge(struct net_buf *buf, uint16_t *len, const uint8_t **auth);

int bt_obex_get_header_auth_rsp(struct net_buf *buf, uint16_t *len, const uint8_t **auth);

int bt_obex_get_header_creator_id(struct net_buf *buf, uint32_t *creator_id);

int bt_obex_get_header_wan_uuid(struct net_buf *buf, uint16_t *len, const uint8_t **uuid);

int bt_obex_get_header_obj_class(struct net_buf *buf, uint16_t *len, const uint8_t **obj_class);

int bt_obex_get_header_session_param(struct net_buf *buf, uint16_t *len,
                                     const uint8_t **session_param);

int bt_obex_get_header_session_seq_number(struct net_buf *buf, uint32_t *session_seq_number);

int bt_obex_get_header_action_id(struct net_buf *buf, uint8_t *action_id);

int bt_obex_get_header_dest_name(struct net_buf *buf, uint16_t *len, const uint8_t **dest_name);

int bt_obex_get_header_perm(struct net_buf *buf, uint32_t *perm);

int bt_obex_get_header_srm(struct net_buf *buf, uint8_t *srm);

int bt_obex_get_header_srm_param(struct net_buf *buf, uint8_t *srm_param);

int bt_obex_make_uuid(union bt_obex_uuid *uuid, const uint8_t *data, uint16_t len);

bool bt_obex_string_is_valid(uint8_t id, uint16_t len, const uint8_t *str);

bool bt_obex_has_header(struct net_buf *buf, uint8_t id);

bool bt_obex_has_app_param(struct net_buf *buf, uint8_t id);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_OBEX_H_ */