Vault - a secure value storage (data-at-rest) implementation for Go.
VaultStore is specifically designed as a data store component for securely storing and retrieving secrets. It is not an API or a complete secrets management system. Features such as user management, access control, and API endpoints are intentionally beyond the scope of this project.
VaultStore is meant to be integrated into your application as a library, providing the data storage layer for your secrets management needs. The application using VaultStore is responsible for implementing any additional layers such as API endpoints, user management, or access control if needed.
- Overview - General overview of the VaultStore library
- Usage Guide - Examples of how to use VaultStore
- Technical Reference - Detailed technical information
- Query Interface - Documentation for the flexible query interface
- Data Stores - Information about the data store implementation
- Secure storage of sensitive data
- Token-based access to secrets
- Password protection for stored values
- Flexible query interface for retrieving records
- Soft delete functionality for data recovery
- Support for multiple database backends
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). You can find a copy of the license at https://www.gnu.org/licenses/agpl-3.0.en.html
For commercial use, please use my contact page to obtain a commercial license.
go get -u github.com/gouniverse/valuestore
For database schema, record structure, and other technical information, please see the Technical Reference.
vault, err := NewStore(NewStoreOptions{
VaultTableName: "my_vault",
DB: databaseInstance,
AutomigrateEnabled: true,
})Here are some basic examples of using VaultStore. For comprehensive documentation, see the Usage Guide.
// Create a token
token, err := vault.TokenCreate("my_value", "my_password", 20)
// Check if a token exists
exists, err := vault.TokenExists(token)
// Read a value using a token
value, err := vault.TokenRead(token, "my_password")
// Update a token's value
err := vault.TokenUpdate(token, "new_value", "my_password")
// Hard delete a token
err := vault.TokenDelete(token)
// Soft delete a token
err := vault.TokenSoftDelete(token)Click any of the buttons below to start a new development environment to contribute to the codebase without having to install anything on your machine:
For a detailed version history and changes, please see the Changelog.