@coderoftime/fints 0.0.0-stage → 0.1.0

package/dist/v3/dialog.js

@@ -0,0 +1,138 @@
+// Internal to the package, and named after the FinTS specification. Documentation is where the meaning is not evident.
+import { FinTsProtocolError } from '../core/errors.js';
+import { FeedbackCodes, hasCode } from '../core/feedback.js';
+import { requireBankParameters } from '../session/parameter-data.js';
+import { PinTanDialog } from '../session/pin-tan-dialog.js';
+import { TanMethod } from '../tan/tan-models.js';
+import { IncomingMessage3 } from './message.js';
+import { Segments, TanResponse } from './segments.js';
+/** Dialog ID of a dialog the bank has not answered yet, and customer system ID before synchronization. */
+const unassigned = '0';
+/** The first version of HKTAN that supports strong customer authentication. */
+const firstScaVersion = 6;
+/** The first version of HKTAN that supports app approvals, with the status request (process S). */
+const firstDecoupledVersion = 7;
+/** One FinTS 3.0 dialog: numbered messages under the dialog ID the bank assigns in its first answer. */
+export class FinTs3Dialog extends PinTanDialog {
+    host;
+    anonymous;
+    systemId;
+    id = unassigned;
+    constructor(host, method, tanMedium, anonymous) {
+        super(method, tanMedium);
+        this.host = host;
+        this.anonymous = anonymous;
+        this.systemId = anonymous ? unassigned : (host.systemId ?? unassigned);
+    }
+    static signed(host, method, tanMedium) {
+        return new FinTs3Dialog(host, method, tanMedium, false);
+    }
+    /** A dialog without login, which only delivers the bank parameter data. */
+    static anonymous(host) {
+        return new FinTs3Dialog(host, TanMethod.oneStep, undefined, true);
+    }
+    get bankParameters() {
+        return this.host.bankParameters;
+    }
+    get isActive() {
+        return this.id !== unassigned && !this.hasEnded;
+    }
+    /** The version of the HKTAN segments: that of the HITANS segment the bank describes the method in. */
+    get tanVersion() {
+        return this.bankParameters?.tanVersion(this.method) ?? firstScaVersion;
+    }
+    start(synchronize = false) {
+        if (synchronize)
+            this.systemId = unassigned;
+        return this.sendSegments([
+            ...this.host.initSegments(this.systemId),
+            ...(this.isTwoStep ? [this.tanRequest('HKIDN')] : []),
+            ...(synchronize ? [Segments.synchronization()] : []),
+        ]);
+    }
+    /**
+     * Opens the dialog, asking strong authentication for `order` with a two-step method, then sends `order` in the next
+     * message.
+     */
+    startWith(order) {
+        return {
+            login: () => this.sendSegments([
+                ...this.host.initSegments(this.systemId),
+                ...(this.isTwoStep ? [this.tanRequest(order.type)] : []),
+            ]),
+            order: () => this.sendSegments([order]),
+        };
+    }
+    /**
+     * Opens the anonymous dialog; the answer carries the bank parameter data.
+     *
+     * With `announceSca` the message also carries HKTAN, the way a client that can do strong customer authentication
+     * tells the bank so, whereupon the bank may send parameter data suited to it (PIN/TAN, B.4.3.1).
+     */
+    requestBankParameters(announceSca = false) {
+        return this.sendSegments([
+            ...this.host.initSegments(unassigned, true),
+            ...(announceSca ? [Segments.tanProcess4(firstScaVersion, 'HKIDN')] : []),
+        ]);
+    }
+    send(order) {
+        const needsTan = this.isTwoStep && requireBankParameters(this.bankParameters).pinTan.requiresTan(order.type);
+        return this.sendSegments([order, ...(needsTan ? [this.tanRequest(order.type)] : [])]);
+    }
+    async sendEnd() {
+        await this.sendSegments([Segments.dialogEnd(this.id)]);
+    }
+    tanRequest(segmentType) {
+        return Segments.tanProcess4(this.tanVersion, segmentType, this.mediumName);
+    }
+    /**
+     * The approval a HITAN segment of process 4 asks for, answered with HKTAN process 2 (TAN) or S (status).
+     *
+     * Throws `FinTsProtocolError` for an app approval with a method of HITANS #6: the status request (process S) came with
+     * version 7, along with app approvals (PIN/TAN B.5.2).
+     */
+    approvalIn(response) {
+        const tan = tanResponseOf(response, '4');
+        if (tan === undefined || tan.isDummy)
+            return undefined;
+        if (hasCode(response.feedback, FeedbackCodes.decoupledPending) && this.tanVersion < firstDecoupledVersion) {
+            throw new FinTsProtocolError('The bank asks for an app approval, which needs HKTAN version 7');
+        }
+        const reference = tan.reference;
+        return this.approvalOf(response, {
+            reference,
+            message: tan.challenge,
+            hhdUc: tan.hhdUc,
+            validUntil: tan.validUntil,
+            tanMediumName: tan.mediumName,
+            submitTan: (value) => this.sendSegments([Segments.tanProcess2(this.tanVersion, reference)], value),
+            checkStatus: () => this.sendSegments([Segments.tanProcessStatus(this.tanVersion, reference)]),
+            // A status answer that the approval is still pending may carry new instructions (PIN/TAN B.4.2.2.1, step 2b).
+            instructionsIn: (status) => tanResponseOf(status, 'S')?.challenge,
+        });
+    }
+    sendSegments(segments, tan) {
+        return this.transmit((number) => this.host.post({
+            dialogId: this.id,
+            number,
+            segments,
+            signing: this.anonymous
+                ? undefined
+                : { securityFunction: this.method.securityFunction, systemId: this.systemId },
+            tan,
+        }), (answer) => IncomingMessage3.parse(answer));
+    }
+    /** The bank assigns the dialog ID in its answer to the first message. */
+    readDialogData(response) {
+        if (this.id === unassigned)
+            this.id = response.dialogId ?? unassigned;
+    }
+}
+/** The TAN part of `response` that answers TAN `process`. */
+function tanResponseOf(response, process) {
+    return response
+        .findAll('HITAN')
+        .map((s) => TanResponse.parse(s))
+        .find((t) => t.process === process);
+}
+//# sourceMappingURL=dialog.js.map

