namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a certificate.
+ /// The class that represents a certificate.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Certificate
{
/// <summary>
- /// Load Certificate from the given file path.
+ /// Loads Certificate from the given file path.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="filePath">The path of certificate file to be loaded.</param>
/// <returns>Loaded certificate class instance.</returns>
/// <exception cref="ArgumentNullException">
- /// filePath should not be null
+ /// The filePath should not be null
/// </exception>
/// <exception cref="InvalidOperationException">
/// Invalid certificate file format. Provided file path does not exist or
public class CertificateManager : Manager
{
/// <summary>
- /// Gets a certificate from secure repository.
+ /// Gets a certificate from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="alias">The name of a certificate to retrieve.</param>
+ /// <param name="alias">The name of a certificate to be retrieved.</param>
/// <param name="password">
/// The password used in decrypting a certificate value. If password of
/// policy is provided in SaveCertificate(), the same password should be
/// </param>
/// <returns>A certificate specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in an invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Certificate does not exist with the alias or certificate-protecting
+ /// The certificate does not exist with the alias or certificate-protecting
/// password isn't matched.
/// </exception>
static public Certificate Get(string alias, string password)
}
/// <summary>
- /// Gets all alias of certificates which the client can access.
+ /// Gets all aliases of certificates, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of certificates which the client can access.</returns>
+ /// <returns>All aliases of certificates, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores a certificate inside secure repository based on the provided policy.
+ /// Stores a certificate inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a certificate to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. cert argument is invalid format.
+ /// The alias argument is in the invalid format. cert argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Certificate with alias does already exist.
+ /// The certificate with alias already exist.
/// </exception>
static public void Save(string alias, Certificate cert, Policy policy)
{
/// </param>
/// <returns>A newly created certificate chain.</returns>
/// <exception cref="ArgumentNullException">
- /// certificate argument is null.
+ /// The certificate argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Some of certificate in arguments is invalid.
+ /// Some of the certificates in arguments are invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Some of certificate in arguments is expired or not valid yet.
+ /// Some of the certificates in arguments are expired or not valid yet.
/// Certificate cannot build chain.
- /// Root certificate is not in trusted system certificate store.
+ /// The root certificate is not in the trusted system certificate store.
/// </exception>
/// <remarks>
/// The trusted root certificate of the chain should exist in the system's
/// certificate storage.
/// </remarks>
/// <remarks>
- /// The trusted root certificate of the chain in system's certificate storage
+ /// The trusted root certificate of the chain in the system's certificate storage
/// is added to the certificate chain.
/// </remarks>
static public IEnumerable<Certificate> GetCertificateChain(
/// </param>
/// <returns>A newly created certificate chain.</returns>
/// <exception cref="ArgumentNullException">
- /// certificate argument is null.
+ /// The certificate argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Some of certificate in arguments is invalid.
+ /// Some of the certificates in arguments are invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Some of certificate in arguments is expired or not valid yet.
+ /// Some of the certificates in arguments are expired or not valid yet.
/// Certificate cannot build chain.
- /// Root certificate is not in trusted system certificate store.
+ /// The root certificate is not in the trusted system certificate store.
/// </exception>
/// <remarks>
- /// The trusted root certificate of the chain in system's certificate storage
+ /// The trusted root certificate of the chain in the system's certificate storage
/// is added to the certificate chain.
/// </remarks>
static public IEnumerable<Certificate> GetCertificateChain(
}
/// <summary>
- /// Perform OCSP which checks certificate is whether revoked or not.
+ /// Perform OCSP, which checks whether the certificate is revoked or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="certificateChain">
- /// Valid certificate chain to perform OCSP check.
+ /// Valid certificate chain to perform the OCSP check.
/// </param>
- /// <returns>A status result of OCSP check.</returns>
+ /// <returns>A status result of the OCSP check.</returns>
/// <exception cref="ArgumentNullException">
- /// certificateChain argument is null.
+ /// The certificateChain argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// certificateChain is not valid chain or certificate.
+ /// The certificateChain is not valid chain or certificate.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// some of certificate in chain is expired or not valid yet.
+ /// Some of the certificates in chain are expired or not valid yet.
/// </exception>
static public OcspStatus CheckOcsp(IEnumerable<Certificate> certificateChain)
{
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with CBC mode.
+ /// A class for holding parameters for the AES algorithm with the CBC mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCbcCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCbc.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with CFB mode.
+ /// A class for holding parameters for the AES algorithm with the CFB mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCfbCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCfb.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for AES algorithm.
+ /// An abstract class for holding parameters for the AES algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public abstract class AesCipherParameters : CipherParameters
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with counter mode.
+ /// A class for holding parameters for the AES algorithm with the counter mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCtrCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr.</remarks>
}
/// <summary>
- /// Length of counter block in bits.
+ /// Length of the counter block in bits.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>Optional, only 128b is supported at the moment.</remarks>
- /// <exception cref="ArgumentOutOfRangeException">value should be positive.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">The value should be positive.</exception>
public long CounterLength
{
get
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with GCM mode.
+ /// A class for holding parameters for the AES algorithm with the GCM mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesGcmCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesGcm.</remarks>
/// GCM tag length in bits.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>One of {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used.</remarks>
- /// <exception cref="ArgumentOutOfRangeException">TagLength should be one of {32, 64, 96, 104, 112, 120, 128}</exception>
+ /// <remarks>One of {32, 64, 96, 104, 112, 120, 128} (optional), if not present the length 128 is used.</remarks>
+ /// <exception cref="ArgumentOutOfRangeException">TagLength should be one of {32, 64, 96, 104, 112, 120, 128}.</exception>
public long TagLength
{
get
}
/// <summary>
- /// Additional authentication data(optional)
+ /// Additional authentication data (optional).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] AAD
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// This class provides the methods encrypting and decrypting data.
+ /// This class provides the methods for encrypting and decrypting data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Cipher
}
/// <summary>
- /// Decrypts data using selected key and algorithm.
+ /// Decrypts data using the selected key and the algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="keyAlias">Alias of the key to be used for decryption.</param>
/// <param name="password">
/// The password used in decrypting a key value. If password of policy is
- /// provided in SaveKey(), the same password should be provided
+ /// provided in SaveKey(), the same password should be provided.
/// </param>
/// <param name="cipherText">
/// Data to be decrypted (some algorithms may require additional information
/// </param>
/// <returns>Decrypted data.</returns>
/// <exception cref="ArgumentNullException">
- /// keyAlias or cipherText is null.
+ /// The keyAlias or cipherText is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Mandatory algorithm parameter is missing or invalid.
- /// Optional algorithm parameter is invalid.
+ /// The mandatory algorithm parameter is missing or invalid.
+ /// The optional algorithm parameter is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with keyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the keyAlias.
/// </exception>
/// <remarks>
/// The key type specified by keyAlias should be compatible with the algorithm
/// provided in SaveKey(), the same password should be provided.
/// </param>
/// <param name="plainText">
- /// Data to be encrypted. In case of AES algorithm there are no restrictions on
- /// the size of data. For RSA the size must be smaller or equal to (key_size_in
- /// bytes - 42). Example: for 1024 RSA key the maximum data size is
+ /// Data to be encrypted. In case of the AES algorithm, there are no restrictions on
+ /// the size of data. For RSA, the size must be smaller or equal to (key_size_in
+ /// bytes - 42). Example: For 1024 RSA key, the maximum data size is
/// 1024/8 - 42 = 86.
/// </param>
/// <returns>Encrypted data.</returns>
/// <exception cref="ArgumentNullException">
- /// keyAlias or plainText is null.
+ /// The keyAlias or plainText is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Mandatory algorithm parameter is missing or invalid.
- /// Optional algorithm parameter is invalid.
+ /// The mandatory algorithm parameter is missing or invalid.
+ /// The optional algorithm parameter is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with keyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the keyAlias.
/// </exception>
/// <remarks>
- /// The key type specified by keyAlias should be compatible with the algorithm
+ /// The key type specified by the keyAlias should be compatible with the algorithm
/// specified in Parameters.
/// </remarks>
public byte[] Encrypt(string keyAlias, string password, byte[] plainText)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for crypto cipher algorithm types.
+ /// Enumeration for the crypto cipher algorithm types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CipherAlgorithmType : int
{
/// <summary>
- /// AES-CTR algorithm
+ /// The AES-CTR algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCtr(mandatory),
/// - ParameterName.IV = 16 - byte initialization vector(mandatory)
/// </summary>
AesCtr = 0x01,
/// <summary>
- /// AES-CBC algorithm
+ /// The AES-CBC algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCbc(mandatory),
/// - ParameterName.IV = 16-byte initialization vector(mandatory)
/// </summary>
AesCbc,
/// <summary>
- /// AES-GCM algorithm
+ /// The AES-GCM algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesGcm(mandatory),
/// - ParameterName.IV = initialization vector(mandatory)
/// </summary>
AesGcm,
/// <summary>
- /// AES-CFB algorithm
+ /// Th AES-CFB algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCfb(mandatory),
/// - ParameterName.IV = 16-byte initialization vector(mandatory)
/// </summary>
AesCfb,
/// <summary>
- /// RSA-OAEP algorithm
+ /// The RSA-OAEP algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = RsaOaep(required),
/// - ParameterName.Label = label to be associated with the message
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for cipher algorithm parameters.
+ /// Enumeration for the cipher algorithm parameters.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CipherParameterName : int
{
/// <summary>
- /// Algorithm Type
+ /// The Algorithm Type.
/// </summary>
AlgorithmType = 0x01,
/// <summary>
- /// Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM)
+ /// Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM).
/// </summary>
IV = 101,
/// <summary>
- /// Integer - ctr length in bits
+ /// Integer - ctr length in bits.
/// </summary>
CounterLength = 102,
/// <summary>
- /// Additional authenticated data(AAD)
+ /// Additional authenticated data(AAD).
/// </summary>
AAD = 103,
/// <summary>
- /// Tag Length
+ /// Tag Length.
/// </summary>
TagLength = 104,
/// <summary>
- /// Label
+ /// Label.
/// </summary>
Label = 105
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for encryption and decryption.
+ /// An abstract class for holding parameters for encryption and decryption.
/// </summary>
/// <since_tizen> 3 </since_tizen>
abstract public class CipherParameters
private SafeCipherParametersHandle _handle;
/// <summary>
- /// Cipher algorithm type.
+ /// The Cipher algorithm type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CipherAlgorithmType Algorithm
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for DSA signature algorithm.
+ /// A class for holding parameters for the DSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public DsaSignatureParameters() : base(SignatureAlgorithmType.Dsa)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for ECDSA signature algorithm.
+ /// A class for holding parameters for the ECDSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class EcdsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public EcdsaSignatureParameters() : base(SignatureAlgorithmType.Ecdsa)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for hash algorithm
+ /// Enumeration for the hash algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum HashAlgorithm : int
{
/// <summary>
- /// No Hash Algorithm
+ /// The no hash algorithm.
/// </summary>
None = 0,
/// <summary>
- /// Hash Algorithm SHA1
+ /// The hash algorithm SHA1.
/// </summary>
Sha1,
/// <summary>
- /// Hash Algorithm SHA256
+ /// The hash algorithm SHA256.
/// </summary>
Sha256,
/// <summary>
- /// Hash Algorithm SHA384
+ /// The hash algorithm SHA384.
/// </summary>
Sha384,
/// <summary>
- /// Hash Algorithm SHA512
+ /// The hash algorithm SHA512.
/// </summary>
Sha512
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for RSA algorithm with OAEP mode.
+ /// A class for holding parameters for the RSA algorithm with the OAEP mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RsaOaepCipherParameters : CipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.RsaOaep.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for RSA padding algorithm
+ /// Enumeration for the RSA padding algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum RsaPaddingAlgorithm : int
{
/// <summary>
- /// No Padding
+ /// No padding.
/// </summary>
None = 0,
/// <summary>
- /// PKCS#1 Padding
+ /// PKCS#1 padding.
/// </summary>
Pkcs1,
/// <summary>
- /// X9.31 padding
+ /// X9.31 padding.
/// </summary>
X931
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for RSA signature algorithm.
+ /// A class for holding parameters for the RSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The RsaPadding is set to RsaPaddingAlgorithm.None.</remarks>
}
/// <summary>
- /// RSA padding algorithm
+ /// The RSA padding algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public RsaPaddingAlgorithm RsaPadding
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// This class provides the methods creating and verifying a signature.
+ /// This class provides the methods for creating and verifying a signature.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Signature
/// <param name="message">The message that is signed with a private key.</param>
/// <returns>A newly created signature.</returns>
/// <exception cref="ArgumentNullException">
- /// privateKeyAlias or message is null.
+ /// The privateKeyAlias or message is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// privateKeyAlias is invalid format.
+ /// The privateKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with privateKeyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the privateKeyAlias.
/// </exception>
/// <remarks>
- /// The key type specified by privateKeyAlias should be compatible with the
+ /// The key type specified by the privateKeyAlias should be compatible with the
/// algorithm specified in Parameters.
/// </remarks>
/// <remarks>
- /// If password of policy is provided during storing a key, the same password
+ /// If the password of policy is provided during storing a key, the same password
/// should be provided.
/// </remarks>
public byte[] Sign(string privateKeyAlias, string password, byte[] message)
/// The signature status. True is returned when the signature is valid.
/// </returns>
/// <exception cref="ArgumentNullException">
- /// publicKeyAlias, message or signature is null.
+ /// The publicKeyAlias, message or signature is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// publicKeyAlias is invalid format.
+ /// The publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with publicKeyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the publicKeyAlias.
/// </exception>
/// <remarks>
/// The key type specified by publicKeyAlias should be compatible with the
public enum SignatureAlgorithmType : int
{
/// <summary>
- /// RSA signature algorithm
+ /// The RSA signature algorithm.
/// </summary>
Rsa = 0x01,
/// <summary>
- /// DSA signature algorithm
+ /// The DSA signature algorithm.
/// </summary>
Dsa,
/// <summary>
- /// ECDSA signature algorithm
+ /// The ECDSA signature algorithm.
/// </summary>
Ecdsa
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for signature algorithm parameters.
+ /// Enumeration for the signature algorithm parameters.
/// </summary>
/// <since_tizen> 3 </since_tizen>
internal enum SignatureParameterName : int
{
/// <summary>
- /// Signaturea Algorithm Type
+ /// The signature algorithm type.
/// </summary>
AlgorithmType = 0x01,
/// <summary>
- /// Hash Algorithm Type
+ /// The hash algorithm type.
/// </summary>
HashAlgorithm,
/// <summary>
- /// RSA Padding Algorithm Type
+ /// The RSA padding algorithm type.
/// </summary>
RsaPaddingAlgorithm
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for signing and verification.
+ /// An abstract class for holding parameters for signing and verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
abstract public class SignatureParameters
private Dictionary<SignatureParameterName, int> _parameters;
/// <summary>
- /// Signature algorithm type.
+ /// The signature algorithm type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public SignatureAlgorithmType SignatureAlgorithm
}
/// <summary>
- /// Hash algorithm used in signing anve verification.
+ /// The hash algorithm used in signing anve verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public HashAlgorithm HashAlgorithm
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for data format
+ /// Enumeration for data format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DataFormat : int
{
/// <summary>
- /// DER format base64 encoded data
+ /// The DER format base64 encoded data.
/// </summary>
DerBase64 = 0,
/// <summary>
- /// DER encoded data
+ /// The DER encoded data.
/// </summary>
Der,
/// <summary>
- /// PEM encoded data. It consists of the DER format base64 encoded
+ /// The PEM encoded data. It consists of the DER format base64 encoded
/// with additional header and footer lines.
/// </summary>
Pem
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing and retrieving data.
+ /// This class provides the methods for storing and retrieving data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DataManager : Manager
{
/// <summary>
- /// Gets data from secure repository.
+ /// Gets data from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a certificate to retrieve.</param>
/// </param>
/// <returns>Data specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null.
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Data does not exist with the alias or data-protecting password isn't matched.
}
/// <summary>
- /// Gets all alias of data which the client can access.
+ /// Gets all aliases of data, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of data which the client can access.</returns>
+ /// <returns>All aliases of data, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores data inside secure repository based on the provided policy.
+ /// Stores data inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of data to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. Data policy cannot be unextractable.
+ /// The alias argument is in the invalid format. Data policy cannot be unextractable.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Data with alias does already exist.
+ /// Data with alias already exist.
/// </exception>
static public void Save(string alias, byte[] data, Policy policy)
{
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for elliptic curve
+ /// Enumeration for the elliptic curve.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum EllipticCurveType : int
{
/// <summary>
- /// Elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain
+ /// The elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain.
/// </summary>
Prime192V1 = 0,
/// <summary>
- /// "SEC 2" recommended elliptic curve domain - secp256r1
+ /// The "SEC 2" recommended elliptic curve domain - secp256r1.
/// </summary>
Prime256V1,
/// <summary>
- /// NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2
+ /// The NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2.
/// </summary>
Secp384R1
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a key.
+ /// The class that represents a key.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Key
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing, retrieving, and creating keys.
+ /// This class provides the methods for storing, retrieving, and creating keys.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class KeyManager : Manager
{
/// <summary>
- /// Gets a key from secure repository.
+ /// Gets a key from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a key to retrieve.</param>
/// </param>
/// <returns>A key specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null.
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key does not exist with the alias or key-protecting password isn't matched.
+ /// The key does not exist with the alias or the key-protecting password isn't matched.
/// </exception>
static public Key Get(string alias, string password)
{
}
/// <summary>
- /// Gets all alias of keys which the client can access.
+ /// Gets all aliases of keys, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of keys which the client can access.</returns>
+ /// <returns>All aliases of keys, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores a key inside secure repository based on the provided policy.
+ /// Stores a key inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a key to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. key argument is invalid format.
+ /// The alias argument is in the invalid format. key argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with alias does already exist.
+ /// The key with alias does already exist.
/// </exception>
/// <remarks>
- /// Type in key may be set to KeyType.None as an input.
- /// Type is determined inside secure reposioty during storing keys.
+ /// The type in key may be set to KeyType.None as an input.
+ /// The type is determined inside the secure reposioty during storing keys.
/// </remarks>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void Save(string alias, Key key, Policy policy)
}
/// <summary>
- /// Creates RSA private/public key pair and stores them inside secure repository
+ /// Creates the RSA private/public key pair and stores them inside the secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
+ /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with the
+ /// If the password in policy is provided, the key is additionally encrypted with the
/// password in policy.
/// </remarks>
static public void CreateRsaKeyPair(
}
/// <summary>
- /// Creates DSA private/public key pair and stores them inside secure repository
+ /// Creates the DSA private/public key pair and stores them inside the secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
+ /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateDsaKeyPair(
}
/// <summary>
- /// Creates ECDSA private/public key pair and stores them inside secure repository
+ /// Creates the ECDSA private/public key pair and stores them inside secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is
+ /// The elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is in the
/// invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateEcdsaKeyPair(
}
/// <summary>
- /// Creates AES key and stores it inside secure repository based on each policy.
+ /// Creates the AES key and stores it inside the secure repository based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="size">
- /// The size of key strength to be created. 128, 192 and 256 are supported.
+ /// The size of the key strength to be created. 128, 192 and 256 are supported.
/// </param>
/// <param name="keyAlias">The name of key to be stored.</param>
/// <param name="policy">The policy about how to store the key securely.</param>
/// <exception cref="ArgumentNullException">
- /// keyAlias or policy is null.
+ /// The keyAlias or policy is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Key size is invalid. keyAlias is invalid format.
+ /// The key size is invalid. keyAlias is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateAesKey(int size, string keyAlias, Policy policy)
public enum KeyType : int
{
/// <summary>
- /// Key type not specified
+ /// Key type not specified.
/// </summary>
None = 0,
/// <summary>
- /// RSA public key
+ /// The RSA public key.
/// </summary>
RsaPublic,
/// <summary>
- /// RSA private key
+ /// The RSA private key.
/// </summary>
RsaPrivate,
/// <summary>
- /// ECDSA public key
+ /// The ECDSA public key.
/// </summary>
EcdsaPublic,
/// <summary>
- /// ECDSA private key
+ /// The ECDSA private key.
/// </summary>
EcdsaPrivate,
/// <summary>
- /// DSA public key
+ /// The DSA public key.
/// </summary>
DsaPublic,
/// <summary>
- /// DSA private key
+ /// The DSA private key.
/// </summary>
DsaPrivate,
/// <summary>
- /// AES key
+ /// The AES key.
/// </summary>
Aes
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class is a base class of XxxManager classes. It provides the common methods
+ /// This class is a base class of the XxxManager classes. It provides the common methods
/// for all sub classes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Manager
{
/// <summary>
- /// Creates a new full alias which is concatenation of owner id and alias.
+ /// Creates a new full alias, which is concatenation of owner ID and alias.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="ownerId">Data owner's id. This should be package id if data
+ /// <param name="ownerId">Data owner's ID. This should be package ID if data
/// owner is application. If you want to access data stored by system services,
/// use CreateFullSystemAlias() instead.</param>
/// <param name="alias">Data alias.</param>
}
/// <summary>
- /// Creates a new full alias which is concatenation of system service's
- /// owner id and alias.
+ /// Creates a new full alias, which is concatenation of system service's
+ /// owner ID and alias.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="alias">Data alias which is owned by system service.</param>
+ /// <param name="alias">Data alias, which is owned by system service.</param>
static public string CreateFullSystemAlias(string alias)
{
return Manager.CreateFullAlias(Manager.SystemOwnerId, alias);
}
/// <summary>
- /// Removes a an entry (no matter of type) from the key manager.
+ /// Removes an entry (no matter of type) from the key manager.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">Item alias to be removed.</param>
- /// <exception cref="ArgumentNullException">alias is null.</exception>
- /// <exception cref="ArgumentException">alias is invalid format.</exception>
- /// <exception cref="InvalidOperationException">alias does not exist.</exception>
+ /// <exception cref="ArgumentNullException">The alias is null.</exception>
+ /// <exception cref="ArgumentException">The alias is in the invalid format.</exception>
+ /// <exception cref="InvalidOperationException">The alias does not exist.</exception>
/// <remarks>
- /// To remove item, client must have remove permission to the specified item.
+ /// To remove item, client must remove permission to the specified item.
/// </remarks>
/// <remarks>The item owner can remove by default.</remarks>
static public void RemoveAlias(string alias)
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">Item alias for which access will be granted.</param>
/// <param name="otherPackageId">
- /// Package id of the application that will gain access rights.
+ /// Package ID of the application that will gain access rights.
/// </param>
/// <param name="permissions">
/// Mask of permissions(Permission enum) granted for an application with
/// otherPackageId.
/// </param>
/// <exception cref="ArgumentNullException">
- /// alias or otherPackageId is null.
+ /// The alias or otherPackageId is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// alias or otherPackageId is invalid format.
+ /// The alias or otherPackageId is in the invalid format.
/// </exception>
- /// <exception cref="InvalidOperationException">alias does not exist.</exception>
+ /// <exception cref="InvalidOperationException">The alias does not exist.</exception>
/// <remarks>Data identified by alias should exist.</remarks>
/// <remarks>The item owner can set permissions.</remarks>
static public void SetPermission(
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for OCSP status.
+ /// Enumeration for the OCSP status.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum OcspStatus : int
{
/// <summary>
- /// OCSP status is good
+ /// The OCSP status is good.
/// </summary>
Good = 0x00,
/// <summary>
- /// The certificate is revoked
+ /// The certificate is revoked.
/// </summary>
Revoked = 0x01,
/// <summary>
- /// Unknown error
+ /// Unknown error.
/// </summary>
Unknown = 0x02,
/// <summary>
- /// The certificate does not provide OCSP extension
+ /// The certificate does not provide the OCSP extension.
/// </summary>
Unsupported = 0x03,
/// <summary>
- /// The invalid URL in certificate OCSP extension
+ /// The invalid URL in the certificate OCSP extension.
/// </summary>
InvalidUrl = 0x04,
/// <summary>
- /// The invalid response from OCSP server
+ /// The invalid response from the OCSP server.
/// </summary>
InvalidResponse = 0x05,
/// <summary>
- /// OCSP remote server error
+ /// The OCSP remote server error.
/// </summary>
RemoteError = 0x06,
/// <summary>
- /// Network connection error
+ /// The Network connection error.
/// </summary>
NetworkError = 0x07,
/// <summary>
- /// Internal error
+ /// An Internal error.
/// </summary>
InternalError = 0x08
}
public enum Permission : int
{
/// <summary>
- /// Clear permissions
+ /// Clear permissions.
/// </summary>
None = 0x00,
/// <summary>
- /// Eead allowed
+ /// Read allowed.
/// </summary>
Read = 0x01,
/// <summary>
- /// Remove allowed
+ /// Remove allowed.
/// </summary>
Remove = 0x02
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a PKCS#12 contents.
+ /// The class that represents a PKCS#12 contents.
/// It has a private key or its certificate or all the members of a chain of trust.
/// </summary>
/// <since_tizen> 3 </since_tizen>
private SafeCertificateListHandle _certChainHandle = null;
/// <summary>
- /// Load Pkcs12 from the given PKCS#12 file path.
+ /// Loads the Pkcs12 from the given PKCS#12 file path.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="filePath">The path of PKCS12 file to be loaded.</param>
+ /// <param name="filePath">The path of the PKCS12 file to be loaded.</param>
/// <param name="filePassword">The passphrase used to decrypt the PCKS12 file.
- /// If PKCS12 file is not encrypted, passphrase can be null.</param>
- /// <exception cref="ArgumentNullException">filePath is null.</exception>
+ /// If the PKCS12 file is not encrypted, passphrase can be null.</param>
+ /// <exception cref="ArgumentNullException">The filePath is null.</exception>
/// <exception cref="InvalidOperationException">
/// No file on filePath.
/// No permission to access file.
- /// File is invalid PKCS12 format.
+ /// File is in the invalid PKCS12 format.
/// File cannot be extracted with provided filePassword.
/// </exception>
static public Pkcs12 Load(string filePath, string filePassword)
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="privateKey">A private key.</param>
- /// <param name="certificate">A certificate corresponding the private key</param>
+ /// <param name="certificate">A certificate corresponding the private key.</param>
/// <param name="caChain">
/// A certificate chain of CA(Certificate Authority) that issued the certificate.
/// </param>
}
/// <summary>
- /// A certificate corresponding the private key.
+ /// A certificate corresponding to the private key.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public Certificate Certificate
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing, retrieving Pkcs12 contents.
+ /// This class provides the methods for storing and retrieving the Pkcs12 contents.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Pkcs12Manager : Manager
{
/// <summary>
- /// Gets Pkcs12 contents from secure repository.
+ /// Gets Pkcs12 contents from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of data to retrieve.</param>
/// <param name="keyPassword">
/// The password used in decrypting a private key value. If password of
- /// keyPolicy is provided in SavePkcs12(), the same password should be provided
+ /// keyPolicy is provided in SavePkcs12(), the same password should be provided.
/// </param>
/// <param name="cerificatePassword">
/// The password used in decrypting a certificate value. If password of
/// certificatePolicy is provided in SavePkcs12(), the same password should be
- /// provided
+ /// provided.
/// </param>
/// <returns>A Pkcs12 data specified by alias.</returns>
- /// <exception cref="ArgumentNullException">Alias argument is null.</exception>
+ /// <exception cref="ArgumentNullException">The alias argument is null.</exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Pkcs12 does not exist with the alias.
/// </param>
/// <exception cref="ArgumentNullException">Any of argument is null.</exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. Pkcs12 argument is invalid format.
+ /// The alias argument is in the invalid format. Pkcs12 argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Pkcs12 with alias does already exist.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="password">Used to encrypt data secure repository.</param>
- /// <param name="extractable">If true key may be extracted from secure repository.</param>
+ /// <param name="extractable">If true, key may be extracted from the secure repository.</param>
public Policy(String password, bool extractable)
{
Password = password;
/// <summary>
/// Used to encrypt data secure repository. If it is not null, the data
- /// (or key, or certificate) is stored encrypted with this password inside secure repository
+ /// (or key, or certificate) is stored encrypted with this password inside secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public String Password
}
/// <summary>
- /// If true key may be extracted from secure repository.
+ /// If true, key may be extracted from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool Extractable
namespace Tizen.Security
{
/// <summary>
- /// The class provides the information of the given privilege and API version.
+ /// This class provides the information of the given privilege and the API version.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class Privilege
/// Gets the display name of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <returns>The display name of given privilege at given api version</returns>
+ /// <remarks>If there's no matching privilege, then it returns last token of the given privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <returns>The display name of the given privilege at the given API version.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDisplayName(string apiVersion, string privilege)
{
string displayName;
/// Gets the display name of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <param name="packageType">The type of application package</param>
- /// <returns>The display name of given privilege at given api version and the package type</returns>
+ /// <remarks>If there's no matching privilege, then it returns last token of the given privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <param name="packageType">The type of application package.</param>
+ /// <returns>The display name of the given privilege at the given API version and the package type.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDisplayName(string apiVersion, string privilege, PackageType packageType)
{
string displayName;
/// Gets the description of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <returns>The description of given privilege at given api version</returns>
+ /// <remarks>If there's no matching privilege, then it returns description string for undefined privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <returns>The description of given privilege at the given API version</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDescription(string apiVersion, string privilege)
{
string description;
/// Gets the description of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <param name="packageType">The type of application package</param>
- /// <returns>The description of given privilege at given api version and the package type</returns>
+ /// <remarks>If there's no matching privilege, then it returns description string for undefined privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <param name="packageType">The type of application package.</param>
+ /// <returns>The description of given privilege at the given API version and the package type.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDescription(string apiVersion, string privilege, PackageType packageType)
{
string description;
/// Gets the display name of the privacy group in which the given privilege is included.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="privilege">The privilege</param>
+ /// <param name="privilege">The privilege.</param>
/// <remarks>The privilege must be privacy related.</remarks>
- /// <returns>The privacy group's display name that the given privilege is included in</returns>
+ /// <returns>The privacy group's display name that the given privilege is included in.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetPrivacyDisplayName(string privilege)
{
string displayName;
/// Gets the status of the given privacy related privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="privilege">The privilege</param>
+ /// <param name="privilege">The privilege.</param>
/// <remarks>The privilege must be privacy related.</remarks>
- /// <returns>status true if the privilege is on and false if the privilege is off.</returns>
+ /// <returns>Status true if the privilege is on and false if the privilege is off.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static bool GetPrivacyPrivilegeStatus(string privilege)
{
bool status;
projects / platform / core / csapi / tizenfx.git / commitdiff