2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FSecCryptoSkipJackCipher.h
20 * @brief This is the header file for the %SkipJackCipher class.
22 * This header file contains the declarations of the %SkipJackCipher class.
24 #ifndef _FSEC_CRYPTO_SKIPJACK_CIPHER_H_
25 #define _FSEC_CRYPTO_SKIPJACK_CIPHER_H_
27 #include <FSecCryptoISymmetricCipher.h>
32 namespace Tizen { namespace Security { namespace Crypto
35 class _SymmetricCipher;
37 * @class SkipJackCipher
38 * @brief This class provides methods for encryption and decryption using the Skipjack algorithm.
42 * 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
43 * padding scheme and the cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n
45 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/ciphers.htm">Ciphers</a>.
47 * @see ISymmetricCipher
51 class _OSP_EXPORT_ SkipJackCipher
52 : public virtual ISymmetricCipher
53 , public Tizen::Base::Object
58 * The object is not fully constructed after this constructor is called. For full construction, @n
59 * the Construct() method must be called right after calling this constructor.
66 * This destructor overrides Tizen::Base::Object::~Object().
70 virtual ~SkipJackCipher(void);
73 * Constructs and initializes this instance of %SkipJackCipher with the specified parameters.
77 * @return An error code
78 * @param[in] transformation The name of the requested mode or padding scheme @n
79 * As the default key size of the Skipjack cipher is 80 bits, there is no need to mention it explicitly.
80 * For example, "CBC/PKCS7PADDING" or "ECB/NOPADDING".
81 * @param[in] opMode The cipher operation mode @n
82 * The only valid values for %SkipJackCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT.
83 * @exception E_SUCCESS The method is successful.
84 * @exception E_OUT_OF_MEMORY The memory is insufficient.
85 * @exception E_INVALID_ARG The specified @c opMode contains invalid value for the cipher operation.
86 * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n
87 * 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.
90 virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode);
93 * Sets a symmetric key for encryption or decryption.
97 * @return An error code
98 * @param[in] key An instance of ISecretKey
99 * @exception E_SUCCESS The method is successful.
100 * @exception E_INVALID_ARG The specified key is invalid.
101 * @exception E_OUT_OF_MEMORY The memory is insufficient.
103 virtual result SetKey(const Tizen::Security::ISecretKey& key);
106 * Sets the initial vector.
110 * @return An error code
111 * @param[in] initialVector The initial vector
112 * @exception E_SUCCESS The method is successful.
113 * @exception E_INVALID_ARG The specified input parameter is invalid.
114 * @exception E_OUT_OF_MEMORY The memory is insufficient.
116 virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector);
119 * Encrypts the data (single-part).
123 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
124 * else @c null if an error occurs
125 * @param[in] input An instance of Tizen::Base::ByteBuffer
126 * @exception E_SUCCESS The method is successful.
127 * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data.
128 * @exception E_OUT_OF_MEMORY The memory is insufficient.
129 * @exception E_KEY_NOT_FOUND The specified key is not found.
130 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
131 * @exception E_OVERFLOW This operation has caused the memory to overflow.
132 * @exception E_SYSTEM A system error has occurred. @n
133 * The method has failed to operate with the OpenSSL library, or
134 * the Tizen::Base::ByteBuffer operation has failed.
135 * @remarks The specific error code can be accessed using the GetLastResult() method.
136 * @remarks A secret key and an initial vector are set before calling this method.
138 virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input);
141 * Decrypts the data (single-part).
145 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
146 * else @c null if an error occurs
147 * @param[in] input An instance of Tizen::Base::ByteBuffer
148 * @exception E_SUCCESS The method is successful.
149 * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data.
150 * @exception E_OUT_OF_MEMORY The memory is insufficient.
151 * @exception E_KEY_NOT_FOUND The specified key is not found.
152 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
153 * @exception E_OVERFLOW This operation has caused the memory to overflow.
154 * @exception E_SYSTEM A system error has occurred. @n
155 * The method has failed to operate with the OpenSSL library, or
156 * the Tizen::Base::ByteBuffer operation has failed.
157 * @remarks The specific error code can be accessed using the GetLastResult() method.
158 * @remarks A secret key and an initial vector are set before calling this method.
160 virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input);
163 * Initializes a multiple-part encryption or decryption operation.
167 * @return An error code
168 * @exception E_SUCCESS The method is successful.
169 * @exception E_OUT_OF_MEMORY The memory is insufficient.
170 * @exception E_KEY_NOT_FOUND The specified key is not found.
171 * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
172 * @exception E_SYSTEM A system error has occurred. @n
173 * The method has failed to operate with the OpenSSL library.
174 * @remarks A secret key and an initial vector are set before calling this method.
176 virtual result Initialize(void);
179 * Updates a multiple-part encryption or decryption operation.
183 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
184 * else @c null if an error occurs
185 * @param[in] input An instance of Tizen::Base::ByteBuffer
186 * @exception E_SUCCESS The method is successful.
187 * @exception E_OUT_OF_MEMORY The memory is insufficient.
188 * @exception E_OVERFLOW This operation has caused the memory to overflow.
189 * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
190 * @exception E_SYSTEM A system error has occurred. @n
191 * The method has failed to operate with the OpenSSL library, or
192 * the Tizen::Base::ByteBuffer operation has failed.
193 * @remarks The specific error code can be accessed using the GetLastResult() method.
195 virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input);
198 * Finalizes a multiple-part encryption or decryption operation.
202 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
203 * else @c null if an error occurs
204 * @exception E_SUCCESS The method is successful.
205 * @exception E_OUT_OF_MEMORY The memory is insufficient.
206 * @exception E_OVERFLOW This operation has caused the memory to overflow.
207 * @exception E_SYSTEM A system error has occurred. @n
208 * The method has failed to operate with the OpenSSL library, or
209 * the Tizen::Base::ByteBuffer operation has failed.
210 * @remarks The specific error code can be accessed using the GetLastResult() method.
212 virtual Tizen::Base::ByteBuffer* FinalizeN(void);
215 * Wraps the specified key.
219 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
220 * else @c null if an error occurs
221 * @param[in] secretKey The secret key to wrap
222 * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null.
223 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
225 virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
228 * Unwraps the specified wrapped key.
232 * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
233 * else @c null if an error occurs
234 * @param[in] wrappedKey The wrapped key to unwrap
235 * @remarks This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n
236 * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
238 virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);
243 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
247 SkipJackCipher(const SkipJackCipher& rhs);
250 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
254 SkipJackCipher& operator =(const SkipJackCipher& rhs);
257 _SymmetricCipher* __pSymmetricCipher;
258 const evp_cipher_st* __pCipherAlgorithm;
259 Tizen::Base::String __cipherAlgorithm;
261 class _SkipJackCipherImpl* __pSkipJackCipherImpl;
262 friend class _SkipJackCipherImpl;
266 } } } //Tizen::Security::Crypto
268 #endif //_FSEC_CRYPTO_SKIPJACK_CIPHER_H_