diff --git a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/AuthenticationProviderService.java b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/AuthenticationProviderService.java index 63999d8a9..ceab17479 100644 --- a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/AuthenticationProviderService.java +++ b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/AuthenticationProviderService.java @@ -22,9 +22,7 @@ package org.apache.guacamole.auth.cas; import com.google.inject.Inject; import com.google.inject.Provider; import java.util.Arrays; -import java.util.HashMap; import java.util.Map; -import java.util.Map.Entry; import javax.servlet.http.HttpServletRequest; import org.apache.guacamole.form.Field; import org.apache.guacamole.GuacamoleException; diff --git a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java index 963dd245f..f3198de93 100644 --- a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java +++ b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java @@ -34,9 +34,9 @@ import java.util.Map.Entry; import javax.xml.bind.DatatypeConverter; import org.apache.guacamole.GuacamoleException; import org.apache.guacamole.GuacamoleServerException; -import org.apache.guacamole.auth.cas.CASTokenName; import org.apache.guacamole.auth.cas.conf.ConfigurationService; import org.apache.guacamole.net.auth.Credentials; +import org.apache.guacamole.token.TokenName; import org.jasig.cas.client.authentication.AttributePrincipal; import org.jasig.cas.client.validation.Assertion; import org.jasig.cas.client.validation.Cas20ProxyTicketValidator; @@ -54,6 +54,11 @@ public class TicketValidationService { * Logger for this class. */ private static final Logger logger = LoggerFactory.getLogger(TicketValidationService.class); + + /** + * The prefix to use when generating token names. + */ + public static final String CAS_ATTRIBUTE_TOKEN_PREFIX = "CAS_"; /** * Service for retrieving CAS configuration information. @@ -96,7 +101,8 @@ public class TicketValidationService { String confRedirectURI = confService.getRedirectURI(); Assertion a = validator.validate(ticket, confRedirectURI); AttributePrincipal principal = a.getPrincipal(); - Map ticketAttrs = principal.getAttributes(); + Map ticketAttrs = + new HashMap<>(principal.getAttributes()); // Retrieve username and set the credentials. String username = principal.getName(); @@ -112,8 +118,9 @@ public class TicketValidationService { } // Convert remaining attributes that have values to Strings - for (Entry attr : ticketAttrs.entrySet()) { - String tokenName = CASTokenName.fromAttribute(attr.getKey().toString()); + for (Entry attr : ticketAttrs.entrySet()) { + String tokenName = TokenName.fromAttribute(attr.getKey(), + CAS_ATTRIBUTE_TOKEN_PREFIX); Object value = attr.getValue(); if (value != null) tokens.put(tokenName, value.toString()); diff --git a/extensions/guacamole-auth-cas/src/test/java/org/apache/guacamole/auth/cas/CASTokenNameTest.java b/extensions/guacamole-auth-cas/src/test/java/org/apache/guacamole/auth/cas/CASTokenNameTest.java deleted file mode 100644 index 56b42be83..000000000 --- a/extensions/guacamole-auth-cas/src/test/java/org/apache/guacamole/auth/cas/CASTokenNameTest.java +++ /dev/null @@ -1,53 +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.cas; - -import static org.junit.Assert.assertEquals; -import org.junit.Test; - -/** - * Test which verifies automatic generation of LDAP-specific connection - * parameter token names. - */ -public class CASTokenNameTest { - - /** - * Verifies that TokenName.fromAttribute() generates token names as - * specified, regardless of the naming convention of the attribute. - */ - @Test - public void testFromAttribute() { - assertEquals("CAS_A", CASTokenName.fromAttribute("a")); - assertEquals("CAS_B", CASTokenName.fromAttribute("b")); - assertEquals("CAS_1", CASTokenName.fromAttribute("1")); - assertEquals("CAS_SOME_URL", CASTokenName.fromAttribute("someURL")); - assertEquals("CAS_LOWERCASE_WITH_DASHES", CASTokenName.fromAttribute("lowercase-with-dashes")); - assertEquals("CAS_HEADLESS_CAMEL_CASE", CASTokenName.fromAttribute("headlessCamelCase")); - assertEquals("CAS_CAMEL_CASE", CASTokenName.fromAttribute("CamelCase")); - assertEquals("CAS_CAMEL_CASE", CASTokenName.fromAttribute("CamelCase")); - assertEquals("CAS_LOWERCASE_WITH_UNDERSCORES", CASTokenName.fromAttribute("lowercase_with_underscores")); - assertEquals("CAS_UPPERCASE_WITH_UNDERSCORES", CASTokenName.fromAttribute("UPPERCASE_WITH_UNDERSCORES")); - assertEquals("CAS_A_VERY_INCONSISTENT_MIX_OF_ALL_STYLES", CASTokenName.fromAttribute("aVery-INCONSISTENTMix_ofAllStyles")); - assertEquals("CAS_ABC_123_DEF_456", CASTokenName.fromAttribute("abc123def456")); - assertEquals("CAS_ABC_123_DEF_456", CASTokenName.fromAttribute("ABC123DEF456")); - assertEquals("CAS_WORD_A_WORD_AB_WORD_ABC_WORD", CASTokenName.fromAttribute("WordAWordABWordABCWord")); - } - -} diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java index db928d7e0..ac1fee4ce 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java @@ -41,6 +41,7 @@ import org.apache.guacamole.net.auth.AuthenticatedUser; import org.apache.guacamole.net.auth.Credentials; import org.apache.guacamole.net.auth.credentials.CredentialsInfo; import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException; +import org.apache.guacamole.token.TokenName; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -53,7 +54,12 @@ public class AuthenticationProviderService { /** * Logger for this class. */ - private final Logger logger = LoggerFactory.getLogger(AuthenticationProviderService.class); + private static final Logger logger = LoggerFactory.getLogger(AuthenticationProviderService.class); + + /** + * The prefix that will be used when generating tokens. + */ + public static final String LDAP_ATTRIBUTE_TOKEN_PREFIX = "LDAP_"; /** * Service for creating and managing connections to LDAP servers. @@ -294,7 +300,7 @@ public class AuthenticationProviderService { String[] attrArray = attrList.toArray(new String[attrList.size()]); String userDN = getUserBindDN(username); - Map tokens = new HashMap(); + Map tokens = new HashMap<>(); try { // Get LDAP attributes by querying LDAP @@ -309,7 +315,8 @@ public class AuthenticationProviderService { // Convert each retrieved attribute into a corresponding token for (Object attrObj : attrSet) { LDAPAttribute attr = (LDAPAttribute)attrObj; - tokens.put(LDAPTokenName.fromAttribute(attr.getName()), attr.getStringValue()); + tokens.put(TokenName.fromAttribute(attr.getName(), + LDAP_ATTRIBUTE_TOKEN_PREFIX), attr.getStringValue()); } } diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java index f84912610..3aaf324c9 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java @@ -28,7 +28,6 @@ import com.novell.ldap.LDAPJSSEStartTLSFactory; import java.io.UnsupportedEncodingException; import org.apache.guacamole.GuacamoleException; import org.apache.guacamole.GuacamoleUnsupportedException; -import org.apache.guacamole.auth.ldap.ReferralAuthHandler; import org.slf4j.Logger; import org.slf4j.LoggerFactory; diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPTokenName.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPTokenName.java deleted file mode 100644 index dfcc2f522..000000000 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPTokenName.java +++ /dev/null @@ -1,33 +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.ldap; - -import org.apache.guacamole.token.TokenName; - -/** - * Utility class for generating parameter token names. - */ -public class LDAPTokenName extends TokenName { - - public static String fromAttribute(String name) { - return fromAttribute(name, "LDAP_"); - } - -} \ No newline at end of file diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ReferralAuthHandler.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ReferralAuthHandler.java index e605b3c0b..a5e359a66 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ReferralAuthHandler.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ReferralAuthHandler.java @@ -19,12 +19,9 @@ package org.apache.guacamole.auth.ldap; -import com.google.inject.Inject; import com.novell.ldap.LDAPAuthHandler; import com.novell.ldap.LDAPAuthProvider; -import com.novell.ldap.LDAPConnection; import java.io.UnsupportedEncodingException; -import org.apache.guacamole.GuacamoleException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -48,6 +45,12 @@ public class ReferralAuthHandler implements LDAPAuthHandler { * Creates a ReferralAuthHandler object to handle authentication when * following referrals in a LDAP connection, using the provided dn and * password. + * + * @param dn + * The distinguished name to use for the referral login. + * + * @param password + * The password to use for the referral login. */ public ReferralAuthHandler(String dn, String password) { byte[] passwordBytes; diff --git a/extensions/guacamole-auth-ldap/src/test/java/org/apache/guacamole/auth/ldap/LDAPTokenNameTest.java b/extensions/guacamole-auth-ldap/src/test/java/org/apache/guacamole/auth/ldap/LDAPTokenNameTest.java deleted file mode 100644 index 80aba7dcf..000000000 --- a/extensions/guacamole-auth-ldap/src/test/java/org/apache/guacamole/auth/ldap/LDAPTokenNameTest.java +++ /dev/null @@ -1,53 +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.ldap; - -import static org.junit.Assert.assertEquals; -import org.junit.Test; - -/** - * Test which verifies automatic generation of LDAP-specific connection - * parameter token names. - */ -public class LDAPTokenNameTest { - - /** - * Verifies that TokenName.fromAttribute() generates token names as - * specified, regardless of the naming convention of the attribute. - */ - @Test - public void testFromAttribute() { - assertEquals("LDAP_A", LDAPTokenName.fromAttribute("a")); - assertEquals("LDAP_B", LDAPTokenName.fromAttribute("b")); - assertEquals("LDAP_1", LDAPTokenName.fromAttribute("1")); - assertEquals("LDAP_SOME_URL", LDAPTokenName.fromAttribute("someURL")); - assertEquals("LDAP_LOWERCASE_WITH_DASHES", LDAPTokenName.fromAttribute("lowercase-with-dashes")); - assertEquals("LDAP_HEADLESS_CAMEL_CASE", LDAPTokenName.fromAttribute("headlessCamelCase")); - assertEquals("LDAP_CAMEL_CASE", LDAPTokenName.fromAttribute("CamelCase")); - assertEquals("LDAP_CAMEL_CASE", LDAPTokenName.fromAttribute("CamelCase")); - assertEquals("LDAP_LOWERCASE_WITH_UNDERSCORES", LDAPTokenName.fromAttribute("lowercase_with_underscores")); - assertEquals("LDAP_UPPERCASE_WITH_UNDERSCORES", LDAPTokenName.fromAttribute("UPPERCASE_WITH_UNDERSCORES")); - assertEquals("LDAP_A_VERY_INCONSISTENT_MIX_OF_ALL_STYLES", LDAPTokenName.fromAttribute("aVery-INCONSISTENTMix_ofAllStyles")); - assertEquals("LDAP_ABC_123_DEF_456", LDAPTokenName.fromAttribute("abc123def456")); - assertEquals("LDAP_ABC_123_DEF_456", LDAPTokenName.fromAttribute("ABC123DEF456")); - assertEquals("LDAP_WORD_A_WORD_AB_WORD_ABC_WORD", LDAPTokenName.fromAttribute("WordAWordABWordABCWord")); - } - -} diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/token/TokenName.java b/guacamole-ext/src/main/java/org/apache/guacamole/token/TokenName.java index 90e17ded7..1e90114e5 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/token/TokenName.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/token/TokenName.java @@ -65,7 +65,8 @@ public abstract class TokenName { * automatically be transformed from "CamelCase", "headlessCamelCase", * "lowercase_with_underscores", and "mixes_ofBoth_Styles" to consistent * "UPPERCASE_WITH_UNDERSCORES". Each returned attribute will be prefixed - * with "LDAP_". + * with value provided in the prefix. The value provided in prefix will + * be prepended to the attribute name, but will itself not be transformed. * * @param name * The name of the attribute to use to generate the token name. @@ -99,5 +100,21 @@ public abstract class TokenName { return builder.toString(); } + + /** + * Generate the name of a parameter from the value of the given attribute, + * and with a blank prefix such that the token name will simply be the + * transformed version of the attribute name. + * + * @param name + * The name of the attribute to use to generate the token name. + * + * @return + * The name of the parameter token that should be populated with the + * value of the attribute having the given name. + */ + public static String fromAttribute(final String name) { + return fromAttribute(name, ""); + } } diff --git a/guacamole-ext/src/test/java/org/apache/guacamole/token/TokenNameTest.java b/guacamole-ext/src/test/java/org/apache/guacamole/token/TokenNameTest.java index f2d468e78..08c819158 100644 --- a/guacamole-ext/src/test/java/org/apache/guacamole/token/TokenNameTest.java +++ b/guacamole-ext/src/test/java/org/apache/guacamole/token/TokenNameTest.java @@ -34,20 +34,23 @@ public class TokenNameTest { */ @Test public void testFromAttribute() { - assertEquals("A", TokenName.fromAttribute("a", "")); - assertEquals("B", TokenName.fromAttribute("b", "")); - assertEquals("1", TokenName.fromAttribute("1", "")); - assertEquals("SOME_URL", TokenName.fromAttribute("someURL", "")); - assertEquals("LOWERCASE_WITH_DASHES", TokenName.fromAttribute("lowercase-with-dashes", "")); - assertEquals("HEADLESS_CAMEL_CASE", TokenName.fromAttribute("headlessCamelCase", "")); - assertEquals("CAMEL_CASE", TokenName.fromAttribute("CamelCase", "")); - assertEquals("CAMEL_CASE", TokenName.fromAttribute("CamelCase", "")); - assertEquals("LOWERCASE_WITH_UNDERSCORES", TokenName.fromAttribute("lowercase_with_underscores", "")); - assertEquals("UPPERCASE_WITH_UNDERSCORES", TokenName.fromAttribute("UPPERCASE_WITH_UNDERSCORES", "")); - assertEquals("A_VERY_INCONSISTENT_MIX_OF_ALL_STYLES", TokenName.fromAttribute("aVery-INCONSISTENTMix_ofAllStyles", "")); - assertEquals("ABC_123_DEF_456", TokenName.fromAttribute("abc123def456", "")); - assertEquals("ABC_123_DEF_456", TokenName.fromAttribute("ABC123DEF456", "")); - assertEquals("WORD_A_WORD_AB_WORD_ABC_WORD", TokenName.fromAttribute("WordAWordABWordABCWord", "")); + assertEquals("A", TokenName.fromAttribute("a")); + assertEquals("B", TokenName.fromAttribute("b")); + assertEquals("1", TokenName.fromAttribute("1")); + assertEquals("SOME_URL", TokenName.fromAttribute("someURL")); + assertEquals("LOWERCASE_WITH_DASHES", TokenName.fromAttribute("lowercase-with-dashes")); + assertEquals("HEADLESS_CAMEL_CASE", TokenName.fromAttribute("headlessCamelCase")); + assertEquals("CAMEL_CASE", TokenName.fromAttribute("CamelCase")); + assertEquals("CAMEL_CASE", TokenName.fromAttribute("CamelCase")); + assertEquals("LOWERCASE_WITH_UNDERSCORES", TokenName.fromAttribute("lowercase_with_underscores")); + assertEquals("UPPERCASE_WITH_UNDERSCORES", TokenName.fromAttribute("UPPERCASE_WITH_UNDERSCORES")); + assertEquals("A_VERY_INCONSISTENT_MIX_OF_ALL_STYLES", TokenName.fromAttribute("aVery-INCONSISTENTMix_ofAllStyles")); + assertEquals("ABC_123_DEF_456", TokenName.fromAttribute("abc123def456")); + assertEquals("ABC_123_DEF_456", TokenName.fromAttribute("ABC123DEF456")); + assertEquals("WORD_A_WORD_AB_WORD_ABC_WORD", TokenName.fromAttribute("WordAWordABWordABCWord")); + + assertEquals("AUTH_ATTRIBUTE", TokenName.fromAttribute("Attribute", "AUTH_")); + assertEquals("auth_SOMETHING", TokenName.fromAttribute("Something", "auth_")); } }