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  *
  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.ClampProperties;
  32 import org.onap.clamp.clds.config.CldsUserJsonDecoder;
  33 import org.onap.clamp.clds.exception.CldsConfigException;
  34 import org.onap.clamp.clds.exception.CldsUsersException;
  35 import org.onap.clamp.clds.service.CldsUser;
  36 import org.springframework.beans.factory.annotation.Autowired;
  37 import org.springframework.beans.factory.annotation.Value;
  38 import org.springframework.context.annotation.Configuration;
  39 import org.springframework.context.annotation.Profile;
  40 import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
  41 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  42 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  43 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  44 import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  45 import org.springframework.security.crypto.password.PasswordEncoder;
  46
  47 /**
  48  * This class is used to enable the HTTP authentication to login. It requires a
  49  * specific JSON file containing the user definition
  50  * (classpath:clds/clds-users.json).
  51  */
  52 @Configuration
  53 @EnableWebSecurity
  54 @Profile("clamp-spring-authentication")
  55 public class CldsSecurityConfigUsers extends WebSecurityConfigurerAdapter {
  56
  57     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsSecurityConfigUsers.class);
  58     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
  59     @Autowired
  60     private ClampProperties refProp;
  61     @Value("${clamp.config.security.permission.type.cl:permission-type-cl}")
  62     private String cldsPersmissionTypeCl;
  63     @Value("${CLDS_PERMISSION_INSTANCE:dev}")
  64     private String cldsPermissionInstance;
  65     @Value("${clamp.config.security.encoder:bcrypt}")
  66     private String cldsEncoderMethod;
  67     @Value("${clamp.config.security.encoder.bcrypt.strength:10}")
  68     private Integer cldsBcryptEncoderStrength;
  69
  70     /**
  71      * This method configures on which URL the authorization will be enabled.
  72      */
  73     @Override
  74     protected void configure(HttpSecurity http) {
  75         try {
  76             http.csrf().disable().httpBasic().and().authorizeRequests().antMatchers("/restservices/clds/v1/user/**")
  77                     .authenticated().anyRequest().permitAll().and().logout();
  78         } catch (Exception e) {
  79             logger.error("Exception occurred during the setup of the Web users in memory", e);
  80             throw new CldsUsersException("Exception occurred during the setup of the Web users in memory", e);
  81         }
  82     }
  83
  84     /**
  85      * This method is called by the framework and is used to load all the users
  86      * defined in cldsUsersFile variable (this file path can be configured in
  87      * the application.properties).
  88      *
  89      * @param auth
  90      */
  91     @Autowired
  92     public void configureGlobal(AuthenticationManagerBuilder auth) {
  93         // configure algorithm used for password hashing
  94         final PasswordEncoder passwordEncoder = getPasswordEncoder();
  95
  96         try {
  97             CldsUser[] usersList = loadUsers();
  98             // no users defined
  99             if (null == usersList) {
 100                 logger.warn("No users defined. Users should be defined under clds-users.json");
 101                 return;
 102             }
 103             for (CldsUser user : usersList) {
 104                 auth.inMemoryAuthentication().withUser(user.getUser()).password(user.getPassword())
 105                     .roles(user.getPermissionsString()).and().passwordEncoder(passwordEncoder);
 106             }
 107         } catch (Exception e) {
 108             logger.error("Exception occurred during the setup of the Web users in memory", e);
 109             throw new CldsUsersException("Exception occurred during the setup of the Web users in memory", e);
 110         }
 111     }
 112
 113     /**
 114      * This method loads physically the JSON file and convert it to an Array of
 115      * CldsUser.
 116      *
 117      * @return The array of CldsUser
 118      * @throws IOException
 119      *             In case of the file is not found
 120      */
 121     private CldsUser[] loadUsers() throws IOException {
 122         logger.info("Load from clds-users.properties");
 123         return CldsUserJsonDecoder.decodeJson(refProp.getFileContent("files.cldsUsers"));
 124     }
 125
 126     /**
 127      * This methods returns the chosen encoder for password hashing.
 128      */
 129     private PasswordEncoder getPasswordEncoder() {
 130         if ("bcrypt".equals(cldsEncoderMethod)) {
 131             return new BCryptPasswordEncoder(cldsBcryptEncoderStrength);
 132         } else {
 133             throw new CldsConfigException("Invalid clamp.config.security.encoder value. 'bcrypt' is the only option at this time.");
 134         }
 135     }
 136 }