Skip to content

Commit 0b5439b

Browse files
committed
Add a more descriptive preface
1 parent 56d2ce8 commit 0b5439b

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

languages/go/goeql/goeql.go

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
package goeql
22

3-
// This package contains helpers to use with Go/Xorm to serialize/deserialize values
4-
// into the shape EQL and the CipherStash proxy needs to enable encryption/decryption.
3+
// goeql is a collection of helpers for serializing and deserializing values
4+
// into the shape EQL and the CipherStash Proxy needs to enable encryption and
5+
// decryption of values, and search of those encrypted values while keeping them
6+
// encrypted at all times.
57

68
// EQL expects a json format that looks like this:
9+
//
710
// '{"k":"pt","p":"a string representation of the plaintext that is being encrypted","i":{"t":"table","c":"column"},"v":1}'
11+
//
12+
// More documentation on this format can be found at https://github.com/cipherstash/encrypt-query-language#data-format
813

914
import (
1015
"encoding/json"

0 commit comments

Comments
 (0)