Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Chuck Lever III <chuck.lever@oracle.com>
To:     Steve Dickson <steved@redhat.com>,
        Benjamin Coddington <bcodding@redhat.com>
CC:     Linux NFS Mailing List <linux-nfs@vger.kernel.org>
Subject: Re: [nfs-utils PATCH] nfs4id: a tool to create and persist nfs4
 client uniquifiers
Thread-Topic: [nfs-utils PATCH] nfs4id: a tool to create and persist nfs4
 client uniquifiers
Thread-Index: AQHYGca9ZpW/pPf5rEWUIwyc/qfEDKyJ14OAgAAE1wA=
Date:   Tue, 8 Feb 2022 16:21:41 +0000
Message-ID: <33B10EBB-3DD1-45FE-B7D2-D5EA21DFB172@oracle.com>
References: <c2e8b7c06352d3cad3454de096024fff80e638af.1643979161.git.bcodding@redhat.com>
 <6f01c382-8da5-5673-30db-0c0099d820b5@redhat.com>
In-Reply-To: <6f01c382-8da5-5673-30db-0c0099d820b5@redhat.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?DzSwrJMZcz+wuADVlz4w3UqacjJKS4Nh7LxAen2TPT2PT68Zh6vUBuB3TAlR?=
 =?us-ascii?Q?T3zqUP1zSfrjlBVvFVNWSrSoPsvXPyvJ8zcraOdiCpTF/ragCgM147oxHTrs?=
 =?us-ascii?Q?ZZLtX9E487Psr/Yy7dkJHGmxCMavjM8YyJOiLErOm8HJ0yylkR3epJY//di7?=
 =?us-ascii?Q?Z8RDvBAZE8vgGsJZOn5cSd3MYvJEyc8P8OqEv2sg+CFj3LtDYYzU5dvOG92q?=
 =?us-ascii?Q?0ZSAtoeLYEVy8fuQGIxu4vbG+s1TjSWsM7q1u6bM9iK7y6L1lN/cEh8OTUBy?=
 =?us-ascii?Q?0s9YY60lBpCeXVjdGnWMMJF/0HRJB3EH5CScS80TEtAuVU0+GsEsYsklULXh?=
 =?us-ascii?Q?PjsBTFwqTFORdwdr4K3cSs9o8SEDcttQ9ISkiBXEWgQ1YR+/wcHfqxFfOm+I?=
 =?us-ascii?Q?qakpuMrYZ6jCI83P9DxTxiMx5gwMquhBaxlO53WpGDskjBfsnCh0KlqnhXHV?=
 =?us-ascii?Q?x5FC31dI23H054HLCo9E0zOaWIhjEBoKcWLDmjVvOcOMFvHdcZwXDr9zplb6?=
 =?us-ascii?Q?wFaI8BSnR7CuqjeDeNcf7Q/COILPmghCENhCLW6tV34oqY4krP/A8mrn9Ghz?=
 =?us-ascii?Q?zmo+xKprXQ8UXb+oz+Z7FZ8umDv6YrywTVfLL/lfPsbTDVGrG/dEYEHBUDow?=
 =?us-ascii?Q?XfjaWJLA6/TvWnG4Ff9QPDby/b2po4nj3aYE5K4p5IOQlaWd7kmZ/XLuPYAS?=
 =?us-ascii?Q?rPWsdQUQf6JnL4EJzhP/XBCSgaXI6vk4ITU/Ouj1OpwGf1l8yUIjFhluA6D6?=
 =?us-ascii?Q?4Okb9s/b+0C0/zfLGupPU2M+9TD5SG9arb3ExWEaq5tEFBgttSMaJ8BCmknC?=
 =?us-ascii?Q?PMhHxyrAR15/9DSD8He79lnXoWDQ/tJBxYzzdNmYnhRUjOPD1Wlsf30HhVYn?=
 =?us-ascii?Q?qeGupJYKFB/i03h0jNPp+zoX05+04QfAImwyGZNvBn/aW6nZn+oemFICSsin?=
 =?us-ascii?Q?oz4QuyGreyu/wU1qyrElaAeHut2X8dI9kQam1hbZWU1fgzInrB4HX1pTbKlq?=
 =?us-ascii?Q?iJNvNhRSlxcl2eZ8/uwF32odeokqrmS2hS0yI0/lIE/4wY/SGzJeocTAPNc3?=
 =?us-ascii?Q?JvwG0iqqCmS/xLZ7c+umsEeZFT53iJ9T0MLiAlC32uoKB3klv7TgyTRauLib?=
 =?us-ascii?Q?k3dP8lORtRK1MRFWtcuy6UK8E1bae9gv5qBcBr38ql1nNji0WvG8HGVKQn0Q?=
 =?us-ascii?Q?3QPlqkzN9l0m3eymD+Eregx0lataxU+N+iUUT9OdX5NqWubo/lU0WD/AlsKr?=
 =?us-ascii?Q?DdX0BBGU5unEHvEkOk2iQluXZfnbBCwGmh0GpUeJr806WMV1AQ2Es5IpLyFD?=
 =?us-ascii?Q?1klDLlPiBx+J3ar1p8vM4sevwDq1TtriVYY95uw24scSBxQHGALgnDzFu7Hu?=
 =?us-ascii?Q?IR8FmkGL8INQ0N01n05/9Pg6QN13CDfpJb/1pNXGvSvS39okl8gq3H4quT7j?=
 =?us-ascii?Q?j5oxwXZnWgUEQZb8cVbAaD9MpXfH667479uKSu+HXw3iiU1j/Zy+EyavG0BZ?=
 =?us-ascii?Q?Zb3N4xck4LQ5hCJ1EpeTcrGASoFi3Z6Nsv3cv7CoB9Bh2voY5UwyXfakDDkq?=
 =?us-ascii?Q?PjssXPk89jpkVUOA9AU9e5gs7dixKJ2wvlA/2GCi1qP5ecLr2E6y8bPPmzjj?=
 =?us-ascii?Q?fPKoOjpuQhAhBEle0HAQeC4=3D?=
