From d5799f3fcd65fa5d3765f347fcfb7403c802b33c Mon Sep 17 00:00:00 2001 From: Yunjin Lee Date: Tue, 5 Sep 2017 18:53:51 +0900 Subject: [PATCH] Apply English-reviewed Security API cs files - Original author: Editor Lionbridge - https://review.tizen.org/gerrit/#/c/140757 Change-Id: I217e83b4c6232dd48623fa8862af3e9f3f46bfa6 Signed-off-by: Yunjin Lee --- .../Tizen.Security.SecureRepository/Certificate.cs | 6 +- .../CertificateManager.cs | 52 ++++++++-------- .../Crypto/AesCbcCipherParameters.cs | 4 +- .../Crypto/AesCfbCipherParameters.cs | 4 +- .../Crypto/AesCipherParameters.cs | 2 +- .../Crypto/AesCtrCipherParameters.cs | 8 +-- .../Crypto/AesGcmCipherParameters.cs | 10 ++-- .../Crypto/Cipher.cs | 34 +++++------ .../Crypto/CipherAlgorithmType.cs | 12 ++-- .../Crypto/CipherParameterName.cs | 14 ++--- .../Crypto/CipherParameters.cs | 4 +- .../Crypto/DsaSignatureParameters.cs | 4 +- .../Crypto/EcdsaSignatureParameters.cs | 4 +- .../Crypto/HashAlgorithm.cs | 12 ++-- .../Crypto/RsaOaepCipherParameters.cs | 4 +- .../Crypto/RsaPaddingAlgorithm.cs | 8 +-- .../Crypto/RsaSignatureParameters.cs | 6 +- .../Crypto/Signature.cs | 22 +++---- .../Crypto/SignatureAlgorithmType.cs | 6 +- .../Crypto/SignatureParameterName.cs | 8 +-- .../Crypto/SignatureParameters.cs | 6 +- .../Tizen.Security.SecureRepository/DataFormat.cs | 8 +-- .../Tizen.Security.SecureRepository/DataManager.cs | 18 +++--- .../EllipticCurveType.cs | 8 +-- .../Tizen.Security.SecureRepository/Key.cs | 2 +- .../Tizen.Security.SecureRepository/KeyManager.cs | 62 +++++++++---------- .../Tizen.Security.SecureRepository/KeyType.cs | 16 ++--- .../Tizen.Security.SecureRepository/Manager.cs | 30 +++++----- .../Tizen.Security.SecureRepository/OcspStatus.cs | 20 +++---- .../Tizen.Security.SecureRepository/Permission.cs | 6 +- .../Tizen.Security.SecureRepository/Pkcs12.cs | 16 ++--- .../Pkcs12Manager.cs | 14 ++--- .../Tizen.Security.SecureRepository/Policy.cs | 6 +- src/Tizen.Security/Tizen.Security/Privilege.cs | 70 +++++++++++----------- 34 files changed, 253 insertions(+), 253 deletions(-) diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Certificate.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Certificate.cs index 401a554..99c02d5 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Certificate.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Certificate.cs @@ -21,19 +21,19 @@ using static Interop; namespace Tizen.Security.SecureRepository { /// - /// Class that represents a certificate. + /// The class that represents a certificate. /// /// 3 public class Certificate { /// - /// Load Certificate from the given file path. + /// Loads Certificate from the given file path. /// /// 3 /// The path of certificate file to be loaded. /// Loaded certificate class instance. /// - /// filePath should not be null + /// The filePath should not be null /// /// /// Invalid certificate file format. Provided file path does not exist or diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/CertificateManager.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/CertificateManager.cs index c034267..631de76 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/CertificateManager.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/CertificateManager.cs @@ -27,10 +27,10 @@ namespace Tizen.Security.SecureRepository public class CertificateManager : Manager { /// - /// Gets a certificate from secure repository. + /// Gets a certificate from the secure repository. /// /// 3 - /// The name of a certificate to retrieve. + /// The name of a certificate to be retrieved. /// /// The password used in decrypting a certificate value. If password of /// policy is provided in SaveCertificate(), the same password should be @@ -38,13 +38,13 @@ namespace Tizen.Security.SecureRepository /// /// A certificate specified by alias. /// - /// Alias argument is null + /// The alias argument is null. /// /// - /// Alias argument is invalid format. + /// The alias argument is in an invalid format. /// /// - /// 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. /// static public Certificate Get(string alias, string password) @@ -69,10 +69,10 @@ namespace Tizen.Security.SecureRepository } /// - /// Gets all alias of certificates which the client can access. + /// Gets all aliases of certificates, which the client can access. /// /// 3 - /// All alias of certificates which the client can access. + /// All aliases of certificates, which the client can access. /// No alias to get. static public IEnumerable GetAliases() { @@ -93,7 +93,7 @@ namespace Tizen.Security.SecureRepository } /// - /// Stores a certificate inside secure repository based on the provided policy. + /// Stores a certificate inside the secure repository based on the provided policy. /// /// 3 /// The name of a certificate to be stored. @@ -105,10 +105,10 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// 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. /// /// - /// Certificate with alias does already exist. + /// The certificate with alias already exist. /// static public void Save(string alias, Certificate cert, Policy policy) { @@ -131,22 +131,22 @@ namespace Tizen.Security.SecureRepository /// /// A newly created certificate chain. /// - /// certificate argument is null. + /// The certificate argument is null. /// /// - /// Some of certificate in arguments is invalid. + /// Some of the certificates in arguments are invalid. /// /// - /// 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. /// /// /// The trusted root certificate of the chain should exist in the system's /// certificate storage. /// /// - /// 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. /// static public IEnumerable GetCertificateChain( @@ -201,18 +201,18 @@ namespace Tizen.Security.SecureRepository /// /// A newly created certificate chain. /// - /// certificate argument is null. + /// The certificate argument is null. /// /// - /// Some of certificate in arguments is invalid. + /// Some of the certificates in arguments are invalid. /// /// - /// 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. /// /// - /// 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. /// static public IEnumerable GetCertificateChain( @@ -256,21 +256,21 @@ namespace Tizen.Security.SecureRepository } /// - /// Perform OCSP which checks certificate is whether revoked or not. + /// Perform OCSP, which checks whether the certificate is revoked or not. /// /// 3 /// - /// Valid certificate chain to perform OCSP check. + /// Valid certificate chain to perform the OCSP check. /// - /// A status result of OCSP check. + /// A status result of the OCSP check. /// - /// certificateChain argument is null. + /// The certificateChain argument is null. /// /// - /// certificateChain is not valid chain or certificate. + /// The certificateChain is not valid chain or certificate. /// /// - /// some of certificate in chain is expired or not valid yet. + /// Some of the certificates in chain are expired or not valid yet. /// static public OcspStatus CheckOcsp(IEnumerable certificateChain) { diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCbcCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCbcCipherParameters.cs index 36e8902..69cfb9e 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCbcCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCbcCipherParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for AES algorithm with CBC mode. + /// A class for holding parameters for the AES algorithm with the CBC mode. /// /// 3 public class AesCbcCipherParameters : AesCipherParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCbc. diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCfbCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCfbCipherParameters.cs index 6bb35af..efff9da 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCfbCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCfbCipherParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for AES algorithm with CFB mode. + /// A class for holding parameters for the AES algorithm with the CFB mode. /// /// 3 public class AesCfbCipherParameters : AesCipherParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCfb. diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCipherParameters.cs index 095f9ae..78c05dc 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCipherParameters.cs @@ -17,7 +17,7 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A abstract class holding parameters for AES algorithm. + /// An abstract class for holding parameters for the AES algorithm. /// /// 3 public abstract class AesCipherParameters : CipherParameters diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCtrCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCtrCipherParameters.cs index 731254f..222f8bf 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCtrCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesCtrCipherParameters.cs @@ -19,13 +19,13 @@ using System; namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for AES algorithm with counter mode. + /// A class for holding parameters for the AES algorithm with the counter mode. /// /// 3 public class AesCtrCipherParameters : AesCipherParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr. @@ -34,11 +34,11 @@ namespace Tizen.Security.SecureRepository.Crypto } /// - /// Length of counter block in bits. + /// Length of the counter block in bits. /// /// 3 /// Optional, only 128b is supported at the moment. - /// value should be positive. + /// The value should be positive. public long CounterLength { get diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesGcmCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesGcmCipherParameters.cs index cab0ccc..be09b02 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesGcmCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/AesGcmCipherParameters.cs @@ -19,13 +19,13 @@ using System; namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for AES algorithm with GCM mode. + /// A class for holding parameters for the AES algorithm with the GCM mode. /// /// 3 public class AesGcmCipherParameters : AesCipherParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesGcm. @@ -37,8 +37,8 @@ namespace Tizen.Security.SecureRepository.Crypto /// GCM tag length in bits. /// /// 3 - /// One of {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used. - /// TagLength should be one of {32, 64, 96, 104, 112, 120, 128} + /// One of {32, 64, 96, 104, 112, 120, 128} (optional), if not present the length 128 is used. + /// TagLength should be one of {32, 64, 96, 104, 112, 120, 128}. public long TagLength { get @@ -61,7 +61,7 @@ namespace Tizen.Security.SecureRepository.Crypto } /// - /// Additional authentication data(optional) + /// Additional authentication data (optional). /// /// 3 public byte[] AAD diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Cipher.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Cipher.cs index e84c070..d3e38fc 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Cipher.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Cipher.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Security.SecureRepository.Crypto { /// - /// This class provides the methods encrypting and decrypting data. + /// This class provides the methods for encrypting and decrypting data. /// /// 3 public class Cipher @@ -46,13 +46,13 @@ namespace Tizen.Security.SecureRepository.Crypto } /// - /// Decrypts data using selected key and algorithm. + /// Decrypts data using the selected key and the algorithm. /// /// 3 /// Alias of the key to be used for decryption. /// /// 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. /// /// /// Data to be decrypted (some algorithms may require additional information @@ -60,15 +60,15 @@ namespace Tizen.Security.SecureRepository.Crypto /// /// Decrypted data. /// - /// keyAlias or cipherText is null. + /// The keyAlias or cipherText is null. /// /// - /// 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. /// /// - /// 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. /// /// /// The key type specified by keyAlias should be compatible with the algorithm @@ -109,25 +109,25 @@ namespace Tizen.Security.SecureRepository.Crypto /// provided in SaveKey(), the same password should be provided. /// /// - /// 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. /// /// Encrypted data. /// - /// keyAlias or plainText is null. + /// The keyAlias or plainText is null. /// /// - /// 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. /// /// - /// 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. /// /// - /// 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. /// public byte[] Encrypt(string keyAlias, string password, byte[] plainText) diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherAlgorithmType.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherAlgorithmType.cs index 7487ebc..274634f 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherAlgorithmType.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherAlgorithmType.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// Enumeration for crypto cipher algorithm types. + /// Enumeration for the crypto cipher algorithm types. /// /// 3 public enum CipherAlgorithmType : int { /// - /// AES-CTR algorithm + /// The AES-CTR algorithm. /// Supported parameters: /// - ParameterName.AlgorithmType = AesCtr(mandatory), /// - ParameterName.IV = 16 - byte initialization vector(mandatory) @@ -32,14 +32,14 @@ namespace Tizen.Security.SecureRepository.Crypto /// AesCtr = 0x01, /// - /// AES-CBC algorithm + /// The AES-CBC algorithm. /// Supported parameters: /// - ParameterName.AlgorithmType = AesCbc(mandatory), /// - ParameterName.IV = 16-byte initialization vector(mandatory) /// AesCbc, /// - /// AES-GCM algorithm + /// The AES-GCM algorithm. /// Supported parameters: /// - ParameterName.AlgorithmType = AesGcm(mandatory), /// - ParameterName.IV = initialization vector(mandatory) @@ -49,14 +49,14 @@ namespace Tizen.Security.SecureRepository.Crypto /// AesGcm, /// - /// AES-CFB algorithm + /// Th AES-CFB algorithm. /// Supported parameters: /// - ParameterName.AlgorithmType = AesCfb(mandatory), /// - ParameterName.IV = 16-byte initialization vector(mandatory) /// AesCfb, /// - /// RSA-OAEP algorithm + /// The RSA-OAEP algorithm. /// Supported parameters: /// - ParameterName.AlgorithmType = RsaOaep(required), /// - ParameterName.Label = label to be associated with the message diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameterName.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameterName.cs index be3801e..27a1ea1 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameterName.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameterName.cs @@ -17,33 +17,33 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// Enumeration for cipher algorithm parameters. + /// Enumeration for the cipher algorithm parameters. /// /// 3 public enum CipherParameterName : int { /// - /// Algorithm Type + /// The Algorithm Type. /// AlgorithmType = 0x01, /// - /// 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). /// IV = 101, /// - /// Integer - ctr length in bits + /// Integer - ctr length in bits. /// CounterLength = 102, /// - /// Additional authenticated data(AAD) + /// Additional authenticated data(AAD). /// AAD = 103, /// - /// Tag Length + /// Tag Length. /// TagLength = 104, /// - /// Label + /// Label. /// Label = 105 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameters.cs index 450b159..57b8aa4 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/CipherParameters.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Security.SecureRepository.Crypto { /// - /// A abstract class holding parameters for encryption and decryption. + /// An abstract class for holding parameters for encryption and decryption. /// /// 3 abstract public class CipherParameters @@ -27,7 +27,7 @@ namespace Tizen.Security.SecureRepository.Crypto private SafeCipherParametersHandle _handle; /// - /// Cipher algorithm type. + /// The Cipher algorithm type. /// /// 3 public CipherAlgorithmType Algorithm diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/DsaSignatureParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/DsaSignatureParameters.cs index 2c58255..cd7d610 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/DsaSignatureParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/DsaSignatureParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for DSA signature algorithm. + /// A class for holding parameters for the DSA signature algorithm. /// /// 3 public class DsaSignatureParameters : SignatureParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 public DsaSignatureParameters() : base(SignatureAlgorithmType.Dsa) diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/EcdsaSignatureParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/EcdsaSignatureParameters.cs index 3cd6e65..31e584c 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/EcdsaSignatureParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/EcdsaSignatureParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for ECDSA signature algorithm. + /// A class for holding parameters for the ECDSA signature algorithm. /// /// 3 public class EcdsaSignatureParameters : SignatureParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 public EcdsaSignatureParameters() : base(SignatureAlgorithmType.Ecdsa) diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/HashAlgorithm.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/HashAlgorithm.cs index 66c6491..636d163 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/HashAlgorithm.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/HashAlgorithm.cs @@ -17,29 +17,29 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// Enumeration for hash algorithm + /// Enumeration for the hash algorithm. /// /// 3 public enum HashAlgorithm : int { /// - /// No Hash Algorithm + /// The no hash algorithm. /// None = 0, /// - /// Hash Algorithm SHA1 + /// The hash algorithm SHA1. /// Sha1, /// - /// Hash Algorithm SHA256 + /// The hash algorithm SHA256. /// Sha256, /// - /// Hash Algorithm SHA384 + /// The hash algorithm SHA384. /// Sha384, /// - /// Hash Algorithm SHA512 + /// The hash algorithm SHA512. /// Sha512 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaOaepCipherParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaOaepCipherParameters.cs index f0fbe9f..dd1b735 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaOaepCipherParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaOaepCipherParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for RSA algorithm with OAEP mode. + /// A class for holding parameters for the RSA algorithm with the OAEP mode. /// /// 3 public class RsaOaepCipherParameters : CipherParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.RsaOaep. diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaPaddingAlgorithm.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaPaddingAlgorithm.cs index 5da20f6..39b34fe 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaPaddingAlgorithm.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaPaddingAlgorithm.cs @@ -17,21 +17,21 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// Enumeration for RSA padding algorithm + /// Enumeration for the RSA padding algorithm. /// /// 3 public enum RsaPaddingAlgorithm : int { /// - /// No Padding + /// No padding. /// None = 0, /// - /// PKCS#1 Padding + /// PKCS#1 padding. /// Pkcs1, /// - /// X9.31 padding + /// X9.31 padding. /// X931 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaSignatureParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaSignatureParameters.cs index b1dfe7b..7274f89 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaSignatureParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/RsaSignatureParameters.cs @@ -17,13 +17,13 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// A class holding parameters for RSA signature algorithm. + /// A class for holding parameters for the RSA signature algorithm. /// /// 3 public class RsaSignatureParameters : SignatureParameters { /// - /// A default constructor + /// A default constructor. /// /// 3 /// The RsaPadding is set to RsaPaddingAlgorithm.None. @@ -32,7 +32,7 @@ namespace Tizen.Security.SecureRepository.Crypto } /// - /// RSA padding algorithm + /// The RSA padding algorithm. /// /// 3 public RsaPaddingAlgorithm RsaPadding diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Signature.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Signature.cs index 3e34ce7..65d7824 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Signature.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/Signature.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Security.SecureRepository.Crypto { /// - /// This class provides the methods creating and verifying a signature. + /// This class provides the methods for creating and verifying a signature. /// /// 3 public class Signature @@ -57,21 +57,21 @@ namespace Tizen.Security.SecureRepository.Crypto /// The message that is signed with a private key. /// A newly created signature. /// - /// privateKeyAlias or message is null. + /// The privateKeyAlias or message is null. /// /// - /// privateKeyAlias is invalid format. + /// The privateKeyAlias is invalid format. /// /// - /// 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. /// /// - /// 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. /// /// - /// 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. /// public byte[] Sign(string privateKeyAlias, string password, byte[] message) @@ -128,14 +128,14 @@ namespace Tizen.Security.SecureRepository.Crypto /// The signature status. True is returned when the signature is valid. /// /// - /// publicKeyAlias, message or signature is null. + /// The publicKeyAlias, message or signature is null. /// /// - /// publicKeyAlias is invalid format. + /// The publicKeyAlias is invalid format. /// /// - /// 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. /// /// /// The key type specified by publicKeyAlias should be compatible with the diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureAlgorithmType.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureAlgorithmType.cs index 68b5ba1..de83765 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureAlgorithmType.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureAlgorithmType.cs @@ -23,15 +23,15 @@ namespace Tizen.Security.SecureRepository.Crypto public enum SignatureAlgorithmType : int { /// - /// RSA signature algorithm + /// The RSA signature algorithm. /// Rsa = 0x01, /// - /// DSA signature algorithm + /// The DSA signature algorithm. /// Dsa, /// - /// ECDSA signature algorithm + /// The ECDSA signature algorithm. /// Ecdsa } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameterName.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameterName.cs index 1662ad1..c265ad1 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameterName.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameterName.cs @@ -17,21 +17,21 @@ namespace Tizen.Security.SecureRepository.Crypto { /// - /// Enumeration for signature algorithm parameters. + /// Enumeration for the signature algorithm parameters. /// /// 3 internal enum SignatureParameterName : int { /// - /// Signaturea Algorithm Type + /// The signature algorithm type. /// AlgorithmType = 0x01, /// - /// Hash Algorithm Type + /// The hash algorithm type. /// HashAlgorithm, /// - /// RSA Padding Algorithm Type + /// The RSA padding algorithm type. /// RsaPaddingAlgorithm } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameters.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameters.cs index bccf4cc..a612243 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameters.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Crypto/SignatureParameters.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Security.SecureRepository.Crypto { /// - /// A abstract class holding parameters for signing and verification. + /// An abstract class for holding parameters for signing and verification. /// /// 3 abstract public class SignatureParameters @@ -28,7 +28,7 @@ namespace Tizen.Security.SecureRepository.Crypto private Dictionary _parameters; /// - /// Signature algorithm type. + /// The signature algorithm type. /// /// 3 public SignatureAlgorithmType SignatureAlgorithm @@ -37,7 +37,7 @@ namespace Tizen.Security.SecureRepository.Crypto } /// - /// Hash algorithm used in signing anve verification. + /// The hash algorithm used in signing anve verification. /// /// 3 public HashAlgorithm HashAlgorithm diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataFormat.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataFormat.cs index cd96acf..6b3fac4 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataFormat.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataFormat.cs @@ -17,21 +17,21 @@ namespace Tizen.Security.SecureRepository { /// - /// Enumeration for data format + /// Enumeration for data format. /// /// 3 public enum DataFormat : int { /// - /// DER format base64 encoded data + /// The DER format base64 encoded data. /// DerBase64 = 0, /// - /// DER encoded data + /// The DER encoded data. /// Der, /// - /// 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. /// Pem diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataManager.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataManager.cs index 38fd661..556522b 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataManager.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/DataManager.cs @@ -21,13 +21,13 @@ using static Interop; namespace Tizen.Security.SecureRepository { /// - /// This class provides the methods storing and retrieving data. + /// This class provides the methods for storing and retrieving data. /// /// 3 public class DataManager : Manager { /// - /// Gets data from secure repository. + /// Gets data from the secure repository. /// /// 3 /// The name of a certificate to retrieve. @@ -38,10 +38,10 @@ namespace Tizen.Security.SecureRepository /// /// Data specified by alias. /// - /// Alias argument is null. + /// The alias argument is null. /// /// - /// Alias argument is invalid format. + /// The alias argument is in the invalid format. /// /// /// Data does not exist with the alias or data-protecting password isn't matched. @@ -68,10 +68,10 @@ namespace Tizen.Security.SecureRepository } /// - /// Gets all alias of data which the client can access. + /// Gets all aliases of data, which the client can access. /// /// 3 - /// All alias of data which the client can access. + /// All aliases of data, which the client can access. /// No alias to get. static public IEnumerable GetAliases() { @@ -92,7 +92,7 @@ namespace Tizen.Security.SecureRepository } /// - /// Stores data inside secure repository based on the provided policy. + /// Stores data inside the secure repository based on the provided policy. /// /// 3 /// The name of data to be stored. @@ -102,10 +102,10 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// Alias argument is invalid format. Data policy cannot be unextractable. + /// The alias argument is in the invalid format. Data policy cannot be unextractable. /// /// - /// Data with alias does already exist. + /// Data with alias already exist. /// static public void Save(string alias, byte[] data, Policy policy) { diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/EllipticCurveType.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/EllipticCurveType.cs index 6e52871..d2c13b1 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/EllipticCurveType.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/EllipticCurveType.cs @@ -17,21 +17,21 @@ namespace Tizen.Security.SecureRepository { /// - /// Enumeration for elliptic curve + /// Enumeration for the elliptic curve. /// /// 3 public enum EllipticCurveType : int { /// - /// 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. /// Prime192V1 = 0, /// - /// "SEC 2" recommended elliptic curve domain - secp256r1 + /// The "SEC 2" recommended elliptic curve domain - secp256r1. /// Prime256V1, /// - /// 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. /// Secp384R1 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Key.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Key.cs index e175f55..675fc0a 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Key.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Key.cs @@ -21,7 +21,7 @@ using static Interop; namespace Tizen.Security.SecureRepository { /// - /// Class that represents a key. + /// The class that represents a key. /// /// 3 public class Key diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyManager.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyManager.cs index cb2395f..f1e3bac 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyManager.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyManager.cs @@ -20,13 +20,13 @@ using System.Collections.Generic; namespace Tizen.Security.SecureRepository { /// - /// This class provides the methods storing, retrieving, and creating keys. + /// This class provides the methods for storing, retrieving, and creating keys. /// /// 3 public class KeyManager : Manager { /// - /// Gets a key from secure repository. + /// Gets a key from the secure repository. /// /// 3 /// The name of a key to retrieve. @@ -37,13 +37,13 @@ namespace Tizen.Security.SecureRepository /// /// A key specified by alias. /// - /// Alias argument is null. + /// The alias argument is null. /// /// - /// Alias argument is invalid format. + /// The alias argument is in the invalid format. /// /// - /// 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. /// static public Key Get(string alias, string password) { @@ -67,10 +67,10 @@ namespace Tizen.Security.SecureRepository } /// - /// Gets all alias of keys which the client can access. + /// Gets all aliases of keys, which the client can access. /// /// 3 - /// All alias of keys which the client can access. + /// All aliases of keys, which the client can access. /// No alias to get. static public IEnumerable GetAliases() { @@ -91,7 +91,7 @@ namespace Tizen.Security.SecureRepository } /// - /// Stores a key inside secure repository based on the provided policy. + /// Stores a key inside the secure repository based on the provided policy. /// /// 3 /// The name of a key to be stored. @@ -101,17 +101,17 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// 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. /// /// - /// Key with alias does already exist. + /// The key with alias does already exist. /// /// - /// 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. /// /// - /// 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. /// static public void Save(string alias, Key key, Policy policy) @@ -126,7 +126,7 @@ namespace Tizen.Security.SecureRepository } /// - /// 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. /// /// 3 @@ -145,13 +145,13 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format. + /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format. /// /// - /// Key with privateKeyAlias or publicKeyAlias does already exist. + /// The key with privateKeyAlias or publicKeyAlias does already exist. /// /// - /// 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. /// static public void CreateRsaKeyPair( @@ -172,7 +172,7 @@ namespace Tizen.Security.SecureRepository } /// - /// 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. /// /// 3 @@ -192,13 +192,13 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format. + /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format. /// /// - /// Key with privateKeyAlias or publicKeyAlias does already exist. + /// The key with privateKeyAlias or publicKeyAlias does already exist. /// /// - /// 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. /// static public void CreateDsaKeyPair( @@ -219,7 +219,7 @@ namespace Tizen.Security.SecureRepository } /// - /// 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. /// /// 3 @@ -236,14 +236,14 @@ namespace Tizen.Security.SecureRepository /// Any of argument is null. /// /// - /// Elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is + /// The elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is in the /// invalid format. /// /// - /// Key with privateKeyAlias or publicKeyAlias does already exist. + /// The key with privateKeyAlias or publicKeyAlias does already exist. /// /// - /// 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. /// static public void CreateEcdsaKeyPair( @@ -262,25 +262,25 @@ namespace Tizen.Security.SecureRepository } /// - /// 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. /// /// 3 /// - /// 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. /// /// The name of key to be stored. /// The policy about how to store the key securely. /// - /// keyAlias or policy is null. + /// The keyAlias or policy is null. /// /// - /// Key size is invalid. keyAlias is invalid format. + /// The key size is invalid. keyAlias is in the invalid format. /// /// - /// Key with privateKeyAlias or publicKeyAlias does already exist. + /// The key with privateKeyAlias or publicKeyAlias does already exist. /// /// - /// 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. /// static public void CreateAesKey(int size, string keyAlias, Policy policy) diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyType.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyType.cs index 483af31..2458f76 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyType.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/KeyType.cs @@ -23,35 +23,35 @@ namespace Tizen.Security.SecureRepository public enum KeyType : int { /// - /// Key type not specified + /// Key type not specified. /// None = 0, /// - /// RSA public key + /// The RSA public key. /// RsaPublic, /// - /// RSA private key + /// The RSA private key. /// RsaPrivate, /// - /// ECDSA public key + /// The ECDSA public key. /// EcdsaPublic, /// - /// ECDSA private key + /// The ECDSA private key. /// EcdsaPrivate, /// - /// DSA public key + /// The DSA public key. /// DsaPublic, /// - /// DSA private key + /// The DSA private key. /// DsaPrivate, /// - /// AES key + /// The AES key. /// Aes } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Manager.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Manager.cs index 035eb8e..9df853b 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Manager.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Manager.cs @@ -19,17 +19,17 @@ using System; namespace Tizen.Security.SecureRepository { /// - /// 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. /// /// 3 public class Manager { /// - /// 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. /// /// 3 - /// Data owner's id. This should be package id if data + /// 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. /// Data alias. @@ -39,26 +39,26 @@ namespace Tizen.Security.SecureRepository } /// - /// 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. /// /// 3 - /// Data alias which is owned by system service. + /// Data alias, which is owned by system service. static public string CreateFullSystemAlias(string alias) { return Manager.CreateFullAlias(Manager.SystemOwnerId, alias); } /// - /// Removes a an entry (no matter of type) from the key manager. + /// Removes an entry (no matter of type) from the key manager. /// /// 3 /// Item alias to be removed. - /// alias is null. - /// alias is invalid format. - /// alias does not exist. + /// The alias is null. + /// The alias is in the invalid format. + /// The alias does not exist. /// - /// To remove item, client must have remove permission to the specified item. + /// To remove item, client must remove permission to the specified item. /// /// The item owner can remove by default. static public void RemoveAlias(string alias) @@ -77,19 +77,19 @@ namespace Tizen.Security.SecureRepository /// 3 /// Item alias for which access will be granted. /// - /// Package id of the application that will gain access rights. + /// Package ID of the application that will gain access rights. /// /// /// Mask of permissions(Permission enum) granted for an application with /// otherPackageId. /// /// - /// alias or otherPackageId is null. + /// The alias or otherPackageId is null. /// /// - /// alias or otherPackageId is invalid format. + /// The alias or otherPackageId is in the invalid format. /// - /// alias does not exist. + /// The alias does not exist. /// Data identified by alias should exist. /// The item owner can set permissions. static public void SetPermission( diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/OcspStatus.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/OcspStatus.cs index b6517e8..4e58135 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/OcspStatus.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/OcspStatus.cs @@ -23,45 +23,45 @@ using System.Threading.Tasks; namespace Tizen.Security.SecureRepository { /// - /// Enumeration for OCSP status. + /// Enumeration for the OCSP status. /// /// 3 public enum OcspStatus : int { /// - /// OCSP status is good + /// The OCSP status is good. /// Good = 0x00, /// - /// The certificate is revoked + /// The certificate is revoked. /// Revoked = 0x01, /// - /// Unknown error + /// Unknown error. /// Unknown = 0x02, /// - /// The certificate does not provide OCSP extension + /// The certificate does not provide the OCSP extension. /// Unsupported = 0x03, /// - /// The invalid URL in certificate OCSP extension + /// The invalid URL in the certificate OCSP extension. /// InvalidUrl = 0x04, /// - /// The invalid response from OCSP server + /// The invalid response from the OCSP server. /// InvalidResponse = 0x05, /// - /// OCSP remote server error + /// The OCSP remote server error. /// RemoteError = 0x06, /// - /// Network connection error + /// The Network connection error. /// NetworkError = 0x07, /// - /// Internal error + /// An Internal error. /// InternalError = 0x08 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Permission.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Permission.cs index 9dc4bda..33a3f95 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Permission.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Permission.cs @@ -24,15 +24,15 @@ namespace Tizen.Security.SecureRepository public enum Permission : int { /// - /// Clear permissions + /// Clear permissions. /// None = 0x00, /// - /// Eead allowed + /// Read allowed. /// Read = 0x01, /// - /// Remove allowed + /// Remove allowed. /// Remove = 0x02 } diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12.cs index fea73f9..0afb0e3 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12.cs @@ -22,7 +22,7 @@ using static Interop; namespace Tizen.Security.SecureRepository { /// - /// 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. /// /// 3 @@ -31,17 +31,17 @@ namespace Tizen.Security.SecureRepository private SafeCertificateListHandle _certChainHandle = null; /// - /// Load Pkcs12 from the given PKCS#12 file path. + /// Loads the Pkcs12 from the given PKCS#12 file path. /// /// 3 - /// The path of PKCS12 file to be loaded. + /// The path of the PKCS12 file to be loaded. /// The passphrase used to decrypt the PCKS12 file. - /// If PKCS12 file is not encrypted, passphrase can be null. - /// filePath is null. + /// If the PKCS12 file is not encrypted, passphrase can be null. + /// The filePath is null. /// /// 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. /// static public Pkcs12 Load(string filePath, string filePassword) @@ -83,7 +83,7 @@ namespace Tizen.Security.SecureRepository /// /// 3 /// A private key. - /// A certificate corresponding the private key + /// A certificate corresponding the private key. /// /// A certificate chain of CA(Certificate Authority) that issued the certificate. /// @@ -159,7 +159,7 @@ namespace Tizen.Security.SecureRepository } /// - /// A certificate corresponding the private key. + /// A certificate corresponding to the private key. /// /// 3 public Certificate Certificate diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12Manager.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12Manager.cs index 661db40..8775ab5 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12Manager.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Pkcs12Manager.cs @@ -20,29 +20,29 @@ using static Interop; namespace Tizen.Security.SecureRepository { /// - /// This class provides the methods storing, retrieving Pkcs12 contents. + /// This class provides the methods for storing and retrieving the Pkcs12 contents. /// /// 3 public class Pkcs12Manager : Manager { /// - /// Gets Pkcs12 contents from secure repository. + /// Gets Pkcs12 contents from the secure repository. /// /// 3 /// The name of data to retrieve. /// /// 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. /// /// /// The password used in decrypting a certificate value. If password of /// certificatePolicy is provided in SavePkcs12(), the same password should be - /// provided + /// provided. /// /// A Pkcs12 data specified by alias. - /// Alias argument is null. + /// The alias argument is null. /// - /// Alias argument is invalid format. + /// The alias argument is in the invalid format. /// /// /// Pkcs12 does not exist with the alias. @@ -87,7 +87,7 @@ namespace Tizen.Security.SecureRepository /// /// Any of argument is null. /// - /// 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. /// /// /// Pkcs12 with alias does already exist. diff --git a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Policy.cs b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Policy.cs index 56fac91..ba3a885 100644 --- a/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Policy.cs +++ b/src/Tizen.Security.SecureRepository/Tizen.Security.SecureRepository/Policy.cs @@ -41,7 +41,7 @@ namespace Tizen.Security.SecureRepository /// /// 3 /// Used to encrypt data secure repository. - /// If true key may be extracted from secure repository. + /// If true, key may be extracted from the secure repository. public Policy(String password, bool extractable) { Password = password; @@ -50,7 +50,7 @@ namespace Tizen.Security.SecureRepository /// /// 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. /// /// 3 public String Password @@ -59,7 +59,7 @@ namespace Tizen.Security.SecureRepository } /// - /// If true key may be extracted from secure repository. + /// If true, key may be extracted from the secure repository. /// /// 3 public bool Extractable diff --git a/src/Tizen.Security/Tizen.Security/Privilege.cs b/src/Tizen.Security/Tizen.Security/Privilege.cs index 8c62607..6e2d606 100755 --- a/src/Tizen.Security/Tizen.Security/Privilege.cs +++ b/src/Tizen.Security/Tizen.Security/Privilege.cs @@ -22,7 +22,7 @@ using Tizen.Applications; namespace Tizen.Security { /// - /// 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. /// /// 3 public static class Privilege @@ -50,14 +50,14 @@ namespace Tizen.Security /// Gets the display name of the given privilege. /// /// 3 - /// If there's no matching privilege then it returns last token of given privilege. - /// The api version - /// The privilege - /// The display name of given privilege at given api version + /// If there's no matching privilege, then it returns last token of the given privilege. + /// The API version. + /// The privilege. + /// The display name of the given privilege at the given API version. /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static string GetDisplayName(string apiVersion, string privilege) { string displayName; @@ -73,15 +73,15 @@ namespace Tizen.Security /// Gets the display name of the given privilege. /// /// 3 - /// If there's no matching privilege then it returns last token of given privilege. - /// The api version - /// The privilege - /// The type of application package - /// The display name of given privilege at given api version and the package type + /// If there's no matching privilege, then it returns last token of the given privilege. + /// The API version. + /// The privilege. + /// The type of application package. + /// The display name of the given privilege at the given API version and the package type. /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static string GetDisplayName(string apiVersion, string privilege, PackageType packageType) { string displayName; @@ -97,14 +97,14 @@ namespace Tizen.Security /// Gets the description of the given privilege. /// /// 3 - /// If there's no matching privilege then it returns description string for undefined privilege. - /// The api version - /// The privilege - /// The description of given privilege at given api version + /// If there's no matching privilege, then it returns description string for undefined privilege. + /// The API version. + /// The privilege. + /// The description of given privilege at the given API version /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static string GetDescription(string apiVersion, string privilege) { string description; @@ -120,15 +120,15 @@ namespace Tizen.Security /// Gets the description of the given privilege. /// /// 3 - /// If there's no matching privilege then it returns description string for undefined privilege. - /// The api version - /// The privilege - /// The type of application package - /// The description of given privilege at given api version and the package type + /// If there's no matching privilege, then it returns description string for undefined privilege. + /// The API version. + /// The privilege. + /// The type of application package. + /// The description of given privilege at the given API version and the package type. /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static string GetDescription(string apiVersion, string privilege, PackageType packageType) { string description; @@ -144,13 +144,13 @@ namespace Tizen.Security /// Gets the display name of the privacy group in which the given privilege is included. /// /// 3 - /// The privilege + /// The privilege. /// The privilege must be privacy related. - /// The privacy group's display name that the given privilege is included in + /// The privacy group's display name that the given privilege is included in. /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static string GetPrivacyDisplayName(string privilege) { string displayName; @@ -166,13 +166,13 @@ namespace Tizen.Security /// Gets the status of the given privacy related privilege. /// /// 3 - /// The privilege + /// The privilege. /// The privilege must be privacy related. - /// status true if the privilege is on and false if the privilege is off. + /// Status true if the privilege is on and false if the privilege is off. /// Thrown when there is a null parameter. /// Thrown when there is an invalid parameter. - /// Thrown when out of memory occurs - /// Thrown when internal error occurs. + /// Thrown when out of memory occurs. + /// Thrown when an internal error occurs. public static bool GetPrivacyPrivilegeStatus(string privilege) { bool status; -- 2.7.4