/Vault

A file system based secrets repository, powered by OpenPGP.

Primary LanguageC#MIT LicenseMIT

VAULT

Vault

A file system based secrets repository, powered by OpenPGP.

License


[ Getting Started | Installation | Development | Contributing | Credits | License | Author ]

For the past two decades, I have used various techniques to manage my confidential, personal information from flat files, encrypted volumes like TrueCrypt, BitLocker, to 3rd party tools like, KeePass, Boxcryptor and SafeInCloud. Each have their pros and cons.

Everybody has different ways they manage this and different needs.

So I decided, I will take a look at what I my requirements were and have listed them below

  • It should be file system based
  • Files should be encrypted at a file level
  • Files should be plain text, yet structured if needed to be
  • Files should have a version history
  • Use Open Source Tools

With these requirements in mind, I set out to searching for a the right tool and I came across pass. Pass fit my requirements to the T, with just one issue, it is a linux based tool.

I have nothing against linux, just that most of my primary systems are Windows & I don't want to install WSL or anything else to get this to work. Looking at the home page of pass, I noticed there are a few windows based tools for the same listed there.

Looking at how pass was designed and the simplicity of it, started me down a path to create something of my own.

Getting Started

To run this application locally, you can use the following guide.

  1. Clone this repository
    $ git clone https://github.com/mattseemon/vault
  2. Open solution src/Vault.sln in Visual Studio 2019
  3. Press F5 to run application in debug mode or Ctrl+F5 to run application normally.

Installation

Channel Release
Stable Stable Release
Pre Release Pre Release
  • Future application updates are installed directly from within the App.

Development

VAULT was developed using the below tools and technologies.

Libraries used

Library Version
Newtonsoft.Json 13.0.1
MahApps.Metro 2.4.5
MahApps.Metro.IconPacks.Material 4.8.0
Microsoft.Extensions.Hosting 5.0.0
Microsoft.Extensions.Logging 5.0.0
Microsoft.Extensions.Caching.Memory 5.0.0
Microsoft.Toolkit.Mvvm 7.0.2
Hardcodet.NotifyIcon.Wpf 1.1.0
Markdig.Wpf 0.5.0.1
Serilog 2.10.0
Serilog.Formatting.Compact 1.1.0
Serilog.Sinks.Async 1.4.0
Serilog.Sinks.File 4.1.0
Serilog.Extensions.Logging 3.0.1
Enterwell.Clients.Wpf.Notifications *
LiteDB 5.0.10
Portable.BouncyCastle 1.8.10

* Instead of using the published packages, either included the code as-is or a modified version of the same.

Contributing

If you want to contribute to the project, check out the wiki article here.

Credits

License

The source code in this repository is covered under the MIT License listed here. Feel free to use this in your own projects with attribution!

Copyright (c) 2021 Matt Seemon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Matt Seemon

Built with Matt Seemon in Goa, India.

Open Source  You didn't ask for this  Powered By Responsibility