AnyEvent-XMPP
view release on metacpan or search on metacpan
lib/AnyEvent/XMPP/Connection.pm view on Meta::CPAN
=item username => $username
This is your C<$username> (the userpart in the JID);
Note: You have to take care that the stringprep profile for
nodes can be applied at: C<$username>. Otherwise the server
might signal an error. See L<AnyEvent::XMPP::Util> for utility functions
to check this.
B<NOTE:> This field has no effect if C<jid> is given!
=item domain => $domain
If you didn't provide a C<jid> (see above) you have to set the
C<username> which you want to connect as (see above) and the
C<$domain> to connect to.
B<NOTE:> This field has no effect if C<jid> is given!
=item resource => $resource
If this argument is given C<$resource> will be passed as desired
resource on resource binding.
Note: You have to take care that the stringprep profile for
resources can be applied at: C<$resource>. Otherwise the server
might signal an error. See L<AnyEvent::XMPP::Util> for utility functions
to check this.
=item host => $host
This parameter specifies the hostname where we are going
to connect to. The default for this is the C<domain> of the C<jid>.
B<NOTE:> To disable DNS SRV lookup you need to specify the port B<number>
yourself. See C<port> below.
=item use_host_as_sasl_hostname => $bool
This is a special parameter for people who might want to use GSSAPI SASL
mechanism. It will cause the value of the C<host> parameter (see above) to be
passed to the SASL mechanisms, instead of the C<domain> of the JID.
This flag is provided until support for XEP 0233 is deployed, which
will fix the hostname issue w.r.t. GSSAPI SASL.
=item port => $port
This is optional, the default value for C<$port> is 'xmpp-client=5222', which
will used as C<$service> argument to C<tcp_connect> of L<AnyEvent::Socket>.
B<NOTE:> If you specify the port number here (instead of 'xmpp-client=5222'),
B<no> DNS SRV lookup will be done when connecting.
=item connect_timeout => $timeout
This sets the connection timeout. If the socket connect takes too long
a C<disconnect> event will be generated with an appropriate error message.
If this argument is not given no timeout is installed for the connects.
=item password => $password
This is the password for the C<username> above.
=item disable_ssl => $bool
If C<$bool> is true no SSL will be used.
=item old_style_ssl => $bool
If C<$bool> is true the TLS handshake will be initiated when the TCP
connection was established. This is useful if you have to connect to
an old Jabber server, with old-style SSL connections on port 5223.
But that practice has been discouraged in XMPP, and a TLS handshake is done
after the XML stream has been established. Only use this option if you know
what you are doing.
=item disable_sasl => $bool
If C<$bool> is true SASL will NOT be used to authenticate with the server, even
if it advertises SASL through stream features. Alternative authentication
methods will be used, such as IQ Auth (XEP-0078) if the server offers it.
=item disable_iq_auth => $bool
This disables the use of IQ Auth (XEP-0078) for authentication, you might want
to exclude it because it's deprecated and insecure. (However, I want to reach a
maximum in compatibility with L<AnyEvent::XMPP> so I'm not disabling this by
default.
See also C<disable_old_jabber_authentication> below.
=item anal_iq_auth => $bool
This enables the anal iq auth mechanism that will first look in the stream
features before trying to start iq authentication. Yes, servers don't always
advertise what they can. I only implemented this option for my test suite.
=item disable_old_jabber_authentication => $bool
If C<$bool> is a true value, then the B<VERY> old style authentication method
with B<VERY> old jabber server won't be used when a <stream> start tag from the server
without version attribute is received.
The B<VERY> old style authentication method is per default enabled to ensure
maximum compatibility with old jabber implementations. The old method works as
follows: When a <stream> start tag is received from the server with no
'version' attribute IQ Auth (XEP-0078) will be initiated to authenticate with
the server.
Please note that the old authentication method will fail if C<disable_iq_auth>
is true.
=item stream_version_override => $version
B<NOTE:> Only use if you B<really> know what you are doing!
This will override the stream version which is sent in the XMPP stream
initiation element. This is currently only used by the tests which
set C<$version> to '0.9' for testing IQ authentication with ejabberd.
=item whitespace_ping_interval => $interval
lib/AnyEvent/XMPP/Connection.pm view on Meta::CPAN
sub reply_iq_error {
my ($self, $iqnode, $errtype, $error, %attrs) = @_;
return $self->_reply_iq(
$iqnode,
'error',
sub { $self->{writer}->write_error_tag ($iqnode, $errtype, $error) },
%attrs
);
}
sub _reply_iq {
my ($self, $iqnode, $type, $create_cb, %attrs) = @_;
return $self->{writer}->send_iq (
$iqnode->attr ('id'), $type, $create_cb,
(defined $iqnode->attr ('from') ? (to => $iqnode->attr ('from')) : ()),
(defined $iqnode->attr ('to') ? (from => $iqnode->attr ('to')) : ()),
%attrs
);
}
sub handle_iq {
my ($self, $node) = @_;
my $type = $node->attr ('type');
my $id = $node->attr ('id');
delete $self->{iq_timers}->{$id} if defined $id;
if ($type eq 'result') {
if (my $cb = delete $self->{iqs}->{$id}) {
eval {
$cb->($node);
};
if ($@) { $self->event (iq_result_cb_exception => $@) }
}
} elsif ($type eq 'error') {
if (my $cb = delete $self->{iqs}->{$id}) {
my $error = AnyEvent::XMPP::Error::IQ->new (node => $node);
eval {
$cb->(($error->type eq 'continue' ? $node : undef), $error);
};
if ($@) { $self->event (iq_result_cb_exception => $@) }
}
} else {
my $handled = 0;
$self->event ("iq_${type}_request_xml" => $node, \$handled);
$handled or $self->reply_iq_error ($node, undef, 'service-unavailable');
}
}
sub send_sasl_auth {
my ($self, @mechs) = @_;
for (qw/username password domain/) {
die "No '$_' argument given to new, but '$_' is required\n"
unless defined $self->{$_};
}
$self->{writer}->send_sasl_auth (
[map { $_->text } @mechs],
$self->{username},
($self->{use_host_as_sasl_hostname}
? $self->{host}
: $self->{domain}),
$self->{password}
);
}
sub handle_stream_features {
my ($self, $node) = @_;
my @bind = $node->find_all ([qw/bind bind/]);
my @tls = $node->find_all ([qw/tls starttls/]);
# and yet another weird thingie: in XEP-0077 it's said that
# the register feature MAY be advertised by the server. That means:
# it MAY not be advertised even if it is available... so we don't
# care about it...
# my @reg = $node->find_all ([qw/register register/]);
if (not ($self->{disable_ssl}) && not ($self->{ssl_enabled}) && @tls) {
$self->{writer}->send_starttls;
} elsif (not $self->{authenticated}) {
my $continue = 1;
$self->event (stream_pre_authentication => \$continue);
if ($continue) {
$self->authenticate;
}
} elsif (@bind) {
$self->do_rebind ($self->{resource});
}
}
=item B<authenticate>
This method should be called after the C<stream_pre_authentication> event
was emitted to continue authentication of the stream.
Usually this method only has to be called when you want to register before
you authenticate. See also the documentation of the C<stream_pre_authentication>
event below.
=cut
sub authenticate {
my ($self) = @_;
my $node = $self->{features};
my @mechs = $node->find_all ([qw/sasl mechanisms/], [qw/sasl mechanism/]);
# Yes, and also iq-auth isn't correctly advertised in the
# stream features! We all love the depreacted XEP-0078, eh?
my @iqa = $node->find_all ([qw/iqauth auth/]);
if (not ($self->{disable_sasl}) && @mechs) {
$self->send_sasl_auth (@mechs)
} elsif (not $self->{disable_iq_auth}) {
if ($self->{anal_iq_auth} && !@iqa) {
if (@iqa) {
$self->do_iq_auth;
} else {
die "No authentication method left after anal iq auth, neither SASL or IQ auth.\n";
}
} else {
lib/AnyEvent/XMPP/Connection.pm view on Meta::CPAN
}
sub handle_sasl_challenge {
my ($self, $node) = @_;
$self->{writer}->send_sasl_response ($node->text);
}
sub handle_sasl_success {
my ($self, $node) = @_;
$self->{authenticated} = 1;
$self->{parser}->init;
$self->{writer}->init;
$self->{writer}->send_init_stream (
$self->{language}, $self->{domain}, $self->{stream_namespace}
);
}
sub handle_error {
my ($self, $node) = @_;
my $error = AnyEvent::XMPP::Error::Stream->new (node => $node);
$self->event (stream_error => $error);
$self->{writer}->send_end_of_stream;
}
# This is a hack for jabberd 1.4.2, VERY OLD Jabber stuff.
sub start_old_style_authentication {
my ($self) = @_;
$self->{features}
= AnyEvent::XMPP::Node->new (
'http://etherx.jabber.org/streams', 'features', [], $self->{parser}
);
my $continue = 1;
$self->event (stream_pre_authentication => \$continue);
if ($continue) {
$self->do_iq_auth;
}
}
sub do_iq_auth {
my ($self) = @_;
if ($self->{anal_iq_auth}) {
$self->send_iq (get => {
defns => 'auth', node => { ns => 'auth', name => 'query',
# heh, something i've seen on some ejabberd site:
# childs => [ { name => 'username', childs => [ $self->{username} ] } ]
}
}, sub {
my ($n, $e) = @_;
if ($e) {
$self->event (iq_auth_error =>
AnyEvent::XMPP::Error::IQAuth->new (context => 'iq_error', iq_error => $e)
);
} else {
my $fields = {};
my (@query) = $n->find_all ([qw/auth query/]);
if (@query) {
for (qw/username password digest resource/) {
if ($query[0]->find_all ([qw/auth/, $_])) {
$fields->{$_} = 1;
}
}
$self->do_iq_auth_send ($fields);
} else {
$self->event (iq_auth_error =>
AnyEvent::XMPP::Error::IQAuth->new (context => 'no_fields')
);
}
}
});
} else {
$self->do_iq_auth_send ({ username => 1, password => 1, resource => 1 });
}
}
sub do_iq_auth_send {
my ($self, $fields) = @_;
for (qw/username password resource/) {
die "No '$_' argument given to new, but '$_' is required\n"
unless defined $self->{$_};
}
my $do_resource = $fields->{resource};
my $password = $self->{password};
if ($fields->{digest}) {
my $out_password = encode ("UTF-8", $password);
my $out = lc sha1_hex ($self->stream_id () . $out_password);
$fields = {
username => $self->{username},
digest => $out,
}
} else {
$fields = {
username => $self->{username},
password => $password
}
}
if ($do_resource && defined $self->{resource}) {
$fields->{resource} = $self->{resource}
}
$self->send_iq (set => {
defns => 'auth',
node => { ns => 'auth', name => 'query', childs => [
map { { name => $_, childs => [ $fields->{$_} ] } } reverse sort keys %$fields
]}
}, sub {
my ($n, $e) = @_;
if ($e) {
$self->event (iq_auth_error =>
AnyEvent::XMPP::Error::IQAuth->new (context => 'iq_error', iq_error => $e)
);
} else {
$self->{authenticated} = 1;
$self->{jid} = join_jid ($self->{username}, $self->{domain}, $self->{resource});
$self->event (stream_ready => $self->{jid});
}
});
}
=item B<send_presence ($type, $create_cb, %attrs)>
This method sends a presence stanza, for the meanings
of C<$type>, C<$create_cb> and C<%attrs> please take a look
at the documentation for C<send_presence> method of L<AnyEvent::XMPP::Writer>.
This methods does attach an id attribute to the presence stanza and
will return the id that was used (so you can react on possible replies).
=cut
sub send_presence {
my ($self, $type, $create_cb, %attrs) = @_;
my $id = $self->{iq_id}++;
$self->{writer}->send_presence ($id, $type, $create_cb, %attrs);
$id
}
=item B<send_message ($to, $type, $create_cb, %attrs)>
This method sends a message stanza, for the meanings
of C<$to>, C<$type>, C<$create_cb> and C<%attrs> please take a look
at the documentation for C<send_message> method of L<AnyEvent::XMPP::Writer>.
This methods does attach an id attribute to the message stanza and
will return the id that was used (so you can react on possible replies).
=cut
sub send_message {
my ($self, $to, $type, $create_cb, %attrs) = @_;
my $id = delete $attrs{id} || $self->{iq_id}++;
$self->{writer}->send_message ($id, $to, $type, $create_cb, %attrs);
$id
( run in 0.486 second using v1.01-cache-2.11-cpan-39bf76dae61 )