josekit 0.10.3

JOSE (Javascript Object Signing and Encryption) library for 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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
use std::borrow::Cow;
use std::cmp::Eq;
use std::collections::{BTreeMap, BTreeSet};
use std::fmt::Debug;

use anyhow::bail;

use crate::jwe::enc::{A128CBC_HS256, A128GCM, A192CBC_HS384, A192GCM, A256CBC_HS512, A256GCM};
use crate::jwe::zip::Def;
use crate::jwe::{
    JweCompression, JweContentEncryption, JweDecrypter, JweEncrypter, JweHeader, JweHeaderSet,
};
use crate::util;
use crate::{JoseError, JoseHeader, Map, Value};

#[derive(Debug, Eq, PartialEq, Clone)]
pub struct JweContext {
    acceptable_criticals: BTreeSet<String>,
    compressions: BTreeMap<String, Box<dyn JweCompression>>,
    content_encryptions: BTreeMap<String, Box<dyn JweContentEncryption>>,
}

impl JweContext {
    pub fn new() -> Self {
        Self {
            acceptable_criticals: BTreeSet::new(),
            compressions: {
                let compressions: Vec<Box<dyn JweCompression>> = vec![Box::new(Def)];

                let mut map = BTreeMap::new();
                for compression in compressions {
                    map.insert(compression.name().to_string(), compression);
                }
                map
            },
            content_encryptions: {
                let content_encryptions: Vec<Box<dyn JweContentEncryption>> = vec![
                    Box::new(A128CBC_HS256),
                    Box::new(A192CBC_HS384),
                    Box::new(A256CBC_HS512),
                    Box::new(A128GCM),
                    Box::new(A192GCM),
                    Box::new(A256GCM),
                ];

                let mut map = BTreeMap::new();
                for content_encryption in content_encryptions {
                    map.insert(content_encryption.name().to_string(), content_encryption);
                }
                map
            },
        }
    }

    /// Test a critical header claim name is acceptable.
    ///
    /// # Arguments
    ///
    /// * `name` - a critical header claim name
    pub fn is_acceptable_critical(&self, name: &str) -> bool {
        self.acceptable_criticals.contains(name)
    }

    /// Add a acceptable critical header claim name
    ///
    /// # Arguments
    ///
    /// * `name` - a acceptable critical header claim name
    pub fn add_acceptable_critical(&mut self, name: &str) {
        self.acceptable_criticals.insert(name.to_string());
    }

    /// Remove a acceptable critical header claim name
    ///
    /// # Arguments
    ///
    /// * `name` - a acceptable critical header claim name
    pub fn remove_acceptable_critical(&mut self, name: &str) {
        self.acceptable_criticals.remove(name);
    }

    /// Get a compression algorithm for zip header claim value.
    ///
    /// # Arguments
    ///
    /// * `name` - a zip header claim name
    pub fn get_compression(&self, name: &str) -> Option<&dyn JweCompression> {
        match self.compressions.get(name) {
            Some(val) => Some(val.as_ref()),
            None => None,
        }
    }

    /// Add a compression algorithm for zip header claim name.
    ///
    /// # Arguments
    ///
    /// * `compression` - a compression algorithm
    pub fn add_compression(&mut self, compression: Box<dyn JweCompression>) {
        self.compressions
            .insert(compression.name().to_string(), compression);
    }

    /// Remove a compression algorithm for zip header claim name.
    ///
    /// # Arguments
    ///
    /// * `name` - a zip header claim name
    pub fn remove_compression(&mut self, name: &str) {
        self.compressions.remove(name);
    }

    /// Get a content encryption algorithm for enc header claim value.
    ///
    /// # Arguments
    ///
    /// * `name` - a content encryption header claim name
    pub fn get_content_encryption(&self, name: &str) -> Option<&dyn JweContentEncryption> {
        match self.content_encryptions.get(name) {
            Some(val) => Some(val.as_ref()),
            None => None,
        }
    }

    /// Add a content encryption algorithm for enc header claim name.
    ///
    /// # Arguments
    ///
    /// * `content_encryption` - a content encryption algorithm
    pub fn add_content_encryption(&mut self, content_encryption: Box<dyn JweContentEncryption>) {
        self.content_encryptions
            .insert(content_encryption.name().to_string(), content_encryption);
    }

    /// Remove a content encryption algorithm for enc header claim name.
    ///
    /// # Arguments
    ///
    /// * `name` - a enc header claim name
    pub fn remove_content_encryption(&mut self, name: &str) {
        self.content_encryptions.remove(name);
    }

    /// Return a representation of the data that is formatted by compact serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWS heaser claims.
    /// * `encrypter` - The JWS encrypter.
    pub fn serialize_compact(
        &self,
        payload: &[u8],
        header: &JweHeader,
        encrypter: &dyn JweEncrypter,
    ) -> Result<String, JoseError> {
        self.serialize_compact_with_selector(payload, header, |_header| Some(encrypter))
    }

