diff --git a/Makefile.am b/Makefile.am index 0f60262..898d704 100644 --- a/Makefile.am +++ b/Makefile.am @@ -20,5 +20,5 @@ AUTOMAKE_OPTIONS = foreign EXTRA_DIST = autogen.sh CONTRIBUTING.md LICENSE.txt \ README.md SECURITY.md -SUBDIRS = src systemd +SUBDIRS = man src systemd MAINTAINERCLEANFILES = Makefile.in cscope.* ktls-utils*.tar.gz diff --git a/configure.ac b/configure.ac index 0dd23f2..d2d0e7e 100644 --- a/configure.ac +++ b/configure.ac @@ -29,6 +29,7 @@ AC_USE_SYSTEM_EXTENSIONS AC_LANG(C) AC_PROG_CC AC_PROG_INSTALL +AC_PROG_MKDIR_P unitdir=/usr/lib/systemd/system AC_ARG_WITH(systemd, @@ -93,5 +94,12 @@ fi AC_SUBST([AM_CPPFLAGS]) -AC_CONFIG_FILES([Makefile src/Makefile src/tlshd/Makefile systemd/Makefile]) +AC_CONFIG_FILES([Makefile \ + man/Makefile \ + man/man5/Makefile \ + man/man8/Makefile \ + src/Makefile \ + src/tlshd/Makefile \ + systemd/Makefile]) + AC_OUTPUT diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..b5ae14c --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,21 @@ +# +# Copyright (c) 2025 Oracle and/or its affiliates. +# +# ktls-utils is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; version 2. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. +# + +SUBDIRS = man5 man8 + +MAINTAINERCLEANFILES = Makefile.in diff --git a/man/man5/Makefile.am b/man/man5/Makefile.am new file mode 100644 index 0000000..4da6eaa --- /dev/null +++ b/man/man5/Makefile.am @@ -0,0 +1,21 @@ +# +# Copyright (c) 2025 Oracle and/or its affiliates. +# +# ktls-utils is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; version 2. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. +# + +dist_man5_MANS = tlshd.conf.5 + +MAINTAINERCLEANFILES = Makefile.in diff --git a/src/tlshd/tlshd.conf.man b/man/man5/tlshd.conf.5 similarity index 99% rename from src/tlshd/tlshd.conf.man rename to man/man5/tlshd.conf.5 index 575d88b..5333edf 100644 --- a/src/tlshd/tlshd.conf.man +++ b/man/man5/tlshd.conf.5 @@ -22,7 +22,7 @@ .SH NAME tlshd.conf \- tlshd configuration file .SH SYNOPSIS -.B /etc/tlshd.conf +.I /etc/tlshd.conf .SH DESCRIPTION The .B tlshd diff --git a/man/man8/Makefile.am b/man/man8/Makefile.am new file mode 100644 index 0000000..4ac1650 --- /dev/null +++ b/man/man8/Makefile.am @@ -0,0 +1,21 @@ +# +# Copyright (c) 2025 Oracle and/or its affiliates. +# +# ktls-utils is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; version 2. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. +# + +dist_man8_MANS = tlshd.8 + +MAINTAINERCLEANFILES = Makefile.in diff --git a/src/tlshd/tlshd.man b/man/man8/tlshd.8 similarity index 93% rename from src/tlshd/tlshd.man rename to man/man8/tlshd.8 index 62ea58b..6ccaeaa 100644 --- a/src/tlshd/tlshd.man +++ b/man/man8/tlshd.8 @@ -28,14 +28,13 @@ The .B tlshd program implements a user agent that services TLS handshake requests on behalf of kernel TLS consumers. -Using the -.BR accept (2) -system call, it materializes kernel socket endpoints in user space -in order to perform TLS handshakes using a TLS library. +It materializes kernel socket endpoints in user space +in order to perform TLS handshakes using a standard TLS library. After each handshake completes, .B tlshd plants TLS session metadata into the kernel socket to enable -the use of kTLS to secure subsequent communication on that socket. +the use of kTLS to secure subsequent communication on that socket, +and passes the socket back to the kernel. .SH OPTIONS .TP .B \-c " or " \-\-config diff --git a/src/tlshd/Makefile.am b/src/tlshd/Makefile.am index d1a13ef..d6c6e51 100644 --- a/src/tlshd/Makefile.am +++ b/src/tlshd/Makefile.am @@ -18,10 +18,6 @@ dist_sysconf_DATA = tlshd.conf -man5_MANS = tlshd.conf.man -man8_MANS = tlshd.man -EXTRA_DIST = $(man5_MANS) $(man8_MANS) - sbin_PROGRAMS = tlshd tlshd_CFLAGS = -Werror -Wall -Wextra $(LIBGNUTLS_CFLAGS) \ $(LIBKEYUTILS_CFLAGS) $(GLIB_CFLAGS) $(LIBNL3_CFLAGS) \