perm

Documentation

Overview

Package perm provides constants for file and directory permissions.

Note that these permissions are further restricted by the system configured umask.

Index

• Constants
• func FixDirectoryPermissions(ctx context.Context, path string) error
• type Umask
  • func GetUmask() Umask
  • func (mask Umask) Mask(mode fs.FileMode) fs.FileMode

Constants

const (
	// PrivateDir is the permissions given for a directory that must only be
	// used by gitaly.
	PrivateDir fs.FileMode = 0o700

	// GroupPrivateDir is the permissions given for a directory that must only
	// be used by gitaly and the git group.
	GroupPrivateDir fs.FileMode = 0o770

	// SharedDir is the permission given for a directory that may be read
	// outside of gitaly.
	SharedDir fs.FileMode = 0o755

	// PublicDir is the permission given for a directory that may be read or
	// written outside of gitaly.
	PublicDir fs.FileMode = 0o777

	// PrivateWriteOnceFile is the most restrictive file permission. Given to
	// files that are expected to be written only once and must be read only by
	// gitaly.
	PrivateWriteOnceFile fs.FileMode = 0o400

	// PrivateFile is the permissions given for a file that must only be used
	// by gitaly.
	PrivateFile fs.FileMode = 0o600

	// SharedFile is the permission given for a file that may be read outside
	// of gitaly.
	SharedFile fs.FileMode = 0o644

	// SharedReadOnlyFile is the permission given for a read only file that may also
	// be read outside of Gitaly.
	SharedReadOnlyFile fs.FileMode = 0o444

	// PublicFile is the permission given for a file that may be read or
	// written outside of gitaly.
	PublicFile fs.FileMode = 0o666

	// PrivateExecutable is the permissions given for an executable that must
	// only be used by gitaly.
	PrivateExecutable fs.FileMode = 0o700

	// SharedExecutable is the permission given for an executable that may be
	// executed outside of gitaly.
	SharedExecutable fs.FileMode = 0o755
)

Functions

func FixDirectoryPermissions

func FixDirectoryPermissions(ctx context.Context, path string) error

FixDirectoryPermissions does a recursive directory walk to look for directories that cannot be accessed by the current user, and tries to fix those with chmod. The motivating problem is that directories with mode 0 break os.RemoveAll.

Types

type Umask

type Umask int

Umask represents a umask that is used to mask mode bits.

func GetUmask

func GetUmask() Umask

GetUmask gets the currently set umask. Not safe to call concurrently with other file operations as it has to set the Umask to get the old value.

func (Umask) Mask

func (mask Umask) Mask(mode fs.FileMode) fs.FileMode

Mask applies the mask on the mode.