File: device_trust_key_manager.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 (101 lines) | stat: -rw-r--r-- 4,013 bytes parent folder | download | duplicates (9)
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
91
92
93
94
95
96
97
98
99
100
101
// Copyright 2021 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_ENTERPRISE_BROWSER_DEVICE_TRUST_DEVICE_TRUST_KEY_MANAGER_H_
#define COMPONENTS_ENTERPRISE_BROWSER_DEVICE_TRUST_DEVICE_TRUST_KEY_MANAGER_H_

#include <optional>
#include <string>
#include <vector>

#include "base/functional/callback.h"
#include "components/policy/proto/device_management_backend.pb.h"
#include "crypto/signature_verifier.h"

namespace enterprise_connectors {

// Interface for the instance in charge of starting signing key
// creation/rotation, caching of the key and providing access to its methods.
class DeviceTrustKeyManager {
 public:
  virtual ~DeviceTrustKeyManager() = default;

  // TODO(b:265141726): Rename this enum to reduce confusion with the other
  // KeyRotationResult enum used as installer type.
  enum class KeyRotationResult {
    SUCCESS = 0,
    FAILURE = 1,
    CANCELLATION = 2,
  };

  enum class PermanentFailure {
    // A HTTP response code of 409 was returned when trying to upload a key
    // for the first time. This means a key already exists remotely for the
    // current device, and an admin will need to clear it before upload will
    // succeed.
    kCreationUploadConflict = 0,

    // This error is used to indicate that the browser is missing some
    // permissions in order to set up the Device Trust connector.
    // On Linux, this can mean that the management binary wasn't tagged with the
    // proper Linux group.
    kInsufficientPermissions = 1,

    // A platform-specific requirement was not met.
    // On Mac, this can mean that the current device does not support Secure
    // Enclave.
    kOsRestriction = 2,

    // Something is missing from the installation.
    kInvalidInstallation = 3,
  };

  struct KeyMetadata {
    enterprise_management::BrowserPublicKeyUploadRequest::KeyTrustLevel
        trust_level{};
    crypto::SignatureVerifier::SignatureAlgorithm algorithm{};
    std::string spki_bytes{};
    std::optional<int> synchronization_response_code = std::nullopt;
    std::optional<PermanentFailure> permanent_failure = std::nullopt;
  };

  // Starts the initialization of the manager which includes trying to load the
  // signing key, or kicking off its creation. This function is idempotent, so
  // only the initial call matters (subsequent calls will be ignored).
  virtual void StartInitialization() = 0;

  // Starts a key rotation sequence which will update the serialized key,
  // upload it to the server using the `nonce`, and then update the cached key.
  // Invokes `callback` upon completing the rotation with an enum parameter
  // indicating the outcome for the request.
  virtual void RotateKey(
      const std::string& nonce,
      base::OnceCallback<void(KeyRotationResult)> callback) = 0;

  // Asynchronously exports the signing key pair's public key into a string.
  // Invokes `callback` with that string when it is available.
  virtual void ExportPublicKeyAsync(
      base::OnceCallback<void(std::optional<std::string>)> callback) = 0;

  // Asynchronously signs the given string `str` using the signing key pair.
  // Invokes `callback` with the signed data when it is available.
  virtual void SignStringAsync(
      const std::string& str,
      base::OnceCallback<void(std::optional<std::vector<uint8_t>>)>
          callback) = 0;

  // Returns KeyMetadata for the currently loaded key. If no key is loaded,
  // returns std::nullopt.
  virtual std::optional<KeyMetadata> GetLoadedKeyMetadata() const = 0;

  // Returns true if the manager hit a permanent failure for which retrying
  // would do no good. Permanent failures will prevent retrying for the lifespan
  // of the browser process. The browser will retry key creation again upon
  // restart.
  virtual bool HasPermanentFailure() const = 0;
};

}  // namespace enterprise_connectors

#endif  // COMPONENTS_ENTERPRISE_BROWSER_DEVICE_TRUST_DEVICE_TRUST_KEY_MANAGER_H_