inc/FSecCryptoAesCipher.h

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