//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class Pkcs05PbMacParameters
- * @brief This class implements the functionalities specified by the Pkcs05 MAC scheme.
- * PBMAC1 combines a password-based key derivation function, which shall be PBKDF2
- * for this version of PKCS #5, with an underlying message authentication
- * scheme. The key length and any other parameters for
- * the underlying message authentication scheme depend on the scheme.
+ * @brief This class provides methods for the functionalities specified by the PKCS05 MAC scheme.
*
- * It is defined in ASN.1 as:
+ * @since 2.1
+ *
+ * The %Pkcs05PbMacParameters class implements the functionalities specified by the PKCS05 MAC scheme.
+ * PBMAC1 combines a password-based key derivation function, which will be PBKDF2 for this version of PKCS #5, with an underlying
+ * message authentication scheme. The key length and any other parameters for the underlying message authentication scheme depend
+ * on the scheme.
*
+ * This is defined in ASN.1 as demonstrated in the following code:
+ * @code
* PBMAC1-params ::= SEQUENCE {
* keyDerivationFunc AlgorithmIdentifier {{PBMAC1-KDFs}},
* messageAuthScheme AlgorithmIdentifier {{PBMAC1-MACs}} }
- * @since 2.1
+ * @endcode
*
*/
virtual ~Pkcs05PbMacParameters(void);
/**
- * Initializes this instance of %Pkcs05PbMacParameters with the Bytebuffer which contain Password based message @n
- * authentication parameters structure(PBMAC1) in ASN.1 DER format.
+ * Initializes this instance of %Pkcs05PbMacParameters with the Tizen::Base::ByteBuffer instance that contains Password Based Message
+ * Authentication Cryptography parameters structure(PBMAC1) in ASN.1 DER format.
*
* @since 2.1
*
* @return An error code
- * @param[in] encodedData DER encoded Bytebuffer contains Pkcs05PbMacParameters.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing %Pkcs05PbMacParameters.
+ * @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 %Pkcs05PbMacParameters with supplied input parameters values.
+ * Initializes this %Pkcs05PbMacParameters with specified input parameter values.
*
* @since 2.1
*
* @return An error code
- * @param[in] keyDerivationFunc An instance of AlgorithmIdentifier, holding key derivation function.
- * @param[in] messageAuthScheme An instance of AlgorithmIdentifier, holding message authentication scheme.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] keyDerivationFunc An instance of AlgorithmIdentifier holding key derivation function
+ * @param[in] messageAuthScheme An instance of AlgorithmIdentifier holding message authentication scheme
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
*/
result Construct(const AlgorithmIdentifier& keyDerivationFunc, const AlgorithmIdentifier& messageAuthScheme);
/**
- * Gets the encoded form of the Pkcs05PbMacParameters.
- * It is assumed that each Pkcs05PbMacParameters will have only a single form of encoding example ASN.1 DER.
+ * Gets the encoded form of the %Pkcs05PbMacParameters instance. @n
+ * It is assumed that each %Pkcs05PbMacParameters will have only a single form of encoding, for example ASN.1 DER.
*
* @since 2.1
*
- * @return A pointer to the ByteBuffer class that contains the output, @n
- * else @c null if an error occurs.
+ * @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.
* @remarks The specific error code can be accessed using the GetLastResult() method.
Tizen::Base::ByteBuffer* GetEncodedDataN(void) const;
/**
- * Get the reference to the AlgorithmIdentifier instance which identifies the underlying key derivation function.
- * It shall be an algorithm ID with an OID in the set PBES2-KDFs, which for this version of PKCS #5 shall consist of id-PBKDF2.
+ * Gets a reference to the AlgorithmIdentifier instance that identifies the underlying key derivation function. @n
+ * It will be an algorithm ID with an OID in the set PBES2-KDFs, which for this version of PKCS #5 will consist of ID-PBKDF2.
*
* @since 2.1
*
- * @return A reference to AlgorithmIdentifier holding the underlying key derivation function.
+ * @return A reference to the AlgorithmIdentifier instance holding the underlying key derivation function.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const AlgorithmIdentifier& GetKeyDerivationAlgorithm(void) const;
/**
- * This function implements GetMacAlgorithm API which returns the algorithm identifier which identifies the underlying
- * MAC algorithm. It shall be an OID like OID_HMAC_SHA1 or OID_HMAC_SHA2_224 etc.
+ * Gets the algorithm identifier that identifies the underlying MAC algorithm. @n
+ * It shall be an OID like ::OID_HMAC_SHA1 or ::OID_HMAC_SHA2_224, and so on.
*
* @since 2.1
*
- * @return A reference to AlgorithmIdentifier holding the underlying MAC algorithm.
+ * @return A reference to the AlgorithmIdentifier instance holding the underlying MAC algorithm
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const AlgorithmIdentifier& GetMacAlgorithm(void) const;
/**
- * Get the AlgorithmParameters which identifies the underlying Parameters like PbKdf2,PbEs2,PbMac1.
- * For this class AlgorithmParameters will be of PbMac1 type.
+ * Gets the AlgorithmParameters that identifies the underlying Parameters such as PbKdf2, PbEs2, PbMac1. @n
+ * For this class, %AlgorithmParameters will be of PbMac1 type.
*
* @since 2.1
*
- * @return A pointer to IAlgorithmParameters Containing the algorithm identifier of underlying pseudo random function.
+ * @return A pointer to the IAlgorithmParameters instance containing the algorithm identifier of underlying pseudo random function
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IAlgorithmParameters* CloneN(void) const;
/**
- * Get the PkcsAlgorithmParameterType value.
+ * Gets the PkcsAlgorithmParameterType value.
*
* @since 2.1
*
- * @return PkcsAlgorithmParameterType holding enum value PKCS_ALGO_PARAM_TYPE_PKCS05_MAC for PBMAC Parameters.
+ * @return An instance of PkcsAlgorithmParameterType holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_MAC for PBMAC parameters
*/
virtual PkcsAlgorithmParameterType GetType(void) const;
* else @c false
* @param[in] rhs An instance of %Pkcs05PbMacParameters
* @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