Skip to content

Commit bb1c4bf

Browse files
authored
Merge pull request #3822 from ControlSystemStudio/tls_1_5
PVA: Update TLS documentation to 1.5
2 parents 0a6b83c + 7751d43 commit bb1c4bf

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

core/pva/TLS.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,56 +28,60 @@ certificates for servers (IOCs) and clients (users running CS-Studio
2828
as well as IOCs reading from other IOCs).
2929
This is an example recipe for getting started.
3030

31-
1) Build EPICS base and PVXS as described on
31+
1) For a good overview on building EPICS base and PVXS see
3232
https://george-mcintyre.github.io/pvxs/spvaqstart.html
3333

34+
At the time of this writing, the most recent tagged versions
35+
can be found in https://github.com/slac-epics/pvxs-tls
36+
and https://github.com/slac-epics/pvxs-cms
37+
3438
2) Start `pvacms -v`. It will create several files, including
3539

36-
* `~/.config/pva/1.3/admin.p12`: Certificate for the `admin` user
40+
* `~/.config/pva/1.5/admin.p12`: Certificate for the `admin` user
3741

3842
3) For an IOC, request a hybrid server and client certificate.
3943
Note its "Certificate identifier":
4044

4145
```
4246
$ authnstd -v --name ioc --cert-usage ioc
43-
Keychain file created : /home/user/.config/pva/1.3/server.p12
47+
Keychain file created : /home/user/.config/pva/1.5/server.p12
4448
Certificate identifier : e53ed409:15273288300286014953
4549
```
4650

4751
As `admin`, accept that certificate:
4852

4953
```
50-
$ EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.3/admin.p12 \
54+
$ EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.5/admin.p12 \
5155
pvxcert --approve e53ed409:15273288300286014953
5256
Approve ==> CERT:STATUS:e53ed409:15273288300286014953 ==> Completed Successfully
5357
```
5458

55-
* `~/.config/pva/1.3/server.p12`: Our server certificate (hybrid, for IOC)
59+
* `~/.config/pva/1.5/server.p12`: Our server certificate (hybrid, for IOC)
5660

5761
4) Request a client certificate, note its identifier:
5862

5963
```
6064
$ authnstd -v
61-
Keychain file created : /home/user/.config/pva/1.3/client.p12
65+
Keychain file created : /home/user/.config/pva/1.5/client.p12
6266
Certificate identifier : e53ed409:11521018863975115478
6367
```
6468

6569
Accept that certificate:
6670

6771
```
68-
$ EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.3/admin.p12 \
72+
$ EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.5/admin.p12 \
6973
pvxcert --approve e53ed409:11521018863975115478
7074
Approve ==> CERT:STATUS:e53ed409:11521018863975115478 ==> Completed Successfully
7175
```
7276

73-
* `~/.config/pva/1.3/client.p12`: Our client (user) certificate
77+
* `~/.config/pva/1.5/client.p12`: Our client (user) certificate
7478

7579

7680
You now have a server and a client certificate.
7781
Example for checking the status:
7882

7983
```
80-
$ pvxcert -f ~/.config/pva/1.3/client.p12
84+
$ pvxcert -f ~/.config/pva/1.5/client.p12
8185
...
8286
Subject : CN=fred, C=US, O=host.site.org
8387
...
@@ -91,7 +95,7 @@ Status : VALID
9195
To list certificate details:
9296

9397
```
94-
keytool -list -v -keystore ~/.config/pva/1.3/client.p12 -storepass ""
98+
keytool -list -v -keystore ~/.config/pva/1.5/client.p12 -storepass ""
9599
```
96100

97101
Following the `pvacms` and `authnstd` messages, you will notice that secure PVA
@@ -114,7 +118,7 @@ Secure IOC
114118
Example for running a secure IOC:
115119

116120
```
117-
$ EPICS_PVAS_TLS_KEYCHAIN=~/.config/pva/1.3/server.p12 \
121+
$ EPICS_PVAS_TLS_KEYCHAIN=~/.config/pva/1.5/server.p12 \
118122
softIocPVX -m user=fred -d pvxs/test/testioc.db
119123
```
120124

@@ -128,14 +132,14 @@ Secure Java PVA Client
128132
Example for running Java PVA client command line tool:
129133

130134
```
131-
$ export EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.3/client.p12
135+
$ export EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.5/client.p12
132136
$ pvaclient monitor -v 5 fred:aiExample
133137
```
134138

135139
Example for running CS-Studio:
136140

137141
```
138-
$ export EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.3/client.p12
142+
$ export EPICS_PVA_TLS_KEYCHAIN=~/.config/pva/1.5/client.p12
139143
$ phoebus.sh
140144
```
141145

0 commit comments

Comments
 (0)