@floegence/flowersec-core 0.26.0 → 2.0.0

package/dist/v2/artifact.d.ts

@@ -0,0 +1,128 @@
+export type ArtifactCarrierV2 = "websocket" | "raw_quic" | "webtransport";
+export type ArtifactPathKindV2 = "direct" | "tunnel";
+export type ArtifactCandidateV2 = Readonly<{
+    id: string;
+    carrier: ArtifactCarrierV2;
+    url: string;
+    wire_profile: string;
+    normalized_url?: string;
+}>;
+export type CanonicalArtifactCandidateV2 = Readonly<{
+    carrier: ArtifactCarrierV2;
+    id: string;
+    normalized_url: string;
+    wire_profile: string;
+}>;
+export type SessionContractV2 = Readonly<{
+    channel_id: string;
+    init_expire_at_unix_s: number;
+    idle_timeout_seconds: number;
+    establish_timeout_seconds: number;
+    rekey_prepare_timeout_seconds: number;
+    rekey_completion_timeout_seconds: number;
+    max_inbound_streams: number;
+    e2ee_psk_b64u: string;
+    allowed_suites: readonly number[];
+    default_suite: number;
+    selected_features: number;
+    contract_hash_b64u: string;
+}>;
+export type DirectArtifactPathV2 = Readonly<{
+    kind: "direct";
+    rendezvous_group_id: string;
+    listener_audience: string;
+    routing_token: string;
+    candidates: readonly ArtifactCandidateV2[];
+}>;
+export type TunnelArtifactPathV2 = Readonly<{
+    kind: "tunnel";
+    rendezvous_group_id: string;
+    listener_audience: string;
+    role: 1 | 2;
+    local_endpoint_instance_id: string;
+    expected_peer_endpoint_instance_id: string;
+    token: string;
+    candidates: readonly ArtifactCandidateV2[];
+}>;
+export type ScopeMetadataV2 = Readonly<{
+    scope: string;
+    scope_version: number;
+    critical: boolean;
+    payload: Readonly<Record<string, unknown>>;
+}>;
+export type CorrelationTagV2 = Readonly<{
+    key: string;
+    value: string;
+}>;
+export type CorrelationContextV2 = Readonly<{
+    v: 2;
+    tags: readonly CorrelationTagV2[];
+}>;
+export type ArtifactV2 = Readonly<{
+    v: 2;
+    profile: "flowersec/2";
+    session: SessionContractV2;
+    path: DirectArtifactPathV2 | TunnelArtifactPathV2;
+    scoped: readonly ScopeMetadataV2[];
+    correlation: CorrelationContextV2;
+}>;
+type CommonFSB2RequestV2 = Readonly<{
+    profile: "flowersec/2";
+    channel_id: string;
+    session_contract_hash_b64u: string;
+    rendezvous_group_id: string;
+    candidates: readonly CanonicalArtifactCandidateV2[];
+    candidate_set_hash_b64u: string;
+    chosen_candidate_id: string;
+    listener_audience: string;
+}>;
+export type DirectFSB2RequestV2 = CommonFSB2RequestV2 & Readonly<{
+    pathKind: "direct";
+    routing_token: string;
+}>;
+export type TunnelFSB2RequestV2 = CommonFSB2RequestV2 & Readonly<{
+    pathKind: "tunnel";
+    role: 1 | 2;
+    endpoint_instance_id: string;
+    attach_token: string;
+}>;
+export type FSB2RequestV2 = DirectFSB2RequestV2 | TunnelFSB2RequestV2;
+export type DecodedFSB2RequestV2 = Readonly<{
+    request: FSB2RequestV2;
+    raw: Uint8Array;
+    localAdmissionBinding: Uint8Array;
+}>;
+export declare enum AdmissionStatusV2 {
+    Success = 0,
+    Reject = 1,
+    Retryable = 2
+}
+export type AdmissionResponseV2 = Readonly<{
+    status: AdmissionStatusV2;
+    reason: string;
+}>;
+export type ArtifactV2ErrorCode = "artifact_too_large" | "fsb2_payload_too_large" | "invalid_artifact" | "invalid_candidate" | "invalid_fsa2" | "invalid_fsb2" | "noncanonical_fsb2";
+export declare class ArtifactV2Error extends Error {
+    readonly code: ArtifactV2ErrorCode;
+    constructor(code: ArtifactV2ErrorCode, message: string);
+}
+export type LabeledHashV2 = Readonly<{
+    canonicalJSON: string;
+    hash: Uint8Array;
+    hashBase64URL: string;
+}>;
+export type CanonicalCandidateSetV2 = LabeledHashV2 & Readonly<{
+    candidates: readonly CanonicalArtifactCandidateV2[];
+}>;
+export declare function computeSessionContractHashV2(session: SessionContractV2): LabeledHashV2;
+export declare function canonicalizeCandidatesV2(kind: ArtifactPathKindV2, candidates: readonly ArtifactCandidateV2[]): CanonicalCandidateSetV2;
+export declare function decodeArtifactV2JSON(raw: string | Uint8Array): ArtifactV2;
+export declare function encodeArtifactV2JSON(artifact: ArtifactV2): Uint8Array;
+export declare function validateArtifactV2(artifact: ArtifactV2): CanonicalCandidateSetV2;
+export declare function buildFSB2RequestV2(artifact: ArtifactV2, chosenCandidateID: string): FSB2RequestV2;
+export declare function encodeFSB2RequestV2(request: FSB2RequestV2): Uint8Array;
+export declare function decodeFSB2RequestV2(raw: Uint8Array): DecodedFSB2RequestV2;
+export declare function admissionBindingV2(rawFSB2: Uint8Array): Uint8Array;
+export declare function encodeFSA2ResponseV2(response: AdmissionResponseV2): Uint8Array;
+export declare function decodeFSA2ResponseV2(raw: Uint8Array): AdmissionResponseV2;
+export {};