aboutsummaryrefslogtreecommitdiff
path: root/subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java
diff options
context:
space:
mode:
Diffstat (limited to 'subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java')
-rw-r--r--subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java246
1 files changed, 0 insertions, 246 deletions
diff --git a/subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java b/subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java
deleted file mode 100644
index add44643..00000000
--- a/subsonic-main/src/main/java/net/sourceforge/subsonic/security/RESTRequestParameterProcessingFilter.java
+++ /dev/null
@@ -1,246 +0,0 @@
-/*
- This file is part of Subsonic.
-
- Subsonic is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- Subsonic is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with Subsonic. If not, see <http://www.gnu.org/licenses/>.
-
- Copyright 2009 (C) Sindre Mehus
- */
-package net.sourceforge.subsonic.security;
-
-import net.sourceforge.subsonic.Logger;
-import net.sourceforge.subsonic.service.SettingsService;
-import net.sourceforge.subsonic.domain.Version;
-import net.sourceforge.subsonic.controller.RESTController;
-import net.sourceforge.subsonic.util.StringUtil;
-import net.sourceforge.subsonic.util.XMLBuilder;
-import org.acegisecurity.Authentication;
-import org.acegisecurity.AuthenticationException;
-import org.acegisecurity.context.SecurityContextHolder;
-import org.acegisecurity.providers.ProviderManager;
-import org.acegisecurity.providers.UsernamePasswordAuthenticationToken;
-import org.apache.commons.lang.StringUtils;
-import org.springframework.web.bind.ServletRequestUtils;
-
-import javax.servlet.Filter;
-import javax.servlet.FilterChain;
-import javax.servlet.FilterConfig;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import java.io.IOException;
-import java.util.Arrays;
-import java.util.Date;
-import java.util.List;
-
-/**
- * Performs authentication based on credentials being present in the HTTP request parameters. Also checks
- * API versions and license information.
- * <p/>
- * The username should be set in parameter "u", and the password should be set in parameter "p".
- * The REST protocol version should be set in parameter "v".
- *
- * The password can either be in plain text or be UTF-8 hexencoded preceded by "enc:".
- *
- * @author Sindre Mehus
- */
-public class RESTRequestParameterProcessingFilter implements Filter {
-
- private static final Logger LOG = Logger.getLogger(RESTRequestParameterProcessingFilter.class);
- private static final long TRIAL_DAYS = 35L;
-
- private ProviderManager authenticationManager;
- private SettingsService settingsService;
-
- /**
- * {@inheritDoc}
- */
- public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
- if (!(request instanceof HttpServletRequest)) {
- throw new ServletException("Can only process HttpServletRequest");
- }
- if (!(response instanceof HttpServletResponse)) {
- throw new ServletException("Can only process HttpServletResponse");
- }
-
- HttpServletRequest httpRequest = (HttpServletRequest) request;
- HttpServletResponse httpResponse = (HttpServletResponse) response;
-
- String username = StringUtils.trimToNull(httpRequest.getParameter("u"));
- String password = decrypt(StringUtils.trimToNull(httpRequest.getParameter("p")));
- String version = StringUtils.trimToNull(httpRequest.getParameter("v"));
- String client = StringUtils.trimToNull(httpRequest.getParameter("c"));
-
- RESTController.ErrorCode errorCode = null;
-
- // The username and password parameters are not required if the user
- // was previously authenticated, for example using Basic Auth.
- Authentication previousAuth = SecurityContextHolder.getContext().getAuthentication();
- boolean missingCredentials = previousAuth == null && (username == null || password == null);
- if (missingCredentials || version == null || client == null) {
- errorCode = RESTController.ErrorCode.MISSING_PARAMETER;
- }
-
- if (errorCode == null) {
- errorCode = checkAPIVersion(version);
- }
-
- if (errorCode == null) {
- errorCode = authenticate(username, password, previousAuth);
- }
-
- if (errorCode == null) {
- String restMethod = StringUtils.substringAfterLast(httpRequest.getRequestURI(), "/");
- errorCode = checkLicense(client, restMethod);
- }
-
- if (errorCode == null) {
- chain.doFilter(request, response);
- } else {
- SecurityContextHolder.getContext().setAuthentication(null);
- sendErrorXml(httpRequest, httpResponse, errorCode);
- }
- }
-
- private RESTController.ErrorCode checkAPIVersion(String version) {
- Version serverVersion = new Version(StringUtil.getRESTProtocolVersion());
- Version clientVersion = new Version(version);
-
- if (serverVersion.getMajor() > clientVersion.getMajor()) {
- return RESTController.ErrorCode.PROTOCOL_MISMATCH_CLIENT_TOO_OLD;
- } else if (serverVersion.getMajor() < clientVersion.getMajor()) {
- return RESTController.ErrorCode.PROTOCOL_MISMATCH_SERVER_TOO_OLD;
- } else if (serverVersion.getMinor() < clientVersion.getMinor()) {
- return RESTController.ErrorCode.PROTOCOL_MISMATCH_SERVER_TOO_OLD;
- }
- return null;
- }
-
- private RESTController.ErrorCode authenticate(String username, String password, Authentication previousAuth) {
-
- // Previously authenticated and username not overridden?
- if (username == null && previousAuth != null) {
- return null;
- }
-
- // Ensure password is given.
- if (password == null) {
- return RESTController.ErrorCode.MISSING_PARAMETER;
- }
-
- try {
- UsernamePasswordAuthenticationToken authRequest = new UsernamePasswordAuthenticationToken(username, password);
- Authentication authResult = authenticationManager.authenticate(authRequest);
- SecurityContextHolder.getContext().setAuthentication(authResult);
-// LOG.info("Authentication succeeded for user " + username);
- } catch (AuthenticationException x) {
- LOG.info("Authentication failed for user " + username);
- return RESTController.ErrorCode.NOT_AUTHENTICATED;
- }
- return null;
- }
-
- private RESTController.ErrorCode checkLicense(String client, String restMethod) {
- if (settingsService.isLicenseValid()) {
- return null;
- }
-
- if (settingsService.getRESTTrialExpires(client) == null) {
- Date expiryDate = new Date(System.currentTimeMillis() + TRIAL_DAYS * 24L * 3600L * 1000L);
- settingsService.setRESTTrialExpires(client, expiryDate);
- settingsService.save();
- LOG.info("REST access for client '" + client + "' will expire " + expiryDate);
- } else if (settingsService.getRESTTrialExpires(client).before(new Date())) {
-
- // Exception: iPhone clients are allowed to call any method except stream.view and download.view.
- List<String> iPhoneClients = Arrays.asList("iSub", "zsubsonic");
- List<String> restrictedMethods = Arrays.asList("stream.view", "download.view");
- if (iPhoneClients.contains(client) && !restrictedMethods.contains(restMethod)) {
- return null;
- }
-
- LOG.info("REST access for client '" + client + "' has expired.");
- return RESTController.ErrorCode.NOT_LICENSED;
- }
-
- return null;
- }
-
- public static String decrypt(String s) {
- if (s == null) {
- return null;
- }
- if (!s.startsWith("enc:")) {
- return s;
- }
- try {
- return StringUtil.utf8HexDecode(s.substring(4));
- } catch (Exception e) {
- return s;
- }
- }
-
- private void sendErrorXml(HttpServletRequest request, HttpServletResponse response, RESTController.ErrorCode errorCode) throws IOException {
- String format = ServletRequestUtils.getStringParameter(request, "f", "xml");
- boolean json = "json".equals(format);
- boolean jsonp = "jsonp".equals(format);
- XMLBuilder builder;
-
- response.setCharacterEncoding(StringUtil.ENCODING_UTF8);
-
- if (json) {
- builder = XMLBuilder.createJSONBuilder();
- response.setContentType("application/json");
- } else if (jsonp) {
- builder = XMLBuilder.createJSONPBuilder(request.getParameter("callback"));
- response.setContentType("text/javascript");
- } else {
- builder = XMLBuilder.createXMLBuilder();
- response.setContentType("text/xml");
- }
-
- builder.preamble(StringUtil.ENCODING_UTF8);
- builder.add("subsonic-response", false,
- new XMLBuilder.Attribute("xmlns", "http://subsonic.org/restapi"),
- new XMLBuilder.Attribute("status", "failed"),
- new XMLBuilder.Attribute("version", StringUtil.getRESTProtocolVersion()));
-
- builder.add("error", true,
- new XMLBuilder.Attribute("code", errorCode.getCode()),
- new XMLBuilder.Attribute("message", errorCode.getMessage()));
- builder.end();
- response.getWriter().print(builder);
- }
-
- /**
- * {@inheritDoc}
- */
- public void init(FilterConfig filterConfig) throws ServletException {
- }
-
- /**
- * {@inheritDoc}
- */
- public void destroy() {
- }
-
- public void setAuthenticationManager(ProviderManager authenticationManager) {
- this.authenticationManager = authenticationManager;
- }
-
- public void setSettingsService(SettingsService settingsService) {
- this.settingsService = settingsService;
- }
-}
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-18 13:08:11 +0000