1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.crypto.cipher

File CipherSpecifications.java

 

Code metrics

0
0
0
1
56
9
0
-
-
0
-

Classes

Class Line # Actions
CipherSpecifications 28 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.crypto.cipher;
21   
22    /**
23    * Common specifications for cipher factories.
24    *
25    * @version $Id: 98a19f0783e47de542ea67f1f69a8cd8395adff3 $
26    * @since 5.4M1
27    */
 
28    public interface CipherSpecifications
29    {
30    /**
31    * @return the algorithm name of created ciphers (ie: AES, CAST5, ...)
32    */
33    String getCipherAlgorithmName();
34   
35    /**
36    * @return the cipher block size (in bytes) that should be used to generate an IV or -1 if the cipher does not
37    * use an initialization vector.
38    */
39    int getIVSize();
40   
41    /**
42    * @return the recommended default key size of created ciphers (in bytes), usually the largest one supported.
43    */
44    int getKeySize();
45   
46    /**
47    * @return an array of the supported key sizes of created ciphers (in bytes).
48    */
49    int[] getSupportedKeySizes();
50   
51    /**
52    * @param keySize the size in bytes of a proposed key.
53    * @return true if the proposed key size is supported.
54    */
55    boolean isSupportedKeySize(int keySize);
56    }