//
/**
- * @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.
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 <a href="../org.tizen.native.appprogramming/html/guide/security/certificate_namespace.htm">Certificates</a>. @n
*
virtual Tizen::Base::String GetFormat(void) const = 0;
/**
- * Adds a certificate to the certificate chain.
- * The order of certificaett addition should be
- * 1. Add user certificate.
- * 2. Add intermediate certificate.
- * 3. Add root CA certificate.
+ * Adds the specified certificate to the certificate chain.
+ * The order of certificates should be as follows: @n
+ * 1. User certificate.
+ * 2. Intermediate certificate.
+ * 3. Root CA certificate.
*
* @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;
* @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
* @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;
* @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
* @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;
projects / platform / framework / native / appfw.git / blobdiff