Class UafClient

Definition

Namespace:: Tizen.Account.FidoClient

Assembly:: Tizen.Account.FidoClient.dll

API Level:: 3

The FIDO UAF Client APIs


                C#
                
                    Copy
                    
                
            
public static class UafClient

Inheritance: System.Object

UafClient

Properties

View Source

MajorVersion

The FIDO Client Major version

Declaration


                C#
                
                    Copy
                    
                
            
public static int MajorVersion { get; }

Property Value

Type	Description
System.Int32

API Level: 3

View Source

MinorVersion

The FIDO Client Minor version

Declaration


                C#
                
                    Copy
                    
                
            
public static int MinorVersion { get; }

Property Value

Type	Description
System.Int32

API Level: 3

View Source

StautsOk

The FIDO Server response for successfull interaction.

Declaration


                C#
                
                    Copy
                    
                
            
public static int StautsOk { get; }

Property Value

Type	Description
System.Int32

API Level: 3

View Source

VendorName

The FIDO Client vendor name

Declaration


                C#
                
                    Copy
                    
                
            
public static string VendorName { get; }

Property Value

Type	Description
System.String

API Level: 3

Methods

View Source

CheckPolicyAsync(UafMessage)

Checks whether the FIDO message can be processed

Declaration


                C#
                
                    Copy
                    
                
            
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<System.Boolean>	True if the message can be handled by the device, else false

Examples


                
                
                    Copy
                    
                
            
    UafMessage uafRequest = new UafMessage()
    {
        Operation = "UafRequestJson"
    };
    bool response = await UafClient.CheckPolicyAsync(uafRequest);

Exceptions

Type	Condition
System.ArgumentException	In case of invalid parameter
UnauthorizedAccessException	Thrown when the application does not have privilege to access this method
System.NotSupportedException	FIDO is not supported

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/fido.client

Feature: http://tizen.org/feature/fido.uaf

View Source

NotifyResultAsync(Int32, UafResponse)

Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task NotifyResultAsync(int responseCode, UafResponse response)

Parameters

Type	Name	Description
System.Int32	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


                
                
                    Copy
                    
                
            
    UafResponse response = new UafResponse()
    {
        Response = "Responsejson"
    };

    await UafClient.NotifyResultAsync(UafClient.StautsOk, response);

Exceptions

Type	Condition
System.ArgumentException	In case of invalid parameter
UnauthorizedAccessException	Thrown when the application does not have privilege to access this method
System.NotSupportedException	FIDO is not supported

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/fido.client

Feature: http://tizen.org/feature/fido.uaf

View Source

ProcessRequestAsync(UafMessage, String)

Processes the given FIDO UAF message.

Declaration


                C#
                
                    Copy
                    
                
            
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
System.String	channelBindng	The channel binding data in JSON format which is received from the relying party server

Returns

Type	Description
System.Threading.Tasks.Task<UafResponse>	FIDO response message

Examples


                
                
                    Copy
                    
                
            
    UafMessage uafRequest = new UafMessage()
    {
        Operation = "UafAuthRequestJson"
    };

    var response = await UafClient.ProcessRequestAsync(uafRequest, null);

Exceptions

Type	Condition
System.ArgumentException	In case of invalid parameter
UnauthorizedAccessException	Thrown when the application does not have privilege to access this method
System.NotSupportedException	FIDO is not supported