libosdp-sys 3.2.1

Sys crate for https://github.com/goToMain/libosdp
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

--
--  Copyright (c) 2024-2026 Siddharth Chandrasekaran <sidcha.dev@gmail.com>
--
--  SPDX-License-Identifier: Apache-2.0

local malformed_error = ProtoExpert.new("Error.Malformed", "Malformed Packet", expert.group.MALFORMED, expert.severity.ERROR)

-- Header
local header = ProtoField.new("OSDP Header", "OSDP.Header", ftypes.BYTES)
local mark = ProtoField.uint8("OSDP.Mark", "Mark byte", base.HEX)
local som = ProtoField.uint8("OSDP.SOM", "Start of message", base.HEX)
local type = ProtoField.new("Message Type", "OSDP.MessageType", ftypes.UINT8, { [0] = "Command", [1] = "Reply" }, base.NONE, 0x80)
local address = ProtoField.new("PD Address", "OSDP.Address", ftypes.UINT8, nil, base.DEC, 0x7f)
local length = ProtoField.uint16("OSDP.Length", "Packet Length", base.DEC)

local control = ProtoField.new("Packet Control", "OSDP.Control", ftypes.UINT8, nil, base.HEX)
local control_sequence = ProtoField.new("Sequence", "OSDP.Control.Sequence", ftypes.UINT8, nil, base.DEC, 0x03)
local control_check = ProtoField.new("Integrity Check", "OSDP.Control.IC", ftypes.UINT8, { [0] = "Checksum", [1] = "CRC-16" }, base.NONE, 0x04)
local control_scb = ProtoField.new("Secure Control Block", "OSDP.Control.SCB", ftypes.UINT8, { [0] = "Absent", [1] = "Present" }, base.NONE, 0x08)
local control_trace = ProtoField.new("Capture Type", "OSDP.Control.Trace", ftypes.UINT8, { [0] = "Original", [1] = "Mangled" }, base.NONE, 0x80)

-- Entire payload
local payload = ProtoField.new("OSDP Payload", "Payload", ftypes.BYTES)

-- SC sub entries
local scb = ProtoField.new("Secure Channel Block", "SCB", ftypes.BYTES)
local sc_data = ProtoField.new("Encrypted Data Block", "SC_DATA", ftypes.BYTES)
local sc_mac = ProtoField.new("Message Authentication Code", "SC_MAC", ftypes.BYTES)

-- Plaintext sub entries
local plaintext_id = ProtoField.uint8("PlainText.ID", "ID", base.HEX)
local plaintext_data = ProtoField.new("Data", "PlainText.Data", ftypes.BYTES)

-- Checksum/CRC16
local packet_check = ProtoField.new("CheckSum", "CheckSum", ftypes.BYTES)

-- Protocol definition
local osdp_protocol = Proto("OSDP", "Open Supervised Device Protocol")
osdp_protocol.fields = {
    header,
    mark, som, type, address, length,
    control, control_sequence, control_check, control_scb, control_trace,

    payload,
    scb, sc_data, sc_mac,
    plaintext_id, plaintext_data,
    packet_check
}

local command_id_table = {
    [0x60] = "POLL",    [0x61] = "ID",      [0x62] = "CAP",     [0x64] = "LSTAT",
    [0x65] = "ISTAT",   [0x66] = "OSTAT",   [0x67] = "RSTAT",   [0x68] = "OUT",
    [0x69] = "LED",     [0x6A] = "BUZ",     [0x6B] = "TEXT",    [0x6C] = "RMODE",
    [0x6D] = "TDSET",   [0x6E] = "COMSET",  [0x73] = "BIOREAD", [0x74] = "BIOMATCH",
    [0x75] = "KEYSET",  [0x76] = "CHLNG",   [0x77] = "SCRYPT",  [0x7B] = "ACURXSIZE",
    [0x7C] = "FILETRANSFER",[0x80] = "MFG", [0xA1] = "XWR",    [0xA2] = "ABORT",
    [0xA3] = "PIVDATA", [0xA4] = "GENAUTH", [0xA5] = "CRAUTH",  [0xA7] = "KEEPACTIVE",
}

local reply_id_table = {
    [0x40] = "ACK",     [0x41] = "NAK",      [0x45] = "PDID",     [0x46] = "PDCAP",
    [0x48] = "LSTATR",  [0x49] = "ISTATR",   [0x4A] = "OSTATR",   [0x4B] = "RSTATR",
    [0x50] = "RAW",     [0x51] = "FMT",      [0x53] = "KEYPPAD",  [0x54] = "COM",
    [0x57] = "BIOREADR",[0x58] = "BIOMATCHR",[0x76] = "CCRYPT",   [0x78] = "RMAC_I",
    [0x79] = "BUSY",    [0x7A] = "FTSTAT",   [0x80] = "PIVDATA",  [0x81] = "CRAUTH",
    [0x83] = "MFGSTATR",[0x84] = "MFGERR",   [0x90] = "MFGREP",   [0xB1] = "XRD",
}

