19 Commits

Author SHA1 Message Date
2259b3f455 doc: update changelog for v0.11.0 2025-12-20 18:24:24 +13:00
b4e8733798 doc: update TODO 2025-12-20 18:24:17 +13:00
ace5e3e65e bolt: support import/export as zip 2025-12-20 18:10:55 +13:00
e132500fd8 util: add slice_and, slice_apply 2025-12-20 18:10:33 +13:00
a6bb412a34 bolt: add comments on boltTargetBucket 2025-12-20 18:10:24 +13:00
51f2a69ed2 badger, sqlite: fix *.* spec for 'all files' in export file path 2025-12-20 17:46:07 +13:00
1db2d9781d ssh-agent: support lock/unlock 2025-12-20 17:21:35 +13:00
9f662a7fa2 badger: move encryption options to sub-struct [BREAKING] 2025-12-20 17:21:28 +13:00
034bd8114a ssh-agent: add initial support 2025-12-20 17:02:23 +13:00
7242e8644b ssh-tunnel: support ssh-agents 2025-12-20 16:43:07 +13:00
820285066b doc: update TODO 2025-12-19 19:17:46 +13:00
94c517a324 secretsvc: treat data column as binary 2025-12-19 19:11:11 +13:00
9fbc7b4ee6 config: fix saving new entries causing order to be lost 2025-12-19 19:06:51 +13:00
421cabb7a5 lmdb: support truncating existing childdb 2025-12-19 19:05:39 +13:00
910ef0dd9a makefile: add helper for running test mongodb server 2025-12-19 18:49:01 +13:00
a9c6b135c7 mongo: show index details in properties pane 2025-12-19 18:48:52 +13:00
02d4b918d6 ui: scroll to top when changing tables 2025-12-19 18:43:02 +13:00
0798547b39 ssh known_hosts support 2025-12-19 18:23:07 +13:00
3d114ec1a4 app: prevent editing if table did not load data 2025-12-19 17:55:41 +13:00
23 changed files with 726 additions and 99 deletions

View File

@@ -58,3 +58,10 @@ dist: yvbolt.linux64.tar.xz yvbolt.win64.zip
clean:
git checkout -- version.go
rm -f yvbolt.exe yvbolt yvbolt.linux64.tar.xz yvbolt.win64.zip
#####
# Test databases in Docker
.PHONY: test-mongo
test-mongo:
sudo docker run --rm -p 127.0.0.1:27017:27017 -e MONGO_INITDB_ROOT_USERNAME=root -e MONGO_INITDB_ROOT_PASSWORD=toor mongo:latest

View File

