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;
022
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * Encryptors apply a cipher to an OutputStream to produce ciphertext.
027 */
028@InterfaceAudience.Public
029public interface Encryptor {
030
031  /**
032   * Set the secret key
033   * @param key
034   */
035  public void setKey(Key key);
036
037  /**
038   * Get the expected length for the initialization vector
039   * @return the expected length for the initialization vector
040   */
041  public int getIvLength();
042
043  /**
044   * Get the cipher's internal block size
045   * @return the cipher's internal block size
046   */
047  public int getBlockSize();
048
049  /**
050   * Get the initialization vector
051   */
052  public byte[] getIv();
053
054  /**
055   * Set the initialization vector
056   * @param iv
057   */
058  public void setIv(byte[] iv);
059
060  /**
061   * Create a stream for encryption
062   * @param out
063   */
064  public OutputStream createEncryptionStream(OutputStream out);
065
066  /**
067   * Reset state, reinitialize with the key and iv
068   */
069  void reset();
070}