add GPL headers

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/workflows/ci.yaml

@@ -5,7 +5,7 @@ jobs:
     strategy:
       matrix:
         version: [1.21]
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest]
     name: Build
     runs-on: ${{ matrix.os }}
     steps:

.github/workflows/pushimage.yaml

@@ -12,7 +12,7 @@ jobs:
       packages: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Log in to the Container registry
         uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567

.gitignore

@@ -3,3 +3,4 @@ anydb
 *.db
 coverage.out
 *.json
+releases

Dockerfile

@@ -1,4 +1,20 @@
-FROM golang:1.21-alpine as builder
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
+FROM golang:1.22-alpine as builder
 
 RUN apk update
 RUN apk upgrade

Makefile

@@ -43,12 +43,12 @@ ifdef HAVE_POD
 	echo "var manpage = \`" >> cmd/$*.go
 	pod2text $*.pod >> cmd/$*.go
 	echo "\`" >> cmd/$*.go
-
-	echo "var usage = \`" >> cmd/$*.go
-	awk '/SYNOPS/{f=1;next} /DESCR/{f=0} f' $*.pod  | sed 's/^    //' >> cmd/$*.go
-	echo "\`" >> cmd/$*.go
 endif
 
+# echo "var usage = \`" >> cmd/$*.go
+# awk '/SYNOPS/{f=1;next} /DESCR/{f=0} f' $*.pod  | sed 's/^    //' >> cmd/$*.go
+# echo "\`" >> cmd/$*.go
+
 buildlocal:
 	go build -ldflags "-X 'github.com/tlinden/anydb/cfg.VERSION=$(VERSION)'"
 

README.md

@@ -15,7 +15,17 @@ reasons:
   anymore. The badger file format on the other hand changes very
   often, which is not good for a tool intended to be used for many
   years.
-- more features
+- more features:
+  - output table in list mode uses TAB separator
+  - better STDIN + pipe support
+  - supports JSON output
+  - supports more verbose tabular output
+  - filtering using regular expressions
+  - tagging
+  - filtering using tags
+  - encryption of entries
+  - templates for custom output for maximum flexibility
+  - includes a tiny web server, which serves a restful API
 
 **anydb** can do all the things you can do with skate:
 
@@ -67,8 +77,8 @@ anydb list '[a-z]+\d'
 anydb list -o wide
 KEY     TAGS            SIZE    AGE             VALUE 
 blah    important       4 B     7 seconds ago   haha 
-foo                     3 B     15 seconds ago  bar  
-猫咪                    3 B     3 seconds ago   喵   
+foo                     3 B     15 seconds ago  bar
+猫咪                    3 B     3 seconds ago   喵
 
 # there are shortcuts as well
 anydb ls -l
@@ -83,6 +93,38 @@ anydb export -o backup.json
 # and import it somewhere else
 anydb import -r backup.json
 
+# you can encrypt entries. anydb asks for a passphrase
+# and will do the same when you retrieve the key using the
+# get command.
+anydb set mypassword -e
+
+# using template output mode you can freely design how to print stuff
+# here, we print the values in CSV format ONLY if they have some tag
+anydb ls -m template -T "{{ if .Tags }}{{ .Key }},{{ .Value }},{{ .Created}}{{ end }}"
+
+# or, to simulate skate's -k or -v
+anydb ls -m template -T "{{ .Key }}"
+anydb ls -m template -T "{{ .Value }}"
+
+# maybe you want to digest the item in a shell script? also
+# note, that both the list and get commands support templates
+eval $(anydb get foo -m template -T "key='{{ .Key }}' value='{{ .Value }}' ts='{{ .Created}}'")
+echo "$key: $value"
+
+# run the restful api server
+anydb serve
+
+# post a new key
+curl -X PUT localhost:8787/anydb/v1/ \
+  -H 'Content-Type: application/json' \
+  -d '{"key":"foo","val":"bar"}'
+
+# retrieve it
+curl localhost:8787/anydb/v1/foo
+
+# list keys
+curl localhost:8787/anydb/v1/
+
 # it comes with a manpage builtin
 anydb man
 ```
@@ -98,21 +140,50 @@ There are multiple ways to install **anydb**:
   
 - The release page also contains a tarball for every supported platform. Unpack it
   to some temporary directory, extract it and execute the following command inside:
-  ```
+  ```shell
   sudo make install
   ```
   
 - You can also install from source. Issue the following commands in your shell:
