From 5dbac644e5eb044fe4844e64827cbb0606a89785 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Thu, 1 Feb 2018 19:48:12 -0800 Subject: [PATCH] GUACAMOLE-493: Remove guacamole-auth-noauth, deprecated since 0.9.13-incubating. --- extensions/guacamole-auth-noauth/.gitignore | 2 - .../doc/example/noauth-config.xml | 25 --- extensions/guacamole-auth-noauth/pom.xml | 139 ------------ .../src/licenses/LICENSE | 203 ----------------- .../guacamole-auth-noauth/src/licenses/NOTICE | 5 - .../src/main/assembly/dist.xml | 58 ----- .../noauth/NoAuthConfigContentHandler.java | 117 ---------- .../auth/noauth/NoAuthenticationProvider.java | 206 ------------------ .../src/main/resources/guac-manifest.json | 16 -- .../src/main/resources/translations/en.json | 7 - pom.xml | 1 - 11 files changed, 779 deletions(-) delete mode 100644 extensions/guacamole-auth-noauth/.gitignore delete mode 100644 extensions/guacamole-auth-noauth/doc/example/noauth-config.xml delete mode 100644 extensions/guacamole-auth-noauth/pom.xml delete mode 100644 extensions/guacamole-auth-noauth/src/licenses/LICENSE delete mode 100644 extensions/guacamole-auth-noauth/src/licenses/NOTICE delete mode 100644 extensions/guacamole-auth-noauth/src/main/assembly/dist.xml delete mode 100644 extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthConfigContentHandler.java delete mode 100644 extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthenticationProvider.java delete mode 100644 extensions/guacamole-auth-noauth/src/main/resources/guac-manifest.json delete mode 100644 extensions/guacamole-auth-noauth/src/main/resources/translations/en.json diff --git a/extensions/guacamole-auth-noauth/.gitignore b/extensions/guacamole-auth-noauth/.gitignore deleted file mode 100644 index 42f4a1a64..000000000 --- a/extensions/guacamole-auth-noauth/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -target/ -*~ diff --git a/extensions/guacamole-auth-noauth/doc/example/noauth-config.xml b/extensions/guacamole-auth-noauth/doc/example/noauth-config.xml deleted file mode 100644 index 0063f7085..000000000 --- a/extensions/guacamole-auth-noauth/doc/example/noauth-config.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - diff --git a/extensions/guacamole-auth-noauth/pom.xml b/extensions/guacamole-auth-noauth/pom.xml deleted file mode 100644 index c211b8112..000000000 --- a/extensions/guacamole-auth-noauth/pom.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - 4.0.0 - org.apache.guacamole - guacamole-auth-noauth - jar - 0.9.14 - guacamole-auth-noauth - http://guacamole.apache.org/ - - - UTF-8 - - - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.3 - - 1.6 - 1.6 - - -Xlint:all - -Werror - - true - - - - - - org.apache.maven.plugins - maven-dependency-plugin - 2.10 - - - unpack-dependencies - prepare-package - - unpack-dependencies - - - runtime - ${project.build.directory}/classes - - - - - - - - maven-assembly-plugin - 2.5.3 - - ${project.artifactId}-${project.version} - false - - src/main/assembly/dist.xml - - - - - make-dist-archive - package - - single - - - - - - - - org.apache.rat - apache-rat-plugin - 0.12 - - - - **/*.json - src/licenses/**/* - - - - - - - validate - validate - - check - - - - - - - - - - - - - - org.apache.guacamole - guacamole-ext - 0.9.14 - provided - - - - - diff --git a/extensions/guacamole-auth-noauth/src/licenses/LICENSE b/extensions/guacamole-auth-noauth/src/licenses/LICENSE deleted file mode 100644 index 6b0b1270f..000000000 --- a/extensions/guacamole-auth-noauth/src/licenses/LICENSE +++ /dev/null @@ -1,203 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - diff --git a/extensions/guacamole-auth-noauth/src/licenses/NOTICE b/extensions/guacamole-auth-noauth/src/licenses/NOTICE deleted file mode 100644 index 47f2b4c24..000000000 --- a/extensions/guacamole-auth-noauth/src/licenses/NOTICE +++ /dev/null @@ -1,5 +0,0 @@ -Apache Guacamole -Copyright 2017 The Apache Software Foundation - -This product includes software developed at -The Apache Software Foundation (http://www.apache.org/). diff --git a/extensions/guacamole-auth-noauth/src/main/assembly/dist.xml b/extensions/guacamole-auth-noauth/src/main/assembly/dist.xml deleted file mode 100644 index 9f2293a5c..000000000 --- a/extensions/guacamole-auth-noauth/src/main/assembly/dist.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - dist - ${project.artifactId}-${project.version} - - - - tar.gz - - - - - - - - doc - - - - - - src/licenses - - - - - target - - - *.jar - - - - - - diff --git a/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthConfigContentHandler.java b/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthConfigContentHandler.java deleted file mode 100644 index abf823f34..000000000 --- a/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthConfigContentHandler.java +++ /dev/null @@ -1,117 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -package org.apache.guacamole.auth.noauth; - -import java.util.Collections; -import java.util.HashMap; -import java.util.Map; -import org.apache.guacamole.protocol.GuacamoleConfiguration; -import org.xml.sax.Attributes; -import org.xml.sax.SAXException; -import org.xml.sax.helpers.DefaultHandler; - -/** - * XML parser for the configuration file used by the NoAuth auth provider. - */ -public class NoAuthConfigContentHandler extends DefaultHandler { - - /** - * Map of all configurations, indexed by name. - */ - private Map configs = new HashMap(); - - /** - * The name of the current configuration, if any. - */ - private String current = null; - - /** - * The current configuration being parsed, if any. - */ - private GuacamoleConfiguration currentConfig = null; - - /** - * Returns the a map of all available configurations as parsed from the - * XML file. This map is unmodifiable. - * - * @return A map of all available configurations. - */ - public Map getConfigs() { - return Collections.unmodifiableMap(configs); - } - - @Override - public void endElement(String uri, String localName, String qName) throws SAXException { - - // If end of config element, add to map - if (localName.equals("config")) { - - // Add to map - configs.put(current, currentConfig); - - // Reset state for next configuration - currentConfig = null; - current = null; - - } - - } - - @Override - public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { - - // Begin configuration parsing if config element - if (localName.equals("config")) { - - // Ensure this config is on the top level - if (current != null) - throw new SAXException("Configurations cannot be nested."); - - // Read name - String name = attributes.getValue("name"); - if (name == null) - throw new SAXException("Each configuration must have a name."); - - // Read protocol - String protocol = attributes.getValue("protocol"); - if (protocol == null) - throw new SAXException("Each configuration must have a protocol."); - - // Create config stub - current = name; - currentConfig = new GuacamoleConfiguration(); - currentConfig.setProtocol(protocol); - - } - - // Add parameters to existing configuration - else if (localName.equals("param")) { - - // Ensure a corresponding config exists - if (currentConfig == null) - throw new SAXException("Parameter without corresponding configuration."); - - currentConfig.setParameter(attributes.getValue("name"), attributes.getValue("value")); - - } - - } - -} diff --git a/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthenticationProvider.java b/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthenticationProvider.java deleted file mode 100644 index bf665b512..000000000 --- a/extensions/guacamole-auth-noauth/src/main/java/org/apache/guacamole/auth/noauth/NoAuthenticationProvider.java +++ /dev/null @@ -1,206 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -package org.apache.guacamole.auth.noauth; - -import java.util.Map; -import java.io.BufferedReader; -import java.io.File; -import java.io.FileReader; -import java.io.IOException; -import java.io.Reader; -import org.apache.guacamole.GuacamoleException; -import org.apache.guacamole.GuacamoleServerException; -import org.apache.guacamole.environment.Environment; -import org.apache.guacamole.environment.LocalEnvironment; -import org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider; -import org.apache.guacamole.net.auth.Credentials; -import org.apache.guacamole.properties.FileGuacamoleProperty; -import org.apache.guacamole.protocol.GuacamoleConfiguration; -import org.slf4j.LoggerFactory; -import org.slf4j.Logger; -import org.xml.sax.InputSource; -import org.xml.sax.SAXException; -import org.xml.sax.XMLReader; -import org.xml.sax.helpers.XMLReaderFactory; - -/** - * Disable authentication in Guacamole. All users accessing Guacamole are - * automatically authenticated as "Anonymous" user and are able to use all - * available GuacamoleConfigurations. - * - * GuacamoleConfiguration are read from the XML file defined by `noauth-config` - * in the Guacamole configuration file (`guacamole.properties`). - * - * - * Example `guacamole.properties`: - * - * noauth-config: /etc/guacamole/noauth-config.xml - * - * - * Example `noauth-config.xml`: - * - * - * - * - * - * - * - */ -@Deprecated -public class NoAuthenticationProvider extends SimpleAuthenticationProvider { - - /** - * Logger for this class. - */ - private Logger logger = LoggerFactory.getLogger(NoAuthenticationProvider.class); - - /** - * Map of all known configurations, indexed by identifier. - */ - private Map configs; - - /** - * The last time the configuration XML was modified, as milliseconds since - * UNIX epoch. - */ - private long configTime; - - /** - * Guacamole server environment. - */ - private final Environment environment; - - /** - * The XML file to read the configuration from. - */ - public static final FileGuacamoleProperty NOAUTH_CONFIG = new FileGuacamoleProperty() { - - @Override - public String getName() { - return "noauth-config"; - } - - }; - - /** - * The default filename to use for the configuration, if not defined within - * guacamole.properties. - */ - public static final String DEFAULT_NOAUTH_CONFIG = "noauth-config.xml"; - - /** - * Creates a new NoAuthenticationProvider that does not perform any - * authentication at all. All attempts to access the Guacamole system are - * presumed to be authorized. - * - * @throws GuacamoleException - * If a required property is missing, or an error occurs while parsing - * a property. - */ - public NoAuthenticationProvider() throws GuacamoleException { - environment = new LocalEnvironment(); - logger.warn("The \"NoAuth\" extension is **DEPRECATED**! This " - + "extension will be removed from the Guacamole codebase " - + "entirely in a future release. Please consider writing an " - + "extension using Guacamole's extension API instead."); - } - - @Override - public String getIdentifier() { - return "noauth"; - } - - /** - * Retrieves the configuration file, as defined within guacamole.properties. - * - * @return The configuration file, as defined within guacamole.properties. - * @throws GuacamoleException If an error occurs while reading the - * property. - */ - private File getConfigurationFile() throws GuacamoleException { - - // Get config file, defaulting to GUACAMOLE_HOME/noauth-config.xml - File configFile = environment.getProperty(NOAUTH_CONFIG); - if (configFile == null) - configFile = new File(environment.getGuacamoleHome(), DEFAULT_NOAUTH_CONFIG); - - return configFile; - - } - - public synchronized void init() throws GuacamoleException { - - // Get configuration file - File configFile = getConfigurationFile(); - logger.debug("Reading configuration file: \"{}\"", configFile); - - // Parse document - try { - - // Set up parser - NoAuthConfigContentHandler contentHandler = new NoAuthConfigContentHandler(); - - XMLReader parser = XMLReaderFactory.createXMLReader(); - parser.setContentHandler(contentHandler); - - // Read and parse file - Reader reader = new BufferedReader(new FileReader(configFile)); - parser.parse(new InputSource(reader)); - reader.close(); - - // Init configs - configTime = configFile.lastModified(); - configs = contentHandler.getConfigs(); - - } - catch (IOException e) { - throw new GuacamoleServerException("Error reading configuration file.", e); - } - catch (SAXException e) { - throw new GuacamoleServerException("Error parsing XML file.", e); - } - - } - - @Override - public Map getAuthorizedConfigurations(Credentials credentials) throws GuacamoleException { - - // Check mapping file mod time - File configFile = getConfigurationFile(); - if (configFile.exists() && configTime < configFile.lastModified()) { - - // If modified recently, gain exclusive access and recheck - synchronized (this) { - if (configFile.exists() && configTime < configFile.lastModified()) { - logger.debug("Configuration file \"{}\" has been modified.", configFile); - init(); // If still not up to date, re-init - } - } - - } - - // If no mapping available, report as such - if (configs == null) - throw new GuacamoleServerException("Configuration could not be read."); - - return configs; - - } -} diff --git a/extensions/guacamole-auth-noauth/src/main/resources/guac-manifest.json b/extensions/guacamole-auth-noauth/src/main/resources/guac-manifest.json deleted file mode 100644 index e99386494..000000000 --- a/extensions/guacamole-auth-noauth/src/main/resources/guac-manifest.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - - "guacamoleVersion" : "0.9.14", - - "name" : "Disabled Authentication (DEPRECATED)", - "namespace" : "guac-noauth", - - "authProviders" : [ - "org.apache.guacamole.auth.noauth.NoAuthenticationProvider" - ], - - "translations" : [ - "translations/en.json" - ] - -} diff --git a/extensions/guacamole-auth-noauth/src/main/resources/translations/en.json b/extensions/guacamole-auth-noauth/src/main/resources/translations/en.json deleted file mode 100644 index f755bd7b9..000000000 --- a/extensions/guacamole-auth-noauth/src/main/resources/translations/en.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - - "DATA_SOURCE_NOAUTH" : { - "NAME" : "NoAuth" - } - -} diff --git a/pom.xml b/pom.xml index 0144d5ac0..59cff02e2 100644 --- a/pom.xml +++ b/pom.xml @@ -54,7 +54,6 @@ extensions/guacamole-auth-header extensions/guacamole-auth-jdbc extensions/guacamole-auth-ldap - extensions/guacamole-auth-noauth extensions/guacamole-auth-openid