pam_prompt.3 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. '\" t
  2. .\" Title: pam_prompt
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 09/03/2021
  6. .\" Manual: Linux-PAM Manual
  7. .\" Source: Linux-PAM Manual
  8. .\" Language: English
  9. .\"
  10. .TH "PAM_PROMPT" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. pam_prompt, pam_vprompt \- interface to conversation function
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <security/pam_ext\&.h>
  37. .fi
  38. .ft
  39. .HP \w'int\ pam_prompt('u
  40. .BI "int pam_prompt(pam_handle_t\ *" "pamh" ", int\ " "style" ", char\ **" "response" ", const\ char\ *" "fmt" ", " "\&.\&.\&." ");"
  41. .HP \w'int\ pam_vprompt('u
  42. .BI "int pam_vprompt(pam_handle_t\ *" "pamh" ", int\ " "style" ", char\ **" "response" ", const\ char\ *" "fmt" ", va_list\ " "args" ");"
  43. .SH "DESCRIPTION"
  44. .PP
  45. The
  46. \fBpam_prompt\fR
  47. function constructs a message from the specified format string and arguments and passes it to the conversation function as set by the service\&. Upon successful return,
  48. \fIresponse\fR
  49. is set to point to a string returned from the conversation function\&. This string is allocated on heap and should be freed\&.
  50. .SH "RETURN VALUES"
  51. .PP
  52. PAM_BUF_ERR
  53. .RS 4
  54. Memory buffer error\&.
  55. .RE
  56. .PP
  57. PAM_CONV_ERR
  58. .RS 4
  59. Conversation failure\&.
  60. .RE
  61. .PP
  62. PAM_SUCCESS
  63. .RS 4
  64. Conversation succeeded, response is set\&.
  65. .RE
  66. .PP
  67. PAM_SYSTEM_ERR
  68. .RS 4
  69. System error\&.
  70. .RE
  71. .SH "SEE ALSO"
  72. .PP
  73. \fBpam\fR(8),
  74. \fBpam_conv\fR(3)
  75. .SH "STANDARDS"
  76. .PP
  77. The
  78. \fBpam_prompt\fR
  79. and
  80. \fBpam_vprompt\fR
  81. functions are Linux\-PAM extensions\&.