Skip to content

Commit

Permalink
Fix typos in code and man pages
Browse files Browse the repository at this point in the history
This patch fixes typos of code and man pages reported by lintian.

Signed-off-by: Seunghun Han <kkamagui@gmail.com>
  • Loading branch information
kkamagui authored and stefanberger committed Jun 15, 2020
1 parent fb5256b commit 2bc601b
Show file tree
Hide file tree
Showing 16 changed files with 57 additions and 57 deletions.
14 changes: 7 additions & 7 deletions man/man3/swtpm_ioctls.3
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ and control commands used by the control channel over socket interface.
.IX Header "DESCRIPTION"
The \s-1CUSE TPM\s0 implements an ioctl interface on the \s-1CUSE TPM\s0's character device.
The ioctl's are used for out-of-band control of various \s-1TPM\s0 operations,
such as its intialization, resetting, and state migration. The control channel
such as its initialization, resetting, and state migration. The control channel
over \s-1TCP\s0 or UnixIO sockets uses control commands for these operations.
.PP
The following is an enumeration of the supported ioctl's and control commands,
Expand All @@ -158,10 +158,10 @@ commands return a \s-1TPM\s0 error code in their response. Ioctl's are prefixed
.PP
In case of the ioctl interface, the pointer to a command's data structure is
passed as the 2nd parameter to the \fIioctl()\fR function. The fields in the command's
data structure are to be fill out in host endianess format.
data structure are to be fill out in host endianness format.
.PP
In case of control commands, the command code must be encoded as a 4 byte
interger preceding the command's data structure. Command code and data must be
integer preceding the command's data structure. Command code and data must be
written in big endian format.
.IP "\fB\s-1PTM_GET_CAPABILITY / CMD_GET_CAPABILITY,\s0 ptm_cap\fR" 4
.IX Item "PTM_GET_CAPABILITY / CMD_GET_CAPABILITY, ptm_cap"
Expand Down Expand Up @@ -242,7 +242,7 @@ delete the volatile state upon startup (\fB\s-1PTM_INIT_FLAG_DELETE_VOLATILE\s0\
A \s-1TPM\s0 result code is returned in the tpm_result field.
.IP "\fB\s-1PTM_SHUTDOWN / CMD_SHUTDOWN,\s0 ptm_res\fR" 4
.IX Item "PTM_SHUTDOWN / CMD_SHUTDOWN, ptm_res"
This ioctl allows to shut down the \s-1TPM.\s0
This ioctl allows a user to shut down the \s-1TPM.\s0
.Sp
A \s-1TPM\s0 result code is returned in ptm_res.
.IP "\fB\s-1PTM_GET_TPMESTABLISHED / CMD_GET_TPMESTABLISHED,\s0 ptm_est\fR" 4
Expand Down Expand Up @@ -387,11 +387,11 @@ The ptm_getstate data structure looks as follows:
\& };
.Ve
.Sp
In the request the state_flags field allows to set the
In the request the state_flags field allows a user to set the
\&\fB\s-1PTM_STATE_FLAG_DECRYPT\s0\fR flag to retrieve decrypted \s-1TPM\s0 state in case
the \s-1TPM\s0's state was written in encrypted form.
.Sp
The type field allows to choose one of the \s-1TPM\s0's state blobs, and must be
The type field allows a user to choose one of the \s-1TPM\s0's state blobs, and must be
one of \fB\s-1PTM_BLOB_TYPE_PERMANENT\s0\fR, \fB\s-1PTM_BLOB_TYPE_VOLATILE\s0\fR, and
\&\fB\s-1PTM_BLOB_TYPE_SAVESTATE\s0\fR.
.Sp
Expand Down Expand Up @@ -489,7 +489,7 @@ See also \fB\f(BIsendmsg\fB\|(2)\fR and \fB\f(BIcmsg\fB\|(3)\fR.
A \s-1TPM\s0 result code is returned in ptm_res.
.IP "\fB\s-1CMD_SET_BUFFERSIZE,\s0 ptm_setbuffersize\fR" 4
.IX Item "CMD_SET_BUFFERSIZE, ptm_setbuffersize"
This command allows to set and query for the buffer size that the \s-1TPM\s0 is
This command allows a user to set and query for the buffer size that the \s-1TPM\s0 is
using for input and output I/O buffers.
.Sp
The ptm_setbuffersize data structure looks as follows:
Expand Down
14 changes: 7 additions & 7 deletions man/man3/swtpm_ioctls.pod
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ B<#include E<lt>tpm_ioctl.hE<gt>>

The CUSE TPM implements an ioctl interface on the CUSE TPM's character device.
The ioctl's are used for out-of-band control of various TPM operations,
such as its intialization, resetting, and state migration. The control channel
such as its initialization, resetting, and state migration. The control channel
over TCP or UnixIO sockets uses control commands for these operations.

The following is an enumeration of the supported ioctl's and control commands,
Expand All @@ -21,10 +21,10 @@ I<PTM> and control commands are prefixed with I<CMD>.

In case of the ioctl interface, the pointer to a command's data structure is
passed as the 2nd parameter to the ioctl() function. The fields in the command's
data structure are to be fill out in host endianess format.
data structure are to be fill out in host endianness format.

In case of control commands, the command code must be encoded as a 4 byte
interger preceding the command's data structure. Command code and data must be
integer preceding the command's data structure. Command code and data must be
written in big endian format.

=over 4
Expand Down Expand Up @@ -122,7 +122,7 @@ A TPM result code is returned in the tpm_result field.

=item B<PTM_SHUTDOWN / CMD_SHUTDOWN, ptm_res>

This ioctl allows to shut down the TPM.
This ioctl allows a user to shut down the TPM.

A TPM result code is returned in ptm_res.

Expand Down Expand Up @@ -267,11 +267,11 @@ The ptm_getstate data structure looks as follows:
} u;
};

