//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class Pkcs05PbKdf2Parameters
- * @brief This class implements the functionalities specified by the PKCS05 KDF2 scheme.
+ * @brief This class provides methods for the functionalities specified by the PKCS05 KDF2 scheme.
*
* @since 2.1
*
- * The %Pkcs05PbKdf2Parameters class implements the functionalities specified by the PKCS05 KDF2 scheme. PBKDF2 applies a pseudo random function to derive
- * keys. The length of the derived key is essentially unbounded. However, the maximum effective search space for the derived key can
- * be limited by the structure of the underlying pseudo random function.
+ * The %Pkcs05PbKdf2Parameters class provides methods for the functionalities specified by the PKCS05 KDF2 scheme. PBKDF2 applies a pseudo
+ * random function to derive keys. The length of the derived key is essentially unbounded. However, the maximum effective search
+ * space for the derived key can be limited by the structure of the underlying pseudo random function.
*
- * 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
* PBKDF2-params ::= SEQUENCE {
* salt CHOICE {
virtual ~Pkcs05PbKdf2Parameters(void);
/**
- * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::ByteBuffer that contains Password Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format.
- *
+ * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::ByteBuffer that contains Password
+ * Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format.
+ *
* @since 2.1
*
* @return An error code
- * @param[in] encodedData DER encoded Tizen::Base::ByteBuffer of %Pkcs05PbKdf2Parameters
- * @exception E_SUCCESS The method is successful.
+ * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer of %Pkcs05PbKdf2Parameters
+ * @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 %Pkcs05PbKdf2Parameters with specified input parameters values.
+ * Initializes the %Pkcs05PbKdf2Parameters with the specified input parameters values.
*
* @since 2.1
*
* @return An error code
- * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer, holding salt value
- * @param[in] iterationCount Integer value holding the positive integer specifying iteration count
- * for generation of password based key
- * @param[in] derivedKeyLength Positive integer specifying length of password based key to generate
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remark In this case, when pseudo random function algorithm is not passed, then default HMAC-SHA1 will be used.
+ * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer holding salt value
+ * @param[in] iterationCount The positive integer specifying iteration count for generation of password based key
+ * @param[in] derivedKeyLength The positive integer specifying the length of the password based key
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @remarks In this case, when pseudo random function algorithm is not passed, then default HMAC-SHA1 will be used.
*/
result Construct(const Tizen::Base::ByteBuffer& saltBuffer, int iterationCount, int derivedKeyLength = 0);
/**
- * Initializes this %Pkcs05PbKdf2Parameters with supplied input parameters values.
+ * Initializes this %Pkcs05PbKdf2Parameters instance with the specified input parameters values.
*
* @since 2.1
*
* @return An error code
- * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer, holding salt value
- * @param[in] iterationCount Integer value holding the positive integer specifying iteration count
- * for generation of password based key
- * @param[in] prf An instance of AlgorithIdentifier, holding the underlying pseudo random function to use to generate a password based key
- * @param[in] derivedKeyLength Positive integer specifying length of password based key to generate
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer holding salt value
+ * @param[in] iterationCount The positive integer specifying iteration count for generation of password based key
+ * @param[in] prf The AlgorithIdentifier instance holding the underlying pseudo random function to use
+ * to generate a password based key
+ * @param[in] derivedKeyLength The positive integer specifying the length of the password based key
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
*/
result Construct(const Tizen::Base::ByteBuffer& saltBuffer, int iterationCount, const AlgorithmIdentifier& prf, int derivedKeyLength = 0);
/**
- * Gets the encoded form of the %Pkcs05PbKdf2Parameters. @n
+ * Gets the encoded form of the %Pkcs05PbKdf2Parameters instance. @n
* It is assumed that each %Pkcs05PbKdf2Parameters will have only a single form of encoding, for example: ASN.1 DER.
*
* @since 2.1
*
- * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
+ * @return A pointer to the Tizen::Base::ByteBuffer instance 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.
*
* @since 2.1
*
- * @return A reference to salt Tizen::Base::ByteBuffer containing the specified salt value
+ * @return A reference to the Tizen::Base::ByteBuffer instance containing the specified salt value
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::ByteBuffer& GetSaltValue(void) const;
int GetDerivedKeyLength(void) const;
/**
- * Gets the reference to the AlgorithmIdentifier that identifies the underlying pseudo random function.
+ * Gets a reference to AlgorithmIdentifier that identifies the underlying pseudo random function.
*
* @since 2.1
*
/**
*
- * Gets the pointer to the AlgorithmParameters that identifies the underlying parameters such as PbKdf2,PbEs2,PbMac1. @n
- * For this class %AlgorithmParameters will be of PbKdf2 type.
+ * Gets a pointer to AlgorithmParameters that identifies the underlying parameters such as PbKdf2,PbEs2,PbMac1. @n
+ * For this class, %AlgorithmParameters will be of PbKdf2 type.
*
* @since 2.1
*
- * @return Pointer to IAlgorithmParameters containing the algorithm identifier of underlying pseudo random function, @n
+ * @return A pointer to IAlgorithmParameters containing the algorithm identifier of underlying pseudo random function, @n
* else @c null if an error occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
*
* @since 2.1
*
- * @return PkcsAlgorithmParameterType holding enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02 for KDF2 Parameters
+ * @return The PkcsAlgorithmParameterType instance holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02 for KDF2 Parameters
*/
virtual PkcsAlgorithmParameterType GetType(void) const;
*
* @return @c true if the specified instance equals the current instance, @n
* else @c false
- * @param[in] rhs An instance of %Pkcs05PbKdf2Parameters
+ * @param[in] rhs An instance of %Pkcs05PbKdf2Parameters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
projects / platform / framework / native / appfw.git / blobdiff