Renamed crates and publish to crates.io.

apognu · Mar 23, 2019 · 3068d37 · 3068d37
1 parent f2963ff
commit 3068d37
Show file tree

Hide file tree

Showing 38 changed files with 147 additions and 112 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 members = [
+  "libknox",
   "knox",
-  "knox-bin",
   "knox-testing"
 ]
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ The following command creates an empty vault and takes the GPG identity for whic
 
 ```
 $ knox init [email protected]
- INFO  knox::commands::init > vault initialized successfully
+ INFO  libknox::commands::init > vault initialized successfully
 ```
 
 By default, the vault will be created in ```$HOME/.knox```. You can change this path by setting the ```KNOX_PATH``` environment variable.
@@ -57,7 +57,7 @@ By default, the vault will be created in ```$HOME/.knox```. You can change this
 
 ```
 $ knox add dir/subdir/website.com username=apognu password=Str0ngP@ss
- INFO  knox::commands::write > entry personal/website was successfully added to the vault
+ INFO  libknox::commands::write > entry personal/website was successfully added to the vault
 ```
 
 ```vault``` is attribute-agnostic, there is no special handling of, for instance, the ```password``` attribute. You can add any number of attributes to an entry.
@@ -69,7 +69,7 @@ One special kind of attribute is _confidential_ attributes. They only differ in
 ```
 $ knox add website.com username=apognu password=
 Enter value for 'password': 
- INFO  knox::commands::write > entry personal/website was successfully added to the vault
+ INFO  libknox::commands::write > entry personal/website was successfully added to the vault
 ```
 
 ### Generated passwords
@@ -90,7 +90,7 @@ An entire file can be embedded into an attribute with the syntax ```attr=@/path/
 
 ```
 $ knox add personal/ssh pubkey=@/home/apognu/.ssh/id_rsa.pub privkey=@/home/apognu/.ssh/id_rsa
-INFO  knox::commands::write > entry personal/ssh was successfully added to the vault
+INFO  libknox::commands::write > entry personal/ssh was successfully added to the vault
 $ knox show personal/ssh
 Store » ssh » keys
   privkey = <file content>
@@ -175,7 +175,7 @@ The syntax for modifying an existing secret is exactly the same as the one used
 
 ```
 $ knox edit website.com -d url username=newlogin password=
- INFO  knox::commands::write > entry website.com was successfully edited
+ INFO  libknox::commands::write > entry website.com was successfully edited
 ```
 
 This command will delete thre ```url``` attribute from the secret, change the ```username``` attribute to ```newlogin``` and prompt for the value of the redacted attribute ```password```
@@ -186,14 +186,14 @@ A secret can be renamed through the ```rename``` command:
 
 ```
 $ knox rename my/first/secret new/location/secret
- INFO  knox::commands::write > entry my/first/secret was successfully renamed to new/location/secret
+ INFO  libknox::commands::write > entry my/first/secret was successfully renamed to new/location/secret
 ```
 
 ## Delete a secret
 
 ```
 $ knox delete dir/subdir/website.com
- INFO  knox::commands::delete > entry 'dir/subdir/website.com' was successfully deleted from the vault
+ INFO  libknox::commands::delete > entry 'dir/subdir/website.com' was successfully deleted from the vault
 ```
 
 ## Check if you've been pwned
@@ -202,7 +202,7 @@ Vault integrates Troy Hunt's [Have I Been Pwned](https://haveibeenpwned.com/) to
 
 ```
 $ knox pwned my/super/password
-INFO  knox::commands::pwned > Pwnage status for attributes at pwned/test
+INFO  libknox::commands::pwned > Pwnage status for attributes at pwned/test
   ⚠ password -> PWNED
   ✓ secure -> CLEAR
   ⚠ apikey -> PWNED
@@ -213,7 +213,7 @@ The check is also performed for confidential attributes when adding or editing a
 You may also omit the ```PATH``` paramter to initiate a vault-wide check against the data breaches. This may take some time, but will check all confidential attributes in your vault:
 
 ```
