varmor

package

v1.5.1 Latest Latest Go to latest Published: May 29, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/scode/saltybox

Links

Open Source Insights

Documentation ¶

Overview ¶

Package varmor provides versioned armoring for arbitrary sequences of bytes.

The armored form is free of whitespace (including newlines), safe to embed in URLs (other than possibly its length) and safe to pass unescaped in a POSIX shell.

Index ¶

func Unwrap(varmoredBody string) ([]byte, error)
func Wrap(body []byte) string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Unwrap ¶

func Unwrap(varmoredBody string) ([]byte, error)

Unwrap an armored string.

Errors conditions include:

The input is provably truncated.
Base64 decoding failure.
Input indicates a future version of of the format that we do not support.
Input does not appear to be the the result of Wrap().

func Wrap ¶

func Wrap(body []byte) string

Wrap an array of bytes in armor, returning the resulting string.

Types ¶

This section is empty.

Source Files ¶

View all Source files

varmor.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL