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.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.A1MediatorController;
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;
56 @EnableGlobalMethodSecurity(securedEnabled = true)
58 public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
60 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
62 // Although constructor arguments are recommended over field injection,
63 // this results in fewer lines of code.
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;
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.headers().frameOptions().disable();
82 http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse());
83 http.addFilterBefore(portalAuthenticationFilterBean(), BasicAuthenticationFilter.class);
87 * Resource paths that do not require authentication, especially including
88 * Swagger-generated documentation.
90 public static final String[] OPEN_PATHS = { //
92 "/swagger-resources/**", //
93 "/swagger-ui.html", //
95 PortalApiConstants.API_PREFIX + "/**", //
96 A1MediatorController.CONTROLLER_PATH + "/" + A1MediatorController.VERSION_METHOD, //
97 AdminController.CONTROLLER_PATH + "/" + AdminController.HEALTH_METHOD, //
98 AdminController.CONTROLLER_PATH + "/" + AdminController.VERSION_METHOD, //
99 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_ALIVE_METHOD, //
100 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.HEALTH_READY_METHOD, //
101 AnrXappController.CONTROLLER_PATH + "/" + AnrXappController.VERSION_METHOD, //
102 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_ALIVE_METHOD, //
103 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.HEALTH_READY_METHOD, //
104 AppManagerController.CONTROLLER_PATH + "/" + AppManagerController.VERSION_METHOD, //
105 E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.HEALTH_METHOD, //
106 E2ManagerController.CONTROLLER_PATH + "/" + E2ManagerController.VERSION_METHOD, //
107 SimpleErrorController.ERROR_PATH, //
108 DashboardConstants.LOGIN_PAGE //
112 public void configure(WebSecurity web) throws Exception {
113 // This disables Spring security, but not the app's filter.
114 web.ignoring().antMatchers(OPEN_PATHS);
118 public PortalAuthManager portalAuthManagerBean()
119 throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException,
120 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
121 return new PortalAuthManager(appName, userName, password, decryptor, userCookie);
125 public DashboardUserManager dashboardUserManagerBean() throws IOException {
126 return new DashboardUserManager(userFilePath);
130 * If this is annotated with @Bean, it is created automatically AND REGISTERED,
131 * and Spring processes annotations in the source of the class. However, the
132 * filter is added in the chain apparently in the wrong order. Alternately, with
133 * no @Bean and added to the chain up in the configure() method in the desired
134 * order, the ignoring() matcher pattern configured above causes Spring to
135 * bypass this filter, which seems to me means the filter participates
138 public PortalAuthenticationFilter portalAuthenticationFilterBean()
139 throws ClassNotFoundException, InstantiationException, IllegalAccessException, IOException,
140 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
141 PortalAuthenticationFilter portalAuthenticationFilter = new PortalAuthenticationFilter(portalAuthManagerBean(),
142 dashboardUserManagerBean());
143 return portalAuthenticationFilter;
147 * Instantiates the EPSDK-FW servlet. Needed because this app is not configured
148 * to scan the EPSDK-FW packages; there's also a chance that Spring-Boot does
149 * not automatically process @WebServlet annotations.
151 * @return Servlet registration bean for the Portal Rest API proxy servlet.
154 public ServletRegistrationBean<PortalRestAPIProxy> portalApiProxyServletBean() {
155 PortalRestAPIProxy servlet = new PortalRestAPIProxy();
156 final ServletRegistrationBean<PortalRestAPIProxy> servletBean = new ServletRegistrationBean<>(servlet,
157 PortalApiConstants.API_PREFIX + "/*");
158 servletBean.setName("PortalRestApiProxyServlet");
163 * Instantiates a trivial login servlet that serves a basic page with a link to
164 * authenticate at Portal. The login filter redirects to this page instead of
167 * @return Servlet registration bean for the Dashboard login servlet.
170 public ServletRegistrationBean<LoginServlet> loginServletBean() {
171 LoginServlet servlet = new LoginServlet();
172 final ServletRegistrationBean<LoginServlet> servletBean = new ServletRegistrationBean<>(servlet,
173 DashboardConstants.LOGIN_PAGE);
174 servletBean.setName("LoginServlet");