    /// Return a representation of the data that is formatted by compact serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWS heaser claims.
    /// * `selector` - a function for selecting the signing algorithm.
    pub fn serialize_compact_with_selector<'a, F>(
        &self,
        payload: &[u8],
        header: &JweHeader,
        selector: F,
    ) -> Result<String, JoseError>
    where
        F: Fn(&JweHeader) -> Option<&'a dyn JweEncrypter>,
    {
        (|| -> anyhow::Result<String> {
            let encrypter = match selector(header) {
                Some(val) => val,
                None => bail!("A encrypter is not found."),
            };

            let cencryption = match header.content_encryption() {
                Some(enc) => match self.get_content_encryption(enc) {
                    Some(val) => val,
                    None => bail!("A content encryption is not registered: {}", enc),
                },
                None => bail!("A enc header claim is required."),
            };

            let compression = match header.compression() {
                Some(zip) => match self.get_compression(zip) {
                    Some(val) => Some(val),
                    None => bail!("A compression algorithm is not registered: {}", zip),
                },
                None => None,
            };

            let mut out_header = header.clone();

            let key_len = cencryption.key_len();
            let key = match encrypter.compute_content_encryption_key(
                cencryption,
                &header,
                &mut out_header,
            )? {
                Some(val) => val,
                None => Cow::Owned(util::random_bytes(key_len)),
            };

            let encrypted_key = encrypter.encrypt(&key, &header, &mut out_header)?;
            if let None = header.claim("kid") {
                if let Some(key_id) = encrypter.key_id() {
                    out_header.set_key_id(key_id);
                }
            }

            out_header.set_algorithm(encrypter.algorithm().name());

            let header_bytes = serde_json::to_vec(out_header.claims_set())?;
            let header_b64 = util::encode_base64_urlsafe_nopad(header_bytes);

            let compressed;
            let content = if let Some(compression) = compression {
                compressed = compression.compress(payload)?;
                &compressed
            } else {
                payload
            };

            let iv_vec;
            let iv = if cencryption.iv_len() > 0 {
                iv_vec = util::random_bytes(cencryption.iv_len());
                Some(iv_vec.as_slice())
            } else {
                None
            };

            let (ciphertext, tag) =
                cencryption.encrypt(&key, iv, content, header_b64.as_bytes())?;

            let mut capacity = 4;
            capacity += header_b64.len();
            if let Some(val) = &encrypted_key {
                capacity += util::ceiling(val.len() * 4, 3);
            }
            if let Some(val) = iv {
                capacity += util::ceiling(val.len() * 4, 3);
            }
            capacity += util::ceiling(ciphertext.len() * 4, 3);
            if let Some(val) = &tag {
                capacity += util::ceiling(val.len() * 4, 3);
            }

            let mut message = String::with_capacity(capacity);
            message.push_str(&header_b64);
            message.push_str(".");
            if let Some(val) = &encrypted_key {
                util::encode_base64_urlsafe_nopad_buf(val, &mut message);
            }
            message.push_str(".");
            if let Some(val) = iv {
                util::encode_base64_urlsafe_nopad_buf(val, &mut message);
            }
            message.push_str(".");
            util::encode_base64_urlsafe_nopad_buf(ciphertext, &mut message);
            message.push_str(".");
            if let Some(val) = &tag {
                util::encode_base64_urlsafe_nopad_buf(val, &mut message);
            }

            Ok(message)
        })()
        .map_err(|err| match err.downcast::<JoseError>() {
            Ok(err) => err,
            Err(err) => JoseError::InvalidJweFormat(err),
        })
    }

    /// Return a representation of the data that is formatted by general json serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWE shared protected and unprotected header claims.
    /// * `recipients` - The JWE header claims and the JWE encrypter pair for recipients.
    /// * `aad` - The JWE additional authenticated data.
    pub fn serialize_general_json(
        &self,
        payload: &[u8],
        header: Option<&JweHeaderSet>,
        recipients: &[(Option<&JweHeader>, &dyn JweEncrypter)],
        aad: Option<&[u8]>,
    ) -> Result<String, JoseError> {
        self.serialize_general_json_with_selector(
            payload,
            header,
            recipients
                .iter()
                .map(|(header, _)| header.as_deref())
                .collect::<Vec<Option<&JweHeader>>>()
                .as_slice(),
            aad,
            |i, _header| Some(recipients[i].1),
        )
    }

    /// Return a representation of the data that is formatted by general json serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWS shared protected and unprotected header claims.
    /// * `recipient_headers` - The JWE unprotected header claims for recipients.
    /// * `aad` - The JWE additional authenticated data.
    /// * `selector` - a function for selecting the encrypting algorithm.
    pub fn serialize_general_json_with_selector<'a, F>(
        &self,
        payload: &[u8],
        header: Option<&JweHeaderSet>,
        recipient_headers: &[Option<&JweHeader>],
        aad: Option<&[u8]>,
        selector: F,
    ) -> Result<String, JoseError>
    where
        F: Fn(usize, &JweHeader) -> Option<&'a dyn JweEncrypter>,
    {
        (|| -> anyhow::Result<String> {
            if recipient_headers.len() == 0 {
                bail!(
                    "A size of recipients must be 1 or more: {}",
                    recipient_headers.len()
                );
            }

            let mut compression = None;
            if let Some(header) = header {
                match header.claims_set(true).get("zip") {
                    Some(Value::String(val)) => match self.get_compression(val) {
                        Some(val) => {
                            compression = Some(val);
                        }
                        None => bail!("A compression algorithm is not registered: {}", val),
                    },
                    Some(_) => bail!("A zip header claim must be a string."),
                    None => {}
                }
            };

            let merged_map = match header {
                Some(val) => val.to_map(),
                None => Map::new(),
            };

            let mut merged_list = Vec::new();
            let mut recipient_header_list = Vec::new();
            let mut encrypter_list = Vec::new();

            let mut selected_cencryption: Option<&dyn JweContentEncryption> = None;
            let mut selected_key: Option<Cow<[u8]>> = None;
            for (i, recipient_header) in recipient_headers.iter().enumerate() {
                let mut merged_map = merged_map.clone();

                if let Some(val) = recipient_header {
                    for (key, value) in val.claims_set() {
                        if merged_map.contains_key(key) {
                            bail!("Duplicate key exists: {}", key);
                        }
                        merged_map.insert(key.clone(), value.clone());
                    }
                }

                let merged = JweHeader::from_map(merged_map)?;

                let cencryption = match merged.claim("enc") {
                    Some(Value::String(enc)) => {
                        if let Some(selected_cencryption) = selected_cencryption {
                            if enc.as_str() != selected_cencryption.name() {
                                bail!("A content encryption must be same for all recipients.");
                            } else {
                                selected_cencryption
                            }
                        } else {
                            match self.get_content_encryption(enc) {
                                Some(val) => {
                                    selected_cencryption = Some(val);
                                    val
                                }
                                None => bail!("A content encryption is not registered: {}", enc),
                            }
                        }
                    }
                    Some(_) => bail!("A enc header claim must be a string."),
                    None => bail!("A enc header claim is required."),
                };

                let encrypter = match selector(i, &merged) {
                    Some(val) => val,
                    None => bail!("A encrypter is not found."),
                };

                let mut recipient_header = match recipient_header {
                    Some(val) => (*val).clone(),
                    None => JweHeader::new(),
                };

                if let Some(key) = encrypter.compute_content_encryption_key(
                    cencryption,
                    &merged,
                    &mut recipient_header,
                )? {
                    if let Some(selected_key) = &selected_key {
                        if key.as_ref() != selected_key.as_ref() {
                            bail!("A content encryption key must be only one.");
                        }
                    } else {
                        selected_key = Some(key);
                    }
                };

                match merged.algorithm() {
                    Some(val) if val == encrypter.algorithm().name() => {}
                    Some(_) => bail!("A signer is unmatched."),
                    None => {
                        recipient_header.set_algorithm(encrypter.algorithm().name().to_string());
                    }
                }

                if let None = merged.key_id() {
                    if let Some(key_id) = encrypter.key_id() {
                        recipient_header.set_key_id(key_id.to_string());
                    }
                }

                merged_list.push(merged);
                recipient_header_list.push(recipient_header);
                encrypter_list.push(encrypter);
            }

            let cencryption = match selected_cencryption {
                Some(val) => val,
                None => bail!("A enc header claim is required."),
            };

            let key = match &selected_key {
                Some(val) => Cow::Borrowed(val.as_ref()),
                None => Cow::Owned(util::random_bytes(cencryption.key_len())),
            };

            let iv = if cencryption.iv_len() > 0 {
                Some(util::random_bytes(cencryption.iv_len()))
            } else {
                None
            };

            let protected_b64 = match header {
                Some(header) => {
                    let protected_map = header.claims_set(true);
                    if protected_map.len() > 0 {
                        let protected_json = serde_json::to_vec(header.claims_set(true))?;
                        let protected_b64 = util::encode_base64_urlsafe_nopad(protected_json);
                        Some(protected_b64)
                    } else {
                        None
                    }
                }
                _ => None,
            };

            let aad_b64 = match aad {
                Some(val) => Some(util::encode_base64_urlsafe_nopad(val)),
                None => None,
            };

            let mut full_aad = String::with_capacity({
                let mut full_aad_capacity = 1;
                if let Some(val) = &protected_b64 {
                    full_aad_capacity += val.len();
                }
                if let Some(val) = &aad_b64 {
                    full_aad_capacity += val.len();
                }
                full_aad_capacity
            });
            if let Some(val) = &protected_b64 {
                full_aad.push_str(&val);
            }
            if let Some(val) = &aad_b64 {
                full_aad.push_str(".");
                full_aad.push_str(&val);
            }

            let compressed;
            let content = if let Some(compression) = compression {
                compressed = compression.compress(payload)?;
                &compressed
            } else {
                payload
            };

            let (ciphertext, tag) =
                cencryption.encrypt(&key, iv.as_deref(), content, full_aad.as_bytes())?;

            let mut writed = false;
            let mut json = String::new();
            if let Some(val) = protected_b64 {
                json.push_str("{\"protected\":\"");
                json.push_str(&val);
                json.push_str("\"");
                writed = true;
            }

            if let Some(val) = header {
                let unprotected_map = val.claims_set(false);
                if unprotected_map.len() > 0 {
                    let unprotected = serde_json::to_string(unprotected_map)?;
                    json.push_str(if writed { "," } else { "{" });
                    json.push_str("\"unprotected\":");
                    json.push_str(&unprotected);
                    writed = true;
                }
            }

            json.push_str(if writed { "," } else { "{" });
            json.push_str("\"recipients\":[");
            for i in 0..recipient_headers.len() {
                if i > 0 {
                    json.push_str(",");
                }

                let merged = &merged_list[i];
                let mut header = &mut recipient_header_list[i];
                let encrypter = encrypter_list[i];

                let encrypted_key = encrypter.encrypt(&key, &merged, &mut header)?;

                if header.len() == 0 {
                    bail!("The per-recipient header must not be empty");
                }
                let header_json = serde_json::to_string(header.claims_set())?;
                json.push_str("{\"header\":");
                json.push_str(&header_json);

                if let Some(val) = encrypted_key {
                    json.push_str(",\"encrypted_key\":\"");
                    util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
                    json.push_str("\"");
                }
                json.push_str("}");
            }
            json.push_str("]");

            if let Some(val) = aad_b64 {
                json.push_str(",\"aad\":\"");
                json.push_str(&val);
                json.push_str("\"");
            }

            json.push_str(",\"iv\":\"");
            if let Some(val) = iv {
                util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
            }
            json.push_str("\"");

            json.push_str(",\"ciphertext\":\"");
            util::encode_base64_urlsafe_nopad_buf(&ciphertext, &mut json);
            json.push_str("\"");

            json.push_str(",\"tag\":\"");
            if let Some(val) = tag {
                util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
            }
            json.push_str("\"");

            json.push_str("}");

            Ok(json)
        })()
        .map_err(|err| match err.downcast::<JoseError>() {
            Ok(err) => err,
            Err(err) => JoseError::InvalidJweFormat(err),
        })
    }

    /// Return a representation of the data that is formatted by flattened json serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWE shared protected and unprotected header claims.
    /// * `recipient_header` - The JWE unprotected header claims per recipient.
    /// * `aad` - The JWE additional authenticated data.
    /// * `encrypter` - The JWS encrypter.
    pub fn serialize_flattened_json(
        &self,
        payload: &[u8],
        header: Option<&JweHeaderSet>,
        recipient_header: Option<&JweHeader>,
        aad: Option<&[u8]>,
        encrypter: &dyn JweEncrypter,
    ) -> Result<String, JoseError> {
        self.serialize_flattened_json_with_selector(
            payload,
            header,
            recipient_header,
            aad,
            |_header| Some(encrypter),
        )
    }

    /// Return a representation of the data that is formatted by flatted json serialization.
    ///
    /// # Arguments
    ///
    /// * `payload` - The payload data.
    /// * `header` - The JWE shared protected and unprotected header claims.
    /// * `recipient_header` - The JWE unprotected header claims per recipient.
    /// * `aad` - The JWE additional authenticated data.
    /// * `selector` - a function for selecting the encrypting algorithm.
    pub fn serialize_flattened_json_with_selector<'a, F>(
        &self,
        payload: &[u8],
        header: Option<&JweHeaderSet>,
        recipient_header: Option<&JweHeader>,
        aad: Option<&[u8]>,
        selector: F,
    ) -> Result<String, JoseError>
    where
        F: Fn(&JweHeader) -> Option<&'a dyn JweEncrypter>,
    {
        (|| -> anyhow::Result<String> {
            let mut compression = None;
            if let Some(header) = header {
                match header.claims_set(true).get("zip") {
                    Some(Value::String(val)) => match self.get_compression(val) {
                        Some(val) => {
                            compression = Some(val);
                        }
                        None => bail!("A compression algorithm is not registered: {}", val),
                    },
                    Some(_) => bail!("A zip header claim must be a string."),
                    None => {}
                }
            };

            let mut merged_map = match header {
                Some(val) => val.to_map(),
                None => Map::new(),
            };

            if let Some(val) = recipient_header {
                for (key, value) in val.claims_set() {
                    if merged_map.contains_key(key) {
                        bail!("Duplicate key exists: {}", key);
                    }
                    merged_map.insert(key.clone(), value.clone());
                }
            }

            let merged = JweHeader::from_map(merged_map)?;

            let cencryption = match merged.claim("enc") {
                Some(Value::String(enc)) => match self.get_content_encryption(enc) {
                    Some(val) => val,
                    None => bail!("A content encryption is not registered: {}", enc),
                },
                Some(_) => bail!("A enc header claim must be a string."),
                None => bail!("A enc header claim is required."),
            };

            let encrypter = match selector(&merged) {
                Some(val) => val,
                None => bail!("A encrypter is not found."),
            };

            let mut protected = match header {
                Some(val) => JweHeader::from_map(val.claims_set(true).clone())?,
                None => JweHeader::new(),
            };

            let key = match encrypter.compute_content_encryption_key(
                cencryption,
                &merged,
                &mut protected,
            )? {
                Some(val) => val,
                None => Cow::Owned(util::random_bytes(cencryption.key_len())),
            };

            let encrypted_key = encrypter.encrypt(&key, &merged, &mut protected)?;

            match merged.algorithm() {
                Some(val) if val == encrypter.algorithm().name() => {}
                Some(_) => bail!("A signer is unmatched."),
                None => {
                    protected.set_algorithm(encrypter.algorithm().name().to_string());
                }
            }

            if let None = merged.key_id() {
                if let Some(key_id) = encrypter.key_id() {
                    protected.set_key_id(key_id.to_string());
                }
            }

            let iv_vec;
            let iv = if cencryption.iv_len() > 0 {
                iv_vec = util::random_bytes(cencryption.iv_len());
                Some(iv_vec.as_slice())
            } else {
                None
            };

            let protected_b64 = if protected.len() > 0 {
                let protected_json = serde_json::to_vec(protected.claims_set())?;
                let protected_b64 = util::encode_base64_urlsafe_nopad(protected_json);
                Some(protected_b64)
            } else {
                None
            };

            let aad_b64 = match aad {
                Some(val) => Some(util::encode_base64_urlsafe_nopad(val)),
                None => None,
            };

            let mut full_aad = String::with_capacity({
                let mut full_aad_capacity = 1;
                if let Some(val) = &protected_b64 {
                    full_aad_capacity += val.len();
                }
                if let Some(val) = &aad_b64 {
                    full_aad_capacity += val.len();
                }
                full_aad_capacity
            });
            if let Some(val) = &protected_b64 {
                full_aad.push_str(&val);
            }
            if let Some(val) = &aad_b64 {
                full_aad.push_str(".");
                full_aad.push_str(&val);
            }

            let compressed;
            let content = if let Some(compression) = compression {
                compressed = compression.compress(payload)?;
                &compressed
            } else {
                payload
            };

            let (ciphertext, tag) = cencryption.encrypt(&key, iv, content, full_aad.as_bytes())?;

            let mut writed = false;
            let mut json = String::new();
            if let Some(val) = protected_b64 {
                json.push_str("{\"protected\":\"");
                json.push_str(&val);
                json.push_str("\"");
                writed = true;
            }

            if let Some(val) = header {
                let unprotected_map = val.claims_set(false);
                if unprotected_map.len() > 0 {
                    let unprotected = serde_json::to_string(unprotected_map)?;
                    json.push_str(if writed { "," } else { "{" });
                    json.push_str("\"unprotected\":");
                    json.push_str(&unprotected);
                    writed = true;
                }
            }

            if let Some(val) = recipient_header {
                let header_map = val.claims_set();
                if header_map.len() > 0 {
                    let header = serde_json::to_string(header_map)?;
                    json.push_str(if writed { "," } else { "{" });
                    json.push_str("\"header\":");
                    json.push_str(&header);
                }
            }

            if let Some(val) = encrypted_key {
                json.push_str(",\"encrypted_key\":\"");
                util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
                json.push_str("\"");
            }

            if let Some(val) = aad_b64 {
                json.push_str(",\"aad\":\"");
                json.push_str(&val);
                json.push_str("\"");
            }

            json.push_str(",\"iv\":\"");
            if let Some(val) = iv {
                util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
            }
            json.push_str("\"");

            json.push_str(",\"ciphertext\":\"");
            util::encode_base64_urlsafe_nopad_buf(&ciphertext, &mut json);
            json.push_str("\"");

            json.push_str(",\"tag\":\"");
            if let Some(val) = tag {
                util::encode_base64_urlsafe_nopad_buf(&val, &mut json);
            }
            json.push_str("\"}");

            Ok(json)
        })()
        .map_err(|err| match err.downcast::<JoseError>() {
            Ok(err) => err,
            Err(err) => JoseError::InvalidJweFormat(err),
        })
    }

    /// Deserialize the input that is formatted by compact serialization.
    ///
    /// # Arguments
    ///
    /// * `input` - The input data.
    /// * `decrypter` - The JWS decrypter.
    pub fn deserialize_compact(
        &self,
        input: impl AsRef<[u8]>,
        decrypter: &dyn JweDecrypter,
    ) -> Result<(Vec<u8>, JweHeader), JoseError> {
        self.deserialize_compact_with_selector(input, |_header| Ok(Some(decrypter)))
    }

    /// Deserialize the input that is formatted by compact serialization.
    ///
    /// # Arguments
    ///
    /// * `input` - The input data.
    /// * `selector` - a function for selecting the decrypting algorithm.
    pub fn deserialize_compact_with_selector<'a, F>(
        &self,
        input: impl AsRef<[u8]>,
        selector: F,
    ) -> Result<(Vec<u8>, JweHeader), JoseError>
    where
        F: Fn(&JweHeader) -> Result<Option<&'a dyn JweDecrypter>, JoseError>,
    {
        (|| -> anyhow::Result<(Vec<u8>, JweHeader)> {
            let input = input.as_ref();
            let indexies: Vec<usize> = input
                .iter()
                .enumerate()
                .filter(|(_, b)| **b == b'.' as u8)
                .map(|(pos, _)| pos)
                .collect();
            if indexies.len() != 4 {
                bail!(
                    "The compact serialization form of JWE must be five parts separated by colon."
                );
            }

            let header_b64 = &input[0..indexies[0]];

            let encrypted_key_b64 = &input[(indexies[0] + 1)..(indexies[1])];
            let encrypted_key_vec;
            let encrypted_key = if encrypted_key_b64.len() > 0 {
                encrypted_key_vec = util::decode_base64_urlsafe_no_pad(encrypted_key_b64)?;
                Some(encrypted_key_vec.as_slice())
            } else {
                None
            };

            let iv_b64 = &input[(indexies[1] + 1)..(indexies[2])];
            let iv_vec;
            let iv = if iv_b64.len() > 0 {
                iv_vec = util::decode_base64_urlsafe_no_pad(iv_b64)?;
                Some(iv_vec.as_slice())
            } else {
                None
            };

            let ciphertext_b64 = &input[(indexies[2] + 1)..(indexies[3])];
            let ciphertext = util::decode_base64_urlsafe_no_pad(ciphertext_b64)?;

            let tag_b64 = &input[(indexies[3] + 1)..];
            let tag_vec;
            let tag = if tag_b64.len() > 0 {
                tag_vec = util::decode_base64_urlsafe_no_pad(tag_b64)?;
                Some(tag_vec.as_slice())
            } else {
                None
            };

            let header = util::decode_base64_urlsafe_no_pad(header_b64)?;
            let merged: Map<String, Value> = serde_json::from_slice(&header)?;
            let merged = JweHeader::from_map(merged)?;

            let decrypter = match selector(&merged)? {
                Some(val) => val,
                None => bail!("A decrypter is not found."),
            };

            let cencryption = match merged.claim("enc") {
                Some(Value::String(val)) => match self.get_content_encryption(val) {
                    Some(val2) => val2,
                    None => bail!("A content encryption is not registered: {}", val),
                },
                Some(_) => bail!("A enc header claim must be a string."),
                None => bail!("A enc header claim is required."),
            };

            let compression = match merged.claim("zip") {
                Some(Value::String(val)) => match self.get_compression(val) {
                    Some(val2) => Some(val2),
                    None => bail!("A compression algorithm is not registered: {}", val),
                },
                Some(_) => bail!("A enc header claim must be a string."),
                None => None,
            };

            match merged.claim("alg") {
                Some(Value::String(val)) => {
                    let expected_alg = decrypter.algorithm().name();
                    if val != expected_alg {
                        bail!("The JWE alg header claim is not {}: {}", expected_alg, val);
                    }
                }
                Some(_) => bail!("A alg header claim must be a string."),
                None => bail!("The JWE alg header claim is required."),
            }

            match decrypter.key_id() {
                Some(expected) => match merged.key_id() {
                    Some(actual) if expected == actual => {}
                    Some(actual) => bail!("The JWE kid header claim is mismatched: {}", actual),
                    None => bail!("The JWE kid header claim is required."),
                },
                None => {}
            }

            let key = decrypter.decrypt(encrypted_key, cencryption, &merged)?;
            if key.len() != cencryption.key_len() {
                bail!(
                    "The key size is expected to be {}: {}",
                    cencryption.key_len(),
                    key.len()
                );
            }

            let content = cencryption.decrypt(&key, iv, &ciphertext, header_b64, tag)?;
            let content = match compression {
                Some(val) => val.decompress(&content)?,
                None => content,
            };

            Ok((content, merged))
        })()
        .map_err(|err| match err.downcast::<JoseError>() {
            Ok(err) => err,
            Err(err) => JoseError::InvalidJweFormat(err),
        })
    }

    /// Deserialize the input that is formatted by json serialization.
    ///
    /// # Arguments
    ///
    /// * `input` - The input data.
    /// * `decrypter` - The JWE decrypter.
    pub fn deserialize_json<'a>(
        &self,
        input: impl AsRef<[u8]>,
        decrypter: &'a dyn JweDecrypter,
    ) -> Result<(Vec<u8>, JweHeader), JoseError> {
        self.deserialize_json_with_selector(input, |header| {
            match header.algorithm() {
                Some(val) => {
                    let expected_alg = decrypter.algorithm().name();
                    if val != expected_alg {
                        return Ok(None);
                    }
                }
                _ => return Ok(None),
            }

            match decrypter.key_id() {
                Some(expected) => match header.key_id() {
                    Some(actual) if expected == actual => {}
                    _ => return Ok(None),
                },
                None => {}
            }

            Ok(Some(decrypter))
        })
    }

    /// Deserialize the input that is formatted by json serialization.
    ///
    /// # Arguments
    ///
    /// * `input` - The input data.
    /// * `selector` - a function for selecting the decrypting algorithm.
    pub fn deserialize_json_with_selector<'a, F>(
        &self,
        input: impl AsRef<[u8]>,
        selector: F,
    ) -> Result<(Vec<u8>, JweHeader), JoseError>
    where
        F: Fn(&JweHeader) -> Result<Option<&'a dyn JweDecrypter>, JoseError>,
    {
        (|| -> anyhow::Result<(Vec<u8>, JweHeader)> {
            let input = input.as_ref();
            let mut map: Map<String, Value> = serde_json::from_slice(input)?;

            let (protected, protected_b64) = match map.remove("protected") {
                Some(Value::String(val)) => {
                    if val.len() == 0 {
                        bail!("The protected field must be empty.");
                    }
                    let vec = util::decode_base64_urlsafe_no_pad(&val)?;
                    let json: Map<String, Value> = serde_json::from_slice(&vec)?;
                    (Some(json), Some(val))
                }
                Some(_) => bail!("The protected field must be a string."),
                None => (None, None),
            };
            let unprotected = match map.remove("unprotected") {
                Some(Value::Object(val)) => {
                    if val.len() == 0 {
                        bail!("The unprotected field must be empty.");
                    }
                    Some(val)
                }
                Some(_) => bail!("The JWE unprotected field must be string."),
                None => None,
            };
            let aad_b64 = match map.remove("aad") {
                Some(Value::String(val)) => {
                    if val.len() == 0 {
                        bail!("The JWE aad field must be empty.");
                    } else if !util::is_base64_urlsafe_nopad(&val) {
                        bail!("The JWE aad field must be a base64 string.");
                    }
                    Some(val)
                }
                Some(_) => bail!("The JWE aad field must be string."),
                None => None,
            };
            let iv_vec;
            let iv = match map.remove("iv") {
                Some(Value::String(val)) => {
                    if val.len() == 0 {
                        bail!("The iv field must be empty.");
                    }
                    iv_vec = util::decode_base64_urlsafe_no_pad(&val)?;
                    Some(iv_vec.as_slice())
                }
                Some(_) => bail!("The iv field must be string."),
                None => None,
            };
            let ciphertext = match map.remove("ciphertext") {
                Some(Value::String(val)) => {
                    if val.len() == 0 {
                        bail!("The ciphertext field must be empty.");
                    }
                    util::decode_base64_urlsafe_no_pad(&val)?
                }
                Some(_) => bail!("The ciphertext field must be string."),
                None => bail!("The ciphertext field is required."),
            };
            let tag_vec;
            let tag = match map.remove("tag") {
                Some(Value::String(val)) => {
                    if val.len() == 0 {
                        bail!("The tag field must be empty.");
                    }
                    tag_vec = util::decode_base64_urlsafe_no_pad(&val)?;
                    Some(tag_vec.as_slice())
                }
                Some(_) => bail!("The tag field must be string."),
                None => None,
            };

            let recipients = match map.remove("recipients") {
                Some(Value::Array(vals)) => {
                    if vals.len() == 0 {
                        bail!("The recipients field must be empty.");
                    }
                    let mut vec = Vec::with_capacity(vals.len());
                    for val in vals {
                        if let Value::Object(val) = val {
                            vec.push(val);
                        } else {
                            bail!("The recipients field must be a array of object.");
                        }
                    }
                    vec
                }
                Some(_) => bail!("The recipients field must be a array."),
                None => {
                    let mut vec = Vec::with_capacity(1);
                    vec.push(map);
                    vec
                }
            };

            for mut recipient in recipients {
                let header = recipient.remove("header");

                let encrypted_key_vec;
                let encrypted_key = match recipient.get("encrypted_key") {
                    Some(Value::String(val)) => {
                        if val.len() == 0 {
                            bail!("The encrypted_key field must be empty.");
                        }
                        encrypted_key_vec = util::decode_base64_urlsafe_no_pad(&val)?;
                        Some(encrypted_key_vec.as_slice())
                    }
                    Some(_) => bail!("The encrypted_key field must be a string."),
                    None => None,
                };

                let mut merged = match header {
                    Some(Value::Object(val)) => val,
                    Some(_) => bail!("The protected field must be a object."),
                    None => Map::new(),
                };

                if let Some(val) = &unprotected {
                    for (key, value) in val {
                        if merged.contains_key(key) {
                            bail!("A duplicate key exists: {}", key);
                        } else {
                            merged.insert(key.clone(), value.clone());
                        }
                    }
                }

                if let Some(val) = &protected {
                    for (key, value) in val {
                        if merged.contains_key(key) {
                            bail!("A duplicate key exists: {}", key);
                        } else {
                            merged.insert(key.clone(), value.clone());
                        }
                    }
                }

                let merged = JweHeader::from_map(merged)?;

                let decrypter = match selector(&merged)? {
                    Some(val) => val,
                    None => continue,
                };

                let cencryption = match merged.claim("enc") {
                    Some(Value::String(val)) => match self.get_content_encryption(val) {
                        Some(val2) => val2,
                        None => bail!("A content encryption is not registered: {}", val),
                    },
                    Some(_) => bail!("A enc header claim must be string."),
                    None => bail!("A enc header claim is required."),
                };

                let compression = match merged.claim("zip") {
                    Some(Value::String(val)) => match self.get_compression(val) {
                        Some(val2) => Some(val2),
                        None => bail!("A compression algorithm is not registered: {}", val),
                    },
                    Some(_) => bail!("A enc header claim must be string."),
                    None => None,
                };

                match merged.algorithm() {
                    Some(val) => {
                        let expected_alg = decrypter.algorithm().name();
                        if val != expected_alg {
                            bail!("The JWE alg header claim is not {}: {}", expected_alg, val);
                        }
                    }
                    None => bail!("The JWE alg header claim is required."),
                }

                match decrypter.key_id() {
                    Some(expected) => match merged.key_id() {
                        Some(actual) if expected == actual => {}
                        Some(actual) => bail!("The JWE kid header claim is mismatched: {}", actual),
                        None => bail!("The JWE kid header claim is required."),
                    },
                    None => {}
                }

                let mut full_aad = match protected_b64 {
                    Some(val) => val,
                    None => String::new(),
                };
                if let Some(val) = aad_b64 {
                    full_aad.push_str(".");
                    full_aad.push_str(&val);
                }

                let key = decrypter.decrypt(encrypted_key, cencryption, &merged)?;
                if key.len() != cencryption.key_len() {
                    bail!(
                        "The key size is expected to be {}: {}",
                        cencryption.key_len(),
                        key.len()
                    );
                }

                let content =
                    cencryption.decrypt(&key, iv, &ciphertext, full_aad.as_bytes(), tag)?;
                let content = match compression {
                    Some(val) => val.decompress(&content)?,
                    None => content,
                };

                return Ok((content, merged));
            }

            bail!("A recipient that matched the header claims is not found.");
        })()
        .map_err(|err| match err.downcast::<JoseError>() {
            Ok(err) => err,
            Err(err) => JoseError::InvalidJweFormat(err),
        })
    }
}

