diff --git a/Makefile b/Makefile index 03b9cea..85bd6e4 100644 --- a/Makefile +++ b/Makefile @@ -62,6 +62,12 @@ QR_WRAP := src/qr/qr.c # FPU-less 68000 (quirc's identify geometry is float-heavy; the pair is what its # docs recommend, and avoids slow double soft-float via rintf/sqrtf/fabsf). QR_CPPFLAGS := -Isrc/qr -DQUIRC_FLOAT_TYPE=float -DQUIRC_USE_TGMATH + +# --- Vendored QR encoder (qrcodegen, MIT) + our portable wrapper ------------ +# qrcodegen is third-party (warnings off, same reasoning as quirc above); it's +# integer-only so no float flags are needed. Reuses the qr-host/qr-m68k object +# pattern rules below (they match any src/qr/%.c, qrcodegen.c included). +QRENC_WRAP := src/qr/qrencode.c DIFF_SRCS := tests/diff/diff_main.c # AmigaOS-only front-end glue (bsdsocket SNTP, ...); m68k build only. qrimage.c # is GUI-only (datatypes.library) so it's excluded here and added to GUI_SRCS. @@ -80,6 +86,10 @@ BUILD := build QUIRC_HOST_OBJS := $(patsubst src/qr/%.c,$(BUILD)/qr-host/%.o,$(QUIRC_SRCS)) QUIRC_M68K_OBJS := $(patsubst src/qr/%.c,$(BUILD)/qr-m68k/%.o,$(QUIRC_SRCS)) +# Object paths for the vendored qrcodegen encoder (same qr-host/qr-m68k rules). +QRCODEGEN_HOST_OBJ := $(BUILD)/qr-host/qrcodegen.o +QRCODEGEN_M68K_OBJ := $(BUILD)/qr-m68k/qrcodegen.o + .PHONY: all test cli smoke diff m68k m68k-docker gui gui-docker gui-smoke qr-onhw qr-onhw-docker qr-onhw-smoke serialtest-m68k serialtest-m68k-docker copperline-smoke pbkdf2-bench asm-bench amissl-bench clean all: test cli @@ -89,9 +99,10 @@ test: $(BUILD)/run-tests VAULT_TEST_FILE=$(BUILD)/amiauth-test.vault \ AMIAUTH_PREFS_DIR=$(BUILD)/prefs-test $(BUILD)/run-tests -$(BUILD)/run-tests: $(CORE_SRCS) $(TEST_SRCS) $(QR_WRAP) $(QUIRC_HOST_OBJS) | $(BUILD) +$(BUILD)/run-tests: $(CORE_SRCS) $(TEST_SRCS) $(QR_WRAP) $(QUIRC_HOST_OBJS) $(QRENC_WRAP) $(QRCODEGEN_HOST_OBJ) | $(BUILD) $(CC) $(CFLAGS) $(CObjINC) $(QR_CPPFLAGS) -Itests \ - $(CORE_SRCS) $(TEST_SRCS) $(QR_WRAP) $(QUIRC_HOST_OBJS) -o $@ + $(CORE_SRCS) $(TEST_SRCS) $(QR_WRAP) $(QUIRC_HOST_OBJS) \ + $(QRENC_WRAP) $(QRCODEGEN_HOST_OBJ) -o $@ # Vendored quirc objects — host toolchain, warnings suppressed (third-party). $(BUILD)/qr-host/%.o: src/qr/%.c | $(BUILD) @@ -100,11 +111,13 @@ $(BUILD)/qr-host/%.o: src/qr/%.c | $(BUILD) # --- Host: native CLI (for local development) --- # Named distinctly from the m68k 'AmiAuth' binary so the two don't collide on a -# case-insensitive filesystem (macOS). +# case-insensitive filesystem (macOS). Includes the QR encoder (#45's CLI QR +# command): our qrencode.c wrapper + the vendored qrcodegen object. cli: $(BUILD)/amiauth-host -$(BUILD)/amiauth-host: $(CORE_SRCS) $(CLI_SRCS) | $(BUILD) - $(CC) $(CFLAGS) $(CObjINC) $(CORE_SRCS) $(CLI_SRCS) -o $@ +$(BUILD)/amiauth-host: $(CORE_SRCS) $(CLI_SRCS) $(QRENC_WRAP) $(QRCODEGEN_HOST_OBJ) | $(BUILD) + $(CC) $(CFLAGS) $(CObjINC) -Isrc/qr $(CORE_SRCS) $(CLI_SRCS) \ + $(QRENC_WRAP) $(QRCODEGEN_HOST_OBJ) -o $@ # --- Host: end-to-end CLI smoke test (always-unlocked round trip) --- smoke: $(BUILD)/amiauth-host @@ -119,8 +132,11 @@ $(BUILD)/run-diff: $(CORE_SRCS) $(DIFF_SRCS) | $(BUILD) $(OPENSSL_LIBS) -o $@ # --- m68k: Amiga CLI binary (amiga-gcc on PATH) --- -m68k: | $(BUILD) - $(M68K_CC) $(M68K_CFLAGS) $(CORE_SRCS) $(ASM_SRCS) $(AMIGA_SRCS) $(CLI_SRCS) -o $(BUILD)/AmiAuth +# Includes the QR encoder (#45's CLI QR command): see the qr-m68k object rule +# below (shared with the GUI's decoder build). +m68k: $(QRCODEGEN_M68K_OBJ) | $(BUILD) + $(M68K_CC) $(M68K_CFLAGS) -Isrc/qr $(CORE_SRCS) $(ASM_SRCS) $(AMIGA_SRCS) $(CLI_SRCS) \ + $(QRENC_WRAP) $(QRCODEGEN_M68K_OBJ) -o $(BUILD)/AmiAuth # --- m68k: ReAction GUI binary (Amiga only; needs intuition + ReAction classes) --- # Includes the QR decoder: qrimage.c (datatypes glue) + our qr.c wrapper + the @@ -132,9 +148,9 @@ $(BUILD)/qr-m68k/%.o: src/qr/%.c | $(BUILD) @mkdir -p $(BUILD)/qr-m68k $(M68K_CC) -std=c99 -O2 -m68000 -noixemul -w $(QR_CPPFLAGS) -c $< -o $@ -gui: $(QUIRC_M68K_OBJS) | $(BUILD) +gui: $(QUIRC_M68K_OBJS) $(QRCODEGEN_M68K_OBJ) | $(BUILD) $(M68K_CC) $(M68K_CFLAGS) $(VERSION_DEFS) $(QR_CPPFLAGS) $(CORE_SRCS) $(ASM_SRCS) $(AMIGA_SRCS) $(GUI_SRCS) \ - $(QR_WRAP) $(QUIRC_M68K_OBJS) -lm -lamiga -o $(BUILD)/AmiAuthGUI + $(QR_WRAP) $(QUIRC_M68K_OBJS) $(QRENC_WRAP) $(QRCODEGEN_M68K_OBJ) -lm -lamiga -o $(BUILD)/AmiAuthGUI gui-docker: $(DOCKER) run --rm --platform linux/amd64 $(DOCKER_USER) -v "$(CURDIR)":/work -w /work \ diff --git a/THIRDPARTY.md b/THIRDPARTY.md index 14edb47..b4b4f5e 100644 --- a/THIRDPARTY.md +++ b/THIRDPARTY.md @@ -2,7 +2,7 @@ AmiAuth ships zero *mandatory runtime* dependencies: everything it needs is either an AmigaOS-standard shared library or compiled into the binary from -source in this repository. The only vendored third-party source is: +source in this repository. The vendored third-party source is: ## quirc — QR-code recognition library @@ -23,3 +23,22 @@ no dependencies of its own (standard C only) and is built with of the program uses. Its ISC licence text is preserved verbatim in every vendored source file. + +## qrcodegen — QR-code generation library + +- **Location:** [`src/qr/`](src/qr/) (`qrcodegen.h`, `qrcodegen.c`) +- **Upstream:** https://github.com/nayuki/QR-Code-generator (the `c/` + subdirectory), pinned to commit `2c9044de6b049ca25cb3cd1649ed7e27aa055138`. + Actively maintained, so unlike quirc no fork is tracked for this one. +- **Author:** Project Nayuki +- **License:** MIT (permissive; compatible with AmiAuth's BSD 2-Clause) + +Used by the GUI and CLI to render an account's `otpauth://` URI as a QR code +for export (#45) — the encode-side counterpart to quirc's decode. It has no +dependencies of its own (standard C only), does no dynamic allocation (every +buffer is caller-supplied), and is integer-only (no floating point), so it +needs no special build flags for the plain-68000 target. The wrapper in +[`src/qr/qrencode.c`](src/qr/qrencode.c) (AmiAuth's own code) is the only +interface the rest of the program uses. + +Its MIT licence text is preserved verbatim in every vendored source file. diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 6fb23ab..87f62dc 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -64,7 +64,7 @@ Resolves corrected UTC without touching the system clock (full design in ## Front-ends - **CLI** — no GUI dependency at all; retains full code-generation on OS 2.x and - floppy-booted machines. Commands: `CODE`, `INIT`, `ADD`, `LIST`, `GET`, + floppy-booted machines. Commands: `CODE`, `INIT`, `ADD`, `LIST`, `GET`, `QR`, `REMOVE`, `SHOW`, `CLOCK`, `SYNC`, `OFFSET`. Amiga-only front-end glue (bsdsocket SNTP, entropy, the GUI-forward client, ...) lives in `src/amiga/` and is linked into the m68k build only; the host build stubs it. When a GUI is resident the @@ -73,9 +73,12 @@ Resolves corrected UTC without touching the system clock (full design in - **GUI (ClassAct/ReAction)** — a multi-column `listbrowser.gadget` (all accounts with live codes + countdown), a large selected-code display, a `fuelgauge.gadget` countdown, add / remove / edit, clipboard copy (iffparse - FTXT, auto-clear), the clock-status LED, and **QR-image import** (decode an + FTXT, auto-clear), the clock-status LED, **QR-image import** (decode an `otpauth://` QR from an image file via `datatypes.library` + a vendored quirc - decoder in `src/qr/`). Uses only classes common to ClassAct 3.3 and ReAction. + decoder in `src/qr/`) and **QR export** (render an account's `otpauth://` + URI as an on-screen QR code for a phone to scan, via a vendored qrcodegen + encoder also in `src/qr/`; CLI counterpart is `QR`, both share the encoder + and its ASCII-art renderer). Uses only classes common to ClassAct 3.3 and ReAction. - **Commodity shell** — runs resident via `commodities.library`: `CX_POPKEY` / `CX_POPUP` / `CX_PRIORITY` tooltypes, default hotkey `ctrl alt a`, window hides (not quits) on close, full Exchange integration (show/hide/enable/disable/kill), diff --git a/src/amiga/guiport.h b/src/amiga/guiport.h index ad3f7c5..8fc8072 100644 --- a/src/amiga/guiport.h +++ b/src/amiga/guiport.h @@ -25,8 +25,10 @@ enum { AAP_SHOW, /* pop the GUI window to the front */ AAP_ADD_SECRET, /* arg = "issuer\nlabel\nbase32secret" (bare-secret ADD; * issuer may be empty, the other two must not be) */ - AAP_ADD_SECRET_STEAM /* same arg shape; builds a Steam Guard account + AAP_ADD_SECRET_STEAM, /* same arg shape; builds a Steam Guard account * instead of an ordinary TOTP one (#44) */ + AAP_QR /* arg = account name; reply buf = ASCII-art QR of the + * account's otpauth:// URI (#45) */ }; /* Result codes (aar_Result / *result). */ @@ -36,7 +38,8 @@ enum { AAR_NOTFOUND, /* no account matched */ AAR_FULL, /* vault is full */ AAR_BADARG, /* e.g. not a valid otpauth:// URI */ - AAR_SAVEFAIL /* mutation applied in memory but the re-save failed */ + AAR_SAVEFAIL, /* mutation applied in memory but the re-save failed */ + AAR_TOOLONG /* AAP_QR: the URI doesn't fit even at the QR version cap */ }; /* Try to forward a command to a resident GUI. Returns 0 if a GUI handled it diff --git a/src/cli/main.c b/src/cli/main.c index 539a0e1..dde7b2a 100644 --- a/src/cli/main.c +++ b/src/cli/main.c @@ -6,6 +6,7 @@ * ADD import an account * LIST list account names * GET print an account's current code + * QR print an ASCII-art QR code * REMOVE delete an account * HELP * @@ -29,6 +30,7 @@ #include "vault.h" #include "pbkdf2.h" #include "prefs.h" +#include "qrencode.h" /* qr_encode_uri/qr_render_ascii (#45) */ #if defined(__unix__) || defined(__APPLE__) || defined(__linux__) # include @@ -611,7 +613,10 @@ static int cmd_init(const char *path, int always_unlocked, long iterations, * the GUI handled it, or -1 if no GUI is running (do it locally). */ static int try_forward(int cmd, const char *arg) { - static char buf[2600]; /* off the ~4 KB shell stack; holds a LIST reply */ + /* Off the ~4 KB shell stack. Sized for the largest reply any forwarded + * command can produce: AAP_QR's ASCII-art render (QR_ENC_ASCII_BUF_LEN, + * ~11.9 KB) dwarfs LIST's "issuer:label\n" lines. */ + static char buf[QR_ENC_ASCII_BUF_LEN]; int result = AAR_OK; if (gui_forward(cmd, arg, buf, sizeof buf, &result) != 0) @@ -619,7 +624,7 @@ static int try_forward(int cmd, const char *arg) switch (result) { case AAR_OK: - if (buf[0]) fputs(buf, stdout); /* GET code / LIST names (with \n) */ + if (buf[0]) fputs(buf, stdout); /* GET code / LIST names / QR art */ return 0; case AAR_LOCKED: fprintf(stderr, "AmiAuth: the running GUI's vault is locked; " @@ -637,6 +642,9 @@ static int try_forward(int cmd, const char *arg) case AAR_SAVEFAIL: fprintf(stderr, "AmiAuth: applied in the GUI but the re-save failed\n"); return 2; + case AAR_TOOLONG: + fprintf(stderr, "AmiAuth: this account's URI is too long to encode as a QR code\n"); + return 2; default: fprintf(stderr, "AmiAuth: the running GUI could not handle that\n"); return 2; @@ -786,6 +794,36 @@ static int cmd_get(const char *path, const char *account) return 0; } +/* Print an account's otpauth:// URI as ASCII-art QR code (#45), for a phone + * to scan directly off a terminal. GUI counterpart: "Show QR code...". */ +static int cmd_qr(const char *path, const char *account) +{ + static vault v; /* ~19 KB: keep it off the (small, ~4 KB) AmigaShell stack */ + static char uri[512]; + static uint8_t modules[QR_ENC_MAX_MODULES * QR_ENC_MAX_MODULES]; + static char ascii[QR_ENC_ASCII_BUF_LEN]; + vault_result rc; + int idx, qsize; + int fc = try_forward(AAP_QR, account); + if (fc >= 0) return fc; + rc = open_vault(&v, path); + if (rc != VAULT_OK) { fprintf(stderr, "AmiAuth: %s\n", vault_err(rc)); return 2; } + idx = find_account(&v, account); + if (idx < 0) { vault_lock(&v); fprintf(stderr, "AmiAuth: no account matching '%s'\n", account); return 2; } + + if (otpauth_build(&v.accounts[idx], uri, sizeof uri) != 0 || + qr_encode_uri(uri, modules, &qsize) != QRENC_OK) { + vault_lock(&v); + fprintf(stderr, "AmiAuth: this account's URI is too long to encode as a QR code\n"); + return 2; + } + qr_render_ascii(modules, qsize, ascii, sizeof ascii); + fputs(ascii, stdout); + + vault_lock(&v); + return 0; +} + static int cmd_remove(const char *path, const char *account) { static vault v; /* ~19 KB: keep it off the (small, ~4 KB) AmigaShell stack */ @@ -822,6 +860,8 @@ static int usage(void) " add STEAM for a Steam Guard code)\n" " LIST List account names\n" " GET Print an account's code\n" + " QR Print an ASCII-art QR code\n" + " of the account (for a phone)\n" " REMOVE Delete an account\n" " SHOW Pop the running GUI to front\n" " CLOCK Show UTC offset + status\n" @@ -895,6 +935,7 @@ static int dispatch(const cli_args *a) } if (ci_streq(a->command, "LIST")) return cmd_list(vault); if (ci_streq(a->command, "GET")) return a->value ? cmd_get(vault, a->value) : usage(); + if (ci_streq(a->command, "QR")) return a->value ? cmd_qr(vault, a->value) : usage(); if (ci_streq(a->command, "REMOVE")) return a->value ? cmd_remove(vault, a->value) : usage(); if (ci_streq(a->command, "SHOW")) return cmd_show(); if (ci_streq(a->command, "CLOCK")) return cmd_clock(); diff --git a/src/core/base32.c b/src/core/base32.c index 86e4619..b517ea3 100644 --- a/src/core/base32.c +++ b/src/core/base32.c @@ -36,3 +36,30 @@ int base32_decode(const char *in, uint8_t *out, size_t outcap) /* Any leftover < 8 bits are padding and discarded. */ return (int)n; } + +int base32_encode(const uint8_t *in, size_t inlen, char *out, size_t outcap) +{ + static const char alphabet[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"; + uint32_t buf = 0; /* bit accumulator (MSB-first) */ + int bits = 0; /* valid bits currently in buf */ + size_t n = 0; + size_t i; + + if (!in || !out) return -1; + + for (i = 0; i < inlen; i++) { + buf = (buf << 8) | in[i]; + bits += 8; + while (bits >= 5) { + bits -= 5; + if (n + 1 >= outcap) return -1; /* leave room for the NUL */ + out[n++] = alphabet[(buf >> bits) & 0x1f]; + } + } + if (bits > 0) { + if (n + 1 >= outcap) return -1; + out[n++] = alphabet[(buf << (5 - bits)) & 0x1f]; + } + out[n] = '\0'; + return (int)n; +} diff --git a/src/core/base32.h b/src/core/base32.h index 4f0e339..6f166c3 100644 --- a/src/core/base32.h +++ b/src/core/base32.h @@ -1,4 +1,5 @@ -/* base32.h — RFC 4648 Base32 decode, tolerant of padding, whitespace and case. */ +/* base32.h — RFC 4648 Base32 encode/decode, tolerant of padding, whitespace + * and case on decode. */ #ifndef AMIAUTH_BASE32_H #define AMIAUTH_BASE32_H @@ -10,4 +11,10 @@ * invalid character or if the result would exceed `outcap`. */ int base32_decode(const char *in, uint8_t *out, size_t outcap); +/* Encode `inlen` bytes of `in` into `out` (capacity `outcap`), NUL-terminated. + * Uppercase RFC 4648 alphabet, no '=' padding (matches how services usually + * display a secret). Returns the number of characters written (excluding the + * NUL), or -1 if the result (plus NUL) would exceed `outcap`. */ +int base32_encode(const uint8_t *in, size_t inlen, char *out, size_t outcap); + #endif /* AMIAUTH_BASE32_H */ diff --git a/src/core/uri.c b/src/core/uri.c index 2872242..db09de2 100644 --- a/src/core/uri.c +++ b/src/core/uri.c @@ -3,6 +3,7 @@ * &period=...&counter=... * LABEL is "accountname" or "issuer:accountname", percent-encoded. * Validated against tests/test_uri.c. */ +#include #include #include @@ -79,6 +80,56 @@ static void copy_str(char *dst, size_t dstcap, const char *src) dst[i] = '\0'; } +/* Append `src` to *cur (advancing it and shrinking *remain), bounds-checked. + * Used to build a URI without ever risking an overflow. */ +static int str_append(char **cur, size_t *remain, const char *src) +{ + size_t len = strlen(src); + if (len >= *remain) return -1; + memcpy(*cur, src, len); + *cur += len; + *remain -= len; + return 0; +} + +/* Percent-encode src and append it (RFC 3986 unreserved set passes through + * unescaped; everything else becomes %XX). Inverse of url_decode(). */ +static int url_encode_append(char **cur, size_t *remain, const char *src) +{ + static const char hex[] = "0123456789ABCDEF"; + for (; *src; src++) { + unsigned char c = (unsigned char)*src; + int unreserved = (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') || + (c >= '0' && c <= '9') || + c == '-' || c == '.' || c == '_' || c == '~'; + if (unreserved) { + if (*remain < 2) return -1; /* this char + eventual NUL */ + *(*cur)++ = (char)c; + (*remain)--; + } else { + if (*remain < 4) return -1; /* %XX + eventual NUL */ + *(*cur)++ = '%'; + *(*cur)++ = hex[c >> 4]; + *(*cur)++ = hex[c & 0xf]; + *remain -= 3; + } + } + return 0; +} + +/* Manual decimal conversion: libnix's sprintf() can't be trusted with a + * uint64_t (no %llu), so the HOTP counter — the one field that can exceed 32 + * bits — gets its own portable formatter. buf must hold at least 21 bytes. */ +static void u64_to_str(uint64_t v, char *buf) +{ + char tmp[20]; + int i = 0, j = 0; + if (v == 0) { buf[0] = '0'; buf[1] = '\0'; return; } + while (v > 0) { tmp[i++] = (char)('0' + (int)(v % 10)); v /= 10; } + while (i > 0) buf[j++] = tmp[--i]; + buf[j] = '\0'; +} + int otpauth_parse(const char *uri, otp_account *out) { const char *p, *slash, *label_start, *label_end, *query; @@ -185,6 +236,73 @@ int otpauth_is_uri(const char *s) return s != NULL && ci_startswith(s, "otpauth://"); } +/* Build an otpauth:// URI from `a` (the inverse of otpauth_parse — see the + * grammar comment at the top of this file). Percent-encodes issuer/label + * separately and joins them with a literal ':', matching how real-world + * otpauth:// generators write the label rather than percent-encoding the + * whole "issuer:label" as one blob. Always emits algorithm=/digits= and + * period= (TOTP) or counter= (HOTP) explicitly rather than relying on + * otpauth_parse's defaults, so the URI is self-describing even if those + * defaults ever change. Steam accounts carry none of those three — Steam + * Guard isn't configurable and otpauth_parse ignores them for type=steam + * anyway. Returns 0 on success, -1 if `out` (capacity outcap) is too small + * or the secret fails to Base32-encode. */ +int otpauth_build(const otp_account *a, char *out, size_t outcap) +{ + char *cur = out; + size_t remain = outcap; + char secretb32[OTP_MAX_SECRET * 8 / 5 + 8]; + char numbuf[21]; /* fits any uint64_t decimal + NUL */ + int is_steam, is_hotp; + + if (!a || !out || outcap == 0) return -1; + out[0] = '\0'; + if (base32_encode(a->secret, a->secret_len, secretb32, sizeof(secretb32)) < 0) + return -1; + + is_steam = strcmp(a->type, "steam") == 0; + is_hotp = strcmp(a->type, "hotp") == 0; + + if (str_append(&cur, &remain, "otpauth://") != 0) return -1; + if (str_append(&cur, &remain, is_steam ? "steam" : is_hotp ? "hotp" : "totp") != 0) + return -1; + if (str_append(&cur, &remain, "/") != 0) return -1; + if (a->issuer[0]) { + if (url_encode_append(&cur, &remain, a->issuer) != 0) return -1; + if (str_append(&cur, &remain, ":") != 0) return -1; + } + if (url_encode_append(&cur, &remain, a->label) != 0) return -1; + + if (str_append(&cur, &remain, "?secret=") != 0) return -1; + if (str_append(&cur, &remain, secretb32) != 0) return -1; + if (a->issuer[0]) { + if (str_append(&cur, &remain, "&issuer=") != 0) return -1; + if (url_encode_append(&cur, &remain, a->issuer) != 0) return -1; + } + + if (!is_steam) { + if (str_append(&cur, &remain, "&algorithm=") != 0) return -1; + if (str_append(&cur, &remain, a->algorithm) != 0) return -1; + + sprintf(numbuf, "%lu", (unsigned long)a->digits); /* small value: safe */ + if (str_append(&cur, &remain, "&digits=") != 0) return -1; + if (str_append(&cur, &remain, numbuf) != 0) return -1; + + if (is_hotp) { + u64_to_str(a->counter, numbuf); + if (str_append(&cur, &remain, "&counter=") != 0) return -1; + if (str_append(&cur, &remain, numbuf) != 0) return -1; + } else { + sprintf(numbuf, "%lu", (unsigned long)a->period); + if (str_append(&cur, &remain, "&period=") != 0) return -1; + if (str_append(&cur, &remain, numbuf) != 0) return -1; + } + } + + *cur = '\0'; + return 0; +} + static int account_from_secret(const char *issuer, const char *label, const char *secret_b32, otp_account *out) { diff --git a/src/core/uri.h b/src/core/uri.h index 4fa8e71..ca989e0 100644 --- a/src/core/uri.h +++ b/src/core/uri.h @@ -34,6 +34,11 @@ int otpauth_parse(const char *uri, otp_account *out); * to route add-account input between URI parsing and the bare-secret path. */ int otpauth_is_uri(const char *s); +/* Build an otpauth:// URI from `a` — the inverse of otpauth_parse(), for QR + * export (#45). Returns 0 on success, -1 if `out` (capacity outcap) is too + * small. See uri.c for the exact grammar/encoding rules. */ +int otpauth_build(const otp_account *a, char *out, size_t outcap); + /* Build an account directly from a bare Base32 secret, with the defaults * nearly every service issues (TOTP, SHA-1, 6 digits, 30 s) — the shortcut * for services that show only the raw secret, no URI. `label` must be diff --git a/src/gui/main.c b/src/gui/main.c index d0e73ef..f59d1a3 100644 --- a/src/gui/main.c +++ b/src/gui/main.c @@ -63,6 +63,8 @@ #include "prefs.h" #include "entropy.h" /* amiga_random (m68k build) */ #include "qr.h" /* qr_decode_gray (portable QR decoder) */ +#include "qrencode.h" /* qr_encode_uri (#45, QR export) */ +#include "uri.h" /* otpauth_build (#45, QR export) */ #include "pbkdf2.h" /* first-run KDF calibration probe */ #include "../version.h" @@ -153,7 +155,7 @@ enum { PWID_OK = 1, PWID_CANCEL, PWID_STR }; /* modal-requester gadgets */ enum { EDID_ISSUER = 1, EDID_LABEL, EDID_DIGITS, EDID_PERIOD, EDID_OK, EDID_CANCEL }; /* edit form */ /* menu / button command ids */ -enum { CMD_ADD_CLIP = 1, CMD_ADD_TYPE, CMD_ADD_QR, CMD_EDIT, CMD_COPY, CMD_REMOVE, CMD_QUIT }; +enum { CMD_ADD_CLIP = 1, CMD_ADD_TYPE, CMD_ADD_QR, CMD_EDIT, CMD_COPY, CMD_SHOW_QR, CMD_REMOVE, CMD_QUIT }; /* Commodity hotkey id (CxMsg id for the CX_POPKEY input event). */ #define EVT_HOTKEY 1 @@ -213,6 +215,7 @@ static struct NewMenu g_menu[] = { { NM_ITEM, (STRPTR)"Add from QR image...",(STRPTR)"I", 0, 0, (APTR)CMD_ADD_QR }, { NM_ITEM, (STRPTR)"Edit selected...", (STRPTR)"E", 0, 0, (APTR)CMD_EDIT }, { NM_ITEM, (STRPTR)"Copy code", (STRPTR)"C", 0, 0, (APTR)CMD_COPY }, + { NM_ITEM, (STRPTR)"Show QR code...", (STRPTR)"S", 0, 0, (APTR)CMD_SHOW_QR }, { NM_ITEM, NM_BARLABEL, NULL, 0, 0, NULL }, { NM_ITEM, (STRPTR)"Remove selected...", (STRPTR)"R", 0, 0, (APTR)CMD_REMOVE }, { NM_END, NULL, NULL, 0, 0, NULL } @@ -1280,6 +1283,134 @@ static int edit_request(otp_account *acct) return done == 1 ? 1 : 0; } +/* QR pixel scale: modules-per-pixel edge length. 4px keeps a version-15 (the + * encoder's cap, see qrencode.h) code at 308x308px -- comfortably scannable, + * reasonable on any classic screen. */ +#define QR_DISPLAY_SCALE 4 + +/* Paint the module grid into `qrobj`'s laid-out bounds within `win`'s + * RastPort, same technique as led_draw(): read the gadget's LeftEdge/TopEdge/ + * Width/Height once it's laid out, draw straight into the window (no imagery + * of its own). Safe to call repeatedly (e.g. on every event, to survive an + * expose window.class doesn't know to repaint for us). */ +static void qr_draw(struct Window *win, Object *qrobj, + const uint8_t *modules, int size) +{ + struct Gadget *g = (struct Gadget *)qrobj; + struct RastPort *rp = win->RPort; + LONG x0, y0, mx, my; + if (!GfxBase || !qrobj || size <= 0) return; + if (g->Width < size * QR_DISPLAY_SCALE || g->Height < size * QR_DISPLAY_SCALE) + return; /* not laid out yet */ + x0 = g->LeftEdge; + y0 = g->TopEdge; + SetAPen(rp, (ULONG)g_shinepen); /* light quiet zone / background */ + RectFill(rp, x0, y0, x0 + size * QR_DISPLAY_SCALE - 1, y0 + size * QR_DISPLAY_SCALE - 1); + SetAPen(rp, (ULONG)g_shadowpen); /* dark modules */ + for (my = 0; my < size; my++) { + for (mx = 0; mx < size; mx++) { + if (!modules[my * size + mx]) continue; + RectFill(rp, x0 + mx * QR_DISPLAY_SCALE, y0 + my * QR_DISPLAY_SCALE, + x0 + (mx + 1) * QR_DISPLAY_SCALE - 1, y0 + (my + 1) * QR_DISPLAY_SCALE - 1); + } + } +} + +/* Show `acct`'s otpauth:// URI as an on-screen QR code for a phone to scan + * (#45, the export counterpart to "Add from QR image..."). Pure display: a + * Close gadget (top-left, standard) is the only way out, no OK/Cancel -- + * there is nothing to confirm. Returns once the window is dismissed. + * + * The encode itself (qr_encode_uri) can take a noticeable moment on real + * 68k hardware - confirmed on-target via Copperline - which is exactly why + * qrencode.c fixes the mask instead of using qrcodegen_Mask_AUTO's 8-way + * search; do not reintroduce AUTO here without re-measuring on real/emulated + * 68k, not just the host build (host is fast enough to hide the cost). */ +static void qr_display(struct Window *parent, const otp_account *acct) +{ + static uint8_t modules[QR_ENC_MAX_MODULES * QR_ENC_MAX_MODULES]; + static char uri[512]; + static char title[OTP_MAX_ISSUER + OTP_MAX_LABEL + 32]; + Object *win, *layoutobj, *qrobj; + struct Window *w; + ULONG sig = 0; + int size = 0; + int done = -1; + + if (otpauth_build(acct, uri, sizeof(uri)) != 0) { + gui_requester(parent, "Could not build a QR code for this account.", "OK", NULL); + return; + } + if (qr_encode_uri(uri, modules, &size) != QRENC_OK) { + gui_requester(parent, + "This account's URI is too long to encode as a QR code.", "OK", NULL); + return; + } + + if (acct->issuer[0]) sprintf(title, "AmiAuth - QR: %s:%s", acct->issuer, acct->label); + else sprintf(title, "AmiAuth - QR: %s", acct->label); + + qrobj = NewObject(NULL, (STRPTR)"button.gadget", + GA_ReadOnly, TRUE, GA_Text, (ULONG)" ", TAG_END); + if (!qrobj) { + gui_requester(parent, "Could not build the QR display.", "OK", NULL); + return; + } + layoutobj = NewObject(LAYOUT_GetClass(), NULL, + LAYOUT_Orientation, LAYOUT_ORIENT_VERT, + LAYOUT_SpaceOuter, TRUE, + LAYOUT_AddChild, (ULONG)qrobj, + CHILD_MinWidth, size * QR_DISPLAY_SCALE, + CHILD_MinHeight, size * QR_DISPLAY_SCALE, + TAG_END); + if (!layoutobj) { + DisposeObject(qrobj); + gui_requester(parent, "Could not build the QR display.", "OK", NULL); + return; + } + win = NewObject(WINDOW_GetClass(), NULL, + WA_Title, (ULONG)title, + WA_Activate, TRUE, + WA_CloseGadget, TRUE, + WA_DragBar, TRUE, + WA_DepthGadget, TRUE, + WA_IDCMP, IDCMP_CLOSEWINDOW | IDCMP_VANILLAKEY, + WINDOW_Position, WPOS_CENTERSCREEN, + WINDOW_Layout, (ULONG)layoutobj, + TAG_END); + if (!win) { + DisposeObject(layoutobj); + gui_requester(parent, "Could not open the QR window.", "OK", NULL); + return; + } + + w = (struct Window *)DoMethod(win, WM_OPEN, NULL); + if (!w) { + DisposeObject(win); + gui_requester(parent, "Could not open the QR window.", "OK", NULL); + return; + } + GetAttr(WINDOW_SigMask, win, &sig); + + while (done < 0) { + ULONG got = Wait(sig | SIGBREAKF_CTRL_C); + ULONG r; + UWORD code; + if (got & SIGBREAKF_CTRL_C) { done = 0; break; } + while ((r = DoMethod(win, WM_HANDLEINPUT, (ULONG)&code)) != WMHI_LASTMSG) { + switch (r & WMHI_CLASSMASK) { + case WMHI_CLOSEWINDOW: done = 0; break; + case WMHI_VANILLAKEY: if (code == 0x1B) done = 0; break; + } + if (done >= 0) break; + } + qr_draw(w, qrobj, modules, size); /* survives expose; cheap to repeat */ + } + + DoMethod(win, WM_CLOSE, NULL); + DisposeObject(win); +} + /* Modal form asking for the Issuer/Label a bare secret doesn't carry (#83). * Both are required, matching the CLI's ISSUER/K LABEL/K. Returns 1 with the * fields filled, 0 on cancel. Needs string.gadget; returns 0 if unavailable. */ @@ -1944,6 +2075,24 @@ int main(int argc, char **argv) } break; } + case AAP_QR: { + int idx; + if (!v.unlocked) { req->aar_Result = AAR_LOCKED; break; } + idx = gui_find_account(&v, arg); + if (idx < 0) { req->aar_Result = AAR_NOTFOUND; break; } + { + static char qruri[512]; + static uint8_t qrmodules[QR_ENC_MAX_MODULES * QR_ENC_MAX_MODULES]; + int qrsize; + if (otpauth_build(&v.accounts[idx], qruri, sizeof qruri) != 0 || + qr_encode_uri(qruri, qrmodules, &qrsize) != QRENC_OK) { + req->aar_Result = AAR_TOOLONG; + break; + } + if (rb) qr_render_ascii(qrmodules, qrsize, rb, rbcap); + } + break; + } case AAP_ADD: { otp_account acct; if (!v.unlocked) req->aar_Result = AAR_LOCKED; @@ -2028,6 +2177,7 @@ int main(int argc, char **argv) ULONG result; UWORD code; int docopy = 0, doadd_clip = 0, doadd_type = 0, doadd_qr = 0, doedit = 0, doremove = 0; + int doshow_qr = 0; long donudge = 0; idle_secs = 0; /* any window input = activity */ while ((result = DoMethod(gw.winobj, WM_HANDLEINPUT, (ULONG)&code)) != WMHI_LASTMSG) { @@ -2069,6 +2219,7 @@ int main(int argc, char **argv) case CMD_ADD_QR: doadd_qr = 1; break; case CMD_EDIT: doedit = 1; break; case CMD_COPY: docopy = 1; break; + case CMD_SHOW_QR: doshow_qr = 1; break; case CMD_REMOVE: doremove = 1; break; case CMD_QUIT: running = 0; break; } @@ -2154,6 +2305,13 @@ int main(int argc, char **argv) memset(&acct, 0, sizeof acct); } + /* --- Show QR code (export, #45): the current account's URI as an + * on-screen code for a phone to scan --- */ + if (doshow_qr && v.count > 0) { + if (sel >= v.count) sel = 0; + qr_display(win, &v.accounts[sel]); + } + /* --- Remove selected (with confirmation) --- */ if (doremove && v.count > 0) { char name[OTP_MAX_ISSUER + OTP_MAX_LABEL + 2]; diff --git a/src/qr/qrcodegen.c b/src/qr/qrcodegen.c new file mode 100644 index 0000000..34f1002 --- /dev/null +++ b/src/qr/qrcodegen.c @@ -0,0 +1,1027 @@ +/* + * QR Code generator library (C) + * + * Copyright (c) Project Nayuki. (MIT License) + * https://www.nayuki.io/page/qr-code-generator-library + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * - The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * - The Software is provided "as is", without warranty of any kind, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. In no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the Software or the use or other dealings in the + * Software. + */ + +#include +#include +#include +#include +#include "qrcodegen.h" + +#ifndef QRCODEGEN_TEST + #define testable static // Keep functions private +#else + #define testable // Expose private functions +#endif + + +/*---- Forward declarations for private functions ----*/ + +// Regarding all public and private functions defined in this source file: +// - They require all pointer/array arguments to be not null unless the array length is zero. +// - They only read input scalar/array arguments, write to output pointer/array +// arguments, and return scalar values; they are "pure" functions. +// - They don't read mutable global variables or write to any global variables. +// - They don't perform I/O, read the clock, print to console, etc. +// - They allocate a small and constant amount of stack memory. +// - They don't allocate or free any memory on the heap. +// - They don't recurse or mutually recurse. All the code +// could be inlined into the top-level public functions. +// - They run in at most quadratic time with respect to input arguments. +// Most functions run in linear time, and some in constant time. +// There are no unbounded loops or non-obvious termination conditions. +// - They are completely thread-safe if the caller does not give the +// same writable buffer to concurrent calls to these functions. + +testable void appendBitsToBuffer(unsigned int val, int numBits, uint8_t buffer[], int *bitLen); + +testable void addEccAndInterleave(uint8_t data[], int version, enum qrcodegen_Ecc ecl, uint8_t result[]); +testable int getNumDataCodewords(int version, enum qrcodegen_Ecc ecl); +testable int getNumRawDataModules(int ver); + +testable void reedSolomonComputeDivisor(int degree, uint8_t result[]); +testable void reedSolomonComputeRemainder(const uint8_t data[], int dataLen, + const uint8_t generator[], int degree, uint8_t result[]); +testable uint8_t reedSolomonMultiply(uint8_t x, uint8_t y); + +testable void initializeFunctionModules(int version, uint8_t qrcode[]); +static void drawLightFunctionModules(uint8_t qrcode[], int version); +static void drawFormatBits(enum qrcodegen_Ecc ecl, enum qrcodegen_Mask mask, uint8_t qrcode[]); +testable int getAlignmentPatternPositions(int version, uint8_t result[7]); +static void fillRectangle(int left, int top, int width, int height, uint8_t qrcode[]); + +static void drawCodewords(const uint8_t data[], int dataLen, uint8_t qrcode[]); +static void applyMask(const uint8_t functionModules[], uint8_t qrcode[], enum qrcodegen_Mask mask); +static long getPenaltyScore(const uint8_t qrcode[]); +static int finderPenaltyCountPatterns(const int runHistory[7], int qrsize); +static int finderPenaltyTerminateAndCount(bool currentRunColor, int currentRunLength, int runHistory[7], int qrsize); +static void finderPenaltyAddHistory(int currentRunLength, int runHistory[7], int qrsize); + +testable bool getModuleBounded(const uint8_t qrcode[], int x, int y); +testable void setModuleBounded(uint8_t qrcode[], int x, int y, bool isDark); +testable void setModuleUnbounded(uint8_t qrcode[], int x, int y, bool isDark); +static bool getBit(int x, int i); + +testable int calcSegmentBitLength(enum qrcodegen_Mode mode, size_t numChars); +testable int getTotalBits(const struct qrcodegen_Segment segs[], size_t len, int version); +static int numCharCountBits(enum qrcodegen_Mode mode, int version); + + + +/*---- Private tables of constants ----*/ + +// The set of all legal characters in alphanumeric mode, where each character +// value maps to the index in the string. For checking text and encoding segments. +static const char *ALPHANUMERIC_CHARSET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:"; + +// Sentinel value for use in only some functions. +#define LENGTH_OVERFLOW -1 + +// For generating error correction codes. +testable const int8_t ECC_CODEWORDS_PER_BLOCK[4][41] = { + // Version: (note that index 0 is for padding, and is set to an illegal value) + //0, 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 Error correction level + {-1, 7, 10, 15, 20, 26, 18, 20, 24, 30, 18, 20, 24, 26, 30, 22, 24, 28, 30, 28, 28, 28, 28, 30, 30, 26, 28, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30}, // Low + {-1, 10, 16, 26, 18, 24, 16, 18, 22, 22, 26, 30, 22, 22, 24, 24, 28, 28, 26, 26, 26, 26, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28}, // Medium + {-1, 13, 22, 18, 26, 18, 24, 18, 22, 20, 24, 28, 26, 24, 20, 30, 24, 28, 28, 26, 30, 28, 30, 30, 30, 30, 28, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30}, // Quartile + {-1, 17, 28, 22, 16, 22, 28, 26, 26, 24, 28, 24, 28, 22, 24, 24, 30, 28, 28, 26, 28, 30, 24, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30, 30}, // High +}; + +#define qrcodegen_REED_SOLOMON_DEGREE_MAX 30 // Based on the table above + +// For generating error correction codes. +testable const int8_t NUM_ERROR_CORRECTION_BLOCKS[4][41] = { + // Version: (note that index 0 is for padding, and is set to an illegal value) + //0, 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 Error correction level + {-1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 4, 4, 4, 4, 4, 6, 6, 6, 6, 7, 8, 8, 9, 9, 10, 12, 12, 12, 13, 14, 15, 16, 17, 18, 19, 19, 20, 21, 22, 24, 25}, // Low + {-1, 1, 1, 1, 2, 2, 4, 4, 4, 5, 5, 5, 8, 9, 9, 10, 10, 11, 13, 14, 16, 17, 17, 18, 20, 21, 23, 25, 26, 28, 29, 31, 33, 35, 37, 38, 40, 43, 45, 47, 49}, // Medium + {-1, 1, 1, 2, 2, 4, 4, 6, 6, 8, 8, 8, 10, 12, 16, 12, 17, 16, 18, 21, 20, 23, 23, 25, 27, 29, 34, 34, 35, 38, 40, 43, 45, 48, 51, 53, 56, 59, 62, 65, 68}, // Quartile + {-1, 1, 1, 2, 4, 4, 4, 5, 6, 8, 8, 11, 11, 16, 16, 18, 16, 19, 21, 25, 25, 25, 34, 30, 32, 35, 37, 40, 42, 45, 48, 51, 54, 57, 60, 63, 66, 70, 74, 77, 81}, // High +}; + +// For automatic mask pattern selection. +static const int PENALTY_N1 = 3; +static const int PENALTY_N2 = 3; +static const int PENALTY_N3 = 40; +static const int PENALTY_N4 = 10; + + + +/*---- High-level QR Code encoding functions ----*/ + +// Public function - see documentation comment in header file. +bool qrcodegen_encodeText(const char *text, uint8_t tempBuffer[], uint8_t qrcode[], + enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl) { + + size_t textLen = strlen(text); + if (textLen == 0) + return qrcodegen_encodeSegmentsAdvanced(NULL, 0, ecl, minVersion, maxVersion, mask, boostEcl, tempBuffer, qrcode); + size_t bufLen = (size_t)qrcodegen_BUFFER_LEN_FOR_VERSION(maxVersion); + + struct qrcodegen_Segment seg; + if (qrcodegen_isNumeric(text)) { + if (qrcodegen_calcSegmentBufferSize(qrcodegen_Mode_NUMERIC, textLen) > bufLen) + goto fail; + seg = qrcodegen_makeNumeric(text, tempBuffer); + } else if (qrcodegen_isAlphanumeric(text)) { + if (qrcodegen_calcSegmentBufferSize(qrcodegen_Mode_ALPHANUMERIC, textLen) > bufLen) + goto fail; + seg = qrcodegen_makeAlphanumeric(text, tempBuffer); + } else { + if (textLen > bufLen) + goto fail; + for (size_t i = 0; i < textLen; i++) + tempBuffer[i] = (uint8_t)text[i]; + seg.mode = qrcodegen_Mode_BYTE; + seg.bitLength = calcSegmentBitLength(seg.mode, textLen); + if (seg.bitLength == LENGTH_OVERFLOW) + goto fail; + seg.numChars = (int)textLen; + seg.data = tempBuffer; + } + return qrcodegen_encodeSegmentsAdvanced(&seg, 1, ecl, minVersion, maxVersion, mask, boostEcl, tempBuffer, qrcode); + +fail: + qrcode[0] = 0; // Set size to invalid value for safety + return false; +} + + +// Public function - see documentation comment in header file. +bool qrcodegen_encodeBinary(uint8_t dataAndTemp[], size_t dataLen, uint8_t qrcode[], + enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl) { + + struct qrcodegen_Segment seg; + seg.mode = qrcodegen_Mode_BYTE; + seg.bitLength = calcSegmentBitLength(seg.mode, dataLen); + if (seg.bitLength == LENGTH_OVERFLOW) { + qrcode[0] = 0; // Set size to invalid value for safety + return false; + } + seg.numChars = (int)dataLen; + seg.data = dataAndTemp; + return qrcodegen_encodeSegmentsAdvanced(&seg, 1, ecl, minVersion, maxVersion, mask, boostEcl, dataAndTemp, qrcode); +} + + +// Appends the given number of low-order bits of the given value to the given byte-based +// bit buffer, increasing the bit length. Requires 0 <= numBits <= 16 and val < 2^numBits. +testable void appendBitsToBuffer(unsigned int val, int numBits, uint8_t buffer[], int *bitLen) { + assert(0 <= numBits && numBits <= 16 && (unsigned long)val >> numBits == 0); + for (int i = numBits - 1; i >= 0; i--, (*bitLen)++) + buffer[*bitLen >> 3] |= ((val >> i) & 1) << (7 - (*bitLen & 7)); +} + + + +/*---- Low-level QR Code encoding functions ----*/ + +// Public function - see documentation comment in header file. +bool qrcodegen_encodeSegments(const struct qrcodegen_Segment segs[], size_t len, + enum qrcodegen_Ecc ecl, uint8_t tempBuffer[], uint8_t qrcode[]) { + return qrcodegen_encodeSegmentsAdvanced(segs, len, ecl, + qrcodegen_VERSION_MIN, qrcodegen_VERSION_MAX, qrcodegen_Mask_AUTO, true, tempBuffer, qrcode); +} + + +// Public function - see documentation comment in header file. +bool qrcodegen_encodeSegmentsAdvanced(const struct qrcodegen_Segment segs[], size_t len, enum qrcodegen_Ecc ecl, + int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl, uint8_t tempBuffer[], uint8_t qrcode[]) { + assert(segs != NULL || len == 0); + assert(qrcodegen_VERSION_MIN <= minVersion && minVersion <= maxVersion && maxVersion <= qrcodegen_VERSION_MAX); + assert(0 <= (int)ecl && (int)ecl <= 3 && -1 <= (int)mask && (int)mask <= 7); + + // Find the minimal version number to use + int version, dataUsedBits; + for (version = minVersion; ; version++) { + int dataCapacityBits = getNumDataCodewords(version, ecl) * 8; // Number of data bits available + dataUsedBits = getTotalBits(segs, len, version); + if (dataUsedBits != LENGTH_OVERFLOW && dataUsedBits <= dataCapacityBits) + break; // This version number is found to be suitable + if (version >= maxVersion) { // All versions in the range could not fit the given data + qrcode[0] = 0; // Set size to invalid value for safety + return false; + } + } + assert(dataUsedBits != LENGTH_OVERFLOW); + + // Increase the error correction level while the data still fits in the current version number + for (int i = (int)qrcodegen_Ecc_MEDIUM; i <= (int)qrcodegen_Ecc_HIGH; i++) { // From low to high + if (boostEcl && dataUsedBits <= getNumDataCodewords(version, (enum qrcodegen_Ecc)i) * 8) + ecl = (enum qrcodegen_Ecc)i; + } + + // Concatenate all segments to create the data bit string + memset(qrcode, 0, (size_t)qrcodegen_BUFFER_LEN_FOR_VERSION(version) * sizeof(qrcode[0])); + int bitLen = 0; + for (size_t i = 0; i < len; i++) { + const struct qrcodegen_Segment *seg = &segs[i]; + appendBitsToBuffer((unsigned int)seg->mode, 4, qrcode, &bitLen); + appendBitsToBuffer((unsigned int)seg->numChars, numCharCountBits(seg->mode, version), qrcode, &bitLen); + for (int j = 0; j < seg->bitLength; j++) { + int bit = (seg->data[j >> 3] >> (7 - (j & 7))) & 1; + appendBitsToBuffer((unsigned int)bit, 1, qrcode, &bitLen); + } + } + assert(bitLen == dataUsedBits); + + // Add terminator and pad up to a byte if applicable + int dataCapacityBits = getNumDataCodewords(version, ecl) * 8; + assert(bitLen <= dataCapacityBits); + int terminatorBits = dataCapacityBits - bitLen; + if (terminatorBits > 4) + terminatorBits = 4; + appendBitsToBuffer(0, terminatorBits, qrcode, &bitLen); + appendBitsToBuffer(0, (8 - bitLen % 8) % 8, qrcode, &bitLen); + assert(bitLen % 8 == 0); + + // Pad with alternating bytes until data capacity is reached + for (uint8_t padByte = 0xEC; bitLen < dataCapacityBits; padByte ^= 0xEC ^ 0x11) + appendBitsToBuffer(padByte, 8, qrcode, &bitLen); + + // Compute ECC, draw modules + addEccAndInterleave(qrcode, version, ecl, tempBuffer); + initializeFunctionModules(version, qrcode); + drawCodewords(tempBuffer, getNumRawDataModules(version) / 8, qrcode); + drawLightFunctionModules(qrcode, version); + initializeFunctionModules(version, tempBuffer); + + // Do masking + if (mask == qrcodegen_Mask_AUTO) { // Automatically choose best mask + long minPenalty = LONG_MAX; + for (int i = 0; i < 8; i++) { + enum qrcodegen_Mask msk = (enum qrcodegen_Mask)i; + applyMask(tempBuffer, qrcode, msk); + drawFormatBits(ecl, msk, qrcode); + long penalty = getPenaltyScore(qrcode); + if (penalty < minPenalty) { + mask = msk; + minPenalty = penalty; + } + applyMask(tempBuffer, qrcode, msk); // Undoes the mask due to XOR + } + } + assert(0 <= (int)mask && (int)mask <= 7); + applyMask(tempBuffer, qrcode, mask); // Apply the final choice of mask + drawFormatBits(ecl, mask, qrcode); // Overwrite old format bits + return true; +} + + + +/*---- Error correction code generation functions ----*/ + +// Appends error correction bytes to each block of the given data array, then interleaves +// bytes from the blocks and stores them in the result array. data[0 : dataLen] contains +// the input data. data[dataLen : rawCodewords] is used as a temporary work area and will +// be clobbered by this function. The final answer is stored in result[0 : rawCodewords]. +testable void addEccAndInterleave(uint8_t data[], int version, enum qrcodegen_Ecc ecl, uint8_t result[]) { + // Calculate parameter numbers + assert(0 <= (int)ecl && (int)ecl < 4 && qrcodegen_VERSION_MIN <= version && version <= qrcodegen_VERSION_MAX); + int numBlocks = NUM_ERROR_CORRECTION_BLOCKS[(int)ecl][version]; + int blockEccLen = ECC_CODEWORDS_PER_BLOCK [(int)ecl][version]; + int rawCodewords = getNumRawDataModules(version) / 8; + int dataLen = getNumDataCodewords(version, ecl); + int numShortBlocks = numBlocks - rawCodewords % numBlocks; + int shortBlockDataLen = rawCodewords / numBlocks - blockEccLen; + + // Split data into blocks, calculate ECC, and interleave + // (not concatenate) the bytes into a single sequence + uint8_t rsdiv[qrcodegen_REED_SOLOMON_DEGREE_MAX]; + reedSolomonComputeDivisor(blockEccLen, rsdiv); + const uint8_t *dat = data; + for (int i = 0; i < numBlocks; i++) { + int datLen = shortBlockDataLen + (i < numShortBlocks ? 0 : 1); + uint8_t *ecc = &data[dataLen]; // Temporary storage + reedSolomonComputeRemainder(dat, datLen, rsdiv, blockEccLen, ecc); + for (int j = 0, k = i; j < datLen; j++, k += numBlocks) { // Copy data + if (j == shortBlockDataLen) + k -= numShortBlocks; + result[k] = dat[j]; + } + for (int j = 0, k = dataLen + i; j < blockEccLen; j++, k += numBlocks) // Copy ECC + result[k] = ecc[j]; + dat += datLen; + } +} + + +// Returns the number of 8-bit codewords that can be used for storing data (not ECC), +// for the given version number and error correction level. The result is in the range [9, 2956]. +testable int getNumDataCodewords(int version, enum qrcodegen_Ecc ecl) { + int v = version, e = (int)ecl; + assert(0 <= e && e < 4); + return getNumRawDataModules(v) / 8 + - ECC_CODEWORDS_PER_BLOCK [e][v] + * NUM_ERROR_CORRECTION_BLOCKS[e][v]; +} + + +// Returns the number of data bits that can be stored in a QR Code of the given version number, after +// all function modules are excluded. This includes remainder bits, so it might not be a multiple of 8. +// The result is in the range [208, 29648]. This could be implemented as a 40-entry lookup table. +testable int getNumRawDataModules(int ver) { + assert(qrcodegen_VERSION_MIN <= ver && ver <= qrcodegen_VERSION_MAX); + int result = (16 * ver + 128) * ver + 64; + if (ver >= 2) { + int numAlign = ver / 7 + 2; + result -= (25 * numAlign - 10) * numAlign - 55; + if (ver >= 7) + result -= 36; + } + assert(208 <= result && result <= 29648); + return result; +} + + + +/*---- Reed-Solomon ECC generator functions ----*/ + +// Computes a Reed-Solomon ECC generator polynomial for the given degree, storing in result[0 : degree]. +// This could be implemented as a lookup table over all possible parameter values, instead of as an algorithm. +testable void reedSolomonComputeDivisor(int degree, uint8_t result[]) { + assert(1 <= degree && degree <= qrcodegen_REED_SOLOMON_DEGREE_MAX); + // Polynomial coefficients are stored from highest to lowest power, excluding the leading term which is always 1. + // For example the polynomial x^3 + 255x^2 + 8x + 93 is stored as the uint8 array {255, 8, 93}. + memset(result, 0, (size_t)degree * sizeof(result[0])); + result[degree - 1] = 1; // Start off with the monomial x^0 + + // Compute the product polynomial (x - r^0) * (x - r^1) * (x - r^2) * ... * (x - r^{degree-1}), + // drop the highest monomial term which is always 1x^degree. + // Note that r = 0x02, which is a generator element of this field GF(2^8/0x11D). + uint8_t root = 1; + for (int i = 0; i < degree; i++) { + // Multiply the current product by (x - r^i) + for (int j = 0; j < degree; j++) { + result[j] = reedSolomonMultiply(result[j], root); + if (j + 1 < degree) + result[j] ^= result[j + 1]; + } + root = reedSolomonMultiply(root, 0x02); + } +} + + +// Computes the Reed-Solomon error correction codeword for the given data and divisor polynomials. +// The remainder when data[0 : dataLen] is divided by divisor[0 : degree] is stored in result[0 : degree]. +// All polynomials are in big endian, and the generator has an implicit leading 1 term. +testable void reedSolomonComputeRemainder(const uint8_t data[], int dataLen, + const uint8_t generator[], int degree, uint8_t result[]) { + assert(1 <= degree && degree <= qrcodegen_REED_SOLOMON_DEGREE_MAX); + memset(result, 0, (size_t)degree * sizeof(result[0])); + for (int i = 0; i < dataLen; i++) { // Polynomial division + uint8_t factor = data[i] ^ result[0]; + memmove(&result[0], &result[1], (size_t)(degree - 1) * sizeof(result[0])); + result[degree - 1] = 0; + for (int j = 0; j < degree; j++) + result[j] ^= reedSolomonMultiply(generator[j], factor); + } +} + +#undef qrcodegen_REED_SOLOMON_DEGREE_MAX + + +// Returns the product of the two given field elements modulo GF(2^8/0x11D). +// All inputs are valid. This could be implemented as a 256*256 lookup table. +testable uint8_t reedSolomonMultiply(uint8_t x, uint8_t y) { + // Russian peasant multiplication + uint8_t z = 0; + for (int i = 7; i >= 0; i--) { + z = (uint8_t)((z << 1) ^ ((z >> 7) * 0x11D)); + z ^= ((y >> i) & 1) * x; + } + return z; +} + + + +/*---- Drawing function modules ----*/ + +// Clears the given QR Code grid with light modules for the given +// version's size, then marks every function module as dark. +testable void initializeFunctionModules(int version, uint8_t qrcode[]) { + // Initialize QR Code + int qrsize = version * 4 + 17; + memset(qrcode, 0, (size_t)((qrsize * qrsize + 7) / 8 + 1) * sizeof(qrcode[0])); + qrcode[0] = (uint8_t)qrsize; + + // Fill horizontal and vertical timing patterns + fillRectangle(6, 0, 1, qrsize, qrcode); + fillRectangle(0, 6, qrsize, 1, qrcode); + + // Fill 3 finder patterns (all corners except bottom right) and format bits + fillRectangle(0, 0, 9, 9, qrcode); + fillRectangle(qrsize - 8, 0, 8, 9, qrcode); + fillRectangle(0, qrsize - 8, 9, 8, qrcode); + + // Fill numerous alignment patterns + uint8_t alignPatPos[7]; + int numAlign = getAlignmentPatternPositions(version, alignPatPos); + for (int i = 0; i < numAlign; i++) { + for (int j = 0; j < numAlign; j++) { + // Don't draw on the three finder corners + if (!((i == 0 && j == 0) || (i == 0 && j == numAlign - 1) || (i == numAlign - 1 && j == 0))) + fillRectangle(alignPatPos[i] - 2, alignPatPos[j] - 2, 5, 5, qrcode); + } + } + + // Fill version blocks + if (version >= 7) { + fillRectangle(qrsize - 11, 0, 3, 6, qrcode); + fillRectangle(0, qrsize - 11, 6, 3, qrcode); + } +} + + +// Draws light function modules and possibly some dark modules onto the given QR Code, without changing +// non-function modules. This does not draw the format bits. This requires all function modules to be previously +// marked dark (namely by initializeFunctionModules()), because this may skip redrawing dark function modules. +static void drawLightFunctionModules(uint8_t qrcode[], int version) { + // Draw horizontal and vertical timing patterns + int qrsize = qrcodegen_getSize(qrcode); + for (int i = 7; i < qrsize - 7; i += 2) { + setModuleBounded(qrcode, 6, i, false); + setModuleBounded(qrcode, i, 6, false); + } + + // Draw 3 finder patterns (all corners except bottom right; overwrites some timing modules) + for (int dy = -4; dy <= 4; dy++) { + for (int dx = -4; dx <= 4; dx++) { + int dist = abs(dx); + if (abs(dy) > dist) + dist = abs(dy); + if (dist == 2 || dist == 4) { + setModuleUnbounded(qrcode, 3 + dx, 3 + dy, false); + setModuleUnbounded(qrcode, qrsize - 4 + dx, 3 + dy, false); + setModuleUnbounded(qrcode, 3 + dx, qrsize - 4 + dy, false); + } + } + } + + // Draw numerous alignment patterns + uint8_t alignPatPos[7]; + int numAlign = getAlignmentPatternPositions(version, alignPatPos); + for (int i = 0; i < numAlign; i++) { + for (int j = 0; j < numAlign; j++) { + if ((i == 0 && j == 0) || (i == 0 && j == numAlign - 1) || (i == numAlign - 1 && j == 0)) + continue; // Don't draw on the three finder corners + for (int dy = -1; dy <= 1; dy++) { + for (int dx = -1; dx <= 1; dx++) + setModuleBounded(qrcode, alignPatPos[i] + dx, alignPatPos[j] + dy, dx == 0 && dy == 0); + } + } + } + + // Draw version blocks + if (version >= 7) { + // Calculate error correction code and pack bits + int rem = version; // version is uint6, in the range [7, 40] + for (int i = 0; i < 12; i++) + rem = (rem << 1) ^ ((rem >> 11) * 0x1F25); + long bits = (long)version << 12 | rem; // uint18 + assert(bits >> 18 == 0); + + // Draw two copies + for (int i = 0; i < 6; i++) { + for (int j = 0; j < 3; j++) { + int k = qrsize - 11 + j; + setModuleBounded(qrcode, k, i, (bits & 1) != 0); + setModuleBounded(qrcode, i, k, (bits & 1) != 0); + bits >>= 1; + } + } + } +} + + +// Draws two copies of the format bits (with its own error correction code) based +// on the given mask and error correction level. This always draws all modules of +// the format bits, unlike drawLightFunctionModules() which might skip dark modules. +static void drawFormatBits(enum qrcodegen_Ecc ecl, enum qrcodegen_Mask mask, uint8_t qrcode[]) { + // Calculate error correction code and pack bits + assert(0 <= (int)mask && (int)mask <= 7); + static const int table[] = {1, 0, 3, 2}; + int data = table[(int)ecl] << 3 | (int)mask; // errCorrLvl is uint2, mask is uint3 + int rem = data; + for (int i = 0; i < 10; i++) + rem = (rem << 1) ^ ((rem >> 9) * 0x537); + int bits = (data << 10 | rem) ^ 0x5412; // uint15 + assert(bits >> 15 == 0); + + // Draw first copy + for (int i = 0; i <= 5; i++) + setModuleBounded(qrcode, 8, i, getBit(bits, i)); + setModuleBounded(qrcode, 8, 7, getBit(bits, 6)); + setModuleBounded(qrcode, 8, 8, getBit(bits, 7)); + setModuleBounded(qrcode, 7, 8, getBit(bits, 8)); + for (int i = 9; i < 15; i++) + setModuleBounded(qrcode, 14 - i, 8, getBit(bits, i)); + + // Draw second copy + int qrsize = qrcodegen_getSize(qrcode); + for (int i = 0; i < 8; i++) + setModuleBounded(qrcode, qrsize - 1 - i, 8, getBit(bits, i)); + for (int i = 8; i < 15; i++) + setModuleBounded(qrcode, 8, qrsize - 15 + i, getBit(bits, i)); + setModuleBounded(qrcode, 8, qrsize - 8, true); // Always dark +} + + +// Calculates and stores an ascending list of positions of alignment patterns +// for this version number, returning the length of the list (in the range [0,7]). +// Each position is in the range [0,177), and are used on both the x and y axes. +// This could be implemented as lookup table of 40 variable-length lists of unsigned bytes. +testable int getAlignmentPatternPositions(int version, uint8_t result[7]) { + if (version == 1) + return 0; + int numAlign = version / 7 + 2; + int step = (version * 8 + numAlign * 3 + 5) / (numAlign * 4 - 4) * 2; + for (int i = numAlign - 1, pos = version * 4 + 10; i >= 1; i--, pos -= step) + result[i] = (uint8_t)pos; + result[0] = 6; + return numAlign; +} + + +// Sets every module in the range [left : left + width] * [top : top + height] to dark. +static void fillRectangle(int left, int top, int width, int height, uint8_t qrcode[]) { + for (int dy = 0; dy < height; dy++) { + for (int dx = 0; dx < width; dx++) + setModuleBounded(qrcode, left + dx, top + dy, true); + } +} + + + +/*---- Drawing data modules and masking ----*/ + +// Draws the raw codewords (including data and ECC) onto the given QR Code. This requires the initial state of +// the QR Code to be dark at function modules and light at codeword modules (including unused remainder bits). +static void drawCodewords(const uint8_t data[], int dataLen, uint8_t qrcode[]) { + int qrsize = qrcodegen_getSize(qrcode); + int i = 0; // Bit index into the data + // Do the funny zigzag scan + for (int right = qrsize - 1; right >= 1; right -= 2) { // Index of right column in each column pair + if (right == 6) + right = 5; + for (int vert = 0; vert < qrsize; vert++) { // Vertical counter + for (int j = 0; j < 2; j++) { + int x = right - j; // Actual x coordinate + bool upward = ((right + 1) & 2) == 0; + int y = upward ? qrsize - 1 - vert : vert; // Actual y coordinate + if (!getModuleBounded(qrcode, x, y) && i < dataLen * 8) { + bool dark = getBit(data[i >> 3], 7 - (i & 7)); + setModuleBounded(qrcode, x, y, dark); + i++; + } + // If this QR Code has any remainder bits (0 to 7), they were assigned as + // 0/false/light by the constructor and are left unchanged by this method + } + } + } + assert(i == dataLen * 8); +} + + +// XORs the codeword modules in this QR Code with the given mask pattern +// and given pattern of function modules. The codeword bits must be drawn +// before masking. Due to the arithmetic of XOR, calling applyMask() with +// the same mask value a second time will undo the mask. A final well-formed +// QR Code needs exactly one (not zero, two, etc.) mask applied. +static void applyMask(const uint8_t functionModules[], uint8_t qrcode[], enum qrcodegen_Mask mask) { + assert(0 <= (int)mask && (int)mask <= 7); // Disallows qrcodegen_Mask_AUTO + int qrsize = qrcodegen_getSize(qrcode); + for (int y = 0; y < qrsize; y++) { + for (int x = 0; x < qrsize; x++) { + if (getModuleBounded(functionModules, x, y)) + continue; + bool invert; + switch ((int)mask) { + case 0: invert = (x + y) % 2 == 0; break; + case 1: invert = y % 2 == 0; break; + case 2: invert = x % 3 == 0; break; + case 3: invert = (x + y) % 3 == 0; break; + case 4: invert = (x / 3 + y / 2) % 2 == 0; break; + case 5: invert = x * y % 2 + x * y % 3 == 0; break; + case 6: invert = (x * y % 2 + x * y % 3) % 2 == 0; break; + case 7: invert = ((x + y) % 2 + x * y % 3) % 2 == 0; break; + default: assert(false); return; + } + bool val = getModuleBounded(qrcode, x, y); + setModuleBounded(qrcode, x, y, val ^ invert); + } + } +} + + +// Calculates and returns the penalty score based on state of the given QR Code's current modules. +// This is used by the automatic mask choice algorithm to find the mask pattern that yields the lowest score. +static long getPenaltyScore(const uint8_t qrcode[]) { + int qrsize = qrcodegen_getSize(qrcode); + long result = 0; + + // Adjacent modules in row having same color, and finder-like patterns + for (int y = 0; y < qrsize; y++) { + bool runColor = false; + int runX = 0; + int runHistory[7] = {0}; + for (int x = 0; x < qrsize; x++) { + if (getModuleBounded(qrcode, x, y) == runColor) { + runX++; + if (runX == 5) + result += PENALTY_N1; + else if (runX > 5) + result++; + } else { + finderPenaltyAddHistory(runX, runHistory, qrsize); + if (!runColor) + result += finderPenaltyCountPatterns(runHistory, qrsize) * PENALTY_N3; + runColor = getModuleBounded(qrcode, x, y); + runX = 1; + } + } + result += finderPenaltyTerminateAndCount(runColor, runX, runHistory, qrsize) * PENALTY_N3; + } + // Adjacent modules in column having same color, and finder-like patterns + for (int x = 0; x < qrsize; x++) { + bool runColor = false; + int runY = 0; + int runHistory[7] = {0}; + for (int y = 0; y < qrsize; y++) { + if (getModuleBounded(qrcode, x, y) == runColor) { + runY++; + if (runY == 5) + result += PENALTY_N1; + else if (runY > 5) + result++; + } else { + finderPenaltyAddHistory(runY, runHistory, qrsize); + if (!runColor) + result += finderPenaltyCountPatterns(runHistory, qrsize) * PENALTY_N3; + runColor = getModuleBounded(qrcode, x, y); + runY = 1; + } + } + result += finderPenaltyTerminateAndCount(runColor, runY, runHistory, qrsize) * PENALTY_N3; + } + + // 2*2 blocks of modules having same color + for (int y = 0; y < qrsize - 1; y++) { + for (int x = 0; x < qrsize - 1; x++) { + bool color = getModuleBounded(qrcode, x, y); + if ( color == getModuleBounded(qrcode, x + 1, y) && + color == getModuleBounded(qrcode, x, y + 1) && + color == getModuleBounded(qrcode, x + 1, y + 1)) + result += PENALTY_N2; + } + } + + // Balance of dark and light modules + int dark = 0; + for (int y = 0; y < qrsize; y++) { + for (int x = 0; x < qrsize; x++) { + if (getModuleBounded(qrcode, x, y)) + dark++; + } + } + int total = qrsize * qrsize; // Note that size is odd, so dark/total != 1/2 + // Compute the smallest integer k >= 0 such that (45-5k)% <= dark/total <= (55+5k)% + int k = (int)((labs(dark * 20L - total * 10L) + total - 1) / total) - 1; + assert(0 <= k && k <= 9); + result += k * PENALTY_N4; + assert(0 <= result && result <= 2568888L); // Non-tight upper bound based on default values of PENALTY_N1, ..., N4 + return result; +} + + +// Can only be called immediately after a light run is added, and +// returns either 0, 1, or 2. A helper function for getPenaltyScore(). +static int finderPenaltyCountPatterns(const int runHistory[7], int qrsize) { + int n = runHistory[1]; + assert(n <= qrsize * 3); (void)qrsize; + bool core = n > 0 && runHistory[2] == n && runHistory[3] == n * 3 && runHistory[4] == n && runHistory[5] == n; + // The maximum QR Code size is 177, hence the dark run length n <= 177. + // Arithmetic is promoted to int, so n*4 will not overflow. + return (core && runHistory[0] >= n * 4 && runHistory[6] >= n ? 1 : 0) + + (core && runHistory[6] >= n * 4 && runHistory[0] >= n ? 1 : 0); +} + + +// Must be called at the end of a line (row or column) of modules. A helper function for getPenaltyScore(). +static int finderPenaltyTerminateAndCount(bool currentRunColor, int currentRunLength, int runHistory[7], int qrsize) { + if (currentRunColor) { // Terminate dark run + finderPenaltyAddHistory(currentRunLength, runHistory, qrsize); + currentRunLength = 0; + } + currentRunLength += qrsize; // Add light border to final run + finderPenaltyAddHistory(currentRunLength, runHistory, qrsize); + return finderPenaltyCountPatterns(runHistory, qrsize); +} + + +// Pushes the given value to the front and drops the last value. A helper function for getPenaltyScore(). +static void finderPenaltyAddHistory(int currentRunLength, int runHistory[7], int qrsize) { + if (runHistory[0] == 0) + currentRunLength += qrsize; // Add light border to initial run + memmove(&runHistory[1], &runHistory[0], 6 * sizeof(runHistory[0])); + runHistory[0] = currentRunLength; +} + + + +/*---- Basic QR Code information ----*/ + +// Public function - see documentation comment in header file. +int qrcodegen_getSize(const uint8_t qrcode[]) { + assert(qrcode != NULL); + int result = qrcode[0]; + assert((qrcodegen_VERSION_MIN * 4 + 17) <= result + && result <= (qrcodegen_VERSION_MAX * 4 + 17)); + return result; +} + + +// Public function - see documentation comment in header file. +bool qrcodegen_getModule(const uint8_t qrcode[], int x, int y) { + assert(qrcode != NULL); + int qrsize = qrcode[0]; + return (0 <= x && x < qrsize && 0 <= y && y < qrsize) && getModuleBounded(qrcode, x, y); +} + + +// Returns the color of the module at the given coordinates, which must be in bounds. +testable bool getModuleBounded(const uint8_t qrcode[], int x, int y) { + int qrsize = qrcode[0]; + assert(21 <= qrsize && qrsize <= 177 && 0 <= x && x < qrsize && 0 <= y && y < qrsize); + int index = y * qrsize + x; + return getBit(qrcode[(index >> 3) + 1], index & 7); +} + + +// Sets the color of the module at the given coordinates, which must be in bounds. +testable void setModuleBounded(uint8_t qrcode[], int x, int y, bool isDark) { + int qrsize = qrcode[0]; + assert(21 <= qrsize && qrsize <= 177 && 0 <= x && x < qrsize && 0 <= y && y < qrsize); + int index = y * qrsize + x; + int bitIndex = index & 7; + int byteIndex = (index >> 3) + 1; + if (isDark) + qrcode[byteIndex] |= 1 << bitIndex; + else + qrcode[byteIndex] &= (1 << bitIndex) ^ 0xFF; +} + + +// Sets the color of the module at the given coordinates, doing nothing if out of bounds. +testable void setModuleUnbounded(uint8_t qrcode[], int x, int y, bool isDark) { + int qrsize = qrcode[0]; + if (0 <= x && x < qrsize && 0 <= y && y < qrsize) + setModuleBounded(qrcode, x, y, isDark); +} + + +// Returns true iff the i'th bit of x is set to 1. Requires x >= 0 and 0 <= i <= 14. +static bool getBit(int x, int i) { + return ((x >> i) & 1) != 0; +} + + + +/*---- Segment handling ----*/ + +// Public function - see documentation comment in header file. +bool qrcodegen_isNumeric(const char *text) { + assert(text != NULL); + for (; *text != '\0'; text++) { + if (*text < '0' || *text > '9') + return false; + } + return true; +} + + +// Public function - see documentation comment in header file. +bool qrcodegen_isAlphanumeric(const char *text) { + assert(text != NULL); + for (; *text != '\0'; text++) { + if (strchr(ALPHANUMERIC_CHARSET, *text) == NULL) + return false; + } + return true; +} + + +// Public function - see documentation comment in header file. +size_t qrcodegen_calcSegmentBufferSize(enum qrcodegen_Mode mode, size_t numChars) { + int temp = calcSegmentBitLength(mode, numChars); + if (temp == LENGTH_OVERFLOW) + return SIZE_MAX; + assert(0 <= temp && temp <= INT16_MAX); + return ((size_t)temp + 7) / 8; +} + + +// Returns the number of data bits needed to represent a segment +// containing the given number of characters using the given mode. Notes: +// - Returns LENGTH_OVERFLOW on failure, i.e. numChars > INT16_MAX +// or the number of needed bits exceeds INT16_MAX (i.e. 32767). +// - Otherwise, all valid results are in the range [0, INT16_MAX]. +// - For byte mode, numChars measures the number of bytes, not Unicode code points. +// - For ECI mode, numChars must be 0, and the worst-case number of bits is returned. +// An actual ECI segment can have shorter data. For non-ECI modes, the result is exact. +testable int calcSegmentBitLength(enum qrcodegen_Mode mode, size_t numChars) { + // All calculations are designed to avoid overflow on all platforms + if (numChars > (unsigned int)INT16_MAX) + return LENGTH_OVERFLOW; + long result = (long)numChars; + if (mode == qrcodegen_Mode_NUMERIC) + result = (result * 10 + 2) / 3; // ceil(10/3 * n) + else if (mode == qrcodegen_Mode_ALPHANUMERIC) + result = (result * 11 + 1) / 2; // ceil(11/2 * n) + else if (mode == qrcodegen_Mode_BYTE) + result *= 8; + else if (mode == qrcodegen_Mode_KANJI) + result *= 13; + else if (mode == qrcodegen_Mode_ECI && numChars == 0) + result = 3 * 8; + else { // Invalid argument + assert(false); + return LENGTH_OVERFLOW; + } + assert(result >= 0); + if (result > INT16_MAX) + return LENGTH_OVERFLOW; + return (int)result; +} + + +// Public function - see documentation comment in header file. +struct qrcodegen_Segment qrcodegen_makeBytes(const uint8_t data[], size_t len, uint8_t buf[]) { + assert(data != NULL || len == 0); + struct qrcodegen_Segment result; + result.mode = qrcodegen_Mode_BYTE; + result.bitLength = calcSegmentBitLength(result.mode, len); + assert(result.bitLength != LENGTH_OVERFLOW); + result.numChars = (int)len; + if (len > 0) + memcpy(buf, data, len * sizeof(buf[0])); + result.data = buf; + return result; +} + + +// Public function - see documentation comment in header file. +struct qrcodegen_Segment qrcodegen_makeNumeric(const char *digits, uint8_t buf[]) { + assert(digits != NULL); + struct qrcodegen_Segment result; + size_t len = strlen(digits); + result.mode = qrcodegen_Mode_NUMERIC; + int bitLen = calcSegmentBitLength(result.mode, len); + assert(bitLen != LENGTH_OVERFLOW); + result.numChars = (int)len; + if (bitLen > 0) + memset(buf, 0, ((size_t)bitLen + 7) / 8 * sizeof(buf[0])); + result.bitLength = 0; + + unsigned int accumData = 0; + int accumCount = 0; + for (; *digits != '\0'; digits++) { + char c = *digits; + assert('0' <= c && c <= '9'); + accumData = accumData * 10 + (unsigned int)(c - '0'); + accumCount++; + if (accumCount == 3) { + appendBitsToBuffer(accumData, 10, buf, &result.bitLength); + accumData = 0; + accumCount = 0; + } + } + if (accumCount > 0) // 1 or 2 digits remaining + appendBitsToBuffer(accumData, accumCount * 3 + 1, buf, &result.bitLength); + assert(result.bitLength == bitLen); + result.data = buf; + return result; +} + + +// Public function - see documentation comment in header file. +struct qrcodegen_Segment qrcodegen_makeAlphanumeric(const char *text, uint8_t buf[]) { + assert(text != NULL); + struct qrcodegen_Segment result; + size_t len = strlen(text); + result.mode = qrcodegen_Mode_ALPHANUMERIC; + int bitLen = calcSegmentBitLength(result.mode, len); + assert(bitLen != LENGTH_OVERFLOW); + result.numChars = (int)len; + if (bitLen > 0) + memset(buf, 0, ((size_t)bitLen + 7) / 8 * sizeof(buf[0])); + result.bitLength = 0; + + unsigned int accumData = 0; + int accumCount = 0; + for (; *text != '\0'; text++) { + const char *temp = strchr(ALPHANUMERIC_CHARSET, *text); + assert(temp != NULL); + accumData = accumData * 45 + (unsigned int)(temp - ALPHANUMERIC_CHARSET); + accumCount++; + if (accumCount == 2) { + appendBitsToBuffer(accumData, 11, buf, &result.bitLength); + accumData = 0; + accumCount = 0; + } + } + if (accumCount > 0) // 1 character remaining + appendBitsToBuffer(accumData, 6, buf, &result.bitLength); + assert(result.bitLength == bitLen); + result.data = buf; + return result; +} + + +// Public function - see documentation comment in header file. +struct qrcodegen_Segment qrcodegen_makeEci(long assignVal, uint8_t buf[]) { + struct qrcodegen_Segment result; + result.mode = qrcodegen_Mode_ECI; + result.numChars = 0; + result.bitLength = 0; + if (assignVal < 0) + assert(false); + else if (assignVal < (1 << 7)) { + memset(buf, 0, 1 * sizeof(buf[0])); + appendBitsToBuffer((unsigned int)assignVal, 8, buf, &result.bitLength); + } else if (assignVal < (1 << 14)) { + memset(buf, 0, 2 * sizeof(buf[0])); + appendBitsToBuffer(2, 2, buf, &result.bitLength); + appendBitsToBuffer((unsigned int)assignVal, 14, buf, &result.bitLength); + } else if (assignVal < 1000000L) { + memset(buf, 0, 3 * sizeof(buf[0])); + appendBitsToBuffer(6, 3, buf, &result.bitLength); + appendBitsToBuffer((unsigned int)(assignVal >> 10), 11, buf, &result.bitLength); + appendBitsToBuffer((unsigned int)(assignVal & 0x3FF), 10, buf, &result.bitLength); + } else + assert(false); + result.data = buf; + return result; +} + + +// Calculates the number of bits needed to encode the given segments at the given version. +// Returns a non-negative number if successful. Otherwise returns LENGTH_OVERFLOW if a segment +// has too many characters to fit its length field, or the total bits exceeds INT16_MAX. +testable int getTotalBits(const struct qrcodegen_Segment segs[], size_t len, int version) { + assert(segs != NULL || len == 0); + long result = 0; + for (size_t i = 0; i < len; i++) { + int numChars = segs[i].numChars; + int bitLength = segs[i].bitLength; + assert(0 <= numChars && numChars <= INT16_MAX); + assert(0 <= bitLength && bitLength <= INT16_MAX); + int ccbits = numCharCountBits(segs[i].mode, version); + assert(0 <= ccbits && ccbits <= 16); + if (numChars >= (1L << ccbits)) + return LENGTH_OVERFLOW; // The segment's length doesn't fit the field's bit width + result += 4L + ccbits + bitLength; + if (result > INT16_MAX) + return LENGTH_OVERFLOW; // The sum might overflow an int type + } + assert(0 <= result && result <= INT16_MAX); + return (int)result; +} + + +// Returns the bit width of the character count field for a segment in the given mode +// in a QR Code at the given version number. The result is in the range [0, 16]. +static int numCharCountBits(enum qrcodegen_Mode mode, int version) { + assert(qrcodegen_VERSION_MIN <= version && version <= qrcodegen_VERSION_MAX); + int i = (version + 7) / 17; + switch (mode) { + case qrcodegen_Mode_NUMERIC : { static const int temp[] = {10, 12, 14}; return temp[i]; } + case qrcodegen_Mode_ALPHANUMERIC: { static const int temp[] = { 9, 11, 13}; return temp[i]; } + case qrcodegen_Mode_BYTE : { static const int temp[] = { 8, 16, 16}; return temp[i]; } + case qrcodegen_Mode_KANJI : { static const int temp[] = { 8, 10, 12}; return temp[i]; } + case qrcodegen_Mode_ECI : return 0; + default: assert(false); return -1; // Dummy value + } +} + + +#undef LENGTH_OVERFLOW diff --git a/src/qr/qrcodegen.h b/src/qr/qrcodegen.h new file mode 100644 index 0000000..6bbc157 --- /dev/null +++ b/src/qr/qrcodegen.h @@ -0,0 +1,385 @@ +/* + * QR Code generator library (C) + * + * Copyright (c) Project Nayuki. (MIT License) + * https://www.nayuki.io/page/qr-code-generator-library + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * - The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * - The Software is provided "as is", without warranty of any kind, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. In no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the Software or the use or other dealings in the + * Software. + */ + +#pragma once + +#include +#include +#include + + +#ifdef __cplusplus +extern "C" { +#endif + + +/* + * This library creates QR Code symbols, which is a type of two-dimension barcode. + * Invented by Denso Wave and described in the ISO/IEC 18004 standard. + * A QR Code structure is an immutable square grid of dark and light cells. + * The library provides functions to create a QR Code from text or binary data. + * The library covers the QR Code Model 2 specification, supporting all versions (sizes) + * from 1 to 40, all 4 error correction levels, and 4 character encoding modes. + * + * Ways to create a QR Code object: + * - High level: Take the payload data and call qrcodegen_encodeText() or qrcodegen_encodeBinary(). + * - Low level: Custom-make the list of segments and call + * qrcodegen_encodeSegments() or qrcodegen_encodeSegmentsAdvanced(). + * (Note that all ways require supplying the desired error correction level and various byte buffers.) + */ + + +/*---- Enum and struct types----*/ + +/* + * The error correction level in a QR Code symbol. + */ +enum qrcodegen_Ecc { + // Must be declared in ascending order of error protection + // so that an internal qrcodegen function works properly + qrcodegen_Ecc_LOW = 0 , // The QR Code can tolerate about 7% erroneous codewords + qrcodegen_Ecc_MEDIUM , // The QR Code can tolerate about 15% erroneous codewords + qrcodegen_Ecc_QUARTILE, // The QR Code can tolerate about 25% erroneous codewords + qrcodegen_Ecc_HIGH , // The QR Code can tolerate about 30% erroneous codewords +}; + + +/* + * The mask pattern used in a QR Code symbol. + */ +enum qrcodegen_Mask { + // A special value to tell the QR Code encoder to + // automatically select an appropriate mask pattern + qrcodegen_Mask_AUTO = -1, + // The eight actual mask patterns + qrcodegen_Mask_0 = 0, + qrcodegen_Mask_1, + qrcodegen_Mask_2, + qrcodegen_Mask_3, + qrcodegen_Mask_4, + qrcodegen_Mask_5, + qrcodegen_Mask_6, + qrcodegen_Mask_7, +}; + + +/* + * Describes how a segment's data bits are interpreted. + */ +enum qrcodegen_Mode { + qrcodegen_Mode_NUMERIC = 0x1, + qrcodegen_Mode_ALPHANUMERIC = 0x2, + qrcodegen_Mode_BYTE = 0x4, + qrcodegen_Mode_KANJI = 0x8, + qrcodegen_Mode_ECI = 0x7, +}; + + +/* + * A segment of character/binary/control data in a QR Code symbol. + * The mid-level way to create a segment is to take the payload data + * and call a factory function such as qrcodegen_makeNumeric(). + * The low-level way to create a segment is to custom-make the bit buffer + * and initialize a qrcodegen_Segment struct with appropriate values. + * Even in the most favorable conditions, a QR Code can only hold 7089 characters of data. + * Any segment longer than this is meaningless for the purpose of generating QR Codes. + * Moreover, the maximum allowed bit length is 32767 because + * the largest QR Code (version 40) has 31329 modules. + */ +struct qrcodegen_Segment { + // The mode indicator of this segment. + enum qrcodegen_Mode mode; + + // The length of this segment's unencoded data. Measured in characters for + // numeric/alphanumeric/kanji mode, bytes for byte mode, and 0 for ECI mode. + // Always zero or positive. Not the same as the data's bit length. + int numChars; + + // The data bits of this segment, packed in bitwise big endian. + // Can be null if the bit length is zero. + uint8_t *data; + + // The number of valid data bits used in the buffer. Requires + // 0 <= bitLength <= 32767, and bitLength <= (capacity of data array) * 8. + // The character count (numChars) must agree with the mode and the bit buffer length. + int bitLength; +}; + + + +/*---- Macro constants and functions ----*/ + +#define qrcodegen_VERSION_MIN 1 // The minimum version number supported in the QR Code Model 2 standard +#define qrcodegen_VERSION_MAX 40 // The maximum version number supported in the QR Code Model 2 standard + +// Calculates the number of bytes needed to store any QR Code up to and including the given version number, +// as a compile-time constant. For example, 'uint8_t buffer[qrcodegen_BUFFER_LEN_FOR_VERSION(25)];' +// can store any single QR Code from version 1 to 25 (inclusive). The result fits in an int (or int16). +// Requires qrcodegen_VERSION_MIN <= n <= qrcodegen_VERSION_MAX. +#define qrcodegen_BUFFER_LEN_FOR_VERSION(n) ((((n) * 4 + 17) * ((n) * 4 + 17) + 7) / 8 + 1) + +// The worst-case number of bytes needed to store one QR Code, up to and including +// version 40. This value equals 3918, which is just under 4 kilobytes. +// Use this more convenient value to avoid calculating tighter memory bounds for buffers. +#define qrcodegen_BUFFER_LEN_MAX qrcodegen_BUFFER_LEN_FOR_VERSION(qrcodegen_VERSION_MAX) + + + +/*---- Functions (high level) to generate QR Codes ----*/ + +/* + * Encodes the given text string to a QR Code, returning true if successful. + * If the data is too long to fit in any version in the given range + * at the given ECC level, then false is returned. + * + * The input text must be encoded in UTF-8 and contain no NULs. + * Requires 1 <= minVersion <= maxVersion <= 40. + * + * The smallest possible QR Code version within the given range is automatically + * chosen for the output. Iff boostEcl is true, then the ECC level of the result + * may be higher than the ecl argument if it can be done without increasing the + * version. The mask is either between qrcodegen_Mask_0 to 7 to force that mask, or + * qrcodegen_Mask_AUTO to automatically choose an appropriate mask (which may be slow). + * + * About the arrays, letting len = qrcodegen_BUFFER_LEN_FOR_VERSION(maxVersion): + * - Before calling the function: + * - The array ranges tempBuffer[0 : len] and qrcode[0 : len] must allow + * reading and writing; hence each array must have a length of at least len. + * - The two ranges must not overlap (aliasing). + * - The initial state of both ranges can be uninitialized + * because the function always writes before reading. + * - After the function returns: + * - Both ranges have no guarantee on which elements are initialized and what values are stored. + * - tempBuffer contains no useful data and should be treated as entirely uninitialized. + * - If successful, qrcode can be passed into qrcodegen_getSize() and qrcodegen_getModule(). + * + * If successful, the resulting QR Code may use numeric, + * alphanumeric, or byte mode to encode the text. + * + * In the most optimistic case, a QR Code at version 40 with low ECC + * can hold any UTF-8 string up to 2953 bytes, or any alphanumeric string + * up to 4296 characters, or any digit string up to 7089 characters. + * These numbers represent the hard upper limit of the QR Code standard. + * + * Please consult the QR Code specification for information on + * data capacities per version, ECC level, and text encoding mode. + */ +bool qrcodegen_encodeText(const char *text, uint8_t tempBuffer[], uint8_t qrcode[], + enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl); + + +/* + * Encodes the given binary data to a QR Code, returning true if successful. + * If the data is too long to fit in any version in the given range + * at the given ECC level, then false is returned. + * + * Requires 1 <= minVersion <= maxVersion <= 40. + * + * The smallest possible QR Code version within the given range is automatically + * chosen for the output. Iff boostEcl is true, then the ECC level of the result + * may be higher than the ecl argument if it can be done without increasing the + * version. The mask is either between qrcodegen_Mask_0 to 7 to force that mask, or + * qrcodegen_Mask_AUTO to automatically choose an appropriate mask (which may be slow). + * + * About the arrays, letting len = qrcodegen_BUFFER_LEN_FOR_VERSION(maxVersion): + * - Before calling the function: + * - The array ranges dataAndTemp[0 : len] and qrcode[0 : len] must allow + * reading and writing; hence each array must have a length of at least len. + * - The two ranges must not overlap (aliasing). + * - The input array range dataAndTemp[0 : dataLen] should normally be + * valid UTF-8 text, but is not required by the QR Code standard. + * - The initial state of dataAndTemp[dataLen : len] and qrcode[0 : len] + * can be uninitialized because the function always writes before reading. + * - After the function returns: + * - Both ranges have no guarantee on which elements are initialized and what values are stored. + * - dataAndTemp contains no useful data and should be treated as entirely uninitialized. + * - If successful, qrcode can be passed into qrcodegen_getSize() and qrcodegen_getModule(). + * + * If successful, the resulting QR Code will use byte mode to encode the data. + * + * In the most optimistic case, a QR Code at version 40 with low ECC can hold any byte + * sequence up to length 2953. This is the hard upper limit of the QR Code standard. + * + * Please consult the QR Code specification for information on + * data capacities per version, ECC level, and text encoding mode. + */ +bool qrcodegen_encodeBinary(uint8_t dataAndTemp[], size_t dataLen, uint8_t qrcode[], + enum qrcodegen_Ecc ecl, int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl); + + +/*---- Functions (low level) to generate QR Codes ----*/ + +/* + * Encodes the given segments to a QR Code, returning true if successful. + * If the data is too long to fit in any version at the given ECC level, + * then false is returned. + * + * The smallest possible QR Code version is automatically chosen for + * the output. The ECC level of the result may be higher than the + * ecl argument if it can be done without increasing the version. + * + * About the byte arrays, letting len = qrcodegen_BUFFER_LEN_FOR_VERSION(qrcodegen_VERSION_MAX): + * - Before calling the function: + * - The array ranges tempBuffer[0 : len] and qrcode[0 : len] must allow + * reading and writing; hence each array must have a length of at least len. + * - The two ranges must not overlap (aliasing). + * - The initial state of both ranges can be uninitialized + * because the function always writes before reading. + * - The input array segs can contain segments whose data buffers overlap with tempBuffer. + * - After the function returns: + * - Both ranges have no guarantee on which elements are initialized and what values are stored. + * - tempBuffer contains no useful data and should be treated as entirely uninitialized. + * - Any segment whose data buffer overlaps with tempBuffer[0 : len] + * must be treated as having invalid values in that array. + * - If successful, qrcode can be passed into qrcodegen_getSize() and qrcodegen_getModule(). + * + * Please consult the QR Code specification for information on + * data capacities per version, ECC level, and text encoding mode. + * + * This function allows the user to create a custom sequence of segments that switches + * between modes (such as alphanumeric and byte) to encode text in less space. + * This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary(). + */ +bool qrcodegen_encodeSegments(const struct qrcodegen_Segment segs[], size_t len, + enum qrcodegen_Ecc ecl, uint8_t tempBuffer[], uint8_t qrcode[]); + + +/* + * Encodes the given segments to a QR Code, returning true if successful. + * If the data is too long to fit in any version in the given range + * at the given ECC level, then false is returned. + * + * Requires 1 <= minVersion <= maxVersion <= 40. + * + * The smallest possible QR Code version within the given range is automatically + * chosen for the output. Iff boostEcl is true, then the ECC level of the result + * may be higher than the ecl argument if it can be done without increasing the + * version. The mask is either between qrcodegen_Mask_0 to 7 to force that mask, or + * qrcodegen_Mask_AUTO to automatically choose an appropriate mask (which may be slow). + * + * About the byte arrays, letting len = qrcodegen_BUFFER_LEN_FOR_VERSION(qrcodegen_VERSION_MAX): + * - Before calling the function: + * - The array ranges tempBuffer[0 : len] and qrcode[0 : len] must allow + * reading and writing; hence each array must have a length of at least len. + * - The two ranges must not overlap (aliasing). + * - The initial state of both ranges can be uninitialized + * because the function always writes before reading. + * - The input array segs can contain segments whose data buffers overlap with tempBuffer. + * - After the function returns: + * - Both ranges have no guarantee on which elements are initialized and what values are stored. + * - tempBuffer contains no useful data and should be treated as entirely uninitialized. + * - Any segment whose data buffer overlaps with tempBuffer[0 : len] + * must be treated as having invalid values in that array. + * - If successful, qrcode can be passed into qrcodegen_getSize() and qrcodegen_getModule(). + * + * Please consult the QR Code specification for information on + * data capacities per version, ECC level, and text encoding mode. + * + * This function allows the user to create a custom sequence of segments that switches + * between modes (such as alphanumeric and byte) to encode text in less space. + * This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary(). + */ +bool qrcodegen_encodeSegmentsAdvanced(const struct qrcodegen_Segment segs[], size_t len, enum qrcodegen_Ecc ecl, + int minVersion, int maxVersion, enum qrcodegen_Mask mask, bool boostEcl, uint8_t tempBuffer[], uint8_t qrcode[]); + + +/* + * Tests whether the given string can be encoded as a segment in numeric mode. + * A string is encodable iff each character is in the range 0 to 9. + */ +bool qrcodegen_isNumeric(const char *text); + + +/* + * Tests whether the given string can be encoded as a segment in alphanumeric mode. + * A string is encodable iff each character is in the following set: 0 to 9, A to Z + * (uppercase only), space, dollar, percent, asterisk, plus, hyphen, period, slash, colon. + */ +bool qrcodegen_isAlphanumeric(const char *text); + + +/* + * Returns the number of bytes (uint8_t) needed for the data buffer of a segment + * containing the given number of characters using the given mode. Notes: + * - Returns SIZE_MAX on failure, i.e. numChars > INT16_MAX or the internal + * calculation of the number of needed bits exceeds INT16_MAX (i.e. 32767). + * - Otherwise, all valid results are in the range [0, ceil(INT16_MAX / 8)], i.e. at most 4096. + * - It is okay for the user to allocate more bytes for the buffer than needed. + * - For byte mode, numChars measures the number of bytes, not Unicode code points. + * - For ECI mode, numChars must be 0, and the worst-case number of bytes is returned. + * An actual ECI segment can have shorter data. For non-ECI modes, the result is exact. + */ +size_t qrcodegen_calcSegmentBufferSize(enum qrcodegen_Mode mode, size_t numChars); + + +/* + * Returns a segment representing the given binary data encoded in + * byte mode. All input byte arrays are acceptable. Any text string + * can be converted to UTF-8 bytes and encoded as a byte mode segment. + */ +struct qrcodegen_Segment qrcodegen_makeBytes(const uint8_t data[], size_t len, uint8_t buf[]); + + +/* + * Returns a segment representing the given string of decimal digits encoded in numeric mode. + */ +struct qrcodegen_Segment qrcodegen_makeNumeric(const char *digits, uint8_t buf[]); + + +/* + * Returns a segment representing the given text string encoded in alphanumeric mode. + * The characters allowed are: 0 to 9, A to Z (uppercase only), space, + * dollar, percent, asterisk, plus, hyphen, period, slash, colon. + */ +struct qrcodegen_Segment qrcodegen_makeAlphanumeric(const char *text, uint8_t buf[]); + + +/* + * Returns a segment representing an Extended Channel Interpretation + * (ECI) designator with the given assignment value. + */ +struct qrcodegen_Segment qrcodegen_makeEci(long assignVal, uint8_t buf[]); + + +/*---- Functions to extract raw data from QR Codes ----*/ + +/* + * Returns the side length of the given QR Code, assuming that encoding succeeded. + * The result is in the range [21, 177]. Note that the length of the array buffer + * is related to the side length - every 'uint8_t qrcode[]' must have length at least + * qrcodegen_BUFFER_LEN_FOR_VERSION(version), which equals ceil(size^2 / 8 + 1). + */ +int qrcodegen_getSize(const uint8_t qrcode[]); + + +/* + * Returns the color of the module (pixel) at the given coordinates, which is false + * for light or true for dark. The top left corner has the coordinates (x=0, y=0). + * If the given coordinates are out of bounds, then false (light) is returned. + */ +bool qrcodegen_getModule(const uint8_t qrcode[], int x, int y); + + +#ifdef __cplusplus +} +#endif diff --git a/src/qr/qrencode.c b/src/qr/qrencode.c new file mode 100644 index 0000000..7a67c61 --- /dev/null +++ b/src/qr/qrencode.c @@ -0,0 +1,66 @@ +/* qrencode.c -- encode an otpauth:// URI as a QR code (#45). + * + * Wraps the vendored qrcodegen library (src/qr/qrcodegen.h, MIT). The whole + * qrcodegen API surface is confined to this file so the rest of AmiAuth only + * sees qr_encode_uri(). Portable C, no malloc, no floating point -- builds + * and is host-tested identically to the m68k build. + */ +#include + +#include "qrencode.h" +#include "qrcodegen.h" + +int qr_encode_uri(const char *uri, uint8_t *modules, int *size) +{ + /* qrcodegen needs two working buffers of this size; ~743 bytes each at + * the version cap. Static: keep them off the small Amiga shell stack, + * same reasoning as this project's other large-buffer locals. */ + static uint8_t tempbuf[qrcodegen_BUFFER_LEN_FOR_VERSION(QR_ENC_MAX_VERSION)]; + static uint8_t qrcode[qrcodegen_BUFFER_LEN_FOR_VERSION(QR_ENC_MAX_VERSION)]; + int n, x, y; + bool ok; + + if (!uri || !modules || !size) return QRENC_ERR_ARGS; + *size = 0; + + /* A fixed mask, and no boostEcl: qrcodegen_Mask_AUTO tries all 8 masks and + * penalty-scores each to pick the most scan-reliable one, and boostEcl + * makes a second pass at a higher ECC level when the chosen version has + * spare capacity - both are pure quality-of-scan polish, and both cost + * real time. On real 68k hardware "real time" turned out to be on the + * order of a minute for a modest-length URI (confirmed on-target via + * Copperline) - unacceptable for an interactive GUI action. Mask 2 is an + * arbitrary but fixed, valid-per-spec choice (any of 0-7 is a correct QR + * code; AUTO only optimises which one scans most reliably). */ + ok = qrcodegen_encodeText(uri, tempbuf, qrcode, qrcodegen_Ecc_MEDIUM, + qrcodegen_VERSION_MIN, QR_ENC_MAX_VERSION, qrcodegen_Mask_2, false); + if (!ok) return QRENC_ERR_TOOLONG; + + n = qrcodegen_getSize(qrcode); + for (y = 0; y < n; y++) + for (x = 0; x < n; x++) + modules[y * n + x] = qrcodegen_getModule(qrcode, x, y) ? 1 : 0; + + *size = n; + return QRENC_OK; +} + +int qr_render_ascii(const uint8_t *modules, int size, char *out, size_t outcap) +{ + size_t pos = 0; + int y, x; + + if (!modules || !out || size <= 0) return -1; + + for (y = 0; y < size; y++) { + for (x = 0; x < size; x++) { + if (pos + 2 >= outcap) return -1; + if (modules[y * size + x]) { out[pos++] = '#'; out[pos++] = '#'; } + else { out[pos++] = ' '; out[pos++] = ' '; } + } + if (pos + 1 >= outcap) return -1; + out[pos++] = '\n'; + } + out[pos] = '\0'; + return (int)pos; +} diff --git a/src/qr/qrencode.h b/src/qr/qrencode.h new file mode 100644 index 0000000..275761f --- /dev/null +++ b/src/qr/qrencode.h @@ -0,0 +1,56 @@ +/* qrencode.h -- encode an otpauth:// URI as a QR code (#45, export/display). + * + * Portable C wrapper over the vendored qrcodegen library (src/qr/qrcodegen.h, + * MIT); see THIRDPARTY.md. Mirrors qr.h's decode-side shape: the vendored + * library's own types never leak past this header. + */ +#ifndef AMIAUTH_QRENCODE_H +#define AMIAUTH_QRENCODE_H + +#include +#include + +/* Result codes for qr_encode_uri(). */ +enum { + QRENC_OK = 0, + QRENC_ERR_ARGS = -1, /* NULL/zero-sized arguments */ + QRENC_ERR_TOOLONG = -2 /* uri doesn't fit even at the version cap */ +}; + +/* Version cap: higher versions pack more data into a finer module grid, which + * scans worse at typical Amiga-screen viewing distance/resolution and needs a + * bigger output buffer. 15 (77x77 modules) comfortably fits any realistic + * otpauth:// URI (secret up to OTP_MAX_SECRET=64 raw bytes, i.e. ~103 Base32 + * chars, plus a percent-encoded issuer/label) while staying easily scannable. */ +#define QR_ENC_MAX_VERSION 15 +#define QR_ENC_MAX_MODULES (QR_ENC_MAX_VERSION * 4 + 17) /* 77 */ + +/* Encode `uri` (a NUL-terminated otpauth:// URI, e.g. from otpauth_build()) + * as a QR code. On success, fills modules[0, *size * *size) — row-major, one + * byte per module (1 = dark, 0 = light) — and sets *size to the code's side + * length. `modules` must have room for QR_ENC_MAX_MODULES*QR_ENC_MAX_MODULES + * bytes regardless of the actual *size returned (~5.9 KB; keep it off the + * Amiga shell's small stack, e.g. `static`, matching this project's other + * large-buffer locals). Returns QRENC_OK or a negative QRENC_ERR_* code; on + * error *size is left at 0. */ +int qr_encode_uri(const char *uri, uint8_t *modules, int *size); + +/* Room for the largest ASCII render qr_render_ascii() can produce: each of + * up to QR_ENC_MAX_MODULES rows becomes QR_ENC_MAX_MODULES*2 characters plus + * a newline, plus a NUL. ~11.9 KB — static/heap only, not the Amiga stack. */ +#define QR_ENC_ASCII_BUF_LEN \ + (QR_ENC_MAX_MODULES * (QR_ENC_MAX_MODULES * 2 + 1) + 1) + +/* Render a qr_encode_uri() module grid as plain-ASCII block art: two + * characters per module horizontally ("##" dark, " " light space) to + * roughly square the aspect ratio on a typical character-cell console, one + * newline-terminated line per module row. Deliberately not Unicode block + * characters (U+2580 etc.) — a stock Amiga console's charset (Topaz/ANSI) + * doesn't have them. Shared by the CLI's QR command and the GUI's AAP_QR + * forward-request handler, so a resident GUI and a fresh CLI process render + * identically. Returns the number of bytes written (excluding the NUL), or + * -1 on NULL/invalid arguments or if `out` (capacity outcap) is too small — + * QR_ENC_ASCII_BUF_LEN is always enough. */ +int qr_render_ascii(const uint8_t *modules, int size, char *out, size_t outcap); + +#endif /* AMIAUTH_QRENCODE_H */ diff --git a/tests/test_base32.c b/tests/test_base32.c index b92c196..08f208c 100644 --- a/tests/test_base32.c +++ b/tests/test_base32.c @@ -34,3 +34,39 @@ void run_base32_tests(void) /* Output exceeding the buffer is an error, not a truncation. */ TEST_CHECK(base32_decode("MZXW6YTBOI======", out, 3) == -1); } + +/* base32_encode (#45, QR export): RFC 4648 vectors, uppercase, no padding. */ +void run_base32_encode_tests(void) +{ + char buf[64]; + + TEST_CHECK(base32_encode((const uint8_t *)"f", 1, buf, sizeof(buf)) == 2); + TEST_CHECK(strcmp(buf, "MY") == 0); + + TEST_CHECK(base32_encode((const uint8_t *)"foobar", 6, buf, sizeof(buf)) == 10); + TEST_CHECK(strcmp(buf, "MZXW6YTBOI") == 0); + + /* Zero-length input encodes to an empty string. */ + TEST_CHECK(base32_encode((const uint8_t *)"", 0, buf, sizeof(buf)) == 0); + TEST_CHECK(buf[0] == '\0'); + + /* Round-trip through decode for every byte value 0-255, in one buffer. */ + { + uint8_t raw[256]; + uint8_t back[256]; + char enc[512]; + int i, n; + for (i = 0; i < 256; i++) raw[i] = (uint8_t)i; + n = base32_encode(raw, sizeof(raw), enc, sizeof(enc)); + TEST_CHECK(n > 0); + TEST_CHECK(base32_decode(enc, back, sizeof(back)) == 256); + TEST_CHECK(memcmp(raw, back, 256) == 0); + } + + /* Too-small buffer is an error, not a truncation. */ + TEST_CHECK(base32_encode((const uint8_t *)"foobar", 6, buf, 4) == -1); + + /* NULL arguments. */ + TEST_CHECK(base32_encode(NULL, 1, buf, sizeof(buf)) == -1); + TEST_CHECK(base32_encode((const uint8_t *)"f", 1, NULL, sizeof(buf)) == -1); +} diff --git a/tests/test_main.c b/tests/test_main.c index 61b52c3..19eb709 100644 --- a/tests/test_main.c +++ b/tests/test_main.c @@ -10,16 +10,19 @@ void run_hmac_tests(void); void run_otp_tests(void); void run_steamguard_tests(void); void run_base32_tests(void); +void run_base32_encode_tests(void); void run_chacha20_tests(void); void run_pbkdf2_tests(void); void run_drbg_tests(void); void run_kdf_tests(void); void run_uri_tests(void); void run_bare_secret_tests(void); +void run_uri_build_tests(void); void run_vault_tests(void); void run_clock_tests(void); void run_prefs_tests(void); void run_qr_tests(void); +void run_qr_encode_tests(void); int main(void) { @@ -30,16 +33,19 @@ int main(void) run_otp_tests(); run_steamguard_tests(); run_base32_tests(); + run_base32_encode_tests(); run_chacha20_tests(); run_pbkdf2_tests(); run_drbg_tests(); run_kdf_tests(); run_uri_tests(); run_bare_secret_tests(); + run_uri_build_tests(); run_vault_tests(); run_clock_tests(); run_prefs_tests(); run_qr_tests(); + run_qr_encode_tests(); printf("\n%d passed, %d failed, %d pending\n", g_test.passed, g_test.failed, g_test.pending); diff --git a/tests/test_qr.c b/tests/test_qr.c index 533967f..4e4c058 100644 --- a/tests/test_qr.c +++ b/tests/test_qr.c @@ -7,6 +7,7 @@ #include "test.h" #include "qr.h" +#include "qrencode.h" #include "uri.h" #include "otp.h" #include "qr/sample_gray.h" @@ -58,3 +59,108 @@ void run_qr_tests(void) TEST_CHECK(qr_decode_gray(qr_otp_gray, QR_OTP_W, QR_OTP_H, uri, 10) == QR_OK); TEST_CHECK(strlen(uri) == 9 && strncmp(uri, QR_OTP_URI, 9) == 0); } + +/* Rasterize a qr_encode_uri() module grid to 8-bit greyscale (module=black, + * background=white), `scale` pixels per module, no extra margin -- qr.c's own + * decode_with_quiet_zone() fallback pads it, so this doesn't need to. */ +static void rasterize(const uint8_t *modules, int size, int scale, + unsigned char *gray, int gw) +{ + int mx, my, py, px; + for (my = 0; my < size; my++) { + for (mx = 0; mx < size; mx++) { + unsigned char v = modules[my * size + mx] ? 0 : 255; + for (py = 0; py < scale; py++) + for (px = 0; px < scale; px++) + gray[(my * scale + py) * gw + (mx * scale + px)] = v; + } + } +} + +/* #45 (QR export): qr_encode_uri() round-tripped through the *real* quirc + * decoder (qr_decode_gray) -- strong end-to-end confidence that whatever this + * project renders on screen is actually scannable, not just "some bits". */ +void run_qr_encode_tests(void) +{ + static uint8_t modules[QR_ENC_MAX_MODULES * QR_ENC_MAX_MODULES]; + /* scale=4, max grid 77*4=308px square: comfortably under any reasonable + * test buffer; kept static/off-stack like every other large buffer here. */ + static unsigned char gray[QR_ENC_MAX_MODULES * 4 * QR_ENC_MAX_MODULES * 4]; + int size; + char uri[512]; + otp_account a, b; + char huge_issuer[OTP_MAX_ISSUER], huge_label[OTP_MAX_LABEL]; + size_t i; + + /* Simple TOTP account, built to a URI, encoded, rasterized, and decoded + * back by the real quirc path -- must come back byte-for-byte. */ + TEST_CHECK(otpauth_parse( + "otpauth://totp/GitHub:alice?secret=JBSWY3DPEHPK3PXP&issuer=GitHub" + "&digits=6&period=30", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(qr_encode_uri(uri, modules, &size) == QRENC_OK); + TEST_CHECK(size > 0 && size <= QR_ENC_MAX_MODULES); + rasterize(modules, size, 4, gray, size * 4); + { + char decoded[512]; + TEST_CHECK(qr_decode_gray(gray, size * 4, size * 4, + decoded, sizeof(decoded)) == QR_OK); + TEST_CHECK(strcmp(decoded, uri) == 0); + TEST_CHECK(otpauth_parse(decoded, &b) == 0); + TEST_CHECK(strcmp(a.issuer, b.issuer) == 0 && strcmp(a.label, b.label) == 0); + TEST_CHECK(a.secret_len == b.secret_len && + memcmp(a.secret, b.secret, a.secret_len) == 0); + } + + /* Steam Guard account (no algorithm/digits/period in the URI) round-trips + * through the same path. */ + TEST_CHECK(otpauth_parse( + "otpauth://steam/Steam:you?secret=JBSWY3DPEHPK3PXP&issuer=Steam", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(qr_encode_uri(uri, modules, &size) == QRENC_OK); + rasterize(modules, size, 4, gray, size * 4); + { + char decoded[512]; + TEST_CHECK(qr_decode_gray(gray, size * 4, size * 4, + decoded, sizeof(decoded)) == QR_OK); + TEST_CHECK(strcmp(decoded, uri) == 0); + } + + /* A generously long but realistic account (full OTP_MAX_SECRET=64 bytes, + * as a SHA-512 secret plausibly is; a longer-than-usual issuer/label) + * still fits within the version cap. */ + strcpy(huge_issuer, "A Reasonably Long Issuer Name"); + strcpy(huge_label, "someone.with.a-long.email-address@example.co.uk"); + memset(&a, 0, sizeof(a)); + strcpy(a.type, "totp"); + strcpy(a.algorithm, "SHA512"); + strcpy(a.issuer, huge_issuer); + strcpy(a.label, huge_label); + a.secret_len = OTP_MAX_SECRET; + for (i = 0; i < a.secret_len; i++) a.secret[i] = (uint8_t)i; + a.digits = 8; + a.period = 30; + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(qr_encode_uri(uri, modules, &size) == QRENC_OK); + TEST_CHECK(size > 0 && size <= QR_ENC_MAX_MODULES); + + /* The true pathological case -- OTP_MAX_ISSUER, OTP_MAX_LABEL and + * OTP_MAX_SECRET all maxed out simultaneously -- genuinely doesn't fit + * even at the version cap. That's fine: it's not a realistic account + * (see the case above for a generous-but-real one), and the point of + * this test is that qr_encode_uri() fails *cleanly* rather than + * overflowing or producing a bad code. */ + for (i = 0; i + 1 < sizeof(huge_issuer); i++) huge_issuer[i] = 'A' + (char)(i % 26); + huge_issuer[sizeof(huge_issuer) - 1] = '\0'; + for (i = 0; i + 1 < sizeof(huge_label); i++) huge_label[i] = 'a' + (char)(i % 26); + huge_label[sizeof(huge_label) - 1] = '\0'; + strcpy(a.issuer, huge_issuer); + strcpy(a.label, huge_label); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(qr_encode_uri(uri, modules, &size) == QRENC_ERR_TOOLONG); + + /* --- argument guards --- */ + TEST_CHECK(qr_encode_uri(NULL, modules, &size) == QRENC_ERR_ARGS); + TEST_CHECK(qr_encode_uri(uri, NULL, &size) == QRENC_ERR_ARGS); + TEST_CHECK(qr_encode_uri(uri, modules, NULL) == QRENC_ERR_ARGS); +} diff --git a/tests/test_uri.c b/tests/test_uri.c index fd86842..2c8927e 100644 --- a/tests/test_uri.c +++ b/tests/test_uri.c @@ -131,3 +131,68 @@ void run_bare_secret_tests(void) TEST_CHECK(otp_account_from_secret_steam("X", "", "JBSWY3DP", &a) == -1); TEST_CHECK(otp_account_from_secret_steam("X", "y", "not!base32", &a) == -1); } + +/* otpauth_build (#45, QR export): the inverse of otpauth_parse. */ +void run_uri_build_tests(void) +{ + otp_account a, b; + char uri[512]; + + /* Exact string for a simple, fully-specified TOTP account. */ + TEST_CHECK(otpauth_parse( + "otpauth://totp/GitHub:alice?secret=JBSWY3DPEHPK3PXP&issuer=GitHub" + "&digits=6&period=30", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(strcmp(uri, + "otpauth://totp/GitHub:alice?secret=JBSWY3DPEHPK3PXP&issuer=GitHub" + "&algorithm=SHA1&digits=6&period=30") == 0); + + /* Round-trip (parse -> build -> parse) preserves every field, across + * TOTP/HOTP, every algorithm, and Steam. */ + TEST_CHECK(otpauth_parse( + "otpauth://totp/x?secret=JBSWY3DP&algorithm=SHA256&digits=8&period=60", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(otpauth_parse(uri, &b) == 0); + TEST_CHECK(strcmp(a.type, b.type) == 0 && strcmp(a.algorithm, b.algorithm) == 0); + TEST_CHECK(a.digits == b.digits && a.period == b.period); + TEST_CHECK(a.secret_len == b.secret_len && + memcmp(a.secret, b.secret, a.secret_len) == 0); + + TEST_CHECK(otpauth_parse( + "otpauth://hotp/Acme:bob?secret=JBSWY3DPEHPK3PXP&algorithm=SHA512" + "&digits=8&counter=4294967297", &a) == 0); /* counter > 32 bits */ + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(otpauth_parse(uri, &b) == 0); + TEST_CHECK(strcmp(b.type, "hotp") == 0 && strcmp(b.algorithm, "SHA512") == 0); + TEST_CHECK(b.digits == 8 && b.counter == 4294967297ULL); + + TEST_CHECK(otpauth_parse( + "otpauth://steam/Steam:you?secret=JBSWY3DP&issuer=Steam", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(otpauth_parse(uri, &b) == 0); + TEST_CHECK(strcmp(b.type, "steam") == 0 && b.digits == 5); + TEST_CHECK(strcmp(b.issuer, "Steam") == 0 && strcmp(b.label, "you") == 0); + + /* Issuer/label containing space and '@' round-trip through percent + * encoding (build) and percent decoding (parse). */ + TEST_CHECK(otpauth_parse( + "otpauth://totp/Example%20Co:john%40example.com?secret=JBSWY3DP" + "&issuer=Example%20Co", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(otpauth_parse(uri, &b) == 0); + TEST_CHECK(strcmp(b.issuer, "Example Co") == 0); + TEST_CHECK(strcmp(b.label, "john@example.com") == 0); + + /* No issuer: no leading "issuer:" on the label, no &issuer= param. */ + TEST_CHECK(otpauth_parse("otpauth://totp/x?secret=JBSWY3DP", &a) == 0); + TEST_CHECK(otpauth_build(&a, uri, sizeof(uri)) == 0); + TEST_CHECK(strstr(uri, "issuer") == NULL); + TEST_CHECK(strncmp(uri, "otpauth://totp/x?", 17) == 0); + + /* Too-small buffer is an error, not a truncation. */ + TEST_CHECK(otpauth_build(&a, uri, 5) == -1); + + /* NULL arguments. */ + TEST_CHECK(otpauth_build(NULL, uri, sizeof(uri)) == -1); + TEST_CHECK(otpauth_build(&a, NULL, sizeof(uri)) == -1); +} diff --git a/userdocs/CLI-Reference.md b/userdocs/CLI-Reference.md index 8676927..b9e2b25 100644 --- a/userdocs/CLI-Reference.md +++ b/userdocs/CLI-Reference.md @@ -13,6 +13,7 @@ type `AmiAuth ?` for the template, `AmiAuth HELP` for the command list. | [`ADD`](#add) | Import an account (`otpauth://` URI or bare secret) | Yes | | [`LIST`](#list) | List account names | Yes | | [`GET`](#get) | Print the current code for an account | Yes | +| [`QR`](#qr) | Print an account as an ASCII-art QR code | Yes | | [`REMOVE`](#remove) | Delete an account | Yes | | [`SHOW`](#show) | Pop the running GUI's window to the front | No | | [`CLOCK`](#clock) | Report the UTC offset and clock trust state | No | @@ -21,7 +22,7 @@ type `AmiAuth ?` for the template, `AmiAuth HELP` for the command list. | [`NUDGE`](#nudge) | Adjust the current UTC offset by a relative amount | No | | [`HELP`](#help) | Print the usage summary | No | -When the GUI is running as a resident commodity, `ADD`, `LIST`, `GET`, +When the GUI is running as a resident commodity, `ADD`, `LIST`, `GET`, `QR`, `REMOVE` and `SHOW` are **forwarded to it** automatically — see [Working with a running GUI](#working-with-a-running-gui) below. @@ -138,6 +139,17 @@ For **HOTP** accounts, `GET` uses the stored counter, then increments it and saves the vault, as RFC 4226 requires — each `GET` produces the next code in the sequence. +### QR + + AmiAuth QR + +Prints the account's `otpauth://` enrolment as an ASCII-art QR code, two +characters per module so it reads roughly square on a typical character-cell +console — scan it with a phone's authenticator app to add the same account +there. Same account-name matching as `GET`. See [Managing Accounts → +Exporting to a phone](Managing-Accounts.md#exporting-to-a-phone) for the GUI +equivalent (*Account → Show QR code…*). + ### REMOVE AmiAuth REMOVE @@ -244,8 +256,8 @@ the offer with the `NOREKEY` switch, or permanently with ## Working with a running GUI On AmigaOS, if `AmiAuthGUI` is resident (see [Commodity and Tooltypes](Commodity-and-Tooltypes.md)), the -CLI does not open the vault itself: `ADD`, `LIST`, `GET`, `REMOVE` and `SHOW` -are forwarded to the GUI over its public `AmiAuth` message port, and the GUI +CLI does not open the vault itself: `ADD`, `LIST`, `GET`, `QR`, `REMOVE` and +`SHOW` are forwarded to the GUI over its public `AmiAuth` message port, and the GUI answers from its already-unlocked vault. You get your code with **no second passphrase prompt**, and there is never a conflict between two processes writing one vault file. diff --git a/userdocs/GUI-Guide.md b/userdocs/GUI-Guide.md index 8972cd5..549fcd9 100644 --- a/userdocs/GUI-Guide.md +++ b/userdocs/GUI-Guide.md @@ -70,12 +70,17 @@ Three ways, all under the **Account** menu: onto the window** from Workbench. See [Managing Accounts](Managing-Accounts.md) for details and requirements. -## Editing and removing +## Editing, exporting and removing - **Edit selected…** opens a requester for the **issuer**, **label**, **digits** (6–8) and **period** (1–86400 s). The label is required. The secret and account type are deliberately not editable — re-add the account if the secret changes. +- **Show QR code…** opens a window with the selected account's `otpauth://` + URI rendered as a QR code, for a phone's authenticator app to scan — the + export counterpart to *Add from QR image…*. Just a display: close it with + its close gadget or Esc. See [Managing Accounts](Managing-Accounts.md#exporting-to-a-phone) + for the CLI equivalent. - **Remove selected…** asks for confirmation, then deletes the account and saves the vault. There is no undo. @@ -89,6 +94,7 @@ Three ways, all under the **Account** menu: | | Add from QR image… | I | | | Edit selected… | E | | | Copy code | C | +| | Show QR code… | S | | | Remove selected… | R | (Standard Right-Amiga menu shortcuts — hold Right-Amiga and press the letter; diff --git a/userdocs/Managing-Accounts.md b/userdocs/Managing-Accounts.md index 80d8658..37d1e5d 100644 --- a/userdocs/Managing-Accounts.md +++ b/userdocs/Managing-Accounts.md @@ -64,6 +64,23 @@ runs on-Amiga using the bundled quirc decoder — the image never leaves your machine. A busy pointer shows while decoding; clear, screen-sized screenshots decode most reliably. +## Exporting to a phone + +To add an AmiAuth account to a phone authenticator app too (see "One secret, +two devices" below), AmiAuth can render the enrolment as a QR code — the +reverse of "From a QR image" above: + +- **GUI:** select an account, then *Account → Show QR code…* opens a window + with the code; scan it with the phone app's *"scan a QR code"* enrolment + option. Close the window (its close gadget, or Esc) when done. +- **CLI:** `AmiAuth QR ` prints the same code as ASCII block art to + the terminal — useful over a serial console or a remote shell, wherever a + phone camera can see the screen but a picture file isn't handy. + +There's no live camera scanning the other way (a classic Amiga has no +camera) — this is display/print only, generated on-Amiga from the account's +stored secret. Nothing is sent over a network. + ## Steam Guard Steam's own mobile authenticator is a TOTP variant: the same HMAC-SHA1/30-second @@ -134,7 +151,10 @@ backup ([Vault and Passphrases](Vault-and-Passphrases.md)) — before removing i - **One secret, two devices:** at enrolment you can add the same secret to AmiAuth *and* a phone app — both generate the same codes. A good hedge while - you decide how much you trust a 30-year-old computer with your logins. + you decide how much you trust a 30-year-old computer with your logins. If + you only added it to AmiAuth, [Exporting to a phone](#exporting-to-a-phone) + above adds the phone app after the fact, from AmiAuth's own copy of the + secret. - **Keep recovery codes** offline regardless. An authenticator — any authenticator — can be lost. - **Migrating from another app:** if you can export `otpauth://` URIs (or