circu.js
    Preparing search index...

    SSL Pipe - Bidirectional SSL/TLS stream processor

    Provides memory-based I/O for SSL/TLS handshake and data transfer. Can operate as both client and server.

    Index

    Constructors

    Properties

    alpnProtocol: string | null

    Get negotiated ALPN protocol

    Protocol name or null if not negotiated

    certificate: CertificateInfo | null

    Get peer certificate information

    Certificate info or null if not available

    cipher: CipherInfo | null

    Get current cipher information

    Cipher info or null if not established

    handshakeComplete: boolean

    Whether SSL handshake is complete

    isServer: boolean

    Whether this pipe operates in server mode

    verifyResult: VerifyResult

    Get peer certificate verification result

    Verification result

    version: string

    Get negotiated SSL/TLS version

    Version string (e.g., "TLSv1.3")

    Methods

    • Feed encrypted data from network to SSL engine

      Parameters

      • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

        Encrypted data received from peer

      Returns number

      Number of bytes consumed

    • Get encrypted data to send to network

      Returns ArrayBuffer | null

      Encrypted data or null if nothing to send

    • Perform one step of SSL/TLS handshake

      Returns boolean

      true if handshake is complete, false if more data needed

    • Read decrypted data from SSL engine

      Parameters

      • Optionalsize: number

        Maximum bytes to read (default: 16384)

      Returns ArrayBuffer | null

      Decrypted data or null if nothing available

    • Initiate SSL/TLS connection shutdown

      Returns number

      Shutdown status code

    • Write plaintext data to SSL engine for encryption

      Parameters

      • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

        Plaintext data to encrypt

      Returns number

      Number of bytes written