From: so.yu Date: Thu, 24 Oct 2013 08:55:21 +0000 (+0900) Subject: Apply reviewed doxygen header X-Git-Tag: submit/tizen/20131210.080830^2^2~26^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fdf5072507c9670d32f378f0a7dbd24ab7bd6b49;p=platform%2Fframework%2Fnative%2Fappfw.git Apply reviewed doxygen header Change-Id: I85b75235062020f6750e3a716f51689235d2e4cd Signed-off-by: so.yu --- diff --git a/inc/FSecAccessController.h b/inc/FSecAccessController.h index 3d66c65..d07843b 100644 --- a/inc/FSecAccessController.h +++ b/inc/FSecAccessController.h @@ -34,10 +34,10 @@ class _PrivilegeManager; /** * @class AccessController - * @brief This class provides a way to check the privilege of privileged API. + * @brief This class provides methods to check the privilege of privileged API. * @since 2.0 * - * The %AccessController class provides a way to check the privilege of privileged API. + * The %AccessController class provides methods to check the privilege of privileged API. */ class _OSP_EXPORT_ AccessController { @@ -54,7 +54,7 @@ public: * @exception E_DATA_NOT_FOUND The privilege information does not exist. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM An unexpected system error has occurred. */ static result CheckPrivilege(int privilege); @@ -69,27 +69,27 @@ public: * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string. * @exception E_DATA_NOT_FOUND The privilege information does not exist. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result CheckPrivilege(const Tizen::Base::String& privilege); /** - * Checks whether the client application which has @c packageId has a privilege to invoke the privileged API. + * Checks whether the client application with the specified @c packageId has a privilege to invoke the privileged API. * * @since 2.1 * @privlevel partner * @privilege %http://tizen.org/privilege/privilegemanager.read * * @return An error code - * @param[in] packageId The package ID + * @param[in] packageId The package ID * @param[in] privilege A string of the specified privilege * @exception E_SUCCESS The method is successful and the request is granted. * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string. * @exception E_DATA_NOT_FOUND The privilege information does not exist. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result CheckPrivilege(const Tizen::App::PackageId& packageId, const Tizen::Base::String& privilege); diff --git a/inc/FSecAesSecureRandom.h b/inc/FSecAesSecureRandom.h index 03641ac..f49b0f6 100644 --- a/inc/FSecAesSecureRandom.h +++ b/inc/FSecAesSecureRandom.h @@ -15,7 +15,7 @@ // /** - * @file FSecAesSecureRandom.h + * @file FSecAesSecureRandom.h * @brief This is the header file for the %AesSecureRandom class. * * This header file contains the declarations of the %AesSecureRandom class. @@ -70,12 +70,12 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @param[in] numBytes The number of random bytes to generate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes); diff --git a/inc/FSecCert.h b/inc/FSecCert.h index 704a82e..e4a5344 100644 --- a/inc/FSecCert.h +++ b/inc/FSecCert.h @@ -15,7 +15,7 @@ // /** - * @file FSecCert.h + * @file FSecCert.h * @brief This is the header file for the %Cert namespace. * * This header file contains the declarations and descriptions of the %Cert namespace. @@ -39,7 +39,7 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Cert namespace contains classes and interfaces for managing certificates, by getting information from security certificates and validating their paths. @n * diff --git a/inc/FSecCertICertificate.h b/inc/FSecCertICertificate.h index 68e481c..dd17a75 100755 --- a/inc/FSecCertICertificate.h +++ b/inc/FSecCertICertificate.h @@ -33,31 +33,31 @@ namespace Tizen { namespace Security { namespace Cert /** * @enum CertificateType * - * Defines the type of certificate. + * Defines the type of security certificate. * * @since 2.0 */ enum CertificateType { ROOT_CA, /**< The Factory-supplied certificates for SSL: ROOT CA */ - OPERATOR_DOMAIN, /**< The Operator Domain */ - TRUSTED_THIRD_PARTY_DOMAIN, /**< The Trusted Third Party Domain */ - USER_CERT, /**< The User Certificates */ - UNKNOWN_TYPE = 10, /**< The unknown type */ + OPERATOR_DOMAIN, /**< The operator domain certificate */ + TRUSTED_THIRD_PARTY_DOMAIN, /**< The trusted third party domain certificate*/ + USER_CERT, /**< The user certificate */ + UNKNOWN_TYPE = 10, /**< The unknown type certificate*/ }; //CertificateType /** * @enum ValidityPeriod * - * Defines the validity period. + * Defines the certificate validity period. * * @since 2.0 */ enum ValidityPeriod { - VALIDITY_PERIOD_VALID, /**< The validity period */ - VALIDITY_PERIOD_EXPIRED, /**< The expiry period */ - VALIDITY_PERIOD_NOT_YET_VALID, /**< The period that is not yet valid */ + VALIDITY_PERIOD_VALID, /**< The certificate is valid */ + VALIDITY_PERIOD_EXPIRED, /**< The certificate has expired */ + VALIDITY_PERIOD_NOT_YET_VALID, /**< The certificate period is not yet valid */ }; //ValidityPeriod /** @@ -66,8 +66,9 @@ enum ValidityPeriod * * @since 2.0 * - * The %ICertificate interface is an abstraction for certificates having different formats. For example, different types of certificates, such as X.509 and PGP, share - * general functionalities, namely encoding and verifying, and some type of information like public keys. Despite containing different sets of information and having different ways for storing, and retrieving them, + * The %ICertificate interface is an abstraction for certificates having different formats. For example, different types of + * certificates, such as X.509 and PGP, share general functionalities, namely encoding and verifying, and information like + * public keys. Despite containing different sets of information and having different ways for storing and retrieving them, * the X.509, X.968, and WTLS certificates can all be implemented by using the %ICertificate interface. * * An identity certificate is a binding of a principal to a public key, which is vouched for by another principal. @@ -184,7 +185,7 @@ public: * * @since 2.0 * - * @return The format of this certificate + * @return The certificate format */ virtual Tizen::Base::String GetFormat(void) const = 0; @@ -193,11 +194,12 @@ public: * * @since 2.0 * - * @return The type of this certificate + * @return The certificate type * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual CertificateType GetType(void) const = 0; @@ -211,16 +213,17 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation 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 certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedDataN(void) const = 0; /** * Gets the fingerprint of the certificate. @n - * It is the hashed value of the encoding of the certificate. + * It is the hash value of the encoding of the certificate. * * @since 2.0 * @@ -228,10 +231,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation 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 certificate parsing operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetFingerprintN(void) const = 0; @@ -246,9 +250,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c publicKey is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing 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 certificate parsing operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Verify(const Tizen::Security::IPublicKey& publicKey) = 0; @@ -262,16 +267,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * 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 Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::IPublicKey* GetPublicKeyN(void) const = 0; /** - * Gets the @c serialNumber value from the certificate. @n - * The serial number is an integer assigned by the Certification Authority (CA) to each certificate. It is unique for each certificate issued by a - * given CA (that is, the issuer name and serial number must identify a unique certificate). @n + * Gets the serial number of the certificate. @n + * The serial number is a unique integer assigned by the Certification Authority (CA) to each certificate (that is, the issuer name and serial number + * must identify a unique certificate). @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -281,23 +287,25 @@ public: * CertificateSerialNumber ::= INTEGER * @endcode * - * Since the serial number can be greater than the system's maximum value for @c int, the output parameter type is @c ByteBuffer, instead of @c int. + * Since the serial number can be greater than the system's maximum defined value for @c int, the output parameter type + * is @c ByteBuffer, instead of @c int. * * @since 2.0 * * @return The serial number of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate serial number information. - * @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 get the certificate serial number information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSerialNumber(void) const = 0; /** * Checks whether the certificate is currently valid. @n - * It is valid if the current date and time are within the validity period given in the certificate. @n - * The validity period consists of two date and time values: the initial date and time, and the final date and time until the validity of the certificate. @n + * It is valid if the current date and time are within the validity period of the certificate. The validity period consists + * of two date and time values: the initial date and time, and the final date and time for the validity of the certificate. @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -313,29 +321,31 @@ public: * generalTime GeneralizedTime } * @endcode * - * @since 2.0 + * @since 2.0 * * @return The validity period of the certificate * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual ValidityPeriod CheckValidityPeriod(void) = 0; /** * Gets the notBefore value of Tizen::Base::String type from the validity period of the certificate. @n - * This value represents the date and time before which the certificate is not valid. + * This value represents the date and time before which the certificate is not valid. * * @since 2.0 * * @return A string representing the date and time value before which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. - * @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 get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod() for relevant ASN.1 definitions */ virtual Tizen::Base::String GetNotBefore(void) const = 0; @@ -343,16 +353,17 @@ public: /** * Gets the notAfter value of Tizen::Base::String type from the validity period of the certificate. @n - * This value represents the date and time after which the certificate is not valid. + * This value represents the date and time after which the certificate is not valid. * * @since 2.0 * * @return A string representing the date and time value after which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. - * @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 get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod() for relevant ASN.1 definitions */ virtual Tizen::Base::String GetNotAfter(void) const = 0; @@ -365,9 +376,10 @@ public: * @return The name of the issuer of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @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 get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetIssuer(void) const = 0; @@ -379,9 +391,10 @@ public: * @return The subject name of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @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 get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSubject(void) const = 0; @@ -394,10 +407,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation 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 certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetSignatureN(void) const = 0; diff --git a/inc/FSecCertICertificatePath.h b/inc/FSecCertICertificatePath.h index 5df9bac..89204b0 100644 --- a/inc/FSecCertICertificatePath.h +++ b/inc/FSecCertICertificatePath.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertICertificatePath.h + * @file FSecCertICertificatePath.h * @brief This is the header file for the %ICertificatePath interface. * * This header file contains the declarations of the %ICertificatePath interface. @@ -33,11 +33,11 @@ namespace Tizen { namespace Security { namespace Cert class ICertificatePathValidationResult; /** * @interface ICertificatePath - * @brief This interface validates the certificate path and gets more information about it. + * @brief This interface provides methods for validating the certificate path and get information about it. * * @since 2.0 * - * The %ICertificatePath interface validates the certificate path and gets more information about it. @n + * The %ICertificatePath interface provides methods for validating the certificate path and get information about it. @n * * For more information on the class features, see Certificates. @n * @@ -212,7 +212,7 @@ public: virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Adds a certificate to the certificate chain. + * Adds the specified certificate to the certificate chain. * The order of certificates should be as follows: @n * 1. User certificate. * 2. Intermediate certificate. @@ -221,25 +221,27 @@ public: * @since 2.0 * * @return An error code - * @param[in] certificate A reference to a certificate + * @param[in] certificate A reference to the certificate to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual result AddCertificate(const Tizen::Security::Cert::ICertificate& certificate) = 0; /** * Validates the specified certificate path. * - * @since 2.0 + * @since 2.0 * - * @return The result of the certificate path validation + * @return The result of the certificate path validation * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(void) = 0; @@ -249,20 +251,21 @@ public: * @since 2.0 * * @return The result of the certificate path validation - * @param[in] trustAnchor The most trusted Certificate Authority (CA) + * @param[in] trustAnchor The trusted Certificate Authority (CA) * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(const Tizen::Security::Cert::ICertificate& trustAnchor) = 0; /** * Gets the trust anchor for the certificate path. * - * @since 2.0 + * @since 2.0 * * @return The root certificate, @n * else @c null if an error occurs @@ -270,9 +273,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * Either of the following conditions has occurred: + * - The certificate link list operation. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetTrustAnchorN(void) const = 0; @@ -284,15 +288,16 @@ public: * @return The length of the certificate path, @n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate list is empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate list is empty. */ virtual int GetLength(void) const = 0; /** * Gets the list of certificates in this certificate path. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the ICertificate interface, @n * else @c null if an error occurs @@ -302,9 +307,10 @@ public: * @exception E_INVALID_ARG The value of the specified @c nth is out of the valid range. @n * It must be less than the value retrieved by the GetLength() method. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate list is empty. - * @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 certificate list is empty. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetCertificateN(int nth) const = 0; diff --git a/inc/FSecCertICertificateSelector.h b/inc/FSecCertICertificateSelector.h index 5afd6b6..13cccc4 100644 --- a/inc/FSecCertICertificateSelector.h +++ b/inc/FSecCertICertificateSelector.h @@ -31,12 +31,12 @@ namespace Tizen { namespace Security { namespace Cert /** * @interface ICertificateSelector - * @brief This interface is a selector that defines a set of criterion for selecting certificates. + * @brief This interface is a selector that defines a set of criterion for selecting certificates. * * @since 2.0 * * The %ICertificateSelector interface is a selector that defines a set of criterion for selecting certificates. - * The classes that implement this interface are used to specify the certificates, which must be retrieved from a certificate store. @n + * The classes that implement this interface are used to specify the certificates, which must be retrieved from a certificate store. @n * * For more information on the class features, see Certificates. * diff --git a/inc/FSecCertICertificateStore.h b/inc/FSecCertICertificateStore.h index 897ffe0..e964ec4 100644 --- a/inc/FSecCertICertificateStore.h +++ b/inc/FSecCertICertificateStore.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Security { namespace Cert /** * @interface ICertificateStore - * @brief This is the interface for retrieving and managing the certificates from a repository. + * @brief This interface provides methods for retrieving and managing the certificates from a repository. * * @since 2.0 * @@ -71,11 +71,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] selector A selector that defines a set of criterion for selecting certificates + * @param[in] selector The selector that defines a set of criterion for selecting certificates * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The IPC operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The IPC operation has failed. * @exception E_INVALID_ARG The specified @c selector is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ @@ -94,18 +95,19 @@ public: virtual result GetCertificateCount(int& count) const = 0; /** - * Gets each certificate that matches the specified selector. + * Gets the certificate that matches the specified selector. * * @since 2.0 * - * @return The certificates that match the specified selector + * @return The certificate that matches the specified selector * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetNextCertificateN(void) const = 0; @@ -119,10 +121,12 @@ public: * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Insert(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate) = 0; @@ -138,11 +142,13 @@ public: * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Update(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& oldCert, const Tizen::Security::Cert::ICertificate& newCert) = 0; @@ -157,11 +163,13 @@ public: * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Remove(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate) = 0; diff --git a/inc/FSecCertTypes.h b/inc/FSecCertTypes.h index 79c904f..e7c80c8 100644 --- a/inc/FSecCertTypes.h +++ b/inc/FSecCertTypes.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertTypes.h + * @file FSecCertTypes.h * @brief This is the header file for the %CertTypes definitions. * * This header file contains the %CertTypes definitions. @@ -35,12 +35,12 @@ namespace Tizen { namespace Security { namespace Cert */ enum ValidationResult { - VALIDATION_SUCCESS = 0, /**< Success */ + VALIDATION_SUCCESS = 0, /**< The validation is a success */ VALIDATION_ERROR_INVALID_PATH, /**< The certificate path does not validate */ - VALIDATION_ERROR_NO_ROOT, /**< The root certificate is not found */ + VALIDATION_ERROR_NO_ROOT, /**< The root certificate is not found */ VALIDATION_ERROR_CERT_EXPIRED, /**< The certificate date falls outside the validity period */ VALIDATION_ERROR_CERT_REVOKED, /**< The certificate has been revoked */ - VALIDATION_ERROR_INVALID_SIGNATURE, /**< The signature is not valid */ + VALIDATION_ERROR_INVALID_SIGNATURE, /**< The signature is not valid */ }; //ValidationResult diff --git a/inc/FSecCertX509Certificate.h b/inc/FSecCertX509Certificate.h index dca0d2c..b1dfee8 100755 --- a/inc/FSecCertX509Certificate.h +++ b/inc/FSecCertX509Certificate.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertX509Certificate.h + * @file FSecCertX509Certificate.h * @brief This is the header file for the %X509Certificate class. * * This header file contains the declarations of the %X509Certificate class. @@ -31,11 +31,11 @@ namespace Tizen { namespace Security { namespace Cert /** * @class X509Certificate - * @brief This class is used for managing a variety of identity certificates. + * @brief This class provides methods for managing identity certificates. * * @since 2.0 * - * The %X509Certificate class is used for managing a variety of identity certificates. @n + * The %X509Certificate class provides methods for managing identity certificates. @n * * For more information on the class features, see Certificates. * @@ -70,17 +70,18 @@ public: * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. */ result Construct(const Tizen::Base::ByteBuffer& input); /** - * Gets the format name for this certificate. + * Gets the format of this certificate. * * @since 2.0 * - * @return The format of this certificate + * @return The certificate format */ virtual Tizen::Base::String GetFormat(void) const; @@ -91,15 +92,17 @@ public: * * @return The certificate type * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual CertificateType GetType(void) const; /** * Gets the encoded form of the certificate. @n - * It is assumed that each certificate type will have only a single form of encoding. For example, X.509 certificates will be encoded as ASN.1 DER. + * It is assumed that each certificate type will have only a single form of encoding. For example, X.509 certificates will + * be encoded as ASN.1 DER. * * @since 2.0 * @@ -107,16 +110,17 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation 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 certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** * Gets the fingerprint of the certificate. @n - * It is the hashed value of the encoding of the certificate. + * It is the hash value of the encoding of the certificate. * * @since 2.0 * @@ -124,10 +128,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation 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 certificate parsing operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetFingerprintN(void) const; @@ -142,9 +147,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c publicKey is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing 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 certificate parsing operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Verify(const Tizen::Security::IPublicKey& publicKey); @@ -158,9 +164,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * 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 Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::IPublicKey* GetPublicKeyN(void) const; @@ -182,9 +189,9 @@ public: int GetSpecVersion(void) const; /** - * Gets the serial number value from the certificate. @n - * The serial number is an integer assigned by the Certification Authority (CA) to each certificate. It is unique for each certificate issued by a given - * CA (that is, the issuer name and serial number must identify a unique certificate). @n + * Gets the serial number of the certificate. @n + * The serial number is a unique integer assigned by the Certification Authority (CA) to each certificate (that is, + * the issuer name and serial number must identify a unique certificate). @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -194,21 +201,22 @@ public: * CertificateSerialNumber ::= INTEGER * @endcode * - * This serial number can be greater than the system's maximum defined value for @c int, the output parameter type is @c ByteBuffer, instead of @c int. + * Since the serial number can be greater than the system's maximum defined value for @c int, the output parameter type + * is @c ByteBuffer, instead of @c int. * - * @since 2.0 + * @since 2.0 * * @return The serial number of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSerialNumber(void) const; /** * Checks whether the certificate is currently valid. @n - * It is valid if the current date and time are within the validity period given in the certificate. The validity period consists of two date and time - * values: the initial date and time, and the final date and time until the validity of the certificate. @n + * It is valid if the current date and time are within the validity period of the certificate. The validity period consists + * of two date and time values: the initial date and time, and the final date and time for the validity of the certificate. @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -228,9 +236,10 @@ public: * * @return The validity period of the certificate * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual ValidityPeriod CheckValidityPeriod(void); @@ -238,15 +247,16 @@ public: * Gets the notBefore value of @c String type from the validity period of the certificate. @n * This value represents the date and time before which the certificate is not valid. * - * @since 2.0 + * @since 2.0 * * @return A string representing the date and time value before which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod(void) for relevant ASN.1 definitions. - * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetNotBefore(void) const; @@ -255,43 +265,46 @@ public: * Gets the notAfter value of @c String type from the validity period of the certificate. @n * This value represents the date and time after which the certificate is not valid. * - * @since 2.0 + * @since 2.0 * * @return A string representing the date and time value after which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod(void) for relevant ASN.1 definitions. - * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetNotAfter(void) const; /** * Gets the name of the issuer of the certificate. * - * @since 2.0 + * @since 2.0 * * @return The name of the issuer of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @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 get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetIssuer(void) const; /** * Gets the subject name of the certificate. * - * @since 2.0 + * @since 2.0 * * @return The subject name of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @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 get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSubject(void) const; @@ -310,30 +323,32 @@ public: * * The algorithm name is determined from the algorithm OID string. * - * @since 2.0 + * @since 2.0 * * @return The signature algorithm of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::String GetSignatureAlgorithm(void) const; /** * Gets the signature of the certificate. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation 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 certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetSignatureN(void) const; diff --git a/inc/FSecCertX509CertificatePath.h b/inc/FSecCertX509CertificatePath.h index 6b3cf8b..d025738 100644 --- a/inc/FSecCertX509CertificatePath.h +++ b/inc/FSecCertX509CertificatePath.h @@ -35,11 +35,11 @@ class _CertMgrSvcProxy; /** * @class X509CertificatePath - * @brief This class provides the certificate path. + * @brief This class provides methods for the certificate path. * * @since 2.0 * - * The %X509CertificatePath class provides the certificate path. @n + * The %X509CertificatePath class provides methods for the certificate path. @n * * For more information on the class features, see Certificates. */ @@ -86,8 +86,9 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual result AddCertificate(const Tizen::Security::Cert::ICertificate& certificate); @@ -98,9 +99,10 @@ public: * * @return The result of the certificate path validation * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(void); @@ -114,9 +116,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(const Tizen::Security::Cert::ICertificate& trustAnchor); @@ -128,8 +131,9 @@ public: * @return The length of the certificate path, @n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual int GetLength(void) const; @@ -140,15 +144,16 @@ public: * * @return A pointer to the ICertificate interface, @n * else @c null if an error occurs - * @param[in] nth The nth certificate in the certificate path (starts from @c 0) + * @param[in] nth The nth certificate in the certificate path (starts from @c 0) * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The value of the specified @c nth is out of the valid range. @n * It must be less than the value retrieved by the GetLength() method. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list 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 certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetCertificateN(int nth) const; @@ -158,14 +163,15 @@ public: * @since 2.0 * * @return The root certificate, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation 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 certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetTrustAnchorN(void) const; diff --git a/inc/FSecCertX509CertificateSelector.h b/inc/FSecCertX509CertificateSelector.h index 72f2645..9950cc6 100644 --- a/inc/FSecCertX509CertificateSelector.h +++ b/inc/FSecCertX509CertificateSelector.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Security { namespace Cert /** * @class X509CertificateSelector - * @brief This class is used for managing a variety of identity certificates. + * @brief This class provides methods for managing a variety of identity certificates. * * @since 2.0 * @@ -40,7 +40,7 @@ namespace Tizen { namespace Security { namespace Cert * For more information on the class features, see Certificates. * * @see ICertificate - * @see Tizen::Security::Cert::ICertificateSelector + * @see ICertificateSelector */ class _OSP_EXPORT_ X509CertificateSelector : public virtual ICertificateSelector diff --git a/inc/FSecCertX509CertificateStore.h b/inc/FSecCertX509CertificateStore.h index 61dcf20..e88fc93 100644 --- a/inc/FSecCertX509CertificateStore.h +++ b/inc/FSecCertX509CertificateStore.h @@ -36,7 +36,7 @@ class _CertMgrSvcProxy; /** * @class X509CertificateStore - * @brief This class is used for retrieving and managing certificates from a repository. + * @brief This class provides methods for retrieving and managing certificates from a repository. * * @since 2.0 * @@ -86,18 +86,19 @@ public: * @privilege %http://tizen.org/privilege/certificate.read * * @return An error code - * @param[in] selector A selector that defines a set of criterion for selecting certificates + * @param[in] selector The selector that defines a set of criterion for selecting certificates * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The IPC operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The IPC operation has failed. * @exception E_INVALID_ARG The specified @c selector is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result SetCertificateSelector(const Tizen::Security::Cert::ICertificateSelector& selector); /** - * Gets a count of certificates that match the specified selector. + * Gets the count of certificates that match the specified selector. * * @since 2.0 * @@ -112,19 +113,20 @@ public: virtual result GetCertificateCount(int& count) const; /** - * Gets each certificate that matches the specified selector. + * Gets the certificate that matches the specified selector. * * @since 2.0 * * @privlevel partner * @privilege %http://tizen.org/privilege/certificate.read * - * @return The certificates that matches the specified selector + * @return The certificate that matches the specified selector * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual Tizen::Security::Cert::ICertificate* GetNextCertificateN(void) const; @@ -142,16 +144,18 @@ public: * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Insert(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate); /** - * Updates the certificate in the certificate store. + * Updates the certificate in the certificate store. * * @since 2.0 * @@ -164,17 +168,19 @@ public: * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Update(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& oldCert, const Tizen::Security::Cert::ICertificate& newCert); /** - * Removes the certificate from the certificate store. + * Removes the certificate from the certificate store. * * @since 2.0 * @@ -186,11 +192,13 @@ public: * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Remove(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate); @@ -204,8 +212,8 @@ public: * @privilege %http://tizen.org/privilege/certificate.write * * @return An error code - * @param[in] filePath The file path of PKCS 12 certificate to insert - * @param[in] password The password string to decrypt PKCS 12 certificate + * @param[in] filePath The file path of PKCS 12 certificate to insert + * @param[in] password The password string to decrypt PKCS 12 certificate * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. diff --git a/inc/FSecCrypto.h b/inc/FSecCrypto.h index 2312423..fad754b 100644 --- a/inc/FSecCrypto.h +++ b/inc/FSecCrypto.h @@ -56,9 +56,10 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * - * The %Crypto namespace provides classes and methods to handle encryption and decryption using hashing, symmetric and asymmetric ciphers. It also provides a mechanism for sending messages over an insecure channel using a key pair (public and private keys). @n + * The %Crypto namespace provides classes and methods to handle encryption and decryption using hashing, symmetric and asymmetric + * ciphers. It also provides a mechanism for sending messages over an insecure channel using a key pair (public and private keys). @n * * For more information on the %Crypto namespace features, see Crypto Guide. @n * diff --git a/inc/FSecCryptoAesCipher.h b/inc/FSecCryptoAesCipher.h index 50059b2..1b94289 100644 --- a/inc/FSecCryptoAesCipher.h +++ b/inc/FSecCryptoAesCipher.h @@ -36,13 +36,13 @@ class _SymmetricCipher; * @class AesCipher * @brief This class provides methods for encryption and decryption using the Advanced Encryption Standard (AES) method. * - * @since 2.0 + * @since 2.0 * * The %AesCipher class provides a symmetric cipher using the Advanced Encryption Standard (AES) method. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT, ::CIPHER_DECRYPT, ::CIPHER_WRAP, - * or ::CIPHER_UNWRAP) parameters. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT, ::CIPHER_DECRYPT, + * ::CIPHER_WRAP, or ::CIPHER_UNWRAP) parameters. @n * - * For more information on the class features, see Ciphers. + * For more information on the class features, see Ciphers. * * @see ISymmetricCipher * @see DesCipher @@ -55,8 +55,8 @@ class _OSP_EXPORT_ AesCipher public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 */ @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/128/NOPADDING" or "CBC/192/NOPADDING". * @param[in] opMode The cipher operation mode @n * For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -101,7 +104,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Sets the initial vector. + * Sets the specified initial vector. * * @since 2.0 * @@ -114,24 +117,25 @@ public: virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector); /** - * Encrypts the data (single-part). + * Encrypts the specified data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * * @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 specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -139,25 +143,26 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %AesCipher for the multiple-part encryption or decryption. * * @since 2.0 * @@ -166,13 +171,14 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,15 +189,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -200,9 +207,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); @@ -211,7 +219,7 @@ public: * Wraps a key. * * @since 2.0 - * @pre Before calling this method, a secret key should be set using SetKey(). + * @pre Before calling this method, set a secret key using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap @@ -221,8 +229,9 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -231,7 +240,7 @@ public: * Unwraps a previously wrapped key. * * @since 2.0 - * @pre Before calling this method, a secret key should be set using SetKey(). + * @pre Before calling this method, set a secret key using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap @@ -241,8 +250,9 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoCastCipher.h b/inc/FSecCryptoCastCipher.h index 4048ccb..94a42dc 100644 --- a/inc/FSecCryptoCastCipher.h +++ b/inc/FSecCryptoCastCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class CastCipher * @brief This class provides methods for encryption and decryption using the CAST-128 algorithm. * - * @since 2.0 + * @since 2.0 * * The %CastCipher class provides a symmetric cipher using the CAST-128 algorithm. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT * or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested key bit/padding scheme @n + * @param[in] transformation The requested key bit/padding scheme @n * The valid values for %CastCipher are "128/PKCS7PADDING" and "128/NOPADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %CastCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -117,20 +120,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -138,40 +142,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %CastCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -181,16 +187,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +206,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); @@ -214,9 +222,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %CastCipher class. + * @remarks + * - This operation is not supported in the %CastCipher class. * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -228,9 +237,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %CastCipher class. + * @remarks + * - This operation is not supported in the %CastCipher class. * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoDesCipher.h b/inc/FSecCryptoDesCipher.h index a875a01..e99b82e 100644 --- a/inc/FSecCryptoDesCipher.h +++ b/inc/FSecCryptoDesCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class DesCipher * @brief This class provides methods for encryption and decryption using the Data Encryption Standard (DES) method. * - * @since 2.0 + * @since 2.0 * * The %DesCipher class provides a symmetric cipher using the Data Encryption Standard (DES) method. - * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation mode + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode * (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/NOPADDING" or "CBC/PKCS7PADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %DesCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -117,20 +120,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -138,40 +142,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %DesCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -181,16 +187,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +206,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoDesEdeCipher.h b/inc/FSecCryptoDesEdeCipher.h index f2b4400..7e6b288 100644 --- a/inc/FSecCryptoDesEdeCipher.h +++ b/inc/FSecCryptoDesEdeCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class DesEdeCipher * @brief This class provides methods for encryption and decryption using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode. * - * @since 2.0 + * @since 2.0 * * The %DesEdeCipher class provides symmetric cipher using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode. - * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -74,19 +74,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/NOPADDING" or "CBC/PKCS7PADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %DesEdeCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -115,20 +118,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -136,40 +140,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %DesEdeCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -179,16 +185,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -197,9 +204,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoDhKeyExchange.h b/inc/FSecCryptoDhKeyExchange.h index ec82246..b040594 100644 --- a/inc/FSecCryptoDhKeyExchange.h +++ b/inc/FSecCryptoDhKeyExchange.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoDhKeyExchange.h + * @file FSecCryptoDhKeyExchange.h * @brief This is the header file for the %DhKeyExchange class. * * This header file contains the declarations of the %DhKeyExchange class. @@ -33,7 +33,7 @@ namespace Tizen { namespace Security { namespace Crypto * @class DhKeyExchange * @brief This class provides methods for a key exchange mechanism using the Diffie-Hellman (DH) algorithm. * - * @since 2.0 + * @since 2.0 * * The %DhKeyExchange class provides a DH key exchange between two communicating users. @n * @@ -214,11 +214,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH - * algorithm that needs to instantiate - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value. */ + * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH algorithm + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value. + */ virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters); /** @@ -233,10 +233,11 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey); diff --git a/inc/FSecCryptoIAsymmetricCipher.h b/inc/FSecCryptoIAsymmetricCipher.h index aff8197..855ed69 100644 --- a/inc/FSecCryptoIAsymmetricCipher.h +++ b/inc/FSecCryptoIAsymmetricCipher.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Security { namespace Crypto /** * @interface IAsymmetricCipher - * @brief This interface provides the functionality of an asymmetric cryptographic cipher for encryption and decryption. + * @brief This interface provides methods for the functionality of an asymmetric cryptographic cipher for encryption and decryption. * * @since 2.0 * @@ -163,7 +163,7 @@ public: virtual ~IAsymmetricCipher(void) {} /** - * Sets an asymmetric private key for encryption or decryption. + * Sets the asymmetric private key for encryption or decryption. * * @since 2.0 * @@ -176,7 +176,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0; /** - * Sets an asymmetric public key for encryption or decryption. + * Sets the asymmetric public key for encryption or decryption. * * @since 2.0 * @@ -193,7 +193,7 @@ public: * * @since 2.0 * - * @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 * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -201,9 +201,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @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. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred.n + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0; @@ -212,7 +213,7 @@ public: * * @since 2.0 * - * @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 * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -220,9 +221,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @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. + * @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. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0; diff --git a/inc/FSecCryptoIHash.h b/inc/FSecCryptoIHash.h index cdf7eeb..90f0b58 100644 --- a/inc/FSecCryptoIHash.h +++ b/inc/FSecCryptoIHash.h @@ -39,8 +39,8 @@ namespace Tizen { namespace Security { namespace Crypto * * For more information on the class features, see Hashing. @n * - * The following example demonstrates how to use the %IHash interface. - * @code + * The following example demonstrates how to use the %IHash interface. + * @code * * result * MyClass::TestHashSample(void) @@ -195,8 +195,8 @@ class _OSP_EXPORT_ IHash public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -204,12 +204,12 @@ public: /** * Sets the hash algorithm. @n - * Only supported in Secure Hash Algorithm-2 (SHA-2). + * This method is only supported in Secure Hash Algorithm-2 (SHA-2). * * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -223,31 +223,33 @@ 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 containing the data * @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_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. + * @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. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const = 0; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -256,14 +258,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -271,9 +274,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0; @@ -292,4 +296,4 @@ protected: } } } //Tizen::Security::Crypto -#endif //_FSEC_CRYPTO_IHASH_H_ +#endif //_FSEC_CRYPTO_IHASH_H_ diff --git a/inc/FSecCryptoIHmac.h b/inc/FSecCryptoIHmac.h index b8e4c77..241639b 100755 --- a/inc/FSecCryptoIHmac.h +++ b/inc/FSecCryptoIHmac.h @@ -289,8 +289,8 @@ class _OSP_EXPORT_ IHmac public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -302,7 +302,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -323,9 +323,9 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key) = 0; /** - * Gets the HMAC with a given input. + * Gets the HMAC for the specified input. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs @@ -334,14 +334,15 @@ public: * @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_KEY_NOT_FOUND The 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. + * @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. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const = 0; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -349,13 +350,14 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -364,24 +366,26 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0; diff --git a/inc/FSecCryptoIKeyExchange.h b/inc/FSecCryptoIKeyExchange.h index fdcfc87..5a7aeba 100644 --- a/inc/FSecCryptoIKeyExchange.h +++ b/inc/FSecCryptoIKeyExchange.h @@ -48,8 +48,8 @@ class _OSP_EXPORT_ IKeyExchange public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -61,7 +61,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] keyParameters The domain parameters of the key exchange algorithm that needs to instantiate + * @param[in] keyParameters The domain parameters of the key exchange algorithm * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -81,9 +81,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey) = 0; diff --git a/inc/FSecCryptoISignature.h b/inc/FSecCryptoISignature.h index 2a9f1f5..a376b85 100755 --- a/inc/FSecCryptoISignature.h +++ b/inc/FSecCryptoISignature.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoISignature.h + * @file FSecCryptoISignature.h * @brief This is the header file for the %ISignature interface. * * This header file contains the declarations of the %ISignature interface. @@ -32,7 +32,7 @@ namespace Tizen { namespace Security { namespace Crypto /** * @interface ISignature - * @brief This interface provides the functionality of a digital signature algorithm. + * @brief This interface provides methods for a digital signature algorithm. * * @since 2.0 * @@ -42,7 +42,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The following example demonstrates how to use the %ISignature interface. * - * @code + * @code * * void * MyClass::TestSignatureSample(void) @@ -130,14 +130,14 @@ namespace Tizen { namespace Security { namespace Crypto * * r = E_SUCCESS; * - * CATCH: + * CATCH: * delete pSignature; * delete pOutput; * delete pKeyPairGen; * delete pKeyPair; - * } + * } * - * @endcode + * @endcode */ class _OSP_EXPORT_ ISignature @@ -145,15 +145,15 @@ class _OSP_EXPORT_ ISignature public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ virtual ~ISignature(void) {} /** - * Sets an asymmetric private key for signature. + * Sets the asymmetric private key for signature. * * @since 2.0 * @@ -166,7 +166,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0; /** - * Sets an asymmetric public key for verification. + * Sets the asymmetric public key for verification. * * @since 2.0 * @@ -190,14 +190,15 @@ public: * @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_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. + * @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. */ virtual Tizen::Base::ByteBuffer* SignN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Verifies the data. @n + * Verifies the specified data. @n * The verification is done by comparing the @c signedData to the signature created by the @c data. * * @since 2.0 @@ -210,9 +211,10 @@ public: * @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_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. + * @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. */ virtual bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData) = 0; diff --git a/inc/FSecCryptoISymmetricCipher.h b/inc/FSecCryptoISymmetricCipher.h index d6108e4..7f344dc 100644 --- a/inc/FSecCryptoISymmetricCipher.h +++ b/inc/FSecCryptoISymmetricCipher.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoISymmetricCipher.h + * @file FSecCryptoISymmetricCipher.h * @brief This is the header file for the %ISymmetricCipher interface. * * This header file contains the declarations of the %ISymmetricCipher interface. @@ -223,8 +223,8 @@ class _OSP_EXPORT_ ISymmetricCipher public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -236,7 +236,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode or key bit or padding scheme + * @param[in] transformation The requested mode or key bit or padding scheme * @param[in] opMode The cipher operation mode @n * For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP. * @exception E_SUCCESS The method is successful. @@ -247,12 +247,12 @@ public: virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode = Tizen::Security::Crypto::CIPHER_ENCRYPT) = 0; /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * * @return An error code - * @param[in] key An instance of ISecretKey + * @param[in] key An instance of ISecretKey to set * @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. @@ -265,7 +265,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] initialVector The initial vector + * @param[in] initialVector The initial vector to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -286,9 +286,10 @@ public: * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0; @@ -306,14 +307,16 @@ public: * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. + * * * @since 2.0 * @@ -322,13 +325,14 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part encryption or decryption operation. + * Updates the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -339,15 +343,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. - * @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* UpdateN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -356,15 +361,16 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void) = 0; /** - * Wraps the specified key. + * Wraps a key. * * @since 2.0 * @@ -376,11 +382,12 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @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. * - This operation is only supported in AesCipher. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey) = 0; @@ -398,9 +405,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @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. + * @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. * - This operation is only supported in AesCipher. diff --git a/inc/FSecCryptoKeaKeyExchange.h b/inc/FSecCryptoKeaKeyExchange.h index 1a50489..e969c07 100644 --- a/inc/FSecCryptoKeaKeyExchange.h +++ b/inc/FSecCryptoKeaKeyExchange.h @@ -33,17 +33,17 @@ namespace Tizen { namespace Security { namespace Crypto * @class KeaKeyExchange * @brief This class provides methods for performing the key exchange mechanism using Key Exchange Algorithm (KEA). * - * @since 2.0 + * @since 2.0 * * The %KeaKeyExchange class provides a KEA key exchange between two communicating users. @n * - * For more information on the class features, see Key exchanging. + * For more information on the class features, see Key exchanging. * - * @see IKeyExchange - * @see KeyPairGenerator + * @see IKeyExchange + * @see KeyPairGenerator * - * The following example demonstrates how to use the %KeaKeyExchange class. - * @code + * The following example demonstrates how to use the %KeaKeyExchange class. + * @code * * void KeaGenerateSecretExample(void) * { @@ -292,7 +292,7 @@ public: * This parameter needs to be instantiated. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. */ virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters); @@ -308,9 +308,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey); diff --git a/inc/FSecCryptoMd5Hash.h b/inc/FSecCryptoMd5Hash.h index b752b35..65baec2 100644 --- a/inc/FSecCryptoMd5Hash.h +++ b/inc/FSecCryptoMd5Hash.h @@ -61,7 +61,7 @@ public: /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Md5Hash(void); @@ -92,28 +92,30 @@ public: * @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_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. + * @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* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -122,14 +124,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -137,9 +140,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoMd5Hmac.h b/inc/FSecCryptoMd5Hmac.h index 0b1504e..04743d0 100644 --- a/inc/FSecCryptoMd5Hmac.h +++ b/inc/FSecCryptoMd5Hmac.h @@ -37,7 +37,8 @@ namespace Tizen { namespace Security { namespace Crypto * * @since 2.0 * - * The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) algorithm, which provides a hash with a secret key. @n + * The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) + * algorithm, which provides a hash with a secret key. * * For more information on the class features, see Hashing. * @@ -61,7 +62,7 @@ public: /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Md5Hmac(void); @@ -73,18 +74,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. - * @remarks Do not call this method. It is not supported. + * @remarks Do not call this method. It is not supported. */ virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** * Sets the secret key. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] key An instance of ISecretKey @@ -95,7 +96,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets the HMAC with the specified input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -106,15 +107,16 @@ public: * @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_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. + * @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* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -128,7 +130,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -137,9 +139,10 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); @@ -152,9 +155,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoRc2Cipher.h b/inc/FSecCryptoRc2Cipher.h index 005f6c6..309058c 100644 --- a/inc/FSecCryptoRc2Cipher.h +++ b/inc/FSecCryptoRc2Cipher.h @@ -37,14 +37,14 @@ class _SymmetricCipher; * * @since 2.0 * - * The %Rc2Cipher class provides a symmetric cipher using the RC2 algorithm. - * It sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * The %Rc2Cipher class provides a symmetric cipher using the RC2 algorithm. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * * @see ISymmetricCipher - * @see DesCipher - * @see DesEdeCipher + * @see DesCipher + * @see DesEdeCipher */ class _OSP_EXPORT_ Rc2Cipher : public virtual ISymmetricCipher @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/padding scheme @n + * @param[in] transformation The requested mode/padding scheme @n * The RC2 support variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. * The key bits are not required to be mentioned in the transformation. * There are four valid transformations for RC2, "CBC/NOPADDING", @@ -81,16 +81,19 @@ public: * @param[in] opMode The cipher operation mode @n * The valid values for %Rc2Cipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the + * result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. @n - * The variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. + * Sets the symmetric key for encryption or decryption. @n + * The variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. * * @since 2.0 * @@ -119,20 +122,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -140,40 +144,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %Rc2Cipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,16 +189,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -201,9 +208,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoRc4Cipher.h b/inc/FSecCryptoRc4Cipher.h index d2bd3e1..bb10601 100644 --- a/inc/FSecCryptoRc4Cipher.h +++ b/inc/FSecCryptoRc4Cipher.h @@ -38,14 +38,14 @@ class _SymmetricCipher; * * @since 2.0 * - * The %Rc4Cipher class provides a symmetric cipher using the RC4 algorithm. - * It sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * The %Rc4Cipher class provides a symmetric cipher using the RC4 algorithm. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * * @see ISymmetricCipher - * @see DesCipher - * @see DesEdeCipher + * @see DesCipher + * @see DesEdeCipher */ class _OSP_EXPORT_ Rc4Cipher : public virtual ISymmetricCipher @@ -78,16 +78,17 @@ public: * @param[in] opMode The cipher operation mode @n * The valid values for %Rc4Cipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG A specified input parameter is invalid. * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption operation. @n - * The variable length key ranges from 40 bits to 256 bits, in steps of 8 bits. + * Sets the symmetric key for encryption or decryption operation. @n + * The variable length key ranges from 40 bits to 256 bits, in steps of 8 bits. * * @since 2.0 * @@ -116,20 +117,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -137,40 +139,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %Rc4Cipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - The method has failed to operate with the OpenSSL library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -180,17 +184,18 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +204,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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 This operation is not required for RC4. Always return @c null if this method is called. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoRsaCipher.h b/inc/FSecCryptoRsaCipher.h index b0bf9aa..431081d 100755 --- a/inc/FSecCryptoRsaCipher.h +++ b/inc/FSecCryptoRsaCipher.h @@ -68,7 +68,7 @@ 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 * @@ -82,7 +82,7 @@ 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 * @@ -109,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); @@ -123,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); diff --git a/inc/FSecCryptoRsaSignature.h b/inc/FSecCryptoRsaSignature.h index eb60157..067e98f 100755 --- a/inc/FSecCryptoRsaSignature.h +++ b/inc/FSecCryptoRsaSignature.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %RsaSignature class implements the Rivest Shamir Adleman (RSA) signatures. @n * - * For more information on the class features, see Ciphers. + * For more information on the class features, see Ciphers. * * @see ISignature * @see IKeyPairGenerator @@ -69,13 +69,13 @@ public: virtual ~RsaSignature(void); /** - * Sets an asymmetric private key for signature. + * Sets the asymmetric private key for signature. * * @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 + * The 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 +83,13 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key); /** - * Sets an asymmetric public key for verification. + * Sets the asymmetric public key for verification. * * @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 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. @@ -101,40 +101,42 @@ public: * The %SignN() method only supports sha1withRsa for signing the data * @since 2.0 * - * @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 - * @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_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* SignN(const Tizen::Base::ByteBuffer& input); /** * Signs the data. @n - * The %SignN() method provides the additional option to developer for setting digest algorithm that is needed for signing the data + * The %SignN() method provides the additional option for setting the digest algorithm that is needed for signing the data * * @since 2.0 * - * @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 - * @param[in] input An instance of Tizen::Base::ByteBuffer - * @param[in] algorithm An instance of Tizen::Base::String that contains the digest algorithm, - * valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. + * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] algorithm The Tizen::Base::String instance that contains the digest algorithm. @n + * The valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. * @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_KEY_NOT_FOUND The specified key is not found. * @exception E_UNSUPPORTED_ALGORITHM The specified algorithm is not supported. - * @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. */ Tizen::Base::ByteBuffer* SignN(const Tizen::Base::ByteBuffer& input, const Tizen::Base::String& algorithm); @@ -148,40 +150,42 @@ public: * @return @c true if the signed data is correct, @n * else @c false * @param[in] data An instance of Tizen::Base::ByteBuffer that contains the original data - * @param[in] signedData A instance of Tizen::Base::ByteBuffer that contains the signed data + * @param[in] signedData An instance of Tizen::Base::ByteBuffer that contains the signed data * @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_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 bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData); /** * Verifies the data. @n * The verification is done by comparing the @c signedData to the signature created by the @c data. @n - * The %Verify() method provides the additional option to developer for setting digest algorithm that is needed for verifying the signed data + * The %Verify() method provides the additional option for setting the digest algorithm that is needed for verifying the signed data * * @since 2.0 * * @return @c true if the signed data is correct, @n * else @c false * @param[in] data An instance of Tizen::Base::ByteBuffer that contains the original data - * @param[in] signedData A instance of Tizen::Base::ByteBuffer that contains the signed data - * @param[in] algorithm An instance of Tizen::Base::String that contains the digest algorithm, - * valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. + * @param[in] signedData An instance of Tizen::Base::ByteBuffer that contains the signed data + * @param[in] algorithm The Tizen::Base::String instance that contains the digest algorithm. @n + * The valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. * @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_KEY_NOT_FOUND The specified key is not found. * @exception E_UNSUPPORTED_ALGORITHM The specified algorithm is not supported. - * @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. */ bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData, const Tizen::Base::String& algorithm); diff --git a/inc/FSecCryptoSha1Hash.h b/inc/FSecCryptoSha1Hash.h index a376b30..451311f 100644 --- a/inc/FSecCryptoSha1Hash.h +++ b/inc/FSecCryptoSha1Hash.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha1Hash class implements the SHA-1 hash algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see IHash * @see Md5Hash @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -82,7 +82,7 @@ public: virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** - * Gets the hashes of a data (single-part). + * Gets the hashes of the specified data (single-part). * * @since 2.0 * @@ -92,15 +92,16 @@ public: * @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_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. + * @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* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * @@ -113,7 +114,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -122,14 +123,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -137,9 +139,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoSha1Hmac.h b/inc/FSecCryptoSha1Hmac.h index 0861f55..1f814d3 100644 --- a/inc/FSecCryptoSha1Hmac.h +++ b/inc/FSecCryptoSha1Hmac.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha1Hmac class implements the SHA-1 HMAC algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see IHmac * @see Md5Hmac @@ -54,14 +54,14 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ Sha1Hmac(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Sha1Hmac(void); @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -95,7 +95,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets HMAC with the given input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -106,14 +106,15 @@ public: * @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_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. + * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -121,13 +122,14 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @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. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -136,14 +138,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * @@ -151,10 +154,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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* FinalizeN(void); diff --git a/inc/FSecCryptoSha2Hash.h b/inc/FSecCryptoSha2Hash.h index 705db99..12910fb 100755 --- a/inc/FSecCryptoSha2Hash.h +++ b/inc/FSecCryptoSha2Hash.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha2Hash class implements the SHA-2 hash algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see Tizen::Security::Crypto::IHash * @see Tizen::Security::Crypto::Md5Hash @@ -59,7 +59,7 @@ public: Sha2Hash(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * * @since 2.0 */ @@ -71,7 +71,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -79,7 +79,7 @@ public: virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** - * Gets the hashes of the data (single-part). + * Gets the hashes of the specified data (single-part). * * @since 2.0 * @@ -89,28 +89,30 @@ public: * @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_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. + * @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* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -119,14 +121,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -134,9 +137,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoSha2Hmac.h b/inc/FSecCryptoSha2Hmac.h index e2ba99a..54eca9a 100755 --- a/inc/FSecCryptoSha2Hmac.h +++ b/inc/FSecCryptoSha2Hmac.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha2Hmac class implements the SHA-2 HMAC algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see Tizen::Security::Crypto::IHmac * @see Tizen::Security::Crypto::Md5Hmac @@ -71,7 +71,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -92,7 +92,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets the HMAC with the given input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -103,15 +103,16 @@ public: * @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_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. + * @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* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -125,7 +126,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another part of the data. + * Updates the multiple-part HMAC operation while processing another part of the data. * * @since 2.0 * @@ -134,14 +135,15 @@ public: * @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_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. + * @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. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * @@ -149,9 +151,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @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. + * @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* FinalizeN(void); diff --git a/inc/FSecCryptoSkipJackCipher.h b/inc/FSecCryptoSkipJackCipher.h index 8c1f67b..44dfbd5 100755 --- a/inc/FSecCryptoSkipJackCipher.h +++ b/inc/FSecCryptoSkipJackCipher.h @@ -38,8 +38,8 @@ class _SymmetricCipher; * * @since 2.0 * - * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. Appropriate values have to be set for the requested mode or key bit or - * padding scheme and the cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n + * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. @n + * This class allows to set appropriate values for the requested mode or key bit or padding scheme and the cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. * * For more information on the class features, see Ciphers. * @@ -74,7 +74,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode or padding scheme @n + * @param[in] transformation The requested mode or padding scheme @n * As the default key size of the Skipjack cipher is 80 bits, there is no need to mention it explicitly. * For example, "CBC/PKCS7PADDING" or "ECB/NOPADDING". * @param[in] opMode The cipher operation mode @n @@ -82,14 +82,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c opMode contains invalid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, + * then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -118,7 +119,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @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 @@ -128,10 +129,11 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); @@ -139,9 +141,9 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @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. @@ -149,30 +151,32 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %SkipJackCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @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. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,15 +187,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @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* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -200,17 +205,18 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @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. + * @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* FinalizeN(void); /** - * Wraps the specified key. + * Wraps a key. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs @@ -222,15 +228,15 @@ public: virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); /** - * Unwraps the specified wrapped key. + * Unwraps a previously wrapped key. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap * @remarks - * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n + * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoTypes.h b/inc/FSecCryptoTypes.h index 208c9b7..f8e4837 100755 --- a/inc/FSecCryptoTypes.h +++ b/inc/FSecCryptoTypes.h @@ -28,19 +28,19 @@ namespace Tizen { namespace Security { namespace Crypto { /** - * @enum CipherOperation + * @enum CipherOperation * * Defines the cipher operation. * - * @since 2.0 + * @since 2.0 */ enum CipherOperation { - CIPHER_ENCRYPT = 0, /**Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see ISecureRandom * @see AesSecureRandom @@ -53,21 +53,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ DesSecureRandom(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~DesSecureRandom(void); /** - * Generates a user-specified number of random bytes. + * Generates a user-defined number of random bytes. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n * else @c null if an error occurs @@ -75,8 +75,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM A system error has occurred. @n + * The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes); diff --git a/inc/FSecIKey.h b/inc/FSecIKey.h index b00d0ec..5df7c25 100644 --- a/inc/FSecIKey.h +++ b/inc/FSecIKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKey.h + * @file FSecIKey.h * @brief This is the header file for the %IKey interface. * * This header file contains the declarations of the %IKey interface. @@ -29,12 +29,14 @@ namespace Tizen { namespace Security { /** - * @interface IKey - * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. + * @interface IKey + * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract + * the encoding format of the key. * * @since 2.0 * - * The %IKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. @n + * The %IKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding + * format of the key. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -50,8 +52,8 @@ class _OSP_EXPORT_ IKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ diff --git a/inc/FSecIKeyPairGenerator.h b/inc/FSecIKeyPairGenerator.h index 58b0b92..e852930 100644 --- a/inc/FSecIKeyPairGenerator.h +++ b/inc/FSecIKeyPairGenerator.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKeyPairGenerator.h + * @file FSecIKeyPairGenerator.h * @brief This is the header file for the %IKeyPairGenerator interface. * * This header file contains the declarations of the %IKeyPairGenerator interface. @@ -47,8 +47,8 @@ class _OSP_EXPORT_ IKeyPairGenerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -62,9 +62,10 @@ public: * @return An error code * @param[in] modulusBitSize The modulus size in bits * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c modulusBitSize is invalid. @n - * The modulus size must be atleast greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c modulusBitSize is invalid. + * - The modulus size must be atleast greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ virtual result Construct(int modulusBitSize) = 0; @@ -78,9 +79,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The requested algorithm is not supported. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. - * @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. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::KeyPair* GenerateKeyPairN(void) const = 0; diff --git a/inc/FSecIKeyParameters.h b/inc/FSecIKeyParameters.h index a9f1cb5..3f8b098 100644 --- a/inc/FSecIKeyParameters.h +++ b/inc/FSecIKeyParameters.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKeyParameters.h + * @file FSecIKeyParameters.h * @brief This is the header file for the %IKeyParameters interface. * * This header file contains the declarations of the %IKeyParameters interface. @@ -46,22 +46,22 @@ class _OSP_EXPORT_ IKeyParameters public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ virtual ~IKeyParameters(void) {} /** - * Gets the value of the parameter for a specified key parameter type. + * Gets the value of the parameter for the specified key parameter type. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the parameter values, @n * else @c null if an error occurs * @param[in] paramType The type of the parameter @n - * For example, @c KEY_PARAMETER_DH_G. + * For example, @c KEY_PARAMETER_DH_G. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_TYPE The specified @c paramType is not supported. diff --git a/inc/FSecIPrivateKey.h b/inc/FSecIPrivateKey.h index 897f910..bfc0704 100644 --- a/inc/FSecIPrivateKey.h +++ b/inc/FSecIPrivateKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIPrivateKey.h + * @file FSecIPrivateKey.h * @brief This is the header file for the %IPrivateKey interface. * * This header file contains the declarations of the %IPrivateKey interface. @@ -46,24 +46,24 @@ class _OSP_EXPORT_ IPrivateKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IPrivateKey(void){} /** - * Gets the name of the primary encoding format of a key. + * Gets the name of the primary encoding format of the key. * * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Gets a private key in its primary encoding format. + * Gets the private key in its primary encoding format. * * @since 2.0 * @@ -71,7 +71,7 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecIPublicKey.h b/inc/FSecIPublicKey.h index 62f7b7a..e9f1593 100644 --- a/inc/FSecIPublicKey.h +++ b/inc/FSecIPublicKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIPublicKey.h + * @file FSecIPublicKey.h * @brief This is the header file for the %IPublicKey interface. * * This header file contains the declarations of the %IPublicKey interface. @@ -46,32 +46,32 @@ class _OSP_EXPORT_ IPublicKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IPublicKey(void){} /** - * Gets the name of the primary encoding format of a key. + * Gets the name of the primary encoding format of the key. * * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Gets a public key in its primary encoding format. + * Gets the public key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecISecretKey.h b/inc/FSecISecretKey.h index 1bb8e73..936590a 100644 --- a/inc/FSecISecretKey.h +++ b/inc/FSecISecretKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecISecretKey.h + * @file FSecISecretKey.h * @brief This is the header file for the %ISecretKey interface. * * This header file contains the declarations of the %ISecretKey interface. @@ -31,11 +31,13 @@ namespace Tizen { namespace Security /** * @interface ISecretKey - * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. + * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract + * the encoding format of the key. * * @since 2.0 * - * The %ISecretKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. @n + * The %ISecretKey interface provides methods that help in setting the buffer for the key. These methods also extract the + * encoding format of the key. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -46,8 +48,8 @@ class _OSP_EXPORT_ ISecretKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -71,7 +73,7 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecISecretKeyGenerator.h b/inc/FSecISecretKeyGenerator.h index c6c827f..563c67e 100644 --- a/inc/FSecISecretKeyGenerator.h +++ b/inc/FSecISecretKeyGenerator.h @@ -34,7 +34,7 @@ namespace Tizen { namespace Security * @interface ISecretKeyGenerator * @brief This interface provides the abstract methods for generating a secret (symmetric) key. * - * @since 2.0 + * @since 2.0 * * The %ISecretKeyGenerator interface provides the abstract methods for generating a secret (symmetric) key. @n * @@ -47,10 +47,10 @@ class _OSP_EXPORT_ ISecretKeyGenerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~ISecretKeyGenerator(void) {} @@ -63,9 +63,10 @@ public: * else @c null if the secret key generation fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. - * @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. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::ISecretKey* GenerateKeyN(void) = 0; diff --git a/inc/FSecISecureRandom.h b/inc/FSecISecureRandom.h index d873417..bdefc20 100644 --- a/inc/FSecISecureRandom.h +++ b/inc/FSecISecureRandom.h @@ -33,11 +33,11 @@ namespace Tizen { namespace Security * @interface ISecureRandom * @brief This interface provides the abstract methods for generating a secure random object. * - * @since 2.0 + * @since 2.0 * - * The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n + * The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see Tizen::Security::AesSecureRandom * @see Tizen::Security::DesSecureRandom @@ -48,8 +48,8 @@ class _OSP_EXPORT_ ISecureRandom public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -66,10 +66,11 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @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* GenerateRandomBytesN(int numBytes) = 0; diff --git a/inc/FSecKeaKeyParameters.h b/inc/FSecKeaKeyParameters.h index c7fb1de..2c9e7d4 100644 --- a/inc/FSecKeaKeyParameters.h +++ b/inc/FSecKeaKeyParameters.h @@ -102,17 +102,17 @@ class _OSP_EXPORT_ KeaKeyParameters public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ KeaKeyParameters(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~KeaKeyParameters(void); @@ -122,12 +122,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] primeNumber The prime number to instantiate - * @param[in] generatorNumber The generator value to instantiate - * @param[in] privateKeySize The size of the private key to instantiate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] primeNumber The prime number to instantiate + * @param[in] generatorNumber The generator value to instantiate + * @param[in] privateKeySize The size of the private key to instantiate + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * */ result Construct(const Tizen::Base::ByteBuffer& primeNumber, const Tizen::Base::ByteBuffer& generatorNumber, int privateKeySize); @@ -140,7 +140,7 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the parameter values, @n * else @c null if an error occurs * @param[in] paramType The parameter type @n - * For example, @c KEY_PARAMETER_KEA_P. + * For example, @c KEY_PARAMETER_KEA_P. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_TYPE The specified @c paramType is not supported. diff --git a/inc/FSecKeyPair.h b/inc/FSecKeyPair.h index 1496d48..42c8e30 100644 --- a/inc/FSecKeyPair.h +++ b/inc/FSecKeyPair.h @@ -33,18 +33,19 @@ namespace Tizen { namespace Security { /** - * @class KeyPair - * @brief This class is a simple holder for a key pair (a public and a private key). + * @class KeyPair + * @brief This class is a simple holder for a key pair (a public and a private key). * - * @since 2.0 + * @since 2.0 * - * The %KeyPair class manages a pair of keys comprising of a public and a private key, which are used in asymmetric ciphers. The key pairs are mainly used to encrypt messages and provide digital signatures. @n + * The %KeyPair class manages a pair of keys comprising of a public and a private key, which are used in asymmetric ciphers. + * The key pairs are mainly used to encrypt messages and provide digital signatures. @n * * For more information on the class features, see Key Management and CSPRNG. * - * @see IKeyPairGenerator - * @see Tizen::Security::IPublicKey - * @see Tizen::Security::IPrivateKey + * @see IKeyPairGenerator + * @see Tizen::Security::IPublicKey + * @see Tizen::Security::IPrivateKey */ class _OSP_EXPORT_ KeyPair : public Tizen::Base::Object diff --git a/inc/FSecKeyPairGenerator.h b/inc/FSecKeyPairGenerator.h index 56195de..fb272a2 100755 --- a/inc/FSecKeyPairGenerator.h +++ b/inc/FSecKeyPairGenerator.h @@ -31,17 +31,19 @@ namespace Tizen { namespace Security { /** - * @class KeyPairGenerator - * @brief This class provides a pair of public and private keys for the Public key algorithm. + * @class KeyPairGenerator + * @brief This class provides methods for generating a pair of public and private keys for the Public key algorithm. * - * @since 2.0 + * @since 2.0 * - * The %KeyPairGenerator class generates a key pair and its parameters that consists of a public and private key. These are used in asymmetric ciphers. The generated key pair and parameters are based on the underlying key pair encryption algorithm. @n + * The %KeyPairGenerator class generates a key pair and its parameters that consists of a public and private key. + * These are used in asymmetric ciphers. The generated key pair and parameters are based on the underlying key pair + * encryption algorithm. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * - * @see Tizen::Security::IKeyPairGenerator - * @see Tizen::Security::KeyPair + * @see Tizen::Security::IKeyPairGenerator + * @see Tizen::Security::KeyPair */ class _OSP_EXPORT_ KeyPairGenerator : public virtual IKeyPairGenerator @@ -50,17 +52,17 @@ class _OSP_EXPORT_ KeyPairGenerator public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ KeyPairGenerator(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~KeyPairGenerator(void); @@ -70,29 +72,30 @@ public: * @since 2.0 * * @return An error code - * @param[in] modulusBitSize The modulus size in bits + * @param[in] modulusBitSize The modulus size in bits * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified size is invalid. @n - * The modulus size must be at least greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * The modulus size must be at least greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ virtual result Construct(int modulusBitSize); /** * Constructs and initializes an instance of %KeyPairGenerator with the specified parameters. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] modulusBitSize The modulus size in bits @n * This is used for key generation. - * @param[in] algorithm The algorithm used to generate the key parameters @n + * @param[in] algorithm The algorithm used to generate the key parameters @n * The supported algorithms are RSA, DH, and KEA. The default value is RSA. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified size is invalid. @n - * @exception E_UNSUPPORTED_ALGORITHM The requested @c algorithm is not supported. @n - * The modulus size must be at least greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * @exception E_UNSUPPORTED_ALGORITHM Either of the following conditions has occurred: + * - The requested @c algorithm is not supported. + * - The modulus size must be at least greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ result Construct(int modulusBitSize, Tizen::Base::String algorithm); @@ -104,11 +107,11 @@ public: * The generated key parameters may be required to create a key pair. The RSA algorithm * does not call this method to generate a key pair. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the IKeyParameters class that contains a subset of the domain parameters ('p' prime - * number, 'g' generator) that are used to generate a key pair, @n - * else @c null if the method fails to create the key parameters + * @return A pointer to the IKeyParameters instance that contains a subset of the domain parameters ('p' prime + * number, 'g' generator) that are used to generate the key pair, @n + * else @c null if the method fails to create the key parameters * @param[in] lInBits The size of 'p', a prime number in bits @n * The size must be @c 1024 bits, @c 2048 bits, or @c 3072 bits. * @param[in] nInBits The size of 'g', a generator value in bits @n @@ -118,8 +121,10 @@ public: * - 256 bits, when @c lInBits is @c 3072 bits. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - The method cannot proceed due to a severe system error. + * - 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. */ Tizen::Security::IKeyParameters* GenerateKeyParametersN(int lInBits = 1024, int nInBits = 160) const; @@ -129,14 +134,16 @@ public: * * @since 2.0 * - * @return A pointer to the KeyPair class, @n + * @return A pointer to the KeyPair instance, @n * else @c null if the method fails to create the key pair - * @param[in] pKeyParams The domain parameters of the key exchange algorithm @n + * @param[in] pKeyParams The domain parameters of the key exchange algorithm @n * These parameters are instantiated. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - The method cannot proceed due to a severe system error. + * - 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. */ Tizen::Security::KeyPair* GenerateKeyPairN(Tizen::Security::IKeyParameters* pKeyParams) const; @@ -146,14 +153,16 @@ public: * * @since 2.0 * - * @return A pointer to the KeyPair class, @n - else @c null if the method fails to create the key pair. - * Default key format will be pkcs1 for private key and x509 for public key. + * @return A pointer to the KeyPair instance, @n + * else @c null if the method fails to create the key pair. @n + * The default key format will be pkcs1 for private key and x509 for public key. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @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: + * - The method cannot proceed due to a severe system error. + * - 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::Security::KeyPair* GenerateKeyPairN(void) const; @@ -179,7 +188,7 @@ private: class _KeyPairGeneratorImpl* __pKeyPairGeneratorImpl; friend class _KeyPairGeneratorImpl; -}; //KeyPairGenerator +}; //KeyPairGenerator } } //Tizen::Security diff --git a/inc/FSecPkcs.h b/inc/FSecPkcs.h index 3bff801..fa39748 100755 --- a/inc/FSecPkcs.h +++ b/inc/FSecPkcs.h @@ -39,12 +39,12 @@ #include /** - * @namespace Tizen::Security::Pkcs - * @brief This namespace contains classes and interfaces for managing the PKCS 5 and 8 implementation. - * @since 2.1 + * @namespace Tizen::Security::Pkcs + * @brief This namespace contains classes and interfaces for managing the PKCS 5 and 8 implementation. + * @since 2.1 * - * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @remarks @b Header @b %file: @b \#include @b @n + * @b Library: @b osp-appfw * * * The %Pkcs namespace provides classes and interfaces for managing PKCS 5 and 8 implementation. @@ -52,7 +52,7 @@ * mac genaration/verification. * It also provides a standard format to store private key and encrypted private key. * - * For more information on the %Pkcs namespace features, see Pkcs Guide. @n + * For more information on the %Pkcs namespace features, see Pkcs Guide. @n * * The following diagram illustrates the relationships between the classes belonging to the %Pkcs namespace. * @image html security_pkcs_classdiagram.png diff --git a/inc/FSecPkcsAlgorithmIdentifier.h b/inc/FSecPkcsAlgorithmIdentifier.h index e67efab..4c8f7ae 100755 --- a/inc/FSecPkcsAlgorithmIdentifier.h +++ b/inc/FSecPkcsAlgorithmIdentifier.h @@ -38,10 +38,10 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %AlgorithmIdentifier class implements the ASN.1 specified %AlgorithmIdentifier, which is used for - * creating the standard %AlgorithmIdentifier object. - * %AlgorithmIdentifier structure consists the OID value of the algorithm along with the parameters of that algorithm. + * creating the standard %AlgorithmIdentifier object. The %AlgorithmIdentifier structure consists of the OID value of the + * algorithm along with the parameters of the algorithm. * - * 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 * AlgorithmIdentifier { ALGORITHM-IDENTIFIER:InfoObjectSet } * ::= @@ -74,45 +74,47 @@ public: virtual ~AlgorithmIdentifier(void); /** - * Initializes the %AlgorithmIdentifier with supplied input parameter values. + * Initializes the %AlgorithmIdentifier with the specified input parameter values. * * @since 2.1 * * @return An error code * @param[in] objectId The object identifier of a particular algorithm @n - * Object IDs are defined by standard bodies for algorithms and other crypto objects. - * Object ID of %AlgorithmIdentifier can be described in string format like 1.2.3.4 + * The object IDs are defined by standard bodies for algorithms and other crypto objects. @n + * The object ID of %AlgorithmIdentifier can be described in string format like 1.2.3.4 * @param[in] pParams A pointer to the AlgorithmParameters object @n - * This is an optional parameter and contains a list of user specified input parameters for the specified algorithm. For example, for Symmetric algorithms Initial vector, IV is required as an input. The default value of this parameter is @c null. - * @exception E_SUCCESS The method is successful. + * This is an optional parameter and contains a list of user specified input parameters for + * the specified algorithm. For example, for Symmetric algorithms Initial vector, IV is required + * as an input. The default value of this parameter is @c null. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_UNSUPPORTED_ALGORITHM The object ID of the input algorithm is not supported. */ result Construct(const Tizen::Base::String& objectId, const IAlgorithmParameters* pParams = null); /** - * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains @n + * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains * the ASN.1 specified %AlgorithmIdentifier structure. * * @since 2.1 * * @return An error code - * @param[in] encodedData An instance of DER encoded Tizen::Base::ByteBuffer - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] encodedData An instance of DER encoded Tizen::Base::ByteBuffer + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); /** * Checks whether the specified instance of %AlgorithmIdentifier equals the current instance. * - * @since 2.1 + * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false - * @param[in] rhs An instance of %AlgorithmIdentifier - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * else @c false + * @param[in] rhs An instance of %AlgorithmIdentifier + * @exception E_SUCCESS The method is successful. + * @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; @@ -127,12 +129,12 @@ public: virtual int GetHashCode(void) const; /** - * Gets the copy of %AlgorithmIdentifier instance. + * Gets the copy of the %AlgorithmIdentifier instance. * * @since 2.1 * - * @return Pointer to %AlgorithmIdentifier, containing the copy of the specified instance, @n - * else @c null if an error occurs + * @return A pointer to the %AlgorithmIdentifier instance that is the copy of the specified instance, @n + * else @c null if an error occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ AlgorithmIdentifier* CloneN(void) const; @@ -142,8 +144,8 @@ public: * * @since 2.1 * - * @return Pointer to IAlgorithmParameters, containing the parameter list of algorithm, @n - * else @c null if an no parameters exist + * @return A pointer to the IAlgorithmParameters instance containing the parameter list of algorithm, @n + * else @c null if no parameters exist * @remarks The specific error code can be accessed using the GetLastResult() method. */ IAlgorithmParameters* GetParametersN(void) const; @@ -151,9 +153,9 @@ public: /** * Gets the object ID value of an algorithm in string format. * - * @since 2.1 + * @since 2.1 * - * @return Object ID of %AlgorithmIdentifier in string format like 1.2.3.4 + * @return The object ID of %AlgorithmIdentifier in string format like 1.2.3.4 * */ Tizen::Base::String GetAlgorithmObjectId(void) const; @@ -164,8 +166,8 @@ public: * * @since 2.1 * - * @return Pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @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. diff --git a/inc/FSecPkcsIAlgorithmParameters.h b/inc/FSecPkcsIAlgorithmParameters.h index a9c7f15..1ba2f3c 100755 --- a/inc/FSecPkcsIAlgorithmParameters.h +++ b/inc/FSecPkcsIAlgorithmParameters.h @@ -31,14 +31,14 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @interface IAlgorithmParameters - * @brief This interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic - * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. + * @brief This interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic + * functionalities that must be supported by all the derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. * * @since 2.1 * - * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic - * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. - * This is an abstract class and hence, object of this class cannot be instantiated. + * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic + * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. + * This is an abstract class and hence, object of this class cannot be instantiated. * */ @@ -46,20 +46,20 @@ class _OSP_EXPORT_ IAlgorithmParameters { public: /** - * This polymorphic destructor should be overridden if required. This way, @n - * the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.1 */ virtual ~IAlgorithmParameters(void) {} /** - * Gets the copy of parameters of the specified algorithm type. + * Gets the copy of the parameters of the specified algorithm type. * - * @since 2.1 + * @since 2.1 * - * @return Pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n - * else @c null if an error occurs + * @return A pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n + * else @c null if an error occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IAlgorithmParameters* CloneN(void) const = 0; @@ -67,9 +67,9 @@ public: /** * Gets the PKCS algorithm parameter type enumerated value. * - * @since 2.1 + * @since 2.1 * - * @return PkcsAlgorithmParamterType, containing the enumerated value of PkcsAlgorithmParameterType + * @return The type containing the enumerated value of PkcsAlgorithmParameterType * */ virtual PkcsAlgorithmParameterType GetType(void) const = 0; @@ -82,7 +82,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved1(void) {} @@ -92,7 +92,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved2(void) {} @@ -102,7 +102,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved3(void) {} diff --git a/inc/FSecPkcsInitialVector.h b/inc/FSecPkcsInitialVector.h index c9695af..dc09cde 100755 --- a/inc/FSecPkcsInitialVector.h +++ b/inc/FSecPkcsInitialVector.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %InitialVector class implements the functionalities specified by the %InitialVector class. - * This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE. - * This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption. + * This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE. + * This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption. * * */ @@ -73,18 +73,18 @@ public: * * @return An error code * - * @param[in] initialVector An instance of Tizen::Base::ByteBuffer, holding the initial vector data - * @exception E_SUCCESS The method is successful. + * @param[in] initialVector An instance of Tizen::Base::ByteBuffer holding the initial vector data + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& initialVector); /** - * Gets copy of this instance. + * Gets a copy of this instance. * * @since 2.1 * - * @return A pointer to IAlgorithmParameters, containing the copy of this instance + * @return A pointer to IAlgorithmParameters containing the copy of this instance * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IAlgorithmParameters* CloneN(void) const; @@ -94,7 +94,7 @@ public: * * @since 2.1 * - * @return PkcsAlgorithmParameterType Enum value containing the PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter + * @return PkcsAlgorithmParameterType The enum value containing the @c PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter * */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -105,10 +105,10 @@ public: * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false + * else @c false * @param[in] rhs An instance of %InitialVector - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SUCCESS The method is successful. + * @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; @@ -123,7 +123,7 @@ public: virtual int GetHashCode(void) const; /** - * Gets the instance of Tizen::Base::ByteBuffer that contains the Initial Vector value. + * Gets an instance of Tizen::Base::ByteBuffer that contains the Initial Vector value. * * @since 2.1 * @@ -132,13 +132,13 @@ public: const Tizen::Base::ByteBuffer& GetInitialVector(void) const; /** - * Gets the encoded form of the InitialVector. @n - * It is assumed that each InitialVector type will have only a single form of encoding that is DER encoding. + * Gets the encoded form of the %InitialVector. @n + * It is assumed that each %InitialVector type will have only a single form of encoding that is DER encoding. * * @since 2.1 * - * @return Pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @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. diff --git a/inc/FSecPkcsPkcs05PbEs2Parameters.h b/inc/FSecPkcsPkcs05PbEs2Parameters.h index 92381b8..c6a7af5 100755 --- a/inc/FSecPkcsPkcs05PbEs2Parameters.h +++ b/inc/FSecPkcsPkcs05PbEs2Parameters.h @@ -35,16 +35,15 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05PbEs2Parameters - * @brief This class implements the functionalities specified by the PKCS05 encryption scheme 2. + * @brief This class provides methods for the functionalities specified by the PKCS05 encryption scheme 2. * * @since 2.1 * * The %Pkcs05PbEs2Parameters class implements the functionalities specified by the PKCS05 encryption scheme 2. - * PBES2 combines a password-based key derivation function, which is PBKDF2 - * for PKCS #5 version 2.1, with an underlying encryption scheme. - * The key length and any other parameters for the underlying encryption scheme depends on the scheme. + * PBES2 combines a password-based key derivation function, which is PBKDF2 for PKCS #5 version 2.1, with an underlying + * encryption scheme. The key length and any other parameters for the underlying encryption scheme depends on the scheme. * - * 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 * PBES2-params ::= SEQUENCE { * keyDerivationFunc AlgorithmIdentifier {{PBES2-KDFs}}, @@ -76,26 +75,27 @@ public: virtual ~Pkcs05PbEs2Parameters(void); /** - * Initializes this instance of %Pkcs05PbEs2Parameters with the encoded Tizen::Base::ByteBuffer, which contain Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format. + * Initializes this instance of %Pkcs05PbEs2Parameters with the specified encoded Tizen::Base::ByteBuffer, which contains + * Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format. * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing %Pkcs05PbEs2Parameters - * @exception E_SUCCESS The method is successful. + * @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 this %Pkcs05PbEs2Parameters with specified input parameters values. + * Initializes this %Pkcs05PbEs2Parameters with the specified input parameters values. * * @since 2.1 * * @return An error code - * @param[in] keyDerivationFunction An instance of AlgorithmIdentifier, holding key derivation function - * @param[in] encryptionScheme An instance of AlgorithmIdentifier, holding encryption scheme - * @exception E_SUCCESS The method is successful. + * @param[in] keyDerivationFunction An instance of AlgorithmIdentifier holding key derivation function + * @param[in] encryptionScheme An instance of AlgorithmIdentifier holding encryption scheme + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& keyDerivationFunction, const AlgorithmIdentifier& encryptionScheme); @@ -106,8 +106,8 @@ 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 + * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -115,30 +115,30 @@ public: Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** - * Gets the reference to the AlgorithmIdentifier instance, which 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. + * Gets a reference to the AlgorithmIdentifier instance, which identifies the underlying key derivation function. @n + * It will be an algorithm ID with an OID in the set PBES2-KDFs, which will consist of id-PBKDF2 for this version of PKCS #5. * * @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; /** - * Gets the reference to the AlgorithmIdentifier instance, which identifies the underlying encryption algorithm. @n + * Gets a reference to the AlgorithmIdentifier instance, which identifies the underlying encryption algorithm. @n * It shall be an OID in the set PBES2-Encs, whose definition is left to the application. * * @since 2.1 * - * @return A reference to AlgorithmIdentifier holding the underlying encryption algorithm + * @return A reference to the AlgorithmIdentifier instance holding the underlying encryption algorithm * @remarks The specific error code can be accessed using the GetLastResult() method. */ const AlgorithmIdentifier& GetEncryptionScheme(void) const; /** * Gets the AlgorithmParameters that identifies the underlying parameters such as PbKdf2, PbEs2, PbMac1. @n - * For this class %AlgorithmParameters will be of PBES2 type. + * For this class, %AlgorithmParameters will be of PBES2 type. * * @since 2.1 * @@ -154,7 +154,7 @@ public: * * @since 2.1 * - * @return PkcsAlgorithmParameterType holding enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02 for PBES2 Parameters + * @return The PkcsAlgorithmParameterType instance holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02 for PBES2 Parameters * */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -166,9 +166,9 @@ public: * * @return @c true if the specified instance equals the current instance, @n * else @c false - * @param[in] rhs An instance of %Pkcs05PbEs2Parameters + * @param[in] rhs An instance of %Pkcs05PbEs2Parameters * @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; diff --git a/inc/FSecPkcsPkcs05PbKdf2Parameters.h b/inc/FSecPkcsPkcs05PbKdf2Parameters.h index a04945b..e3d2d9d 100755 --- a/inc/FSecPkcsPkcs05PbKdf2Parameters.h +++ b/inc/FSecPkcsPkcs05PbKdf2Parameters.h @@ -34,15 +34,15 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @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 { @@ -79,56 +79,56 @@ public: 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. + * @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. @@ -141,7 +141,7 @@ public: * * @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; @@ -169,7 +169,7 @@ public: 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 * @@ -180,12 +180,12 @@ public: /** * - * 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. */ @@ -196,7 +196,7 @@ public: * * @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; @@ -207,9 +207,9 @@ public: * * @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; diff --git a/inc/FSecPkcsPkcs05PbMacParameters.h b/inc/FSecPkcsPkcs05PbMacParameters.h index 3e78e00..d164a96 100755 --- a/inc/FSecPkcsPkcs05PbMacParameters.h +++ b/inc/FSecPkcsPkcs05PbMacParameters.h @@ -34,17 +34,16 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05PbMacParameters - * @brief This class implements the functionalities specified by the PKCS05 MAC scheme. + * @brief This class provides methods for the functionalities specified by the PKCS05 MAC scheme. * * @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. + * 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: + * This is defined in ASN.1 as demonstrated in the following code: * @code * PBMAC1-params ::= SEQUENCE { * keyDerivationFunc AlgorithmIdentifier {{PBMAC1-KDFs}}, @@ -75,14 +74,14 @@ public: virtual ~Pkcs05PbMacParameters(void); /** - * Initializes this instance of %Pkcs05PbMacParameters with the Tizen::Base::ByteBuffer instance that contains Password Based Message @n + * 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 Tizen::Base::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); @@ -93,21 +92,21 @@ public: * @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. @n + * 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 Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs. + * 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. @@ -115,44 +114,44 @@ public: Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** - * Gets the reference to the AlgorithmIdentifier instance that identifies the underlying key derivation function. @n + * 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; /** - * 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. + * 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; /** * Gets the AlgorithmParameters that identifies the underlying Parameters such as PbKdf2, PbEs2, PbMac1. @n - * For this class %AlgorithmParameters will be of PbMac1 type. + * 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 @c 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; @@ -165,7 +164,7 @@ public: * 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; diff --git a/inc/FSecPkcsPkcs05Schemes.h b/inc/FSecPkcsPkcs05Schemes.h index e6d3da8..72d4226 100755 --- a/inc/FSecPkcsPkcs05Schemes.h +++ b/inc/FSecPkcsPkcs05Schemes.h @@ -34,13 +34,13 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05Schemes - * @brief This class implements the functionalities specified by the pkcs05 schemes like key derivation function, - * encryption and signature schemes. + * @brief This class provides methods for the functionalities specified by the pkcs05 schemes like key derivation function, + * encryption and signature schemes. * * @since 2.1 * - * The %Pkcs05Schemes class implements the functionalities specified by the pkcs05 schemes like key derivation function, - * encryption and signature schemes. + * The %Pkcs05Schemes class provides methods for the functionalities specified by the pkcs05 schemes like key derivation function, + * encryption and signature schemes. */ class _OSP_EXPORT_ Pkcs05Schemes @@ -68,11 +68,11 @@ public: * @since 2.1 * * @return An error code - * @param[in] password An instance of Tizen::Base::ByteBuffer holding the password - * @param[in] derivedKeyLength A positive integer that contains the length of derived key @n - * It is a variable length in PbEs2 based on the underlying encryption operation. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] password An instance of Tizen::Base::ByteBuffer holding the password + * @param[in] derivedKeyLength The length of the derived key @n + * The length is variable in PbEs2 based on the underlying encryption operation. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& password, int derivedKeyLength); @@ -85,89 +85,88 @@ public: * * @return A pointer to Tizen::Base::ByteBuffer that contains the derived key, @n * else @c null if an error occurs - * @param[in] params An instance of PbKdf2Parameters containing the Kdf2 parameter, - * salt value, iteration count, and key length - * @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] params An instance of PbKdf2Parameters containing the Kdf2 parameter, + * salt value, iteration count, and key length + * @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* GenerateKeyKdf2N(const Pkcs05PbKdf2Parameters& params); /** - * Encrypts the message M under a password P to produce a ciphertext C, by applying selected key derivation function KDF - * (which is GenerateKeyKdf2N) and selected underlying encryption scheme (which can be any block chiper). + * Encrypts the message M under a password P to produce a ciphertext C, by applying the selected key derivation function KDF + * (which is GenerateKeyKdf2N) and the selected underlying encryption scheme (which can be any block chiper). * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer that contains the encrypted message, @n * else @c null if an error occurs - * @param[in] params An instance of the PbEs2Parameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the plain text to encrypt - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbEs2Parameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the plain text to encrypt + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A 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* EncryptionScheme2N(const Pkcs05PbEs2Parameters& params, const Tizen::Base::ByteBuffer& message); /** - * Decrypts the ciphertext C, under a password P to recover message M , by applying selected key derivation function KDF(which is GenerateKeyKdf2N) - * and selected underlying decryption algorithm (which can be any block cipher). + * Decrypts the ciphertext C, under a password P to recover message M , by applying the selected key derivation function KDF + * (which is GenerateKeyKdf2N) and the selected underlying decryption algorithm (which can be any block cipher). * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer that contains the plain text message - * @param[in] params An instance of the PbEs2Parameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the cipher text to decrypt - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbEs2Parameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the cipher text to decrypt + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A 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* DecryptionScheme2N(const Pkcs05PbEs2Parameters& params, const Tizen::Base::ByteBuffer& message); /** - * Gets a message M under a password P to generate a message authentication code T, - * by applying selected key derivation function KDF(which is GenerateKeyKdf2N) and selected underlying message authentication scheme - * (which can be any HMAC algorithm). @n GenerateMacN combines a password-based key derivation function, which shall be - * GenerateKeyKdf2N 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. + * Gets the message M under a password P to generate a message authentication code T, by applying the selected key derivation + * function KDF(which is GenerateKeyKdf2N) and the selected underlying message authentication scheme (which can be any HMAC algorithm). @n + * GenerateMacN combines a password-based key derivation function, which shall be GenerateKeyKdf2N 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. * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer containing the HMAC generated from message, @n * else @c null if an error occurs - * @param[in] params An instance of the PbMacParameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message for which MAC needs to generate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbMacParameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message to generate MAC + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A 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* GetPbHMacN(const Pkcs05PbMacParameters& params, const Tizen::Base::ByteBuffer& message); /** - * Verifies a message M under a password P to verify a message authentication code T, - * by applying a selected key derivation function KDF2 and a selected underlying message authentication scheme combines a - * password-based key derivation function, which shall be GenerateKeyKdf2N for this version of PKCS #5, with an underlying - * message authentication scheme (which can be any SHA-1 or any SHA-2 algorithm). @n The key length and any other parameters - * for the underlying message authentication scheme depend on the scheme. + * Verifies the message M under a password P to verify a message authentication code T, by applying a selected key derivation + * function KDF2 and a selected underlying message authentication scheme. This method combines a password-based key derivation function, + * which shall be GenerateKeyKdf2N for this version of PKCS #5, with an underlying message authentication scheme (which can + * be any SHA-1 or any SHA-2 algorithm). @n + * The key length and any other parameters for the underlying message authentication scheme depend on the scheme. * * @since 2.1 * * @return An error code - * @param[in] params An instance of the PbMacParameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message M - * @param[in] mac An instance of Tizen::Base::ByteBuffer holding the HMAC mac that needs to verify against the message - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbMacParameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message M + * @param[in] mac An instance of Tizen::Base::ByteBuffer holding the HMAC mac to verify against the message + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A 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. */ result VerifyPbMac(const Pkcs05PbMacParameters& params, const Tizen::Base::ByteBuffer& message, const Tizen::Base::ByteBuffer& mac); diff --git a/inc/FSecPkcsPkcs08Attribute.h b/inc/FSecPkcsPkcs08Attribute.h index 578c720..e78e6af 100755 --- a/inc/FSecPkcsPkcs08Attribute.h +++ b/inc/FSecPkcsPkcs08Attribute.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %Pkcs08Attribute class implements the functionalities specified by the %Pkcs08Attribute class. An Attribute object consists - * of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a - * container for adding, inserting, removing, and encoding X.509 AttributeValue. + * of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a + * container for adding, inserting, removing, and encoding X.509 AttributeValue. * */ @@ -63,14 +63,14 @@ public: virtual ~Pkcs08Attribute(void); /** - * Initializes this instance of %Pkcs08Attribute with the Tizen::Base::ByteBuffer that contains the X.509 attribute @n + * Initializes this instance of %Pkcs08Attribute with the specified Tizen::Base::ByteBuffer instance that contains the X.509 attribute * structure in ASN.1 DER format. * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing the X.509 attribute structure - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -81,8 +81,9 @@ public: * @since 2.1 * * @return An error code - * @param[in] attributeType The object identifier of a particular X.509 attribute type @n Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies. - * @exception E_SUCCESS The method is successful. + * @param[in] attributeType The object identifier of a particular X.509 attribute type @n + * Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::String& attributeType); @@ -93,33 +94,33 @@ public: * * @since 2.1 * - * @return Containing the object ID of attribute type in string format like 2.5.4.41 + * @return The string with the object ID of attribute type like 2.5.4.41 * */ Tizen::Base::String GetAttributeType(void) const; /** - * Adds an attribute value in the attribute value list. + * Adds the attribute value in the attribute value list. * * @since 2.1 * * @return An error code - * @param[in] attributeValue An instance of Pkcs08AttributeValue to add an attribute in the list + * @param[in] attributeValue An instance of Pkcs08AttributeValue */ result AddAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * Removes an attribute value from the attribute value list. + * Removes the attribute value from the attribute value list. * * @since 2.1 * * @return An error code - * @param[in] attributeValue An instance of Pkcs08AttributeValue to remove an attribute from the list + * @param[in] attributeValue An instance of Pkcs08AttributeValue */ result RemoveAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * Returns an array list containing the attribute values of type Pkcs08AttributeValue. + * Gets an array list containing the attribute values of type Pkcs08AttributeValue. * * @since 2.1 * @@ -134,7 +135,7 @@ 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 + * 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. diff --git a/inc/FSecPkcsPkcs08AttributeValue.h b/inc/FSecPkcsPkcs08AttributeValue.h index 2333152..186bad4 100755 --- a/inc/FSecPkcsPkcs08AttributeValue.h +++ b/inc/FSecPkcsPkcs08AttributeValue.h @@ -61,14 +61,14 @@ public: virtual ~Pkcs08AttributeValue(void); /** - * Initializes this instance of %Pkcs08AttributeValue with the Tizen::Base::ByteBuffer that contains the AttributeValue @n - * (contain tag, that is, Ans1_Type and the value). + * Initializes this instance of %Pkcs08AttributeValue with the specified Tizen::Base::ByteBuffer that contains the AttributeValue @n + * (contains tag, that is, Ans1_Type and the value). * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer of AttributeValue - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -81,19 +81,19 @@ public: * * @return An error code * @param[in] value An instance of Tizen::Base::ByteBuffer holding raw value - * @param[in] tag A tag holding the tag type @n This tag number is assigned by ASN1 standards for @n - * basic data types. + * @param[in] tag A tag holding the tag type @n This tag number is assigned by ASN1 standards for + * basic data types. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& value, Pkcs08TagValue tag); /** - * Gets a reference to Tizen::Base::ByteBuffer that contains the attribute value. + * Gets a reference to the Tizen::Base::ByteBuffer instance that contains the attribute value. * * @since 2.1 * - * @return A reference to Tizen::Base::ByteBuffer containing raw value + * @return An instance of Tizen::Base::ByteBuffer containing raw value * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Tizen::Base::ByteBuffer& GetValue(void) const; @@ -114,8 +114,8 @@ 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 + * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h index a3c0863..3b6cc05 100755 --- a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h +++ b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h @@ -37,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}}, @@ -68,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); @@ -88,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); @@ -99,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); @@ -136,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); @@ -151,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; diff --git a/inc/FSecPkcsPkcs08PrivateKeyInfo.h b/inc/FSecPkcsPkcs08PrivateKeyInfo.h index 662f2e8..e507597 100755 --- a/inc/FSecPkcsPkcs08PrivateKeyInfo.h +++ b/inc/FSecPkcsPkcs08PrivateKeyInfo.h @@ -73,16 +73,16 @@ public: virtual ~Pkcs08PrivateKeyInfo(void); /** - * 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 + * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer that contains pkcs08 private key info + * structure(PrivateKeyInfo) in ASN.1 DER format. @n * 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 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. + * @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); @@ -92,16 +92,16 @@ public: * @since 2.1 * * @return An error code. - * @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 A specified input parameter is invalid. + * @param[in] keyAlgorithmId An instance of AlgorithmIdentifier holding the algorithm identifier of the private key algorithm + * @param[in] privateKey An instance of Tizen::Base::ByteBuffer holding the private key + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& keyAlgorithmId, const Tizen::Base::ByteBuffer& privateKey); /** - * 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. + * Gets the private key syntax version number of PrivateKeyInfo object that is used for storing private key and its related + * information and default value of this version is @c 0. * * @since 2.1 * @@ -111,7 +111,7 @@ public: int GetVersion(void) const; /** - * Gets the reference to AlgorithmIdentifier that identifies the secret key algorithm. + * Gets a reference to AlgorithmIdentifier that identifies the secret key algorithm. * * @since 2.1 * @@ -121,7 +121,7 @@ public: const AlgorithmIdentifier& GetPrivateKeyAlgorithm(void) const; /** - * Gets the reference to Tizen::Base::ByteBuffer that contains the private key in binary format. + * Gets a reference to Tizen::Base::ByteBuffer that contains the private key in binary format. * * @since 2.1 * @@ -131,7 +131,7 @@ public: const Tizen::Base::ByteBuffer& GetPrivateKey(void) const; /** - * Gets the attributes of the type Pkcs08Attribute that are extended information of the private key in context. + * Gets the attributes of the type Pkcs08Attribute that are the extended information of the private key in context. * * @since 2.1 * @@ -140,7 +140,7 @@ public: const Tizen::Base::Collection::ArrayList& GetAttributes(void) const; /** - * Adds the attributes in private key information that is extended information of the private key in context. + * Adds the attributes in private key information that is the extended information of the private key in context. * * @since 2.1 * @@ -150,7 +150,7 @@ public: result AddAttribute(const Pkcs08Attribute& attributes); /** - * Removes the attribute in private key information that is extended information of the private key in context. + * Removes the attributes from the private key information that is the extended information of the private key in context. * * @since 2.1 * @@ -158,7 +158,7 @@ public: * @param[in] attributes An instance of Pkcs08Attribute */ result RemoveAttribute(const Pkcs08Attribute& attributes); - + /** * Gets the DER encoded %Pkcs08PrivateKeyInfo structure. * diff --git a/inc/FSecPkcsRc2CbcParameters.h b/inc/FSecPkcsRc2CbcParameters.h index d5d3a8d..4147faa 100755 --- a/inc/FSecPkcsRc2CbcParameters.h +++ b/inc/FSecPkcsRc2CbcParameters.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %Rc2CbcParameters class implements the functionalities specified by the Rc2 Cbc mode parameter. - * This class represents the Rc2 cbc mode parameter for symmetric ciphers RC2. - * ASN.1 format for RC2-CBC-Parameter ::= SEQUENCE { + * This class represents the Rc2 cbc mode parameter for symmetric ciphers RC2. + * ASN.1 format for RC2-CBC-Parameter ::= SEQUENCE { * rc2ParameterVersion INTEGER OPTIONAL, * iv OCTET STRING (SIZE(8)) } * @@ -72,12 +72,12 @@ public: * @since 2.1 * * @return An error code - * @param[in] initialVector An instance of Tizen::Base::ByteBuffer containing the initial vector - * @param[in] version An integer value that defines the rc2 cbc parameter version @n - * As per Pkcs 5 standard, possible values can be 160,120,58, or any value - * greater than or equal to 256. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @param[in] initialVector An instance of Tizen::Base::ByteBuffer containing the initial vector + * @param[in] version An integer value that defines the rc2 cbc parameter version @n + * As per Pkcs 5 standard, possible values can be 160,120,58, or any value + * greater than or equal to 256. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& initialVector, int version = 0); @@ -107,10 +107,10 @@ public: * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false + * else @c false * @param[in] rhs An instance of %Rc2CbcParameters * @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; @@ -151,7 +151,7 @@ public: * @since 2.1 * * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * 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. diff --git a/inc/FSecPkcsTypes.h b/inc/FSecPkcsTypes.h index c9cd4fd..5deb37c 100755 --- a/inc/FSecPkcsTypes.h +++ b/inc/FSecPkcsTypes.h @@ -18,7 +18,7 @@ * @file FSecPkcsTypes.h * @brief This is the header file for the declarations of the %PkcsAlgorithmParameterType and %Pkcs08TagValue enumerators and the AttributeType OID List. * - * This header file contains the declarations of the %PkcsAlgorithmParameterType and %Pkcs08TagValue enumerators and the AttributeType OID List. + * This header file contains the declarations of the PkcsAlgorithmParameterType and Pkcs08TagValue enumerators and the AttributeType OID List. */ #ifndef _FSEC_PKCS_TYPES_H_ @@ -30,7 +30,7 @@ namespace Tizen { namespace Security { namespace Pkcs { /** - * @enum PkcsAlgorithmParameterType + * @enum PkcsAlgorithmParameterType * * Defines the types of parameters. * @@ -38,97 +38,97 @@ namespace Tizen { namespace Security { namespace Pkcs */ enum PkcsAlgorithmParameterType { - PKCS_ALGO_PARAM_TYPE_IV, /**< The parameter type is initial vector */ - PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02, /**< The parameter type is pkcs5 password based encryption scheme2 */ - PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02, /**< The parameter type is pkcs5 password based key derivation scheme2 */ - PKCS_ALGO_PARAM_TYPE_PKCS05_MAC, /**< The parameter type is pkcs5 message authentication scheme */ - PKCS_ALGO_PARAM_TYPE_RC2, /**< The parameter type is rc2 cbc */ - PKCS_ALGO_PARAM_TYPE_UNKOWN = 0xFFFFFFFF /**< An unknown parameter type */ + PKCS_ALGO_PARAM_TYPE_IV, /**< The parameter type is initial vector */ + PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02, /**< The parameter type is pkcs5 password based encryption scheme2 */ + PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02, /**< The parameter type is pkcs5 password based key derivation scheme2 */ + PKCS_ALGO_PARAM_TYPE_PKCS05_MAC, /**< The parameter type is pkcs5 message authentication scheme */ + PKCS_ALGO_PARAM_TYPE_RC2, /**< The parameter type is rc2 cbc */ + PKCS_ALGO_PARAM_TYPE_UNKOWN = 0xFFFFFFFF /**< An unknown parameter type */ }; //PkcsAlgorithmParameterType; /** - * @enum Pkcs08TagValue + * @enum Pkcs08TagValue * * Defines the Asn1 tag type. * - * @since 2.1 + * @since 2.1 */ enum Pkcs08TagValue { - PKCS08_TAG_RESERVED = 0, /**< Reserved for use by the encoding rules */ - PKCS08_TAG_BOOLEAN = 1, /**< An arbitrary bool value */ - PKCS08_TAG_INTEGER = 2, /**< An arbitrary integer value */ - PKCS08_TAG_BITSTRING = 3, /**< An arbitrary string of bits */ - PKCS08_TAG_OCTETSTRING = 4, /**< An arbitrary string of octets */ - PKCS08_TAG_NULL = 5, /**< A null value */ - PKCS08_TAG_OBJECT_ID = 6, /**< An object identifier */ - PKCS08_TAG_OBJECT_DES = 7, /**< An object descriptor providing a brief description of an object */ - PKCS08_TAG_EXTERNAL = 8, /**< An arbitrary external value */ - PKCS08_TAG_REAL = 9, /**< An arbitrary real value */ - PKCS08_TAG_ENUM = 10, /**< An enumerated value */ - PKCS08_TAG_EMBEDDED = 11, /**< An embedded value */ - PKCS08_TAG_UTF8STRING = 12, /**< An arbitrary utf8 string */ - PKCS08_TAG_REL_OBJ_ID = 13, /**< A relative object ID */ - PKCS08_TAG_SEQUENCE = 16, /**< An ordered collection of one or more types */ - PKCS08_TAG_SET = 17, /**< An unordered collection of one or more types */ - PKCS08_TAG_CHAR_STRING = 18, /**< A numeric string */ - PKCS08_TAG_PRINTABLE_STRING = 19, /**< An arbitrary string of printable characters */ - PKCS08_TAG_TELETEXT_STRING = 20, /**< A teletext string, T61 string */ - PKCS08_TAG_VIDEOTEXT_STRING = 21, /**< A videotext string */ - PKCS08_TAG_IA5STRING = 22, /**< An arbitrary string of IA5 (ASCII) characters */ - PKCS08_TAG_UTC_TIME = 23, /**< A coordinated universal time or Greenwich Mean Time (GMT) value */ - PKCS08_TAG_GEN_TIME = 24, /**< A generalized time */ - PKCS08_TAG_GRAPHICS_STRING = 25, /**< A graphic string */ - PKCS08_TAG_VISIBLE_STRING = 26, /**< A visible string, ISO64 string */ - PKCS08_TAG_GENERAL_STRING = 27, /**< A general string */ - PKCS08_TAG_UNIVERSAL_STRING = 28, /**< A universal string */ - PKCS08_TAG_CHARACTER_STRING = 29, /**< An arbitrary character string */ - PKCS08_TAG_BMP_STRING = 30, /**< A bmp string */ - PKCS08_TAG_UNKNOWN = -1 /**< An unknown tag type */ + PKCS08_TAG_RESERVED = 0, /**< Reserved for use by the encoding rules */ + PKCS08_TAG_BOOLEAN = 1, /**< An arbitrary bool value */ + PKCS08_TAG_INTEGER = 2, /**< An arbitrary integer value */ + PKCS08_TAG_BITSTRING = 3, /**< An arbitrary string of bits */ + PKCS08_TAG_OCTETSTRING = 4, /**< An arbitrary string of octets */ + PKCS08_TAG_NULL = 5, /**< A null value */ + PKCS08_TAG_OBJECT_ID = 6, /**< An object identifier */ + PKCS08_TAG_OBJECT_DES = 7, /**< An object descriptor providing a brief description of an object */ + PKCS08_TAG_EXTERNAL = 8, /**< An arbitrary external value */ + PKCS08_TAG_REAL = 9, /**< An arbitrary real value */ + PKCS08_TAG_ENUM = 10, /**< An enumerated value */ + PKCS08_TAG_EMBEDDED = 11, /**< An embedded value */ + PKCS08_TAG_UTF8STRING = 12, /**< An arbitrary utf8 string */ + PKCS08_TAG_REL_OBJ_ID = 13, /**< A relative object ID */ + PKCS08_TAG_SEQUENCE = 16, /**< An ordered collection of one or more types */ + PKCS08_TAG_SET = 17, /**< An unordered collection of one or more types */ + PKCS08_TAG_CHAR_STRING = 18, /**< A numeric string */ + PKCS08_TAG_PRINTABLE_STRING = 19, /**< An arbitrary string of printable characters */ + PKCS08_TAG_TELETEXT_STRING = 20, /**< A teletext string, T61 string */ + PKCS08_TAG_VIDEOTEXT_STRING = 21, /**< A videotext string */ + PKCS08_TAG_IA5STRING = 22, /**< An arbitrary string of IA5 (ASCII) characters */ + PKCS08_TAG_UTC_TIME = 23, /**< A coordinated universal time or Greenwich Mean Time (GMT) value */ + PKCS08_TAG_GEN_TIME = 24, /**< A generalized time */ + PKCS08_TAG_GRAPHICS_STRING = 25, /**< A graphic string */ + PKCS08_TAG_VISIBLE_STRING = 26, /**< A visible string, ISO64 string */ + PKCS08_TAG_GENERAL_STRING = 27, /**< A general string */ + PKCS08_TAG_UNIVERSAL_STRING = 28, /**< A universal string */ + PKCS08_TAG_CHARACTER_STRING = 29, /**< An arbitrary character string */ + PKCS08_TAG_BMP_STRING = 30, /**< A bmp string */ + PKCS08_TAG_UNKNOWN = -1 /**< An unknown tag type */ }; // Pkcs08TagValue; /* -- Basic object identifiers in Pkcs05 and Pkcs08 */ -_OSP_EXPORT_ extern const wchar_t OID_PBKDF2[]; /**< An object identifier for password based key derivation function scheme2 */ -_OSP_EXPORT_ extern const wchar_t OID_PBES2[]; /**< An object identifier for password based encryption scheme2 */ -_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[]; /**< An object identifier for password based message authentication scheme1 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA1[]; /**< An object identifier for hmac-sha1 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_224[]; /**< An object identifier for hmac-sha224 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_256[]; /**< An object identifier for hmac-sha256 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_384[]; /**< An object identifier for hmac-sha384 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_512[]; /**< An object identifier for hmac-sha512 */ -_OSP_EXPORT_ extern const wchar_t OID_DES_CBC[]; /**< An object identifier for des-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_DES_CBC_EDE3[]; /**< An object identifier for des-cbc-ede3 mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_128_CBC[]; /**< An object identifier for aes-128-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_192_CBC[]; /**< An object identifier for aes-192-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_256_CBC[]; /**< An object identifier for aes-256-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_RC2_CBC[]; /**< An object identifier for rc2-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_RSA_ENCRYPTION[]; /**< An object identifier for RSA encryption scheme */ +_OSP_EXPORT_ extern const wchar_t OID_PBKDF2[]; /**< An object identifier for password based key derivation function scheme2 */ +_OSP_EXPORT_ extern const wchar_t OID_PBES2[]; /**< An object identifier for password based encryption scheme2 */ +_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[]; /**< An object identifier for password based message authentication scheme1 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA1[]; /**< An object identifier for hmac-sha1 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_224[]; /**< An object identifier for hmac-sha224 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_256[]; /**< An object identifier for hmac-sha256 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_384[]; /**< An object identifier for hmac-sha384 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_512[]; /**< An object identifier for hmac-sha512 */ +_OSP_EXPORT_ extern const wchar_t OID_DES_CBC[]; /**< An object identifier for des-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_DES_CBC_EDE3[]; /**< An object identifier for des-cbc-ede3 mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_128_CBC[]; /**< An object identifier for aes-128-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_192_CBC[]; /**< An object identifier for aes-192-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_256_CBC[]; /**< An object identifier for aes-256-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_RC2_CBC[]; /**< An object identifier for rc2-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_RSA_ENCRYPTION[]; /**< An object identifier for RSA encryption scheme */ /* -- Basic object identifiers in Pkcs08 for AttributeType */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[]; /**< An object identifier for attribute type name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[]; /**< An object identifier for attribute type surname */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< An object identifier for attribute type of any given name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[]; /**< An object identifier for attribute type initial */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[]; /**< An object identifier for attribute type generation qualifier */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< An object identifier for attribute type common name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[]; /**< An object identifier for attribute type locality name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[]; /**< An object identifier for attribute type state/province name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< An object identifier for attribute type of any organization name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[]; /**< An object identifier for any organization unit name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< An object identifier for attribute type title */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[]; /**< An object identifier for distinguished name qualifier */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[]; /**< An object identifier for attribute type country name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[]; /**< An object identifier for attribute type serial number */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< An object identifier for attribute type pseudonym */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< An object identifier for any domain component */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[]; /**< An object identifier for any email address */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[]; /**< An object identifier for attribute type name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[]; /**< An object identifier for attribute type surname */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< An object identifier for attribute type of any given name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[]; /**< An object identifier for attribute type initial */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[]; /**< An object identifier for attribute type generation qualifier */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< An object identifier for attribute type common name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[]; /**< An object identifier for attribute type locality name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[]; /**< An object identifier for attribute type state/province name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< An object identifier for attribute type of any organization name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[]; /**< An object identifier for any organization unit name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< An object identifier for attribute type title */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[]; /**< An object identifier for distinguished name qualifier */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[]; /**< An object identifier for attribute type country name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[]; /**< An object identifier for attribute type serial number */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< An object identifier for attribute type pseudonym */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< An object identifier for any domain component */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[]; /**< An object identifier for any email address */ } } } // Tizen::Security::Pkcs diff --git a/inc/FSecPrivacyInfo.h b/inc/FSecPrivacyInfo.h index 2bd6004..05b5ac3 100755 --- a/inc/FSecPrivacyInfo.h +++ b/inc/FSecPrivacyInfo.h @@ -13,25 +13,25 @@ // See the License for the specific language governing permissions and // limitations under the License. // - + /** -* @file FSecPrivacyInfo.h -* @brief This is the header file for the %PrivacyInfo class. +* @file FSecPrivacyInfo.h +* @brief This is the header file for the %PrivacyInfo class. * * This header file contains the declarations of the %PrivacyInfo class. */ - + #ifndef _FSEC_PRIVACY_INFO_H_ #define _FSEC_PRIVACY_INFO_H_ - + #include - + namespace Tizen { namespace Security { - + /** * @class PrivacyInfo -* @brief This class represents the privacy information. +* @brief This class provides methods for the privacy information. * * @since 2.1 * @@ -40,13 +40,13 @@ namespace Tizen { namespace Security * The %PrivacyInfo class represents the privacy information. * This class provides methods to retrieve the name and description of privilege. */ - + class _OSP_EXPORT_ PrivacyInfo : public Tizen::Base::Object { public: - + /** * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. @@ -54,7 +54,7 @@ public: * @since 2.1 */ PrivacyInfo(void); - + /** * This destructor overrides Tizen::Base::Object::~Object(). * @@ -62,7 +62,7 @@ public: * */ virtual ~PrivacyInfo(void); - + /** * Initializes this instance of %PrivacyInfo with the specified parameters. * @@ -71,15 +71,15 @@ public: * @return An error code * @param[in] privacyId The privacy ID * @param[in] enable Set to @c true to enable the privacy setting, @n - * else @c false + * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId does not exist. * */ result Construct(const Tizen::Base::String& privacyId, bool enable = false); - + /** - * Gets a privacy ID. + * Gets the privacy ID. * * @since 2.1 * @@ -87,7 +87,7 @@ public: * */ Tizen::Base::String GetId(void) const; - + /** * Checks whether the privacy setting is enabled. * @@ -98,20 +98,21 @@ public: * @see SetEnabled() */ bool IsEnabled(void) const; - + /** * Enables or disables the privacy setting. * * @since 2.1 * - * @param[in] enable A Boolean value indicating whether the privacy setting is enabled + * @param[in] enable @c true if the privacy setting is enabled, @n + * else @c false * @see IsEnabled() * */ void SetEnabled(bool enable); - + /** - * Gets a localized display name of privacy. + * Gets the localized display name of privacy. * * @since 2.1 * @@ -120,9 +121,9 @@ public: * */ Tizen::Base::String GetDisplayName(void) const; - + /** - * Gets a localized description of privacy. + * Gets the localized description of privacy. * * @since 2.1 * @@ -131,31 +132,31 @@ public: * */ Tizen::Base::String GetDescription(void) const; - + private: - + // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivacyInfo + // @param[in] rhs An instance of %PrivacyInfo // PrivacyInfo(const PrivacyInfo& rhs); - + // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivacyInfo + // @param[in] rhs An instance of %PrivacyInfo // PrivacyInfo& operator =(const PrivacyInfo& rhs); - + private: - + class _PrivacyInfoImpl* __pImpl; friend class _PrivacyInfoImpl; - + }; // PrivacyInfo - + } } // Tizen::Security - + #endif // _FSEC_PRIVACY_INFO_H_ - + diff --git a/inc/FSecPrivacyManager.h b/inc/FSecPrivacyManager.h index ad91939..52b1beb 100755 --- a/inc/FSecPrivacyManager.h +++ b/inc/FSecPrivacyManager.h @@ -13,17 +13,17 @@ // See the License for the specific language governing permissions and // limitations under the License. // - + /** * @file FSecPrivacyManager.h * @brief This is the header file for the %PrivacyManager class. * * This header file contains the declarations of the %PrivacyManager class. */ - + #ifndef _FSEC_PRIVACY_MANAGER_H_ #define _FSEC_PRIVACY_MANAGER_H_ - + #include #include @@ -34,42 +34,42 @@ class IList; namespace Tizen { namespace Security { - + class PrivacyInfo; - + /** - * @class PrivacyManager - * @brief This class gets the privacy information and manages an application's privacy settings. + * @class PrivacyManager + * @brief This class provides methods for managing the privacy information and the application's privacy settings. * - * @since 2.1 + * @since 2.1 * - * @final This class is not intended for extension. + * @final This class is not intended for extension. * * The %PrivacyManager class lets an application to get or save application's privacy settings. */ - + class _OSP_EXPORT_ PrivacyManager : public Tizen::Base::Object { public: - + /** - * Gets the privacy manager instance. + * Gets a pointer to the %PrivacyManager instance. * * @since 2.1 * * @return A pointer to the %PrivacyManager instance, @n * else @c null if it fails * - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @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. */ static PrivacyManager* GetInstance(void); - + /** - * Gets a list of packages which access user's privacy information. + * Gets the list of packages which access user's privacy information. * * @since 2.1 * @privlevel platform @@ -85,9 +85,9 @@ public: * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPrivacyAppPackageListN(void) const; - + /** - * Gets a list of privacy information of a package. + * Gets the list of privacy information of a package. * * @since 2.1 * @privlevel platform @@ -106,7 +106,7 @@ public: Tizen::Base::Collection::IList* GetPrivacyInfoListN(const Tizen::App::PackageId& packageId) const; /** - * Sets a specific privacy setting of a package. + * Sets the privacy setting of the specified package. * * @since 2.1 * @privlevel platform @@ -116,52 +116,53 @@ public: * @param[in] packageId The package ID * @param[in] privacyInfo The privacy information to set * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c packageId is not found in privacy database or @n - * the package is not defined to access the privacy information. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The specified @c packageId is not found in privacy database. + * - The package is not defined to access the privacy information. * @exception E_INVALID_ARG The specified @c packageId length is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * */ result SetAppPackagePrivacy(const Tizen::App::PackageId& packageId, const PrivacyInfo& privacyInfo); - + private: - + // // This default constructor is intentionally declared as private to implement the %Singleton semantic. // - // @since 2.1 + // @since 2.1 // PrivacyManager(void); - + // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.1 + // @since 2.1 // PrivacyManager(const PrivacyManager& rhs); - + // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.1 + // @since 2.1 // PrivacyManager& operator =(const PrivacyManager& rhs); - + // // This destructor is intentionally declared as private to implement the %Singleton semantic. // - // @since 2.1 + // @since 2.1 // virtual ~PrivacyManager(void); - + private: - + class _PrivacyManagerImpl* __pPrivacyManagerImpl; friend class _PrivacyManagerImpl; - + }; // PrivacyManager - + }} // Tizen::Security - + #endif // _FSEC_PRIVACY_MANAGER_H_ diff --git a/inc/FSecPrivateKey.h b/inc/FSecPrivateKey.h index 0cc1ef0..425f17b 100644 --- a/inc/FSecPrivateKey.h +++ b/inc/FSecPrivateKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecPrivateKey.h + * @file FSecPrivateKey.h * @brief This is the header file for the %PrivateKey class. * * This header file contains the declarations of the %PrivateKey class. @@ -32,13 +32,13 @@ namespace Tizen { namespace Security /** * @class PrivateKey - * @brief This class specifies the RSA private key. + * @brief This class provides methods to manage the RSA private key. * - * @since 2.0 + * @since 2.0 * - * The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @n + * The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see IKey * @see IPrivateKey @@ -54,43 +54,43 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ PrivateKey(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~PrivateKey(void); /** * Gets the name of the primary encoding format of the current instance of %PrivateKey. * - * @since 2.0 + * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const; /** * Gets the private key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const; /** * Sets the private key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer diff --git a/inc/FSecPrivilegeInfo.h b/inc/FSecPrivilegeInfo.h index c4362a5..af5a82b 100755 --- a/inc/FSecPrivilegeInfo.h +++ b/inc/FSecPrivilegeInfo.h @@ -23,9 +23,9 @@ #ifndef _FSEC_PRIVILEGE_INFO_H_ #define _FSEC_PRIVILEGE_INFO_H_ - + #include - + namespace Tizen { namespace Security { @@ -33,7 +33,7 @@ class _PrivilegeInfoImpl; /** * @class PrivilegeInfo -* @brief This class represents the privilege information. +* @brief This class provides methods for managing the privilege information. * * @since 2.1 * @@ -53,7 +53,7 @@ public: * The object is not fully constructed after this constructor is called. @n * For full construction, the Construct() method must be called right after calling this constructor. * - * @since 2.1 + * @since 2.1 */ PrivilegeInfo(void); @@ -68,22 +68,22 @@ public: /** * Initializes this instance of %PrivilegeInfo with the specified parameters. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] privilegeId The privilege ID - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c privilegeId is invalid. + * @return An error code + * @param[in] privilegeId The privilege ID + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c privilegeId is invalid. * */ result Construct(const Tizen::Base::String& privilegeId); /** - * Gets a privilege ID. + * Gets the privilege ID. * - * @since 2.1 + * @since 2.1 * - * @return The privilege ID + * @return The privilege ID * */ Tizen::Base::String GetId(void) const; @@ -91,10 +91,10 @@ public: /** * Gets the localized display name of privilege. * - * @since 2.1 + * @since 2.1 * - * @return The display name of privilege, @n - * else an empty string is returned if there is no value + * @return The display name of privilege, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDisplayName(void) const; @@ -102,10 +102,10 @@ public: /** * Gets the localized description of privilege. * - * @since 2.1 + * @since 2.1 * - * @return The description of privilege, @n - * else an empty string is returned if there is no value + * @return The description of privilege, @n + * else an empty string is returned if there is no value * */ Tizen::Base::String GetDescription(void) const; @@ -115,14 +115,14 @@ private: // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivilegeInfo + // @param[in] rhs An instance of %PrivilegeInfo // PrivilegeInfo(const PrivilegeInfo& rhs); // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivilegeInfo + // @param[in] rhs An instance of %PrivilegeInfo // PrivilegeInfo& operator =(const PrivilegeInfo& rhs); diff --git a/inc/FSecPublicKey.h b/inc/FSecPublicKey.h index 53f37bb..63ab2b9 100644 --- a/inc/FSecPublicKey.h +++ b/inc/FSecPublicKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecPublicKey.h + * @file FSecPublicKey.h * @brief This is the header file for the %PublicKey class. * * This header file contains the declarations of the %PublicKey class. @@ -32,9 +32,9 @@ namespace Tizen { namespace Security /** * @class PublicKey - * @brief This class specifies the RSA public key. + * @brief This class provides methods for managing the RSA public key. * - * @since 2.0 + * @since 2.0 * * The %PublicKey class manages a public key, which is used in asymmetric ciphers. * The RSA algorithm encrypts the data using the public key. @n @@ -54,21 +54,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ PublicKey(void); /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~PublicKey(void); /** * Gets the name of the primary encoding format of the current instance of %PublicKey. * - * @since 2.0 + * @since 2.0 * * @return The primary encoding format of the key */ @@ -77,20 +77,20 @@ public: /** * Gets the public key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const; /** * Sets the public key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer @@ -105,14 +105,14 @@ private: // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.0 + // @since 2.0 // PublicKey(const PublicKey& rhs); // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.0 + // @since 2.0 // PublicKey& operator =(const PublicKey& rhs); diff --git a/inc/FSecRsaKeyConverter.h b/inc/FSecRsaKeyConverter.h index 1cf437a..90cf88b 100755 --- a/inc/FSecRsaKeyConverter.h +++ b/inc/FSecRsaKeyConverter.h @@ -15,7 +15,7 @@ // /** - * @file FSecRsaKeyConverter.h + * @file FSecRsaKeyConverter.h * @brief This is the header file for the %RsaKeyConverter class. * * This header file contains the declarations of the %RsaKeyConverter class. @@ -31,30 +31,30 @@ namespace Tizen { namespace Security { /** - * @enum RsaKeyFormat + * @enum RsaKeyFormat * - * Defines the types of rsa key format. + * Defines the types of rsa key format. * - * @since 2.1 + * @since 2.1 */ enum RsaKeyFormat { - RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY = 0, /**< The rsa key format is PKCS1 private key */ - RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY = 1, /**< The rsa key format is PKCS1 public key */ - RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY = 2, /**< The rsa key format is PKCS8 private key */ - RSA_KEY_FORMAT_X509_PUBLIC_KEY = 3, /**< The rsa key format is X509 public key */ - RSA_KEY_FORMAT_UNKNOWN = 0xffffffff /**< The rsa key format is unknown */ + RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY = 0, /**< The rsa key format is PKCS1 private key */ + RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY = 1, /**< The rsa key format is PKCS1 public key */ + RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY = 2, /**< The rsa key format is PKCS8 private key */ + RSA_KEY_FORMAT_X509_PUBLIC_KEY = 3, /**< The rsa key format is X509 public key */ + RSA_KEY_FORMAT_UNKNOWN = 0xffffffff /**< The rsa key format is unknown */ }; //RsaKeyFormat; /** - * @class RsaKeyConverter - * @brief This class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. + * @class RsaKeyConverter + * @brief This class provides methods for converting the RSA public/private key in multiple key formats and multiple encoding formats. * - * @since 2.1 + * @since 2.1 * - * The %RsaKeyConverter class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. @n - * Supported RSA key formats are PKCS1/PKCS8/X509. @n - * Supported encoding formats are DER/PEM. + * The %RsaKeyConverter class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. @n + * The supported RSA key formats are PKCS1/PKCS8/X509. @n + * The supported encoding formats are DER/PEM. */ class _OSP_EXPORT_ RsaKeyConverter @@ -62,38 +62,40 @@ class _OSP_EXPORT_ RsaKeyConverter public: /** - * Generates a RSA encoded private key in the passed input RSA key format. @n + * Generates an RSA encoded private key in the passed input RSA key format. @n * If the input private key is in PEM encoded format, then the output RSA private key will be PEM encoded; if it is in DER encoded format, * then the output RSA private key will be DER encoded. * * @since 2.1 * * @return A pointer to the encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the private key in the passed input format - * @param[in] format An enum value that contains the RSA private key format @n - * Valid values for the supported output RSA private key formats are only @c RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY and @c RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY. - * @param[in] key An instance of IPrivateKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the private key in the passed input format + * @param[in] format An enum value that contains the RSA private key format @n + * The valid values for the supported output RSA private key formats are only + * @c RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY and @c RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY. + * @param[in] key An instance of IPrivateKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPrivateKeyFormatN(RsaKeyFormat format, const IPrivateKey& key); /** - * Generates a RSA encoded public key in the passed input RSA key format. @n + * Generates an RSA encoded public key in the passed input RSA key format. @n * If the input public key is in PEM encoded format, then the output RSA public key will be PEM encoded; if it is in DER encoded format, * then the output RSA public key will be DER encoded. * * @since 2.1 * * @return A pointer to the encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the public key in the passed input format - * @param[in] format An enum value that contains the RSA public key format @n - * Valid values for the supported output RSA public key formats are only @c RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY and @c RSA_KEY_FORMAT_X509_PUBLIC_KEY. - * @param[in] key An instance of IPublicKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the public key in the passed input format + * @param[in] format An enum value that contains the RSA public key format @n + * The valid values for the supported output RSA public key formats are only + * @c RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY and @c RSA_KEY_FORMAT_X509_PUBLIC_KEY. + * @param[in] key An instance of IPublicKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPublicKeyFormatN(RsaKeyFormat format, const IPublicKey& key); @@ -103,12 +105,12 @@ public: * @since 2.1 * * @return A pointer to the PEM encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the key in the PEM encoded format - * @param[in] format An enum value that contains the RSA key format of the input key - * @param[in] key An instance of IKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the key in the PEM encoded format + * @param[in] format An enum value that contains the RSA key format of the input key + * @param[in] key An instance of IKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertDerToPemN(RsaKeyFormat format, const IKey& key); @@ -118,12 +120,12 @@ public: * @since 2.1 * * @return A pointer to the DER encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the key in the DER encoded format + * else @c null if the method fails to convert the key in the DER encoded format * @param[in] format An enum value that contains the RSA key format of the input key * @param[in] key An instance of IKey - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPemToDerN(RsaKeyFormat format, const IKey& key); @@ -160,7 +162,7 @@ private: class _RsaKeyConverterImpl* __pRsaKeyConverterImpl; friend class _RsaKeyConverterImpl; -}; //RsaKeyConverter +}; //RsaKeyConverter } } //Tizen::Security diff --git a/inc/FSecSecretKey.h b/inc/FSecSecretKey.h index 643c582..b3fedcb 100644 --- a/inc/FSecSecretKey.h +++ b/inc/FSecSecretKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecSecretKey.h + * @file FSecSecretKey.h * @brief This is the header file for the %SecretKey class. * * This header file contains the declarations of the %SecretKey class. @@ -32,18 +32,19 @@ namespace Tizen { namespace Security /** * @class SecretKey - * @brief This class specifies a secret key. + * @brief This class provides methods for managing a secret key. * - * @since 2.0 + * @since 2.0 * - * The %SecretKey class manages a secret key, which is used in symmetric ciphers, such as Advanced Encryption Standard (AES), Data Encryption Standard (DES), and Triple Data Encryption Standard (3DES). @n + * The %SecretKey class manages a secret key, which is used in symmetric ciphers, such as Advanced Encryption Standard (AES), + * Data Encryption Standard (DES), and Triple Data Encryption Standard (3DES). @n * * For more information on the class features, see Key Management and CSPRNG. * - * @see IKey - * @see ISecretKey - * @see SecretKeyGenerator - * @see ISecretKeyGenerator + * @see IKey + * @see ISecretKey + * @see SecretKeyGenerator + * @see ISecretKeyGenerator */ class _OSP_EXPORT_ SecretKey : public virtual IKey @@ -55,21 +56,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ SecretKey(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~SecretKey(void); /** * Gets the name of the primary encoding format of the current instance of %SecretKey. * - * @since 2.0 + * @since 2.0 * * @return The primary encoding format of a key */ @@ -78,10 +79,10 @@ public: /** * Gets the secret key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -91,12 +92,12 @@ public: /** * Sets the secret key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c keyBuffer is invalid. + * @exception E_INVALID_ARG The specified @c keyBuffer is invalid. */ virtual result SetKey(const Tizen::Base::ByteBuffer& keyBuffer); @@ -122,7 +123,7 @@ private: class _SecretKeyImpl* __pSecretKeyImpl; friend class _SecretKeyImpl; -}; //SecretKey +}; //SecretKey } } // Tizen::Security diff --git a/inc/FSecSecretKeyGenerator.h b/inc/FSecSecretKeyGenerator.h index 9671a65..ac91aac 100755 --- a/inc/FSecSecretKeyGenerator.h +++ b/inc/FSecSecretKeyGenerator.h @@ -33,11 +33,12 @@ namespace Tizen { namespace Security /** * @class SecretKeyGenerator - * @brief This class is used for generating a secret (symmetric) key. + * @brief This class provides methods for generating a secret (symmetric) key. * - * @since 2.0 + * @since 2.0 * - * The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key is based on an encryption algorithm. @n + * The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key + * is based on an encryption algorithm. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -50,24 +51,24 @@ class _OSP_EXPORT_ SecretKeyGenerator public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ SecretKeyGenerator(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~SecretKeyGenerator(void); /** * Constructs and initializes this instance of %SecretKeyGenerator with the specified key. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBytes The key of type Tizen::Base::ByteBuffer @@ -80,11 +81,11 @@ public: /** * Constructs and initializes this instance of %SecretKeyGenerator for the specified @c algorithm. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] algorithm The name of the secure random generator algorithm @n - * For example, "AES","DES", or "3DES". + * For example, "AES","DES", or "3DES". * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c algorithm is invalid or an empty string. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -95,7 +96,7 @@ public: * Constructs and initializes this instance of %SecretKeyGenerator with the specified key size. @n * The default algorithm is Advanced Encryption Standard (AES). * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keySize The key size @@ -108,13 +109,13 @@ public: /** * Generates a new secret key. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the ISecretKey interface, @n - * else @c null if it fails to generate a secret key + * else @c null if it fails to generate a secret key * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::ISecretKey* GenerateKeyN(void); diff --git a/inc/FSecurity.h b/inc/FSecurity.h index f29edfc..6ff18c0 100755 --- a/inc/FSecurity.h +++ b/inc/FSecurity.h @@ -60,14 +60,14 @@ * @namespace Tizen::Security * @brief This namespace contains classes and interfaces for security services. * - * @since 2.0 + * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * - * The %Security namespace contains classes for - * managing certificates, cryptographic keys, signatures, and for generating pseudo-random numbers. @n + * The %Security namespace contains classes for managing certificates, cryptographic keys, signatures, + * and for generating pseudo-random numbers. @n * * For more information on the %Security namespace features, see Security Guide. @n *