proxmark3/client/luascripts/hf_14a_raw.lua

local cmds = require('commands')
local getopt = require('getopt')
local lib14a = require('read14a')
local ansicolors  = require('ansicolors')

copyright = ''
author = "Martin Holst Swende"
version = 'v1.0.2'
desc = [[
This is a script to allow raw 14443a commands to be sent and received.
]]
example = [[
    # 1. Connect and don't disconnect
    script run hf_14a_raw -k

    # 2. Send mf auth, read response (nonce)
    script run hf_14a_raw -o -x 6000F57b -k

    # 3. disconnect
    script run hf_14a_raw -o

    # All three steps in one go:
    script run hf_14a_raw -x 6000F57b
]]
usage = [[
script run hf_14a_raw -x 6000F57b
]]
arguments = [[
    -o              do not connect - use this only if you previously used -k to stay connected
    -r              do not read response
    -c              calculate and append CRC
    -k              stay connected - dont inactivate the field
    -x <payload>    Data to send (NO SPACES!)
    -d              Debug flag
    -t              Topaz mode
    -3              ISO14443-4 (use RATS)
]]

--[[

This script communicates with
/armsrc/iso14443a.c, specifically ReaderIso14443a() at around line 1779 and onwards.

Check there for details about data format and how commands are interpreted on the
device-side.
]]

-- Some globals
local DEBUG = false -- the debug flag

-------------------------------
-- Some utilities
-------------------------------

---
-- A debug printout-function
local function dbg(args)
    if not DEBUG then return end
    if type(args) == 'table' then
        local i = 1
        while args[i] do
            dbg(args[i])
            i = i+1
        end
    else
        print('###', args)
    end
end
---
-- This is only meant to be used when errors occur
local function oops(err)
    print('ERROR:', err)
    core.clearCommandBuffer()
    return nil, err
end
---
-- Usage help
local function help()
    print(copyright)
    print(author)
    print(version)
    print(desc)
    print(ansicolors.cyan..'Usage'..ansicolors.reset)
    print(usage)
    print(ansicolors.cyan..'Arguments'..ansicolors.reset)
    print(arguments)
    print(ansicolors.cyan..'Example usage'..ansicolors.reset)
    print(example)
end
---
-- The main entry point
function main(args)

    if args == nil or #args == 0 then return help() end

    local ignore_response = false
    local append_crc = false
    local stayconnected = false
    local payload = nil
    local doconnect = true
    local topaz_mode = false
    local no_rats = false

    -- Read the parameters
    for o, a in getopt.getopt(args, 'orcpx:dt3') do
        if o == 'o' then doconnect = false end
        if o == 'r' then ignore_response = true end
        if o == 'c' then append_crc = true end
        if o == 'p' then stayconnected = true end
        if o == 'x' then payload = a end
        if o == 'd' then DEBUG = true end
        if o == 't' then topaz_mode = true end
        if o == '3' then no_rats = true end
    end

    -- First of all, connect
    if doconnect then
        dbg("doconnect")

        info, err = lib14a.read(true, no_rats)
        if err then
            lib14a.disconnect()
            return oops(err)
        end
        print(('Connected to card, uid = %s'):format(info.uid))
    end

    -- The actual raw payload, if any
    if payload then
        res, err = sendRaw(payload,{ignore_response = ignore_response, topaz_mode = topaz_mode, append_crc = append_crc})
        if err then
            lib14a.disconnect()
            return oops(err)
        end

        if not ignoreresponse then
            -- Display the returned data
            showdata(res)
        end
    end
    -- And, perhaps disconnect?
    if not stayconnected then
        lib14a.disconnect()
    end
end

--- Picks out and displays the data read from a tag
-- Specifically, takes a usb packet, converts to a Command
-- (as in commands.lua), takes the data-array and
-- reads the number of bytes specified in arg1 (arg0 in c-struct)
-- and displays the data
-- @param usbpacket the data received from the device
function showdata(usbpacket)
    local cmd_response = Command.parse(usbpacket)
    local len = tonumber(cmd_response.arg1) *2
    --print("data length:",len)
    local data = string.sub(tostring(cmd_response.data), 0, len);
    print("<< ",data)
end

function sendRaw(rawdata, options)
    print('>> ', rawdata)

    local flags = lib14a.ISO14A_COMMAND.ISO14A_NO_DISCONNECT + lib14a.ISO14A_COMMAND.ISO14A_RAW

    if options.topaz_mode then
        flags = flags + lib14a.ISO14A_COMMAND.ISO14A_TOPAZMODE
    end
    if options.append_crc then
        flags = flags + lib14a.ISO14A_COMMAND.ISO14A_APPEND_CRC
    end

    local command = Command:newMIX{cmd = cmds.CMD_HF_ISO14443A_READER,
                                arg1 = flags, -- Send raw
                                -- arg2 contains the length, which is half the length
                                -- of the ASCII-string rawdata
                                arg2 = string.len(rawdata)/2,
                                data = rawdata}
    return  command:sendMIX(options.ignore_response)
end


-------------------------
-- Testing
-------------------------
function selftest()
    DEBUG = true
    dbg('Performing test')
    main()
    main('-k')
    main(' -o -x 6000F57b -k')
    main('-o')
    main('-x 6000F57b')
    dbg('Tests done')
end
-- Flip the switch here to perform a sanity check.
-- It read a nonce in two different ways, as specified in the usage-section
if '--test'==args then
    selftest()
else
    -- Call the main
    main(args)
end