package/dist/v3/dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.js","sourceRoot":"","sources":["../../src/v3/dialog.ts"],"names":[],"mappings":"AAAA,uHAAuH;AAEvH,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGtD,0GAA0G;AAC1G,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB,+EAA+E;AAC/E,MAAM,eAAe,GAAG,CAAC,CAAC;AAE1B,mGAAmG;AACnG,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAqChC,wGAAwG;AACxG,MAAM,OAAO,YAAa,SAAQ,YAA2C;IAKxD;IAGA;IAPX,QAAQ,CAAS;IACjB,EAAE,GAAG,UAAU,CAAC;IAExB,YACmB,IAAsB,EACvC,MAAiB,EACjB,SAA6B,EACZ,SAAkB;QAEnC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QALR,SAAI,GAAJ,IAAI,CAAkB;QAGtB,cAAS,GAAT,SAAS,CAAS;QAGnC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAsB,EAAE,MAAiB,EAAE,SAAkB;QACzE,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,SAAS,CAAC,IAAsB;QACrC,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,IAAc,cAAc;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;IAClC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,EAAE,KAAK,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAClD,CAAC;IAED,sGAAsG;IACtG,IAAY,UAAU;QACpB,OAAO,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,WAAW,GAAG,KAAK;QACvB,IAAI,WAAW;YAAE,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC;QAC5C,OAAO,IAAI,CAAC,YAAY,CAAC;YACvB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACrD,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAkB;QAC1B,OAAO;YACL,KAAK,EAAE,GAAG,EAAE,CACV,IAAI,CAAC,YAAY,CAAC;gBAChB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACxC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACzD,CAAC;YACJ,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC;SACxC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,WAAW,GAAG,KAAK;QACvC,OAAO,IAAI,CAAC,YAAY,CAAC;YACvB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC;YAC3C,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACzE,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,KAAkB;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,qBAAqB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7G,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAES,KAAK,CAAC,OAAO;QACrB,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAEO,UAAU,CAAC,WAAmB;QACpC,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACO,UAAU,CAAC,QAA0B;QAC7C,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACzC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QACvD,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,UAAU,GAAG,qBAAqB,EAAE,CAAC;YAC1G,MAAM,IAAI,kBAAkB,CAAC,gEAAgE,CAAC,CAAC;QACjG,CAAC;QACD,MAAM,SAAS,GAAG,GAAG,CAAC,SAAU,CAAC;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC/B,SAAS;YACT,OAAO,EAAE,GAAG,CAAC,SAAS;YACtB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,aAAa,EAAE,GAAG,CAAC,UAAU;YAC7B,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC;YAClG,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;YAC7F,8GAA8G;YAC9G,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS;SAClE,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,QAAgC,EAAE,GAAY;QACjE,OAAO,IAAI,CAAC,QAAQ,CAClB,CAAC,MAAM,EAAE,EAAE,CACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACb,QAAQ,EAAE,IAAI,CAAC,EAAE;YACjB,MAAM;YACN,QAAQ;YACR,OAAO,EAAE,IAAI,CAAC,SAAS;gBACrB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;YAC/E,GAAG;SACJ,CAAC,EACJ,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAC3C,CAAC;IACJ,CAAC;IAED,yEAAyE;IAC/D,cAAc,CAAC,QAA0B;QACjD,IAAI,IAAI,CAAC,EAAE,KAAK,UAAU;YAAE,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,IAAI,UAAU,CAAC;IACxE,CAAC;CACF;AAED,6DAA6D;AAC7D,SAAS,aAAa,CAAC,QAA0B,EAAE,OAAe;IAChE,OAAO,QAAQ;SACZ,OAAO,CAAC,OAAO,CAAC;SAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAChC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/v3/message.d.ts

