Lua SDK

The Lua account client is in lua/auth.lua in mesgd-sdk. Use it to enroll an account, obtain a session, and manage public keys independently of the PKI layer. The examples use an existing account named alice; passwords and authenticator codes come from the application rather than literals in source.

Support status

The account adapter is available, but a built-in HTTPS transport is still pending. The transport argument in the examples is application code, not a missing SDK constructor.

Completeness position: 16 of 18. Tested account adapter; native HTTPS and interoperable JWK/PKI support remain pending. The language matrix explains the ranking criteria and comparable tiers. WSS readiness is listed separately; no SDK currently provides a complete, validated encrypted messaging workflow against this server.

Setup and transport

Load the account module with require('auth') from the SDK's Lua directory, or add that directory to package.path. JSON serialization and HTTPS are provided by the application, so the auth module does not require a specific HTTP library.

Auth.new takes a function (method, path, body, token) -> status, decoded_object. The JSON encoder must preserve public_keys as an array, including an empty array; Lua's empty table alone does not distinguish an array from an object.

A custom transport must serialize JSON, attach Authorization: Bearer TOKEN only when a token is supplied, verify the certificate and hostname, reject redirects, and use a finite timeout. Its origin is an HTTPS URL, such as https://mesgd.example.com, rather than a WebSocket URL.

Log in, read keys, and log out

Pass the current authenticator code as a six-digit string, preserving leading zeroes. This example reads the account's published keys and ends the session on its successful path. Applications that retain a session can keep the bearer until logout or expiry instead.

local Auth = require('auth')

local function read_keys(transport, password, otp)
  local client = Auth.new(transport)
  local session = client:login('alice', password, otp)
  local token = session.access_token
  local keys = client:keys(token)
  client:logout(token)
  return keys.public_keys
end

Methods return decoded Lua tables. HTTP failures raise a table with status and message; invalid input triggers assertions. The Lua PKI implementation is still being rewritten and does not have the shared protocol guarantees of the tested implementations.

Enroll a new account

The following fragment uses an existing client or transport from the example above. Signup returns a pending enrollment. Display qr_png_base64 or otpauth_uri, let the person configure the authenticator, then collect a code to confirm it. These calls are separate application steps, with user interaction between them.

local enrollment = client:signup('alice', 'alice@example.com', password, {})
-- Display enrollment before collecting enrollment_otp.
local session = client:confirm('alice', enrollment.enrollment_token, enrollment_otp)
local recovery_codes = session.recovery_codes

Confirmation returns the first session and eight recovery codes. Display the recovery codes for separate safekeeping. A code accepted for confirmation cannot be reused for login or a key update; wait for a new authenticator step before another operation that consumes a code.

Account operations

A key update takes the session token, current password, a fresh authenticator code, and an array containing only public JWKs. An empty array clears the linked keys. A password reset takes the username, a saved recovery code, a new password, and a fresh authenticator code; success replaces the recovery codes and revokes existing sessions without returning a new session.

The shared authentication reference documents argument order, response fields, and transport behavior. Session refresh is available through the HTTP API but is not wrapped by these seven SDK operations.

Message connections

The Lua ping/pong sample requires a mesgd module that is absent from this checkout. The account adapter remains usable with an application-supplied HTTPS transport.

Account login does not establish a message connection. The current server accepts JSON WebSocket frames and can authenticate an upgrade with a login session or an issued grant token. Login sessions carry identity without path restrictions; grants limit routing to assigned patterns. See WebSocket and Routing.

The encrypted registration handshake in the ping/pong samples is not implemented by the current mesgd listener. Treat those samples as experimental cryptographic examples, with compatibility limits described in Samples.

Validation

From the mesgd-sdk repository root, run the account contract suite for this language:

python3 tests/test_auth.py --language lua

This is an offline request-contract check. Missing toolchains are reported as skips. See Languages for live HTTPS and PKI test coverage.