utils

Documentation

Overview

Package utils collects various services: simple operations, compression, etc.

Index

• Variables
• func CompressFile(source *os.File) error
• func LoadConfig(filename string, config *ConfigStructure) error
• func SaveConfig(filename string, config *ConfigStructure) error
• func StrMapSortedKeys(m map[string]string) []string
• func StrMapsEqual(m1, m2 map[string]string) bool
• func StrSliceDeduplicate(s []string) []string
• func StrSliceHasItem(s []string, item string) bool
• func StrSlicesEqual(s1, s2 []string) bool
• func StrSlicesSubstract(l, r []string) []string
• func StringsIsSubset(subset, full []string, errorFmt string) error
• type ChecksumInfo
  • func ChecksumsForFile(path string) (ChecksumInfo, error)
• type ChecksumWriter
  • func NewChecksumWriter() *ChecksumWriter
  • func (c *ChecksumWriter) Sum() ChecksumInfo
  • func (c *ChecksumWriter) Write(p []byte) (n int, err error)
• type ConfigStructure
• type GpgSigner
  • func (g *GpgSigner) ClearSign(source string, destination string) error
  • func (g *GpgSigner) DetachedSign(source string, destination string) error
  • func (g *GpgSigner) Init() error
  • func (g *GpgSigner) SetKey(keyRef string)
  • func (g *GpgSigner) SetKeyRing(keyring, secretKeyring string)
• type GpgVerifier
  • func (g *GpgVerifier) AddKeyring(keyring string)
  • func (g *GpgVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)
  • func (g *GpgVerifier) InitKeyring() error
  • func (g *GpgVerifier) VerifyClearsigned(clearsigned io.Reader) error
  • func (g *GpgVerifier) VerifyDetachedSignature(signature, cleartext io.Reader) error
• type Signer
• type Verifier

Variables

var Config = ConfigStructure{
	RootDir:                filepath.Join(os.Getenv("HOME"), ".aptly"),
	DownloadConcurrency:    4,
	Architectures:          []string{},
	DepFollowSuggests:      false,
	DepFollowRecommends:    false,
	DepFollowAllVariants:   false,
	DepFollowSource:        false,
	GpgDisableSign:         false,
	GpgDisableVerify:       false,
	DownloadSourcePackages: false,
	PpaDistributorID:       "ubuntu",
	PpaCodename:            "",
}

Config is configuration for aptly, shared by all modules

Functions

func CompressFile

func CompressFile(source *os.File) error

CompressFile compresses file specified by source to .gz & .bz2

It uses internal gzip and external bzip2, see: https://code.google.com/p/go/issues/detail?id=4828

func LoadConfig

func LoadConfig(filename string, config *ConfigStructure) error

LoadConfig loads configuration from json file

func SaveConfig

func SaveConfig(filename string, config *ConfigStructure) error

SaveConfig write configuration to json file

func StrMapSortedKeys

func StrMapSortedKeys(m map[string]string) []string

StrMapSortedKeys returns keys of map[string]string sorted

func StrMapsEqual

func StrMapsEqual(m1, m2 map[string]string) bool

StrMapsEqual compares two map[string]string

func StrSliceDeduplicate

func StrSliceDeduplicate(s []string) []string

StrSliceDeduplicate removes dups in slice

func StrSliceHasItem

func StrSliceHasItem(s []string, item string) bool

StrSliceHasItem checks item for presence in slice

func StrSlicesEqual

func StrSlicesEqual(s1, s2 []string) bool

StrSlicesEqual compares two slices for equality

func StrSlicesSubstract

func StrSlicesSubstract(l, r []string) []string

StrSlicesSubstract finds all the strings which are in l but not in r, both slices shoult be sorted

func StringsIsSubset

func StringsIsSubset(subset, full []string, errorFmt string) error

StringsIsSubset checks that subset is strict subset of full, and returns error formatted with errorFmt otherwise

Types

type ChecksumInfo

type ChecksumInfo struct {
	Size   int64
	MD5    string
	SHA1   string
	SHA256 string
}

ChecksumInfo represents checksums for a single file