@@ -0,0 +1,72 @@
+import { BankMessage } from '../core/bank-info.js';
+import { FinTsFeedback } from '../core/feedback.js';
+import type { BankResponse } from '../session/protocol.js';
+import { type Segment, SegmentSpec } from './syntax.js';
+/** Signature data of a PIN/TAN message. */
+export interface PinTanCredentials {
+    readonly countryCode: string;
+    readonly bankCode: string;
+    readonly userId: string;
+    readonly systemId: string;
+    readonly pin: string;
+    readonly securityFunction: string;
+}
+/** A message to send, and the same message with PIN and TAN masked for logging. */
+export declare class OutgoingMessage {
+    readonly bytes: Uint8Array;
+    /** The parts of the masked message, each decoded on its own as the bank's text is. */
+    private readonly maskedParts;
+    constructor(bytes: Uint8Array, 
+    /** The parts of the masked message, each decoded on its own as the bank's text is. */
+    maskedParts: readonly Uint8Array[]);
+    /** The message with PIN and TAN masked; decoded only when a logger asks for it. */
+    get masked(): string;
+}
+/**
+ * Builds a message: header (HNHBK), the `segments`, trailer (HNHBS).
+ *
+ * With `security` the segments are signed with PIN and optional `tan` (HNSHK … HNSHA) and wrapped in the encryption
+ * envelope (HNVSK, HNVSD) that PIN/TAN uses without actual encryption.
+ *
+ * The masked message states the sizes of its masked content, so that the log does not tell how long PIN and TAN are.
+ */
+export declare function buildMessage(parts: {
+    dialogId: string;
+    messageNumber: number;
+    segments: readonly SegmentSpec[];
+    security?: PinTanCredentials | undefined;
+    tan?: string | undefined;
+    now?: Date;
+}): OutgoingMessage;
+/** A received message, with the segments of the encryption envelope unpacked. */
+export declare class IncomingMessage3 implements BankResponse {
+    readonly segments: readonly Segment[];
+    readonly size: number;
+    /**
+     * Return codes for the whole message (HIRMG), then for single request segments (HIRMS).
+     *
+     * The segment a HIRMS refers to is not kept: each message carries one order, and the answer that completes an
+     * approval reports on the order of an earlier message (PIN/TAN B.4.2.1).
+     */
+    readonly feedback: readonly FinTsFeedback[];
+    readonly messageRejected: boolean;
+    private constructor();
+    /**
+     * Parses a message; throws `FormatError` if `data` is not a FinTS message, such as the HTML page of a proxy or a
+     * maintenance notice.
+     */
+    static parse(data: Uint8Array): IncomingMessage3;
+    static combine(first: IncomingMessage3, second: IncomingMessage3): IncomingMessage3;
+    get bankMessages(): BankMessage[];
+    get dialogId(): string | undefined;
+    find(type: string): Segment | undefined;
+    findAll(type: string): Segment[];
+}
+/**
+ * Unpacks the transport encoding: PIN/TAN servers answer in base64, a few with the raw message.
+ *
+ * Returns anything else unchanged, for `IncomingMessage3.parse` to reject.
+ */
+export declare function decodeTransport(body: Uint8Array): Uint8Array;
+export declare function encodeTransport(message: Uint8Array): Uint8Array;
+//# sourceMappingURL=message.d.ts.map

package/dist/v3/message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/v3/message.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAM3D,OAAO,EAAyB,KAAK,OAAO,EAAE,WAAW,EAAqB,MAAM,aAAa,CAAC;AAElG,2CAA2C;AAC3C,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC;AA+DD,mFAAmF;AACnF,qBAAa,eAAe;IAExB,QAAQ,CAAC,KAAK,EAAE,UAAU;IAC1B,sFAAsF;IACtF,OAAO,CAAC,QAAQ,CAAC,WAAW;gBAFnB,KAAK,EAAE,UAAU;IAC1B,sFAAsF;IACrE,WAAW,EAAE,SAAS,UAAU,EAAE;IAGrD,mFAAmF;IACnF,IAAI,MAAM,IAAI,MAAM,CAEnB;CACF;AASD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACzC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,IAAI,CAAC;CACZ,GAAG,eAAe,CAelB;AAgFD,iFAAiF;AACjF,qBAAa,gBAAiB,YAAW,YAAY;IAYjD,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAZvB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IAE5C,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAElC,OAAO;IAaP;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,gBAAgB;IAehD,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAInF,IAAI,YAAY,IAAI,WAAW,EAAE,CAEhC;IAED,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAIvC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE;CAGjC;AAeD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAQ5D;AAaD,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,CAE/D"}

