xref: /freebsd/contrib/kyua/utils/passwd.hpp (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/passwd.hpp
30 /// Querying and manipulation of users and groups.
31 
32 #if !defined(UTILS_PASSWD_HPP)
33 #define UTILS_PASSWD_HPP
34 
35 #include "utils/passwd_fwd.hpp"
36 
37 #include <string>
38 #include <vector>
39 
40 namespace utils {
41 namespace passwd {
42 
43 
44 /// Represents a system user.
45 class user {
46 public:
47     /// The name of the user.
48     std::string name;
49 
50     /// The system-wide identifier of the user.
51     unsigned int uid;
52 
53     /// The login group identifier for the user.
54     unsigned int gid;
55 
56     user(const std::string&, const unsigned int, const unsigned int);
57 
58     bool is_root(void) const;
59 };
60 
61 
62 user current_user(void);
63 user find_user_by_name(const std::string&);
64 user find_user_by_uid(const unsigned int);
65 void set_current_user_for_testing(const user&);
66 void set_mock_users_for_testing(const std::vector< user >&);
67 
68 
69 }  // namespace passwd
70 }  // namespace utils
71 
72 #endif  // !defined(UTILS_PASSWD_HPP)
73