Fix various doc nits. (a7aadf8b) · Commits · CYBER - Cyber Security / TS 103 523 MSP / TLMSP / TLMSP OpenSSL

doc/apps/CA.pl.pod

+42 −20

Original line number	Original line	Diff line number	Diff line
	@@ -7,19 +7,27 @@ CA.pl - friendlier interface for OpenSSL certificate programs
	=head1 SYNOPSIS		=head1 SYNOPSIS

	B<CA.pl>		B<CA.pl>
	[B<-?>]		B<-?> \|
	[B<-h>]		B<-h> \|
	[B<-help>]		B<-help>
	[B<-newcert>]
	[B<-newreq>]		B<CA.pl>
	[B<-newreq-nodes>]		B<-newcert> \|
	[B<-newca>]		B<-newreq> \|
	[B<-xsign>]		B<-newreq-nodes> \|
	[B<-sign>]		B<-xsign> \|
	[B<-signreq>]		B<-sign> \|
	[B<-signcert>]		B<-signCA> \|
	[B<-verify>]		B<-signcert> \|
	[B<files>]		B<-crl> \|
			B<-newca>
			[B<-extra-cmd> extra-params]

			B<CA.pl> B<-pkcs12> [B<-extra-pkcs12> extra-params] [B<certname>]

			B<CA.pl> B<-verify> [B<-extra-verify> extra-params] B<certfile>...

			B<CA.pl> B<-revoke> [B<-extra-ca> extra-params] B<certfile> [B<reason>]

	=head1 DESCRIPTION		=head1 DESCRIPTION

	@@ -28,7 +36,7 @@ arguments to the B<openssl> command for some common certificate operations.
	It is intended to simplify the process of certificate creation and management		It is intended to simplify the process of certificate creation and management
	by the use of some simple options.		by the use of some simple options.

	=head1 COMMAND OPTIONS		=head1 OPTIONS

	=over 4		=over 4

	@@ -40,15 +48,18 @@ prints a usage message.

	creates a new self signed certificate. The private key is written to the file		creates a new self signed certificate. The private key is written to the file
	"newkey.pem" and the request written to the file "newreq.pem".		"newkey.pem" and the request written to the file "newreq.pem".
			This argument invokes B<openssl req> command.

	=item B<-newreq>		=item B<-newreq>

	creates a new certificate request. The private key is written to the file		creates a new certificate request. The private key is written to the file
	"newkey.pem" and the request written to the file "newreq.pem".		"newkey.pem" and the request written to the file "newreq.pem".
			Executes B<openssl req> command below the hood.

	=item B<-newreq-nodes>		=item B<-newreq-nodes>

	is like B<-newreq> except that the private key will not be encrypted.		is like B<-newreq> except that the private key will not be encrypted.
			Uses B<openssl req> command.

	=item B<-newca>		=item B<-newca>

	@@ -57,6 +68,7 @@ and B<-xsign> options). The user is prompted to enter the filename of the CA
	certificates (which should also contain the private key) or by hitting ENTER		certificates (which should also contain the private key) or by hitting ENTER
	details of the CA will be prompted for. The relevant files and directories		details of the CA will be prompted for. The relevant files and directories
	are created in a directory called "demoCA" in the current directory.		are created in a directory called "demoCA" in the current directory.
			B<openssl req> and B<openssl ca> commands are get invoked.

	=item B<-pkcs12>		=item B<-pkcs12>

	@@ -68,29 +80,31 @@ B<-sign> option. The PKCS#12 file can be imported directly into a browser.
	If there is an additional argument on the command line it will be used as the		If there is an additional argument on the command line it will be used as the
	"friendly name" for the certificate (which is typically displayed in the browser		"friendly name" for the certificate (which is typically displayed in the browser
	list box), otherwise the name "My Certificate" is used.		list box), otherwise the name "My Certificate" is used.
			Delegates work to B<openssl pkcs12> command.

	=item B<-sign>, B<-signreq>, B<-xsign>		=item B<-sign>, B<-signcert>, B<-xsign>

	calls the B<ca> program to sign a certificate request. It expects the request		calls the B<ca> program to sign a certificate request. It expects the request
	to be in the file "newreq.pem". The new certificate is written to the file		to be in the file "newreq.pem". The new certificate is written to the file
	"newcert.pem" except in the case of the B<-xsign> option when it is written		"newcert.pem" except in the case of the B<-xsign> option when it is written
	to standard output.		to standard output. Leverages B<openssl ca> command.


	=item B<-signCA>		=item B<-signCA>

	this option is the same as the B<-signreq> option except it uses the configuration		this option is the same as the B<-signreq> option except it uses the configuration
	file section B<v3_ca> and so makes the signed request a valid CA certificate. This		file section B<v3_ca> and so makes the signed request a valid CA certificate. This
	is useful when creating intermediate CA from a root CA.		is useful when creating intermediate CA from a root CA.
			Extra params are passed on to B<openssl ca> command.

	=item B<-signcert>		=item B<-signcert>

	this option is the same as B<-sign> except it expects a self signed certificate		this option is the same as B<-sign> except it expects a self signed certificate
	to be present in the file "newreq.pem".		to be present in the file "newreq.pem".
			Extra params are passed on to B<openssl x509> and B<openssl ca> commands.

	=item B<-crl>		=item B<-crl>

	generate a CRL		generate a CRL. Executes B<openssl ca> command.

	=item B<-revoke certfile [reason]>		=item B<-revoke certfile [reason]>

	@@ -98,15 +112,23 @@ revoke the certificate contained in the specified B<certfile>. An optional
	reason may be specified, and must be one of: B<unspecified>,		reason may be specified, and must be one of: B<unspecified>,
	B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>,		B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>,
	B<cessationOfOperation>, B<certificateHold>, or B<removeFromCRL>.		B<cessationOfOperation>, B<certificateHold>, or B<removeFromCRL>.
			Leverages B<openssl ca> command.

	=item B<-verify>		=item B<-verify>

	verifies certificates against the CA certificate for "demoCA". If no certificates		verifies certificates against the CA certificate for "demoCA". If no certificates
	are specified on the command line it tries to verify the file "newcert.pem".		are specified on the command line it tries to verify the file "newcert.pem".
			Invokes B<openssl verify> command.

	=item B<files>		=item B<-extra-req> \| B<-extra-ca> \| B<-extra-pkcs12> \| B<-extra-x509> \| B<-extra-verify> <extra-params>

	one or more optional certificate file names for use with the B<-verify> command.		The purpose of these parameters is to allow optional parameters to be supplied
			to B<openssl> that this command executes. The B<-extra-cmd> are specific to the
			option being used and the B<openssl> command getting invoked. For example
			when this command invokes B<openssl req> extra parameters can be passed on
			with the B<-extra-req> parameter. The
			B<openssl> commands being invoked per option are documented below.
			Users should consult B<openssl> command documentation for more information.

	=back		=back

