goffx

README

goffx

goffx is a pure go implementation of Format-preserving, Feistel-based encryption (FFX) from https://github.com/emulbreh/pyffx.

Only support sha1 at present. It's no difficult to add other encryption algorithms.

Usage

package main

import (
    "fmt"

    "github.com/Me1onRind/goffx"
)

func main() {
    ie := goffx.Integer("secret-key", 4)
    fmt.Println(ie.Encrypt(1234)) // output 6103 <nil>
    fmt.Println(ie.Decrypt(6103)) // output 1234 <nil>

    se := goffx.String("secret-key", "abc", 6)
    fmt.Println(se.Encrypt("aaabbb")) // output "acbacc" <nil>
    fmt.Println(se.Decrypt("acbacc")) // output "aaabbb" <nil>
}

Documentation

Index

• Variables
• type FFX
  • func NewFFX(key string, rounds int) *FFX
• type IntegerCodecs
  • func Integer(ffx string, length int) *IntegerCodecs
  • func (i *IntegerCodecs) Decrypt(v int) (int, error)
  • func (i *IntegerCodecs) Encrypt(v int) (int, error)
• type StringCodecs
  • func String(ffx, alphabet string, length int) *StringCodecs
  • func (s *StringCodecs) Decrypt(v string) (string, error)
  • func (s *StringCodecs) Encrypt(v string) (string, error)

Variables

var (
	SequenceLengthNoMatch = errors.New("Sequence length is wrong")
	NonAlphabetCharacter  = errors.New("Non Alphabet Character")
)

Types

type FFX

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

func NewFFX

func NewFFX(key string, rounds int) *FFX

type IntegerCodecs

type IntegerCodecs struct {
	StringCodecs
}

func Integer

func Integer(ffx string, length int) *IntegerCodecs

func (*IntegerCodecs) Decrypt

func (i *IntegerCodecs) Decrypt(v int) (int, error)

func (*IntegerCodecs) Encrypt

func (i *IntegerCodecs) Encrypt(v int) (int, error)

type StringCodecs

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

func String

func String(ffx, alphabet string, length int) *StringCodecs

func (*StringCodecs) Decrypt

func (s *StringCodecs) Decrypt(v string) (string, error)

func (*StringCodecs) Encrypt

func (s *StringCodecs) Encrypt(v string) (string, error)