omnitrail

README

omnitrail-go

Overview

Omnitrail-go is a Go library designed to manage and track file and directory metadata, including permissions, ownership, and cryptographic hashes. It supports various plugins to handle different types of metadata and hashing algorithms.

Features

• File Plugin: Computes SHA1, SHA256, and Gitoid hashes for files.
• Directory Plugin: Manages directory structures and computes Gitoid hashes for directories.
• Posix Plugin: Tracks POSIX file permissions, ownership, and size.

Installation

To install the library, use the following command:

go get github.com/yourusername/omnitrail-go

Usage

Creating a New Trail

To create a new trail, use the NewTrail function:

import "github.com/yourusername/omnitrail-go"

trail := omnitrail.NewTrail()

Adding Files and Directories

To add files and directories to the trail, use the Add method:

err := trail.Add("/path/to/file_or_directory")
if err != nil {
    log.Fatalf("Failed to add path: %v", err)
}

Generating ADG Strings

To generate ADG strings, use the FormatADGString function:

adgString := omnitrail.FormatADGString(trail)
fmt.Println(adgString)

Testing

To run the tests, use the following command:

go test ./...

License

This project is licensed under the ApacheV2 License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

Acknowledgements

Special thanks to all contributors and the open-source community for their support.

Documentation

Index

• func FormatADGString(mapping Factory) string
• type DirectoryPlugin
  • func (plug *DirectoryPlugin) Add(path string) error
  • func (plug *DirectoryPlugin) SetAllowList(allowList []string)
  • func (plug *DirectoryPlugin) Sha1ADG(m map[string]string)
  • func (plug *DirectoryPlugin) Sha256ADG(m map[string]string)
  • func (plug *DirectoryPlugin) Store(envelope *Envelope) error
• type Element
• type Envelope
• type Factory
  • func NewTrail(option ...Option) Factory
• type Feature
• type FilePlugin
  • func (plug *FilePlugin) Add(filePath string) error
  • func (plug *FilePlugin) SetAllowList(allowList []string)
  • func (plug *FilePlugin) Sha1ADG(m map[string]string)
  • func (plug *FilePlugin) Sha256ADG(m map[string]string)
  • func (plug *FilePlugin) Store(envelope *Envelope) error
• type Header
• type Option
• type Options
• type Plugin
  • func NewDirectoryPlugin() Plugin
  • func NewFilePlugin() Plugin
  • func NewPosixPlugin() Plugin
• type Posix
• type PosixPlugin
  • func (p *PosixPlugin) Add(path string) error
  • func (plug *PosixPlugin) SetAllowList(allowList []string)
  • func (p *PosixPlugin) Sha1ADG(_ map[string]string)
  • func (p *PosixPlugin) Sha256ADG(_ map[string]string)
  • func (p *PosixPlugin) Store(envelope *Envelope) error

Functions

func FormatADGString

func FormatADGString(mapping Factory) string

Types

type DirectoryPlugin

type DirectoryPlugin struct {
	AllowList []string
	// contains filtered or unexported fields
}

func (*DirectoryPlugin) Add

func (plug *DirectoryPlugin) Add(path string) error

func (*DirectoryPlugin) SetAllowList

func (plug *DirectoryPlugin) SetAllowList(allowList []string)

func (*DirectoryPlugin) Sha1ADG

func (plug *DirectoryPlugin) Sha1ADG(m map[string]string)

func (*DirectoryPlugin) Sha256ADG

func (plug *DirectoryPlugin) Sha256ADG(m map[string]string)

func (*DirectoryPlugin) Store

func (plug *DirectoryPlugin) Store(envelope *Envelope) error

type Element

type Element struct {
	Type         string `json:"type"`
	Sha1         string `json:"sha1,omitempty"`
	Sha256       string `json:"sha256,omitempty"`
	Sha1Gitoid   string `json:"gitoid:sha1,omitempty"`
	Sha256Gitoid string `json:"gitoid:sha256,omitempty"`
	Posix        *Posix `json:"posix,omitempty"`
}

type Envelope

type Envelope struct {
	Header  Header              `json:"header"`
	Mapping map[string]*Element `json:"mapping"`
}

type Factory

type Factory interface {
	Add(originalPath string) error
	Sha1ADGs() map[string]string
	Sha256ADGs() map[string]string
	Envelope() *Envelope
}

func NewTrail

func NewTrail(option ...Option) Factory

type Feature

type Feature struct {
	Algorithms []string `json:"algorithms,omitempty"`
}

type FilePlugin

type FilePlugin struct {
	AllowList []string
	// contains filtered or unexported fields
}

func (*FilePlugin) Add

func (plug *FilePlugin) Add(filePath string) error

func (*FilePlugin) SetAllowList

func (plug *FilePlugin) SetAllowList(allowList []string)

func (*FilePlugin) Sha1ADG

func (plug *FilePlugin) Sha1ADG(m map[string]string)

func (*FilePlugin) Sha256ADG

func (plug *FilePlugin) Sha256ADG(m map[string]string)

func (*FilePlugin) Store

func (plug *FilePlugin) Store(envelope *Envelope) error

type Header

type Header struct {
	Features map[string]Feature `json:"features"`
}

type Option

type Option func(o *Options)

type Options

type Options struct {
	Sha1Enabled   bool
	Sha256Enabled bool
}

type Plugin

type Plugin interface {
	Add(path string) error
	Store(envelope *Envelope) error
	Sha1ADG(map[string]string)
	Sha256ADG(map[string]string)
	SetAllowList([]string)
}

func NewDirectoryPlugin

func NewDirectoryPlugin() Plugin

func NewFilePlugin

func NewFilePlugin() Plugin

func NewPosixPlugin

func NewPosixPlugin() Plugin

type Posix

type Posix struct {
	ATime              string `json:"atime,omitempty"`
	CTime              string `json:"ctime,omitempty"`
	CreationTime       string `json:"creation_time,omitempty"`
	ExtendedAttributes string `json:"extended_attributes,omitempty"`
	FileDeviceID       string `json:"file_device_id,omitempty"`
	FileFlags          string `json:"file_flags,omitempty"`
	FileInode          string `json:"file_inode,omitempty"`
	FileSystemID       string `json:"file_system_id,omitempty"`
	FileType           string `json:"file_type,omitempty"`
	HardLinkCount      string `json:"hard_link_count,omitempty"`
	MTime              string `json:"mtime,omitempty"`
	MetadataCTime      string `json:"metadata_ctime,omitempty"`
	OwnerGID           string `json:"owner_gid,omitempty"`
	OwnerUID           string `json:"owner_uid,omitempty"`
	Permissions        string `json:"permissions,omitempty"`
	Size               string `json:"size,omitempty"`
}

type PosixPlugin

type PosixPlugin struct {
	AllowList []string
	// contains filtered or unexported fields
}

func (*PosixPlugin) Add

func (p *PosixPlugin) Add(path string) error

func (*PosixPlugin) SetAllowList

func (plug *PosixPlugin) SetAllowList(allowList []string)

func (*PosixPlugin) Sha1ADG

func (p *PosixPlugin) Sha1ADG(_ map[string]string)

func (*PosixPlugin) Sha256ADG

func (p *PosixPlugin) Sha256ADG(_ map[string]string)

func (*PosixPlugin) Store

func (p *PosixPlugin) Store(envelope *Envelope) error