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 and Nokia
   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.io.IOException;
  23 import java.lang.invoke.MethodHandles;
  24 import java.lang.reflect.InvocationTargetException;
  25
  26 import org.onap.portalsdk.core.onboarding.crossapi.PortalRestAPIProxy;
  27 import org.onap.portalsdk.core.onboarding.util.PortalApiConstants;
  28 import org.oransc.ric.portal.dashboard.DashboardConstants;
  29 import org.oransc.ric.portal.dashboard.LoginServlet;
  30 import org.oransc.ric.portal.dashboard.controller.AcXappController;
  31 import org.oransc.ric.portal.dashboard.controller.AdminController;
  32 import org.oransc.ric.portal.dashboard.controller.AnrXappController;
  33 import org.oransc.ric.portal.dashboard.controller.AppManagerController;
  34 import org.oransc.ric.portal.dashboard.controller.E2ManagerController;
  35 import org.oransc.ric.portal.dashboard.controller.SimpleErrorController;
  36 import org.oransc.ric.portal.dashboard.portalapi.DashboardUserManager;
  37 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthManager;
  38 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthenticationFilter;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import org.springframework.beans.factory.annotation.Value;
  42 import org.springframework.boot.web.servlet.ServletRegistrationBean;
  43 import org.springframework.context.annotation.Bean;
  44 import org.springframework.context.annotation.Configuration;
  45 import org.springframework.context.annotation.Profile;
  46 import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
  47 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  48 import org.springframework.security.config.annotation.web.builders.WebSecurity;
  49 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  50 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  51 import org.springframework.security.web.authentication.www.BasicAuthenticationFilter;
  52 import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
  53
  54 @Configuration
  55 @EnableWebSecurity
  56 @EnableGlobalMethodSecurity(securedEnabled = true)
  57 @Profile("!test")
  58 public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
  59
  60         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  61
  62         // Although constructor arguments are recommended over field injection,
  63         // this results in fewer lines of code.
  64         @Value("${userfile}")
  65         private String userFilePath;
  66         @Value("${portalapi.appname}")
  67         private String appName;
  68         @Value("${portalapi.username}")
  69         private String userName;
  70         @Value("${portalapi.password}")
  71         private String password;
  72         @Value("${portalapi.decryptor}")
  73         private String decryptor;
  74         @Value("${portalapi.usercookie}")
  75         private String userCookie;
  76
  77         protected void configure(HttpSecurity http) throws Exception {
  78                 logger.debug("configure: portalapi.username {}", userName);
  79                 // A chain of ".and()" always baffles me
  80                 http.authorizeRequests().anyRequest().authenticated();
  81                 http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse());
  82                 http.addFilterBefore(portalAuthenticationFilterBean(), BasicAuthenticationFilter.class);
  83         }
  84
  85         /**
  86          * Resource paths that do not require authentication, especially including
  87          * Swagger-generated documentation.
  88          */
  89         public static final String[] OPEN_PATHS = { //
  90                         "/v2/api-docs", //
  91                         "/swagger-resources/**", //
  92                         "/swagger-ui.html", //
  93                         "/webjars/**", //
  94                         PortalApiConstants.API_PREFIX + "/**", //
  95                         AcXappController.CONTROLLER_PATH + "/" + AcXappController.VERSION_METHOD, //
  96                         AdminController.CONTROLLER_PATH + "/" + AdminController.HEALTH_METHOD, //
  97                         AdminController.CONTROLLER_PATH + "/" + AdminController.VERSION_METHOD, //
  98                         AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_ALIVE_METHOD, //
  99                         AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_READY_METHOD, //
 100                         AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.VERSION_METHOD, //
 101                         AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_ALIVE_METHOD, //
 102                         AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_READY_METHOD, //
 103                         AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.VERSION_METHOD, //
 104                         E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.HEALTH_METHOD, //
 105                         E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.VERSION_METHOD, //
 106                         SimpleErrorController.ERROR_PATH, //
 107                         DashboardConstants.LOGIN_PAGE //
 108         };
 109
 110         @Override
 111         public void configure(WebSecurity web) throws Exception {
 112                 // This disables Spring security, but not the app's filter.
 113                 web.ignoring().antMatchers(OPEN_PATHS);
 114         }
 115
 116         @Bean
 117         public PortalAuthManager portalAuthManagerBean()
 118                         throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException,
 119                         IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
 120                 return new PortalAuthManager(appName, userName, password, decryptor, userCookie);
 121         }
 122
 123         @Bean
 124         public DashboardUserManager dashboardUserManagerBean() throws IOException {
 125                 return new DashboardUserManager(userFilePath);
 126         }
 127
 128         /*
 129          * If this is annotated with @Bean, it is created automatically AND REGISTERED,
 130          * and Spring processes annotations in the source of the class. However, the
 131          * filter is added in the chain apparently in the wrong order. Alternately, with
 132          * no @Bean and added to the chain up in the configure() method in the desired
 133          * order, the ignoring() matcher pattern configured above causes Spring to
 134          * bypass this filter, which seems to me means the filter participates
 135          * correctly.
 136          */
 137         public PortalAuthenticationFilter portalAuthenticationFilterBean()
 138                         throws ClassNotFoundException, InstantiationException, IllegalAccessException, IOException,
 139                         IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
 140                 PortalAuthenticationFilter portalAuthenticationFilter = new PortalAuthenticationFilter(portalAuthManagerBean(),
 141                                 dashboardUserManagerBean());
 142                 return portalAuthenticationFilter;
 143         }
 144
 145         /**
 146          * Instantiates the EPSDK-FW servlet. Needed because this app is not configured
 147          * to scan the EPSDK-FW packages; there's also a chance that Spring-Boot does
 148          * not automatically process @WebServlet annotations.
 149          *
 150          * @return Servlet registration bean for the Portal Rest API proxy servlet.
 151          */
 152         @Bean
 153         public ServletRegistrationBean<PortalRestAPIProxy> portalApiProxyServletBean() {
 154                 PortalRestAPIProxy servlet = new PortalRestAPIProxy();
 155                 final ServletRegistrationBean<PortalRestAPIProxy> servletBean = new ServletRegistrationBean<>(servlet,
 156                                 PortalApiConstants.API_PREFIX + "/*");
 157                 servletBean.setName("PortalRestApiProxyServlet");
 158                 return servletBean;
 159         }
 160
 161         /**
 162          * Instantiates a trivial login servlet that serves a basic page with a link to
 163          * authenticate at Portal. The login filter redirects to this page instead of
 164          * Portal.
 165          *
 166          * @return Servlet registration bean for the Dashboard login servlet.
 167          */
 168         @Bean
 169         public ServletRegistrationBean<LoginServlet> loginServletBean() {
 170                 LoginServlet servlet = new LoginServlet();
 171                 final ServletRegistrationBean<LoginServlet> servletBean = new ServletRegistrationBean<>(servlet,
 172                                 DashboardConstants.LOGIN_PAGE);
 173                 servletBean.setName("LoginServlet");
 174                 return servletBean;
 175         }
 176
 177 }