powhttp-sdk 0.2.0

Official SDK for building powhttp extensions in Rust.
Documentation
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
use serde::{Deserialize, Serialize};
use super::shared::{NamedU8, NamedU16, Side};
use crate::serde_helpers::hex_2d;

/// A TLS record-layer event observed on one side of the connection.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TlsEvent {
    pub side: Side,
    pub message: TlsMessage,
}

/// Top-level TLS message type.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum TlsMessage {
    Alert(Alert),
    ChangeCipherSpec(ChangeCipherSpec),
    Handshake(HandshakeMessage),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Alert {
    pub level: NamedU8,
    pub description: NamedU8,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChangeCipherSpec {
    #[serde(with = "hex")]
    pub data: Vec<u8>,
}

/// A parsed TLS handshake message.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum HandshakeMessage {
    ClientHello(ClientHello),
    ServerHello(ServerHello),
    NewSessionTicket(NewSessionTicket),
    EncryptedExtensions(EncryptedExtensions),
    Certificate(Certificate),
    ServerKeyExchange(ServerKeyExchange),
    CertificateRequest(CertificateRequest),
    ServerHelloDone,
    CertificateVerify(CertificateVerify),
    ClientKeyExchange(ClientKeyExchange),
    Finished(Finished),
    CompressedCertificate(CompressedCertificate),
}

/// TLS ClientHello message fields.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientHello {
    pub version: NamedU16,
    #[serde(with = "hex")]
    pub random: [u8; 32],
    #[serde(with = "hex")]
    pub session_id: Vec<u8>,
    pub cipher_suites: Vec<NamedU16>,
    pub compression_methods: Vec<NamedU8>,
    pub extensions: Vec<ClientExtension>,
}

/// TLS ServerHello message fields.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerHello {
    pub version: NamedU16,
    #[serde(with = "hex")]
    pub random: [u8; 32],
    #[serde(with = "hex")]
    pub session_id: Vec<u8>,
    pub cipher_suite: NamedU16,
    pub compression_method: NamedU8,
    pub extensions: Vec<ServerExtension>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NewSessionTicket {
    #[serde(with = "hex")]
    pub ticket: Vec<u8>,
}

/// A TLS extension from a ClientHello message.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientExtension {
    pub extension_type: NamedU16,
    pub extension_data: ClientExtensionData,
}

/// Parsed data for a client TLS extension.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum ClientExtensionData {
    Grease(Grease),
    SignedCertificateTimestamp,
    StatusRequest(CertificateStatusRequest),
    Alpn(Alpn),
    Ech(Ech),
    CompressCertificate(CompressCertificateExt),
    SessionTicket(SessionTicket),
    SupportedGroups(SupportedGroups),
    RenegotiationInfo(RenegotiationInfo),
    ExtendedMasterSecret,
    KeyShare(KeyShareClientHello),
    SignatureAlgorithms(SignatureAlgorithms),
    ServerName(ServerNameList),
    EcPointFormats(EcPointFormats),
    SupportedVersions(ClientSupportedVersions),
    PskKeyExchangeModes(PskKeyExchangeModes),
    ApplicationSettingsSupport(ApplicationSettingsSupport),
    ApplicationSettings(ApplicationSettings),
    EncryptThenMac,
    CertificateAuthorities(CertificateAuthorities),
    Padding(Padding),
    Unknown(UnknownExtension),
}

/// A TLS extension from a ServerHello message.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerExtension {
    pub extension_type: NamedU16,
    pub extension_data: ServerExtensionData,
}

