Class SecureSession

constructor

• new SecureSession(args): SecureSession

• Parameters

  • args: {
        attestationKey: Uint8Array;
        caseAuthenticatedTags?: CaseAuthenticatedTag[];
        decryptKey: Uint8Array;
        encryptKey: Uint8Array;
        fabric: undefined | Fabric;
        id: number;
        isInitiator: boolean;
        manager?: SessionManager;
        peerNodeId: NodeId;
        peerSessionId: number;
        sessionParameters?: Partial<SessionParameters>;
    }

    • attestationKey: Uint8Array

    • OptionalcaseAuthenticatedTags?: CaseAuthenticatedTag[]

    • decryptKey: Uint8Array

    • encryptKey: Uint8Array

    • fabric: undefined | Fabric

    • id: number

    • isInitiator: boolean

    • Optionalmanager?: SessionManager

    • peerNodeId: NodeId

    • peerSessionId: number

    • OptionalsessionParameters?: Partial<SessionParameters>

  Returns SecureSession

ReadonlysupportsMRP

associatedFabric

• get associatedFabric(): Fabric

• Returns Fabric

attestationChallengeKey

• get attestationChallengeKey(): Uint8Array

• Returns Uint8Array

caseAuthenticatedTags

• get caseAuthenticatedTags(): CaseAuthenticatedTag[]

• Returns CaseAuthenticatedTag[]

closingAfterExchangeFinished

• get closingAfterExchangeFinished(): boolean

• Returns boolean

fabric

• get fabric(): undefined | Fabric

• Returns undefined | Fabric

id

• get id(): number

• Returns number

isClosing

• get isClosing(): boolean

• Returns boolean

isPase

• get isPase(): boolean

• Returns boolean

isSecure

• get isSecure(): boolean

• Returns boolean

name

• get name(): string

• Returns string

nodeId

• get nodeId(): NodeId

• Returns NodeId

peerAddress

• get peerAddress(): PeerAddress

• The peer node's address.

  Returns PeerAddress

peerNodeId

• get peerNodeId(): NodeId

• Returns NodeId

peerSessionId

• get peerSessionId(): number

• Returns number

sendCloseMessageWhenClosing

• get sendCloseMessageWhenClosing(): boolean

• Returns boolean

subscriptions

• get subscriptions(): BasicSet<Subscription, Subscription>

• Returns BasicSet<Subscription, Subscription>

addAssociatedFabric

• addAssociatedFabric(fabric): void

• Parameters

  • fabric: Fabric

  Returns void

clearSubscriptions

• clearSubscriptions(flushSubscriptions?): Promise<void>

• Parameters

  • flushSubscriptions: boolean = false

  Returns Promise<void>

close

• close(closeAfterExchangeFinished?): Promise<void>

• Parameters

  • OptionalcloseAfterExchangeFinished: boolean

  Returns Promise<void>

decode

• decode(__namedParameters, aad): DecodedMessage

• Parameters

  • __namedParameters: DecodedPacket
  • aad: Uint8Array

  Returns DecodedMessage

destroy

• destroy(sendClose?, closeAfterExchangeFinished?): Promise<void>

• Destroys a session. Outstanding subscription data will be discarded.

  Parameters

  • sendClose: boolean = false
  • closeAfterExchangeFinished: boolean = true

  Returns Promise<void>

encode

• encode(message): Packet

• Parameters

  • message: Message

  Returns Packet

end

• end(sendClose, closeAfterExchangeFinished?): Promise<void>

• Ends a session. Outstanding subscription data will be flushed before the session is destroyed.

  Parameters

  • sendClose: boolean
  • closeAfterExchangeFinished: boolean = false

  Returns Promise<void>

peerIs

• peerIs(address): boolean

• Indicates whether a peer matches a specific address.

  Parameters

  • address: PeerAddress

  Returns boolean

Staticcreate

• create(args): Promise<SecureSession>

• Parameters

  • args: {
        caseAuthenticatedTags?: CaseAuthenticatedTag[];
        fabric: undefined | Fabric;
        id: number;
        isInitiator: boolean;
        isResumption: boolean;
        manager?: SessionManager;
        peerNodeId: NodeId;
        peerSessionId: number;
        peerSessionParameters?: Partial<SessionParameters>;
        salt: Uint8Array;
        sharedSecret: Uint8Array;
    }

    • OptionalcaseAuthenticatedTags?: CaseAuthenticatedTag[]

    • fabric: undefined | Fabric

    • id: number

    • isInitiator: boolean

    • isResumption: boolean

    • Optionalmanager?: SessionManager

    • peerNodeId: NodeId

    • peerSessionId: number

    • OptionalpeerSessionParameters?: Partial<SessionParameters>

    • salt: Uint8Array

    • sharedSecret: Uint8Array

  Returns Promise<SecureSession>