logo

checkpassword-ng

Uniform password checking interface for applications

checkpassword.8 (1898B)

    

  1. .\" checkpassword-ng: Uniform password checking interface for applications
  2. .\" Copyright © 2021 checkpassword-ng Authors <https://hacktivis.me/git/checkpassword-ng>
  3. .\" SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
  4. .Dd 2021-04-27
  5. .Dt CHECKPASSWORD 8
  6. .Sh NAME
  7. .Nm checkpassword
  8. .Nd Uniform password checking interface for applications
  9. .Sh SYNOPSIS
  10. .Nm
  11. .Ar prog
  12. .Sh DESCRIPTION
  13. .Nm
  14. reads at most 512-octets from file descriptor 3 and then closes it.
  15. zero-byte-separated data is given on file descriptor 3:
  16. .Bl -bullet -compact
  17. .It
  18. login name
  19. .It
  20. password
  21. .It
  22. timestamp (ignored in this implementation)
  23. .It
  24. possibly more data (also ignored)
  25. .El
  26. .Pp
  27. .Nm
  28. is for applications that typically shouldn't effectively run as root like screen lockers, for others you might want to directly use
  29. .Xr chkpw 3
  30. .Pp
  31. Client applications are highly recommended use a restricted
  32. .Ev PATH
  33. or a direct path to launch
  34. .Nm .
  35. It is also recommended to give a restricted
  36. .Ev PATH
  37. or a direct path for
  38. .Ar prog .
  39. .Sh ENVIRONMENT VARIABLES
  40. Ignored in this implementation, used in others to pass options.
  41. .Sh EXIT STATUS
  42. If the password is invalid,
  43. .Nm
  44. returns 1.
  45. If
  46. .Nm
  47. is misused, it may return 2.
  48. If there is a temporary problem,
  49. .Nm
  50. returns 111.
  51. If the password is correct,
  52. .Nm
  53. runs
  54. .Ar prog .
  55. .Sh SEE ALSO
  56. .Lk https://cr.yp.to/checkpwd/interface.html The checkpassword interface
  57. .Sh LIMITATIONS
  58. PAM (Pluggable Authentication Modules)
  59. is unsupported for now, an implementation with the same standardized interface
  60. with support for it is available at
  61. .Lk http://checkpasswd-pam.sourceforge.net/
  62. .Sh BUGS
  63. Please send all bugs to
  64. .Mt contact+chkpw@hacktivis.me
  65. .Pp
  66. For security bugs you can encrypt the email with
  67. .Xr reop 1 ,
  68. my public key is found at:
  69. .Lk https://hacktivis.me/reop.pub
  70. .Sh Author
  71. This implementation of
  72. .Nm
  73. was written from scratch by
  74. .An Haelwenn (lanodan) Monnier Aq Mt contact+chkpw@hacktivis.me