Skip to content

Commit e3d37e4

Browse files
committed
Decouple vault package from cli and move it to a separate repo
1 parent 8acadf7 commit e3d37e4

32 files changed

+16
-1017
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
# Fosskey CLI
88

9+
Fosskey CLI (command-line interface) is the simplest way to start using an [encrypted vault][vault-repo] to store your secrets and passwords.
10+
11+
## What is Fosskey?
12+
913
Fosskey is a [**F**]ree, [**O**]pen-source, [**S**]ecure, and [**S**]elf-custodial keychain.
1014

1115
## How do "they" store our passwords?
@@ -145,6 +149,7 @@ Fosskey does not store the master key. Instead, it uses the Argon2id key-derivat
145149

146150
While using the recommended parameters specified in [RFC 9106][rfc9106-params], the encryption/decryption method took about 0.8 seconds to process on a quad-core Intel processor with 16 GiB of memory. If a master key is composed of 8 characters of upper-case (A-Z), lower-case (a-z) letters and numbers (0-9), and symbols (32), there will be a total of 94 possible characters. Therefore, at least a total of B=nP(r-1) brute-force attacks is required to guess the correct master key. Here "B" is the permutation of (n, r-1). Thus, with the target hardware configuration (quad-core, 16 GiB memory), it will take about 1.3 million computation years to brute-force the 8-character long master key.
147151

152+
[vault-repo]: https://github.com/fosskey/vault
148153
[chacha20-poly1305]: https://en.wikipedia.org/wiki/ChaCha20-Poly1305
149154
[argon2]: https://en.wikipedia.org/wiki/Argon2
150155
[rfc9106-params]: https://www.rfc-editor.org/rfc/rfc9106.html#name-parameter-choice

cmd/delete.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

cmd/fetch.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

cmd/insert.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

cmd/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

cmd/rekey.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

cmd/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
var rootCmd = &cobra.Command{
1212
Use: "foss",
1313
Short: "A free, open-source, secure, and self-custodial keychain",
14-
Version: "0.0.0",
14+
Version: "0.1.0",
1515
CompletionOptions: cobra.CompletionOptions{
1616
DisableDefaultCmd: false,
1717
HiddenDefaultCmd: true,

cmd/update.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"fmt"
66

77
"github.com/fosskey/cli/internal/util"
8-
"github.com/fosskey/cli/internal/vault"
8+
"github.com/fosskey/vault"
99
"github.com/spf13/cobra"
1010
)
1111

go.mod

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ module github.com/fosskey/cli
33
go 1.19
44

55
require (
6+
github.com/fosskey/vault v0.1.0
67
github.com/spf13/cobra v1.6.1
7-
golang.org/x/crypto v0.4.0
88
golang.org/x/term v0.3.0
99
)
1010

1111
require (
1212
github.com/inconshreveable/mousetrap v1.0.1 // indirect
1313
github.com/spf13/pflag v1.0.5 // indirect
14+
golang.org/x/crypto v0.4.0 // indirect
1415
golang.org/x/sys v0.3.0 // indirect
1516
)

go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
2+
github.com/fosskey/vault v0.1.0 h1:Ii7S0SfsesL2wt2QSn9dJn/OXR0mqNL4ABusQ6OHvLg=
3+
github.com/fosskey/vault v0.1.0/go.mod h1:RVYylQ3n2b9U/yzOkAMMhKPJthRfLLzRxdtK6ySKAWM=
24
github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc=
35
github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
46
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=

0 commit comments

Comments
 (0)