Artifacts/bin/public/Tizen.Account.FidoClient.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Account.FidoClient</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Interop.Libraries">
   8             <summary>
   9             Wrapper class for maintaining names of dependent native libraries.
  10             </summary>
  11         </member>
  12         <!-- Badly formed XML comment ignored for member "T:Tizen.Account.FidoClient.AuthenticatorInformation" -->
  13         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.Title">
  14             <summary>
  15             The authenticator Title
  16             </summary>
  17             <since_tizen> 3 </since_tizen>
  18         </member>
  19         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.Aaid">
  20             <summary>
  21             The Authenticator AAID (Authenticator Attestation ID)
  22             </summary>
  23             <since_tizen> 3 </since_tizen>
  24         </member>
  25         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.Description">
  26             <summary>
  27             The Authenticator description
  28             </summary>
  29             <since_tizen> 3 </since_tizen>
  30         </member>
  31         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.AssertionScheme">
  32             <summary>
  33             The Authenticator assertion scheme.
  34             </summary>
  35             <since_tizen> 3 </since_tizen>
  36         </member>
  37         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.AuthenticationAlgorithm">
  38             <summary>
  39             The Authenticator algorithm.
  40             </summary>
  41             <since_tizen> 3 </since_tizen>
  42         </member>
  43         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.UserVerification">
  44             <summary>
  45             The user verification method of this Authenticator
  46             </summary>
  47             <since_tizen> 3 </since_tizen>
  48         </member>
  49         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.KeyProtection">
  50             <summary>
  51             The key protection method of this Authenticator.
  52             </summary>
  53             <since_tizen> 3 </since_tizen>
  54         </member>
  55         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.MatcherProtection">
  56             <summary>
  57             The matcher protection method of this Authenticator.
  58             </summary>
  59             <since_tizen> 3 </since_tizen>
  60         </member>
  61         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.AttachmentHint">
  62             <summary>
  63             The attachment hint of this Authenticator.
  64             </summary>
  65             <since_tizen> 3 </since_tizen>
  66         </member>
  67         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.IsSecondFactorOnly">
  68             <summary>
  69             Denotes the Authenticator is Second factor only which is supported by U2F standards.
  70             </summary>
  71             <since_tizen> 3 </since_tizen>
  72         </member>
  73         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.AttestationTypes">
  74             <summary>
  75             The available attestation types for this Authenticator.
  76             </summary>
  77             <since_tizen> 3 </since_tizen>
  78         </member>
  79         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.TcDisplayType">
  80             <summary>
  81             The Transaction Confirmation display type of this Authenticator.
  82             </summary>
  83             <since_tizen> 3 </since_tizen>
  84         </member>
  85         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.TcDisplayContentType">
  86             <summary>
  87             The Transaction Confirmation display type of this Authenticator.
  88             </summary>
  89             <since_tizen> 3 </since_tizen>
  90         </member>
  91         <member name="P:Tizen.Account.FidoClient.AuthenticatorInformation.Icon">
  92             <summary>
  93             The icon of this Authenticator.
  94             </summary>
  95             <since_tizen> 3 </since_tizen>
  96         </member>
  97         <member name="T:Tizen.Account.FidoClient.UafAuthenticatorFinder">
  98             <summary>
  99             Class to find available FIDO specific authenticators on the device
 100             </summary>
 101             <since_tizen> 3 </since_tizen>
 102         </member>
 103         <!-- Badly formed XML comment ignored for member "M:Tizen.Account.FidoClient.UafAuthenticatorFinder.DiscoverAuthenticatorsAsync" -->
 104         <member name="T:Tizen.Account.FidoClient.UafClient">
 105             <summary>
 106             The FIDO UAF Client APIs
 107             </summary>
 108             <since_tizen> 3 </since_tizen>
 109         </member>
 110         <member name="P:Tizen.Account.FidoClient.UafClient.VendorName">
 111             <summary>
 112             The FIDO Client vendor name
 113             </summary>
 114             <since_tizen> 3 </since_tizen>
 115         </member>
 116         <member name="P:Tizen.Account.FidoClient.UafClient.MajorVersion">
 117             <summary>
 118             The FIDO Client Major version
 119             </summary>
 120             <since_tizen> 3 </since_tizen>
 121         </member>
 122         <member name="P:Tizen.Account.FidoClient.UafClient.MinorVersion">
 123             <summary>
 124             The FIDO Client Minor version
 125             </summary>
 126             <since_tizen> 3 </since_tizen>
 127         </member>
 128         <member name="P:Tizen.Account.FidoClient.UafClient.StautsOk">
 129             <summary>
 130             The FIDO Server response for successfull interaction.
 131             </summary>
 132             <since_tizen> 3 </since_tizen>
 133         </member>
 134         <member name="M:Tizen.Account.FidoClient.UafClient.CheckPolicyAsync(Tizen.Account.FidoClient.UafMessage)">
 135             <summary>
 136             Checks whether the FIDO message can be processed
 137             </summary>
 138             <since_tizen> 3 </since_tizen>
 139             <param name="uafMessage">The FIDO UAF message which is received from the relying party server</param>
 140             <returns>True if the message can be handled by the device, else false</returns>
 141             <privilege>http://tizen.org/privilege/fido.client</privilege>
 142             <feature>http://tizen.org/feature/fido.uaf</feature>
 143             <exception cref="T:System.ArgumentException"> In case of invalid parameter</exception>
 144             <exception cref="T:System.UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
 145             <exception cref="T:System.NotSupportedException">FIDO is not supported</exception>
 146             <example>
 147             <code>
 148                 UafMessage uafRequest = new UafMessage()
 149                 {
 150                     Operation = "UafRequestJson"
 151                 };
 152                 bool response = await UafClient.CheckPolicyAsync(uafRequest);
 153             </code>
 154             </example>
 155         </member>
 156         <member name="M:Tizen.Account.FidoClient.UafClient.ProcessRequestAsync(Tizen.Account.FidoClient.UafMessage,System.String)">
 157              <summary>
 158              Processes the given FIDO UAF message.
 159              </summary>
 160              <since_tizen> 3 </since_tizen>
 161              <param name="uafMessage">The FIDO UAF message which is received from the relying party server</param>
 162              <param name="channelBindng">The channel binding data in JSON format which is received from the relying party server</param>
 163              <returns>FIDO response message</returns>
 164              <privilege>http://tizen.org/privilege/fido.client</privilege>
 165              <feature>http://tizen.org/feature/fido.uaf</feature>
 166              <exception cref="T:System.ArgumentException"> In case of invalid parameter</exception>
 167              <exception cref="T:System.UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
 168              <exception cref="T:System.NotSupportedException">FIDO is not supported</exception>
 169              <example>
 170              <code>
 171                  UafMessage uafRequest = new UafMessage()
 172                  {
 173                      Operation = "UafAuthRequestJson"
 174                  };
 175
 176                  var response = await UafClient.ProcessRequestAsync(uafRequest, null);
 177              </code>
 178              </example>
 179         </member>
 180         <member name="M:Tizen.Account.FidoClient.UafClient.NotifyResultAsync(System.Int32,Tizen.Account.FidoClient.UafResponse)">
 181              <summary>
 182              Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.
 183              </summary>
 184              <since_tizen> 3 </since_tizen>
 185              <param name="responseCode">The status code received from Server.(StautsOk implies success)</param>
 186              <param name="response">The FIDO response message sent to server in JSON format</param>
 187              <privilege>http://tizen.org/privilege/fido.client</privilege>
 188              <feature>http://tizen.org/feature/fido.uaf</feature>
 189              <remarks>
 190              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
 191              </remarks>
 192              <exception cref="T:System.ArgumentException"> In case of invalid parameter</exception>
 193              <exception cref="T:System.UnauthorizedAccessException">Thrown when the application does not have privilege to access this method</exception>
 194              <exception cref="T:System.NotSupportedException">FIDO is not supported</exception>
 195              <example>
 196              <code>
 197                  UafResponse response = new UafResponse()
 198                  {
 199                      Response = "Responsejson"
 200                  };
 201
 202                  await UafClient.NotifyResultAsync(UafClient.StautsOk, response);
 203              </code>
 204              </example>
 205         </member>
 206         <member name="T:Tizen.Account.FidoClient.AuthenticationAlgorithm">
 207             <summary>
 208             Authenticator's supported algorithm and encoding
 209             </summary>
 210             <since_tizen> 3 </since_tizen>
 211         </member>
 212         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.Secp256r1EcdsaSha256Raw">
 213             <summary>
 214             SECP256R1 ECDSA SHA256 Raw
 215             </summary>
 216             <since_tizen> 3 </since_tizen>
 217         </member>
 218         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.Secp256r1EcdsaSha256Der">
 219             <summary>
 220             SECP256R1 ECDSA SHA256 DER
 221             </summary>
 222             <since_tizen> 3 </since_tizen>
 223         </member>
 224         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.RsassaPssSha256Raw">
 225             <summary>
 226             RSA PSS SHA256 Raw
 227             </summary>
 228             <since_tizen> 3 </since_tizen>
 229         </member>
 230         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.RsassaPssSha256Der">
 231             <summary>
 232             RSA PSS SHA256 DER
 233             </summary>
 234             <since_tizen> 3 </since_tizen>
 235         </member>
 236         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.Secp256k1EcdsaSha256Raw">
 237             <summary>
 238             SECP256K1 ECDSA SHA256 Raw
 239             </summary>
 240             <since_tizen> 3 </since_tizen>
 241         </member>
 242         <member name="F:Tizen.Account.FidoClient.AuthenticationAlgorithm.Secp256k1EcdsaSha256Der">
 243             <summary>
 244             SECP256K1 ECDSA SHA256 DER
 245             </summary>
 246             <since_tizen> 3 </since_tizen>
 247         </member>
 248         <member name="T:Tizen.Account.FidoClient.UserVerificationMethod">
 249             <summary>
 250             Authenticator's supported user verification method type.
 251             </summary>
 252             <since_tizen> 3 </since_tizen>
 253         </member>
 254         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Presence">
 255             <summary>
 256             User presence verification.
 257             </summary>
 258             <since_tizen> 3 </since_tizen>
 259         </member>
 260         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Fingerprint">
 261             <summary>
 262             User fingerprint verification.
 263             </summary>
 264             <since_tizen> 3 </since_tizen>
 265         </member>
 266         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Passcode">
 267             <summary>
 268             User passcode verification.
 269             </summary>
 270             <since_tizen> 3 </since_tizen>
 271         </member>
 272         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Voiceprint">
 273             <summary>
 274             User voiceprint verification.
 275             </summary>
 276             <since_tizen> 3 </since_tizen>
 277         </member>
 278         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Faceprint">
 279             <summary>
 280             User faceprint verification.
 281             </summary>
 282             <since_tizen> 3 </since_tizen>
 283         </member>
 284         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Location">
 285             <summary>
 286             User location verification.
 287             </summary>
 288             <since_tizen> 3 </since_tizen>
 289         </member>
 290         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Eyeprint">
 291             <summary>
 292             User eyeprint verification.
 293             </summary>
 294             <since_tizen> 3 </since_tizen>
 295         </member>
 296         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Pattern">
 297             <summary>
 298             User pattern verification.
 299             </summary>
 300             <since_tizen> 3 </since_tizen>
 301         </member>
 302         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.Handprint">
 303             <summary>
 304             User handprint verification.
 305             </summary>
 306             <since_tizen> 3 </since_tizen>
 307         </member>
 308         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.None">
 309             <summary>
 310             Silent verification.
 311             </summary>
 312             <since_tizen> 3 </since_tizen>
 313         </member>
 314         <member name="F:Tizen.Account.FidoClient.UserVerificationMethod.All">
 315             <summary>
 316             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).
 317             </summary>
 318             <since_tizen> 3 </since_tizen>
 319         </member>
 320         <member name="T:Tizen.Account.FidoClient.KeyProtectionType">
 321             <summary>
 322             Authenticator's supported key protection method type.
 323             </summary>
 324             <since_tizen> 3 </since_tizen>
 325         </member>
 326         <member name="F:Tizen.Account.FidoClient.KeyProtectionType.Software">
 327             <summary>
 328             Software based key management.
 329             </summary>
 330             <since_tizen> 3 </since_tizen>
 331         </member>
 332         <member name="F:Tizen.Account.FidoClient.KeyProtectionType.Hardware">
 333             <summary>
 334             Hardware based key management.
 335             </summary>
 336             <since_tizen> 3 </since_tizen>
 337         </member>
 338         <member name="F:Tizen.Account.FidoClient.KeyProtectionType.Tee">
 339             <summary>
 340             Trusted Execution Environment based key management.
 341             </summary>
 342             <since_tizen> 3 </since_tizen>
 343         </member>
 344         <member name="F:Tizen.Account.FidoClient.KeyProtectionType.SecureElement">
 345             <summary>
 346             Secure Element based key management.
 347             </summary>
 348             <since_tizen> 3 </since_tizen>
 349         </member>
 350         <member name="F:Tizen.Account.FidoClient.KeyProtectionType.RemoteHandle">
 351             <summary>
 352             Authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle.
 353             </summary>
 354             <since_tizen> 3 </since_tizen>
 355         </member>
 356         <member name="T:Tizen.Account.FidoClient.MatcherProtectionType">
 357             <summary>
 358             Authenticator's supported matcher protection type.
 359             </summary>
 360             <since_tizen> 3 </since_tizen>
 361         </member>
 362         <member name="F:Tizen.Account.FidoClient.MatcherProtectionType.Software">
 363             <summary>
 364             Authenticator's matcher is running in software.
 365             </summary>
 366             <since_tizen> 3 </since_tizen>
 367         </member>
 368         <member name="F:Tizen.Account.FidoClient.MatcherProtectionType.Tee">
 369             <summary>
 370             Authenticator's matcher is running inside the Trusted Execution Environment.
 371             </summary>
 372             <since_tizen> 3 </since_tizen>
 373         </member>
 374         <member name="F:Tizen.Account.FidoClient.MatcherProtectionType.OnChip">
 375             <summary>
 376             Aauthenticator's matcher is running on the chip.
 377             </summary>
 378             <since_tizen> 3 </since_tizen>
 379         </member>
 380         <member name="T:Tizen.Account.FidoClient.AuthenticatorAttachmentHint">
 381             <summary>
 382             Authenticator's supproted method to communicate to FIDO user device.
 383             </summary>
 384             <since_tizen> 3 </since_tizen>
 385         </member>
 386         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Internal">
 387             <summary>
 388             Authenticator is permanently attached to the FIDO User Device.
 389             </summary>
 390             <since_tizen> 3 </since_tizen>
 391         </member>
 392         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.External">
 393             <summary>
 394             Authenticator is removable or remote from the FIDO User Device.
 395             </summary>
 396             <since_tizen> 3 </since_tizen>
 397         </member>
 398         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Wired">
 399             <summary>
 400             The external authenticator currently has an exclusive wired connection.
 401             </summary>
 402             <since_tizen> 3 </since_tizen>
 403         </member>
 404         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Wireless">
 405             <summary>
 406             The external authenticator communicates with the FIDO User Device through wireless means.
 407             </summary>
 408             <since_tizen> 3 </since_tizen>
 409         </member>
 410         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Nfc">
 411             <summary>
 412             Authenticator is able to communicate by NFC to the FIDO User Device.
 413             </summary>
 414             <since_tizen> 3 </since_tizen>
 415         </member>
 416         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Bt">
 417             <summary>
 418             Authenticator is able to communicate by Bluetooth to the FIDO User Device.
 419             </summary>
 420             <since_tizen> 3 </since_tizen>
 421         </member>
 422         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Nw">
 423             <summary>
 424             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).
 425             </summary>
 426             <since_tizen> 3 </since_tizen>
 427         </member>
 428         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.Ready">
 429             <summary>
 430             The external authenticator is in a "ready" state.
 431             </summary>
 432             <since_tizen> 3 </since_tizen>
 433         </member>
 434         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttachmentHint.WifiDirect">
 435             <summary>
 436             The external authenticator is able to communicate using WiFi Direct with the FIDO User Device.
 437             </summary>
 438             <since_tizen> 3 </since_tizen>
 439         </member>
 440         <member name="T:Tizen.Account.FidoClient.AuthenticatorAttestationType">
 441             <summary>
 442             Authenticator's supported Attestation type.
 443             </summary>
 444             <since_tizen> 3 </since_tizen>
 445         </member>
 446         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttestationType.BasicFull">
 447             <summary>
 448             Full basic attestation.
 449             </summary>
 450             <since_tizen> 3 </since_tizen>
 451         </member>
 452         <member name="F:Tizen.Account.FidoClient.AuthenticatorAttestationType.BasicSurrogate">
 453             <summary>
 454             Surrogate basic attestation.
 455             </summary>
 456             <since_tizen> 3 </since_tizen>
 457         </member>
 458         <member name="T:Tizen.Account.FidoClient.TransactionConfirmationDisplayType">
 459             <summary>
 460             Transaction confirmation display capability type.
 461             </summary>
 462             <since_tizen> 3 </since_tizen>
 463         </member>
 464         <member name="F:Tizen.Account.FidoClient.TransactionConfirmationDisplayType.Any">
 465             <summary>
 466             Some form of transaction confirmation display is available on this authenticator.
 467             </summary>
 468             <since_tizen> 3 </since_tizen>
 469         </member>
 470         <member name="F:Tizen.Account.FidoClient.TransactionConfirmationDisplayType.PrivilegedSoftware">
 471             <summary>
 472             Software-based transaction confirmation display operating in a privileged context is available on this authenticator.
 473             </summary>
 474             <since_tizen> 3 </since_tizen>
 475         </member>
 476         <member name="F:Tizen.Account.FidoClient.TransactionConfirmationDisplayType.Tee">
 477             <summary>
 478             Transaction confirmation display is in a Trusted Execution Environment.
 479             </summary>
 480             <since_tizen> 3 </since_tizen>
 481         </member>
 482         <member name="F:Tizen.Account.FidoClient.TransactionConfirmationDisplayType.Hw">
 483             <summary>
 484             Transaction confirmation display based on hardware assisted capabilities is available on this authenticator.
 485             </summary>
 486             <since_tizen> 3 </since_tizen>
 487         </member>
 488         <member name="F:Tizen.Account.FidoClient.TransactionConfirmationDisplayType.Remote">
 489             <summary>
 490             Transaction confirmation display is provided on a distinct device from the FIDO User Device.
 491             </summary>
 492             <since_tizen> 3 </since_tizen>
 493         </member>
 494         <member name="T:Tizen.Account.FidoClient.UafMessage">
 495             <summary>
 496             The FIDO message received from the relying party server
 497             </summary>
 498             <since_tizen> 3 </since_tizen>
 499         </member>
 500         <member name="M:Tizen.Account.FidoClient.UafMessage.#ctor">
 501             <summary>
 502             The constructor
 503             </summary>
 504             <since_tizen> 3 </since_tizen>
 505         </member>
 506         <member name="P:Tizen.Account.FidoClient.UafMessage.Operation">
 507             <summary>
 508             The FIDO message in JSON format which is received from the relying party server
 509             </summary>
 510             <since_tizen> 3 </since_tizen>
 511         </member>
 512         <member name="T:Tizen.Account.FidoClient.UafResponse">
 513             <summary>
 514             Represents FIDO response message
 515             </summary>
 516             <since_tizen> 3 </since_tizen>
 517         </member>
 518         <member name="M:Tizen.Account.FidoClient.UafResponse.#ctor">
 519             <summary>
 520             The constructor
 521             </summary>
 522             <since_tizen> 3 </since_tizen>
 523         </member>
 524         <member name="P:Tizen.Account.FidoClient.UafResponse.Response">
 525             <summary>
 526             FIDO response message in JSON format
 527             </summary>
 528             <since_tizen> 3 </since_tizen>
 529         </member>
 530     </members>
 531 </doc>