Skip to content

Commit

Permalink
Remove the ondisk backend (#1720)
Browse files Browse the repository at this point in the history
This backend has never been fully completed and shouldn't be used
as-is.

RELEASE_NOTES=[CLEANUP] Remove the ondisk backend

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
  • Loading branch information
dominikschulz authored Jan 18, 2021
1 parent de2740d commit ad07e1f
Show file tree
Hide file tree
Showing 28 changed files with 24 additions and 1,546 deletions.
1 change: 0 additions & 1 deletion docs/backends.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ the context handlers in the same package.

* [fs](backends/fs.md) - Filesystem storage without RCS support
* [gitfs](backends/gitfs.md) - Filesystem storage with Git RCS
* [ondisk](backends/ondisk.md) - EXPERIMENTAL Fully encrypted filesystem storage with custom RCS

## Crypto Backends (crypto)

Expand Down
30 changes: 0 additions & 30 deletions docs/backends/ondisk.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/commands/convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Warning: Converting between different RCS backends will loose part of the histor
## Synopsis

```
$ gopass convert --store=foo --move=true --storage=ondisk --crypto=age
$ gopass convert --store=foo --move=true --storage=gitfs --crypto=age
$ gopass convert --store=bar --move=false --storage=fs --crypto=plain
```

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Note: We do not support adding recipients using `init`. Please use `gopass recip

```
$ gopass init
$ gopass init --crypto [age|gpg] --storage=[fs|gitfs|ondisk]
$ gopass init --crypto [age|gpg] --storage=[fs|gitfs]
```

## Flags
Expand All @@ -21,6 +21,6 @@ Flag | Aliases | Description
`--path` | `-p` | Initialize the (sub) store in this location.
`--store` | `-s` | Mount the newly initialized sub-store at this mount point
`--crypto` | | Select the crypto backend. Choose one of: `gpgcli`, `age`, `xc` (deprecated) or `plain`. Default: `gpgcli`
`--storage` | | Select the storage and RCS backend. Choose one of: `gitfs`, `fs`, `ondisk`. Default: `gitfs`
`--storage` | | Select the storage and RCS backend. Choose one of: `gitfs`, `fs`. Default: `gitfs`

See [backends.md](../backends.md) for more information on the available backends.
2 changes: 1 addition & 1 deletion docs/commands/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ TODO: We need to specify the expectations around new lines.
* The `--clip` flag will copy the value of the `Password` field to the clipboard and doesn't display any part of the secret.
* The `--alsoclip` option will copy the value of the `Password` field but also display the secret content depending on the `safecontent` setting, i.e. obstructing the `Password` field if `safecontent` is `true` or just displaying it if not.
* The `--qr` flags operates complementary to other flags. It will *additionally* format the value of the `Password` entry as a QR code and display it. Other than that it will honor the other options, e.g. `gopass show --qr` will display the QR code *and* the whole secret content below. One special case is the `-o` flag, this flag doesn't make a lot of sense in combination, so if both `--qr` and `-o` are given only the QR code will be displayed.
* Since gopass already supports different RCS backends (e.g. git and the custom `ondisk` format) we do not support arbitrary git refs as arguments to the `--revision` flag. Using those might work, but this is explicitly not supported and bug reports will be closed as `wont-fix`. There are two issues with using arbitrary git refs is that (a) this doesn't work with non-git RCS backends and (b) git versions a whole repository, not single files. So the revision `HEAD^`
* Since gopass plans to supports different RCS backends we do not support arbitrary git refs as arguments to the `--revision` flag. Using those might work, but this is explicitly not supported and bug reports will be closed as `wont-fix`. There are two issues with using arbitrary git refs is that (a) this doesn't work with non-git RCS backends and (b) git versions a whole repository, not single files. So the revision `HEAD^`
might not have any changes for a given entry. Thus we only support specifc revisions obtained from `gopass history` or our custom syntax `-N` where N is an integer identifying a specific commit before `HEAD` (cf. `HEAD~N`).

## Parsing and secrets
Expand Down
4 changes: 0 additions & 4 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ require (
github.com/martinhoefling/goxkcdpwgen v0.0.0-20190331205820-7dc3d102eca3
github.com/mattn/go-colorable v0.1.7
github.com/mattn/go-isatty v0.0.12
github.com/minio/minio-go/v7 v7.0.7
github.com/mitchellh/go-homedir v1.1.0
github.com/mitchellh/go-ps v1.0.0
github.com/muesli/crunchy v0.4.0
Expand All @@ -35,8 +34,6 @@ require (
github.com/pkg/errors v0.9.1
github.com/schollz/closestmatch v0.0.0-20190308193919-1fbe626be92e
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
github.com/smartystreets/assertions v1.0.0 // indirect
github.com/smartystreets/goconvey v1.6.4 // indirect
github.com/stretchr/testify v1.6.1
github.com/urfave/cli/v2 v2.2.0
github.com/xrash/smetrics v0.0.0-20200730060457-89a2a8a1fb0b // indirect
Expand All @@ -45,7 +42,6 @@ require (
golang.org/x/sys v0.0.0-20201024232916-9f70ab9862d5
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
gopkg.in/ini.v1 v1.60.1 // indirect
gopkg.in/yaml.v2 v2.3.0
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
gotest.tools v2.2.0+incompatible
Expand Down
Loading

0 comments on commit ad07e1f

Please sign in to comment.