cipher

package

v0.63.0 Latest Latest Go to latest Published: Mar 17, 2024 License: MIT Imports: 5 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/rokath/trice

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cipher provides an encryption and decryption interface.

It abstracts from the used cipher algorithm

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Password is the key one needs to decrypt trice logs if encrypted
	Password string

	// ShowKey if set, allows to see the encryption passphrase
	ShowKey bool
)

local config values

Functions ¶

func Decrypt ¶ added in v0.24.1

func Decrypt(dst, src []byte) (c int)

Decrypt converts src into dst and returns count of converted bytes. Only multiple of 8 are convertable, so last 0-7 bytes are not convertable and c is a multiple of 8. The smaller byte slice limits the conversion.

func Decrypt8 ¶

func Decrypt8(b []byte) (d []byte)

Decrypt8 translates an encryption protected byte slice back in a slice of length 8.

Shorter slices are extended with 0 until length 8. Longer slices are truncated to length 8.

func Encrypt8 ¶

func Encrypt8(b []byte) (e []byte)

Encrypt8 translates a byte slice in a protected slice of length 8.

Shorter slices are extended with 0x16 until length 8. Longer slices are truncated to length 8.

func SetUp ¶

func SetUp(w io.Writer) error

SetUp uses the Password to create a cipher. If Password is "" encryption/decryption is disabled.

Types ¶

This section is empty.

Source Files ¶

View all Source files

cipher.go

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