1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
|
{-# LANGUAGE OverloadedStrings #-}
module HandshakeSpec where
import Control.Monad
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as L
import Data.IORef
import Data.List
import Data.Maybe
import Data.X509 (ExtKeyUsageFlag (..))
import Network.TLS
import Network.TLS.Extra.Cipher
import Network.TLS.Internal
import Test.Hspec
import Test.Hspec.QuickCheck
import Test.QuickCheck
import API
import Arbitrary
import PipeChan
import Run
import Session
spec :: Spec
spec = do
describe "pipe" $ do
it "can setup a channel" pipe_work
describe "handshake" $ do
prop "can run TLS 1.2" handshake_simple
prop "can run TLS 1.3" handshake13_simple
prop "can update key for TLS 1.3" handshake_update_key
prop "can prevent downgrade attack" handshake13_downgrade
prop "can negotiate hash and signature" handshake_hashsignatures
prop "can negotiate cipher suite" handshake_ciphersuites
prop "can negotiate group" handshake_groups
prop "can negotiate elliptic curve" handshake_ec
prop "can fallback for certificate with cipher" handshake_cert_fallback_cipher
prop
"can fallback for certificate with hash and signature"
handshake_cert_fallback_hs
prop "can handle server key usage" handshake_server_key_usage
prop "can handle client key usage" handshake_client_key_usage
prop "can authenticate client" handshake_client_auth
prop "can receive client authentication failure" handshake_client_auth_fail
prop "can handle extended main secret" handshake_ems
prop "can resume with extended main secret" handshake_resumption_ems
prop "can handle ALPN" handshake_alpn
prop "can handle SNI" handshake_sni
prop "can re-negotiate with TLS 1.2" handshake12_renegotiation
prop "can resume session with TLS 1.2" handshake12_session_resumption
prop "can resume session ticket with TLS 1.2" handshake12_session_ticket
prop "can handshake with TLS 1.3 Full" handshake13_full
prop "can handshake with TLS 1.3 HRR" handshake13_hrr
prop "can handshake with TLS 1.3 PSK" handshake13_psk
prop "can handshake with TLS 1.3 PSK ticket" handshake13_psk_ticket
prop "can handshake with TLS 1.3 PSK -> HRR" handshake13_psk_fallback
prop "can handshake with TLS 1.3 0RTT" handshake13_0rtt
prop "can handshake with TLS 1.3 0RTT -> PSK" handshake13_0rtt_fallback
prop "can handshake with TLS 1.3 EE" handshake13_ee_groups
prop "can handshake with TLS 1.3 EC groups" handshake13_ec
prop "can handshake with TLS 1.3 FFDHE groups" handshake13_ffdhe
prop "can handshake with TLS 1.3 Post-handshake auth" post_handshake_auth
--------------------------------------------------------------
pipe_work :: IO ()
pipe_work = do
pipe <- newPipe
_ <- runPipe pipe
let bSize = 16
n <- generate (choose (1, 32))
let d1 = B.replicate (bSize * n) 40
let d2 = B.replicate (bSize * n) 45
d1' <- writePipeC pipe d1 >> readPipeS pipe (B.length d1)
d1' `shouldBe` d1
d2' <- writePipeS pipe d2 >> readPipeC pipe (B.length d2)
d2' `shouldBe` d2
--------------------------------------------------------------
handshake_simple :: (ClientParams, ServerParams) -> IO ()
handshake_simple = runTLSSimple
--------------------------------------------------------------
newtype CSP13 = CSP13 (ClientParams, ServerParams) deriving (Show)
instance Arbitrary CSP13 where
arbitrary = CSP13 <$> arbitraryPairParams13
handshake13_simple :: CSP13 -> IO ()
handshake13_simple (CSP13 params) = runTLSSimple13 params hs
where
cgrps = supportedGroups $ clientSupported $ fst params
sgrps = supportedGroups $ serverSupported $ snd params
hs = if unsafeHead cgrps `elem` sgrps then FullHandshake else HelloRetryRequest
--------------------------------------------------------------
handshake13_downgrade :: (ClientParams, ServerParams) -> IO ()
handshake13_downgrade (cparam, sparam) = do
versionForced <-
generate $ elements (supportedVersions $ clientSupported cparam)
let debug' = (serverDebug sparam){debugVersionForced = Just versionForced}
sparam' = sparam{serverDebug = debug'}
params = (cparam, sparam')
downgraded =
(isVersionEnabled TLS13 params && versionForced < TLS13)
|| (isVersionEnabled TLS12 params && versionForced < TLS12)
if downgraded
then runTLSFailure params handshake handshake
else runTLSSimple params
handshake_update_key :: (ClientParams, ServerParams) -> IO ()
handshake_update_key = runTLSSimpleKeyUpdate
--------------------------------------------------------------
handshake_hashsignatures
:: ([HashAndSignatureAlgorithm], [HashAndSignatureAlgorithm]) -> IO ()
handshake_hashsignatures (clientHashSigs, serverHashSigs) = do
tls13 <- generate arbitrary
let version = if tls13 then TLS13 else TLS12
ciphers =
[ cipher_ECDHE_RSA_WITH_AES_256_GCM_SHA384
, cipher_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
, cipher13_AES_128_GCM_SHA256
]
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
([version], [version])
(ciphers, ciphers)
let clientParam' =
clientParam
{ clientSupported =
(clientSupported clientParam)
{ supportedHashSignatures = clientHashSigs
}
}
serverParam' =
serverParam
{ serverSupported =
(serverSupported serverParam)
{ supportedHashSignatures = serverHashSigs
}
}
commonHashSigs = clientHashSigs `intersect` serverHashSigs
shouldFail
| tls13 = all incompatibleWithDefaultCurve commonHashSigs
| otherwise = null commonHashSigs
if shouldFail
then runTLSFailure (clientParam', serverParam') handshake handshake
else runTLSSimple (clientParam', serverParam')
where
incompatibleWithDefaultCurve (h, SignatureECDSA) = h /= HashSHA256
incompatibleWithDefaultCurve _ = False
handshake_ciphersuites :: ([Cipher], [Cipher]) -> IO ()
handshake_ciphersuites (clientCiphers, serverCiphers) = do
tls13 <- generate arbitrary
let version = if tls13 then TLS13 else TLS12
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
([version], [version])
(clientCiphers, serverCiphers)
let adequate = cipherAllowedForVersion version
shouldSucceed = any adequate (clientCiphers `intersect` serverCiphers)
if shouldSucceed
then runTLSSimple (clientParam, serverParam)
else runTLSFailure (clientParam, serverParam) handshake handshake
--------------------------------------------------------------
handshake_groups :: GGP -> IO ()
handshake_groups (GGP clientGroups serverGroups) = do
tls13 <- generate arbitrary
let versions = if tls13 then [TLS13] else [TLS12]
ciphers = ciphersuite_strong
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
(versions, versions)
(ciphers, ciphers)
denyCustom <- generate arbitrary
let groupUsage =
if denyCustom
then GroupUsageUnsupported "custom group denied"
else GroupUsageValid
clientParam' =
clientParam
{ clientSupported =
(clientSupported clientParam)
{ supportedGroups = clientGroups
}
, clientHooks =
(clientHooks clientParam)
{ onCustomFFDHEGroup = \_ _ -> return groupUsage
}
}
serverParam' =
serverParam
{ serverSupported =
(serverSupported serverParam)
{ supportedGroups = serverGroups
}
}
commonGroups = clientGroups `intersect` serverGroups
shouldFail = null commonGroups
p minfo = isNothing (minfo >>= infoSupportedGroup) == null commonGroups
if shouldFail
then runTLSFailure (clientParam', serverParam') handshake handshake
else runTLSPredicate (clientParam', serverParam') p
--------------------------------------------------------------
newtype SG = SG [Group] deriving (Show)
instance Arbitrary SG where
arbitrary = SG <$> shuffle sigGroups
where
sigGroups = [P256, P521]
handshake_ec :: SG -> IO ()
handshake_ec (SG sigGroups) = do
let versions = [TLS12]
ciphers =
[ cipher_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
]
hashSignatures =
[ (HashSHA256, SignatureECDSA)
]
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
(versions, versions)
(ciphers, ciphers)
clientGroups <- generate $ shuffle sigGroups
clientHashSignatures <- generate $ sublistOf hashSignatures
serverHashSignatures <- generate $ sublistOf hashSignatures
credentials <- generate arbitraryCredentialsOfEachCurve
let clientParam' =
clientParam
{ clientSupported =
(clientSupported clientParam)
{ supportedGroups = clientGroups
, supportedHashSignatures = clientHashSignatures
}
}
serverParam' =
serverParam
{ serverSupported =
(serverSupported serverParam)
{ supportedGroups = sigGroups
, supportedHashSignatures = serverHashSignatures
}
, serverShared =
(serverShared serverParam)
{ sharedCredentials = Credentials credentials
}
}
sigAlgs = map snd (clientHashSignatures `intersect` serverHashSignatures)
ecdsaDenied = SignatureECDSA `notElem` sigAlgs
if ecdsaDenied
then runTLSFailure (clientParam', serverParam') handshake handshake
else runTLSSimple (clientParam', serverParam')
-- Tests ability to use or ignore client "signature_algorithms" extension when
-- choosing a server certificate. Here peers allow DHE_RSA_AES128_SHA1 but
-- the server RSA certificate has a SHA-1 signature that the client does not
-- support. Server may choose the DSA certificate only when cipher
-- DHE_DSA_AES128_SHA1 is allowed. Otherwise it must fallback to the RSA
-- certificate.
data OC = OC [Cipher] [Cipher] deriving (Show)
instance Arbitrary OC where
arbitrary = OC <$> sublistOf otherCiphers <*> sublistOf otherCiphers
where
otherCiphers =
[ cipher_ECDHE_RSA_WITH_AES_256_GCM_SHA384
, cipher_ECDHE_RSA_WITH_AES_128_GCM_SHA256
]
handshake_cert_fallback_cipher :: OC -> IO ()
handshake_cert_fallback_cipher (OC clientCiphers serverCiphers) = do
let clientVersions = [TLS12]
serverVersions = [TLS12]
commonCiphers = [cipher_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
hashSignatures = [(HashSHA256, SignatureRSA), (HashSHA1, SignatureDSA)]
chainRef <- newIORef Nothing
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
(clientVersions, serverVersions)
(clientCiphers ++ commonCiphers, serverCiphers ++ commonCiphers)
let clientParam' =
clientParam
{ clientSupported =
(clientSupported clientParam)
{ supportedHashSignatures = hashSignatures
}
, clientHooks =
(clientHooks clientParam)
{ onServerCertificate = \_ _ _ chain ->
writeIORef chainRef (Just chain) >> return []
}
}
runTLSSimple (clientParam', serverParam)
serverChain <- readIORef chainRef
isLeafRSA serverChain `shouldBe` True
-- Same as above but testing with supportedHashSignatures directly instead of
-- ciphers, and thus allowing TLS13. Peers accept RSA with SHA-256 but the
-- server RSA certificate has a SHA-1 signature. When Ed25519 is allowed by
-- both client and server, the Ed25519 certificate is selected. Otherwise the
-- server fallbacks to RSA.
--
-- Note: SHA-1 is supposed to be disallowed in X.509 signatures with TLS13
-- unless client advertises explicit support. Currently this is not enforced by
-- the library, which is useful to test this scenario. SHA-1 could be replaced
-- by another algorithm.
data OHS = OHS [HashAndSignatureAlgorithm] [HashAndSignatureAlgorithm]
deriving (Show)
instance Arbitrary OHS where
arbitrary = OHS <$> sublistOf otherHS <*> sublistOf otherHS
where
otherHS = [(HashIntrinsic, SignatureEd25519)]
handshake_cert_fallback_hs :: OHS -> IO ()
handshake_cert_fallback_hs (OHS clientHS serverHS) = do
tls13 <- generate arbitrary
let versions = if tls13 then [TLS13] else [TLS12]
ciphers =
[ cipher_ECDHE_RSA_WITH_AES_128_GCM_SHA256
, cipher_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
, cipher13_AES_128_GCM_SHA256
]
commonHS =
[ (HashSHA256, SignatureRSA)
, (HashIntrinsic, SignatureRSApssRSAeSHA256)
]
chainRef <- newIORef Nothing
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
(versions, versions)
(ciphers, ciphers)
let clientParam' =
clientParam
{ clientSupported =
(clientSupported clientParam)
{ supportedHashSignatures = commonHS ++ clientHS
}
, clientHooks =
(clientHooks clientParam)
{ onServerCertificate = \_ _ _ chain ->
writeIORef chainRef (Just chain) >> return []
}
}
serverParam' =
serverParam
{ serverSupported =
(serverSupported serverParam)
{ supportedHashSignatures = commonHS ++ serverHS
}
}
eddsaDisallowed =
(HashIntrinsic, SignatureEd25519) `notElem` clientHS
|| (HashIntrinsic, SignatureEd25519) `notElem` serverHS
runTLSSimple (clientParam', serverParam')
serverChain <- readIORef chainRef
isLeafRSA serverChain `shouldBe` eddsaDisallowed
--------------------------------------------------------------
handshake_server_key_usage :: [ExtKeyUsageFlag] -> IO ()
handshake_server_key_usage usageFlags = do
tls13 <- generate arbitrary
let versions = if tls13 then [TLS13] else [TLS12]
ciphers = ciphersuite_all
(clientParam, serverParam) <-
generate $
arbitraryPairParamsWithVersionsAndCiphers
(versions, versions)
(ciphers, ciphers)
cred <- generate $ arbitraryRSACredentialWithUsage usageFlags
let serverParam' =
serverParam
{ serverShared =
(serverShared serverParam)
{ sharedCredentials = Credentials [cred]
}
}
shouldSucceed = KeyUsage_digitalSignature `elem` usageFlags
if shouldSucceed
then runTLSSimple (clientParam, serverParam')
else runTLSFailure (clientParam, serverParam') handshake handshake
handshake_client_key_usage :: [ExtKeyUsageFlag] -> IO ()
handshake_client_key_usage usageFlags = do
(clientParam, serverParam) <- generate arbitrary
cred <- generate $ arbitraryRSACredentialWithUsage usageFlags
let clientParam' =
clientParam
{ clientHooks =
(clientHooks clientParam)
{ onCertificateRequest = \_ -> return $ Just cred
}
}
serverParam' =
serverParam
{ serverWantClientCert = True
, serverHooks =
(serverHooks serverParam)
{ onClientCertificate = \_ -> return CertificateUsageAccept
}
}
shouldSucceed = KeyUsage_digitalSignature `elem` usageFlags
if shouldSucceed
then runTLSSimple (clientParam', serverParam')
else runTLSFailure (clientParam', serverParam') handshake handshake
--------------------------------------------------------------
handshake_client_auth :: (ClientParams, ServerParams) -> IO ()
handshake_client_auth (clientParam, serverParam) = do
let clientVersions = supportedVersions $ clientSupported clientParam
serverVersions = supportedVersions $ serverSupported serverParam
version = maximum (clientVersions `intersect` serverVersions)
cred <- generate (arbitraryClientCredential version)
let clientParam' =
clientParam
{ clientHooks =
(clientHooks clientParam)
{ onCertificateRequest = \_ -> return $ Just cred
}
}
serverParam' =
serverParam
{ serverWantClientCert = True
, serverHooks =
(serverHooks serverParam)
{ onClientCertificate = validateChain cred
}
}
runTLSSimple (clientParam', serverParam')
where
validateChain cred chain
| chain == fst cred = return CertificateUsageAccept
| otherwise = return (CertificateUsageReject CertificateRejectUnknownCA)
handshake_client_auth_fail :: (ClientParams, ServerParams) -> IO ()
handshake_client_auth_fail (clientParam, serverParam) = do
let clientVersions = supportedVersions $ clientSupported clientParam
serverVersions = supportedVersions $ serverSupported serverParam
version = maximum (clientVersions `intersect` serverVersions)
cred <- generate (arbitraryClientCredential version)
let clientParam' =
clientParam
{ clientHooks =
(clientHooks clientParam)
{ onCertificateRequest = \_ -> return $ Just cred
}
}
serverParam' =
serverParam
{ serverWantClientCert = True
, serverHooks =
(serverHooks serverParam)
{ onClientCertificate = validateChain cred
}
}
runTLSFailure (clientParam', serverParam') handshake handshake
where
validateChain _ _ = return (CertificateUsageReject CertificateRejectUnknownCA)
--------------------------------------------------------------
handshake_ems :: (EMSMode, EMSMode) -> IO ()
handshake_ems (cems, sems) = do
params <- generate arbitrary
let params' = setEMSMode (cems, sems) params
version = getConnectVersion params'
emsVersion = version >= TLS10 && version <= TLS12
use = cems /= NoEMS && sems /= NoEMS
require = cems == RequireEMS || sems == RequireEMS
p info = infoExtendedMainSecret info == (emsVersion && use)
if emsVersion && require && not use
then runTLSFailure params' handshake handshake
else runTLSPredicate params' (maybe False p)
newtype CompatEMS = CompatEMS (EMSMode, EMSMode) deriving (Show)
instance Arbitrary CompatEMS where
arbitrary = CompatEMS <$> (arbitrary `suchThat` compatible)
where
compatible (NoEMS, RequireEMS) = False
compatible (RequireEMS, NoEMS) = False
compatible _ = True
handshake_resumption_ems :: (CompatEMS, CompatEMS) -> IO ()
handshake_resumption_ems (CompatEMS ems, CompatEMS ems2) = do
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
plainParams <- generate arbitrary
let params =
setEMSMode ems $
setPairParamsSessionManagers sessionManagers plainParams
runTLSSimple params
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let params2 =
setEMSMode ems2 $
setPairParamsSessionResuming (fromJust sessionParams) params
let version = getConnectVersion params2
emsVersion = version >= TLS10 && version <= TLS12
if emsVersion && use ems && not (use ems2)
then runTLSFailure params2 handshake handshake
else do
runTLSSimple params2
mSessionParams2 <- readClientSessionRef sessionRefs
let sameSession = sessionParams == mSessionParams2
sameUse = use ems == use ems2
when emsVersion (sameSession `shouldBe` sameUse)
where
use (NoEMS, _) = False
use (_, NoEMS) = False
use _ = True
--------------------------------------------------------------
handshake_alpn :: (ClientParams, ServerParams) -> IO ()
handshake_alpn (clientParam, serverParam) = do
let clientParam' =
clientParam
{ clientHooks =
(clientHooks clientParam)
{ onSuggestALPN = return $ Just ["h2", "http/1.1"]
}
}
serverParam' =
serverParam
{ serverHooks =
(serverHooks serverParam)
{ onALPNClientSuggest = Just alpn
}
}
params' = (clientParam', serverParam')
runTLSSuccess params' hsClient hsServer
where
hsClient ctx = do
handshake ctx
proto <- getNegotiatedProtocol ctx
proto `shouldBe` Just "h2"
hsServer ctx = do
handshake ctx
proto <- getNegotiatedProtocol ctx
proto `shouldBe` Just "h2"
alpn xs
| "h2" `elem` xs = return "h2"
| otherwise = return "http/1.1"
handshake_sni :: (ClientParams, ServerParams) -> IO ()
handshake_sni (clientParam, serverParam) = do
ref <- newIORef Nothing
let clientParam' =
clientParam
{ clientServerIdentification = (serverName, "")
}
serverParam' =
serverParam
{ serverHooks =
(serverHooks serverParam)
{ onServerNameIndication = onSNI ref
}
}
params' = (clientParam', serverParam')
runTLSSuccess params' hsClient hsServer
receivedName <- readIORef ref
receivedName `shouldBe` Just (Just serverName)
where
hsClient ctx = do
handshake ctx
msni <- getClientSNI ctx
expectMaybe "C: SNI should be Just" serverName msni
hsServer ctx = do
handshake ctx
msni <- getClientSNI ctx
expectMaybe "S: SNI should be Just" serverName msni
onSNI ref name = do
mx <- readIORef ref
mx `shouldBe` Nothing
writeIORef ref (Just name)
return (Credentials [])
serverName = "haskell.org"
--------------------------------------------------------------
newtype CSP12 = CSP12 (ClientParams, ServerParams) deriving (Show)
instance Arbitrary CSP12 where
arbitrary = CSP12 <$> arbitraryPairParams12
handshake12_renegotiation :: CSP12 -> IO ()
handshake12_renegotiation (CSP12 (cparams, sparams)) = do
renegDisabled <- generate arbitrary
let sparams' =
sparams
{ serverSupported =
(serverSupported sparams)
{ supportedClientInitiatedRenegotiation = not renegDisabled
}
}
if renegDisabled
then runTLSFailure (cparams, sparams') hsClient hsServer
else runTLSSimple (cparams, sparams')
where
hsClient ctx = handshake ctx >> handshake ctx
-- recvData receives the alert from the second handshake
hsServer ctx = handshake ctx >> void (recvData ctx)
handshake12_session_resumption :: CSP12 -> IO ()
handshake12_session_resumption (CSP12 plainParams) = do
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
let params = setPairParamsSessionManagers sessionManagers plainParams
runTLSSimple params
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let params2 = setPairParamsSessionResuming (fromJust sessionParams) params
runTLSPredicate params2 (maybe False infoTLS12Resumption)
handshake12_session_ticket :: CSP12 -> IO ()
handshake12_session_ticket (CSP12 plainParams) = do
sessionRefs <- twoSessionRefs
let sessionManagers0 = twoSessionManagers sessionRefs
sessionManagers = (fst sessionManagers0, oneSessionTicket)
let params = setPairParamsSessionManagers sessionManagers plainParams
runTLSSimple params
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let params2 = setPairParamsSessionResuming (fromJust sessionParams) params
runTLSPredicate params2 (maybe False infoTLS12Resumption)
--------------------------------------------------------------
handshake13_full :: CSP13 -> IO ()
handshake13_full (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
params =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
runTLSSimple13 params FullHandshake
handshake13_hrr :: CSP13 -> IO ()
handshake13_hrr (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
params =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
runTLSSimple13 params HelloRetryRequest
handshake13_psk :: CSP13 -> IO ()
handshake13_psk (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
params0 =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
let params = setPairParamsSessionManagers sessionManagers params0
runTLSSimple13 params HelloRetryRequest
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let params2 = setPairParamsSessionResuming (fromJust sessionParams) params
runTLSSimple13 params2 PreSharedKey
handshake13_psk_ticket :: CSP13 -> IO ()
handshake13_psk_ticket (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
params0 =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
sessionRefs <- twoSessionRefs
let sessionManagers0 = twoSessionManagers sessionRefs
sessionManagers = (fst sessionManagers0, oneSessionTicket)
let params = setPairParamsSessionManagers sessionManagers params0
runTLSSimple13 params HelloRetryRequest
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let params2 = setPairParamsSessionResuming (fromJust sessionParams) params
runTLSSimple13 params2 PreSharedKey
handshake13_psk_fallback :: CSP13 -> IO ()
handshake13_psk_fallback (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers =
[ cipher13_AES_128_GCM_SHA256
, cipher13_AES_128_CCM_SHA256
]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
params0 =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
let params = setPairParamsSessionManagers sessionManagers params0
runTLSSimple13 params HelloRetryRequest
-- resumption fails because GCM cipher is not supported anymore, full
-- handshake is not possible because X25519 has been removed, so we are
-- back with P256 after hello retry
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
let (cli2, srv2) = setPairParamsSessionResuming (fromJust sessionParams) params
srv2' = srv2{serverSupported = svrSupported'}
svrSupported' =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_CCM_SHA256]
, supportedGroups = [P256]
}
runTLSSimple13 (cli2, srv2') HelloRetryRequest
handshake13_0rtt :: CSP13 -> IO ()
handshake13_0rtt (CSP13 (cli, srv)) = do
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [X25519]
}
cliHooks =
defaultClientHooks
{ onSuggestALPN = return $ Just ["h2"]
}
svrHooks =
defaultServerHooks
{ onALPNClientSuggest = Just (return . unsafeHead)
}
params0 =
( cli
{ clientSupported = cliSupported
, clientHooks = cliHooks
}
, srv
{ serverSupported = svrSupported
, serverHooks = svrHooks
, serverEarlyDataSize = 2048
}
)
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
let params = setPairParamsSessionManagers sessionManagers params0
runTLSSimple13 params HelloRetryRequest
runTLS0rtt params sessionRefs
runTLS0rtt params sessionRefs
where
runTLS0rtt params sessionRefs = do
-- and resume
sessionParams <- readClientSessionRef sessionRefs
expectJust "session param should be Just" sessionParams
clearClientSessionRef sessionRefs
earlyData <- B.pack <$> generate (someWords8 256)
let (pc, ps) = setPairParamsSessionResuming (fromJust sessionParams) params
params2 = (pc{clientUseEarlyData = True}, ps)
runTLS0RTT params2 RTT0 earlyData
handshake13_0rtt_fallback :: CSP13 -> IO ()
handshake13_0rtt_fallback (CSP13 (cli, srv)) = do
group0 <- generate $ elements [P256, X25519]
let cliSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [P256, X25519]
}
svrSupported =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [group0]
}
params =
( cli{clientSupported = cliSupported}
, srv
{ serverSupported = svrSupported
, serverEarlyDataSize = 1024
}
)
sessionRefs <- twoSessionRefs
let sessionManagers = twoSessionManagers sessionRefs
let params0 = setPairParamsSessionManagers sessionManagers params
let mode = if group0 == P256 then FullHandshake else HelloRetryRequest
runTLSSimple13 params0 mode
-- and resume
mSessionParams <- readClientSessionRef sessionRefs
case mSessionParams of
Nothing -> expectationFailure "session params: Just is expected"
Just sessionParams -> do
earlyData <- B.pack <$> generate (someWords8 256)
group1 <- generate $ elements [P256, X25519]
let (pc, ps) = setPairParamsSessionResuming sessionParams params0
svrSupported1 =
defaultSupported
{ supportedCiphers = [cipher13_AES_128_GCM_SHA256]
, supportedGroups = [group1]
}
params1 =
( pc{clientUseEarlyData = True}
, ps
{ serverEarlyDataSize = 0
, serverSupported = svrSupported1
}
)
-- C: [P256, X25519]
-- S: [group0]
-- C: [P256, X25519]
-- S: [group1]
if group0 == group1
-- 0-RTT is not allowed, so fallback to PreSharedKey
then runTLS0RTT params1 PreSharedKey earlyData
-- HRR but not allowed for 0-RTT
else runTLSFailure params1 (tlsClient earlyData) tlsServer
where
tlsClient earlyData ctx = do
handshake ctx
sendData ctx $ L.fromStrict earlyData
_ <- recvData ctx
bye ctx
tlsServer ctx = do
handshake ctx
_ <- recvData ctx
bye ctx
handshake13_ee_groups :: CSP13 -> IO ()
handshake13_ee_groups (CSP13 (cli, srv)) = do
let -- The client prefers P256
cliSupported = (clientSupported cli){supportedGroups = [P256, X25519]}
-- The server prefers X25519
svrSupported = (serverSupported srv){supportedGroups = [X25519, P256]}
params =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
(_, serverMessages) <- runTLSCapture13 params
-- The server should tell X25519 in supported_groups in EE to clinet
let isSupportedGroups (ExtensionRaw eid _) = eid == EID_SupportedGroups
eeMessagesHaveExt =
[ any isSupportedGroups exts
| EncryptedExtensions13 exts <- serverMessages
]
eeMessagesHaveExt `shouldBe` [True]
handshake13_ec :: CSP13 -> IO ()
handshake13_ec (CSP13 (cli, srv)) = do
EC cgrps <- generate arbitrary
EC sgrps <- generate arbitrary
let cliSupported = (clientSupported cli){supportedGroups = cgrps}
svrSupported = (serverSupported srv){supportedGroups = sgrps}
params =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
runTLSSimple13 params FullHandshake
handshake13_ffdhe :: CSP13 -> IO ()
handshake13_ffdhe (CSP13 (cli, srv)) = do
FFDHE cgrps <- generate arbitrary
FFDHE sgrps <- generate arbitrary
let cliSupported = (clientSupported cli){supportedGroups = cgrps}
svrSupported = (serverSupported srv){supportedGroups = sgrps}
params =
( cli{clientSupported = cliSupported}
, srv{serverSupported = svrSupported}
)
runTLSSimple13 params FullHandshake
post_handshake_auth :: CSP13 -> IO ()
post_handshake_auth (CSP13 (clientParam, serverParam)) = do
cred <- generate (arbitraryClientCredential TLS13)
let clientParam' =
clientParam
{ clientHooks =
(clientHooks clientParam)
{ onCertificateRequest = \_ -> return $ Just cred
}
}
serverParam' =
serverParam
{ serverHooks =
(serverHooks serverParam)
{ onClientCertificate = validateChain cred
}
}
if isCredentialDSA cred
then runTLSFailure (clientParam', serverParam') hsClient hsServer
else runTLSSuccess (clientParam', serverParam') hsClient hsServer
where
validateChain cred chain
| chain == fst cred = return CertificateUsageAccept
| otherwise = return (CertificateUsageReject CertificateRejectUnknownCA)
hsClient ctx = do
handshake ctx
sendData ctx "request 1"
recvDataAssert ctx "response 1"
sendData ctx "request 2"
recvDataAssert ctx "response 2"
hsServer ctx = do
handshake ctx
recvDataAssert ctx "request 1"
_ <- requestCertificate ctx -- single request
sendData ctx "response 1"
recvDataAssert ctx "request 2"
_ <- requestCertificate ctx
_ <- requestCertificate ctx -- two simultaneously
sendData ctx "response 2"
expectJust :: String -> Maybe a -> Expectation
expectJust tag mx = case mx of
Nothing -> expectationFailure tag
Just _ -> return ()
|