File: auth_request.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (59 lines) | stat: -rw-r--r-- 2,182 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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROMEOS_ASH_COMPONENTS_OSAUTH_PUBLIC_REQUEST_AUTH_REQUEST_H_
#define CHROMEOS_ASH_COMPONENTS_OSAUTH_PUBLIC_REQUEST_AUTH_REQUEST_H_

#include <memory>

#include "base/component_export.h"
#include "chromeos/ash/components/login/auth/public/auth_session_intent.h"

namespace ash {

class UserContext;

// This class encapsulates logic that governs behaviors specific to
// a given `ActiveSessionAuthController::Reason`.
// `AuthRequest` is passed to `ActiveSessionAuthController::ShowAuthDialog`
// to modify various behaviors of the authentication.
class COMPONENT_EXPORT(CHROMEOS_ASH_COMPONENTS_OSAUTH) AuthRequest {
 public:
  // The enums below are used in histograms, do not remove/renumber entries. If
  // you're adding to any of these enums, update
  // ActiveSessionAuthControllerReason in
  // tools/metrics/histograms/metadata/ash/enums.xml:
  enum class Reason {
    kPasswordManager = 0,
    kSettings = 1,
    kWebAuthN = 2,
    kMaxValue = kWebAuthN
  };

  // Returns the AuthSession intent to be used for the AuthRequest.
  // This differs from `GetAuthReason` in that in returns the
  // cryptohome-level intent of the authentication. i.e kDecrypt vs
  // kVerifyOnly vs kWebAuthN.
  virtual AuthSessionIntent GetAuthSessionIntent() const = 0;

  // Return the reason from authentication. This is the client that
  // requested the authentication. i.e ChromeOS settings, Chrome
  // password manager, WebAuthN.
  virtual Reason GetAuthReason() const = 0;

  // Returns a description to attach under the dialog's Titlebar,
  // describing the purpose of the authentication. i.e "ChromeOS
  // settings would like to know it's you".
  virtual const std::u16string GetDescription() const = 0;

  // Notified clients of the authentication of success or failure.
  virtual void NotifyAuthSuccess(std::unique_ptr<UserContext> user_context) = 0;
  virtual void NotifyAuthFailure() = 0;

  virtual ~AuthRequest() = default;
};

}  // namespace ash

#endif  // CHROMEOS_ASH_COMPONENTS_OSAUTH_PUBLIC_REQUEST_AUTH_REQUEST_H_