/// Parsed data for a server TLS extension.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum ServerExtensionData {
    ServerName,
    SignatureAlgorithms(SignatureAlgorithms),
    KeyShareServerHello(KeyShareServerHello),
    KeyShareHelloRetryRequest(KeyShareHelloRetryRequest),
    SupportedVersions(ServerSupportedVersions),
    ExtendedMasterSecret,
    Alpn(Alpn),
    Ech(Ech),
    ApplicationSettings(ApplicationSettings),
    SessionTicket(SessionTicket),
    CertificateAuthorities(CertificateAuthorities),
    Unknown(UnknownExtension),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Grease {
    #[serde(with = "hex")]
    pub data: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CertificateStatusRequest {
    pub status_type: NamedU8,
    pub request: StatusRequest,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum StatusRequest {
    Ocsp(OcspStatusRequest),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OcspStatusRequest {
    #[serde(with = "hex_2d")]
    pub responder_id_list: Vec<Vec<u8>>,
    #[serde(with = "hex")]
    pub extensions: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Alpn {
    pub protocols: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Ech {
    #[serde(with = "hex")]
    pub ech: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CompressCertificateExt {
    pub algorithms: Vec<NamedU16>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SessionTicket {
    #[serde(with = "hex")]
    pub ticket: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SupportedGroups {
    pub named_group_list: Vec<NamedU16>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RenegotiationInfo {
    #[serde(with = "hex")]
    pub renegotiated_connection: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct KeyShareClientHello {
    pub client_shares: Vec<KeyShareEntry>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct KeyShareEntry {
    pub group: NamedU16,
    #[serde(with = "hex")]
    pub key_exchange: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SignatureAlgorithms {
    pub supported_signature_algorithms: Vec<NamedU16>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerNameList {
    pub server_name_list: Vec<ServerName>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerName {
    pub name_type: NamedU8,
    pub name: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EcPointFormats {
    pub ec_point_format_list: Vec<NamedU8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientSupportedVersions {
    pub versions: Vec<NamedU16>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerSupportedVersions {
    pub selected_version: NamedU16,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PskKeyExchangeModes {
    pub ke_modes: Vec<NamedU8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ApplicationSettingsSupport {
    pub supported_protocols: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ApplicationSettings {
    #[serde(with = "hex")]
    pub settings: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CertificateAuthorities {
    #[serde(with = "hex_2d")]
    pub authorities: Vec<Vec<u8>>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Padding {
    #[serde(with = "hex")]
    pub data: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UnknownExtension {
    #[serde(with = "hex")]
    pub data: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct KeyShareServerHello {
    pub server_share: KeyShareEntry,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct KeyShareHelloRetryRequest {
    pub selected_group: NamedU16,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum EncryptedExtensions {
    Client(Vec<ClientExtension>),
    Server(Vec<ServerExtension>),
}

/// TLS Certificate message in either TLS 1.2 or TLS 1.3 format.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "content")]
pub enum Certificate {
    Tls13(Tls13Certificate),
    Tls12(Tls12Certificate),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Tls13Certificate {
    #[serde(with = "hex")]
    pub certificate_request_context: Vec<u8>,
    pub certificate_list: Vec<CertificateEntry>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CertificateEntry {
    #[serde(with = "hex")]
    pub cert_data: Vec<u8>,
    #[serde(with = "hex")]
    pub extensions: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Tls12Certificate {
    #[serde(with = "hex_2d")]
    pub certificates: Vec<Vec<u8>>,
}

/// TLS ServerKeyExchange for either DH or ECDH key exchange.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", content = "content")]
pub enum ServerKeyExchange {
    Dh(DhServerKeyExchange),
    Ecdh(EcdhServerKeyExchange),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DhServerKeyExchange {
    pub params: ServerDhParams,
    pub signed_params: Option<DigitallySigned>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerDhParams {
    #[serde(with = "hex")]
    pub p: Vec<u8>,
    #[serde(with = "hex")]
    pub g: Vec<u8>,
    #[serde(with = "hex")]
    pub ys: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DigitallySigned {
    pub algorithm: NamedU16,
    #[serde(with = "hex")]
    pub signature: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EcdhServerKeyExchange {
    pub params: ServerEcdhParams,
    pub signed_params: Option<DigitallySigned>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ServerEcdhParams {
    pub curve_params: EcParams,
    #[serde(with = "hex")]
    pub public: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", content = "content")]
pub enum EcParams {
    ExplicitPrime(ExplicitPrimeParams),
    #[serde(rename = "explicit_char2")]
    ExplicitChar2(ExplicitChar2Params),
    NamedCurve(NamedCurveParams),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ExplicitPrimeParams {
    #[serde(with = "hex")]
    pub p: Vec<u8>,
    pub curve: EcCurve,
    #[serde(with = "hex")]
    pub base: Vec<u8>,
    #[serde(with = "hex")]
    pub order: Vec<u8>,
    #[serde(with = "hex")]
    pub cofactor: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ExplicitChar2Params {
    pub m: u16,
    pub basis: Char2Basis,
    pub curve: EcCurve,
    #[serde(with = "hex")]
    pub base: Vec<u8>,
    #[serde(with = "hex")]
    pub order: Vec<u8>,
    #[serde(with = "hex")]
    pub cofactor: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NamedCurveParams {
    pub named_curve: NamedU16,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EcCurve {
    #[serde(with = "hex")]
    pub a: Vec<u8>,
    #[serde(with = "hex")]
    pub b: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", content = "content")]
pub enum Char2Basis {
    Trinomial(TrinomialBasis),
    Pentanomial(PentanomialBasis),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TrinomialBasis {
    #[serde(with = "hex")]
    pub k: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PentanomialBasis {
    #[serde(with = "hex")]
    pub k1: Vec<u8>,
    #[serde(with = "hex")]
    pub k2: Vec<u8>,
    #[serde(with = "hex")]
    pub k3: Vec<u8>,
}

/// TLS ClientKeyExchange for DH, ECDH or RSA key exchange.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", content = "content")]
pub enum ClientKeyExchange {
    Dh(DhClientKeyExchange),
    Ecdh(EcdhClientKeyExchange),
    Rsa(RsaClientKeyExchange),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DhClientKeyExchange {
    #[serde(with = "hex")]
    pub yc: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EcdhClientKeyExchange {
    #[serde(with = "hex")]
    pub yc: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RsaClientKeyExchange {
    #[serde(with = "hex")]
    pub encrypted_pre_master_secret: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", content = "content")]
pub enum CertificateRequest {
    Tls13(Tls13CertificateRequest),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Tls13CertificateRequest {
    #[serde(with = "hex")]
    pub certificate_request_context: Vec<u8>,
    pub extensions: Vec<ServerExtension>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CertificateVerify {
    pub algorithm: NamedU16,
    #[serde(with = "hex")]
    pub signature: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Finished {
    #[serde(with = "hex")]
    pub verify_data: Vec<u8>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CompressedCertificate {
    pub algorithm: NamedU16,
    pub uncompressed_len: usize,
    #[serde(with = "hex")]
    pub compressed_certificate_message: Vec<u8>,
}