doc/apps/ca.pod

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -62,7 +62,7 @@ and their status.

	The options descriptions will be divided into each purpose.		The options descriptions will be divided into each purpose.

	=head1 COMMAND OPTIONS		=head1 OPTIONS

	=over 4		=over 4

doc/apps/ciphers.pod

+8 −2

Original line number	Original line	Diff line number	Diff line
	@@ -15,6 +15,7 @@ B<openssl> B<ciphers>
	[B<-tls1>]		[B<-tls1>]
	[B<-tls1_1>]		[B<-tls1_1>]
	[B<-tls1_2>]		[B<-tls1_2>]
			[B<-tls1_3>]
	[B<-s>]		[B<-s>]
	[B<-psk>]		[B<-psk>]
	[B<-srp>]		[B<-srp>]
	@@ -27,7 +28,7 @@ The B<ciphers> command converts textual OpenSSL cipher lists into ordered
	SSL cipher preference lists. It can be used as a test tool to determine		SSL cipher preference lists. It can be used as a test tool to determine
	the appropriate cipherlist.		the appropriate cipherlist.

	=head1 COMMAND OPTIONS		=head1 OPTIONS

	=over 4		=over 4

	@@ -69,6 +70,11 @@ L<SSL_CIPHER_description(3)>.

	Like B<-v>, but include the official cipher suite values in hex.		Like B<-v>, but include the official cipher suite values in hex.

			=item B<-tls1_3>

			In combination with the B<-s> option, list the ciphers which would be used if
			TLSv1.3 were negotiated.

	=item B<-tls1_2>		=item B<-tls1_2>

	In combination with the B<-s> option, list the ciphers which would be used if		In combination with the B<-s> option, list the ciphers which would be used if
	@@ -711,7 +717,7 @@ Set security level to 2 and display all ciphers consistent with level 2:

	=head1 SEE ALSO		=head1 SEE ALSO

	L<s_client(1)>, L<s_server(1)>, L<ssl(3)>		L<s_client(1)>, L<s_server(1)>, L<ssl(7)>

	=head1 HISTORY		=head1 HISTORY

doc/apps/cms.pod

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -104,7 +104,7 @@ B<openssl> B<cms>
	The B<cms> command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and		The B<cms> command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and
	verify, compress and uncompress S/MIME messages.		verify, compress and uncompress S/MIME messages.

	=head1 COMMAND OPTIONS		=head1 OPTIONS

	There are fourteen operation options that set the type of operation to be		There are fourteen operation options that set the type of operation to be
	performed. The meaning of the other options varies according to the operation		performed. The meaning of the other options varies according to the operation

doc/apps/crl.pod

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -26,7 +26,7 @@ B<openssl> B<crl>

	The B<crl> command processes CRL files in DER or PEM format.		The B<crl> command processes CRL files in DER or PEM format.

	=head1 COMMAND OPTIONS		=head1 OPTIONS

	=over 4		=over 4