README
¶
Gophkeeper
Server
$ go build -o gophserver ./cmd/server
$ ./gophserver
Will output help information about server run configuration:
Environment variables:
DATABASE_DSN string
Database connection URL
PASSWORD_MIN_LENGTH uint
Password minimum length (default "0")
REST_ADDRESS string
Address that REST api listens on. (default ":16355")
REST_HOST_WHITELIST slice
(default "")
REST_USE_TLS bool
Use TLS or not (default "true")
TOKEN_LIFESPAN int64
JWT Token lifespan in milliseconds (default "15m")
TOKEN_SECRET string
Base64 encoded JWT Token secret
USERNAME_MIN_LENGTH uint
Username minimum length (default "0")
exit status 1
For a localhost set REST_USE_TLS to "false"
CLI
$ go build -o gophkeeper ./cmd/cli
$ ./gophkeeper -s "https://localhost:16355" help
Where https://localhost:16355 is the address that the server listens on
Note that, even though the client does not need to connect to the
server for a help, it will still require a value set to the -s flag,
thus the value can be any valid string if you only want to see the help.
$ ./gophkeeper -s none help
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
cli
Package cli provides command line interface to a gophkeeper via CLI.
|
Package cli provides command line interface to a gophkeeper via CLI. |
|
composed_read_closer
Package composedreadcloser provides ComposedReadCloser, which can be use to compbine an io.Reader and an io.Closer together in a single object.
|
Package composedreadcloser provides ComposedReadCloser, which can be use to compbine an io.Reader and an io.Closer together in a single object. |
|
deferred
Package deferred provides Deferred object, that can store a single deferred value.
|
Package deferred provides Deferred object, that can store a single deferred value. |
|
server
Package token provides everything needed for token creation.
|
Package token provides everything needed for token creation. |
|
server/encrypted
Package encrypted provides gophkeeper implementation that encrypts the data passed to it, and restores it.
|
Package encrypted provides gophkeeper implementation that encrypts the data passed to it, and restores it. |
|
server/encrypted/internal
Package encryption provides encryption utils.
|
Package encryption provides encryption utils. |
|
server/postgres
Package postgres provides gophkeeper implementation with postgresql database storage.
|
Package postgres provides gophkeeper implementation with postgresql database storage. |
|
server/rest
Package rest provides REST implementation of gophkeeper via Rest object.
|
Package rest provides REST implementation of gophkeeper via Rest object. |
|
server/rest/authentication
Package authentication provides authentication related middleware and functions.
|
Package authentication provides authentication related middleware and functions. |
|
server/rest/login
Package login provides REST endpoint to authenticate a user.
|
Package login provides REST endpoint to authenticate a user. |
|
server/rest/register
Package register provides REST endpoint to register a new user.
|
Package register provides REST endpoint to register a new user. |
|
server/rest/vault
Package vault provides REST entry for manipulating the vault of the authenticated user.
|
Package vault provides REST entry for manipulating the vault of the authenticated user. |
|
server/rest/vault/blob
Package blob provides REST endpoints to store and restore a file.
|
Package blob provides REST endpoints to store and restore a file. |
|
server/rest/vault/credential
Package credential provides authorization related middleware and function.
|
Package credential provides authorization related middleware and function. |
|
server/rest/vault/piece
Package piece provides REST endpoints to store and restore a piece.
|
Package piece provides REST endpoints to store and restore a piece. |
|
stack
Package stack provides Stack (LIFO structure) implementation.
|
Package stack provides Stack (LIFO structure) implementation. |
|
pkg
|
|
|
gophkeeper
Package gophkeeper contains core Gophkeeper types.
|
Package gophkeeper contains core Gophkeeper types. |
|
gophkeeper/rest
Package rest is a Gophkeeper implementation over HTTP.
|
Package rest is a Gophkeeper implementation over HTTP. |
|
gophkeeper/virtual
Package virtual contains virtual (in-memory) Gophkeeper implementation.
|
Package virtual contains virtual (in-memory) Gophkeeper implementation. |
Click to show internal directories.
Click to hide internal directories.