README.md in crypt_keeper-0.4.2 vs README.md in crypt_keeper-0.5.0
- old
+ new
@@ -13,11 +13,11 @@
3. Provides a `decrypt` method that returns the plaintext
Note: Any options defined using `crypt_keeper` will be passed to `new` as a
hash.
-You can see an AES example [here](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/aes.rb).
+You can see an AES example [here](/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/provider/aes.rb).
## Why?
The options available were either too complicated under the hood or had weird
edge cases that made the library hard to use. I wanted to write something
@@ -48,22 +48,24 @@
update the content without going through the current encryptor.
## Creating your own encryptor
Creating your own encryptor is easy. All you have to do is create a class
-under the `CryptKeeperProviders` namespace, like this:
+under the `CryptKeeper::Provider` namespace, like this:
```ruby
-module CryptKeeperProviders
- class MyEncryptor
- def initialize(options = {})
- end
+module CryptKeeper
+ module Provider
+ class MyEncryptor
+ def initialize(options = {})
+ end
- def encrypt(value)
- end
+ def encrypt(value)
+ end
- def decrypt(value)
+ def decrypt(value)
+ end
end
end
end
```
@@ -79,22 +81,24 @@
## Available Encryptors
There are two included encryptors.
-* [AES](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/aes.rb)
+* [AES](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/provider/aes.rb)
* Encryption is peformed using AES-256 via OpenSSL.
-* [MySQL AES](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/mysql_aes.rb)
+* [MySQL AES](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/provider/mysql_aes.rb)
* Encryption is peformed MySQL's native AES functions.
+ * ActiveRecord logs are [automatically](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/log_subscriber/mysql_aes.rb)
+ filtered for you to protect senitive data from being logged.
-* [PostgreSQL PGP](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/postgres_pgp.rb).
+* [PostgreSQL PGP](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/provider/postgres_pgp.rb).
* Encryption is performed using PostgresSQL's native [PGP functions](http://www.postgresql.org/docs/9.1/static/pgcrypto.html).
* It requires the `pgcrypto` PostgresSQL extension:
`CREATE EXTENSION IF NOT EXISTS pgcrypto`
- * ActiveRecord logs are [automatically](https://github.com/jmazzi/crypt_keeper_providers/blob/master/lib/crypt_keeper_providers/postgres_pgp/log_subscriber.rb)
+ * ActiveRecord logs are [automatically](https://github.com/jmazzi/crypt_keeper/blob/master/lib/crypt_keeper/log_subscriber/postgres_pgp.rb)
filtered for you to protect senitive data from being logged.
## Requirements
CryptKeeper has been tested against ActiveRecord 3.0, 3.1, and 3.2 using ruby