src/main/java/org/onap/clamp/clds/config/spring/CldsSecurityConfigUsers.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  * ===================================================================
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23
  24 package org.onap.clamp.clds.config.spring;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28
  29 import java.io.IOException;
  30
  31 import org.onap.clamp.clds.config.CldsUserJsonDecoder;
  32 import org.onap.clamp.clds.exception.CldsUsersException;
  33 import org.onap.clamp.clds.service.CldsUser;
  34 import org.springframework.beans.factory.annotation.Autowired;
  35 import org.springframework.beans.factory.annotation.Value;
  36 import org.springframework.context.ApplicationContext;
  37 import org.springframework.context.annotation.Configuration;
  38 import org.springframework.context.annotation.Profile;
  39 import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
  40 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  41 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  42 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  43
  44 /**
  45  * This class is used to enable the HTTP authentication to login. It requires a
  46  * specific JSON file containing the user definition
  47  * (classpath:etc/config/clds/clds-users.json).
  48  */
  49 @Configuration
  50 @EnableWebSecurity
  51 @Profile("clamp-spring-authentication")
  52 public class CldsSecurityConfigUsers extends WebSecurityConfigurerAdapter {
  53
  54     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsSecurityConfigUsers.class);
  55     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
  56     @Autowired
  57     private ApplicationContext appContext;
  58     @Value("${org.onap.clamp.config.files.cldsUsers:'classpath:etc/config/clds/clds-users.json'}")
  59     private String cldsUsersFile;
  60     @Value("${clamp.config.security.permission.type.cl:permission-type-cl}")
  61     private String cldsPersmissionTypeCl;
  62     @Value("${CLDS_PERMISSION_INSTANCE:dev}")
  63     private String cldsPermissionInstance;
  64
  65     /**
  66      * This method configures on which URL the authorization will be enabled.
  67      */
  68     @Override
  69     protected void configure(HttpSecurity http) {
  70         try {
  71             http.csrf().disable().httpBasic().and().authorizeRequests().antMatchers("/restservices/clds/v1/user/**")
  72                     .authenticated().anyRequest().permitAll().and().logout();
  73         } catch (Exception e) {
  74             logger.error("Exception occurred during the setup of the Web users in memory", e);
  75             throw new CldsUsersException("Exception occurred during the setup of the Web users in memory", e);
  76         }
  77     }
  78
  79     /**
  80      * This method is called by the framework and is used to load all the users
  81      * defined in cldsUsersFile variable (this file path can be configured in
  82      * the application.properties).
  83      *
  84      * @param auth
  85      */
  86     @Autowired
  87     public void configureGlobal(AuthenticationManagerBuilder auth) {
  88         try {
  89             CldsUser[] usersList = loadUsers();
  90             // no users defined
  91             if (null == usersList) {
  92                 logger.warn("No users defined. Users should be defined under " + cldsUsersFile);
  93                 return;
  94             }
  95             for (CldsUser user : usersList) {
  96                 auth.inMemoryAuthentication().withUser(user.getUser()).password(user.getPassword())
  97                         .roles(user.getPermissionsString());
  98             }
  99         } catch (Exception e) {
 100             logger.error("Exception occurred during the setup of the Web users in memory", e);
 101             throw new CldsUsersException("Exception occurred during the setup of the Web users in memory", e);
 102         }
 103     }
 104
 105     /**
 106      * This method loads physically the JSON file and convert it to an Array of
 107      * CldsUser.
 108      *
 109      * @return The array of CldsUser
 110      */
 111     private CldsUser[] loadUsers() {
 112         try {
 113             logger.info("Load from clds-users.properties");
 114             return CldsUserJsonDecoder.decodeJson(appContext.getResource(cldsUsersFile).getInputStream());
 115         } catch (IOException e) {
 116             logger.error("Unable to decode the User Json file", e);
 117             throw new CldsUsersException("Load from clds-users.properties", e);
 118         }
 119     }
 120 }