Skip to contentSkip to conversation

nfs-utils: add nfs.idmap

PATCH In review Bryan Schumaker 3 participants 8 messages Oct 26, 2010 – Oct 28, 2010

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 nfs-utils: add nfs.idmap

This patch adds the nfs.idmap program to nfs-utils. This program is called by the nfs idmapper through request-keys to map between uid / user name and gid / group name.

---

aclocal/keyutils.m4 new file +11 -0
new file mode 100644
index 0000000..84bc112
@@ -0,0 +1,11 @@
+dnl Checks for keyutils library and headers
+dnl
+AC_DEFUN([AC_KEYUTILS], [
+
+  dnl Check for libkeyutils; do not add to LIBS if found
+  AC_CHECK_LIB([keyutils], [keyctl_instantiate], [LIBKEYUTILS=-lkeyutils], ,)
+  AC_SUBST(LIBKEYUTILS)
+
+  AC_CHECK_HEADERS([keyutils.h], ,
+  		   [AC_MSG_ERROR([keyutils.h header not found.])])
+])dnl
configure.ac +4 -0
index 3058be6..0907f72 100644
@@ -247,6 +247,9 @@ if test "$enable_nfsv4" = yes; then
   dnl check for nfsidmap libraries and headers
   AC_LIBNFSIDMAP
 
+  dnl check for the keyutils libraries and headers
+  AC_KEYUTILS
+
   dnl librpcsecgss already has a dependency on libgssapi,
   dnl but we need to make sure we get the right version
   if test "$enable_gss" = yes; then