function get_id_name(id, is_cmd)
    local name = nil
    if is_cmd then
        name = command_id_table[id]
        if name then
            name = "CMD_" .. name
        else
            name = "CMD_UNKNOWN"
        end
    else
        name = reply_id_table[id]
        if name then
            name = "REPLY_" .. name
        else
            name = "REPLY_UNKNOWN"
        end
    end
    return name
end

-- Protocol disector
function osdp_protocol.dissector(buffer, pinfo, tree)
    local packet_length = buffer:len()
    if length == 0 then
        tree:add_proto_expert_info(malformed_error)
        return
    end

    local packet_mac_len = 4
    local packet_check_len = 1
    local has_mark = false;
    local first_byte = buffer(0, 1):uint()
    if first_byte == 0xFF then
        has_mark = true;
    else
        if first_byte ~= 0x53 then
            tree:add_proto_expert_info(malformed_error)
            return
        end
    end
    local packet_header_len = 5
    local pos = 0

    if has_mark then
        packet_header_len = 6
        pos = 1
    end

    local control_byte = buffer(pos + 4, 1):uint()
    local has_crc16 = (control_byte & 0x04) == 0x04
    local has_scb = (control_byte & 0x08) == 0x08
    local trace_mangled = (control_byte & 0x80) == 0x80

    if has_crc16 then
        packet_check_len = 2
    end
    if trace_mangled then
        packet_check_len = 0
    end

    local subtree = tree:add(osdp_protocol, buffer(0, packet_length), "OSDP Packet")

    -- Packet header
    local header_subtree = subtree:add(header, buffer(0, packet_header_len))
    if has_mark then
        header_subtree:add(mark, buffer(0, 1))
    end
    header_subtree:add(som, buffer(pos + 0, 1))
    header_subtree:add(type, buffer(pos + 1, 1))
    header_subtree:add(address, buffer(pos + 1, 1))
    header_subtree:add_le(length, buffer(pos + 2, 2))

    local control_subtree = header_subtree:add(control, buffer(pos + 4, 1))
    control_subtree:add(control_sequence, buffer(pos + 4, 1))
    control_subtree:add(control_check, buffer(pos + 4, 1))
    control_subtree:add(control_scb, buffer(pos + 4, 1))
    control_subtree:add(control_trace, buffer(pos + 4, 1))

    pinfo.cols.protocol = osdp_protocol.name
    local pd_address = buffer(pos + 1, 1):uint() & 0x7f
    local is_cmd = (buffer(pos + 1, 1):uint() & 0x80) ~= 0x80
    if is_cmd then
        pinfo.cols.src = "CP"
        pinfo.cols.dst = "PD[" .. tostring(pd_address) .. "]"
    else
        pinfo.cols.src = "PD[" .. tostring(pd_address) .. "]"
        pinfo.cols.dst = "CP"
    end

    -- payload
    local offset = packet_header_len
    local payload_len = packet_length - packet_header_len - packet_check_len

    local payload_subtree = subtree:add(payload, buffer(offset, payload_len))
    if has_scb then
        -- Secure Control Block
        local scb_len = buffer(offset, 1):uint()
        local scb_type = buffer(offset + 1, 1):uint()
        local scs_type_name = "SCS_" .. string.format("%x", scb_type)

        local scb_subtree = payload_subtree:add(scb, buffer(offset, scb_len))
        local id = buffer(offset + scb_len, 1):uint()
        payload_subtree:add(plaintext_id, buffer(offset + scb_len, 1))
            :append_text(" (" .. get_id_name(id, is_cmd) .. ")")

        -- +1 and -1 below are to skip the Command/Response ID
        offset = offset + scb_len + 1
        payload_len = payload_len - scb_len - 1
        local info = "Secure Message"
        if scb_type < 0x15 then
            info = "SC Handshake"
        end
        if trace_mangled then
            -- This message was mangled by data tracer to have SCB but no
            -- encrypted data so we add them as is.
            payload_subtree:add(plaintext_data, buffer(offset, payload_len))
            info = "Decrypted " .. info
        else
            -- Secure Data Block
            if scb_type >= 0x15 then
                if scb_type == 0x17 or scb_type == 0x18 then
                    scb_subtree:add(sc_data, buffer(offset, payload_len))
                    info = info .. " with Data"
                end
                scb_subtree:add(sc_mac, buffer(offset + payload_len - packet_mac_len, packet_mac_len))
            end
        end
        pinfo.cols.info = info .. " (" .. scs_type_name .. ")"
    else
        -- Plain text block
        local id = buffer(offset, 1):uint()
        payload_subtree:add(plaintext_id, buffer(offset, 1))
            :append_text(" (" .. get_id_name(id, is_cmd) .. ")")
        -- +1 and -1 below are to skip the Command/Response ID
        payload_subtree:add(plaintext_data, buffer(offset + 1, payload_len - 1))
        pinfo.cols.info = "Plaintext Message"
    end

    -- Packet check
    if packet_check_len > 0 then
        subtree:add(packet_check, buffer(packet_length - packet_check_len, packet_check_len))
    end
end