internal static partial class Interop
{
/// <summary>
- /// Wrapper class for maintaining names of dependent native libraries.
+ /// The wrapper class for maintaining names of dependent native libraries.
/// </summary>
internal static partial class Libraries
{
}
/// <summary>
- /// The authenticator Title
+ /// The authenticator title.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Title { get; internal set; }
/// <summary>
- /// The Authenticator AAID (Authenticator Attestation ID)
+ /// The authenticator AAID (Authenticator Attestation ID).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Aaid { get; internal set; }
/// <summary>
- /// The Authenticator description
+ /// The authenticator description.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Description { get; internal set; }
/// <summary>
- /// The Authenticator assertion scheme.
+ /// The authenticator assertion scheme.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string AssertionScheme { get; internal set; }
/// <summary>
- /// The Authenticator algorithm.
+ /// The authenticator algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public AuthenticationAlgorithm AuthenticationAlgorithm { get; internal set; }
/// <summary>
- /// The user verification method of this Authenticator
+ /// The user verification method of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public UserVerificationMethod UserVerification { get; internal set; }
/// <summary>
- /// The key protection method of this Authenticator.
+ /// The key protection method of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public KeyProtectionType KeyProtection { get; internal set; }
/// <summary>
- /// The matcher protection method of this Authenticator.
+ /// The matcher protection method of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public MatcherProtectionType MatcherProtection { get; internal set; }
/// <summary>
- /// The attachment hint of this Authenticator.
+ /// The attachment hint of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public AuthenticatorAttachmentHint AttachmentHint { get; internal set; }
/// <summary>
- /// Denotes the Authenticator is Second factor only which is supported by U2F standards.
+ /// Denotes that the authenticator is the second factor only which is supported by U2F standards.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool IsSecondFactorOnly { get; internal set; }
/// <summary>
- /// The available attestation types for this Authenticator.
+ /// The available attestation types for this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IEnumerable<AuthenticatorAttestationType> AttestationTypes { get; internal set; }
/// <summary>
- /// The Transaction Confirmation display type of this Authenticator.
+ /// The transaction confirmation display type of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public TransactionConfirmationDisplayType TcDisplayType { get; internal set; }
/// <summary>
- /// The Transaction Confirmation display type of this Authenticator.
+ /// The transaction confirmation display type of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string TcDisplayContentType { get; internal set; }
/// <summary>
- /// The icon of this Authenticator.
+ /// The icon of this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Icon { get; internal set; }
namespace Tizen.Account.FidoClient
{
/// <summary>
- /// Class to find available FIDO specific authenticators on the device
+ /// This class is used to find available FIDO specific authenticators on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class UafAuthenticatorFinder
{
/// <summary>
- /// Retrieves all the available FIDO authenticators supported by this Device.
+ /// Retrieves all the available FIDO authenticators supported by this device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Enumerable list of authenticators</returns>
+ /// <returns>Enumerable list of authenticators.</returns>
/// <privilege>http://tizen.org/privilege/fido.client</privilege>
/// <feature>http://tizen.org/feature/fido.uaf</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
- /// <exception cref="NotSupportedException">FIDO is not supported</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have a privilege to access this method.</exception>
+ /// <exception cref="NotSupportedException">FIDO is not supported.</exception>
/// <example>
/// <code>
namespace Tizen.Account.FidoClient
{
/// <summary>
- /// The FIDO UAF Client APIs
+ /// The FIDO UAF client APIs.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class UafClient
}
/// <summary>
- /// The FIDO Client vendor name
+ /// The FIDO client vendor name.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static string VendorName
}
/// <summary>
- /// The FIDO Client Major version
+ /// The FIDO client major version.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static int MajorVersion
}
/// <summary>
- /// The FIDO Client Minor version
+ /// The FIDO client minor version.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static int MinorVersion
}
/// <summary>
- /// The FIDO Server response for successfull interaction.
+ /// The FIDO server response for the successful interaction.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static int StautsOk
}
/// <summary>
- /// Checks whether the FIDO message can be processed
+ /// Checks whether the FIDO message can be processed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="uafMessage">The FIDO UAF message which is received from the relying party server</param>
- /// <returns>True if the message can be handled by the device, else false</returns>
+ /// <param name="uafMessage">The FIDO UAF message which is received from the relying party server.</param>
+ /// <returns>True if the message can be handled by the device, else false.</returns>
/// <privilege>http://tizen.org/privilege/fido.client</privilege>
/// <feature>http://tizen.org/feature/fido.uaf</feature>
- /// <exception cref="ArgumentException"> In case of invalid parameter</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
- /// <exception cref="NotSupportedException">FIDO is not supported</exception>
+ /// <exception cref="ArgumentException"> In case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have a privilege to access this method.</exception>
+ /// <exception cref="NotSupportedException">FIDO is not supported.</exception>
/// <example>
/// <code>
/// UafMessage uafRequest = new UafMessage()
/// Processes the given FIDO UAF message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="uafMessage">The FIDO UAF message which is received from the relying party server</param>
- /// <param name="channelBindng">The channel binding data in JSON format which is received from the relying party server</param>
- /// <returns>FIDO response message</returns>
+ /// <param name="uafMessage">The FIDO UAF message which is received from the relying party server.</param>
+ /// <param name="channelBindng">The channel binding data in the JSON format which is received from the relying party server.</param>
+ /// <returns>FIDO response message.</returns>
/// <privilege>http://tizen.org/privilege/fido.client</privilege>
/// <feature>http://tizen.org/feature/fido.uaf</feature>
- /// <exception cref="ArgumentException"> In case of invalid parameter</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
- /// <exception cref="NotSupportedException">FIDO is not supported</exception>
+ /// <exception cref="ArgumentException"> In case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have a privilege to access this method.</exception>
+ /// <exception cref="NotSupportedException">FIDO is not supported.</exception>
/// <example>
/// <code>
/// UafMessage uafRequest = new UafMessage()
}
/// <summary>
- /// Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.
+ /// Notifies the FIDO client about the server result. The FIDO server sends the result of processing a UAF message to the FIDO client.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="responseCode">The status code received from Server.(StautsOk implies success)</param>
- /// <param name="response">The FIDO response message sent to server in JSON format</param>
+ /// <param name="responseCode">The status code received from the server (StautsOk implies success).</param>
+ /// <param name="response">The FIDO response message sent to the server in the JSON format.</param>
/// <privilege>http://tizen.org/privilege/fido.client</privilege>
/// <feature>http://tizen.org/feature/fido.uaf</feature>
/// <remarks>
- /// This is especially important for cases when a new registration may be considered by the client to be in a pending state until it is communicated that the server accepted it
+ /// This is especially important for cases when a new registration may be considered by the client to be in a pending state until it is communicated that the server accepted it.
/// </remarks>
- /// <exception cref="ArgumentException"> In case of invalid parameter</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
- /// <exception cref="NotSupportedException">FIDO is not supported</exception>
+ /// <exception cref="ArgumentException"> In case of an invalid parameter.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have a privilege to access this method.</exception>
+ /// <exception cref="NotSupportedException">FIDO is not supported.</exception>
/// <example>
/// <code>
/// UafResponse response = new UafResponse()
namespace Tizen.Account.FidoClient
{
/// <summary>
- /// Authenticator's supported algorithm and encoding
+ /// The authenticator's supported algorithm and encoding.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum AuthenticationAlgorithm
{
/// <summary>
- /// SECP256R1 ECDSA SHA256 Raw
+ /// SECP256R1 ECDSA SHA256 Raw.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Secp256r1EcdsaSha256Raw = 0X01,
/// <summary>
- /// SECP256R1 ECDSA SHA256 DER
+ /// SECP256R1 ECDSA SHA256 DER.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Secp256r1EcdsaSha256Der = 0X02,
/// <summary>
- /// RSA PSS SHA256 Raw
+ /// RSA PSS SHA256 Raw.
/// </summary>
/// <since_tizen> 3 </since_tizen>
RsassaPssSha256Raw = 0X03,
/// <summary>
- /// RSA PSS SHA256 DER
+ /// RSA PSS SHA256 DER.
/// </summary>
/// <since_tizen> 3 </since_tizen>
RsassaPssSha256Der = 0X04,
/// <summary>
- /// SECP256K1 ECDSA SHA256 Raw
+ /// SECP256K1 ECDSA SHA256 Raw.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Secp256k1EcdsaSha256Raw = 0X05,
/// <summary>
- /// SECP256K1 ECDSA SHA256 DER
+ /// SECP256K1 ECDSA SHA256 DER.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Secp256k1EcdsaSha256Der = 0X06
}
/// <summary>
- /// Authenticator's supported user verification method type.
+ /// The authenticator's supported user verification method type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum UserVerificationMethod
{
/// <summary>
- /// User presence verification.
+ /// The user presence verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Presence = 0X01,
/// <summary>
- /// User fingerprint verification.
+ /// The user fingerprint verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Fingerprint = 0X02,
/// <summary>
- /// User passcode verification.
+ /// The user passcode verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Passcode = 0X04,
/// <summary>
- /// User voiceprint verification.
+ /// The user voiceprint verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Voiceprint = 0X08,
/// <summary>
- /// User faceprint verification.
+ /// The user faceprint verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Faceprint = 0X10,
/// <summary>
- /// User location verification.
+ /// The user location verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Location = 0X20,
/// <summary>
- /// User eyeprint verification.
+ /// The user eyeprint verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Eyeprint = 0X40,
/// <summary>
- /// User pattern verification.
+ /// The user pattern verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Pattern = 0X80,
/// <summary>
- /// User handprint verification.
+ /// The user handprint verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Handprint = 0X100,
/// <summary>
- /// Silent verification.
+ /// The silent verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None = 0X200,
/// <summary>
- /// If an authenticator sets multiple flags for user verification types, it may also set this flag to indicate that all verification methods will be enforced (e.g. faceprint AND voiceprint). If flags for multiple user verification methods are set and this flag is not set, verification with only one is necessary (e.g. fingerprint OR passcode).
+ /// If an authenticator sets multiple flags for user verification types, it may also set this flag to indicate that all verification methods will be enforced (for example, faceprint AND voiceprint). If flags for multiple user verification methods are set and this flag is not set, verification with only one is necessary (for eample, fingerprint OR passcode).
/// </summary>
/// <since_tizen> 3 </since_tizen>
All = 0X400
}
/// <summary>
- /// Authenticator's supported key protection method type.
+ /// The authenticator's supported key protection method type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum KeyProtectionType
{
/// <summary>
- /// Software based key management.
+ /// The software based key management.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Software = 0X01,
/// <summary>
- /// Hardware based key management.
+ /// The hardware based key management.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Hardware = 0X02,
/// <summary>
- /// Trusted Execution Environment based key management.
+ /// The trusted execution environment based key management.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Tee = 0X04,
/// <summary>
- /// Secure Element based key management.
+ /// The secure element based key management.
/// </summary>
/// <since_tizen> 3 </since_tizen>
SecureElement = 0X08,
/// <summary>
- /// Authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle.
+ ///The authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle.
/// </summary>
/// <since_tizen> 3 </since_tizen>
RemoteHandle = 0X10
}
/// <summary>
- /// Authenticator's supported matcher protection type.
+ /// The authenticator's supported matcher protection type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum MatcherProtectionType
{
/// <summary>
- /// Authenticator's matcher is running in software.
+ /// The authenticator's matcher is running in the software.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Software = 0X01,
/// <summary>
- /// Authenticator's matcher is running inside the Trusted Execution Environment.
+ /// The authenticator's matcher is running inside the trusted execution environment.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Tee = 0X02,
/// <summary>
- /// Aauthenticator's matcher is running on the chip.
+ /// The authenticator's matcher is running on the chip.
/// </summary>
/// <since_tizen> 3 </since_tizen>
OnChip = 0X04
}
/// <summary>
- /// Authenticator's supproted method to communicate to FIDO user device.
+ /// Th authenticator's supproted method to communicate to the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum AuthenticatorAttachmentHint
{
/// <summary>
- /// Authenticator is permanently attached to the FIDO User Device.
+ /// The authenticator is permanently attached to the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Internal = 0X01,
/// <summary>
- /// Authenticator is removable or remote from the FIDO User Device.
+ /// The authenticator is removable or remote from the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
External = 0X02,
Wired = 0X04,
/// <summary>
- /// The external authenticator communicates with the FIDO User Device through wireless means.
+ /// The external authenticator communicates with the FIDO user device through wireless means.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Wireless = 0X08,
/// <summary>
- /// Authenticator is able to communicate by NFC to the FIDO User Device.
+ /// The authenticator is able to communicate by the NFC to the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Nfc = 0X10,
/// <summary>
- /// Authenticator is able to communicate by Bluetooth to the FIDO User Device.
+ /// The authenticator is able to communicate by Bluetooth to the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Bt = 0X20,
/// <summary>
- /// Authenticator is connected to the FIDO User Device ver a non-exclusive network (e.g. over a TCP/IP LAN or WAN, as opposed to a PAN or point-to-point connection).
+ /// The authenticator is connected to the FIDO user device over a non-exclusive network (for example, over a TCP/IP LAN or WAN, as opposed to a PAN or point-to-point connection).
/// </summary>
/// <since_tizen> 3 </since_tizen>
Nw = 0X40,
Ready = 0X80,
/// <summary>
- /// The external authenticator is able to communicate using WiFi Direct with the FIDO User Device.
+ /// The external authenticator is able to communicate using WiFi Direct with the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
WifiDirect = 0X100
}
/// <summary>
- /// Authenticator's supported Attestation type.
+ /// The authenticator's supported attestation type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum AuthenticatorAttestationType
{
/// <summary>
- /// Full basic attestation.
+ /// The full basic attestation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
BasicFull = 0X3e07,
/// <summary>
- /// Surrogate basic attestation.
+ /// The surrogate basic attestation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
BasicSurrogate = 0X3e08,
}
/// <summary>
- /// Transaction confirmation display capability type.
+ /// The transaction confirmation display capability type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum TransactionConfirmationDisplayType
Any = 0X01,
/// <summary>
- /// Software-based transaction confirmation display operating in a privileged context is available on this authenticator.
+ /// The software-based transaction confirmation display operating in a privileged context is available on this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
PrivilegedSoftware = 0X02,
/// <summary>
- /// Transaction confirmation display is in a Trusted Execution Environment.
+ /// The transaction confirmation display is in a trusted execution environment.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Tee = 0X04,
/// <summary>
- /// Transaction confirmation display based on hardware assisted capabilities is available on this authenticator.
+ /// The transaction confirmation display based on the hardware assisted capabilities is available on this authenticator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Hw = 0X08,
/// <summary>
- /// Transaction confirmation display is provided on a distinct device from the FIDO User Device.
+ /// The transaction confirmation display is provided on a distinct device from the FIDO user device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Remote = 0X10
namespace Tizen.Account.FidoClient
{
/// <summary>
- /// The FIDO message received from the relying party server
+ /// The FIDO message received from the relying party server.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class UafMessage
{
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public UafMessage()
}
/// <summary>
- /// The FIDO message in JSON format which is received from the relying party server
+ /// The FIDO message in the JSON format which is received from the relying party server.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Operation { get; set; }
namespace Tizen.Account.FidoClient
{
/// <summary>
- /// Represents FIDO response message
+ /// Represents the FIDO response message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class UafResponse
{
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public UafResponse()
}
/// <summary>
- /// FIDO response message in JSON format
+ /// The FIDO response message in the JSON format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Response { set; get; }
projects / platform / core / csapi / fido-client.git / commitdiff