#[cfg(test)]
mod tests {
    use crate::jwe::{
        alg::direct::DirectJweAlgorithm, deserialize_compact, deserialize_json, serialize_compact,
        serialize_flattened_json, serialize_general_json, JweHeader, JweHeaderSet,
    };
    use anyhow::Result;

    const CONTENT_CIPHERS: [(&str, usize); 6] = [
        ("A128CBC-HS256", 32),
        ("A192CBC-HS384", 48),
        ("A256CBC-HS512", 64),
        ("A128GCM", 16),
        ("A192GCM", 24),
        ("A256GCM", 32),
    ];

    #[test]
    fn compact_dir() -> Result<()> {
        let payload = b"hello world";
        let alg = DirectJweAlgorithm::Dir;
        for (cipher, keylen) in CONTENT_CIPHERS {
            let mut header = JweHeader::new();
            header.set_content_encryption(cipher);
            let key = vec![0; keylen];
            let encrypter = alg.encrypter_from_bytes(&key)?;
            let jwe = serialize_compact(payload, &header, &encrypter)?;
            println!("{}", jwe);

            let decrypter = alg.decrypter_from_bytes(&key)?;
            let (data, _header) = deserialize_compact(&jwe, &decrypter)?;
            assert_eq!(data, payload);
        }
        Ok(())
    }

