-
Notifications
You must be signed in to change notification settings - Fork 5
/
idpasslite.proto
executable file
·207 lines (181 loc) · 7.47 KB
/
idpasslite.proto
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
* Copyright (C) 2020 Newlogic Pte. Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
syntax = "proto3";
package idpass;
option java_package = "org.idpass.lite.proto";
option java_multiple_files = true;
message Date {
// Year of date. Must be from 1 to 9999, or 0 if specifying a date without
// a year.
int32 year = 1;
// Month of year. Must be from 1 to 12, or 0 if specifying a year without a
// month and day.
int32 month = 2;
// Day of month. Must be from 1 to 31 and valid for the year and month, or 0
// if specifying a year by itself or a year and month where the day is not
// significant.
int32 day = 3;
}
message Pair {
string key = 1;
string value = 2;
}
message Dictionary {
repeated Pair pairs = 1;
}
message CardAccess {
enum FingerType {
R1 = 0;
R2 = 1;
R3 = 2;
R4 = 3;
R5 = 4;
L1 = 5;
L2 = 6;
L3 = 7;
L4 = 8;
L5 = 9;
}
enum EyeType {
R = 0;
L = 1;
}
FingerType finger = 1;
bytes fingerprint = 2;
EyeType eye = 3;
bytes iris = 4;
bytes face = 5;
string pin = 6;
}
// Original Source https://github.com/protobuf-net/protobuf-net/blob/main/src/protogen.site/wwwroot/protoc/google/type/postal_address.proto
// Represents a postal address, e.g. for postal delivery or payments addresses.
// Given a postal address, a postal service can deliver items to a premise, P.O.
// Box or similar.
message PostalAddress {
// The schema revision of the `PostalAddress`.
// All new revisions **must** be backward compatible with old revisions.
int32 revision = 1;
// Required. CLDR region code of the country/region of the address. This
// is never inferred and it is up to the user to ensure the value is
// correct. See http://cldr.unicode.org/ and
// http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
// for details. Example: "CH" for Switzerland.
string region_code = 2;
// Optional. BCP-47 language code of the contents of this address (if
// known). This is often the UI language of the input form or is expected
// to match one of the languages used in the address' country/region, or their
// transliterated equivalents.
// This can affect formatting in certain countries, but is not critical
// to the correctness of the data and will never affect any validation or
// other non-formatting related operations.
//
// If this value is not known, it should be omitted (rather than specifying a
// possibly incorrect default).
//
// Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
// Optional. Postal code of the address. Not all countries use or require
// postal codes to be present, but where they are used, they may trigger
// additional validation with other parts of the address (e.g. state/zip
// validation in the U.S.A.).
string postal_code = 4;
// Optional. Additional, country-specific, sorting code. This is not used
// in most regions. Where it is used, the value is either a string like
// "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
// alone, representing the "sector code" (Jamaica), "delivery area indicator"
// (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
// Optional. Highest administrative subdivision which is used for postal
// addresses of a country or region.
// For example, this can be a state, a province, an oblast, or a prefecture.
// Specifically, for Spain this is the province and not the autonomous
// community (e.g. "Barcelona" and not "Catalonia").
// Many countries don't use an administrative area in postal addresses. E.g.
// in Switzerland this should be left unpopulated.
string administrative_area = 6;
// Optional. Generally refers to the city/town portion of the address.
// Examples: US city, IT comune, UK post town.
// In regions of the world where localities are not well defined or do not fit
// into this structure well, leave locality empty and use address_lines.
string locality = 7;
// Optional. Sublocality of the address.
// For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
// Unstructured address lines describing the lower levels of an address.
//
// Because values in address_lines do not have type information and may
// sometimes contain multiple values in a single field (e.g.
// "Austin, TX"), it is important that the line order is clear. The order of
// address lines should be "envelope order" for the country/region of the
// address. In places where this can vary (e.g. Japan), address_language is
// used to make it explicit (e.g. "ja" for large-to-small ordering and
// "ja-Latn" or "en" for small-to-large). This way, the most specific line of
// an address can be selected based on the language.
//
// The minimum permitted structural representation of an address consists
// of a region_code with all remaining information placed in the
// address_lines. It would be possible to format such an address very
// approximately without geocoding, but no semantic reasoning could be
// made about any of the address components until it was at least
// partially resolved.
//
// Creating an address only containing a region_code and address_lines, and
// then geocoding is the recommended way to handle completely unstructured
// addresses (as opposed to guessing which parts of the address should be
// localities or administrative areas).
repeated string address_lines = 9;
// Optional. The recipient at the address.
// This field may, under certain circumstances, contain multiline information.
// For example, it might contain "care of" information.
repeated string recipients = 10;
// Optional. The name of the organization at the address.
string organization = 11;
}
message CardDetails {
string UIN = 9;
string fullName = 8;
string surName = 1;
string givenName = 2;
string placeOfBirth = 3;
Date dateOfBirth = 4;
int32 gender = 7; // Reserved: Female = 1 / Male = 2 / Diverse = 3 // The list can then be extended as needed
PostalAddress postalAddress = 10;
repeated Pair extra = 5;
int64 createdAt = 6; // Timestamp in seconds
}
message IDPassCard {
CardAccess access = 1;
CardDetails details = 2;
bytes encryptionKey = 3; // ed22519 key
}
message SignedIDPassCard {
IDPassCard card = 1;
}
message PublicSignedIDPassCard {
CardDetails details = 1;
}
message Certificate {
bytes pubkey = 1;
bytes issuerkey = 2;
bytes signature = 3;
}
message IDPassCards {
PublicSignedIDPassCard publicCard = 1;
bytes encryptedCard = 2;
bytes signature = 3;
bytes signerPublicKey = 4;
repeated Certificate certificates = 5;
}