osidm

Documentation

Overview

Package osidm implements an identity manager using os functions.

For testing only, should not be used in a production environment.

Index

• func SetUser(name string) (avfs.UserReader, error)
• func User() avfs.UserReader
• type OsGroup
  • func (g *OsGroup) Gid() int
  • func (g *OsGroup) Name() string
• type OsIdm
  • func New() *OsIdm
  • func (idm *OsIdm) AdminGroup() avfs.GroupReader
  • func (idm *OsIdm) AdminUser() avfs.UserReader
  • func (idm *OsIdm) Features() avfs.Features
  • func (idm *OsIdm) GroupAdd(name string) (avfs.GroupReader, error)
  • func (idm *OsIdm) GroupDel(name string) error
  • func (idm *OsIdm) HasFeature(feature avfs.Features) bool
  • func (idm *OsIdm) LookupGroup(name string) (avfs.GroupReader, error)
  • func (idm *OsIdm) LookupGroupId(gid int) (avfs.GroupReader, error)
  • func (idm *OsIdm) LookupUser(name string) (avfs.UserReader, error)
  • func (idm *OsIdm) LookupUserId(uid int) (avfs.UserReader, error)
  • func (idm *OsIdm) OSType() avfs.OSType
  • func (idm *OsIdm) SetUser(name string) (avfs.UserReader, error)
  • func (idm *OsIdm) Type() string
  • func (idm *OsIdm) User() avfs.UserReader
  • func (idm *OsIdm) UserAdd(name, groupName string) (avfs.UserReader, error)
  • func (idm *OsIdm) UserDel(name string) error
• type OsUser
  • func (u *OsUser) Gid() int
  • func (u *OsUser) IsAdmin() bool
  • func (u *OsUser) Name() string
  • func (u *OsUser) Uid() int

Functions

func SetUser

func SetUser(name string) (avfs.UserReader, error)

func User

func User() avfs.UserReader

User returns the current user of the OS.

Types

type OsGroup

type OsGroup struct {
	// contains filtered or unexported fields
}

OsGroup is the implementation of avfs.GroupReader.

func (*OsGroup) Gid

func (g *OsGroup) Gid() int

Gid returns the group ID.

func (*OsGroup) Name

func (g *OsGroup) Name() string

Name returns the group name.

type OsIdm

type OsIdm struct {
	// contains filtered or unexported fields
}

OsIdm implements a rudimentary identity manager using the avfs.IdentityMgr interface.

func New

func New() *OsIdm

New creates a new OsIdm identity manager.

func (*OsIdm) AdminGroup

func (idm *OsIdm) AdminGroup() avfs.GroupReader

AdminGroup returns the administrator (root) group.

func (*OsIdm) AdminUser

func (idm *OsIdm) AdminUser() avfs.UserReader

AdminUser returns the administrator (root) user.

func (*OsIdm) Features

func (idm *OsIdm) Features() avfs.Features

Features returns the set of features provided by the file system or identity manager.

func (*OsIdm) GroupAdd

func (idm *OsIdm) GroupAdd(name string) (avfs.GroupReader, error)

GroupAdd adds a new group.

func (*OsIdm) GroupDel

func (idm *OsIdm) GroupDel(name string) error

GroupDel deletes an existing group.

func (*OsIdm) HasFeature

func (idm *OsIdm) HasFeature(feature avfs.Features) bool

HasFeature returns true if the file system or identity manager provides a given feature.

func (*OsIdm) LookupGroup

func (idm *OsIdm) LookupGroup(name string) (avfs.GroupReader, error)

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

func (*OsIdm) LookupGroupId

func (idm *OsIdm) LookupGroupId(gid int) (avfs.GroupReader, error)

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

func (*OsIdm) LookupUser

func (idm *OsIdm) LookupUser(name string) (avfs.UserReader, error)

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

func (*OsIdm) LookupUserId

func (idm *OsIdm) LookupUserId(uid int) (avfs.UserReader, error)

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

func (*OsIdm) OSType

func (idm *OsIdm) OSType() avfs.OSType

OSType returns the operating system type of the identity manager.

func (*OsIdm) SetUser

func (idm *OsIdm) SetUser(name string) (avfs.UserReader, error)

SetUser sets and returns the current user. If the user is not found, the returned error is of type UnknownUserError.

func (*OsIdm) Type

func (idm *OsIdm) Type() string

Type returns the type of the fileSystem or Identity manager.

func (*OsIdm) User

func (idm *OsIdm) User() avfs.UserReader

User returns the current user.

func (*OsIdm) UserAdd

func (idm *OsIdm) UserAdd(name, groupName string) (avfs.UserReader, error)

UserAdd adds a new user.

func (*OsIdm) UserDel

func (idm *OsIdm) UserDel(name string) error

UserDel deletes an existing user.

type OsUser

type OsUser struct {
	// contains filtered or unexported fields
}

OsUser is the implementation of avfs.UserReader.

func (*OsUser) Gid

func (u *OsUser) Gid() int

Gid returns the primary group ID of the user.

func (*OsUser) IsAdmin

func (u *OsUser) IsAdmin() bool

IsAdmin returns true if the user has administrator (root) privileges.

func (*OsUser) Name

func (u *OsUser) Name() string

Name returns the user name.

func (*OsUser) Uid

func (u *OsUser) Uid() int

Uid returns the user ID.