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
|
# --
# 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::Common;
use strict;
use warnings;
use Kernel::System::VariableCheck qw(:all);
our $ObjectManagerDisabled = 1;
=head1 NAME
Kernel::GenericInterface::Operation::Common - Base class for all Operations
=head1 PUBLIC INTERFACE
=head2 Auth()
performs user or customer user authorization
my ( $UserID, $UserType ) = $CommonObject->Auth(
Data => {
SessionID => 'AValidSessionIDValue' # the ID of the user session
UserLogin => 'Agent', # if no SessionID is given UserLogin or
# CustomerUserLogin is required
CustomerUserLogin => 'Customer',
Password => 'some password', # user password
},
);
returns
(
1, # the UserID from login or session data
'Agent', # || 'Customer', the UserType.
);
=cut
sub Auth {
my ( $Self, %Param ) = @_;
my $SessionID = $Param{Data}->{SessionID} || '';
# check if a valid SessionID is present
if ($SessionID) {
my $ValidSessionID;
# get session object
my $SessionObject = $Kernel::OM->Get('Kernel::System::AuthSession');
if ($SessionID) {
$ValidSessionID = $SessionObject->CheckSessionID( SessionID => $SessionID );
}
return 0 if !$ValidSessionID;
# get session data
my %UserData = $SessionObject->GetSessionIDData(
SessionID => $SessionID,
);
# get UserID from SessionIDData
if ( $UserData{UserID} && $UserData{UserType} ne 'Customer' ) {
return ( $UserData{UserID}, $UserData{UserType} );
}
elsif ( $UserData{UserLogin} && $UserData{UserType} eq 'Customer' ) {
# if UserCustomerLogin
return ( $UserData{UserLogin}, $UserData{UserType} );
}
return 0;
}
if ( defined $Param{Data}->{UserLogin} && $Param{Data}->{UserLogin} ) {
my $UserID = $Self->_AuthUser(%Param);
# if UserLogin
if ($UserID) {
return ( $UserID, 'User' );
}
}
elsif ( defined $Param{Data}->{CustomerUserLogin} && $Param{Data}->{CustomerUserLogin} ) {
my $CustomerUserID = $Self->_AuthCustomerUser(%Param);
# if UserCustomerLogin
if ($CustomerUserID) {
return ( $CustomerUserID, 'Customer' );
}
}
return 0;
}
=head2 ReturnError()
helper function to return an error message.
my $Return = $CommonObject->ReturnError(
ErrorCode => Ticket.AccessDenied,
ErrorMessage => 'You don't have rights to access this ticket',
);
=cut
sub ReturnError {
my ( $Self, %Param ) = @_;
$Self->{DebuggerObject}->Error(
Summary => $Param{ErrorCode},
Data => $Param{ErrorMessage},
);
# return structure
return {
Success => 1,
ErrorMessage => "$Param{ErrorCode}: $Param{ErrorMessage}",
Data => {
Error => {
ErrorCode => $Param{ErrorCode},
ErrorMessage => $Param{ErrorMessage},
},
},
};
}
=begin Internal:
=head2 _AuthUser()
performs user authentication
my $UserID = $CommonObject->_AuthUser(
UserLogin => 'Agent',
Password => 'some password', # plain text password
);
returns
$UserID = 1; # the UserID from login or session data
=cut
sub _AuthUser {
my ( $Self, %Param ) = @_;
my $ReturnData = 0;
# get params
my $PostUser = $Param{Data}->{UserLogin} || '';
my $PostPw = $Param{Data}->{Password} || '';
# check submitted data
my $User = $Kernel::OM->Get('Kernel::System::Auth')->Auth(
User => $PostUser,
Pw => $PostPw,
);
# login is valid
if ($User) {
# get UserID
my $UserID = $Kernel::OM->Get('Kernel::System::User')->UserLookup(
UserLogin => $User,
);
$ReturnData = $UserID;
}
return $ReturnData;
}
=head2 _AuthCustomerUser()
performs customer user authentication
my $UserID = $CommonObject->_AuthCustomerUser(
UserLogin => 'Agent',
Password => 'some password', # plain text password
);
returns
$UserID = 1; # the UserID from login or session data
=cut
sub _AuthCustomerUser {
my ( $Self, %Param ) = @_;
my $ReturnData = $Param{Data}->{CustomerUserLogin} || 0;
# get params
my $PostUser = $Param{Data}->{CustomerUserLogin} || '';
my $PostPw = $Param{Data}->{Password} || '';
# check submitted data
my $User = $Kernel::OM->Get('Kernel::System::CustomerAuth')->Auth(
User => $PostUser,
Pw => $PostPw,
);
# login is invalid
if ( !$User ) {
$ReturnData = 0;
}
return $ReturnData;
}
1;
=end Internal:
=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
|
