sym

Sym

Can be used as an importable pkg or as a CLI.

Use as a CLI

go install github.com/fuskovic/sym/cmd/sym@latest

Examples

Generate a Key

// default key size is 16
sym keygen

// other valid sizes include 24, and 32
sym keygen --size 32

// output to a file
sym keygen -o key.txt

Encrypt a file

sym encrypt \
    -f key.txt \
    -i inputfile.txt \
    -o outputfile.enc

Encrypt a dir

sym encrypt \
    -f key.txt \
    -i testdir \
    -o encrypted_dir.enc

Decrypt a file

sym decrypt \
    -f key.txt \
    -i ciphertext.enc \
    -o plaintext.txt

Decrypt a dir

sym decrypt \
    -f key.txt \
    -i encrypted_dir.enc \
    -o decrypted_dir

Use as a library

go get -u github.com/fuskovic/sym

Examples

Generate a Key

    // use KeyGen if you want a specific size
    key, err := sym.KeyGen(32)
    if err != nil {
        // handle err
    }

    // or use MustKeyGen to generate a default size (16) key
    key := sym.MustKeyGen()

Use key from file

    key, err := sym.KeyFromFilePath("/path/to/my.key")
    if err != nil {
        // handle err
    }

Encrypt/Decrypt Strings

    key := sym.MustKeyGen()

    ciphertext, err := sym.EncryptString(key, "hello world")
    if err != nil {
        // handle error
    }

    plaintext, err := sym.DecryptString(key, ciphertext)
    if err != nil {
        // handle error
    }

Encrypt/Decrypt Files

    key := sym.MustKeyGen()

    err := sym.EncryptFile(key,
        "/path/to/existing/plaintext/file.txt",
        "/path/to/write/the/encrypted/file/to.enc",
    )

    if err != nil {
        // handle error
    }

    err = sym.DecryptFile(key,
        "/path/to/encrypted/file.enc",
        "/path/to/write/decrypted/file/to.txt",
    )

    if err != nil {
        // handle error
    }
    

Encrypt/Decrypt Dirs

    key := sym.MustKeyGen()

    err := sym.EncryptDir(key,
        "/path/to/existing/dir",
        "/path/to/write/encrypted/dir",
    )

    if err != nil {
        // handle error
    }

    err = sym.DecryptDir(key,
        "/path/to/encrypted/dir",
        "/path/to/write/decrypted/dir",
    )

    if err != nil {
        // handle error
    }