/usr/share/otrs/Kernel/System/Auth.pm is in otrs2 6.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 | # --
# Copyright (C) 2001-2018 OTRS AG, http://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (AGPL). If you
# did not receive this file, see http://www.gnu.org/licenses/agpl.txt.
# --
package Kernel::System::Auth;
use strict;
use warnings;
use Kernel::Language qw(Translatable);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::DateTime',
'Kernel::System::Group',
'Kernel::System::Log',
'Kernel::System::Main',
'Kernel::System::SystemMaintenance',
'Kernel::System::User',
'Kernel::System::Valid',
);
=head1 NAME
Kernel::System::Auth - agent authentication module.
=head1 DESCRIPTION
The authentication module for the agent interface.
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $AuthObject = $Kernel::OM->Get('Kernel::System::Auth');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
# get needed objects
my $MainObject = $Kernel::OM->Get('Kernel::System::Main');
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
# load auth modules
COUNT:
for my $Count ( '', 1 .. 10 ) {
my $GenericModule = $ConfigObject->Get("AuthModule$Count");
next COUNT if !$GenericModule;
if ( !$MainObject->Require($GenericModule) ) {
$MainObject->Die("Can't load backend module $GenericModule! $@");
}
$Self->{"AuthBackend$Count"} = $GenericModule->new( Count => $Count );
}
# load 2factor auth modules
COUNT:
for my $Count ( '', 1 .. 10 ) {
my $GenericModule = $ConfigObject->Get("AuthTwoFactorModule$Count");
next COUNT if !$GenericModule;
if ( !$MainObject->Require($GenericModule) ) {
$MainObject->Die("Can't load backend module $GenericModule! $@");
}
$Self->{"AuthTwoFactorBackend$Count"} = $GenericModule->new( %{$Self}, Count => $Count );
}
# load sync modules
COUNT:
for my $Count ( '', 1 .. 10 ) {
my $GenericModule = $ConfigObject->Get("AuthSyncModule$Count");
next COUNT if !$GenericModule;
if ( !$MainObject->Require($GenericModule) ) {
$MainObject->Die("Can't load backend module $GenericModule! $@");
}
$Self->{"AuthSyncBackend$Count"} = $GenericModule->new( %{$Self}, Count => $Count );
}
# Initialize last error message
$Self->{LastErrorMessage} = '';
return $Self;
}
=head2 GetOption()
Get module options. Currently there is just one option, "PreAuth".
if ( $AuthObject->GetOption( What => 'PreAuth' ) ) {
print "No login screen is needed. Authentication is based on some other options. E. g. $ENV{REMOTE_USER}\n";
}
=cut
sub GetOption {
my ( $Self, %Param ) = @_;
return $Self->{AuthBackend}->GetOption(%Param);
}
=head2 Auth()
The authentication function.
if ( $AuthObject->Auth( User => $User, Pw => $Pw ) ) {
print "Auth ok!\n";
}
else {
print "Auth invalid!\n";
}
=cut
sub Auth {
my ( $Self, %Param ) = @_;
# get needed objects
my $UserObject = $Kernel::OM->Get('Kernel::System::User');
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
# use all 11 auth backends and return on first true
my $User;
COUNT:
for my $Count ( '', 1 .. 10 ) {
# return on no config setting
next COUNT if !$Self->{"AuthBackend$Count"};
# check auth backend
$User = $Self->{"AuthBackend$Count"}->Auth(%Param);
# next on no success
next COUNT if !$User;
# Sync will happen before two factor authentication (if configured)
# because user might not exist before being created in sync (see bug #11966).
# A failed two factor auth after successful sync will result
# in a new or updated user but no information or permission leak.
# configured auth sync backend
my $AuthSyncBackend = $ConfigObject->Get("AuthModule::UseSyncBackend$Count");
if ( !defined $AuthSyncBackend ) {
$AuthSyncBackend = $ConfigObject->Get("AuthModule{$Count}::UseSyncBackend");
}
# for backwards compatibility, OTRS 3.1.1, 3.1.2 and 3.1.3 used this wrong format (see bug#8387)
# sync with configured auth backend
if ( defined $AuthSyncBackend ) {
# if $AuthSyncBackend is defined but empty, don't sync with any backend
if ($AuthSyncBackend) {
# sync configured backend
$Self->{$AuthSyncBackend}->Sync( %Param, User => $User );
}
}
# use all 11 sync backends
else {
SOURCE:
for my $Count ( '', 1 .. 10 ) {
# return on no config setting
next SOURCE if !$Self->{"AuthSyncBackend$Count"};
# sync backend
$Self->{"AuthSyncBackend$Count"}->Sync( %Param, User => $User );
}
}
# If we have no UserID at this point
# it means auth was ok but user didn't exist before
# and wasn't created in sync module.
# We will skip two factor authentication even if configured
# because we don't have user data to compare the otp anyway.
# This will not count as a failed login.
my $UserID = $UserObject->UserLookup(
UserLogin => $User,
);
last COUNT if !$UserID;
# check 2factor auth backends
my $TwoFactorAuth;
TWOFACTORSOURCE:
for my $Count ( '', 1 .. 10 ) {
# return on no config setting
next TWOFACTORSOURCE if !$Self->{"AuthTwoFactorBackend$Count"};
# 2factor backend
my $AuthOk = $Self->{"AuthTwoFactorBackend$Count"}->Auth(
TwoFactorToken => $Param{TwoFactorToken},
User => $User,
UserID => $UserID,
);
$TwoFactorAuth = $AuthOk ? 'passed' : 'failed';
last TWOFACTORSOURCE if $AuthOk;
}
# if at least one 2factor auth backend was checked but none was successful,
# it counts as a failed login
if ( $TwoFactorAuth && $TwoFactorAuth ne 'passed' ) {
$User = undef;
last COUNT;
}
# remember auth backend
$UserObject->SetPreferences(
Key => 'UserAuthBackend',
Value => $Count,
UserID => $UserID,
);
last COUNT;
}
# return if no auth user
if ( !$User ) {
# remember failed logins
my $UserID = $UserObject->UserLookup(
UserLogin => $Param{User},
);
return if !$UserID;
my %User = $UserObject->GetUserData(
UserID => $UserID,
Valid => 1,
);
my $Count = $User{UserLoginFailed} || 0;
$Count++;
$UserObject->SetPreferences(
Key => 'UserLoginFailed',
Value => $Count,
UserID => $UserID,
);
# set agent to invalid-temporarily if max failed logins reached
my $Config = $ConfigObject->Get('PreferencesGroups');
my $PasswordMaxLoginFailed;
if ( $Config && $Config->{Password} && $Config->{Password}->{PasswordMaxLoginFailed} ) {
$PasswordMaxLoginFailed = $Config->{Password}->{PasswordMaxLoginFailed};
}
return if !%User;
return if !$PasswordMaxLoginFailed;
return if $Count < $PasswordMaxLoginFailed;
my $ValidID = $Kernel::OM->Get('Kernel::System::Valid')->ValidLookup(
Valid => 'invalid-temporarily',
);
# Make sure not to accidentially overwrite the password.
delete $User{UserPw};
my $Update = $UserObject->UserUpdate(
%User,
ValidID => $ValidID,
ChangeUserID => 1,
);
return if !$Update;
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'notice',
Message => "Login failed $Count times. Set $User{UserLogin} to "
. "'invalid-temporarily'.",
);
return;
}
# remember login attributes
my $UserID = $UserObject->UserLookup(
UserLogin => $User,
);
return $User if !$UserID;
# on system maintenance just admin users
# should be allowed to get into the system
my $ActiveMaintenance = $Kernel::OM->Get('Kernel::System::SystemMaintenance')->SystemMaintenanceIsActive();
# reset failed logins
$UserObject->SetPreferences(
Key => 'UserLoginFailed',
Value => 0,
UserID => $UserID,
);
# check if system maintenance is active
if ($ActiveMaintenance) {
# check if user is allow to login
# get current user groups
my %Groups = $Kernel::OM->Get('Kernel::System::Group')->PermissionUserGet(
UserID => $UserID,
Type => 'move_into',
);
# reverse groups hash for easy look up
%Groups = reverse %Groups;
# check if the user is in the Admin group
# if that is not the case return
if ( !$Groups{admin} ) {
$Self->{LastErrorMessage} =
$ConfigObject->Get('SystemMaintenance::IsActiveDefaultLoginErrorMessage')
|| Translatable("It is currently not possible to login due to a scheduled system maintenance.");
return;
}
}
# last login preferences update
$UserObject->SetPreferences(
Key => 'UserLastLogin',
Value => $Kernel::OM->Create('Kernel::System::DateTime')->ToEpoch(),
UserID => $UserID,
);
return $User;
}
=head2 GetLastErrorMessage()
Retrieve $Self->{LastErrorMessage} content.
my $AuthErrorMessage = $AuthObject->GetLastErrorMessage();
Result:
$AuthErrorMessage = "An error string message.";
=cut
sub GetLastErrorMessage {
my ( $Self, %Param ) = @_;
return $Self->{LastErrorMessage};
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<http://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (AGPL). If you
did not receive this file, see L<http://www.gnu.org/licenses/agpl.txt>.
=cut
|