client/luascripts/hf_14b_calypso.lua
local cmds = require('commands')
local getopt = require('getopt')
local lib14b = require('read14b')
local utils = require('utils')
local iso7816 = require('7816_error')
local ansicolors  = require('ansicolors')

copyright = ''
author = 'Iceman'
version = 'v1.0.5'
desc = [[
This is a script to communicate with a CALYSPO / 14443b tag using the '14b raw' commands
]]
example = [[
    script run hf_14b_calypso -b 11223344

]]
usage = [[
script run hf_14b_calypso -h -b
]]
arguments = [[
      h   this helptext
      b   raw bytes to send
]]

--[[
This script communicates with  /armsrc/iso14443b.c,
Check there for details about data format and how commands are interpreted on the
device-side.
]]

local PM3_SUCCESS = 0

--[[-- iceman, todo:  return payload from ISO14b APDU is a struct now. iso14b_raw_apdu_response_t
typedef struct {
    uint8_t response_byte;
    uint16_t datalen;
    uint8_t data[];
} PACKED iso14b_raw_apdu_response_t;
--]]

local function calypso_parse(result)
    if result.Length >= 0 then
        local response_byte = string.sub(result.Data, 0, 1);
        local datalen = string.sub(result.Data, 2, 5);
        local d = string.sub(result.Data, 6, datalen * 2);
        return {
            response_byte = response_byte,
            datalen = datalen,
            data = d
            }, nil
    end
    return nil, "calypso_parse failed"
end
---
-- 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)
    lib14b.disconnect()
    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
--
-- helper function,  give current count of items in lua-table.
local function tablelen(T)
  local count = 0
  for _ in pairs(T) do count = count + 1 end
  return count
