HSM Command Console

Overview

The HSM Command Console acts as a client that talks to an HSM's host interface. It packs your command payload with the vendor's framing (length header, STX/ETX, etc.), sends it over the socket, and shows the raw request/response exchange. Point it at ISO8583Studio's own HSM Simulator or at a physical device on your bench.

Quick Start

1. Create a console configuration — From the Home screen open HSM Host Console and add a new configuration.
2. Pick your HSM vendor — In Connection Settings, choose the HSM Type. The port and framing default to that vendor (e.g. Thales payShield → port 1500, 2-byte binary length).
3. Set the address — Enter the HSM's IP Address and Port, and a connection Timeout.
4. (Optional) Enable TLS — In SSL/TLS Configuration turn on TLS, choose the version and certificate-verification mode, and attach your CA / client certificate.
5. Launch and connect — Open the console and click Connect. The header dot turns green when the socket is up.
6. Send a command — In the Console tab select a command from the vendor set, fill its fields, and send. The response appears in the exchange log.

Supported HSM Vendors

Selecting a vendor sets its default port and message framing automatically. All vendors are driven over the same socket client.

Connection Settings

The Connection Settings configuration tab defines the transport to the HSM.

Message Framing

HSMs delimit messages differently. The console supports the common framing schemes; the correct one is selected when you pick a vendor, and can be overridden.

Additional framing fields: TCP Length Header Enabled toggle, Message Header (hex, e.g. 0000), Message Trailer (hex, optional), and Message Header Length.

SSL / TLS Configuration

Enable encrypted transport to the HSM in the SSL/TLS Configuration tab.

Command Console Tab

The Console tab is the interactive workspace. Pick a host command from the active vendor's command set, populate its parameter fields, and send it. The request and the decoded response are appended to the exchange log with response codes and timing.

• Vendor command set — the available commands follow the selected HSM vendor (for Thales, the full payShield host-command set).
• Field editor — each command exposes its parameters as labelled inputs so you don't hand-assemble the payload.
• Send & inspect — responses are shown raw and parsed; errors surface the HSM's response/error code.

Scenario Builder Tab

A scenario is an ordered list of command steps — each step captures a commandCode and its field values. Build a sequence (for example: generate a key, export it under a ZMK, then translate a PIN block), name it, and save it into the configuration for reuse.

• Steps — add, reorder, and edit command steps; values from earlier steps can feed later ones.
• Saved scenarios — persisted with the configuration and available to both the console and the load tester.
• Playlists — group custom text, single commands, and whole scenarios into a runnable playlist with optional auto-advance.

Load Testing Tab

Drive a saved scenario against the HSM to measure throughput and stability. Configure it in the Load Test Settings tab and run it from the Load Test tab.

Logs Tab

The Logs tab streams every exchange — request, response, connection events — with timestamps. Clear the buffer, and see live connection count and byte counters. Global logging can be toggled in app settings.

Tabs Reference