Merge pull request #242 from robbiet480/bcrypt

Add a bcrypt function

crypto.go

@@ -30,7 +30,7 @@ import (
 	"strings"
 
 	"github.com/google/uuid"
-	"golang.org/x/crypto/bcrypt"
+	bcrypt_lib "golang.org/x/crypto/bcrypt"
 	"golang.org/x/crypto/scrypt"
 )
 
@@ -49,15 +49,20 @@ func adler32sum(input string) string {
 	return fmt.Sprintf("%d", hash)
 }
 
+func bcrypt(input string) string {
+	hash, err := bcrypt_lib.GenerateFromPassword([]byte(input), bcrypt_lib.DefaultCost)
+	if err != nil {
+		return fmt.Sprintf("failed to encrypt string with bcrypt: %s", err)
+	}
+
+	return string(hash)
+}
+
 func htpasswd(username string, password string) string {
 	if strings.Contains(username, ":") {
 		return fmt.Sprintf("invalid username: %s", username)
 	}
-	hash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
-	if err != nil {
-		return fmt.Sprintf("failed to create htpasswd: %s", err)
-	}
-	return fmt.Sprintf("%s:%s", username, hash)
+	return fmt.Sprintf("%s:%s", username, bcrypt(password))
 }
 
 // uuidv4 provides a safe and secure UUID v4 implementation

crypto_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	"golang.org/x/crypto/bcrypt"
+	bcrypt_lib "golang.org/x/crypto/bcrypt"
 )
 
 const (
@@ -37,6 +37,16 @@ func TestAdler32Sum(t *testing.T) {
 	}
 }
 
+func TestBcrypt(t *testing.T) {
+	out, err := runRaw(`{{"abc" | bcrypt}}`, nil)
+	if err != nil {
+		t.Error(err)
+	}
+	if bcrypt_lib.CompareHashAndPassword([]byte(out), []byte("abc")) != nil {
+		t.Error("Generated hash is not the equivalent for password:", "abc")
+	}
+}
+
 type HtpasswdCred struct {
 	Username string
 	Password string
@@ -59,7 +69,7 @@ func TestHtpasswd(t *testing.T) {
 		if 0 != strings.Compare(credential.Username, result[0]) && credential.Valid {
 			t.Error("Generated username did not match for:", credential.Username)
 		}
-		if bcrypt.CompareHashAndPassword([]byte(result[1]), []byte(credential.Password)) != nil && credential.Valid {
+		if bcrypt_lib.CompareHashAndPassword([]byte(result[1]), []byte(credential.Password)) != nil && credential.Valid {
 			t.Error("Generated hash is not the equivalent for password:", credential.Password)
 		}
 	}

docs/crypto.md

@@ -28,6 +28,13 @@ The `adler32sum` function receives a string, and computes its Adler-32 checksum.
 ```
 adler32sum "Hello world!"
 ```
+## bcrypt
+
+The `bcrypt` function receives a string, and generates its `bcrypt` hash.
+
+```
+bcrypt "myPassword"
+```
 
 ## htpasswd
 

functions.go

@@ -303,6 +303,7 @@ var genericMap = map[string]interface{}{
 	"concat":      concat,
 
 	// Crypto:
+	"bcrypt":            bcrypt,
 	"htpasswd":          htpasswd,
 	"genPrivateKey":     generatePrivateKey,
 	"derivePassword":    derivePassword,