Index

Modules: nimvault, nimvault/age, nimvault/cli, nimvault/commands, nimvault/crypto, nimvault/gpg, nimvault/manifest.

API symbols

add:

• commands: proc add(repo, path: string; cfg: GpgConfig; noGitignore = false)

addDir:

• commands: proc addDir(repo, dirPath: string; cfg: GpgConfig; noGitignore = false)

addDirReport:

• commands: proc addDirReport(repo, dirPath: string; cfg: GpgConfig; noGitignore = false): string

addReport:

• commands: proc addReport(repo, path: string; cfg: GpgConfig; noGitignore = false): string

ageBinary:

• age: proc ageBinary(): string

ageDecrypt:

• age: proc ageDecrypt(cfg: GpgConfig; inPath, outPath: string)

ageDecryptToString:

• age: proc ageDecryptToString(cfg: GpgConfig; inPath: string): string

ageEncrypt:

• age: proc ageEncrypt(cfg: GpgConfig; inPath, outPath: string)

ageIdentityPath:

• age: proc ageIdentityPath(cfg: GpgConfig): string

blobExt:

• crypto: proc blobExt(cfg: GpgConfig): string

blobPath:

• crypto: proc blobPath(repo: string; cfg: GpgConfig; id: string): string

decryptFile:

• crypto: proc decryptFile(cfg: GpgConfig; inPath, outPath: string; verifySig = false)

decryptProcess:

• crypto: proc decryptProcess(cfg: GpgConfig; inPath, outPath: string): Process

decryptToString:

• crypto: proc decryptToString(cfg: GpgConfig; inPath: string; verifySig = false): string

effectiveSigner:

• crypto: proc effectiveSigner(cfg: GpgConfig): string

ekDir:

• manifest: EntryKind.ekDir

ekFile:

• manifest: EntryKind.ekFile

encryptFile:

• crypto: proc encryptFile(cfg: GpgConfig; inPath, outPath: string)

encryptProcess:

• crypto: proc encryptProcess(cfg: GpgConfig; inPath, outPath: string): Process

EntryKind:

• manifest: enum EntryKind

expandHome:

• manifest: proc expandHome(p: string): string

findBlob:

• crypto: proc findBlob(repo: string; cfg: GpgConfig; id: string): string

findManifest:

• crypto: proc findManifest(repo: string; cfg: GpgConfig): string

genId:

• manifest: proc genId(): string

get:

• commands: proc get(repo, path: string; cfg: GpgConfig; allowUnsigned = false): string

GpgConfig:

• gpg: object GpgConfig

gpgDecrypt:

• gpg: proc gpgDecrypt(inPath, outPath: string; verifySig = false)

gpgDecryptToString:

• gpg: proc gpgDecryptToString(inPath: string; verifySig = false): string

gpgEncrypt:

• gpg: proc gpgEncrypt(cfg: GpgConfig; inPath, outPath: string)

gpgParallelism:

• gpg: proc gpgParallelism(): int

initGpgConfig:

• gpg: proc initGpgConfig(cliRecipient: string; repo: string): GpgConfig

isPathSafe:

• manifest: proc isPathSafe(cfg: GpgConfig; manifestPath: string): bool

list:

• commands: proc list(repo: string; cfg: GpgConfig)

listReport:

• commands: proc listReport(repo: string; cfg: GpgConfig): string

loadManifest:

• manifest: proc loadManifest(repo: string; verifySig = false; cfg = GpgConfig()): seq[VaultEntry]

main:

• cli: proc main(args: seq[string] = commandLineParams())

manifestPath:

• crypto: proc manifestPath(repo: string; cfg: GpgConfig): string

move:

• commands: proc move(repo, oldPath, newPath: string; cfg: GpgConfig)

moveReport:

• commands: proc moveReport(repo, oldPath, newPath: string; cfg: GpgConfig): string

NimvaultError:

• gpg: object NimvaultError

nvQuiet:

• gpg: var nvQuiet

nvRaise:

• gpg: proc nvRaise(msg: string)

remove:

• commands: proc remove(repo, path: string; cfg: GpgConfig)

removeReport:

• commands: proc removeReport(repo, path: string; cfg: GpgConfig): string

resolvePath:

• manifest: proc resolvePath(cfg: GpgConfig; path: string): string

resolveRecipient:

• gpg: proc resolveRecipient(cli, env, configRecipient: string): string

saveManifest:

• manifest: proc saveManifest(repo: string; entries: seq[VaultEntry]; cfg: GpgConfig)

scan:

• commands: proc scan(repo: string; target: string; cfg: GpgConfig)

scanReport:

• commands: proc scanReport(repo, target: string; cfg: GpgConfig): string

seal:

• commands: proc seal(repo: string; cfg: GpgConfig)

sealReport:

• commands: proc sealReport(repo: string; cfg: GpgConfig): string

sha256sum:

• gpg: proc sha256sum(path: string): string

sha256sumBytes:

• gpg: proc sha256sumBytes(data: string): string

signaturesInBand:

• crypto: proc signaturesInBand(cfg: GpgConfig): bool

signManifest:

• crypto: proc signManifest(cfg: GpgConfig; path: string)

sshSign:

• age: proc sshSign(cfg: GpgConfig; path: string)

sshVerify:

• age: proc sshVerify(cfg: GpgConfig; path: string)

status:

• commands: proc status(repo: string; cfg: GpgConfig)

statusReport:

• commands: proc statusReport(repo: string; cfg: GpgConfig): string

storePath:

• manifest: proc storePath(cfg: GpgConfig; absPath: string; repo: string): string

unseal:

• commands: proc unseal(repo: string; cfg: GpgConfig; allowUnsigned = false; only: seq[string] = @[])

unsealReport:

• commands: proc unsealReport(repo: string; cfg: GpgConfig; allowUnsigned = false; only: seq[string] = @[]): string

usesAge:

• crypto: proc usesAge(cfg: GpgConfig): bool

VaultConfigFile:

• gpg: tuple VaultConfigFile

vaultDir:

• manifest: proc vaultDir(repo: string): string

VaultEntry:

• manifest: tuple VaultEntry

verifyManifest:

• crypto: proc verifyManifest(cfg: GpgConfig; path: string; requireSig: bool)

Version:

• cli: const Version