external/bsd/kyua-cli/dist/utils/passwd.hpp

   1 // Copyright 2010 Google Inc.
   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 <string>
  36 #include <vector>
  37
  38 namespace utils {
  39 namespace passwd {
  40
  41
  42 /// Represents a system user.
  43 class user {
  44 public:
  45     /// The name of the user.
  46     std::string name;
  47
  48     /// The system-wide identifier of the user.
  49     unsigned int uid;
  50
  51     /// The login group identifier for the user.
  52     unsigned int gid;
  53
  54     user(const std::string&, const unsigned int, const unsigned int);
  55
  56     bool is_root(void) const;
  57 };
  58
  59
  60 user current_user(void);
  61 user find_user_by_name(const std::string&);
  62 user find_user_by_uid(const unsigned int);
  63 void set_current_user_for_testing(const user&);
  64 void set_mock_users_for_testing(const std::vector< user >&);
  65
  66
  67 }  // namespace passwd
  68 }  // namespace utils
  69
  70 #endif  // !defined(UTILS_PASSWD_HPP)