]> git.ipfire.org Git - thirdparty/strongswan.git/commitdiff
pki: Created pki --scepca man page
authorAndreas Steffen <andreas.steffen@strongswan.org>
Sat, 30 Jul 2022 12:21:50 +0000 (14:21 +0200)
committerAndreas Steffen <andreas.steffen@strongswan.org>
Wed, 24 Aug 2022 18:46:44 +0000 (20:46 +0200)
configure.ac
src/pki/man/Makefile.am
src/pki/man/pki---scepca.1.in [new file with mode: 0644]
src/pki/man/pki.1.in

index dd9d128c1db0f5a69509e0544d659c8fa7749e23..7434d58612dbab64e684207a564c46d91082e516 100644 (file)
@@ -2175,6 +2175,7 @@ AC_CONFIG_FILES([
        src/pki/man/pki---print.1
        src/pki/man/pki---pub.1
        src/pki/man/pki---req.1
+       src/pki/man/pki---scepca.1
        src/pki/man/pki---self.1
        src/pki/man/pki---signcrl.1
        src/pki/man/pki---verify.1
index fc94400317357d25891f7445ddf46b3aa6b364c5..489c913674642119e65a87b722cc5237410f24df 100644 (file)
@@ -9,6 +9,7 @@ man1_MANS = \
        pki---print.1 \
        pki---pub.1 \
        pki---req.1 \
+       pki---scepca.1 \
        pki---self.1 \
        pki---signcrl.1 \
        pki---verify.1
diff --git a/src/pki/man/pki---scepca.1.in b/src/pki/man/pki---scepca.1.in
new file mode 100644 (file)
index 0000000..ac37055
--- /dev/null
@@ -0,0 +1,149 @@
+.TH "PKI \-\-SCEPCA" 1 "2022-08-22" "@PACKAGE_VERSION@" "strongSwan"
+.
+.SH "NAME"
+.
+pki \-\-scepca \- Get CA [and RA] certificate[s] from a SCEP server
+.
+.SH "SYNOPSIS"
+.
+.SY pki\ \-\-scepca
+.BI\-\-\-url\~ url
+.OP \-\-caout file
+.OP \-\-raout file
+.OP \-\-outform encoding
+.OP \-\-force
+.OP \-\-debug level
+.YS
+.
+.SY pki\ \-\-scepca
+.BI \-\-options\~ file
+.YS
+.
+.SY "pki \-\-scepca"
+.B \-h
+|
+.B \-\-help
+.YS
+.
+.SH "DESCRIPTION"
+.
+This sub-command of
+.BR pki (1)
+gets CA and RA certificates via http from a SCEP server using the \fIGetCACert\fR
+command of the Simple Certificate Enrollment Protocol (RFC 8894).
+.
+.SH "OPTIONS"
+.
+.TP
+.B "\-h, \-\-help"
+Print usage information with a summary of the available options.
+.TP
+.BI "\-v, \-\-debug " level
+Set debug level, default: 1.
+.TP
+.BI "\-+, \-\-options " file
+Read command line options from \fIfile\fR.
+.TP
+.BI "\-u, \-\-url " url
+URL of the SCEP server.
+.TP
+.BI "\-c, \-\-caout " file
+If present, path where the fetched root CA certificate file is stored to.
+If several CA certificates are downloaded, then the value of
+.B \-\-caout
+is used as a template to derive unique filenames (*-1, *-2, etc.) for the
+intermediate or sub CA certificates.
+If a file suffix is missing, then depending on the value of
+.B \-\-outform
+either .\fIder\fR (the default) or .\fIpem\fR is automatically appended.
+.TP
+.BI "\-r, \-\-raout " file
+If present, path where the fetched RA certificate file is stored to.
+If multiple RA certificates are available, then the value of
+.B \-\-raout
+is used as a template to derive unique filenames (*-2, etc.). If the
+.B \-\-raout
+option is missing, then the value of
+.B \-\-caout
+is used as a template to derive unique filenames (*-ra, *-ra-2, etc.) for the RA
+certificates. If a file suffix is missing, then depending on the value of
+.B \-\-outform
+either .\fIder\fR (the default) or .\fIpem\fR is automatically appended.
+.TP
+.BI "\-f, \-\-outform " encoding
+Encoding of the created certificate file. Either \fIder\fR (ASN.1 DER) or
+\fIpem\fR (Base64 PEM), defaults to \fIder\fR.
+.TP
+.B "\-F, \-\-force"
+Force overwrite of existing files.
+.
+.SH "EXAMPLES"
+.
+A SCEP server sends a root CA and an intermediate CA certificate as well as an
+RA certificate:
+.PP
+.EX
+pki \-\-scepca \-\-url http://pki.strongswan.org:8080/scep \-\-caout myca.crt \-\-raout myra.crt
+
+Root CA cert "C=CH, O=strongSwan Project, CN=strongSwan Root CA"
+  serial: 65:31:00:ca:79:da:16:6b:aa:ac:89:e2:a8:f9:49:c3:10:ab:64:54
+  SHA256: 96:70:50:51:cd:b9:e7:94:6b:04:f6:15:45:80:fc:90:85:01:71:2a:f6:4f:d1:1b:2d:a1:7e:eb:bf:dd:be:86
+  SHA1  : 8e:f3:78:b0:34:a6:c1:6a:7b:c6:f5:91:eb:e5:46:9b:0d:0a:a7:ba (jvN4sDSmwWp7xvWR6+VGmw0Kp7o)
+Root CA cert is untrusted, valid until Aug 12 15:51:34 2032, 'myca.crt'
+Sub CA cert "C=CH, O=strongSwan Project, CN=strongSwan Issuing CA"
+  serial: 74:f9:7e:72:7d:b8:fd:f2:c6:e5:1b:fa:37:f9:cb:87:bf:9c:ea:e2
+  SHA256: a3:5b:4b:12:d5:8f:68:7b:05:11:08:27:f5:42:62:b8:b5:01:1b:19:37:9c:28:78:5d:37:08:69:6a:8c:07:bf
+  SHA1  : 8c:e6:67:67:c2:23:89:7b:d0:bc:b1:50:d2:1c:bc:8d:8d:69:15:11 (jOZnZ8IjiXvQvLFQ0hy8jY1pFRE)
+  using certificate "C=CH, O=strongSwan Project, CN=strongSwan Issuing CA"
+  using trusted ca certificate "C=CH, O=strongSwan Project, CN=strongSwan Root CA"
+  reached self-signed root ca with a path length of 0
+Sub CA cert is trusted, valid until Aug 12 15:51:34 2027, 'mycacert-1.crt'
+RA cert "C=CH, O=strongSwan Project, CN=SCEP RA"
+  serial: 74:f9:7e:72:7d:b8:fd:f2:c6:e5:1b:fa:37:f9:cb:87:bf:9c:ea:e3
+  SHA256: 57:22:f3:13:69:2f:24:82:12:59:8e:05:63:0b:f5:a8:fb:4e:78:87:8d:68:d1:4c:c1:c4:b5:85:db:bb:64:df
+  SHA1  : bc:d1:46:76:55:7f:8c:d1:c5:22:31:b9:d7:b1:49:b5:95:a4:f3:ea (vNFGdlV/jNHFIjG517FJtZWk8+o)
+  using certificate "C=CH, O=strongSwan Project, CN=SCEP RA"
+  using untrusted intermediate certificate "C=CH, O=strongSwan Project, CN=strongSwan Issuing CA"
+  using trusted ca certificate "C=CH, O=strongSwan Project, CN=strongSwan Root CA"
+  reached self-signed root ca with a path length of 1
+RA cert is trusted, valid until Aug 10 15:51:34 2023, 'myra.crt'
+.EE
+.PP
+The trusthworthiness of the root CA certificate has to be established manually by
+verifying the SHA256 or SHA1 fingerprint of the DER-encoded certificate that is
+e.g. listed on the official PKI website or by some other means.
+.P
+The stored certificate files in DER format can be overwritten by PEM-encoded
+versions with:
+.PP
+.EX
+pki \-\-scepca \-\-url http://pki.strongswan.org:8080/scep \-\-caout myca.crt \-\-raout myra.crt \\
+             \-\-outform pem \-\-force
+.EE
+.PP
+If the
+.B \-\-raout
+option is omitted and the
+.B \-\-caout
+template doesn't have a file suffix, then with
+.B \-\-outform
+\fIpem\fR the following filenames are derived:
+.PP
+.EX
+pki \-\-scepca \-\-url http://pki.strongswan.org:8080/scep \-\-caout scep/myca \-\-outform pem
+
+Root CA cert "C=CH, O=strongSwan Project, CN=strongSwan Root CA"
+  ...
+Root CA cert is untrusted, valid until Aug 12 15:51:34 2032, written to 'scep/myca.pem'
+Sub CA cert "C=CH, O=strongSwan Project, CN=strongSwan Issuing CA"
+  ...
+Sub CA cert is trusted, valid until Aug 12 15:51:34 2027, 'mycacert-1.crt'
+RA cert "C=CH, O=strongSwan Project, CN=SCEP RA"
+  ...
+RA cert is trusted, valid until Aug 10 15:51:34 2023, 'myca-ra.crt'
+.EE
+.PP
+.
+.SH "SEE ALSO"
+.
+.BR pki (1)
index f1a2ae2c07ef74a2b8bddc0b3eccdcdff1d92369..6f1efa7a021711c6833b0341d9f9815277ff142e 100644 (file)
@@ -1,4 +1,4 @@
-.TH PKI 1 "2015-08-06" "@PACKAGE_VERSION@" "strongSwan"
+.TH PKI 1 "2022-08-22" "@PACKAGE_VERSION@" "strongSwan"
 .
 .SH "NAME"
 .
@@ -30,6 +30,16 @@ private key of a CA and containing subjectAltNames, CRL distribution points
 and URIs of OCSP servers. You can also extract raw public keys from private
 keys, certificate requests and certificates and compute two kinds of SHA-1-based
 key IDs.
+.P
+The
+.B pki
+command now supports certificate enrollment via the
+.B Simple Certificate Enrollment Protocol
+(SCEP) as defined by RFC 8894, replacing the obsoleted
+.B ipsec scepclient
+tool. Additionally the
+.B Enrollment over Secure Transport
+(EST) protocol (RFC 7030) is supported, too.
 .
 .SH "COMMANDS"
 .
@@ -72,6 +82,18 @@ Extract a public key from a private key or certificate.
 .TP
 .B "\-v, \-\-verify"
 Verify a certificate using a CA certificate.
+.TP
+.B "\-S, \-\-scep"
+Enroll an X.509 certificate with a SCEP server.
+.TP
+.B "\-C, \-\-scepca"
+Get CA [and RA] certificate[s] from a SCEP server.
+.TP
+.B "\-E, \-\-est"
+Enroll an X.509 certificate with an EST server.
+.TP
+.B "\-e, \-\-estca"
+Get CA certificate[s] from an EST server.
 .
 .SH "EXAMPLES"
 .
@@ -161,4 +183,8 @@ certificates with the \-\-crl option.
 .BR pki\ \-\-print (1),
 .BR pki\ \-\-dn (1),
 .BR pki\ \-\-pub (1),
-.BR pki\ \-\-verify (1)
+.BR pki\ \-\-verify (1),
+.BR pki\ \-\-scep (1)
+.BR pki\ \-\-scepca (1)
+.BR pki\ \-\-est (1)
+.BR pki\ \-\-estca (1)