gosum

README

Gosum

Self verification of golang lib.

Install cmd

go install github.com/xuender/gosum/cmd/gosum@latest

Examples

base

Check the integrity of the execution file to prevent tampering or virus intrusion.

package main

import (
	"fmt"

	"github.com/xuender/gosum"
)

func main() {
	if err := gosum.Check("secret_key"); err != nil {
		panic(err)
	}

	fmt.Println("Hello Word.")
	fmt.Println("This file integrity.")
}

go build -o helloword main.go
gosum -s=secret_key helloword

env

Check environment variables.

package main

import (
	"fmt"

	"github.com/xuender/gosum"
)

func main() {
	if err := gosum.CheckEnv("SECRET_KEY"); err != nil {
		panic(err)
	}

	fmt.Println("Hello Word.")
	fmt.Println("Run on safe environment.")
}

go build -o helloword main.go
SECRET_KEY=secret_key gosum -e=SECRET_KEY helloword
# set env and run
SECRET_KEY=secret_key ./helloword

machine

Only run on the sign machine.

package main

import (
	"fmt"

	"github.com/xuender/gosum"
)

func main() {
	if err := gosum.CheckMachine(); err != nil {
		panic(err)
	}

	fmt.Println("Hello Word.")
	fmt.Println("Run on sign machine.")
}

go build -o helloword main.go
# sign on the final running machine
gosum -m helloword

ps: CheckMachine must be signed, otherwise it cannot run after build.

Documentation

Index

• Constants
• Variables
• func Check(secret string) error
• func CheckEnv(env string) error
• func CheckFile(file, secret string) error
• func CheckMachine() error
• func GetMachineSecret() (string, error)
• type ContainsReader
  • func NewContainsReader(reader io.Reader, subslice []byte) *ContainsReader
  • func (p *ContainsReader) Contains() bool
  • func (p *ContainsReader) Read(data []byte) (n int, err error)
• type Sum
  • func NewSum(file string, secret []byte) *Sum
  • func (p *Sum) Check() error
  • func (p *Sum) Hash() ([]byte, error)
  • func (p *Sum) Sign() error

Constants

const (
	FileMode = 0o666
	DirMode  = 0o700
)

Variables

var (
	ErrSignFailed = errors.New("sign failed")
	ErrFileName   = errors.New("error file name")
	ErrSigned     = errors.New("file has been signed")
)

var (
	ModVersion = "(devel)"
	ModSum     = "00000000"
	ModPath    = ""
)

nolint

Functions

func Check

func Check(secret string) error

func CheckEnv

func CheckEnv(env string) error

func CheckFile

func CheckFile(file, secret string) error

func CheckMachine

func CheckMachine() error

func GetMachineSecret

func GetMachineSecret() (string, error)

Types

type ContainsReader

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

func NewContainsReader

func NewContainsReader(reader io.Reader, subslice []byte) *ContainsReader

func (*ContainsReader) Contains

func (p *ContainsReader) Contains() bool

func (*ContainsReader) Read

func (p *ContainsReader) Read(data []byte) (n int, err error)

type Sum

type Sum struct {
	Error    error
	HasGosum bool
	// contains filtered or unexported fields
}

func NewSum

func NewSum(file string, secret []byte) *Sum

func (*Sum) Check

func (p *Sum) Check() error

func (*Sum) Hash

func (p *Sum) Hash() ([]byte, error)

func (*Sum) Sign

func (p *Sum) Sign() error