Skip to content

Commit

Permalink
added pseudorandom generator
Browse files Browse the repository at this point in the history
  • Loading branch information
ganigeorgiev committed Nov 6, 2022
1 parent 46dc6cc commit 4cddb6b
Show file tree
Hide file tree
Showing 9 changed files with 86 additions and 44 deletions.
2 changes: 1 addition & 1 deletion apis/settings.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ func (api *settingsApi) testS3(c echo.Context) error {
}
defer fs.Close()

testFileKey := "pb_test_" + security.RandomString(5) + "/test.txt"
testFileKey := "pb_test_" + security.PseudoRandomString(5) + "/test.txt"

if err := fs.Upload([]byte("test"), testFileKey); err != nil {
return NewBadRequestError("Failed to upload a test file. Raw error: \n"+err.Error(), nil)
Expand Down
4 changes: 2 additions & 2 deletions daos/record.go
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ func (dao *Dao) SyncRecordTableSchema(newCollection *models.Collection, oldColle
// This way we are always doing 1 more rename operation but it provides better dev experience.

if oldField == nil {
tempName := field.Name + security.RandomString(5)
tempName := field.Name + security.PseudoRandomString(5)
toRename[tempName] = field.Name

// add
Expand All @@ -539,7 +539,7 @@ func (dao *Dao) SyncRecordTableSchema(newCollection *models.Collection, oldColle
return err
}
} else if oldField.Name != field.Name {
tempName := field.Name + security.RandomString(5)
tempName := field.Name + security.PseudoRandomString(5)
toRename[tempName] = field.Name

// rename
Expand Down
2 changes: 1 addition & 1 deletion daos/record_expand.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ func (dao *Dao) expandRecords(records []*models.Record, expandPath string, fetch
}
// indirect relation
relField = &schema.SchemaField{
Id: "indirect_" + security.RandomString(3),
Id: "indirect_" + security.PseudoRandomString(5),
Type: schema.FieldTypeRelation,
Name: parts[0],
Options: relFieldOptions,
Expand Down
2 changes: 1 addition & 1 deletion forms/collection_upsert_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ func TestCollectionUpsertWithCustomId(t *testing.T) {

newCollection := func() *models.Collection {
return &models.Collection{
Name: "c_" + security.RandomString(4),
Name: "c_" + security.PseudoRandomString(4),
Schema: existingCollection.Schema,
}
}
Expand Down
2 changes: 1 addition & 1 deletion models/schema/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ func (s *Schema) RemoveField(id string) {
func (s *Schema) AddField(newField *SchemaField) {
if newField.Id == "" {
// set default id
newField.Id = strings.ToLower(security.RandomString(8))
newField.Id = strings.ToLower(security.PseudoRandomString(8))
}

for i, field := range s.fields {
Expand Down
4 changes: 2 additions & 2 deletions resolvers/record_field_resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ func (r *RecordFieldResolver) Resolve(fieldName string) (resultName string, plac
currentCollectionName = collection.Name
currentTableAlias = "__auth_" + inflector.Columnify(currentCollectionName)

authIdParamKey := "auth" + security.RandomString(5)
authIdParamKey := "auth" + security.PseudoRandomString(5)
authIdParams := dbx.Params{authIdParamKey: authRecordId}
// ---

Expand Down Expand Up @@ -354,7 +354,7 @@ func (r *RecordFieldResolver) resolveStaticRequestField(path ...string) (resultN
resultVal = val
}

placeholder := "f" + security.RandomString(7)
placeholder := "f" + security.PseudoRandomString(5)
name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: resultVal}

Expand Down
6 changes: 3 additions & 3 deletions tools/search/filter.go
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ func (f FilterData) resolveToken(token fexpr.Token, fieldResolver FieldResolver)
// current datetime constant
// ---
if token.Literal == "@now" {
placeholder := "t" + security.RandomString(7)
placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: types.NowDateTime().String()}

Expand Down Expand Up @@ -161,13 +161,13 @@ func (f FilterData) resolveToken(token fexpr.Token, fieldResolver FieldResolver)

return name, params, err
case fexpr.TokenText:
placeholder := "t" + security.RandomString(7)
placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: token.Literal}

return name, params, nil
case fexpr.TokenNumber:
placeholder := "t" + security.RandomString(7)
placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: cast.ToFloat64(token.Literal)}

Expand Down
40 changes: 32 additions & 8 deletions tools/security/random.go
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
package security

import (
"crypto/rand"
cryptoRand "crypto/rand"
"math/big"
mathRand "math/rand"
)

// RandomString generates a random string with the specified length.
const defaultRandomAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"

// RandomString generates a cryptographically random string with the specified length.
//
// The generated string is cryptographically random and matches
// [A-Za-z0-9]+ (aka. it's transparent to URL-encoding).
// The generated string matches [A-Za-z0-9]+ and it's transparent to URL-encoding.
func RandomString(length int) string {
const alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"

return RandomStringWithAlphabet(length, alphabet)
return RandomStringWithAlphabet(length, defaultRandomAlphabet)
}

// RandomStringWithAlphabet generates a cryptographically random string
Expand All @@ -24,7 +24,7 @@ func RandomStringWithAlphabet(length int, alphabet string) string {
max := big.NewInt(int64(len(alphabet)))

for i := range b {
n, err := rand.Int(rand.Reader, max)
n, err := cryptoRand.Int(cryptoRand.Reader, max)
if err != nil {
panic(err)
}
Expand All @@ -33,3 +33,27 @@ func RandomStringWithAlphabet(length int, alphabet string) string {

return string(b)
}

// RandomString generates a pseudorandom string with the specified length.
//
// The generated string matches [A-Za-z0-9]+ and it's transparent to URL-encoding.
//
// For a cryptographically random string (but a little bit slower) use PseudoRandomString instead.
func PseudoRandomString(length int) string {
return RandomStringWithAlphabet(length, defaultRandomAlphabet)
}

// PseudoRandomStringWithAlphabet generates a pseudorandom string
// with the specified length and characters set.
//
// For a cryptographically random (but a little bit slower) use RandomStringWithAlphabet instead.
func PseudoRandomStringWithAlphabet(length int, alphabet string) string {
b := make([]byte, length)
max := len(alphabet)

for i := range b {
b[i] = alphabet[mathRand.Intn(max)]
}

return string(b)
}
68 changes: 43 additions & 25 deletions tools/security/random_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,47 +8,39 @@ import (
)

func TestRandomString(t *testing.T) {
generated := []string{}
reg := regexp.MustCompile(`[a-zA-Z0-9]+`)
length := 10

for i := 0; i < 100; i++ {
result := security.RandomString(length)

if len(result) != length {
t.Fatalf("(%d) Expected the length of the string to be %d, got %d", i, length, len(result))
}
testRandomString(t, security.RandomString)
}

if match := reg.MatchString(result); !match {
t.Fatalf("(%d) The generated string should have only [a-zA-Z0-9]+ characters, got %q", i, result)
}
func TestRandomStringWithAlphabet(t *testing.T) {
testRandomStringWithAlphabet(t, security.RandomStringWithAlphabet)
}

for _, str := range generated {
if str == result {
t.Fatalf("(%d) Repeating random string - found %q in \n%v", i, result, generated)
}
}
func TestPseudoRandomString(t *testing.T) {
testRandomString(t, security.PseudoRandomString)
}

generated = append(generated, result)
}
func TestPseudoRandomStringWithAlphabet(t *testing.T) {
testRandomStringWithAlphabet(t, security.PseudoRandomStringWithAlphabet)
}

func TestRandomStringWithAlphabet(t *testing.T) {
// -------------------------------------------------------------------

func testRandomStringWithAlphabet(t *testing.T, randomFunc func(n int, alphabet string) string) {
scenarios := []struct {
alphabet string
expectPattern string
}{
{"0123456789_", `[0-9_]+`},
{"abcd", `[abcd]+`},
{"abcdef", `[abcdef]+`},
{"!@#$%^&*()", `[\!\@\#\$\%\^\&\*\(\)]+`},
}

for i, s := range scenarios {
generated := make([]string, 0, 100)
generated := make([]string, 0, 1000)
length := 10

for j := 0; j < 100; j++ {
result := security.RandomStringWithAlphabet(length, s.alphabet)
for j := 0; j < 1000; j++ {
result := randomFunc(length, s.alphabet)

if len(result) != length {
t.Fatalf("(%d:%d) Expected the length of the string to be %d, got %d", i, j, length, len(result))
Expand All @@ -69,3 +61,29 @@ func TestRandomStringWithAlphabet(t *testing.T) {
}
}
}

func testRandomString(t *testing.T, randomFunc func(n int) string) {
generated := make([]string, 0, 1000)
reg := regexp.MustCompile(`[a-zA-Z0-9]+`)
length := 10

for i := 0; i < 1000; i++ {
result := randomFunc(length)

if len(result) != length {
t.Fatalf("(%d) Expected the length of the string to be %d, got %d", i, length, len(result))
}

if match := reg.MatchString(result); !match {
t.Fatalf("(%d) The generated string should have only [a-zA-Z0-9]+ characters, got %q", i, result)
}

for _, str := range generated {
if str == result {
t.Fatalf("(%d) Repeating random string - found %q in \n%v", i, result, generated)
}
}

generated = append(generated, result)
}
}

0 comments on commit 4cddb6b

Please sign in to comment.