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
use super::{Class, Header, Length, Tag};
use crate::ber::ber_read_element_content_as;
use crate::ber::bitstring_to_u64;
use crate::ber::integer::*;
use crate::ber::MAX_RECURSION;
use crate::error::BerError;
use crate::oid::Oid;
use alloc::borrow::ToOwned;
use alloc::boxed::Box;
use alloc::vec::Vec;
use asn1_rs::ASN1DateTime;
use asn1_rs::Any;
#[cfg(feature = "bitvec")]
use bitvec::{order::Msb0, slice::BitSlice};
use core::convert::AsRef;
use core::convert::From;
use core::convert::TryFrom;
use core::ops::Index;
/// Representation of a BER-encoded (X.690) object
///
/// A BER object is composed of a header describing the object class, type and length,
/// and the content.
///
/// Note that the content may sometimes not match the header tag (for ex when parsing IMPLICIT
/// tagged values).
#[derive(Debug, Clone, PartialEq)]
pub struct BerObject<'a> {
pub header: Header<'a>,
pub content: BerObjectContent<'a>,
}
/// BER object content
#[derive(Debug, Clone, PartialEq)]
#[allow(clippy::upper_case_acronyms)]
pub enum BerObjectContent<'a> {
/// EOC (no content)
EndOfContent,
/// BOOLEAN: decoded value
Boolean(bool),
/// INTEGER: raw bytes
///
/// Note: the reason to store the raw bytes is that integers have non-finite length in the
/// spec, and also that the raw encoding is also important for some applications.
///
/// To extract the number, see the `as_u64`, `as_u32`, `as_bigint` and `as_biguint` methods.
Integer(&'a [u8]),
/// BIT STRING: number of unused bits, and object
BitString(u8, BitStringObject<'a>),
/// OCTET STRING: slice
OctetString(&'a [u8]),
/// NULL (no content)
Null,
/// ENUMERATED: decoded enum number
Enum(u64),
/// OID
OID(Oid<'a>),
/// RELATIVE OID
RelativeOID(Oid<'a>),
/// NumericString: decoded string
NumericString(&'a str),
/// VisibleString: decoded string
VisibleString(&'a str),
/// PrintableString: decoded string
PrintableString(&'a str),
/// IA5String: decoded string
IA5String(&'a str),
/// UTF8String: decoded string
UTF8String(&'a str),
/// T61String: decoded string
T61String(&'a str),
/// VideotexString: decoded string
VideotexString(&'a str),
/// BmpString: decoded string
BmpString(&'a str),
/// UniversalString: raw object bytes
UniversalString(&'a [u8]),
/// SEQUENCE: list of objects
Sequence(Vec<BerObject<'a>>),
/// SET: list of objects
Set(Vec<BerObject<'a>>),
/// UTCTime: decoded string
UTCTime(ASN1DateTime),
/// GeneralizedTime: decoded string
GeneralizedTime(ASN1DateTime),
/// Object descriptor: decoded string
ObjectDescriptor(&'a str),
/// GraphicString: decoded string
GraphicString(&'a str),
/// GeneralString: decoded string
GeneralString(&'a str),
/// Optional object
Optional(Option<Box<BerObject<'a>>>),
/// Tagged object (EXPLICIT): class, tag and content of inner object
Tagged(Class, Tag, Box<BerObject<'a>>),
/// Private or Unknown (for ex. unknown tag) object
Unknown(Any<'a>),
}
impl<'a> BerObject<'a> {
/// Build a BerObject from a header and content.
///
/// Note: values are not checked, so the tag can be different from the real content, or flags
/// can be invalid.
#[inline]
pub const fn from_header_and_content<'o>(
header: Header<'o>,
content: BerObjectContent<'o>,
) -> BerObject<'o> {
BerObject { header, content }
}
/// Build a BerObject from its content, using default flags (no class, correct tag,
/// and constructed flag set only for Set and Sequence)
pub const fn from_obj(c: BerObjectContent) -> BerObject {
let class = Class::Universal;
let tag = c.tag();
let constructed = matches!(tag, Tag::Sequence | Tag::Set);
let header = Header::new(class, constructed, tag, Length::Definite(0));
BerObject { header, content: c }
}
/// Build a DER integer object from a slice containing an encoded integer
pub const fn from_int_slice(i: &'a [u8]) -> BerObject<'a> {
let header = Header::new(Class::Universal, false, Tag::Integer, Length::Definite(0));
BerObject {
header,
content: BerObjectContent::Integer(i),
}
}
/// Set a tag for the BER object
pub fn set_raw_tag(self, raw_tag: Option<&'a [u8]>) -> BerObject {
let header = self.header.with_raw_tag(raw_tag.map(|x| x.into()));
BerObject { header, ..self }
}
/// Build a DER sequence object from a vector of DER objects
pub const fn from_seq(l: Vec<BerObject>) -> BerObject {
BerObject::from_obj(BerObjectContent::Sequence(l))
}
/// Build a DER set object from a vector of DER objects
pub const fn from_set(l: Vec<BerObject>) -> BerObject {
BerObject::from_obj(BerObjectContent::Set(l))
}
/// Attempt to read a signed integer value from DER object.
///
/// This can fail if the object is not an integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x80");
/// assert_eq!(
/// der_int.as_i64(),
/// Ok(-128)
/// );
/// ```
pub fn as_i64(&self) -> Result<i64, BerError> {
self.content.as_i64()
}
/// Attempt to read a signed integer value from DER object.
///
/// This can fail if the object is not an integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x80");
/// assert_eq!(
/// der_int.as_i32(),
/// Ok(-128)
/// );
/// ```
pub fn as_i32(&self) -> Result<i32, BerError> {
self.content.as_i32()
}
/// Attempt to read integer value from DER object.
///
/// This can fail if the object is not an unsigned integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x01\x00\x01");
/// assert_eq!(
/// der_int.as_u64(),
/// Ok(0x10001)
/// );
/// ```
pub fn as_u64(&self) -> Result<u64, BerError> {
self.content.as_u64()
}
/// Attempt to read integer value from DER object.
///
/// This can fail if the object is not an unsigned integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # extern crate der_parser;
/// # use der_parser::ber::{BerObject,BerObjectContent};
/// let der_int = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
/// assert_eq!(
/// der_int.as_u32(),
/// Ok(0x10001)
/// );
/// ```
pub fn as_u32(&self) -> Result<u32, BerError> {
self.content.as_u32()
}
/// Attempt to read integer value from DER object.
/// This can fail if the object is not a boolean.
pub fn as_bool(&self) -> Result<bool, BerError> {
self.content.as_bool()
}
/// Attempt to read an OID value from DER object.
/// This can fail if the object is not an OID.
pub fn as_oid(&self) -> Result<&Oid<'a>, BerError> {
self.content.as_oid()
}
/// Attempt to read an OID value from DER object.
/// This can fail if the object is not an OID.
pub fn as_oid_val(&self) -> Result<Oid<'a>, BerError> {
self.content.as_oid_val()
}
/// Attempt to get a reference on the content from an optional object.
/// This can fail if the object is not optional.
pub fn as_optional(&self) -> Result<Option<&BerObject<'a>>, BerError> {
self.content.as_optional()
}
/// Attempt to get a reference on the content from a tagged object.
/// This can fail if the object is not tagged.
pub fn as_tagged(&self) -> Result<(Class, Tag, &BerObject<'a>), BerError> {
self.content.as_tagged()
}
/// Attempt to read a reference to a BitString value from DER object.
/// This can fail if the object is not an BitString.
///
/// Note that this function returns a reference to the BitString. To get an owned value,
/// use [`as_bitstring`](struct.BerObject.html#method.as_bitstring)
pub fn as_bitstring_ref(&self) -> Result<&BitStringObject, BerError> {
self.content.as_bitstring_ref()
}
/// Attempt to read a BitString value from DER object.
/// This can fail if the object is not an BitString.
pub fn as_bitstring(&self) -> Result<BitStringObject<'a>, BerError> {
self.content.as_bitstring()
}
/// Constructs a shared `&BitSlice` reference over the object data, if available as slice.
#[cfg(feature = "bitvec")]
pub fn as_bitslice(&self) -> Result<&BitSlice<Msb0, u8>, BerError> {
self.content.as_bitslice()
}
/// Attempt to extract the list of objects from a DER sequence.
/// This can fail if the object is not a sequence.
pub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError> {
self.content.as_sequence()
}
/// Attempt to extract the list of objects from a DER set.
/// This can fail if the object is not a set.
pub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError> {
self.content.as_set()
}
/// Attempt to get the content from a DER object, as a slice.
/// This can fail if the object does not contain a type directly equivalent to a slice (e.g a
/// sequence).
/// This function mostly concerns string types, integers, or unknown DER objects.
pub fn as_slice(&self) -> Result<&'a [u8], BerError> {
self.content.as_slice()
}
/// Attempt to get the content from a DER object, as a str.
/// This can fail if the object does not contain a string type.
///
/// Only some string types are considered here. Other
/// string types can be read using `as_slice`.
pub fn as_str(&self) -> Result<&'a str, BerError> {
self.content.as_str()
}
/// Get the BER object header's class.
#[inline]
pub const fn class(&self) -> Class {
self.header.class()
}
/// Get the BER object header's tag.
#[inline]
pub const fn tag(&self) -> Tag {
self.header.tag()
}
/// Get the BER object header's length.
#[inline]
pub const fn length(&self) -> Length {
self.header.length()
}
/// Test if object class is Universal
#[inline]
pub const fn is_universal(&self) -> bool {
self.header.is_universal()
}
/// Test if object class is Application
#[inline]
pub const fn is_application(&self) -> bool {
self.header.is_application()
}
/// Test if object class is Context-specific
#[inline]
pub const fn is_contextspecific(&self) -> bool {
self.header.is_contextspecific()
}
/// Test if object class is Private
#[inline]
pub fn is_private(&self) -> bool {
self.header.is_private()
}
/// Test if object is primitive
#[inline]
pub const fn is_primitive(&self) -> bool {
self.header.is_primitive()
}
/// Test if object is constructed
#[inline]
pub const fn is_constructed(&self) -> bool {
self.header.is_constructed()
}
/// Return error if `class` is not the expected class
#[inline]
pub const fn assert_class(&self, class: Class) -> Result<(), BerError> {
self.header.assert_class(class)
}
/// Return error if `tag` is not the expected tag
#[inline]
pub const fn assert_tag(&self, tag: Tag) -> Result<(), BerError> {
self.header.assert_tag(tag)
}
/// Return error if object is not constructed
#[inline]
pub const fn assert_constructed(&self) -> Result<(), BerError> {
self.header.assert_constructed()
}
/// Return error if object is not primitive
#[inline]
pub const fn assert_primitive(&self) -> Result<(), BerError> {
self.header.assert_primitive()
}
}
/// Build a DER object from an OID.
impl<'a> From<Oid<'a>> for BerObject<'a> {
fn from(oid: Oid<'a>) -> BerObject<'a> {
BerObject::from_obj(BerObjectContent::OID(oid))
}
}
/// Build a DER object from a BerObjectContent.
impl<'a> From<BerObjectContent<'a>> for BerObject<'a> {
fn from(obj: BerObjectContent<'a>) -> BerObject<'a> {
BerObject::from_obj(obj)
}
}
impl<'a> BerObjectContent<'a> {
/// Attempt to read a signed integer value from this object.
///
/// This can fail if the object is not an integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x80");
/// assert_eq!(
/// der_int.as_i64(),
/// Ok(-128)
/// );
/// ```
pub fn as_i64(&self) -> Result<i64, BerError> {
if let BerObjectContent::Integer(bytes) = self {
let result = if is_highest_bit_set(bytes) {
<i64>::from_be_bytes(decode_array_int8(bytes)?)
} else {
<u64>::from_be_bytes(decode_array_uint8(bytes)?) as i64
};
Ok(result)
} else {
Err(BerError::BerValueError)
}
}
/// Attempt to read a signed integer value from this object.
///
/// This can fail if the object is not an integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x80");
/// assert_eq!(
/// der_int.as_i32(),
/// Ok(-128)
/// );
/// ```
pub fn as_i32(&self) -> Result<i32, BerError> {
if let BerObjectContent::Integer(bytes) = self {
let result = if is_highest_bit_set(bytes) {
<i32>::from_be_bytes(decode_array_int4(bytes)?)
} else {
<u32>::from_be_bytes(decode_array_uint4(bytes)?) as i32
};
Ok(result)
} else {
Err(BerError::BerValueError)
}
}
/// Attempt to read integer value from this object.
///
/// This can fail if the object is not an unsigned integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # use der_parser::ber::BerObject;
/// let der_int = BerObject::from_int_slice(b"\x01\x00\x01");
/// assert_eq!(
/// der_int.as_u64(),
/// Ok(0x10001)
/// );
/// ```
pub fn as_u64(&self) -> Result<u64, BerError> {
match self {
BerObjectContent::Integer(i) => {
let result = <u64>::from_be_bytes(decode_array_uint8(i)?);
Ok(result)
}
BerObjectContent::BitString(ignored_bits, data) => {
bitstring_to_u64(*ignored_bits as usize, data)
}
BerObjectContent::Enum(i) => Ok(*i),
_ => Err(BerError::BerTypeError),
}
}
/// Attempt to read integer value from this object.
///
/// This can fail if the object is not an unsigned integer, or if it is too large.
///
/// # Examples
///
/// ```rust
/// # extern crate der_parser;
/// # use der_parser::ber::{BerObject,BerObjectContent};
/// let der_int = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
/// assert_eq!(
/// der_int.as_u32(),
/// Ok(0x10001)
/// );
/// ```
pub fn as_u32(&self) -> Result<u32, BerError> {
match self {
BerObjectContent::Integer(i) => {
let result = <u32>::from_be_bytes(decode_array_uint4(i)?);
Ok(result)
}
BerObjectContent::BitString(ignored_bits, data) => {
bitstring_to_u64(*ignored_bits as usize, data).and_then(|x| {
if x > u64::from(core::u32::MAX) {
Err(BerError::IntegerTooLarge)
} else {
Ok(x as u32)
}
})
}
BerObjectContent::Enum(i) => {
if *i > u64::from(core::u32::MAX) {
Err(BerError::IntegerTooLarge)
} else {
Ok(*i as u32)
}
}
_ => Err(BerError::BerTypeError),
}
}
pub fn as_bool(&self) -> Result<bool, BerError> {
match *self {
BerObjectContent::Boolean(b) => Ok(b),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_oid(&self) -> Result<&Oid<'a>, BerError> {
match *self {
BerObjectContent::OID(ref o) => Ok(o),
BerObjectContent::RelativeOID(ref o) => Ok(o),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_oid_val(&self) -> Result<Oid<'a>, BerError> {
self.as_oid().map(|o| o.clone())
}
pub fn as_optional(&self) -> Result<Option<&BerObject<'a>>, BerError> {
match *self {
BerObjectContent::Optional(Some(ref o)) => Ok(Some(o)),
BerObjectContent::Optional(None) => Ok(None),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_tagged(&self) -> Result<(Class, Tag, &BerObject<'a>), BerError> {
match *self {
BerObjectContent::Tagged(class, tag, ref o) => Ok((class, tag, o.as_ref())),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_bitstring_ref(&self) -> Result<&BitStringObject, BerError> {
match *self {
BerObjectContent::BitString(_, ref b) => Ok(b),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_bitstring(&self) -> Result<BitStringObject<'a>, BerError> {
match *self {
BerObjectContent::BitString(_, ref b) => Ok(b.to_owned()),
_ => Err(BerError::BerTypeError),
}
}
/// Constructs a shared `&BitSlice` reference over the object data, if available as slice.
#[cfg(feature = "bitvec")]
pub fn as_bitslice(&self) -> Result<&BitSlice<Msb0, u8>, BerError> {
self.as_slice()
.and_then(|s| BitSlice::<Msb0, _>::from_slice(s).map_err(|_| BerError::BerValueError))
}
pub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError> {
match *self {
BerObjectContent::Sequence(ref s) => Ok(s),
_ => Err(BerError::BerTypeError),
}
}
pub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError> {
match *self {
BerObjectContent::Set(ref s) => Ok(s),
_ => Err(BerError::BerTypeError),
}
}
#[rustfmt::skip]
pub fn as_slice(&self) -> Result<&'a [u8],BerError> {
match *self {
BerObjectContent::NumericString(s) |
BerObjectContent::BmpString(s) |
BerObjectContent::VisibleString(s) |
BerObjectContent::PrintableString(s) |
BerObjectContent::GeneralString(s) |
BerObjectContent::ObjectDescriptor(s) |
BerObjectContent::GraphicString(s) |
BerObjectContent::T61String(s) |
BerObjectContent::VideotexString(s) |
BerObjectContent::UTF8String(s) |
BerObjectContent::IA5String(s) => Ok(s.as_ref()),
BerObjectContent::Integer(s) |
BerObjectContent::BitString(_,BitStringObject{data:s}) |
BerObjectContent::OctetString(s) |
BerObjectContent::UniversalString(s) => Ok(s),
BerObjectContent::Unknown(ref any) => Ok(any.data),
_ => Err(BerError::BerTypeError),
}
}
#[rustfmt::skip]
pub fn as_str(&self) -> Result<&'a str,BerError> {
match *self {
BerObjectContent::NumericString(s) |
BerObjectContent::BmpString(s) |
BerObjectContent::VisibleString(s) |
BerObjectContent::PrintableString(s) |
BerObjectContent::GeneralString(s) |
BerObjectContent::ObjectDescriptor(s) |
BerObjectContent::GraphicString(s) |
BerObjectContent::T61String(s) |
BerObjectContent::VideotexString(s) |
BerObjectContent::UTF8String(s) |
BerObjectContent::IA5String(s) => Ok(s),
_ => Err(BerError::BerTypeError),
}
}
#[rustfmt::skip]
const fn tag(&self) -> Tag {
match self {
BerObjectContent::EndOfContent => Tag::EndOfContent,
BerObjectContent::Boolean(_) => Tag::Boolean,
BerObjectContent::Integer(_) => Tag::Integer,
BerObjectContent::BitString(_,_) => Tag::BitString,
BerObjectContent::OctetString(_) => Tag::OctetString,
BerObjectContent::Null => Tag::Null,
BerObjectContent::Enum(_) => Tag::Enumerated,
BerObjectContent::OID(_) => Tag::Oid,
BerObjectContent::NumericString(_) => Tag::NumericString,
BerObjectContent::VisibleString(_) => Tag::VisibleString,
BerObjectContent::PrintableString(_) => Tag::PrintableString,
BerObjectContent::IA5String(_) => Tag::Ia5String,
BerObjectContent::UTF8String(_) => Tag::Utf8String,
BerObjectContent::RelativeOID(_) => Tag::RelativeOid,
BerObjectContent::T61String(_) => Tag::T61String,
BerObjectContent::VideotexString(_) => Tag::VideotexString,
BerObjectContent::BmpString(_) => Tag::BmpString,
BerObjectContent::UniversalString(_) => Tag::UniversalString,
BerObjectContent::Sequence(_) => Tag::Sequence,
BerObjectContent::Set(_) => Tag::Set,
BerObjectContent::UTCTime(_) => Tag::UtcTime,
BerObjectContent::GeneralizedTime(_) => Tag::GeneralizedTime,
BerObjectContent::ObjectDescriptor(_) => Tag::ObjectDescriptor,
BerObjectContent::GraphicString(_) => Tag::GraphicString,
BerObjectContent::GeneralString(_) => Tag::GeneralString,
BerObjectContent::Tagged(_,x,_) => *x,
BerObjectContent::Unknown(any) => any.tag(),
BerObjectContent::Optional(Some(obj)) => obj.content.tag(),
BerObjectContent::Optional(None) => Tag(0x00), // XXX invalid !
}
}
}
#[cfg(feature = "bigint")]
#[cfg_attr(docsrs, doc(cfg(feature = "bigint")))]
use num_bigint::{BigInt, BigUint};
#[cfg(feature = "bigint")]
#[cfg_attr(docsrs, doc(cfg(feature = "bigint")))]
impl<'a> BerObject<'a> {
/// Attempt to read an integer value from this object.
///
/// This can fail if the object is not an integer.
///
/// # Examples
///
/// ```rust
/// use der_parser::ber::*;
///
/// let data = &[0x02, 0x03, 0x01, 0x00, 0x01];
///
/// let (_, object) = parse_ber_integer(data).expect("parsing failed");
/// # #[cfg(feature = "bigint")]
/// assert_eq!(object.as_bigint(), Ok(65537.into()))
/// ```
pub fn as_bigint(&self) -> Result<BigInt, BerError> {
match self.content {
BerObjectContent::Integer(s) => Ok(BigInt::from_signed_bytes_be(s)),
_ => Err(BerError::BerValueError),
}
}
/// Attempt to read a positive integer value from this object.
///
/// This can fail if the object is not an integer, or is negative.
///
/// # Examples
///
/// ```rust
/// use der_parser::ber::*;
///
/// let data = &[0x02, 0x03, 0x01, 0x00, 0x01];
///
/// let (_, object) = parse_ber_integer(data).expect("parsing failed");
/// # #[cfg(feature = "bigint")]
/// assert_eq!(object.as_biguint(), Ok(65537_u32.into()))
/// ```
pub fn as_biguint(&self) -> Result<BigUint, BerError> {
match self.content {
BerObjectContent::Integer(s) => {
if is_highest_bit_set(s) {
return Err(BerError::IntegerNegative);
}
Ok(BigUint::from_bytes_be(s))
}
_ => Err(BerError::BerValueError),
}
}
}
impl<'a> TryFrom<Any<'a>> for BerObject<'a> {
type Error = asn1_rs::Error;
fn try_from(any: Any<'a>) -> Result<Self, Self::Error> {
let (header, data) = (any.header, any.data);
let (_, content) = ber_read_element_content_as(
data,
header.tag(),
header.length(),
header.constructed(),
MAX_RECURSION,
)?;
let obj = BerObject::from_header_and_content(header, content);
Ok(obj)
}
}
impl<'a, 'b> TryFrom<&'b Any<'a>> for BerObject<'a> {
type Error = asn1_rs::Error;
fn try_from(any: &'b Any<'a>) -> Result<Self, Self::Error> {
let (header, data) = (any.header.clone(), any.data);
let (_, content) = ber_read_element_content_as(
data,
header.tag(),
header.length(),
header.constructed(),
MAX_RECURSION,
)?;
let obj = BerObject::from_header_and_content(header, content);
Ok(obj)
}
}
// This is a consuming iterator
impl<'a> IntoIterator for BerObject<'a> {
type Item = BerObject<'a>;
type IntoIter = BerObjectIntoIterator<'a>;
fn into_iter(self) -> Self::IntoIter {
// match self {
// BerObjectContent::Sequence(ref v) => (),
// _ => (),
// };
BerObjectIntoIterator { val: self, idx: 0 }
}
}
#[derive(Debug)]
pub struct BerObjectIntoIterator<'a> {
val: BerObject<'a>,
idx: usize,
}
impl<'a> Iterator for BerObjectIntoIterator<'a> {
type Item = BerObject<'a>;
fn next(&mut self) -> Option<BerObject<'a>> {
// let result = if self.idx < self.vec.len() {
// Some(self.vec[self.idx].clone())
// } else {
// None
// };
let res = match self.val.content {
BerObjectContent::Sequence(ref v) if self.idx < v.len() => Some(v[self.idx].clone()),
BerObjectContent::Set(ref v) if self.idx < v.len() => Some(v[self.idx].clone()),
_ => {
if self.idx == 0 {
Some(self.val.clone())
} else {
None
}
}
};
self.idx += 1;
res
}
}
// impl<'a> Iterator for BerObjectContent<'a> {
// type Item = BerObjectContent<'a>;
//
// fn next(&mut self) -> Option<BerObjectContent<'a>> {
// None
// }
// }
#[derive(Debug)]
pub struct BerObjectRefIterator<'a> {
obj: &'a BerObject<'a>,
idx: usize,
}
impl<'a> Iterator for BerObjectRefIterator<'a> {
type Item = &'a BerObject<'a>;
fn next(&mut self) -> Option<&'a BerObject<'a>> {
let res = match (self.obj).content {
BerObjectContent::Sequence(ref v) if self.idx < v.len() => Some(&v[self.idx]),
BerObjectContent::Set(ref v) if self.idx < v.len() => Some(&v[self.idx]),
_ => None,
};
self.idx += 1;
res
}
}
impl<'a> BerObject<'a> {
pub fn ref_iter(&'a self) -> BerObjectRefIterator<'a> {
BerObjectRefIterator { obj: self, idx: 0 }
}
}
impl<'a> Index<usize> for BerObject<'a> {
type Output = BerObject<'a>;
fn index(&self, idx: usize) -> &BerObject<'a> {
match (self).content {
BerObjectContent::Sequence(ref v) if idx < v.len() => &v[idx],
BerObjectContent::Set(ref v) if idx < v.len() => &v[idx],
_ => panic!("Try to index BerObjectContent which is not constructed"),
}
// XXX the following
// self.ref_iter().nth(idx).unwrap()
// fails with:
// error: cannot infer an appropriate lifetime for autoref due to conflicting requirements [E0495]
// self.ref_iter().nth(idx).unwrap()
}
}
/// BitString wrapper
#[derive(Clone, Debug, PartialEq)]
pub struct BitStringObject<'a> {
pub data: &'a [u8],
}
impl<'a> BitStringObject<'a> {
/// Test if bit `bitnum` is set
pub fn is_set(&self, bitnum: usize) -> bool {
let byte_pos = bitnum / 8;
if byte_pos >= self.data.len() {
return false;
}
let b = 7 - (bitnum % 8);
(self.data[byte_pos] & (1 << b)) != 0
}
/// Constructs a shared `&BitSlice` reference over the object data.
#[cfg(feature = "bitvec")]
pub fn as_bitslice(&self) -> Option<&BitSlice<Msb0, u8>> {
BitSlice::<Msb0, _>::from_slice(self.data).ok()
}
}
impl<'a> AsRef<[u8]> for BitStringObject<'a> {
fn as_ref(&self) -> &[u8] {
self.data
}
}
#[cfg(test)]
mod tests {
use asn1_rs::{Any, FromDer};
use core::convert::TryFrom;
use crate::ber::*;
use crate::oid::*;
#[test]
fn ber_from_any() {
let bytes = &[0x02, 0x03, 0x01, 0x00, 0x01];
let (rem, any) = Any::from_der(bytes).expect("parsing failed");
assert!(rem.is_empty());
let obj = BerObject::try_from(any).expect("try_from(any) failed");
assert_eq!(obj.as_u32(), Ok(0x10001_u32));
}
#[test]
fn test_der_as_u64() {
let der_obj = BerObject::from_int_slice(b"\x01\x00\x02");
assert_eq!(der_obj.as_u64(), Ok(0x10002));
}
#[test]
fn test_ber_as_u64_bitstring() {
let (_, ber_obj) = parse_ber_bitstring(b"\x03\x04\x06\x6e\x5d\xc0").unwrap();
assert_eq!(ber_obj.as_u64(), Ok(0b011011100101110111));
let (_, ber_obj_with_nonzero_padding) =
parse_ber_bitstring(b"\x03\x04\x06\x6e\x5d\xe0").unwrap();
assert_eq!(
ber_obj_with_nonzero_padding.as_u64(),
Ok(0b011011100101110111)
);
}
#[test]
fn test_der_seq_iter() {
let der_obj = BerObject::from_obj(BerObjectContent::Sequence(vec![
BerObject::from_int_slice(b"\x01\x00\x01"),
BerObject::from_int_slice(b"\x01\x00\x00"),
]));
let expected_values = vec![
BerObject::from_int_slice(b"\x01\x00\x01"),
BerObject::from_int_slice(b"\x01\x00\x00"),
];
for (idx, v) in der_obj.ref_iter().enumerate() {
// println!("v: {:?}", v);
assert_eq!((*v), expected_values[idx]);
}
}
#[test]
fn test_der_from_oid() {
let obj: BerObject = Oid::from(&[1, 2]).unwrap().into();
let expected = BerObject::from_obj(BerObjectContent::OID(Oid::from(&[1, 2]).unwrap()));
assert_eq!(obj, expected);
}
#[test]
fn test_der_bitstringobject() {
let obj = BitStringObject {
data: &[0x0f, 0x00, 0x40],
};
assert!(!obj.is_set(0));
assert!(obj.is_set(7));
assert!(!obj.is_set(9));
assert!(obj.is_set(17));
}
#[cfg(feature = "bitvec")]
#[test]
fn test_der_bitslice() {
use std::string::String;
let obj = BitStringObject {
data: &[0x0f, 0x00, 0x40],
};
let slice = obj.as_bitslice().expect("as_bitslice");
assert_eq!(slice.get(0).as_deref(), Some(&false));
assert_eq!(slice.get(7).as_deref(), Some(&true));
assert_eq!(slice.get(9).as_deref(), Some(&false));
assert_eq!(slice.get(17).as_deref(), Some(&true));
let s = slice.iter().fold(String::with_capacity(24), |mut acc, b| {
acc += if *b { "1" } else { "0" };
acc
});
assert_eq!(&s, "000011110000000001000000");
}
#[test]
fn test_der_bistringobject_asref() {
fn assert_equal<T: AsRef<[u8]>>(s: T, b: &[u8]) {
assert_eq!(s.as_ref(), b);
}
let b: &[u8] = &[0x0f, 0x00, 0x40];
let obj = BitStringObject { data: b };
assert_equal(obj, b);
}
#[cfg(feature = "bigint")]
#[test]
fn test_der_to_bigint() {
let obj = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
let expected = ::num_bigint::BigInt::from(0x10001);
assert_eq!(obj.as_bigint(), Ok(expected));
}
#[cfg(feature = "bigint")]
#[test]
fn test_der_to_biguint() {
let obj = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
let expected = ::num_bigint::BigUint::from(0x10001_u32);
assert_eq!(obj.as_biguint(), Ok(expected));
}
}