webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/WebSecurityConfiguration.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   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  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20 package org.oransc.ric.portal.dashboard.config;
  21
  22 import java.lang.invoke.MethodHandles;
  23 import java.lang.reflect.InvocationTargetException;
  24
  25 import org.onap.portalsdk.core.onboarding.util.PortalApiConstants;
  26 import org.oransc.ric.portal.dashboard.DashboardConstants;
  27 import org.oransc.ric.portal.dashboard.DashboardUserManager;
  28 import org.oransc.ric.portal.dashboard.controller.A1MediatorController;
  29 import org.oransc.ric.portal.dashboard.controller.AdminController;
  30 import org.oransc.ric.portal.dashboard.controller.AppManagerController;
  31 import org.oransc.ric.portal.dashboard.controller.E2ManagerController;
  32 import org.oransc.ric.portal.dashboard.controller.SimpleErrorController;
  33 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthManager;
  34 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthenticationFilter;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.springframework.beans.factory.annotation.Autowired;
  38 import org.springframework.beans.factory.annotation.Value;
  39 import org.springframework.context.annotation.Bean;
  40 import org.springframework.context.annotation.Configuration;
  41 import org.springframework.context.annotation.Profile;
  42 import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
  43 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  44 import org.springframework.security.config.annotation.web.builders.WebSecurity;
  45 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  46 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  47 import org.springframework.security.web.authentication.www.BasicAuthenticationFilter;
  48 import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
  49
  50 @Configuration
  51 @EnableWebSecurity
  52 @EnableGlobalMethodSecurity(securedEnabled = true)
  53 @Profile("!test")
  54 public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
  55
  56         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  57
  58         // Although constructor arguments are recommended over field injection,
  59         // this results in fewer lines of code.
  60         @Value("${portalapi.security}")
  61         private Boolean portalapiSecurity;
  62         @Value("${portalapi.appname}")
  63         private String appName;
  64         @Value("${portalapi.username}")
  65         private String userName;
  66         @Value("${portalapi.password}")
  67         private String password;
  68         @Value("${portalapi.decryptor}")
  69         private String decryptor;
  70         @Value("${portalapi.usercookie}")
  71         private String userCookie;
  72
  73         @Autowired
  74         DashboardUserManager userManager;
  75
  76         @Override
  77         protected void configure(HttpSecurity http) throws Exception {
  78                 logger.debug("configure: portalapi.appName {}", appName);
  79                 // A chain of ".and()" always baffles me
  80                 http.authorizeRequests().anyRequest().authenticated();
  81                 http.headers().frameOptions().disable();
  82                 http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse());
  83                 http.addFilterBefore(portalAuthenticationFilterBean(), BasicAuthenticationFilter.class);
  84         }
  85
  86         /**
  87          * Resource paths that do not require authentication, including
  88          * Swagger-generated documentation.
  89          */
  90         protected static final String[] OPEN_PATHS = { //
  91                         "/v2/api-docs", //
  92                         "/swagger-resources/**", //
  93                         "/swagger-ui.html", //
  94                         "/webjars/**", //
  95                         PortalApiConstants.API_PREFIX + "/**", //
  96                         A1MediatorController.CONTROLLER_PATH + "/" + DashboardConstants.VERSION_METHOD, //
  97                         AdminController.CONTROLLER_PATH + "/" + AdminController.HEALTH_METHOD, //
  98                         AdminController.CONTROLLER_PATH + "/" + AdminController.VERSION_METHOD, //
  99                         AppManagerController.CONTROLLER_PATH + "/" + DashboardConstants.RIC_INSTANCE_KEY + "/*/"
 100                                         + AppManagerController.HEALTH_ALIVE_METHOD, //
 101                         AppManagerController.CONTROLLER_PATH + "/" + DashboardConstants.RIC_INSTANCE_KEY + "/*/"
 102                                         + AppManagerController.HEALTH_READY_METHOD, //
 103                         AppManagerController.CONTROLLER_PATH + "/" + DashboardConstants.VERSION_METHOD, //
 104                         E2ManagerController.CONTROLLER_PATH + "/" + DashboardConstants.RIC_INSTANCE_KEY + "/*/"
 105                                         + E2ManagerController.HEALTH_METHOD, //
 106                         E2ManagerController.CONTROLLER_PATH + "/" + DashboardConstants.VERSION_METHOD, //
 107                         SimpleErrorController.ERROR_PATH };
 108
 109         @Override
 110         public void configure(WebSecurity web) throws Exception {
 111                 // This disables Spring security, but not the app's filter.
 112                 web.ignoring().antMatchers(OPEN_PATHS);
 113         }
 114
 115         @Bean
 116         public PortalAuthManager portalAuthManagerBean() throws ClassNotFoundException, IllegalAccessException,
 117                         InstantiationException, InvocationTargetException, NoSuchMethodException {
 118                 logger.debug("portalAuthManagerBean");
 119                 return new PortalAuthManager(appName, userName, password, decryptor, userCookie);
 120         }
 121
 122         /*
 123          * If this is annotated with @Bean, it is created automatically AND REGISTERED,
 124          * and Spring processes annotations in the source of the class. However, the
 125          * filter is added in the chain apparently in the wrong order. Alternately, with
 126          * no @Bean and added to the chain up in the configure() method in the desired
 127          * order, the ignoring() matcher pattern configured above causes Spring to
 128          * bypass this filter, which seems to me means the filter participates
 129          * correctly.
 130          */
 131         public PortalAuthenticationFilter portalAuthenticationFilterBean() throws ClassNotFoundException,
 132                         IllegalAccessException, InstantiationException, InvocationTargetException, NoSuchMethodException {
 133                 logger.debug("portalAuthenticationFilterBean");
 134                 return new PortalAuthenticationFilter(portalapiSecurity, portalAuthManagerBean(), this.userManager);
 135         }
 136
 137 }