Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.opencord.kafka.integrations; |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 18 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.JsonNode; |
| 20 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 21 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Shubham Sharma | 4cf3760 | 2019-06-20 07:16:08 +0000 | [diff] [blame^] | 22 | import java.time.Instant; |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 23 | import org.onosproject.net.AnnotationKeys; |
| 24 | import org.onosproject.net.device.DeviceService; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 25 | import org.opencord.aaa.AuthenticationEvent; |
| 26 | import org.opencord.aaa.AuthenticationEventListener; |
| 27 | import org.opencord.aaa.AuthenticationService; |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 28 | import org.opencord.aaa.AuthenticationStatisticsEvent; |
| 29 | import org.opencord.aaa.AuthenticationStatisticsEventListener; |
| 30 | import org.opencord.aaa.AuthenticationStatisticsService; |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 31 | import org.opencord.kafka.EventBusService; |
| 32 | import org.osgi.service.component.annotations.Activate; |
| 33 | import org.osgi.service.component.annotations.Component; |
| 34 | import org.osgi.service.component.annotations.Deactivate; |
| 35 | import org.osgi.service.component.annotations.Reference; |
| 36 | import org.osgi.service.component.annotations.ReferenceCardinality; |
| 37 | import org.osgi.service.component.annotations.ReferencePolicy; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 38 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 39 | import java.util.concurrent.atomic.AtomicReference; |
Jonathan Hart | 2aad779 | 2018-07-31 15:09:17 -0400 | [diff] [blame] | 40 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 41 | /** |
| 42 | * Listens for AAA events and pushes them on a Kafka bus. |
| 43 | */ |
| 44 | @Component(immediate = true) |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 45 | public class AaaKafkaIntegration extends AbstractKafkaIntegration { |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 46 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 47 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 48 | protected EventBusService eventBusService; |
| 49 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 50 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 51 | protected DeviceService deviceService; |
| 52 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 53 | @Reference(cardinality = ReferenceCardinality.OPTIONAL, |
Matteo Scandolo | d50a4d3 | 2019-04-24 12:10:21 -0700 | [diff] [blame] | 54 | policy = ReferencePolicy.DYNAMIC, |
Matteo Scandolo | 03f13c1 | 2019-03-20 14:38:12 -0700 | [diff] [blame] | 55 | bind = "bindAuthenticationService", |
| 56 | unbind = "unbindAuthenticationService") |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 57 | protected volatile AuthenticationService ignore; |
| 58 | private final AtomicReference<AuthenticationService> authServiceRef = new AtomicReference<>(); |
| 59 | @Reference(cardinality = ReferenceCardinality.OPTIONAL, |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 60 | policy = ReferencePolicy.DYNAMIC, |
| 61 | bind = "bindAuthenticationStatService", |
| 62 | unbind = "unbindAuthenticationStatService") |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 63 | protected volatile AuthenticationStatisticsService ignore2; |
| 64 | private final AtomicReference<AuthenticationStatisticsService> authStatServiceRef = new AtomicReference<>(); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 65 | |
| 66 | private final AuthenticationEventListener listener = new InternalAuthenticationListener(); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 67 | private final AuthenticationStatisticsEventListener authenticationStatisticsEventListener = |
Shubham Sharma | 4cf3760 | 2019-06-20 07:16:08 +0000 | [diff] [blame^] | 68 | new InternalAuthenticationStatisticsListner(); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 69 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 70 | // topics |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 71 | private static final String TOPIC = "authentication.events"; |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 72 | private static final String AUTHENTICATION_STATISTICS_TOPIC = "onos.aaa.stats.kpis"; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 73 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 74 | // auth event params |
Jonathan Hart | 2aad779 | 2018-07-31 15:09:17 -0400 | [diff] [blame] | 75 | private static final String TIMESTAMP = "timestamp"; |
Jonathan Hart | f54e5ba | 2018-07-31 14:57:22 -0400 | [diff] [blame] | 76 | private static final String DEVICE_ID = "deviceId"; |
| 77 | private static final String PORT_NUMBER = "portNumber"; |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 78 | private static final String SERIAL_NUMBER = "serialNumber"; |
Jonathan Hart | f54e5ba | 2018-07-31 14:57:22 -0400 | [diff] [blame] | 79 | private static final String AUTHENTICATION_STATE = "authenticationState"; |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 80 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 81 | // auth stats event params |
| 82 | private static final String ACCEPT_RESPONSES_RX = "acceptResponsesRx"; |
| 83 | private static final String REJECT_RESPONSES_RX = "rejectResponsesRx"; |
| 84 | private static final String CHALLENGE_RESPONSES_RX = "challengeResponsesRx"; |
| 85 | private static final String ACCESS_REQUESTS_TX = "accessRequestsTx"; |
| 86 | private static final String INVALID_VALIDATORS_RX = "invalidValidatorsRx"; |
| 87 | private static final String UNKNOWN_TYPE_RX = "unknownTypeRx"; |
| 88 | private static final String PENDING_REQUESTS = "pendingRequests"; |
| 89 | private static final String DROPPED_RESPONSES_RX = "droppedResponsesRx"; |
| 90 | private static final String MALFORMED_RESPONSES_RX = "malformedResponsesRx"; |
| 91 | private static final String UNKNOWN_SERVER_RX = "unknownServerRx"; |
| 92 | private static final String REQUEST_RTT_MILLIS = "requestRttMillis"; |
| 93 | private static final String REQUEST_RE_TX = "requestReTx"; |
Shubham Sharma | 4cf3760 | 2019-06-20 07:16:08 +0000 | [diff] [blame^] | 94 | private static final String TIMED_OUT_PACKETS = "timedOutPackets"; |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 95 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 96 | protected void bindAuthenticationService(AuthenticationService incomingService) { |
| 97 | bindAndAddListener(incomingService, authServiceRef, listener); |
Matteo Scandolo | 03f13c1 | 2019-03-20 14:38:12 -0700 | [diff] [blame] | 98 | } |
| 99 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 100 | protected void unbindAuthenticationService(AuthenticationService outgoingService) { |
| 101 | unbindAndRemoveListener(outgoingService, authServiceRef, listener); |
Matteo Scandolo | 03f13c1 | 2019-03-20 14:38:12 -0700 | [diff] [blame] | 102 | } |
| 103 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 104 | protected void bindAuthenticationStatService(AuthenticationStatisticsService incomingService) { |
| 105 | bindAndAddListener(incomingService, authStatServiceRef, authenticationStatisticsEventListener); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 106 | } |
| 107 | |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 108 | protected void unbindAuthenticationStatService(AuthenticationStatisticsService outgoingService) { |
| 109 | unbindAndRemoveListener(outgoingService, authStatServiceRef, authenticationStatisticsEventListener); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 110 | } |
| 111 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 112 | @Activate |
| 113 | public void activate() { |
Matteo Scandolo | d50a4d3 | 2019-04-24 12:10:21 -0700 | [diff] [blame] | 114 | log.info("Started AaaKafkaIntegration"); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Deactivate |
| 118 | public void deactivate() { |
Carmelo Cascone | 7e73fa1 | 2019-07-15 18:29:01 -0700 | [diff] [blame] | 119 | unbindAuthenticationService(authServiceRef.get()); |
| 120 | unbindAuthenticationStatService(authStatServiceRef.get()); |
Matteo Scandolo | d50a4d3 | 2019-04-24 12:10:21 -0700 | [diff] [blame] | 121 | log.info("Stopped AaaKafkaIntegration"); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | private void handle(AuthenticationEvent event) { |
| 125 | eventBusService.send(TOPIC, serialize(event)); |
| 126 | } |
| 127 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 128 | private void handleStat(AuthenticationStatisticsEvent event) { |
| 129 | eventBusService.send(AUTHENTICATION_STATISTICS_TOPIC, serializeStat(event)); |
Matteo Scandolo | 29d3f7b | 2019-11-25 10:42:04 -0700 | [diff] [blame] | 130 | log.trace("AuthenticationStatisticsEvent sent successfully"); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 131 | } |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 132 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 133 | private JsonNode serialize(AuthenticationEvent event) { |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 134 | String sn = deviceService.getPort(event.subject()).annotations().value(AnnotationKeys.PORT_NAME); |
| 135 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 136 | ObjectMapper mapper = new ObjectMapper(); |
| 137 | ObjectNode authEvent = mapper.createObjectNode(); |
Jonathan Hart | 2aad779 | 2018-07-31 15:09:17 -0400 | [diff] [blame] | 138 | authEvent.put(TIMESTAMP, Instant.now().toString()); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 139 | authEvent.put(DEVICE_ID, event.subject().deviceId().toString()); |
| 140 | authEvent.put(PORT_NUMBER, event.subject().port().toString()); |
Matteo Scandolo | 580fb7f | 2019-04-17 15:33:15 -0700 | [diff] [blame] | 141 | authEvent.put(SERIAL_NUMBER, sn); |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 142 | authEvent.put(AUTHENTICATION_STATE, event.type().toString()); |
| 143 | return authEvent; |
| 144 | } |
| 145 | |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 146 | private JsonNode serializeStat(AuthenticationStatisticsEvent event) { |
Matteo Scandolo | 29d3f7b | 2019-11-25 10:42:04 -0700 | [diff] [blame] | 147 | log.trace("Serializing AuthenticationStatisticsEvent"); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 148 | ObjectMapper mapper = new ObjectMapper(); |
| 149 | ObjectNode authMetricsEvent = mapper.createObjectNode(); |
| 150 | authMetricsEvent.put(TIMESTAMP, Instant.now().toString()); |
| 151 | authMetricsEvent.put(ACCEPT_RESPONSES_RX, event.subject().getAcceptResponsesRx()); |
| 152 | authMetricsEvent.put(REJECT_RESPONSES_RX, event.subject().getRejectResponsesRx()); |
| 153 | authMetricsEvent.put(CHALLENGE_RESPONSES_RX, event.subject().getChallengeResponsesRx()); |
| 154 | authMetricsEvent.put(ACCESS_REQUESTS_TX, event.subject().getAccessRequestsTx()); |
| 155 | authMetricsEvent.put(INVALID_VALIDATORS_RX, event.subject().getInvalidValidatorsRx()); |
| 156 | authMetricsEvent.put(UNKNOWN_TYPE_RX, event.subject().getUnknownTypeRx()); |
| 157 | authMetricsEvent.put(PENDING_REQUESTS, event.subject().getPendingRequests()); |
| 158 | authMetricsEvent.put(DROPPED_RESPONSES_RX, event.subject().getDroppedResponsesRx()); |
| 159 | authMetricsEvent.put(MALFORMED_RESPONSES_RX, event.subject().getMalformedResponsesRx()); |
| 160 | authMetricsEvent.put(UNKNOWN_SERVER_RX, event.subject().getUnknownServerRx()); |
| 161 | authMetricsEvent.put(REQUEST_RTT_MILLIS, event.subject().getRequestRttMilis()); |
| 162 | authMetricsEvent.put(REQUEST_RE_TX, event.subject().getRequestReTx()); |
Shubham Sharma | 4cf3760 | 2019-06-20 07:16:08 +0000 | [diff] [blame^] | 163 | authMetricsEvent.put(TIMED_OUT_PACKETS, event.subject().getTimedOutPackets()); |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 164 | return authMetricsEvent; |
| 165 | } |
| 166 | |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 167 | private class InternalAuthenticationListener implements |
Shubham Sharma | 4cf3760 | 2019-06-20 07:16:08 +0000 | [diff] [blame^] | 168 | AuthenticationEventListener { |
Jonathan Hart | 501f788 | 2018-07-24 14:39:57 -0700 | [diff] [blame] | 169 | @Override |
| 170 | public void event(AuthenticationEvent authenticationEvent) { |
| 171 | handle(authenticationEvent); |
| 172 | } |
| 173 | } |
kartikey dubey | 6e90309 | 2019-05-22 13:35:28 +0000 | [diff] [blame] | 174 | |
| 175 | private class InternalAuthenticationStatisticsListner implements |
| 176 | AuthenticationStatisticsEventListener { |
| 177 | @Override |
| 178 | public void event(AuthenticationStatisticsEvent authenticationStatisticsEvent) { |
| 179 | handleStat(authenticationStatisticsEvent); |
| 180 | } |
| 181 | } |
| 182 | } |