@floegence/flowersec-core 2.5.4 → 3.0.0

package/dist/v3/protocol.d.ts

@@ -0,0 +1,99 @@
+export declare class ProtocolV3Error extends Error {
+}
+export declare enum DirectionV3 {
+    ClientToServer = 1,
+    ServerToClient = 2
+}
+export declare enum CipherSuiteV3 {
+    ChaCha20Poly1305 = 1,
+    AES256GCM = 2
+}
+export type EpochRootsV3 = Readonly<{
+    epochSecret: Uint8Array;
+    controlRoot: Uint8Array;
+    streamRoot: Uint8Array;
+    setupRoot: Uint8Array;
+    rekeyRoot: Uint8Array;
+}>;
+export type RecordMaterialV3 = Readonly<{
+    secret: Uint8Array;
+    recordKey: Uint8Array;
+    noncePrefix: Uint8Array;
+}>;
+export type SetupPrefaceV3 = Readonly<{
+    openerRole: 1 | 2;
+    logicalStreamID: bigint;
+    initialSendEpoch: number;
+    setupMAC: Uint8Array;
+}>;
+export type RecordHeaderV3 = Readonly<{
+    epoch: number;
+    sequence: bigint;
+    ciphertextLength: number;
+}>;
+export type OpenPayloadV3 = Readonly<{
+    logicalStreamID: bigint;
+    fss3Hash: Uint8Array;
+    kind: string;
+    metadata: Uint8Array;
+}>;
+export declare enum InnerTypeV3 {
+    Open = 1,
+    OpenACK = 2,
+    OpenReject = 3,
+    Data = 4,
+    FIN = 5,
+    StreamKeyUpdate = 6,
+    SessionReady = 16,
+    Ping = 17,
+    Pong = 18,
+    SessionKeyUpdate = 19,
+    StreamReset = 20,
+    GoAway = 21,
+    SessionClose = 22,
+    SessionReadyACK = 23,
+    SessionKeyUpdateACK = 24,
+    StreamKeyUpdateACK = 25,
+    SessionReadyConfirm = 26
+}
+export type InnerRecordV3 = Readonly<{
+    type: InnerTypeV3;
+    payload: Uint8Array;
+}>;
+export type OpenRejectV3 = Readonly<{
+    openHash: Uint8Array;
+    reason: number;
+    knownReason: boolean;
+}>;
+export type StreamKeyUpdateACKV3 = Readonly<{
+    logicalStreamID: bigint;
+    transition: bigint;
+    epoch: number;
+}>;
+export declare function deriveEpochZero(sessionPRK: Uint8Array, direction: DirectionV3): EpochRootsV3;
+export declare function deriveEpochRoots(epochSecret: Uint8Array): EpochRootsV3;
+export declare function deriveNextEpoch(rekeyRoot: Uint8Array, h3: Uint8Array, direction: DirectionV3, nextEpoch: number): Uint8Array;
+export declare function deriveStreamMaterial(streamRoot: Uint8Array, h3: Uint8Array, logicalStreamID: bigint, direction: DirectionV3, epoch: number): RecordMaterialV3;
+export declare function deriveControlMaterial(controlRoot: Uint8Array, h3: Uint8Array, direction: DirectionV3, epoch: number): RecordMaterialV3;
+export declare function computeSetupMAC(setupRoot: Uint8Array, h3: Uint8Array, preface: SetupPrefaceV3): Uint8Array;
+export declare function encodeSetupPreface(preface: SetupPrefaceV3): Uint8Array;
+export declare function decodeSetupPrefaceV3(raw: Uint8Array): SetupPrefaceV3;
+export declare function verifySetupMAC(setupRoot: Uint8Array, h3: Uint8Array, preface: SetupPrefaceV3): boolean;
+export declare function computeFSS3HashV3(raw: Uint8Array): Uint8Array;
+export declare function encodeRecordHeader(header: RecordHeaderV3): Uint8Array;
+export declare function decodeRecordHeader(raw: Uint8Array): RecordHeaderV3;
+export declare function buildDataInner(payload: Uint8Array): Uint8Array;
+export declare function encodeInnerRecordV3(type: InnerTypeV3, payload: Uint8Array): Uint8Array;
+export declare function decodeInnerRecordV3(raw: Uint8Array): InnerRecordV3;
+export declare function encodeOpenPayload(payload: OpenPayloadV3): Uint8Array;
+export declare function decodeOpenPayload(raw: Uint8Array): OpenPayloadV3;
+export declare function computeOpenHashV3(rawOpenPayload: Uint8Array): Uint8Array;
+export declare function encodeOpenACKV3(openHash: Uint8Array): Uint8Array;
+export declare function decodeOpenACKV3(raw: Uint8Array): Uint8Array;
+export declare function encodeOpenRejectV3(openHash: Uint8Array, reason: number): Uint8Array;
+export declare function decodeOpenRejectV3(raw: Uint8Array): OpenRejectV3;
+export declare function encodeStreamKeyUpdateACKV3(value: StreamKeyUpdateACKV3): Uint8Array;
+export declare function decodeStreamKeyUpdateACKV3(raw: Uint8Array): StreamKeyUpdateACKV3;
+export declare function buildRecordAAD(h3: Uint8Array, logicalStreamID: bigint, direction: DirectionV3, rawHeader: Uint8Array): Uint8Array;
+export declare function sealRecord(suite: CipherSuiteV3, material: RecordMaterialV3, h3: Uint8Array, logicalStreamID: bigint, direction: DirectionV3, header: RecordHeaderV3, plaintext: Uint8Array): Uint8Array;
+export declare function openRecord(suite: CipherSuiteV3, material: RecordMaterialV3, h3: Uint8Array, logicalStreamID: bigint, direction: DirectionV3, header: RecordHeaderV3, ciphertext: Uint8Array): Uint8Array;