package user

import "os/user"

Package user allows user account lookups by name or id.

Index ¶

• type Group
• func LookupGroup(name string) (*Group, error)
• func LookupGroupId(gid string) (*Group, error)
• type UnknownGroupError
• func (e UnknownGroupError) Error() string
• type UnknownGroupIdError
• func (e UnknownGroupIdError) Error() string
• type UnknownUserError
• func (e UnknownUserError) Error() string
• type UnknownUserIdError
• func (e UnknownUserIdError) Error() string
• type User
• func Current() (*User, error)
• func Lookup(username string) (*User, error)
• func LookupId(uid string) (*User, error)
• func (u *User) GroupIds() ([]string, error)

Types ¶

type Group ¶

type Group struct {
	Gid  string // group ID
	Name string // group name
}

Group represents a grouping of users.

On POSIX systems Gid contains a decimal number representing the group ID.

func LookupGroup ¶

func LookupGroup(name string) (*Group, error)

LookupGroup looks up a group by name. If the group cannot be found, the returned error is of type UnknownGroupError.

func LookupGroupId ¶

func LookupGroupId(gid string) (*Group, error)

LookupGroupId looks up a group by groupid. If the group cannot be found, the returned error is of type UnknownGroupIdError.

type UnknownGroupError ¶

type UnknownGroupError string

UnknownGroupError is returned by LookupGroup when a group cannot be found.

func (UnknownGroupError) Error ¶

func (e UnknownGroupError) Error() string

type UnknownGroupIdError ¶

type UnknownGroupIdError string

UnknownGroupIdError is returned by LookupGroupId when a group cannot be found.

func (UnknownGroupIdError) Error ¶

func (e UnknownGroupIdError) Error() string

type UnknownUserError ¶

type UnknownUserError string

UnknownUserError is returned by Lookup when a user cannot be found.

func (UnknownUserError) Error ¶

func (e UnknownUserError) Error() string

type UnknownUserIdError ¶

type UnknownUserIdError int

UnknownUserIdError is returned by LookupId when a user cannot be found.

func (UnknownUserIdError) Error ¶

func (e UnknownUserIdError) Error() string

type User ¶

type User struct {
	// Uid is the user ID.
	// On POSIX systems, this is a decimal number representing the uid.
	// On Windows, this is a security identifier (SID) in a string format.
	// On Plan 9, this is the contents of /dev/user.
	Uid string
	// Gid is the primary group ID.
	// On POSIX systems, this is a decimal number representing the gid.
	// On Windows, this is a SID in a string format.
	// On Plan 9, this is the contents of /dev/user.
	Gid string
	// Username is the login name.
	Username string
	// Name is the user's real or display name.
	// It might be blank.
	// On POSIX systems, this is the first (or only) entry in the GECOS field
	// list.
	// On Windows, this is the user's display name.
	// On Plan 9, this is the contents of /dev/user.
	Name string
	// HomeDir is the path to the user's home directory (if they have one).
	HomeDir string
}

User represents a user account.

func Current ¶

func Current() (*User, error)

Current returns the current user.

func Lookup ¶

func Lookup(username string) (*User, error)

Lookup looks up a user by username. If the user cannot be found, the returned error is of type UnknownUserError.

func LookupId ¶

func LookupId(uid string) (*User, error)

LookupId looks up a user by userid. If the user cannot be found, the returned error is of type UnknownUserIdError.

func (*User) GroupIds ¶

func (u *User) GroupIds() ([]string, error)

GroupIds returns the list of group IDs that the user is a member of.

Source Files ¶

lookup.go user.go