package/dist/v3/message.js

@@ -0,0 +1,259 @@
+// Internal to the package, and named after the FinTS specification. Documentation is where the meaning is not evident.
+import { BankMessage } from '../core/bank-info.js';
+import { FinTsFeedback } from '../core/feedback.js';
+import { TanMethod } from '../tan/tan-models.js';
+import { base64Encode, BytesBuilder, latin1Decode, latin1Encode } from '../util/bytes.js';
+import { formatFintsDate, formatFintsTime } from '../util/dates.js';
+import { FormatError } from '../util/errors.js';
+import { decodeBankText, decodeBase64Lines } from '../util/text.js';
+import { Binary, parseSegments, SegmentSpec } from './syntax.js';
+function isTwoStep(c) {
+    return c.securityFunction !== TanMethod.oneStep.securityFunction;
+}
+// Codes of the PIN/TAN security envelope, from the FinTS security specification. PIN/TAN neither hashes, signs nor
+// encrypts, but the envelope must name the algorithms of the chip card procedures all the same.
+/** Area the signature covers: signature head and data (SHM). */
+const signedArea = 1;
+/** Role of the security supplier: issuer (ISS). */
+const issuer = 1;
+/** Security identification: message sender (MS), empty CID, then the customer system ID. */
+function sender(systemId) {
+    return [1, null, systemId];
+}
+/** Security reference number, the same in every message. */
+const securityReference = 1;
+/** Security time stamp (STS). */
+function timestamp(time) {
+    return [1, formatFintsDate(time), formatFintsTime(time)];
+}
+/** Hash algorithm: owner hashing (OHA), mutually agreed algorithm (ZZZ), initialisation value in clear (IVC). */
+const hashAlgorithm = [1, 999, 1];
+/** Signature algorithm: owner signing (OSG), RSA, ISO 9796-1. */
+const signatureAlgorithm = [6, 10, 16];
+/** Security function of the encryption head: plain text, since PIN/TAN does not encrypt. */
+const plainText = 998;
+/**
+ * Encryption algorithm: owner symmetric (OSY), CBC, 2-key triple DES, a key of zeros, symmetric key (KYE),
+ * initialisation value in clear (IVC).
+ */
+const encryptionAlgorithm = [2, 2, 13, new Binary(new Uint8Array(8)), 5, 1];
+/** Compression function: none. */
+const noCompression = 0;
+/** Key name: bank, user, key type `S` (signature) or `V` (encryption), key number and version 0. */
+function keyName(c, keyType) {
+    return [c.countryCode, c.bankCode, c.userId, keyType, 0, 0];
+}
+/** A random integer from 0 below `bound`, from a cryptographically secure source. */
+function secureRandom(bound) {
+    const values = new Uint32Array(1);
+    crypto.getRandomValues(values);
+    return values[0] % bound;
+}
+/** A random 14-digit reference that ties the signature head (HNSHK) to the signature end (HNSHA). */
+function securityControlReference() {
+    return `${secureRandom(900000000) + 100000000}${secureRandom(100000).toString().padStart(5, '0')}`;
+}
+/** A message to send, and the same message with PIN and TAN masked for logging. */
+export class OutgoingMessage {
+    bytes;
+    maskedParts;
+    constructor(bytes, 
+    /** The parts of the masked message, each decoded on its own as the bank's text is. */
+    maskedParts) {
+        this.bytes = bytes;
+        this.maskedParts = maskedParts;
+    }
+    /** The message with PIN and TAN masked; decoded only when a logger asks for it. */
+    get masked() {
+        return this.maskedParts.map(decodeBankText).join('');
+    }
+}
+/**
+ * Builds a message: header (HNHBK), the `segments`, trailer (HNHBS).
+ *
+ * With `security` the segments are signed with PIN and optional `tan` (HNSHK … HNSHA) and wrapped in the encryption
+ * envelope (HNVSK, HNVSD) that PIN/TAN uses without actual encryption.
+ *
+ * The masked message states the sizes of its masked content, so that the log does not tell how long PIN and TAN are.
+ */
+export function buildMessage(parts) {
+    const body = parts.security === undefined
+        ? plainBody(parts.segments)
+        : signedBody(parts.segments, parts.security, parts.tan, parts.now ?? new Date());
+    const trailer = new SegmentSpec('HNHBS', 1, [parts.messageNumber]).build(body.nextNumber);
+    // The header states the size of the whole message, itself included; its own size does not depend on it.
+    const header = (size) => new SegmentSpec('HNHBK', 3, [size.toString().padStart(12, '0'), 300, parts.dialogId, parts.messageNumber]).build(1);
+    const sizeOf = (sections) => header(0).length + lengthOf(sections) + trailer.length;
+    const result = new BytesBuilder();
+    result.add(header(sizeOf([body.bytes])));
+    result.add(body.bytes);
+    result.add(trailer);
+    return new OutgoingMessage(result.takeBytes(), [header(sizeOf(body.masked)), ...body.masked, trailer]);
+}
+/** The number of bytes in `parts` together. */
+function lengthOf(parts) {
+    return parts.reduce((sum, part) => sum + part.length, 0);
+}
+/** The segments of a message without security, as the anonymous dialog sends them. */
+function plainBody(segments) {
+    const built = segments.map((segment, i) => segment.build(i + 2));
+    const bytes = new BytesBuilder();
+    built.forEach((b) => {
+        bytes.add(b);
+    });
+    return { bytes: bytes.takeBytes(), masked: built, nextNumber: built.length + 2 };
+}
+/** The segments signed with PIN and optional `tan`, inside the encryption envelope. */
+function signedBody(segments, security, tan, time) {
+    const profile = ['PIN', isTwoStep(security) ? 2 : 1];
+    const controlReference = securityControlReference();
+    const inner = new BytesBuilder();
+    const maskedInner = [];
+    const addInner = (built, masked) => {
+        inner.add(built);
+        maskedInner.push(masked ?? built);
+    };
+    addInner(new SegmentSpec('HNSHK', 4, [
+        profile,
+        security.securityFunction,
+        controlReference,
+        signedArea,
+        issuer,
+        sender(security.systemId),
+        securityReference,
+        timestamp(time),
+        hashAlgorithm,
+        signatureAlgorithm,
+        keyName(security, 'S'),
+    ]).build(2));
+    let number = 3;
+    for (const segment of segments)
+        addInner(segment.build(number++));
+    const signatureEnd = (pin, tanValue) => new SegmentSpec('HNSHA', 2, [controlReference, null, [pin, tanValue]]);
+    addInner(signatureEnd(security.pin, tan).build(number), signatureEnd('***', tan === undefined ? undefined : '***').build(number));
+    const innerBytes = inner.takeBytes();
+    const encryptionHead = new SegmentSpec('HNVSK', 3, [
+        profile,
+        plainText,
+        issuer,
+        sender(security.systemId),
+        timestamp(time),
+        encryptionAlgorithm,
+        keyName(security, 'V'),
+        noCompression,
+    ]).build(998);
+    const bytes = new BytesBuilder();
+    bytes.add(encryptionHead);
+    bytes.add(new SegmentSpec('HNVSD', 1, [new Binary(innerBytes)]).build(999));
+    const masked = [
+        encryptionHead,
+        latin1Encode(`HNVSD:999:1+@${lengthOf(maskedInner)}@`),
+        ...maskedInner,
+        latin1Encode("'"),
+    ];
+    return { bytes: bytes.takeBytes(), masked, nextNumber: number + 1 };
+}
+/** A received message, with the segments of the encryption envelope unpacked. */
+export class IncomingMessage3 {
+    segments;
+    size;
+    /**
+     * Return codes for the whole message (HIRMG), then for single request segments (HIRMS).
+     *
+     * The segment a HIRMS refers to is not kept: each message carries one order, and the answer that completes an
+     * approval reports on the order of an earlier message (PIN/TAN B.4.2.1).
+     */
+    feedback;
+    messageRejected;
+    constructor(segments, size) {
+        this.segments = segments;
+        this.size = size;
+        this.feedback = Object.freeze(['HIRMG', 'HIRMS'].flatMap((type) => segments.filter((s) => s.type === type).flatMap(feedbackOf)));
+        this.messageRejected = segments
+            .filter((s) => s.type === 'HIRMG')
+            .flatMap(feedbackOf)
+            .some((f) => f.isError);
+    }
+    /**
+     * Parses a message; throws `FormatError` if `data` is not a FinTS message, such as the HTML page of a proxy or a
+     * maintenance notice.
+     */
+    static parse(data) {
+        const outer = parseSegments(data);
+        if (outer[0]?.type !== 'HNHBK')
+            throw new FormatError('Not a FinTS message: no message header');
+        const segments = [];
+        for (const s of outer) {
+            if (s.type === 'HNVSD') {
+                const payload = s.binary(1);
+                if (payload !== undefined)
+                    segments.push(...parseSegments(payload));
+            }
+            else {
+                segments.push(s);
+            }
+        }
+        return new IncomingMessage3(segments, data.length);
+    }
+    static combine(first, second) {
+        return new IncomingMessage3([...first.segments, ...second.segments], first.size + second.size);
+    }
+    get bankMessages() {
+        return this.findAll('HIKIM').map((m) => new BankMessage(m.text(1) ?? '', m.text(2) ?? ''));
+    }
+    get dialogId() {
+        return this.find('HNHBK')?.text(3);
+    }
+    find(type) {
+        return this.segments.find((s) => s.type === type);
+    }
+    findAll(type) {
+        return this.segments.filter((s) => s.type === type);
+    }
+}
+function feedbackOf(s) {
+    const feedback = [];
+    for (let i = 1; i < s.length; i++) {
+        const code = s.text(i);
+        if (code === undefined)
+            continue;
+        const parameters = [];
+        // Empty parameters stay, as empty text, so that each keeps its position.
+        for (let j = 3; j < s.group(i).length; j++)
+            parameters.push(s.text(i, j) ?? '');
+        feedback.push(new FinTsFeedback({ code, reference: s.text(i, 1), text: s.text(i, 2) ?? '', parameters }));
+    }
+    return feedback;
+}
+/**
+ * Unpacks the transport encoding: PIN/TAN servers answer in base64, a few with the raw message.
+ *
+ * Returns anything else unchanged, for `IncomingMessage3.parse` to reject.
+ */
+export function decodeTransport(body) {
+    if (startsWithMessageHeader(body))
+        return body;
+    try {
+        return decodeBase64Lines(latin1Decode(body));
+    }
+    catch (error) {
+        if (error instanceof FormatError)
+            return body;
+        throw error;
+    }
+}
+const messageHeader = latin1Encode('HNHBK');
+const whitespaceBytes = new Set([0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x20]);
+/** Whether `body` is a raw message: its header segment comes first, after any white space. */
+function startsWithMessageHeader(body) {
+    let start = 0;
+    while (start < body.length && whitespaceBytes.has(body[start]))
+        start++;
+    if (body.length - start < messageHeader.length)
+        return false;
+    return messageHeader.every((byte, i) => body[start + i] === byte);
+}
+export function encodeTransport(message) {
+    return latin1Encode(base64Encode(message));
+}
+//# sourceMappingURL=message.js.map

