README
¶
sqlprotector
A go package to add support for data at rest encryption to Golang's standard library database/sql.
Installation
In your Golang project, please run:
go get github.com/bartmika/sqlprotector
Documentation
All documentation can be found here.
Contributing
Found a bug? Want a feature to improve your developer experience? Please create an issue.
License
Made with ❤️ by Bartlomiej Mika.
The project is licensed under the ISC License.
Resource used:
- How We Encrypt Data in MySQL With Go By Baron Schwartz helped me understand the overall big picture with what is involved with setting up your own data at rest encryption with Golang.
- Built In Interfaces by Jason Moiron help understand how we utilize the
sql.Scanneranddriver.Valuerinterfaces inside the go packages database/sql to write our own custom functionality. - Securing Information in Database using Data Encryption (written in Go) by Purnaresa Yuliartanto help understand how to do encryption and decryption.
- go-cryptkeeper by Zach Auclair is a go package which implemented data at rest encryption utilizing the
sql.Scanneranddriver.Valuerinterfaces inside the go packages database/sql to write our own custom functionality.
Documentation
¶
Index ¶
- func GetSQLProtectorPassphrase() []byte
- func MarshalJSONNullString(ns sql.NullString) ([]byte, error)
- func SetSQLProtectorPassphrase(passphrase []byte) error
- func UnmarshalJSONNullString(data []byte) (sql.NullString, error)
- type NullString
- type ProtectBool
- type ProtectFloat64
- type ProtectInt64
- type ProtectInt8
- type ProtectNullString
- type ProtectString
- type ProtectUint64
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSQLProtectorPassphrase ¶
func GetSQLProtectorPassphrase() []byte
GetSQLProtectorPassphrase returns the password used for encryption.
func MarshalJSONNullString ¶
func MarshalJSONNullString(ns sql.NullString) ([]byte, error)
func SetSQLProtectorPassphrase ¶
SetSQLProtectorPassphrase sets the password to use for encryption.
func UnmarshalJSONNullString ¶
func UnmarshalJSONNullString(data []byte) (sql.NullString, error)
Types ¶
type NullString ¶
type NullString struct {
sql.NullString
}
Nullable String that overrides sql.NullString
type ProtectBool ¶
type ProtectBool struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext bool
}
ProtectBool represents the uint64 value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectBool) Scan ¶
func (ls *ProtectBool) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectFloat64 ¶
type ProtectFloat64 struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext float64
}
ProtectFloat64 represents the uint64 value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectFloat64) Scan ¶
func (ls *ProtectFloat64) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectInt64 ¶
type ProtectInt64 struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext int64
}
ProtectInt64 represents the int64 value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectInt64) Scan ¶
func (ls *ProtectInt64) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectInt8 ¶
type ProtectInt8 struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext int8
}
ProtectInt8 represents the int8 value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectInt8) Scan ¶
func (ls *ProtectInt8) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectNullString ¶
type ProtectNullString struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext sql.NullString
}
ProtectNullString represents the string value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectNullString) Scan ¶
func (ls *ProtectNullString) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectString ¶
type ProtectString struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext string
}
ProtectString represents the string value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectString) Scan ¶
func (ls *ProtectString) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
type ProtectUint64 ¶
type ProtectUint64 struct {
// Plaintext data in use when your application fetches the data from the database; in addition, plaintext data gets encrypted when saved to the database.
Plaintext uint64
}
ProtectUint64 represents the uint64 value that will get encrypted when the data is stored in the database and when we want to decrypt data from a database.
func (*ProtectUint64) Scan ¶
func (ls *ProtectUint64) Scan(value interface{}) error
Scan implements sql.Scanner interface from the database/sql package and decryptes incoming sql column data.
Source Files