diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2021-12-20 11:33:37 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska@appnovation.com> | 2021-12-20 11:33:37 +0000 |
| commit | 4057413c79ffb467210f27de71006d4237b8d8e9 (patch) | |
| tree | 54903a2afc27f2e68940517374fc63eedd7a1db4 | |
| parent | bd256d597ea313d35e9a9d00ff6f4cb073b92130 (diff) | |
| download | utmps-4057413c79ffb467210f27de71006d4237b8d8e9.tar.xz | |
Add utmps-write doc
Signed-off-by: Laurent Bercot <ska@appnovation.com>
| -rw-r--r-- | doc/index.html | 1 | ||||
| -rw-r--r-- | doc/utmps-utmpd.html | 2 | ||||
| -rw-r--r-- | doc/utmps-write.html | 100 | ||||
| -rw-r--r-- | doc/utmps-wtmpd.html | 2 |
4 files changed, 103 insertions, 2 deletions
diff --git a/doc/index.html b/doc/index.html index 75aac4f..f22082d 100644 --- a/doc/index.html +++ b/doc/index.html @@ -108,6 +108,7 @@ the previous versions of utmps and the current one. </li> <ul> <li><a href="utmps-utmpd.html">The <tt>utmps-utmpd</tt> program</a></li> <li><a href="utmps-wtmpd.html">The <tt>utmps-wtmpd</tt> program</a></li> +<li><a href="utmps-write.html">The <tt>utmps-write</tt> program</a></li> </ul> <h3> Libraries </h3> diff --git a/doc/utmps-utmpd.html b/doc/utmps-utmpd.html index 2bee9ad..ea7fb3b 100644 --- a/doc/utmps-utmpd.html +++ b/doc/utmps-utmpd.html @@ -34,7 +34,7 @@ a script as a part of a "utmpd" on how to run such a service. The simplest way to do so, for testing purposes, is a command line such as: </p> -<pre>s6-ipcserver -l0 utmpd-socket utmps-utmpd</pre> +<pre>s6-ipcserver .utmpd-socket utmps-utmpd</pre> <p> while being in the <tt>/run/utmps</tt> directory. </p> diff --git a/doc/utmps-write.html b/doc/utmps-write.html new file mode 100644 index 0000000..d456a00 --- /dev/null +++ b/doc/utmps-write.html @@ -0,0 +1,100 @@ +<html> + <head> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <title>utmps: the utmps-write program</title> + <meta name="Description" content="utmps: the utmps-write program" /> + <meta name="Keywords" content="utmps utmp wtmp database client writing" /> + <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> + </head> +<body> + +<p> +<a href="index.html">utmps</a><br /> +<a href="//skarnet.org/software/">Software</a><br /> +<a href="//skarnet.org/">skarnet.org</a> +</p> + +<h1> The utmps-write program </h1> + +<p> +utmps-write is a command-line generic utmp client for utmps. +It sends an arbitrary utmp entry to the utmpd and/or wtmpd daemon. It can +be used to test utmps installations. +</p> + +<h2> Interface </h2> + +<pre> + utmps-write [ -u ] [ -w ] [ -U <em>utmpd-socket</em> ] [ -W <em>wtmpd-socket</em> ] [ -t <em>timeout</em> ] [ -T <em>timestamp</em> ] [ -h <em>host</em> ] [ -i <em>ip</em> ] [ -l <em>user</em> ] [ -p <em>pid</em> ] <em>id</em> <em>type</em> <em>line</em> +</pre> + +<ul> + <li> <tt>utmps-write</tt> constructs an utmp entry of type <em>type</em>, with identifier <em>id</em>, containing the line <em>line</em>. </li> + <li> Other fields can also be manually filled via options; by default, <tt>utmps-write</tt> will put in reasonable values. </li> + <li> <tt>utmps-write</tt> connects to a <a href="utmps-utmpd.html">utmpd</a> and/or a +<a href="utmps-wtmpd.html">wtmpd</a> instance, and sends them that utmp entry for writing. </li> + <li> It exits 0 on success, or prints an error message on stderr. </li> +</ul> + +<p> + The <em>type</em> argument must be symbolic: EMPTY, BOOT_TIME etc. The valid types +are the symbolic constants for the <tt>ut_type</tt> field of the <tt>utmpx</tt> structure, +as documented <a href="https://man7.org/linux/man-pages/man5/utmp.5.html">here</a> +or in the <tt>utmps/utmpx.h</tt> header provided with the utmps package. +</p> + +<h2> Options </h2> + +<ul> + <li> <tt>-u</tt> : add the entry to the utmp database. </li> + <li> <tt>-w</tt> : add the entry to the wtmp database. At least one of the <tt>-u</tt> or <tt>-w</tt> +option must be given. </li> + <li> <tt>-U</tt> <em>utmpd-socket</em> : if the <tt>-u</tt> option has been given, +connect to a utmpd instance listening on <em>utmpd-socket</em>. The default is the compile-time +default, <tt>/run/utmps/.utmpd-socket</tt> or the value given to the <tt>--with-utmp-socket</tt> +configure option. </li> + <li> <tt>-W</tt> <em>wtmpd-socket</em> : if the <tt>-w</tt> option has been given, +connect to a wtmpd instance listening on <em>wtmpd-socket</em>. The default is the compile-time +default, <tt>/run/utmps/.wtmpd-socket</tt> or the value given to the <tt>--with-wtmp-socket</tt> +configure option. </li> + <li> <tt>-t</tt> <em>timeout</em> : if the operations have not been completed +under <em>timeout</em> milliseconds, exit with an error message. By default, <tt>utmps-write</tt> +will wait forever for an answer from the utmpd or wtmpd daemons. </li> + <li> <tt>-T</tt> <em>timestamp</em> : spoof the <tt>ut_tv</tt> field of the utmp +entry. <em>timestamp</em> must be given as an absolute +<a href="https://cr.yp.to/libtai/tai64.html#tai64n">TAI64N label</a> in external TAI64N format, +prepended with a <tt>@</tt> character. By default, <tt>ut_tv</tt> will contain the time when +<tt>utmps-write</tt> was invoked. </li> + <li> <tt>-h</tt> <em>host</em> : spoof the <tt>ut_host</tt> field of the utmp entry. +By default, it is empty (all null characters). </li> + <li> <tt>-i</tt> <em>ip</em> : spoof the <tt>ut_addr_v6</tt> field of the utmp entry. +<em>ip</em> can be given as an ipv4 or an ipv6 address. By default, it's <tt>::</tt> (all null +characters). </li> + <li> <tt>-l</tt> <em>user</em> : spoof the <tt>ut_user</tt> field of the utmp entry. +This can only be done by root, otherwise the utmp or wtmp daemon will refuse to add the entry. +By default, the field contains the user's name as obtained by +<a href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpwuid.html">getpwuid()</a>. </li> + <li> <tt>-p</tt> <em>pid</em> : spoof the <tt>ut_pid</tt> field of the utmp entry. +By default, the field contains the pid of the <tt>utmps-write</tt> process. </li> +</ul> + +<h2> Notes </h2> + +<ul> + <li> There is an official API to <em>write</em> a complete utmp entry to the +utmp or the wtmp database, and this is what <tt>utmps-write</tt> uses. However, +there is no official API to <em>read</em>, and format, a complete utmp entry from +the databases; you can read them from instance via util-linux's +<a href="https://man7.org/linux/man-pages/man1/utmpdump.1.html">utmpdump</a> +utility, but you need to give it the direct path to the utmp and wtmp files. </li> + <li> The wtmp database can only grow; a user calling <tt>utmps-write -w</tt> +repeatedly can easily make it grow fast and indefinitely, using up all the available +disk space. This is a fundamental problem with the design of utmp, and is already +achievable without the use of <tt>utmps-write</tt>. The only solution is for +administrators to detect fast-growing wtmp files, and clean them up or archive them. </li> +</ul> + +</body> +</html> diff --git a/doc/utmps-wtmpd.html b/doc/utmps-wtmpd.html index f2f77db..d8a3b7c 100644 --- a/doc/utmps-wtmpd.html +++ b/doc/utmps-wtmpd.html @@ -34,7 +34,7 @@ a script as a part of a "wtmpd" on how to run such a service. The simplest way to do so, for testing purposes, is a command line such as: </p> -<pre>s6-ipcserver -l0 wtmpd-socket utmps-wtmpd</pre> +<pre>s6-ipcserver .wtmpd-socket utmps-wtmpd</pre> <p> while being in the <tt>/run/utmps</tt> directory. </p> |