-  ```
+  ```shell
   git clone https://github.com/TLINDEN/anydb.git
   cd anydb
   make
   sudo make install
   ```
 
+- Or, if you have the GO toolkit installed, just install it like this:
+  ```shell
+  go install github.com/tlinden/anydb@latest
+  ```
+
 If you  do not find a  binary release for your  platform, please don't
 hesitate to ask me about it, I'll add it.
 
+### Using the docker image
+
+A pre-built docker  image is available, which you can  use to test the
+app without  installing it. To download:
+
+```shell
+docker pull ghcr.io/tlinden/anydb:latest
+```
+
+To execute anydb  inside the image do something like this:
+
+```shell
+mkdir mydb
+docker run -ti  -v mydb:/db -u `id -u $USER` -e HOME=/db ghcr.io/tlinden/anydb:latest set foo bar
+docker run -ti  -v mydb:/db -u `id -u $USER` -e HOME=/db ghcr.io/tlinden/anydb:latest list -o wide
+```
+
+Here, we operate in a local  directory `mydb`, which we'll use as HOME
+inside  the  docker  container.  anydb  will  store  its  database  in
+`mydb/.config/anydb/default.db`.
+
+A list of available images is  [here](https://github.com/tlinden/anydb/pkgs/container/anydb/versions?filters%5Bversion_type%5D=tagged)
+
+
 ## Documentation
 
 The  documentation  is  provided  as  a unix  man-page.   It  will  be

TODO.md

@@ -0,0 +1,4 @@
+- repl
+- mime-type => exec app + value
+- custom buckets (like skate: key@bucket or key+bucket)
+- encryption per bucket, one key for all entries (in that bucket)

anydb.1

@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
 .\"
 .\" Standard preamble:
 .\" ========================================================================

app/attr.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package app
 
 import (
@@ -8,12 +24,13 @@ import (
 )
 
 type DbAttr struct {
-	Key  string
-	Val  string
-	Bin  []byte
-	Args []string
-	Tags []string
-	File string
+	Key       string
+	Val       string
+	Bin       []byte
+	Args      []string
+	Tags      []string
+	File      string
+	Encrypted bool
 }
 
 func (attr *DbAttr) ParseKV() error {
@@ -51,7 +68,7 @@ func (attr *DbAttr) GetFileValue() error {
 	} else {
 		filehandle, err := os.OpenFile(attr.File, os.O_RDONLY, 0600)
 		if err != nil {
-			return err
+			return fmt.Errorf("failed to open file %s: %w", attr.File, err)
 		}
 
 		fd = filehandle
@@ -61,7 +78,7 @@ func (attr *DbAttr) GetFileValue() error {
 		// read from file or stdin pipe
 		data, err := io.ReadAll(fd)
 		if err != nil {
-			return err
+			return fmt.Errorf("failed to read from pipe: %w", err)
 		}
 
 		// poor man's text file test

app/crypto.go

@@ -0,0 +1,173 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+package app
+
+import (
+	"crypto/rand"
+	"encoding/base64"
+	"errors"
+	"fmt"
+	"os"
+	"syscall"
+
+	"golang.org/x/crypto/argon2"
+	"golang.org/x/crypto/chacha20poly1305"
+	"golang.org/x/term"
+)
+
+const (
+	ArgonMem      uint32 = 64 * 1024
+	ArgonIter     uint32 = 5
+	ArgonParallel uint8  = 2
+	ArgonSaltLen  int    = 16
+	ArgonKeyLen   uint32 = 32
+	B64SaltLen    int    = 22
+)
+
+type Key struct {
+	Salt []byte
+	Key  []byte
+}
+
+// called from interactive thread, hides  input and returns clear text
+// password
+func AskForPassword() ([]byte, error) {
+	fmt.Fprint(os.Stderr, "Password: ")
+	pass, err := term.ReadPassword(int(syscall.Stdin))
+	if err != nil {
+		return nil, fmt.Errorf("failed to read password: %w", err)
+	}
+
+	fmt.Fprintln(os.Stderr)
+
+	return pass, nil
+}
+
+// We're  using the  Argon2id  key derivation  algorithm  to derive  a
+// secure  key from  the given  password. This  is important,  because
+// users might  use unsecure  passwords. The resulting  encrypted data
+// might of course easily be decrypted  using brute force methods if a
+// weak password  was used, but  that would  cost, because of  the key
+// derivation. It does several rounds  of hash calculations which take
+// a considerable  amount of cpu  time. For  our legal user  that's no
+// problem because it's being executed  only once, but an attacker has
+// to do it in a forever loop, which will take a lot of time.
+func DeriveKey(password []byte, salt []byte) (*Key, error) {
+	if salt == nil {
+		// none given, new password
+		newsalt, err := GetRandom(ArgonSaltLen, ArgonSaltLen)
+		if err != nil {
+			return nil, err
+		}
+
+		salt = newsalt
+	}
+
+	hash := argon2.IDKey(
+		[]byte(password), salt,
+		ArgonIter,
+		ArgonMem,
+		ArgonParallel,
+		ArgonKeyLen,
+	)
+
+	return &Key{Key: hash, Salt: salt}, nil
+}
+
+// Retrieve a random chunk of given size
+func GetRandom(size int, capacity int) ([]byte, error) {
+	buf := make([]byte, size, capacity)
+	_, err := rand.Read(buf)
+	if err != nil {
+		return nil, fmt.Errorf("failed to retrieve random bytes: %w", err)
+	}
+
+	return buf, nil
+}
+
+// Encrypt clear  text given in  attr using ChaCha20  and auhtenticate
+// using the mac Poly1305. The cipher text will be put into attr, thus
+// modifying it.
+//
+// The cipher text consists of:
+// base64(password-salt) + base64(12 byte nonce + ciphertext + 16 byte mac)
+func Encrypt(pass []byte, attr *DbAttr) error {
+	key, err := DeriveKey(pass, nil)
+	if err != nil {
+		return err
+	}
+
+	aead, err := chacha20poly1305.New(key.Key)
+	if err != nil {
+		return fmt.Errorf("failed to create AEAD cipher: %w", err)
+	}
+
+	var plain []byte
+	if attr.Val != "" {
+		plain = []byte(attr.Val)
+	} else {
+		plain = attr.Bin
+	}
+
+	total := aead.NonceSize() + len(plain) + aead.Overhead()
+
+	nonce, err := GetRandom(aead.NonceSize(), total)
+	if err != nil {
+		return err
+	}
+
+	cipher := aead.Seal(nonce, nonce, plain, nil)
+
+	attr.Bin = nil
+	attr.Val = base64.RawStdEncoding.EncodeToString(key.Salt) +
+		base64.RawStdEncoding.EncodeToString(cipher)
+
+	attr.Encrypted = true
+
+	return nil
+}
+
+// Do the reverse
+func Decrypt(pass []byte, cipherb64 string) ([]byte, error) {
+	salt, err := base64.RawStdEncoding.Strict().DecodeString(cipherb64[0:B64SaltLen])
+	if err != nil {
+		return nil, fmt.Errorf("failed to encode to base64: %w", err)
+	}
+
+	key, err := DeriveKey(pass, salt)
+	if err != nil {
+		return nil, err
+	}
+
+	cipher, err := base64.RawStdEncoding.Strict().DecodeString(cipherb64[B64SaltLen:])
+	if err != nil {
+		return nil, fmt.Errorf("failed to encode to base64: %w", err)
+	}
+
+	aead, err := chacha20poly1305.New(key.Key)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create AEAD cipher: %w", err)
+	}
+
+	if len(cipher) < aead.NonceSize() {
+		return nil, errors.New("ciphertext too short")
+	}
+
+	nonce, ciphertext := cipher[:aead.NonceSize()], cipher[aead.NonceSize():]
+
+	return aead.Open(nil, nonce, ciphertext, nil)
+}

app/db.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package app
 
 import (
@@ -13,6 +29,8 @@ import (
 	bolt "go.etcd.io/bbolt"
 )
 
+const MaxValueWidth int = 60
+
 type DB struct {
 	Debug  bool
 	Dbfile string
@@ -20,12 +38,33 @@ type DB struct {
 }
 
 type DbEntry struct {
-	Id      string    `json:"id"`
-	Key     string    `json:"key"`
-	Value   string    `json:"value"`
-	Bin     []byte    `json:"bin"`
-	Tags    []string  `json:"tags"`
-	Created time.Time `json:"created"`
+	Id        string    `json:"id"`
+	Key       string    `json:"key"`
+	Value     string    `json:"value"`
+	Encrypted bool      `json:"encrypted"`
+	Bin       []byte    `json:"bin"`
+	Tags      []string  `json:"tags"`
+	Created   time.Time `json:"created"`
+	Size      int
+}
+
+// Post process an entry for list output.
+// Do NOT call it during write processing!
+func (entry *DbEntry) Normalize() {
+	entry.Size = len(entry.Value)
+
+	if entry.Encrypted {
+		entry.Value = "<encrypted-content>"
+	}
+
+	if len(entry.Bin) > 0 {
+		entry.Value = "<binary-content>"
+		entry.Size = len(entry.Bin)
+	}
+
+	if len(entry.Value) > MaxValueWidth {
+		entry.Value = entry.Value[0:MaxValueWidth] + "..."
+	}
 }
 
 type DbEntries []DbEntry
@@ -37,17 +76,19 @@ type DbTag struct {
 const BucketData string = "data"
 
 func New(file string, debug bool) (*DB, error) {
-	if _, err := os.Stat(filepath.Dir(file)); os.IsNotExist(err) {
-		os.MkdirAll(filepath.Dir(file), 0700)
-	}
-
 	return &DB{Debug: debug, Dbfile: file}, nil
 }
 
 func (db *DB) Open() error {
+	if _, err := os.Stat(filepath.Dir(db.Dbfile)); os.IsNotExist(err) {
+		if err := os.MkdirAll(filepath.Dir(db.Dbfile), 0700); err != nil {
+			return err
+		}
+	}
+
 	b, err := bolt.Open(db.Dbfile, 0600, nil)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to open DB %s: %w", db.Dbfile, err)
 	}
 
 	db.DB = b
@@ -81,7 +122,7 @@ func (db *DB) List(attr *DbAttr) (DbEntries, error) {
 		err := bucket.ForEach(func(key, jsonentry []byte) error {
 			var entry DbEntry
 			if err := json.Unmarshal(jsonentry, &entry); err != nil {
-				return fmt.Errorf("unable to unmarshal json: %s", err)
+				return fmt.Errorf("failed to unmarshal from json: %w", err)
 			}
 
 			var include bool
@@ -128,16 +169,13 @@ func (db *DB) Set(attr *DbAttr) error {
 	}
 	defer db.Close()
 
-	if err := attr.ParseKV(); err != nil {
-		return err
-	}
-
 	entry := DbEntry{
-		Key:     attr.Key,
-		Value:   attr.Val,
-		Bin:     attr.Bin,
-		Tags:    attr.Tags,
-		Created: time.Now(),
+		Key:       attr.Key,
+		Value:     attr.Val,
+		Bin:       attr.Bin,
+		Tags:      attr.Tags,
+		Encrypted: attr.Encrypted,
+		Created:   time.Now(),
 	}
 
 	// check if the  entry already exists and if yes,  check if it has
@@ -156,7 +194,7 @@ func (db *DB) Set(attr *DbAttr) error {
 
 		var oldentry DbEntry
 		if err := json.Unmarshal(jsonentry, &oldentry); err != nil {
-			return fmt.Errorf("unable to unmarshal json: %s", err)
+			return fmt.Errorf("failed to unmarshal from json: %w", err)
 		}
 
 		if len(oldentry.Tags) > 0 && len(entry.Tags) == 0 {
@@ -175,17 +213,17 @@ func (db *DB) Set(attr *DbAttr) error {
 		// insert data
 		bucket, err := tx.CreateBucketIfNotExists([]byte(BucketData))
 		if err != nil {
-			return fmt.Errorf("create bucket: %s", err)
+			return fmt.Errorf("failed to create DB bucket: %w", err)
 		}
 
 		jsonentry, err := json.Marshal(entry)
 		if err != nil {
-			return fmt.Errorf("json marshalling failure: %s", err)
+			return fmt.Errorf("failed to marshall json: %w", err)
 		}
 
 		err = bucket.Put([]byte(entry.Key), []byte(jsonentry))
 		if err != nil {
-			return fmt.Errorf("insert data: %s", err)
+			return fmt.Errorf("failed to insert data: %w", err)
 		}
 
 		return nil
@@ -204,10 +242,6 @@ func (db *DB) Get(attr *DbAttr) (*DbEntry, error) {
 	}
 	defer db.Close()
 
-	if err := attr.ParseKV(); err != nil {
-		return nil, err
-	}
-
 	entry := DbEntry{}
 
 	err := db.DB.View(func(tx *bolt.Tx) error {
@@ -222,20 +256,21 @@ func (db *DB) Get(attr *DbAttr) (*DbEntry, error) {
 		}
 
 		if err := json.Unmarshal(jsonentry, &entry); err != nil {
-			return fmt.Errorf("unable to unmarshal json: %s", err)
+			return fmt.Errorf("failed to unmarshal from json: %w", err)
 		}
 
 		return nil
 	})
 
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to read from DB: %w", err)
 	}
 
 	return &entry, nil
 }
 
 func (db *DB) Del(attr *DbAttr) error {
+	// FIXME: check if it exists prior to just call bucket.Delete()?
 	if err := db.Open(); err != nil {
 		return err
 	}
@@ -269,14 +304,14 @@ func (db *DB) Import(attr *DbAttr) error {
 	newfile := db.Dbfile + now.Format("-02.01.2006T03:04.05")
 
 	if err := json.Unmarshal([]byte(attr.Val), &entries); err != nil {
-		return cleanError(newfile, fmt.Errorf("unable to unmarshal json: %s", err))
+		return cleanError(newfile, fmt.Errorf("failed to unmarshal json: %w", err))
 	}
 
 	if fileExists(db.Dbfile) {
 		// backup the old file
 		err := os.Rename(db.Dbfile, newfile)
 		if err != nil {
-			return err
+			return fmt.Errorf("failed to rename file %s to %s: %w", db.Dbfile, newfile, err)
 		}
 
 	}
@@ -291,18 +326,18 @@ func (db *DB) Import(attr *DbAttr) error {
 		// insert data
 		bucket, err := tx.CreateBucketIfNotExists([]byte(BucketData))
 		if err != nil {
-			return fmt.Errorf("create bucket: %s", err)
+			return fmt.Errorf("failed to create bucket: %w", err)
 		}
 
 		for _, entry := range entries {
 			jsonentry, err := json.Marshal(entry)
 			if err != nil {
-				return fmt.Errorf("json marshalling failure: %s", err)
+				return fmt.Errorf("failed to marshall json: %w", err)
 			}
 
 			err = bucket.Put([]byte(entry.Key), []byte(jsonentry))
 			if err != nil {
-				return fmt.Errorf("insert data: %s", err)
+				return fmt.Errorf("failed to insert data into DB: %w", err)
 			}
 		}
 

app/generic.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package app
 
 // look if a key in a map exists, generic variant

cfg/config.go

@@ -2,14 +2,18 @@ package cfg
 
 import "github.com/tlinden/anydb/app"
 
-var Version string = "v0.0.1"
+var Version string = "v0.0.4"
 
 type Config struct {
-	Debug     bool
-	Dbfile    string
-	Mode      string // wide, table, yaml, json
-	NoHeaders bool
-	DB        *app.DB
-	File      string
-	Tags      []string
+	Debug      bool
+	Dbfile     string
+	Template   string
+	Mode       string // wide, table, yaml, json
+	NoHeaders  bool
+	NoHumanize bool
+	Encrypt    bool
+	DB         *app.DB
+	File       string
+	Tags       []string
+	Listen     string
 }

cmd/anydb.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package cmd
 
 var manpage = `
