joshelser commented on a change in pull request #3934:
URL: https://github.com/apache/hbase/pull/3934#discussion_r779714133



##########
File path: 
hbase-common/src/main/java/org/apache/hadoop/hbase/exceptions/SaslAuthenticationException.java
##########
@@ -0,0 +1,52 @@
+/*
+ * 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.hadoop.hbase.exceptions;
+
+import javax.security.sasl.SaslServer;
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * This exception indicates that SASL authentication has failed. The error 
message
+ * in the exception indicates the actual cause of failure.
+ * <p>
+ * SASL authentication failures typically indicate invalid credentials, but
+ * could also include other failures specific to the SASL mechanism used
+ * for authentication.
+ * </p>
+ * <p><b>Note:</b>If {@link SaslServer#evaluateResponse(byte[])} throws this 
exception during
+ * authentication, the message from the exception will be sent to clients in 
the SaslAuthenticate
+ * response. Custom {@link SaslServer} implementations may throw this 
exception in order to
+ * provide custom error messages to clients, but should take care not to 
include any
+ * security-critical information in the message that should not be leaked to 
unauthenticated
+ * clients.
+ * </p>
+ */
+@InterfaceAudience.Public
+public class SaslAuthenticationException extends RuntimeException {

Review comment:
       Ok, I missed that. That's a good reason. We may have to do some 
unwrapping later (SaslAuthenticationException -> ... -> AccessDeniedException), 
but we're historically not great at throwing a clear exception :)




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@hbase.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to