Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidafsilva/jvault
A Java "Vault" API for secure key-value pairs storage
https://github.com/davidafsilva/jvault
Last synced: about 2 months ago
JSON representation
A Java "Vault" API for secure key-value pairs storage
- Host: GitHub
- URL: https://github.com/davidafsilva/jvault
- Owner: davidafsilva
- Created: 2014-10-12T17:01:25.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-25T11:22:21.000Z (almost 10 years ago)
- Last Synced: 2024-10-08T18:01:46.814Z (3 months ago)
- Language: Java
- Size: 320 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
jVault [](https://codeship.com/projects/49190) [](https://coveralls.io/r/davidafsilva/jVault?branch=master)
=============
jVault is a secure key-value pairs storage.
The vault ciphers the entries value with AES (variant based on the specified key size) with a key
derived from a provided password (PBE) and salt. Padding is also added, if required.
Additionally, file based vaults provide integrity check by including a MAC (HMAC with SHA-256) in the file
Currently, these are the supported vault implementation:
- [In-Memory](https://github.com/davidafsilva/jVault/blob/master/src/main/java/pt/davidafsilva/jvault/vault/InMemoryVault.java)
- [File](https://github.com/davidafsilva/jVault/blob/master/src/main/java/pt/davidafsilva/jvault/vault/ByteFileVault.java)
- [XML](https://github.com/davidafsilva/jVault/blob/master/src/main/java/pt/davidafsilva/jvault/vault/XmlFileVault.java)
- [JSON](https://github.com/davidafsilva/jVault/blob/master/src/main/java/pt/davidafsilva/jvault/vault/JsonFileVault.java)
Usage:
------
#### 1. Use the VaultBuilder to initialize a in-memory secure vault
```java
final Vault vault = VaultBuilder.create()
.inMemory()
.password("PM6CduB3rAhcdEKN961NR0583620vHJM")
.salt("naoQ8qbq")
.iterations(32768)
.keySize(256)
.build();
```
#### 2. Use the VaultBuilder to initialize a (byte/raw) file based secure vault
```java
final Vault vault = VaultBuilder.create()
.rawFile(FileSystems.getDefault().getPath("vaults", "notes.vault"))
.password("PM6CduB3rAhcdEKN961NR0583620vHJM")
.salt("naoQ8qbq")
.iterations(32768)
.keySize(256)
.build();
```
#### 3. Use the VaultBuilder to initialize a XML based secure vault
```java
final Vault vault = VaultBuilder.create()
.xmlFile(FileSystems.getDefault().getPath("vaults", "notes.vault"))
.password("PM6CduB3rAhcdEKN961NR0583620vHJM")
.salt("naoQ8qbq")
.iterations(32768)
.keySize(256)
.build();
```
#### 4. Use the VaultBuilder to initialize a JSON based secure vault
```java
final Vault vault = VaultBuilder.create()
.jsonFile(FileSystems.getDefault().getPath("vaults", "notes.vault"))
.password("PM6CduB3rAhcdEKN961NR0583620vHJM")
.salt("naoQ8qbq")
.iterations(32768)
.keySize(256)
.build();
```
Key sizes:
------
Beware of the out-of-the-box restrictions that Java has regarding key sizes, the jurisdiction policy files shipped with the Java SE Development Kit allow "strong" but limited cryptography to be used.
For more information please visit the [JCA Docs](http://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#importlimits).
Logging:
------
Beware of logging in the current release, debug logging might expose sensitive data. As such,
debug level should only be used for it's purpose, debugging, development.
Copyright ©
---------
Copyright (C) 2014 David Silva
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the David Silva nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.