System.Posix.User · unix-2.8.7.0

User environment

0 declarations

Querying the user environment

valuegetRealUserID :: IO UserID

#

getRealUserID calls getuid to obtain the real UserID associated with the current process.

valuegetRealGroupID :: IO GroupID

#

getRealGroupID calls getgid to obtain the real GroupID associated with the current process.

valuegetEffectiveUserID :: IO UserID

#

getEffectiveUserID calls geteuid to obtain the effective UserID associated with the current process.

valuegetEffectiveGroupID :: IO GroupID

#

getEffectiveGroupID calls getegid to obtain the effective GroupID associated with the current process.

valuegetGroups :: IO [GroupID]

#

getGroups calls getgroups to obtain the list of supplementary GroupIDs associated with the current process.

valuegetLoginName :: IO String

#

getLoginName calls getlogin to obtain the login name associated with the current process.

valuegetEffectiveUserName :: IO String

#

getEffectiveUserName gets the name associated with the effective UserID of the process.

The group database

valuegroupName :: GroupEntry -> String

#

valuegroupPassword :: GroupEntry -> String

#

valuegroupID :: GroupEntry -> GroupID

#

valuegroupMembers :: GroupEntry -> [String]

#

patternpattern GroupEntry :: String -> String -> GroupID -> [String] -> GroupEntry

#

Manually constructing GroupEntry in String modules is discouraged. It will truncate Chars to 8bit. Use System.Posix.User.ByteString instead.

valuegetGroupEntryForID :: GroupID -> IO GroupEntry

#

getGroupEntryForID gid calls getgrgid_r to obtain the GroupEntry information associated with GroupID gid. This operation may fail with isDoesNotExistError if no such group exists.

valuegetGroupEntryForName :: String -> IO GroupEntry

#

getGroupEntryForName name calls getgrnam_r to obtain the GroupEntry information associated with the group called name. This operation may fail with isDoesNotExistError if no such group exists.

valuegetAllGroupEntries :: IO [GroupEntry]

#

getAllGroupEntries returns all group entries on the system by repeatedly calling getgrent

The user database

valueuserName :: UserEntry -> String

#

valueuserPassword :: UserEntry -> String

#

valueuserID :: UserEntry -> UserID

#

valueuserGroupID :: UserEntry -> GroupID

#

valueuserGecos :: UserEntry -> String

#

valuehomeDirectory :: UserEntry -> String

#

valueuserShell :: UserEntry -> String

#

patternpattern UserEntry :: String -> String -> UserID -> GroupID -> String -> String -> String -> UserEntry

#

Manually constructing UserEntry in String modules is discouraged. It will truncate Chars to 8bit. Use System.Posix.User.ByteString instead.

valuegetUserEntryForID :: UserID -> IO UserEntry

#

getUserEntryForID uid calls getpwuid_r to obtain the UserEntry information associated with UserID uid. This operation may fail with isDoesNotExistError if no such user exists.

valuegetUserEntryForName :: String -> IO UserEntry

#

getUserEntryForName name calls getpwnam_r to obtain the UserEntry information associated with the user login name. This operation may fail with isDoesNotExistError if no such user exists.

valuegetAllUserEntries :: IO [UserEntry]

#

getAllUserEntries returns all user entries on the system by repeatedly calling getpwent

Modifying the user environment

valuesetUserID :: UserID -> IO ()

#

setUserID uid calls setuid to set the real, effective, and saved set-user-id associated with the current process to uid.

valuesetGroupID :: GroupID -> IO ()

#

setGroupID gid calls setgid to set the real, effective, and saved set-group-id associated with the current process to gid.

valuesetEffectiveUserID :: UserID -> IO ()

#

setEffectiveUserID uid calls seteuid to set the effective user-id associated with the current process to uid. This does not update the real user-id or set-user-id.

valuesetEffectiveGroupID :: GroupID -> IO ()

#

setEffectiveGroupID uid calls setegid to set the effective group-id associated with the current process to gid. This does not update the real group-id or set-group-id.

valuesetGroups :: [GroupID] -> IO ()

#

setGroups calls setgroups to set the list of supplementary GroupIDs associated with the current process.