File: internal_authenticator.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (90 lines) | stat: -rw-r--r-- 3,979 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_WEBAUTHN_CORE_BROWSER_INTERNAL_AUTHENTICATOR_H_
#define COMPONENTS_WEBAUTHN_CORE_BROWSER_INTERNAL_AUTHENTICATOR_H_

#include "base/functional/callback.h"
#include "third_party/blink/public/mojom/webauthn/authenticator.mojom.h"
#include "url/origin.h"

namespace content {
class RenderFrameHost;
}  // namespace content

namespace webauthn {

// Callback for GetMatchingCredentialIds. This method is not exposed to the
// renderer directly, and so its callback is not defined in mojom.
using GetMatchingCredentialIdsCallback =
    base::OnceCallback<void(std::vector<std::vector<uint8_t>>)>;

// Interface similar to blink::mojom::Authenticator meant only for internal
// components in Chrome to use in order to direct authenticators to create or
// use a public key credential. Unlike Authenticator, the caller will be
// allowed to set its own effective origin.
class InternalAuthenticator {
 public:
  using GetAssertionCallback = base::OnceCallback<void(
      blink::mojom::AuthenticatorStatus,
      blink::mojom::GetAssertionAuthenticatorResponsePtr,
      blink::mojom::WebAuthnDOMExceptionDetailsPtr)>;
  virtual ~InternalAuthenticator() = default;

  // Sets the effective origin of the caller. Since this may be a browser
  // process, the Relying Party ID may be different from the renderer's origin.
  virtual void SetEffectiveOrigin(const url::Origin& origin) = 0;

  // Sets the payment information to be added to the "clientDataJson". Should be
  // used only if the user has confirmed the payment information that was
  // displayed to the user.
  virtual void SetPaymentOptions(blink::mojom::PaymentOptionsPtr payment) = 0;

  // Gets the credential info for a new public key credential created by an
  // authenticator for the given |options|. Invokes |callback| with credentials
  // if authentication was successful.
  virtual void MakeCredential(
      blink::mojom::PublicKeyCredentialCreationOptionsPtr options,
      blink::mojom::Authenticator::MakeCredentialCallback callback) = 0;

  // Uses an existing credential to produce an assertion for the given
  // |options|. Invokes |callback| with assertion response if authentication
  // was successful.
  virtual void GetAssertion(
      blink::mojom::PublicKeyCredentialRequestOptionsPtr options,
      GetAssertionCallback callback) = 0;

  // Returns true if the user platform provides an authenticator. Relying
  // Parties use this method to determine whether they can create a new
  // credential using a user-verifying platform authenticator.
  virtual void IsUserVerifyingPlatformAuthenticatorAvailable(
      blink::mojom::Authenticator::
          IsUserVerifyingPlatformAuthenticatorAvailableCallback callback) = 0;

  // Returns true if an authenticator supports the GetMatchingCredentialIds API.
  virtual bool IsGetMatchingCredentialIdsSupported() = 0;

  // Queries the authenticator for known credentials for the given
  // |relying_party_id| which are also in the input |credential_ids| list.
  // Optionally, can restrict to only match third-party payment enabled
  // credentials.
  virtual void GetMatchingCredentialIds(
      const std::string& relying_party_id,
      const std::vector<std::vector<uint8_t>>& credential_ids,
      bool require_third_party_payment_bit,
      GetMatchingCredentialIdsCallback callback) = 0;

  // Cancel an ongoing MakeCredential or GetAssertion request.
  // Only one MakeCredential or GetAssertion call at a time is allowed,
  // any future calls are cancelled.
  virtual void Cancel() = 0;

  // Returns the non-owned RenderFrameHost associated with this authenticator.
  // Can be used for observing the host's deletion.
  virtual content::RenderFrameHost* GetRenderFrameHost() = 0;
};

}  // namespace webauthn

#endif  // COMPONENTS_WEBAUTHN_CORE_BROWSER_INTERNAL_AUTHENTICATOR_H_