Skip to content

fix(auth): Validate uuid params in admin methods #1171

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/gotrue/lib/src/gotrue_admin_api.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'package:gotrue/gotrue.dart';
import 'package:gotrue/src/fetch.dart';
import 'package:gotrue/src/helper.dart';
import 'package:gotrue/src/types/auth_response.dart';
import 'package:gotrue/src/types/fetch_options.dart';
import 'package:http/http.dart';
Expand Down Expand Up @@ -70,6 +71,7 @@ class GoTrueAdminApi {
///
/// This function should only be called on a server. Never expose your `service_role` key on the client.
Future<void> deleteUser(String id) async {
validateUuid(id);
final options = GotrueRequestOptions(headers: _headers);
await _fetch.request(
'$_url/admin/users/$id',
Expand Down Expand Up @@ -173,6 +175,7 @@ class GoTrueAdminApi {

/// Gets the user by their id.
Future<UserResponse> getUserById(String uid) async {
validateUuid(uid);
final options = GotrueRequestOptions(headers: _headers);
final response = await _fetch.request(
'$_url/admin/users/$uid',
Expand All @@ -187,6 +190,7 @@ class GoTrueAdminApi {
String uid, {
required AdminUserAttributes attributes,
}) async {
validateUuid(uid);
final body = attributes.toJson();
final options = GotrueRequestOptions(headers: _headers, body: body);
final response = await _fetch.request(
Expand Down
6 changes: 6 additions & 0 deletions packages/gotrue/lib/src/gotrue_admin_mfa_api.dart
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import 'fetch.dart';
import 'helper.dart';
import 'types/fetch_options.dart';
import 'types/mfa.dart';

Expand All @@ -17,6 +18,8 @@ class GoTrueAdminMFAApi {

Future<AuthMFAAdminListFactorsResponse> listFactors(
{required String userId}) async {
validateUuid(userId);

final data = await _fetch.request(
'$_url/admin/users/$userId/factors',
RequestMethodType.get,
Expand All @@ -33,6 +36,9 @@ class GoTrueAdminMFAApi {
required String userId,
required String factorId,
}) async {
validateUuid(userId);
validateUuid(factorId);

final data = await _fetch.request(
'$_url/admin/users/$userId/factors/$factorId',
RequestMethodType.delete,
Expand Down
9 changes: 9 additions & 0 deletions packages/gotrue/lib/src/helper.dart
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,12 @@ String generatePKCEChallenge(String verifier) {
return base64UrlEncode(sha256.convert(ascii.encode(verifier)).bytes)
.split('=')[0];
}

final uuidRegex =
RegExp(r'^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$');

void validateUuid(String id) {
if (!uuidRegex.hasMatch(id)) {
throw ArgumentError('Invalid id: $id, must be a valid UUID');
}
}
36 changes: 36 additions & 0 deletions packages/gotrue/test/admin_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,40 @@ void main() {
expect(userLengthBefore - 1, userLengthAfter);
});
});

group('validates ids', () {
test('deleteUser() validates ids', () {
expect(() => client.admin.deleteUser('invalid-id'),
throwsA(isA<ArgumentError>()));
});

test('getUserById() validates ids', () {
expect(() => client.admin.getUserById('invalid-id'),
throwsA(isA<ArgumentError>()));
});

test('updateUserById() validates ids', () {
expect(
() => client.admin.updateUserById('invalid-id',
attributes: AdminUserAttributes(email: 'test@test.com')),
throwsA(isA<ArgumentError>()));
});

test('listFactors() validates ids', () {
expect(() => client.admin.mfa.listFactors(userId: 'invalid-id'),
throwsA(isA<ArgumentError>()));
});

test('deleteFactor() validates ids', () {
expect(
() => client.admin.mfa.deleteFactor(
userId: 'invalid-id', factorId: 'invalid-factor-id'),
throwsA(isA<ArgumentError>()));

expect(
() => client.admin.mfa
.deleteFactor(userId: userId1, factorId: 'invalid-factor-id'),
throwsA(isA<ArgumentError>()));
});
});
}
Loading