package/dist/v3/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/v3/message.ts"],"names":[],"mappings":"AAAA,uHAAuH;AAEvH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAgB,WAAW,EAAqB,MAAM,aAAa,CAAC;AAYlG,SAAS,SAAS,CAAC,CAAoB;IACrC,OAAO,CAAC,CAAC,gBAAgB,KAAK,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC;AACnE,CAAC;AAED,mHAAmH;AACnH,gGAAgG;AAEhG,gEAAgE;AAChE,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,mDAAmD;AACnD,MAAM,MAAM,GAAG,CAAC,CAAC;AAEjB,4FAA4F;AAC5F,SAAS,MAAM,CAAC,QAAgB;IAC9B,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED,4DAA4D;AAC5D,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B,iCAAiC;AACjC,SAAS,SAAS,CAAC,IAAU;IAC3B,OAAO,CAAC,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,iHAAiH;AACjH,MAAM,aAAa,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAElC,iEAAiE;AACjE,MAAM,kBAAkB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;AAEvC,4FAA4F;AAC5F,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAE5E,kCAAkC;AAClC,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,oGAAoG;AACpG,SAAS,OAAO,CAAC,CAAoB,EAAE,OAAe;IACpD,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,qFAAqF;AACrF,SAAS,YAAY,CAAC,KAAa;IACjC,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC,CAAC,CAAE,GAAG,KAAK,CAAC;AAC5B,CAAC;AAED,qGAAqG;AACrG,SAAS,wBAAwB;IAC/B,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AACrG,CAAC;AAED,mFAAmF;AACnF,MAAM,OAAO,eAAe;IAEf;IAEQ;IAHnB,YACW,KAAiB;IAC1B,sFAAsF;IACrE,WAAkC;QAF1C,UAAK,GAAL,KAAK,CAAY;QAET,gBAAW,GAAX,WAAW,CAAuB;IAClD,CAAC;IAEJ,mFAAmF;IACnF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AASD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,KAO5B;IACC,MAAM,IAAI,GACR,KAAK,CAAC,QAAQ,KAAK,SAAS;QAC1B,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3B,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;IACrF,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC1F,wGAAwG;IACxG,MAAM,MAAM,GAAG,CAAC,IAAY,EAAc,EAAE,CAC1C,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtH,MAAM,MAAM,GAAG,CAAC,QAA+B,EAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACnH,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpB,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,+CAA+C;AAC/C,SAAS,QAAQ,CAAC,KAA4B;IAC5C,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,sFAAsF;AACtF,SAAS,SAAS,CAAC,QAAgC;IACjD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAClB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,uFAAuF;AACvF,SAAS,UAAU,CACjB,QAAgC,EAChC,QAA2B,EAC3B,GAAuB,EACvB,IAAU;IAEV,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,MAAM,gBAAgB,GAAG,wBAAwB,EAAE,CAAC;IACpD,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,MAAmB,EAAQ,EAAE;QAChE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,QAAQ,CACN,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE;QAC1B,OAAO;QACP,QAAQ,CAAC,gBAAgB;QACzB,gBAAgB;QAChB,UAAU;QACV,MAAM;QACN,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACzB,iBAAiB;QACjB,SAAS,CAAC,IAAI,CAAC;QACf,aAAa;QACb,kBAAkB;QAClB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;KACvB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CACZ,CAAC;IACF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,OAAO,IAAI,QAAQ;QAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAClE,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,QAA4B,EAAe,EAAE,CAC9E,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACzE,QAAQ,CACN,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAC7C,YAAY,CAAC,KAAK,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CACzE,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IACrC,MAAM,cAAc,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE;QACjD,OAAO;QACP,SAAS;QACT,MAAM;QACN,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACzB,SAAS,CAAC,IAAI,CAAC;QACf,mBAAmB;QACnB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;QACtB,aAAa;KACd,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACd,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1B,KAAK,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG;QACb,cAAc;QACd,YAAY,CAAC,gBAAgB,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC;QACtD,GAAG,WAAW;QACd,YAAY,CAAC,GAAG,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;AACtE,CAAC;AAED,iFAAiF;AACjF,MAAM,OAAO,gBAAgB;IAYhB;IACA;IAZX;;;;;OAKG;IACM,QAAQ,CAA2B;IAEnC,eAAe,CAAU;IAElC,YACW,QAA4B,EAC5B,IAAY;QADZ,aAAQ,GAAR,QAAQ,CAAoB;QAC5B,SAAI,GAAJ,IAAI,CAAQ;QAErB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC3B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAClG,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,QAAQ;aAC5B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC;aACjC,OAAO,CAAC,UAAU,CAAC;aACnB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,IAAgB;QAC3B,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,OAAO;YAAE,MAAM,IAAI,WAAW,CAAC,wCAAwC,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBACvB,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,OAAO,KAAK,SAAS;oBAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;YACtE,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,KAAuB,EAAE,MAAwB;QAC9D,OAAO,IAAI,gBAAgB,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAU;IAC5B,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,IAAI,KAAK,SAAS;YAAE,SAAS;QACjC,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,yEAAyE;QACzE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAChF,QAAQ,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAC5G,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAgB;IAC9C,IAAI,uBAAuB,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,IAAI,CAAC;QACH,OAAO,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW;YAAE,OAAO,IAAI,CAAC;QAC9C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAC5C,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAEtE,8FAA8F;AAC9F,SAAS,uBAAuB,CAAC,IAAgB;IAC/C,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC;QAAE,KAAK,EAAE,CAAC;IACzE,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,GAAG,aAAa,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC7D,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAmB;IACjD,OAAO,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7C,CAAC"}

