Subversion Repositories Programming Utils

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
86 rm5248 1
/*
2
 * Licensed to the Apache Software Foundation (ASF) under one
3
 * or more contributor license agreements.  See the NOTICE file
4
 * distributed with this work for additional information
5
 * regarding copyright ownership.  The ASF licenses this file
6
 * to you under the Apache License, Version 2.0 (the
7
 * "License"); you may not use this file except in compliance
8
 * with the License.  You may obtain a copy of the License at
9
 *
10
 *   http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing,
13
 * software distributed under the License is distributed on an
14
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
 * KIND, either express or implied.  See the License for the
16
 * specific language governing permissions and limitations
17
 * under the License.
18
 */
19
package org.apache.sshd.common;
20
 
21
/**
22
 * Wrapper for a cryptographic cipher, used either for encryption
23
 * or decryption.
24
 *
25
 * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
26
 */
27
public interface Cipher  {
28
 
29
    enum Mode {
30
        Encrypt, Decrypt
31
    }
32
 
33
    /**
34
     * Retrieves the size of the initialization vector
35
     *
36
     * @return
37
     */
38
    int getIVSize();
39
 
40
    /**
41
     * Retrieves the block size for this cipher
42
     *
43
     * @return
44
     */
45
    int getBlockSize();
46
 
47
    /**
48
     * Initialize the cipher for encryption or decryption with
49
     * the given private key and initialization vector
50
     *
51
     * @param mode
52
     * @param key
53
     * @param iv
54
     * @throws Exception
55
     */
56
    void init(Mode mode, byte[] key, byte[] iv) throws Exception;
57
 
58
    /**
59
     * Performs in-place encryption or decryption on the given data.
60
     *
61
     * @param input
62
     * @param inputOffset
63
     * @param inputLen
64
     * @throws Exception
65
     */
66
    void update(byte[] input, int inputOffset, int inputLen) throws Exception;
67
 
68
}