Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rncryptor/rncryptor-go
Go implementation of RNCryptor
https://github.com/rncryptor/rncryptor-go
Last synced: about 2 months ago
JSON representation
Go implementation of RNCryptor
- Host: GitHub
- URL: https://github.com/rncryptor/rncryptor-go
- Owner: RNCryptor
- License: mit
- Created: 2014-12-11T23:38:40.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-23T06:28:25.000Z (over 7 years ago)
- Last Synced: 2024-08-21T12:49:50.067Z (4 months ago)
- Language: Go
- Homepage:
- Size: 184 KB
- Stars: 20
- Watchers: 6
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RNCryptor-go
============
Go implementation of [RNCryptor](http://rncryptor.github.io).
#### What is RNCryptor?
> RNCryptor is a data format specificiation for AES encryption, with AES-256, random-salted PBKDF2,
> AES-CBC, random IV, and HMAC. It has implementations in several languages.
You can head over to the [RNCryptor website](http://rncryptor.github.io) for more information,
or checkout the [GitHub Organization](https://github.com/RNCryptor) for implementations in other
languages.
## Installation
```sh
go get github.com/RNCryptor/RNCryptor-go
```
## Example
```go
package main
import(
"fmt"
"github.com/RNCryptor/RNCryptor-go"
)
func main() {
pass := "test"
data := []byte("hello world")
fmt.Printf("source: %v\n", string(data))
encrypted, _ := rncryptor.Encrypt(pass, data)
fmt.Printf("encrypted: %v\n", string(encrypted))
// if you need to send the encrypted data across
// the wire, you'll probably want to call
// `base64.StdEncoding.EncodeToString(encrypted)`
// to base64 the data rather than transmiting raw bytes
decrypted, _ := rncryptor.Decrypt(pass, encrypted)
fmt.Printf("decrypted: %v\n", string(decrypted))
}
```
## API
### Encrypt(password string, data []byte) ([]byte, error)
Encrypts `data` using `password`. Automatically handles salting, iv-generation, and hmac signing.
Returns the decrypted data, or an error, if encryption was unsuccessful.
- Password must be at least 1 character long.
```go
encrypted, err := rncryptor.Encrypt("securepassword", []byte("bytes to encrypt"))
if err != nil {
log.Printf("error encrypting data: %v", err)
}
// from here, you can encode `encrypted` however you want
// base64.StdEncoding.EncodeToString(encrypted)
```
### Decrypt(password string, data []byte) ([]byte, error)
Decrypts `data` using `password`. Returns un-encrypted data, or an error if decryption is
unsuccessful (e.g. password mismatch).
- Password must match the password used during encryption
```go
// if the encrypted data has been encoded, you'll need to decode it first
// base64.StdEncoding.DecodeString("base64data")
decrypted, err := rncryptor.Decrypt("securepassword", []byte("encrypted bytes"))
if err != nil {
log.Printf("error decrypting data: %v", err)
}
```
## Notes
If you'd like to help with any of the items below, send a pull-request!
- Only supports [version
3](https://github.com/RNCryptor/RNCryptor-Spec/blob/0625abe597e67af4a9a40f460a10bc069b7caf48/RNCryptor-Spec-v3.md)
of the RNCryptor spec.
- Only provides functions for password-based encryption, lacks function for [key-based
encryption](https://github.com/RNCryptor/RNCryptor-Spec/blob/0625abe597e67af4a9a40f460a10bc069b7caf48/RNCryptor-Spec-v3.md#key-based-encryption-abstract-language).
## Contributing
Please read over [GitHub's guide on
contributing](https://guides.github.com/activities/contributing-to-open-source/) if you'd like to
lend a hand!
## Credits
Thanks to [Rob Napier](http://robnapier.net) and the maintainers of the various
[RNCryptor implementations](https://github.com/RNCryptor) for all their hard work!