File: messages.proto

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 (171 lines) | stat: -rw-r--r-- 5,048 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

syntax = "proto2";

option optimize_for = LITE_RUNTIME;

package biod;

option go_package = "go.chromium.org/chromiumos/system_api/biod_messages_proto";

import "constants.proto";

// Included in biod's AuthScanDone signal
message FingerprintMessage {
  oneof msg {
    FingerprintError error = 1;
    ScanResult scan_result = 2;
  }
}

// Returned from biod's GetNonce method.
message GetNonceReply {
  optional bytes nonce = 1;
}

// Included in biod's EnrollScanDone signal.
message EnrollScanDone {
  optional ScanResult scan_result = 1;
  optional bool done = 2;
  optional int32 percent_complete = 3;
  optional bytes auth_nonce = 4;
}

// Included in AuthStackManager's AuthScanDone signal.
message AuthScanDone {
  optional bytes auth_nonce = 1;
}

message StartEnrollSessionRequest {
  optional bytes gsc_nonce = 1;
  optional bytes encrypted_label_seed = 2;
  optional bytes iv = 3;
}

// Returned from biod's StartEnrollSession method.
message StartEnrollSessionReply {
  optional FingerprintError error = 1;
}

message StartAuthSessionRequest {
  optional bytes user_id = 1;
  optional bytes gsc_nonce = 2;
  optional bytes encrypted_label_seed = 3;
  optional bytes iv = 4;
}

// Returned from biod's StartAuthSession method.
message StartAuthSessionReply {
  optional FingerprintError error = 1;
}

// Included in StatusChanged signal.
message BiometricsManagerStatusChanged {
  optional BiometricsManagerStatus status = 1;
}

message FpPublicKey {
  optional bytes x = 1;
  optional bytes y = 2;
}

message CreateCredentialRequest {
  optional FpPublicKey pub = 1;
}

message CreateCredentialReply {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused. Please update biod_metrics.cc and
  // histograms.xml if new variants are added.
  enum CreateCredentialStatus {
    UNKNOWN = 0;
    SUCCESS = 1;
    INCORRECT_STATE = 2;       // biod isn't ready for creating credential.
    NO_TEMPLATE = 3;           // failed to retrieve template from AuthStack.
    NO_SECRET = 4;             // failed to retrieve secrets from AuthStack.
    CREATE_RECORD_FAILED = 5;  // failed to create record for the template.
  }

  optional CreateCredentialStatus status = 1;
  optional bytes encrypted_secret = 2;
  optional bytes iv = 3;
  optional FpPublicKey pub = 4;
  optional string record_id = 5;
}

message AuthenticateCredentialRequest {
  optional FpPublicKey pub = 1;
}

message AuthenticateCredentialReply {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused. Please update biod_metrics.cc and
  // histograms.xml if new variants are added.
  enum AuthenticateCredentialStatus {
    UNKNOWN = 0;
    SUCCESS = 1;
    INCORRECT_STATE = 2;   // biod isn't ready for authenticating credential.
    SET_NONCE_FAILED = 3;  // Failed to establish nonce session.
    UPLOAD_TEMPLATES_FAILED = 4;  // Failed to upload templates for match.
    MATCH_FAILED = 5;             // The match command itself failed.
    NO_TEMPLATES = 6;    // AuthStack reports there are no templates to match.
    NO_SECRET = 7;       // Failed to retrieve match secret.
    INTERNAL_ERROR = 8;  // AuthStack internal error.
  }

  optional AuthenticateCredentialStatus status = 1;
  optional ScanResult scan_result = 2;
  optional bytes encrypted_secret = 3;
  optional bytes iv = 4;
  optional FpPublicKey pub = 5;
  optional string record_id = 6;
}

message DeleteCredentialRequest {
  optional string user_id = 1;
  optional string record_id = 2;
}

message DeleteCredentialReply {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused. Please update biod_metrics.cc and
  // histograms.xml if new variants are added.
  enum DeleteCredentialStatus {
    UNKNOWN = 0;
    SUCCESS = 1;
    INCORRECT_STATE = 2;
    // The credential to delete doesn't exist. No need for deletion.
    NOT_EXIST = 3;
    // The credential to delete exists, but deletion failed.
    DELETION_FAILED = 4;
  }
  optional DeleteCredentialStatus status = 1;
}

message EnrollLegacyTemplateRequest {
  optional bytes legacy_record_id = 1;
  optional bytes gsc_nonce = 2;
  optional bytes encrypted_label_seed = 3;
  optional bytes iv = 4;
}

message LegacyRecord {
  optional string legacy_record_id = 1;
  // user supplied description of the finger.
  optional string label = 2;
}

message ListLegacyRecordsReply {
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused. Please update biod_metrics.cc and
  // histograms.xml if new variants are added.
  enum ListLegacyRecordsStatus {
    UNKNOWN = 0;
    SUCCESS = 1;
    INCORRECT_STATE = 2;  // E.g., no user is logged in.
  }
  optional ListLegacyRecordsStatus status = 2;
  repeated LegacyRecord legacy_records = 1;
}