func ChecksumsForFile

func ChecksumsForFile(path string) (ChecksumInfo, error)

ChecksumsForFile generates size, MD5, SHA1 & SHA256 checksums for given file

type ChecksumWriter

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

ChecksumWriter is a writer that does checksum calculation on the fly passing data to real writer

func NewChecksumWriter

func NewChecksumWriter() *ChecksumWriter

NewChecksumWriter creates checksum calculator for given writer w

func (*ChecksumWriter) Sum

func (c *ChecksumWriter) Sum() ChecksumInfo

Sum returns caculated ChecksumInfo

func (*ChecksumWriter) Write

func (c *ChecksumWriter) Write(p []byte) (n int, err error)

Write implememnts pass-through writing with checksum calculation on the fly

type ConfigStructure

type ConfigStructure struct {
	RootDir                string   `json:"rootDir"`
	DownloadConcurrency    int      `json:"downloadConcurrency"`
	Architectures          []string `json:"architectures"`
	DepFollowSuggests      bool     `json:"dependencyFollowSuggests"`
	DepFollowRecommends    bool     `json:"dependencyFollowRecommends"`
	DepFollowAllVariants   bool     `json:"dependencyFollowAllVariants"`
	DepFollowSource        bool     `json:"dependencyFollowSource"`
	GpgDisableSign         bool     `json:"gpgDisableSign"`
	GpgDisableVerify       bool     `json:"gpgDisableVerify"`
	DownloadSourcePackages bool     `json:"downloadSourcePackages"`
	PpaDistributorID       string   `json:"ppaDistributorID"`
	PpaCodename            string   `json:"ppaCodename"`
}

ConfigStructure is structure of main configuration

type GpgSigner

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

GpgSigner is implementation of Signer interface using gpg

func (*GpgSigner) ClearSign

func (g *GpgSigner) ClearSign(source string, destination string) error

ClearSign clear-signs the file

func (*GpgSigner) DetachedSign

func (g *GpgSigner) DetachedSign(source string, destination string) error

DetachedSign signs file with detached signature in ASCII format

func (*GpgSigner) Init

func (g *GpgSigner) Init() error

Init verifies availability of gpg & presence of keys

func (*GpgSigner) SetKey

func (g *GpgSigner) SetKey(keyRef string)

SetKey sets key ID to use when signing files

func (*GpgSigner) SetKeyRing

func (g *GpgSigner) SetKeyRing(keyring, secretKeyring string)

SetKeyRing allows to set custom keyring and secretkeyring

type GpgVerifier

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

GpgVerifier is implementation of Verifier interface using gpgv

func (*GpgVerifier) AddKeyring

func (g *GpgVerifier) AddKeyring(keyring string)

AddKeyring adds custom keyring to GPG parameters

func (*GpgVerifier) ExtractClearsigned

func (g *GpgVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)

ExtractClearsigned extracts cleartext from clearsigned file WITHOUT signature verification

func (*GpgVerifier) InitKeyring

func (g *GpgVerifier) InitKeyring() error

InitKeyring verifies that gpg is installed and some keys are trusted

func (*GpgVerifier) VerifyClearsigned

func (g *GpgVerifier) VerifyClearsigned(clearsigned io.Reader) error

VerifyClearsigned verifies clearsigned file using gpgv

func (*GpgVerifier) VerifyDetachedSignature

func (g *GpgVerifier) VerifyDetachedSignature(signature, cleartext io.Reader) error

VerifyDetachedSignature verifies combination of signature and cleartext using gpgv

type Signer

type Signer interface {
	Init() error
	SetKey(keyRef string)
	SetKeyRing(keyring, secretKeyring string)
	DetachedSign(source string, destination string) error
	ClearSign(source string, destination string) error
}

Signer interface describes facility implementing signing of files

type Verifier

type Verifier interface {
	InitKeyring() error
	AddKeyring(keyring string)
	VerifyDetachedSignature(signature, cleartext io.Reader) error
	VerifyClearsigned(clearsigned io.Reader) error
	ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)
}

Verifier interface describes signature verification factility