@@ -435,6 +438,7 @@ AC_CONFIG_FILES([
 	utils/mountd/Makefile
 	utils/nfsd/Makefile
 	utils/nfsstat/Makefile
+	utils/nfs.idmap/Makefile
 	utils/showmount/Makefile
 	utils/statd/Makefile
 	tests/Makefile
utils/Makefile.am +1 -0
index 8665183..332ecff 100644
@@ -4,6 +4,7 @@ OPTDIRS =
 
 if CONFIG_NFSV4
 OPTDIRS += idmapd
+OPTDIRS += nfs.idmap
 endif
 
 if CONFIG_GSS
utils/nfs.idmap/Makefile.am new file +9 -0
new file mode 100644
index 0000000..29e17af
@@ -0,0 +1,9 @@
+## Process this file with automake to produce Makefile.in
+
+man8_MANS = nfs.idmap.man
+
+sbin_PROGRAMS	= nfs.idmap
+nfs_idmap_SOURCES = nfs.idmap.c
+nfs_idmap_LDADD = -lnfsidmap -lkeyutils
+
+MAINTAINERCLEANFILES = Makefile.in
utils/nfs.idmap/nfs.idmap.c new file +118 -0

118 lines not on this page · raw message

utils/nfs.idmap/nfs.idmap.man new file +60 -0

60 lines not on this page · raw message

#1 lore raw

Here is an updated patch.
-Bryan

This patch adds the nfs.idmap program to nfs-utils. This program is called by the nfs idmapper through request-keys to map between uid / user name and gid / group name.

---

aclocal/keyutils.m4 new file +11 -0
new file mode 100644
index 0000000..84bc112
@@ -0,0 +1,11 @@
+dnl Checks for keyutils library and headers
+dnl
+AC_DEFUN([AC_KEYUTILS], [
+
+  dnl Check for libkeyutils; do not add to LIBS if found
+  AC_CHECK_LIB([keyutils], [keyctl_instantiate], [LIBKEYUTILS=-lkeyutils], ,)
+  AC_SUBST(LIBKEYUTILS)
+
+  AC_CHECK_HEADERS([keyutils.h], ,
+  		   [AC_MSG_ERROR([keyutils.h header not found.])])
+])dnl
configure.ac +4 -0
index 3058be6..0907f72 100644
@@ -247,6 +247,9 @@ if test "$enable_nfsv4" = yes; then
   dnl check for nfsidmap libraries and headers
   AC_LIBNFSIDMAP
 
+  dnl check for the keyutils libraries and headers
+  AC_KEYUTILS
+
   dnl librpcsecgss already has a dependency on libgssapi,
   dnl but we need to make sure we get the right version
   if test "$enable_gss" = yes; then
@@ -435,6 +438,7 @@ AC_CONFIG_FILES([
 	utils/mountd/Makefile
 	utils/nfsd/Makefile
 	utils/nfsstat/Makefile
+	utils/nfs.idmap/Makefile
 	utils/showmount/Makefile
 	utils/statd/Makefile
 	tests/Makefile
utils/Makefile.am +1 -0
index 8665183..332ecff 100644
@@ -4,6 +4,7 @@ OPTDIRS =
 
 if CONFIG_NFSV4
 OPTDIRS += idmapd
+OPTDIRS += nfs.idmap
 endif
 
 if CONFIG_GSS
utils/nfs.idmap/Makefile.am new file +9 -0
new file mode 100644
index 0000000..29e17af
@@ -0,0 +1,9 @@
+## Process this file with automake to produce Makefile.in
+
+man8_MANS = nfs.idmap.man
+
+sbin_PROGRAMS	= nfs.idmap
+nfs_idmap_SOURCES = nfs.idmap.c
+nfs_idmap_LDADD = -lnfsidmap -lkeyutils
+
+MAINTAINERCLEANFILES = Makefile.in
utils/nfs.idmap/nfs.idmap.c new file +118 -0

118 lines not on this page · raw message

utils/nfs.idmap/nfs.idmap.man new file +60 -0

60 lines not on this page · raw message

#2 lore raw

Hey Bryan,

A couple nits.... which I will be more than willing to take of...

1) I would like to change the binary name from nfs.idmap to nfsidmap which is consistent with how the rest of the binaries are named. (i.e. binary names generally don't have any '.' or '-' in them)

2) Change the source directory from utils/nfs.idmap to utils/idmap which again makes it consistent with what is already there.

3) The man page talks about a /usr/sbin/idmap file and then later talks about a /usr/sbin/nfs.idmap program. Can I assume those are same binary, since I only see on binary being installed? Also, maybe we should move the binary to /sbin so it would be available early in the boot

Comments?

steved.

Quoted 211 lines · Bryan Schumaker

Here is an updated patch.
-Bryan

This patch adds the nfs.idmap program to nfs-utils. This program is called by the nfs idmapper through request-keys to map between uid / user name and gid / group name.

---

aclocal/keyutils.m4 new file +11 -0
new file mode 100644
index 0000000..84bc112
@@ -0,0 +1,11 @@
+dnl Checks for keyutils library and headers
+dnl
+AC_DEFUN([AC_KEYUTILS], [
+
+  dnl Check for libkeyutils; do not add to LIBS if found
+  AC_CHECK_LIB([keyutils], [keyctl_instantiate], [LIBKEYUTILS=-lkeyutils], ,)
+  AC_SUBST(LIBKEYUTILS)
+
+  AC_CHECK_HEADERS([keyutils.h], ,
+  		   [AC_MSG_ERROR([keyutils.h header not found.])])
+])dnl
configure.ac +4 -0
index 3058be6..0907f72 100644
@@ -247,6 +247,9 @@ if test "$enable_nfsv4" = yes; then
   dnl check for nfsidmap libraries and headers
   AC_LIBNFSIDMAP
 
+  dnl check for the keyutils libraries and headers
+  AC_KEYUTILS
+
   dnl librpcsecgss already has a dependency on libgssapi,
   dnl but we need to make sure we get the right version
   if test "$enable_gss" = yes; then
@@ -435,6 +438,7 @@ AC_CONFIG_FILES([
 	utils/mountd/Makefile
 	utils/nfsd/Makefile
 	utils/nfsstat/Makefile
+	utils/nfs.idmap/Makefile
 	utils/showmount/Makefile
 	utils/statd/Makefile
 	tests/Makefile
utils/Makefile.am +1 -0
index 8665183..332ecff 100644
@@ -4,6 +4,7 @@ OPTDIRS =
 
 if CONFIG_NFSV4
 OPTDIRS += idmapd
+OPTDIRS += nfs.idmap
 endif
 
 if CONFIG_GSS
utils/nfs.idmap/Makefile.am new file +9 -0
new file mode 100644
index 0000000..29e17af
@@ -0,0 +1,9 @@
+## Process this file with automake to produce Makefile.in
+
+man8_MANS = nfs.idmap.man
+
+sbin_PROGRAMS	= nfs.idmap
+nfs_idmap_SOURCES = nfs.idmap.c
+nfs_idmap_LDADD = -lnfsidmap -lkeyutils
+
+MAINTAINERCLEANFILES = Makefile.in
utils/nfs.idmap/nfs.idmap.c new file +118 -0
new file mode 100644
index 0000000..abbcb65
@@ -0,0 +1,118 @@
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <pwd.h>
+#include <grp.h>
+#include <keyutils.h>
+#include <nfsidmap.h>
+
+#include <syslog.h>
+
+/* gcc nfs.idmap.c -o nfs.idmap -l nfsidmap -l keyutils */
+
+#define MAX_ID_LEN   11
+#define IDMAP_NAMESZ 128
+#define USER  1
+#define GROUP 0
+
+
+/*
+ * Find either a user or group id based on the name@domain string
+ */
+int id_lookup(char *name_at_domain, key_serial_t key, int type)
+{
+	char id[MAX_ID_LEN];
+	uid_t uid = 0;
+	gid_t gid = 0;
+	int rc;
+
+	if (type == USER) {
+		rc = nfs4_owner_to_uid(name_at_domain, &uid);
+		sprintf(id, "%u", uid);
+	} else {
+		rc = nfs4_group_owner_to_gid(name_at_domain, &gid);
+		sprintf(id, "%u", gid);
+	}
+
+	if (rc == 0)
+		rc = keyctl_instantiate(key, id, strlen(id) + 1, 0);
+
+	return rc;
+}
+
+/*
+ * Find the name@domain string from either a user or group id
+ */
+int name_lookup(char *id, key_serial_t key, int type)
+{
+	char name[IDMAP_NAMESZ];
+	char domain[NFS4_MAX_DOMAIN_LEN];
+	uid_t uid;
+	gid_t gid;
+	int rc;
+
+	rc = nfs4_get_default_domain(NULL, domain, NFS4_MAX_DOMAIN_LEN);
+	if (rc != 0) {
+		rc = -1;
+		goto out;
+	}
+
+	if (type == USER) {
+		uid = atoi(id);
+		rc = nfs4_uid_to_name(uid, domain, name, IDMAP_NAMESZ);
+	} else {
+		gid = atoi(id);
+		rc = nfs4_gid_to_name(gid, domain, name, IDMAP_NAMESZ);
+	}
+
+	if (rc == 0)
+		rc = keyctl_instantiate(key, &name, strlen(name), 0);
+
+out:
+	return rc;
+}
+
+int main(int argc, char **argv)
+{
+	char *arg;
+	char *value;
+	char *type;
+	int rc = 1;
+	int timeout = 600;
+	key_serial_t key;
+
+	if (argc < 3)
+		return 1;
+
+	arg = malloc(sizeof(char) * strlen(argv[2]) + 1);
+	strcpy(arg, argv[2]);
+	type = strtok(arg, ":");
+	value = strtok(NULL, ":");
+
+	if (argc == 4) {
+		timeout = atoi(argv[3]);
+		if (timeout < 0)
+			timeout = 0;
+	}
+
+	key = strtol(argv[1], NULL, 10);
+
+	if (strcmp(type, "uid") == 0)
+		rc = id_lookup(value, key, USER);
+	else if (strcmp(type, "gid") == 0)
+		rc = id_lookup(value, key, GROUP);
+	else if (strcmp(type, "user") == 0)
+		rc = name_lookup(value, key, USER);
+	else if (strcmp(type, "group") == 0)
+		rc = name_lookup(value, key, GROUP);
+
+	/* Set timeout to 5 (600 seconds) minutes */
+	if (rc == 0)
+		keyctl_set_timeout(key, timeout);
+
+	free(arg);
+	return rc;
+}
utils/nfs.idmap/nfs.idmap.man new file +4 -0
new file mode 100644
index 0000000..9008dd9
@@ -0,0 +1,60 @@
+.\"
+.\"@(#)nfs.idmap(8) - The NFS idmapper upcall program
+.\"
+.\" Copyright (C) 2010 Bryan Schumaker <[email protected]>

utils/nfs.idmap/nfs.idmap.man line 14

Quoted 10 lines
utils/nfs.idmap/nfs.idmap.man new file +10 -0
+.TH nfs.idmap 5 "1 October 2010"
+.SH NAME
+nfs.idmap \- The NFS idmapper upcall program
+.SH DESCRIPTION
+The file
+.I /usr/sbin/idmap
+is used by the NFS idmapper to translate user and group ids into names, and to
+translate user and group names into ids. Idmapper uses request-key to perform
+the upcall and cache the result.
+.I /usr/sbin/idmap

I'm assuming this should be

Quoted 46 lines
utils/nfs.idmap/nfs.idmap.man new file +46 -0
+should only be called by request-key, and will perform the translation and
+initialize a key with the resulting information.
+.PP
+NFS_USE_NEW_IDMAPPER must be selected when configuring the kernel to use this
+feature.
+.SH CONFIGURING
+The file
+.I /etc/request-key.conf
+will need to be modified so
+.I /sbin/request-key
+can properly direct the upcall. The following line should be added before a call
+to keyctl negate:
+.PP
+create	id_resolver	*	*	/usr/sbin/nfs.idmap %k %d 600
+.PP
+This will direct all nfs_idmap requests to the program
+.I /usr/sbin/nfs.idmap
+The last parameter, 600, defines how many seconds into the future the key will
+expire.  This is an optional parameter for
+.I /usr/sbin/nfs.idmap
+and will default to 600 seconds when not specified.
+.PP
+The idmapper system uses four key descriptions:
+.PP
+	  uid: Find the UID for the given user
+.br
+	  gid: Find the GID for the given group
+.br
+	 user: Find the user name for the given UID
+.br
+	group: Find the group name for the given GID
+.PP
+You can choose to handle any of these individually, rather than using the
+generic upcall program.  If you would like to use your own program for a uid
+lookup then you would edit your request-key.conf so it looks similar to this:
+.PP
+create	id_resolver	uid:*	*	/some/other/program %k %d 600
+.br
+create	id_resolver	*		*	/usr/sbin/nfs.idmap %k %d 600
+.PP
+Notice that the new line was added above the line for the generic program.
+request-key will find the first matching line and run the corresponding program.
+In this case, /some/other/program will handle all uid lookups, and
+/usr/sbin/nfs.idmap will handle gid, user, and group lookups.
+.SH AUTHOR
+Bryan Schumaker, <[email protected]>
#3 lore raw
Quoted 11 lines · Steve Dickson

Hey Bryan,

A couple nits.... which I will be more than willing to take of...

1) I would like to change the binary name from nfs.idmap to nfsidmap which is consistent with how the rest of the binaries are named. (i.e. binary names generally don't have any '.' or '-' in them)

2) Change the source directory from utils/nfs.idmap to utils/idmap which again makes it consistent with what is already there.

These both sounds reasonable to me. I'll make a patch to modify the kernel documentation to reflect this.

Quoted 8 lines

3) The man page talks about a /usr/sbin/idmap file and then later talks about a /usr/sbin/nfs.idmap program. Can I assume those are same binary, since I only see on binary being installed? Also, maybe we should move the binary to /sbin so it would be available early in the boot

Comments?

Yes, those are the same binary. I don't know how that slipped through, but thanks for catching it. Making it available early in the boot sounds like it could be useful. I'll change this in the kernel documentation, too.

Quoted 2 lines

steved.

#4 lore raw
Quoted 9 lines · Bryan Schumaker
Quoted 8 lines · Steve Dickson

Hey Bryan,

A couple nits.... which I will be more than willing to take of...

1) I would like to change the binary name from nfs.idmap to nfsidmap which is consistent with how the rest of the binaries are named. (i.e. binary names generally don't have any '.' or '-' in them)

Quoted 6 lines
Quoted 3 lines

2) Change the source directory from utils/nfs.idmap to utils/idmap which again makes it consistent with what is already there.

These both sounds reasonable to me. I'll make a patch to modify the kernel documentation to reflect this.

Quoted 1 line

We just sent in one patch to change the name in the kernel docs, now the name is changing again?

Let's wait with this until an actual nfs-utils release is available, so we can also update the 'Documentation/Changes' file with the new minimal release version number.

Trond

#5 lore raw
Quoted 14 lines · Trond Myklebust
Quoted 13 lines · Bryan Schumaker
Quoted 11 lines · Steve Dickson

Hey Bryan,

A couple nits.... which I will be more than willing to take of...

1) I would like to change the binary name from nfs.idmap to nfsidmap which is consistent with how the rest of the binaries are named. (i.e. binary names generally don't have any '.' or '-' in them)

2) Change the source directory from utils/nfs.idmap to utils/idmap which again makes it consistent with what is already there.