Content-Type: text/plain; charset="us-ascii"
Content-ID: <67365C310A2A81418F08816DB4518692@namprd10.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: CH0PR10MB4858.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7909f899-517a-4462-2eac-08d9eb1f170d
X-MS-Exchange-CrossTenant-originalarrivaltime: 08 Feb 2022 16:21:41.1483
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: WQeZkj+9AO7LYxyCG7m07rvrVo+PbLrosf55JoHSlRVNsJ8EmllXZO9ikWglJ567dF4VscTfB5+oMp8YNdcQPQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR10MB3200
X-Proofpoint-Virus-Version: vendor=nai engine=6300 definitions=10252 signatures=673431
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 mlxscore=0 bulkscore=0
 phishscore=0 malwarescore=0 mlxlogscore=999 adultscore=0 spamscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2201110000
 definitions=main-2202080100
X-Proofpoint-GUID: MV6juN6g3oYJIp1O0XRdtP066sZQDDuf
X-Proofpoint-ORIG-GUID: MV6juN6g3oYJIp1O0XRdtP066sZQDDuf
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H5,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-nfs.vger.kernel.org>
X-Mailing-List: linux-nfs@vger.kernel.org


> On Feb 8, 2022, at 11:04 AM, Steve Dickson <steved@redhat.com> wrote:
>=20
> Hello,
>=20
> On 2/4/22 7:56 AM, Benjamin Coddington wrote:
>> The nfs4id program will either create a new UUID from a random source or
>> derive it from /etc/machine-id, else it returns a UUID that has already
>> been written to /etc/nfs4-id.  This small, lightweight tool is suitable =
for
>> execution by systemd-udev in rules to populate the nfs4 client uniquifie=
r.
>> Signed-off-by: Benjamin Coddington <bcodding@redhat.com>
>> ---
>>  .gitignore               |   1 +
>>  configure.ac             |   4 +
>>  tools/Makefile.am        |   1 +
>>  tools/nfs4id/Makefile.am |   8 ++
>>  tools/nfs4id/nfs4id.c    | 184 +++++++++++++++++++++++++++++++++++++++
>>  tools/nfs4id/nfs4id.man  |  29 ++++++
>>  6 files changed, 227 insertions(+)
>>  create mode 100644 tools/nfs4id/Makefile.am
>>  create mode 100644 tools/nfs4id/nfs4id.c
>>  create mode 100644 tools/nfs4id/nfs4id.man
> Just a nit... naming convention... In the past
> we never put the protocol version in the name.
> Do a ls tools and utils directory and you
> see what I mean....
>=20
> Would it be a problem to change the name from
> nfs4id to nfsid?

