File: usergroup.hpp

package info (click to toggle)
openvpn3-client 25%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,276 kB
  • sloc: cpp: 190,085; python: 7,218; ansic: 1,866; sh: 1,361; java: 402; lisp: 81; makefile: 17
file content (216 lines) | stat: -rw-r--r-- 5,263 bytes parent folder | download
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//

#ifndef OPENVPN_COMMON_USERGROUP_H
#define OPENVPN_COMMON_USERGROUP_H

#include <pwd.h>
#include <grp.h>
#include <unistd.h>
#include <sys/types.h>
#include <errno.h>

#include <string>

#include <openvpn/common/platform.hpp>

#ifdef OPENVPN_PLATFORM_LINUX
#include <sys/prctl.h>
#endif

#include <openvpn/common/size.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/to_string.hpp>
#include <openvpn/common/strerror.hpp>

namespace openvpn {
// NOTE: -- SetUserGroup object does not own passwd and group
// objects, therefore *pw and *gr can change under us.
class SetUserGroup
{
  public:
    OPENVPN_EXCEPTION(user_group_err);

    SetUserGroup(const std::string &user, const std::string &group, const bool strict)
        : SetUserGroup(user.empty() ? nullptr : user.c_str(),
                       group.empty() ? nullptr : group.c_str(),
                       strict)
    {
    }

    SetUserGroup(const char *user, const char *group, const bool strict)
        : pw(nullptr),
          gr(nullptr)
    {
        if (user)
        {
            pw = ::getpwnam(user);
            if (!pw && strict)
                OPENVPN_THROW(user_group_err, "user lookup failed for '" << user << '\'');
            user_name = user;
        }
        if (group)
        {
            gr = ::getgrnam(group);
            if (!gr && strict)
                OPENVPN_THROW(user_group_err, "group lookup failed for '" << group << '\'');
            group_name = group;
        }
    }

    virtual ~SetUserGroup() = default;

    const std::string &user() const
    {
        return user_name;
    }

    const std::string &group() const
    {
        return group_name;
    }

    virtual void pre_thread() const
    {
    }

    virtual void post_thread() const
    {
    }

    virtual void activate() const
    {
        do_setgid_setgroups();
        do_setuid();
        retain_core_dumps();
    }

    void chown(const std::string &fn) const
    {
        if (pw && gr)
        {
            const int status = ::chown(fn.c_str(), uid(), gid());
            if (status < 0)
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "chown " << user_name << '.' << group_name << ' ' << fn << " : " << strerror_str(eno));
            }
        }
    }

    void chown(const int fd, const std::string &title) const
    {
        if (pw && gr)
        {
            const int status = ::fchown(fd, uid(), gid());
            if (status < 0)
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "chown " << user_name << '.' << group_name << ' ' << title << " : " << strerror_str(eno));
            }
        }
    }

    void invalidate()
    {
        pw = nullptr;
        gr = nullptr;
    }

    uid_t uid() const
    {
        if (pw)
            return pw->pw_uid;
        else
            return -1;
    }

    gid_t gid() const
    {
        if (gr)
            return gr->gr_gid;
        else
            return -1;
    }

    bool uid_defined() const
    {
        return bool(pw);
    }

    bool gid_defined() const
    {
        return bool(gr);
    }

    bool defined() const
    {
        return uid_defined() && gid_defined();
    }

  protected:
    void do_setgid_setgroups() const
    {
        if (gr)
        {
            if (::setgid(gr->gr_gid))
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "setgid failed for group '" << group_name << "': " << strerror_str(eno));
            }
            gid_t gr_list[1];
            gr_list[0] = gr->gr_gid;
            if (::setgroups(1, gr_list))
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "setgroups failed for group '" << group_name << "': " << strerror_str(eno));
            }
            OPENVPN_LOG("GID set to '" << group_name << '\'');
        }
    }

    void do_setuid() const
    {
        if (pw)
        {
            if (::setuid(pw->pw_uid))
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "setuid failed for user '" << user_name << "': " << strerror_str(eno));
            }
            OPENVPN_LOG("UID set to '" << user_name << '\'');
        }
    }

    void retain_core_dumps() const
    {
#ifdef OPENVPN_PLATFORM_LINUX
        // retain core dumpability after setgid/setuid
        if (gr || pw)
        {
            if (::prctl(PR_SET_DUMPABLE, 1))
            {
                const int eno = errno;
                OPENVPN_THROW(user_group_err, "SetUserGroup prctl PR_SET_DUMPABLE fail: " << strerror_str(eno));
            }
        }
#endif
    }

    std::string user_name;
    std::string group_name;

    struct passwd *pw;
    struct group *gr;
};
} // namespace openvpn

#endif