vinegar

README

vinegar

vinegar is a library for producing, Vigenere tables and encrypting/decrypting messages with them.

Plaintext messages have their spaces removed during encryption as the library uses the standard latin alphabet modified by a keyword (with duplicates removed). This means the decrypted message will also have no spaces but will match the plaintext input in all other ways.

package main

import (
    "fmt"
  
    "github.com/h5law/vinegar"
)

func main() {
    vig := vinegar.NewVigenere("kyrptos")
    cipher := vig.Encrypt("this is a secret hidden message", "neddih")
    plain := vig.Decrypt(cipher, "neddih")
    fmt.Println(cipher)                        // wzzjtqklunlzwzzqzzfpujuusv
    fmt.Println(plain)                         // thisisasecrethiddenmessage
    // Using the wrong key
    fmt.Println(vig.Decrypt(cipher, "hidden")) // cdisnyfrecsscdidhsxhesdrma
}

Documentation

Overview

Package vinegar provides a Vigenere table builder and encryption/decryption tools for encoding and decoding plaintext and its corresponding ciphertext.

Index

• type Vigenere
  • func NewVigenere(keyword string) Vigenere

Types

type Vigenere

type Vigenere interface {
	// Encrypt encrypts the given message using the keyword provided
	// according to the vigenere table of the Vigenere struct.
	Encrypt(message, keyword string) string
	// Decrypt decrypts the provided ciphertext using the keyword and
	// vigenere table from the struct - the resulting plaintext will have no spaces.
	Decrypt(cipher, keyword string) string
}

func NewVigenere

func NewVigenere(keyword string) Vigenere

NewVigenere produces a Vigenere Table using the given keyword. It first will format the keyword given by removing any duplicates and enforcing it to be 26 lowercasse latin characters. Once formatted the table is produced by shifting the alphabet 26 times maaking a 26x26 matrix of runes