2009-03-13 17:02:59 +01:00
|
|
|
%%%-------------------------------------------------------------------
|
|
|
|
%%% File : ejabberd_captcha.erl
|
|
|
|
%%% Author : Evgeniy Khramtsov <xramtsov@gmail.com>
|
2009-06-09 12:56:14 +02:00
|
|
|
%%% Purpose : CAPTCHA processing.
|
2009-03-13 17:02:59 +01:00
|
|
|
%%% Created : 26 Apr 2008 by Evgeniy Khramtsov <xramtsov@gmail.com>
|
2009-06-09 12:56:14 +02:00
|
|
|
%%%
|
|
|
|
%%%
|
2019-01-08 22:53:27 +01:00
|
|
|
%%% ejabberd, Copyright (C) 2002-2019 ProcessOne
|
2009-06-09 12:56:14 +02:00
|
|
|
%%%
|
|
|
|
%%% This program is free software; you can redistribute it and/or
|
|
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
|
|
%%% License, or (at your option) any later version.
|
|
|
|
%%%
|
|
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
%%% General Public License for more details.
|
|
|
|
%%%
|
2014-02-22 11:27:40 +01:00
|
|
|
%%% You should have received a copy of the GNU General Public License along
|
|
|
|
%%% with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
2009-06-09 12:56:14 +02:00
|
|
|
%%%
|
2009-03-13 17:02:59 +01:00
|
|
|
%%%-------------------------------------------------------------------
|
2009-06-09 12:56:14 +02:00
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
-module(ejabberd_captcha).
|
|
|
|
|
2015-06-01 14:38:27 +02:00
|
|
|
-behaviour(ejabberd_config).
|
|
|
|
|
2015-05-21 17:02:36 +02:00
|
|
|
-protocol({xep, 158, '1.0'}).
|
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
-behaviour(gen_server).
|
2011-04-18 08:09:05 +02:00
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
%% API
|
|
|
|
-export([start_link/0]).
|
|
|
|
|
|
|
|
%% gen_server callbacks
|
2013-03-14 10:33:02 +01:00
|
|
|
-export([init/1, handle_call/3, handle_cast/2,
|
|
|
|
handle_info/2, terminate/2, code_change/3]).
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
-export([create_captcha/6, build_captcha_html/2,
|
|
|
|
check_captcha/2, process_reply/1, process/2,
|
|
|
|
is_feature_available/0, create_captcha_x/5,
|
2018-01-26 13:02:06 +01:00
|
|
|
opt_type/1, host_up/1, host_down/1,
|
|
|
|
config_reloaded/0, process_iq/1]).
|
2013-03-14 10:33:02 +01:00
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
-include("xmpp.hrl").
|
2013-04-08 11:12:54 +02:00
|
|
|
-include("logger.hrl").
|
|
|
|
-include("ejabberd_http.hrl").
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
-define(CAPTCHA_LIFETIME, 120000).
|
|
|
|
-define(LIMIT_PERIOD, 60*1000*1000).
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
-type image_error() :: efbig | enodata | limit | malformed_image | timeout.
|
2013-03-14 10:33:02 +01:00
|
|
|
|
2018-01-26 13:02:06 +01:00
|
|
|
-record(state, {limits = treap:empty() :: treap:treap(),
|
|
|
|
enabled = false :: boolean()}).
|
2013-03-14 10:33:02 +01:00
|
|
|
|
|
|
|
-record(captcha, {id :: binary(),
|
2017-02-16 12:18:36 +01:00
|
|
|
pid :: pid() | undefined,
|
2013-03-14 10:33:02 +01:00
|
|
|
key :: binary(),
|
|
|
|
tref :: reference(),
|
|
|
|
args :: any()}).
|
2009-03-14 07:27:05 +01:00
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
start_link() ->
|
2013-03-14 10:33:02 +01:00
|
|
|
gen_server:start_link({local, ?MODULE}, ?MODULE, [],
|
|
|
|
[]).
|
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
-spec captcha_text(undefined | binary()) -> binary().
|
|
|
|
captcha_text(Lang) ->
|
|
|
|
translate:translate(Lang, <<"Enter the text you see">>).
|
|
|
|
|
|
|
|
-spec mk_ocr_field(binary() | undefined, binary(), binary()) -> xdata_field().
|
|
|
|
mk_ocr_field(Lang, CID, Type) ->
|
|
|
|
URI = #media_uri{type = Type, uri = <<"cid:", CID/binary>>},
|
|
|
|
#xdata_field{var = <<"ocr">>,
|
2016-10-07 09:31:03 +02:00
|
|
|
type = 'text-single',
|
2016-07-28 14:10:41 +02:00
|
|
|
label = captcha_text(Lang),
|
|
|
|
required = true,
|
|
|
|
sub_els = [#media{uri = [URI]}]}.
|
|
|
|
|
|
|
|
mk_field(Type, Var, Value) ->
|
|
|
|
#xdata_field{type = Type, var = Var, values = [Value]}.
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
-spec create_captcha(binary(), jid(), jid(),
|
2016-07-28 14:10:41 +02:00
|
|
|
binary(), any(), any()) -> {error, image_error()} |
|
|
|
|
{ok, binary(), [text()], [xmlel()]}.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
create_captcha(SID, From, To, Lang, Limiter, Args) ->
|
2011-04-14 10:03:02 +02:00
|
|
|
case create_image(Limiter) of
|
2013-03-14 10:33:02 +01:00
|
|
|
{ok, Type, Key, Image} ->
|
2018-07-05 10:51:49 +02:00
|
|
|
Id = <<(p1_rand:get_string())/binary>>,
|
2017-02-26 08:07:12 +01:00
|
|
|
JID = jid:encode(From),
|
2017-03-14 00:31:51 +01:00
|
|
|
CID = <<"sha1+", (str:sha(Image))/binary, "@bob.xmpp.org">>,
|
2016-07-28 14:10:41 +02:00
|
|
|
Data = #bob_data{cid = CID, 'max-age' = 0, type = Type,
|
|
|
|
data = Image},
|
|
|
|
Fs = [mk_field(hidden, <<"FORM_TYPE">>, ?NS_CAPTCHA),
|
2017-02-26 08:07:12 +01:00
|
|
|
mk_field(hidden, <<"from">>, jid:encode(To)),
|
2016-07-28 14:10:41 +02:00
|
|
|
mk_field(hidden, <<"challenge">>, Id),
|
|
|
|
mk_field(hidden, <<"sid">>, SID),
|
|
|
|
mk_ocr_field(Lang, CID, Type)],
|
|
|
|
X = #xdata{type = form, fields = Fs},
|
|
|
|
Captcha = #xcaptcha{xdata = X},
|
2016-11-26 08:05:22 +01:00
|
|
|
BodyString = {<<"Your messages to ~s are being blocked. "
|
|
|
|
"To unblock them, visit ~s">>, [JID, get_url(Id)]},
|
2016-07-28 14:10:41 +02:00
|
|
|
Body = xmpp:mk_text(BodyString, Lang),
|
|
|
|
OOB = #oob_x{url = get_url(Id)},
|
2018-12-21 15:32:23 +01:00
|
|
|
Hint = #hint{type = 'no-store'},
|
2013-03-14 10:33:02 +01:00
|
|
|
Tref = erlang:send_after(?CAPTCHA_LIFETIME, ?MODULE,
|
|
|
|
{remove_id, Id}),
|
|
|
|
ets:insert(captcha,
|
|
|
|
#captcha{id = Id, pid = self(), key = Key, tref = Tref,
|
|
|
|
args = Args}),
|
2018-12-21 15:32:23 +01:00
|
|
|
{ok, Id, Body, [Hint, OOB, Captcha, Data]};
|
2013-03-14 10:33:02 +01:00
|
|
|
Err -> Err
|
2009-03-14 07:27:05 +01:00
|
|
|
end.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
-spec create_captcha_x(binary(), jid(), binary(), any(), xdata()) ->
|
|
|
|
{ok, xdata()} | {error, image_error()}.
|
2010-10-24 07:30:16 +02:00
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
create_captcha_x(SID, To, Lang, Limiter, #xdata{fields = Fs} = X) ->
|
2011-04-14 10:03:02 +02:00
|
|
|
case create_image(Limiter) of
|
2013-03-14 10:33:02 +01:00
|
|
|
{ok, Type, Key, Image} ->
|
2018-07-05 10:51:49 +02:00
|
|
|
Id = <<(p1_rand:get_string())/binary>>,
|
2017-03-14 00:31:51 +01:00
|
|
|
CID = <<"sha1+", (str:sha(Image))/binary, "@bob.xmpp.org">>,
|
2016-07-28 14:10:41 +02:00
|
|
|
Data = #bob_data{cid = CID, 'max-age' = 0, type = Type, data = Image},
|
2013-03-14 10:33:02 +01:00
|
|
|
HelpTxt = translate:translate(Lang,
|
|
|
|
<<"If you don't see the CAPTCHA image here, "
|
|
|
|
"visit the web page.">>),
|
|
|
|
Imageurl = get_url(<<Id/binary, "/image">>),
|
2016-07-28 14:10:41 +02:00
|
|
|
NewFs = [mk_field(hidden, <<"FORM_TYPE">>, ?NS_CAPTCHA)|Fs] ++
|
2018-11-12 17:07:35 +01:00
|
|
|
[#xdata_field{type = fixed, var = <<"captcha-fallback-text">>, values = [HelpTxt]},
|
2016-07-28 14:10:41 +02:00
|
|
|
#xdata_field{type = hidden, var = <<"captchahidden">>,
|
|
|
|
values = [<<"workaround-for-psi">>]},
|
2018-11-12 17:07:35 +01:00
|
|
|
#xdata_field{type = 'text-single', var = <<"captcha-fallback-url">>,
|
2016-07-28 14:10:41 +02:00
|
|
|
label = translate:translate(
|
|
|
|
Lang, <<"CAPTCHA web page">>),
|
|
|
|
values = [Imageurl]},
|
2017-02-26 08:07:12 +01:00
|
|
|
mk_field(hidden, <<"from">>, jid:encode(To)),
|
2016-07-28 14:10:41 +02:00
|
|
|
mk_field(hidden, <<"challenge">>, Id),
|
|
|
|
mk_field(hidden, <<"sid">>, SID),
|
|
|
|
mk_ocr_field(Lang, CID, Type)],
|
|
|
|
Captcha = X#xdata{type = form, fields = NewFs},
|
2013-03-14 10:33:02 +01:00
|
|
|
Tref = erlang:send_after(?CAPTCHA_LIFETIME, ?MODULE,
|
|
|
|
{remove_id, Id}),
|
|
|
|
ets:insert(captcha,
|
|
|
|
#captcha{id = Id, key = Key, tref = Tref}),
|
|
|
|
{ok, [Captcha, Data]};
|
|
|
|
Err -> Err
|
2010-10-24 07:30:16 +02:00
|
|
|
end.
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
-spec build_captcha_html(binary(), binary()) -> captcha_not_found |
|
|
|
|
{xmlel(),
|
|
|
|
{xmlel(), xmlel(),
|
|
|
|
xmlel(), xmlel()}}.
|
|
|
|
|
2009-03-30 13:55:31 +02:00
|
|
|
build_captcha_html(Id, Lang) ->
|
2013-03-14 10:33:02 +01:00
|
|
|
case lookup_captcha(Id) of
|
|
|
|
{ok, _} ->
|
|
|
|
ImgEl = #xmlel{name = <<"img">>,
|
|
|
|
attrs =
|
|
|
|
[{<<"src">>, get_url(<<Id/binary, "/image">>)}],
|
|
|
|
children = []},
|
2016-07-28 14:10:41 +02:00
|
|
|
TextEl = {xmlcdata, captcha_text(Lang)},
|
2013-03-14 10:33:02 +01:00
|
|
|
IdEl = #xmlel{name = <<"input">>,
|
|
|
|
attrs =
|
|
|
|
[{<<"type">>, <<"hidden">>}, {<<"name">>, <<"id">>},
|
|
|
|
{<<"value">>, Id}],
|
|
|
|
children = []},
|
|
|
|
KeyEl = #xmlel{name = <<"input">>,
|
|
|
|
attrs =
|
|
|
|
[{<<"type">>, <<"text">>}, {<<"name">>, <<"key">>},
|
|
|
|
{<<"size">>, <<"10">>}],
|
|
|
|
children = []},
|
|
|
|
FormEl = #xmlel{name = <<"form">>,
|
|
|
|
attrs =
|
|
|
|
[{<<"action">>, get_url(Id)},
|
|
|
|
{<<"name">>, <<"captcha">>},
|
|
|
|
{<<"method">>, <<"POST">>}],
|
|
|
|
children =
|
|
|
|
[ImgEl,
|
|
|
|
#xmlel{name = <<"br">>, attrs = [],
|
|
|
|
children = []},
|
|
|
|
TextEl,
|
|
|
|
#xmlel{name = <<"br">>, attrs = [],
|
|
|
|
children = []},
|
|
|
|
IdEl, KeyEl,
|
|
|
|
#xmlel{name = <<"br">>, attrs = [],
|
|
|
|
children = []},
|
|
|
|
#xmlel{name = <<"input">>,
|
|
|
|
attrs =
|
|
|
|
[{<<"type">>, <<"submit">>},
|
|
|
|
{<<"name">>, <<"enter">>},
|
|
|
|
{<<"value">>, <<"OK">>}],
|
|
|
|
children = []}]},
|
|
|
|
{FormEl, {ImgEl, TextEl, IdEl, KeyEl}};
|
|
|
|
_ -> captcha_not_found
|
2009-03-30 13:55:31 +02:00
|
|
|
end.
|
|
|
|
|
2016-07-28 14:10:41 +02:00
|
|
|
-spec process_reply(xmpp_element()) -> ok | {error, bad_match | not_found | malformed}.
|
|
|
|
|
|
|
|
process_reply(#xdata{} = X) ->
|
|
|
|
case {xmpp_util:get_xdata_values(<<"challenge">>, X),
|
|
|
|
xmpp_util:get_xdata_values(<<"ocr">>, X)} of
|
|
|
|
{[Id], [OCR]} ->
|
|
|
|
case check_captcha(Id, OCR) of
|
|
|
|
captcha_valid -> ok;
|
|
|
|
captcha_non_valid -> {error, bad_match};
|
|
|
|
captcha_not_found -> {error, not_found}
|
|
|
|
end;
|
|
|
|
_ ->
|
|
|
|
{error, malformed}
|
2009-03-14 07:27:05 +01:00
|
|
|
end;
|
2016-07-28 14:10:41 +02:00
|
|
|
process_reply(#xcaptcha{xdata = #xdata{} = X}) ->
|
|
|
|
process_reply(X);
|
|
|
|
process_reply(_) ->
|
|
|
|
{error, malformed}.
|
2009-03-30 13:55:31 +02:00
|
|
|
|
2018-01-26 13:02:06 +01:00
|
|
|
process_iq(#iq{type = set, lang = Lang, sub_els = [#xcaptcha{} = El]} = IQ) ->
|
|
|
|
case process_reply(El) of
|
|
|
|
ok ->
|
|
|
|
xmpp:make_iq_result(IQ);
|
|
|
|
{error, malformed} ->
|
|
|
|
Txt = <<"Incorrect CAPTCHA submit">>,
|
|
|
|
xmpp:make_error(IQ, xmpp:err_bad_request(Txt, Lang));
|
|
|
|
{error, _} ->
|
|
|
|
Txt = <<"The CAPTCHA verification has failed">>,
|
|
|
|
xmpp:make_error(IQ, xmpp:err_not_allowed(Txt, Lang))
|
|
|
|
end;
|
|
|
|
process_iq(#iq{type = get, lang = Lang} = IQ) ->
|
|
|
|
Txt = <<"Value 'get' of 'type' attribute is not allowed">>,
|
|
|
|
xmpp:make_error(IQ, xmpp:err_not_allowed(Txt, Lang));
|
|
|
|
process_iq(#iq{lang = Lang} = IQ) ->
|
|
|
|
Txt = <<"No module is handling this query">>,
|
|
|
|
xmpp:make_error(IQ, xmpp:err_service_unavailable(Txt, Lang)).
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
process(_Handlers,
|
|
|
|
#request{method = 'GET', lang = Lang,
|
|
|
|
path = [_, Id]}) ->
|
2009-03-30 13:55:31 +02:00
|
|
|
case build_captcha_html(Id, Lang) of
|
2013-03-14 10:33:02 +01:00
|
|
|
{FormEl, _} when is_tuple(FormEl) ->
|
|
|
|
Form = #xmlel{name = <<"div">>,
|
|
|
|
attrs = [{<<"align">>, <<"center">>}],
|
|
|
|
children = [FormEl]},
|
|
|
|
ejabberd_web:make_xhtml([Form]);
|
|
|
|
captcha_not_found -> ejabberd_web:error(not_found)
|
2009-03-14 07:27:05 +01:00
|
|
|
end;
|
2013-03-14 10:33:02 +01:00
|
|
|
process(_Handlers,
|
|
|
|
#request{method = 'GET', path = [_, Id, <<"image">>],
|
|
|
|
ip = IP}) ->
|
2011-04-14 10:03:02 +02:00
|
|
|
{Addr, _Port} = IP,
|
2013-03-14 10:33:02 +01:00
|
|
|
case lookup_captcha(Id) of
|
|
|
|
{ok, #captcha{key = Key}} ->
|
|
|
|
case create_image(Addr, Key) of
|
|
|
|
{ok, Type, _, Img} ->
|
|
|
|
{200,
|
|
|
|
[{<<"Content-Type">>, Type},
|
|
|
|
{<<"Cache-Control">>, <<"no-cache">>},
|
|
|
|
{<<"Last-Modified">>, list_to_binary(httpd_util:rfc1123_date())}],
|
|
|
|
Img};
|
|
|
|
{error, limit} -> ejabberd_web:error(not_allowed);
|
|
|
|
_ -> ejabberd_web:error(not_found)
|
|
|
|
end;
|
|
|
|
_ -> ejabberd_web:error(not_found)
|
2009-03-14 07:27:05 +01:00
|
|
|
end;
|
2013-03-14 10:33:02 +01:00
|
|
|
process(_Handlers,
|
|
|
|
#request{method = 'POST', q = Q, lang = Lang,
|
|
|
|
path = [_, Id]}) ->
|
|
|
|
ProvidedKey = proplists:get_value(<<"key">>, Q, none),
|
2009-03-30 13:55:31 +02:00
|
|
|
case check_captcha(Id, ProvidedKey) of
|
2013-03-14 10:33:02 +01:00
|
|
|
captcha_valid ->
|
|
|
|
Form = #xmlel{name = <<"p">>, attrs = [],
|
|
|
|
children =
|
|
|
|
[{xmlcdata,
|
|
|
|
translate:translate(Lang,
|
|
|
|
<<"The CAPTCHA is valid.">>)}]},
|
|
|
|
ejabberd_web:make_xhtml([Form]);
|
|
|
|
captcha_non_valid -> ejabberd_web:error(not_allowed);
|
|
|
|
captcha_not_found -> ejabberd_web:error(not_found)
|
2009-07-30 15:08:26 +02:00
|
|
|
end;
|
|
|
|
process(_Handlers, _Request) ->
|
|
|
|
ejabberd_web:error(not_found).
|
2009-03-30 13:55:31 +02:00
|
|
|
|
2018-01-26 13:02:06 +01:00
|
|
|
host_up(Host) ->
|
|
|
|
gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_CAPTCHA,
|
2018-02-11 10:54:15 +01:00
|
|
|
?MODULE, process_iq).
|
2018-01-26 13:02:06 +01:00
|
|
|
|
|
|
|
host_down(Host) ->
|
|
|
|
gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_CAPTCHA).
|
|
|
|
|
|
|
|
config_reloaded() ->
|
|
|
|
gen_server:call(?MODULE, config_reloaded, timer:minutes(1)).
|
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
init([]) ->
|
2013-03-14 10:33:02 +01:00
|
|
|
mnesia:delete_table(captcha),
|
2018-01-26 13:02:06 +01:00
|
|
|
ets:new(captcha, [named_table, public, {keypos, #captcha.id}]),
|
|
|
|
case check_captcha_setup() of
|
|
|
|
true ->
|
|
|
|
register_handlers(),
|
|
|
|
ejabberd_hooks:add(config_reloaded, ?MODULE, config_reloaded, 50),
|
|
|
|
{ok, #state{enabled = true}};
|
|
|
|
false ->
|
|
|
|
{ok, #state{enabled = false}};
|
|
|
|
{error, Reason} ->
|
|
|
|
{stop, Reason}
|
|
|
|
end.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
handle_call({is_limited, Limiter, RateLimit}, _From,
|
|
|
|
State) ->
|
2011-04-14 10:03:02 +02:00
|
|
|
NowPriority = now_priority(),
|
2013-03-14 10:33:02 +01:00
|
|
|
CleanPriority = NowPriority + (?LIMIT_PERIOD),
|
2011-04-14 10:03:02 +02:00
|
|
|
Limits = clean_treap(State#state.limits, CleanPriority),
|
|
|
|
case treap:lookup(Limiter, Limits) of
|
2013-03-14 10:33:02 +01:00
|
|
|
{ok, _, Rate} when Rate >= RateLimit ->
|
|
|
|
{reply, true, State#state{limits = Limits}};
|
|
|
|
{ok, Priority, Rate} ->
|
|
|
|
NewLimits = treap:insert(Limiter, Priority, Rate + 1,
|
|
|
|
Limits),
|
|
|
|
{reply, false, State#state{limits = NewLimits}};
|
|
|
|
_ ->
|
|
|
|
NewLimits = treap:insert(Limiter, NowPriority, 1,
|
|
|
|
Limits),
|
|
|
|
{reply, false, State#state{limits = NewLimits}}
|
2011-04-14 10:03:02 +02:00
|
|
|
end;
|
2018-01-26 13:02:06 +01:00
|
|
|
handle_call(config_reloaded, _From, #state{enabled = Enabled} = State) ->
|
|
|
|
State1 = case is_feature_available() of
|
|
|
|
true when not Enabled ->
|
|
|
|
case check_captcha_setup() of
|
|
|
|
true ->
|
|
|
|
register_handlers(),
|
|
|
|
State#state{enabled = true};
|
|
|
|
_ ->
|
|
|
|
State
|
|
|
|
end;
|
|
|
|
false when Enabled ->
|
|
|
|
unregister_handlers(),
|
|
|
|
State#state{enabled = false};
|
|
|
|
_ ->
|
|
|
|
State
|
|
|
|
end,
|
|
|
|
{reply, ok, State1};
|
2009-03-13 17:02:59 +01:00
|
|
|
handle_call(_Request, _From, State) ->
|
|
|
|
{reply, bad_request, State}.
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
handle_cast(_Msg, State) -> {noreply, State}.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
|
|
|
handle_info({remove_id, Id}, State) ->
|
2009-03-14 07:27:05 +01:00
|
|
|
?DEBUG("captcha ~p timed out", [Id]),
|
2013-03-14 10:33:02 +01:00
|
|
|
case ets:lookup(captcha, Id) of
|
2018-01-26 13:02:06 +01:00
|
|
|
[#captcha{args = Args, pid = Pid}] ->
|
|
|
|
callback(captcha_failed, Pid, Args),
|
|
|
|
ets:delete(captcha, Id);
|
|
|
|
_ -> ok
|
2013-03-14 10:33:02 +01:00
|
|
|
end,
|
2009-03-13 17:02:59 +01:00
|
|
|
{noreply, State};
|
2013-03-14 10:33:02 +01:00
|
|
|
handle_info(_Info, State) -> {noreply, State}.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2018-01-26 13:02:06 +01:00
|
|
|
terminate(_Reason, #state{enabled = Enabled}) ->
|
|
|
|
if Enabled -> unregister_handlers();
|
|
|
|
true -> ok
|
|
|
|
end,
|
|
|
|
ejabberd_hooks:delete(config_reloaded, ?MODULE, config_reloaded, 50).
|
|
|
|
|
|
|
|
register_handlers() ->
|
|
|
|
ejabberd_hooks:add(host_up, ?MODULE, host_up, 50),
|
|
|
|
ejabberd_hooks:add(host_down, ?MODULE, host_down, 50),
|
2018-06-14 13:00:47 +02:00
|
|
|
lists:foreach(fun host_up/1, ejabberd_config:get_myhosts()).
|
2018-01-26 13:02:06 +01:00
|
|
|
|
|
|
|
unregister_handlers() ->
|
|
|
|
ejabberd_hooks:delete(host_up, ?MODULE, host_up, 50),
|
|
|
|
ejabberd_hooks:delete(host_down, ?MODULE, host_down, 50),
|
2018-06-14 13:00:47 +02:00
|
|
|
lists:foreach(fun host_down/1, ejabberd_config:get_myhosts()).
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
code_change(_OldVsn, State, _Extra) -> {ok, State}.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
create_image() -> create_image(undefined).
|
2011-04-14 10:03:02 +02:00
|
|
|
|
|
|
|
create_image(Limiter) ->
|
2018-07-05 10:51:49 +02:00
|
|
|
Key = str:substr(p1_rand:get_string(), 1, 6),
|
2011-04-14 10:03:02 +02:00
|
|
|
create_image(Limiter, Key).
|
|
|
|
|
|
|
|
create_image(Limiter, Key) ->
|
|
|
|
case is_limited(Limiter) of
|
2013-03-14 10:33:02 +01:00
|
|
|
true -> {error, limit};
|
|
|
|
false -> do_create_image(Key)
|
2011-04-14 10:03:02 +02:00
|
|
|
end.
|
2009-03-13 17:02:59 +01:00
|
|
|
|
2011-04-14 10:03:02 +02:00
|
|
|
do_create_image(Key) ->
|
2009-03-13 17:02:59 +01:00
|
|
|
FileName = get_prog_name(),
|
|
|
|
Cmd = lists:flatten(io_lib:format("~s ~s", [FileName, Key])),
|
|
|
|
case cmd(Cmd) of
|
2013-03-14 10:33:02 +01:00
|
|
|
{ok,
|
|
|
|
<<137, $P, $N, $G, $\r, $\n, 26, $\n, _/binary>> =
|
|
|
|
Img} ->
|
|
|
|
{ok, <<"image/png">>, Key, Img};
|
|
|
|
{ok, <<255, 216, _/binary>> = Img} ->
|
|
|
|
{ok, <<"image/jpeg">>, Key, Img};
|
|
|
|
{ok, <<$G, $I, $F, $8, X, $a, _/binary>> = Img}
|
|
|
|
when X == $7; X == $9 ->
|
|
|
|
{ok, <<"image/gif">>, Key, Img};
|
|
|
|
{error, enodata = Reason} ->
|
|
|
|
?ERROR_MSG("Failed to process output from \"~s\". "
|
|
|
|
"Maybe ImageMagick's Convert program "
|
|
|
|
"is not installed.",
|
|
|
|
[Cmd]),
|
|
|
|
{error, Reason};
|
|
|
|
{error, Reason} ->
|
|
|
|
?ERROR_MSG("Failed to process an output from \"~s\": ~p",
|
|
|
|
[Cmd, Reason]),
|
|
|
|
{error, Reason};
|
|
|
|
_ ->
|
|
|
|
Reason = malformed_image,
|
|
|
|
?ERROR_MSG("Failed to process an output from \"~s\": ~p",
|
|
|
|
[Cmd, Reason]),
|
|
|
|
{error, Reason}
|
2009-03-13 17:02:59 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
get_prog_name() ->
|
2017-04-29 10:39:40 +02:00
|
|
|
case ejabberd_config:get_option(captcha_cmd) of
|
2013-03-14 10:33:02 +01:00
|
|
|
undefined ->
|
|
|
|
?DEBUG("The option captcha_cmd is not configured, "
|
|
|
|
"but some module wants to use the CAPTCHA "
|
|
|
|
"feature.",
|
|
|
|
[]),
|
|
|
|
false;
|
|
|
|
FileName ->
|
|
|
|
FileName
|
2009-03-13 17:02:59 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
get_url(Str) ->
|
2017-04-29 10:39:40 +02:00
|
|
|
CaptchaHost = ejabberd_config:get_option(captcha_host, <<"">>),
|
2013-03-14 10:33:02 +01:00
|
|
|
case str:tokens(CaptchaHost, <<":">>) of
|
|
|
|
[Host] ->
|
|
|
|
<<"http://", Host/binary, "/captcha/", Str/binary>>;
|
|
|
|
[<<"http", _/binary>> = TransferProt, Host] ->
|
|
|
|
<<TransferProt/binary, ":", Host/binary, "/captcha/",
|
|
|
|
Str/binary>>;
|
|
|
|
[Host, PortString] ->
|
|
|
|
TransferProt =
|
|
|
|
iolist_to_binary(atom_to_list(get_transfer_protocol(PortString))),
|
|
|
|
<<TransferProt/binary, "://", Host/binary, ":",
|
|
|
|
PortString/binary, "/captcha/", Str/binary>>;
|
|
|
|
[TransferProt, Host, PortString] ->
|
|
|
|
<<TransferProt/binary, ":", Host/binary, ":",
|
|
|
|
PortString/binary, "/captcha/", Str/binary>>;
|
|
|
|
_ ->
|
2018-06-14 13:00:47 +02:00
|
|
|
<<"http://", (ejabberd_config:get_myname())/binary, "/captcha/", Str/binary>>
|
2009-03-13 17:02:59 +01:00
|
|
|
end.
|
|
|
|
|
2011-03-03 11:35:47 +01:00
|
|
|
get_transfer_protocol(PortString) ->
|
2016-09-24 22:34:28 +02:00
|
|
|
PortNumber = binary_to_integer(PortString),
|
2011-02-14 12:58:33 +01:00
|
|
|
PortListeners = get_port_listeners(PortNumber),
|
|
|
|
get_captcha_transfer_protocol(PortListeners).
|
|
|
|
|
|
|
|
get_port_listeners(PortNumber) ->
|
2017-04-29 10:39:40 +02:00
|
|
|
AllListeners = ejabberd_config:get_option(listen, []),
|
2017-08-11 10:43:16 +02:00
|
|
|
lists:filter(
|
|
|
|
fun({{Port, _IP, _Transport}, _Module, _Opts}) ->
|
|
|
|
Port == PortNumber
|
|
|
|
end, AllListeners).
|
2011-02-14 12:58:33 +01:00
|
|
|
|
|
|
|
get_captcha_transfer_protocol([]) ->
|
2013-03-14 10:33:02 +01:00
|
|
|
throw(<<"The port number mentioned in captcha_host "
|
|
|
|
"is not a ejabberd_http listener with "
|
|
|
|
"'captcha' option. Change the port number "
|
|
|
|
"or specify http:// in that option.">>);
|
2017-08-11 10:43:16 +02:00
|
|
|
get_captcha_transfer_protocol([{_, ejabberd_http, Opts} | Listeners]) ->
|
|
|
|
case proplists:get_bool(captcha, Opts) of
|
2013-03-14 10:33:02 +01:00
|
|
|
true ->
|
2017-08-11 10:43:16 +02:00
|
|
|
case proplists:get_bool(tls, Opts) of
|
|
|
|
true -> https;
|
|
|
|
false -> http
|
|
|
|
end;
|
|
|
|
false -> get_captcha_transfer_protocol(Listeners)
|
2011-02-14 12:58:33 +01:00
|
|
|
end;
|
|
|
|
get_captcha_transfer_protocol([_ | Listeners]) ->
|
|
|
|
get_captcha_transfer_protocol(Listeners).
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
is_limited(undefined) -> false;
|
2011-04-14 10:03:02 +02:00
|
|
|
is_limited(Limiter) ->
|
2017-04-29 10:39:40 +02:00
|
|
|
case ejabberd_config:get_option(captcha_limit) of
|
2013-03-14 10:33:02 +01:00
|
|
|
undefined -> false;
|
|
|
|
Int ->
|
|
|
|
case catch gen_server:call(?MODULE,
|
|
|
|
{is_limited, Limiter, Int}, 5000)
|
|
|
|
of
|
|
|
|
true -> true;
|
|
|
|
false -> false;
|
|
|
|
Err -> ?ERROR_MSG("Call failed: ~p", [Err]), false
|
|
|
|
end
|
2011-04-14 10:03:02 +02:00
|
|
|
end.
|
|
|
|
|
2009-03-13 17:02:59 +01:00
|
|
|
-define(CMD_TIMEOUT, 5000).
|
2013-03-14 10:33:02 +01:00
|
|
|
|
|
|
|
-define(MAX_FILE_SIZE, 64 * 1024).
|
2009-03-13 17:02:59 +01:00
|
|
|
|
|
|
|
cmd(Cmd) ->
|
|
|
|
Port = open_port({spawn, Cmd}, [stream, eof, binary]),
|
2013-03-14 10:33:02 +01:00
|
|
|
TRef = erlang:start_timer(?CMD_TIMEOUT, self(),
|
|
|
|
timeout),
|
2009-03-13 17:02:59 +01:00
|
|
|
recv_data(Port, TRef, <<>>).
|
|
|
|
|
|
|
|
recv_data(Port, TRef, Buf) ->
|
|
|
|
receive
|
2013-03-14 10:33:02 +01:00
|
|
|
{Port, {data, Bytes}} ->
|
|
|
|
NewBuf = <<Buf/binary, Bytes/binary>>,
|
|
|
|
if byte_size(NewBuf) > (?MAX_FILE_SIZE) ->
|
|
|
|
return(Port, TRef, {error, efbig});
|
|
|
|
true -> recv_data(Port, TRef, NewBuf)
|
|
|
|
end;
|
|
|
|
{Port, {data, _}} -> return(Port, TRef, {error, efbig});
|
|
|
|
{Port, eof} when Buf /= <<>> ->
|
|
|
|
return(Port, TRef, {ok, Buf});
|
|
|
|
{Port, eof} -> return(Port, TRef, {error, enodata});
|
|
|
|
{timeout, TRef, _} ->
|
|
|
|
return(Port, TRef, {error, timeout})
|
2009-03-13 17:02:59 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
return(Port, TRef, Result) ->
|
2018-07-17 20:50:58 +02:00
|
|
|
misc:cancel_timer(TRef),
|
2009-03-13 17:02:59 +01:00
|
|
|
catch port_close(Port),
|
|
|
|
Result.
|
2009-05-26 13:53:58 +02:00
|
|
|
|
|
|
|
is_feature_available() ->
|
2011-04-26 13:59:08 +02:00
|
|
|
case get_prog_name() of
|
2013-03-14 10:33:02 +01:00
|
|
|
Prog when is_binary(Prog) -> true;
|
|
|
|
false -> false
|
2009-05-26 13:53:58 +02:00
|
|
|
end.
|
|
|
|
|
|
|
|
check_captcha_setup() ->
|
2011-05-18 04:48:02 +02:00
|
|
|
case is_feature_available() of
|
2018-01-26 13:02:06 +01:00
|
|
|
true ->
|
|
|
|
case create_image() of
|
|
|
|
{ok, _, _, _} ->
|
|
|
|
true;
|
|
|
|
Err ->
|
|
|
|
?CRITICAL_MSG("Captcha is enabled in the option captcha_cmd, "
|
|
|
|
"but it can't generate images.",
|
|
|
|
[]),
|
|
|
|
Err
|
|
|
|
end;
|
|
|
|
false ->
|
|
|
|
false
|
2013-03-14 10:33:02 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
lookup_captcha(Id) ->
|
|
|
|
case ets:lookup(captcha, Id) of
|
|
|
|
[C] -> {ok, C};
|
|
|
|
_ -> {error, enoent}
|
|
|
|
end.
|
|
|
|
|
2015-10-07 00:06:58 +02:00
|
|
|
-spec check_captcha(binary(), binary()) -> captcha_not_found |
|
|
|
|
captcha_valid |
|
|
|
|
captcha_non_valid.
|
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
check_captcha(Id, ProvidedKey) ->
|
|
|
|
case ets:lookup(captcha, Id) of
|
2018-01-26 13:02:06 +01:00
|
|
|
[#captcha{pid = Pid, args = Args, key = ValidKey, tref = Tref}] ->
|
|
|
|
ets:delete(captcha, Id),
|
2018-07-17 20:50:58 +02:00
|
|
|
misc:cancel_timer(Tref),
|
2018-01-26 13:02:06 +01:00
|
|
|
if ValidKey == ProvidedKey ->
|
|
|
|
callback(captcha_succeed, Pid, Args),
|
|
|
|
captcha_valid;
|
|
|
|
true ->
|
|
|
|
callback(captcha_failed, Pid, Args),
|
|
|
|
captcha_non_valid
|
|
|
|
end;
|
|
|
|
_ ->
|
|
|
|
captcha_not_found
|
2009-05-26 13:53:58 +02:00
|
|
|
end.
|
2011-04-14 10:03:02 +02:00
|
|
|
|
|
|
|
clean_treap(Treap, CleanPriority) ->
|
|
|
|
case treap:is_empty(Treap) of
|
2013-03-14 10:33:02 +01:00
|
|
|
true -> Treap;
|
|
|
|
false ->
|
|
|
|
{_Key, Priority, _Value} = treap:get_root(Treap),
|
|
|
|
if Priority > CleanPriority ->
|
|
|
|
clean_treap(treap:delete_root(Treap), CleanPriority);
|
|
|
|
true -> Treap
|
|
|
|
end
|
2011-04-14 10:03:02 +02:00
|
|
|
end.
|
|
|
|
|
2018-01-26 13:02:06 +01:00
|
|
|
-spec callback(captcha_succeed | captcha_failed, pid(), term()) -> any().
|
|
|
|
callback(Result, _Pid, F) when is_function(F) ->
|
|
|
|
F(Result);
|
|
|
|
callback(Result, Pid, Args) when is_pid(Pid) ->
|
|
|
|
Pid ! {Result, Args};
|
|
|
|
callback(_, _, _) ->
|
|
|
|
ok.
|
|
|
|
|
2011-04-14 10:03:02 +02:00
|
|
|
now_priority() ->
|
2015-12-04 15:08:43 +01:00
|
|
|
-p1_time_compat:system_time(micro_seconds).
|
2015-06-01 14:38:27 +02:00
|
|
|
|
2018-09-09 08:59:08 +02:00
|
|
|
-spec opt_type(atom()) -> fun((any()) -> any()) | [atom()].
|
2015-06-01 14:38:27 +02:00
|
|
|
opt_type(captcha_cmd) ->
|
|
|
|
fun (FileName) ->
|
|
|
|
F = iolist_to_binary(FileName), if F /= <<"">> -> F end
|
|
|
|
end;
|
|
|
|
opt_type(captcha_host) -> fun iolist_to_binary/1;
|
|
|
|
opt_type(captcha_limit) ->
|
|
|
|
fun (I) when is_integer(I), I > 0 -> I end;
|
|
|
|
opt_type(_) ->
|
2017-04-28 12:23:32 +02:00
|
|
|
[captcha_cmd, captcha_host, captcha_limit].
|