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
use crate::ber::*; use crate::error::*; use nom::bytes::complete::take; use nom::combinator::{all_consuming, complete, cut, map}; use nom::error::ParseError; use nom::multi::many0; use nom::{Err, IResult}; /// Parse a SEQUENCE OF object /// /// Given a subparser for a BER type, parse a sequence of identical objects. /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_sequence_of, BerObject}; /// # use der_parser::error::BerResult; /// # /// /// Read a SEQUENCE OF INTEGER /// fn parser(i:&[u8]) -> BerResult<BerObject> { /// parse_ber_sequence_of(parse_ber_integer)(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_seq(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]); /// # assert_eq!(parser(&bytes), Ok((empty, expected))); /// let (rem, v) = parser(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_sequence_of<'a, F>(f: F) -> impl FnMut(&'a [u8]) -> BerResult where F: Fn(&'a [u8]) -> BerResult, { map(parse_ber_sequence_of_v(f), BerObject::from_seq) } /// Parse a SEQUENCE OF object (returning a vec) /// /// Given a subparser for a BER type, parse a sequence of identical objects. /// /// This differs from `parse_ber_sequence_of` in the parse function and return type. /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_sequence_of_v, BerObject}; /// # use der_parser::error::BerResult; /// # /// /// Read a SEQUENCE OF INTEGER /// fn parser(i:&[u8]) -> BerResult<Vec<BerObject>> { /// parse_ber_sequence_of_v(parse_ber_integer)(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]; /// let (rem, v) = parser(&bytes).expect("parsing failed"); /// # assert_eq!(v, expected); /// ``` pub fn parse_ber_sequence_of_v<'a, T, F, E>( f: F, ) -> impl FnMut(&'a [u8]) -> IResult<&'a [u8], Vec<T>, E> where F: FnMut(&'a [u8]) -> IResult<&'a [u8], T, E>, E: ParseError<&'a [u8]> + From<BerError>, { let mut subparser = all_consuming(many0(complete(cut(f)))); parse_ber_sequence_defined_g(move |data, _| subparser(data)) } /// Parse a defined sequence of DER elements (function version) /// /// Given a list of expected parsers, apply them to build a DER sequence and /// return the remaining bytes and the built object. /// /// The remaining bytes point *after* the sequence: any bytes that are part of the sequence but not /// parsed are ignored. /// /// The object header is not available to the parsing function, and the returned type is always a /// `BerObject`. /// For a generic version, see /// [`parse_ber_sequence_defined_g`](fn.parse_ber_sequence_defined_g.html). /// /// # Examples /// /// Parsing a sequence of identical types (same as `parse_ber_sequence_of`): /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_sequence_defined, BerObject}; /// # use der_parser::error::BerResult; /// use nom::combinator::complete; /// use nom::multi::many1; /// /// fn localparse_seq(i:&[u8]) -> BerResult { /// parse_ber_sequence_defined( /// many1(complete(parse_ber_integer)) /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_seq(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]); /// # assert_eq!(localparse_seq(&bytes), Ok((empty, expected))); /// let (rem, v) = localparse_seq(&bytes).expect("parsing failed"); /// ``` /// /// Parsing a defined sequence with different types: /// /// ```rust /// # use der_parser::ber::*; /// # use der_parser::error::BerResult; /// use nom::combinator::map; /// use nom::sequence::tuple; /// /// /// Read a DER-encoded object: /// /// SEQUENCE { /// /// a INTEGER, /// /// b OCTETSTRING /// /// } /// fn localparse_seq(i:&[u8]) -> BerResult { /// parse_ber_sequence_defined( /// // the nom `tuple` combinator returns a tuple, so we have to map it /// // to a list /// map( /// tuple((parse_ber_integer, parse_ber_octetstring)), /// |(a, b)| vec![a, b] /// ) /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x04, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_seq(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_obj(BerObjectContent::OctetString(b"\x01\x00\x00")), /// # ]); /// # assert_eq!(localparse_seq(&bytes), Ok((empty, expected))); /// let (rem, v) = localparse_seq(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_sequence_defined<'a, F>(mut f: F) -> impl FnMut(&'a [u8]) -> BerResult where F: FnMut(&'a [u8]) -> BerResult<Vec<BerObject>>, { map( parse_ber_sequence_defined_g(move |data, _| f(data)), BerObject::from_seq, ) } /// Parse a defined SEQUENCE object (generic function) /// /// Given a parser for sequence content, apply it to build a DER sequence and /// return the remaining bytes and the built object. /// /// The remaining bytes point *after* the sequence: any bytes that are part of the sequence but not /// parsed are ignored. /// /// Unlike `parse_ber_sequence_defined`, this function allows returning any object or error type, /// and also passes the object header to the callback. /// /// # Examples /// /// Parsing a defined sequence with different types: /// /// ```rust /// # use der_parser::ber::*; /// # use der_parser::error::BerResult; /// # /// # #[derive(Debug, PartialEq)] /// pub struct MyObject<'a> { /// a: u32, /// b: &'a [u8], /// } /// /// /// Read a DER-encoded object: /// /// SEQUENCE { /// /// a INTEGER (0..4294967295), /// /// b OCTETSTRING /// /// } /// fn parse_myobject(i: &[u8]) -> BerResult<MyObject> { /// parse_ber_sequence_defined_g( /// |i:&[u8], _| { /// let (i, a) = parse_ber_u32(i)?; /// let (i, obj) = parse_ber_octetstring(i)?; /// let b = obj.as_slice().unwrap(); /// Ok((i, MyObject{ a, b })) /// } /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x04, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = MyObject { /// # a: 0x010001, /// # b: &[01, 00, 00] /// # }; /// # assert_eq!(parse_myobject(&bytes), Ok((empty, expected))); /// let (rem, v) = parse_myobject(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_sequence_defined_g<'a, O, F, E>( mut f: F, ) -> impl FnMut(&'a [u8]) -> IResult<&'a [u8], O, E> where F: FnMut(&'a [u8], BerObjectHeader<'a>) -> IResult<&'a [u8], O, E>, E: ParseError<&'a [u8]> + From<BerError>, { parse_ber_container(move |i, hdr| { if hdr.tag != BerTag::Sequence { return Err(Err::Error(BerError::InvalidTag.into())); } f(i, hdr) }) } /// Parse a SET OF object /// /// Given a subparser for a BER type, parse a set of identical objects. /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_set_of, BerObject}; /// # use der_parser::error::BerResult; /// # /// /// Read a SET OF INTEGER /// fn parser(i:&[u8]) -> BerResult<BerObject> { /// parse_ber_set_of(parse_ber_integer)(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x31, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_set(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]); /// # assert_eq!(parser(&bytes), Ok((empty, expected))); /// let (rem, v) = parser(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_set_of<'a, F>(f: F) -> impl FnMut(&'a [u8]) -> BerResult where F: Fn(&'a [u8]) -> BerResult, { map(parse_ber_set_of_v(f), BerObject::from_set) } /// Parse a SET OF object (returning a vec) /// /// Given a subparser for a BER type, parse a set of identical objects. /// /// This differs from `parse_ber_set_of` in the parse function and return type. /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_set_of_v, BerObject}; /// # use der_parser::error::BerResult; /// # /// /// Read a SET OF INTEGER /// fn parser(i:&[u8]) -> BerResult<Vec<BerObject>> { /// parse_ber_set_of_v(parse_ber_integer)(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x31, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]; /// let (rem, v) = parser(&bytes).expect("parsing failed"); /// # assert_eq!(v, expected); /// ``` pub fn parse_ber_set_of_v<'a, T, F, E>(f: F) -> impl FnMut(&'a [u8]) -> IResult<&'a [u8], Vec<T>, E> where F: FnMut(&'a [u8]) -> IResult<&'a [u8], T, E>, E: ParseError<&'a [u8]> + From<BerError>, { let mut subparser = all_consuming(many0(complete(cut(f)))); parse_ber_set_defined_g(move |data, _| subparser(data)) } /// Parse a defined set of DER elements (function version) /// /// Given a list of expected parsers, apply them to build a DER set and /// return the remaining bytes and the built object. /// /// The remaining bytes point *after* the set: any bytes that are part of the sequence but not /// parsed are ignored. /// The nom combinator `all_consuming` can be used to ensure all the content is parsed. /// /// The object header is not available to the parsing function, and the returned type is always a /// `BerObject`. /// For a generic version, see [`parse_ber_set_defined_g`](fn.parse_ber_set_defined_g.html). /// /// # Examples /// /// Parsing a set of identical types (same as `parse_ber_set_of`): /// /// ```rust /// # use der_parser::ber::{parse_ber_integer, parse_ber_set_defined, BerObject}; /// # use der_parser::error::BerResult; /// use nom::combinator::complete; /// use nom::multi::many1; /// /// fn localparse_seq(i:&[u8]) -> BerResult { /// parse_ber_set_defined( /// many1(complete(parse_ber_integer)) /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x31, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x02, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_set(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_int_slice(b"\x01\x00\x00"), /// # ]); /// # assert_eq!(localparse_seq(&bytes), Ok((empty, expected))); /// let (rem, v) = localparse_seq(&bytes).expect("parsing failed"); /// ``` /// /// Parsing a defined set with different types: /// /// ```rust /// # use der_parser::ber::*; /// # use der_parser::error::BerResult; /// use nom::combinator::map; /// use nom::sequence::tuple; /// /// /// Read a DER-encoded object: /// /// SET { /// /// a INTEGER, /// /// b OCTETSTRING /// /// } /// fn localparse_set(i:&[u8]) -> BerResult { /// parse_ber_set_defined( /// // the nom `tuple` combinator returns a tuple, so we have to map it /// // to a list /// map( /// tuple((parse_ber_integer, parse_ber_octetstring)), /// |(a, b)| vec![a, b] /// ) /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x31, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x04, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = BerObject::from_set(vec![ /// # BerObject::from_int_slice(b"\x01\x00\x01"), /// # BerObject::from_obj(BerObjectContent::OctetString(b"\x01\x00\x00")), /// # ]); /// # assert_eq!(localparse_set(&bytes), Ok((empty, expected))); /// let (rem, v) = localparse_set(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_set_defined<'a, F>(mut f: F) -> impl FnMut(&'a [u8]) -> BerResult where F: FnMut(&'a [u8]) -> BerResult<Vec<BerObject>>, { map( parse_ber_set_defined_g(move |data, _| f(data)), BerObject::from_set, ) } /// Parse a defined SET object (generic version) /// /// Given a parser for set content, apply it to build a DER set and /// return the remaining bytes and the built object. /// /// The remaining bytes point *after* the set: any bytes that are part of the sequence but not /// parsed are ignored. /// The nom combinator `all_consuming` can be used to ensure all the content is parsed. /// /// Unlike `parse_ber_set_defined`, this function allows returning any object or error type, /// and also passes the object header to the callback. /// /// # Examples /// /// Parsing a defined set with different types: /// /// ```rust /// # use der_parser::ber::*; /// # use der_parser::error::BerResult; /// # /// # #[derive(Debug, PartialEq)] /// pub struct MyObject<'a> { /// a: u32, /// b: &'a [u8], /// } /// /// /// Read a DER-encoded object: /// /// SET { /// /// a INTEGER (0..4294967295), /// /// b OCTETSTRING /// /// } /// fn parse_myobject(i: &[u8]) -> BerResult<MyObject> { /// parse_ber_set_defined_g( /// |i:&[u8], _| { /// let (i, a) = parse_ber_u32(i)?; /// let (i, obj) = parse_ber_octetstring(i)?; /// let b = obj.as_slice().unwrap(); /// Ok((i, MyObject{ a, b })) /// } /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x31, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x04, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = MyObject { /// # a: 0x010001, /// # b: &[01, 00, 00] /// # }; /// # assert_eq!(parse_myobject(&bytes), Ok((empty, expected))); /// let (rem, v) = parse_myobject(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_set_defined_g<'a, O, F, E>( mut f: F, ) -> impl FnMut(&'a [u8]) -> IResult<&'a [u8], O, E> where F: FnMut(&'a [u8], BerObjectHeader<'a>) -> IResult<&'a [u8], O, E>, E: ParseError<&'a [u8]> + From<BerError>, { parse_ber_container(move |i, hdr| { if hdr.tag != BerTag::Set { return Err(Err::Error(BerError::InvalidTag.into())); } f(i, hdr) }) } /// Parse a BER object and apply provided function to content /// /// Given a parser for content, read BER object header and apply parser to /// return the remaining bytes and the parser result. /// /// The remaining bytes point *after* the content: any bytes that are part of the content but not /// parsed are ignored. /// The nom combinator `all_consuming` can be used to ensure all the content is parsed. /// /// This function is mostly intended for structured objects, but can be used for any valid BER /// object. /// /// # Examples /// /// Parsing a defined sequence with different types: /// /// ```rust /// # use der_parser::ber::*; /// # use der_parser::error::{BerError, BerResult}; /// # /// # #[derive(Debug, PartialEq)] /// pub struct MyObject<'a> { /// a: u32, /// b: &'a [u8], /// } /// /// /// Read a DER-encoded object: /// /// SEQUENCE { /// /// a INTEGER (0..4294967295), /// /// b OCTETSTRING /// /// } /// fn parse_myobject(i: &[u8]) -> BerResult<MyObject> { /// parse_ber_container( /// |i: &[u8], hdr: BerObjectHeader| { /// if hdr.tag != BerTag::Sequence { /// return Err(nom::Err::Error(BerError::BerTypeError.into())); /// } /// let (i, a) = parse_ber_u32(i)?; /// let (i, obj) = parse_ber_octetstring(i)?; /// let b = obj.as_slice().unwrap(); /// Ok((i, MyObject{ a, b })) /// } /// )(i) /// } /// /// # let empty = &b""[..]; /// # let bytes = [ 0x30, 0x0a, /// # 0x02, 0x03, 0x01, 0x00, 0x01, /// # 0x04, 0x03, 0x01, 0x00, 0x00, /// # ]; /// # let expected = MyObject { /// # a: 0x010001, /// # b: &[01, 00, 00] /// # }; /// # assert_eq!(parse_myobject(&bytes), Ok((empty, expected))); /// let (rem, v) = parse_myobject(&bytes).expect("parsing failed"); /// ``` pub fn parse_ber_container<'a, O, F, E>(mut f: F) -> impl FnMut(&'a [u8]) -> IResult<&'a [u8], O, E> where F: FnMut(&'a [u8], BerObjectHeader<'a>) -> IResult<&'a [u8], O, E>, E: ParseError<&'a [u8]> + From<BerError>, { move |i: &[u8]| { let (i, hdr) = ber_read_element_header(i).map_err(nom::Err::convert)?; let (i, data) = match hdr.len { BerSize::Definite(len) => take(len)(i)?, BerSize::Indefinite => { ber_get_object_content(i, &hdr, MAX_RECURSION).map_err(nom::Err::convert)? } }; let (_rest, v) = f(data, hdr)?; Ok((i, v)) } }