File: variations_command_line.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; 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 (123 lines) | stat: -rw-r--r-- 4,513 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright 2018 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_VARIATIONS_NET_VARIATIONS_COMMAND_LINE_H_
#define COMPONENTS_VARIATIONS_NET_VARIATIONS_COMMAND_LINE_H_

#include <optional>
#include <string>

#include "build/build_config.h"
#include "build/buildflag.h"

#if !BUILDFLAG(IS_CHROMEOS)
#include "base/feature_list.h"
#endif

namespace base {
class CommandLine;
class FeatureList;
class FilePath;
}  // namespace base

namespace variations {

#if !BUILDFLAG(IS_CHROMEOS)
BASE_DECLARE_FEATURE(kFeedbackIncludeVariations);

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(VariationsStateEncryptionStatus)
enum class VariationsStateEncryptionStatus {
  kSuccess = 0,
  kEmptyInput = 1,
  kHpkeSetupFailure = 2,
  kHpkeSealFailure = 3,
  kMaxValue = kHpkeSealFailure,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/variations/enums.xml:VariationsStateEncryptionStatus)
#endif

// Parses the content of `variations::switches::kVariationsStateFile` and
// modifies the command-line arguments of the running process by setting the
// switches contained in that file. The function will exit the process with
// an error message if the passed file's contents are invalid.
void MaybeUnpackVariationsStateFile();

// This struct contains all the fields that are needed to replicate the complete
// state of variations (including all the registered trials with corresponding
// groups, params and features) for the client, with methods to convert this to
// various formats.
struct VariationsCommandLine {
  std::string field_trial_states;
  std::string field_trial_params;
  std::string enable_features;
  std::string disable_features;

  VariationsCommandLine();
  ~VariationsCommandLine();
  VariationsCommandLine(VariationsCommandLine&&);
  VariationsCommandLine& operator=(VariationsCommandLine&&);

  // Creates a VariationsCommandLine for the current state of this client.
  static VariationsCommandLine GetForCurrentProcess();

  // Creates a VariationsCommandLine from the given `command_line`.
  static VariationsCommandLine GetForCommandLine(
      const base::CommandLine& command_line);

  // Returns the state in command-line format.
  std::string ToString() const;

  // Applies the state to the given `command_line`.
  void ApplyToCommandLine(base::CommandLine& command_line) const;

  // Applies the state to the current process' FeatureList and FieldTrialList.
  void ApplyToFeatureAndFieldTrialList(base::FeatureList* feature_list) const;

  // Loads the feature state as serialized by `WriteToFile` from `file_path`.
  // Returns nullopt if loading failed for some reason.
  static std::optional<VariationsCommandLine> ReadFromFile(
      const base::FilePath& file_path);

  // Loads the feature state as serialized by `WriteToString`.
  // Returns nullopt if loading failed for some reason.
  static std::optional<VariationsCommandLine> ReadFromString(
      const std::string& serialized_json);

  // Serializes the state to `file_path`. The serialized state can be loaded
  // back in with `ReadFromFile`. Returns false if saving failed for some
  // reason.
  bool WriteToFile(const base::FilePath& file_path) const;

  // Serializes the state to `serialized_json`. The serialized state can be
  // loaded back in with `ReadFromString`. Returns false if saving failed for
  // some reason.
  bool WriteToString(std::string* serialized_json) const;

#if !BUILDFLAG(IS_CHROMEOS)
  // Serializes and encrypts the state to `ciphertext` with a public key.
  // Encryption is needed for security and privacy purpose. This is used by
  // the feedback component.
  // The `ciphertext` is a combination of:
  //   The encapsulated shared secret + encrypted bytes.
  VariationsStateEncryptionStatus EncryptToString(
      std::vector<uint8_t>* ciphertext) const;

  // Test the internal function `EncryptStringWithPublicKey`.
  // The `ciphertext` is a combination of:
  //   The encapsulated shared secret + encrypted bytes.
  // If `enc_len` is not null, it will store the length of the
  // encapsulated shared secret.
  VariationsStateEncryptionStatus EncryptToStringForTesting(
      std::vector<uint8_t>* ciphertext,
      base::span<const uint8_t> public_key,
      size_t* enc_len) const;
#endif
};

}  // namespace variations

#endif  // COMPONENTS_VARIATIONS_NET_VARIATIONS_COMMAND_LINE_H_