user

Documentation

Overview

userパッケージは、名前またはIDによるユーザーアカウントの検索を可能にします。

ほとんどのUnixシステムでは、このパッケージにはユーザーとグループのIDを名前に解決し、 補足的なグループIDをリストアップするための2つの内部実装があります。 一つは純粋なGoで書かれており、/etc/passwdと/etc/groupを解析します。 もう一つはcgoベースで、getpwuid_r、getgrnam_r、getgrouplistなどの 標準Cライブラリ(libc)のルーチンに依存しています。

cgoが利用可能で、特定のプラットフォームのlibcに必要なルーチンが実装されている場合、 cgoベース（libcバックエンド）のコードが使用されます。 これは、純粋なGoの実装を強制するosusergoビルドタグを使用することで上書きすることができます。

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
	Name string
}

Groupはユーザーのグループを表します。

POSIXシステムでは、GidはグループIDを表す10進数を含みます。

func LookupGroup

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

LookupGroupは名前でグループを検索します。グループが見つからない場合、 返されるエラーのタイプは UnknownGroupError です。

func LookupGroupId

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

LookupGroupIdはグループIDでグループを検索します。グループが見つからない場合、 返されるエラーのタイプは UnknownGroupIdError です。

type UnknownGroupError

type UnknownGroupError string

UnknownGroupErrorは、グループが見つからない場合に LookupGroup によって返されるエラーです。

func (UnknownGroupError) Error

func (e UnknownGroupError) Error() string

type UnknownGroupIdError

type UnknownGroupIdError string

UnknownGroupIdErrorは、グループが見つからない場合に LookupGroupId によって返されるエラーです。

func (UnknownGroupIdError) Error

func (e UnknownGroupIdError) Error() string

type UnknownUserError

type UnknownUserError string

UnknownUserErrorは、ユーザーが見つからない場合に Lookup によって返されるエラーです。

func (UnknownUserError) Error

func (e UnknownUserError) Error() string

type UnknownUserIdError

type UnknownUserIdError int

UnknownUserIdErrorは、ユーザーが見つからない場合に LookupId によって返されるエラーです。

func (UnknownUserIdError) Error

func (e UnknownUserIdError) Error() string

type User

type User struct {
	// UidはユーザーIDです。
	// POSIXシステムでは、これはuidを表す10進数です。
	// Windowsでは、これは文字列形式のセキュリティ識別子（SID）です。
	// Plan 9では、これは/dev/userの内容です。
	Uid string
	// GidはプライマリグループIDです。
	// POSIXシステムでは、これはgidを表す10進数です。
	// Windowsでは、これは文字列形式のセキュリティ識別子（SID）です。
	// Plan 9では、これは/dev/userの内容です。
	Gid string
	// Usernameはログイン名です。
	Username string
	// Nameはユーザーの実名または表示名です。
	// 空である可能性があります。
	// POSIXシステムでは、これはGECOSフィールドリストの最初（または唯一）のエントリです。
	// Windowsでは、これはユーザーの表示名です。
	// Plan 9では、これは/dev/userの内容です。
	Name string
	// HomeDirはユーザーのホームディレクトリへのパスです（もし存在する場合）。
	HomeDir string
}

Userはユーザーアカウントを表します。

func Current

func Current() (*User, error)

Currentは現在のユーザーを返します。

最初の呼び出しは現在のユーザー情報をキャッシュします。 その後の呼び出しはキャッシュされた値を返し、現在のユーザーへの変更は反映されません。

func Lookup

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

Lookupはユーザー名でユーザーを検索します。ユーザーが見つからない場合、 返されるエラーのタイプは UnknownUserError です。

func LookupId

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

LookupIdはユーザーIDでユーザーを検索します。ユーザーが見つからない場合、 返されるエラーのタイプは UnknownUserIdError です。

func (*User) GroupIds

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

GroupIdsは、ユーザーがメンバーであるグループIDのリストを返します。