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
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::GenericInterface::Operation::Session::SessionGet;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(IsStringWithData IsHashRefWithData);
use parent qw(
Kernel::GenericInterface::Operation::Common
Kernel::GenericInterface::Operation::Session::Common
);
our $ObjectManagerDisabled = 1;
=head1 NAME
Kernel::GenericInterface::Operation::Session::SessionGet - GenericInterface Session Get Operation backend
=head1 PUBLIC INTERFACE
=head2 new()
usually, you want to create an instance of this
by using Kernel::GenericInterface::Operation->new();
=cut
sub new {
my ( $Type, %Param ) = @_;
my $Self = {};
bless( $Self, $Type );
# check needed objects
for my $Needed (
qw(DebuggerObject WebserviceID)
)
{
if ( !$Param{$Needed} ) {
return {
Success => 0,
ErrorMessage => "Got no $Needed!"
};
}
$Self->{$Needed} = $Param{$Needed};
}
return $Self;
}
=head2 Run()
Get session information.
my $Result = $OperationObject->Run(
Data => {
SessionID => '1234567890123456',
},
);
$Result = {
Success => 1, # 0 or 1
ErrorMessage => '', # In case of an error
Data => {
UserSessionStart => '1293801801',
UserRemoteAddr => '127.0.0.1',
UserRemoteUserAgent => 'Some User Agent x.x',
UserLastname => 'SomeLastName',
UserFirstname => 'SomeFirstname',
# and other preferences values
},
};
=cut
sub Run {
my ( $Self, %Param ) = @_;
if ( !IsHashRefWithData( $Param{Data} ) ) {
return $Self->ReturnError(
ErrorCode => 'SessionGet.MissingParameter',
ErrorMessage => "SessionGet: The request is empty!",
);
}
if ( !$Param{Data}->{SessionID} ) {
return $Self->ReturnError(
ErrorCode => 'SessionGet.MissingParameter',
ErrorMessage => "SessionGet: SessionID is missing!",
);
}
my $SessionObject = $Kernel::OM->Get('Kernel::System::AuthSession');
# Honor SessionCheckRemoteIP, SessionMaxIdleTime, etc.
my $Valid = $SessionObject->CheckSessionID(
SessionID => $Param{Data}->{SessionID},
);
if ( !$Valid ) {
return $Self->ReturnError(
ErrorCode => 'SessionGet.SessionInvalid',
ErrorMessage => 'SessionGet: SessionID is Invalid!',
);
}
my %SessionDataRaw = $SessionObject->GetSessionIDData(
SessionID => $Param{Data}->{SessionID},
);
# Filter out some sensitive values
delete $SessionDataRaw{UserPw};
delete $SessionDataRaw{UserChallengeToken};
my $JSONObject = $Kernel::OM->Get('Kernel::System::JSON');
my @SessionData;
for my $DataKey ( sort keys %SessionDataRaw ) {
my $Value = $SessionDataRaw{$DataKey};
my %Data = (
Key => $DataKey,
Value => $Value,
);
if ( ref $Value ) {
$Data{Value} = $JSONObject->Encode(
Data => $Value,
SortKeys => 1,
);
$Data{Serialized} = 1;
}
push @SessionData, \%Data;
}
return {
Success => 1,
Data => {
SessionData => \@SessionData,
},
};
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (GPL). If you
did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut
|