hadoop-common-project/hadoop-nfs/src/main/java/org/apache/hadoop/oncrpc/security/SecurityHandler.java

/**
 * 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.oncrpc.security;

import java.io.IOException;

import org.apache.hadoop.oncrpc.RpcCall;
import org.apache.hadoop.oncrpc.XDR;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class SecurityHandler {
  public static final Logger LOG =
      LoggerFactory.getLogger(SecurityHandler.class);
  
  public abstract String getUser();

  public abstract boolean shouldSilentlyDrop(RpcCall request);

  public abstract Verifier getVerifer(RpcCall request) throws IOException;

  public boolean isUnwrapRequired() {
    return false;
  }

  public boolean isWrapRequired() {
    return false;
  }

  /**
   * Used by GSS.
   * @param request RPC request
   * @param data request data
   * @throws IOException fail to unwrap RPC call
   * @return XDR response
   */
  public XDR unwrap(RpcCall request, byte[] data ) throws IOException {
    throw new UnsupportedOperationException();
  }
  
  /**
   * Used by GSS.
   * @param request RPC request
   * @param response RPC response
   * @throws IOException fail to wrap RPC call
   * @return response byte buffer
   */
  public byte[] wrap(RpcCall request, XDR response) throws IOException {
    throw new UnsupportedOperationException();
  }
  
  /**
   * Used by AUTH_SYS.
   * Return the uid of the NFS user credential.
   * @return uid
   */
  public int getUid() {
    throw new UnsupportedOperationException();
  }
  
  /**
   * Used by AUTH_SYS.
   * Return the gid of the NFS user credential.
   * @return gid
   */
  public int getGid() {
    throw new UnsupportedOperationException();
  }

  /**
   * Used by AUTH_SYS.
   * Return the auxiliary gids of the NFS user credential.
   * @return auxiliary gids
   */
  public int[] getAuxGids() {
    throw new UnsupportedOperationException();
  }
}