sdk

Documentation

Index

• Constants
• func LoadMasterKeyFromExchange(masterkey *files.MasterKey, fingerprint [20]byte) error
• func LoadMasterKeyFromReader(masterkey *files.MasterKey, reader io.Reader) error
• func LoadPubkeysFromExchange(masterkey *files.MasterKey, fingerprint [20]byte) (openpgp.EntityList, error)
• func RedactRepo(masterkey *files.MasterKey) error
• func RemoveGitSettings(cb func(string)) error
• func SaveGitSettings(argv0 string, cb func(string)) error
• func SaveMasterExchange(masterkey *files.MasterKey, key *openpgp.Entity) error
• func SavePubkeyExchange(masterkey *files.MasterKey, key *openpgp.Entity) error
• func TouchFile(filesystem afero.Fs, fullpath string) error
• func TouchUp(masterkey *files.MasterKey, softErrHandler func(string, error)) error
• func TouchUpFiles(masterkey *files.MasterKey, files []string, softErrHandler func(string, error)) error
• func UpdateMasterExchangeKeys(masterkey *files.MasterKey) (int, error)

Constants

const (
	// AttrName defines name used in .gitattribute file's attribute
	// like: `*.key filter=AttrName diff=AttrName`
	AttrName = "redact"
)

Functions

func LoadMasterKeyFromExchange

func LoadMasterKeyFromExchange(masterkey *files.MasterKey, fingerprint [20]byte) error

LoadMasterKeyFromExchange loads data from an encrypted master key into provided object, and then saves it.

func LoadMasterKeyFromReader

func LoadMasterKeyFromReader(masterkey *files.MasterKey, reader io.Reader) error

LoadMasterKeyFromReader reads master key from an io.Reader, and saves it into its place.

func LoadPubkeysFromExchange

func LoadPubkeysFromExchange(masterkey *files.MasterKey, fingerprint [20]byte) (openpgp.EntityList, error)

LoadPubkeysFromExchange loads a public key from key exchange

func RedactRepo

func RedactRepo(masterkey *files.MasterKey) error

RedactRepo returns the loaded master key if it is unlocked. Otherwise, it returns appropriate error:

- not a git repository: if git repository cannot be detected - detecting top level directory: ...: if git rev-parse command returns with failure - repository is not using redact: when there're no key exchange dir in the repo - repository is locked: when there is an exchange dir

func RemoveGitSettings

func RemoveGitSettings(cb func(string)) error

RemoveGitSettings removes filter / diff settings from git repository config

func SaveGitSettings

func SaveGitSettings(argv0 string, cb func(string)) error

SaveGitSettings sets filter / diff settings into git repository config

func SaveMasterExchange

func SaveMasterExchange(masterkey *files.MasterKey, key *openpgp.Entity) error

SaveMasterExchange saves master key into key exchange, encrypted with OpenPGP key

func SavePubkeyExchange

func SavePubkeyExchange(masterkey *files.MasterKey, key *openpgp.Entity) error

SavePubkeyExchange saves public OpenPGP key into key exchange

func TouchFile

func TouchFile(filesystem afero.Fs, fullpath string) error

TouchFile touches a single file

func TouchUp

func TouchUp(masterkey *files.MasterKey, softErrHandler func(string, error)) error

TouchUp touches and checks out encrypted files, generally fixing them.

func TouchUpFiles

func TouchUpFiles(masterkey *files.MasterKey, files []string, softErrHandler func(string, error)) error

TouchUpFiles force-checkouts specific files in a repo

func UpdateMasterExchangeKeys

func UpdateMasterExchangeKeys(masterkey *files.MasterKey) (int, error)

UpdateMasterExchangeKeys updates all key exchange master keys with new data