libthai-idcard 0.2.0

A Rust library for reading Thai National ID smart cards via PC/SC
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225

"""
python_usage.py — Example of using libthaiidcard from Python.

Usage:
    # Build the shared library first:
    make shared

    # Then run this script:
    python3 examples/python_usage.py [reader_name]
"""

import ctypes
import ctypes.util
import os
import platform
import sys

# ---------------------------------------------------------------------------
# Locate the shared library
# ---------------------------------------------------------------------------


def find_library() -> str:
    """Locate libthaiidcard — tries platform-specific paths."""

    # Determine the library filename for the current platform
    system = platform.system()
    if system == "Windows":
        lib_name = "thaiidcard.dll"
    elif system == "Darwin":
        lib_name = "libthaiidcard.dylib"
    else:  # Linux and other Unix
        lib_name = "libthaiidcard.so"

    # Project root (two levels up from examples/)
    project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

    candidates = [
        # Development build
        os.path.join(project_root, "target", "debug", lib_name),
        os.path.join(project_root, "target", "release", lib_name),
    ]

    if system == "Darwin":
        candidates.extend([
            "/usr/local/lib/" + lib_name,
            "/opt/homebrew/lib/" + lib_name,
        ])
    elif system == "Linux":
        candidates.extend([
            "/usr/local/lib/" + lib_name,
            "/usr/lib/" + lib_name,
            "/usr/lib/x86_64-linux-gnu/" + lib_name,
            "/usr/lib/aarch64-linux-gnu/" + lib_name,
        ])
    elif system == "Windows":
        sysroot = os.environ.get("SYSTEMROOT", "C:\\Windows")
        pf = os.environ.get("PROGRAMFILES", "C:\\Program Files")
        candidates.extend([
            os.path.join(sysroot, "System32", lib_name),
            os.path.join(pf, "thaiidcard", "bin", lib_name),
        ])

    # ctypes fallback — searches system library paths
    fallback = ctypes.util.find_library("thaiidcard")
    if fallback:
        candidates.append(fallback)

    for path in candidates:
        if path and os.path.exists(path):
            return path

    raise FileNotFoundError(
        f"libthaiidcard not found ({lib_name}). "
        f"Build it with: make shared"
    )


# ---------------------------------------------------------------------------
# Load library and define argument/return types
# ---------------------------------------------------------------------------

lib = ctypes.cdll.LoadLibrary(find_library())

# --- thaiid_read(reader: str|null, face: int, nhso: int, laser: int) -> handle ---
lib.thaiid_read.restype = ctypes.c_void_p
lib.thaiid_read.argtypes = [
    ctypes.c_char_p,
    ctypes.c_int,
    ctypes.c_int,
    ctypes.c_int,
]

# --- thaiid_free(handle) ---
lib.thaiid_free.restype = None
lib.thaiid_free.argtypes = [ctypes.c_void_p]

# --- thaiid_get_last_error() -> str ---
lib.thaiid_get_last_error.restype = ctypes.c_char_p
lib.thaiid_get_last_error.argtypes = []


# --- getters: all take handle, return str ---
def _make_getter(name: str):
    fn = getattr(lib, name)
    fn.restype = ctypes.c_char_p
    fn.argtypes = [ctypes.c_void_p]
    return fn


GETTERS = {
    "cid": _make_getter("thaiid_get_cid"),
    "name_thai": _make_getter("thaiid_get_name_thai"),
    "name_en": _make_getter("thaiid_get_name_en"),
    "dob": _make_getter("thaiid_get_dob"),
    "gender": _make_getter("thaiid_get_gender"),
    "card_issuer": _make_getter("thaiid_get_card_issuer"),
    "issue_date": _make_getter("thaiid_get_issue_date"),
    "expire_date": _make_getter("thaiid_get_expire_date"),
    "address": _make_getter("thaiid_get_address"),
    "face_image": _make_getter("thaiid_get_face_image"),
    "laser_id": _make_getter("thaiid_get_laser_id"),
    "main_inscl": _make_getter("thaiid_get_main_inscl"),
    "sub_inscl": _make_getter("thaiid_get_sub_inscl"),
    "main_hospital": _make_getter("thaiid_get_main_hospital"),
    "sub_hospital": _make_getter("thaiid_get_sub_hospital"),
    "paid_type": _make_getter("thaiid_get_paid_type"),
    "nhso_issue_date": _make_getter("thaiid_get_nhso_issue_date"),
    "nhso_expire_date": _make_getter("thaiid_get_nhso_expire_date"),
    "nhso_update_date": _make_getter("thaiid_get_nhso_update_date"),
    "change_hospital_amount": _make_getter(
        "thaiid_get_change_hospital_amount"
    ),
}


def read_card(
    reader_name: str | None = None,
    show_face: bool = True,
    show_nhso: bool = True,
    show_laser: bool = False,
) -> dict | None:
    """Read a Thai National ID smart card and return the data as a dict."""

    reader_c = reader_name.encode("utf-8") if reader_name else None
    handle = lib.thaiid_read(
        reader_c, int(show_face), int(show_nhso), int(show_laser)
    )

    if not handle:
        err = lib.thaiid_get_last_error()
        raise RuntimeError(err.decode("utf-8") if err else "Unknown error")

    try:
        data = {}
        for key, getter in GETTERS.items():
            val = getter(handle)
            data[key] = val.decode("utf-8") if val else ""
        return data
    finally:
        lib.thaiid_free(handle)


# ---------------------------------------------------------------------------
# Pretty-print
# ---------------------------------------------------------------------------


def print_card(data: dict):
    def field(label: str, key: str):
        val = data.get(key, "")
        print(f"  {label:<20} {val}")

    print("\n=== Personal Information ===")
    field("CID:", "cid")
    field("Name (TH):", "name_thai")
    field("Name (EN):", "name_en")
    field("DOB:", "dob")
    field("Gender:", "gender")
    field("Card Issuer:", "card_issuer")
    field("Issue Date:", "issue_date")
    field("Expire Date:", "expire_date")
    field("Address:", "address")

    face = data.get("face_image", "")
    if face:
        print(f"  {'Face Image:':<20} [{len(face)} bytes base64]")

    laser = data.get("laser_id", "")
    if laser:
        print("\n=== Card Info ===")
        field("Laser ID:", "laser_id")

    inscl = data.get("main_inscl", "")
    if inscl:
        print("\n=== NHSO Information ===")
        field("Main Inscl:", "main_inscl")
        field("Sub Inscl:", "sub_inscl")
        field("Main Hosp:", "main_hospital")
        field("Sub Hosp:", "sub_hospital")
        field("Paid Type:", "paid_type")
        field("NHSO Issue:", "nhso_issue_date")
        field("NHSO Expire:", "nhso_expire_date")
        field("NHSO Update:", "nhso_update_date")
        field("Change Hosp:", "change_hospital_amount")


# ---------------------------------------------------------------------------
# Main
# ---------------------------------------------------------------------------

if __name__ == "__main__":
    reader = sys.argv[1] if len(sys.argv) > 1 else None

    print(f"Using library: {find_library()}")
    print(f"Reader:        {reader or '(auto-detect)'}")
    print("Waiting for card...")

    try:
        data = read_card(reader)
        print_card(data)
        print("\nDone.")
    except Exception as e:
        print(f"Error: {e}", file=sys.stderr)
        sys.exit(1)