summaryrefslogtreecommitdiff
path: root/lib/sbuild/auth/pam-message.h
blob: 2faea6171194ac81f115de96ffbdc598a185732f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/* Copyright © 2005-2013  Roger Leigh <rleigh@debian.org>
 *
 * schroot is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * schroot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_AUTH_PAM_MESSAGE_H
#define SBUILD_AUTH_PAM_MESSAGE_H

#include <string>

#include <security/pam_appl.h>

namespace sbuild
{
  namespace auth
  {

    /**
     * Authentication messages.
     *
     * When pam needs to interact with the user, it does this by
     * sending a list of pam_message objects to an pam_conv
     * conversation object.  These messages tell the conversation object
     * how to display the message to the user, and if necessary, whether
     * or not to ask the user for some input.  They also store the
     * user's input, if required.
     */
    class pam_message
    {
    public:
      /// Message type
      enum message_type
        {
          /// Display a prompt, with no echoing of user input.
          MESSAGE_PROMPT_NOECHO = PAM_PROMPT_ECHO_OFF,
          /// Display a prompt, echoing user input.
          MESSAGE_PROMPT_ECHO = PAM_PROMPT_ECHO_ON,
          /// Display an error message.
          MESSAGE_ERROR = PAM_ERROR_MSG,
          /// Display an informational message.
          MESSAGE_INFO = PAM_TEXT_INFO
        };

      /**
       * The constructor.
       *
       * @param type the type of message.
       * @param message the message to display.
       */
      pam_message (message_type       type,
                   const std::string& message);

      /// The destructor.
      virtual ~pam_message ();

      /// The type of message.
      message_type type;
      /// The message to display.
      std::string  message;
      /// The user's response (if any).
      std::string  response;
    };

  }
}

#endif /* SBUILD_AUTH_PAM_MESSAGE_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */