logo

checkpassword-ng

Uniform password checking interface for applications

chkpw.3 (1397B)

    

  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 CHKPW 3
  6. .Sh NAME
  7. .Nm chkpw
  8. .Nd Uniform password checking interface for applications
  9. .Sh SYNOPSIS
  10. .In chkpw.h
  11. .Vt extern struct chkpw_extra;
  12. .Ft char *
  13. .Fo chkpw_shadow
  14. .Fa "const char *username"
  15. .Fa "const char *password"
  16. .Fa "struct chkpw_extra"
  17. .Fc
  18. .Sh DESCRIPTION
  19. .Fn chkpw_shadow
  20. will verify
  21. .Va password
  22. against
  23. .Va username .
  24. Additionnal options might be passed in the future via
  25. .Va chkpw_extra ,
  26. for now it is safe to give it
  27. .Aq NULL .
  28. .Pp
  29. This interface is for applications which already have access to files like
  30. .Pa /etc/shadow ,
  31. for others they should consider using 
  32. .Xr checkpassword 8
  33. which doesn't requires your application to be running with special privileges.
  34. .Sh RETURN VALUES
  35. .Fn chkpw_shadow
  36. returns
  37. .Aq NULL
  38. on success, on failure it returns an error message to be passed to the user.
  39. .Sh LIMITATIONS
  40. PAM (Pluggable Authentication Modules)
  41. is unsupported for now.
  42. .Sh BUGS
  43. Please send all bugs to
  44. .Mt contact+chkpw@hacktivis.me
  45. .Pp
  46. For security bugs you can encrypt the email with
  47. .Xr reop 1 ,
  48. my public key is found at:
  49. .Lk https://hacktivis.me/reop.pub
  50. .Sh Author
  51. .An Haelwenn (lanodan) Monnier Aq Mt contact+chkpw@hacktivis.me