In the request the state_flags field allows to set the
In the request the state_flags field allows a user to set the
B<PTM_STATE_FLAG_DECRYPT> flag to retrieve decrypted TPM state in case
the TPM's state was written in encrypted form.

The type field allows to choose one of the TPM's state blobs, and must be
The type field allows a user to choose one of the TPM's state blobs, and must be
one of B<PTM_BLOB_TYPE_PERMANENT>, B<PTM_BLOB_TYPE_VOLATILE>, and
B<PTM_BLOB_TYPE_SAVESTATE>.

Expand Down Expand Up @@ -370,7 +370,7 @@ A TPM result code is returned in ptm_res.

=item B<CMD_SET_BUFFERSIZE, ptm_setbuffersize>

This command allows to set and query for the buffer size that the TPM is
This command allows a user to set and query for the buffer size that the TPM is
using for input and output I/O buffers.

The ptm_setbuffersize data structure looks as follows:
Expand Down
22 changes: 11 additions & 11 deletions man/man8/swtpm.8
Original file line number Diff line number Diff line change
Expand Up @@ -183,15 +183,15 @@ must be passed with the fd parameter and the commands are read from this file
descriptor then.
If a port is provided the \fIbind address\fR on which to listen for \s-1TCP\s0 connections
can be provided as well; the default bind address is 127.0.0.1. If a link
local IPv6 addresss if provided, the name of the interface to bind to must be
local IPv6 address is provided, the name of the interface to bind to must be
provided with \fIifname\fR.
.Sp
This parameter enables a persistent connection by default unless the disconnect option
is given. This parameter should be used rather than the \-p and \-\-fd options.
.IP "\fB\-\-server type=unixio[,path=<path>][,fd=<fd>] [,mode=<0...>][,uid=<uid>][,gid=<gid>]\fR" 4
.IX Item "--server type=unixio[,path=<path>][,fd=<fd>] [,mode=<0...>][,uid=<uid>][,gid=<gid>]"
Expect UnixIO connections on the given path. If no path is provided, a file descriptor
must be passed instead. The mode parameter allows to set the file mode bits of the
must be passed instead. The mode parameter allows a user to set the file mode bits of the
UnixIO path. The mode bits value must be given as an octal number starting with a '0'.
The default value is 0770. uid and gid set the ownership of the UnixIO socket's path.
This operation requires root privileges.
Expand Down Expand Up @@ -235,10 +235,10 @@ This option adds a control channel to the \s-1TPM.\s0 The control channel can ei
a given \fIpath\fR or \fIfiledescriptor\fR or it can use a \s-1TCP\s0 socket on the given \fIport\fR or \fIfiledescriptor\fR.
If a port is provided the \fIbind address\fR on which to listen for \s-1TCP\s0 connections
can be provided as well; the default bind address is 127.0.0.1. If a link
local IPv6 addresss if provided, the name of the interface to bind to must be
local IPv6 address is provided, the name of the interface to bind to must be
provided with \fIifname\fR.
.Sp
The mode parameter allows to set the file mode bits of the UnixIO path.
The mode parameter allows a user to set the file mode bits of the UnixIO path.
The mode bits value must be given as an octal number starting with a '0'.
The default value is 0770. uid and gid set the ownership of the UnixIO socket's path.
This operation requires root privileges.
Expand Down Expand Up @@ -275,7 +275,7 @@ Choose \s-1TPM 2\s0 functionality; by default a \s-1TPM 1.2\s0 is chosen.
Enable logging to a file given its file descriptor or its path. Use '\-' for path to
suppress the logging.
.Sp
The level parameter allows to choose the level of logging. Starting at log
The level parameter allows a user to choose the level of logging. Starting at log
level 5, libtpms debug logging is activated.
.Sp
All logged lines will be prefixed with prefix. By default no prefix is prepended.
Expand All @@ -290,7 +290,7 @@ The \fIallow-set-locality\fR parameter allows the swtpm to receive
TPM/TPM2_SetLocality commands. This is parameter is useful if the Linux
\&\s-1VTPM\s0 proxy driver access is enabled by file descriptor passing.
This option is implied by the \fI\-\-vtpm\-proxy\fR option and therefore need not
be explicity set if this option is passed. In all other cases care should be
be explicitly set if this option is passed. In all other cases care should be
taken as to who can send the TPM/TPM2_SetLocality command.
.IP "\fB\-\-key file=<keyfile>|fd=<fd> [,format=<hex|binary>][,mode=aes\-cbc|aes\-256\-cbc], [remove[=true|false]]\fR" 4
.IX Item "--key file=<keyfile>|fd=<fd> [,format=<hex|binary>][,mode=aes-cbc|aes-256-cbc], [remove[=true|false]]"
Expand All @@ -310,14 +310,14 @@ The \fIremove\fR parameter will attempt to remove the given keyfile once the key
has been read.
.IP "\fB\-\-key pwdfile=<passphrase file>|pwdfd=<fd> [,mode=aes\-cbc|aes\-256\-cbc][remove[=true|false]][,kdf=sha512|pbkdf2]\fR" 4
.IX Item "--key pwdfile=<passphrase file>|pwdfd=<fd> [,mode=aes-cbc|aes-256-cbc][remove[=true|false]][,kdf=sha512|pbkdf2]"
This variant of the key parameter allows to provide a passphrase in a file.
This variant of the key parameter allows a user to provide a passphrase in a file.
The file is read and a key is derived from it using either a \s-1SHA512\s0 hash
or \s-1PBKDF2.\s0 By default \s-1PBKDF2\s0 is used.
.IP "\fB\-\-migration\-key file=<keyfile>|fd=<fd> [,format=<hex|binary>][,mode=aes\-cbc|aes\-256\-cbc] [,remove[=true|false]]\fR" 4
.IX Item "--migration-key file=<keyfile>|fd=<fd> [,format=<hex|binary>][,mode=aes-cbc|aes-256-cbc] [,remove[=true|false]]"
The availability of a migration key ensures that the state of the \s-1TPM\s0
will not be revealed in unencrypted form when
the \s-1TPM\s0 state blobs are retreived through the ioctl interface.
the \s-1TPM\s0 state blobs are retrieved through the ioctl interface.
The migration key is not used for encrypting \s-1TPM\s0 state written to files,
this is what the \fI\-\-key\fR parameter is used for.
.Sp
Expand Down Expand Up @@ -347,20 +347,20 @@ The \fIremove\fR parameter will attempt to remove the given keyfile once the key
has been read.
.IP "\fB\-\-migration\-key pwdfile=<passphrase file>|pwdfd=<fd> [,mode=aes\-cbc|aes\-256\-cbc][,remove[=true|false]][,pdf=sha512|pbkdf2]\fR" 4
.IX Item "--migration-key pwdfile=<passphrase file>|pwdfd=<fd> [,mode=aes-cbc|aes-256-cbc][,remove[=true|false]][,pdf=sha512|pbkdf2]"
This variant of the key parameter allows to provide a passphrase in a file.
This variant of the key parameter allows a user to provide a passphrase in a file.
The file is read and a key is derived from it using either a \s-1SHA512\s0 hash
or \s-1PBKDF2.\s0 By default \s-1PBKDF2\s0 is used.
.IP "\fB\-\-pid file=<pidfile>|fd=<filedescriptor>\fR" 4
.IX Item "--pid file=<pidfile>|fd=<filedescriptor>"
This options allows to set the name of file where the process \s-1ID\s0 (pid) of the \s-1TPM\s0
This options allows a user to set the name of file where the process \s-1ID\s0 (pid) of the \s-1TPM\s0
will be written into. It is also possible to pass a file descriptor to a file that
has been opened for writing.
.IP "\fB\-r|\-\-runas <owner>\fR" 4
.IX Item "-r|--runas <owner>"
Switch to the given user. This option can only be used when swtpm is started as root.
.IP "\fB\-\-seccomp action=none|log|kill\fR (since v0.2)" 4
.IX Item "--seccomp action=none|log|kill (since v0.2)"
This option allows to select the action to take by the seccomp profile when
This option allows a user to select the action to take by the seccomp profile when
a syscall is executed that is not allowed. The default is \fIkill\fR. To disable
the seccomp profile, choose \fInone\fR. The \fIlog\fR action logs offending syscalls.
The \fIlog\fR action is only available if libseccomp supports logging.
Expand Down
22 changes: 11 additions & 11 deletions man/man8/swtpm.pod
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ must be passed with the fd parameter and the commands are read from this file
descriptor then.
If a port is provided the I<bind address> on which to listen for TCP connections
can be provided as well; the default bind address is 127.0.0.1. If a link
local IPv6 addresss if provided, the name of the interface to bind to must be
local IPv6 address is provided, the name of the interface to bind to must be
provided with I<ifname>.

