rustls/error.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
use alloc::format;
use alloc::string::String;
use alloc::vec::Vec;
use core::fmt;
#[cfg(feature = "std")]
use std::time::SystemTimeError;
use crate::enums::{AlertDescription, ContentType, HandshakeType};
use crate::msgs::handshake::{EchConfigPayload, KeyExchangeAlgorithm};
use crate::rand;
/// rustls reports protocol errors using this type.
#[non_exhaustive]
#[derive(Debug, PartialEq, Clone)]
pub enum Error {
/// We received a TLS message that isn't valid right now.
/// `expect_types` lists the message types we can expect right now.
/// `got_type` is the type we found. This error is typically
/// caused by a buggy TLS stack (the peer or this one), a broken
/// network, or an attack.
InappropriateMessage {
/// Which types we expected
expect_types: Vec<ContentType>,
/// What type we received
got_type: ContentType,
},
/// We received a TLS handshake message that isn't valid right now.
/// `expect_types` lists the handshake message types we can expect
/// right now. `got_type` is the type we found.
InappropriateHandshakeMessage {
/// Which handshake type we expected
expect_types: Vec<HandshakeType>,
/// What handshake type we received
got_type: HandshakeType,
},
/// An error occurred while handling Encrypted Client Hello (ECH).
InvalidEncryptedClientHello(EncryptedClientHelloError),
/// The peer sent us a TLS message with invalid contents.
InvalidMessage(InvalidMessage),
/// The peer didn't give us any certificates.
NoCertificatesPresented,
/// The certificate verifier doesn't support the given type of name.
UnsupportedNameType,
/// We couldn't decrypt a message. This is invariably fatal.
DecryptError,
/// We couldn't encrypt a message because it was larger than the allowed message size.
/// This should never happen if the application is using valid record sizes.
EncryptError,
/// The peer doesn't support a protocol version/feature we require.
/// The parameter gives a hint as to what version/feature it is.
PeerIncompatible(PeerIncompatible),
/// The peer deviated from the standard TLS protocol.
/// The parameter gives a hint where.
PeerMisbehaved(PeerMisbehaved),
/// We received a fatal alert. This means the peer is unhappy.
AlertReceived(AlertDescription),
/// We saw an invalid certificate.
///
/// The contained error is from the certificate validation trait
/// implementation.
InvalidCertificate(CertificateError),
/// A provided certificate revocation list (CRL) was invalid.
InvalidCertRevocationList(CertRevocationListError),
/// A catch-all error for unlikely errors.
General(String),
/// We failed to figure out what time it currently is.
FailedToGetCurrentTime,
/// We failed to acquire random bytes from the system.
FailedToGetRandomBytes,
/// This function doesn't work until the TLS handshake
/// is complete.
HandshakeNotComplete,
/// The peer sent an oversized record/fragment.
PeerSentOversizedRecord,
/// An incoming connection did not support any known application protocol.
NoApplicationProtocol,
/// The `max_fragment_size` value supplied in configuration was too small,
/// or too large.
BadMaxFragmentSize,
/// Specific failure cases from [`keys_match`] or a [`crate::crypto::signer::SigningKey`] that cannot produce a corresponding public key.
///
/// [`keys_match`]: crate::crypto::signer::CertifiedKey::keys_match
InconsistentKeys(InconsistentKeys),
/// Any other error.
///
/// This variant should only be used when the error is not better described by a more
/// specific variant. For example, if a custom crypto provider returns a
/// provider specific error.
///
/// Enums holding this variant will never compare equal to each other.
Other(OtherError),
}
/// Specific failure cases from [`keys_match`] or a [`crate::crypto::signer::SigningKey`] that cannot produce a corresponding public key.
///
/// [`keys_match`]: crate::crypto::signer::CertifiedKey::keys_match
#[non_exhaustive]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum InconsistentKeys {
/// The public key returned by the [`SigningKey`] does not match the public key information in the certificate.
///
/// [`SigningKey`]: crate::crypto::signer::SigningKey
KeyMismatch,
/// The [`SigningKey`] cannot produce its corresponding public key.
///
/// [`SigningKey`]: crate::crypto::signer::SigningKey
Unknown,
}
impl From<InconsistentKeys> for Error {
#[inline]
fn from(e: InconsistentKeys) -> Self {
Self::InconsistentKeys(e)
}
}
/// A corrupt TLS message payload that resulted in an error.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum InvalidMessage {
/// A certificate payload exceeded rustls's 64KB limit
CertificatePayloadTooLarge,
/// An advertised message was larger then expected.
HandshakePayloadTooLarge,
/// The peer sent us a syntactically incorrect ChangeCipherSpec payload.
InvalidCcs,
/// An unknown content type was encountered during message decoding.
InvalidContentType,
/// A peer sent an invalid certificate status type
InvalidCertificateStatusType,
/// Context was incorrectly attached to a certificate request during a handshake.
InvalidCertRequest,
/// A peer's DH params could not be decoded
InvalidDhParams,
/// A message was zero-length when its record kind forbids it.
InvalidEmptyPayload,
/// A peer sent an unexpected key update request.
InvalidKeyUpdate,
/// A peer's server name could not be decoded
InvalidServerName,
/// A TLS message payload was larger then allowed by the specification.
MessageTooLarge,
/// Message is shorter than the expected length
MessageTooShort,
/// Missing data for the named handshake payload value
MissingData(&'static str),
/// A peer did not advertise its supported key exchange groups.
MissingKeyExchange,
/// A peer sent an empty list of signature schemes
NoSignatureSchemes,
/// Trailing data found for the named handshake payload value
TrailingData(&'static str),
/// A peer sent an unexpected message type.
UnexpectedMessage(&'static str),
/// An unknown TLS protocol was encountered during message decoding.
UnknownProtocolVersion,
/// A peer sent a non-null compression method.
UnsupportedCompression,
/// A peer sent an unknown elliptic curve type.
UnsupportedCurveType,
/// A peer sent an unsupported key exchange algorithm.
UnsupportedKeyExchangeAlgorithm(KeyExchangeAlgorithm),
}
impl From<InvalidMessage> for Error {
#[inline]
fn from(e: InvalidMessage) -> Self {
Self::InvalidMessage(e)
}
}
#[non_exhaustive]
#[allow(missing_docs)]
#[derive(Debug, PartialEq, Clone)]
/// The set of cases where we failed to make a connection because we thought
/// the peer was misbehaving.
///
/// This is `non_exhaustive`: we might add or stop using items here in minor
/// versions. We also don't document what they mean. Generally a user of
/// rustls shouldn't vary its behaviour on these error codes, and there is
/// nothing it can do to improve matters.
///
/// Please file a bug against rustls if you see `Error::PeerMisbehaved` in
/// the wild.
pub enum PeerMisbehaved {
AttemptedDowngradeToTls12WhenTls13IsSupported,
BadCertChainExtensions,
DisallowedEncryptedExtension,
DuplicateClientHelloExtensions,
DuplicateEncryptedExtensions,
DuplicateHelloRetryRequestExtensions,
DuplicateNewSessionTicketExtensions,
DuplicateServerHelloExtensions,
DuplicateServerNameTypes,
EarlyDataAttemptedInSecondClientHello,
EarlyDataExtensionWithoutResumption,
EarlyDataOfferedWithVariedCipherSuite,
HandshakeHashVariedAfterRetry,
IllegalHelloRetryRequestWithEmptyCookie,
IllegalHelloRetryRequestWithNoChanges,
IllegalHelloRetryRequestWithOfferedGroup,
IllegalHelloRetryRequestWithUnofferedCipherSuite,
IllegalHelloRetryRequestWithUnofferedNamedGroup,
IllegalHelloRetryRequestWithUnsupportedVersion,
IllegalHelloRetryRequestWithWrongSessionId,
IllegalHelloRetryRequestWithInvalidEch,
IllegalMiddleboxChangeCipherSpec,
IllegalTlsInnerPlaintext,
IncorrectBinder,
InvalidCertCompression,
InvalidMaxEarlyDataSize,
InvalidKeyShare,
KeyEpochWithPendingFragment,
KeyUpdateReceivedInQuicConnection,
MessageInterleavedWithHandshakeMessage,
MissingBinderInPskExtension,
MissingKeyShare,
MissingPskModesExtension,
MissingQuicTransportParameters,
OfferedDuplicateCertificateCompressions,
OfferedDuplicateKeyShares,
OfferedEarlyDataWithOldProtocolVersion,
OfferedEmptyApplicationProtocol,
OfferedIncorrectCompressions,
PskExtensionMustBeLast,
PskExtensionWithMismatchedIdsAndBinders,
RefusedToFollowHelloRetryRequest,
RejectedEarlyDataInterleavedWithHandshakeMessage,
ResumptionAttemptedWithVariedEms,
ResumptionOfferedWithVariedCipherSuite,
ResumptionOfferedWithVariedEms,
ResumptionOfferedWithIncompatibleCipherSuite,
SelectedDifferentCipherSuiteAfterRetry,
SelectedInvalidPsk,
SelectedTls12UsingTls13VersionExtension,
SelectedUnofferedApplicationProtocol,
SelectedUnofferedCertCompression,
SelectedUnofferedCipherSuite,
SelectedUnofferedCompression,
SelectedUnofferedKxGroup,
SelectedUnofferedPsk,
SelectedUnusableCipherSuiteForVersion,
ServerHelloMustOfferUncompressedEcPoints,
ServerNameDifferedOnRetry,
ServerNameMustContainOneHostName,
SignedKxWithWrongAlgorithm,
SignedHandshakeWithUnadvertisedSigScheme,
TooManyEmptyFragments,
TooManyKeyUpdateRequests,
TooManyRenegotiationRequests,
TooManyWarningAlertsReceived,
TooMuchEarlyDataReceived,
UnexpectedCleartextExtension,
UnsolicitedCertExtension,
UnsolicitedEncryptedExtension,
UnsolicitedSctList,
UnsolicitedServerHelloExtension,
WrongGroupForKeyShare,
UnsolicitedEchExtension,
}
impl From<PeerMisbehaved> for Error {
#[inline]
fn from(e: PeerMisbehaved) -> Self {
Self::PeerMisbehaved(e)
}
}
#[non_exhaustive]
#[allow(missing_docs)]
#[derive(Debug, PartialEq, Clone)]
/// The set of cases where we failed to make a connection because a peer
/// doesn't support a TLS version/feature we require.
///
/// This is `non_exhaustive`: we might add or stop using items here in minor
/// versions.
pub enum PeerIncompatible {
EcPointsExtensionRequired,
ExtendedMasterSecretExtensionRequired,
IncorrectCertificateTypeExtension,
KeyShareExtensionRequired,
NamedGroupsExtensionRequired,
NoCertificateRequestSignatureSchemesInCommon,
NoCipherSuitesInCommon,
NoEcPointFormatsInCommon,
NoKxGroupsInCommon,
NoSignatureSchemesInCommon,
NullCompressionRequired,
ServerDoesNotSupportTls12Or13,
ServerSentHelloRetryRequestWithUnknownExtension,
ServerTlsVersionIsDisabledByOurConfig,
SignatureAlgorithmsExtensionRequired,
SupportedVersionsExtensionRequired,
Tls12NotOffered,
Tls12NotOfferedOrEnabled,
Tls13RequiredForQuic,
UncompressedEcPointsRequired,
UnsolicitedCertificateTypeExtension,
ServerRejectedEncryptedClientHello(Option<Vec<EchConfigPayload>>),
}
impl From<PeerIncompatible> for Error {
#[inline]
fn from(e: PeerIncompatible) -> Self {
Self::PeerIncompatible(e)
}
}
#[non_exhaustive]
#[derive(Debug, Clone)]
/// The ways in which certificate validators can express errors.
///
/// Note that the rustls TLS protocol code interprets specifically these
/// error codes to send specific TLS alerts. Therefore, if a
/// custom certificate validator uses incorrect errors the library as
/// a whole will send alerts that do not match the standard (this is usually
/// a minor issue, but could be misleading).
pub enum CertificateError {
/// The certificate is not correctly encoded.
BadEncoding,
/// The current time is after the `notAfter` time in the certificate.
Expired,
/// The current time is before the `notBefore` time in the certificate.
NotValidYet,
/// The certificate has been revoked.
Revoked,
/// The certificate contains an extension marked critical, but it was
/// not processed by the certificate validator.
UnhandledCriticalExtension,
/// The certificate chain is not issued by a known root certificate.
UnknownIssuer,
/// The certificate's revocation status could not be determined.
UnknownRevocationStatus,
/// The certificate's revocation status could not be determined, because the CRL is expired.
ExpiredRevocationList,
/// A certificate is not correctly signed by the key of its alleged
/// issuer.
BadSignature,
/// The subject names in an end-entity certificate do not include
/// the expected name.
NotValidForName,
/// The certificate is being used for a different purpose than allowed.
InvalidPurpose,
/// The certificate is valid, but the handshake is rejected for other
/// reasons.
ApplicationVerificationFailure,
/// Any other error.
///
/// This can be used by custom verifiers to expose the underlying error
/// (where they are not better described by the more specific errors
/// above).
///
/// It is also used by the default verifier in case its error is
/// not covered by the above common cases.
///
/// Enums holding this variant will never compare equal to each other.
Other(OtherError),
}
impl PartialEq<Self> for CertificateError {
fn eq(&self, other: &Self) -> bool {
use CertificateError::*;
#[allow(clippy::match_like_matches_macro)]
match (self, other) {
(BadEncoding, BadEncoding) => true,
(Expired, Expired) => true,
(NotValidYet, NotValidYet) => true,
(Revoked, Revoked) => true,
(UnhandledCriticalExtension, UnhandledCriticalExtension) => true,
(UnknownIssuer, UnknownIssuer) => true,
(BadSignature, BadSignature) => true,
(NotValidForName, NotValidForName) => true,
(InvalidPurpose, InvalidPurpose) => true,
(ApplicationVerificationFailure, ApplicationVerificationFailure) => true,
(ExpiredRevocationList, ExpiredRevocationList) => true,
_ => false,
}
}
}
// The following mapping are heavily referenced in:
// * [OpenSSL Implementation](https://github.com/openssl/openssl/blob/45bb98bfa223efd3258f445ad443f878011450f0/ssl/statem/statem_lib.c#L1434)
// * [BoringSSL Implementation](https://github.com/google/boringssl/blob/583c60bd4bf76d61b2634a58bcda99a92de106cb/ssl/ssl_x509.cc#L1323)
impl From<CertificateError> for AlertDescription {
fn from(e: CertificateError) -> Self {
use CertificateError::*;
match e {
BadEncoding | UnhandledCriticalExtension | NotValidForName => Self::BadCertificate,
// RFC 5246/RFC 8446
// certificate_expired
// A certificate has expired or **is not currently valid**.
Expired | NotValidYet => Self::CertificateExpired,
Revoked => Self::CertificateRevoked,
// OpenSSL, BoringSSL and AWS-LC all generate an Unknown CA alert for
// the case where revocation status can not be determined, so we do the same here.
UnknownIssuer | UnknownRevocationStatus | ExpiredRevocationList => Self::UnknownCA,
BadSignature => Self::DecryptError,
InvalidPurpose => Self::UnsupportedCertificate,
ApplicationVerificationFailure => Self::AccessDenied,
// RFC 5246/RFC 8446
// certificate_unknown
// Some other (unspecified) issue arose in processing the
// certificate, rendering it unacceptable.
Other(..) => Self::CertificateUnknown,
}
}
}
impl From<CertificateError> for Error {
#[inline]
fn from(e: CertificateError) -> Self {
Self::InvalidCertificate(e)
}
}
#[non_exhaustive]
#[derive(Debug, Clone)]
/// The ways in which a certificate revocation list (CRL) can be invalid.
pub enum CertRevocationListError {
/// The CRL had a bad, or unsupported signature from its issuer.
BadSignature,
/// The CRL contained an invalid CRL number.
InvalidCrlNumber,
/// The CRL contained a revoked certificate with an invalid serial number.
InvalidRevokedCertSerialNumber,
/// The CRL issuer does not specify the cRLSign key usage.
IssuerInvalidForCrl,
/// The CRL is invalid for some other reason.
///
/// Enums holding this variant will never compare equal to each other.
Other(OtherError),
/// The CRL is not correctly encoded.
ParseError,
/// The CRL is not a v2 X.509 CRL.
UnsupportedCrlVersion,
/// The CRL, or a revoked certificate in the CRL, contained an unsupported critical extension.
UnsupportedCriticalExtension,
/// The CRL is an unsupported delta CRL, containing only changes relative to another CRL.
UnsupportedDeltaCrl,
/// The CRL is an unsupported indirect CRL, containing revoked certificates issued by a CA
/// other than the issuer of the CRL.
UnsupportedIndirectCrl,
/// The CRL contained a revoked certificate with an unsupported revocation reason.
/// See RFC 5280 Section 5.3.1[^1] for a list of supported revocation reasons.
///
/// [^1]: <https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1>
UnsupportedRevocationReason,
}
impl PartialEq<Self> for CertRevocationListError {
fn eq(&self, other: &Self) -> bool {
use CertRevocationListError::*;
#[allow(clippy::match_like_matches_macro)]
match (self, other) {
(BadSignature, BadSignature) => true,
(InvalidCrlNumber, InvalidCrlNumber) => true,
(InvalidRevokedCertSerialNumber, InvalidRevokedCertSerialNumber) => true,
(IssuerInvalidForCrl, IssuerInvalidForCrl) => true,
(ParseError, ParseError) => true,
(UnsupportedCrlVersion, UnsupportedCrlVersion) => true,
(UnsupportedCriticalExtension, UnsupportedCriticalExtension) => true,
(UnsupportedDeltaCrl, UnsupportedDeltaCrl) => true,
(UnsupportedIndirectCrl, UnsupportedIndirectCrl) => true,
(UnsupportedRevocationReason, UnsupportedRevocationReason) => true,
_ => false,
}
}
}
impl From<CertRevocationListError> for Error {
#[inline]
fn from(e: CertRevocationListError) -> Self {
Self::InvalidCertRevocationList(e)
}
}
#[non_exhaustive]
#[derive(Debug, Clone, Eq, PartialEq)]
/// An error that occurred while handling Encrypted Client Hello (ECH).
pub enum EncryptedClientHelloError {
/// The provided ECH configuration list was invalid.
InvalidConfigList,
/// No compatible ECH configuration.
NoCompatibleConfig,
/// The client configuration has server name indication (SNI) disabled.
SniRequired,
}
impl From<EncryptedClientHelloError> for Error {
#[inline]
fn from(e: EncryptedClientHelloError) -> Self {
Self::InvalidEncryptedClientHello(e)
}
}
fn join<T: fmt::Debug>(items: &[T]) -> String {
items
.iter()
.map(|x| format!("{:?}", x))
.collect::<Vec<String>>()
.join(" or ")
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Self::InappropriateMessage {
ref expect_types,
ref got_type,
} => write!(
f,
"received unexpected message: got {:?} when expecting {}",
got_type,
join::<ContentType>(expect_types)
),
Self::InappropriateHandshakeMessage {
ref expect_types,
ref got_type,
} => write!(
f,
"received unexpected handshake message: got {:?} when expecting {}",
got_type,
join::<HandshakeType>(expect_types)
),
Self::InvalidMessage(ref typ) => {
write!(f, "received corrupt message of type {:?}", typ)
}
Self::PeerIncompatible(ref why) => write!(f, "peer is incompatible: {:?}", why),
Self::PeerMisbehaved(ref why) => write!(f, "peer misbehaved: {:?}", why),
Self::AlertReceived(ref alert) => write!(f, "received fatal alert: {:?}", alert),
Self::InvalidCertificate(ref err) => {
write!(f, "invalid peer certificate: {:?}", err)
}
Self::InvalidCertRevocationList(ref err) => {
write!(f, "invalid certificate revocation list: {:?}", err)
}
Self::NoCertificatesPresented => write!(f, "peer sent no certificates"),
Self::UnsupportedNameType => write!(f, "presented server name type wasn't supported"),
Self::DecryptError => write!(f, "cannot decrypt peer's message"),
Self::InvalidEncryptedClientHello(ref err) => {
write!(f, "encrypted client hello failure: {:?}", err)
}
Self::EncryptError => write!(f, "cannot encrypt message"),
Self::PeerSentOversizedRecord => write!(f, "peer sent excess record size"),
Self::HandshakeNotComplete => write!(f, "handshake not complete"),
Self::NoApplicationProtocol => write!(f, "peer doesn't support any known protocol"),
Self::FailedToGetCurrentTime => write!(f, "failed to get current time"),
Self::FailedToGetRandomBytes => write!(f, "failed to get random bytes"),
Self::BadMaxFragmentSize => {
write!(f, "the supplied max_fragment_size was too small or large")
}
Self::InconsistentKeys(ref why) => {
write!(f, "keys may not be consistent: {:?}", why)
}
Self::General(ref err) => write!(f, "unexpected error: {}", err),
Self::Other(ref err) => write!(f, "other error: {}", err),
}
}
}
#[cfg(feature = "std")]
impl From<SystemTimeError> for Error {
#[inline]
fn from(_: SystemTimeError) -> Self {
Self::FailedToGetCurrentTime
}
}
#[cfg(feature = "std")]
impl std::error::Error for Error {}
impl From<rand::GetRandomFailed> for Error {
fn from(_: rand::GetRandomFailed) -> Self {
Self::FailedToGetRandomBytes
}
}
mod other_error {
#[cfg(feature = "std")]
use alloc::sync::Arc;
use core::fmt;
#[cfg(feature = "std")]
use std::error::Error as StdError;
use super::Error;
/// Any other error that cannot be expressed by a more specific [`Error`] variant.
///
/// For example, an `OtherError` could be produced by a custom crypto provider
/// exposing a provider specific error.
///
/// Enums holding this type will never compare equal to each other.
#[derive(Debug, Clone)]
pub struct OtherError(#[cfg(feature = "std")] pub Arc<dyn StdError + Send + Sync>);
impl PartialEq<Self> for OtherError {
fn eq(&self, _other: &Self) -> bool {
false
}
}
impl From<OtherError> for Error {
fn from(value: OtherError) -> Self {
Self::Other(value)
}
}
impl fmt::Display for OtherError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
#[cfg(feature = "std")]
{
write!(f, "{}", self.0)
}
#[cfg(not(feature = "std"))]
{
f.write_str("no further information available")
}
}
}
#[cfg(feature = "std")]
impl StdError for OtherError {
fn source(&self) -> Option<&(dyn StdError + 'static)> {
Some(self.0.as_ref())
}
}
}
pub use other_error::OtherError;
#[cfg(test)]
mod tests {
use std::prelude::v1::*;
use std::{println, vec};
use super::{CertRevocationListError, Error, InconsistentKeys, InvalidMessage, OtherError};
#[test]
fn certificate_error_equality() {
use super::CertificateError::*;
assert_eq!(BadEncoding, BadEncoding);
assert_eq!(Expired, Expired);
assert_eq!(NotValidYet, NotValidYet);
assert_eq!(Revoked, Revoked);
assert_eq!(UnhandledCriticalExtension, UnhandledCriticalExtension);
assert_eq!(UnknownIssuer, UnknownIssuer);
assert_eq!(BadSignature, BadSignature);
assert_eq!(NotValidForName, NotValidForName);
assert_eq!(InvalidPurpose, InvalidPurpose);
assert_eq!(
ApplicationVerificationFailure,
ApplicationVerificationFailure
);
let other = Other(OtherError(
#[cfg(feature = "std")]
alloc::sync::Arc::from(Box::from("")),
));
assert_ne!(other, other);
assert_ne!(BadEncoding, Expired);
}
#[test]
fn crl_error_equality() {
use super::CertRevocationListError::*;
assert_eq!(BadSignature, BadSignature);
assert_eq!(InvalidCrlNumber, InvalidCrlNumber);
assert_eq!(
InvalidRevokedCertSerialNumber,
InvalidRevokedCertSerialNumber
);
assert_eq!(IssuerInvalidForCrl, IssuerInvalidForCrl);
assert_eq!(ParseError, ParseError);
assert_eq!(UnsupportedCriticalExtension, UnsupportedCriticalExtension);
assert_eq!(UnsupportedCrlVersion, UnsupportedCrlVersion);
assert_eq!(UnsupportedDeltaCrl, UnsupportedDeltaCrl);
assert_eq!(UnsupportedIndirectCrl, UnsupportedIndirectCrl);
assert_eq!(UnsupportedRevocationReason, UnsupportedRevocationReason);
let other = Other(OtherError(
#[cfg(feature = "std")]
alloc::sync::Arc::from(Box::from("")),
));
assert_ne!(other, other);
assert_ne!(BadSignature, InvalidCrlNumber);
}
#[test]
#[cfg(feature = "std")]
fn other_error_equality() {
let other_error = OtherError(alloc::sync::Arc::from(Box::from("")));
assert_ne!(other_error, other_error);
let other: Error = other_error.into();
assert_ne!(other, other);
}
#[test]
fn smoke() {
use crate::enums::{AlertDescription, ContentType, HandshakeType};
let all = vec![
Error::InappropriateMessage {
expect_types: vec![ContentType::Alert],
got_type: ContentType::Handshake,
},
Error::InappropriateHandshakeMessage {
expect_types: vec![HandshakeType::ClientHello, HandshakeType::Finished],
got_type: HandshakeType::ServerHello,
},
Error::InvalidMessage(InvalidMessage::InvalidCcs),
Error::NoCertificatesPresented,
Error::DecryptError,
super::PeerIncompatible::Tls12NotOffered.into(),
super::PeerMisbehaved::UnsolicitedCertExtension.into(),
Error::AlertReceived(AlertDescription::ExportRestriction),
super::CertificateError::Expired.into(),
Error::General("undocumented error".to_string()),
Error::FailedToGetCurrentTime,
Error::FailedToGetRandomBytes,
Error::HandshakeNotComplete,
Error::PeerSentOversizedRecord,
Error::NoApplicationProtocol,
Error::BadMaxFragmentSize,
Error::InconsistentKeys(InconsistentKeys::KeyMismatch),
Error::InconsistentKeys(InconsistentKeys::Unknown),
Error::InvalidCertRevocationList(CertRevocationListError::BadSignature),
Error::Other(OtherError(
#[cfg(feature = "std")]
alloc::sync::Arc::from(Box::from("")),
)),
];
for err in all {
println!("{:?}:", err);
println!(" fmt '{}'", err);
}
}
#[test]
fn rand_error_mapping() {
use super::rand;
let err: Error = rand::GetRandomFailed.into();
assert_eq!(err, Error::FailedToGetRandomBytes);
}
#[cfg(feature = "std")]
#[test]
fn time_error_mapping() {
use std::time::SystemTime;
let time_error = SystemTime::UNIX_EPOCH
.duration_since(SystemTime::now())
.unwrap_err();
let err: Error = time_error.into();
assert_eq!(err, Error::FailedToGetCurrentTime);
}
}