avtool

README

avtool

NOTE: Original code written by @pbthorste for https://github.com/pbthorste/avtool

HUGE SHOUT OUT to @pbthorste

This module provides a reimplementation of ansible-vault encrypt and decprypt functionality in Go.

Why the fork?

As of writing the mainline has been stale for ~4 years.

I have found this code to be highly useful and important for writing other ansible-vault related tools. I wanted to modernize the work done previously to support go.mod while also updating the interface as an importable module for other code.

CLI Tool

Please see gwvault for a purpose built ansible-vault binary written in go.

It leverages the work done by @pbthorste for https://github.com/pbthorste/avtool while further fleshing out the CLI tool to be more in line with the original ansible-vault CLI tool.

Thanks and Attribution

Original code written by @pbthorste

Documentation

Index

• func Decrypt(data, password string) (result string, err error)
• func DecryptFile(filename, password string) (result string, err error)
• func Encrypt(body, password string) (result string, err error)
• func EncryptFile(filename, password string) (result string, err error)
• func GenerateRandomBytes(n int) ([]byte, error)

Functions

func Decrypt

func Decrypt(data, password string) (result string, err error)

Decrypt a string containing the ansible vault

func DecryptFile

func DecryptFile(filename, password string) (result string, err error)

func Encrypt

func Encrypt(body, password string) (result string, err error)

see https://github.com/ansible/ansible/blob/0b8011436dc7f842b78298848e298f2a57ee8d78/lib/ansible/parsing/vault/__init__.py#L710

func EncryptFile

func EncryptFile(filename, password string) (result string, err error)

func GenerateRandomBytes

func GenerateRandomBytes(n int) ([]byte, error)