Quoted 5 lines
Quoted 2 lines

These both sounds reasonable to me. I'll make a patch to modify the kernel documentation to reflect this.

Quoted 1 line

We just sent in one patch to change the name in the kernel docs, now the name is changing again?

I'll take the blame for that... I should have gotten into the conversation earlier... sorry about that...

Quoted 4 lines

Let's wait with this until an actual nfs-utils release is available, so we can also update the 'Documentation/Changes' file with the new minimal release version number.

Just to be clear... the kernel changes will be in the 2.6.37 kernel, correct?

steved.

#6 lore raw
Quoted 7 lines · Steve Dickson
Quoted 4 lines · Trond Myklebust

Let's wait with this until an actual nfs-utils release is available, so we can also update the 'Documentation/Changes' file with the new minimal release version number.

Just to be clear... the kernel changes will be in the 2.6.37 kernel, correct?

Yes. They have already been merged into Linus' git tree.

So FWIW, the name nfs.idmap is consistent with the apparent convention in /etc/request-key.conf for the cifs.upcall and David's proposal for a dns.upcall.

Cheers
Trond

#7 lore raw
Quoted 10 lines · Trond Myklebust
Quoted 7 lines · Steve Dickson
Quoted 4 lines · Trond Myklebust

Let's wait with this until an actual nfs-utils release is available, so we can also update the 'Documentation/Changes' file with the new minimal release version number.

Just to be clear... the kernel changes will be in the 2.6.37 kernel, correct?

Yes. They have already been merged into Linus' git tree.

Cool..

Quoted 4 lines

So FWIW, the name nfs.idmap is consistent with the apparent convention in /etc/request-key.conf for the cifs.upcall and David's proposal for a dns.upcall.

Well those don't live in nfs-utils.. ;-)

steved.