Compare commits

..

No commits in common. "300a52f9fe2af18eb091adeccbe706afc7e32e12" and "bfd28c281e480912cb1a9298c73595553e73910d" have entirely different histories.

21 changed files with 225 additions and 240 deletions

View File

@ -10,7 +10,7 @@ void main() {
});
final log = Logger('FailureReconnectionTest');
test('Failing an awaited connection with TestingSleepReconnectionPolicy', () async {
test('Failing an awaited connection', () async {
var errors = 0;
final connection = XmppConnection(
TestingSleepReconnectionPolicy(10),
@ -52,47 +52,4 @@ void main() {
await Future.delayed(const Duration(seconds: 20));
expect(errors, 1);
}, timeout: Timeout.factor(2));
test('Failing an awaited connection with ExponentialBackoffReconnectionPolicy', () async {
var errors = 0;
final connection = XmppConnection(
ExponentialBackoffReconnectionPolicy(1),
TCPSocketWrapper(false),
);
connection.registerFeatureNegotiators([
StartTlsNegotiator(),
]);
connection.registerManagers([
DiscoManager(),
RosterManager(),
PingManager(),
MessageManager(),
PresenceManager('http://moxxmpp.example'),
]);
connection.asBroadcastStream().listen((event) {
if (event is ConnectionStateChangedEvent) {
if (event.state == XmppConnectionState.error) {
errors++;
}
}
});
connection.setConnectionSettings(
ConnectionSettings(
jid: JID.fromString('testuser@no-sasl.badxmpp.eu'),
password: 'abc123',
useDirectTLS: true,
allowPlainAuth: true,
),
);
final result = await connection.connectAwaitable();
log.info('Connection failed as expected');
expect(result.success, false);
expect(errors, 1);
log.info('Waiting 20 seconds for unexpected reconnections');
await Future.delayed(const Duration(seconds: 20));
expect(errors, 1);
}, timeout: Timeout.factor(2));
}

View File

@ -25,12 +25,12 @@ export 'package:moxxmpp/src/presence.dart';
export 'package:moxxmpp/src/reconnect.dart';
export 'package:moxxmpp/src/rfcs/rfc_2782.dart';
export 'package:moxxmpp/src/rfcs/rfc_4790.dart';
export 'package:moxxmpp/src/roster/errors.dart';
export 'package:moxxmpp/src/roster/roster.dart';
export 'package:moxxmpp/src/roster.dart';
export 'package:moxxmpp/src/settings.dart';
export 'package:moxxmpp/src/socket.dart';
export 'package:moxxmpp/src/stanza.dart';
export 'package:moxxmpp/src/stringxml.dart';
export 'package:moxxmpp/src/types/error.dart';
export 'package:moxxmpp/src/types/result.dart';
export 'package:moxxmpp/src/xeps/staging/extensible_file_thumbnails.dart';
export 'package:moxxmpp/src/xeps/staging/file_upload_notification.dart';
@ -61,8 +61,7 @@ export 'package:moxxmpp/src/xeps/xep_0333.dart';
export 'package:moxxmpp/src/xeps/xep_0334.dart';
export 'package:moxxmpp/src/xeps/xep_0352.dart';
export 'package:moxxmpp/src/xeps/xep_0359.dart';
export 'package:moxxmpp/src/xeps/xep_0363/errors.dart';
export 'package:moxxmpp/src/xeps/xep_0363/xep_0363.dart';
export 'package:moxxmpp/src/xeps/xep_0363.dart';
export 'package:moxxmpp/src/xeps/xep_0380.dart';
export 'package:moxxmpp/src/xeps/xep_0384/crypto.dart';
export 'package:moxxmpp/src/xeps/xep_0384/errors.dart';

View File

@ -2,7 +2,6 @@ import 'dart:async';
import 'package:logging/logging.dart';
import 'package:meta/meta.dart';
import 'package:moxxmpp/src/buffer.dart';
import 'package:moxxmpp/src/errors.dart';
import 'package:moxxmpp/src/events.dart';
import 'package:moxxmpp/src/iq.dart';
import 'package:moxxmpp/src/managers/attributes.dart';
@ -15,7 +14,7 @@ import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/presence.dart';
import 'package:moxxmpp/src/reconnect.dart';
import 'package:moxxmpp/src/roster/roster.dart';
import 'package:moxxmpp/src/roster.dart';
import 'package:moxxmpp/src/routing.dart';
import 'package:moxxmpp/src/settings.dart';
import 'package:moxxmpp/src/socket.dart';
@ -62,14 +61,14 @@ class XmppConnectionResult {
const XmppConnectionResult(
this.success,
{
this.error,
this.reason,
}
);
final bool success;
// If a connection attempt fails, i.e. success is false, then this indicates the
// reason the connection failed.
final XmppError? error;
// NOTE: [reason] is not human-readable, but the type of SASL error.
// See sasl/errors.dart
final String? reason;
}
class XmppConnection {
@ -346,8 +345,12 @@ class XmppConnection {
}
/// Called when a stream ending error has occurred
Future<void> handleError(XmppError error) async {
_log.severe('handleError called with ${error.toString()}');
Future<void> handleError(Object? error) async {
if (error != null) {
_log.severe('handleError: $error');
} else {
_log.severe('handleError: Called with null');
}
// Whenever we encounter an error that would trigger a reconnection attempt while
// the connection result is being awaited, don't attempt a reconnection but instead
@ -355,12 +358,7 @@ class XmppConnection {
if (_connectionCompleter != null) {
_log.info('Not triggering reconnection since connection result is being awaited');
await _disconnect(triggeredByUser: false, state: XmppConnectionState.error);
_connectionCompleter?.complete(
XmppConnectionResult(
false,
error: error,
),
);
_connectionCompleter?.complete(const XmppConnectionResult(false));
_connectionCompleter = null;
return;
}
@ -372,7 +370,7 @@ class XmppConnection {
/// Called whenever the socket creates an event
Future<void> _handleSocketEvent(XmppSocketEvent event) async {
if (event is XmppSocketErrorEvent) {
await handleError(SocketError(event));
await handleError(event.error);
} else if (event is XmppSocketClosureEvent) {
if (_socketClosureTriggersReconnect) {
_log.fine('Received XmppSocketClosureEvent. Reconnecting...');
@ -527,7 +525,7 @@ class XmppConnection {
/// Called when we timeout during connecting
Future<void> _onConnectingTimeout() async {
_log.severe('Connection stuck in "connecting". Causing a reconnection...');
await handleError(TimeoutError());
await handleError('Connecting timeout');
}
void _destroyConnectingTimer() {
@ -751,34 +749,20 @@ class XmppConnection {
// Send out initial presence
await getPresenceManager().sendInitialPresence();
}
/// To be called after _currentNegotiator!.negotiate(..) has been called. Checks the
/// state of the negotiator and picks the next negotiatior, ends negotiation or
/// waits, depending on what the negotiator did.
Future<void> _checkCurrentNegotiator() async {
if (_currentNegotiator!.state == NegotiatorState.done) {
_log.finest('Negotiator ${_currentNegotiator!.id} done');
Future<void> _executeCurrentNegotiator(XMLNode nonza) async {
// If we don't have a negotiator get one
_currentNegotiator ??= getNextNegotiator(_streamFeatures);
if (_currentNegotiator == null && _isMandatoryNegotiationDone(_streamFeatures) && !_isNegotiationPossible(_streamFeatures)) {
_log.finest('Negotiations done!');
_updateRoutingState(RoutingState.handleStanzas);
await _onNegotiationsDone();
return;
}
final result = await _currentNegotiator!.negotiate(nonza);
if (result.isType<NegotiatorError>()) {
_log.severe('Negotiator returned an error');
await handleError(result.get<NegotiatorError>());
return;
}
final state = result.get<NegotiatorState>();
_currentNegotiator!.state = state;
switch (state) {
case NegotiatorState.ready: return;
case NegotiatorState.done:
if (_currentNegotiator!.sendStreamHeaderWhenDone) {
_currentNegotiator = null;
_streamFeatures.clear();
_sendStreamHeader();
} else {
// Track what features we still have
_streamFeatures
.removeWhere((node) {
return node.attributes['xmlns'] == _currentNegotiator!.negotiatingXmlns;
@ -788,6 +772,7 @@ class XmppConnection {
if (_isMandatoryNegotiationDone(_streamFeatures) && !_isNegotiationPossible(_streamFeatures)) {
_log.finest('Negotiations done!');
_updateRoutingState(RoutingState.handleStanzas);
await _onNegotiationsDone();
} else {
_currentNegotiator = getNextNegotiator(_streamFeatures);
@ -797,16 +782,15 @@ class XmppConnection {
tag: 'stream:features',
children: _streamFeatures,
);
await _executeCurrentNegotiator(fakeStanza);
await _currentNegotiator!.negotiate(fakeStanza);
await _checkCurrentNegotiator();
}
}
break;
case NegotiatorState.retryLater:
} else if (_currentNegotiator!.state == NegotiatorState.retryLater) {
_log.finest('Negotiator wants to continue later. Picking new one...');
_currentNegotiator!.state = NegotiatorState.ready;
if (_isMandatoryNegotiationDone(_streamFeatures) && !_isNegotiationPossible(_streamFeatures)) {
_log.finest('Negotiations done!');
@ -820,18 +804,24 @@ class XmppConnection {
tag: 'stream:features',
children: _streamFeatures,
);
await _executeCurrentNegotiator(fakeStanza);
await _currentNegotiator!.negotiate(fakeStanza);
await _checkCurrentNegotiator();
}
break;
case NegotiatorState.skipRest:
} else if (_currentNegotiator!.state == NegotiatorState.skipRest) {
_log.finest('Negotiator wants to skip the remaining negotiation... Negotiations (assumed) done!');
_updateRoutingState(RoutingState.handleStanzas);
await _onNegotiationsDone();
break;
} else if (_currentNegotiator!.state == NegotiatorState.error) {
_log.severe('Negotiator returned an error');
await handleError(null);
}
}
void _closeSocket() {
_socket.close();
}
/// Called whenever we receive data that has been parsed as XML.
Future<void> handleXmlStream(XMLNode node) async {
// Check if we received a stream error
@ -839,7 +829,7 @@ class XmppConnection {
_log
..finest('<== ${node.toXml()}')
..severe('Received a stream error! Attempting reconnection');
await handleError(StreamError());
await handleError('Stream error');
return;
}
@ -859,14 +849,53 @@ class XmppConnection {
return;
}
if (node.tag == 'stream:features') {
// Store the received stream features
_streamFeatures
..clear()
..addAll(node.children);
}
if (_currentNegotiator != null) {
// If we already have a negotiator, just let it do its thing
_log.finest('Negotiator currently active...');
await _executeCurrentNegotiator(node);
await _currentNegotiator!.negotiate(node);
await _checkCurrentNegotiator();
} else {
_streamFeatures
..clear()
..addAll(node.children);
// We need to pick a new one
if (_isMandatoryNegotiationDone(node.children)) {
// Mandatory features are done but can we still negotiate more?
if (_isNegotiationPossible(node.children)) {// We can still negotiate features, so do that.
_log.finest('All required stream features done! Continuing negotiation');
_currentNegotiator = getNextNegotiator(node.children);
_log.finest('Chose $_currentNegotiator as next negotiator');
await _currentNegotiator!.negotiate(node);
await _checkCurrentNegotiator();
} else {
_updateRoutingState(RoutingState.handleStanzas);
}
} else {
// There still are mandatory features
if (!_isNegotiationPossible(node.children)) {
_log.severe('Mandatory negotiations not done but continuation not possible');
_updateRoutingState(RoutingState.error);
await _setConnectionState(XmppConnectionState.error);
// Resolve the connection completion future
_connectionCompleter?.complete(
const XmppConnectionResult(
false,
reason: 'Could not complete connection negotiations',
),
);
_connectionCompleter = null;
return;
}
_currentNegotiator = getNextNegotiator(node.children);
_log.finest('Chose $_currentNegotiator as next negotiator');
await _currentNegotiator!.negotiate(node);
await _checkCurrentNegotiator();
}
}
});
break;
case RoutingState.handleStanzas:
@ -898,6 +927,20 @@ class XmppConnection {
} else if (event is AuthenticationSuccessEvent) {
_log.finest('Received AuthenticationSuccessEvent. Setting _isAuthenticated to true');
_isAuthenticated = true;
} else if (event is AuthenticationFailedEvent) {
_log.finest('Failed authentication');
_updateRoutingState(RoutingState.error);
await _setConnectionState(XmppConnectionState.error);
// Resolve the connection completion future
_connectionCompleter?.complete(
XmppConnectionResult(
false,
reason: 'Authentication failed: ${event.saslError}',
),
);
_connectionCompleter = null;
_closeSocket();
}
for (final manager in _xmppManagers.values) {
@ -1010,7 +1053,7 @@ class XmppConnection {
port: port,
);
if (!result) {
await handleError(NoConnectionError());
await handleError(null);
} else {
await _reconnectionPolicy.onSuccess();
_log.fine('Preparing the internal state for a connection attempt');

View File

@ -1,20 +0,0 @@
import 'package:moxxmpp/src/socket.dart';
/// An internal error class
abstract class XmppError {}
/// Returned if we could not establish a TCP connection
/// to the server.
class NoConnectionError extends XmppError {}
/// Returned if a socket error occured
class SocketError extends XmppError {
SocketError(this.event);
final XmppSocketErrorEvent event;
}
/// Returned if we time out
class TimeoutError extends XmppError {}
/// Returned if we received a stream error
class StreamError extends XmppError {}

View File

@ -1,12 +1,10 @@
import 'package:moxlib/moxlib.dart';
import 'package:moxxmpp/src/errors.dart';
import 'package:moxxmpp/src/events.dart';
import 'package:moxxmpp/src/jid.dart';
import 'package:moxxmpp/src/managers/base.dart';
import 'package:moxxmpp/src/settings.dart';
import 'package:moxxmpp/src/socket.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
/// The state a negotiator is currently in
enum NegotiatorState {
@ -16,15 +14,15 @@ enum NegotiatorState {
done,
// Cancel the current attempt but we are not done
retryLater,
// The negotiator is in an error state
error,
// Skip the rest of the negotiation and assume the stream ready. Only use this when
// using stream restoration XEPs, like Stream Management.
skipRest,
}
/// A base class for all errors that may occur during feature negotiation
abstract class NegotiatorError extends XmppError {}
class NegotiatorAttributes {
const NegotiatorAttributes(
this.sendNonza,
this.getConnectionSettings,
@ -99,7 +97,7 @@ abstract class XmppFeatureNegotiatorBase {
/// must switch some internal state to prevent getting matched immediately again.
/// If ready is returned, then the negotiator indicates that it is not done with
/// negotiation.
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza);
Future<void> negotiate(XMLNode nonza);
/// Reset the negotiator to a state that negotation can happen again.
void reset() {

View File

@ -4,12 +4,9 @@ import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
import 'package:moxxmpp/src/xeps/xep_0198/xep_0198.dart';
import 'package:uuid/uuid.dart';
class ResourceBindingFailedError extends NegotiatorError {}
class ResourceBindingNegotiator extends XmppFeatureNegotiatorBase {
ResourceBindingNegotiator() : _requestSent = false, super(0, false, bindXmlns, resourceBindingNegotiator);
@ -26,7 +23,7 @@ class ResourceBindingNegotiator extends XmppFeatureNegotiatorBase {
}
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
if (!_requestSent) {
final stanza = XMLNode.xmlns(
tag: 'iq',
@ -45,10 +42,10 @@ class ResourceBindingNegotiator extends XmppFeatureNegotiatorBase {
_requestSent = true;
attributes.sendNonza(stanza);
return const Result(NegotiatorState.ready);
} else {
if (nonza.tag != 'iq' || nonza.attributes['type'] != 'result') {
return Result(ResourceBindingFailedError());
state = NegotiatorState.error;
return;
}
final bind = nonza.firstTag('bind')!;
@ -56,7 +53,7 @@ class ResourceBindingNegotiator extends XmppFeatureNegotiatorBase {
final resource = jid.innerText().split('/')[1];
await attributes.sendEvent(ResourceBindingSuccessEvent(resource: resource));
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
}

View File

@ -1,3 +0,0 @@
import 'package:moxxmpp/src/negotiators/negotiator.dart';
class SaslFailedError extends NegotiatorError {}

View File

@ -1,13 +1,12 @@
import 'dart:convert';
import 'package:logging/logging.dart';
import 'package:moxxmpp/src/events.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/negotiators/sasl/errors.dart';
import 'package:moxxmpp/src/negotiators/sasl/negotiator.dart';
import 'package:moxxmpp/src/negotiators/sasl/nonza.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
class SaslPlainAuthNonza extends SaslAuthNonza {
SaslPlainAuthNonza(String username, String password) : super(
@ -16,6 +15,7 @@ class SaslPlainAuthNonza extends SaslAuthNonza {
}
class SaslPlainNegotiator extends SaslNegotiator {
SaslPlainNegotiator()
: _authSent = false,
_log = Logger('SaslPlainNegotiator'),
@ -41,7 +41,7 @@ class SaslPlainNegotiator extends SaslNegotiator {
}
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
if (!_authSent) {
final settings = attributes.getConnectionSettings();
attributes.sendNonza(
@ -49,17 +49,17 @@ class SaslPlainNegotiator extends SaslNegotiator {
redact: SaslPlainAuthNonza('******', '******').toXml(),
);
_authSent = true;
return const Result(NegotiatorState.ready);
} else {
final tag = nonza.tag;
if (tag == 'success') {
await attributes.sendEvent(AuthenticationSuccessEvent());
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
} else {
// We assume it's a <failure/>
final error = nonza.children.first.tag;
await attributes.sendEvent(AuthenticationFailedEvent(error));
return Result(SaslFailedError());
state = NegotiatorState.error;
}
}
}

View File

@ -1,17 +1,16 @@
import 'dart:convert';
import 'dart:math' show Random;
import 'package:cryptography/cryptography.dart';
import 'package:logging/logging.dart';
import 'package:moxxmpp/src/events.dart';
import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/negotiators/sasl/errors.dart';
import 'package:moxxmpp/src/negotiators/sasl/kv.dart';
import 'package:moxxmpp/src/negotiators/sasl/negotiator.dart';
import 'package:moxxmpp/src/negotiators/sasl/nonza.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
import 'package:random_string/random_string.dart';
import 'package:saslprep/saslprep.dart';
@ -90,6 +89,7 @@ enum ScramState {
const gs2Header = 'n,,';
class SaslScramNegotiator extends SaslNegotiator {
// NOTE: NEVER, and I mean, NEVER set clientNonce or initalMessageNoGS2. They are just there for testing
SaslScramNegotiator(
int priority,
@ -197,7 +197,7 @@ class SaslScramNegotiator extends SaslNegotiator {
}
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
switch (_scramState) {
case ScramState.preSent:
if (clientNonce == null || clientNonce == '') {
@ -211,14 +211,15 @@ class SaslScramNegotiator extends SaslNegotiator {
SaslScramAuthNonza(body: base64.encode(utf8.encode(gs2Header + initialMessageNoGS2)), type: hashType),
redact: SaslScramAuthNonza(body: '******', type: hashType).toXml(),
);
return const Result(NegotiatorState.ready);
break;
case ScramState.initialMessageSent:
if (nonza.tag != 'challenge') {
final error = nonza.children.first.tag;
await attributes.sendEvent(AuthenticationFailedEvent(error));
state = NegotiatorState.error;
_scramState = ScramState.error;
return Result(SaslFailedError());
return;
}
final challengeBase64 = nonza.innerText();
@ -229,14 +230,15 @@ class SaslScramNegotiator extends SaslNegotiator {
SaslScramResponseNonza(body: responseBase64),
redact: SaslScramResponseNonza(body: '******').toXml(),
);
return const Result(NegotiatorState.ready);
return;
case ScramState.challengeResponseSent:
if (nonza.tag != 'success') {
// We assume it's a <failure />
final error = nonza.children.first.tag;
await attributes.sendEvent(AuthenticationFailedEvent(error));
_scramState = ScramState.error;
return Result(SaslFailedError());
state = NegotiatorState.error;
return;
}
// NOTE: This assumes that the string is always "v=..." and contains no other parameters
@ -246,13 +248,16 @@ class SaslScramNegotiator extends SaslNegotiator {
//final error = nonza.children.first.tag;
//attributes.sendEvent(AuthenticationFailedEvent(error));
_scramState = ScramState.error;
return Result(SaslFailedError());
state = NegotiatorState.error;
return;
}
await attributes.sendEvent(AuthenticationSuccessEvent());
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
return;
case ScramState.error:
return Result(SaslFailedError());
state = NegotiatorState.error;
return;
}
}

View File

@ -3,15 +3,12 @@ import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
enum _StartTlsState {
ready,
requested
}
class StartTLSFailedError extends NegotiatorError {}
class StartTLSNonza extends XMLNode {
StartTLSNonza() : super.xmlns(
tag: 'starttls',
@ -30,17 +27,18 @@ class StartTlsNegotiator extends XmppFeatureNegotiatorBase {
final Logger _log;
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
switch (_state) {
case _StartTlsState.ready:
_log.fine('StartTLS is available. Performing StartTLS upgrade...');
_state = _StartTlsState.requested;
attributes.sendNonza(StartTLSNonza());
return const Result(NegotiatorState.ready);
break;
case _StartTlsState.requested:
if (nonza.tag != 'proceed' || nonza.attributes['xmlns'] != startTlsXmlns) {
_log.severe('Failed to perform StartTLS negotiation');
return Result(StartTLSFailedError());
state = NegotiatorState.error;
return;
}
_log.fine('Securing socket');
@ -48,11 +46,13 @@ class StartTlsNegotiator extends XmppFeatureNegotiatorBase {
.secure(attributes.getConnectionSettings().jid.domain);
if (!result) {
_log.severe('Failed to secure stream');
return Result(StartTLSFailedError());
state = NegotiatorState.error;
return;
}
_log.fine('Stream is now TLS secured');
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
break;
}
}

View File

@ -80,11 +80,10 @@ abstract class ReconnectionPolicy {
/// for every failed attempt.
class ExponentialBackoffReconnectionPolicy extends ReconnectionPolicy {
ExponentialBackoffReconnectionPolicy(this._maxBackoffTime)
ExponentialBackoffReconnectionPolicy()
: _counter = 0,
_log = Logger('ExponentialBackoffReconnectionPolicy'),
super();
final int _maxBackoffTime;
int _counter;
Timer? _timer;
final Logger _log;
@ -125,7 +124,7 @@ class ExponentialBackoffReconnectionPolicy extends ReconnectionPolicy {
}
// Wait at max 80 seconds.
final seconds = min(min(pow(2, _counter).toInt(), 80), _maxBackoffTime);
final seconds = min(pow(2, _counter).toInt(), 80);
_timer = Timer(Duration(seconds: seconds), _onTimerElapsed);
}

View File

@ -7,12 +7,15 @@ import 'package:moxxmpp/src/managers/namespaces.dart';
import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/roster/errors.dart';
import 'package:moxxmpp/src/stanza.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
import 'package:moxxmpp/src/types/error.dart';
const rosterErrorNoQuery = 1;
const rosterErrorNonResult = 2;
class XmppRosterItem {
XmppRosterItem({ required this.jid, required this.subscription, this.ask, this.name, this.groups = const [] });
final String jid;
final String? name;
@ -28,12 +31,14 @@ enum RosterRemovalResult {
}
class RosterRequestResult {
RosterRequestResult({ required this.items, this.ver });
List<XmppRosterItem> items;
String? ver;
}
class RosterPushEvent extends XmppEvent {
RosterPushEvent({ required this.item, this.ver });
final XmppRosterItem item;
final String? ver;
@ -48,11 +53,11 @@ class RosterFeatureNegotiator extends XmppFeatureNegotiatorBase {
bool get isSupported => _supported;
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
// negotiate is only called when the negotiator matched, meaning the server
// advertises roster versioning.
_supported = true;
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
@override
@ -143,7 +148,7 @@ class RosterManager extends XmppManagerBase {
/// Shared code between requesting rosters without and with roster versioning, if
/// the server deems a regular roster response more efficient than n roster pushes.
Future<Result<RosterRequestResult, RosterError>> _handleRosterResponse(XMLNode? query) async {
Future<MayFail<RosterRequestResult>> _handleRosterResponse(XMLNode? query) async {
final List<XmppRosterItem> items;
if (query != null) {
items = query.children.map((item) => XmppRosterItem(
@ -161,7 +166,7 @@ class RosterManager extends XmppManagerBase {
}
} else {
logger.warning('Server response to roster request without roster versioning does not contain a <query /> element, while the type is not error. This violates RFC6121');
return Result(NoQueryError());
return MayFail.failure(rosterErrorNoQuery);
}
final ver = query.attributes['ver'] as String?;
@ -170,7 +175,7 @@ class RosterManager extends XmppManagerBase {
await commitLastRosterVersion(ver);
}
return Result(
return MayFail.success(
RosterRequestResult(
items: items,
ver: ver,
@ -180,7 +185,7 @@ class RosterManager extends XmppManagerBase {
}
/// Requests the roster following RFC 6121 without using roster versioning.
Future<Result<RosterRequestResult, RosterError>> requestRoster() async {
Future<MayFail<RosterRequestResult>> requestRoster() async {
final attrs = getAttributes();
final response = await attrs.sendStanza(
Stanza.iq(
@ -196,7 +201,7 @@ class RosterManager extends XmppManagerBase {
if (response.attributes['type'] != 'result') {
logger.warning('Error requesting roster without roster versioning: ${response.toXml()}');
return Result(UnknownError());
return MayFail.failure(rosterErrorNonResult);
}
final query = response.firstTag('query', xmlns: rosterXmlns);
@ -205,7 +210,7 @@ class RosterManager extends XmppManagerBase {
/// Requests a series of roster pushes according to RFC6121. Requires that the server
/// advertises urn:xmpp:features:rosterver in the stream features.
Future<Result<RosterRequestResult?, RosterError>> requestRosterPushes() async {
Future<MayFail<RosterRequestResult?>> requestRosterPushes() async {
if (_rosterVersion == null) {
await loadLastRosterVersion();
}
@ -228,7 +233,7 @@ class RosterManager extends XmppManagerBase {
if (result.attributes['type'] != 'result') {
logger.warning('Requesting roster pushes failed: ${result.toXml()}');
return Result(UnknownError());
return MayFail.failure(rosterErrorNonResult);
}
final query = result.firstTag('query', xmlns: rosterXmlns);

View File

@ -1,7 +0,0 @@
abstract class RosterError {}
/// Returned when the server's response did not contain a <query /> element
class NoQueryError extends RosterError {}
/// Unspecified error
class UnknownError extends RosterError {}

View File

@ -0,0 +1,19 @@
/// A wrapper class that can be used to indicate that a function may return a valid
/// instance of [T] but may also fail.
/// The way [MayFail] is intended to be used to to have function specific - or application
/// specific - error codes that can be either handled by code or be translated into a
/// localised error message for the user.
class MayFail<T> {
MayFail({ this.result, this.errorCode });
MayFail.success(this.result);
MayFail.failure(this.errorCode);
T? result;
int? errorCode;
bool isError() => result == null && errorCode != null;
T getValue() => result!;
int getErrorCode() => errorCode!;
}

View File

@ -5,7 +5,6 @@ import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
import 'package:moxxmpp/src/xeps/xep_0198/nonzas.dart';
import 'package:moxxmpp/src/xeps/xep_0198/state.dart';
import 'package:moxxmpp/src/xeps/xep_0198/xep_0198.dart';
@ -24,6 +23,7 @@ enum _StreamManagementNegotiatorState {
/// StreamManagementManager at least once before connecting, if stream resumption
/// is wanted.
class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
StreamManagementNegotiator()
: _state = _StreamManagementNegotiatorState.ready,
_supported = false,
@ -59,7 +59,7 @@ class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
}
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
// negotiate is only called when we matched the stream feature, so we know
// that the server advertises it.
_supported = true;
@ -80,8 +80,7 @@ class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
_state = _StreamManagementNegotiatorState.enableRequested;
attributes.sendNonza(StreamManagementEnableNonza());
}
return const Result(NegotiatorState.ready);
break;
case _StreamManagementNegotiatorState.resumeRequested:
if (nonza.tag == 'resumed') {
_log.finest('Stream Management resumption successful');
@ -98,7 +97,7 @@ class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
_resumeFailed = false;
_isResumed = true;
return const Result(NegotiatorState.skipRest);
state = NegotiatorState.skipRest;
} else {
// We assume it is <failed />
_log.info('Stream resumption failed. Expected <resumed />, got ${nonza.tag}, Proceeding with new stream...');
@ -114,8 +113,9 @@ class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
_resumeFailed = true;
_isResumed = false;
_state = _StreamManagementNegotiatorState.ready;
return const Result(NegotiatorState.retryLater);
state = NegotiatorState.retryLater;
}
break;
case _StreamManagementNegotiatorState.enableRequested:
if (nonza.tag == 'enabled') {
_log.finest('Stream Management enabled');
@ -133,12 +133,14 @@ class StreamManagementNegotiator extends XmppFeatureNegotiatorBase {
),
);
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
} else {
// We assume a <failed />
_log.warning('Stream Management enablement failed');
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
break;
}
}

View File

@ -4,7 +4,6 @@ import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/negotiators/namespaces.dart';
import 'package:moxxmpp/src/negotiators/negotiator.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
class CSIActiveNonza extends XMLNode {
CSIActiveNonza() : super(
@ -33,11 +32,11 @@ class CSINegotiator extends XmppFeatureNegotiatorBase {
bool get isSupported => _supported;
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
// negotiate is only called when the negotiator matched, meaning the server
// advertises CSI.
_supported = true;
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
@override

View File

@ -7,15 +7,19 @@ import 'package:moxxmpp/src/managers/namespaces.dart';
import 'package:moxxmpp/src/namespaces.dart';
import 'package:moxxmpp/src/stanza.dart';
import 'package:moxxmpp/src/stringxml.dart';
import 'package:moxxmpp/src/types/result.dart';
import 'package:moxxmpp/src/types/error.dart';
import 'package:moxxmpp/src/xeps/xep_0030/errors.dart';
import 'package:moxxmpp/src/xeps/xep_0030/types.dart';
import 'package:moxxmpp/src/xeps/xep_0030/xep_0030.dart';
import 'package:moxxmpp/src/xeps/xep_0363/errors.dart';
const errorNoUploadServer = 1;
const errorFileTooBig = 2;
const errorGeneric = 3;
const allowedHTTPHeaders = [ 'authorization', 'cookie', 'expires' ];
class HttpFileUploadSlot {
const HttpFileUploadSlot(this.putUrl, this.getUrl, this.headers);
final String putUrl;
final String getUrl;
@ -41,6 +45,7 @@ Map<String, String> prepareHeaders(Map<String, String> headers) {
}
class HttpFileUploadManager extends XmppManagerBase {
HttpFileUploadManager() : _gotSupported = false, _supported = false, super();
JID? _entityJid;
int? _maxUploadSize;
@ -114,17 +119,17 @@ class HttpFileUploadManager extends XmppManagerBase {
/// the file's size in octets. [contentType] is optional and refers to the file's
/// Mime type.
/// Returns an [HttpFileUploadSlot] if the request was successful; null otherwise.
Future<Result<HttpFileUploadSlot, HttpFileUploadError>> requestUploadSlot(String filename, int filesize, { String? contentType }) async {
if (!(await isSupported())) return Result(NoEntityKnownError());
Future<MayFail<HttpFileUploadSlot>> requestUploadSlot(String filename, int filesize, { String? contentType }) async {
if (!(await isSupported())) return MayFail.failure(errorNoUploadServer);
if (_entityJid == null) {
logger.warning('Attempted to request HTTP File Upload slot but no entity is known to send this request to.');
return Result(NoEntityKnownError());
return MayFail.failure(errorNoUploadServer);
}
if (_maxUploadSize != null && filesize > _maxUploadSize!) {
logger.warning('Attempted to request HTTP File Upload slot for a file that exceeds the filesize limit');
return Result(FileTooBigError());
return MayFail.failure(errorFileTooBig);
}
final attrs = getAttributes();
@ -149,7 +154,7 @@ class HttpFileUploadManager extends XmppManagerBase {
if (response.attributes['type']! != 'result') {
logger.severe('Failed to request HTTP File Upload slot.');
// TODO(Unknown): Be more precise
return Result(UnknownHttpFileUploadError());
return MayFail.failure(errorGeneric);
}
final slot = response.firstTag('slot', xmlns: httpFileUploadXmlns)!;
@ -164,7 +169,7 @@ class HttpFileUploadManager extends XmppManagerBase {
}),
);
return Result(
return MayFail.success(
HttpFileUploadSlot(
putUrl,
getUrl,

View File

@ -1,10 +0,0 @@
abstract class HttpFileUploadError {}
/// Returned when we don't know what JID to ask for an upload slot
class NoEntityKnownError extends HttpFileUploadError {}
/// Returned when the file we want to upload is too big
class FileTooBigError extends HttpFileUploadError {}
/// Unspecified errors
class UnknownHttpFileUploadError extends HttpFileUploadError {}

View File

@ -44,6 +44,7 @@ const _doNotEncryptList = [
];
abstract class OmemoManager extends XmppManagerBase {
OmemoManager() : _handlerLock = Lock(), _handlerFutures = {}, super();
final Lock _handlerLock;

View File

@ -3,10 +3,10 @@ import 'package:test/test.dart';
import 'helpers/logging.dart';
import 'helpers/xmpp.dart';
const exampleXmlns1 = 'im:moxxmpp:example1';
const exampleNamespace1 = 'im.moxxmpp.test.example1';
const exampleXmlns2 = 'im:moxxmpp:example2';
const exampleNamespace2 = 'im.moxxmpp.test.example2';
const exampleXmlns1 = 'im:moxxy:example1';
const exampleNamespace1 = 'im.moxxy.test.example1';
const exampleXmlns2 = 'im:moxxy:example2';
const exampleNamespace2 = 'im.moxxy.test.example2';
class StubNegotiator1 extends XmppFeatureNegotiatorBase {
StubNegotiator1() : called = false, super(1, false, exampleXmlns1, exampleNamespace1);
@ -14,9 +14,9 @@ class StubNegotiator1 extends XmppFeatureNegotiatorBase {
bool called;
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
called = true;
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
}
@ -26,9 +26,9 @@ class StubNegotiator2 extends XmppFeatureNegotiatorBase {
bool called;
@override
Future<Result<NegotiatorState, NegotiatorError>> negotiate(XMLNode nonza) async {
Future<void> negotiate(XMLNode nonza) async {
called = true;
return const Result(NegotiatorState.done);
state = NegotiatorState.done;
}
}
@ -47,8 +47,8 @@ void main() {
from="test.server"
xml:lang="en">
<stream:features xmlns="http://etherx.jabber.org/streams">
<example1 xmlns="im:moxxmpp:example1" />
<example2 xmlns="im:moxxmpp:example2" />
<example1 xmlns="im:moxxy:example1" />
<example2 xmlns="im:moxxy:example2" />
</stream:features>''',
),
],

View File

@ -128,9 +128,9 @@ void main() {
'c=biws,r=rOprNGfwEbeRWgbNEkqO%hvYDpWUa2RaTCAfuxFIlj)hNlF\$k0,p=dHzbZapWIk4jUhN+Ute9ytag9zjfMHgsqmmiz7AndVQ=',
);
final result = await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj02cnJpVFJCaTIzV3BSUi93dHVwK21NaFVaVW4vZEI1bkxUSlJzamw5NUc0PQ==</success>"));
await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj02cnJpVFJCaTIzV3BSUi93dHVwK21NaFVaVW4vZEI1bkxUSlJzamw5NUc0PQ==</success>"));
expect(result.get<NegotiatorState>(), NegotiatorState.done);
expect(negotiator.state, NegotiatorState.done);
});
test('Test a positive server signature check', () async {
@ -150,9 +150,9 @@ void main() {
await negotiator.negotiate(scramSha1StreamFeatures);
await negotiator.negotiate(XMLNode.fromString("<challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>cj1meWtvK2QybGJiRmdPTlJ2OXFreGRhd0wzcmZjTkhZSlkxWlZ2V1ZzN2oscz1RU1hDUitRNnNlazhiZjkyLGk9NDA5Ng==</challenge>"));
final result = await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(result.get<NegotiatorState>(), NegotiatorState.done);
expect(negotiator.state, NegotiatorState.done);
});
test('Test a negative server signature check', () async {
@ -170,15 +170,11 @@ void main() {
),
);
var result;
result = await negotiator.negotiate(scramSha1StreamFeatures);
expect(result.isType<NegotiatorState>(), true);
await negotiator.negotiate(scramSha1StreamFeatures);
await negotiator.negotiate(XMLNode.fromString("<challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>cj1meWtvK2QybGJiRmdPTlJ2OXFreGRhd0wzcmZjTkhZSlkxWlZ2V1ZzN2oscz1RU1hDUitRNnNlazhiZjkyLGk9NDA5Ng==</challenge>"));
await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1zbUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
result = await negotiator.negotiate(XMLNode.fromString("<challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>cj1meWtvK2QybGJiRmdPTlJ2OXFreGRhd0wzcmZjTkhZSlkxWlZ2V1ZzN2oscz1RU1hDUitRNnNlazhiZjkyLGk9NDA5Ng==</challenge>"));
expect(result.isType<NegotiatorState>(), true);
result = await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1zbUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(result.isType<NegotiatorError>(), true);
expect(negotiator.state, NegotiatorState.error);
});
test('Test a resetting the SCRAM negotiator', () async {
@ -198,14 +194,14 @@ void main() {
await negotiator.negotiate(scramSha1StreamFeatures);
await negotiator.negotiate(XMLNode.fromString("<challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>cj1meWtvK2QybGJiRmdPTlJ2OXFreGRhd0wzcmZjTkhZSlkxWlZ2V1ZzN2oscz1RU1hDUitRNnNlazhiZjkyLGk9NDA5Ng==</challenge>"));
final result1 = await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(result1.get<NegotiatorState>(), NegotiatorState.done);
await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(negotiator.state, NegotiatorState.done);
// Reset and try again
negotiator.reset();
await negotiator.negotiate(scramSha1StreamFeatures);
await negotiator.negotiate(XMLNode.fromString("<challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>cj1meWtvK2QybGJiRmdPTlJ2OXFreGRhd0wzcmZjTkhZSlkxWlZ2V1ZzN2oscz1RU1hDUitRNnNlazhiZjkyLGk9NDA5Ng==</challenge>"));
final result2 = await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(result2.get<NegotiatorState>(), NegotiatorState.done);
await negotiator.negotiate(XMLNode.fromString("<success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>dj1ybUY5cHFWOFM3c3VBb1pXamE0ZEpSa0ZzS1E9</success>"));
expect(negotiator.state, NegotiatorState.done);
});
}