This parameter enables a persistent connection by default unless the disconnect option
Expand All @@ -61,7 +61,7 @@ is given. This parameter should be used rather than the -p and --fd options.
=item B<--server type=unixio[,path=E<lt>pathE<gt>][,fd=E<lt>fdE<gt>] [,mode=E<lt>0...E<gt>][,uid=E<lt>uidE<gt>][,gid=E<lt>gidE<gt>]>

Expect UnixIO connections on the given path. If no path is provided, a file descriptor
must be passed instead. The mode parameter allows to set the file mode bits of the
must be passed instead. The mode parameter allows a user to set the file mode bits of the
UnixIO path. The mode bits value must be given as an octal number starting with a '0'.
The default value is 0770. uid and gid set the ownership of the UnixIO socket's path.
This operation requires root privileges.
Expand Down Expand Up @@ -131,10 +131,10 @@ This option adds a control channel to the TPM. The control channel can either us
a given I<path> or I<filedescriptor> or it can use a TCP socket on the given I<port> or I<filedescriptor>.
If a port is provided the I<bind address> on which to listen for TCP connections
can be provided as well; the default bind address is 127.0.0.1. If a link
local IPv6 addresss if provided, the name of the interface to bind to must be
local IPv6 address is provided, the name of the interface to bind to must be
provided with I<ifname>.

