1 /*******************************************************************************
2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 * ============LICENSE_END=========================================================
19 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 *******************************************************************************/
22 package org.onap.dmaap.dmf.mr.service.impl;
24 import com.att.eelf.configuration.EELFLogger;
25 import com.att.eelf.configuration.EELFManager;
26 import com.att.nsa.configs.ConfigDbException;
27 import com.att.nsa.drumlin.service.standards.HttpStatusCodes;
28 import com.att.nsa.security.NsaApiKey;
29 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
30 import com.att.nsa.security.db.NsaApiDb;
31 import com.att.nsa.security.db.NsaApiDb.KeyExistsException;
32 import com.att.nsa.security.db.simple.NsaSimpleApiKey;
33 import org.json.JSONArray;
34 import org.json.JSONObject;
35 import org.onap.dmaap.dmf.mr.beans.ApiKeyBean;
36 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
37 import org.onap.dmaap.dmf.mr.constants.CambriaConstants;
38 import org.onap.dmaap.dmf.mr.security.DMaaPAuthenticatorImpl;
39 import org.onap.dmaap.dmf.mr.service.ApiKeysService;
40 import org.onap.dmaap.dmf.mr.utils.ConfigurationReader;
41 import org.onap.dmaap.dmf.mr.utils.DMaaPResponseBuilder;
42 import org.onap.dmaap.dmf.mr.utils.Emailer;
43 import org.springframework.stereotype.Service;
45 import java.io.IOException;
48 * Implementation of the ApiKeysService, this will provide the below operations,
49 * getAllApiKeys, getApiKey, createApiKey, updateApiKey, deleteApiKey
51 * @author nilanjana.maity
54 public class ApiKeysServiceImpl implements ApiKeysService {
57 private static final EELFLogger log = EELFManager.getInstance().getLogger(ApiKeysServiceImpl.class.toString());
59 * This method will provide all the ApiKeys present in kafka server.
62 * @throws ConfigDbException
65 public void getAllApiKeys(DMaaPContext dmaapContext)
66 throws ConfigDbException, IOException {
68 ConfigurationReader configReader = dmaapContext.getConfigReader();
70 log.info("configReader : " + configReader.toString());
72 final JSONObject result = new JSONObject();
73 final JSONArray keys = new JSONArray();
74 result.put("apiKeys", keys);
76 NsaApiDb<NsaSimpleApiKey> apiDb = configReader.getfApiKeyDb();
78 for (String key : apiDb.loadAllKeys()) {
81 log.info("========== ApiKeysServiceImpl: getAllApiKeys: Api Keys are : "
82 + keys.toString() + "===========");
83 DMaaPResponseBuilder.respondOk(dmaapContext, result);
89 * @throws ConfigDbException
93 public void getApiKey(DMaaPContext dmaapContext, String apikey)
94 throws ConfigDbException, IOException {
96 String errorMsg = "Api key name is not mentioned.";
97 int errorCode = HttpStatusCodes.k400_badRequest;
100 NsaSimpleApiKey simpleApiKey = getApiKeyDb(dmaapContext)
104 if (null != simpleApiKey) {
105 JSONObject result = simpleApiKey.asJsonObject();
106 DMaaPResponseBuilder.respondOk(dmaapContext, result);
107 log.info("========== ApiKeysServiceImpl: getApiKey : "
108 + result.toString() + "===========");
111 errorMsg = "Api key [" + apikey + "] does not exist.";
112 errorCode = HttpStatusCodes.k404_notFound;
113 log.info("========== ApiKeysServiceImpl: getApiKey: Error : API Key does not exist. "
115 DMaaPResponseBuilder.respondWithError(dmaapContext, errorCode,
117 throw new IOException();
124 * @param dmaapContext
126 * @throws KeyExistsException
127 * @throws ConfigDbException
128 * @throws IOException
131 public void createApiKey(DMaaPContext dmaapContext, ApiKeyBean nsaApiKey)
132 throws KeyExistsException, ConfigDbException, IOException {
134 log.debug("TopicService: : createApiKey....");
136 String contactEmail = nsaApiKey.getEmail();
137 final boolean emailProvided = contactEmail != null && contactEmail.length() > 0 && contactEmail.indexOf("@") > 1 ;
138 String kSetting_AllowAnonymousKeys= com.att.ajsc.filemonitor.AJSCPropertiesMap.getProperty(CambriaConstants.msgRtr_prop,"apiKeys.allowAnonymous");
139 if(null==kSetting_AllowAnonymousKeys) {
140 kSetting_AllowAnonymousKeys ="false";
143 if ( kSetting_AllowAnonymousKeys.equalsIgnoreCase("true") && !emailProvided )
145 DMaaPResponseBuilder.respondWithErrorInJson(dmaapContext, 400, "You must provide an email address.");
150 final NsaApiDb<NsaSimpleApiKey> apiKeyDb = getApiKeyDb(dmaapContext);
151 String apiKey = nsaApiKey.getKey();
152 String sharedSecret = nsaApiKey.getSharedSecret();
153 final NsaSimpleApiKey key = apiKeyDb.createApiKey(apiKey,
157 if (null != nsaApiKey.getEmail()) {
158 key.setContactEmail(nsaApiKey.getEmail());
161 if (null != nsaApiKey.getDescription()) {
162 key.setDescription(nsaApiKey.getDescription());
165 log.debug("=======ApiKeysServiceImpl: createApiKey : saving api key : "
166 + key.toString() + "=====");
167 apiKeyDb.saveApiKey(key);
169 // email out the secret to validate the email address
172 String body = "\n" + "Your email address was provided as the creator of new API key \""
173 + apiKey + "\".\n" + "\n" + "If you did not make this request, please let us know."
174 + "but don't worry -"
175 + " the API key is useless without the information below, which has been provided "
176 + "only to you.\n" + "\n\n" + "For API key \"" + apiKey + "\", use API key secret:\n\n\t"
177 + sharedSecret + "\n\n" + "Note that it's normal to share the API key"
178 + " (" + apiKey + "). "
179 + "This is how you are granted access to resources " + "like a UEB topic or Flatiron scope. "
180 + "However, you should NOT share the API key's secret. " + "The API key is associated with your"
181 + " email alone. ALL access to data made with this " + "key will be your responsibility. If you "
182 + "share the secret, someone else can use the API key " + "to access proprietary data with your "
183 + "identity.\n" + "\n" + "Enjoy!\n" + "\n" + "The GFP/SA-2020 Team";
185 Emailer em = dmaapContext.getConfigReader().getSystemEmailer();
186 em.send(contactEmail, "New API Key", body);
188 log.debug("TopicService: : sending response.");
190 JSONObject o = key.asJsonObject();
192 o.put ( NsaSimpleApiKey.kApiSecretField,
194 "Emailed to " + contactEmail + "." :
197 DMaaPResponseBuilder.respondOk(dmaapContext,
202 log.debug("=======ApiKeysServiceImpl: createApiKey : Error in creating API Key.=====");
203 DMaaPResponseBuilder.respondWithError(dmaapContext,
204 HttpStatusCodes.k500_internalServerError,
205 "Failed to create api key.");
206 throw new KeyExistsException(apiKey);
211 * @param dmaapContext
214 * @throws ConfigDbException
215 * @throws IOException
216 * @throws AccessDeniedException
219 public void updateApiKey(DMaaPContext dmaapContext, String apikey,
220 ApiKeyBean nsaApiKey) throws ConfigDbException, IOException, AccessDeniedException {
222 String errorMsg = "Api key name is not mentioned.";
223 int errorCode = HttpStatusCodes.k400_badRequest;
225 if (null != apikey) {
226 final NsaApiDb<NsaSimpleApiKey> apiKeyDb = getApiKeyDb(dmaapContext);
227 final NsaSimpleApiKey key = apiKeyDb.loadApiKey(apikey);
228 boolean shouldUpdate = false;
231 final NsaApiKey user = DMaaPAuthenticatorImpl
232 .getAuthenticatedUser(dmaapContext);
234 if (user == null || !user.getKey().equals(key.getKey())) {
235 throw new AccessDeniedException("You must authenticate with the key you'd like to update.");
238 if (null != nsaApiKey.getEmail()) {
239 key.setContactEmail(nsaApiKey.getEmail());
243 if (null != nsaApiKey.getDescription()) {
244 key.setDescription(nsaApiKey.getDescription());
249 apiKeyDb.saveApiKey(key);
252 log.info("======ApiKeysServiceImpl : updateApiKey : Key Updated Successfully :"
253 + key.toString() + "=========");
254 DMaaPResponseBuilder.respondOk(dmaapContext,
259 errorMsg = "Api key [" + apikey + "] does not exist.";
260 errorCode = HttpStatusCodes.k404_notFound;
261 DMaaPResponseBuilder.respondWithError(dmaapContext, errorCode,
263 log.info("======ApiKeysServiceImpl : updateApiKey : Error in Updating Key.============");
264 throw new IOException();
269 * @param dmaapContext
271 * @throws ConfigDbException
272 * @throws IOException
273 * @throws AccessDeniedException
276 public void deleteApiKey(DMaaPContext dmaapContext, String apikey)
277 throws ConfigDbException, IOException, AccessDeniedException {
279 String errorMsg = "Api key name is not mentioned.";
280 int errorCode = HttpStatusCodes.k400_badRequest;
282 if (null != apikey) {
283 final NsaApiDb<NsaSimpleApiKey> apiKeyDb = getApiKeyDb(dmaapContext);
284 final NsaSimpleApiKey key = apiKeyDb.loadApiKey(apikey);
288 final NsaApiKey user = DMaaPAuthenticatorImpl
289 .getAuthenticatedUser(dmaapContext);
290 if (user == null || !user.getKey().equals(key.getKey())) {
291 throw new AccessDeniedException("You don't own the API key.");
294 apiKeyDb.deleteApiKey(key);
295 log.info("======ApiKeysServiceImpl : deleteApiKey : Deleted Key successfully.============");
296 DMaaPResponseBuilder.respondOkWithHtml(dmaapContext,
297 "Api key [" + apikey + "] deleted successfully.");
301 errorMsg = "Api key [" + apikey + "] does not exist.";
302 errorCode = HttpStatusCodes.k404_notFound;
303 DMaaPResponseBuilder.respondWithError(dmaapContext, errorCode,
305 log.info("======ApiKeysServiceImpl : deleteApiKey : Error while deleting key.============");
306 throw new IOException();
312 * @param dmaapContext
315 private NsaApiDb<NsaSimpleApiKey> getApiKeyDb(DMaaPContext dmaapContext) {
316 ConfigurationReader configReader = dmaapContext.getConfigReader();
317 return configReader.getfApiKeyDb();