end
---
-- helper function, gives a sorted table from table t,
-- order can be a separate sorting-order function.
local function spairs(t, order)
    -- collect the keys
    local keys = {}
    for k in pairs(t) do keys[#keys+1] = k end

    -- if order function given, sort by it by passing the table and keys a, b,
    -- otherwise just sort the keys
    if order then
        table.sort(keys, function(a,b) return order(t, a, b) end)
    else
        table.sort(keys)
    end

    -- return the iterator function
    local i = 0
    return function()
        i = i + 1
        if keys[i] then
            return keys[i], t[keys[i]]
        end
    end
end
---
-- Sends a usbpackage ,  "hf 14b raw"
-- if it reads the response, it converts it to a lua object "Command" first and the Data is cut to correct length.
local function calypso_send_cmd_raw(data, ignoreresponse )

    local flags = lib14b.ISO14B_COMMAND.ISO14B_APDU

    data = data or ""
    -- LEN of data, half the length of the ASCII-string hex string
    -- 2 bytes flags
    -- 4 bytes timeout
    -- 2 bytes raw len
    -- n bytes raw

    local flags_str  = ('%04x'):format(utils.SwapEndianness(('%04x'):format(flags), 16))
    local time_str  =  ('%08x'):format(0)
    local rawlen_str = ('%04x'):format(utils.SwapEndianness(('%04x'):format(( 8 + #data/2)), 16))
    local senddata = ('%s%s%s%s'):format(flags_str, time_str, rawlen_str,data)
    local c = Command:newNG{cmd = cmds.CMD_HF_ISO14443B_COMMAND, data = senddata}
    local result, err = c:sendNG(ignoreresponse, 2000)
    if result and result.status == PM3_SUCCESS then
        return calypso_parse(result)
    else
        err = 'No response from card'
    end
    return result, err
end
---
-- calypso_card_num : Reads card number from ATR and
-- writes it in the tree in decimal format.
local function calypso_card_num(card)
    if not card then return end
    local card_num = tonumber( card.uid:sub(1, 8), 16)
    print('')
    print('Card UID    ' ..ansicolors.green..card.uid:format('%x')..ansicolors.reset)
    print('Card Number ' ..ansicolors.green..string.format('%u', card_num)..ansicolors.reset)
    print('-----------------------')
end
---
-- analyse CALYPSO apdu status bytes.
local function calypso_apdu_status(apdu)
    -- last two is CRC
    -- next two is APDU status bytes.
    local mess = 'FAIL'
    local sw = apdu:sub( #apdu - 7 , #apdu - 4)
    desc, err = iso7816.tostring(sw)
    --print ('SW', sw, desc, err )
    local status = ( sw == '9000' )
    return status, desc, err
end

local CLA = '94'
local _calypso_cmds = {

-- Break down of command bytes:
--  A4 = select
--  Master File  3F00
--  0x3F = master file
--  0x00 = master file id, is constant to 0x00.

--  DF Dedicated File  38nn
--  can be seen as directories
--  0x38
--  0xNN  id
--  ["01.Select ICC file"] = '0294 a4 080004 3f00 0002',

--  EF Elementary File
--  EF1 Pin file
--  EF2 Key file
--  Grey Lock file
--  Electronic deposit file
--  Electronic Purse file
--  Electronic Transaction log file

    ['01.Select ICC file']    = CLA..'a4 080004 3f00 0002',
    ['02.ICC']                = CLA..'b2 01 041d',
    ['03.Select EnvHol file'] = CLA..'a4 080004 2000 2001',
    ['04.EnvHol1']            = CLA..'b2 01 041d',
    ['05.Select EvLog file']  = CLA..'a4 080004 2000 2010',
    ['06.EvLog1']             = CLA..'b2 01 041d',
    ['07.EvLog2']             = CLA..'b2 02 041d',
    ['08.EvLog3']             = CLA..'b2 03 041d',
    ['09.Select ConList file']= CLA..'a4 080004 2000 2050',
    ['10.ConList']            = CLA..'b2 01 041d',
    ['11.Select Contra file'] = CLA..'a4 080004 2000 2020',
    ['12.Contra1']            = CLA..'b2 01 041d',
    ['13.Contra2']            = CLA..'b2 02 041d',
    ['14.Contra3']            = CLA..'b2 03 041d',
    ['15.Contra4']            = CLA..'b2 04 041d',
    ['16.Select Counter file']= CLA..'a4 080004 2000 2069',
    ['17.Counter']            = CLA..'b2 01 041d',
    ['18.Select SpecEv file'] = CLA..'a4 080004 2000 2040',
    ['19.SpecEv1']            = CLA..'b2 01 041d',
}

---
-- The main entry point
function main(args)

    print( string.rep('--',20) )
    print( string.rep('--',20) )
    print()

    local data, apdu, flags, uid, cid, result, err, card
    -- Read the parameters
    for o, a in getopt.getopt(args, 'h') do
        if o == 'h' then return help() end
        if o == 'b' then bytes = a end
    end

--    lib14b.connect()

    -- Select 14b tag.
    card, err = lib14b.waitFor14443b()
    if not card then return oops(err) end

    calypso_card_num(card)
    cid = card.cid

    --[[
    NAME        VALUE  APDU_POS
    PCB         0x0A   0
    CID         0x00   1
    CLA         0x94   2
    SELECT FILE 0xA4   3
    READ FILE   0xB2   3
    P1                 4
    P2                 5
    LEN_
             0  1  2  3  4  5  6  7
    apdu = '02 94 a4 08 00 04 3f 00 00 02'  --select ICC file
    DF_NAME = "1TIC.ICA"
    --]]
    --for i = 1,10 do
        --result, err = calypso_send_cmd_raw('0294a40800043f000002',false)  --select ICC file
        for i, apdu in spairs(_calypso_cmds) do
            print('>> '..ansicolors.yellow..i..ansicolors.reset)
            apdu = apdu:gsub('%s+', '')
            obj, err = calypso_send_cmd_raw(apdu, false)
            if err then
                print('<< '..err)
            else
                if obj.data then
                    local status, desc, err = calypso_apdu_status(obj.data)
                    local d = data:sub(3, (obj.datalen - 8))
                    if status then
                        print('<< '..d..' ('..ansicolors.green..'ok'..ansicolors.reset..')')
                    else
                        print('<< '..d..' '..ansicolors.red..err..ansicolors.reset )
                    end
                else
                    print('<< no answer')
                end
            end
        end
    lib14b.disconnect()
end
---
-- a simple selftest function, tries to convert
function selftest()
    DEBUG = true
    dbg('Performing test')
    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