The mode parameter allows to set the file mode bits of the UnixIO path.
The mode parameter allows a user to set the file mode bits of the UnixIO path.
The mode bits value must be given as an octal number starting with a '0'.
The default value is 0770. uid and gid set the ownership of the UnixIO socket's path.
This operation requires root privileges.
Expand Down Expand Up @@ -181,7 +181,7 @@ Choose TPM 2 functionality; by default a TPM 1.2 is chosen.
Enable logging to a file given its file descriptor or its path. Use '-' for path to
suppress the logging.

The level parameter allows to choose the level of logging. Starting at log
The level parameter allows a user to choose the level of logging. Starting at log
level 5, libtpms debug logging is activated.

All logged lines will be prefixed with prefix. By default no prefix is prepended.
Expand All @@ -197,7 +197,7 @@ The I<allow-set-locality> parameter allows the swtpm to receive
TPM/TPM2_SetLocality commands. This is parameter is useful if the Linux
VTPM proxy driver access is enabled by file descriptor passing.
This option is implied by the I<--vtpm-proxy> option and therefore need not
be explicity set if this option is passed. In all other cases care should be
be explicitly set if this option is passed. In all other cases care should be
taken as to who can send the TPM/TPM2_SetLocality command.

=item B<--key file=E<lt>keyfileE<gt>|fd=E<lt>fdE<gt> [,format=E<lt>hex|binaryE<gt>][,mode=aes-cbc|aes-256-cbc], [remove[=true|false]]>
Expand All @@ -219,15 +219,15 @@ has been read.

=item B<--key pwdfile=E<lt>passphrase fileE<gt>|pwdfd=E<lt>fdE<gt> [,mode=aes-cbc|aes-256-cbc][remove[=true|false]][,kdf=sha512|pbkdf2]>

This variant of the key parameter allows to provide a passphrase in a file.
This variant of the key parameter allows a user to provide a passphrase in a file.
The file is read and a key is derived from it using either a SHA512 hash
or PBKDF2. By default PBKDF2 is used.

=item B<--migration-key file=E<lt>keyfileE<gt>|fd=E<lt>fdE<gt> [,format=E<lt>hex|binaryE<gt>][,mode=aes-cbc|aes-256-cbc] [,remove[=true|false]]>

