added pseudorandom generator

This commit is contained in:
Gani Georgiev 2022-11-06 15:26:34 +02:00
parent 46dc6cc47c
commit 4cddb6b5cb
9 changed files with 89 additions and 47 deletions

View File

@ -91,7 +91,7 @@ func (api *settingsApi) testS3(c echo.Context) error {
} }
defer fs.Close() 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 { if err := fs.Upload([]byte("test"), testFileKey); err != nil {
return NewBadRequestError("Failed to upload a test file. Raw error: \n"+err.Error(), nil) return NewBadRequestError("Failed to upload a test file. Raw error: \n"+err.Error(), nil)

View File

@ -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. // This way we are always doing 1 more rename operation but it provides better dev experience.
if oldField == nil { if oldField == nil {
tempName := field.Name + security.RandomString(5) tempName := field.Name + security.PseudoRandomString(5)
toRename[tempName] = field.Name toRename[tempName] = field.Name
// add // add
@ -539,7 +539,7 @@ func (dao *Dao) SyncRecordTableSchema(newCollection *models.Collection, oldColle
return err return err
} }
} else if oldField.Name != field.Name { } else if oldField.Name != field.Name {
tempName := field.Name + security.RandomString(5) tempName := field.Name + security.PseudoRandomString(5)
toRename[tempName] = field.Name toRename[tempName] = field.Name
// rename // rename

View File

@ -129,7 +129,7 @@ func (dao *Dao) expandRecords(records []*models.Record, expandPath string, fetch
} }
// indirect relation // indirect relation
relField = &schema.SchemaField{ relField = &schema.SchemaField{
Id: "indirect_" + security.RandomString(3), Id: "indirect_" + security.PseudoRandomString(5),
Type: schema.FieldTypeRelation, Type: schema.FieldTypeRelation,
Name: parts[0], Name: parts[0],
Options: relFieldOptions, Options: relFieldOptions,

View File

@ -494,7 +494,7 @@ func TestCollectionUpsertWithCustomId(t *testing.T) {
newCollection := func() *models.Collection { newCollection := func() *models.Collection {
return &models.Collection{ return &models.Collection{
Name: "c_" + security.RandomString(4), Name: "c_" + security.PseudoRandomString(4),
Schema: existingCollection.Schema, Schema: existingCollection.Schema,
} }
} }

View File

@ -113,7 +113,7 @@ func (s *Schema) RemoveField(id string) {
func (s *Schema) AddField(newField *SchemaField) { func (s *Schema) AddField(newField *SchemaField) {
if newField.Id == "" { if newField.Id == "" {
// set default id // set default id
newField.Id = strings.ToLower(security.RandomString(8)) newField.Id = strings.ToLower(security.PseudoRandomString(8))
} }
for i, field := range s.fields { for i, field := range s.fields {

View File

@ -193,7 +193,7 @@ func (r *RecordFieldResolver) Resolve(fieldName string) (resultName string, plac
currentCollectionName = collection.Name currentCollectionName = collection.Name
currentTableAlias = "__auth_" + inflector.Columnify(currentCollectionName) currentTableAlias = "__auth_" + inflector.Columnify(currentCollectionName)
authIdParamKey := "auth" + security.RandomString(5) authIdParamKey := "auth" + security.PseudoRandomString(5)
authIdParams := dbx.Params{authIdParamKey: authRecordId} authIdParams := dbx.Params{authIdParamKey: authRecordId}
// --- // ---
@ -354,7 +354,7 @@ func (r *RecordFieldResolver) resolveStaticRequestField(path ...string) (resultN
resultVal = val resultVal = val
} }
placeholder := "f" + security.RandomString(7) placeholder := "f" + security.PseudoRandomString(5)
name := fmt.Sprintf("{:%s}", placeholder) name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: resultVal} params := dbx.Params{placeholder: resultVal}

View File

@ -133,7 +133,7 @@ func (f FilterData) resolveToken(token fexpr.Token, fieldResolver FieldResolver)
// current datetime constant // current datetime constant
// --- // ---
if token.Literal == "@now" { if token.Literal == "@now" {
placeholder := "t" + security.RandomString(7) placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder) name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: types.NowDateTime().String()} params := dbx.Params{placeholder: types.NowDateTime().String()}
@ -161,13 +161,13 @@ func (f FilterData) resolveToken(token fexpr.Token, fieldResolver FieldResolver)
return name, params, err return name, params, err
case fexpr.TokenText: case fexpr.TokenText:
placeholder := "t" + security.RandomString(7) placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder) name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: token.Literal} params := dbx.Params{placeholder: token.Literal}
return name, params, nil return name, params, nil
case fexpr.TokenNumber: case fexpr.TokenNumber:
placeholder := "t" + security.RandomString(7) placeholder := "t" + security.PseudoRandomString(8)
name := fmt.Sprintf("{:%s}", placeholder) name := fmt.Sprintf("{:%s}", placeholder)
params := dbx.Params{placeholder: cast.ToFloat64(token.Literal)} params := dbx.Params{placeholder: cast.ToFloat64(token.Literal)}

View File

@ -1,18 +1,18 @@
package security package security
import ( import (
"crypto/rand" cryptoRand "crypto/rand"
"math/big" "math/big"
mathRand "math/rand"
) )
// RandomString generates a random string with the specified length. const defaultRandomAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
//
// The generated string is cryptographically random and matches
// [A-Za-z0-9]+ (aka. it's transparent to URL-encoding).
func RandomString(length int) string {
const alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
return RandomStringWithAlphabet(length, alphabet) // RandomString generates a cryptographically random string with the specified length.
//
// The generated string matches [A-Za-z0-9]+ and it's transparent to URL-encoding.
func RandomString(length int) string {
return RandomStringWithAlphabet(length, defaultRandomAlphabet)
} }
// RandomStringWithAlphabet generates a cryptographically random string // RandomStringWithAlphabet generates a cryptographically random string
@ -24,7 +24,7 @@ func RandomStringWithAlphabet(length int, alphabet string) string {
max := big.NewInt(int64(len(alphabet))) max := big.NewInt(int64(len(alphabet)))
for i := range b { for i := range b {
n, err := rand.Int(rand.Reader, max) n, err := cryptoRand.Int(cryptoRand.Reader, max)
if err != nil { if err != nil {
panic(err) panic(err)
} }
@ -33,3 +33,27 @@ func RandomStringWithAlphabet(length int, alphabet string) string {
return string(b) 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)
}

View File

@ -8,47 +8,39 @@ import (
) )
func TestRandomString(t *testing.T) { func TestRandomString(t *testing.T) {
generated := []string{} testRandomString(t, security.RandomString)
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))
}
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)
}
} }
func TestRandomStringWithAlphabet(t *testing.T) { func TestRandomStringWithAlphabet(t *testing.T) {
testRandomStringWithAlphabet(t, security.RandomStringWithAlphabet)
}
func TestPseudoRandomString(t *testing.T) {
testRandomString(t, security.PseudoRandomString)
}
func TestPseudoRandomStringWithAlphabet(t *testing.T) {
testRandomStringWithAlphabet(t, security.PseudoRandomStringWithAlphabet)
}
// -------------------------------------------------------------------
func testRandomStringWithAlphabet(t *testing.T, randomFunc func(n int, alphabet string) string) {
scenarios := []struct { scenarios := []struct {
alphabet string alphabet string
expectPattern string expectPattern string
}{ }{
{"0123456789_", `[0-9_]+`}, {"0123456789_", `[0-9_]+`},
{"abcd", `[abcd]+`}, {"abcdef", `[abcdef]+`},
{"!@#$%^&*()", `[\!\@\#\$\%\^\&\*\(\)]+`}, {"!@#$%^&*()", `[\!\@\#\$\%\^\&\*\(\)]+`},
} }
for i, s := range scenarios { for i, s := range scenarios {
generated := make([]string, 0, 100) generated := make([]string, 0, 1000)
length := 10 length := 10
for j := 0; j < 100; j++ { for j := 0; j < 1000; j++ {
result := security.RandomStringWithAlphabet(length, s.alphabet) result := randomFunc(length, s.alphabet)
if len(result) != length { if len(result) != length {
t.Fatalf("(%d:%d) Expected the length of the string to be %d, got %d", i, j, length, len(result)) t.Fatalf("(%d:%d) Expected the length of the string to be %d, got %d", i, j, length, len(result))
@ -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)
}
}