package/dist/v3/parameters.d.ts

@@ -0,0 +1,79 @@
+import { Account } from '../core/account.js';
+import type { Balance } from '../core/balance.js';
+import { BankInfo } from '../core/bank-info.js';
+import { type BankParameters, type UserParameters } from '../session/parameter-data.js';
+import { TanMethod } from '../tan/tan-models.js';
+import { type Segment } from './syntax.js';
+/** FinTS 3.0 bank parameter data (BPD): HIBPA and the parameter segments (`HI…S`), parsed once. */
+export declare class Bpd3 implements BankParameters {
+    readonly segments: readonly Segment[];
+    readonly bankInfo: BankInfo;
+    /** The two-step TAN methods of HITANS versions 6 and 7, by security function. */
+    private readonly offeredMethods;
+    readonly tanMethods: readonly TanMethod[];
+    readonly unsupportedTanMethods: readonly string[];
+    readonly pinTan: PinTanParameters;
+    /** camt formats the bank offers for HKCAZ. */
+    readonly camtFormats: readonly string[];
+    /** Versions of each parameter segment, by segment type. */
+    private readonly versions;
+    /**
+     * The dialog language HKVVB names: the bank's standard language (HIKOM), else the first it supports (HIBPA). Only
+     * these may be sent once the parameter data are known; `0`, the default, only before (Formals C.3.1.3).
+     */
+    readonly dialogLanguage: number;
+    private constructor();
+    get version(): number;
+    get pinLength(): {
+        min: number | undefined;
+        max: number | undefined;
+    };
+    allowsWithPinTan(transaction: string): boolean;
+    /** The BPD in `all`, or `undefined` if they contain no HIBPA segment. */
+    static fromSegments(all: readonly Segment[], fallbackBankCode: string): Bpd3 | undefined;
+    /** The parameter segment type of a business transaction: `HKSAL` → `HISALS`. */
+    static parameterName(transaction: string): string;
+    bestVersion(transaction: string, implemented: ReadonlySet<number>): number | undefined;
+    /** The version of the HKTAN segments that go with `method`; `undefined` for a method the bank does not offer. */
+    tanVersion(method: TanMethod): number | undefined;
+}
+/**
+ * PIN/TAN parameters (HIPINS): the PIN length, which business transactions PIN/TAN allows, and which of them need a
+ * TAN.
+ */
+export declare class PinTanParameters {
+    private readonly tanRequired;
+    /** The shortest and longest PIN the bank takes. */
+    readonly pinLength: {
+        min: number | undefined;
+        max: number | undefined;
+    };
+    private constructor();
+    /** Reads the HIPINS segment of the highest version. */
+    static parse(segments: readonly Segment[]): PinTanParameters;
+    /** Whether the bank wants a TAN for the business transaction of `segmentType`, such as `HKKAZ`. */
+    requiresTan(segmentType: string): boolean;
+    /** Whether PIN/TAN allows `segmentType` at all: HIPINS lists it, or lists no business transactions (PIN/TAN B.8.1). */
+    allowsWithPinTan(segmentType: string): boolean;
+}
+/** FinTS 3.0 user parameter data (UPD): HIUPA and the accounts (HIUPD), parsed once. */
+export declare class Upd3 implements UserParameters {
+    readonly segments: readonly Segment[];
+    readonly version: number;
+    readonly listsAllTransactions: boolean;
+    readonly listedTransactions: ReadonlySet<string>;
+    /** The accounts with the extension each carries, where it does. */
+    private readonly entries;
+    readonly accounts: readonly Account[];
+    /** `listsAll` tells whether HIUPA declares the lists of permitted transactions complete ("UPD-Verwendung" 0). */
+    private constructor();
+    /** FinTS 3.0 UPD do not list the allowed TAN methods; the bank reports them with return code 3920. */
+    get allowedTanMethods(): readonly string[];
+    completeBalance(account: Account): Balance | undefined;
+    /** The UPD in `all`, or `undefined` if they contain no HIUPA segment. */
+    static fromSegments(all: readonly Segment[], defaultBankCode: string, defaultCountry: string): Upd3 | undefined;
+}
+/** Serializes parameter segments for the saved state. */
+export declare function encodeSegments(segments: readonly Segment[]): string;
+export declare function decodeSegments(data: string): Segment[];
+//# sourceMappingURL=parameters.d.ts.map

