Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

builtins: add gen_random_bytes builtin function #110107

Merged
merged 1 commit into from Sep 7, 2023
Merged

builtins: add gen_random_bytes builtin function #110107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/generated/sql/functions.md
View file
Open in desktop
Expand Up @@ -428,6 +428,8 @@
</ul>
<p>This function requires an enterprise license on a CCL distribution.</p>
</span></td><td>Immutable</td></tr>
<tr><td><a name="gen_random_bytes"></a><code>gen_random_bytes(count: <a href="int.html">int</a>) &rarr; <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns <code>count</code> cryptographically strong random bytes. At most 1024 bytes can be extracted at a time.</p>
</span></td><td>Volatile</td></tr>
<tr><td><a name="gen_salt"></a><code>gen_salt(type: <a href="string.html">string</a>) &rarr; <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Generates a salt for input into the <code>crypt</code> function using the default number of rounds.</p>
</span></td><td>Volatile</td></tr>
<tr><td><a name="gen_salt"></a><code>gen_salt(type: <a href="string.html">string</a>, iter_count: <a href="int.html">int</a>) &rarr; <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Generates a salt for input into the <code>crypt</code> function using <code>iter_count</code> number of rounds.</p>
Expand Down
21 changes: 21 additions & 0 deletions pkg/sql/logictest/testdata/logic_test/pgcrypto_builtins
View file
Open in desktop
Expand Up @@ -308,3 +308,24 @@ query error pgcode XXC01 decrypt_iv can only be used with a CCL distribution
SELECT decrypt_iv('\x91b4ef63852013c8da53829da662b871', 'key', '123', 'aes')

subtest end

subtest gen_random_bytes

statement error pgcode 22023 length 0 is outside the range
SELECT gen_random_bytes(0)

statement error pgcode 22023 length 1025 is outside the range
SELECT gen_random_bytes(1025)

query I
SELECT length(gen_random_bytes(10))
----
10

# Basic to make sure the same result isn't returned.
query B
SELECT gen_random_bytes(5) = gen_random_bytes(5)
----
false

subtest end
1 change: 1 addition & 0 deletions pkg/sql/sem/builtins/fixed_oids.go
View file
Open in desktop
Expand Up @@ -2457,6 +2457,7 @@ var builtinOidsArray = []string{
2486: `encrypt_iv(data: bytes, key: bytes, iv: bytes, type: string) -> bytes`,
2487: `decrypt(data: bytes, key: bytes, type: string) -> bytes`,
2488: `decrypt_iv(data: bytes, key: bytes, iv: bytes, type: string) -> bytes`,
2489: `gen_random_bytes(count: int) -> bytes`,
}

var builtinOidsBySignature map[string]oid.Oid
Expand Down
21 changes: 21 additions & 0 deletions pkg/sql/sem/builtins/pgcrypto_builtins.go
View file
Open in desktop
Expand Up @@ -225,6 +225,27 @@ var pgcryptoBuiltins = map[string]builtinDefinition{

"gen_random_uuid": generateRandomUUID4Impl(),

"gen_random_bytes": makeBuiltin(
tree.FunctionProperties{Category: builtinconstants.CategoryCrypto},
tree.Overload{
Types: tree.ParamTypes{{Name: "count", Typ: types.Int}},
ReturnType: tree.FixedReturnType(types.Bytes),
Fn: func(_ context.Context, _ *eval.Context, args tree.Datums) (tree.Datum, error) {
count := int(tree.MustBeDInt(args[0]))
if count < 1 || count > 1024 {
return nil, pgerror.Newf(pgcode.InvalidParameterValue, "length %d is outside the range [1, 1024]", count)
}
bytes, err := getRandomBytes(count)
if err != nil {
return nil, err
}
return tree.NewDBytes(tree.DBytes(bytes)), nil
},
Info: "Returns `count` cryptographically strong random bytes. At most 1024 bytes can be extracted at a time.",
Volatility: volatility.Volatile,
},
),

"gen_salt": makeBuiltin(
tree.FunctionProperties{Category: builtinconstants.CategoryCrypto},
tree.Overload{
Expand Down