Categorygithub.com/minio/sio
modulepackage
0.4.1
Repository: https://github.com/minio/sio.git
Documentation: pkg.go.dev

# README

Godoc Reference Travis CI Go Report Card

Secure IO

Go implementation of the Data At Rest Encryption (DARE) format.

Introduction

It is a common problem to store data securely - especially on untrusted remote storage. One solution to this problem is cryptography. Before data is stored it is encrypted to ensure that the data is confidential. Unfortunately encrypting data is not enough to prevent more sophisticated attacks. Anyone who has access to the stored data can try to manipulate the data - even if the data is encrypted.

To prevent these kinds of attacks the data must be encrypted in a tamper-resistant way. This means an attacker should not be able to:

  • Read the stored data - this is achieved by modern encryption algorithms.
  • Modify the data by changing parts of the encrypted data.
  • Rearrange or reorder parts of the encrypted data.

Authenticated encryption schemes (AE) - like AES-GCM or ChaCha20-Poly1305 - encrypt and authenticate data. Any modification to the encrypted data (ciphertext) is detected while decrypting the data. But even an AE scheme alone is not sufficiently enough to prevent all kinds of data manipulation.

All modern AE schemes produce an authentication tag which is verified after the ciphertext is decrypted. If a large amount of data is decrypted it is not always possible to buffer all decrypted data until the authentication tag is verified. Returning unauthenticated data has the same issues like encrypting data without authentication.

Splitting the data into small chunks fixes the problem of deferred authentication checks but introduces a new one. The chunks can be reordered - e.g. exchanging chunk 1 and 2 - because every chunk is encrypted separately. Therefore the order of the chunks must be encoded somehow into the chunks itself to be able to detect rearranging any number of chunks.

This project specifies a format for en/decrypting an arbitrary data stream and gives some recommendations about how to use and implement data at rest encryption (DARE). Additionally this project provides a reference implementation in Go.

Applications

DARE is designed with simplicity and efficiency in mind. It combines modern AE schemes with a very simple reorder protection mechanism to build a tamper-resistant encryption scheme. DARE can be used to encrypt files, backups and even large object storage systems.

Its main properties are:

  • Security and high performance by relying on modern AEAD ciphers
  • Small overhead - encryption increases the amount of data by ~0.05%
  • Support for long data streams - up to 256 TB under the same key
  • Random access - arbitrary sequences / ranges can be decrypted independently

Install: go get -u github.com/minio/sio

DARE and github.com/minio/sio are finalized and can be used in production.

We also provide a CLI tool to en/decrypt arbitrary data streams directly from your command line:

Install ncrypt: go get -u github.com/minio/sio/cmd/ncrypt && ncrypt -h

Performance

Cipher8 KB64 KB512 KB1 MB
AES_256_GCM90 MB/s1.96 GB/s2.64 GB/s2.83 GB/s
CHACHA20_POLY130597 MB/s1.23 GB/s1.54 GB/s1.57 GB/s

On i7-6500U 2 x 2.5 GHz | Linux 4.10.0-32-generic | Go 1.8.3 | AES-NI & AVX2

# Packages

No description provided by the author

# Functions

Decrypt reads from src until it encounters an io.EOF and decrypts all received data.
DecryptBuffer decrypts all received data in src.
DecryptedSize computes the size of a decrypted data stream from the encrypted stream size.
DecryptReader wraps the given src and returns an io.Reader which decrypts all received data.
DecryptReaderAt wraps the given src and returns an io.ReaderAt which decrypts all received data.
DecryptWriter wraps the given dst and returns an io.WriteCloser which decrypts all data written to it.
Encrypt reads from src until it encounters an io.EOF and encrypts all received data.
EncryptedSize computes the size of an encrypted data stream from the plaintext size.
EncryptReader wraps the given src and returns an io.Reader which encrypts all received data.
EncryptWriter wraps the given dst and returns an io.WriteCloser which encrypts all data written to it.

# Constants

AES_256_GCM specifies the cipher suite AES-GCM with 256 bit keys.
CHACHA20_POLY1305 specifies the cipher suite ChaCha20Poly1305 with 256 bit keys.
Version10 specifies version 1.0.
Version20 specifies version 2.0.

# Structs

Config contains the format configuration.
Error is the error returned by an io.Reader or io.Writer if the encrypted data cannot be decrypted because it is malformed or not authentic.