Skip to content

Commit 053797f

Browse files
committed
Finalized secure connection documentation
1 parent fb12c58 commit 053797f

4 files changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,16 @@ Before launch the "Server Manager Actor" can be configured with the Keepalive se
144144

145145
![](media/Server%20Menager%20Configuration.png)
146146

147-
The Keepalive settings will be active for all the WebSocket Servers launched by the "WebSocket Server Manager Actor"
147+
**Keepalive** The Keepalive settings will be active for all the WebSocket Servers launched by the "WebSocket Server Manager Actor"
148+
149+
**Certificate Chain** specifies an array of Distinguished Encoding Rules (DER) certificates. The certificates must be supplied depth-first: the server's certificate, followed by the Certificate Authority (CA) that signs the certificate of the server, on up to the root CA. For more details see LabVIEW TLS examples.
150+
151+
**Private Key** a byte array containing the private key of the servers started by the server manager. For more details see LabVIEW TLS examples.
152+
153+
**Secure** If set to TRUE all server started by the server manager will be providing only secure connections. In this case you will need to suitably configure at least the following parameters: **Certificate Chain**, **Private Key**.
154+
155+
**Load OS trusted CAs** specifies whether to load Certificate Authority (CA) certificates trusted by the OS for the secure connection.
156+
148157

149158
### WebSocket Server Listener Settings
150159

@@ -222,6 +231,14 @@ client establishes a WebSocket connection to the server.
222231
**Keepalive** specifies the Keepalive settings for the Server (see
223232
definition above).
224233

234+
**Certificate Chain** specifies an array of Distinguished Encoding Rules (DER) certificates. The certificates must be supplied depth-first: the server's certificate, followed by the Certificate Authority (CA) that signs the certificate of the server, on up to the root CA. For more details see LabVIEW TLS examples.
235+
236+
**Private Key** a byte array containing the server private key. For more details see LabVIEW TLS examples.
237+
238+
**Secure** If set to TRUE the server will be providing only secure connections. In this case you will need to suitably configure at least the following parameters: **Certificate Chain**, **Private Key**.
239+
240+
**Load OS trusted CAs** For secure connections specifies whether to load Certificate Authority (CA) certificates trusted by the OS for the secure connection.
241+
225242
### Add Service
226243

227244
<img src="./media/image6.png" style="width:4.77541in;height:3.01693in"
@@ -276,7 +293,11 @@ before launching it:
276293

277294
**WS URI** specifies the URI of the client with the following format:
278295

279-
*ws://hostname:port/service*
296+
**plain connections**: *ws://hostname:port/service*
297+
298+
**secure connections**: *wss://hostname:port/service*
299+
300+
for secure connections one has to configure the **Certificate** and **Load OS trusted CAs**, see below for description of these parameters.
280301

281302
**Timeout (ms)** is the timeout to establish the connection to the
282303
server. A value of –1 indicates to wait indefinitely.
@@ -291,6 +312,10 @@ created) that subscribes to the WebSocket Client Actor.
291312
**Keepalive** specifies the Keepalive settings for the Client (see
292313
definition above).
293314

315+
**Certificate** Certificate Authority (CA) certificate input as a byte array. For more details see LabVIEW TLS examples.
316+
317+
**Load OS trusted CAs** For secure connections specifies whether to load Certificate Authority (CA) certificates trusted by the OS for the secure connection.
318+
294319
## Send to Peers
295320

296321
<img src="./media/image10.png" style="width:4.20036in;height:2.6419in"
8.55 KB
Loading

media/image5.png

7.97 KB
Loading

media/image9.png

5.11 KB
Loading

0 commit comments

Comments
 (0)