-
Notifications
You must be signed in to change notification settings - Fork 141
477 lines (396 loc) · 15.7 KB
/
pki-nss-hsm-test.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
name: PKI NSS CLI with HSM
on: workflow_call
env:
DS_IMAGE: ${{ vars.DS_IMAGE || 'quay.io/389ds/dirsrv' }}
jobs:
# https://github.com/dogtagpki/pki/wiki/PKI-NSS-CLI
test:
name: Test
runs-on: ubuntu-latest
env:
SHARED: /tmp/workdir/pki
steps:
- name: Clone repository
uses: actions/checkout@v4
- name: Retrieve PKI images
uses: actions/cache@v4
with:
key: pki-images-${{ github.sha }}
path: pki-images.tar
- name: Load PKI images
run: docker load --input pki-images.tar
- name: Set up runner container
run: |
tests/bin/runner-init.sh pki
env:
HOSTNAME: pki.example.com
- name: Create HSM token
run: |
docker exec pki dnf install -y softhsm
docker exec pki softhsm2-util --init-token \
--label HSM \
--so-pin Secret.HSM \
--pin Secret.HSM \
--free
docker exec pki softhsm2-util --show-slots
# create password.conf
echo "internal=" > password.conf
echo "hardware-HSM=Secret.HSM" >> password.conf
- name: Create key in HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-create | tee output
# get key ID
KEY_ID=$(sed -n 's/^\s*Key ID:\s*\(\S\+\)\s*$/\1/p' output)
echo $KEY_ID > ca_signing_key_id
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-show \
--key-id $KEY_ID
- name: Verify key in HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-find | tee output
sed -n 's/\s*Key ID:\s*\(\S\+\)\s*$/\L\1/p' output > actual
diff ca_signing_key_id actual
# verify key not in internal token
docker exec pki pki \
-f $SHARED/password.conf \
nss-key-find | tee actual
echo -n "" > expected
diff expected actual
# https://github.com/dogtagpki/pki/wiki/Generating-CA-Signing-CSR-with-PKI-NSS
- name: Generate CA signing cert request with existing key in HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-request \
--key-id $(cat ca_signing_key_id) \
--subject "CN=Certificate Authority" \
--ext /usr/share/pki/server/certs/ca_signing.conf \
--csr ca_signing.csr
docker exec pki openssl req -text -noout -in ca_signing.csr
docker exec pki certutil -K -d /root/.dogtag/nssdb || true
echo "Secret.HSM" > password.txt
docker exec pki certutil -K \
-d /root/.dogtag/nssdb \
-f $SHARED/password.txt \
-h HSM
# https://github.com/dogtagpki/pki/wiki/Issuing-CA-Signing-Certificate-with-PKI-NSS
- name: Issue self-signed CA signing cert
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-issue \
--csr ca_signing.csr \
--ext /usr/share/pki/server/certs/ca_signing.conf \
--cert ca_signing.crt
docker exec pki openssl x509 -text -noout -in ca_signing.crt
- name: Import CA signing cert into internal token and HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-import \
--cert ca_signing.crt \
--trust CT,C,C \
ca_signing
- name: Verify CA signing cert in internal token
run: |
echo "CT,C,C" > expected
docker exec pki certutil -L -d /root/.dogtag/nssdb | tee output
sed -n 's/^ca_signing\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki nss-cert-show ca_signing | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
# verify key not in internal token
docker exec pki pki \
-f $SHARED/password.conf \
nss-key-find \
--nickname ca_signing | tee actual
echo -n "" > expected
diff actual expected
docker exec pki pki nss-cert-show --cert-file ca_signing.crt
- name: Verify CA signing cert in HSM
run: |
echo "CTu,Cu,Cu" > expected
docker exec pki certutil -L \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
sed -n 's/^HSM:ca_signing\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-show \
HSM:ca_signing | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
echo rsa > expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-find \
--nickname HSM:ca_signing | tee output
sed -n 's/\s*Type:\s*\(\S\+\)\s*$/\L\1/p' output > actual
diff actual expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-show \
--cert-file ca_signing.crt
# https://github.com/dogtagpki/pki/wiki/Generating-SSL-Server-CSR-with-PKI-NSS
- name: Create SSL server cert request with key in HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-request \
--subject "CN=pki.example.com" \
--ext /usr/share/pki/server/certs/sslserver.conf \
--csr sslserver.csr
docker exec pki openssl req -text -noout -in sslserver.csr
docker exec pki certutil -K -d /root/.dogtag/nssdb || true
docker exec pki certutil -K \
-d /root/.dogtag/nssdb \
-f $SHARED/password.txt \
-h HSM
# https://github.com/dogtagpki/pki/wiki/Issuing-SSL-Server-Certificate-with-PKI-NSS
- name: Issue SSL server cert
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-issue \
--issuer HSM:ca_signing \
--csr sslserver.csr \
--ext /usr/share/pki/server/certs/sslserver.conf \
--cert sslserver.crt
docker exec pki openssl x509 -text -noout -in sslserver.crt
- name: Import SSL server cert into internal token and HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-import \
--cert sslserver.crt \
sslserver
- name: Verify SSL server cert in internal token
run: |
echo ",," > expected
docker exec pki certutil -L -d /root/.dogtag/nssdb | tee output
sed -n 's/^sslserver\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki nss-cert-show sslserver | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
# verify key not in internal token
docker exec pki pki \
-f $SHARED/password.conf \
nss-key-find \
--nickname sslserver | tee actual
echo -n "" > expected
diff actual expected
- name: Verify SSL server cert in HSM
run: |
echo "u,u,u" > expected
docker exec pki certutil -L \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
sed -n 's/^HSM:sslserver\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-show \
HSM:sslserver | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
echo rsa > expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-find \
--nickname HSM:sslserver | tee output
sed -n 's/\s*Type:\s*\(\S\+\)\s*$/\L\1/p' output > actual
diff actual expected
# get key ID
sed -n 's/\s*Key ID:\s*\(\S\+\)\s*$/\L\1/p' output > sslserver_key_id
- name: Delete SSL server cert but keep the key
run: |
# delete cert from internal token
docker exec pki pki \
nss-cert-del \
sslserver
# delete cert from HSM
docker exec pki pki \
-f $SHARED/password.conf \
nss-cert-del \
HSM:sslserver
- name: Verify SSL server cert in internal token
run: |
docker exec pki certutil -L -d /root/.dogtag/nssdb | tee output
# SSL server cert should not exist
echo "ca_signing CT,C,C" > expected
sed -n -e '1,4d' -e 's/^\(.*\S\)\s\+\(\S\+\)\s*$/\1 \2/p' output > actual
diff expected actual
docker exec pki certutil -K -d /root/.dogtag/nssdb | tee output
# SSL server key should not exist
echo -n > expected
sed -n 's/^<.*>\s\+\S\+\s\+\S\+\s\+\(.*\)$/\1/p' output | sort > actual
diff expected actual
- name: Verify SSL server cert in HSM
run: |
docker exec pki certutil -L \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
# SSL server cert should not exist
echo "HSM:ca_signing CTu,Cu,Cu" > expected
sed -n -e '1,4d' -e 's/^\(.*\S\)\s\+\(\S\+\)\s*$/\1 \2/p' output > actual
diff expected actual
docker exec pki certutil -K \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
# SSL server key should exist but orphaned
echo "(orphan)" > expected
echo "HSM:ca_signing" >> expected
sed -n 's/^<.*>\s\+\S\+\s\+\S\+\s\+\(.*\)$/\1/p' output | sort > actual
diff expected actual
- name: Create new SSL server cert request with existing key in HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-request \
--key-id $(cat sslserver_key_id) \
--subject "CN=pki.example.com" \
--ext /usr/share/pki/server/certs/sslserver.conf \
--csr new_sslserver.csr
docker exec pki openssl req -text -noout -in new_sslserver.csr
docker exec pki certutil -K -d /root/.dogtag/nssdb || true
docker exec pki certutil -K \
-d /root/.dogtag/nssdb \
-f $SHARED/password.txt \
-h HSM
- name: Issue new SSL server cert
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-issue \
--issuer HSM:ca_signing \
--csr new_sslserver.csr \
--ext /usr/share/pki/server/certs/sslserver.conf \
--cert new_sslserver.crt
docker exec pki openssl x509 -text -noout -in new_sslserver.crt
- name: Import new SSL server cert into internal token and HSM
run: |
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-import \
--cert new_sslserver.crt \
new_sslserver
- name: Verify SSL server cert in internal token
run: |
# verify trust flags
echo ",," > expected
docker exec pki certutil -L -d /root/.dogtag/nssdb | tee output
sed -n 's/^new_sslserver\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki nss-cert-show new_sslserver | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
# verify key not in internal token
docker exec pki pki \
-f $SHARED/password.conf \
nss-key-find \
--nickname new_sslserver | tee actual
echo -n > expected
diff actual expected
- name: Verify SSL server cert in HSM
run: |
# verify trust flags
echo "u,u,u" > expected
docker exec pki certutil -L \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
sed -n 's/^HSM:new_sslserver\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-cert-show \
HSM:new_sslserver | tee output
sed -n 's/\s*Trust Flags:\s*\(\S\+\)\s*$/\1/p' output > actual
diff actual expected
# verify key type
echo rsa > expected
docker exec pki pki \
--token HSM \
-f $SHARED/password.conf \
nss-key-find \
--nickname HSM:new_sslserver | tee output
sed -n 's/\s*Type:\s*\(\S\+\)\s*$/\L\1/p' output > actual
diff actual expected
# get key ID
sed -n 's/\s*Key ID:\s*\(\S\+\)\s*$/\L\1/p' output > new_sslserver_key_id
diff sslserver_key_id new_sslserver_key_id
- name: Delete SSL server cert and key from internal token and HSM
run: |
# delete cert from internal token
docker exec pki pki \
nss-cert-del \
new_sslserver \
--remove-key
# delete cert from HSM
docker exec pki pki \
-f $SHARED/password.conf \
nss-cert-del \
HSM:new_sslserver \
--remove-key
- name: Verify SSL server cert in internal token
run: |
docker exec pki certutil -L -d /root/.dogtag/nssdb | tee output
# SSL server cert should not exist
echo "ca_signing CT,C,C" > expected
sed -n -e '1,4d' -e 's/^\(.*\S\)\s\+\(\S\+\)\s*$/\1 \2/p' output > actual
diff expected actual
docker exec pki certutil -K -d /root/.dogtag/nssdb | tee output
# SSL server key should not exist
echo -n > expected
sed -n 's/^<.*>\s\+\S\+\s\+\S\+\s\+\(.*\)$/\1/p' output | sort > actual
diff expected actual
- name: Verify SSL server cert in HSM
run: |
docker exec pki certutil -L \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
# SSL server cert should not exist
echo "HSM:ca_signing CTu,Cu,Cu" > expected
sed -n -e '1,4d' -e 's/^\(.*\S\)\s\+\(\S\+\)\s*$/\1 \2/p' output > actual
diff expected actual
docker exec pki certutil -K \
-d /root/.dogtag/nssdb \
-h HSM \
-f $SHARED/password.txt | tee output
# SSL server key should not exist
echo "HSM:ca_signing" > expected
sed -n 's/^<.*>\s\+\S\+\s\+\S\+\s\+\(.*\)$/\1/p' output | sort > actual
diff expected actual
- name: Remove HSM token
run: docker exec pki softhsm2-util --delete-token --token HSM