2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 package org.oransc.ric.portal.dashboard.config;
22 import java.io.IOException;
23 import java.lang.invoke.MethodHandles;
24 import java.lang.reflect.InvocationTargetException;
26 import org.onap.portalsdk.core.onboarding.util.PortalApiConstants;
27 import org.oransc.ric.portal.dashboard.DashboardConstants;
28 import org.oransc.ric.portal.dashboard.LoginServlet;
29 import org.oransc.ric.portal.dashboard.controller.A1MediatorController;
30 import org.oransc.ric.portal.dashboard.controller.AdminController;
31 import org.oransc.ric.portal.dashboard.controller.AnrXappController;
32 import org.oransc.ric.portal.dashboard.controller.AppManagerController;
33 import org.oransc.ric.portal.dashboard.controller.E2ManagerController;
34 import org.oransc.ric.portal.dashboard.controller.SimpleErrorController;
35 import org.oransc.ric.portal.dashboard.portalapi.DashboardUserManager;
36 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthManager;
37 import org.oransc.ric.portal.dashboard.portalapi.PortalAuthenticationFilter;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40 import org.springframework.beans.factory.annotation.Value;
41 import org.springframework.boot.web.servlet.ServletRegistrationBean;
42 import org.springframework.context.annotation.Bean;
43 import org.springframework.context.annotation.Configuration;
44 import org.springframework.context.annotation.Profile;
45 import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
46 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
47 import org.springframework.security.config.annotation.web.builders.WebSecurity;
48 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
49 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
50 import org.springframework.security.web.authentication.www.BasicAuthenticationFilter;
51 import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
55 @EnableGlobalMethodSecurity(securedEnabled = true)
57 public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
59 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
61 // Although constructor arguments are recommended over field injection,
62 // this results in fewer lines of code.
63 @Value("${portalapi.security}")
64 private Boolean portalapiSecurity;
65 @Value("${portalapi.appname}")
66 private String appName;
67 @Value("${portalapi.username}")
68 private String userName;
69 @Value("${portalapi.password}")
70 private String password;
71 @Value("${portalapi.decryptor}")
72 private String decryptor;
73 @Value("${portalapi.usercookie}")
74 private String userCookie;
76 private String userFilePath;
78 protected void configure(HttpSecurity http) throws Exception {
79 logger.debug("configure: portalapi.username {}", userName);
80 // A chain of ".and()" always baffles me
81 http.authorizeRequests().anyRequest().authenticated();
82 http.headers().frameOptions().disable();
83 http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse());
84 http.addFilterBefore(portalAuthenticationFilterBean(), BasicAuthenticationFilter.class);
88 * Resource paths that do not require authentication, especially including
89 * Swagger-generated documentation.
91 public static final String[] OPEN_PATHS = { //
93 "/swagger-resources/**", //
94 "/swagger-ui.html", //
96 PortalApiConstants.API_PREFIX + "/**", //
97 A1MediatorController.CONTROLLER_PATH + "/" + A1MediatorController.VERSION_METHOD, //
98 AdminController.CONTROLLER_PATH + "/" + AdminController.HEALTH_METHOD, //
99 AdminController.CONTROLLER_PATH + "/" + AdminController.VERSION_METHOD, //
100 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_ALIVE_METHOD, //
101 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_READY_METHOD, //
102 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.VERSION_METHOD, //
103 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_ALIVE_METHOD, //
104 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_READY_METHOD, //
105 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.VERSION_METHOD, //
106 E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.HEALTH_METHOD, //
107 E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.VERSION_METHOD, //
108 SimpleErrorController.ERROR_PATH, //
109 DashboardConstants.LOGIN_PAGE //
113 public void configure(WebSecurity web) throws Exception {
114 // This disables Spring security, but not the app's filter.
115 web.ignoring().antMatchers(OPEN_PATHS);
119 public PortalAuthManager portalAuthManagerBean()
120 throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException,
121 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
122 return new PortalAuthManager(appName, userName, password, decryptor, userCookie);
126 public DashboardUserManager dashboardUserManagerBean() throws IOException {
127 return new DashboardUserManager(userFilePath);
131 * If this is annotated with @Bean, it is created automatically AND REGISTERED,
132 * and Spring processes annotations in the source of the class. However, the
133 * filter is added in the chain apparently in the wrong order. Alternately, with
134 * no @Bean and added to the chain up in the configure() method in the desired
135 * order, the ignoring() matcher pattern configured above causes Spring to
136 * bypass this filter, which seems to me means the filter participates
139 public PortalAuthenticationFilter portalAuthenticationFilterBean()
140 throws ClassNotFoundException, InstantiationException, IllegalAccessException, IOException,
141 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
142 PortalAuthenticationFilter portalAuthenticationFilter = new PortalAuthenticationFilter(portalapiSecurity,
143 portalAuthManagerBean(), dashboardUserManagerBean());
144 return portalAuthenticationFilter;
148 * Instantiates a trivial login servlet that serves a basic page with a link to
149 * authenticate at Portal. The login filter redirects to this page instead of
152 * @return Servlet registration bean for the Dashboard login servlet.
155 public ServletRegistrationBean<LoginServlet> loginServletBean() {
156 LoginServlet servlet = new LoginServlet();
157 final ServletRegistrationBean<LoginServlet> servletBean = new ServletRegistrationBean<>(servlet,
158 DashboardConstants.LOGIN_PAGE);
159 servletBean.setName("LoginServlet");