@@ -42,28 +58,3 @@ AUTHORS
     Thomas von Dein tom AT vondein DOT org
 
 `
-var usage = `
-
-Usage:
-  anydb <command> [options] [flags]
-  anydb [command]
-
-Available Commands:
-  completion  Generate the autocompletion script for the specified shell
-  del         Delete key
-  export      Export database to json
-  get         Retrieve value for a key
-  help        Help about any command
-  import      Import database dump
-  list        List database contents
-  set         Insert key/value pair
-
-Flags:
-  -f, --dbfile string   DB file to use (default "/home/scip/.config/anydb/default.db")
-  -d, --debug           Enable debugging
-  -h, --help            help for anydb
-  -v, --version         Print program version
-
-Use "anydb [command] --help" for more information about a command.
-
-`

cmd/crud.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package cmd
 
 import (
@@ -7,11 +23,13 @@ import (
 	"os"
 	"os/exec"
 	"strings"
+	"unicode/utf8"
 
 	"github.com/spf13/cobra"
 	"github.com/tlinden/anydb/app"
 	"github.com/tlinden/anydb/cfg"
 	"github.com/tlinden/anydb/output"
+	"github.com/tlinden/anydb/rest"
 )
 
 func Set(conf *cfg.Config) *cobra.Command {
@@ -40,10 +58,29 @@ func Set(conf *cfg.Config) *cobra.Command {
 				attr.Tags = strings.Split(attr.Tags[0], ",")
 			}
 
+			// check if value given as file or via stdin and fill attr accordingly
+			if err := attr.ParseKV(); err != nil {
+				return err
+			}
+
+			// encrypt?
+			if conf.Encrypt {
+				pass, err := app.AskForPassword()
+				if err != nil {
+					return err
+				}
+
+				err = app.Encrypt(pass, &attr)
+				if err != nil {
+					return err
+				}
+			}
+
 			return conf.DB.Set(&attr)
 		},
 	}
 
+	cmd.PersistentFlags().BoolVarP(&conf.Encrypt, "encrypt", "e", false, "encrypt value")
 	cmd.PersistentFlags().StringVarP(&attr.File, "file", "r", "", "Filename or - for STDIN")
 	cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
 
@@ -60,7 +97,7 @@ func Get(conf *cfg.Config) *cobra.Command {
 	)
 
 	var cmd = &cobra.Command{
-		Use:   "get <key> [-o <file>]",
+		Use:   "get  <key> [-o <file>] [-m <mode>] [-n -N] [-T <tpl>]",
 		Short: "Retrieve value for a key",
 		Long:  `Retrieve value for a key`,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -80,11 +117,35 @@ func Get(conf *cfg.Config) *cobra.Command {
 				return err
 			}
 
-			return output.Print(os.Stdout, conf, entry)
+			if entry.Encrypted {
+				pass, err := app.AskForPassword()
+				if err != nil {
+					return err
+				}
+
+				clear, err := app.Decrypt(pass, entry.Value)
+				if err != nil {
+					return err
+				}
+
+				if utf8.ValidString(string(clear)) {
+					entry.Value = string(clear)
+				} else {
+					entry.Bin = clear
+				}
+
+				entry.Encrypted = false
+			}
+
+			return output.Print(os.Stdout, conf, &attr, entry)
 		},
 	}
 
-	cmd.PersistentFlags().StringVarP(&conf.Mode, "output", "o", "", "output to file")
+	cmd.PersistentFlags().StringVarP(&attr.File, "output", "o", "", "output value to file (ignores -m)")
+	cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (simple|wide|json) (default 'simple')")
+	cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
+	cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
+	cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
 
 	cmd.Aliases = append(cmd.Aliases, "show")
 	cmd.Aliases = append(cmd.Aliases, "g")
@@ -144,7 +205,7 @@ func Export(conf *cfg.Config) *cobra.Command {
 				return err
 			}
 
-			return output.WriteFile(&attr, conf, entries)
+			return output.WriteJSON(&attr, conf, entries)
 		},
 	}
 
@@ -163,7 +224,7 @@ func List(conf *cfg.Config) *cobra.Command {
 	)
 
 	var cmd = &cobra.Command{
-		Use:   "list [-t <tag>] [-o <mode>] [<filter-regex>]",
+		Use:   "list  [<filter-regex>] [-t <tag>] [-m <mode>] [-n -N] [-T <tpl>]",
 		Short: "List database contents",
 		Long:  `List database contents`,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -192,9 +253,11 @@ func List(conf *cfg.Config) *cobra.Command {
 		},
 	}
 
-	cmd.PersistentFlags().StringVarP(&conf.Mode, "output-mode", "o", "", "output format (table|wide|json), wide is a verbose table. (default 'table')")
+	cmd.PersistentFlags().StringVarP(&conf.Mode, "mode", "m", "", "output format (table|wide|json), wide is a verbose table. (default 'table')")
+	cmd.PersistentFlags().StringVarP(&conf.Template, "template", "T", "", "go template for '-m template'")
 	cmd.PersistentFlags().BoolVarP(&wide, "wide-output", "l", false, "output mode: wide")
 	cmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "n", false, "omit headers in tables")
+	cmd.PersistentFlags().BoolVarP(&conf.NoHumanize, "no-human", "N", false, "do not translate to human readable values")
 	cmd.PersistentFlags().StringArrayVarP(&attr.Tags, "tags", "t", nil, "tags, multiple allowed")
 
 	cmd.Aliases = append(cmd.Aliases, "/")
@@ -265,3 +328,21 @@ func Man(conf *cfg.Config) *cobra.Command {
 
 	return cmd
 }
+
+func Serve(conf *cfg.Config) *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:   "serve [-l host:port]",
+		Short: "run REST API listener",
+		Long:  `run REST API listener`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			// errors at this stage do not cause the usage to be shown
+			cmd.SilenceUsage = true
+
+			return rest.Runserver(conf, nil)
+		},
+	}
+
+	cmd.PersistentFlags().StringVarP(&conf.Listen, "listen", "l", "localhost:8787", "host:port")
+
+	return cmd
+}

cmd/root.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package cmd
 
 import (
@@ -83,6 +99,7 @@ func Execute() {
 	rootCmd.AddCommand(Del(&conf))
 	rootCmd.AddCommand(Export(&conf))
 	rootCmd.AddCommand(Import(&conf))
+	rootCmd.AddCommand(Serve(&conf))
 	rootCmd.AddCommand(Man(&conf))
 
 	err = rootCmd.Execute()

docker-compose.yaml

@@ -1,3 +1,19 @@
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
 version: "3.9"
 services:
   init:

go.mod

@@ -4,14 +4,27 @@ go 1.22.1
 
 require (
 	github.com/alecthomas/repr v0.4.0 // indirect
+	github.com/andybalholm/brotli v1.1.0 // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/gofiber/fiber/v2 v2.52.5 // indirect
+	github.com/gofiber/fiber/v3 v3.0.0-beta.3 // indirect
+	github.com/gofiber/utils/v2 v2.0.0-beta.4 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/mattn/go-runewidth v0.0.9 // indirect
+	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/olekukonko/tablewriter v0.0.5 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/rogpeppe/go-internal v1.13.1 // indirect
 	github.com/spf13/cobra v1.8.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasthttp v1.55.0 // indirect
+	github.com/valyala/tcplisten v1.0.0 // indirect
 	go.etcd.io/bbolt v1.3.11 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect
 	golang.org/x/term v0.27.0 // indirect
 	golang.org/x/tools v0.22.0 // indirect

go.sum

@@ -2,25 +2,52 @@ github.com/DataDog/zstd v1.4.1/go.mod h1:1jcaCB/ufaK+sKp1NBhlGmpz41jOoPQ35bpF36t
 github.com/Sereal/Sereal v0.0.0-20190618215532-0b8ac451a863/go.mod h1:D0JMgToj/WdxCgd30Kc1UcA9E+WdZoJqeVOuYW7iTBM=
 github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc=
 github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
+github.com/andybalholm/brotli v1.0.5 h1:8uQZIdzKmjc/iuPu7O2ioW48L81FgatrcpfFmiq/cCs=
+github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
+github.com/andybalholm/brotli v1.1.0 h1:eLKJA0d02Lf0mVpIDgYnqXcUn0GqVmEFny3VuID1U3M=
+github.com/andybalholm/brotli v1.1.0/go.mod h1:sms7XGricyQI9K10gOSf56VKKWS4oLer58Q+mhRPtnY=
 github.com/asdine/storm/v3 v3.2.1 h1:I5AqhkPK6nBZ/qJXySdI7ot5BlXSZ7qvDY1zAn5ZJac=
 github.com/asdine/storm/v3 v3.2.1/go.mod h1:LEpXwGt4pIqrE/XcTvCnZHT5MgZCV6Ub9q7yQzOFWr0=
 github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
 github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
+github.com/gofiber/fiber/v2 v2.52.5 h1:tWoP1MJQjGEe4GB5TUGOi7P2E0ZMMRx5ZTG4rT+yGMo=
+github.com/gofiber/fiber/v2 v2.52.5/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
+github.com/gofiber/fiber/v3 v3.0.0-beta.3 h1:7Q2I+HsIqnIEEDB+9oe7Gadpakh6ZLhXpTYz/L20vrg=
+github.com/gofiber/fiber/v3 v3.0.0-beta.3/go.mod h1:kcMur0Dxqk91R7p4vxEpJfDWZ9u5IfvrtQc8Bvv/JmY=
+github.com/gofiber/utils/v2 v2.0.0-beta.4 h1:1gjbVFFwVwUb9arPcqiB6iEjHBwo7cHsyS41NeIW3co=
+github.com/gofiber/utils/v2 v2.0.0-beta.4/go.mod h1:sdRsPU1FXX6YiDGGxd+q2aPJRMzpsxdzCXo9dz+xtOY=
 github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
+github.com/google/uuid v1.5.0 h1:1p67kYwdtXjb0gL0BPiP1Av9wiZPo5A8z2cWkTZ+eyU=
+github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/klauspost/compress v1.17.0 h1:Rnbp4K9EjcDuVuHtd0dgA4qNuv9yKDYKK1ulpJwgrqM=
+github.com/klauspost/compress v1.17.0/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
+github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
+github.com/klauspost/compress v1.17.9/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
+github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
 github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
 github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
@@ -29,15 +56,27 @@ github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3k
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
+github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
+github.com/valyala/fasthttp v1.51.0 h1:8b30A5JlZ6C7AS81RsWjYMQmrZG6feChmgAolCl1SqA=
+github.com/valyala/fasthttp v1.51.0/go.mod h1:oI2XroL+lI7vdXyYoQk03bXBThfFl2cVdIA3Xl7cH8g=
+github.com/valyala/fasthttp v1.55.0 h1:Zkefzgt6a7+bVKHnu/YaYSOPfNYNisSVBo/unVCf8k8=
+github.com/valyala/fasthttp v1.55.0/go.mod h1:NkY9JtkrpPKmgwV3HTaS2HWaJss9RSIsRVfcxxoHiOM=
+github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
+github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
 github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk=
 go.etcd.io/bbolt v1.3.4/go.mod h1:G5EMThwa9y8QZGBClrRx5EY+Yw9kAhnjy3bSjsnlVTQ=
 go.etcd.io/bbolt v1.3.11 h1:yGEzV1wPz2yVCLsD8ZAiGHhHVlczyC9d1rP43/VCRJ0=
 go.etcd.io/bbolt v1.3.11/go.mod h1:dksAq7YMXoljX0xu6VF5DMZGbhYYoLUalEiSySYAS4I=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
+golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
 golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
 golang.org/x/net v0.0.0-20191105084925-a882066a44e0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
 golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.27.0 h1:WP60Sv1nlK1T6SupCHbXzSaN0b9wUmsPoRS9b61A23Q=

main.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package main
 
 import (

main_test.go

@@ -1,3 +1,19 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package main
 
 import (

mkrel.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright © 2023 Thomas von Dein
+# Copyright © 2024 Thomas von Dein
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

output/export.go

@@ -0,0 +1,50 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+package output
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/tlinden/anydb/app"
+	"github.com/tlinden/anydb/cfg"
+)
+
+func WriteJSON(attr *app.DbAttr, conf *cfg.Config, entries app.DbEntries) error {
+	jsonentries, err := json.Marshal(entries)
+	if err != nil {
+		return fmt.Errorf("failed to marshall json: %w", err)
+	}
+
+	if attr.File == "-" {
+		fmt.Println(string(jsonentries))
+	} else {
+		fd, err := os.OpenFile(attr.File, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
+		if err != nil {
+			return fmt.Errorf("failed to open file %s for writing: %w", attr.File, err)
+		}
+
+		if _, err := fd.Write(jsonentries); err != nil {
+			return fmt.Errorf("failed writing to file %s: %w", attr.File, err)
+		}
+
+		fmt.Printf("database contents exported to %s\n", attr.File)
+	}
+
+	return nil
+}

output/list.go

@@ -1,11 +1,30 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package output
 
 import (
+	"bytes"
 	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
+	"strconv"
 	"strings"
+	tpl "text/template"
 
 	"github.com/dustin/go-humanize"
 	"github.com/olekukonko/tablewriter"
@@ -16,64 +35,88 @@ import (
 func List(writer io.Writer, conf *cfg.Config, entries app.DbEntries) error {
 	// FIXME: call sort here
 	switch conf.Mode {
-	case "wide":
-		fallthrough
-	case "":
-		fallthrough
-	case "table":
+	case "wide", "", "table":
 		return ListTable(writer, conf, entries)
 	case "json":
 		return ListJson(writer, conf, entries)
+	case "template":
+		return ListTemplate(writer, conf, entries)
 	default:
 		return errors.New("unsupported mode")
 	}
-
-	return nil
 }
 
 func ListJson(writer io.Writer, conf *cfg.Config, entries app.DbEntries) error {
 	jsonentries, err := json.Marshal(entries)
 	if err != nil {
-		return fmt.Errorf("json marshalling failure: %s", err)
+		return fmt.Errorf("failed marshall json: %s", err)
 	}
 
 	fmt.Println(string(jsonentries))
 	return nil
 }
 
+func ListTemplate(writer io.Writer, conf *cfg.Config, entries app.DbEntries) error {
+	tmpl, err := tpl.New("list").Parse(conf.Template)
+	if err != nil {
+		return fmt.Errorf("failed to parse output template: %w", err)
+	}
+
+	buf := bytes.Buffer{}
+
+	for _, row := range entries {
+		row.Normalize()
+
+		buf.Reset()
+		err = tmpl.Execute(&buf, row)
+		if err != nil {
+			return fmt.Errorf("failed to execute output template: %w", err)
+		}
+
+		if buf.Len() > 0 {
+			fmt.Fprintln(writer, buf.String())
+		}
+	}
+
+	return nil
+}
+
 func ListTable(writer io.Writer, conf *cfg.Config, entries app.DbEntries) error {
 	tableString := &strings.Builder{}
 	table := tablewriter.NewWriter(tableString)
 
 	if !conf.NoHeaders {
 		if conf.Mode == "wide" {
-			table.SetHeader([]string{"KEY", "TAGS", "SIZE", "AGE", "VALUE"})
+			table.SetHeader([]string{"KEY", "TAGS", "SIZE", "UPDATED", "VALUE"})
 		} else {
 			table.SetHeader([]string{"KEY", "VALUE"})
 		}
 	}
 
 	for _, row := range entries {
-		size := len(row.Value)
-
-		if len(row.Bin) > 0 {
-			row.Value = "binary-content"
-			size = len(row.Bin)
-		}
-
-		if len(row.Value) > 60 {
-			row.Value = row.Value[0:60] + "..."
-		}
+		row.Normalize()
 
 		if conf.Mode == "wide" {
-			table.Append([]string{
-				row.Key,
-				strings.Join(row.Tags, ","),
-				humanize.Bytes(uint64(size)),
-				//row.Created.Format("02.01.2006T03:04.05"),
-				humanize.Time(row.Created),
-				row.Value,
-			})
+			switch conf.NoHumanize {
+			case true:
+				table.Append([]string{
+					row.Key,
+					strings.Join(row.Tags, ","),
+					strconv.Itoa(row.Size),
+					row.Created.Format("02.01.2006T03:04.05"),
+					row.Value,
+				})
+			default:
+				table.Append([]string{
+					row.Key,
+					strings.Join(row.Tags, ","),
+					humanize.Bytes(uint64(row.Size)),
+					//row.Created.Format("02.01.2006T03:04.05"),
+					humanize.Time(row.Created),
+					row.Value,
+				})
+			}
+
 		} else {
 			table.Append([]string{row.Key, row.Value})
 		}

output/single.go

@@ -1,6 +1,23 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 package output
 
 import (
+	"encoding/json"
 	"fmt"
 	"io"
 	"os"
@@ -11,49 +28,67 @@ import (
 	"golang.org/x/term"
 )
 
-func Print(writer io.Writer, conf *cfg.Config, entry *app.DbEntry) error {
-	if conf.Mode != "" {
-		// consider this to be a file
-		fd, err := os.OpenFile(conf.Mode, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0755)
-		if err != nil {
-			return err
-		}
-		defer fd.Close()
-
-		if len(entry.Bin) > 0 {
-			// binary file content
-			_, err = fd.Write(entry.Bin)
-		} else {
-			val := entry.Value
-			if !strings.HasSuffix(val, "\n") {
-				// always add a terminal newline
-				val += "\n"
-			}
-
-			_, err = fd.Write([]byte(val))
-		}
-
-		if err != nil {
-			return err
-		}
-
-		return nil
+func Print(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.DbEntry) error {
+	if attr.File != "" {
+		return WriteFile(writer, conf, attr, entry)
 	}
 
 	isatty := term.IsTerminal(int(os.Stdout.Fd()))
-	if len(entry.Bin) > 0 {
-		if isatty {
-			fmt.Println("binary data omitted")
-		} else {
-			os.Stdout.Write(entry.Bin)
-		}
-	} else {
-		fmt.Print(entry.Value)
 
-		if !strings.HasSuffix(entry.Value, "\n") {
-			// always add a terminal newline
-			fmt.Println()
+	switch conf.Mode {
+	case "simple", "":
+		if len(entry.Bin) > 0 {
+			if isatty {
+				fmt.Println("binary data omitted")
+			} else {
+				os.Stdout.Write(entry.Bin)
+			}
+		} else {
+			fmt.Print(entry.Value)
+
+			if !strings.HasSuffix(entry.Value, "\n") {
+				// always add a terminal newline
+				fmt.Println()
+			}
 		}
+	case "json":
+		jsonentry, err := json.Marshal(entry)
+		if err != nil {
+			return fmt.Errorf("failed to marshall json: %s", err)
+		}
+
+		fmt.Println(string(jsonentry))
+	case "wide":
+		return ListTable(writer, conf, app.DbEntries{*entry})
+	case "template":
+		return ListTemplate(writer, conf, app.DbEntries{*entry})
+	}
+
+	return nil
+}
+
+func WriteFile(writer io.Writer, conf *cfg.Config, attr *app.DbAttr, entry *app.DbEntry) error {
+	fd, err := os.OpenFile(attr.File, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)
+	if err != nil {
+		return fmt.Errorf("failed to open file %s for writing: %w", attr.File, err)
+	}
+	defer fd.Close()
+
+	if len(entry.Bin) > 0 {
+		// binary file content
+		_, err = fd.Write(entry.Bin)
+	} else {
+		val := entry.Value
+		if !strings.HasSuffix(val, "\n") {
+			// always add a terminal newline
+			val += "\n"
+		}
+
+		_, err = fd.Write([]byte(val))
+	}
+
+	if err != nil {
+		return fmt.Errorf("failed to write to file %s: %w", attr.File, err)
 	}
 
 	return nil

output/write.go

@@ -1,34 +0,0 @@
-package output
-
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-
-	"github.com/tlinden/anydb/app"
-	"github.com/tlinden/anydb/cfg"
-)
-
-func WriteFile(attr *app.DbAttr, conf *cfg.Config, entries app.DbEntries) error {
-	jsonentries, err := json.Marshal(entries)
-	if err != nil {
-		return fmt.Errorf("json marshalling failure: %s", err)
-	}
-
-	if attr.File == "-" {
-		fmt.Println(string(jsonentries))
-	} else {
-		fd, err := os.OpenFile(attr.File, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
-		if err != nil {
-			return err
-		}
-
-		if _, err := fd.Write(jsonentries); err != nil {
-			return err
-		}
-
-		fmt.Printf("database contents exported to %s\n", attr.File)
-	}
-
-	return nil
-}

rest/handlers.go

@@ -0,0 +1,141 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+package rest
+
+import (
+	//"github.com/alecthomas/repr"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/tlinden/anydb/app"
+	"github.com/tlinden/anydb/cfg"
+)
+
+type SetContext struct {
+	Query string `json:"query" form:"query"`
+}
+
+type ListResponse struct {
+	Success bool
+	Code    int
+	Entries app.DbEntries
+}
+
+type SingleResponse struct {
+	Success bool
+	Code    int
+	Entry   *app.DbEntry
+}
+
+func RestList(c *fiber.Ctx, conf *cfg.Config) error {
+	attr := new(app.DbAttr)
+
+	if len(c.Body()) > 0 {
+
+		if err := c.BodyParser(attr); err != nil {
+			return c.Status(fiber.StatusUnprocessableEntity).JSON(fiber.Map{
+				"errors": err.Error(),
+			})
+
+		}
+	}
+
+	// get list
+	entries, err := conf.DB.List(attr)
+	if err != nil {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"Unable to list keys: "+err.Error())
+	}
+
+	return c.Status(fiber.StatusOK).JSON(
+		ListResponse{
+			Success: true,
+			Code:    fiber.StatusOK,
+			Entries: entries,
+		},
+	)
+}
+
+func RestGet(c *fiber.Ctx, conf *cfg.Config) error {
+	if c.Params("key") == "" {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"key not provided")
+	}
+
+	// get list
+	entry, err := conf.DB.Get(&app.DbAttr{Key: c.Params("key")})
+	if err != nil {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"Unable to get key: "+err.Error())
+	}
+	if entry.Key == "" {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"Key does not exist")
+	}
+
+	return c.Status(fiber.StatusOK).JSON(
+		SingleResponse{
+			Success: true,
+			Code:    fiber.StatusOK,
+			Entry:   entry,
+		},
+	)
+}
+
+func RestDelete(c *fiber.Ctx, conf *cfg.Config) error {
+	if c.Params("key") == "" {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"key not provided")
+	}
+
+	// get list
+	err := conf.DB.Del(&app.DbAttr{Key: c.Params("key")})
+	if err != nil {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"Unable to delete key: "+err.Error())
+	}
+
+	return c.Status(fiber.StatusOK).JSON(
+		Result{
+			Success: true,
+			Code:    fiber.StatusOK,
+			Message: "key deleted",
+		},
+	)
+}
+
+func RestSet(c *fiber.Ctx, conf *cfg.Config) error {
+	attr := new(app.DbAttr)
+	if err := c.BodyParser(attr); err != nil {
+		return c.Status(fiber.StatusUnprocessableEntity).JSON(fiber.Map{
+			"errors": err.Error(),
+		})
+
+	}
+
+	err := conf.DB.Set(attr)
+	if err != nil {
+		return JsonStatus(c, fiber.StatusForbidden,
+			"Unable to set key: "+err.Error())
+	}
+
+	return c.Status(fiber.StatusOK).JSON(
+		Result{
+			Success: true,
+			Code:    fiber.StatusOK,
+		},
+	)
+}

rest/serve.go

@@ -0,0 +1,113 @@
+/*
+Copyright © 2024 Thomas von Dein
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+package rest
+
+import (
+	"github.com/gofiber/fiber/v2"
+	"github.com/gofiber/fiber/v2/middleware/compress"
+	"github.com/gofiber/fiber/v2/middleware/cors"
+	"github.com/gofiber/fiber/v2/middleware/logger"
+	"github.com/tlinden/anydb/cfg"
+)
+
+// used to return to the api client
+type Result struct {
+	Success bool   `json:"success"`
+	Message string `json:"message"`
+	Code    int    `json:"code"`
+}
+
+func Runserver(conf *cfg.Config, args []string) error {
+	// setup api server
+	router := SetupServer(conf)
+
+	// public rest api routes
+	api := router.Group("/anydb/v1")
+	{
+		api.Get("/", func(c *fiber.Ctx) error {
+			return RestList(c, conf)
+		})
+
+		api.Get("/:key", func(c *fiber.Ctx) error {
+			return RestGet(c, conf)
+		})
+
+		api.Delete("/:key", func(c *fiber.Ctx) error {
+			return RestDelete(c, conf)
+		})
+
+		api.Put("/", func(c *fiber.Ctx) error {
+			return RestSet(c, conf)
+		})
+	}
+
+	// public routes
+	{
+		router.Get("/", func(c *fiber.Ctx) error {
+			return c.Send([]byte("Use the REST API"))
+		})
+	}
+
+	return router.Listen(conf.Listen)
+}
+
+func SetupServer(conf *cfg.Config) *fiber.App {
+	// disable colors
+	fiber.DefaultColors = fiber.Colors{}
+
+	router := fiber.New(fiber.Config{
+		CaseSensitive: true,
+		StrictRouting: true,
+		Immutable:     true,
+		ServerHeader:  "anydb serve",
+		AppName:       "anydb",
+	})
+
+	router.Use(logger.New(logger.Config{
+          Format:        "${pid} ${ip}:${port} ${status} - ${method} ${path}\n",
+		DisableColors: true,
+	}))
+
+	router.Use(cors.New(cors.Config{
+		AllowMethods:  "GET,PUT,POST,DELETE",
+		ExposeHeaders: "Content-Type,Accept",
+	}))
+
+	router.Use(compress.New(compress.Config{
+		Level: compress.LevelBestSpeed,
+	}))
+
+	return router
+}
+
+/*
+Wrapper to respond with proper json status, message and code,
+shall be prepared and called by the handlers directly.
+*/
+func JsonStatus(c *fiber.Ctx, code int, msg string) error {
+	success := true
+
+	if code != fiber.StatusOK {
+		success = false
+	}
+
+	return c.Status(code).JSON(Result{
+		Code:    code,
+		Message: msg,
+		Success: success,
+	})
+}

t/files.txtar

@@ -1,3 +1,20 @@
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
+
 # simple file, we cannot use redirection here, so dd is our friend
 exec dd if=/dev/random of=file.txt count=5 bs=10
 

t/interface.txtar

@@ -1,3 +1,20 @@
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
+
 # check default outputs
 
 exec anydb -v

t/restore.txtar

@@ -1,3 +1,20 @@
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
+
 # setup simple db
 exec anydb -f test.db set foo bar
 

t/workflow.txtar

@@ -1,3 +1,20 @@
+# 
+# Copyright © 2024 Thomas von Dein
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 
+
 # simple entry
 exec anydb -f test.db set foo bar
 
@@ -9,7 +26,7 @@ exec anydb -f test.db list
 stdout foo.*bar
 
 # wide list
-exec anydb -f test.db list -o wide
+exec anydb -f test.db list -m wide
 stdout 'plant.*now.*grey'
 
 # list tagged
@@ -42,6 +59,13 @@ stdout grey
 exec anydb -f test.db list -t flower
 ! stdout grey
 
+# check json output
+exec anydb -f test.db list -m json
+stdout '^\[\{'
+
+exec anydb -f test.db get color -m json
+stdout '^\{'
+
 # delete entry
 exec anydb -f test.db del foo