The availability of a migration key ensures that the state of the TPM
will not be revealed in unencrypted form when
the TPM state blobs are retreived through the ioctl interface.
the TPM state blobs are retrieved through the ioctl interface.
The migration key is not used for encrypting TPM state written to files,
this is what the I<--key> parameter is used for.

Expand Down Expand Up @@ -258,13 +258,13 @@ has been read.

=item B<--migration-key pwdfile=E<lt>passphrase fileE<gt>|pwdfd=E<lt>fdE<gt> [,mode=aes-cbc|aes-256-cbc][,remove[=true|false]][,pdf=sha512|pbkdf2]>

This variant of the key parameter allows to provide a passphrase in a file.
This variant of the key parameter allows a user to provide a passphrase in a file.
The file is read and a key is derived from it using either a SHA512 hash
or PBKDF2. By default PBKDF2 is used.

=item B<--pid file=E<lt>pidfileE<gt>|fd=E<lt>filedescriptorE<gt>>

This options allows to set the name of file where the process ID (pid) of the TPM
This options allows a user to set the name of file where the process ID (pid) of the TPM
will be written into. It is also possible to pass a file descriptor to a file that
has been opened for writing.

Expand All @@ -274,7 +274,7 @@ Switch to the given user. This option can only be used when swtpm is started as

=item B<--seccomp action=none|log|kill> (since v0.2)

This option allows to select the action to take by the seccomp profile when
This option allows a user to select the action to take by the seccomp profile when
a syscall is executed that is not allowed. The default is I<kill>. To disable
the seccomp profile, choose I<none>. The I<log> action logs offending syscalls.
The I<log> action is only available if libseccomp supports logging.
Expand Down
2 changes: 1 addition & 1 deletion man/man8/swtpm_bios.8
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ to. By default \fIlocalhost\fR is assumed. The default \s-1TCP\s0 port is 6545 u
the environment variable \fI\s-1TCSD_TCP_DEVICE_PORT\s0\fR indicates another port.
.PP
In case of success 0 will be returned. In case a \s-1TPM\s0 error was
encountered the return code will be 128. In case of communcation
encountered the return code will be 128. In case of communication
failure 255 is returned. In case the \s-1TPM\s0 needs to be reset to become
activated, 129 will be returned.
.PP
Expand Down
2 changes: 1 addition & 1 deletion man/man8/swtpm_ioctl.8
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ Set the locality for the subsequent \s-1TPM\s0 commands.
.IX Item "-v"
Have the \s-1TPM\s0 write the volatile state to a file. Upon a TPM_Init (\-i) the
\&\s-1TPM\s0 state will be read and the \s-1TPM\s0 can then resume operation without further
intialization.
initialization.
.IP "\fB\-C\fR" 4
.IX Item "-C"
Cancel an ongoing \s-1TPM\s0 command.
Expand Down
6 changes: 3 additions & 3 deletions man/man8/swtpm_setup.8
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ swtpm_setup \- Swtpm utility to simulate the manufacturing of a TPM 1.2 or 2.0
\&\fBswtpm_setup [\s-1OPTIONS\s0]\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBswtpm_setup\fR is a tool that prepares the intial state for a libtpms-based
\&\fBswtpm_setup\fR is a tool that prepares the initial state for a libtpms-based
\&\s-1TPM.\s0
.PP
For creating the initial state of a \s-1TPM 1.2,\s0 swtpm_setup must be run either
Expand Down Expand Up @@ -254,7 +254,7 @@ If this option is not given and an existing state file is found, an error
code is returned.
.IP "\fB\-\-not\-overwrite\fR" 4
.IX Item "--not-overwrite"
Do not overwrite existing \s-1TPM\s0 state. If exising \s-1TPM\s0 state is found, the
Do not overwrite existing \s-1TPM\s0 state. If existing \s-1TPM\s0 state is found, the
program ends without an error.
.IP "\fB\-\-vmid <\s-1VM ID\s0\fR>" 4
.IX Item "--vmid <VM ID>"
Expand All @@ -264,7 +264,7 @@ used for creating the certificates and may be required by that tool.
.IP "\fB\-\-pcr\-banks <\s-1PCR\s0 banks\fR>" 4
.IX Item "--pcr-banks <PCR banks>"
Optional comma-separated list of \s-1PCR\s0 banks to activate. Providing '\-'
allows to skip the selection and activates all \s-1PCR\s0 banks. By default
allows a user to skip the selection and activates all \s-1PCR\s0 banks. By default
the sha1 and sha256 banks are activated.
.IP "\fB\-\-swtpm_ioctl <executable\fR>" 4
.IX Item "--swtpm_ioctl <executable>"
Expand Down

0 comments on commit 2bc601b

Please sign in to comment.