2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
18 * @file FSecCryptoDesEdeCipher.h
19 * @brief This is the header file for the %DesEdeCipher class.
21 * This header file contains the declarations of the %DesEdeCipher class.
23 #ifndef _FSEC_CRYPTO_DES_EDE_CIPHER_H_
24 #define _FSEC_CRYPTO_DES_EDE_CIPHER_H_
26 #include <FSecCryptoISymmetricCipher.h>
31 namespace Tizen { namespace Security { namespace Crypto
34 class _SymmetricCipher;
37 * @brief This class provides methods for encryption and decryption using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode.
41 * The %DesEdeCipher class provides symmetric cipher using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode.
42 * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n
44 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/ciphers.htm">Ciphers</a>.
46 * @see ISymmetricCipher
50 class _OSP_EXPORT_ DesEdeCipher
51 : public virtual ISymmetricCipher
52 , public Tizen::Base::Object
57 * The object is not fully constructed after this constructor is called. For full construction, @n
58 * the Construct() method must be called right after calling this constructor.
65 * This destructor overrides Tizen::Base::Object::~Object().
69 virtual ~DesEdeCipher(void);
72 * Initializes this instance of %DesEdeCipher with the specified parameters.
76 * @return An error code
77 * @param[in] transformation The name of the requested mode/key bit/padding scheme @n
78 * For example, "CBC/NOPADDING" or "CBC/PKCS7PADDING".
79 * @param[in] opMode The cipher operation mode @n
80 * The valid values for %DesEdeCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT.
81 * @exception E_SUCCESS The method is successful.
82 * @exception E_OUT_OF_MEMORY The memory is insufficient.
83 * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation.
84 * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n
85 * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned.
87 virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode);
89 * Sets a symmetric key for encryption or decryption.
93 * @return An error code
94 * @param[in] key An instance of ISecretKey
95 * @exception E_SUCCESS The method is successful.
96 * @exception E_INVALID_ARG The specified @c key is invalid.
97 * @exception E_OUT_OF_MEMORY The memory is insufficient.
99 virtual result SetKey(const Tizen::Security::ISecretKey& key);
102 * Sets the initial vector.
106 * @return An error code
107 * @param[in] initialVector The initial vector
108 * @exception E_SUCCESS The method is successful.
109 * @exception E_INVALID_ARG The specified input parameter is invalid.
110 * @exception E_OUT_OF_MEMORY The memory is insufficient.
112 virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector);
115 * Encrypts the data (single-part).
119 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
120 * else @c null if an error occurs
121 * @param[in] input An instance of Tizen::Base::ByteBuffer
122 * @exception E_SUCCESS The method is successful.
123 * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
124 * @exception E_OUT_OF_MEMORY The memory is insufficient.
125 * @exception E_KEY_NOT_FOUND The specified key is not found.
126 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
127 * @exception E_OVERFLOW This operation has caused the memory to overflow.
128 * @exception E_SYSTEM A system error has occurred. @n
129 * The method has failed to operate with the openssl library, or
130 * the Tizen::Base::ByteBuffer operation has failed.
131 * @remarks The specific error code can be accessed using the GetLastResult() method.
132 * @remarks A secret key and an initial vector are set before calling this method.
134 virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input);
137 * Decrypts the data (single-part).
141 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
142 * else @c null if an error occurs
143 * @param[in] input An instance of Tizen::Base::ByteBuffer
144 * @exception E_SUCCESS The method is successful.
145 * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
146 * @exception E_OUT_OF_MEMORY The memory is insufficient.
147 * @exception E_KEY_NOT_FOUND The specified key is not found.
148 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
149 * @exception E_OVERFLOW This operation has caused the memory to overflow.
150 * @exception E_SYSTEM A system error has occurred. @n
151 * The method has failed to operate with the openssl library, or
152 * the Tizen::Base::ByteBuffer operation has failed.
153 * @remarks The specific error code can be accessed using the GetLastResult() method.
154 * @remarks A secret key and an initial vector are set before calling this method.
156 virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input);
159 * Initializes a multiple-part encryption or decryption operation.
163 * @return An error code
164 * @exception E_SUCCESS The method is successful.
165 * @exception E_OUT_OF_MEMORY The memory is insufficient.
166 * @exception E_KEY_NOT_FOUND The specified key is not found.
167 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
168 * @exception E_SYSTEM A system error has occurred. @n
169 * The method has failed to operate with the openssl library.
170 * @remarks A secret key and an initial vector are set before calling this method.
172 virtual result Initialize(void);
175 * Updates a multiple-part encryption or decryption operation.
179 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
180 * else @c null if an error occurs
181 * @param[in] input An instance of Tizen::Base::ByteBuffer
182 * @exception E_SUCCESS The method is successful.
183 * @exception E_OUT_OF_MEMORY The memory is insufficient.
184 * @exception E_OVERFLOW This operation has caused the memory to overflow.
185 * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
186 * @exception E_SYSTEM A system error has occurred. @n
187 * The method has failed to operate with the openssl library, or
188 * the Tizen::Base::ByteBuffer operation has failed.
189 * @remarks The specific error code can be accessed using the GetLastResult() method.
191 virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input);
194 * Finalizes a multiple-part encryption or decryption operation.
198 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
199 * else @c null if an error occurs
200 * @exception E_SUCCESS The method is successful.
201 * @exception E_OUT_OF_MEMORY The memory is insufficient.
202 * @exception E_OVERFLOW This operation has caused the memory to overflow.
203 * @exception E_SYSTEM A system error has occurred. @n
204 * The method has failed to operate with the openssl library, or
205 * the Tizen::Base::ByteBuffer operation has failed.
206 * @remarks The specific error code can be accessed using the GetLastResult() method.
208 virtual Tizen::Base::ByteBuffer* FinalizeN(void);
215 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
216 * else @c null if an error occurs
217 * @param[in] secretKey The secret key to wrap
218 * @remarks This operation is not supported in the %DesEdeCipher class.
219 * Therefore, this method always returns @c null.
220 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
222 virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
225 * Unwraps a previously wrapped key.
229 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
230 * else @c null if an error occurs
231 * @param[in] wrappedKey The wrapped key to unwrap
232 * @remarks This operation is not supported in the %DesEdeCipher class.
233 * Therefore, this method always returns @c null.
234 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
236 virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);
241 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
245 DesEdeCipher(const DesEdeCipher& rhs);
248 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
252 DesEdeCipher& operator =(const DesEdeCipher& rhs);
255 _SymmetricCipher* __pSymmetricCipher;
256 const evp_cipher_st* __pCipherAlgorithm;
257 Tizen::Base::String __cipherAlgorithm;
259 class _DesEdeCipherImpl* __pDesEdeCipherImpl;
260 friend class _DesEdeCipherImpl;
264 } } } //Tizen::Security::Crypto
266 #endif //_FSEC_CRYPTO_DES_EDE_CIPHER_H_