README
¶
simple-password-manager
Ever needed to have a simple key-value store with an encryption backend to handle your app passwords?
Look no further! This is a simple password manger (library) written in Go. You can use it with Go, REST calls and any other language that links with C.
And the best of it all: it's free - BSD licenced - just don't sue me if you loose your passwords (no pun intended, ha!)
Setup / Build
Go
go mod tidy automatically fetches the necessary dependencies when you add the import statement in your code (see also: Go's module support):
import "github.com/image357/password"
Alternatively, use go get in your project to prefetch all dependencies:
go get -u github.com/image357/password/...@latest
C/C++
You can use cmake to build and install the C interface libraries
mkdir build; cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/full/path/to/install/dir
cmake --build .
cmake --install .
Usage
Go
package main
import (
"fmt"
"github.com/image357/password"
"github.com/image357/password/log"
"github.com/image357/password/rest"
"log/slog"
)
func main() {
// create password with id
password.Overwrite("myid", "mypassword", "storage_key")
// get password with id
pwd, _ := password.Get("myid", "storage_key")
fmt.Println(pwd)
// start a multi password rest service on localhost:8080
rest.StartMultiService(
":8080", "/prefix", "storage_key",
func(string, string, string, string) bool { return true },
)
// make logging more verbose
log.Level(slog.LevelDebug)
}
C/C++:
#include <stdio.h>
#include <password/cinterface.h>
bool callback(cchar_t *token, cchar_t *ip, cchar_t *resource, cchar_t *id) {
return true;
}
int main() {
// create password with id
CPWD__Overwrite("myid", "mypassword", "storage_key");
// get password with id
char buffer[256];
CPWD__Get("myid", buffer, 256);
printf("%s\n", buffer);
// start a multi password service on localhost:8080
CPWD__StartMultiService(":8080", "/prefix", "storage_key", callback);
// make logging more verbose
CPWD__LogLevel(CPWD__LevelDebug);
return 0;
}
Example Service
There is an example rest service, which you can use for testing. Install it with:
go install github.com/image357/password/cmd/exampleservice@latest
Warning: do not use this service for production use-cases. It doesn't have any access control and the storage key hides in plain sight!
REST
When you have your rest server running (see above) you can make calls with, e.g., python
import requests
# create password with id
requests.put("http://localhost:8080/prefix/overwrite", json={"id": "myid", "password": "mypassword", "accessToken": "some_token"})
# get password with id
r = requests.get("http://localhost:8080/prefix/get", json={"id": "myid", "accessToken": "some_token"})
print(r.content)
# output: b'{"password":"mypassword"}'
Details
Storage
Files and folders - it's that simple.
Encryption
Yes, the usual - AES256, hashed secrets, etc. For more info have a look at the source code.
Create MSVC shared library
go build -buildmode=c-shared -o ./cinterface/cinterface.dll ./cinterface/cinterface.go
dumpbin /exports cinterface.dll
# then: manually create cinterface.def with EXPORTS heading
lib /DEF:cinterface.def /MACHINE:x64 /OUT:cinterface.lib
Tested with POSIX-Threads and UCRT for MinGW-w64.
Documentation
¶
Index ¶
- Variables
- func Check(id string, password string, key string) (bool, error)
- func Clean() error
- func Delete(id string) error
- func FilePath(id string) string
- func Get(id string, key string) (string, error)
- func GetFileEnding() string
- func GetStorePath() string
- func List() ([]string, error)
- func NormalizeId(path string) string
- func Overwrite(id string, password string, key string) error
- func Set(id string, oldPassword string, newPassword string, key string) error
- func SetFileEnding(e string)
- func SetStorePath(path string)
- func Unset(id string, password string, key string) error
Constants ¶
This section is empty.
Variables ¶
var StorageDirMode os.FileMode = 0700
StorageDirMode controls the directory permission set by this package.
var StorageFileMode os.FileMode = 0600
StorageFileMode controls the file permission set by this package.
Functions ¶
func Check ¶
Check an existing password for equality with the provided password. key is the encryption secret for storage.
func FilePath ¶
FilePath returns the storage filepath of a given password-id with system-specific path separators. It accepts system-unspecific or mixed id separators, i.e. forward- and backward-slashes are treated as the same character.
func GetFileEnding ¶
func GetFileEnding() string
GetFileEnding returns the current file ending of storage files.
func GetStorePath ¶
func GetStorePath() string
GetStorePath returns the current storage path with system-specific path separators.
func NormalizeId ¶
NormalizeId transforms path to lower case letters and normalizes the path separator
func Overwrite ¶
Overwrite an existing password or create a new one. key is the encryption secret for storage.
func Set ¶
Set an existing password-id or create a new one. oldPassword must match the currently stored password. key is the encryption secret for storage.
func SetFileEnding ¶
func SetFileEnding(e string)
SetFileEnding accepts a new file ending for storage files.
func SetStorePath ¶
func SetStorePath(path string)
SetStorePath accepts a new storage path with system-unspecific or mixed path separators.
Types ¶
This section is empty.
Source Files
Directories