Merge pull request #303 from essentialkaos/develop

Version 12.35.0

.scripts/packages.list

@@ -8,7 +8,7 @@
 * + env
 * + errutil
 * + events
-* ! directio
+* + directio
 * + fmtc
 * + fmtc/lscolors
 * + fmtutil
@@ -35,6 +35,7 @@ L + netutil
 * + progress
 * + rand
 * + req
+* + secstr
 * - signal
 * + sliceutil
 * + sortutil

CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Changelog
 
+### 12.35.0
+
+* `[secstr]` New package for working with protected (secure) strings
+* `[req]` Method `Query.String()` renamed to `Query.Encode()`
+* `[passwd]` Added method `GenPasswordVariations` and `GenPasswordBytesVariations` for generating password variations with possible typos fixes
+* `[passwd]` Added methods `HashBytes`, `CheckBytes`, `GenPasswordBytes` and `GetPasswordBytesStrength`
+* `[passwd]` Method `Encrypt` marked as depricated (_use `Hash` method instead_)
+* `[passwd]` Added more usage examples
+
 ### 12.34.0
 
 * `[fsutil]` Added method `TouchFile` for creating empty files

Makefile

@@ -18,6 +18,7 @@ deps: git-config ## Download dependencies
 
 deps-test: git-config ## Download dependencies for tests
 	go get -v github.com/axw/gocov/gocov
+	go get -v golang.org/x/sys/unix
 	go get -v pkg.re/essentialkaos/check.v1
 
 test: ## Run tests

README.md

@@ -67,6 +67,7 @@ go get -u pkg.re/essentialkaos/ek.v12
 * [`progress`](https://pkg.re/essentialkaos/ek.v12/progress?docs) - Package provides methods and structs for creating terminal progress bar
 * [`rand`](https://pkg.re/essentialkaos/ek.v12/rand?docs) - Package for generating random data
 * [`req`](https://pkg.re/essentialkaos/ek.v12/req?docs) - Package simplify working with an HTTP requests
+* [`secstr`](https://pkg.re/essentialkaos/ek.v12/secstr?docs) - Package provides methods and structs for working with protected (secure) strings
 * [`signal`](https://pkg.re/essentialkaos/ek.v12/signal?docs) - Package provides methods for handling POSIX signals
 * [`sliceutil`](https://pkg.re/essentialkaos/ek.v12/sliceutil?docs) - Package provides methods for working with slices
 * [`sortutil`](https://pkg.re/essentialkaos/ek.v12/sortutil?docs) - Package provides methods for sorting slices

ek.go

@@ -19,7 +19,7 @@ import (
 // ////////////////////////////////////////////////////////////////////////////////// //
 
 // VERSION is current ek package version
-const VERSION = "12.34.0"
+const VERSION = "12.35.0"
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 

passwd/example_test.go

@@ -13,6 +13,56 @@ import (
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+func ExampleHash() {
+	password, pepper := "MyPassword", "ABCD1234abcd1234"
+	hash, err := Hash(password, pepper)
+
+	if err != nil {
+		panic(err.Error())
+	}
+
+	fmt.Printf("Hash: %s\n", hash)
+}
+
+func ExampleHashBytes() {
+	password, pepper := []byte("MyPassword"), []byte("ABCD1234abcd1234")
+	hash, err := HashBytes(password, pepper)
+
+	if err != nil {
+		panic(err.Error())
+	}
+
+	fmt.Printf("Hash: %s\n", hash)
+}
+
+func ExampleCheck() {
+	password, pepper := "MyPassword", "ABCD1234abcd1234"
+	hash, err := Hash(password, pepper)
+
+	if err != nil {
+		panic(err.Error())
+	}
+
+	fmt.Printf("Valid: %t\n", Check(password, pepper, hash))
+
+	// Output:
+	// Valid: true
+}
+
+func ExampleCheckBytes() {
+	password, pepper := []byte("MyPassword"), []byte("ABCD1234abcd1234")
+	hash, err := HashBytes(password, pepper)
+
+	if err != nil {
+		panic(err.Error())
+	}
+
+	fmt.Printf("Valid: %t\n", CheckBytes(password, pepper, hash))
+
+	// Output:
+	// Valid: true
+}
+
 func ExampleGenPassword() {
 	weakPassword := GenPassword(16, STRENGTH_WEAK)
 	medPassword := GenPassword(16, STRENGTH_MEDIUM)
@@ -23,6 +73,16 @@ func ExampleGenPassword() {
 	fmt.Printf("Strong password: %s\n", strongPassword)
 }
 
+func ExampleGenPasswordBytes() {
+	weakPassword := GenPasswordBytes(16, STRENGTH_WEAK)
+	medPassword := GenPasswordBytes(16, STRENGTH_MEDIUM)
+	strongPassword := GenPasswordBytes(16, STRENGTH_STRONG)
+
+	fmt.Printf("Weak password: %s\n", weakPassword)
+	fmt.Printf("Medium password: %s\n", medPassword)
+	fmt.Printf("Strong password: %s\n", strongPassword)
+}
+
 func ExampleGetPasswordStrength() {
 	strength := GetPasswordStrength("secret1234%$")
 
@@ -38,3 +98,39 @@ func ExampleGetPasswordStrength() {
 	// Output:
 	// Password is ok
 }
+
+func ExampleGetPasswordBytesStrength() {
+	strength := GetPasswordBytesStrength([]byte("secret1234%$"))
+
+	switch strength {
+	case STRENGTH_STRONG:
+		fmt.Println("Password is strong")
+	case STRENGTH_MEDIUM:
+		fmt.Println("Password is ok")
+	case STRENGTH_WEAK:
+		fmt.Println("Password is weak")
+	}
+
+	// Output:
+	// Password is ok
+}
+
+func ExampleGenPasswordVariations() {
+	password := "myPassword12345"
+	variants := GenPasswordVariations(password)
+
+	fmt.Printf("Variants: %v\n", variants)
+
+	// Output:
+	// Variants: [MYpASSWORD12345 MyPassword12345 myPassword1234]
+}
+
+func ExampleGenPasswordBytesVariations() {
+	password := []byte("myPassword12345")
+	variants := GenPasswordBytesVariations(password)
+
+	fmt.Printf("Variants: %v\n", variants)
+
+	// Output:
+	// Variants: [[77 89 112 65 83 83 87 79 82 68 49 50 51 52 53] [77 121 80 97 115 115 119 111 114 100 49 50 51 52 53] [109 121 80 97 115 115 119 111 114 100 49 50 51 52]]
+}