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 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
//! sspi-rs is a Rust implementation of [Security Support Provider Interface (SSPI)](https://docs.microsoft.com/en-us/windows/win32/rpc/security-support-provider-interface-sspi-).
//! It ships with platform-independent implementations of [Security Support Providers (SSP)](https://docs.microsoft.com/en-us/windows/win32/rpc/security-support-providers-ssps-),
//! and is able to utilize native Microsoft libraries when ran under Windows.
//!
//! The purpose of sspi-rs is to clean the original interface from cluttering and provide users with Rust-friendly SSPs for execution under Linux or any other platform that is
//! able to compile Rust.
//!
//! # Getting started
//!
//! Here is a quick example how to start working with the crate. This is the first stage of the client-server authentication performed on the client side.
//!
//! ```rust
//! use sspi::Sspi;
//! use sspi::Username;
//! use sspi::Ntlm;
//! use sspi::builders::EmptyInitializeSecurityContext;
//! use sspi::SspiImpl;
//!
//! let mut ntlm = Ntlm::new();
//!
//! let identity = sspi::AuthIdentity {
//! username: Username::parse("user").unwrap(),
//! password: "password".to_string().into(),
//! };
//!
//! let mut acq_creds_handle_result = ntlm
//! .acquire_credentials_handle()
//! .with_credential_use(sspi::CredentialUse::Outbound)
//! .with_auth_data(&identity)
//! .execute(&mut ntlm)
//! .expect("AcquireCredentialsHandle resulted in error");
//!
//! let mut output = vec![sspi::SecurityBuffer::new(
//! Vec::new(),
//! sspi::SecurityBufferType::Token,
//! )];
//!
//! let mut builder = ntlm.initialize_security_context()
//! .with_credentials_handle(&mut acq_creds_handle_result.credentials_handle)
//! .with_context_requirements(
//! sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY
//! )
//! .with_target_data_representation(sspi::DataRepresentation::Native)
//! .with_output(&mut output);
//!
//! let result = ntlm.initialize_security_context_impl(&mut builder)
//! .expect("InitializeSecurityContext resulted in error")
//! .resolve_to_result()
//! .expect("InitializeSecurityContext resulted in error");
//!
//! println!("Initialized security context with result status: {:?}", result.status);
//! ```
#[macro_use]
extern crate tracing;
pub mod builders;
pub mod channel_bindings;
pub mod credssp;
pub mod generator;
pub mod kerberos;
pub mod negotiate;
pub mod network_client;
pub mod ntlm;
mod pk_init;
pub mod pku2u;
#[allow(unreachable_patterns)]
mod auth_identity;
mod ber;
#[cfg(feature = "scard")]
pub mod cert_utils;
mod crypto;
mod decrypt_buffer;
mod dns;
mod kdc;
mod krb;
mod secret;
#[cfg(feature = "scard")]
#[allow(dead_code)]
mod smartcard;
mod utils;
#[cfg(all(feature = "tsssp", not(target_os = "windows")))]
compile_error!("tsssp feature should be used only on Windows");
#[cfg(all(feature = "scard", not(target_os = "windows")))]
compile_error!("scard feature should be used only on Windows");
use std::{error, fmt, io, result, str, string};
use bitflags::bitflags;
#[cfg(feature = "tsssp")]
use credssp::sspi_cred_ssp;
pub use decrypt_buffer::DecryptBuffer;
use generator::{GeneratorChangePassword, GeneratorInitSecurityContext};
use num_derive::{FromPrimitive, ToPrimitive};
use picky_asn1::restricted_string::CharSetError;
use picky_asn1_der::Asn1DerError;
use picky_asn1_x509::Certificate;
use picky_krb::gss_api::GssApiMessageError;
use picky_krb::messages::KrbError;
use utils::map_keb_error_code_to_sspi_error;
pub use utils::string_to_utf16;
pub use self::auth_identity::{AuthIdentity, AuthIdentityBuffers, Credentials, CredentialsBuffers, Username};
#[cfg(feature = "scard")]
pub use self::auth_identity::{SmartCardIdentity, SmartCardIdentityBuffers};
pub use self::builders::{
AcceptSecurityContextResult, AcquireCredentialsHandleResult, InitializeSecurityContextResult,
};
use self::builders::{
ChangePassword, FilledAcceptSecurityContext, FilledAcquireCredentialsHandle, FilledInitializeSecurityContext,
};
pub use self::kdc::{detect_kdc_host, detect_kdc_url};
pub use self::kerberos::config::KerberosConfig;
pub use self::kerberos::{Kerberos, KerberosState, KERBEROS_VERSION};
pub use self::negotiate::{Negotiate, NegotiateConfig, NegotiatedProtocol};
pub use self::ntlm::Ntlm;
pub use self::pku2u::{Pku2u, Pku2uConfig, Pku2uState};
pub use self::secret::Secret;
use crate::builders::{
EmptyAcceptSecurityContext, EmptyAcquireCredentialsHandle, EmptyInitializeSecurityContext,
InitializeSecurityContext,
};
/// Representation of SSPI-related result operation. Makes it easier to return a `Result` with SSPI-related `Error`.
pub type Result<T> = result::Result<T, Error>;
pub type Luid = u64;
const PACKAGE_ID_NONE: u16 = 0xFFFF;
/// Retrieves information about a specified security package. This information includes credentials and contexts.
///
/// # Returns
///
/// * `PackageInfo` containing the information about the security principal upon success
/// * `Error` on error
///
/// # Example
///
/// ```
/// let package_info = sspi::query_security_package_info(sspi::SecurityPackageType::Ntlm)
/// .unwrap();
/// println!("Package info:");
/// println!("Name: {:?}", package_info.name);
/// println!("Comment: {}", package_info.comment);
/// ```
///
/// # MSDN
///
/// * [QuerySecurityPackageInfoW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-querysecuritypackageinfow)
pub fn query_security_package_info(package_type: SecurityPackageType) -> Result<PackageInfo> {
match package_type {
SecurityPackageType::Ntlm => Ok(ntlm::PACKAGE_INFO.clone()),
SecurityPackageType::Kerberos => Ok(kerberos::PACKAGE_INFO.clone()),
SecurityPackageType::Negotiate => Ok(negotiate::PACKAGE_INFO.clone()),
SecurityPackageType::Pku2u => Ok(pku2u::PACKAGE_INFO.clone()),
#[cfg(feature = "tsssp")]
SecurityPackageType::CredSsp => Ok(sspi_cred_ssp::PACKAGE_INFO.clone()),
SecurityPackageType::Other(s) => Err(Error::new(
ErrorKind::Unknown,
format!("Queried info about unknown package: {:?}", s),
)),
}
}
/// Returns an array of `PackageInfo` structures that provide information about the security packages available to the client.
///
/// # Returns
///
/// * `Vec` of `PackageInfo` structures upon success
/// * `Error` on error
///
/// # Example
///
/// ```
/// let packages = sspi::enumerate_security_packages().unwrap();
///
/// println!("Available packages:");
/// for ssp in packages {
/// println!("{:?}", ssp.name);
/// }
/// ```
///
/// # MSDN
///
/// * [EnumerateSecurityPackagesW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-enumeratesecuritypackagesw)
pub fn enumerate_security_packages() -> Result<Vec<PackageInfo>> {
Ok(vec![
negotiate::PACKAGE_INFO.clone(),
kerberos::PACKAGE_INFO.clone(),
pku2u::PACKAGE_INFO.clone(),
ntlm::PACKAGE_INFO.clone(),
#[cfg(feature = "tsssp")]
credssp::sspi_cred_ssp::PACKAGE_INFO.clone(),
])
}
/// This trait provides interface for all available SSPI functions. The `acquire_credentials_handle`,
/// `initialize_security_context`, and `accept_security_context` methods return Builders that make it
/// easier to assemble the list of arguments for the function and then execute it.
///
/// # MSDN
///
/// * [SSPI.h](https://docs.microsoft.com/en-us/windows/win32/api/sspi/)
pub trait Sspi
where
Self: Sized + SspiImpl,
{
/// Acquires a handle to preexisting credentials of a security principal. The preexisting credentials are
/// available only for `sspi::winapi` module. This handle is required by the `initialize_security_context`
/// and `accept_security_context` functions. These can be either preexisting credentials, which are
/// established through a system logon, or the caller can provide alternative credentials. Alternative
/// credentials are always required to specify when using platform independent SSPs.
///
/// # Returns
///
/// * `AcquireCredentialsHandle` builder
///
/// # Requirements for execution
///
/// These methods are required to be called before calling the `execute` method of the `AcquireCredentialsHandle` builder:
/// * [`with_credential_use`](builders/struct.AcquireCredentialsHandle.html#method.with_credential_use)
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
///
/// let mut ntlm = sspi::Ntlm::new();
///
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// #[allow(unused_variables)]
/// let result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
/// ```
///
/// # MSDN
///
/// * [AcquireCredentialshandleW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acquirecredentialshandlew)
fn acquire_credentials_handle<'a>(
&mut self,
) -> EmptyAcquireCredentialsHandle<'a, Self::CredentialsHandle, Self::AuthenticationData> {
EmptyAcquireCredentialsHandle::new()
}
/// Initiates the client side, outbound security context from a credential handle.
/// The function is used to build a security context between the client application and a remote peer. The function returns a token
/// that the client must pass to the remote peer, which the peer in turn submits to the local security implementation through the
/// `accept_security_context` call.
///
/// # Returns
///
/// * `InitializeSecurityContext` builder
///
/// # Requirements for execution
///
/// These methods are required to be called before calling the `execute` method
/// * [`with_credentials_handle`](builders/struct.InitializeSecurityContext.html#method.with_credentials_handle)
/// * [`with_context_requirements`](builders/struct.InitializeSecurityContext.html#method.with_context_requirements)
/// * [`with_target_data_representation`](builders/struct.InitializeSecurityContext.html#method.with_target_data_representation)
/// * [`with_output`](builders/struct.InitializeSecurityContext.html#method.with_output)
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
/// use sspi::builders::EmptyInitializeSecurityContext;
/// use sspi::SspiImpl;
///
/// let mut ntlm = sspi::Ntlm::new();
///
/// let identity = sspi::AuthIdentity {
/// username: Username::new(&whoami::username(), Some(&whoami::hostname())).unwrap(),
/// password: String::from("password").into(),
/// };
///
/// let mut acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// let mut credentials_handle = acq_cred_result.credentials_handle;
///
/// let mut output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// #[allow(unused_variables)]
/// let mut builder = ntlm.initialize_security_context()
/// .with_credentials_handle(&mut credentials_handle)
/// .with_context_requirements(
/// sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY,
/// )
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_output(&mut output_buffer);
///
/// let result = ntlm.initialize_security_context_impl(&mut builder)
/// .unwrap()
/// .resolve_to_result()
/// .unwrap();
/// ```
///
/// # MSDN
///
/// * [InitializeSecurityContextW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-initializesecuritycontextw)
fn initialize_security_context<'a>(&mut self) -> EmptyInitializeSecurityContext<'a, Self::CredentialsHandle> {
InitializeSecurityContext::new()
}
/// Lets the server component of a transport application establish a security context between the server and a remote client.
/// The remote client calls the `initialize_security_context` function to start the process of establishing a security context.
/// The server can require one or more reply tokens from the remote client to complete establishing the security context.
///
/// # Returns
///
/// * `AcceptSecurityContext` builder
///
/// # Requirements for execution
///
/// These methods are required to be called before calling the `execute` method of the `AcceptSecurityContext` builder:
/// * [`with_credentials_handle`](builders/struct.AcceptSecurityContext.html#method.with_credentials_handle)
/// * [`with_context_requirements`](builders/struct.AcceptSecurityContext.html#method.with_context_requirements)
/// * [`with_target_data_representation`](builders/struct.AcceptSecurityContext.html#method.with_target_data_representation)
/// * [`with_output`](builders/struct.AcceptSecurityContext.html#method.with_output)
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
/// use sspi::builders::EmptyInitializeSecurityContext;
/// use sspi::SspiImpl;
///
/// let mut client_ntlm = sspi::Ntlm::new();
///
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// let mut client_acq_cred_result = client_ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut client_ntlm)
/// .unwrap();
///
/// let mut client_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// let mut builder = client_ntlm.initialize_security_context()
/// .with_credentials_handle(&mut client_acq_cred_result.credentials_handle)
/// .with_context_requirements(
/// sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY,
/// )
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_target_name("user")
/// .with_output(&mut client_output_buffer);
///
/// let _result = client_ntlm.initialize_security_context_impl(&mut builder)
/// .unwrap()
/// .resolve_to_result()
/// .unwrap();
///
/// let mut ntlm = sspi::Ntlm::new();
/// let mut output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// let mut server_acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Inbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// let mut credentials_handle = server_acq_cred_result.credentials_handle;
///
/// #[allow(unused_variables)]
/// let result = ntlm
/// .accept_security_context()
/// .with_credentials_handle(&mut credentials_handle)
/// .with_context_requirements(sspi::ServerRequestFlags::ALLOCATE_MEMORY)
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_input(&mut client_output_buffer)
/// .with_output(&mut output_buffer)
/// .execute(&mut ntlm)
/// .unwrap();
/// ```
///
/// # MSDN
///
/// * [AcceptSecurityContext function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext)
fn accept_security_context<'a>(&mut self) -> EmptyAcceptSecurityContext<'a, Self::CredentialsHandle> {
EmptyAcceptSecurityContext::new()
}
/// Completes an authentication token. This function is used by protocols, such as DCE,
/// that need to revise the security information after the transport application has updated some message parameters.
///
/// # Parameters
///
/// * `token`: `SecurityBuffer` that contains the buffer descriptor for the entire message
///
/// # Returns
///
/// * `SspiOk` on success
/// * `Error` on error
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
/// use sspi::builders::EmptyInitializeSecurityContext;
/// use sspi::SspiImpl;
///
/// let mut client_ntlm = sspi::Ntlm::new();
/// let mut ntlm = sspi::Ntlm::new();
///
/// let mut client_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
/// let mut output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// let mut client_acq_cred_result = client_ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// let mut server_acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Inbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// loop {
/// client_output_buffer[0].buffer.clear();
///
/// let mut builder = client_ntlm.initialize_security_context()
/// .with_credentials_handle(&mut client_acq_cred_result.credentials_handle)
/// .with_context_requirements(
/// sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY,
/// )
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_target_name("user")
/// .with_input(&mut output_buffer)
/// .with_output(&mut client_output_buffer);
///
/// let _client_result = client_ntlm.initialize_security_context_impl(&mut builder)
/// .unwrap()
/// .resolve_to_result()
/// .unwrap();
///
/// let server_result = ntlm
/// .accept_security_context()
/// .with_credentials_handle(&mut server_acq_cred_result.credentials_handle)
/// .with_context_requirements(sspi::ServerRequestFlags::ALLOCATE_MEMORY)
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_input(&mut client_output_buffer)
/// .with_output(&mut output_buffer)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// if server_result.status == sspi::SecurityStatus::CompleteAndContinue
/// || server_result.status == sspi::SecurityStatus::CompleteNeeded
/// {
/// break;
/// }
/// }
///
/// #[allow(unused_variables)]
/// let result = ntlm
/// .complete_auth_token(&mut output_buffer)
/// .unwrap();
/// ```
///
/// # MSDN
///
/// * [CompleteAuthToken function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-completeauthtoken)
fn complete_auth_token(&mut self, token: &mut [SecurityBuffer]) -> Result<SecurityStatus>;
/// Encrypts a message to provide privacy. The function allows the application to choose among cryptographic algorithms supported by the chosen mechanism.
/// Some packages do not have messages to be encrypted or decrypted but rather provide an integrity hash that can be checked.
///
/// # Parameters
///
/// * `flags`: package-specific flags that indicate the quality of protection. A security package can use this parameter to enable the selection of cryptographic algorithms
/// * `message`: on input, the structure accepts one or more `SecurityBuffer` structures that can be of type `SecurityBufferType::Data`.
/// That buffer contains the message to be encrypted. The message is encrypted in place, overwriting the original contents of the structure.
/// * `sequence_number`: the sequence number that the transport application assigned to the message. If the transport application does not maintain sequence numbers, this parameter must be zero
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
/// use sspi::builders::EmptyInitializeSecurityContext;
/// use sspi::SspiImpl;
///
/// let mut client_ntlm = sspi::Ntlm::new();
/// let mut ntlm = sspi::Ntlm::new();
///
/// let mut client_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
/// let mut server_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// let mut client_acq_cred_result = client_ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut client_ntlm)
/// .unwrap();
///
/// let mut server_acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Inbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// loop {
/// client_output_buffer[0].buffer.clear();
///
/// let mut builder = client_ntlm.initialize_security_context()
/// .with_credentials_handle(&mut client_acq_cred_result.credentials_handle)
/// .with_context_requirements(
/// sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY,
/// )
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_target_name("user")
/// .with_input(&mut server_output_buffer)
/// .with_output(&mut client_output_buffer);
///
/// let _client_result = client_ntlm.initialize_security_context_impl(&mut builder)
/// .unwrap()
/// .resolve_to_result()
/// .unwrap();
///
/// let server_result = ntlm
/// .accept_security_context()
/// .with_credentials_handle(&mut server_acq_cred_result.credentials_handle)
/// .with_context_requirements(sspi::ServerRequestFlags::ALLOCATE_MEMORY)
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_input(&mut client_output_buffer)
/// .with_output(&mut server_output_buffer)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// if server_result.status == sspi::SecurityStatus::CompleteAndContinue
/// || server_result.status == sspi::SecurityStatus::CompleteNeeded
/// {
/// break;
/// }
/// }
///
/// let _result = ntlm
/// .complete_auth_token(&mut server_output_buffer)
/// .unwrap();
///
/// let mut msg_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token),
/// sspi::SecurityBuffer::new(Vec::from("This is a message".as_bytes()), sspi::SecurityBufferType::Data)];
///
/// println!("Unencrypted: {:?}", msg_buffer[1].buffer);
///
/// # #[allow(unused_variables)]
/// let result = ntlm
/// .encrypt_message(sspi::EncryptionFlags::empty(), &mut msg_buffer, 0).unwrap();
///
/// println!("Encrypted: {:?}", msg_buffer[1].buffer);
/// ```
///
/// # Returns
///
/// * `SspiOk` on success
/// * `Error` on error
///
/// # MSDN
///
/// * [EncryptMessage function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-encryptmessage)
fn encrypt_message(
&mut self,
flags: EncryptionFlags,
message: &mut [SecurityBuffer],
sequence_number: u32,
) -> Result<SecurityStatus>;
/// Decrypts a message. Some packages do not encrypt and decrypt messages but rather perform and check an integrity hash.
///
/// # Parameters
///
/// * `message`: on input, the structure references one or more `SecurityBuffer` structures.
/// At least one of these must be of type `SecurityBufferType::Data`.
/// That buffer contains the encrypted message. The encrypted message is decrypted in place, overwriting the original contents of its buffer
/// * `sequence_number`: the sequence number that the transport application assigned to the message. If the transport application does not maintain sequence numbers, this parameter must be zero
///
/// # Returns
///
/// * `DecryptionFlags` upon success
/// * `Error` on error
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
/// use sspi::builders::EmptyInitializeSecurityContext;
/// use sspi::SspiImpl;
///
/// let mut ntlm = sspi::Ntlm::new();
/// let mut server_ntlm = sspi::Ntlm::new();
///
/// let mut client_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
/// let mut server_output_buffer = vec![sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token)];
///
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// let mut client_acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Outbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm)
/// .unwrap();
///
/// let mut server_acq_cred_result = server_ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Inbound)
/// .with_auth_data(&identity)
/// .execute(&mut server_ntlm)
/// .unwrap();
///
/// loop {
/// client_output_buffer[0].buffer.clear();
///
/// let mut builder = ntlm.initialize_security_context()
/// .with_credentials_handle(&mut client_acq_cred_result.credentials_handle)
/// .with_context_requirements(
/// sspi::ClientRequestFlags::CONFIDENTIALITY | sspi::ClientRequestFlags::ALLOCATE_MEMORY,
/// )
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_target_name("user")
/// .with_input(&mut server_output_buffer)
/// .with_output(&mut client_output_buffer);
///
/// let _client_result = ntlm.initialize_security_context_impl(&mut builder)
/// .unwrap()
/// .resolve_to_result()
/// .unwrap();
///
/// let server_result = server_ntlm
/// .accept_security_context()
/// .with_credentials_handle(&mut server_acq_cred_result.credentials_handle)
/// .with_context_requirements(sspi::ServerRequestFlags::ALLOCATE_MEMORY)
/// .with_target_data_representation(sspi::DataRepresentation::Native)
/// .with_input(&mut client_output_buffer)
/// .with_output(&mut server_output_buffer)
/// .execute(&mut server_ntlm)
/// .unwrap();
///
/// if server_result.status == sspi::SecurityStatus::CompleteAndContinue
/// || server_result.status == sspi::SecurityStatus::CompleteNeeded
/// {
/// break;
/// }
/// }
///
/// let _result = server_ntlm
/// .complete_auth_token(&mut server_output_buffer)
/// .unwrap();
///
/// let mut msg = [sspi::SecurityBuffer::new(Vec::new(), sspi::SecurityBufferType::Token),
/// sspi::SecurityBuffer::new(Vec::from("This is a message".as_bytes()), sspi::SecurityBufferType::Data)];
///
/// let _result = server_ntlm
/// .encrypt_message(sspi::EncryptionFlags::empty(), &mut msg, 0).unwrap();
///
/// let [mut token, mut data] = msg;
///
/// let mut msg_buffer = vec![
/// sspi::DecryptBuffer::Token(&mut token.buffer),
/// sspi::DecryptBuffer::Data(&mut data.buffer),
/// ];
///
/// #[allow(unused_variables)]
/// let encryption_flags = ntlm
/// .decrypt_message(&mut msg_buffer, 0)
/// .unwrap();
///
/// println!("Decrypted message: {:?}", msg_buffer[1].data());
/// ```
///
/// # MSDN
///
/// * [DecryptMessage function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-decryptmessage)
fn decrypt_message(&mut self, message: &mut [DecryptBuffer], sequence_number: u32) -> Result<DecryptionFlags>;
/// Retrieves information about the bounds of sizes of authentication information of the current security principal.
///
/// # Returns
///
/// * `ContextSizes` upon success
/// * `Error` on error
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// let mut ntlm = sspi::Ntlm::new();
/// let sizes = ntlm.query_context_sizes().unwrap();
/// println!("Max token: {}", sizes.max_token);
/// println!("Max signature: {}", sizes.max_signature);
/// println!("Block: {}", sizes.block);
/// println!("Security trailer: {}", sizes.security_trailer);
/// ```
///
/// # MSDN
///
/// * [QueryCredentialsAttributesW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-querycredentialsattributesw)
fn query_context_sizes(&mut self) -> Result<ContextSizes>;
/// Retrieves the username of the credential associated to the context.
///
/// # Returns
///
/// * `ContextNames` upon success
/// * `Error` on error
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// use sspi::Username;
///
/// let mut ntlm = sspi::Ntlm::new();
/// let identity = sspi::AuthIdentity {
/// username: Username::parse("user").unwrap(),
/// password: "password".to_string().into(),
/// };
///
/// let _acq_cred_result = ntlm
/// .acquire_credentials_handle()
/// .with_credential_use(sspi::CredentialUse::Inbound)
/// .with_auth_data(&identity)
/// .execute(&mut ntlm).unwrap();
///
/// let names = ntlm.query_context_names().unwrap();
/// println!("Username: {:?}", names.username.account_name());
/// println!("Domain: {:?}", names.username.domain_name());
/// ```
///
/// # MSDN
///
/// * [QuerySecurityPackageInfoW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-querysecuritypackageinfow)
fn query_context_names(&mut self) -> Result<ContextNames>;
/// Queries the sizes of the various parts of a stream used in the per-message functions. This function is implemented only for CredSSP security package.
///
/// # MSDN
///
/// * [QuerySecurityPackageInfoW function (`ulAttribute` parameter)](https://learn.microsoft.com/en-us/windows/win32/secauthn/querycontextattributes--schannel)
fn query_context_stream_sizes(&mut self) -> Result<StreamSizes> {
Err(Error::new(
ErrorKind::UnsupportedFunction,
"query_context_stream_sizes is not supported",
))
}
/// Retrieves information about the specified security package. This information includes the bounds of sizes of authentication information, credentials, and contexts.
///
/// # Returns
///
/// * `PackageInfo` containing the information about the package
/// * `Error` on error
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// let mut ntlm = sspi::Ntlm::new();
/// let info = ntlm.query_context_package_info().unwrap();
/// println!("Package name: {:?}", info.name);
/// ```
///
/// # MSDN
///
/// * [QuerySecurityPackageInfoW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-querysecuritypackageinfow)
fn query_context_package_info(&mut self) -> Result<PackageInfo>;
/// Retrieves the trust information of the certificate.
///
/// # Returns
///
/// * `CertTrustStatus` on success
///
/// # Example
///
/// ```
/// use sspi::Sspi;
/// let mut ntlm = sspi::Ntlm::new();
/// let cert_info = ntlm.query_context_package_info().unwrap();
/// ```
///
/// # MSDN
///
/// * [QueryContextAttributes (CredSSP) function (`ulAttribute` parameter)](https://docs.microsoft.com/en-us/windows/win32/secauthn/querycontextattributes--credssp)
fn query_context_cert_trust_status(&mut self) -> Result<CertTrustStatus>;
/// Retrieves the information about the end certificate supplied by the server. This function is implemented only for CredSSP security package.
///
/// # Returns
///
/// * `CertContext` on success
///
/// # MSDN
///
/// * [QueryContextAttributes (CredSSP) function (`ulAttribute` parameter)](https://docs.microsoft.com/en-us/windows/win32/secauthn/querycontextattributes--credssp)
fn query_context_remote_cert(&mut self) -> Result<CertContext> {
Err(Error::new(
ErrorKind::UnsupportedFunction,
"query_remote_cert_context is not supported",
))
}
/// Retrieves the information about the negotiated security package. This function is implemented only for CredSSP security package.
///
/// # Returns
///
/// * `PackageInfo` on success
///
/// # MSDN
///
/// * [QueryContextAttributes (CredSSP) function (`ulAttribute` parameter)](https://learn.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-querycontextattributesw)
fn query_context_negotiation_package(&mut self) -> Result<PackageInfo> {
Err(Error::new(
ErrorKind::UnsupportedFunction,
"query_context_negotiation_package is not supported",
))
}
/// Returns detailed information on the established connection. This function is implemented only for CredSSP security package.
///
/// # Returns
///
/// * `ConnectionInfo` on success
///
/// # MSDN
///
/// * [QueryContextAttributes (CredSSP) function (`ulAttribute` parameter)](https://docs.microsoft.com/en-us/windows/win32/secauthn/querycontextattributes--credssp)
fn query_context_connection_info(&mut self) -> Result<ConnectionInfo> {
Err(Error::new(
ErrorKind::UnsupportedFunction,
"query_context_connection_info is not supported",
))
}
/// Changes the password for a Windows domain account.
///
/// # Returns
///
/// * `()` on success
///
/// # Example
///
/// ```ignore
/// use sspi::{Sspi, ChangePasswordBuilder};
/// let mut ntlm = sspi::Ntlm::new();
/// let mut output = [];
/// let cert_info = ntlm.query_context_package_info().unwrap();
/// let change_password = ChangePasswordBuilder::new()
/// .with_domain_name("domain".into())
/// .with_account_name("username".into())
/// .with_old_password("old_password".into())
/// .with_old_password("new_password".into())
/// .with_output(&mut output)
/// .build()
/// .unwrap();
/// ntlm.change_password(change_password).unwrap();
/// ```
///
/// # MSDN
///
/// * [ChangeAccountPasswordW function](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-changeaccountpasswordw)
fn change_password<'a>(&'a mut self, change_password: ChangePassword<'a>) -> Result<GeneratorChangePassword>;
}
/// Protocol used to establish connection.
///
/// # MSDN
///
/// [SecPkgContext_ConnectionInfo (`dwProtocol` field)](https://learn.microsoft.com/en-us/windows/win32/api/schannel/ns-schannel-secpkgcontext_connectioninfo)
#[derive(Debug, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum ConnectionProtocol {
SpProtTls1Client = 0x80,
SpProtTls1Server = 0x40,
SpProtSsl3Client = 0x20,
SpProtSsl3Server = 0x10,
SpProtTls1_1Client = 0x200,
SpProtTls1_1Server = 0x100,
SpProtTls1_2Client = 0x800,
SpProtTls1_2Server = 0x400,
SpProtTls1_3Client = 0x00002000,
SpProtTls1_3Server = 0x00001000,
SpProtPct1Client = 0x2,
SpProtPct1Server = 0x1,
SpProtSsl2Client = 0x8,
SpProtSsl2Server = 0x4,
}
/// Algorithm identifier for the bulk encryption cipher used by the connection.
///
/// # MSDN
///
/// [SecPkgContext_ConnectionInfo (`aiCipher` field)](https://learn.microsoft.com/en-us/windows/win32/api/schannel/ns-schannel-secpkgcontext_connectioninfo)
#[derive(Debug, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum ConnectionCipher {
Calg3des = 26115,
CalgAes128 = 26126,
CalgAes256 = 26128,
CalgDes = 26113,
CalgRc2 = 26114,
CalgRc4 = 26625,
NoEncryption = 0,
}
/// ALG_ID indicating the hash used for generating Message Authentication Codes (MACs).
///
/// # MSDN
///
/// [SecPkgContext_ConnectionInfo (`aiHash` field)](https://learn.microsoft.com/en-us/windows/win32/api/schannel/ns-schannel-secpkgcontext_connectioninfo)
#[derive(Debug, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum ConnectionHash {
CalgMd5 = 32771,
CalgSha = 32772,
}
/// ALG_ID indicating the key exchange algorithm used to generate the shared master secret.
///
/// # MSDN
///
/// [SecPkgContext_ConnectionInfo (`aiExch` field)](https://learn.microsoft.com/en-us/windows/win32/api/schannel/ns-schannel-secpkgcontext_connectioninfo)
#[derive(Debug, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum ConnectionKeyExchange {
CalgRsaKeyx = 41984,
CalgDhEphem = 43522,
}
/// Type of certificate encoding used.
///
/// # MSDN
///
/// [CERT_CONTEXT (`dwCertEncodingType` field)](https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/ns-wincrypt-cert_context)
#[derive(Debug, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum CertEncodingType {
Pkcs7AsnEncoding = 65536,
X509AsnEncoding = 1,
}
/// The CERT_CONTEXT structure contains both the encoded and decoded representations of a certificate.
///
/// # MSDN
///
/// [CERT_CONTEXT](https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/ns-wincrypt-cert_context)
#[derive(Debug, Clone, PartialEq)]
pub struct CertContext {
pub encoding_type: CertEncodingType,
pub raw_cert: Vec<u8>,
pub cert: Certificate,
}
/// This structure contains protocol and cipher information.
///
/// # MSDN
///
/// [SecPkgContext_ConnectionInfo](https://learn.microsoft.com/en-us/windows/win32/api/schannel/ns-schannel-secpkgcontext_connectioninfo)
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ConnectionInfo {
pub protocol: ConnectionProtocol,
pub cipher: ConnectionCipher,
pub cipher_strength: u32,
pub hash: ConnectionHash,
pub hash_strength: u32,
pub key_exchange: ConnectionKeyExchange,
pub exchange_strength: u32,
}
/// Trait for performing authentication on the client or server side
pub trait SspiImpl {
/// Represents raw data for authentication
type CredentialsHandle;
/// Represents authentication data prepared for the authentication process
type AuthenticationData;
fn acquire_credentials_handle_impl(
&mut self,
builder: FilledAcquireCredentialsHandle<'_, Self::CredentialsHandle, Self::AuthenticationData>,
) -> Result<AcquireCredentialsHandleResult<Self::CredentialsHandle>>;
fn initialize_security_context_impl<'a>(
&'a mut self,
builder: &'a mut FilledInitializeSecurityContext<'a, Self::CredentialsHandle>,
) -> Result<GeneratorInitSecurityContext>;
fn accept_security_context_impl(
&mut self,
builder: FilledAcceptSecurityContext<'_, Self::CredentialsHandle>,
) -> Result<AcceptSecurityContextResult>;
}
pub trait SspiEx
where
Self: Sized + SspiImpl,
{
fn custom_set_auth_identity(&mut self, identity: Self::AuthenticationData) -> Result<()>;
}
pub type SspiPackage<'a, CredsHandle, AuthData> =
&'a mut dyn SspiImpl<CredentialsHandle = CredsHandle, AuthenticationData = AuthData>;
bitflags! {
/// Indicate the quality of protection. Used in the `encrypt_message` method.
///
/// # MSDN
///
/// * [EncryptMessage function (`fQOP` parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-encryptmessage)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct EncryptionFlags: u32 {
const WRAP_OOB_DATA = 0x4000_0000;
const WRAP_NO_ENCRYPT = 0x8000_0001;
}
}
bitflags! {
/// Indicate the quality of protection. Returned by the `decrypt_message` method.
///
/// # MSDN
///
/// * [DecryptMessage function (`pfQOP` parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-decryptmessage)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct DecryptionFlags: u32 {
const SIGN_ONLY = 0x8000_0000;
const WRAP_NO_ENCRYPT = 0x8000_0001;
}
}
bitflags! {
/// Indicate requests for the context. Not all packages can support all requirements. Bit flags can be combined by using bitwise-OR operations.
///
/// # MSDN
///
/// * [Context Requirements](https://docs.microsoft.com/en-us/windows/win32/secauthn/context-requirements)
/// * [InitializeSecurityContextW function (fContextReq parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-initializesecuritycontextw)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ClientRequestFlags: u32 {
/// The server can use the context to authenticate to other servers as the client.
/// The `MUTUAL_AUTH` flag must be set for this flag to work. Valid for Kerberos. Ignore this flag for constrained delegation.
const DELEGATE = 0x1;
/// The mutual authentication policy of the service will be satisfied.
const MUTUAL_AUTH = 0x2;
/// Detect replayed messages that have been encoded by using the `encrypt_message` or `make_signature` (TBI) functions.
const REPLAY_DETECT = 0x4;
/// Detect messages received out of sequence.
const SEQUENCE_DETECT = 0x8;
/// Encrypt messages by using the `encrypt_message` function.
const CONFIDENTIALITY = 0x10;
/// A new session key must be negotiated. This value is supported only by the Kerberos security package.
const USE_SESSION_KEY = 0x20;
const PROMPT_FOR_CREDS = 0x40;
/// Schannel must not attempt to supply credentials for the client automatically.
const USE_SUPPLIED_CREDS = 0x80;
/// The security package allocates output buffers for you.
const ALLOCATE_MEMORY = 0x100;
const USE_DCE_STYLE = 0x200;
const DATAGRAM = 0x400;
/// The security context will not handle formatting messages. This value is the default for the Kerberos, Negotiate, and NTLM security packages.
const CONNECTION = 0x800;
const CALL_LEVEL = 0x1000;
const FRAGMENT_SUPPLIED = 0x2000;
/// When errors occur, the remote party will be notified.
const EXTENDED_ERROR = 0x4000;
/// Support a stream-oriented connection.
const STREAM = 0x8000;
/// Sign messages and verify signatures by using the `encrypt_message` and `make_signature` (TBI) functions.
const INTEGRITY = 0x0001_0000;
const IDENTIFY = 0x0002_0000;
const NULL_SESSION = 0x0004_0000;
/// Schannel must not authenticate the server automatically.
const MANUAL_CRED_VALIDATION = 0x0008_0000;
const RESERVED1 = 0x0010_0000;
const FRAGMENT_TO_FIT = 0x0020_0000;
const FORWARD_CREDENTIALS = 0x0040_0000;
/// If this flag is set, the `Integrity` flag is ignored. This value is supported only by the Negotiate and Kerberos security packages.
const NO_INTEGRITY = 0x0080_0000;
const USE_HTTP_STYLE = 0x100_0000;
const UNVERIFIED_TARGET_NAME = 0x2000_0000;
const CONFIDENTIALITY_ONLY = 0x4000_0000;
}
}
bitflags! {
/// Specify the attributes required by the server to establish the context. Bit flags can be combined by using bitwise-OR operations.
///
/// # MSDN
///
/// * [Context Requirements](https://docs.microsoft.com/en-us/windows/win32/secauthn/context-requirements)
/// * [AcceptSecurityContext function function (fContextReq parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext?redirectedfrom=MSDN)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ServerRequestFlags: u32 {
/// The server is allowed to impersonate the client. Ignore this flag for [constrained delegation](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly).
const DELEGATE = 0x1;
const MUTUAL_AUTH = 0x2;
/// Detect replayed packets.
const REPLAY_DETECT = 0x4;
/// Detect messages received out of sequence.
const SEQUENCE_DETECT = 0x8;
const CONFIDENTIALITY = 0x10;
const USE_SESSION_KEY = 0x20;
const SESSION_TICKET = 0x40;
/// Credential Security Support Provider (CredSSP) will allocate output buffers.
const ALLOCATE_MEMORY = 0x100;
const USE_DCE_STYLE = 0x200;
const DATAGRAM = 0x400;
/// The security context will not handle formatting messages.
const CONNECTION = 0x800;
const CALL_LEVEL = 0x1000;
const FRAGMENT_SUPPLIED = 0x2000;
/// When errors occur, the remote party will be notified.
const EXTENDED_ERROR = 0x8000;
/// Support a stream-oriented connection.
const STREAM = 0x0001_0000;
const INTEGRITY = 0x0002_0000;
const LICENSING = 0x0004_0000;
const IDENTIFY = 0x0008_0000;
const ALLOW_NULL_SESSION = 0x0010_0000;
const ALLOW_NON_USER_LOGONS = 0x0020_0000;
const ALLOW_CONTEXT_REPLAY = 0x0040_0000;
const FRAGMENT_TO_FIT = 0x80_0000;
const NO_TOKEN = 0x100_0000;
const PROXY_BINDINGS = 0x400_0000;
const ALLOW_MISSING_BINDINGS = 0x1000_0000;
}
}
bitflags! {
/// Indicate the attributes of the established context.
///
/// # MSDN
///
/// * [Context Requirements](https://docs.microsoft.com/en-us/windows/win32/secauthn/context-requirements)
/// * [InitializeSecurityContextW function (pfContextAttr parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-initializesecuritycontextw)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ClientResponseFlags: u32 {
/// The server can use the context to authenticate to other servers as the client.
/// The `MUTUAL_AUTH` flag must be set for this flag to work. Valid for Kerberos. Ignore this flag for constrained delegation.
const DELEGATE = 0x1;
/// The mutual authentication policy of the service will be satisfied.
const MUTUAL_AUTH = 0x2;
/// Detect replayed messages that have been encoded by using the `encrypt_message` or `make_signature` (TBI) functions.
const REPLAY_DETECT = 0x4;
/// Detect messages received out of sequence.
const SEQUENCE_DETECT = 0x8;
/// Encrypt messages by using the `encrypt_message` function.
const CONFIDENTIALITY = 0x10;
/// A new session key must be negotiated. This value is supported only by the Kerberos security package.
const USE_SESSION_KEY = 0x20;
const USED_COLLECTED_CREDS = 0x40;
/// Schannel must not attempt to supply credentials for the client automatically.
const USED_SUPPLIED_CREDS = 0x80;
/// The security package allocates output buffers for you.
const ALLOCATED_MEMORY = 0x100;
const USED_DCE_STYLE = 0x200;
const DATAGRAM = 0x400;
/// The security context will not handle formatting messages. This value is the default for the Kerberos, Negotiate, and NTLM security packages.
const CONNECTION = 0x800;
const INTERMEDIATE_RETURN = 0x1000;
const CALL_LEVEL = 0x2000;
/// When errors occur, the remote party will be notified.
const EXTENDED_ERROR = 0x4000;
/// Support a stream-oriented connection.
const STREAM = 0x8000;
/// Sign messages and verify signatures by using the `encrypt_message` and `make_signature` (TBI) functions.
const INTEGRITY = 0x0001_0000;
const IDENTIFY = 0x0002_0000;
const NULL_SESSION = 0x0004_0000;
/// Schannel must not authenticate the server automatically.
const MANUAL_CRED_VALIDATION = 0x0008_0000;
const RESERVED1 = 0x10_0000;
const FRAGMENT_ONLY = 0x0020_0000;
const FORWARD_CREDENTIALS = 0x0040_0000;
const USED_HTTP_STYLE = 0x100_0000;
const NO_ADDITIONAL_TOKEN = 0x200_0000;
const REAUTHENTICATION = 0x800_0000;
const CONFIDENTIALITY_ONLY = 0x4000_0000;
}
}
bitflags! {
/// Indicate the attributes of the established context.
///
/// # MSDN
///
/// * [Context Requirements](https://docs.microsoft.com/en-us/windows/win32/secauthn/context-requirements)
/// * [AcceptSecurityContext function function (pfContextAttr parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext?redirectedfrom=MSDN)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ServerResponseFlags: u32 {
/// The server is allowed to impersonate the client. Ignore this flag for [constrained delegation](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly).
const DELEGATE = 0x1;
const MUTUAL_AUTH = 0x2;
/// Detect replayed packets.
const REPLAY_DETECT = 0x4;
/// Detect messages received out of sequence.
const SEQUENCE_DETECT = 0x8;
const CONFIDENTIALITY = 0x10;
const USE_SESSION_KEY = 0x20;
const SESSION_TICKET = 0x40;
/// Credential Security Support Provider (CredSSP) will allocate output buffers.
const ALLOCATED_MEMORY = 0x100;
const USED_DCE_STYLE = 0x200;
const DATAGRAM = 0x400;
/// The security context will not handle formatting messages.
const CONNECTION = 0x800;
const CALL_LEVEL = 0x2000;
const THIRD_LEG_FAILED = 0x4000;
/// When errors occur, the remote party will be notified.
const EXTENDED_ERROR = 0x8000;
/// Support a stream-oriented connection.
const STREAM = 0x0001_0000;
const INTEGRITY = 0x0002_0000;
const LICENSING = 0x0004_0000;
const IDENTIFY = 0x0008_0000;
const NULL_SESSION = 0x0010_0000;
const ALLOW_NON_USER_LOGONS = 0x0020_0000;
const ALLOW_CONTEXT_REPLAY = 0x0040_0000;
const FRAGMENT_ONLY = 0x0080_0000;
const NO_TOKEN = 0x100_0000;
const NO_ADDITIONAL_TOKEN = 0x200_0000;
}
}
/// The data representation, such as byte ordering, on the target.
///
/// # MSDN
///
/// * [AcceptSecurityContext function (TargetDataRep parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acceptsecuritycontext)
#[derive(Debug, Copy, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum DataRepresentation {
Network = 0,
Native = 0x10,
}
/// Describes a buffer allocated by a transport application to pass to a security package.
///
/// # MSDN
///
/// * [SecBuffer structure](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secbuffer)
#[derive(Clone)]
pub struct SecurityBuffer {
pub buffer: Vec<u8>,
pub buffer_type: SecurityBufferType,
}
impl fmt::Debug for SecurityBuffer {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "SecurityBuffer {{ buffer_type: {:?}, buffer: 0x", self.buffer_type)?;
self.buffer.iter().try_for_each(|byte| write!(f, "{byte:02X}"))?;
write!(f, " }}")?;
Ok(())
}
}
impl SecurityBuffer {
pub fn new(buffer: Vec<u8>, buffer_type: SecurityBufferType) -> Self {
Self { buffer, buffer_type }
}
pub fn find_buffer(buffers: &[SecurityBuffer], buffer_type: SecurityBufferType) -> Result<&SecurityBuffer> {
buffers.iter().find(|b| b.buffer_type == buffer_type).ok_or_else(|| {
Error::new(
ErrorKind::InvalidToken,
format!("No buffer was provided with type {:?}", buffer_type),
)
})
}
pub fn find_buffer_mut(
buffers: &mut [SecurityBuffer],
buffer_type: SecurityBufferType,
) -> Result<&mut SecurityBuffer> {
buffers
.iter_mut()
.find(|b| b.buffer_type == buffer_type)
.ok_or_else(|| {
Error::new(
ErrorKind::InvalidToken,
format!("No buffer was provided with type {:?}", buffer_type),
)
})
}
}
/// Bit flags that indicate the type of buffer.
///
/// # MSDN
///
/// * [SecBuffer structure (BufferType parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secbuffer)
#[repr(u32)]
#[derive(Debug, Copy, Clone, Eq, PartialEq, Default, FromPrimitive, ToPrimitive)]
pub enum SecurityBufferType {
#[default]
Empty = 0,
/// The buffer contains common data. The security package can read and write this data, for example, to encrypt some or all of it.
Data = 1,
/// The buffer contains the security token portion of the message. This is read-only for input parameters or read/write for output parameters.
Token = 2,
TransportToPackageParameters = 3,
/// The security package uses this value to indicate the number of missing bytes in a particular message.
Missing = 4,
/// The security package uses this value to indicate the number of extra or unprocessed bytes in a message.
Extra = 5,
/// The buffer contains a protocol-specific trailer for a particular record. It is not usually of interest to callers.
StreamTrailer = 6,
/// The buffer contains a protocol-specific header for a particular record. It is not usually of interest to callers.
StreamHeader = 7,
NegotiationInfo = 8,
Padding = 9,
Stream = 10,
ObjectIdsList = 11,
ObjectIdsListSignature = 12,
/// This flag is reserved. Do not use it.
Target = 13,
/// The buffer contains channel binding information.
ChannelBindings = 14,
/// The buffer contains a [DOMAIN_PASSWORD_INFORMATION](https://docs.microsoft.com/en-us/windows/win32/api/ntsecapi/ns-ntsecapi-domain_password_information) structure.
ChangePasswordResponse = 15,
/// The buffer specifies the [service principal name (SPN)](https://docs.microsoft.com/en-us/windows/win32/secgloss/s-gly) of the target.
TargetHost = 16,
/// The buffer contains an alert message.
Alert = 17,
/// The buffer contains a list of application protocol IDs, one list per application protocol negotiation extension type to be enabled.
ApplicationProtocol = 18,
/// The buffer contains a bitmask for a `ReadOnly` buffer.
AttributeMark = 0xF000_0000,
/// The buffer is read-only with no checksum. This flag is intended for sending header information to the security package for computing the checksum.
/// The package can read this buffer, but cannot modify it.
ReadOnly = 0x8000_0000,
/// The buffer is read-only with a checksum.
ReadOnlyWithChecksum = 0x1000_0000,
}
/// A flag that indicates how the credentials are used.
///
/// # MSDN
///
/// * [AcquireCredentialsHandleW function (fCredentialUse parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/nf-sspi-acquirecredentialshandlew)
#[derive(Debug, Copy, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum CredentialUse {
Inbound = 1,
Outbound = 2,
Both = 3,
Default = 4,
}
/// Represents the security principal in use.
#[derive(Debug, Clone)]
pub enum SecurityPackageType {
Ntlm,
Kerberos,
Negotiate,
Pku2u,
#[cfg(feature = "tsssp")]
CredSsp,
Other(String),
}
impl AsRef<str> for SecurityPackageType {
fn as_ref(&self) -> &str {
match self {
SecurityPackageType::Ntlm => ntlm::PKG_NAME,
SecurityPackageType::Kerberos => kerberos::PKG_NAME,
SecurityPackageType::Negotiate => negotiate::PKG_NAME,
SecurityPackageType::Pku2u => pku2u::PKG_NAME,
#[cfg(feature = "tsssp")]
SecurityPackageType::CredSsp => sspi_cred_ssp::PKG_NAME,
SecurityPackageType::Other(name) => name.as_str(),
}
}
}
impl string::ToString for SecurityPackageType {
fn to_string(&self) -> String {
match self {
SecurityPackageType::Ntlm => ntlm::PKG_NAME.into(),
SecurityPackageType::Kerberos => kerberos::PKG_NAME.into(),
SecurityPackageType::Negotiate => negotiate::PKG_NAME.into(),
SecurityPackageType::Pku2u => pku2u::PKG_NAME.into(),
#[cfg(feature = "tsssp")]
SecurityPackageType::CredSsp => sspi_cred_ssp::PKG_NAME.into(),
SecurityPackageType::Other(name) => name.clone(),
}
}
}
impl str::FromStr for SecurityPackageType {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
match s {
ntlm::PKG_NAME => Ok(SecurityPackageType::Ntlm),
kerberos::PKG_NAME => Ok(SecurityPackageType::Kerberos),
negotiate::PKG_NAME => Ok(SecurityPackageType::Negotiate),
pku2u::PKG_NAME => Ok(SecurityPackageType::Pku2u),
#[cfg(feature = "tsssp")]
sspi_cred_ssp::PKG_NAME => Ok(SecurityPackageType::CredSsp),
s => Ok(SecurityPackageType::Other(s.to_string())),
}
}
}
/// General security principal information
///
/// Provides general information about a security package, such as its name and capabilities. Returned by `query_security_package_info`.
///
/// # MSDN
///
/// * [SecPkgInfoW structure](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secpkginfow)
#[derive(Debug, Clone)]
pub struct PackageInfo {
pub capabilities: PackageCapabilities,
pub rpc_id: u16,
pub max_token_len: u32,
pub name: SecurityPackageType,
pub comment: String,
}
bitflags! {
/// Set of bit flags that describes the capabilities of the security package. It is possible to combine them.
///
/// # MSDN
///
/// * [SecPkgInfoW structure (`fCapabilities` parameter)](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secpkginfow)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct PackageCapabilities: u32 {
/// The security package supports the `make_signature` (TBI) and `verify_signature` (TBI) functions.
const INTEGRITY = 0x1;
/// The security package supports the `encrypt_message` and `decrypt_message` functions.
const PRIVACY = 0x2;
/// The package is interested only in the security-token portion of messages, and will ignore any other buffers. This is a performance-related issue.
const TOKEN_ONLY = 0x4;
/// Supports [datagram](https://docs.microsoft.com/en-us/windows/win32/secgloss/d-gly)-style authentication.
/// For more information, see [SSPI Context Semantics](https://docs.microsoft.com/en-us/windows/win32/secauthn/sspi-context-semantics).
const DATAGRAM = 0x8;
/// Supports connection-oriented style authentication. For more information, see [SSPI Context Semantics](https://docs.microsoft.com/en-us/windows/win32/secauthn/sspi-context-semantics).
const CONNECTION = 0x10;
/// Multiple legs are required for authentication.
const MULTI_REQUIRED = 0x20;
/// Server authentication support is not provided.
const CLIENT_ONLY = 0x40;
/// Supports extended error handling. For more information, see [Extended Error Information](https://docs.microsoft.com/en-us/windows/win32/secauthn/extended-error-information).
const EXTENDED_ERROR = 0x80;
/// Supports Windows impersonation in server contexts.
const IMPERSONATION = 0x100;
/// Understands Windows principal and target names.
const ACCEPT_WIN32_NAME = 0x200;
/// Supports stream semantics. For more information, see [SSPI Context Semantics](https://docs.microsoft.com/en-us/windows/win32/secauthn/sspi-context-semantics).
const STREAM = 0x400;
/// Can be used by the [Microsoft Negotiate](https://docs.microsoft.com/windows/desktop/SecAuthN/microsoft-negotiate) security package.
const NEGOTIABLE = 0x800;
/// Supports GSS compatibility.
const GSS_COMPATIBLE = 0x1000;
/// Supports [LsaLogonUser](https://docs.microsoft.com/windows/desktop/api/ntsecapi/nf-ntsecapi-lsalogonuser).
const LOGON = 0x2000;
/// Token buffers are in ASCII characters format.
const ASCII_BUFFERS = 0x4000;
/// Supports separating large tokens into smaller buffers so that applications can make repeated calls to
/// `initialize_security_context` and `accept_security_context` with the smaller buffers to complete authentication.
const FRAGMENT = 0x8000;
/// Supports mutual authentication.
const MUTUAL_AUTH = 0x1_0000;
/// Supports delegation.
const DELEGATION = 0x2_0000;
/// The security package supports using a checksum instead of in-place encryption when calling the `encrypt_message` function.
const READONLY_WITH_CHECKSUM = 0x4_0000;
/// Supports callers with restricted tokens.
const RESTRICTED_TOKENS = 0x8_0000;
/// The security package extends the [Microsoft Negotiate](https://docs.microsoft.com/windows/desktop/SecAuthN/microsoft-negotiate) security package.
/// There can be at most one package of this type.
const NEGO_EXTENDER = 0x10_0000;
/// This package is negotiated by the package of type `NEGO_EXTENDER`.
const NEGOTIABLE2 = 0x20_0000;
/// This package receives all calls from app container apps.
const APP_CONTAINER_PASSTHROUGH = 0x40_0000;
/// This package receives calls from app container apps if one of the following checks succeeds:
/// * Caller has default credentials capability
/// * The target is a proxy server
/// * The caller has supplied credentials
const APP_CONTAINER_CHECKS = 0x80_0000;
}
}
/// Indicates the sizes of the various parts of a stream for use with the message support functions.
/// `query_context_stream_sizes` function returns this structure.
///
/// # MSDN
///
/// * [SecPkgContext_StreamSizes](https://learn.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secpkgcontext_streamsizes)
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct StreamSizes {
pub header: u32,
pub trailer: u32,
pub max_message: u32,
pub buffers: u32,
pub block_size: u32,
}
/// Indicates the sizes of important structures used in the message support functions.
/// `query_context_sizes` function returns this structure.
///
/// # MSDN
///
/// * [SecPkgContext_Sizes structure](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secpkgcontext_sizes)
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ContextSizes {
pub max_token: u32,
pub max_signature: u32,
pub block: u32,
pub security_trailer: u32,
}
/// Contains trust information about a certificate in a certificate chain,
/// summary trust information about a simple chain of certificates, or summary information about an array of simple chains.
/// `query_context_cert_trust_status` function returns this structure.
///
/// # MSDN
///
/// * [CERT_TRUST_STATUS structure](https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/ns-wincrypt-cert_trust_status)
#[derive(Debug, Clone)]
pub struct CertTrustStatus {
pub error_status: CertTrustErrorStatus,
pub info_status: CertTrustInfoStatus,
}
bitflags! {
/// Flags representing the error status codes used in `CertTrustStatus`.
///
/// # MSDN
///
/// * [CERT_TRUST_STATUS structure](https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/ns-wincrypt-cert_trust_status)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CertTrustErrorStatus: u32 {
/// No error found for this certificate or chain.
const NO_ERROR = 0x0;
/// This certificate or one of the certificates in the certificate chain is not time valid.
const IS_NOT_TIME_VALID = 0x1;
const IS_NOT_TIME_NESTED = 0x2;
/// Trust for this certificate or one of the certificates in the certificate chain has been revoked.
const IS_REVOKED = 0x4;
/// The certificate or one of the certificates in the certificate chain does not have a valid signature.
const IS_NOT_SIGNATURE_VALID = 0x8;
/// The certificate or certificate chain is not valid for its proposed usage.
const IS_NOT_VALID_FOR_USAGE = 0x10;
/// The certificate or certificate chain is based on an untrusted root.
const IS_UNTRUSTED_ROOT = 0x20;
/// The revocation status of the certificate or one of the certificates in the certificate chain is unknown.
const REVOCATION_STATUS_UNKNOWN = 0x40;
/// One of the certificates in the chain was issued by a
/// [`certification authority`](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly)
/// that the original certificate had certified.
const IS_CYCLIC = 0x80;
/// One of the certificates has an extension that is not valid.
const INVALID_EXTENSION = 0x100;
/// The certificate or one of the certificates in the certificate chain has a policy constraints extension,
/// and one of the issued certificates has a disallowed policy mapping extension or does not have a
/// required issuance policies extension.
const INVALID_POLICY_CONSTRAINTS = 0x200;
/// The certificate or one of the certificates in the certificate chain has a basic constraints extension,
/// and either the certificate cannot be used to issue other certificates, or the chain path length has been exceeded.
const INVALID_BASIC_CONSTRAINTS = 0x400;
/// The certificate or one of the certificates in the certificate chain has a name constraints extension that is not valid.
const INVALID_NAME_CONSTRAINTS = 0x800;
/// The certificate or one of the certificates in the certificate chain has a name constraints extension that contains
/// unsupported fields. The minimum and maximum fields are not supported.
/// Thus minimum must always be zero and maximum must always be absent. Only UPN is supported for an Other Name.
/// The following alternative name choices are not supported:
/// * X400 Address
/// * EDI Party Name
/// * Registered Id
const HAS_NOT_SUPPORTED_NAME_CONSTRAINT = 0x1000;
/// The certificate or one of the certificates in the certificate chain has a name constraints extension and a name
/// constraint is missing for one of the name choices in the end certificate.
const HAS_NOT_DEFINED_NAME_CONSTRAINT = 0x2000;
/// The certificate or one of the certificates in the certificate chain has a name constraints extension,
/// and there is not a permitted name constraint for one of the name choices in the end certificate.
const HAS_NOT_PERMITTED_NAME_CONSTRAINT = 0x4000;
/// The certificate or one of the certificates in the certificate chain has a name constraints extension,
/// and one of the name choices in the end certificate is explicitly excluded.
const HAS_EXCLUDED_NAME_CONSTRAINT = 0x8000;
/// The certificate chain is not complete.
const IS_PARTIAL_CHAIN = 0x0001_0000;
/// A [certificate trust list](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly)
/// (CTL) used to create this chain was not time valid.
const CTL_IS_NOT_TIME_VALID = 0x0002_0000;
/// A CTL used to create this chain did not have a valid signature.
const CTL_IS_NOT_SIGNATURE_VALID = 0x0004_0000;
/// A CTL used to create this chain is not valid for this usage.
const CTL_IS_NOT_VALID_FOR_USAGE = 0x0008_0000;
/// The revocation status of the certificate or one of the certificates in the certificate chain is either offline or stale.
const IS_OFFLINE_REVOCATION = 0x100_0000;
/// The end certificate does not have any resultant issuance policies, and one of the issuing
/// [certification authority](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly)
/// certificates has a policy constraints extension requiring it.
const NO_ISSUANCE_CHAIN_POLICY = 0x200_0000;
}
}
bitflags! {
/// Flags representing the info status codes used in `CertTrustStatus`.
///
/// # MSDN
///
/// * [CERT_TRUST_STATUS structure](https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/ns-wincrypt-cert_trust_status)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CertTrustInfoStatus: u32 {
/// An exact match issuer certificate has been found for this certificate. This status code applies to certificates only.
const HAS_EXACT_MATCH_ISSUER = 0x1;
/// A key match issuer certificate has been found for this certificate. This status code applies to certificates only.
const HAS_KEY_MATCH_ISSUER = 0x2;
/// A name match issuer certificate has been found for this certificate. This status code applies to certificates only.
const HAS_NAME_MATCH_ISSUER = 0x4;
/// This certificate is self-signed. This status code applies to certificates only.
const IS_SELF_SIGNED = 0x8;
const AUTO_UPDATE_CA_REVOCATION = 0x10;
const AUTO_UPDATE_END_REVOCATION = 0x20;
const NO_OCSP_FAILOVER_TO_CRL = 0x40;
const IS_KEY_ROLLOVER = 0x80;
/// The certificate or chain has a preferred issuer. This status code applies to certificates and chains.
const HAS_PREFERRED_ISSUER = 0x100;
/// An issuance chain policy exists. This status code applies to certificates and chains.
const HAS_ISSUANCE_CHAIN_POLICY = 0x200;
/// A valid name constraints for all namespaces, including UPN. This status code applies to certificates and chains.
const HAS_VALID_NAME_CONSTRAINTS = 0x400;
/// This certificate is peer trusted. This status code applies to certificates only.
const IS_PEER_TRUSTED = 0x800;
/// This certificate's [certificate revocation list](https://docs.microsoft.com/windows/desktop/SecGloss/c-gly)
/// (CRL) validity has been extended. This status code applies to certificates only.
const HAS_CRL_VALIDITY_EXTENDED = 0x1000;
const IS_FROM_EXCLUSIVE_TRUST_STORE = 0x2000;
const IS_CA_TRUSTED = 0x4000;
const HAS_AUTO_UPDATE_WEAK_SIGNATURE = 0x8000;
const SSL_HANDSHAKE_OCSP = 0x0004_0000;
const SSL_TIME_VALID_OCSP = 0x0008_0000;
const SSL_RECONNECT_OCSP = 0x0010_0000;
const IS_COMPLEX_CHAIN = 0x0001_0000;
const HAS_ALLOW_WEAK_SIGNATURE = 0x0002_0000;
const SSL_TIME_VALID = 0x100_0000;
const NO_TIME_CHECK = 0x200_0000;
}
}
/// Indicates the name of the user associated with a security context.
/// `query_context_names` function returns this structure.
///
/// # MSDN
///
/// * [SecPkgContext_NamesW structure](https://docs.microsoft.com/en-us/windows/win32/api/sspi/ns-sspi-secpkgcontext_namesw)
#[derive(Debug, Clone)]
pub struct ContextNames {
pub username: Username,
}
/// The kind of an SSPI related error. Enables to specify an error based on its type.
///
/// [SSPI Status Codes](https://learn.microsoft.com/en-us/windows/win32/secauthn/sspi-status-codes).
#[repr(u32)]
#[derive(Debug, Copy, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum ErrorKind {
Unknown = 0,
InsufficientMemory = 0x8009_0300,
InvalidHandle = 0x8009_0301,
UnsupportedFunction = 0x8009_0302,
TargetUnknown = 0x8009_0303,
/// May correspond to any internal error (I/O error, server error, etc.).
InternalError = 0x8009_0304,
SecurityPackageNotFound = 0x8009_0305,
NotOwned = 0x8009_0306,
CannotInstall = 0x8009_0307,
/// Used in cases when supplied data is missing or invalid.
InvalidToken = 0x8009_0308,
CannotPack = 0x8009_0309,
OperationNotSupported = 0x8009_030A,
NoImpersonation = 0x8009_030B,
LogonDenied = 0x8009_030C,
UnknownCredentials = 0x8009_030D,
NoCredentials = 0x8009_030E,
/// Used in contexts of supplying invalid credentials.
MessageAltered = 0x8009_030F,
/// Used when a required NTLM state does not correspond to the current.
OutOfSequence = 0x8009_0310,
NoAuthenticatingAuthority = 0x8009_0311,
BadPackageId = 0x8009_0316,
ContextExpired = 0x8009_0317,
IncompleteMessage = 0x8009_0318,
IncompleteCredentials = 0x8009_0320,
BufferTooSmall = 0x8009_0321,
WrongPrincipalName = 0x8009_0322,
TimeSkew = 0x8009_0324,
UntrustedRoot = 0x8009_0325,
IllegalMessage = 0x8009_0326,
CertificateUnknown = 0x8009_0327,
CertificateExpired = 0x8009_0328,
EncryptFailure = 0x8009_0329,
DecryptFailure = 0x8009_0330,
AlgorithmMismatch = 0x8009_0331,
SecurityQosFailed = 0x8009_0332,
UnfinishedContextDeleted = 0x8009_0333,
NoTgtReply = 0x8009_0334,
NoIpAddress = 0x8009_0335,
WrongCredentialHandle = 0x8009_0336,
CryptoSystemInvalid = 0x8009_0337,
MaxReferralsExceeded = 0x8009_0338,
MustBeKdc = 0x8009_0339,
StrongCryptoNotSupported = 0x8009_033A,
TooManyPrincipals = 0x8009_033B,
NoPaData = 0x8009_033C,
PkInitNameMismatch = 0x8009_033D,
SmartCardLogonRequired = 0x8009_033E,
ShutdownInProgress = 0x8009_033F,
KdcInvalidRequest = 0x8009_0340,
KdcUnknownEType = 0x8009_0341,
KdcUnknownEType2 = 0x8009_0342,
UnsupportedPreAuth = 0x8009_0343,
DelegationRequired = 0x8009_0345,
BadBindings = 0x8009_0346,
MultipleAccounts = 0x8009_0347,
NoKerbKey = 0x8009_0348,
CertWrongUsage = 0x8009_0349,
DowngradeDetected = 0x8009_0350,
SmartCardCertificateRevoked = 0x8009_0351,
IssuingCAUntrusted = 0x8009_0352,
RevocationOffline = 0x8009_0353,
PkInitClientFailure = 0x8009_0354,
SmartCardCertExpired = 0x8009_0355,
NoS4uProtSupport = 0x8009_0356,
CrossRealmDelegationFailure = 0x8009_0357,
RevocationOfflineKdc = 0x8009_0358,
IssuingCaUntrustedKdc = 0x8009_0359,
KdcCertExpired = 0x8009_035A,
KdcCertRevoked = 0x8009_035B,
InvalidParameter = 0x8009_035D,
DelegationPolicy = 0x8009_035E,
PolicyNtlmOnly = 0x8009_035F,
NoContext = 0x8009_0361,
Pku2uCertFailure = 0x8009_0362,
MutualAuthFailed = 0x8009_0363,
OnlyHttpsAllowed = 0x8009_0365,
ApplicationProtocolMismatch = 0x8009_0367,
}
/// Holds the `ErrorKind` and the description of the SSPI-related error.
#[derive(Debug, Clone)]
pub struct Error {
pub error_type: ErrorKind,
pub description: String,
pub nstatus: Option<credssp::NStatusCode>,
}
/// The success status of SSPI-related operation.
#[derive(Debug, Copy, Clone, Eq, PartialEq, FromPrimitive, ToPrimitive)]
pub enum SecurityStatus {
Ok = 0,
ContinueNeeded = 0x0009_0312,
CompleteNeeded = 0x0009_0313,
CompleteAndContinue = 0x0009_0314,
LocalLogon = 0x0009_0315,
ContextExpired = 0x0009_0317,
IncompleteCredentials = 0x0009_0320,
Renegotiate = 0x0009_0321,
NoLsaContext = 0x0009_0323,
}
impl Error {
/// Allows to fill a new error easily, supplying it with a coherent description.
pub fn new(error_type: ErrorKind, description: impl ToString) -> Self {
Self {
error_type,
description: description.to_string(),
nstatus: None,
}
}
pub fn new_with_nstatus(
error_type: ErrorKind,
description: impl Into<String>,
status_code: credssp::NStatusCode,
) -> Self {
Self {
error_type,
description: description.into(),
nstatus: Some(status_code),
}
}
}
impl error::Error for Error {}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}: {}", self.error_type, self.description)?;
if let Some(nstatus) = self.nstatus {
write!(f, "; status is {}", nstatus)?;
}
Ok(())
}
}
impl From<Asn1DerError> for Error {
fn from(err: Asn1DerError) -> Self {
Self::new(ErrorKind::InvalidToken, format!("ASN1 DER error: {:?}", err))
}
}
impl From<KrbError> for Error {
fn from(krb_error: KrbError) -> Self {
let (error_kind, mut description) = map_keb_error_code_to_sspi_error(krb_error.0.error_code.0);
// https://www.rfc-editor.org/rfc/rfc4120#section-5.9.1
// This field contains additional text to help explain the error code
// associated with the failed request
if let Some(e_text) = krb_error.0.e_text.0 {
description.push_str(&format!(". Additional error text: {:?}", e_text.0));
}
// This field contains additional data about the error for use by the
// application to help it recover from or handle the error.
if let Some(e_data) = krb_error.0.e_data.0 {
description.push_str(&format!(". Additional error data: {:?}", e_data.0));
}
Error::new(error_kind, description)
}
}
impl From<picky_krb::crypto::KerberosCryptoError> for Error {
fn from(err: picky_krb::crypto::KerberosCryptoError) -> Self {
use picky_krb::crypto::KerberosCryptoError;
match err {
KerberosCryptoError::KeyLength(actual, expected) => Self::new(
ErrorKind::InvalidParameter,
format!("invalid key length. actual: {}. expected: {}", actual, expected),
),
KerberosCryptoError::CipherLength(actual, expected) => Self::new(
ErrorKind::InvalidParameter,
format!("invalid cipher length. actual: {}. expected: {}", actual, expected),
),
KerberosCryptoError::AlgorithmIdentifier(identifier) => Self::new(
ErrorKind::InvalidParameter,
format!("unknown algorithm identifier: {}", identifier),
),
KerberosCryptoError::IntegrityCheck => Self::new(ErrorKind::MessageAltered, err.to_string()),
KerberosCryptoError::CipherError(description) => Self::new(ErrorKind::InvalidParameter, description),
KerberosCryptoError::CipherPad(description) => {
Self::new(ErrorKind::InvalidParameter, description.to_string())
}
KerberosCryptoError::CipherUnpad(description) => {
Self::new(ErrorKind::InvalidParameter, description.to_string())
}
KerberosCryptoError::SeedBitLen(description) => Self::new(ErrorKind::InvalidParameter, description),
KerberosCryptoError::AlgorithmIdentifierData(identifier) => Self::new(
ErrorKind::InvalidParameter,
format!("unknown algorithm identifier: {:?}", identifier),
),
}
}
}
impl From<picky_krb::crypto::diffie_hellman::DiffieHellmanError> for Error {
fn from(error: picky_krb::crypto::diffie_hellman::DiffieHellmanError) -> Self {
use picky_krb::crypto::diffie_hellman::DiffieHellmanError;
match error {
DiffieHellmanError::BitLen(description) => Self::new(ErrorKind::InternalError, description),
error => Self::new(ErrorKind::InternalError, error.to_string()),
}
}
}
impl From<CharSetError> for Error {
fn from(err: CharSetError) -> Self {
Self::new(ErrorKind::InternalError, err.to_string())
}
}
impl From<GssApiMessageError> for Error {
fn from(err: GssApiMessageError) -> Self {
match err {
GssApiMessageError::IoError(err) => Self::from(err),
GssApiMessageError::InvalidId(_, _) => Self::new(ErrorKind::InvalidToken, err.to_string()),
GssApiMessageError::InvalidMicFiller(_) => Self::new(ErrorKind::InvalidToken, err.to_string()),
GssApiMessageError::InvalidWrapFiller(_) => Self::new(ErrorKind::InvalidToken, err.to_string()),
GssApiMessageError::Asn1Error(_) => Self::new(ErrorKind::InvalidToken, err.to_string()),
}
}
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Self {
Self::new(ErrorKind::InternalError, format!("IO error: {:?}", err))
}
}
impl From<rand::Error> for Error {
fn from(err: rand::Error) -> Self {
Self::new(ErrorKind::InternalError, format!("Rand error: {:?}", err))
}
}
impl From<std::str::Utf8Error> for Error {
fn from(err: std::str::Utf8Error) -> Self {
Self::new(ErrorKind::InternalError, format!("UTF-8 error: {:?}", err))
}
}
impl From<std::string::FromUtf8Error> for Error {
fn from(err: std::string::FromUtf8Error) -> Self {
Self::new(ErrorKind::InternalError, format!("UTF-8 error: {:?}", err))
}
}
impl From<string::FromUtf16Error> for Error {
fn from(err: string::FromUtf16Error) -> Self {
Self::new(ErrorKind::InternalError, format!("UTF-16 error: {:?}", err))
}
}
impl From<Error> for io::Error {
fn from(err: Error) -> io::Error {
io::Error::new(
io::ErrorKind::Other,
format!("{:?}: {}", err.error_type, err.description),
)
}
}
impl From<std::num::TryFromIntError> for Error {
fn from(_: std::num::TryFromIntError) -> Self {
Self::new(ErrorKind::InternalError, "Integer conversion error")
}
}
impl<T> From<std::sync::PoisonError<T>> for Error {
fn from(_: std::sync::PoisonError<T>) -> Self {
Self::new(ErrorKind::InternalError, "Can not lock SspiHandle mutex")
}
}
#[cfg(feature = "scard")]
impl From<pcsc::Error> for Error {
fn from(_value: pcsc::Error) -> Self {
Self::new(ErrorKind::InternalError, "pcsc error".to_owned())
}
}
#[cfg(feature = "scard")]
impl From<picky::key::KeyError> for Error {
fn from(err: picky::key::KeyError) -> Self {
Self::new(ErrorKind::InternalError, format!("RSA key error: {:?}", err))
}
}
#[cfg(feature = "scard")]
impl From<winscard::Error> for Error {
fn from(value: winscard::Error) -> Self {
Self::new(
ErrorKind::InternalError,
format!("Error while using a smart card: {}", value),
)
}
}