@@ -18,13 +18,13 @@ See also [qbolt](https://code.ivysaur.me/qbolt) for more/different functionality
## Supported databases
There are currently 14 supported databases:
There are currently 15 supported databases:
Database |Read |Editing |Query |Connection options |Context menu actions
-------------|------|---------|------|--------------------|--------
Badger v4 |Yes |Yes |No |Encrypted, readonly, in-memory |Backup, restore, compact
Bitcask |Yes |Yes |No |Readonly, autorecovery |Backup
Bolt |Yes |Yes |No |Readonly |Create/delete child buckets
Bolt |Yes |Yes |No |Readonly |Create/delete child buckets, import/export as zip
Debconf |Yes |No |No | |
Freedesktop.org Secret Service |Yes |No | No | |Unlock, create new collection
LevelDB |Yes |Yes |No |Readonly |
@@ -35,6 +35,7 @@ Pebble |Yes |Yes |No |Readonly, in-memory |
Redis |Yes |No |Yes |SSH tunnel, RESP v3 |
RoseDB |Yes |Yes |No | |
SQLite |Yes |Yes |Yes |CLI driver, in-memory |Vacuum, export
SSH Agent |Yes |No |No |Unix/TCP |Lock, unlock
Starskey |Yes |Yes |No |Compression |
## License
@@ -48,6 +49,14 @@ The code in this project is licensed under the ISC license (see `LICENSE` file f
## Changelog
2025-12-20 v0.11.0
- Badger: Change encryption configuration options (**BREAKING**)
- SSH Agent: Initial support, including lock/unlock
- Badger, SQLite: Fix "all files" spec when choosing an export file path
- Bolt: Support import/export as zip archive
- Support SSH agents when using SSH tunnels (e.g. for Redis or Mongo)
2025-12-17 v0.10.1
- Fix mixed Qt 5 / Qt 6 syntax

48
TODO
View File

@@ -1,8 +1,14 @@
- BUG: Adding new entries to connection manager, then selecting them, opens wrong entry
- BUG: Connecting to multiple DBs from connection manager: if one has an error, the error popup from the others is lost
- BUG: ExecQuery being called multiple times on error?
- Parity with QBolt, merge projects together
- Drag and drop database into UI (QBolt parity)
- Merge with QBolt
- Portable mode (portable.txt or portable/ dir)
- Syntax highlighting in editor
- Autorefresh
- Sshagent
- want to trigger an async refresh from inside the LDB after lock/unlock
- support adding/removing keys (will need per-row actions)
- Bolt: import/export should support passworded zips
- Table: BSON view can't see data
- Table: quick filter
- QSortFilterProxyModel
@@ -14,7 +20,6 @@
- SecretService: Support insert/update/delete
- Binary data viewer
- Detect jpg/png and show as image
- Prevent editing invalid-utf8 fields as text (binary data editor?)
- More DB types
- MySQL (& MariaDB/TiDB)
- Postgres
@@ -23,6 +28,7 @@
- MSSQL (recursive navigation for instances)
- Other K/V stores from https://github.com/smallnest/kvbench
- Windows registry
- Allow entering path for quick navigation
- LDAP
- Dolt
- Memcache
@@ -35,27 +41,37 @@
- Etcd
- v2: hierarchal
- v3: flat key namespace
- Tokyo Cabinet, Kyoto Cabinet, Tkrzw
- https://github.com/TerraTech/go-tokyocabinet needs pkg-config tokyocabinet
- https://github.com/estraier/tkrzw-go needs pkg-config tkrzw
- CSV file
- Allow querying with sqlite or duckDB?
- Parquet file
- Allow querying with duckDB?
- IRC client
- SSDB (Redis-compatible)
- Time-series DBs
- Prometheus
- VictoriaMetrics
- FrostDB https://github.com/polarsignals/frostdb
- https://dbdb.io/browse?programming=go-lang&q=
- Stoolap https://github.com/stoolap/stoolap
- Rust, needs C binding layer https://github.com/mozilla/cbindgen
- Maxmind GeoIP MMDB format
- https://github.com/maxmind/mmdbwriter
- ssh-agent
- Connection dialog
- SSH over Cockpit
- KeePass kdbx
- Not-quite-DBs
- IRC client
- Docker daemon (images, containers, ...)
- ssh-agent
- ssh known-hosts
- golang.org/x/crypto/ssh/knownhosts - already using this package
- Generic ODBC, database/sql, ...
- Other language DBs
- C, C++
- Tokyo Cabinet, Kyoto Cabinet, Tkrzw
- https://github.com/TerraTech/go-tokyocabinet needs pkg-config tokyocabinet
- https://github.com/estraier/tkrzw-go needs pkg-config tkrzw
- cdb (DJB's Constant Database)
- Rust
- Stoolap https://github.com/stoolap/stoolap
- Rust, needs C binding layer https://github.com/mozilla/cbindgen
- JDBC Java databases
- H2, HSQLDB, Apache Derby
- SQLite CLI driver:
- Context support
- Write support
@@ -69,17 +85,20 @@
- SQLite:
- drop table doesn't autorefresh nav since callback is late
- more accurate type handling
- binary data currently shows as "<<binary>>", edits wrongly
- views
- other special objects (triggers? udf functions?)
- remove current hardcoded LIMIT 1000
- attach additional db to same connection
- LMDB: dupsort mode (duplicate keys / entries-per-key)
- MongoDB
- UI for replica sets, ssl certs, cluster, custom auth database
- SSH tunnel: error `ssh: tcpChan: deadline not supported` - needs workaround
- BSON type column with autoconfig based column editor
- Backup/restore
- drop db/collection doesn't autorefresh nav since server is asynchronous
- SSH tunnel - option to use external/system SSH
- SSH tunnel
- option to use external/system SSH
- SSH over Cockpit
- Performance
- Warning if data table is filtered to 1000 rows, or add pagination
- Context/interrupt slow queries
@@ -91,4 +110,3 @@
- Export all data from grid
- Export all data from all buckets within a DB
- Reconnect
- Connecting to multiple DBs from connection manager: if one has an error, the error popup from the others is lost

BIN
assets/vendor_ssh.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 377 B

View File

@@ -32,6 +32,7 @@ type ConnectionConfig struct {
Redis *redisConnectionOptions `yicon:":/assets/vendor_redis.png" json:",omitempty"`
RoseDB *roseDBConn `ylabel:"RoseDB" yicon:":/assets/vendor_rosedb.png" json:",omitempty"`
SQLite *sqliteConnection `ylabel:"SQLite" yicon:":/assets/vendor_sqlite.png" json:",omitempty"`
SSHAgent *sshAgentConn `yicon:":/assets/vendor_ssh.png" json:",omitempty"`
Starskey *starskeyConnection `yicon:":/assets/vendor_starskey.png" json:",omitempty"`
}
@@ -99,6 +100,11 @@ func (cc *ConnectionConfig) Connect(ctx context.Context) (loadedDatabase, string
var _ DBConnector = &ConnectionConfig{}
func (f *App) OnMnuConnectClick() {
config := NewConnectionConfig()
f.showConnectDialog(config)
}
func (f *App) showConnectDialog(config *ConnectionConfig) {
// autoconfig.OpenDialog() does not give us a "yes/no" result back from the
// dialog, so we still have to custom construct the dialog and use the
@@ -109,8 +115,6 @@ func (f *App) OnMnuConnectClick() {
dlg.ConnectDialog.SetModal(true)
dlg.ConnectDialog.SetAttribute(qt.WA_DeleteOnClose)
config := NewConnectionConfig()
saver := autoconfig.MakeConfigArea(config, dlg.formLayout)
dlg.ConnectDialog.OnAccept(func(super func()) {

View File

@@ -88,6 +88,12 @@ func (f *App) getConnectionManagerContents() (*SavedConfig, error) {
return nil, err
}
// Before returning the configuration, sort the entries alphabetically
sort.Slice(ret.Entries, func(i, j int) bool {
// FIXME there is probably a slightly more efficient way of doing this
return strings.ToLower(ret.Entries[i].Description) < strings.ToLower(ret.Entries[j].Description)
})
// Success
return &ret, nil
}
@@ -153,15 +159,7 @@ func (f *App) saveConnectionManagerContents(sc *SavedConfig) error {
}
// Force update the saved version
sc.UserAgent = APPNAME // TODO get app's own version
// When saving, the version that gets saved always has descriptions sorted
// alphabetically.
// But, you won't know this until you reload the contents.
sort.Slice(sc.Entries, func(i, j int) bool {
// FIXME there is probably a slightly more efficient way of doing this
return strings.ToLower(sc.Entries[i].Description) < strings.ToLower(sc.Entries[j].Description)
})
sc.UserAgent = APPNAME + `/` + appVersion // e.g. yvbolt/v0.0.0-devel
// Marshal

View File

@@ -82,7 +82,7 @@ func (ld *badgerLoadedDatabase) NavContext(bucketPath []string) ([]contextAction
}
func (ld *badgerLoadedDatabase) ExportBackup(sender *qt.QTreeWidgetItem, bucketPath []string) error {
saveAs := qt.QFileDialog_GetSaveFileName4(sender.TreeWidget().QWidget, "Export backup...", "", "Badger database backups (*.bak);;All files (*.*)")
saveAs := qt.QFileDialog_GetSaveFileName4(sender.TreeWidget().QWidget, "Export backup...", "", "Badger database backups (*.bak);;All files (*)")
if saveAs == "" {
return nil
}
@@ -98,7 +98,7 @@ func (ld *badgerLoadedDatabase) ExportBackup(sender *qt.QTreeWidgetItem, bucketP
}
func (ld *badgerLoadedDatabase) ImportBackup(sender *qt.QTreeWidgetItem, bucketPath []string) error {
openPath := qt.QFileDialog_GetOpenFileName4(sender.TreeWidget().QWidget, "Import backup...", "", "Badger database backups (*.bak);;All files (*.*)")
openPath := qt.QFileDialog_GetOpenFileName4(sender.TreeWidget().QWidget, "Import backup...", "", "Badger database backups (*.bak);;All files (*)")
if openPath == "" {
return nil
}
@@ -140,37 +140,54 @@ var _ editableLoadedDatabase = &badgerLoadedDatabase{} // interface assertion
type badgerConnection struct {
Type autoconfig.OneOf
Disk *struct {
Directory autoconfig.ExistingDirectory
Readonly bool
Encryption_Method autoconfig.EnumList `yenum:"None;;Hex (AES-128/192/256);;Passphrase (SHA256 KDF to AES-256)"`
Encryption_Key autoconfig.Password
Directory autoconfig.ExistingDirectory
Readonly bool
Encryption *encryptionKey
}
Memory *struct{}
}
type encryptionKey struct {
Method autoconfig.EnumList `yenum:"Text;;Hex;;Passphrase (SHA256 KDF to AES-256)"`
Key autoconfig.Password
}
func (e encryptionKey) Get() ([]byte, error) {
switch e.Method {
case 0: // Text
return []byte(e.Key), nil
case 1: // Hex
// For Badger, the input must be 16/24/32 bytes for AES-128/192/256
// The library checks this, we don't need to
return hex.DecodeString(string(e.Key))
case 2: // Passphrase (SHA256 KDF to AES-256)
hasher := sha256.New()
hasher.Write([]byte(e.Key))
return hasher.Sum(nil), nil
default:
return nil, fmt.Errorf("Unsupported encoding method for encryption key")
}
}
func (bdc *badgerConnection) Connect(ctx context.Context) (loadedDatabase, string, error) {
if bdc.Disk != nil {
opts := badger.DefaultOptions(string(bdc.Disk.Directory))
opts.ReadOnly = bdc.Disk.Readonly
opts.MetricsEnabled = false
switch bdc.Disk.Encryption_Method {
case 0: // None
case 1: // Hex (AES-128/192/256) - must be 16/24/32 bytes
ehx, err := hex.DecodeString(string(bdc.Disk.Encryption_Key))
if bdc.Disk.Encryption != nil {
ehx, err := bdc.Disk.Encryption.Get()
if err != nil {
return nil, "", err
return nil, "", fmt.Errorf("Loading encryption key: %w", err)
}
if !(len(ehx) == 16 || len(ehx) == 24 || len(ehx) == 32) {
return nil, "", fmt.Errorf("Hex encryption key must be 16/24/32 bytes long, got %d", len(ehx))
return nil, "", fmt.Errorf("Encryption key must be 16/24/32 bytes long, got %d", len(ehx))
}
opts.EncryptionKey = ehx
case 2: // Passphrase (SHA256 KDF to AES-256)
hasher := sha256.New()
hasher.Write([]byte(bdc.Disk.Encryption_Key))
opts.EncryptionKey = hasher.Sum(nil)
}
db, err := badger.Open(opts)

View File

@@ -183,14 +183,30 @@ func (ld *boltLoadedDatabase) NavChildren(bucketPath []string) ([]string, error)
return boltChildBucketNames(ld.db, bucketPath)
}
func (ld *boltLoadedDatabase) NavContext(bucketPath []string) (ret []contextAction, err error) {
ret = append(ret, contextAction{"Add bucket...", ld.AddChildBucket})
func (ld *boltLoadedDatabase) NavContext(bucketPath []string) ([]contextAction, error) {
ret := []contextAction{
{"Add bucket...", ld.AddChildBucket},
}
if len(bucketPath) > 0 {
ret = append(ret, contextAction{"Delete bucket", ld.DeleteBucket})
}
return
if len(bucketPath) == 0 {
ret = append(ret, contextAction{"Export to .zip...", ld.exportToZip})
}
return ret, nil
}
func (ld *boltLoadedDatabase) exportToZip(sender *qt.QTreeWidgetItem, bucketPath []string) error {
// Popup for output file
savePath := qt.QFileDialog_GetSaveFileName4(sender.TreeWidget().QWidget, "Save backup as...", "", "Zip archive (*.zip);;All files (*)")
if savePath == "" {
return nil // cancelled
}
return ld.exportDatabaseToZip(savePath)
}
func (ld *boltLoadedDatabase) AddChildBucket(sender *qt.QTreeWidgetItem, bucketPath []string) error {
@@ -248,6 +264,11 @@ var _ editableLoadedDatabase = &boltLoadedDatabase{} // interface assertion
//
// boltTargetBucket resolves the bucketPath to a specific bolt.Bucket.
// If the path is empty, this function returns <nil> and you must manually access
// the root bucket.
// If the bucket does not exist, this function returns <nil>. It does not create
// the bucket.
func boltTargetBucket(tx *bbolt.Tx, path []string) *bbolt.Bucket {
// If we are already deep in buckets, go directly there to find children

230
db_bolt_zip.go Normal file
View File

@@ -0,0 +1,230 @@
package main
import (
"archive/zip"
"bytes"
"fmt"
"io"
"io/fs"
"os"
"path"
"strings"
"github.com/mappu/autoconfig"
qt "github.com/mappu/miqt/qt6"
"go.etcd.io/bbolt"
)
func (ld *boltLoadedDatabase) exportDatabaseToZip(zippath string) error {
fh, err := os.OpenFile(zippath, os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0644)
if err != nil {
return fmt.Errorf("Error opening output file: %w", err)
}
defer fh.Close()
zw := zip.NewWriter(fh)
// Filenames in zip files cannot contain `/` characters. Mangle it
// TODO undo this transfomation on import(!)
safename := func(n string) string {
return strings.ReplaceAll(string(n), `/`, `__`)
}
err = ld.db.View(func(tx *bbolt.Tx) error {
var process func(currentPath []string) error
process = func(currentPath []string) error {
// Create folder-entry for our own bucket
ourFolderName := path.Join(slice_apply(currentPath, safename)...)
ourBucket := zip.FileHeader{
Name: ourFolderName + `/`, // Trailing slash = directory
}
ourBucket.SetMode(fs.ModeDir | 0755)
_, err := zw.CreateHeader(&ourBucket)
if err != nil {
return err
}
// Create file entries for all non-bucket children
b := boltTargetBucket(tx, currentPath)
var childBuckets []string
var c *bbolt.Cursor
if b != nil {
c = b.Cursor() // in bucket
} else {
c = tx.Cursor()
}
for k, v := c.First(); k != nil; k, v = c.Next() {
if v == nil {
// That's a bucket
childBuckets = append(childBuckets, string(k))
continue
}
fileItem := zip.FileHeader{
Name: path.Join(ourFolderName, safename(string(k))),
}
fileItem.SetMode(0644)
fileW, err := zw.CreateHeader(&fileItem)
if err != nil {
return err
}
_, err = io.CopyN(fileW, bytes.NewReader(v), int64(len(v)))
if err != nil {
return err
}
}
// Recurse for all bucket-type children
for _, childBucketName := range childBuckets {
process(slice_and(currentPath, childBucketName))
}
// Done
return nil
}
return process([]string{})
})
if err != nil {
return err
}
err = zw.Flush()
if err != nil {
return err
}
err = zw.Close()
if err != nil {
return err
}
return fh.Close()
}
func (f *App) Bolt_ImportZipToDatabase_OnTriggered() {
zippath := qt.QFileDialog_GetOpenFileName4(f.ui.MainWindow.QWidget, "Select a zip archive to import...", "", "Zip archives (*.zip);;All files (*)")
if zippath == "" {
return // cancelled
}
dbpath := qt.QFileDialog_GetSaveFileName4(f.ui.MainWindow.QWidget, "Select an output file to save as...", "", "Bolt database (*.db);;All files (*)")
if dbpath == "" {
return // cancelled
}
err := Bolt_ImportZipToDatabase(dbpath, zippath)
if err != nil {
qt.QMessageBox_Warning(f.ui.MainWindow.QWidget, APPNAME, err.Error())
return
}
res := qt.QMessageBox_Question2(f.ui.MainWindow.QWidget, APPNAME, "The import was successful. Would you like to open the Bolt database now?", qt.QMessageBox__Yes, qt.QMessageBox__No)
if res != int(qt.QMessageBox__Yes) {
return
}
config := NewConnectionConfig()
config.Type = "Bolt"
config.Bolt = &boltConfig{
Path: autoconfig.ExistingFile(dbpath),
Readonly: false,
}
f.showConnectDialog(config)
}
func Bolt_ImportZipToDatabase(dbpath, zippath string) error {
db, err := bbolt.Open(dbpath, 0644, nil)
if err != nil {
return fmt.Errorf("Opening target database: %w", err)
}
defer db.Close()
fh, err := os.OpenFile(zippath, os.O_RDONLY, 0400)
if err != nil {
return fmt.Errorf("Opening input archive: %w", err)
}
defer fh.Close()
fstat, err := fh.Stat()
if err != nil {
return err
}
zr, err := zip.NewReader(fh, fstat.Size())
if err != nil {
return fmt.Errorf("Reading zip file format: %w", err)
}
return db.Update(func(tx *bbolt.Tx) error {
for _, zf := range zr.File {
if strings.HasSuffix(zf.Name, `/`) || (zf.Mode()&fs.ModeDir) != 0 {
// Bucket
if zf.Name == `/` {
continue // virtual entry for top-level directory, skip
}
bucketPath := strings.Split(strings.TrimSuffix(zf.Name, `/`), `/`)
parentBucket := boltTargetBucket(tx, bucketPath[0:len(bucketPath)-1])
newBucketName := []byte(bucketPath[len(bucketPath)-1])
var err error
if parentBucket == nil {
_, err = tx.CreateBucket(newBucketName) // at top level
} else {
_, err = parentBucket.CreateBucket(newBucketName) // child bucket
}
if err != nil {
return fmt.Errorf("Creating bucket %q: %w", zf.Name, err)
}
} else {
// Object
objectPath := strings.Split(zf.Name, `/`)
rc, err := zf.Open()
if err != nil {
return err
}
content, err := io.ReadAll(rc)
if err != nil {
return err
}
parentBucket := boltTargetBucket(tx, objectPath[0:len(objectPath)-1]) // Can't be nil, items always exist within a bucket
objectKey := []byte(objectPath[len(objectPath)-1])
err = parentBucket.Put(objectKey, content)
if err != nil {
return err
}
err = rc.Close()
if err != nil {
return err
}
}
}
// Done
return nil
})
}

View File

@@ -178,9 +178,14 @@ func (ld *lmdbDatabase) createChildDatabase(sender *qt.QTreeWidgetItem, bucketPa
})
}
//func (ld *lmdbDatabase) truncateAllContent(sender *qt.QTreeWidgetItem, bucketPath []string) error {
// TODO add warning
//}
func (ld *lmdbDatabase) truncateAllContent(sender *qt.QTreeWidgetItem, bucketPath []string) error {
if !vcl_confirm_dialog(sender.TreeWidget().QWidget, fmt.Sprintf("Are you sure you want to empty the child database %q?", bucketPath[0])) {
return nil // cancelled
}
return ld.drop(bucketPath[0], true)
}
func (ld *lmdbDatabase) deleteChildDatabase(sender *qt.QTreeWidgetItem, bucketPath []string) error {
@@ -188,8 +193,12 @@ func (ld *lmdbDatabase) deleteChildDatabase(sender *qt.QTreeWidgetItem, bucketPa
return nil // cancelled
}
return ld.drop(bucketPath[0], true)
}
func (ld *lmdbDatabase) drop(multiDbName string, delet bool) error {
return ld.db.Update(func(txn *lmdb.Txn) error {
dbi, err := txn.OpenDBI(bucketPath[0], 0)
dbi, err := txn.OpenDBI(multiDbName, 0)
if err != nil {
return err
}
@@ -208,6 +217,7 @@ func (ld *lmdbDatabase) NavContext(bucketPath []string) ([]contextAction, error)
}, nil
} else {
return []contextAction{
contextAction{"Truncate and remove all contents...", ld.truncateAllContent},
contextAction{"Remove child database...", ld.deleteChildDatabase},
}, nil
}

View File

@@ -18,8 +18,7 @@ import (
)
// MongoDB support
// To test:
// sudo docker run --rm -p 127.0.0.1:27017:27017 -e MONGO_INITDB_ROOT_USERNAME=root -e MONGO_INITDB_ROOT_PASSWORD=toor mongo:latest
// To test: `make test-mongo`
type mongoLdb struct {
client *mongo.Client
@@ -49,13 +48,23 @@ func (ld *mongoLdb) Properties(bucketPath []string) (string, error) {
info := "Database " + db.Name() + "\n"
info += "Collection " + coll.Name() + "\n"
// Document count
count, err := coll.EstimatedDocumentCount(ctx)
if err != nil {
return "", err
return "", fmt.Errorf("Estimating document count: %w", err)
}
info += fmt.Sprintf("Estimated document count: %d", count) + "\n"
// TODO return more details
// Index info
allIndexes, err := coll.Indexes().ListSpecifications(ctx)
if err != nil {
return "", fmt.Errorf("Checking indexes: %w", err)
}
info += fmt.Sprintf("\nIndexes (%d):\n", len(allIndexes))
for _, idxInfo := range allIndexes {
info += fmt.Sprintf("- %q (namespace=%q, version=%d)\n", idxInfo.Name, idxInfo.Namespace, idxInfo.Version)
}
return info, nil

View File

@@ -37,7 +37,7 @@ func (ld *secretServiceDb) RenderForNav(f *tableState, bucketPath []string) erro
} else if len(bucketPath) == 1 {
f.SetupColumns(
slice_repeat(columnType_inlineText, 6),
[]columnType{columnType_inlineText, columnType_inlineText, columnType_inlineText, columnType_inlineText, columnType_inlineText, columnType_popupData},
[]string{"ID", "Label", "Attributes", "ContentType", "Parameters", "Value"},
)
@@ -74,13 +74,12 @@ func (ld *secretServiceDb) RenderForNav(f *tableState, bucketPath []string) erro
}
f.AddRowData(
// All strings
string(item), // ID
label.Value().(string), // Label
attrs.String(), // Attributes (JSON)
secr.ContentType, // ContentType
string(secr.Parameters), // Parameters
string(secr.Value), // Value
secr.Value, // Value - []byte
)
}

View File

@@ -365,7 +365,7 @@ func (ld *sqliteLoadedDatabase) CompactDatabase(sender *qt.QTreeWidgetItem, buck
func (ld *sqliteLoadedDatabase) ExportBackup(sender *qt.QTreeWidgetItem, bucketPath []string) error {
// Popup for output file
savePath := qt.QFileDialog_GetSaveFileName4(sender.TreeWidget().QWidget, "Save backup as...", "", "SQLite database (*.db *.db3 *.sqlite *.sqlite3);;All files (*.*)")
savePath := qt.QFileDialog_GetSaveFileName4(sender.TreeWidget().QWidget, "Save backup as...", "", "SQLite database (*.db *.db3 *.sqlite *.sqlite3);;All files (*)")
if savePath == "" {
return nil // cancelled
}

179
db_sshagent.go Normal file
View File

@@ -0,0 +1,179 @@
package main
import (
"context"
"fmt"
"net"
"net/netip"
"os"
"github.com/mappu/autoconfig"
qt "github.com/mappu/miqt/qt6"
"golang.org/x/crypto/ssh/agent"
)
type sshAgentLdb struct {
conn agent.ExtendedAgent
}
func (ld *sshAgentLdb) DriverName() string {
return "ssh-agent"
}
func (ld *sshAgentLdb) Properties(bucketPath []string) (string, error) {
return "", nil
}
func (ld *sshAgentLdb) RenderForNav(f *tableState, bucketPath []string) error {
keys, err := ld.conn.List()
if err != nil {
return err
}
f.SetupColumns([]columnType{columnType_inlineText, columnType_inlineText, columnType_popupData}, []string{"Comment", "Type", "Public Key"})
for _, key := range keys {
// The publicKey blob is the effective primary-key for DB manipulation
f.AddRow_PK_Data(key.Blob, key.Comment, key.Format, key.Blob)
}
f.Ready()
return nil
}
func (ld *sshAgentLdb) NavChildren(bucketPath []string) ([]string, error) {
return []string{}, nil // No children
}
func (ld *sshAgentLdb) lockPrompt(sender *qt.QTreeWidgetItem, bucketPath []string) error {
parent := sender.TreeWidget().QWidget
props := encryptionKey{}
autoconfig.OpenDialog(&props, parent, "Enter lock password...", func() {
key, err := props.Get()
if err != nil {
qt.QMessageBox_Warning(parent, APPNAME, err.Error())
return
}
if len(key) == 0 {
// Cancelled
return
}
err = ld.conn.Lock(key)
if err != nil {
qt.QMessageBox_Warning(parent, APPNAME, "Locking SSH agent: "+err.Error())
return
}
})
return nil // n.b. refreshes now
}
func (ld *sshAgentLdb) unlockPrompt(sender *qt.QTreeWidgetItem, bucketPath []string) error {
parent := sender.TreeWidget().QWidget
props := encryptionKey{}
autoconfig.OpenDialog(&props, parent, "Enter unlock password...", func() {
key, err := props.Get()
if err != nil {
qt.QMessageBox_Warning(parent, APPNAME, err.Error())
return
}
if len(key) == 0 {
// Cancelled
return
}
err = ld.conn.Unlock(key)
if err != nil {
qt.QMessageBox_Warning(parent, APPNAME, "Unlocking SSH agent: "+err.Error())
return
}
// Trigger a refresh
})
return nil // n.b. refreshes now, which may cause double-error if we are still locked
}
func (ld *sshAgentLdb) NavContext(bucketPath []string) ([]contextAction, error) {
return []contextAction{
{"Lock agent...", ld.lockPrompt},
{"Unlock agent...", ld.unlockPrompt},
}, nil
}
func (ld *sshAgentLdb) Close() {
// noop
}
var _ loadedDatabase = &sshAgentLdb{} // interface assertion
//
type sshAgentConn struct {
Type autoconfig.OneOf
Unix *autoconfig.ExistingFile
TCP *autoconfig.AddressPort
}
func (c *sshAgentConn) Reset() {
if sshAuthSock := os.Getenv("SSH_AUTH_SOCK"); sshAuthSock != "" {
if _, err := os.Stat(sshAuthSock); err == nil {
// File
c.Type = "Unix"
val := autoconfig.ExistingFile(sshAuthSock)
c.Unix = &val
} else if props, err := netip.ParseAddrPort(sshAuthSock); err == nil {
// IP:Port
c.Type = "TCP"
val := autoconfig.AddressPort{
Address: props.Addr().String(),
Port: int(props.Port()),
}
c.TCP = &val
} else {
// Can't parse env var
}
}
}
func (c *sshAgentConn) getAgent() (agent.ExtendedAgent, error) {
if c.Unix != nil {
conn, err := net.Dial("unix", string(*c.Unix))
if err != nil {
return nil, fmt.Errorf("Connecting to SSH agent %q: %w", c.Unix, err)
}
return agent.NewClient(conn), nil
} else if c.TCP != nil {
conn, err := net.Dial("tcp", fmt.Sprintf("%s:%d", c.TCP.Address, c.TCP.Port))
if err != nil {
return nil, fmt.Errorf("Connecting to SSH agent %q: %w", c.TCP.String(), err)
}
return agent.NewClient(conn), nil
} else {
return nil, fmt.Errorf("No connection details specified")
}
}
func (c *sshAgentConn) Connect(ctx context.Context) (loadedDatabase, string, error) {
agent, err := c.getAgent()
if err != nil {
return nil, "", err
}
return &sshAgentLdb{conn: agent}, "SSH Agent", nil
}

View File

@@ -39,6 +39,7 @@
<file>assets/vendor_riak.png</file>
<file>assets/vendor_rosedb.png</file>
<file>assets/vendor_sqlite.png</file>
<file>assets/vendor_ssh.png</file>
<file>assets/vendor_starskey.png</file>
</qresource>
</RCC>

BIN
embed.rcc

Binary file not shown.

13
main.go
View File

@@ -54,6 +54,8 @@ func newApp() *App {
a.ui.mnuDriverVersions.OnTriggered(a.OnMenuHelpVersion)
a.ui.mnuHelpAbout.OnTriggered(a.OnMnuHelpHomepage)
a.ui.actionCreate_Bolt_database_from_zip.OnTriggered(a.Bolt_ImportZipToDatabase_OnTriggered)
//
a.ui.Buckets.OnCurrentItemChanged(a.OnNavChange)
@@ -277,7 +279,7 @@ func (f *App) OnDataCommitClick() {
f.refreshContent(node) // Refresh RHS pane/data content
// Preserve scroll position
// TODO
// (Happens automatically with QTableView)
}
func (f *App) OnNavContextClose() {
@@ -422,6 +424,12 @@ func (f *App) OnNavChange(node *qt.QTreeWidgetItem, prev *qt.QTreeWidgetItem) {
}
}
if node != prev {
// Changing tables (not just refreshing the current table)
// Reset scroll position to top
f.ui.contentBox.ScrollToTop()
}
// OK, continue with change
f.refreshContent(node)
}
@@ -461,7 +469,8 @@ func (f *App) refreshContent(node *qt.QTreeWidgetItem) {
// Toggle the Edit functionality
// Do this *after* RenderForNav as it disables editing by default.
_, editable := ld.(editableLoadedDatabase)
f.ui.actionApply_changes.SetEnabled(false) // will be enabled after add/delete/edit
editable = editable && f.contentTbl.IsReady() // if there was a failure loading, don't allow edit
f.ui.actionApply_changes.SetEnabled(false) // will be enabled after add/delete/edit
f.ui.actionDelete_row.SetEnabled(editable)
f.ui.actionAddRow.SetEnabled(editable)
f.contentTbl.SetAllowEditing(editable)

View File

@@ -10,41 +10,43 @@ import (
)
type MainWindowUi struct {
MainWindow *qt.QMainWindow
centralwidget *qt.QWidget
gridLayout *qt.QGridLayout
splitter *qt.QSplitter
Buckets *qt.QTreeWidget
tabWidget *qt.QTabWidget
tabProperties *qt.QWidget
gridLayout_2 *qt.QGridLayout
propertiesBox *qt.QTextEdit
tabData *qt.QWidget
verticalLayout *qt.QVBoxLayout
contentBox *qt.QTableView
tabQuery *qt.QWidget
verticalLayout_2 *qt.QVBoxLayout
splitter_2 *qt.QSplitter
queryInput *qt.QPlainTextEdit
queryResult *qt.QTableView
menubar *qt.QMenuBar
menu_File *qt.QMenu
menu_Query *qt.QMenu
menu_Help *qt.QMenu
menu_Data *qt.QMenu
statusbar *qt.QStatusBar
toolBar *qt.QToolBar
actionE_xit *qt.QAction
mnuExecute *qt.QAction
mnuDriverVersions *qt.QAction
mnuHelpAbout *qt.QAction
actionConnect *qt.QAction
actionRefresh *qt.QAction
actionAbout_Qt *qt.QAction
actionAddRow *qt.QAction
actionDelete_row *qt.QAction
actionApply_changes *qt.QAction
actionConnectionManager *qt.QAction
MainWindow *qt.QMainWindow
centralwidget *qt.QWidget
gridLayout *qt.QGridLayout
splitter *qt.QSplitter
Buckets *qt.QTreeWidget
tabWidget *qt.QTabWidget
tabProperties *qt.QWidget
gridLayout_2 *qt.QGridLayout
propertiesBox *qt.QTextEdit
tabData *qt.QWidget
verticalLayout *qt.QVBoxLayout
contentBox *qt.QTableView
tabQuery *qt.QWidget
verticalLayout_2 *qt.QVBoxLayout
splitter_2 *qt.QSplitter
queryInput *qt.QPlainTextEdit
queryResult *qt.QTableView
menubar *qt.QMenuBar
menu_File *qt.QMenu
menu_Query *qt.QMenu
menu_Help *qt.QMenu
menu_Data *qt.QMenu
menu_Tools *qt.QMenu
statusbar *qt.QStatusBar
toolBar *qt.QToolBar
actionE_xit *qt.QAction
mnuExecute *qt.QAction
mnuDriverVersions *qt.QAction
mnuHelpAbout *qt.QAction
actionConnect *qt.QAction
actionRefresh *qt.QAction
actionAbout_Qt *qt.QAction
actionAddRow *qt.QAction
actionDelete_row *qt.QAction
actionApply_changes *qt.QAction
actionConnectionManager *qt.QAction
actionCreate_Bolt_database_from_zip *qt.QAction
}
// NewMainWindowUi creates all Qt widget classes for MainWindow.
@@ -137,6 +139,10 @@ func NewMainWindowUi() *MainWindowUi {
icon9.AddFile4(":/assets/database_key.png", qt.NewQSize(), qt.QIcon__Normal, qt.QIcon__Off)
ui.actionConnectionManager.SetIcon(icon9)
/* miqt-uic: no handler for QAction property 'menuRole' */
ui.actionCreate_Bolt_database_from_zip = qt.NewQAction()
actionCreate_Bolt_database_from_zip__objectName := qt.NewQAnyStringView3("actionCreate_Bolt_database_from_zip")
ui.actionCreate_Bolt_database_from_zip.SetObjectName(*actionCreate_Bolt_database_from_zip__objectName)
actionCreate_Bolt_database_from_zip__objectName.Delete() // setter copied value
ui.centralwidget = qt.NewQWidget(ui.MainWindow.QWidget)
centralwidget__objectName := qt.NewQAnyStringView3("centralwidget")
ui.centralwidget.SetObjectName(*centralwidget__objectName)
@@ -289,9 +295,15 @@ func NewMainWindowUi() *MainWindowUi {
ui.menu_Data.QWidget.AddAction(ui.actionAddRow)
ui.menu_Data.QWidget.AddAction(ui.actionDelete_row)
ui.menu_Data.QWidget.AddAction(ui.actionApply_changes)
ui.menu_Tools = qt.NewQMenu(ui.menubar.QWidget)
menu_Tools__objectName := qt.NewQAnyStringView3("menu_Tools")
ui.menu_Tools.SetObjectName(*menu_Tools__objectName)
menu_Tools__objectName.Delete() // setter copied value
ui.menu_Tools.QWidget.AddAction(ui.actionCreate_Bolt_database_from_zip)
ui.menubar.AddMenu(ui.menu_File)
ui.menubar.AddMenu(ui.menu_Data)
ui.menubar.AddMenu(ui.menu_Query)
ui.menubar.AddMenu(ui.menu_Tools)
ui.menubar.AddMenu(ui.menu_Help)
ui.MainWindow.SetMenuBar(ui.menubar)
ui.statusbar = qt.NewQStatusBar(ui.MainWindow.QWidget)
@@ -344,6 +356,7 @@ func (ui *MainWindowUi) Retranslate() {
ui.actionApply_changes.SetText(qt.QMainWindow_Tr("Apply changes"))
ui.actionConnectionManager.SetText(qt.QMainWindow_Tr("Connection Manager"))
ui.actionConnectionManager.SetToolTip(qt.QMainWindow_Tr("Connection Manager"))
ui.actionCreate_Bolt_database_from_zip.SetText(qt.QMainWindow_Tr("Create Bolt database from zip"))
ui.tabWidget.SetTabText(ui.tabWidget.IndexOf(ui.tabProperties), qt.QTabWidget_Tr("Properties"))
ui.tabWidget.SetTabText(ui.tabWidget.IndexOf(ui.tabData), qt.QTabWidget_Tr("Data"))
ui.tabWidget.SetTabText(ui.tabWidget.IndexOf(ui.tabQuery), qt.QTabWidget_Tr("Query"))
@@ -351,5 +364,6 @@ func (ui *MainWindowUi) Retranslate() {
ui.menu_Query.SetTitle(qt.QMenuBar_Tr("&Query"))
ui.menu_Help.SetTitle(qt.QMenuBar_Tr("&Help"))
ui.menu_Data.SetTitle(qt.QMenuBar_Tr("&Data"))
ui.menu_Tools.SetTitle(qt.QMenuBar_Tr("&Tools"))
ui.toolBar.SetWindowTitle(qt.QMainWindow_Tr("toolBar"))
}

View File

@@ -179,9 +179,16 @@
<addaction name="actionDelete_row"/>
<addaction name="actionApply_changes"/>
</widget>
<widget class="QMenu" name="menu_Tools">
<property name="title">
<string>&amp;Tools</string>
</property>
<addaction name="actionCreate_Bolt_database_from_zip"/>
</widget>
<addaction name="menu_File"/>
<addaction name="menu_Data"/>
<addaction name="menu_Query"/>
<addaction name="menu_Tools"/>
<addaction name="menu_Help"/>
</widget>
<widget class="QStatusBar" name="statusbar"/>
@@ -347,6 +354,11 @@
<enum>QAction::MenuRole::NoRole</enum>
</property>
</action>
<action name="actionCreate_Bolt_database_from_zip">
<property name="text">
<string>Create Bolt database from zip</string>
</property>
</action>
</widget>
<resources>
<include location="embed.qrc"/>

View File

@@ -5,10 +5,12 @@ import (
"errors"
"fmt"
"os"
"path/filepath"
"github.com/mappu/autoconfig"
qt "github.com/mappu/miqt/qt6"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/knownhosts"
)
type SSHTunnel struct {
@@ -28,11 +30,40 @@ type SSHTunnel struct {
PrivateKeyContent autoconfig.MultiLineString `ylabel:"Private Key"`
PrivateKeyContentPassword autoconfig.Password `ylabel:"Password (optional)"`
} `ylabel:"Private key (Internal)"`
SSHAgent *sshAgentConn `ylabel:"SSH Agent"`
}
H2 autoconfig.Header `ylabel:"Server host key:" json:",omitempty"`
HostVerification struct {
Type autoconfig.OneOf
InsecureSkipVerify *struct{}
ExternalKnownHostsFile *struct {
Path autoconfig.ExistingFile
}
}
}
func (s *SSHTunnel) Reset() { // Used by autoconfig package when creating a new value
s.Server.Port = 22
if sshAuthSock := os.Getenv("SSH_AUTH_SOCK"); sshAuthSock != "" {
s.Auth.Type = "SSHAgent"
s.Auth.SSHAgent = &sshAgentConn{}
s.Auth.SSHAgent.Reset()
}
if homeDir, err := os.UserHomeDir(); err == nil {
defaultKnownHostsFile := filepath.Join(homeDir, `.ssh`, `known_hosts`)
if _, err := os.Stat(defaultKnownHostsFile); err == nil {
s.HostVerification.Type = "ExternalKnownHostsFile"
alloc_inplace(&s.HostVerification.ExternalKnownHostsFile)
s.HostVerification.ExternalKnownHostsFile.Path = autoconfig.ExistingFile(defaultKnownHostsFile)
}
}
if s.HostVerification.Type == "" {
s.HostVerification.Type = "InsecureSkipVerify"
alloc_inplace(&s.HostVerification.InsecureSkipVerify)
}
}
func (s *SSHTunnel) String() string {
@@ -56,8 +87,7 @@ func (s SSHTunnel) Open(ctx context.Context) (*ssh.Client, error) {
return nil
},
HostKeyCallback: ssh.InsecureIgnoreHostKey(), // FIXME
User: s.Username,
User: s.Username,
}
if s.Auth.Password != nil {
@@ -86,8 +116,40 @@ func (s SSHTunnel) Open(ctx context.Context) (*ssh.Client, error) {
return nil, fmt.Errorf("Parsing private key: %w", err)
}
cfg.Auth = append(cfg.Auth, ssh.PublicKeys(signer))
} else if s.Auth.SSHAgent != nil {
sa, err := s.Auth.SSHAgent.getAgent()
if err != nil {
return nil, fmt.Errorf("Connecting to SSH agent: %w", err)
}
cfg.Auth = append(cfg.Auth, ssh.PublicKeysCallback(sa.Signers))
} else {
return nil, fmt.Errorf("Unsupported value %q for Auth", s.Auth.Type)
}
//
if s.HostVerification.Type == "" || s.HostVerification.InsecureSkipVerify != nil {
cfg.HostKeyCallback = ssh.InsecureIgnoreHostKey()
} else if s.HostVerification.ExternalKnownHostsFile != nil {
cb, err := knownhosts.New(string(s.HostVerification.ExternalKnownHostsFile.Path))
if err != nil {
return nil, fmt.Errorf("Parsing known_hosts file %q: %w")
}
cfg.HostKeyCallback = cb
} else {
return nil, fmt.Errorf("Unsupported value %q for HostVerification", s.HostVerification.Type)
}
//
// TODO DialContext
// Use wrapper from https://github.com/golang/go/issues/20288
return ssh.Dial("tcp", fmt.Sprintf("%s:%d", s.Server.Address, s.Server.Port), &cfg)

View File

@@ -202,6 +202,10 @@ func (ts *tableState) Ready() {
ts.tbl.SetEnabled(true)
}
func (ts *tableState) IsReady() bool {
return ts.tbl.IsEnabled()
}
// DeleteSelectedRows marks the selected rows for deletion.
func (ts *tableState) DeleteSelectedRows() {
rows := ts.tbl.SelectionModel().SelectedRows()

View File

@@ -32,6 +32,7 @@ func (bc *binColumn) Display(aRow int) *qt.QVariant {
func (bc *binColumn) Inspect(parent *qt.QWidget, aRow int) {
// do nothing
// TODO support hexview for noneditable columns
}
func (bc *binColumn) SimpleEditData(aRow int) *qt.QVariant {

View File

@@ -54,6 +54,24 @@ func slice_remove_index[T comparable](slice []T, s int) []T {
return append(slice[:s], slice[s+1:]...)
}
// slice_and copies a slice and adds one more thing on the end.
func slice_and[T comparable](base []T, and T) []T {
ret := make([]T, len(base)+1)
copy(ret, base)
ret[len(ret)-1] = and
return ret
}
// slice_apply creates a new slice where every element of the input arr is transformed.
func slice_apply[T comparable](arr []T, transform func(T) T) []T {
ret := make([]T, len(arr))
for i := 0; i < len(arr); i++ {
ret[i] = transform(arr[i])
}
return ret
}
// slice_set_len sets the length of the slice. Use it like append -
// x = slice_set_len(x, 10)
func slice_set_len[T any](slice []T, newlen int) []T {
@@ -94,3 +112,8 @@ func bson_find_id(doc bson.D) (string, bool) {
return "", false
}
func alloc_inplace[T any](target **T) {
var newObj T
*target = &newObj
}