go-sqlcipher/README.md

95 lines
3.3 KiB
Markdown
Raw Normal View History

2015-04-01 17:48:28 +03:00
go-sqlcipher
2011-12-03 16:57:40 +04:00
==========
2015-04-06 18:57:05 +03:00
[![wercker status](https://app.wercker.com/status/644cebafbb8dc7be796f0d45578a9a12/m "wercker status")](https://app.wercker.com/project/bykey/644cebafbb8dc7be796f0d45578a9a12)
2011-12-03 16:57:40 +04:00
2015-04-01 17:49:37 +03:00
SQLCipher driver conforming to the built-in database/sql interface and using the latest sqlite3 code.
2015-04-01 17:48:28 +03:00
which is
`3.8.8.3 2015-02-25 13:29:11 9d6c1880fb75660bbabd693175579529785f8a6b`
Working with sqlcipher version which is
`3.8.6 2014-08-15 11:46:33 9491ba7d738528f168657adb43a198238abde19e`
It's wrapper with
* [go-sqlite3](https://github.com/mattn/go-sqlite3) sqlite3 driver for go that using database/sql.
* [SQLCipher](https://github.com/sqlcipher/sqlcipher) SQLCipher is an SQLite extension that provides 256 bit AES encryption of database files.
* Using [openssl](https://github.com/openssl/openssl) as the 256 bit AES encryption.
*Have't build test in a windows machine or linux machine*
**Working in my macbook-air**
```
Configured with: --prefix=/Applications/Xcode.app/Contents/Developer/usr --with-gxx-include-dir=/usr/include/c++/4.2.1
Apple LLVM version 6.0 (clang-600.0.56) (based on LLVM 3.5svn)
Target: x86_64-apple-darwin14.3.0
Thread model: posix
OpenSSL 0.9.8zd 8 Jan 2015
built on: Mar 9 2015
platform: darwin64-x86_64-llvm
options: bn(64,64) md2(int) rc4(ptr,char) des(idx,cisc,16,int) blowfish(idx)
compiler: -arch x86_64 -fmessage-length=0 -pipe -Wno-trigraphs -fpascal-strings -fasm-blocks -O3 -D_REENTRANT -DDSO_DLFCN -DHAVE_DLFCN_H -DL_ENDIAN -DMD32_REG_T=int -DOPENSSL_NO_IDEA -DOPENSSL_PIC -DOPENSSL_THREADS -DZLIB -mmacosx-version-min=10.6
OPENSSLDIR: "/System/Library/OpenSSL"
```
2011-12-03 16:57:40 +04:00
Installation
2012-03-29 07:46:32 +04:00
------------
2013-09-03 16:48:14 +04:00
This package can be installed with the go get command:
2012-07-09 03:45:22 +04:00
2015-04-01 17:48:28 +03:00
go get github.com/xeodou/go-sqlcipher
Documentation
-------------
2015-04-01 17:48:28 +03:00
API documentation can be found here: http://godoc.org/github.com/xeodou/go-sqlcipher
Examples can be found under the `./_example` directory
2012-03-29 07:48:11 +04:00
2013-02-13 13:27:35 +04:00
FAQ
---
2015-04-02 06:03:09 +03:00
The golang code is copy from [go-sqlite3](https://github.com/mattn/go-sqlite3)
2015-04-01 17:48:28 +03:00
If you have some issue, you can maybe you can find from https://github.com/mattn/go-sqlite3/issues
2015-04-01 17:51:38 +03:00
2015-04-01 17:48:28 +03:00
Here is some help from go-sqlite3 project.
2013-02-13 13:38:12 +04:00
* Can't build go-sqlite3 on windows 64bit.
2013-02-13 13:27:35 +04:00
2015-04-01 17:48:28 +03:00
> Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit.
2013-02-13 13:38:12 +04:00
> See: https://github.com/mattn/go-sqlite3/issues/27
2013-02-13 13:27:35 +04:00
2013-02-13 13:38:12 +04:00
* Getting insert error while query is opened.
2013-02-13 13:27:35 +04:00
2013-06-18 15:40:15 +04:00
> You can pass some arguments into the connection string, for example, a URI.
2013-02-13 13:38:12 +04:00
> See: https://github.com/mattn/go-sqlite3/issues/39
2013-02-13 13:27:35 +04:00
2014-11-14 13:49:22 +03:00
* Do you want cross compiling? mingw on Linux or Mac?
> See: https://github.com/mattn/go-sqlite3/issues/106
2014-11-14 13:50:39 +03:00
> See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html
2014-11-14 13:49:22 +03:00
2015-03-04 19:19:33 +03:00
* Want to get time.Time with current locale
Use `loc=auto` in SQLite3 filename schema like `file:foo.db?loc=auto`.
2015-04-01 17:48:28 +03:00
* Print some waring messages like `warning: 'RAND_add' is deprecated: first deprecated in OS X 10.7`
2015-04-01 17:52:22 +03:00
You can ignore these messages.
2015-04-01 17:48:28 +03:00
License
2011-12-03 16:57:40 +04:00
-------
2015-04-01 17:48:28 +03:00
MIT:
sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h
The -binding suffix was added to avoid build failures under gccgo.
2015-04-01 17:48:28 +03:00
In this repository, those files are amalgamation code that copied from SQLCipher. The license of those codes are depend on the license of SQLCipher.
Author
------
2015-04-01 17:48:28 +03:00
[xeodou](https://xeodou.me)