-
Notifications
You must be signed in to change notification settings - Fork 141
646 lines (549 loc) · 20.9 KB
/
python-ca-rest-api-v1-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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
name: CA Python API with REST API v1
on: workflow_call
env:
DS_IMAGE: ${{ vars.DS_IMAGE || 'quay.io/389ds/dirsrv' }}
jobs:
# https://github.com/dogtagpki/pki/wiki/Deploying-CA-Container
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: Create network
run: docker network create example
- name: Set up client container
run: |
tests/bin/runner-init.sh \
--hostname=client.example.com \
--network=example \
client
####################################################################################################
# Create system certs
- name: Create CA signing cert
run: |
mkdir certs
docker exec client pki \
nss-cert-request \
--subject "CN=CA Signing Certificate" \
--ext /usr/share/pki/server/certs/ca_signing.conf \
--csr $SHARED/certs/ca_signing.csr
docker exec client pki \
nss-cert-issue \
--csr $SHARED/certs/ca_signing.csr \
--ext /usr/share/pki/server/certs/ca_signing.conf \
--cert $SHARED/certs/ca_signing.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/ca_signing.crt \
--trust CT,C,C \
ca_signing
docker exec client pki \
nss-cert-show \
ca_signing
- name: Create OCSP signing cert
run: |
docker exec client pki \
nss-cert-request \
--subject "CN=OCSP Signing Certificate" \
--ext /usr/share/pki/server/certs/ocsp_signing.conf \
--csr $SHARED/certs/ocsp_signing.csr
docker exec client pki \
nss-cert-issue \
--issuer ca_signing \
--csr $SHARED/certs/ocsp_signing.csr \
--ext /usr/share/pki/server/certs/ocsp_signing.conf \
--cert $SHARED/certs/ocsp_signing.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/ocsp_signing.crt \
ocsp_signing
docker exec client pki \
nss-cert-show \
ocsp_signing
- name: Create audit signing cert
run: |
docker exec client pki \
nss-cert-request \
--subject "CN=Audit Signing Certificate" \
--ext /usr/share/pki/server/certs/audit_signing.conf \
--csr $SHARED/certs/audit_signing.csr
docker exec client pki \
nss-cert-issue \
--issuer ca_signing \
--csr $SHARED/certs/audit_signing.csr \
--ext /usr/share/pki/server/certs/audit_signing.conf \
--cert $SHARED/certs/audit_signing.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/audit_signing.crt \
--trust ,,P \
audit_signing
docker exec client pki \
nss-cert-show \
audit_signing
- name: Create subsystem cert
run: |
docker exec client pki \
nss-cert-request \
--subject "CN=Subsystem Certificate" \
--ext /usr/share/pki/server/certs/subsystem.conf \
--csr $SHARED/certs/subsystem.csr
docker exec client pki \
nss-cert-issue \
--issuer ca_signing \
--csr $SHARED/certs/subsystem.csr \
--ext /usr/share/pki/server/certs/subsystem.conf \
--cert $SHARED/certs/subsystem.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/subsystem.crt \
subsystem
docker exec client pki \
nss-cert-show \
subsystem
- name: Create SSL server cert
run: |
docker exec client pki \
nss-cert-request \
--subject "CN=ca.example.com" \
--ext /usr/share/pki/server/certs/sslserver.conf \
--csr $SHARED/certs/sslserver.csr
docker exec client pki \
nss-cert-issue \
--issuer ca_signing \
--csr $SHARED/certs/sslserver.csr \
--ext /usr/share/pki/server/certs/sslserver.conf \
--cert $SHARED/certs/sslserver.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/sslserver.crt \
sslserver
docker exec client pki \
nss-cert-show \
sslserver
- name: Create admin cert
run: |
docker exec client pki \
nss-cert-request \
--subject "CN=Administrator" \
--ext /usr/share/pki/server/certs/admin.conf \
--csr $SHARED/certs/admin.csr
docker exec client pki \
nss-cert-issue \
--issuer ca_signing \
--csr $SHARED/certs/admin.csr \
--ext /usr/share/pki/server/certs/admin.conf \
--cert $SHARED/certs/admin.crt
docker exec client pki \
nss-cert-import \
--cert $SHARED/certs/admin.crt \
admin
docker exec client pki \
nss-cert-show \
admin
- name: "Export system certs and keys to PKCS #12 file"
run: |
docker exec client pki pkcs12-export \
--pkcs12 $SHARED/certs/server.p12 \
--password Secret.123 \
ca_signing \
ocsp_signing \
audit_signing \
subsystem \
sslserver
- name: "Export admin cert and key to PKCS #12 file"
run: |
docker exec client pki pkcs12-export \
--pkcs12 $SHARED/certs/admin.p12 \
--password Secret.123 \
admin
- name: "Export admin key to PEM file"
run: |
docker exec client openssl pkcs12 \
-in $SHARED/certs/admin.p12 \
-passin pass:Secret.123 \
-out $SHARED/certs/admin.key \
-nodes \
-nocerts
####################################################################################################
# Set up CA database
- name: Set up DS container
run: |
tests/bin/ds-create.sh \
--image=${{ env.DS_IMAGE }} \
--hostname=ds.example.com \
--network=example \
--network-alias=ds.example.com \
--password=Secret.123 \
ds
# https://github.com/dogtagpki/pki/wiki/Setting-up-CA-Database
- name: Configure DS database
run: |
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/base/server/database/ds/config.ldif
- name: Add PKI schema
run: |
docker exec ds ldapmodify \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/base/server/database/ds/schema.ldif
- name: Add CA base entry
run: |
docker exec -i ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 << EOF
dn: dc=ca,dc=pki,dc=example,dc=com
objectClass: dcObject
dc: ca
EOF
- name: Add CA database entries
run: |
sed \
-e 's/{rootSuffix}/dc=ca,dc=pki,dc=example,dc=com/g' \
base/ca/database/ds/create.ldif \
| tee create.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/create.ldif
- name: Add CA search indexes
run: |
sed \
-e 's/{database}/userroot/g' \
base/ca/database/ds/index.ldif \
| tee index.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/index.ldif
- name: Rebuild CA search indexes
run: |
# start rebuild task
sed \
-e 's/{database}/userroot/g' \
base/ca/database/ds/indextasks.ldif \
| tee indextasks.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/indextasks.ldif
# wait for task to complete
while true; do
sleep 1
docker exec ds ldapsearch \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-b "cn=index1160589770, cn=index, cn=tasks, cn=config" \
-LLL \
nsTaskExitCode \
| tee output
sed -n -e 's/nsTaskExitCode:\s*\(.*\)/\1/p' output > nsTaskExitCode
cat nsTaskExitCode
if [ -s nsTaskExitCode ]; then
break
fi
done
echo "0" > expected
diff expected nsTaskExitCode
- name: Add CA ACL resources
run: |
sed \
-e 's/{rootSuffix}/dc=ca,dc=pki,dc=example,dc=com/g' \
base/ca/database/ds/acl.ldif \
| tee acl.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/acl.ldif
- name: Add CA VLV indexes
run: |
sed \
-e 's/{instanceId}/pki-tomcat/g' \
-e 's/{database}/userroot/g' \
-e 's/{rootSuffix}/dc=ca,dc=pki,dc=example,dc=com/g' \
base/ca/database/ds/vlv.ldif \
| tee vlv.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/vlv.ldif
- name: Rebuild CA VLV indexes
run: |
# start rebuild task
sed \
-e 's/{database}/userroot/g' \
-e 's/{instanceId}/pki-tomcat/g' \
base/ca/database/ds/vlvtasks.ldif \
| tee vlvtasks.ldif
docker exec ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-f $SHARED/vlvtasks.ldif
# wait for task to complete
while true; do
sleep 1
docker exec ds ldapsearch \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 \
-b "cn=index1160589769, cn=index, cn=tasks, cn=config" \
-LLL \
nsTaskExitCode \
| tee output
sed -n -e 's/nsTaskExitCode:\s*\(.*\)/\1/p' output > nsTaskExitCode
cat nsTaskExitCode
if [ -s nsTaskExitCode ]; then
break
fi
done
echo "0" > expected
diff expected nsTaskExitCode
####################################################################################################
# Set up admin user
# https://github.com/dogtagpki/pki/wiki/Setting-up-CA-Admin-User
- name: Add admin user
run: |
docker exec -i ds ldapadd \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 << EOF
dn: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: cmsuser
cn: admin
sn: admin
uid: admin
mail: [email protected]
userPassword: Secret.123
userState: 1
userType: adminType
EOF
- name: Assign admin cert to admin user
run: |
# convert cert from PEM to DER
openssl x509 -outform der -in certs/admin.crt -out certs/admin.der
# get serial number
openssl x509 -text -noout -in certs/admin.crt | tee output
SERIAL=$(sed -En 'N; s/^ *Serial Number:\n *(.*)$/\1/p; D' output)
echo "SERIAL: $SERIAL"
HEX_SERIAL=$(echo "$SERIAL" | tr -d ':')
echo "HEX_SERIAL: $HEX_SERIAL"
DEC_SERIAL=$(python -c "print(int('$HEX_SERIAL', 16))")
echo "DEC_SERIAL: $DEC_SERIAL"
docker exec -i ds ldapmodify \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 << EOF
dn: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: description
description: 2;$DEC_SERIAL;CN=CA Signing Certificate;CN=Administrator
-
add: userCertificate
userCertificate:< file:$SHARED/certs/admin.der
-
EOF
- name: Add admin user into CA groups
run: |
docker exec -i ds ldapmodify \
-H ldap://ds.example.com:3389 \
-D "cn=Directory Manager" \
-w Secret.123 << EOF
dn: cn=Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Certificate Manager Agents,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Security Domain Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise CA Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise KRA Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise RA Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise TKS Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise OCSP Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
dn: cn=Enterprise TPS Administrators,ou=groups,dc=ca,dc=pki,dc=example,dc=com
changetype: modify
add: uniqueMember
uniqueMember: uid=admin,ou=people,dc=ca,dc=pki,dc=example,dc=com
-
EOF
####################################################################################################
# Install CA that only supports REST API v1
- name: Create PKI CA 11.4 Dockerfile
run: |
# create a new Dockerfile to disable access log buffer
cat > Dockerfile-pki-ca-11.4 <<EOF
FROM quay.io/dogtagpki/pki-ca:11.4 AS pki-ca-11.4
RUN dnf install -y xmlstarlet
RUN cat /etc/tomcat/server.xml
RUN xmlstarlet edit --inplace \
-u "//Valve[@className='org.apache.catalina.valves.AccessLogValve']/@buffered" \
-v "false" \
-i "//Valve[@className='org.apache.catalina.valves.AccessLogValve' and not(@buffered)]" \
-t attr \
-n "buffered" \
-v "false" \
/etc/tomcat/server.xml
EOF
- name: Build PKI CA 11.4 image
uses: docker/build-push-action@v6
with:
context: .
tags: pki-ca:11.4
target: pki-ca-11.4
file: Dockerfile-pki-ca-11.4
- name: Create PKI CA 11.4 container
run: |
docker run \
--name ca \
--hostname=ca.example.com \
--network=example \
--network-alias=ca.example.com \
-v $PWD/certs:/certs \
--detach \
pki-ca:11.4
- name: Wait for CA container to start
run: |
docker exec client curl \
--retry 180 \
--retry-delay 0 \
--retry-connrefused \
-s \
-k \
-o /dev/null \
https://ca.example.com:8443
####################################################################################################
# Check Python API against CA that only supports REST API v1
- name: Check PKI server info
run: |
docker exec client python /usr/share/pki/tests/bin/pki-info.py \
-U https://ca.example.com:8443 \
--ca-bundle $SHARED/certs/ca_signing.crt \
-v
sleep 1
# check HTTP methods, paths, protocols, status, and authenticated users
docker exec ca find /var/log/pki/pki-tomcat \
-name "localhost_access_log.*" \
-exec cat {} \; \
| tail -2 \
| sed -e 's/^.* .* \(.*\) \[.*\] "\(.*\)" \(.*\) .*$/\2 \3 \1/' \
| tee output
# Python API should fall back to REST API v1
cat > expected << EOF
GET /pki/v2/info HTTP/1.1 404 -
GET /pki/rest/info HTTP/1.1 200 -
EOF
diff expected output
- name: Check CA certs
run: |
docker exec client python /usr/share/pki/tests/ca/bin/pki-ca-cert-find.py \
-U https://ca.example.com:8443 \
--ca-bundle $SHARED/certs/ca_signing.crt \
-v
sleep 1
# check HTTP methods, paths, protocols, status, and authenticated users
docker exec ca find /var/log/pki/pki-tomcat \
-name "localhost_access_log.*" \
-exec cat {} \; \
| tail -3 \
| sed -e 's/^.* .* \(.*\) \[.*\] "\(.*\)" \(.*\) .*$/\2 \3 \1/' \
| tee output
# Python API should fall back to REST API v1
cat > expected << EOF
GET /pki/v2/info HTTP/1.1 404 -
GET /pki/rest/info HTTP/1.1 200 -
POST /ca/rest/certs/search HTTP/1.1 200 -
EOF
- name: Check CA users
run: |
docker exec client python /usr/share/pki/tests/ca/bin/pki-ca-user-find.py \
-U https://ca.example.com:8443 \
--ca-bundle $SHARED/certs/ca_signing.crt \
--client-cert $SHARED/certs/admin.crt \
--client-key $SHARED/certs/admin.key \
-v
sleep 1
# check HTTP methods, paths, protocols, status, and authenticated users
docker exec ca find /var/log/pki/pki-tomcat \
-name "localhost_access_log.*" \
-exec cat {} \; \
| tail -5 \
| sed -e 's/^.* .* \(.*\) \[.*\] "\(.*\)" \(.*\) .*$/\2 \3 \1/' \
| tee output
# Python API should fall back to REST API v1
cat > expected << EOF
GET /pki/v2/info HTTP/1.1 404 -
GET /pki/rest/info HTTP/1.1 200 -
GET /ca/rest/account/login HTTP/1.1 200 admin
GET /ca/rest/admin/users HTTP/1.1 200 admin
GET /ca/rest/account/logout HTTP/1.1 204 admin
EOF
diff expected output
- name: Check DS server systemd journal
if: always()
run: |
docker exec ds journalctl -x --no-pager -u [email protected]
- name: Check DS container logs
if: always()
run: |
docker logs ds
- name: Check PKI server access log
if: always()
run: |
docker exec ca find /var/log/pki/pki-tomcat -name "localhost_access_log.*" -exec cat {} \;
- name: Check CA container logs
if: always()
run: |
docker logs ca