domain/base/opt/cookie.rs
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
//! EDNS Option for DNS cookies.
//!
//! The option in this module – [`Cookie`] – is part of a simple mechanism
//! that helps DNS servers to mitigate denial-of-service and amplification
//! attacks called DNS cookies.
//!
//! In this mechanism, the client creates a client cookie and includes it in
//! its request to a server. When answering, the server generates a server
//! cookie from the client cookie and a secret and includes it in the
//! response. When the client sends subsequent queries to the same server,
//! it includes both the same client cookie as before and the server cookie
//! it received, thus identifying itself as having sent a query before.
//! Because server cookies are deterministic for a given client cookie, the
//! server doesn’t need to keep any state other than the secret.
//!
//! The DNS Cookie mechanism is defined in [RFC 7873]. Guidance for creating
//! client and server cookies is provided by [RFC 9018].
//!
//! [RFC 7873]: https://tools.ietf.org/html/rfc7873
//! [RFC 9018]: https://tools.ietf.org/html/rfc9018
use core::{fmt, hash};
use octseq::array::Array;
use octseq::builder::OctetsBuilder;
use octseq::octets::Octets;
use octseq::parse::Parser;
use crate::base::Serial;
use crate::utils::base16;
use super::super::iana::OptionCode;
use super::super::message_builder::OptBuilder;
use super::super::wire::{Composer, ParseError};
use super::{Opt, OptData, ComposeOptData, ParseOptData};
//------------ Cookie --------------------------------------------------------
/// Option data for a DNS cookie.
///
/// A value of this type carries two parts: A mandatory [`ClientCookie`] and
/// an optional [`ServerCookie`]. The client cookie is chosen by, yes, the
/// client and added to a request when contacting a specific server for the
/// first time. When responding, a server calculates a server cookie from the
/// client cookie and adds both of them to the response. The client remembers
/// both and includes them in subsequent requests. The server can now check
/// that the the server cookie was indeed calculated by it and treat the
/// repeat customer differently.
///
/// While you can create a new cookie using the [`new`][Self::new] method,
/// shortcuts are available for the standard workflow. A new initial cookie
/// can be created via [`create_initial`][Self::create_initial]. As this will
/// be a random client cookie, it needs the `rand` feature. The server can
/// check whether a received cookie includes a server cookie created by it
/// via the
#[cfg_attr(feature = "siphasher", doc = "[`check_server_hash`](Self::check_server_hash)")]
#[cfg_attr(not(feature = "siphasher"), doc = "`check_server_hash`")]
/// method. It needs the SipHash-2-4 algorithm and is thus available if the
/// `siphasher` feature is enabled. The same feature also enables the
#[cfg_attr(feature = "siphasher", doc = "[`create_response`](Self::create_response)")]
#[cfg_attr(not(feature = "siphasher"), doc = "`create_response`")]
/// method which creates the server
/// cookie to be included in a response.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "rand", derive(Default))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct Cookie {
/// The client cookie.
client: ClientCookie,
/// The optional server cookie.
server: Option<ServerCookie>,
}
impl Cookie {
/// The option code for this option.
pub(super) const CODE: OptionCode = OptionCode::COOKIE;
/// Creates a new cookie from client and optional server cookie.
#[must_use]
pub fn new(
client: ClientCookie,
server: Option<ServerCookie>
) -> Self {
Cookie { client, server }
}
/// Returns the client cookie.
#[must_use]
pub fn client(&self) -> ClientCookie {
self.client
}
/// Returns a reference to the server cookie if present.
#[must_use]
pub fn server(&self) -> Option<&ServerCookie> {
self.server.as_ref()
}
/// Parses the cookie from its wire format.
pub fn parse<Octs: AsRef<[u8]> + ?Sized>(
parser: &mut Parser<Octs>
) -> Result<Self, ParseError> {
Ok(Cookie::new(
ClientCookie::parse(parser)?,
ServerCookie::parse_opt(parser)?,
))
}
/// Returns whether the standard server cookie’s hash is correct.
///
/// The `client_ip` is the source IP address of a request. The `secret`
/// is the server cookie secret. The timestamp is checked via the
/// `timestamp_ok` closure which is given the timestamp and should return
/// whether it is acceptable.
///
/// Returns `false` if the cookie is not a server cookie, if it is but
/// not a standard server cookie, or if it is but either the timestamp
/// is not acceptable or the hash differs from what it should be.
///
/// Thus, if this method returns `false`, there is no valid server cookie
/// and the server can proceed as if there was no server cookie as
/// described in section 5.2.3 of [RFC 7873].
///
/// [RFC 7873]: https://tools.ietf.org/html/rfc7873
#[cfg(feature = "siphasher")]
pub fn check_server_hash(
&self,
client_ip: crate::base::net::IpAddr,
secret: &[u8; 16],
timestamp_ok: impl FnOnce(Serial) -> bool,
) -> bool {
self.server.as_ref().and_then(|server| {
server.try_to_standard()
}).and_then(|server| {
timestamp_ok(server.timestamp()).then_some(server)
}).map(|server| {
server.check_hash(self.client(), client_ip, secret)
}).unwrap_or(false)
}
/// Creates a random client cookie for including in an initial request.
#[cfg(feature = "rand")]
#[must_use]
pub fn create_initial() -> Self {
Self::new(ClientCookie::new_random(), None)
}
/// Creates a standard format cookie option for sending a response.
///
/// This method uses the client cookie and the additional values provided
/// to produce a cookie option that should be included in a response.
#[cfg(feature = "siphasher")]
pub fn create_response(
&self,
timestamp: Serial,
client_ip: crate::base::net::IpAddr,
secret: &[u8; 16]
) -> Self {
Self::new(
self.client,
Some(
StandardServerCookie::calculate(
self.client, timestamp, client_ip, secret
).into()
)
)
}
/// Placeholder for unnecessary octets conversion.
///
/// This method only exists for the `AllOptData` macro.
pub(super) fn try_octets_from<E>(src: Self) -> Result<Self, E> {
Ok(src)
}
}
//--- OptData
impl OptData for Cookie {
fn code(&self) -> OptionCode {
OptionCode::COOKIE
}
}
impl<'a, Octs: AsRef<[u8]> + ?Sized> ParseOptData<'a, Octs> for Cookie {
fn parse_option(
code: OptionCode,
parser: &mut Parser<'a, Octs>,
) -> Result<Option<Self>, ParseError> {
if code == OptionCode::COOKIE {
Self::parse(parser).map(Some)
}
else {
Ok(None)
}
}
}
impl ComposeOptData for Cookie {
fn compose_len(&self) -> u16 {
match self.server.as_ref() {
Some(server) => {
ClientCookie::COMPOSE_LEN.checked_add(
server.compose_len()
).expect("long server cookie")
}
None => ClientCookie::COMPOSE_LEN
}
}
fn compose_option<Target: OctetsBuilder + ?Sized>(
&self, target: &mut Target
) -> Result<(), Target::AppendError> {
self.client.compose(target)?;
if let Some(server) = self.server.as_ref() {
server.compose(target)?;
}
Ok(())
}
}
impl fmt::Display for Cookie {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(&self.client, f)?;
if let Some(server) = self.server.as_ref() {
fmt::Display::fmt(server, f)?;
}
Ok(())
}
}
//--- Extending Opt and OptBuilder
impl<Octs: Octets> Opt<Octs> {
/// Returns the first cookie option if present.
pub fn cookie(&self) -> Option<Cookie> {
self.first()
}
}
impl<'a, Target: Composer> OptBuilder<'a, Target> {
/// Appends a new cookie option.
pub fn cookie(
&mut self, cookie: Cookie,
) -> Result<(), Target::AppendError> {
self.push(&cookie)
}
/// Appends a new initial client cookie.
///
/// The appened cookie will have a random client cookie portion and no
/// server cookie. See [`Cookie`] for more information about cookies.
#[cfg(feature = "rand")]
pub fn initial_cookie(&mut self) -> Result<(), Target::AppendError> {
self.push(&Cookie::create_initial())
}
}
//------------ ClientCookie --------------------------------------------------
/// A client cookie for DNS cookies.
///
/// The client cookies consists of exactly 8 octets. It is generated by a
/// client for each server it sends queries to. It is important to use a
/// different cookie for every server so a server cannot spoof answers for
/// other servers.
///
/// Originally, it was suggested to include the client’s IP address when
/// generating the cookie, but since the address may not be known when
/// originating a request, this has been relaxed and it is now suggested that
/// the cookies is just random data. If the `rand` feature is enabled, the
/// `new`
#[cfg_attr(feature = "rand", doc = "[`new_random`][ClientCookie::new_random]")]
#[cfg_attr(not(feature = "rand"), doc = "`new_random`")]
/// constructor can be used to generate such a random cookie. Otherwise,
/// it needs to be created from the octets via
/// [`from_octets`][ClientCookie::from_octets]. Similarly, the `Default`
/// implementation will create a random cookie and is thus only available if
/// the `rand` feature is enabled.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd)]
pub struct ClientCookie([u8; 8]);
#[cfg(feature = "serde")]
impl serde::Serialize for ClientCookie {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer {
use octseq::serde::SerializeOctets;
self.0.serialize_octets(serializer)
}
}
impl ClientCookie {
/// Creates a new client cookie from the given octets.
#[must_use]
pub const fn from_octets(octets: [u8; 8]) -> Self {
Self(octets)
}
/// Creates a new random client cookie.
#[cfg(feature = "rand")]
#[must_use]
pub fn new_random() -> Self {
Self(rand::random())
}
/// Converts the cookie into its octets.
#[must_use]
pub fn into_octets(self) -> [u8; 8] {
self.0
}
/// Parses a client cookie from its wire format.
pub fn parse<Octs: AsRef<[u8]> + ?Sized>(
parser: &mut Parser<Octs>
) -> Result<Self, ParseError> {
let mut res = Self::from_octets([0; 8]);
parser.parse_buf(res.as_mut())?;
Ok(res)
}
/// The length of the wire format of a client cookie.
pub const COMPOSE_LEN: u16 = 8;
/// Appends the wire format of the client cookie to the target.
pub fn compose<Target: OctetsBuilder + ?Sized>(
&self, target: &mut Target
) -> Result<(), Target::AppendError> {
target.append_slice(&self.0)
}
}
//--- Default
#[cfg(feature = "rand")]
impl Default for ClientCookie {
fn default() -> Self {
Self::new_random()
}
}
//--- From
impl From<[u8; 8]> for ClientCookie {
fn from(src: [u8; 8]) -> Self {
Self::from_octets(src)
}
}
impl From<ClientCookie> for [u8; 8] {
fn from(src: ClientCookie) -> Self {
src.0
}
}
//--- AsRef and AsMut
impl AsRef<[u8]> for ClientCookie {
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
impl AsMut<[u8]> for ClientCookie {
fn as_mut(&mut self) -> &mut [u8] {
self.0.as_mut()
}
}
//--- Hash
impl hash::Hash for ClientCookie {
fn hash<H: hash::Hasher>(&self, state: &mut H) {
state.write(&self.0)
}
}
//--- Display
impl fmt::Display for ClientCookie {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
base16::display(self.0.as_ref(), f)
}
}
//------------ ServerCookie --------------------------------------------------
/// A server cookie for DNS cookies.
///
/// In the original specification, the server cookie was of variable length
/// between 8 and 32 octets. It was supposed to be generated via some sort
/// of message authentication code from the client cookie and a server secret.
/// Leaving the concrete mechanism to the implementer resulted in
/// interoperability problems if servers from multiple vendors were placed
/// behind the same public address. Thus, [RFC 9018] defined a standard
/// mechanism of the content and generation of the cookie.
///
/// This standard server cookie consists of a 1 octet version number
/// (currently 1), 3 reserved octets that must be zero, a 4 octet timestamp
/// as seconds since the Unix epoch, and 8 octets of hash value.
///
/// In version 1, the hash is calculated feeding the SipHash-2-4 that has been
/// initialized with a server secret the concatenation of client cookie,
/// version, reserved, timestamp, client IP address.
///
/// [RFC 9018]: https://tools.ietf.org/html/rfc9018
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ServerCookie(Array<32>);
#[cfg(feature = "serde")]
impl serde::Serialize for ServerCookie {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer {
use octseq::serde::SerializeOctets;
self.0.serialize_octets(serializer)
}
}
impl ServerCookie {
/// Creates a new server cookie from the given octets.
///
/// # Panics
///
/// The function panics if `octets` is shorter than 8 octets or longer
/// than 32.
#[must_use]
pub fn from_octets(slice: &[u8]) -> Self {
assert!(slice.len() >= 8, "server cookie shorter than 8 octets");
let mut res = Array::new();
res.append_slice(slice).expect("server cookie longer tha 32 octets");
Self(res)
}
/// Parses a server cookie from its wire format.
pub fn parse<Octs: AsRef<[u8]> + ?Sized>(
parser: &mut Parser<Octs>
) -> Result<Self, ParseError> {
if parser.remaining() < 8 {
return Err(ParseError::form_error("short server cookie"))
}
let mut res = Array::new();
res.resize_raw(parser.remaining()).map_err(|_| {
ParseError::form_error("long server cookie")
})?;
parser.parse_buf(res.as_slice_mut())?;
Ok(Self(res))
}
/// Parses an optional server cookie from its wire format.
pub fn parse_opt<Octs: AsRef<[u8]> + ?Sized>(
parser: &mut Parser<Octs>
) -> Result<Option<Self>, ParseError> {
if parser.remaining() > 0 {
Self::parse(parser).map(Some)
}
else {
Ok(None)
}
}
/// Converts the cookie into a standard cookie if possible.
///
/// This is possible if the length of the cookie is 16 octets. Returns
/// `None` otherwise.
pub fn try_to_standard(&self) -> Option<StandardServerCookie> {
TryFrom::try_from(self.0.as_slice()).map(StandardServerCookie).ok()
}
/// Returns the length of the wire format of the cookie.
#[must_use]
pub fn compose_len(&self) -> u16 {
u16::try_from(self.0.len()).expect("long server cookie")
}
/// Appends the wire format of the cookie to the target.
pub fn compose<Target: OctetsBuilder + ?Sized>(
&self, target: &mut Target
) -> Result<(), Target::AppendError> {
target.append_slice(self.0.as_ref())
}
}
//--- From
impl From<StandardServerCookie> for ServerCookie {
fn from(src: StandardServerCookie) -> Self {
Self::from_octets(&src.0)
}
}
//--- AsRef
impl AsRef<[u8]> for ServerCookie {
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
//--- Display
impl fmt::Display for ServerCookie {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
base16::display(self.0.as_ref(), f)
}
}
//------------ StandardServerCookie ------------------------------------------
/// An interoperable server cookie for DNS cookies.
///
/// In the original specification, the server cookie was of variable length
/// and rules for its generation were left to the server implementers. This
/// resulted in interoperability problems if servers from multiple vendors
/// were placed behind the same public address. Thus, [RFC 9018] defined a
/// standard mechanism of the content and generation of the cookie. This
/// type is such a standard server cookie.
///
/// This standard server cookie consists of a 1 octet version number
/// (currently 1), 3 reserved octets that must be zero, a 4 octet timestamp
/// as seconds since the Unix epoch, and 8 octets of hash value.
///
/// In version 1, the hash is calculated feeding the SipHash-2-4 that has been
/// initialized with a server secret the concatenation of client cookie,
/// version, reserved, timestamp, client IP address. Generatin and checking
/// the hash is available if the `siphasher` feature is enabled.
///
/// [RFC 9018]: https://tools.ietf.org/html/rfc9018
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct StandardServerCookie(
// We let this type wrap a u8 array so we can provide AsRef<[u8]> it.
// This makes reading the timestamp a tiny bit expensive on certain
// systems, but so be it.
[u8; 16]
);
impl StandardServerCookie {
/// Creates a new server cookie from the provided components.
#[must_use]
pub fn new(
version: u8,
reserved: [u8; 3],
timestamp: Serial,
hash: [u8; 8]
) -> Self {
let ts = timestamp.into_int().to_be_bytes();
Self(
[ version, reserved[0], reserved[1], reserved[2],
ts[0], ts[1], ts[2], ts[3],
hash[0], hash[1], hash[2], hash[3],
hash[4], hash[5], hash[6], hash[7],
]
)
}
/// Calculates the server cookie for the given components.
#[cfg(feature = "siphasher")]
pub fn calculate(
client_cookie: ClientCookie,
timestamp: Serial,
client_ip: crate::base::net::IpAddr,
secret: &[u8; 16]
) -> Self {
let mut res = Self::new(1, [0; 3], timestamp, [0; 8]);
res.set_hash(
res.calculate_hash(client_cookie, client_ip, secret)
);
res
}
/// Returns the version field of the cookie.
#[must_use]
pub fn version(self) -> u8 {
self.0[0]
}
/// Returns the reserved field of the cookie.
#[must_use]
pub fn reserved(self) -> [u8; 3] {
TryFrom::try_from(&self.0[1..4]).expect("bad slicing")
}
/// Returns the timestamp field of the cookie.
#[must_use]
pub fn timestamp(self) -> Serial {
Serial::from_be_bytes(
TryFrom::try_from(&self.0[4..8]).expect("bad slicing")
)
}
/// Returns the hash field of the cookie.
#[must_use]
pub fn hash(self) -> [u8; 8] {
TryFrom::try_from(&self.0[8..]).expect("bad slicing")
}
/// Sets the hash field to the given value.
pub fn set_hash(&mut self, hash: [u8; 8]) {
self.0[8..].copy_from_slice(&hash);
}
/// Returns whether the hash matches the given client cookie and secret.
#[cfg(feature = "siphasher")]
pub fn check_hash(
self,
client_cookie: ClientCookie,
client_ip: crate::base::net::IpAddr,
secret: &[u8; 16]
) -> bool {
self.calculate_hash(client_cookie, client_ip, secret) == self.hash()
}
/// Calculates the hash value.
///
/// The method takes the version, reserved, and timestamp fields from
/// `self` and the rest from the arguments. It returns the hash as an
/// octets array.
//
// XXX The hash implementation for SipHash-2-4 returns the result as
// a `u64` whereas RFC 9018 assumes it is returned as an octets array in
// a standard ordering. Somewhat surprisingly, this ordering turns out to
// be little endian.
#[cfg(feature = "siphasher")]
fn calculate_hash(
self,
client_cookie: ClientCookie,
client_ip: crate::base::net::IpAddr,
secret: &[u8; 16]
) -> [u8; 8] {
use core::hash::{Hash, Hasher};
use crate::base::net::IpAddr;
let mut hasher = siphasher::sip::SipHasher24::new_with_key(secret);
client_cookie.hash(&mut hasher);
hasher.write(&self.0[..8]);
match client_ip {
IpAddr::V4(addr) => hasher.write(&addr.octets()),
IpAddr::V6(addr) => hasher.write(&addr.octets()),
}
hasher.finish().to_le_bytes()
}
}
//--- Display
impl fmt::Display for StandardServerCookie {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
base16::display(self.0.as_ref(), f)
}
}
//============ Tests =========================================================
#[cfg(test)]
mod test {
#[allow(unused_imports)]
use super::*;
/// Tests from Appendix A of RFC 9018.
#[cfg(all(feature = "siphasher", feature = "std"))]
mod standard_server {
use crate::base::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use crate::base::wire::{compose_vec, parse_slice};
use super::*;
const CLIENT_1: IpAddr = IpAddr::V4(Ipv4Addr::new(198, 51, 100, 100));
const CLIENT_2: IpAddr = IpAddr::V4(Ipv4Addr::new(203, 0, 113, 203));
const CLIENT_6: IpAddr = IpAddr::V6(Ipv6Addr::new(
0x2001, 0xdb8, 0x220, 0x1, 0x59de, 0xd0f4, 0x8769, 0x82b8
));
const SECRET: [u8; 16] = [
0xe5, 0xe9, 0x73, 0xe5, 0xa6, 0xb2, 0xa4, 0x3f,
0x48, 0xe7, 0xdc, 0x84, 0x9e, 0x37, 0xbf, 0xcf,
];
/// A.1. Learning a New Server Cookie
#[test]
fn new_cookie() {
let request = Cookie::new(
ClientCookie::from_octets(
[ 0x24, 0x64, 0xc4, 0xab, 0xcf, 0x10, 0xc9, 0x57 ]
),
None
);
assert_eq!(
compose_vec(|vec| request.compose_option(vec)),
base16::decode_vec("2464c4abcf10c957").unwrap()
);
assert_eq!(
compose_vec(|vec| {
request.create_response(
Serial(1559731985), CLIENT_1, &SECRET
).compose_option(vec)
}),
base16::decode_vec(
"2464c4abcf10c957010000005cf79f111f8130c3eee29480"
).unwrap()
);
}
/// A.2. The Same Client Learning a Renewed (Fresh) Server Cookie
#[test]
fn renew_cookie() {
let request = parse_slice(
&base16::decode_vec(
"2464c4abcf10c957010000005cf79f111f8130c3eee29480"
).unwrap(),
Cookie::parse
).unwrap();
assert!(
request.check_server_hash(
CLIENT_1, &SECRET,
|serial| serial == Serial(1559731985)
)
);
assert_eq!(
compose_vec(|vec| {
request.create_response(
Serial(1559734385), CLIENT_1, &SECRET
).compose_option(vec)
}),
base16::decode_vec(
"2464c4abcf10c957010000005cf7a871d4a564a1442aca77"
).unwrap()
);
}
/// A.3. Another Client Learning a Renewed Server Cookie
#[test]
fn non_zero_reserved() {
let request = parse_slice(
&base16::decode_vec(
"fc93fc62807ddb8601abcdef5cf78f71a314227b6679ebf5"
).unwrap(),
Cookie::parse
).unwrap();
assert!(
request.check_server_hash(
CLIENT_2, &SECRET,
|serial| serial == Serial(1559727985)
)
);
assert_eq!(
compose_vec(|vec| {
request.create_response(
Serial(1559734700), CLIENT_2, &SECRET
).compose_option(vec)
}),
base16::decode_vec(
"fc93fc62807ddb86010000005cf7a9acf73a7810aca2381e"
).unwrap()
);
}
/// A.4. IPv6 Query with Rolled Over Secret
#[test]
fn new_secret() {
const OLD_SECRET: [u8; 16] = [
0xdd, 0x3b, 0xdf, 0x93, 0x44, 0xb6, 0x78, 0xb1,
0x85, 0xa6, 0xf5, 0xcb, 0x60, 0xfc, 0xa7, 0x15,
];
const NEW_SECRET: [u8; 16] = [
0x44, 0x55, 0x36, 0xbc, 0xd2, 0x51, 0x32, 0x98,
0x07, 0x5a, 0x5d, 0x37, 0x96, 0x63, 0xc9, 0x62,
];
let request = parse_slice(
&base16::decode_vec(
"22681ab97d52c298010000005cf7c57926556bd0934c72f8"
).unwrap(),
Cookie::parse
).unwrap();
assert!(
!request.check_server_hash(
CLIENT_6, &NEW_SECRET,
|serial| serial == Serial(1559741817)
)
);
assert!(
request.check_server_hash(
CLIENT_6, &OLD_SECRET,
|serial| serial == Serial(1559741817)
)
);
assert_eq!(
compose_vec(|vec| {
request.create_response(
Serial(1559741961), CLIENT_6, &NEW_SECRET
).compose_option(vec)
}),
base16::decode_vec(
"22681ab97d52c298010000005cf7c609a6bb79d16625507a"
).unwrap()
);
}
}
}