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
|
/*-
* ============LICENSE_START==========================================
* ONAP Portal
* ===================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ===================================================================
*
* Unless otherwise specified, all software contained herein is licensed
* under the Apache License, Version 2.0 (the "License");
* you may not use this software except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* ============LICENSE_END============================================
*
*
*/
package org.onap.portalapp.portal.logging.aop;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.onap.portalapp.portal.transport.FieldsValidator;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.portalsdk.core.util.SystemProperties.SecurityEventTypeEnum;
import org.springframework.beans.factory.annotation.Autowired;
@Aspect
@org.springframework.context.annotation.Configuration
public class EPEELFLoggerAspect {
EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(EPEELFLoggerAspect.class);
@Autowired
EPEELFLoggerAdvice epAdvice;
/*
* Point-cut expression to handle all INCOMING_REST_MESSAGES
*/
@Pointcut("execution(public * org.onap.portalapp.portal.controller.*.*(..))")
public void incomingAuditMessages() {}
/*
* Handles all INCOMING_REST_MESSAGES from kpiDashboard
*/
@Pointcut("execution(public * org.onap.portalapp.kpidash.controller.*.*(..))")
public void kpiDashboardAuditMessages() {}
/*
* Point-cut expression to handle all session management INCOMING_REST_MESSAGES
*/
@Pointcut("execution(public * org.onap.portalapp.controller.sessionmgt.*.*(..))")
public void sessionMgtIncomingAuditMessages() {}
/*
* Point-cut expression to handle UserProfileController INCOMING_REST_MESSAGES
*/
@Pointcut("execution(public * org.onap.portalapp.controller.core.UserProfileController.*(..))")
public void userProfileIncomingAuditMessages() {}
/*
* Point-cut expression to handle UserProfileController INCOMING_REST_MESSAGES
*/
@Pointcut("execution(public * org.onap.portalapp.controller.ONAPWelcomeController.*(..))")
public void welcomeIncomingAuditMessages() {}
/*
* Point-cut expression to handle INCOMING Logout Rest Messages
*/
@Pointcut("execution(public * org.onap.portalapp.controller.ECOMPLogoutController.*(..))")
public void logoutAuditMessages() {}
/*
* Point-cut expression which handles all the OUTGOING_REST_MESSAGES.
*/
@Pointcut("execution(public * org.onap.portalapp.portal.service.ApplicationsRestClientServiceImpl.*(..))")
public void outgoingAuditMessages() {}
/*
* Point-cut expression to handle all the session management OUTGOING_REST_MESSAGES.
*/
@Pointcut("execution(public * org.onap.portalapp.service.sessionmgt.SessionCommunication.*(..))")
public void sessionMgtOutgoingAuditMessages() {}
/*
* Point-cut expression which handles all the LDAP_PHONEBOOK_USER_SEARCH calls.
*/
@Pointcut("execution(public * org.onap.portalapp.portal.service.EPLdapServiceImpl.*(..))")
public void phoneBookSearchAuditMessages() {}
/*
* Handles Audit, Metrics & Debug logging for the point-cut
* expression defined at class-level
*/
@Around("(incomingAuditMessages() || kpiDashboardAuditMessages() || sessionMgtIncomingAuditMessages() || "
+ "userProfileIncomingAuditMessages() || welcomeIncomingAuditMessages()) && @within(epAuditLog)")
public Object incomingAuditMessagesAroundClass(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.INCOMING_REST_MESSAGE);
}
/*
* Handles Audit, Metrics & Debug logging for the point-cut
* expression defined at class-level
*/
@Around("(outgoingAuditMessages() || sessionMgtOutgoingAuditMessages()) && @within(epAuditLog)")
public Object outgoingAuditMessagesAroundClass(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.OUTGOING_REST_MESSAGE);
}
/*
* Handles Audit, Metrics & Debug logging for the point-cut
* expression defined at method-level
*/
@Around("(outgoingAuditMessages() || sessionMgtOutgoingAuditMessages()) && @annotation(epAuditLog)")
public Object outgoingAuditMessagesAroundMethod(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.OUTGOING_REST_MESSAGE);
}
/*
* Handles Audit, Metrics & Debug logging for the point-cut
* expression defined at method-level
*/
@Around("(incomingAuditMessages() || kpiDashboardAuditMessages() || sessionMgtIncomingAuditMessages() ||"
+ "userProfileIncomingAuditMessages() || welcomeIncomingAuditMessages()) && @annotation(epAuditLog)")
public Object incomingAuditMessagesAroundMethod(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.INCOMING_REST_MESSAGE);
}
@Around("@annotation(epAuditLog)")
public Object loginAuditMessagesAroundMethod(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.FE_LOGIN_ATTEMPT);
}
@Around("logoutAuditMessages() && @annotation(epAuditLog)")
public Object logoutAuditMessagesAroundMethod(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.FE_LOGOUT);
}
@Around("phoneBookSearchAuditMessages() && @annotation(epAuditLog)")
public Object phonebookSearchAuditMessagesAroundMethod(ProceedingJoinPoint joinPoint, EPAuditLog epAuditLog) throws Throwable {
return this.logAroundMethod(joinPoint, SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH);
}
private Object logAroundMethod(ProceedingJoinPoint joinPoint, SecurityEventTypeEnum securityEventType) throws Throwable {
//Before
Object[] passOnArgs = new Object[] {joinPoint.getSignature().getDeclaringType().getName(), joinPoint.getSignature().getName()};
Object[] returnArgs = epAdvice.before(securityEventType, joinPoint.getArgs(), passOnArgs);
//Call the actual method
Object result = null;
String statusCode = "COMPLETE";
String responseCode = "200";
try {
result = joinPoint.proceed();
} catch(Exception e) {
logger.error(EELFLoggerDelegate.errorLogger, "logAroundMethod failed", e);
statusCode = "ERROR";
responseCode = "500"; //Internal server error
}
//Check the result
if (securityEventType!=null) {
if (result==null) {
statusCode = "ERROR";
//Check if there is an internal response code
//and use it if the caller function has configured it.
responseCode = epAdvice.getInternalResponseCode();
if (responseCode==null||responseCode=="") {
responseCode = "500"; //Internal server error
}
} else if (result instanceof FieldsValidator) {
FieldsValidator fieldsValidator = (FieldsValidator) result;
if (fieldsValidator!=null && fieldsValidator.httpStatusCode!=null) {
responseCode = fieldsValidator.httpStatusCode.toString();
}
}
}
//After
epAdvice.after(securityEventType, statusCode, responseCode, joinPoint.getArgs(), returnArgs, passOnArgs);
return result;
}
//Metrics Logging
@Pointcut("execution(* *(..))")
public void performMetricsLogging() {}
@Around("performMetricsLogging() && @within(epMetricsLog)")
public Object metricsLoggingAroundClass(ProceedingJoinPoint joinPoint, EPMetricsLog epMetricsLog) throws Throwable {
return this.logAroundMethod(joinPoint, null);
}
@Around("performMetricsLogging() && @annotation(epMetricsLog)")
public Object metricsLoggingAroundMethod(ProceedingJoinPoint joinPoint, EPMetricsLog epMetricsLog) throws Throwable {
return this.logAroundMethod(joinPoint, null);
}
}
|
