//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class Pkcs08PrivateKeyInfo
- * @brief This class implements the functionalities specified by the Pkcs08 PrivateKeyInfo class.
- * This class represents the structure of Pkcs08 Private Key Info.
+ * @brief This class implements the functionalities specified by the %Pkcs08PrivateKeyInfo class.
*
- * It is defined in ASN.1 as:
+ * @since 2.1
+ *
+ * The %Pkcs08PrivateKeyInfo class implements the functionalities specified by the %Pkcs08PrivateKeyInfo class.
+ * This class represents the structure of Pkcs08 Private Key Info.
*
+ * This is defined in ASN.1 as demonstrated in the following code:
+ * @code
* PrivateKeyInfo ::= SEQUENCE {
* version Version,
* privateKeyAlgorithm AlgorithmIdentifier {{PrivateKeyAlgorithms}},
* privateKey PrivateKey,
* attributes [0] Attributes OPTIONAL }
- * @since 2.1
- *
+ * @endcode
*/
class _OSP_EXPORT_ Pkcs08PrivateKeyInfo
virtual ~Pkcs08PrivateKeyInfo(void);
/**
- * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer which contain @n
+ * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer that contains @n
* pkcs08 private key info structure(PrivateKeyInfo) in ASN.1 DER format. @n
- * It parses this encoded buffer and extracts the appropiate values of private key, its algorithm id and attributes.
+ * It parses this encoded buffer and extracts the appropriate values of private key, its algorithm ID, and attributes.
*
* @since 2.1
*
* @return An error code
- * @param[in] encodedData The instance of Bytebuffer, containing DER encoded PrivateKeyInfo structure.
+ * @param[in] encodedData An instance of Tizen::Base::ByteBuffer containing DER encoded PrivateKeyInfo 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);
/**
- * Initializes the %Pkcs08PrivateKeyInfo with supplied input parameters values.
+ * Initializes this instance of %Pkcs08PrivateKeyInfo with the values of the specified input parameters.
*
* @since 2.1
*
* @return An error code.
- * @param[in] keyAlgorithmId An instance of AlgorithIdentifier, holding algorithm identifier of private key algorithm.
- * @param[in] privateKey An instance of ByteBuffer holding privatekey.
+ * @param[in] keyAlgorithmId An instance of AlgorithmIdentifier holding algorithm identifier of the private key algorithm
+ * @param[in] privateKey An instance of Tizen::Base::ByteBuffer holding private key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
*/
result Construct(const AlgorithmIdentifier& keyAlgorithmId, const Tizen::Base::ByteBuffer& privateKey);
/**
- * This function will provide the implementation of GetVersion API to get the private key syntax version number of PrivateKeyInfo object @n
- * that is used for storing private key and its related information and default value of this version is 0.
+ * Gets the private key syntax version number of PrivateKeyInfo object @n
+ * that is used for storing private key and its related information and default value of this version is @c 0.
*
* @since 2.1
*
- * @return An integer valuse contains the version.
+ * @return An integer value that contains the version
*
*/
int GetVersion(void) const;
/**
- * Gets the reference to AlgorithmIdentifier which identifies the secret key algorithm.
+ * Gets the reference to AlgorithmIdentifier that identifies the secret key algorithm.
*
* @since 2.1
*
- * @return A reference to AlgorithmIdentifier Contains the algorithm identifier of Pkcs08PrivateKeyInfo object.
+ * @return A reference to AlgorithmIdentifier that contains the algorithm identifier of the %Pkcs08PrivateKeyInfo object
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const AlgorithmIdentifier& GetPrivateKeyAlgorithm(void) const;
/**
- * This function will provide the implementation of GetPrivateKeyN API to get the reference to ByteBuffer which contains
- * the private key in binary format.
+ * Gets the reference to Tizen::Base::ByteBuffer that contains the private key in binary format.
*
* @since 2.1
*
- * @return A reference to ByteBuffer Contains the private key of Pkcs08PrivateKeyInfo object.
+ * @return A reference to Tizen::Base::ByteBuffer that contains the private key of the %Pkcs08PrivateKeyInfo object
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::ByteBuffer& GetPrivateKey(void) const;
/**
- * This API will provide the implementation of GetAttributes API to get the Attributes of type Pkcs08Attribute which are extended @n
- * information of private key in context.
+ * Gets the attributes of the type Pkcs08Attribute that are extended information of the private key in context.
*
* @since 2.1
*
- * @return Reference to array list, contains the list of attributes of type Pkcs08Attribute.
+ * @return A reference to Tizen::Base::Collection::ArrayList that contains the list of attributes of type Pkcs08Attribute
*/
const Tizen::Base::Collection::ArrayList& GetAttributes(void) const;
/**
- * This function adds Attributes in private key info i.e. extended information of private key in context.
+ * Adds the attributes in private key information that is extended information of the private key in context.
*
* @since 2.1
*
* @return An error code
- * @param[in] attributes An instance of Pkcs08Attribute class..
+ * @param[in] attributes An instance of Pkcs08Attribute
*/
result AddAttribute(const Pkcs08Attribute& attributes);
/**
- * This function remove Attribute in private key info i.e. extended information of private key in context.
+ * Removes the attribute in private key information that is extended information of the private key in context.
*
* @since 2.1
*
* @return An error code
- * @param[in] attributes An instance of Pkcs08Attribute class.
+ * @param[in] attributes An instance of Pkcs08Attribute
*/
result RemoveAttribute(const Pkcs08Attribute& attributes);
/**
- * Gets the DER encoded Pkcs08PrivateKeyInfo structure.
+ * Gets the DER encoded %Pkcs08PrivateKeyInfo structure.
*
* @since 2.1
*
- * @return Pointer to ByteBuffer Contains the DER encoded private key info.
+ * @return A pointer to Tizen::Base::ByteBuffer that contains the DER encoded private key information
* @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.
projects / platform / framework / native / appfw.git / blobdiff