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 FSecCryptoSkipJackCipher.h
19 * @brief This is the header file for the %SkipJackCipher class.
21 * This header file contains the declarations of the %SkipJackCipher class.
23 #ifndef _FSEC_CRYPTO_SKIPJACK_CIPHER_H_
24 #define _FSEC_CRYPTO_SKIPJACK_CIPHER_H_
26 #include <FSecCryptoISymmetricCipher.h>
31 namespace Tizen { namespace Security { namespace Crypto
34 class _SymmetricCipher;
36 * @class SkipJackCipher
37 * @brief This class provides methods for encryption and decryption using the Skipjack algorithm.
41 * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. Appropriate values have to be set for the requested mode or key bit or
42 * padding scheme and the 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_ SkipJackCipher
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 ~SkipJackCipher(void);
72 * Constructs and initializes this instance of %SkipJackCipher with the specified parameters.
76 * @return An error code
77 * @param[in] transformation The name of the requested mode or padding scheme @n
78 * As the default key size of the Skipjack cipher is 80 bits, there is no need to mention it explicitly.
79 * For example, "CBC/PKCS7PADDING" or "ECB/NOPADDING".
80 * @param[in] opMode The cipher operation mode @n
81 * The only valid values for %SkipJackCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT.
82 * @exception E_SUCCESS The method is successful.
83 * @exception E_OUT_OF_MEMORY The memory is insufficient.
84 * @exception E_INVALID_ARG The specified @c opMode contains invalid value for the cipher operation.
85 * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n
86 * 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.
89 virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode);
92 * Sets a symmetric key for encryption or decryption.
96 * @return An error code
97 * @param[in] key An instance of ISecretKey
98 * @exception E_SUCCESS The method is successful.
99 * @exception E_INVALID_ARG The specified key is invalid.
100 * @exception E_OUT_OF_MEMORY The memory is insufficient.
102 virtual result SetKey(const Tizen::Security::ISecretKey& key);
105 * Sets the initial vector.
109 * @return An error code
110 * @param[in] initialVector The initial vector
111 * @exception E_SUCCESS The method is successful.
112 * @exception E_INVALID_ARG The specified input parameter is invalid.
113 * @exception E_OUT_OF_MEMORY The memory is insufficient.
115 virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector);
118 * Encrypts the data (single-part).
122 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
123 * else @c null if an error occurs
124 * @param[in] input An instance of Tizen::Base::ByteBuffer
125 * @exception E_SUCCESS The method is successful.
126 * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data.
127 * @exception E_OUT_OF_MEMORY The memory is insufficient.
128 * @exception E_KEY_NOT_FOUND The specified key is not found.
129 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
130 * @exception E_OVERFLOW This operation has caused the memory to overflow.
131 * @exception E_SYSTEM A system error has occurred. @n
132 * The method has failed to operate with the OpenSSL library, or
133 * the Tizen::Base::ByteBuffer operation has failed.
134 * @remarks The specific error code can be accessed using the GetLastResult() method.
135 * @remarks A secret key and an initial vector are set before calling this method.
137 virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input);
140 * Decrypts the data (single-part).
144 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
145 * else @c null if an error occurs
146 * @param[in] input An instance of Tizen::Base::ByteBuffer
147 * @exception E_SUCCESS The method is successful.
148 * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data.
149 * @exception E_OUT_OF_MEMORY The memory is insufficient.
150 * @exception E_KEY_NOT_FOUND The specified key is not found.
151 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
152 * @exception E_OVERFLOW This operation has caused the memory to overflow.
153 * @exception E_SYSTEM A system error has occurred. @n
154 * The method has failed to operate with the OpenSSL library, or
155 * the Tizen::Base::ByteBuffer operation has failed.
156 * @remarks The specific error code can be accessed using the GetLastResult() method.
157 * @remarks A secret key and an initial vector are set before calling this method.
159 virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input);
162 * Initializes a multiple-part encryption or decryption operation.
166 * @return An error code
167 * @exception E_SUCCESS The method is successful.
168 * @exception E_OUT_OF_MEMORY The memory is insufficient.
169 * @exception E_KEY_NOT_FOUND The specified key is not found.
170 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
171 * @exception E_SYSTEM A system error has occurred. @n
172 * The method has failed to operate with the OpenSSL library.
173 * @remarks A secret key and an initial vector are set before calling this method.
175 virtual result Initialize(void);
178 * Updates a multiple-part encryption or decryption operation.
182 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
183 * else @c null if an error occurs
184 * @param[in] input An instance of Tizen::Base::ByteBuffer
185 * @exception E_SUCCESS The method is successful.
186 * @exception E_OUT_OF_MEMORY The memory is insufficient.
187 * @exception E_OVERFLOW This operation has caused the memory to overflow.
188 * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
189 * @exception E_SYSTEM A system error has occurred. @n
190 * The method has failed to operate with the OpenSSL library, or
191 * the Tizen::Base::ByteBuffer operation has failed.
192 * @remarks The specific error code can be accessed using the GetLastResult() method.
194 virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input);
197 * Finalizes a multiple-part encryption or decryption operation.
201 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
202 * else @c null if an error occurs
203 * @exception E_SUCCESS The method is successful.
204 * @exception E_OUT_OF_MEMORY The memory is insufficient.
205 * @exception E_OVERFLOW This operation has caused the memory to overflow.
206 * @exception E_SYSTEM A system error has occurred. @n
207 * The method has failed to operate with the OpenSSL library, or
208 * the Tizen::Base::ByteBuffer operation has failed.
209 * @remarks The specific error code can be accessed using the GetLastResult() method.
211 virtual Tizen::Base::ByteBuffer* FinalizeN(void);
214 * Wraps the specified key.
218 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
219 * else @c null if an error occurs
220 * @param[in] secretKey The secret key to wrap
221 * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null.
222 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
224 virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
227 * Unwraps the specified wrapped key.
231 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
232 * else @c null if an error occurs
233 * @param[in] wrappedKey The wrapped key to unwrap
234 * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n
235 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
237 virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);
242 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
246 SkipJackCipher(const SkipJackCipher& rhs);
249 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
253 SkipJackCipher& operator =(const SkipJackCipher& rhs);
256 _SymmetricCipher* __pSymmetricCipher;
257 const evp_cipher_st* __pCipherAlgorithm;
258 Tizen::Base::String __cipherAlgorithm;
260 class _SkipJackCipherImpl* __pSkipJackCipherImpl;
261 friend class _SkipJackCipherImpl;
265 } } } //Tizen::Security::Crypto
267 #endif //_FSEC_CRYPTO_SKIPJACK_CIPHER_H_