File: sbuild-auth-pam.h

package info (click to toggle)
schroot 1.6.4-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,684 kB
  • sloc: cpp: 21,427; sh: 12,516; makefile: 829; ansic: 231; sed: 16
file content (145 lines) | stat: -rw-r--r-- 3,489 bytes parent folder | download | duplicates (6)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* Copyright © 2005-2007  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_H
#define SBUILD_AUTH_PAM_H

#include <sbuild/sbuild-auth.h>
#include <sbuild/sbuild-auth-pam-conv.h>

#include <security/pam_appl.h>

namespace sbuild
{

  /**
   * Authentication handler.
   *
   * auth_pam handles user authentication, authorisation and session
   * management using the Pluggable Authentication Modules (PAM)
   * library.  It is essentially an object-oriented wrapper around PAM.
   */
  class auth_pam : public auth
  {
  private:
    /**
     * The constructor.
     *
     * @param service_name the PAM service name.  This should be a
     * hard-coded constant string literal for safety and security.
     * This is passed to pam_start() when initialising PAM, and is
     * used to load the correct configuration file from /etc/pam.d.
     */
    auth_pam (std::string const& service_name);

  public:
    /**
     * The destructor.
     */
    virtual ~auth_pam ();

    /**
     * Create an auth_pam object.
     *
     * @param service_name the PAM service name.  This should be a
     * hard-coded constant string literal for safety and security.
     * This is passed to pam_start() when initialising PAM, and is
     * used to load the correct configuration file from /etc/pam.d.
     * @returns a shared pointer to the created object.
     */
    static auth::ptr
    create (std::string const& service_name);

    virtual environment
    get_auth_environment () const;

    /**
     * Get the conversation handler.
     *
     * @returns a shared pointer to the conversation handler.
     */
    auth_pam_conv::ptr&
    get_conv ();

    /**
     * Set the conversation handler.
     *
     * @param conv a shared pointer to the conversation handler.
     */
    void
    set_conv (auth_pam_conv::ptr& conv);

    virtual void
    start ();

    virtual void
    stop ();

    virtual void
    authenticate (status auth_status);

    virtual void
    setupenv ();

    virtual void
    account ();

    virtual void
    cred_establish ();

    virtual void
    cred_delete ();

    virtual void
    open_session ();

    virtual void
    close_session ();

    /**
     * Check if PAM is initialised (i.e. start has been called).
     * @returns true if initialised, otherwise false.
     */
    virtual bool
    is_initialised () const;

  private:
    /**
     * Get a description of a PAM error.
     *
     * @param pam_error the PAM error number.
     * @returns the description.
     */
    const char *
    pam_strerror (int pam_error);

    /// The PAM handle.
    pam_handle_t       *pam;
    /// The PAM conversation handler.
    auth_pam_conv::ptr  conv;
  };

}

#endif /* SBUILD_AUTH_PAM_H */

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