cosmos::PasswdInfo Class Reference

Password Database Information for Users. More...

#include <PasswdInfo.hxx>

Inheritance diagram for cosmos::PasswdInfo:

Public Member Functions
	PasswdInfo (const SysString name)
	Obtains PasswdInfo for the given username name.
	PasswdInfo (const UserID uid)
	Obtains PasswdInfo for the given numerical user id uid.
SysString	name () const
SysString	passwd () const
	Returns the optional encrypted password.
UserID	uid () const
GroupID	gid () const
	The user's main group ID.
SysString	gecos () const
	Returns the comment field which is used for different things like a full user name.
SysString	homeDir () const
	Path to the user's home directory.
SysString	shell () const
	Optional command interpreter for the user.
Public Member Functions inherited from cosmos::InfoBase< struct passwd >
bool	valid () const
	Returns whether data is present in the object.
void	reset ()
	Zeroes out all data.
const struct passwd *	raw () const
	Grants access to the raw underlying data structure.
struct passwd *	raw ()

Additional Inherited Members
Protected Member Functions inherited from cosmos::InfoBase< struct passwd >
bool	getInfo (std::function< int(struct passwd **)> get_func, const char *errlabel)
	Helper to drive the common getter function logic for getpw* and getgr*.
Protected Attributes inherited from cosmos::InfoBase< struct passwd >
bool	m_valid
struct passwd	m_info
	struct passwd or struct group.
std::vector< char >	m_buf
	Extra space for storing the dynamic strings in the m_info struct.

Detailed Description

Password Database Information for Users.

This type obtains and stores data for an individual user account ID as found in the /etc/passwd database.

Definition at line 18 of file PasswdInfo.hxx.

Constructor & Destructor Documentation

PasswdInfo() [1/2]

cosmos::PasswdInfo::PasswdInfo ( const SysString name )

explicit

Obtains PasswdInfo for the given username name.

If an error occurs obtaining the entry then an ApiError exception is thrown.

If simply no matching entry exists then no exception is thrown but valid() return false and all members are empty.

Definition at line 8 of file PasswdInfo.cxx.

                                           {
        auto call = [&](struct passwd **res) -> int {
                return getpwnam_r(name.raw(), &m_info,
                        m_buf.data(), m_buf.size(),
                        res);
        };
 
        m_valid = getInfo(call, "getpwnam_r()");
 
        if (!m_valid)
                reset();
}

PasswdInfo() [2/2]

cosmos::PasswdInfo::PasswdInfo ( const UserID uid )

explicit

Obtains PasswdInfo for the given numerical user id uid.

See also

PasswdInfo(const SysString)

Definition at line 21 of file PasswdInfo.cxx.

                                       {
        auto call = [&](struct passwd **res) -> int {
                return getpwuid_r(to_integral(uid), &m_info,
                        m_buf.data(), m_buf.size(),
                        res);
        };
 
        m_valid = getInfo(call, "getpwuid_r()");
 
        if (!m_valid)
                reset();
}

Member Function Documentation

gecos()

SysString cosmos::PasswdInfo::gecos ( ) const

inline

Returns the comment field which is used for different things like a full user name.

Definition at line 49 of file PasswdInfo.hxx.

{ return m_info.pw_gecos; }

gid()

GroupID cosmos::PasswdInfo::gid ( ) const

inline

The user's main group ID.

Definition at line 46 of file PasswdInfo.hxx.

{ return GroupID{m_info.pw_gid}; }

homeDir()

SysString cosmos::PasswdInfo::homeDir ( ) const

inline

Path to the user's home directory.

Definition at line 52 of file PasswdInfo.hxx.

{ return m_info.pw_dir; }

name()

SysString cosmos::PasswdInfo::name ( ) const

inline

Definition at line 38 of file PasswdInfo.hxx.

{ return m_info.pw_name; }

passwd()

SysString cosmos::PasswdInfo::passwd ( ) const

inline

Returns the optional encrypted password.

Definition at line 41 of file PasswdInfo.hxx.

{ return m_info.pw_passwd; }

shell()

SysString cosmos::PasswdInfo::shell ( ) const

inline

Optional command interpreter for the user.

Definition at line 55 of file PasswdInfo.hxx.

{ return m_info.pw_shell; }

uid()

UserID cosmos::PasswdInfo::uid ( ) const

inline

Definition at line 43 of file PasswdInfo.hxx.

{ return UserID{m_info.pw_uid}; }

---

The documentation for this class was generated from the following files:

• include/PasswdInfo.hxx
• src/PasswdInfo.cxx