//
/**
- * @file FSecCryptoISymmetricCipher.h
+ * @file FSecCryptoISymmetricCipher.h
* @brief This is the header file for the %ISymmetricCipher interface.
*
* This header file contains the declarations of the %ISymmetricCipher interface.
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
- * are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] transformation The name of the requested mode or key bit or padding scheme
+ * @param[in] transformation The requested mode or key bit or padding scheme
* @param[in] opMode The cipher operation mode @n
* For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP.
* @exception E_SUCCESS The method is successful.
virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode = Tizen::Security::Crypto::CIPHER_ENCRYPT) = 0;
/**
- * Sets a symmetric key for encryption or decryption.
+ * Sets the symmetric key for encryption or decryption.
*
* @since 2.0
*
* @return An error code
- * @param[in] key An instance of ISecretKey
+ * @param[in] key An instance of ISecretKey to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c key is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @since 2.0
*
* @return An error code
- * @param[in] initialVector The initial vector
+ * @param[in] initialVector The initial vector to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_KEY_NOT_FOUND The key is not found.
* @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
* @exception E_OVERFLOW This operation has caused the memory to overflow.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
*/
virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0;
* @exception E_KEY_NOT_FOUND The key is not found.
* @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
* @exception E_OVERFLOW This operation has caused the memory to overflow.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
*/
virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0;
/**
- * Initializes a multiple-part encryption or decryption operation.
+ * Initializes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
+ *
*
* @since 2.0
*
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_KEY_NOT_FOUND The key is not found.
* @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
*/
virtual result Initialize(void) = 0;
/**
- * Updates a multiple-part encryption or decryption operation.
+ * Updates the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
*
* @since 2.0
*
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OVERFLOW This operation has caused the memory to overflow.
* @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input) = 0;
/**
- * Finalizes a multiple-part encryption or decryption operation.
+ * Finalizes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OVERFLOW This operation has caused the memory to overflow.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0;
/**
- * Wraps the specified key.
+ * Wraps a key.
*
* @since 2.0
*
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_KEY_NOT_FOUND The key is not found.
* @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
* - This operation is only supported in AesCipher.
*/
virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey) = 0;
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_KEY_NOT_FOUND The key is not found.
* @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid.
- * @exception E_SYSTEM A system error has occurred. @n
- * The method has failed to operate with the openssl library, or
- * the Tizen::Base::ByteBuffer operation has failed.
+ * @exception E_SYSTEM Either of the following conditions has occurred:
+ * - A system error has occurred.
+ * - The method has failed to operate with the openssl library.
+ * - The Tizen::Base::ByteBuffer operation has failed.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - This operation is only supported in AesCipher.
projects / platform / framework / native / appfw.git / blobdiff