# gorm-sqlite-cipher

**Repository Path**: cetofork/gorm-sqlite-cipher

## Basic Information

- **Project Name**: gorm-sqlite-cipher
- **Description**: SQLite driver for GORM supporting encryption
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-13
- **Last Updated**: 2025-03-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gorm-sqlite-cipher

[![GoDoc Reference](https://godoc.org/github.com/CovenantSQL/go-sqlite3-encrypt?status.svg)](https://pkg.go.dev/github.com/jackfr0st13/gorm-sqlite-cipher)
[![Go Report Card](https://goreportcard.com/badge/github.com/CovenantSQL/go-sqlite3-encrypt)](https://goreportcard.com/report/github.com/jackfr0st13/gorm-sqlite-cipher)

### Description

Go sqlite3 driver for [GORM](https://gorm.io/) with an AES-256 encrypted sqlite3 database
conforming to the built-in database/sql interface. It is based on:

- Go sqlite3 driver: https://github.com/mattn/go-sqlite3
- SQLite extension with AES-256 codec: https://github.com/sqlcipher/sqlcipher
- AES-256 implementation from: https://github.com/libtom/libtomcrypt
- GORM sqlite driver : https://github.com/go-gorm/sqlite

SQLite itself is part of SQLCipher.

### Installation

This package can be installed with the go get command:

    go get github.com/jackfr0st13/gorm-sqlite-cipher

## USAGE

```go
import (
  sqliteEncrypt "github.com/jackfr0st13/gorm-sqlite-cipher"
  "gorm.io/gorm"
)
key := "passphrase"
dbname := "go-sqlcipher.sqlite"
dbnameWithDSN := dbname + fmt.Sprintf("?_pragma_key=%s&_pragma_cipher_page_size=4096", key)
db, err := gorm.Open(sqliteEncrypt.Open(dbnameWithDSN), &gorm.Config{})
```

### License

The code of the originating packages is covered by their respective licenses.
See [LICENSE](LICENSE) file for details.