secretsfs

Documentation

Index

• Variables
• func FIOMaps() map[string]*FIOMap
• func FIOMapsEnabled() map[string]*FIOMap
• func GetInode(npath string) uint64
• func GetInodeIfRegistered(npath string) (uint64, bool)
• func GetMapStringKeys(m map[string]interface{}) []string
• func IsRootPath(rootpath string) bool
• func PrettyPrint(v interface{}) ([]byte, error)
• func RegisterRoot(fm *FIOMap)
• func RootPathsEnabled() []string
• type FIOInternal
  • func (sf *FIOInternal) FIOPath() string
  • func (sf *FIOInternal) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno
  • func (sf *FIOInternal) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)
  • func (sf *FIOInternal) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
  • func (sf *FIOInternal) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
  • func (sf *FIOInternal) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)
• type FIOMap
• type FIORoot
• type FIOSecretsFiles
  • func (sf *FIOSecretsFiles) FIOPath() string
  • func (sf *FIOSecretsFiles) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno
  • func (sf *FIOSecretsFiles) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)
  • func (sf *FIOSecretsFiles) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
  • func (sf *FIOSecretsFiles) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
  • func (sf *FIOSecretsFiles) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)
• type FIOTemplateFiles
  • func (sf *FIOTemplateFiles) FIOPath() string
  • func (sf *FIOTemplateFiles) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno
  • func (sf *FIOTemplateFiles) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)
  • func (sf *FIOTemplateFiles) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
  • func (sf *FIOTemplateFiles) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
  • func (sf *FIOTemplateFiles) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)
• type FIOTest
  • func (sf *FIOTest) FIOPath() string
  • func (sf *FIOTest) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno
  • func (sf *FIOTest) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)
  • func (sf *FIOTest) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
  • func (sf *FIOTest) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
  • func (sf *FIOTest) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)
• type SfsNode
  • func GetNewRootNode(npath string, fms map[string]*FIOMap) *SfsNode
  • func NewNode(npath string) *SfsNode
  • func (n *SfsNode) Getattr(ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno
  • func (n *SfsNode) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno)
  • func (n *SfsNode) NPath() string
  • func (n *SfsNode) OnAdd(ctx context.Context)
  • func (n *SfsNode) Open(ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
  • func (n *SfsNode) Read(ctx context.Context, fh fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
  • func (n *SfsNode) Readdir(ctx context.Context) (fs.DirStream, syscall.Errno)

Variables

var TEMPLATESPATHS map[string]string

Functions

func FIOMaps

func FIOMaps() map[string]*FIOMap

FIOMaps returns all registered FIO Plugins mapped with their mountpaths. Generally used by rootnode so it can correctly redirect calls to corresponding plugins.

func FIOMapsEnabled

func FIOMapsEnabled() map[string]*FIOMap

FIOMapsEnabled returns a map[string]*FIOMap only with enabled FIOMaps

func GetInode

func GetInode(npath string) uint64

GetInode returns a valid inode for npath. If it isn't registered yet, it will be registered

func GetInodeIfRegistered

func GetInodeIfRegistered(npath string) (uint64, bool)

GetInodeIfRegistered returns the inode if it is registered, won't register it if it isn't already registered

func GetMapStringKeys

func GetMapStringKeys(m map[string]interface{}) []string

GetMapStringKeys returns []string containing all keys from a map[string]interface{}

func IsRootPath

func IsRootPath(rootpath string) bool

IsRootPath checks whether the given rootpath is registered and enabled in fiomaps

func PrettyPrint

func PrettyPrint(v interface{}) ([]byte, error)

PrettyPrint variable (struct, map, array, slice) in Golang https://siongui.github.io/2016/01/30/go-pretty-print-variable/

func RegisterRoot

func RegisterRoot(fm *FIOMap)

RegisterRoot registers FIOMaps. To be used inside of init() function of plugins. If FIO is enabled due to configuration, also enable it. If not, only register in in Disabled state.

func RootPathsEnabled

func RootPathsEnabled() []string

RootPathsEnabled returns all registered fioRootPaths that are enabled

Types

type FIOInternal

type FIOInternal struct{}

func (*FIOInternal) FIOPath

func (sf *FIOInternal) FIOPath() string

FIOPath returns name of implemented FIO Plugin sf := Secretsfs Fio

func (*FIOInternal) Getattr

func (sf *FIOInternal) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

func (*FIOInternal) Lookup

func (sf *FIOInternal) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)

Lookuper

func (*FIOInternal) Open

func (sf *FIOInternal) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)

