Описание параметров в конфигурационном файле OpcUaClientSettings-0.json

18 мая 2023

ID 240932

Параметры, отмеченные как обязательные, следует явно указать. Прочие параметры настраивать необязательно. Для необязательных параметров, не включенных в конфигурационный файл, может использоваться значение по умолчанию, предусмотренное протоколом OPC UA.

Параметры в файле OpcUaClientSettings-0.json

Имя параметра

Обязательный параметр

Описание

Возможные значения и примечания

id

Да

Идентификатор клиента OPC UA, принимающего данные от сервера OPC UA.

0.

Значение этого параметра должно совпадать со значением параметра receivingHubId в конфигурационном файле GuideSettings-0.json.

name

Да

Имя клиента OPC UA, принимающего данные от сервера OPC UA.

<OPC UA client name>.

Пример: Kaspersky IoT Secure Gateway 100 OPC UA Client.

description

 

Описание клиента OPC UA, принимающего данные от сервера OPC UA.

<OPC UA client description>.

Пример: Collect data from CNC by Kaspersky IoT Secure Gateway 100.

url

Да

Адрес сервера OPC UA.

<сетевой протокол>://<хост>:<порт>.

Пример: opc.tcp://192.168.177.7:4840.

Порт 4840 используется по умолчанию.

readingCycle

Нет

Частота считывания данных шлюзом (в секундах).

1.

Целое значение не меньше 0.

0 – специальное значение, которое устанавливает использование максимальной частоты, доступной клиенту и серверу.

security

Да

Блок параметров безопасности клиента OPC UA. Содержит параметры mode, policy, trustList и блок параметров clientPkiData.

  • Блок параметров {mode, policy, clientPkiData, trustList}.
  • null.

В блоке параметров security настраиваются режимы и политики безопасной коммуникации, указываются используемые сертификаты и криптографические ключи для цифровой подписи и шифрования данных.

Если не требуется настраивать параметры безопасности, укажите null в блоке security. При этом будет использоваться режим безопасности None.

mode

Нет

Режим управления безопасностью подключения клиентского приложения.

  • Sign – режим, в котором для подключения требуется использовать цифровую подпись данных.
  • SignAndEncrypt – режим, в котором для подключения требуется одновременно использовать цифровую подпись данных и шифрование данных.
  • None – режим, в котором для подключения не требуется использовать цифровую подпись данных и шифрование данных. Не рекомендуется использовать этот режим, так как он не обеспечивает безопасное подключение клиента OPC UA к серверу OPC UA.
  • Any – режим, в котором для подключения будет использован любой из перечисленных режимов (при условии поддержки сервером): Sign, SignAndEncrypt, None.

policy

Нет

Название политики безопасности, используемой на сервере OPC UA.

  • Basic128Rsa15.
  • Basic256.
  • Basic256Sha256.
  • None.
  • Any – возможно использование любой из перечисленных политик (при условии поддержки сервером).

Политика безопасности None является наиболее совместимой с разными видами источников данных для соединения по OPC UA.

clientPkiData

Нет

Блок параметров, содержащий сертификат и закрытый криптографический ключ клиента OPC UA для безопасного соединения.

Блок параметров {certificate, privateKey}.

Блок параметров clientPkiData требуется заполнить даже в случае, если полям mode и policy установлено значение None.

Для безопасного взаимодействия по OPC UA вам потребуется создать закрытый криптографический ключ и сертификат и добавить их в конфигурацию клиента и сервера. При генерации сертификатов для соединения клиента (Kaspersky IoT Secure Gateway 100) и сервера OPC UA удостоверьтесь, что сертификаты удовлетворяют следующим требованиям:

  • Параметры криптографических ключей и сертификатов соответствуют выбранной политике безопасности.
  • Используется формат DER или PEM для сертификатов и криптографических ключей клиента.
  • Для сертификата клиента значение поля Subject Alt Name содержит значение URI:urn:aprotech:KISG100:OpcUaClient.

certificate

Нет

Имя файла сертификата.

opc-ua-client.crt.

privateKey

Нет

Имя файла закрытого криптографического ключа.

opc-ua-client.key.

trustList

Нет

Массив, содержащий имена файлов доверенных сертификатов.

  • [opc-ua-server.crt] – одно или несколько имен файлов доверенных сертификатов сервера OPC UA.
  • AllowAll – разрешение подключение к серверу OPC UA без проверки его сертификата.

Если конфигурация сервера OPC UA предполагает использование собственного списка доверенных сертификатов, добавьте сертификат клиента в этот список. Если проверка сертификатов не требуется, укажите для этого параметра значение AllowAll.

userCredentials

Нет

Блок параметров с учетными данными клиента OPC UA на сервере OPC UA.

  • Блок параметров {username, password} с учетными данными пользователя.
  • null – указывается, если вы хотите разрешить анонимное подключение клиента OPC UA к серверу OPC UA. В этом случае указывать значения username и password не требуется.

username

Нет

Имя учетной записи пользователя для авторизации на сервере OPC UA.

<username>.

password

Нет

Пароль учетной записи пользователя для авторизации на сервере OPC UA.

<password>.

heartbeat

Нет

Блок параметров, содержащий настройки сигнала работоспособности Kaspersky IoT Secure Gateway 100, генерируемый клиентом OPC UA.

  • Блок параметров {id, name, timeout}.
  • null.

Если вы не добавите параметр heartbeat или укажете значение null, сигналы работоспособности отправляться не будут.

id

Нет

Идентификатор узла данных.

0.

name

Нет

Имя узла данных.

<heartbeat node name>.

Пример: Heartbeat.

timeout

Нет

Период в секундах между генерацией сигналов работоспособности.

60.

Требуется указать целое значение не меньше 0. Значение по умолчанию – 30.

nodes

Да

Блок параметров узлов данных.

Блок параметров {id, name}.

Заполняется для каждого узла данных. Идентификатор и имя узла данных требуются для построения маршрутов и передачи данных от сервера OPC UA в MQTT-брокер.

id

Да

Идентификатор исходящего порта.

<id>.

name

Да

Имя исходящего порта. Должно совпадать с именем целевого порта name одного из MQTT-топиков, указанных в блоке параметров topics в конфигурационном файле MqttPublisherSettings-0.json.

<node name>.

Пример: Temperature.

Для корректной передачи данных от сервера OPC UA в MQTT-брокер, требуется сопоставить узлы данных OPC UA и соответствующие им MQTT-топики. Сопоставление осуществляется по значению name.

 

nodeId

Да

Идентификатор узла данных.

<namespace>, <nodeID>.

ns

Да

Идентификатор пространства имен сервера OPC UA.

<namespace>.

nodeId

Да

Идентификатор узла данных в пространстве имен сервера OPC UA.

<nodeID>.

Возможны два типа идентификатора:

  • s (string) – строковое значение идентификатора узла данных. Например, "nodeId": "ns=1;s=Variable temperature".
  • i (numeric) – числовое значение идентификатора узла данных. Например, "nodeId": "ns=2;i=2045".

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!