-INFO  knox::commands::pwned > checking for pwned secret across your vault
+INFO  libknox::commands::pwned > checking for pwned secret across your vault
   ⚠  test/insecure/test1/password -> PWNED
   ⚠  test/insecure/test1/apikey -> PWNED
   ⚠  test/insecure/test2/password -> PWNED
@@ -232,10 +232,10 @@ When you add or remove an identity to or from the vault, all entries (including
 
 ```
 $ knox init [email protected]
- INFO  knox::commands::init > vault initialized successfully at /vault
+ INFO  libknox::commands::init > vault initialized successfully at /vault
 [...]
 $ knox identities add [email protected]
-INFO  knox::commands::identities > Writing metadata file...
+INFO  libknox::commands::identities > Writing metadata file...
 re-encrypting entry company/secret1
 re-encrypting entry personal/secret2
 re-encrypting entry company/secret2
@@ -256,7 +256,7 @@ The library contained in ```knox``` can be used by your program to access and ma
 #
 # main.rs
 
-use knox::prelude::*;
+use libknox::prelude::*;
 
 fn main() -> Result<(), Box<dyn Error>> {
   let context = VaultContext::open("/home/user/.knox")?;

diff --git a/knox-bin/Cargo.toml b/knox-bin/Cargo.toml
diff --git a/knox-bin/src/util/mod.rs b/knox-bin/src/util/mod.rs
diff --git a/knox-testing/Cargo.toml b/knox-testing/Cargo.toml
@@ -10,7 +10,7 @@ publish = false
 edition = "2018"
 
 [dependencies]
-knox = { path = "../knox" }
+libknox = { path = "../libknox" }
 tempfile = "^3.0"
 protobuf = "^2.2"
 gpgme = "^0.8"

diff --git a/knox/Cargo.toml b/knox/Cargo.toml
@@ -1,25 +1,31 @@
 [package]
 name = "knox"
 version = "0.1.0"
-description = "secret vault encrypted with GPG"
+description = "structured secret vault encrypted through GPG"
 authors = ["Antoine POPINEAU <[email protected]>"]
 repository = "https://github.com/apognu/knox"
 license = "MIT"
 
 edition = "2018"
 workspace = "../"
-build = "build.rs"
 
-[build-dependencies]
-protoc-rust = "2.0"
+[[bin]]
+name = "knox"
+path = "src/main.rs"
 
 [dev-dependencies]
 knox_testing = { path = "../knox-testing" }
 
 [dependencies]
-protobuf = "^2.2"
-gpgme = "^0.8"
-uuid = { version = "^0.7", features = ["v4"] }
-
-[features]
-protobufs = []
+libknox = "^0.1"
+log = "^0.4"
+pretty_env_logger = "^0.2"
+clap = { version = "^2.0", features = ["yaml"] }
+rand = "^0.6"
+rpassword = "2.1.0"
+colored = "1.6"
+clipboard = "^0.5"
+dirs = "1.0.4"
+reqwest = "^0.9.0"
+sha-1 = "^0.8.0"
+indicatif = "^0.11.0"
diff --git a/knox-bin/src/cli.yml → knox/src/cli.yml b/knox-bin/src/cli.yml → knox/src/cli.yml
diff --git a/knox-bin/src/commands/delete.rs → knox/src/commands/delete.rs b/knox-bin/src/commands/delete.rs → knox/src/commands/delete.rs
@@ -3,7 +3,7 @@ use std::error::Error;
 use colored::*;
 use log::*;
 
-use knox::prelude::*;
+use libknox::prelude::*;
 
 use crate::util::vault_path;
 
@@ -26,7 +26,7 @@ pub(crate) fn delete(args: &clap::ArgMatches) -> Result<(), Box<dyn Error>> {
 mod tests {
   use clap::App;
 
-  use knox::prelude::*;
+  use libknox::prelude::*;
   use knox_testing::spec;
 
   #[test]

diff --git a/knox-bin/src/commands/display.rs → knox/src/commands/display.rs b/knox-bin/src/commands/display.rs → knox/src/commands/display.rs
@@ -7,7 +7,7 @@ use colored::*;
 use log::*;
 
 use crate::util::{display, hierarchy, vault_path};
-use knox::prelude::*;
+use libknox::prelude::*;
 
 pub(crate) fn list(args: &clap::ArgMatches) -> Result<(), Box<dyn Error>> {
   let path = args.value_of("path");

diff --git a/knox-bin/src/commands/identities.rs → knox/src/commands/identities.rs b/knox-bin/src/commands/identities.rs → knox/src/commands/identities.rs
@@ -2,7 +2,7 @@ use std::error::Error;
 
 use colored::*;
 use indicatif::ProgressBar;
-use knox::prelude::*;
+use libknox::prelude::*;
 use log::*;
 
 use crate::util::vault_path;

diff --git a/knox-bin/src/commands/info.rs → knox/src/commands/info.rs b/knox-bin/src/commands/info.rs → knox/src/commands/info.rs
@@ -1,7 +1,7 @@
 use std::error::Error;
 
 use colored::*;
-use knox::prelude::*;
+use libknox::prelude::*;
 
 use crate::util::vault_path;
 

diff --git a/knox-bin/src/commands/init.rs → knox/src/commands/init.rs b/knox-bin/src/commands/init.rs → knox/src/commands/init.rs
@@ -3,7 +3,7 @@ use std::error::Error;
 use colored::*;
 use log::*;
 
-use knox::prelude::*;
+use libknox::prelude::*;
 
 use crate::util::vault_path;
 
@@ -26,7 +26,7 @@ pub(crate) fn init(args: &clap::ArgMatches) -> Result<(), Box<dyn Error>> {
 mod tests {
   use clap::App;
 
-  use knox::prelude::*;
+  use libknox::prelude::*;
   use knox_testing::spec;
 
   #[test]

diff --git a/knox-bin/src/commands/mod.rs → knox/src/commands/mod.rs b/knox-bin/src/commands/mod.rs → knox/src/commands/mod.rs
diff --git a/knox-bin/src/commands/pwned.rs → knox/src/commands/pwned.rs b/knox-bin/src/commands/pwned.rs → knox/src/commands/pwned.rs
@@ -3,7 +3,7 @@ use std::error::Error;
 
 use colored::*;
 use indicatif::ProgressBar;
-use knox::prelude::*;
+use libknox::prelude::*;
 use log::*;
 use sha1::{Digest, Sha1};
 

diff --git a/knox-bin/src/commands/write.rs → knox/src/commands/write.rs b/knox-bin/src/commands/write.rs → knox/src/commands/write.rs
@@ -1,7 +1,7 @@
 use std::error::Error;
 
 use colored::*;
-use knox::prelude::*;
+use libknox::prelude::*;
 use log::*;
 
 use crate::commands::pwned::{self, PwnedResult};
@@ -122,7 +122,7 @@ pub(crate) fn rename(args: &clap::ArgMatches) -> Result<(), Box<dyn Error>> {
 mod tests {
   use clap::App;
 
-  use knox::prelude::*;
+  use libknox::prelude::*;
   use knox_testing::spec;
 
   #[test]

diff --git a/knox-bin/src/main.rs → knox/src/main.rs b/knox-bin/src/main.rs → knox/src/main.rs
diff --git a/knox/src/spec.rs b/knox/src/spec.rs
@@ -1,10 +1,10 @@
-#[cfg(test)]
+// #[cfg(test)]
 use std::error::Error;
 use std::path::Path;
 
 use knox_testing::spec;
 
-use crate::prelude::*;
+use libknox::prelude::*;
 
 pub(crate) fn get_test_vault<P>(path: P) -> Result<VaultContext, Box<dyn Error>>
 where