Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FSecCryptoRsaCipher.h
old mode 100644 (file)
new mode 100755 (executable)
index 857ef9f..431081d
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -69,13 +68,13 @@ public:
        virtual ~RsaCipher(void);
 
        /**
-        *      Sets an asymmetric private key for encryption or decryption.
+        *      Sets the asymmetric private key for encryption or decryption.
         *
         *      @since          2.0
         *
         *      @return         An error code
-        *      @param[in]      key                                             An instance of IKey
-        *                                                                              Key can be in PEM/DER/PKCS8 format only.
+        *      @param[in]      key                                             An instance of IKey @n
+        *                                                                              The @c key can be in PEM/DER/PKCS8 format only.
         *      @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.
@@ -83,13 +82,13 @@ public:
        virtual result SetPrivateKey(const Tizen::Security::IKey& key);
 
        /**
-        *      Sets an asymmetric public key for encryption or decryption.
+        *      Sets the asymmetric public key for encryption or decryption.
         *
         *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      key                                             An instance of IKey
-        *                                                                              Key can be in PEM/DER/X509 public key format only.
+        *                                                                              The @c key can be in PEM/DER/X509 public key format only.
         *      @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.
@@ -110,10 +109,11 @@ public:
         *      @exception      E_UNSUPPORTED_ALGORITHM The algorithm is not supported.
         *      @exception      E_OVERFLOW                              This operation has caused the memory to overflow.
         *      @exception      E_KEY_NOT_FOUND                 The specified key is not found.
-        *      @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* EncryptN(const Tizen::Base::ByteBuffer& input);
 
@@ -124,17 +124,18 @@ public:
         *
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
-        *  @param[in]  input                                   An instance of Tizen::Base::ByteBuffer
+        *      @param[in]      input                                   An instance of Tizen::Base::ByteBuffer
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   The input Tizen::Base::ByteBuffer is empty or contains invalid data.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_UNSUPPORTED_ALGORITHM The algorithm is not supported.
         *      @exception      E_OVERFLOW                              This operation has caused the memory to overflow.
         *      @exception      E_KEY_NOT_FOUND                 The specified key is not found.
-        *      @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* DecryptN(const Tizen::Base::ByteBuffer& input);