Flush app registry before releasing file lock
[platform/framework/native/appfw.git] / inc / FSecPkcsPkcs08EncryptedPrivateKeyInfo.h
index 6c132f7..3b6cc05 100755 (executable)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -38,9 +37,9 @@ namespace Tizen { namespace Security { namespace Pkcs
  * @since              2.1
  *
  * The %Pkcs08EncryptedPrivateKeyInfo class provides methods to encrypt a private key. An encrypted private key structure consist
- *                                     of an encryption algorithm and the encrypted Pkcs08PrivateKeyInfo.
+ * of an encryption algorithm and the encrypted Pkcs08PrivateKeyInfo.
  *
- *                             This is defined in ASN.1 as demonstrated in the following code:
+ * This is defined in ASN.1 as demonstrated in the following code:
  * @code
  *                             EncryptedPrivateKeyInfo ::= SEQUENCE {
  *                             encryptionAlgorithm AlgorithmIdentifier {{KeyEncryptionAlgorithms}},
@@ -69,15 +68,15 @@ public:
        virtual ~Pkcs08EncryptedPrivateKeyInfo(void);
 
        /**
-        * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::ByteBuffer that contains  @n
+        * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::ByteBuffer that contains
         * the EncryptedPrivateKeyInfo structure(EncryptedPrivateKeyInfo) in ASN.1 DER format.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                                     The DER encoded Tizen::Base::ByteBuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure
-        * @exception   E_SUCCESS                                               The method is successful.
-        * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
+        * @param[in]   encodedData                             The DER encoded Tizen::Base::ByteBuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::ByteBuffer& encodedData);
 
@@ -89,7 +88,7 @@ public:
         * @return              An error code
         * @param[in]   algorithmId                                     An instance of AlgorithmIdentifier
         * @param[in]   encryptedData                           An encrypted private key
-        * @exception   E_SUCCESS                                               The method is successful.
+        * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           A specified input parameter is invalid.
         */
        result Construct(const AlgorithmIdentifier& algorithmId, const Tizen::Base::ByteBuffer& encryptedData);
@@ -100,11 +99,11 @@ public:
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   algorithmId                                             An instance of AlgorithmIdentifier that identifies the secret key algorithm
-        * @param[in]   key                                                                             The key for encrypting privateKeyInfo
-        * @param[in]   encodedPrivateKeyInfo   An instance of Tizen::Base::ByteBuffer containing encoded privateKeyInfo
-        * @exception   E_SUCCESS                                                       The method is successful.
-        * @exception   E_INVALID_ARG                                   A specified input parameter is invalid.
+        * @param[in]   algorithmId                             An instance of AlgorithmIdentifier that identifies the secret key algorithm
+        * @param[in]   key                                             The key for encrypting PrivateKeyInfo
+        * @param[in]   encodedPrivateKeyInfo   An instance of Tizen::Base::ByteBuffer containing encoded PrivateKeyInfo
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_INVALID_ARG                   A specified input parameter is invalid.
         *
         */
        result Construct(const AlgorithmIdentifier& algorithmId, const Tizen::Base::ByteBuffer& key, const Tizen::Base::ByteBuffer& encodedPrivateKeyInfo);
@@ -137,11 +136,11 @@ public:
         *
         * @return              A pointer to Tizen::Base::ByteBuffer that contains the decrypted private key of the %Pkcs08EncryptedPrivateKeyInfo object, @n
         *                              else @c null if an error occurs
-        * @param[in]   key                             An instance of Tizen::Base::ByteBuffer holding a key to decrypt the private key using a particular @n
-        *                                                                                      secret key algorithm
-        * @exception   E_SUCCESS                                               The method is successful.
-        * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @exception   E_SYSTEM                                                The method cannot proceed due to a severe system error.
+        * @param[in]   key                             An instance of Tizen::Base::ByteBuffer holding a key to decrypt the private key using a particular
+        *                                                              secret key algorithm
+        * @exception   E_SUCCESS                               The method is successful.
+        * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
+        * @exception   E_SYSTEM                                The method cannot proceed due to a severe system error.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& key);
@@ -152,9 +151,9 @@ public:
         * @since               2.1
         *
         * @return              A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
-        *                                              else @c null if an error occurs
-        * @exception   E_SUCCESS                                               The method is successful.
-        * @exception   E_SYSTEM                                                The method cannot proceed due to a severe system error.
+        *                              else @c null if an error occurs
+        * @exception   E_SUCCESS                                       The method is successful.
+        * @exception   E_SYSTEM                                        The method cannot proceed due to a severe system error.
         * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        Tizen::Base::ByteBuffer* GetEncodedDataN(void) const;