Packages
rabbit_common
4.3.4
4.3.4
4.2.1
4.2.0
retired
4.2.0-rc.1
retired
4.1.6
4.1.5
retired
4.1.5-rc.2
retired
4.1.5-rc.1
4.0.3
4.0.3-rc.1
4.0.2
4.0.2-rc.2
4.0.2-rc.1
4.0.1
4.0.0
4.0.0-rc.2
4.0.0-rc.1
3.13.7
3.13.6
3.13.5
3.13.4
3.13.3
3.13.2
3.13.2-rc.1
3.13.1
3.13.0
3.13.0-rc.6
3.13.0-rc.5
3.13.0-rc.4
3.13.0-rc.3
3.13.0-rc.2
3.13.0-rc.1
3.12.14
3.12.13
3.12.12
3.12.11
3.12.10
3.12.9
3.12.8
3.12.7
3.12.6
3.12.5
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.12.0-rc.4
3.12.0-rc.3
3.12.0-rc.2
3.12.0-rc.1
3.11.28
3.11.27
3.11.26
3.11.25
3.11.24
3.11.23
3.11.22
3.11.21
3.11.20
3.11.19
3.11.18
3.11.17
3.11.16
3.11.15
3.11.14
3.11.13
3.11.12
3.11.11
3.11.10
3.11.9
3.11.8
3.11.7
3.11.6
3.11.5
3.11.4
3.11.3
3.11.2
3.11.1
3.11.0
3.11.0-rc.2
3.11.0-rc.1
3.11.0-1
3.10.25
3.10.24
3.10.23
3.10.22
3.10.21
3.10.20
3.10.19
3.10.18
3.10.17
3.10.16
3.10.15
3.10.14
3.10.13
3.10.12
3.10.11
3.10.10
3.10.9
3.10.8
3.10.7
3.10.6
3.10.5
3.10.4
3.10.3
3.10.2
3.10.1
3.10.0
3.10.0-rc.6
3.10.0-rc.5
3.9.29
3.9.28
3.9.27
3.9.26
3.9.25
3.9.24
3.9.23
3.9.22
3.9.21
3.9.20
3.9.19
3.9.18
3.9.17
3.9.16
3.9.15
3.9.11
3.9.10
3.9.9
3.9.8
3.9.7
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.8.35
3.8.34
3.8.33
3.8.32
3.8.31
3.8.30
3.8.26
3.8.25
3.8.24
3.8.23
3.8.22
3.8.21
3.8.20
3.8.19
3.8.14
3.8.12-rc.3
3.8.12-rc.2
3.8.12-rc.1
3.8.11
3.8.10
3.8.10-rc.6
3.8.10-rc.5
3.8.10-rc.1
3.8.9
3.8.8
3.8.7
3.8.6
3.8.6-rc.2
3.8.6-rc.1
3.8.5
3.8.5-rc.2
3.8.5-rc.1
3.8.4
3.8.4-rc.3
3.8.4-rc.1
3.8.3
3.8.3-rc.2
3.8.3-rc.1
3.8.2
3.8.2-rc.1
3.8.1
3.8.1-rc.1
3.8.0
3.8.0-rc.3
3.8.0-rc.2
3.8.0-rc.1
3.7.28
3.7.27
3.7.27-rc.2
3.7.27-rc.1
3.7.26
3.7.25
3.7.25-rc.1
3.7.24
3.7.24-rc.2
3.7.24-rc.1
3.7.23
3.7.23-rc.1
3.7.22
3.7.22-rc.2
3.7.22-rc.1
3.7.21
3.7.20
3.7.20-rc.2
3.7.20-rc.1
3.7.19
3.7.18
3.7.18-rc.1
3.7.17
3.7.17-rc.3
3.7.17-rc.2
3.7.17-rc.1
retired
3.7.16
retired
3.7.16-rc.4
retired
3.7.16-rc.3
retired
3.7.16-rc.2
retired
3.7.16-rc.1
retired
3.7.16-beta.1
3.7.15
3.7.14
3.7.14-rc.2
3.7.14-rc.1
3.7.13
3.7.13-rc.2
3.7.13-rc.1
3.7.12
3.7.12-rc.2
3.7.12-rc.1
3.7.11
3.7.11-rc.2
3.7.11-rc.1
3.7.10-rc.4
3.7.10-rc.3
3.7.10-rc.2
3.7.10-rc.1
3.7.9
3.7.9-rc.3
3.7.9-rc.2
3.7.8
3.7.8-rc.4
3.7.8-rc.3
3.7.8-rc.2
3.7.8-rc.1
3.7.7
3.7.7-rc.2
3.7.7-rc.1
3.7.6
3.7.6-rc.2
3.7.6-rc.1
3.7.5
3.7.5-rc.1
3.7.4
3.7.4-rc.4
3.7.4-rc.3
3.7.4-rc.2
3.7.4-rc.1
3.7.3
3.7.3-rc.2
3.7.3-rc.1
3.7.2
3.7.1
3.7.0-rc.2
3.7.0-alpha.544
3.7.0-alpha.542
3.6.16
3.6.16-rc.1
3.6.15
3.6.15-rc.1
3.6.14
3.6.13
3.6.12
3.6.11
3.6.10
3.6.9
3.6.8
3.6.7
3.6.7-pre.1
3.5.6
3.5.0
3.4.0
3.3.5
3.0.2
0.0.0-rc.1
Modules shared by rabbitmq-server and rabbitmq-erlang-client
Current section
Files
Jump to
Current section
Files
src/rabbit_re.erl
%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
%%
%% Copyright (c) 2007-2026 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
%%
-module(rabbit_re).
-export([run/2, run/3,
matches/2, matches/3,
escape/1,
compile/1, compile/2,
match_limit/0,
max_pattern_length/0]).
-define(MATCH_LIMIT, 50_000).
-define(MAX_PATTERN_LENGTH, 1024).
-spec match_limit() -> pos_integer().
match_limit() -> ?MATCH_LIMIT.
-spec max_pattern_length() -> pos_integer().
max_pattern_length() -> ?MAX_PATTERN_LENGTH.
-spec run(iodata() | unicode:charlist(), re:mp() | iodata()) ->
match | nomatch | {error, term()}.
run(Subject, Pattern) ->
run(Subject, Pattern, [{capture, none}]).
-spec run(iodata() | unicode:charlist(),
re:mp() | iodata(),
re:options()) ->
{match, [{integer(), integer()} | binary() | string()]}
| match
| nomatch
| {error, term()}.
run(Subject, Pattern, Opts) ->
try
re:run(Subject, Pattern,
[{match_limit, ?MATCH_LIMIT},
{match_limit_recursion, ?MATCH_LIMIT}
| Opts])
catch
%% `re:run/3` raises on malformed patterns and other shape errors.
%% Surface them as a safe error tuple so callers do not need to
%% wrap every call in `try`.
error:Reason -> {error, Reason}
end.
-spec matches(iodata() | unicode:charlist(), re:mp() | iodata()) -> boolean().
matches(Subject, Pattern) ->
matches(Subject, Pattern, []).
-spec matches(iodata() | unicode:charlist(),
re:mp() | iodata(),
re:options()) -> boolean().
matches(Subject, Pattern, Opts) ->
%% `{capture, none}` must come last because `re:run/3` resolves
%% repeated capture options with last-wins precedence.
case run(Subject, Pattern, Opts ++ [{capture, none}]) of
match -> true;
_ -> false
end.
%% Escape every regex metacharacter in a binary so it matches literally, for
%% embedding untrusted values (topic-permission variables, OAuth2 scopes) in a
%% pattern without letting them alter its meaning.
-spec escape(binary()) -> binary().
escape(Bin) when is_binary(Bin) ->
<< <<(escape_char(C))/binary>> || <<C>> <= Bin >>.
%% "-" is only special inside a "[...]" character class, where it forms a
%% range, so it must be escaped alongside the metacharacters that are special
%% outside a class.
-spec escape_char(byte()) -> binary().
escape_char(C)
when C =:= $\\; C =:= $^; C =:= $$; C =:= $.;
C =:= $|; C =:= $?; C =:= $*; C =:= $+;
C =:= $(; C =:= $); C =:= $[; C =:= $];
C =:= ${; C =:= $}; C =:= $- ->
<<$\\, C>>;
escape_char(C) ->
<<C>>.
-spec compile(iodata()) -> {ok, re:mp()} | {error, term()}.
compile(Pattern) ->
compile(Pattern, []).
-spec compile(iodata(), re:compile_options()) ->
{ok, re:mp()} | {error, term()}.
compile(Pattern, _Opts) when is_binary(Pattern),
byte_size(Pattern) > ?MAX_PATTERN_LENGTH ->
{error, pattern_too_long};
compile(Pattern, _Opts) when is_list(Pattern),
length(Pattern) > ?MAX_PATTERN_LENGTH ->
{error, pattern_too_long};
compile(Pattern, Opts) ->
re:compile(Pattern, Opts).