The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    ServerSecureChannelLayer Class

    Uses
    Extends EventEmitter
    Defined in: packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:65
    Module: opcua.server

    Constructor

    ServerSecureChannelLayer

    (
    • options
    )

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:65

    Parameters:

    • options Object
      • parent OPCUAServerEndPoint

        parent

      • [timeout= 10000] Number optional

        timeout in milliseconds

      • [defaultSecureTokenLifetime= 30000] optional

        defaultSecureTokenLifetime

      • [objectFactory] optional

        an factory that provides a method createObjectId(id) for the message builder

    Methods

    _check_receiverCertificateThumbprint verify that the receiverCertificateThumbprint send by the client matching the CertificateThumbPrint of the server

    (
    • clientSecurityHeader
    )
    Boolean private

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:990

    Parameters:

    • clientSecurityHeader Object

    Returns:

    Boolean:

    _prepare_security_header

    (
    • request
    • message
    )
    AsymmetricAlgorithmSecurityHeader private

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:683

    Parameters:

    • request Object
    • message Object

    Returns:

    AsymmetricAlgorithmSecurityHeader:

    _process_certificates

    (
    • message
    • callback
    )
    private async

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:641

    _process_certificates extracts client public keys from client certificate and store them in self.receiverPublicKey and self.receiverCertificate it also caches self.receiverPublicKeyLength.

    so they can be used by security channel.

    Parameters:

    • message Object

      the message coming from the client

    • callback Object

    _read_headers

    (
    • binaryStream
    )
    Boolean private

    Inherited from MessageBuilder: packages\node-opcua-secure-channel\src\message_builder.js:327

    Parameters:

    • binaryStream Object

    Returns:

    Boolean:

    chunkSecureMessage

    (
    • msgType
    • options
    • message
    • messageChunkCallback
    )

    Inherited from MessageChunker: packages\node-opcua-secure-channel\src\message_chunker.js:53

    Parameters:

    • msgType String
    • options Object
      • tokenId
      • chunkSize

        [default=8196]

      • signatureLength Integer

        [default=0]

      • signingFunc Function

        [default=null]

    • message Object
    • messageChunkCallback Function

    close

    (
    • callback
    )
    async

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:874

    Abruptly close a Server SecureChannel ,by terminating the underlying transport.

    Parameters:

    • callback Function

    getCertificate

    () Buffer

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:176

    Returns:

    Buffer:

    the X509 DER form certificate

    getCertificate

    () Buffer

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:167

    Returns:

    Buffer:

    the X509 DER form certificate

    getPrivateKey

    () Buffer

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:194

    Returns:

    Buffer:

    the privateKey

    init

    (
    • socket
    • callback
    )
    async

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:320

    Parameters:

    • socket Socket
    • callback Function

    send_error_and_abort

    (
    • statusCode
    • description
    • message
    • callback
    )
    async

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:610

    send a ServiceFault response

    Parameters:

    • statusCode StatusCode

      the status code

    • description String
    • message String
    • callback Function

    send_response

    (
    • msgType
    • response
    • message
    • [callback]
    )
    async

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:536

    Parameters:

    • msgType Object
    • response Object
    • message Object
    • [callback] Function optional

      an optional callback function

    update

    (
    • options
    )

    Inherited from MessageChunker: packages\node-opcua-secure-channel\src\message_chunker.js:33

    Parameters:

    • options Object
      • securityHeader Object

        SecurityHeader

      • [derivedKeys] Object optional

        derivedKeys

    Properties

    bytesRead

    Number

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:1169

    the number of bytes read so far by this channel

    bytesWritten

    Number

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:1179

    the number of bytes written so far by this channel

    endpoints

    OPCUAServerEndPoint

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:150

    the endpoint associated with this secure channel

    hashKey

    String

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:1215

    The unique hash key to identify this secure channel

    hasSession

    Boolean

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:1205

    true when the secure channel is assigned to a active session

    isOpened

    Boolean

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:1194

    true when the secure channel has been opened successfully

    Events

    abort

    Defined in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:861

    notify the observers that the SecureChannel has aborted. the reason could be :

    • a CloseSecureChannelRequest has been received.
    • a invalid message has been received the event is sent after the underlying transport layer has been closed.

    invalid_sequence_number

    Inherited from MessageBuilder: packages\node-opcua-secure-channel\src\message_builder.js:91

    notify the observers that a message with an invalid sequence number has been received.

    Event Payload:

    • expected Number
      sequence Number
    • actual Number
      sequence Number

    message

    Inherited from MessageBuilder but overwritten in packages\node-opcua-secure-channel\src\server\server_secure_channel_layer.js:977

    notify the observer that a OPCUA message has been received. It is up to one observer to call send_response or send_error_and_abort to complete the transaction.

    Event Payload:

    • message Object