Class UafClient
Definition
- Namespace:
- Tizen.Account.FidoClient
- Assembly:
- Tizen.Account.FidoClient.dll
The FIDO UAF Client APIs
public static class UafClient
- Inheritance
-
objectUafClient
Properties
View SourceMajorVersion
The FIDO Client Major version
Declaration
public static int MajorVersion { get; }
Property Value
Type | Description |
---|---|
int |
MinorVersion
The FIDO Client Minor version
Declaration
public static int MinorVersion { get; }
Property Value
Type | Description |
---|---|
int |
StautsOk
The FIDO Server response for successfull interaction.
Declaration
public static int StautsOk { get; }
Property Value
Type | Description |
---|---|
int |
VendorName
The FIDO Client vendor name
Declaration
public static string VendorName { get; }
Property Value
Type | Description |
---|---|
string |
Methods
View SourceCheckPolicyAsync(UafMessage)
Checks whether the FIDO message can be processed
Declaration
public static Task<bool> CheckPolicyAsync(UafMessage uafMessage)
Parameters
Type | Name | Description |
---|---|---|
UafMessage | uafMessage | The FIDO UAF message which is received from the relying party server |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><bool> | True if the message can be handled by the device, else false |
Examples
UafMessage uafRequest = new UafMessage()
{
Operation = "UafRequestJson"
};
bool response = await UafClient.CheckPolicyAsync(uafRequest);
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of invalid parameter |
System.UnauthorizedAccessException | Thrown when the application does not have privilege to access this method |
System.NotSupportedException | FIDO is not supported |
NotifyResultAsync(int, UafResponse)
Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.
Declaration
public static Task NotifyResultAsync(int responseCode, UafResponse response)
Parameters
Type | Name | Description |
---|---|---|
int | responseCode | The status code received from Server.(StautsOk implies success) |
UafResponse | response | The FIDO response message sent to server in JSON format |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
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
Examples
UafResponse response = new UafResponse()
{
Response = "Responsejson"
};
await UafClient.NotifyResultAsync(UafClient.StautsOk, response);
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of invalid parameter |
System.UnauthorizedAccessException | Thrown when the application does not have privilege to access this method |
System.NotSupportedException | FIDO is not supported |
ProcessRequestAsync(UafMessage, string)
Processes the given FIDO UAF message.
Declaration
public static Task<UafResponse> ProcessRequestAsync(UafMessage uafMessage, string channelBindng)
Parameters
Type | Name | Description |
---|---|---|
UafMessage | uafMessage | The FIDO UAF message which is received from the relying party server |
string | channelBindng | The channel binding data in JSON format which is received from the relying party server |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><UafResponse> | FIDO response message |
Examples
UafMessage uafRequest = new UafMessage()
{
Operation = "UafAuthRequestJson"
};
var response = await UafClient.ProcessRequestAsync(uafRequest, null);
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of invalid parameter |
System.UnauthorizedAccessException | Thrown when the application does not have privilege to access this method |
System.NotSupportedException | FIDO is not supported |