decrypt

Documentation

Overview

Package decrypt is the external API other Go programs can use to decrypt SOPS files. It is the only package in SOPS with a stable API.

Index

• func Data(data []byte, format string) (cleartext []byte, err error)
• func DataWithFormat(data []byte, format Format) (cleartext []byte, err error)
• func File(path, format string) (cleartext []byte, err error)

Functions

func Data

func Data(data []byte, format string) (cleartext []byte, err error)

Data is a helper that takes encrypted data and a format string, decrypts the data and returns its cleartext in an []byte. The format string can be `json`, `yaml`, `ini`, `dotenv` or `binary`. If the format string is empty, binary format is assumed.

func DataWithFormat

func DataWithFormat(data []byte, format Format) (cleartext []byte, err error)

DataWithFormat is a helper that takes encrypted data, and a format enum value, decrypts the data and returns its cleartext in an []byte.

func File

func File(path, format string) (cleartext []byte, err error)

File is a wrapper around Data that reads a local encrypted file and returns its cleartext data in an []byte