    #[test]
    fn flattened_json_dir() -> Result<()> {
        let payload = b"hello world";
        let alg = DirectJweAlgorithm::Dir;
        for (cipher, keylen) in CONTENT_CIPHERS {
            let mut hs = JweHeaderSet::new();
            hs.set_content_encryption(cipher, true);
            let key = vec![0; keylen];
            let encrypter = alg.encrypter_from_bytes(&key)?;
            let jwe = serialize_flattened_json(payload, Some(&hs), None, None, &encrypter)?;
            println!("{}", jwe);

            let decrypter = alg.decrypter_from_bytes(&key)?;
            let (data, _header) = deserialize_json(&jwe, &decrypter)?;
            assert_eq!(data, payload);
        }
        Ok(())
    }

    #[test]
    fn general_json_dir() -> Result<()> {
        let payload = b"hello world";
        let alg = DirectJweAlgorithm::Dir;
        for (cipher, keylen) in CONTENT_CIPHERS {
            let mut hs = JweHeaderSet::new();
            hs.set_content_encryption(cipher, true);
            let key = vec![0; keylen];
            let encrypter = alg.encrypter_from_bytes(&key)?;
            let jwe = serialize_general_json(payload, Some(&hs), &[(None, &encrypter)], None)?;
            println!("{}", jwe);

            let decrypter = alg.decrypter_from_bytes(&key)?;
            let (data, _header) = deserialize_json(&jwe, &decrypter)?;
            assert_eq!(data, payload);
        }
        Ok(())
    }
}