ceph/src/arrow/java/flight/flight-core/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *    http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.arrow.flight.auth;
  19
  20 import java.util.Iterator;
  21 import java.util.Optional;
  22
  23 /**
  24  * Interface for Server side authentication handlers.
  25  */
  26 public interface ServerAuthHandler {
  27
  28   /**
  29    * Validate the client token provided on each call.
  30    *
  31    * @return An empty optional if the client is not authenticated; the peer identity otherwise (may be the empty
  32    *     string).
  33    */
  34   Optional<String> isValid(byte[] token);
  35
  36   /**
  37    * Handle the initial handshake with the client.
  38    *
  39    * @param outgoing A writer to send messages to the client.
  40    * @param incoming An iterator of messages from the client.
  41    * @return true if client is authenticated, false otherwise.
  42    */
  43   boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
  44
  45   /**
  46    * Interface for a server implementations to send back authentication messages
  47    * back to the client.
  48    */
  49   interface ServerAuthSender {
  50
  51     void send(byte[] payload);
  52
  53     void onError(Throwable cause);
  54
  55   }
  56
  57   /**
  58    * An auth handler that does nothing.
  59    */
  60   ServerAuthHandler NO_OP = new ServerAuthHandler() {
  61
  62     @Override
  63     public Optional<String> isValid(byte[] token) {
  64       return Optional.of("");
  65     }
  66
  67     @Override
  68     public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
  69       return true;
  70     }
  71   };
  72 }