Opener

func (*FIOInternal) Read

func (sf *FIOInternal) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)

Reader

func (*FIOInternal) Readdir

func (sf *FIOInternal) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)

Readdirer

type FIOMap

type FIOMap struct {
	Root    FIORoot
	Enabled bool
}

FIOMap maps the FIORoot Node to a Mountpath Used for registering FIORoots to the secretsfs rootnode

type FIORoot

type FIORoot interface {
	// Node Operations
	Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)
	Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)
	Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)
	Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)
	Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

	// FIOPath() is used for registering and finding FIOMaps
	FIOPath() string
}

FIORoot interface describes functions a new FIO plugin should implement.

type FIOSecretsFiles

type FIOSecretsFiles struct{}

func (*FIOSecretsFiles) FIOPath

func (sf *FIOSecretsFiles) FIOPath() string

func (*FIOSecretsFiles) Getattr

func (sf *FIOSecretsFiles) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

func (*FIOSecretsFiles) Lookup

func (sf *FIOSecretsFiles) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)

func (*FIOSecretsFiles) Open

func (sf *FIOSecretsFiles) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)

func (*FIOSecretsFiles) Read

func (sf *FIOSecretsFiles) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)

func (*FIOSecretsFiles) Readdir

func (sf *FIOSecretsFiles) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)

type FIOTemplateFiles

type FIOTemplateFiles struct{}

func (*FIOTemplateFiles) FIOPath

func (sf *FIOTemplateFiles) FIOPath() string

func (*FIOTemplateFiles) Getattr

func (sf *FIOTemplateFiles) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

func (*FIOTemplateFiles) Lookup

func (sf *FIOTemplateFiles) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)

func (*FIOTemplateFiles) Open

func (sf *FIOTemplateFiles) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)

func (*FIOTemplateFiles) Read

func (sf *FIOTemplateFiles) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)

func (*FIOTemplateFiles) Readdir

func (sf *FIOTemplateFiles) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)

type FIOTest

type FIOTest struct{}

func (*FIOTest) FIOPath

func (sf *FIOTest) FIOPath() string

FIOPath returns name of implemented FIO Plugin sf := Secretsfs Fio

func (*FIOTest) Getattr

func (sf *FIOTest) Getattr(n *SfsNode, ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

func (*FIOTest) Lookup

func (sf *FIOTest) Lookup(n *SfsNode, ctx context.Context, name string, out *fuse.EntryOut) (node *fs.Inode, errno syscall.Errno)

Lookuper

func (*FIOTest) Open

func (sf *FIOTest) Open(n *SfsNode, ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)

Opener

func (*FIOTest) Read

func (sf *FIOTest) Read(n *SfsNode, ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)

Reader

func (*FIOTest) Readdir

func (sf *FIOTest) Readdir(n *SfsNode, ctx context.Context) (out fs.DirStream, errno syscall.Errno)

Readdirer

type SfsNode

type SfsNode struct {
	fs.Inode
	// contains filtered or unexported fields
}

func GetNewRootNode

func GetNewRootNode(npath string, fms map[string]*FIOMap) *SfsNode

func NewNode

func NewNode(npath string) *SfsNode

func (*SfsNode) Getattr

func (n *SfsNode) Getattr(ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno

func (*SfsNode) Lookup

func (n *SfsNode) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno)

func (*SfsNode) NPath

func (n *SfsNode) NPath() string

func (*SfsNode) OnAdd

func (n *SfsNode) OnAdd(ctx context.Context)

func (*SfsNode) Open

func (n *SfsNode) Open(ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno)

func (*SfsNode) Read

func (n *SfsNode) Read(ctx context.Context, fh fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno)

func (*SfsNode) Readdir

func (n *SfsNode) Readdir(ctx context.Context) (fs.DirStream, syscall.Errno)