nfs4id is pretty generic, too.

Can we go with nfs-client-id ?


> steved.
>=20
>> diff --git a/.gitignore b/.gitignore
>> index c89d1cd2583d..a37964148dd8 100644
>> --- a/.gitignore
>> +++ b/.gitignore
>> @@ -61,6 +61,7 @@ utils/statd/statd
>>  tools/locktest/testlk
>>  tools/getiversion/getiversion
>>  tools/nfsconf/nfsconf
>> +tools/nfs4id/nfs4id
>>  support/export/mount.h
>>  support/export/mount_clnt.c
>>  support/export/mount_xdr.c
>> diff --git a/configure.ac b/configure.ac
>> index 50e9b321dcf3..93d0a902cfd8 100644
>> --- a/configure.ac
>> +++ b/configure.ac
>> @@ -355,6 +355,9 @@ if test "$enable_nfsv4" =3D yes; then
>>    dnl check for the keyutils libraries and headers
>>    AC_KEYUTILS
>>  +  dnl check for the libuuid library and headers
>> +  AC_LIBUUID
>> +
>>    dnl Check for sqlite3
>>    AC_SQLITE3_VERS
>>  @@ -740,6 +743,7 @@ AC_CONFIG_FILES([
>>  	tools/nfsdclnts/Makefile
>>  	tools/nfsconf/Makefile
>>  	tools/nfsdclddb/Makefile
>> +	tools/nfs4id/Makefile
>>  	utils/Makefile
>>  	utils/blkmapd/Makefile
>>  	utils/nfsdcld/Makefile
>> diff --git a/tools/Makefile.am b/tools/Makefile.am
>> index 9b4b0803db39..cc658f69bb32 100644
>> --- a/tools/Makefile.am
>> +++ b/tools/Makefile.am
>> @@ -7,6 +7,7 @@ OPTDIRS +=3D rpcgen
>>  endif
>>    OPTDIRS +=3D nfsconf
>> +OPTDIRS +=3D nfs4id
>>    if CONFIG_NFSDCLD
>>  OPTDIRS +=3D nfsdclddb
>> diff --git a/tools/nfs4id/Makefile.am b/tools/nfs4id/Makefile.am
>> new file mode 100644
>> index 000000000000..d1e60a35a510
>> --- /dev/null
>> +++ b/tools/nfs4id/Makefile.am
>> @@ -0,0 +1,8 @@
>> +## Process this file with automake to produce Makefile.in
>> +
>> +man8_MANS	=3D nfs4id.man
>> +
>> +bin_PROGRAMS =3D nfs4id
>> +
>> +nfs4id_SOURCES =3D nfs4id.c
>> +nfs4id_LDADD =3D $(LIBUUID)
>> diff --git a/tools/nfs4id/nfs4id.c b/tools/nfs4id/nfs4id.c
>> new file mode 100644
>> index 000000000000..dbb807ae21f3
>> --- /dev/null
>> +++ b/tools/nfs4id/nfs4id.c
>> @@ -0,0 +1,184 @@
>> +/*
>> + * nfs4id.c -- create and persist uniquifiers for nfs4 clients
>> + *
>> + * Copyright (C) 2022  Red Hat, Benjamin Coddington <bcodding@redhat.co=
m>
>> + *
>> + * This program 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; either version 2
>> + * of the License, or (at your option) any later version.
>> + *
>> + * 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.
>> + */
>> +
>> +#include <stdio.h>
>> +#include <stdarg.h>
>> +#include <getopt.h>
>> +#include <string.h>
>> +#include <errno.h>
>> +#include <stdlib.h>
>> +#include <fcntl.h>
>> +#include <unistd.h>
>> +#include <uuid/uuid.h>
>> +
>> +#define NFS4IDFILE "/etc/nfs4-id"
>> +
>> +UUID_DEFINE(nfs4_clientid_uuid_template,
>> +	0xa2, 0x25, 0x68, 0xb2, 0x7a, 0x5f, 0x49, 0x90,
>> +	0x8f, 0x98, 0xc5, 0xf0, 0x67, 0x78, 0xcc, 0xf1);
>> +
>> +static char *prog;
>> +static char *source =3D NULL;
>> +static char nfs4_id[64];
>> +static int force =3D 0;
>> +
>> +static void usage(void)
>> +{
>> +	fprintf(stderr, "usage: %s [-f|--force] [machine]\n", prog);
>> +}
>> +
>> +static void fatal(const char *fmt, ...)
>> +{
>> +	int err =3D errno;
>> +	va_list args;
>> +	char fatal_msg[256] =3D "fatal: ";
>> +
>> +	va_start(args, fmt);
>> +	vsnprintf(&fatal_msg[7], 255, fmt, args);
>> +	if (err)
>> +		fprintf(stderr, "%s: %s\n", fatal_msg, strerror(err));
>> +	else
>> +		fprintf(stderr, "%s\n", fatal_msg);
>> +	exit(-1);
>> +}
>> +
>> +static int read_nfs4_id(void)
>> +{
>> +	int fd;
>> +
>> +	fd =3D open(NFS4IDFILE, O_RDONLY);
>> +	if (fd < 0)
>> +		return fd;
>> +	read(fd, nfs4_id, 64);
>> +	close(fd);
>> +	return 0;
>> +}
>> +
>> +static void write_nfs4_id(void)
>> +{
>> +	int fd;
>> +
>> +	fd =3D open(NFS4IDFILE, O_RDWR|O_TRUNC|O_CREAT, S_IRUSR|S_IWUSR|S_IRGR=
P|S_IROTH);
>> +	if (fd < 0)
>> +		fatal("could not write id to " NFS4IDFILE);
>> +	write(fd, nfs4_id, 37);
>> +}
>> +
>> +static void print_nfs4_id(void)
>> +{
>> +	fprintf(stdout, "%s", nfs4_id);
>> +}
>> +=09
>> +static void check_or_make_id(void)
>> +{
>> +	int ret;
>> +	uuid_t nfs4id_uuid;
>> +
>> +	ret =3D read_nfs4_id();
>> +	if (ret !=3D 0) {
>> +		if (errno !=3D ENOENT )
>> +			fatal("reading file " NFS4IDFILE);
>> +		uuid_generate_random(nfs4id_uuid);
>> +		uuid_unparse(nfs4id_uuid, nfs4_id);
>> +		nfs4_id[36] =3D '\n';
>> +		nfs4_id[37] =3D '\0';
>> +		write_nfs4_id();
>> +	}
>> +	print_nfs4_id();=09
>> +}
>> +
>> +static void check_or_make_id_from_machine(void)
>> +{
>> +	int fd, ret;
>> +	char machineid[32];
>> +	uuid_t nfs4id_uuid;
>> +
>> +	ret =3D read_nfs4_id();
>> +	if (ret !=3D 0) {
>> +		if (errno !=3D ENOENT )
>> +			fatal("reading file " NFS4IDFILE);
>> +
>> +		fd =3D open("/etc/machine-id", O_RDONLY);
>> +		if (fd < 0)
>> +			fatal("unable to read /etc/machine-id");
>> +
>> +		read(fd, machineid, 32);
>> +		close(fd);
>> +
>> +		uuid_generate_sha1(nfs4id_uuid, nfs4_clientid_uuid_template, machinei=
d, 32);
>> +		uuid_unparse(nfs4id_uuid, nfs4_id);
>> +		nfs4_id[36] =3D '\n';
>> +		nfs4_id[37] =3D '\0';
>> +		write_nfs4_id();
>> +	}
>> +	print_nfs4_id();
>> +}
>> +
>> +int main(int argc, char **argv)
>> +{
>> +	prog =3D argv[0];
>> +
>> +	while (1) {
>> +		int opt;
>> +		int option_index =3D 0;
>> +		static struct option long_options[] =3D {
>> +			{"force",	no_argument,	0, 'f' },
>> +			{0,			0,				0, 0 }
>> +		};
>> +
>> +		errno =3D 0;
>> +		opt =3D getopt_long(argc, argv, ":f", long_options, &option_index);
>> +		if (opt =3D=3D -1)
>> +			break;
>> +
>> +		switch (opt) {
>> +		case 'f':
>> +			force =3D 1;
>> +			break;
>> +		case '?':
>> +			usage();
>> +			fatal("unexpected arg \"%s\"", argv[optind - 1]);
>> +			break;
>> +		}
>> +	}
>> +
>> +	argc -=3D optind;
>> +
>> +	if (argc > 1) {
>> +		usage();
>> +		fatal("Too many arguments");
>> +	}
>> +
>> +	if (argc)
>> +		source =3D argv[optind++];
>> +
>> +	if (force)
>> +		unlink(NFS4IDFILE);
>> +
>> +	if (!source)
>> +		check_or_make_id();
>> +	else if (strcmp(source, "machine") =3D=3D 0)
>> +		check_or_make_id_from_machine();
>> +	else {
>> +		usage();
>> +		fatal("unrecognized source %s\n", source);
>> +	}
>> +}
>> diff --git a/tools/nfs4id/nfs4id.man b/tools/nfs4id/nfs4id.man
>> new file mode 100644
>> index 000000000000..358f836468a2
>> --- /dev/null
>> +++ b/tools/nfs4id/nfs4id.man
>> @@ -0,0 +1,29 @@
>> +.\"
>> +.\" nfs4id(8)
>> +.\"
>> +.TH nfs4id 8 "3 Feb 2022"
>> +.SH NAME
>> +nfs4id \- Generate or return nfs4 client id uniqueifiers
>> +.SH SYNOPSIS
>> +.B nfs4id [ -f | --force ] [<source>]
>> +
>> +.SH DESCRIPTION
>> +The
>> +.B nfs4id
>> +command provides a simple utility to help NFS Version 4 clients use uni=
que
>> +and persistent client id values.  The command checks for the existence =
of a
>> +file /etc/nfs4-id and returns the first 64 chars read from that file.  =
If
>> +the file is not found, a UUID is generated from the specified source an=
d
>> +written to the file and returned.
>> +.SH OPTIONS
>> +.TP
>> +.BR \-f, \-\-force
>> +Overwrite the existing /etc/nfs4-id with a UUID generated from <source>=
.
>> +.SH Sources
>> +If <source> is not specified, nfs4id will generate a new random UUID.
>> +
>> +If <source> is "machine", nfs4id will generate a deterministic UUID val=
ue
>> +derived from a sha1 hash of the contents of /etc/machine-id and a stati=
c
>> +key.
>> +.SH SEE ALSO
>> +.BR machine-id (5)

--
Chuck Lever