package/dist/v3/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/v3/parameters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAwB,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9G,OAAO,EAAE,SAAS,EAA0B,MAAM,sBAAsB,CAAC;AAIzE,OAAO,EAAiB,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAsC1D,mGAAmG;AACnG,qBAAa,IAAK,YAAW,cAAc;IAuBvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE;IAtBvC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,iFAAiF;IACjF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqC;IAEpE,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,SAAS,MAAM,EAAE,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC,8CAA8C;IAC9C,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAExC,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IAEpE;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,OAAO;IA8BP,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,SAAS,IAAI;QAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAEpE;IAED,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAI9C,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,gBAAgB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMxF,gFAAgF;IAChF,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIjD,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,SAAS;IAItF,iHAAiH;IACjH,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAGlD;AAsHD;;;GAGG;AACH,qBAAa,gBAAgB;IAEzB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;IAH1E,OAAO;IAMP,uDAAuD;IACvD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,GAAG,gBAAgB;IAgB5D,mGAAmG;IACnG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAIzC,uHAAuH;IACvH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;CAG/C;AAcD,wFAAwF;AACxF,qBAAa,IAAK,YAAW,cAAc;IAWvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE;IAVvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAEjD,mEAAmE;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAEtC,iHAAiH;IACjH,OAAO;IAiBP,sGAAsG;IACtG,IAAI,iBAAiB,IAAI,SAAS,MAAM,EAAE,CAEzC;IAED,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAItD,yEAAyE;IACzE,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;CAMhH;AA+FD,yDAAyD;AACzD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,CAInE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,CAEtD"}