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
// Copyright 2016 Masaki Hara
// Copyright 2019 Fortanix, Inc.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#![forbid(missing_docs)]
use alloc::vec::Vec;
#[cfg(feature = "num-bigint")]
use num_bigint::{BigUint, BigInt};
#[cfg(feature = "bit-vec")]
use bit_vec::BitVec;
use super::{PCBit, Tag};
use super::tags::{TAG_BOOLEAN,TAG_INTEGER,TAG_OCTETSTRING};
use super::tags::{TAG_NULL,TAG_OID,TAG_UTF8STRING,TAG_SEQUENCE,TAG_SET,TAG_ENUM,TAG_IA5STRING,TAG_BMPSTRING};
use super::tags::{TAG_NUMERICSTRING,TAG_PRINTABLESTRING,TAG_VISIBLESTRING};
use super::models::{ObjectIdentifier,TaggedDerValue};
#[cfg(feature = "time")]
use super::models::{UTCTime,GeneralizedTime};
/// Constructs DER-encoded data as `Vec<u8>`.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriter`], to which the ASN.1 value is written.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_sequence(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// })
/// });
/// assert_eq!(der, vec![48, 6, 2, 1, 10, 1, 1, 255]);
/// ```
pub fn construct_der<F>(callback: F) -> Vec<u8>
where F: FnOnce(DERWriter) {
let mut buf = Vec::new();
{
let mut writer = DERWriterSeq {
buf: &mut buf,
};
callback(writer.next());
}
return buf;
}
/// Tries to construct DER-encoded data as `Vec<u8>`.
///
/// Same as [`construct_der`], only that it allows
/// returning an error from the passed closure.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSeq`], to which the ASN.1 values are written.
///
/// # Examples
///
/// ```
/// use yasna;
/// let res_ok = yasna::try_construct_der::<_, ()>(|writer| {
/// writer.write_sequence(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// });
/// Ok(())
/// });
/// let res_err = yasna::try_construct_der::<_, &str>(|writer| {
/// writer.write_sequence(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// return Err("some error here");
/// })?;
/// Ok(())
/// });
/// assert_eq!(res_ok, Ok(vec![48, 6, 2, 1, 10, 1, 1, 255]));
/// assert_eq!(res_err, Err("some error here"));
/// ```
pub fn try_construct_der<F, E>(callback: F) -> Result<Vec<u8>, E>
where F: FnOnce(DERWriter) -> Result<(), E> {
let mut buf = Vec::new();
{
let mut writer = DERWriterSeq {
buf: &mut buf,
};
callback(writer.next())?;
}
return Ok(buf);
}
/// Constructs DER-encoded sequence of data as `Vec<u8>`.
///
/// This is similar to [`construct_der`], but this function
/// accepts more than one ASN.1 values.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSeq`], to which the ASN.1 values are written.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der_seq(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// });
/// assert_eq!(der, vec![2, 1, 10, 1, 1, 255]);
/// ```
pub fn construct_der_seq<F>(callback: F) -> Vec<u8>
where F: FnOnce(&mut DERWriterSeq) {
let mut buf = Vec::new();
{
let mut writer = DERWriterSeq {
buf: &mut buf,
};
callback(&mut writer);
}
return buf;
}
/// Tries to construct a DER-encoded sequence of data as `Vec<u8>`.
///
/// Same as [`construct_der_seq`], only that it allows
/// returning an error from the passed closure.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSeq`], to which the ASN.1 values are written.
///
/// # Examples
///
/// ```
/// use yasna;
/// let res_ok = yasna::try_construct_der_seq::<_, ()>(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// Ok(())
/// });
/// let res_err = yasna::try_construct_der_seq::<_, &str>(|writer| {
/// return Err("some error here");
/// });
/// assert_eq!(res_ok, Ok(vec![2, 1, 10, 1, 1, 255]));
/// assert_eq!(res_err, Err("some error here"));
/// ```
pub fn try_construct_der_seq<F, E>(callback: F) -> Result<Vec<u8> , E>
where F: FnOnce(&mut DERWriterSeq) -> Result<(), E> {
let mut buf = Vec::new();
{
let mut writer = DERWriterSeq {
buf: &mut buf,
};
callback(&mut writer)?;
}
return Ok(buf);
}
/// A writer object that accepts an ASN.1 value.
///
/// The two main sources of `DERWriterSeq` are:
///
/// - The [`construct_der`] function, the starting point of
/// DER serialization.
/// - The [`next`](DERWriterSeq::next) method of [`DERWriterSeq`].
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_i64(10)
/// });
/// assert_eq!(der, vec![2, 1, 10]);
/// ```
#[derive(Debug)]
pub struct DERWriter<'a> {
buf: &'a mut Vec<u8>,
implicit_tag: Option<Tag>,
}
impl<'a> DERWriter<'a> {
fn from_buf(buf: &'a mut Vec<u8>) -> Self {
return DERWriter {
buf,
implicit_tag: None,
}
}
/// Writes BER identifier (tag + primitive/constructed) octets.
fn write_identifier(&mut self, tag: Tag, pc: PCBit) {
let tag = if let Some(tag) = self.implicit_tag { tag } else { tag };
self.implicit_tag = None;
let classid = tag.tag_class as u8;
let pcid = pc as u8;
if tag.tag_number < 31 {
self.buf.push(
(classid << 6) | (pcid << 5) | (tag.tag_number as u8));
return;
}
self.buf.push((classid << 6) | (pcid << 5) | 31);
let mut shiftnum = 63; // ceil(64 / 7) * 7 - 7
while (tag.tag_number >> shiftnum) == 0 {
shiftnum -= 7;
}
while shiftnum > 0 {
self.buf.push(128 | (((tag.tag_number >> shiftnum) & 127) as u8));
shiftnum -= 7;
}
self.buf.push((tag.tag_number & 127) as u8);
}
/// Writes BER length octets.
fn write_length(&mut self, length: usize) {
let length = length as u64;
if length < 128 {
self.buf.push(length as u8);
return;
}
let mut shiftnum = 56; // ceil(64 / 8) * 8 - 8
while (length >> shiftnum) == 0 {
shiftnum -= 8;
}
self.buf.push(128 | ((shiftnum / 8 + 1) as u8));
loop {
self.buf.push((length >> shiftnum) as u8);
if shiftnum == 0 {
break;
}
shiftnum -= 8;
}
}
/// Deals with unknown length procedures.
/// This function first marks the current position and
/// allocates 3 bytes. Then it calls back `callback`.
/// It then calculates the length and moves the written data
/// to the actual position. Finally, it writes the length.
fn with_length<T, F>(&mut self, callback: F) -> T
where F: FnOnce(&mut Self) -> T {
let expected_length_length = 3;
for _ in 0..3 {
self.buf.push(255);
}
let start_pos = self.buf.len();
let result = callback(self);
let length = (self.buf.len() - start_pos) as u64;
let length_length;
let mut shiftnum = 56; // ceil(64 / 8) * 8 - 8
if length < 128 {
length_length = 1;
} else {
while (length >> shiftnum) == 0 {
shiftnum -= 8;
}
length_length = shiftnum / 8 + 2;
}
let new_start_pos;
if length_length < expected_length_length {
let diff = expected_length_length - length_length;
new_start_pos = start_pos - diff;
self.buf.drain(new_start_pos .. start_pos);
} else if length_length > expected_length_length {
let diff = length_length - expected_length_length;
new_start_pos = start_pos + diff;
for _ in 0..diff { self.buf.insert(start_pos, 0); }
} else {
new_start_pos = start_pos;
}
let mut idx = new_start_pos - length_length;
if length < 128 {
self.buf[idx] = length as u8;
} else {
self.buf[idx] = 128 | ((shiftnum / 8 + 1) as u8);
idx += 1;
loop {
self.buf[idx] = (length >> shiftnum) as u8;
idx += 1;
if shiftnum == 0 {
break;
}
shiftnum -= 8;
}
}
return result;
}
/// Writes `bool` as an ASN.1 BOOLEAN value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_bool(true)
/// });
/// assert_eq!(der, vec![1, 1, 255]);
/// ```
pub fn write_bool(mut self, val: bool) {
self.write_identifier(TAG_BOOLEAN, PCBit::Primitive);
self.write_length(1);
self.buf.push(if val { 255 } else { 0 });
}
fn write_integer(mut self, tag: Tag, val: i64) {
let mut shiftnum = 56;
while shiftnum > 0 &&
(val >> (shiftnum-1) == 0 || val >> (shiftnum-1) == -1) {
shiftnum -= 8;
}
self.write_identifier(tag, PCBit::Primitive);
self.write_length(shiftnum / 8 + 1);
loop {
self.buf.push((val >> shiftnum) as u8);
if shiftnum == 0 {
break;
}
shiftnum -= 8;
}
}
/// Writes `i64` as an ASN.1 ENUMERATED value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_enum(2)
/// });
/// assert_eq!(der, vec![10, 1, 2]);
/// ```
pub fn write_enum(self, val: i64) {
self.write_integer(TAG_ENUM, val);
}
/// Writes `i64` as an ASN.1 INTEGER value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_i64(1234567890)
/// });
/// assert_eq!(der, vec![2, 4, 73, 150, 2, 210]);
/// ```
pub fn write_i64(self, val: i64) {
self.write_integer(TAG_INTEGER, val);
}
/// Writes `u64` as an ASN.1 INTEGER value.
pub fn write_u64(mut self, val: u64) {
let mut shiftnum = 64;
while shiftnum > 0 && val >> (shiftnum-1) == 0 {
shiftnum -= 8;
}
self.write_identifier(TAG_INTEGER, PCBit::Primitive);
self.write_length(shiftnum / 8 + 1);
if shiftnum == 64 {
self.buf.push(0);
shiftnum -= 8;
}
loop {
self.buf.push((val >> shiftnum) as u8);
if shiftnum == 0 {
break;
}
shiftnum -= 8;
}
}
/// Writes `i32` as an ASN.1 INTEGER value.
pub fn write_i32(self, val: i32) {
self.write_i64(val as i64)
}
/// Writes `u32` as an ASN.1 INTEGER value.
pub fn write_u32(self, val: u32) {
self.write_i64(val as i64)
}
/// Writes `i16` as an ASN.1 INTEGER value.
pub fn write_i16(self, val: i16) {
self.write_i64(val as i64)
}
/// Writes `u16` as an ASN.1 INTEGER value.
pub fn write_u16(self, val: u16) {
self.write_i64(val as i64)
}
/// Writes `i8` as an ASN.1 INTEGER value.
pub fn write_i8(self, val: i8) {
self.write_i64(val as i64)
}
/// Writes `u8` as an ASN.1 INTEGER value.
pub fn write_u8(self, val: u8) {
self.write_i64(val as i64)
}
#[cfg(feature = "num-bigint")]
/// Writes `BigInt` as an ASN.1 INTEGER value.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// use num_bigint::BigInt;
/// let der = yasna::construct_der(|writer| {
/// writer.write_bigint(
/// &BigInt::parse_bytes(b"1234567890", 10).unwrap())
/// });
/// assert_eq!(der, vec![2, 4, 73, 150, 2, 210]);
/// # }
/// ```
///
/// # Features
///
/// This method is enabled by `num` feature.
///
/// ```toml
/// [dependencies]
/// yasna = { version = "*", features = ["num-bigint"] }
/// ```
pub fn write_bigint(self, val: &BigInt) {
use num_bigint::Sign;
let (sign, mut bytes) = val.to_bytes_be();
if sign == Sign::Minus {
let mut carry: usize = 1;
for b in bytes.iter_mut().rev() {
let bval = 255 - (*b as usize);
*b = (bval + carry) as u8;
carry = (bval + carry) >> 8;
}
}
self.write_bigint_bytes(&bytes, sign != Sign::Minus);
}
/// Writes `&[u8]` and `bool` as an ASN.1 INTEGER value.
///
/// The first parameter encodes the bytes of the integer, in big-endian
/// byte ordering and two's complement format. The second parameter encodes
/// the sign, and is true if the number is non-negative, and false if it is
/// negative. Zero is encoded by passing an empty slice.
///
/// The number is expected to be in two's complement format, so for example
/// `1` is encoded as `[1]` and `-1` as `[255]`.
///
/// You don't have to worry about leading bits, meaning that if the leading
/// bit of a positive number is not zero, a leading zero byte will be
/// encoded by the function. Similarly, if the leading bit of a negative
/// number is not one, a leading byte will be added by the function as well.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// // Encodes 1234567890
/// writer.write_bigint_bytes(&[73, 150, 2, 210], true)
/// });
/// assert_eq!(der, vec![2, 4, 73, 150, 2, 210]);
/// # }
/// ```
pub fn write_bigint_bytes(mut self, bytes: &[u8], positive: bool) {
let mut bytes = bytes;
// Remove leading zero bytes
while bytes.get(0) == Some(&0) {
bytes = &bytes[1..];
}
if !positive {
// Remove leading 255 bytes
// (the order is important here, [255, 0] should be a fixpoint input)
while bytes.len() > 1 && bytes[0] == 255 && bytes.get(1).unwrap_or(&0) & 128 != 0 {
bytes = &bytes[1..];
}
}
self.write_identifier(TAG_INTEGER, PCBit::Primitive);
if bytes.len() == 0 || bytes[0] == 0 {
self.write_length(1);
self.buf.push(0);
} else if positive {
if bytes[0] >= 128 {
self.write_length(bytes.len() + 1);
self.buf.push(0);
} else {
self.write_length(bytes.len());
}
self.buf.extend_from_slice(&bytes);
} else {
debug_assert!(bytes[0] != 0);
if bytes[0] < 128 {
self.write_length(bytes.len() + 1);
self.buf.push(255);
} else {
self.write_length(bytes.len());
}
self.buf.extend_from_slice(&bytes);
}
}
#[cfg(feature = "num-bigint")]
/// Writes `BigUint` as an ASN.1 INTEGER value.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// use num_bigint::BigUint;
/// let der = yasna::construct_der(|writer| {
/// writer.write_biguint(
/// &BigUint::parse_bytes(b"1234567890", 10).unwrap())
/// });
/// assert_eq!(der, vec![2, 4, 73, 150, 2, 210]);
/// # }
/// ```
///
/// # Features
///
/// This method is enabled by `num` feature.
///
/// ```toml
/// [dependencies]
/// yasna = { version = "*", features = ["num-bigint"] }
/// ```
pub fn write_biguint(mut self, val: &BigUint) {
self.write_identifier(TAG_INTEGER, PCBit::Primitive);
let mut bytes = val.to_bytes_le();
if &bytes == &[0] {
self.write_length(1);
self.buf.push(0);
return;
}
let byteslen = bytes.len();
debug_assert!(bytes[byteslen-1] != 0);
if bytes[byteslen-1] >= 128 {
self.write_length(byteslen+1);
self.buf.push(0);
} else {
self.write_length(byteslen);
}
bytes.reverse();
self.buf.extend_from_slice(&bytes);
}
#[cfg(feature = "bit-vec")]
/// Writes [`BitVec`] as an ASN.1 BITSTRING value.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// use bit_vec::BitVec;
/// let der = yasna::construct_der(|writer| {
/// writer.write_bitvec(&
/// [1, 1, 0, 0, 1, 1, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1,
/// 0, 1, 1, 1, 0, 1, 0, 0, 0, 0, 0, 1, 1]
/// .iter().map(|&i| i != 0).collect())
/// });
/// assert_eq!(&der, &[3, 5, 3, 206, 213, 116, 24]);
/// # }
/// ```
///
/// # Features
///
/// This method is enabled by `bit-vec` feature.
///
/// ```toml
/// [dependencies]
/// yasna = { version = "*", features = ["bit-vec"] }
/// ```
pub fn write_bitvec(self, bitvec: &BitVec) {
let len = bitvec.len();
let bytes = bitvec.to_bytes();
self.write_bitvec_bytes(&bytes, len);
}
/// Writes `&[u8]` and `usize` as an ASN.1 BITSTRING value.
///
/// The `len` parameter represents the number of bits to be encoded.
/// This function is similar to `write_bitvec`, with `to_bytes` applied to
/// the bitvec, but is available even if the `bit-vec` feature is disabled.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// let der_1 = yasna::construct_der(|writer| {
/// writer.write_bitvec_bytes(&[117, 13, 64], 18)
/// });
/// let der_2 = yasna::construct_der(|writer| {
/// writer.write_bitvec_bytes(&[117, 13, 65], 18)
/// });
/// assert_eq!(&der_1, &[3, 4, 6, 117, 13, 64]);
/// assert_eq!(&der_2, &[3, 4, 6, 117, 13, 64]);
/// # }
/// ```
pub fn write_bitvec_bytes(mut self, bytes: &[u8], len: usize) {
use super::tags::TAG_BITSTRING;
self.write_identifier(TAG_BITSTRING, PCBit::Primitive);
debug_assert!(len <= 8 * bytes.len());
debug_assert!(8 * bytes.len() < len + 8);
self.write_length(1 + bytes.len());
let len_diff = 8 * bytes.len() - len;
self.buf.push(len_diff as u8);
if bytes.len() > 0 {
self.buf.extend_from_slice(&bytes[0 .. bytes.len() - 1]);
let mask = !(255u16 >> (8 - len_diff)) as u8;
self.buf.push(bytes[bytes.len() - 1] & mask);
}
}
/// Writes `&[u8]` as an ASN.1 OCTETSTRING value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_bytes(b"Hello!")
/// });
/// assert_eq!(der, vec![4, 6, 72, 101, 108, 108, 111, 33]);
/// ```
pub fn write_bytes(mut self, bytes: &[u8]) {
self.write_identifier(TAG_OCTETSTRING, PCBit::Primitive);
self.write_length(bytes.len());
self.buf.extend_from_slice(bytes);
}
/// Writes `&str` as an ASN.1 UTF8String value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_utf8_string("Hello!")
/// });
/// assert_eq!(der, vec![12, 6, 72, 101, 108, 108, 111, 33]);
/// ```
pub fn write_utf8_string(mut self, string: &str) {
self.write_identifier(TAG_UTF8STRING, PCBit::Primitive);
self.write_length(string.len());
self.buf.extend_from_slice(string.as_bytes());
}
/// Writes `&str` as an ASN.1 IA5String value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_ia5_string("Hello!")
/// });
/// assert_eq!(der, vec![22, 6, 72, 101, 108, 108, 111, 33]);
/// ```
pub fn write_ia5_string(mut self, string: &str) {
assert!(string.is_ascii(), "IA5 string must be ASCII");
self.write_identifier(TAG_IA5STRING, PCBit::Primitive);
self.write_length(string.len());
self.buf.extend_from_slice(string.as_bytes());
}
/// Writes `&str` as an ASN.1 BMPString value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_bmp_string("❤πü2?")
/// });
/// assert_eq!(der, vec![30, 10, 39, 100, 3, 192, 0, 252, 0, 50, 0, 63]);
/// ```
pub fn write_bmp_string(mut self, string: &str) {
let utf16 : Vec<u16> = string.encode_utf16().collect();
let mut bytes = Vec::with_capacity(utf16.len() * 2);
for c in utf16 {
bytes.push((c / 256) as u8);
bytes.push((c % 256) as u8);
}
self.write_identifier(TAG_BMPSTRING, PCBit::Primitive);
self.write_length(bytes.len());
self.buf.extend_from_slice(&bytes);
}
/// Writes the ASN.1 NULL value.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_null()
/// });
/// assert_eq!(der, vec![5, 0]);
/// ```
pub fn write_null(mut self) {
self.write_identifier(TAG_NULL, PCBit::Primitive);
self.write_length(0);
}
/// Writes an ASN.1 object identifier.
///
/// # Examples
///
/// ```
/// use yasna;
/// use yasna::models::ObjectIdentifier;
/// let der = yasna::construct_der(|writer| {
/// writer.write_oid(&ObjectIdentifier::from_slice(
/// &[1, 2, 840, 113549, 1, 1]))
/// });
/// assert_eq!(&der, &[6, 8, 42, 134, 72, 134, 247, 13, 1, 1]);
/// ```
///
/// # Panics
///
/// It panics when the OID cannot be canonically encoded in BER.
pub fn write_oid(mut self, oid: &ObjectIdentifier) {
assert!(oid.components().len() >= 2, "Invalid OID: too short");
let id0 = oid.components()[0];
let id1 = oid.components()[1];
assert!(
(id0 < 3) && (id1 < 18446744073709551535) &&
(id0 >= 2 || id1 < 40),
"Invalid OID {{{} {} ...}}", id0, id1);
let subid0 = id0 * 40 + id1;
let mut length = 0;
for i in 1..oid.components().len() {
let mut subid = if i == 1 {
subid0
} else {
oid.components()[i]
} | 1;
while subid > 0 {
length += 1;
subid >>= 7;
}
}
self.write_identifier(TAG_OID, PCBit::Primitive);
self.write_length(length);
for i in 1..oid.components().len() {
let subid = if i == 1 {
subid0
} else {
oid.components()[i]
};
let mut shiftnum = 63; // ceil(64 / 7) * 7 - 7
while ((subid|1) >> shiftnum) == 0 {
shiftnum -= 7;
}
while shiftnum > 0 {
self.buf.push(128 | ((((subid|1) >> shiftnum) & 127) as u8));
shiftnum -= 7;
}
self.buf.push((subid & 127) as u8);
}
}
/// Writes an ASN.1 UTF8String.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_utf8string("gnaw ροκανίζω 𪘂る")
/// });
/// assert_eq!(&der, &[
/// 12, 29, 103, 110, 97, 119, 32, 207, 129, 206, 191, 206,
/// 186, 206, 177, 206, 189, 206, 175, 206, 182, 207,
/// 137, 32, 240, 170, 152, 130, 227, 130, 139]);
/// ```
pub fn write_utf8string(self, string: &str) {
self.write_tagged_implicit(TAG_UTF8STRING, |writer| {
writer.write_bytes(string.as_bytes())
})
}
/// Writes ASN.1 SEQUENCE.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSeq`], to which the contents of the
/// SEQUENCE is written.
///
/// This is equivalent to [`write_sequence_of`](Self::write_sequence_of)
/// in behavior.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_sequence(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// })
/// });
/// assert_eq!(der, vec![48, 6, 2, 1, 10, 1, 1, 255]);
/// ```
pub fn write_sequence<T, F>(mut self, callback: F) -> T
where F: FnOnce(&mut DERWriterSeq) -> T {
self.write_identifier(TAG_SEQUENCE, PCBit::Constructed);
return self.with_length(|writer| {
callback(&mut DERWriterSeq {
buf: writer.buf,
})
});
}
/// Writes ASN.1 SEQUENCE OF.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSeq`], to which the contents of the
/// SEQUENCE OF are written.
///
/// This is equivalent to [`write_sequence`](Self::write_sequence) in
/// behavior.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_sequence_of(|writer| {
/// for &i in &[10, -129] {
/// writer.next().write_i64(i);
/// }
/// })
/// });
/// assert_eq!(der, vec![48, 7, 2, 1, 10, 2, 2, 255, 127]);
/// ```
pub fn write_sequence_of<T, F>(self, callback: F) -> T
where F: FnOnce(&mut DERWriterSeq) -> T {
self.write_sequence(callback)
}
/// Writes ASN.1 SET.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSet`], to which the contents of the
/// SET are written.
///
/// For SET OF values, use [`write_set_of`](Self::write_set_of) instead.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_set(|writer| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// })
/// });
/// assert_eq!(der, vec![49, 6, 1, 1, 255, 2, 1, 10]);
/// ```
pub fn write_set<T, F>(mut self, callback: F) -> T
where F: FnOnce(&mut DERWriterSet) -> T {
let mut bufs = Vec::new();
let result = callback(&mut DERWriterSet {
bufs: &mut bufs,
});
for buf in bufs.iter() {
assert!(buf.len() > 0, "Empty output in write_set()");
}
bufs.sort_by(|buf0, buf1| {
let buf00 = buf0[0] & 223;
let buf10 = buf1[0] & 223;
if buf00 != buf10 || (buf0[0] & 31) != 31 {
return buf00.cmp(&buf10);
}
let len0 = buf0[1..].iter().position(|x| x & 128 == 0).unwrap();
let len1 = buf1[1..].iter().position(|x| x & 128 == 0).unwrap();
if len0 != len1 {
return len0.cmp(&len1);
}
return buf0[1..].cmp(&buf1[1..]);
});
// let bufs_len = bufs.iter().map(|buf| buf.len()).sum();
let bufs_len = bufs.iter().map(|buf| buf.len()).fold(0, |x, y| x + y);
self.write_identifier(TAG_SET, PCBit::Constructed);
self.write_length(bufs_len);
for buf in bufs.iter() {
self.buf.extend_from_slice(buf);
}
return result;
}
/// Writes ASN.1 SET OF.
///
/// This function uses the loan pattern: `callback` is called back with
/// a [`DERWriterSet`], to which the contents of the
/// SET OF are written.
///
/// For SET values, use [`write_set`](Self::write_set) instead.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_set_of(|writer| {
/// for &i in &[10, -129] {
/// writer.next().write_i64(i);
/// }
/// })
/// });
/// assert_eq!(der, vec![49, 7, 2, 1, 10, 2, 2, 255, 127]);
/// ```
pub fn write_set_of<T, F>(mut self, callback: F) -> T
where F: FnOnce(&mut DERWriterSet) -> T {
let mut bufs = Vec::new();
let result = callback(&mut DERWriterSet {
bufs: &mut bufs,
});
for buf in bufs.iter() {
assert!(buf.len() > 0, "Empty output in write_set_of()");
}
bufs.sort();
// let bufs_len = bufs.iter().map(|buf| buf.len()).sum();
let bufs_len = bufs.iter().map(|buf| buf.len()).fold(0, |x, y| x + y);
self.write_identifier(TAG_SET, PCBit::Constructed);
self.write_length(bufs_len);
for buf in bufs.iter() {
self.buf.extend_from_slice(buf);
}
return result;
}
/// Writes an ASN.1 NumericString.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_numeric_string("128 256")
/// });
/// assert_eq!(&der, &[18, 7, 49, 50, 56, 32, 50, 53, 54]);
/// ```
pub fn write_numeric_string(self, string: &str) {
let bytes = string.as_bytes();
for &byte in bytes {
assert!(byte == b' ' || (b'0' <= byte && byte <= b'9'),
"Invalid NumericString: {:?} appeared", byte);
}
self.write_tagged_implicit(TAG_NUMERICSTRING, |writer| {
writer.write_bytes(bytes)
});
}
/// Writes an ASN.1 PrintableString.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_printable_string("Co., Ltd.")
/// });
/// assert_eq!(&der, &[19, 9, 67, 111, 46, 44, 32, 76, 116, 100, 46]);
/// ```
pub fn write_printable_string(self, string: &str) {
let bytes = string.as_bytes();
for &byte in bytes {
assert!(
byte == b' ' ||
(b'\'' <= byte && byte <= b':' && byte != b'*') ||
byte == b'=' ||
(b'A' <= byte && byte <= b'Z') ||
(b'a' <= byte && byte <= b'z'),
"Invalid PrintableString: {:?} appeared", byte);
}
self.write_tagged_implicit(TAG_PRINTABLESTRING, |writer| {
writer.write_bytes(bytes)
});
}
#[cfg(feature = "time")]
/// Writes an ASN.1 UTCTime.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// use yasna::models::UTCTime;
/// use time::OffsetDateTime;
/// let der = yasna::construct_der(|writer| {
/// writer.write_utctime(
/// &UTCTime::from_datetime(
/// OffsetDateTime::from_unix_timestamp(378820800).unwrap()))
/// });
/// assert_eq!(&der, &[
/// 23, 13, 56, 50, 48, 49, 48, 50, 49, 50, 48, 48, 48, 48, 90]);
/// # }
/// ```
///
/// # Features
///
/// This method is enabled by `time` feature.
///
/// ```toml
/// [dependencies]
/// yasna = { version = "*", features = ["time"] }
/// ```
pub fn write_utctime(self, datetime: &UTCTime) {
use super::tags::TAG_UTCTIME;
self.write_tagged_implicit(TAG_UTCTIME, |writer| {
writer.write_bytes(&datetime.to_bytes())
});
}
#[cfg(feature = "time")]
/// Writes an ASN.1 GeneralizedTime.
///
/// # Examples
///
/// ```
/// # fn main() {
/// use yasna;
/// use yasna::models::GeneralizedTime;
/// use time::OffsetDateTime;
/// let der = yasna::construct_der(|writer| {
/// writer.write_generalized_time(
/// &GeneralizedTime::from_datetime(
/// OffsetDateTime::from_unix_timestamp_nanos(
/// 500_159_309_724_000_000).unwrap()))
/// });
/// assert_eq!(&der, &[
/// 24, 19, 49, 57, 56, 53, 49, 49, 48, 54, 50,
/// 49, 48, 56, 50, 57, 46, 55, 50, 52, 90]);
/// # }
/// ```
///
/// # Features
///
/// This method is enabled by `time` feature.
///
/// ```toml
/// [dependencies]
/// yasna = { version = "*", features = ["time"] }
/// ```
pub fn write_generalized_time(self, datetime: &GeneralizedTime) {
use super::tags::TAG_GENERALIZEDTIME;
self.write_tagged_implicit(TAG_GENERALIZEDTIME, |writer| {
writer.write_bytes(&datetime.to_bytes())
});
}
/// Writes an ASN.1 VisibleString.
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_visible_string("Hi!")
/// });
/// assert_eq!(&der, &[26, 3, 72, 105, 33]);
/// ```
pub fn write_visible_string(self, string: &str) {
let bytes = string.as_bytes();
for &byte in bytes {
assert!(b' ' <= byte && byte <= b'~',
"Invalid VisibleString: {:?} appeared", byte);
}
self.write_tagged_implicit(TAG_VISIBLESTRING, |writer| {
writer.write_bytes(bytes)
});
}
/// Writes an (explicitly) tagged value.
///
/// # Examples
///
/// ```
/// use yasna::{self,Tag};
/// let der = yasna::construct_der(|writer| {
/// writer.write_tagged(Tag::context(3), |writer| {
/// writer.write_i64(10)
/// })
/// });
/// assert_eq!(der, vec![163, 3, 2, 1, 10]);
/// ```
///
/// Note: you can achieve the same using
/// [`write_tagged_implicit`](Self::write_tagged_implicit):
///
/// ```
/// use yasna::{self,Tag};
/// let der = yasna::construct_der(|writer| {
/// writer.write_tagged_implicit(Tag::context(3), |writer| {
/// writer.write_sequence(|writer| {
/// let writer = writer.next();
/// writer.write_i64(10)
/// })
/// })
/// });
/// assert_eq!(der, vec![163, 3, 2, 1, 10]);
/// ```
pub fn write_tagged<T, F>(mut self, tag: Tag, callback: F) -> T
where F: FnOnce(DERWriter) -> T {
self.write_identifier(tag, PCBit::Constructed);
return self.with_length(|writer| {
callback(DERWriter::from_buf(writer.buf))
});
}
/// Writes an implicitly tagged value.
///
/// # Examples
///
/// ```
/// use yasna::{self,Tag};
/// let der = yasna::construct_der(|writer| {
/// writer.write_tagged_implicit(Tag::context(3), |writer| {
/// writer.write_i64(10)
/// })
/// });
/// assert_eq!(der, vec![131, 1, 10]);
/// ```
pub fn write_tagged_implicit<T, F>
(mut self, tag: Tag, callback: F) -> T
where F: FnOnce(DERWriter) -> T {
let tag = if let Some(tag) = self.implicit_tag { tag } else { tag };
self.implicit_tag = None;
let mut writer = DERWriter::from_buf(self.buf);
writer.implicit_tag = Some(tag);
return callback(writer);
}
/// Writes the arbitrary tagged DER value in `der`.
///
/// # Examples
///
/// ```
/// use yasna;
/// use yasna::models::TaggedDerValue;
/// use yasna::tags::TAG_OCTETSTRING;
/// let tagged_der_value = TaggedDerValue::from_tag_and_bytes(TAG_OCTETSTRING, b"Hello!".to_vec());
/// let der1 = yasna::construct_der(|writer| {
/// writer.write_tagged_der(&tagged_der_value)
/// });
/// let der2 = yasna::construct_der(|writer| {
/// writer.write_bytes(b"Hello!")
/// });
/// assert_eq!(der1, der2);
/// ```
pub fn write_tagged_der(mut self, der: &TaggedDerValue) {
self.write_identifier(der.tag(), der.pcbit());
self.write_length(der.value().len());
self.buf.extend_from_slice(der.value());
}
/// Writes `&[u8]` into the DER output buffer directly. Properly encoded tag
/// and length must be included at the start of the passed buffer.
///
/// # Examples
///
/// ```
/// use yasna;
/// let raw_der = yasna::construct_der(|writer| {
/// writer.write_der(b"\x04\x06Hello!")
/// });
/// let der = yasna::construct_der(|writer| {
/// writer.write_bytes(b"Hello!")
/// });
/// assert_eq!(raw_der, der);
/// ```
pub fn write_der(self, der: &[u8]) {
self.buf.extend_from_slice(der);
}
}
/// A writer object that accepts ASN.1 values.
///
/// The main source of this object is the [`write_sequence`][write_sequence]
/// method from [`DERWriter`].
///
/// [write_sequence]: DERWriter::write_sequence
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_sequence(|writer : &mut yasna::DERWriterSeq| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// })
/// });
/// assert_eq!(der, vec![48, 6, 2, 1, 10, 1, 1, 255]);
/// ```
#[derive(Debug)]
pub struct DERWriterSeq<'a> {
buf: &'a mut Vec<u8>,
}
impl<'a> DERWriterSeq<'a> {
/// Generates a new [`DERWriter`].
pub fn next<'b>(&'b mut self) -> DERWriter<'b> {
return DERWriter::from_buf(self.buf);
}
}
/// A writer object that accepts ASN.1 values.
///
/// The main source of this object is the [`write_set`](DERWriter::write_set)
/// method from [`DERWriter`].
///
/// # Examples
///
/// ```
/// use yasna;
/// let der = yasna::construct_der(|writer| {
/// writer.write_set(|writer : &mut yasna::DERWriterSet| {
/// writer.next().write_i64(10);
/// writer.next().write_bool(true);
/// })
/// });
/// assert_eq!(der, vec![49, 6, 1, 1, 255, 2, 1, 10]);
/// ```
#[derive(Debug)]
pub struct DERWriterSet<'a> {
bufs: &'a mut Vec<Vec<u8>>,
}
impl<'a> DERWriterSet<'a> {
/// Generates a new [`DERWriter`].
pub fn next<'b>(&'b mut self) -> DERWriter<'b> {
self.bufs.push(Vec::new());
return DERWriter::from_buf(self.bufs.last_mut().unwrap());
}
}
#[cfg(test)]
mod tests;