//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
//
/**
- * @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.
{
/**
- * @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
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);
* @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);
* @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);
class _RsaKeyConverterImpl* __pRsaKeyConverterImpl;
friend class _RsaKeyConverterImpl;
-}; //RsaKeyConverter
+}; //RsaKeyConverter
} } //Tizen::Security
projects / platform / framework / native / appfw.git / blobdiff