idmapper.txt 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. =========
  2. ID Mapper
  3. =========
  4. Id mapper is used by NFS to translate user and group ids into names, and to
  5. translate user and group names into ids. Part of this translation involves
  6. performing an upcall to userspace to request the information. Id mapper will
  7. user request-key to perform this upcall and cache the result. The program
  8. /usr/sbin/nfs.idmap should be called by request-key, and will perform the
  9. translation and initialize a key with the resulting information.
  10. NFS_USE_NEW_IDMAPPER must be selected when configuring the kernel to use this
  11. feature.
  12. ===========
  13. Configuring
  14. ===========
  15. The file /etc/request-key.conf will need to be modified so /sbin/request-key can
  16. direct the upcall. The following line should be added:
  17. #OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...
  18. #====== ======= =============== =============== ===============================
  19. create id_resolver * * /usr/sbin/nfs.idmap %k %d 600
  20. This will direct all id_resolver requests to the program /usr/sbin/nfs.idmap.
  21. The last parameter, 600, defines how many seconds into the future the key will
  22. expire. This parameter is optional for /usr/sbin/nfs.idmap. When the timeout
  23. is not specified, nfs.idmap will default to 600 seconds.
  24. id mapper uses for key descriptions:
  25. uid: Find the UID for the given user
  26. gid: Find the GID for the given group
  27. user: Find the user name for the given UID
  28. group: Find the group name for the given GID
  29. You can handle any of these individually, rather than using the generic upcall
  30. program. If you would like to use your own program for a uid lookup then you
  31. would edit your request-key.conf so it look similar to this:
  32. #OP TYPE DESCRIPTION CALLOUT INFO PROGRAM ARG1 ARG2 ARG3 ...
  33. #====== ======= =============== =============== ===============================
  34. create id_resolver uid:* * /some/other/program %k %d 600
  35. create id_resolver * * /usr/sbin/nfs.idmap %k %d 600
  36. Notice that the new line was added above the line for the generic program.
  37. request-key will find the first matching line and corresponding program. In
  38. this case, /some/other/program will handle all uid lookups and
  39. /usr/sbin/nfs.idmap will handle gid, user, and group lookups.
  40. See <file:Documentation/security/keys-request-keys.txt> for more information
  41. about the request-key function.
  42. =========
  43. nfs.idmap
  44. =========
  45. nfs.idmap is designed to be called by request-key, and should not be run "by
  46. hand". This program takes two arguments, a serialized key and a key
  47. description. The serialized key is first converted into a key_serial_t, and
  48. then passed as an argument to keyctl_instantiate (both are part of keyutils.h).
  49. The actual lookups are performed by functions found in nfsidmap.h. nfs.idmap
  50. determines the correct function to call by looking at the first part of the
  51. description string. For example, a uid lookup description will appear as
  52. "uid:user@domain".
  53. nfs.idmap will return 0 if the key was instantiated, and non-zero otherwise.