aescrypt

README

aescrypt

Golang implementation of AES file encryption/decryption compatible with AES Crypt version 1 & 2

Installation

go get github.com/andreacioni/aescrypt

Example

package main

import (
    "fmt"
    "github.com/andreacioni/aescrypt"
)

func main() {
    aesCrypt := aescrypt.New("super_secret_password")

    if err := aesCrypt.Encrypt("plain_text_file.txt", "plain_text_file.txt.aes"); err != nil {
        fmt.Printf("Failed to encrypt the file: %v\n", err)
    }

    if err := aesCrypt.Decrypt("plain_text_file.txt.aes", "plain_text_file.txt"); err != nil {
        fmt.Printf("Failed to decrypt the file: %v\n", err)
    }
}

Made with by Andrea Cioni

Documentation

Overview

*

• BSD 3-Clause License *
• Copyright (c) 2018, Andrea Cioni All rights reserved. *
• Redistribution and use in source and binary forms, with or without
• modification, are permitted provided that the following conditions are met: *
• Redistributions of source code must retain the above copyright notice, this
• list of conditions and the following disclaimer. *
• Redistributions in binary form must reproduce the above copyright notice,
• this list of conditions and the following disclaimer in the documentation
• and/or other materials provided with the distribution. *
• Neither the name of the copyright holder nor the names of its contributors
• may be used to endorse or promote products derived from this software without
• specific prior written permission. *
• THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
• AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
• IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
• ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
• LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
• CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
• SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
• INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
• CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
• ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
• POSSIBILITY OF SUCH DAMAGE. *

Index

• Constants
• type AESCrypt
  • func New(key string) *AESCrypt
  • func NewV1(key string) *AESCrypt
  • func NewV2(key string) *AESCrypt
  • func NewVersion(ver AESVersion, key string) *AESCrypt
  • func (c *AESCrypt) Decrypt(fromPath, toPath string) error
  • func (c *AESCrypt) Encrypt(fromPath, toPath string) error
• type AESVersion

Constants

const (

	// AESCryptVersion1 -> version 1
	AESCryptVersion1 AESVersion = 0x01

	// AESCryptVersion2 -> version 2
	AESCryptVersion2 AESVersion = 0x02

	// BlockSizeBytes dimension (in bytes) of the block size
	BlockSizeBytes = 16

	//KeySizeBytes dimension (in bytes) of the key
	KeySizeBytes = 32

	// IVSizeBytes dimension (in bytes) of the IV
	IVSizeBytes = 16
)

Types

type AESCrypt

type AESCrypt struct {
	// contains filtered or unexported fields
}

AESCrypt struct old some information about an instance of an encrypter/decrypter

func New

func New(key string) *AESCrypt

New build an AESCrypt instance using default version = 2 (shorthand for: NewV2(key))

func NewV1

func NewV1(key string) *AESCrypt

NewV1 is a shorthand for NewVersion(AESCryptVersion1, key)

func NewV2

func NewV2(key string) *AESCrypt

NewV2 is a shorthand for NewVersion(AESCryptVersion2, key)

func NewVersion

func NewVersion(ver AESVersion, key string) *AESCrypt

NewVersion build an AESCrypt instance with specified version and key. Specified version doesn't matter on decryption (version will be read from the supplied input file)

func (*AESCrypt) Decrypt

func (c *AESCrypt) Decrypt(fromPath, toPath string) error

Decrypt decrypt the content of the file whose path is specified by 'fromPath' and save the result in the file whose path is specified by 'toPath'. If the output target file exist it will be overwritten.

func (*AESCrypt) Encrypt

func (c *AESCrypt) Encrypt(fromPath, toPath string) error

Encrypt crypt the content of the file whose path is specified by 'fromPath' and save the result in the file whose path is specified by 'toPath'. If the output target file exist it will be overwritten

type AESVersion

type AESVersion byte

AESVersion byte represents the version used by AESCrypt