Files
apidash/lib/screens/common_widgets/auth/oauth2_field.dart

491 lines
17 KiB
Dart

import 'dart:convert';
import 'package:apidash/providers/settings_providers.dart';
import 'package:apidash/providers/collection_providers.dart';
import 'package:apidash/models/models.dart';
import 'package:apidash/utils/file_utils.dart';
import 'package:apidash/widgets/field_auth.dart';
import 'package:apidash_core/apidash_core.dart';
import 'package:apidash_design_system/apidash_design_system.dart';
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:timeago/timeago.dart' as timeago;
import 'consts.dart';
class OAuth2Fields extends ConsumerStatefulWidget {
final AuthModel? authData;
final bool readOnly;
final Function(AuthModel?)? updateAuth;
const OAuth2Fields({
super.key,
required this.authData,
this.updateAuth,
this.readOnly = false,
});
@override
ConsumerState<OAuth2Fields> createState() => _OAuth2FieldsState();
}
class _OAuth2FieldsState extends ConsumerState<OAuth2Fields> {
late OAuth2GrantType _grantType;
late TextEditingController _authorizationUrlController;
late TextEditingController _accessTokenUrlController;
late TextEditingController _clientIdController;
late TextEditingController _clientSecretController;
late TextEditingController _redirectUrlController;
late TextEditingController _scopeController;
late TextEditingController _stateController;
late String _codeChallengeMethod;
late TextEditingController _usernameController;
late TextEditingController _passwordController;
late TextEditingController _refreshTokenController;
late TextEditingController _identityTokenController;
late TextEditingController _accessTokenController;
DateTime? _tokenExpiration;
@override
void initState() {
super.initState();
final oauth2 = widget.authData?.oauth2;
_grantType = oauth2?.grantType ?? OAuth2GrantType.authorizationCode;
_authorizationUrlController =
TextEditingController(text: oauth2?.authorizationUrl ?? '');
_accessTokenUrlController =
TextEditingController(text: oauth2?.accessTokenUrl ?? '');
_clientIdController = TextEditingController(text: oauth2?.clientId ?? '');
_clientSecretController =
TextEditingController(text: oauth2?.clientSecret ?? '');
_redirectUrlController =
TextEditingController(text: oauth2?.redirectUrl ?? '');
_scopeController = TextEditingController(text: oauth2?.scope ?? '');
_stateController = TextEditingController(text: oauth2?.state ?? '');
_usernameController = TextEditingController(text: oauth2?.username ?? '');
_passwordController = TextEditingController(text: oauth2?.password ?? '');
_refreshTokenController =
TextEditingController(text: oauth2?.refreshToken ?? '');
_identityTokenController =
TextEditingController(text: oauth2?.identityToken ?? '');
_accessTokenController =
TextEditingController(text: oauth2?.accessToken ?? '');
_codeChallengeMethod = oauth2?.codeChallengeMethod ?? 'sha-256';
// Load credentials from file if available
_loadCredentialsFromFile();
}
Future<void> _loadCredentialsFromFile() async {
final credentialsFilePath = widget.authData?.oauth2?.credentialsFilePath;
if (credentialsFilePath != null && credentialsFilePath.isNotEmpty) {
try {
final credentialsFile = await loadFileFromPath(credentialsFilePath);
if (credentialsFile != null) {
final credentials = await credentialsFile.readAsString();
if (credentials.isNotEmpty) {
final Map<String, dynamic> decoded = jsonDecode(credentials);
setState(() {
if (decoded['refreshToken'] != null) {
_refreshTokenController.text = decoded['refreshToken']!;
} else {
_refreshTokenController.text = "N/A";
}
if (decoded['idToken'] != null) {
_identityTokenController.text = decoded['idToken']!;
} else {
_identityTokenController.text = "N/A";
}
if (decoded['accessToken'] != null) {
_accessTokenController.text = decoded['accessToken']!;
} else {
_accessTokenController.text = "N/A";
}
// Parse expiration time
if (decoded['expiration'] != null) {
_tokenExpiration =
DateTime.fromMillisecondsSinceEpoch(decoded['expiration']!);
} else {
_tokenExpiration = null;
}
});
}
}
} catch (e) {
// Handle file reading or JSON parsing errors silently
debugPrint('Error loading OAuth2 credentials: $e');
}
}
}
@override
Widget build(BuildContext context) {
// Watch for changes in the selected request model's HTTP response
ref.listen<RequestModel?>(selectedRequestModelProvider, (previous, next) {
// Check if the HTTP response has changed (new response received)
if (previous?.httpResponseModel != next?.httpResponseModel &&
next?.httpResponseModel != null) {
// Only reload if this request uses OAuth2 auth and has credentials file path
final authModel = next?.httpRequestModel?.authModel;
if (authModel?.type == APIAuthType.oauth2 &&
authModel?.oauth2?.credentialsFilePath != null) {
// Small delay to ensure file is written before reading
Future.delayed(const Duration(milliseconds: 100), () {
_loadCredentialsFromFile();
});
}
}
});
return ListView(
shrinkWrap: true,
physics: ClampingScrollPhysics(),
children: [
Text(
kLabelOAuth2GrantType,
style: Theme.of(context).textTheme.labelLarge,
),
kVSpacer5,
ADPopupMenu<OAuth2GrantType>(
value: _grantType.displayType,
values: OAuth2GrantType.values.map((e) => (e, e.displayType)),
tooltip: kTooltipOAuth2GrantType,
isOutlined: true,
onChanged: widget.readOnly
? null
: (OAuth2GrantType? newGrantType) {
if (newGrantType != null && newGrantType != _grantType) {
setState(() {
_grantType = newGrantType;
});
_updateOAuth2();
}
},
),
kVSpacer16,
if (_shouldShowField(OAuth2Field.authorizationUrl))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _authorizationUrlController,
hintText: kHintOAuth2AuthorizationUrl,
infoText: kInfoOAuth2AuthorizationUrl,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.username))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _usernameController,
hintText: kHintOAuth2Username,
infoText: kInfoOAuth2Username,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.password))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _passwordController,
hintText: kHintOAuth2Password,
infoText: kInfoOAuth2Password,
isObscureText: true,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.accessTokenUrl))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _accessTokenUrlController,
hintText: kHintOAuth2AccessTokenUrl,
infoText: kInfoOAuth2AccessTokenUrl,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.clientId))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _clientIdController,
hintText: kHintOAuth2ClientId,
infoText: kInfoOAuth2ClientId,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.clientSecret))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _clientSecretController,
hintText: kHintOAuth2ClientSecret,
infoText: kInfoOAuth2ClientSecret,
isObscureText: true,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.codeChallengeMethod)) ...[
Text(
kLabelOAuth2CodeChallengeMethod,
style: Theme.of(context).textTheme.labelLarge,
),
kVSpacer5,
ADPopupMenu<String>(
value: _codeChallengeMethod.toUpperCase(),
values: const [
('SHA-256', 'sha-256'),
('Plaintext', 'plaintext'),
],
tooltip: kTooltipOAuth2CodeChallengeMethod,
isOutlined: true,
onChanged: widget.readOnly
? null
: (String? newMethod) {
if (newMethod != null &&
newMethod != _codeChallengeMethod) {
setState(() {
_codeChallengeMethod = newMethod;
});
_updateOAuth2();
}
},
),
kVSpacer16,
],
if (_shouldShowField(OAuth2Field.redirectUrl))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _redirectUrlController,
hintText: kHintOAuth2RedirectUrl,
infoText: kInfoOAuth2RedirectUrl,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.scope))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _scopeController,
hintText: kHintOAuth2Scope,
infoText: kInfoOAuth2Scope,
onChanged: (_) => _updateOAuth2(),
),
),
if (_shouldShowField(OAuth2Field.state))
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _stateController,
hintText: kHintOAuth2State,
infoText: kInfoOAuth2State,
onChanged: (_) => _updateOAuth2(),
),
),
..._buildFieldWithSpacing(
ADTextButton(
label: kButtonClearOAuth2Session,
onPressed: clearStoredCredentials,
),
),
Divider(),
kVSpacer16,
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _refreshTokenController,
hintText: kHintOAuth2RefreshToken,
infoText: kInfoOAuth2RefreshToken,
onChanged: (_) => _updateOAuth2(),
),
),
..._buildFieldWithSpacing(
AuthTextField(
readOnly: widget.readOnly,
controller: _identityTokenController,
hintText: kHintOAuth2IdentityToken,
infoText: kInfoOAuth2IdentityToken,
onChanged: (_) => _updateOAuth2(),
),
),
..._buildFieldWithSpacing(
Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
AuthTextField(
readOnly: widget.readOnly,
controller: _accessTokenController,
hintText: kHintOAuth2AccessToken,
infoText: kInfoOAuth2AccessToken,
onChanged: (_) => _updateOAuth2(),
),
if (_tokenExpiration != null) ...[
const SizedBox(height: 4),
Text(
_getExpirationText(),
style: Theme.of(context).textTheme.bodySmall?.copyWith(
color: _tokenExpiration!.isBefore(DateTime.now())
? Theme.of(context).colorScheme.error
: Theme.of(context).colorScheme.onSurfaceVariant,
),
),
],
],
),
),
kVSpacer16,
],
);
}
List<Widget> _buildFieldWithSpacing(Widget field) {
return [
field,
kVSpacer16,
];
}
bool _shouldShowField(OAuth2Field field) {
const alwaysShownFields = {
OAuth2Field.accessTokenUrl,
OAuth2Field.clientId,
OAuth2Field.clientSecret,
OAuth2Field.scope,
OAuth2Field.refreshToken,
OAuth2Field.identityToken,
OAuth2Field.accessToken,
OAuth2Field.clearSession,
};
if (alwaysShownFields.contains(field)) {
return true;
}
switch (_grantType) {
case OAuth2GrantType.authorizationCode:
return const {
OAuth2Field.authorizationUrl,
OAuth2Field.redirectUrl,
OAuth2Field.codeChallengeMethod,
OAuth2Field.state,
}.contains(field);
case OAuth2GrantType.resourceOwnerPassword:
return const {
OAuth2Field.username,
OAuth2Field.password,
}.contains(field);
case OAuth2GrantType.clientCredentials:
return false;
}
}
void _updateOAuth2() async {
final String? credentialsFilePath =
ref.read(settingsProvider).workspaceFolderPath;
if (credentialsFilePath == null) {
return;
}
final updatedOAuth2 = AuthOAuth2Model(
grantType: _grantType,
authorizationUrl: _authorizationUrlController.text.trim(),
clientId: _clientIdController.text.trim(),
accessTokenUrl: _accessTokenUrlController.text.trim(),
clientSecret: _clientSecretController.text.trim(),
credentialsFilePath: "$credentialsFilePath/oauth2_credentials.json",
codeChallengeMethod: _codeChallengeMethod,
redirectUrl: _redirectUrlController.text.trim(),
scope: _scopeController.text.trim(),
state: _stateController.text.trim(),
username: _usernameController.text.trim(),
password: _passwordController.text.trim(),
refreshToken: _refreshTokenController.text.trim(),
identityToken: _identityTokenController.text.trim(),
accessToken: _accessTokenController.text.trim(),
);
widget.updateAuth?.call(
widget.authData?.copyWith(
type: APIAuthType.oauth2,
oauth2: updatedOAuth2,
) ??
AuthModel(
type: APIAuthType.oauth2,
oauth2: updatedOAuth2,
),
);
}
Future<void> clearStoredCredentials() async {
final credentialsFilePath = widget.authData?.oauth2?.credentialsFilePath;
if (credentialsFilePath != null && credentialsFilePath.isNotEmpty) {
await deleteFileFromPath(credentialsFilePath);
}
setState(() {
_refreshTokenController.text = "";
_accessTokenController.text = "";
_identityTokenController.text = "";
_tokenExpiration = null;
});
}
String _getExpirationText() {
if (_tokenExpiration == null) {
return "";
}
final now = DateTime.now();
if (_tokenExpiration!.isBefore(now)) {
return "Token expired ${timeago.format(_tokenExpiration!, clock: now)}";
} else {
// For future times, we want to show "in X hours" instead of "X hours from now"
final duration = _tokenExpiration!.difference(now);
if (duration.inDays > 0) {
return "Token expires in ${duration.inDays} day${duration.inDays > 1 ? 's' : ''}";
} else if (duration.inHours > 0) {
return "Token expires in ${duration.inHours} hour${duration.inHours > 1 ? 's' : ''}";
} else if (duration.inMinutes > 0) {
return "Token expires in ${duration.inMinutes} minute${duration.inMinutes > 1 ? 's' : ''}";
} else {
return "Token expires in less than a minute";
}
}
}
@override
void dispose() {
_authorizationUrlController.dispose();
_accessTokenUrlController.dispose();
_clientIdController.dispose();
_clientSecretController.dispose();
_redirectUrlController.dispose();
_scopeController.dispose();
_stateController.dispose();
_usernameController.dispose();
_passwordController.dispose();
_refreshTokenController.dispose();
_identityTokenController.dispose();
_accessTokenController.dispose();
super.dispose();
}
}
enum OAuth2Field {
authorizationUrl,
accessTokenUrl,
clientId,
clientSecret,
redirectUrl,
scope,
state,
codeChallengeMethod,
username,
password,
refreshToken,
identityToken,
accessToken,
clearSession,
}