Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
PasswordBasedCipherFactory	35	0	-	0	0	-1.0 -	Show methods

Class PasswordBasedCipherFactory

Class PasswordBasedCipherFactory	Line # 35	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

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.password;
21
22		import org.xwiki.component.annotation.Role;
23		import org.xwiki.crypto.cipher.CipherSpecifications;
24		import org.xwiki.crypto.params.cipher.symmetric.SymmetricCipherParameters;
25		import org.xwiki.crypto.password.params.KeyDerivationFunctionParameters;
26
27		/**
28		* Factory creating block ciphers for encryption and decryption that use a password to derive their keys
29		* (and initialization vector when that one is not provided).
30		*
31		* @version $Id: 56622ccb558be08c5b66304ae406a3d1e072f2ab $
32		* @since 5.4M1
33		*/
34		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
35		public interface PasswordBasedCipherFactory extends CipherSpecifications
36		{
37		/**
38		* Create a new initialized password based cipher from parameters.
39		*
40		* @param forEncryption if true the cipher is initialised for encryption, if false for decryption.
41		* @param password cipher parameters, using a password converted to bytes for the key.
42		* @param kdfParameters the parameters of the derivation function.
43		* @return an initialized cipher ready to process data.
44		*/
45		PasswordBasedCipher getInstance(boolean forEncryption, SymmetricCipherParameters password,
46		KeyDerivationFunctionParameters kdfParameters);
47
48		/**
49		* Create a new initialized password based cipher using the given key derivation function.
50		*
51		* @param forEncryption if true the cipher is initialised for encryption, if false for decryption.
52		* @param password cipher parameters, using a password converted to bytes for the key.
53		* @param function the key derivation function to use for deriving key from password.
54		* @return an initialized cipher ready to process data.
55		*/
56		PasswordBasedCipher getInstance(boolean forEncryption, SymmetricCipherParameters password,
57		KeyDerivationFunction function);
58
59		/**
60		* Create a new initialized password based cipher from serialized encoding.
61		*
62		* @param forEncryption if true the cipher is initialised for encryption, if false for decryption.
63		* @param password the password used to derive the encryption key.
64		* @param encoded encoded parameters to initialize the cipher and derivation function.
65		* @return an initialized cipher ready to process data.
66		*/
67		PasswordBasedCipher getInstance(boolean forEncryption, byte[] password, byte[] encoded);
68		}