nfs-utils: signed filehandle support
Subsystems (2)
v3 cover nfs-utils: signed filehandle support
Here are two patches allowing userspace to set a secret key for kNFSD to sign filehandles, and also set the option to sign filehandles for an export.
The secret key passed to the server is the first 128 bits of a sha1 hash of the contents of a file configured via the nfs.conf server section "fh_key_file". Exports that have the option "sign_fh" set will cause the server to use this key to append an 8-byte siphash of the filehandle onto each filehandle.
This version of the userspace patches correspond with the v3 of the kernel changes which have been posted here:
https://lore.kernel.org/linux-nfs/[email protected]
This work is based on a branch that includes Jeff Layton's patch for min-threads:
https://lore.kernel.org/linux-nfs/[email protected]/
Comments and critique welcomed.
Changes since v1:
- fh_key hash is passed as an optional attr to threads verb
- include missing hash_fh_key_file() function hunk
- wording updates (thanks NeilBrown)
Changes since v2:
- send fh_key as netlink attribute (Jeff Layton)
- cull redundant loop in hash function (NeilBrown)
- tuneup sigh_fh man page wording (NeilBrown)
Benjamin Coddington (2):
exportfs: Add support for export option sign_fh nfsdctl/rpc.nfsd: Add support for passing encrypted filehandle key
nfs.conf | 1 + support/include/nfs/export.h | 2 +- support/include/nfslib.h | 2 + support/nfs/Makefile.am | 4 +- support/nfs/exports.c | 4 ++ support/nfs/fh_key_file.c | 79 ++++++++++++++++++++++++++++++++++++ systemd/nfs.conf.man | 1 + utils/exportfs/exportfs.c | 2 + utils/exportfs/exports.man | 9 ++++ utils/nfsd/nfssvc.h | 1 + utils/nfsdctl/nfsd_netlink.h | 1 + utils/nfsdctl/nfsdctl.c | 35 ++++++++++++++-- 12 files changed, 134 insertions(+), 7 deletions(-) create mode 100644 support/nfs/fh_key_file.c
base-commit: 612e407c46b848932c32be00b835a7b5317e3d08
prerequisite-patch-id: cc4d768b1f6935b3c94ae87bd0389270717bc5b0
Signature · 1 line
2.50.1
PATCH v3 1/2 exportfs: Add support for export option sign_fh
If configured with "sign_fh", exports will be flagged to signal that filehandles should be signed with a Message Authentication Code (MAC).
--- support/include/nfs/export.h | 2 +- support/nfs/exports.c | 4 ++++ utils/exportfs/exportfs.c | 2 ++ utils/exportfs/exports.man | 9 +++++++++ 4 files changed, 16 insertions(+), 1 deletion(-)
support/include/nfs/export.h +1 -1
@@ -19,7 +19,7 @@#define NFSEXP_GATHERED_WRITES 0x0020#define NFSEXP_NOREADDIRPLUS 0x0040#define NFSEXP_SECURITY_LABEL 0x0080 -/* 0x100 unused */ +#define NFSEXP_SIGN_FH 0x0100#define NFSEXP_NOHIDE 0x0200#define NFSEXP_NOSUBTREECHECK 0x0400#define NFSEXP_NOAUTHNLM 0x0800
support/nfs/exports.c +4 -0
@@ -310,6 +310,8 @@ putexportent(struct exportent *ep)fprintf (fp,"nordirplus," );if (ep->e_flags &NFSEXP_SECURITY_LABEL )fprintf (fp,"security_label," ); +if (ep->e_flags &NFSEXP_SIGN_FH ) +fprintf (fp,"sign_fh," );fprintf (fp,"%spnfs," , (ep->e_flags &NFSEXP_PNFS )?"" :"no_" );if (ep->e_flags &NFSEXP_FSID ) {fprintf (fp,"fsid=%d," , ep->e_fsid);
@@ -676,6 +678,8 @@ parseopts(char *cp, struct exportent *ep, int *had_subtree_opt_ptr)setflags (NFSEXP_NOREADDIRPLUS , active, ep); else if (!strcmp(opt, "security_label"))setflags (NFSEXP_SECURITY_LABEL , active, ep); + else if (!strcmp(opt, "sign_fh")) +setflags (NFSEXP_SIGN_FH , active, ep); else if (!strcmp(opt, "nohide"))setflags (NFSEXP_NOHIDE , active, ep); else if (!strcmp(opt, "hide"))
utils/exportfs/exportfs.c +2 -0
@@ -718,6 +718,8 @@ dump(int verbose, int export_format) c =dumpopt (c,"nordirplus" );if (ep->e_flags &NFSEXP_SECURITY_LABEL ) c =dumpopt (c,"security_label" ); +if (ep->e_flags &NFSEXP_SIGN_FH ) + c =dumpopt (c,"sign_fh" );if (ep->e_flags &NFSEXP_NOACL ) c =dumpopt (c,"no_acl" );if (ep->e_flags &NFSEXP_PNFS )
utils/exportfs/exports.man +9 -0
@@ -351,6 +351,15 @@ file. If you put neither option, .B exportfs will warn you that the change has occurred. +.TP +.IR sign_fh +This option enforces signing filehandles on the export. If the server has +been configured with a secret key for such purpose, filehandles will include +a hash to verify the filehandle was created by the server in order to guard +against filehandle guessing attacks which can bypass path-name based access +restrictions. Note that for NFSv2 and NFSv3, some exported filesystems may +exceed the maximum filehandle size when the signing hash is added. + .TP .IR insecure_locks .TP
Signature · 1 line
2.50.1
Re: [PATCH v3 1/2] exportfs: Add support for export option sign_fh
Quoted 65 lines · Benjamin Coddington
If configured with "
sign_fh", exports will be flagged to signal that filehandles should be signed with a Message Authentication Code (MAC).Signed-off-by Benjamin Coddington <[email protected]>--- support/include/nfs/export.h | 2 +- support/nfs/exports.c | 4 ++++ utils/exportfs/exportfs.c | 2 ++ utils/exportfs/exports.man | 9 +++++++++ 4 files changed, 16 insertions(+), 1 deletion(-)support/include/nfs/export.h +1
-1@@ -19,7 +19,7 @@#define NFSEXP_GATHERED_WRITES 0x0020#define NFSEXP_NOREADDIRPLUS 0x0040#define NFSEXP_SECURITY_LABEL 0x0080 -/* 0x100 unused */ +#define NFSEXP_SIGN_FH 0x0100#define NFSEXP_NOHIDE 0x0200#define NFSEXP_NOSUBTREECHECK 0x0400#define NFSEXP_NOAUTHNLM 0x0800support/nfs/exports.c +4
-0@@ -310,6 +310,8 @@ putexportent(struct exportent *ep)fprintf (fp,"nordirplus," );if (ep->e_flags &NFSEXP_SECURITY_LABEL )fprintf (fp,"security_label," ); +if (ep->e_flags &NFSEXP_SIGN_FH ) +fprintf (fp,"sign_fh," );fprintf (fp,"%spnfs," , (ep->e_flags &NFSEXP_PNFS )?"" :"no_" );if (ep->e_flags &NFSEXP_FSID ) {fprintf (fp,"fsid=%d," , ep->e_fsid);@@ -676,6 +678,8 @@ parseopts(char *cp, struct exportent *ep, int *had_subtree_opt_ptr)setflags (NFSEXP_NOREADDIRPLUS , active, ep); else if (!strcmp(opt, "security_label"))setflags (NFSEXP_SECURITY_LABEL , active, ep); + else if (!strcmp(opt, "sign_fh")) +setflags (NFSEXP_SIGN_FH , active, ep); else if (!strcmp(opt, "nohide"))setflags (NFSEXP_NOHIDE , active, ep); else if (!strcmp(opt, "hide"))utils/exportfs/exportfs.c +2
-0@@ -718,6 +718,8 @@ dump(int verbose, int export_format) c =dumpopt (c,"nordirplus" );if (ep->e_flags &NFSEXP_SECURITY_LABEL ) c =dumpopt (c,"security_label" ); +if (ep->e_flags &NFSEXP_SIGN_FH ) + c =dumpopt (c,"sign_fh" );if (ep->e_flags &NFSEXP_NOACL ) c =dumpopt (c,"no_acl" );if (ep->e_flags &NFSEXP_PNFS )utils/exportfs/exports.man +0
-0@@ -351,6 +351,15 @@ file. If you put neither option, .B exportfs
utils/exportfs/exports.man file. If you put neither option, · line 361
Quoted 10 lines
utils/exportfs/exports.man +8
-0will warn you that the change has occurred. +.TP +.IR sign_fh +This option enforces signing filehandles on the export. If the server has +been configured with a secret key for such purpose, filehandles will include +a hash to verify the filehandle was created by the server in order to guard +against filehandle guessing attacks which can bypass path-name based access +restrictions. Note that for NFSv2 and NFSv3, some exported filesystems may +exceed the maximum filehandle size when the signing hash is added.
Now I thought NFSv2 wasn't supported.
NFSv2 file handles are all the same size, so there is no space to add the MAC.
Quoted 4 lines
utils/exportfs/exports.man +1
-0+ .TP .IR insecure_locks .TP
Signature · 1 line
Chuck Lever
Re: [PATCH v3 1/2] exportfs: Add support for export option sign_fh
Quoted 68 lines · Chuck Lever
Quoted 67 lines · Benjamin Coddington
If configured with "
sign_fh", exports will be flagged to signal that filehandles should be signed with a Message Authentication Code (MAC).Signed-off-by Benjamin Coddington <[email protected]>--- support/include/nfs/export.h | 2 +- support/nfs/exports.c | 4 ++++ utils/exportfs/exportfs.c | 2 ++ utils/exportfs/exports.man | 9 +++++++++ 4 files changed, 16 insertions(+), 1 deletion(-)support/include/nfs/export.h +1
-1@@ -19,7 +19,7 @@#define NFSEXP_GATHERED_WRITES 0x0020#define NFSEXP_NOREADDIRPLUS 0x0040#define NFSEXP_SECURITY_LABEL 0x0080 -/* 0x100 unused */ +#define NFSEXP_SIGN_FH 0x0100#define NFSEXP_NOHIDE 0x0200#define NFSEXP_NOSUBTREECHECK 0x0400#define NFSEXP_NOAUTHNLM 0x0800support/nfs/exports.c +4
-0@@ -310,6 +310,8 @@ putexportent(struct exportent *ep)fprintf (fp,"nordirplus," );if (ep->e_flags &NFSEXP_SECURITY_LABEL )fprintf (fp,"security_label," ); +if (ep->e_flags &NFSEXP_SIGN_FH ) +fprintf (fp,"sign_fh," );fprintf (fp,"%spnfs," , (ep->e_flags &NFSEXP_PNFS )?"" :"no_" );if (ep->e_flags &NFSEXP_FSID ) {fprintf (fp,"fsid=%d," , ep->e_fsid);@@ -676,6 +678,8 @@ parseopts(char *cp, struct exportent *ep, int *had_subtree_opt_ptr)setflags (NFSEXP_NOREADDIRPLUS , active, ep); else if (!strcmp(opt, "security_label"))setflags (NFSEXP_SECURITY_LABEL , active, ep); + else if (!strcmp(opt, "sign_fh")) +setflags (NFSEXP_SIGN_FH , active, ep); else if (!strcmp(opt, "nohide"))setflags (NFSEXP_NOHIDE , active, ep); else if (!strcmp(opt, "hide"))utils/exportfs/exportfs.c +2
-0@@ -718,6 +718,8 @@ dump(int verbose, int export_format) c =dumpopt (c,"nordirplus" );if (ep->e_flags &NFSEXP_SECURITY_LABEL ) c =dumpopt (c,"security_label" ); +if (ep->e_flags &NFSEXP_SIGN_FH ) + c =dumpopt (c,"sign_fh" );if (ep->e_flags &NFSEXP_NOACL ) c =dumpopt (c,"no_acl" );if (ep->e_flags &NFSEXP_PNFS )utils/exportfs/exports.man +0
-0@@ -351,6 +351,15 @@ file. If you put neither option, .B exportfs will warn you that the change has occurred.
Quoted 10 lines
utils/exportfs/exports.man file. If you put neither option, · line 361
Quoted 8 lines
utils/exportfs/exports.man +8
-0+.TP +.IR sign_fh +This option enforces signing filehandles on the export. If the server has +been configured with a secret key for such purpose, filehandles will include +a hash to verify the filehandle was created by the server in order to guard +against filehandle guessing attacks which can bypass path-name based access +restrictions. Note that for NFSv2 and NFSv3, some exported filesystems may +exceed the maximum filehandle size when the signing hash is added.Now I thought NFSv2 wasn't supported.
My mistake, I will update this wording. There's nothing here (or in the kernel patches) that tries to handle the NFSv2 case.
Ben
PATCH v3 2/2 nfsdctl/rpc.nfsd: Add support for passing encrypted filehandle key
In reply to Benjamin CoddingtonIf fh-key-file=<path> is set in the nfsd section of nfs.conf, the "nfsdctl autostart" command will hash the contents of the file with libuuid's uuid_generate_sha1 and send the first 16 bytes into the kernel on NFSD_A_SERVER_FH_KEY.
A compatible kernel can use this key to sign filehandles.
--- nfs.conf | 1 + support/include/nfslib.h | 2 + support/nfs/Makefile.am | 4 +- support/nfs/fh_key_file.c | 79 ++++++++++++++++++++++++++++++++++++ systemd/nfs.conf.man | 1 + utils/nfsd/nfssvc.h | 1 + utils/nfsdctl/nfsd_netlink.h | 1 + utils/nfsdctl/nfsdctl.c | 35 ++++++++++++++-- 8 files changed, 118 insertions(+), 6 deletions(-) create mode 100644 support/nfs/fh_key_file.c
nfs.conf +1 -0
@@ -76,6 +76,7 @@ # vers4.2=y rdma=y rdma-port=20049 +# fh-key-file=/etc/nfs_fh.key [statd] # debug=0
support/include/nfslib.h +2 -0
@@ -22,6 +22,7 @@#include <paths.h> #include <rpcsvc/nfs_prot.h> #include <nfs/nfs.h> +#include <uuid/uuid.h> #include "xlog.h" #ifndef _PATH_EXPORTS
@@ -132,6 +133,7 @@ struct rmtabent * fgetrmtabent(FILE *fp, int log, long *pos);void fputrmtabent (FILE *fp,struct rmtabent *xep,long *pos);void fendrmtabent (FILE *fp);void frewindrmtabent (FILE *fp); +int hash_fh_key_file (const char *fh_key_file,uuid_t hash);_Bool state_setup_basedir (const char *,const char *);int setup_state_path_names (const char *,const char *,const char *,const char *,struct state_paths *);
support/nfs/Makefile.am +2 -2
@@ -7,8 +7,8 @@ libnfs_la_SOURCES = exports.c rmtab.c xio.c rpcmisc.c rpcdispatch.c \ xcommon.c wildmat.c mydaemon.c \ rpc_socket.c getport.c \ svc_socket.c cacheio.c closeall.c nfs_mntent.c \ - svc_create.c atomicio.c strlcat.c strlcpy.c -libnfs_la_LIBADD = libnfsconf.la + svc_create.c atomicio.c strlcat.c strlcpy.c fh_key_file.c +libnfs_la_LIBADD = libnfsconf.la -luuid libnfs_la_CPPFLAGS = $(AM_CPPFLAGS) $(CPPFLAGS) -I$(top_srcdir)/support/reexport libnfsconf_la_SOURCES = conffile.c xlog.c
support/nfs/fh_key_file.c new file +79 -0
79 lines not on this page · raw message
systemd/nfs.conf.man +1 -0
@@ -176,6 +176,7 @@ Recognized values: .BR vers4.1 , .BR vers4.2 , .BR rdma , +.BR fh-key-file , Version and protocol values are Boolean values as described above, and are also used by
utils/nfsd/nfssvc.h +1 -0
@@ -30,3 +30,4 @@ void nfssvc_setvers(unsigned int ctlbits, unsigned int minorvers4, unsigned int minorvers4set, int force4dot0);int nfssvc_threads (int nrservs);void nfssvc_get_minormask (unsigned int *mask); +int nfssvc_setfh_key (const char *fh_key_file);
utils/nfsdctl/nfsd_netlink.h +1 -0
@@ -34,6 +34,7 @@ enum {NFSD_A_SERVER_GRACETIME ,NFSD_A_SERVER_LEASETIME ,NFSD_A_SERVER_SCOPE , +NFSD_A_SERVER_FH_KEY , __NFSD_A_SERVER_MAX,NFSD_A_SERVER_MAX = (__NFSD_A_SERVER_MAX -1 )
utils/nfsdctl/nfsdctl.c +31 -4
@@ -29,6 +29,7 @@#include <readline/readline.h> #include <readline/history.h> +#include <uuid/uuid.h> #ifdef USE_SYSTEM_NFSD_NETLINK_H #include <linux/nfsd_netlink.h>
@@ -42,6 +43,7 @@#include "lockd_netlink.h" #endif +#include "nfslib.h" #include "nfsdctl.h" #include "conffile.h" #include "xlog.h"
@@ -524,8 +526,10 @@ out: }static int threads_doit (struct nl_sock *sock,int cmd,int grace,int lease, -int pool_count,int *pool_threads,char *scope,int minthreads) +int pool_count,int *pool_threads,char *scope,int minthreads, +uuid_t fh_key) { +struct nl_data *fh_key_data =NULL ;struct genlmsghdr *ghdr;struct nlmsghdr *nlh;struct nl_msg *msg;
@@ -550,6 +554,15 @@ static int threads_doit(struct nl_sock *sock, int cmd, int grace, int lease,if (minthreads >=0 )nla_put_u32 (msg,NFSD_A_SERVER_MIN_THREADS , minthreads);#endif +if (!uuid_is_null (fh_key)) { + fh_key_data =nl_data_alloc (fh_key,sizeof (uuid_t)); +if (!fh_key_data) { +xlog (L_ERROR ,"failed to allocate netlink data" ); + ret =1 ; + goto out; + } +nla_put_data (msg,NFSD_A_SERVER_FH_KEY , fh_key_data); + }for (i =0 ; i < pool_count; ++i)nla_put_u32 (msg,NFSD_A_SERVER_THREADS , pool_threads[i]); }
@@ -584,6 +597,8 @@ static int threads_doit(struct nl_sock *sock, int cmd, int grace, int lease, out_cb:nl_cb_put (cb); out: +if (fh_key_data) +nl_data_free (fh_key_data);nlmsg_free (msg);return ret; }
@@ -612,6 +627,7 @@ static int threads_func(struct nl_sock *sock, int argc, char **argv)int *pool_threads =NULL ;int minthreads =-1 ;int opt, pools =0 ; +uuid_t fh_key; optind =1 ;while ((opt =getopt_long (argc, argv,"h" , threads_options,NULL )) !=-1 ) {
@@ -654,7 +670,9 @@ static int threads_func(struct nl_sock *sock, int argc, char **argv) } } } -return threads_doit (sock, cmd,0 ,0 , pools, pool_threads,NULL , minthreads); +uuid_clear (fh_key); +return threads_doit (sock, cmd,0 ,0 , pools, pool_threads,NULL , + minthreads, fh_key); }/*
@@ -1611,8 +1629,9 @@ static int autostart_func(struct nl_sock *sock, int argc, char ** argv)int *threads, grace, lease, idx, ret, opt, pools, minthreads;struct conf_list *thread_str;struct conf_list_node *n; -char *scope, *pool_mode; +char *scope, *pool_mode, *fh_key_file;bool failed_listeners = false; +uuid_t fh_key; optind =1 ;while ((opt =getopt_long (argc, argv,"h" , help_only_options,NULL )) !=-1 ) {
@@ -1687,12 +1706,20 @@ static int autostart_func(struct nl_sock *sock, int argc, char ** argv) threads[0 ] =DEFAULT_AUTOSTART_THREADS ; } +uuid_clear (fh_key); + fh_key_file =conf_get_str ("nfsd" ,"fh-key-file" ); +if (fh_key_file) { + ret =hash_fh_key_file (fh_key_file, fh_key); +if (ret) +return ret; + } + lease =conf_get_num ("nfsd" ,"lease-time" ,0 ); scope =conf_get_str ("nfsd" ,"scope" ); minthreads =conf_get_num ("nfsd" ,"min-threads" ,0 ); ret =threads_doit (sock,NFSD_CMD_THREADS_SET , grace, lease, pools, - threads, scope, minthreads); + threads, scope, minthreads, fh_key); out:free (threads);return ret;
Signature · 1 line
2.50.1
Jeff Layton
maintainerRe: [PATCH v3 2/2] nfsdctl/rpc.nfsd: Add support for passing encrypted filehandle key
Quoted 178 lines · Benjamin Coddington
If fh-key-file=<path> is set in the nfsd section of nfs.conf, the "nfsdctl autostart" command will hash the contents of the file with libuuid's
uuid_generate_sha1and send the first 16 bytes into the kernel onNFSD_A_SERVER_FH_KEY.A compatible kernel can use this key to sign filehandles.
Signed-off-by Benjamin Coddington <[email protected]>--- nfs.conf | 1 + support/include/nfslib.h | 2 + support/nfs/Makefile.am | 4 +- support/nfs/fh_key_file.c | 79 ++++++++++++++++++++++++++++++++++++ systemd/nfs.conf.man | 1 + utils/nfsd/nfssvc.h | 1 + utils/nfsdctl/nfsd_netlink.h | 1 + utils/nfsdctl/nfsdctl.c | 35 ++++++++++++++-- 8 files changed, 118 insertions(+), 6 deletions(-) create mode 100644 support/nfs/fh_key_file.cnfs.conf +1
-0@@ -76,6 +76,7 @@ # vers4.2=y rdma=y rdma-port=20049 +# fh-key-file=/etc/nfs_fh.key [statd] # debug=0support/include/nfslib.h +2
-0@@ -22,6 +22,7 @@#include <paths.h> #include <rpcsvc/nfs_prot.h> #include <nfs/nfs.h> +#include <uuid/uuid.h> #include "xlog.h" #ifndef _PATH_EXPORTS@@ -132,6 +133,7 @@ struct rmtabent * fgetrmtabent(FILE *fp, int log, long *pos);void fputrmtabent (FILE *fp,struct rmtabent *xep,long *pos);void fendrmtabent (FILE *fp);void frewindrmtabent (FILE *fp); +int hash_fh_key_file (const char *fh_key_file,uuid_t hash);_Bool state_setup_basedir (const char *,const char *);int setup_state_path_names (const char *,const char *,const char *,const char *,struct state_paths *);support/nfs/Makefile.am +2
-2@@ -7,8 +7,8 @@ libnfs_la_SOURCES = exports.c rmtab.c xio.c rpcmisc.c rpcdispatch.c \ xcommon.c wildmat.c mydaemon.c \ rpc_socket.c getport.c \ svc_socket.c cacheio.c closeall.c nfs_mntent.c \ - svc_create.c atomicio.c strlcat.c strlcpy.c -libnfs_la_LIBADD = libnfsconf.la + svc_create.c atomicio.c strlcat.c strlcpy.c fh_key_file.c +libnfs_la_LIBADD = libnfsconf.la -luuid libnfs_la_CPPFLAGS = $(AM_CPPFLAGS) $(CPPFLAGS) -I$(top_srcdir)/support/reexport libnfsconf_la_SOURCES = conffile.c xlog.csupport/nfs/fh_key_file.c new file +79
-0@@ -0,0 +1,79 @@ +/* +* Copyright (c) 2025 Benjamin Coddington <[email protected]> +* All rights reserved. +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions +* are met: +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in the +* documentation and/or other materials provided with the distribution. +* +* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#include <sys/types.h> +#include <unistd.h> +#include <errno.h> +#include <uuid/uuid.h> + +#include "nfslib.h" + +#define HASH_BLOCKSIZE 256 +int hash_fh_key_file (const char *fh_key_file,uuid_t uuid) +{ +const char seed_s[] ="8fc57f1b-1a6f-482f-af92-d2e007c1ae58" ; +FILE *sfile =NULL ; +char buf[HASH_BLOCKSIZE ]; +size_t pos; +int ret =0 ; + + sfile =fopen (fh_key_file,"r" ); +if (!sfile) { + ret = errno; +xlog (L_ERROR ,"Unable to read fh-key-file %s: %s" , fh_key_file,strerror (errno)); + goto out; + } + +uuid_parse (seed_s, uuid); + +while (1 ) { +size_t sread; + pos =0 ; + +if (feof (sfile)) + goto finish_block; + + sread =fread (buf + pos,1 ,HASH_BLOCKSIZE - pos, sfile); + pos += sread; + +if (pos ==HASH_BLOCKSIZE ) +break ; + +if (sread !=HASH_BLOCKSIZE ) { + ret =ferror (sfile); +if (ret) + goto out; + goto finish_block; + } +uuid_generate_sha1 (uuid, uuid, buf,HASH_BLOCKSIZE ); + } +finish_block: +if (pos) +uuid_generate_sha1 (uuid, uuid, buf, pos); +out: +if (sfile) +fclose (sfile); +return ret; +}systemd/nfs.conf.man +1
-0@@ -176,6 +176,7 @@ Recognized values: .BR vers4.1 , .BR vers4.2 , .BR rdma , +.BR fh-key-file , Version and protocol values are Boolean values as described above, and are also used byutils/nfsd/nfssvc.h +1
-0@@ -30,3 +30,4 @@ void nfssvc_setvers(unsigned int ctlbits, unsigned int minorvers4, unsigned int minorvers4set, int force4dot0);int nfssvc_threads (int nrservs);void nfssvc_get_minormask (unsigned int *mask); +int nfssvc_setfh_key (const char *fh_key_file);utils/nfsdctl/nfsd_netlink.h +0
-0
utils/nfsdctl/nfsd_netlink.h enum { · line 38
Quoted 5 lines
utils/nfsdctl/nfsd_netlink.h +1
-0@@ -34,6 +34,7 @@ enum {NFSD_A_SERVER_GRACETIME ,NFSD_A_SERVER_LEASETIME ,NFSD_A_SERVER_SCOPE , + NFSD_A_SERVER_FH_KEY,
I forgot this file was even there!
We'll need to add MIN_THREADS to this before your value, or this won't line up properly. I suppose if we do that too, then we can rip out the autoconf check for that constant as well, and get rid of the #ifdefs. I can send a v2 of the series I just sent that just does this.
You will also want to rebase this on top of those patches, so you can better handle the case where the kernel doesn't support setting a fh_key. I suppose you probably want to throw a hard error in that case, since being unable to set the key could be a security issue (or cause stale filehandles)?
Quoted 111 lines
utils/nfsdctl/nfsd_netlink.h +0
-0__NFSD_A_SERVER_MAX,NFSD_A_SERVER_MAX = (__NFSD_A_SERVER_MAX -1 )utils/nfsdctl/nfsdctl.c +31
-4@@ -29,6 +29,7 @@#include <readline/readline.h> #include <readline/history.h> +#include <uuid/uuid.h> #ifdef USE_SYSTEM_NFSD_NETLINK_H #include <linux/nfsd_netlink.h> @@ -42,6 +43,7 @@#include "lockd_netlink.h" #endif +#include "nfslib.h" #include "nfsdctl.h" #include "conffile.h" #include "xlog.h" @@ -524,8 +526,10 @@ out: }static int threads_doit (struct nl_sock *sock,int cmd,int grace,int lease, -int pool_count,int *pool_threads,char *scope,int minthreads) +int pool_count,int *pool_threads,char *scope,int minthreads, +uuid_t fh_key) { +struct nl_data *fh_key_data =NULL ;struct genlmsghdr *ghdr;struct nlmsghdr *nlh;struct nl_msg *msg;@@ -550,6 +554,15 @@ static int threads_doit(struct nl_sock *sock, int cmd, int grace, int lease,if (minthreads >=0 )nla_put_u32 (msg,NFSD_A_SERVER_MIN_THREADS , minthreads);#endif +if (!uuid_is_null (fh_key)) { + fh_key_data =nl_data_alloc (fh_key,sizeof (uuid_t)); +if (!fh_key_data) { +xlog (L_ERROR ,"failed to allocate netlink data" ); + ret =1 ; + goto out; + } +nla_put_data (msg,NFSD_A_SERVER_FH_KEY , fh_key_data); + }for (i =0 ; i < pool_count; ++i)nla_put_u32 (msg,NFSD_A_SERVER_THREADS , pool_threads[i]); }@@ -584,6 +597,8 @@ static int threads_doit(struct nl_sock *sock, int cmd, int grace, int lease, out_cb:nl_cb_put (cb); out: +if (fh_key_data) +nl_data_free (fh_key_data);nlmsg_free (msg);return ret; }@@ -612,6 +627,7 @@ static int threads_func(struct nl_sock *sock, int argc, char **argv)int *pool_threads =NULL ;int minthreads =-1 ;int opt, pools =0 ; +uuid_t fh_key; optind =1 ;while ((opt =getopt_long (argc, argv,"h" , threads_options,NULL )) !=-1 ) {@@ -654,7 +670,9 @@ static int threads_func(struct nl_sock *sock, int argc, char **argv) } } } -return threads_doit (sock, cmd,0 ,0 , pools, pool_threads,NULL , minthreads); +uuid_clear (fh_key); +return threads_doit (sock, cmd,0 ,0 , pools, pool_threads,NULL , + minthreads, fh_key); }/* @@ -1611,8 +1629,9 @@ static int autostart_func(struct nl_sock *sock, int argc, char ** argv)int *threads, grace, lease, idx, ret, opt, pools, minthreads;struct conf_list *thread_str;struct conf_list_node *n; -char *scope, *pool_mode; +char *scope, *pool_mode, *fh_key_file;bool failed_listeners = false; +uuid_t fh_key; optind =1 ;while ((opt =getopt_long (argc, argv,"h" , help_only_options,NULL )) !=-1 ) {@@ -1687,12 +1706,20 @@ static int autostart_func(struct nl_sock *sock, int argc, char ** argv) threads[0 ] =DEFAULT_AUTOSTART_THREADS ; } +uuid_clear (fh_key); + fh_key_file =conf_get_str ("nfsd" ,"fh-key-file" ); +if (fh_key_file) { + ret =hash_fh_key_file (fh_key_file, fh_key); +if (ret) +return ret; + } + lease =conf_get_num ("nfsd" ,"lease-time" ,0 ); scope =conf_get_str ("nfsd" ,"scope" ); minthreads =conf_get_num ("nfsd" ,"min-threads" ,0 ); ret =threads_doit (sock,NFSD_CMD_THREADS_SET , grace, lease, pools, - threads, scope, minthreads); + threads, scope, minthreads, fh_key); out:free (threads);return ret;
Signature · 1 line
Jeff Layton <[email protected]>
Re: [PATCH v3 2/2] nfsdctl/rpc.nfsd: Add support for passing encrypted filehandle key
Quoted 192 lines · Jeff Layton
Quoted 178 lines · Benjamin Coddington
If fh-key-file=<path> is set in the nfsd section of nfs.conf, the "nfsdctl autostart" command will hash the contents of the file with libuuid's
uuid_generate_sha1and send the first 16 bytes into the kernel onNFSD_A_SERVER_FH_KEY.A compatible kernel can use this key to sign filehandles.
Signed-off-by Benjamin Coddington <[email protected]>--- nfs.conf | 1 + support/include/nfslib.h | 2 + support/nfs/Makefile.am | 4 +- support/nfs/fh_key_file.c | 79 ++++++++++++++++++++++++++++++++++++ systemd/nfs.conf.man | 1 + utils/nfsd/nfssvc.h | 1 + utils/nfsdctl/nfsd_netlink.h | 1 + utils/nfsdctl/nfsdctl.c | 35 ++++++++++++++-- 8 files changed, 118 insertions(+), 6 deletions(-) create mode 100644 support/nfs/fh_key_file.cnfs.conf +1
-0@@ -76,6 +76,7 @@ # vers4.2=y rdma=y rdma-port=20049 +# fh-key-file=/etc/nfs_fh.key [statd] # debug=0support/include/nfslib.h +2
-0@@ -22,6 +22,7 @@#include <paths.h> #include <rpcsvc/nfs_prot.h> #include <nfs/nfs.h> +#include <uuid/uuid.h> #include "xlog.h" #ifndef _PATH_EXPORTS@@ -132,6 +133,7 @@ struct rmtabent * fgetrmtabent(FILE *fp, int log, long *pos);void fputrmtabent (FILE *fp,struct rmtabent *xep,long *pos);void fendrmtabent (FILE *fp);void frewindrmtabent (FILE *fp); +int hash_fh_key_file (const char *fh_key_file,uuid_t hash);_Bool state_setup_basedir (const char *,const char *);int setup_state_path_names (const char *,const char *,const char *,const char *,struct state_paths *);support/nfs/Makefile.am +2
-2@@ -7,8 +7,8 @@ libnfs_la_SOURCES = exports.c rmtab.c xio.c rpcmisc.c rpcdispatch.c \ xcommon.c wildmat.c mydaemon.c \ rpc_socket.c getport.c \ svc_socket.c cacheio.c closeall.c nfs_mntent.c \ - svc_create.c atomicio.c strlcat.c strlcpy.c -libnfs_la_LIBADD = libnfsconf.la + svc_create.c atomicio.c strlcat.c strlcpy.c fh_key_file.c +libnfs_la_LIBADD = libnfsconf.la -luuid libnfs_la_CPPFLAGS = $(AM_CPPFLAGS) $(CPPFLAGS) -I$(top_srcdir)/support/reexport libnfsconf_la_SOURCES = conffile.c xlog.csupport/nfs/fh_key_file.c new file +79
-0@@ -0,0 +1,79 @@ +/* +* Copyright (c) 2025 Benjamin Coddington <[email protected]> +* All rights reserved. +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions +* are met: +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in the +* documentation and/or other materials provided with the distribution. +* +* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#include <sys/types.h> +#include <unistd.h> +#include <errno.h> +#include <uuid/uuid.h> + +#include "nfslib.h" + +#define HASH_BLOCKSIZE 256 +int hash_fh_key_file (const char *fh_key_file,uuid_t uuid) +{ +const char seed_s[] ="8fc57f1b-1a6f-482f-af92-d2e007c1ae58" ; +FILE *sfile =NULL ; +char buf[HASH_BLOCKSIZE ]; +size_t pos; +int ret =0 ; + + sfile =fopen (fh_key_file,"r" ); +if (!sfile) { + ret = errno; +xlog (L_ERROR ,"Unable to read fh-key-file %s: %s" , fh_key_file,strerror (errno)); + goto out; + } + +uuid_parse (seed_s, uuid); + +while (1 ) { +size_t sread; + pos =0 ; + +if (feof (sfile)) + goto finish_block; + + sread =fread (buf + pos,1 ,HASH_BLOCKSIZE - pos, sfile); + pos += sread; + +if (pos ==HASH_BLOCKSIZE ) +break ; + +if (sread !=HASH_BLOCKSIZE ) { + ret =ferror (sfile); +if (ret) + goto out; + goto finish_block; + } +uuid_generate_sha1 (uuid, uuid, buf,HASH_BLOCKSIZE ); + } +finish_block: +if (pos) +uuid_generate_sha1 (uuid, uuid, buf, pos); +out: +if (sfile) +fclose (sfile); +return ret; +}systemd/nfs.conf.man +1
-0@@ -176,6 +176,7 @@ Recognized values: .BR vers4.1 , .BR vers4.2 , .BR rdma , +.BR fh-key-file , Version and protocol values are Boolean values as described above, and are also used byutils/nfsd/nfssvc.h +1
-0@@ -30,3 +30,4 @@ void nfssvc_setvers(unsigned int ctlbits, unsigned int minorvers4, unsigned int minorvers4set, int force4dot0);int nfssvc_threads (int nrservs);void nfssvc_get_minormask (unsigned int *mask); +int nfssvc_setfh_key (const char *fh_key_file);utils/nfsdctl/nfsd_netlink.h +0
-0utils/nfsdctl/nfsd_netlink.h enum { · line 38
Quoted 5 lines
utils/nfsdctl/nfsd_netlink.h +1
-0@@ -34,6 +34,7 @@ enum {NFSD_A_SERVER_GRACETIME ,NFSD_A_SERVER_LEASETIME ,NFSD_A_SERVER_SCOPE , + NFSD_A_SERVER_FH_KEY,I forgot this file was even there!
We'll need to add
MIN_THREADSto this before your value, or this won't line up properly. I suppose if we do that too, then we can rip out the autoconf check for that constant as well, and get rid of the #ifdefs. I can send a v2 of the series I just sent that just does this.
Quoted 5 lines
You will also want to rebase this on top of those patches, so you can better handle the case where the kernel doesn't support setting a
fh_key. I suppose you probably want to throw a hard error in that case, since being unable to set the key could be a security issue (or cause stale filehandles)?
That all makes sense - I will do. Thanks!
Ben
Re: [PATCH v3 2/2] nfsdctl/rpc.nfsd: Add support for passing encrypted filehandle key
In reply to Jeff LaytonSuper late responding, apologies:
Quoted 7 lines · Jeff Layton
Quoted 6 lines · Benjamin Coddington
If fh-key-file=<path> is set in the nfsd section of nfs.conf, the "nfsdctl autostart" command will hash the contents of the file with libuuid's
uuid_generate_sha1and send the first 16 bytes into the kernel onNFSD_A_SERVER_FH_KEY.A compatible kernel can use this key to sign filehandles.
...
Quoted 13 lines
utils/nfsdctl/nfsd_netlink.h +0
-0utils/nfsdctl/nfsd_netlink.h enum { · line 38
Quoted 9 lines
index
887cbd12b695..10df6d750fa1100644utils/nfsdctl/nfsd_netlink.h +1
-0@@ -34,6 +34,7 @@ enum {NFSD_A_SERVER_GRACETIME ,NFSD_A_SERVER_LEASETIME ,NFSD_A_SERVER_SCOPE , + NFSD_A_SERVER_FH_KEY,I forgot this file was even there!
Quoted 8 lines
We'll need to add
MIN_THREADSto this before your value, or this won't line up properly. I suppose if we do that too, then we can rip out the autoconf check for that constant as well, and get rid of the #ifdefs. I can send a v2 of the series I just sent that just does this.You will also want to rebase this on top of those patches, so you can better handle the case where the kernel doesn't support setting a
fh_key.
Thanks! Those patches are very helpful.
Quoted 3 lines
I suppose you probably want to throw a hard error in that case, since being unable to set the key could be a security issue (or cause stale filehandles)?
I've kept this as a soft error because the server will refuse to give out filehandles if the key is not set for a "sign_fh" export. It emits:
[ 76.000602] NFSD: unable to sign filehandles, fh_key not set.
This is a pretty good signal and safer than gating the problem in userspace.
Ben