inc/FSecCryptoAesCipher.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           FSecCryptoAesCipher.h
  20  *      @brief          This is the header file for the %AesCipher class.
  21  *
  22  *      This header file contains the declarations of the %AesCipher class.
  23  */
  24 #ifndef _FSEC_CRYPTO_AES_CIPHER_H_
  25 #define _FSEC_CRYPTO_AES_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          AesCipher
  38  *      @brief          This class provides methods for encryption and decryption using the Advanced Encryption Standard (AES) method.
  39  *
  40  * @since       2.0
  41  *
  42  *      The %AesCipher class provides a symmetric cipher using the Advanced Encryption Standard (AES) method.
  43  *      Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (CIPHER_ENCRYPT, CIPHER_DECRYPT, CIPHER_WRAP, or CIPHER_UNWRAP) 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_ AesCipher
  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         AesCipher(void);
  64
  65         /**
  66          *      This destructor overrides Tizen::Base::Object::~Object().
  67          *
  68          *      @since          2.0
  69          */
  70         virtual ~AesCipher(void);
  71
  72         /**
  73          *      Initializes this instance of %AesCipher with the specified parameters.
  74          *
  75          *      @since          2.0
  76          *
  77          *      @return         An error code
  78          *      @param[in]      transformation                  The name of the requested mode/key bit/padding scheme @n
  79          *                                                                              For example, "CBC/128/NOPADDING" or "CBC/192/NOPADDING".
  80          *      @param[in]      opMode                                  The cipher operation mode @n
  81          *                                                                              For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP.
  82          *      @exception      E_SUCCESS                               The method is successful.
  83          *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
  84          *      @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.
  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.
  87          */
  88         virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode);
  89
  90         /**
  91          *      Sets a symmetric key for encryption or decryption.
  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          */
 173         virtual result Initialize(void);
 174
 175         /**
 176          *      Updates a multiple-part encryption or decryption operation.
 177          *
 178          *      @since          2.0
 179          *
 180          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 181          *                              else @c null if an error occurs
 182          *      @param[in]      input                                   An instance of Tizen::Base::ByteBuffer
 183          *      @exception      E_SUCCESS                               The method is successful.
 184          *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
 185          *      @exception      E_OVERFLOW                              This operation has caused the memory to overflow.
 186          *      @exception      E_INVALID_ARG                   The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
 187          *      @exception      E_SYSTEM                                A system error has occurred. @n
 188          *                                                                              The method has failed to operate with the openssl library, or
 189          *                                                                              the Tizen::Base::ByteBuffer operation has failed.
 190          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 191          */
 192         virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input);
 193
 194         /**
 195          *      Finalizes a multiple-part encryption or decryption operation.
 196          *
 197          *      @since          2.0
 198          *
 199          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 200          *                              else @c null if an error occurs
 201          *      @exception      E_SUCCESS                               The method is successful.
 202          *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
 203          *      @exception      E_OVERFLOW                              This operation has caused the memory to overflow.
 204          *      @exception      E_SYSTEM                                A system error has occurred. @n
 205          *                                                                              The method has failed to operate with the openssl library, or
 206          *                                                                              the Tizen::Base::ByteBuffer operation has failed.
 207          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 208          */
 209         virtual Tizen::Base::ByteBuffer* FinalizeN(void);
 210
 211         /**
 212          *      Wraps a key.
 213          *
 214          *      @since          2.0
 215          *
 216          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 217          *                              else @c null if an error occurs
 218          *      @param[in]      secretKey                                       The secret key to wrap
 219          *      @exception      E_SUCCESS                                       The method is successful.
 220          *      @exception      E_INVALID_ARG                           The specified instance of Tizen::Base::ByteBuffer is invalid or empty.
 221          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 222          *      @exception      E_KEY_NOT_FOUND                         The specified key is not found.
 223          *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
 224          *      @exception      E_UNSUPPORTED_ALGORITHM         The specified cipher algorithm for this method is invalid.
 225          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 226          *                                                                                      The method has failed to operate with the openssl library.
 227          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 228          *      @remarks        A key is set using SetKey() before calling this method.
 229          */
 230         virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
 231
 232         /**
 233          *      Unwraps a previously wrapped key.
 234          *
 235          *      @since          2.0
 236          *
 237          *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
 238          *                              else @c null if an error occurs
 239          *      @param[in]      wrappedKey                                      The wrapped key to unwrap
 240          *      @exception      E_SUCCESS                                       The method is successful.
 241          *      @exception      E_INVALID_ARG                           The specified instance of Tizen::Base::ByteBuffer is invalid.
 242          *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
 243          *      @exception      E_KEY_NOT_FOUND                         The specified key is not found.
 244          *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
 245          *      @exception      E_UNSUPPORTED_ALGORITHM         The specified cipher algorithm for this method is invalid.
 246          *      @exception      E_SYSTEM                                        A system error has occurred. @n
 247          *                                                                                      The method has failed to operate with the openssl library.
 248          *      @remarks        The specific error code can be accessed using the GetLastResult() method.
 249          *      @remarks        A key is set using SetKey() before calling this method.
 250          */
 251         virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);
 252
 253 private:
 254
 255         //
 256         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 257         //
 258         // @since 2.0
 259         //
 260         AesCipher(const AesCipher& rhs);
 261
 262         //
 263         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 264         //
 265         // @since 2.0
 266         //
 267         AesCipher& operator =(const AesCipher& rhs);
 268
 269 private:
 270         _SymmetricCipher* __pSymmetricCipher;
 271         const evp_cipher_st* __pCipherAlgorithm;
 272         Tizen::Base::String __cipherAlgorithm;
 273
 274         class _AesCipherImpl* __pAesCipherImpl;
 275         friend class _AesCipherImpl;
 276
 277 }; //AesCipher
 278
 279 } } } //Tizen::Security:Crypto
 280
 281 #endif //_FSEC_CRYPTO_AES_CIPHER_H_