001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.io.crypto;
019
020import java.io.OutputStream;
021import java.security.Key;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * Encryptors apply a cipher to an OutputStream to produce ciphertext.
026 */
027@InterfaceAudience.Public
028public interface Encryptor {
029
030  /**
031   * Set the secret key
032   */
033  public void setKey(Key key);
034
035  /**
036   * Get the expected length for the initialization vector
037   * @return the expected length for the initialization vector
038   */
039  public int getIvLength();
040
041  /**
042   * Get the cipher's internal block size
043   * @return the cipher's internal block size
044   */
045  public int getBlockSize();
046
047  /**
048   * Get the initialization vector
049   */
050  public byte[] getIv();
051
052  /**
053   * Set the initialization vector
054   */
055  public void setIv(byte[] iv);
056
057  /**
058   * Create a stream for encryption
059   */
060  public OutputStream createEncryptionStream(OutputStream out);
061
062  /**
063   * Reset state, reinitialize with the key and iv
064   */
065  void reset();
066}