inc/FSecCryptoRc4Cipher.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16 //
  17
  18 /**
  19  * @file                FSecCryptoRc4Cipher.h
  20  * @brief               This is the header file for the %Rc4Cipher class.
  21  *
  22  * This header file contains the declarations of the %Rc4Cipher class.
  23  */
  24 #ifndef _FSEC_CRYPTO_RC4_CIPHER_H_
  25 #define _FSEC_CRYPTO_RC4_CIPHER_H_
  26
  27 #include <FSecCryptoISymmetricCipher.h>
  28
  29 struct evp_cipher_st;
  30
  31
  32 namespace Tizen { namespace Security { namespace Crypto
  33 {
  34
  35 class _SymmetricCipher;
  36 /**
  37  *      @class          Rc4Cipher
  38  *      @brief          This class provides methods for encryption and decryption operations using the RC4 algorithm.
  39  *
  40  *      @since          2.0
  41  *
  42  *      The %Rc4Cipher class provides a symmetric cipher using the RC4 algorithm.
  43  *      It sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n
  44  *
  45  *      For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/ciphers.htm">Ciphers</a>.
  46  *
  47  *      @see    ISymmetricCipher
  48  *  @see    DesCipher
  49  *  @see    DesEdeCipher
  50  */
  51 class _OSP_EXPORT_ Rc4Cipher
  52         : public virtual ISymmetricCipher
  53         , public Tizen::Base::Object
  54 {
  55
  56 public:
  57         /**
  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.
  60          *
  61          *      @since          2.0
  62          */
  63         Rc4Cipher(void);
  64
  65         /**
  66          *      This destructor overrides Tizen::Base::Object::~Object().
  67          *
  68          *      @since          2.0
  69          */
  70         virtual ~Rc4Cipher(void);
  71
  72         /**
  73          *      Constructs and initializes an instance of %Rc4Cipher with the specified parameters.
  74          *
  75          *      @since          2.0
  76          *
  77          *      @return         An error code
  78          *      @param[in]      transformation                          The only valid value for %Rc4Cipher for transformation is "NONE"
  79          *      @param[in]      opMode                                          The cipher operation mode @n
  80          *                                                                                      The valid values for %Rc4Cipher 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.
  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.
  86          */
  87         virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode);
  88
  89         /**
  90          *      Sets a symmetric key for encryption or decryption operation. @n
  91          *  The variable length key ranges from 40 bits to 256 bits, in steps of 8 bits.
  92          *
  93          *      @since          2.0
  94          *
  95          *      @return         An error code
  96          *      @param[in]      key                                                     An instance of ISecretKey
  97          *      @exception      E_SUCCESS                                       The method is successful.
  98          *      @exception      E_INVALID_ARG                           The specified @c key is invalid.
  99          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 100          */
 101         virtual result SetKey(const Tizen::Security::ISecretKey& key);
 102
 103         /**
 104          *      Sets the initial vector.
 105          *
 106          *      @since          2.0
 107          *
 108          *      @return         An error code
 109          *      @param[in]      initialVector                           The initial vector
 110          *      @exception      E_SUCCESS                                       The method is successful.
 111          *      @exception      E_INVALID_ARG                           The specified input parameter is invalid.
 112          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 113          */
 114         virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector);
 115
 116         /**
 117          *      Encrypts the data (single-part).
 118          *
 119          *      @since          2.0
 120          *
 121          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 122          *                              else @c null if an error occurs
 123          *      @param[in]      input                                           An instance of Tizen::Base::ByteBuffer
 124          *      @exception      E_SUCCESS                                       The method is successful.
 125          *      @exception      E_INVALID_ARG                           The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
 126          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 127          *      @exception      E_KEY_NOT_FOUND                         The specified key is not found.
 128          *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
 129          *      @exception      E_OVERFLOW                                      This operation has caused the memory to overflow.
 130          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 131          *                                                                                      The method has failed to operate with the OpenSSL library, or
 132          *                                                                                      the Tizen::Base::ByteBuffer operation has failed.
 133          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 134          *      @remarks        A secret key and an initial vector are set before calling this method.
 135          */
 136         virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input);
 137
 138         /**
 139          *      Decrypts the data (single-part).
 140          *
 141          *      @since          2.0
 142          *
 143          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 144          *                              else @c null if an error occurs
 145          *      @param[in]      input                                           An instance of Tizen::Base::ByteBuffer
 146          *      @exception      E_SUCCESS                                       The method is successful.
 147          *      @exception      E_INVALID_ARG                           The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
 148          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 149          *      @exception      E_KEY_NOT_FOUND                         The specified key is not found.
 150          *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
 151          *      @exception      E_OVERFLOW                                      This operation has caused the memory to overflow.
 152          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 153          *                                                                                      The method has failed to operate with the OpenSSL library, or
 154          *                                                                                      the Tizen::Base::ByteBuffer operation has failed.
 155          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 156          *      @remarks        A secret key and an initial vector are set before calling this method.
 157          */
 158         virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input);
 159
 160         /**
 161          *      Initializes a multiple-part encryption or decryption operation.
 162          *
 163          *      @since          2.0
 164          *
 165          *      @return         An error code
 166          *      @exception      E_SUCCESS                                       The method is successful.
 167          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 168          *      @exception      E_KEY_NOT_FOUND                         The specified key is not found.
 169          *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
 170          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 171          *                                                                                      The method has failed to operate with the OpenSSL library.
 172          *      @remarks        A secret key and an initial vector are set before calling this method.
 173          */
 174         virtual result Initialize(void);
 175
 176         /**
 177          *      Updates a multiple-part encryption or decryption operation.
 178          *
 179          *      @since          2.0
 180          *
 181          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 182          *                              else @c null if an error occurs
 183          *      @param[in]      input                                           An instance of Tizen::Base::ByteBuffer
 184          *      @exception      E_SUCCESS                                       The method is successful.
 185          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 186          *      @exception      E_OVERFLOW                                      This operation has caused the memory to overflow.
 187          *      @exception      E_INVALID_ARG                           The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
 188          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 189          *                                                                                      The method has failed to operate with the OpenSSL library, or
 190          *                                                                                      the Tizen::Base::ByteBuffer operation has failed.
 191          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 192          */
 193         virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input);
 194
 195
 196         /**
 197          *      Finalizes a multiple-part encryption or decryption operation.
 198          *
 199          *      @since          2.0
 200          *
 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        This operation is not required for RC4. Always return @c null if this method is called.
 210          */
 211         virtual Tizen::Base::ByteBuffer* FinalizeN(void);
 212
 213         /**
 214          *      Wraps a key.
 215          *
 216          *      @since          2.0
 217          *
 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 the %Rc4Cipher class.
 222          *                              Therefore, this method always returns @c null.
 223          *  @remarks    The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method.
 224          */
 225         virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
 226
 227         /**
 228          *      Unwraps a previously wrapped key.
 229          *
 230          *      @since          2.0
 231          *
 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 the %Rc4Cipher class.
 236          *                              Therefore, this method always returns @c null.
 237          *      @remarks        The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method.
 238          */
 239         virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);
 240
 241 private:
 242
 243         //
 244         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 245         //
 246         // @since 2.0
 247         //
 248         Rc4Cipher(const Rc4Cipher& rhs);
 249
 250         //
 251         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 252         //
 253         // @since 2.0
 254         //
 255         Rc4Cipher& operator =(const Rc4Cipher& rhs);
 256
 257 private:
 258         _SymmetricCipher* __pSymmetricCipher;
 259         const evp_cipher_st* __pCipherAlgorithm;
 260         Tizen::Base::String __cipherAlgorithm;
 261
 262         class _Rc4CipherImpl* __pRc4CipherImpl;
 263         friend class _Rc4CipherImpl;
 264
 265 }; // Rc4Cipher
 266
 267 } } } // Tizen::Security::Crypto
 268
 269 #endif // _FSEC_CRYPTO_RC4_CIPHER_H_