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
//! Communicate with smart cards using the PC/SC API.
//!
//! PC/SC (Personal Computer/Smart Card) is a standard API for
//! communicating with smart cards -- enumerating card readers, connecting
//! to smart cards, sending them commands, etc. See [Wikipedia][1] and
//! [PC/SC Workgroup][2] for more information.
//!
//! [1]: https://en.wikipedia.org/wiki/PC/SC
//! [2]: https://pcscworkgroup.com/
//!
//! This library is a safe and ergonomic FFI wrapper around the following
//! PC/SC implementations:
//!
//! - On Windows, the built-in `WinSCard.dll` library and "Smart Card"
//! service. See [MSDN][3] for documentation of the implemented API.
//!
//! - On macOS, the built-in PCSC framework.
//!
//! - On Linux, BSDs and (hopefully) other systems, the PCSC lite library
//! and pcscd daemon. See [pcsclite][4] for documentation of the
//! implemented API.
//!
//! This crate depends on the [`pcsc-sys`][5] crate. See its documentation
//! if you need to customize how the PCSC implementation is found.
//!
//! [3]: https://msdn.microsoft.com/EN-US/library/aa374731.aspx#smart_card_functions
//! [4]: https://pcsclite.apdu.fr/
//! [5]: https://docs.rs/pcsc-sys
//!
//! ## Communicating with a smart card
//!
//! To communicate with a smart card, you send it APDU (Application
//! Protocol Data Unit) commands, and receive APDU responses.
//!
//! The format of these commands is described in the [ISO 7816 Part 4][6]
//! standard. The commands themselves vary based on the application on the
//! card.
//!
//! [6]: https://cardwerk.com/iso-7816-part-4/
//!
//! ## Note on portability
//!
//! The various implementations are not fully consistent with each other,
//! and some may also miss various features or exhibit various bugs.
//! Hence, you cannot assume that code which works on one platform will
//! behave the same in all other platforms - unfortunately, some
//! adjustments might be needed to reach a common base. See [pcsclite][4]
//! for a list of documented differences, and [Ludovic Rousseau's blog][7]
//! archive for many more details.
//!
//! [7]: https://ludovicrousseau.blogspot.com/
//!
//! Not all PC/SC functionality is covered yet; if you are missing
//! something, please open an issue.
//!
//! ## Note on strings
//!
//! The library uses C strings (`&CStr`) for all strings (e.g. card reader
//! names), to avoid any allocation and conversion overhead.
//!
//! In pcsclite and macOS, all strings are guaranteed to be UTF-8 encoded.
//!
//! In Windows, the API provides two variants of all functions dealing
//! with strings - ASCII and Unicode (in this case, meaning 16-bits wide
//! strings). For ease of implementation, this library wraps the ASCII
//! variants only. (If you require Unicode names in Windows, please open
//! an issue.)
//!
//! Since ASCII is a subset of UTF-8, you can thus safely use UTF-8
//! conversion functions such as `to_str()` to obtain an `&str`/`String`
//! from this library -- but don't do this if you don't need to ☺
//!
//! ## Note on thread safety and blocking operations
//!
//! A library context can be safely moved to another thread or cloned and
//! used from multiple threads.
//!
//! Operations on a given context are not performed concurrently. If one
//! thread performs a blocking operation on a context, such as
//! `get_status_change()`, then another operation on the context will
//! block until the ongoing operation finishes.
//!
//! An ongoing blocking operation on a context can be canceled from another
//! thread by calling the `cancel` function on the context.
//!
//! If you want to perform concurrent operations, for example, monitor
//! smart card reader changes in one thread, and send commands to cards in
//! another, create a different context for each thread.
//!
//! Note however, that if one context has an exclusive transaction with a
//! card, any operation on the same underlying card from not within the
//! transaction will block even across contexts.
//!
//! When issuing a series of commands to a card, it is recommended to always
//! use a transaction -- other programs and even system services can get in
//! the way otherwise, even if you don't expect it.
//!
//! See [MSDN][8] for more details.
//!
//! [8]: https://msdn.microsoft.com/en-us/library/ms953432.aspx#smartcardcspcook_topic2
#![allow(deprecated)]
#![allow(clippy::bad_bit_mask)]
use std::ffi::{CStr, CString};
use std::mem::{forget, transmute};
use std::ops::Deref;
use std::os::raw::c_char;
use std::ptr::{null, null_mut};
use std::sync::Arc;
use bitflags::bitflags;
pub use pcsc_sys as ffi;
use ffi::{DWORD, LONG};
// We use these instead of std::mem::uninitialized -- variables which are
// set to this are always overridden and the dummy values are never exposed.
const DUMMY_LONG: LONG = -1;
const DUMMY_DWORD: DWORD = 0xdead_beef;
// Note on potentially problematic casts (clippy lints `cast-sign-loss`,
// `cast-possible-truncation`): from my analysis they are all OK, for
// both 32bit and 64bit DWORD/LONG. But it is sketchy.
bitflags! {
/// A mask of the state a card reader.
pub struct State: DWORD {
const UNAWARE = ffi::SCARD_STATE_UNAWARE;
const IGNORE = ffi::SCARD_STATE_IGNORE;
const CHANGED = ffi::SCARD_STATE_CHANGED;
const UNKNOWN = ffi::SCARD_STATE_UNKNOWN;
const UNAVAILABLE = ffi::SCARD_STATE_UNAVAILABLE;
const EMPTY = ffi::SCARD_STATE_EMPTY;
const PRESENT = ffi::SCARD_STATE_PRESENT;
const ATRMATCH = ffi::SCARD_STATE_ATRMATCH;
const EXCLUSIVE = ffi::SCARD_STATE_EXCLUSIVE;
const INUSE = ffi::SCARD_STATE_INUSE;
const MUTE = ffi::SCARD_STATE_MUTE;
const UNPOWERED = ffi::SCARD_STATE_UNPOWERED;
}
}
bitflags! {
/// A mask of the status of a card in a card reader.
///
/// # Portability note
///
/// On Windows, Status always has exactly one bit set, and the bit values do
/// not correspond to underlying PC/SC constants. This allows Status to be
/// used in the same way across all platforms.
pub struct Status: DWORD {
const UNKNOWN = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_UNKNOWN }
#[cfg(target_os = "windows")] { 0x0001 }
};
const ABSENT = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_ABSENT }
#[cfg(target_os = "windows")] { 0x0002 }
};
const PRESENT = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_PRESENT }
#[cfg(target_os = "windows")] { 0x0004 }
};
const SWALLOWED = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_SWALLOWED }
#[cfg(target_os = "windows")] { 0x0008 }
};
const POWERED = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_POWERED }
#[cfg(target_os = "windows")] { 0x0010 }
};
const NEGOTIABLE = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_NEGOTIABLE }
#[cfg(target_os = "windows")] { 0x0020 }
};
const SPECIFIC = {
#[cfg(not(target_os = "windows"))] { ffi::SCARD_SPECIFIC }
#[cfg(target_os = "windows")] { 0x0040 }
};
}
}
impl Status {
fn from_raw(raw_status: DWORD) -> Self {
#[cfg(target_os = "windows")]
match raw_status {
ffi::SCARD_UNKNOWN => Status::UNKNOWN,
ffi::SCARD_ABSENT => Status::ABSENT,
ffi::SCARD_PRESENT => Status::PRESENT,
ffi::SCARD_SWALLOWED => Status::SWALLOWED,
ffi::SCARD_POWERED => Status::POWERED,
ffi::SCARD_NEGOTIABLE => Status::NEGOTIABLE,
ffi::SCARD_SPECIFIC => Status::SPECIFIC,
_ => Status::empty(),
}
#[cfg(not(target_os = "windows"))]
Status::from_bits_truncate(raw_status)
}
}
/// How a reader connection is shared.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ShareMode {
Exclusive = ffi::SCARD_SHARE_EXCLUSIVE as u32,
Shared = ffi::SCARD_SHARE_SHARED as u32,
Direct = ffi::SCARD_SHARE_DIRECT as u32,
}
impl ShareMode {
fn into_raw(self) -> DWORD {
DWORD::from(self as u32)
}
}
/// A smart card communication protocol.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Protocol {
T0 = ffi::SCARD_PROTOCOL_T0 as u32,
T1 = ffi::SCARD_PROTOCOL_T1 as u32,
RAW = ffi::SCARD_PROTOCOL_RAW as u32,
}
impl Protocol {
fn from_raw(raw: DWORD) -> Option<Protocol> {
match raw {
ffi::SCARD_PROTOCOL_UNDEFINED => None,
ffi::SCARD_PROTOCOL_T0 => Some(Protocol::T0),
ffi::SCARD_PROTOCOL_T1 => Some(Protocol::T1),
ffi::SCARD_PROTOCOL_RAW => Some(Protocol::RAW),
// This should not be possible, since we only allow to select
// from Protocol's variants (or none).
_ => panic!("impossible protocol: {:#x}", raw),
}
}
}
bitflags! {
/// A mask of possible communication protocols.
pub struct Protocols: DWORD {
const UNDEFINED = ffi::SCARD_PROTOCOL_UNDEFINED;
const T0 = ffi::SCARD_PROTOCOL_T0;
const T1 = ffi::SCARD_PROTOCOL_T1;
const RAW = ffi::SCARD_PROTOCOL_RAW;
const ANY = ffi::SCARD_PROTOCOL_ANY;
}
}
/// Disposition method when disconnecting from a card reader.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Disposition {
LeaveCard = ffi::SCARD_LEAVE_CARD as u32,
ResetCard = ffi::SCARD_RESET_CARD as u32,
UnpowerCard = ffi::SCARD_UNPOWER_CARD as u32,
EjectCard = ffi::SCARD_EJECT_CARD as u32,
}
impl Disposition {
fn into_raw(self) -> DWORD {
DWORD::from(self as u32)
}
}
/// Possible library errors.
///
/// See [pcsclite][1], [MSDN][2].
///
/// [1]: https://pcsclite.apdu.fr/api/group__ErrorCodes.html
/// [2]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa374738(v=vs.85).aspx#smart_card_return_values
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Error {
// <contiguous block 1>
InternalError = ffi::SCARD_F_INTERNAL_ERROR as u32,
Cancelled = ffi::SCARD_E_CANCELLED as u32,
InvalidHandle = ffi::SCARD_E_INVALID_HANDLE as u32,
InvalidParameter = ffi::SCARD_E_INVALID_PARAMETER as u32,
InvalidTarget = ffi::SCARD_E_INVALID_TARGET as u32,
NoMemory = ffi::SCARD_E_NO_MEMORY as u32,
WaitedTooLong = ffi::SCARD_F_WAITED_TOO_LONG as u32,
InsufficientBuffer = ffi::SCARD_E_INSUFFICIENT_BUFFER as u32,
UnknownReader = ffi::SCARD_E_UNKNOWN_READER as u32,
Timeout = ffi::SCARD_E_TIMEOUT as u32,
SharingViolation = ffi::SCARD_E_SHARING_VIOLATION as u32,
NoSmartcard = ffi::SCARD_E_NO_SMARTCARD as u32,
UnknownCard = ffi::SCARD_E_UNKNOWN_CARD as u32,
CantDispose = ffi::SCARD_E_CANT_DISPOSE as u32,
ProtoMismatch = ffi::SCARD_E_PROTO_MISMATCH as u32,
NotReady = ffi::SCARD_E_NOT_READY as u32,
InvalidValue = ffi::SCARD_E_INVALID_VALUE as u32,
SystemCancelled = ffi::SCARD_E_SYSTEM_CANCELLED as u32,
CommError = ffi::SCARD_F_COMM_ERROR as u32,
UnknownError = ffi::SCARD_F_UNKNOWN_ERROR as u32,
InvalidAtr = ffi::SCARD_E_INVALID_ATR as u32,
NotTransacted = ffi::SCARD_E_NOT_TRANSACTED as u32,
ReaderUnavailable = ffi::SCARD_E_READER_UNAVAILABLE as u32,
Shutdown = ffi::SCARD_P_SHUTDOWN as u32,
PciTooSmall = ffi::SCARD_E_PCI_TOO_SMALL as u32,
ReaderUnsupported = ffi::SCARD_E_READER_UNSUPPORTED as u32,
DuplicateReader = ffi::SCARD_E_DUPLICATE_READER as u32,
CardUnsupported = ffi::SCARD_E_CARD_UNSUPPORTED as u32,
NoService = ffi::SCARD_E_NO_SERVICE as u32,
ServiceStopped = ffi::SCARD_E_SERVICE_STOPPED as u32,
#[cfg(target_os = "windows")]
Unexpected = ffi::SCARD_E_UNEXPECTED as u32,
IccInstallation = ffi::SCARD_E_ICC_INSTALLATION as u32,
IccCreateorder = ffi::SCARD_E_ICC_CREATEORDER as u32,
UnsupportedFeature = ffi::SCARD_E_UNSUPPORTED_FEATURE as u32,
DirNotFound = ffi::SCARD_E_DIR_NOT_FOUND as u32,
FileNotFound = ffi::SCARD_E_FILE_NOT_FOUND as u32,
NoDir = ffi::SCARD_E_NO_DIR as u32,
NoFile = ffi::SCARD_E_NO_FILE as u32,
NoAccess = ffi::SCARD_E_NO_ACCESS as u32,
WriteTooMany = ffi::SCARD_E_WRITE_TOO_MANY as u32,
BadSeek = ffi::SCARD_E_BAD_SEEK as u32,
InvalidChv = ffi::SCARD_E_INVALID_CHV as u32,
UnknownResMng = ffi::SCARD_E_UNKNOWN_RES_MNG as u32,
NoSuchCertificate = ffi::SCARD_E_NO_SUCH_CERTIFICATE as u32,
CertificateUnavailable = ffi::SCARD_E_CERTIFICATE_UNAVAILABLE as u32,
NoReadersAvailable = ffi::SCARD_E_NO_READERS_AVAILABLE as u32,
CommDataLost = ffi::SCARD_E_COMM_DATA_LOST as u32,
NoKeyContainer = ffi::SCARD_E_NO_KEY_CONTAINER as u32,
ServerTooBusy = ffi::SCARD_E_SERVER_TOO_BUSY as u32,
// </contiguous block 1>
// <contiguous block 2>
UnsupportedCard = ffi::SCARD_W_UNSUPPORTED_CARD as u32,
UnresponsiveCard = ffi::SCARD_W_UNRESPONSIVE_CARD as u32,
UnpoweredCard = ffi::SCARD_W_UNPOWERED_CARD as u32,
ResetCard = ffi::SCARD_W_RESET_CARD as u32,
RemovedCard = ffi::SCARD_W_REMOVED_CARD as u32,
SecurityViolation = ffi::SCARD_W_SECURITY_VIOLATION as u32,
WrongChv = ffi::SCARD_W_WRONG_CHV as u32,
ChvBlocked = ffi::SCARD_W_CHV_BLOCKED as u32,
Eof = ffi::SCARD_W_EOF as u32,
CancelledByUser = ffi::SCARD_W_CANCELLED_BY_USER as u32,
CardNotAuthenticated = ffi::SCARD_W_CARD_NOT_AUTHENTICATED as u32,
CacheItemNotFound = ffi::SCARD_W_CACHE_ITEM_NOT_FOUND as u32,
CacheItemStale = ffi::SCARD_W_CACHE_ITEM_STALE as u32,
CacheItemTooBig = ffi::SCARD_W_CACHE_ITEM_TOO_BIG as u32,
// </contiguous block 2>
}
impl Error {
#[allow(clippy::manual_range_contains)]
fn from_raw(raw: LONG) -> Error {
unsafe {
// The ranges here are the "blocks" above.
if ffi::SCARD_F_INTERNAL_ERROR <= raw && raw <= ffi::SCARD_E_SERVER_TOO_BUSY
|| ffi::SCARD_W_UNSUPPORTED_CARD <= raw && raw <= ffi::SCARD_W_CACHE_ITEM_TOO_BIG
{
transmute::<u32, Error>(raw as u32)
} else {
if cfg!(debug_assertions) {
panic!("unknown PCSC error code: {:#x}", raw);
}
// We mask unknown error codes here; this is not very nice,
// but seems better than panicking.
Error::UnknownError
}
}
}
fn into_raw(self) -> LONG {
// Note: not using LONG::from() - won't work when LONG is i32.
self as u32 as LONG
}
}
impl std::error::Error for Error {
fn description(&self) -> &str {
// The descriptions are from MSDN.
match *self {
Error::InternalError => "An internal consistency check failed",
Error::Cancelled => "The action was cancelled by an SCardCancel request",
Error::InvalidHandle => "The supplied handle was invalid",
Error::InvalidParameter => "One or more of the supplied parameters could not be properly interpreted",
Error::InvalidTarget => "Registry startup information is missing or invalid",
Error::NoMemory => "Not enough memory available to complete this command",
Error::WaitedTooLong => "An internal consistency timer has expired",
Error::InsufficientBuffer => "The data buffer to receive returned data is too small for the returned data",
Error::UnknownReader => "The specified reader name is not recognized",
Error::Timeout => "The user-specified timeout value has expired",
Error::SharingViolation => "The smart card cannot be accessed because of other connections outstanding",
Error::NoSmartcard => "The operation requires a Smart Card, but no Smart Card is currently in the device",
Error::UnknownCard => "The specified smart card name is not recognized",
Error::CantDispose => "The system could not dispose of the media in the requested manner",
Error::ProtoMismatch => {
"The requested protocols are incompatible with the protocol currently in use with the smart card"
}
Error::NotReady => "The reader or smart card is not ready to accept commands",
Error::InvalidValue => "One or more of the supplied parameters values could not be properly interpreted",
Error::SystemCancelled => "The action was cancelled by the system, presumably to log off or shut down",
Error::CommError => "An internal communications error has been detected",
Error::UnknownError => "An internal error has been detected, but the source is unknown",
Error::InvalidAtr => "An ATR obtained from the registry is not a valid ATR string",
Error::NotTransacted => "An attempt was made to end a non-existent transaction",
Error::ReaderUnavailable => "The specified reader is not currently available for use",
Error::Shutdown => "The operation has been aborted to allow the server application to exit",
Error::PciTooSmall => "The PCI Receive buffer was too small",
Error::ReaderUnsupported => "The reader driver does not meet minimal requirements for support",
Error::DuplicateReader => "The reader driver did not produce a unique reader name",
Error::CardUnsupported => "The smart card does not meet minimal requirements for support",
Error::NoService => "The Smart card resource manager is not running",
Error::ServiceStopped => "The Smart card resource manager has shut down",
#[cfg(target_os = "windows")]
Error::Unexpected => "An unexpected card error has occurred",
Error::UnsupportedFeature => "This smart card does not support the requested feature",
Error::IccInstallation => "No primary provider can be found for the smart card",
Error::IccCreateorder => "The requested order of object creation is not supported",
Error::DirNotFound => "The identified directory does not exist in the smart card",
Error::FileNotFound => "The identified file does not exist in the smart card",
Error::NoDir => "The supplied path does not represent a smart card directory",
Error::NoFile => "The supplied path does not represent a smart card file",
Error::NoAccess => "Access is denied to this file",
Error::WriteTooMany => "The smart card does not have enough memory to store the information",
Error::BadSeek => "There was an error trying to set the smart card file object pointer",
Error::InvalidChv => "The supplied PIN is incorrect",
Error::UnknownResMng => "An unrecognized error code was returned from a layered component",
Error::NoSuchCertificate => "The requested certificate does not exist",
Error::CertificateUnavailable => "The requested certificate could not be obtained",
Error::NoReadersAvailable => "Cannot find a smart card reader",
Error::CommDataLost => "A communications error with the smart card has been detected. Retry the operation",
Error::NoKeyContainer => "The requested key container does not exist on the smart card",
Error::ServerTooBusy => "The smart card resource manager is too busy to complete this operation",
Error::UnsupportedCard => {
"The reader cannot communicate with the card, due to ATR string configuration conflicts"
}
Error::UnresponsiveCard => "The smart card is not responding to a reset",
Error::UnpoweredCard => {
"Power has been removed from the smart card, so that further communication is not possible"
}
Error::ResetCard => "The smart card has been reset, so any shared state information is invalid",
Error::RemovedCard => "The smart card has been removed, so further communication is not possible",
Error::SecurityViolation => "Access was denied because of a security violation",
Error::WrongChv => "The card cannot be accessed because the wrong PIN was presented",
Error::ChvBlocked => {
"The card cannot be accessed because the maximum number of PIN entry attempts has been reached"
}
Error::Eof => "The end of the smart card file has been reached",
Error::CancelledByUser => r#"The user pressed "Cancel" on a Smart Card Selection Dialog"#,
Error::CardNotAuthenticated => "No PIN was presented to the smart card",
Error::CacheItemNotFound => "The requested item could not be found in the cache",
Error::CacheItemStale => "The requested cache item is too old and was deleted from the cache",
Error::CacheItemTooBig => "The new cache item exceeds the maximum per-item size defined for the cache",
}
}
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
f.write_str(std::error::Error::description(self))
}
}
macro_rules! try_pcsc {
($e:expr) => {
match $e {
ffi::SCARD_S_SUCCESS => (),
err => return Err(Error::from_raw(err)),
}
};
}
/// Scope of a context.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Scope {
User = ffi::SCARD_SCOPE_USER as u32,
Terminal = ffi::SCARD_SCOPE_TERMINAL as u32,
System = ffi::SCARD_SCOPE_SYSTEM as u32,
Global = ffi::SCARD_SCOPE_GLOBAL as u32,
}
impl Scope {
fn into_raw(self) -> DWORD {
DWORD::from(self as u32)
}
}
/// A class of Attributes.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum AttributeClass {
VendorInfo = ffi::SCARD_CLASS_VENDOR_INFO as u32,
Communications = ffi::SCARD_CLASS_COMMUNICATIONS as u32,
Protocol = ffi::SCARD_CLASS_PROTOCOL as u32,
PowerMgmt = ffi::SCARD_CLASS_POWER_MGMT as u32,
Security = ffi::SCARD_CLASS_SECURITY as u32,
Mechanical = ffi::SCARD_CLASS_MECHANICAL as u32,
VendorDefined = ffi::SCARD_CLASS_VENDOR_DEFINED as u32,
IfdProtocol = ffi::SCARD_CLASS_IFD_PROTOCOL as u32,
IccState = ffi::SCARD_CLASS_ICC_STATE as u32,
System = ffi::SCARD_CLASS_SYSTEM as u32,
}
/// Card reader attribute types.
#[repr(u32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Attribute {
VendorName = ffi::SCARD_ATTR_VENDOR_NAME as u32,
VendorIfdType = ffi::SCARD_ATTR_VENDOR_IFD_TYPE as u32,
VendorIfdVersion = ffi::SCARD_ATTR_VENDOR_IFD_VERSION as u32,
VendorIfdSerialNo = ffi::SCARD_ATTR_VENDOR_IFD_SERIAL_NO as u32,
ChannelId = ffi::SCARD_ATTR_CHANNEL_ID as u32,
AsyncProtocolTypes = ffi::SCARD_ATTR_ASYNC_PROTOCOL_TYPES as u32,
DefaultClk = ffi::SCARD_ATTR_DEFAULT_CLK as u32,
MaxClk = ffi::SCARD_ATTR_MAX_CLK as u32,
DefaultDataRate = ffi::SCARD_ATTR_DEFAULT_DATA_RATE as u32,
MaxDataRate = ffi::SCARD_ATTR_MAX_DATA_RATE as u32,
MaxIfsd = ffi::SCARD_ATTR_MAX_IFSD as u32,
SyncProtocolTypes = ffi::SCARD_ATTR_SYNC_PROTOCOL_TYPES as u32,
PowerMgmtSupport = ffi::SCARD_ATTR_POWER_MGMT_SUPPORT as u32,
UserToCardAuthDevice = ffi::SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE as u32,
UserAuthInputDevice = ffi::SCARD_ATTR_USER_AUTH_INPUT_DEVICE as u32,
Characteristics = ffi::SCARD_ATTR_CHARACTERISTICS as u32,
CurrentProtocolType = ffi::SCARD_ATTR_CURRENT_PROTOCOL_TYPE as u32,
CurrentClk = ffi::SCARD_ATTR_CURRENT_CLK as u32,
CurrentF = ffi::SCARD_ATTR_CURRENT_F as u32,
CurrentD = ffi::SCARD_ATTR_CURRENT_D as u32,
CurrentN = ffi::SCARD_ATTR_CURRENT_N as u32,
CurrentW = ffi::SCARD_ATTR_CURRENT_W as u32,
CurrentIfsc = ffi::SCARD_ATTR_CURRENT_IFSC as u32,
CurrentIfsd = ffi::SCARD_ATTR_CURRENT_IFSD as u32,
CurrentBwt = ffi::SCARD_ATTR_CURRENT_BWT as u32,
CurrentCwt = ffi::SCARD_ATTR_CURRENT_CWT as u32,
CurrentEbcEncoding = ffi::SCARD_ATTR_CURRENT_EBC_ENCODING as u32,
ExtendedBwt = ffi::SCARD_ATTR_EXTENDED_BWT as u32,
IccPresence = ffi::SCARD_ATTR_ICC_PRESENCE as u32,
IccInterfaceStatus = ffi::SCARD_ATTR_ICC_INTERFACE_STATUS as u32,
CurrentIoState = ffi::SCARD_ATTR_CURRENT_IO_STATE as u32,
AtrString = ffi::SCARD_ATTR_ATR_STRING as u32,
IccTypePerAtr = ffi::SCARD_ATTR_ICC_TYPE_PER_ATR as u32,
EscReset = ffi::SCARD_ATTR_ESC_RESET as u32,
EscCancel = ffi::SCARD_ATTR_ESC_CANCEL as u32,
EscAuthrequest = ffi::SCARD_ATTR_ESC_AUTHREQUEST as u32,
Maxinput = ffi::SCARD_ATTR_MAXINPUT as u32,
DeviceUnit = ffi::SCARD_ATTR_DEVICE_UNIT as u32,
DeviceInUse = ffi::SCARD_ATTR_DEVICE_IN_USE as u32,
DeviceFriendlyName = ffi::SCARD_ATTR_DEVICE_FRIENDLY_NAME as u32,
DeviceSystemName = ffi::SCARD_ATTR_DEVICE_SYSTEM_NAME as u32,
SupressT1IfsRequest = ffi::SCARD_ATTR_SUPRESS_T1_IFS_REQUEST as u32,
}
impl Attribute {
fn into_raw(self) -> DWORD {
DWORD::from(self as u32)
}
}
/// Maximum amount of bytes in an ATR.
pub const MAX_ATR_SIZE: usize = ffi::MAX_ATR_SIZE;
/// Maximum amount of bytes in a short APDU command or response.
pub const MAX_BUFFER_SIZE: usize = ffi::MAX_BUFFER_SIZE;
/// Maximum amount of bytes in an extended APDU command or response.
pub const MAX_BUFFER_SIZE_EXTENDED: usize = ffi::MAX_BUFFER_SIZE_EXTENDED;
/// A special reader name for detecting card reader insertions and removals.
///
/// # Note
///
/// This function is a wrapper around a constant, and is intended to be
/// used as such.
#[allow(non_snake_case)]
// We can't have a const &CStr yet, so we simulate it with a function.
pub fn PNP_NOTIFICATION() -> &'static CStr {
// The panic can't happen, but we avoid unsafe.
CStr::from_bytes_with_nul(b"\\\\?PnP?\\Notification\0").unwrap()
}
/// Transform a control code in the form expected by the platform.
///
/// Control codes passed to `Card::control` are usually defined as inputs
/// to this function.
///
/// This function wraps the `SCARD_CTL_CODE` macro.
pub fn ctl_code(code: DWORD) -> DWORD {
ffi::SCARD_CTL_CODE(code)
}
/// A structure for tracking the current state of card readers and cards.
///
/// This structure wraps `SCARD_READERSTATE` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24
/// [2]: https://msdn.microsoft.com/en-us/library/aa379808.aspx
#[repr(C)]
pub struct ReaderState {
// Note: must be directly transmutable to SCARD_READERSTATE.
inner: ffi::SCARD_READERSTATE,
}
// For some reason, linking in windows fails if we put these directly
// in statics. This is why we have this function instead of the
// SCARD_PCI_* defines from the C API.
fn get_protocol_pci(protocol: Protocol) -> &'static ffi::SCARD_IO_REQUEST {
unsafe {
match protocol {
Protocol::T0 => &ffi::g_rgSCardT0Pci,
Protocol::T1 => &ffi::g_rgSCardT1Pci,
Protocol::RAW => &ffi::g_rgSCardRawPci,
}
}
}
struct ContextInner {
handle: ffi::SCARDCONTEXT,
}
/// Library context to the PCSC service.
///
/// This structure wraps `SCARDCONTEXT`.
pub struct Context {
inner: Arc<ContextInner>,
}
/// A connection to a smart card.
///
/// This structure wraps `SCARDHANDLE`.
pub struct Card {
// Keeps the context alive.
_context: Context,
handle: ffi::SCARDHANDLE,
active_protocol: Option<Protocol>,
}
/// An exclusive transaction with a card.
///
/// A transaction ensures uninterrupted access to the card for its
/// duration. All other operations performed on the same underlying
/// card (even from other processes) will block until the transaction
/// is finished.
// By taking a mut reference to the card we statically enforce that:
// - There can only be one active transaction at a time.
// - All operations on the card must be performed through the transaction
// for the duration of the transaction's lifetime.
pub struct Transaction<'tx> {
card: &'tx mut Card,
}
/// An iterator over card reader names.
///
/// The iterator does not perform any copying or allocations; this is left
/// to the caller's discretion. It is therefore tied to the underlying
/// buffer.
#[derive(Clone, Debug)]
pub struct ReaderNames<'buf> {
buf: &'buf [u8],
pos: usize,
}
impl<'buf> Iterator for ReaderNames<'buf> {
type Item = &'buf CStr;
fn next(&mut self) -> Option<&'buf CStr> {
match self.buf[self.pos..].iter().position(|&c| c == 0) {
None | Some(0) => None,
Some(len) => {
let old_pos = self.pos;
self.pos += len + 1;
// The panic can't happen, but we avoid unsafe.
Some(CStr::from_bytes_with_nul(&self.buf[old_pos..self.pos]).unwrap())
}
}
}
}
impl Context {
/// Establish a new context.
///
/// This function wraps `SCardEstablishContext` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67
/// [2]: https://msdn.microsoft.com/en-us/library/aa379479.aspx
pub fn establish(scope: Scope) -> Result<Context, Error> {
unsafe {
let mut handle: ffi::SCARDCONTEXT = DUMMY_LONG as ffi::SCARDCONTEXT;
try_pcsc!(ffi::SCardEstablishContext(
scope.into_raw(),
null(),
null(),
&mut handle,
));
Ok(Context {
inner: Arc::new(ContextInner { handle }),
})
}
}
/// Release the context.
///
/// In case of error, ownership of the context is returned to the
/// caller.
///
/// This function wraps `SCardReleaseContext` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934
/// [2]: https://msdn.microsoft.com/en-us/library/aa379798.aspx
///
/// ## Note
///
/// `Context` implements `Drop` which automatically releases the
/// context; you only need to call this function if you want to handle
/// errors.
///
/// If the `Context` was cloned, and a clone is still alive, this
/// function will fail with `Error::CantDispose`.
pub fn release(self) -> Result<(), (Context, Error)> {
match Arc::try_unwrap(self.inner) {
Ok(inner) => {
unsafe {
let err = ffi::SCardReleaseContext(inner.handle);
if err != ffi::SCARD_S_SUCCESS {
let context = Context { inner: Arc::new(inner) };
return Err((context, Error::from_raw(err)));
}
// Skip the drop, we did it "manually".
forget(inner);
Ok(())
}
}
Err(arc_inner) => {
let context = Context { inner: arc_inner };
Err((context, Error::CantDispose))
}
}
}
/// Check whether the Context is still valid.
///
/// This function wraps `SCardIsValidContext` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga722eb66bcc44d391f700ff9065cc080b
/// [2]: https://msdn.microsoft.com/en-us/library/aa379788.aspx
pub fn is_valid(&self) -> Result<(), Error> {
unsafe {
try_pcsc!(ffi::SCardIsValidContext(self.inner.handle,));
Ok(())
}
}
/// Cancel any ongoing blocking operation in the Context.
///
/// See the `cancel.rs` example program.
///
/// This function wraps `SCardCancel` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6
/// [2]: https://msdn.microsoft.com/en-us/library/aa379470.aspx
pub fn cancel(&self) -> Result<(), Error> {
unsafe {
try_pcsc!(ffi::SCardCancel(self.inner.handle,));
Ok(())
}
}
/// List all connected card readers.
///
/// `buffer` is a buffer that should be large enough to hold all of
/// the connected reader names. The function `list_readers_len` can be
/// used to find the exact required length.
///
/// Returns an iterator over the reader names. The iterator yields
/// values directly from `buffer`.
///
/// If the buffer is not large enough to hold all of the names,
/// `Error::InsufficientBuffer` is returned.
///
/// This function wraps `SCardListReaders` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9
/// [2]: https://msdn.microsoft.com/en-us/library/aa379793.aspx
pub fn list_readers<'buf>(&self, buffer: &'buf mut [u8]) -> Result<ReaderNames<'buf>, Error> {
unsafe {
assert!(buffer.len() <= std::u32::MAX as usize);
let mut buflen = buffer.len() as DWORD;
// SCardListReaders treats null specially, to query the needed
// buffer length. We don't want the caller to be able to trigger
// this here -- should use `list_readers_len` instead. So needs
// some special treatment.
let bufptr = if buflen == 0 {
null_mut()
} else {
let ptr = buffer.as_mut_ptr() as *mut c_char;
assert!(!ptr.is_null());
ptr
};
let err = ffi::SCardListReaders(self.inner.handle, null(), bufptr, &mut buflen);
if err == Error::NoReadersAvailable.into_raw() {
return Ok(ReaderNames { buf: b"\0", pos: 0 });
}
if err != ffi::SCARD_S_SUCCESS {
return Err(Error::from_raw(err));
}
if bufptr.is_null() {
return Err(Error::InsufficientBuffer);
}
Ok(ReaderNames {
buf: &buffer[..buflen as usize],
pos: 0,
})
}
}
/// Get the needed length of a buffer to be passed to `list_readers`.
///
/// This function wraps `SCardListReaders` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9
/// [2]: https://msdn.microsoft.com/en-us/library/aa379793.aspx
pub fn list_readers_len(&self) -> Result<usize, Error> {
unsafe {
let mut buflen = DUMMY_DWORD;
let err = ffi::SCardListReaders(self.inner.handle, null(), null_mut(), &mut buflen);
if err == Error::NoReadersAvailable.into_raw() {
return Ok(0);
}
if err != ffi::SCARD_S_SUCCESS {
return Err(Error::from_raw(err));
}
Ok(buflen as usize)
}
}
/// List all connected card readers, allocating buffers of the required size.
///
/// This function wraps `SCardListReaders` ([pcsclite][1], [MSDN][2]). It is an owned version
/// of [`list_readers`](#method.list_readers), calling
/// [`list_readers_len`](#method.list_readers_len) to determine the required buffer size.
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9
/// [2]: https://msdn.microsoft.com/en-us/library/aa379793.aspx
pub fn list_readers_owned(&self) -> Result<Vec<CString>, Error> {
let len = self.list_readers_len()?;
if len == 0 {
return Ok(vec![]);
}
let mut buffer = vec![0u8; len];
Ok(self.list_readers(&mut buffer)?.map(ToOwned::to_owned).collect())
}
/// Connect to a card which is present in a reader.
///
/// See the `connect.rs` example program.
///
/// This function wraps `SCardConnect` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5
/// [2]: https://msdn.microsoft.com/en-us/library/aa379473.aspx
pub fn connect(&self, reader: &CStr, share_mode: ShareMode, preferred_protocols: Protocols) -> Result<Card, Error> {
unsafe {
let mut handle: ffi::SCARDHANDLE = DUMMY_LONG as ffi::SCARDHANDLE;
let mut raw_active_protocol: DWORD = DUMMY_DWORD;
try_pcsc!(ffi::SCardConnect(
self.inner.handle,
reader.as_ptr(),
share_mode.into_raw(),
preferred_protocols.bits(),
&mut handle,
&mut raw_active_protocol,
));
let active_protocol = Protocol::from_raw(raw_active_protocol);
Ok(Card {
_context: self.clone(),
handle,
active_protocol,
})
}
}
/// Wait for card and card reader state changes.
///
/// The function blocks until the state of one of the readers changes
/// from corresponding passed-in `ReaderState`. The `ReaderState`s are
/// updated to report the new state.
///
/// A special reader name, `\\?PnP?\Notification`, can be used to
/// detect card reader insertions and removals, as opposed to state
/// changes of a specific reader. Use `PNP_NOTIFICATION()` to easily
/// obtain a static reference to this name.
///
/// See the `monitor.rs` example program.
///
/// This function wraps `SCardGetStatusChange` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24
/// [2]: https://msdn.microsoft.com/en-us/library/aa379773.aspx
pub fn get_status_change<D>(&self, timeout: D, readers: &mut [ReaderState]) -> Result<(), Error>
where
D: Into<Option<std::time::Duration>>,
{
let timeout_ms = match timeout.into() {
Some(duration) => {
let timeout_ms_u64 = duration
.as_secs()
.saturating_mul(1000)
.saturating_add(u64::from(duration.subsec_nanos()) / 1_000_000);
std::cmp::min(ffi::INFINITE, timeout_ms_u64 as DWORD)
}
None => ffi::INFINITE,
};
unsafe {
assert!(readers.len() <= std::u32::MAX as usize);
try_pcsc!(ffi::SCardGetStatusChange(
self.inner.handle,
timeout_ms,
readers.as_mut_ptr() as *mut ffi::SCARD_READERSTATE,
readers.len() as DWORD,
));
Ok(())
}
}
}
impl Drop for ContextInner {
fn drop(&mut self) {
unsafe {
// Error is ignored here; to do proper error handling,
// release() should be called manually.
let _err = ffi::SCardReleaseContext(self.handle);
}
}
}
impl Clone for Context {
/// Clone the `Context`.
///
/// ## Implementation note
///
/// This is implemented in the Rust side with an `Arc::clone`.
fn clone(&self) -> Self {
Context {
inner: Arc::clone(&self.inner),
}
}
}
unsafe impl Send for Context {}
unsafe impl Sync for Context {}
impl ReaderState {
/// Create a ReaderState for a card reader with a given presumed
/// state.
pub fn new<T: Into<CString>>(name: T, current_state: State) -> ReaderState {
ReaderState {
inner: ffi::SCARD_READERSTATE {
szReader: name.into().into_raw(),
// This seems useless to expose.
pvUserData: null_mut(),
dwCurrentState: current_state.bits(),
dwEventState: State::UNAWARE.bits(),
cbAtr: 0,
rgbAtr: [0; ffi::ATR_BUFFER_SIZE],
},
}
}
/// The name of the card reader.
pub fn name(&self) -> &CStr {
// Lifetime elision assigns this the same lifetime as &self; this
// is what we want, and is safe.
unsafe { CStr::from_ptr(self.inner.szReader) }
}
/// The ATR (Answer To Reset) of the card inserted to the reader.
pub fn atr(&self) -> &[u8] {
&self.inner.rgbAtr[0..self.inner.cbAtr as usize]
}
/// The last current state that was set.
pub fn current_state(&self) -> State {
State::from_bits_truncate(self.inner.dwCurrentState)
}
/// The last reported state.
pub fn event_state(&self) -> State {
State::from_bits_truncate(self.inner.dwEventState)
}
/// The card event count.
///
/// The count is incremented for each card insertion or removal in the
/// reader. This can be used to detect a card removal/insertion
/// between two calls to `Context::get_status_change()`.
pub fn event_count(&self) -> u32 {
((self.inner.dwEventState & 0xFFFF_0000) >> 16) as u32
}
/// Sync the currently-known state to the last reported state.
pub fn sync_current_state(&mut self) {
// In windows it is important that the event count is included;
// otherwise PNP_NOTIFICATION is always reported as changed:
// https://stackoverflow.com/a/16467368
self.inner.dwCurrentState = self.inner.dwEventState;
}
}
impl Drop for ReaderState {
fn drop(&mut self) {
// Reclaim the name and drop it immediately.
unsafe { drop(CString::from_raw(self.inner.szReader as *mut c_char)) };
}
}
unsafe impl Send for ReaderState {}
unsafe impl Sync for ReaderState {}
/// Status of a card in a card reader.
#[derive(Clone, Debug)]
pub struct CardStatus<'names_buf, 'atr_buf> {
reader_names: ReaderNames<'names_buf>,
state: DWORD,
protocol: Option<Protocol>,
atr: &'atr_buf [u8],
}
impl<'names_buf, 'atr_buf> CardStatus<'names_buf, 'atr_buf> {
/// Iterator over the names by which the connected card reader is known.
pub fn reader_names(&self) -> ReaderNames<'names_buf> {
self.reader_names.clone()
}
/// Current status of the smart card in the reader.
pub fn status(&self) -> Status {
Status::from_raw(self.state)
}
/// Current protocol of the card, if any.
///
/// The value is meaningful only if a communication protocol has already
/// been established.
///
/// If connected to a reader directly without an active protocol, returns
/// None.
pub fn protocol2(&self) -> Option<Protocol> {
self.protocol
}
/// Current protocol of the card, if any.
///
/// The value is meaningful only if a communication protocol has already
/// been established.
///
/// ## Panics
///
/// This function panics when connected to a reader directly without an
/// active protocol. Use `protocol2()` instead if you want to avoid this.
pub fn protocol(&self) -> Protocol {
self.protocol
.expect("pcsc::CardStatus::protocol() does not support direct connections; use protocol2() instead")
}
/// The current ATR string of the card.
pub fn atr(&self) -> &'atr_buf [u8] {
self.atr
}
}
/// Status of a card in a card reader (owned).
///
/// This is an owned version of [`CardStatus`](struct.CardStatus.html).
#[derive(Clone, Debug)]
pub struct CardStatusOwned {
reader_names: Vec<CString>,
state: DWORD,
protocol: Option<Protocol>,
atr: Vec<u8>,
}
impl CardStatusOwned {
/// Slice of the names by which the connected card reader is known.
pub fn reader_names(&self) -> &[CString] {
&self.reader_names
}
/// Current status of the smart card in the reader.
pub fn status(&self) -> Status {
Status::from_raw(self.state)
}
/// Current protocol of the card, if any.
///
/// The value is meaningful only if a communication protocol has already
/// been established.
///
/// If connected to a reader directly without an active protocol, returns
/// None.
pub fn protocol2(&self) -> Option<Protocol> {
self.protocol
}
/// Current protocol of the card, if any.
///
/// The value is meaningful only if a communication protocol has already
/// been established.
///
/// ## Panics
///
/// This function panics when connected to a reader directly without an
/// active protocol. Use `protocol2()` instead if you want to avoid this.
pub fn protocol(&self) -> Protocol {
self.protocol
.expect("pcsc::CardStatus::protocol() does not support direct connections; use protocol2() instead")
}
/// The current ATR string of the card.
pub fn atr(&self) -> &[u8] {
&self.atr
}
}
impl Card {
/// Start a new exclusive transaction with the card.
///
/// Operations on the card for the duration of the transaction
/// can only be performed through the returned `Transaction`.
///
/// This function wraps `SCardBeginTransaction` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861
/// [2]: https://msdn.microsoft.com/en-us/library/aa379469.aspx
pub fn transaction(&mut self) -> Result<Transaction, Error> {
unsafe {
try_pcsc!(ffi::SCardBeginTransaction(self.handle,));
Ok(Transaction { card: self })
}
}
/// Start a new exclusive transaction with the card.
///
/// Operations on the card for the duration of the transaction
/// can only be performed through the returned `Transaction`.
///
/// This function is like [`Card::transaction`], but also returns the
/// reference to `self` on error. When starting a transaction, you might
/// want to deal with transient errors, like [`Error::ResetCard`], by
/// reconnecting to the card, and retrying the transaction. When this
/// functionality is wrapped, this doesn't work, because mutable references
/// can't be reborrowed (at least in current Rust). This function returns
/// the reference, which allows this construct.
///
/// This function wraps `SCardBeginTransaction` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861
/// [2]: https://msdn.microsoft.com/en-us/library/aa379469.aspx
pub fn transaction2(&mut self) -> Result<Transaction, (&mut Self, Error)> {
unsafe {
let err = ffi::SCardBeginTransaction(self.handle);
if err != ffi::SCARD_S_SUCCESS {
return Err((self, Error::from_raw(err)));
}
Ok(Transaction { card: self })
}
}
/// Reconnect to the card.
///
/// This function wraps `SCardReconnect` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gad5d4393ca8c470112ad9468c44ed8940
/// [2]: https://msdn.microsoft.com/en-us/library/aa379797.aspx
pub fn reconnect(
&mut self,
share_mode: ShareMode,
preferred_protocols: Protocols,
initialization: Disposition,
) -> Result<(), Error> {
unsafe {
let mut raw_active_protocol: DWORD = DUMMY_DWORD;
try_pcsc!(ffi::SCardReconnect(
self.handle,
share_mode.into_raw(),
preferred_protocols.bits(),
initialization.into_raw(),
&mut raw_active_protocol,
));
self.active_protocol = Protocol::from_raw(raw_active_protocol);
Ok(())
}
}
/// Disconnect from the card.
///
/// In case of error, ownership of the card is returned to the caller.
///
/// This function wraps `SCardDisconnect` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a
/// [2]: https://msdn.microsoft.com/en-us/library/aa379475.aspx
///
/// ## Note
///
/// `Card` implements `Drop` which automatically disconnects the card
/// using `Disposition::ResetCard`; you only need to call this
/// function if you want to handle errors or use a different
/// disposition method.
pub fn disconnect(mut self, disposition: Disposition) -> Result<(), (Card, Error)> {
unsafe {
let err = ffi::SCardDisconnect(self.handle, disposition.into_raw());
if err != ffi::SCARD_S_SUCCESS {
return Err((self, Error::from_raw(err)));
}
// Skip the drop, we did it "manually".
std::ptr::drop_in_place(&mut self._context);
forget(self);
Ok(())
}
}
/// Get current info on the card.
///
/// This function wraps `SCardStatus` ([pcsclite][1], [MSDN][2]).
///
/// ## Deprecated
///
/// The reader names and ATR return values are missing.
///
/// When there is no active protocol (as when connecting to the reader
/// directly), this function panics.
///
/// Use `status2()` or `status2_owned()` instead.
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
/// [2]: https://msdn.microsoft.com/en-us/library/aa379803.aspx
#[deprecated(since = "2.3.0", note = "Use status2() or status2_owned() instead.")]
pub fn status(&self) -> Result<(Status, Protocol), Error> {
unsafe {
let mut raw_status: DWORD = DUMMY_DWORD;
let mut raw_protocol: DWORD = DUMMY_DWORD;
try_pcsc!(ffi::SCardStatus(
self.handle,
null_mut(),
null_mut(),
&mut raw_status,
&mut raw_protocol,
null_mut(),
null_mut(),
));
let status = Status::from_raw(raw_status);
let protocol = Protocol::from_raw(raw_protocol)
.expect("pcsc::Card::status() does not support direct connections; use status2() instead");
Ok((status, protocol))
}
}
/// Get current info on the card.
///
/// `names_buffer` is a buffer that should be large enough to hold all of
/// the reader names.
///
/// `atr_buffer` is a buffer that should be large enough to hold the ATR.
/// The recommended size is `MAX_ATR_SIZE`, which should be always
/// sufficent.
///
/// The function `status2_len` can be used to find the exact required
/// lengths.
///
/// If the buffers are not large enough to hold all of the names or the
/// ATR, `Error::InsufficientBuffer` is returned.
///
/// This function wraps `SCardStatus` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
/// [2]: https://msdn.microsoft.com/en-us/library/aa379803.aspx
pub fn status2<'names_buf, 'atr_buf>(
&self,
names_buffer: &'names_buf mut [u8],
atr_buffer: &'atr_buf mut [u8],
) -> Result<CardStatus<'names_buf, 'atr_buf>, Error> {
unsafe {
assert!(names_buffer.len() <= std::u32::MAX as usize);
let mut names_len: DWORD = names_buffer.len() as DWORD;
let mut raw_state: DWORD = DUMMY_DWORD;
let mut raw_protocol: DWORD = DUMMY_DWORD;
assert!(atr_buffer.len() <= std::u32::MAX as usize);
let mut atr_len: DWORD = atr_buffer.len() as DWORD;
try_pcsc!(ffi::SCardStatus(
self.handle,
names_buffer.as_mut_ptr() as *mut c_char,
&mut names_len,
&mut raw_state,
&mut raw_protocol,
atr_buffer.as_mut_ptr(),
&mut atr_len,
));
Ok(CardStatus {
reader_names: ReaderNames {
buf: &names_buffer[..names_len as usize],
pos: 0,
},
state: raw_state,
protocol: Protocol::from_raw(raw_protocol),
atr: &atr_buffer[0..atr_len as usize],
})
}
}
/// Get the needed length of the names buffer (first result) and ATR buffer
/// (second result) to be passed to `status2`.
///
/// This function wraps `SCardStatus` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
/// [2]: https://msdn.microsoft.com/en-us/library/aa379803.aspx
pub fn status2_len(&self) -> Result<(usize, usize), Error> {
unsafe {
let mut names_len: DWORD = DUMMY_DWORD;
let mut raw_state: DWORD = DUMMY_DWORD;
let mut raw_protocol: DWORD = DUMMY_DWORD;
let mut atr_len: DWORD = DUMMY_DWORD;
try_pcsc!(ffi::SCardStatus(
self.handle,
null_mut(),
&mut names_len,
&mut raw_state,
&mut raw_protocol,
null_mut(),
&mut atr_len,
));
Ok((names_len as usize, atr_len as usize))
}
}
/// Get current info on the card, allocating buffers of the required size.
///
/// This function wraps `SCardStatus` ([pcsclite][1], [MSDN][2]). It is an owned version of
/// [`status2`](#method.status2), calling [`status2_len`](#method.status2_len) to determine the
/// required buffer sizes.
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
/// [2]: https://msdn.microsoft.com/en-us/library/aa379803.aspx
pub fn status2_owned(&self) -> Result<CardStatusOwned, Error> {
let (names_len, atr_len) = self.status2_len()?;
let mut names_buffer = vec![0u8; names_len];
let mut atr_buffer = vec![0u8; atr_len];
let (reader_names, state, protocol, atr_len) = {
let card_status = self.status2(&mut names_buffer, &mut atr_buffer)?;
let reader_names = card_status.reader_names.map(ToOwned::to_owned).collect();
(
reader_names,
card_status.state,
card_status.protocol,
card_status.atr.len(),
)
};
atr_buffer.truncate(atr_len);
Ok(CardStatusOwned {
reader_names,
state,
protocol,
atr: atr_buffer,
})
}
/// Get an attribute of the card or card reader.
///
/// `buffer` is a buffer that should be large enough for the attribute
/// data. The function `get_attribute_len` can be used to find the
/// exact required length.
///
/// Returns a slice into `buffer` containing the attribute data.
///
/// If the buffer is not large enough, `Error::InsufficientBuffer` is
/// returned.
///
/// This function wraps `SCardGetAttrib` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602
/// [2]: https://msdn.microsoft.com/en-us/library/aa379559.aspx
pub fn get_attribute<'buf>(&self, attribute: Attribute, buffer: &'buf mut [u8]) -> Result<&'buf [u8], Error> {
unsafe {
assert!(buffer.len() <= std::u32::MAX as usize);
let mut attribute_len = buffer.len() as DWORD;
// SCardGetAttribtreats null specially, to query the needed
// buffer length. We don't want the caller to be able to trigger
// this here -- should use `get_attribute_len` instead. So needs
// some special treatment.
let bufptr = if attribute_len == 0 {
null_mut()
} else {
let ptr = buffer.as_mut_ptr();
assert!(!ptr.is_null());
ptr
};
try_pcsc!(ffi::SCardGetAttrib(
self.handle,
attribute.into_raw(),
buffer.as_mut_ptr(),
&mut attribute_len,
));
if bufptr.is_null() && attribute_len > 0 {
return Err(Error::InsufficientBuffer);
}
Ok(&buffer[0..attribute_len as usize])
}
}
/// Get the needed length of a buffer to be passed to `get_attribute`.
///
/// This function wraps `SCardGetAttrib` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602
/// [2]: https://msdn.microsoft.com/en-us/library/aa379559.aspx
pub fn get_attribute_len(&self, attribute: Attribute) -> Result<usize, Error> {
unsafe {
let mut attribute_len = DUMMY_DWORD;
try_pcsc!(ffi::SCardGetAttrib(
self.handle,
attribute.into_raw(),
null_mut(),
&mut attribute_len,
));
Ok(attribute_len as usize)
}
}
/// Get an attribute of the card or card reader, allocating a buffer of the required size.
///
/// This function wraps `SCardGetAttrib` ([pcsclite][1], [MSDN][2]). It is an owned version of
/// [`get_attribute`](#method.get_attribute), calling
/// [`get_attribute_len`](#method.get_attribute_len) to determine the required buffer size.
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602
/// [2]: https://msdn.microsoft.com/en-us/library/aa379559.aspx
pub fn get_attribute_owned(&self, attribute: Attribute) -> Result<Vec<u8>, Error> {
let len = self.get_attribute_len(attribute)?;
if len == 0 {
return Ok(vec![]);
}
let mut buf = vec![0u8; len];
let n = self.get_attribute(attribute, &mut buf)?.len();
buf.truncate(n);
Ok(buf)
}
/// Set an attribute of the card or card reader.
///
/// This function wraps `SCardSetAttrib` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f
/// [2]: https://msdn.microsoft.com/en-us/library/aa379801.aspx
pub fn set_attribute(&self, attribute: Attribute, attribute_data: &[u8]) -> Result<(), Error> {
unsafe {
assert!(attribute_data.len() <= std::u32::MAX as usize);
try_pcsc!(ffi::SCardSetAttrib(
self.handle,
attribute.into_raw(),
attribute_data.as_ptr(),
attribute_data.len() as DWORD,
));
Ok(())
}
}
/// Transmit an APDU command to the card.
///
/// `receive_buffer` is a buffer that should be large enough to hold
/// the APDU response.
///
/// Returns a slice into `receive_buffer` containing the APDU
/// response.
///
/// If `receive_buffer` is not large enough to hold the APDU response,
/// `Error::InsufficientBuffer` is returned.
///
/// This function wraps `SCardTransmit` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99
/// [2]: https://msdn.microsoft.com/en-us/library/aa379804.aspx
pub fn transmit<'buf>(&self, send_buffer: &[u8], receive_buffer: &'buf mut [u8]) -> Result<&'buf [u8], Error> {
self.transmit2(send_buffer, receive_buffer).map_err(|(err, _)| err)
}
/// Transmit an APDU command to the card.
///
/// This functions works like [transmit](#method.transmit) but the error type is
/// `(Error, usize)`.
///
/// `receive_buffer` is a buffer that should be large enough to hold
/// the APDU response.
///
/// Returns a slice into `receive_buffer` containing the APDU
/// response.
///
/// If `receive_buffer` is not large enough to hold the APDU response,
/// `Error::InsufficientBuffer` is returned, and the `usize` value is set to the
/// required size.
///
/// `usize` value of the error has no meaning for other `Error` values than `Error::InsufficientBuffer`.
///
/// **Note** that when `Error::InsufficientBuffer` is returned, the provided command has
/// been already effectively executed by the card. Do not treat this as a generic way to
/// obtain the size of the response as you may end up issuing commands multiple times
/// which can lead to unexpected results. Normally, most operations on standard card
/// let you know the expected size of the response in advance. Be sure to only use this
/// for commands that may be executed multiple times in a row without changing the state
/// of the card.
///
/// This function wraps `SCardTransmit` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99
/// [2]: https://msdn.microsoft.com/en-us/library/aa379804.aspx
pub fn transmit2<'buf>(
&self,
send_buffer: &[u8],
receive_buffer: &'buf mut [u8],
) -> Result<&'buf [u8], (Error, usize)> {
let active_protocol = self
.active_protocol
.expect("pcsc::Card::transmit() does not work with direct connections");
let send_pci = get_protocol_pci(active_protocol);
let recv_pci = null_mut();
assert!(receive_buffer.len() <= std::u32::MAX as usize);
let mut receive_len = receive_buffer.len() as DWORD;
unsafe {
assert!(send_buffer.len() <= std::u32::MAX as usize);
let r = ffi::SCardTransmit(
self.handle,
send_pci,
send_buffer.as_ptr(),
send_buffer.len() as DWORD,
recv_pci,
receive_buffer.as_mut_ptr(),
&mut receive_len,
);
match r {
ffi::SCARD_S_SUCCESS => (),
err => return Err((Error::from_raw(err), receive_len as usize)),
}
Ok(&receive_buffer[0..receive_len as usize])
}
}
/// Sends a command directly to the reader (driver).
///
/// `control_code` is the reader-specific control code. You may need
/// to pass it through the `ctl_code()` function, according to the
/// driver documentation.
///
/// `receive_buffer` is a buffer that should be large enough to hold
/// the response.
///
/// Returns a slice into `receive_buffer` containing the response.
///
/// If `receive_buffer` is not large enough to hold the response,
/// `Error::InsufficientBuffer` is returned.
///
/// This function wraps `SCardControl` ([pcsclite][1], [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f
/// [2]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa379474(v=vs.85).aspx
pub fn control<'buf>(
&self,
// TODO: This is a portability hazard -- should change to u32
// in the next breaking change release.
control_code: DWORD,
send_buffer: &[u8],
receive_buffer: &'buf mut [u8],
) -> Result<&'buf [u8], Error> {
let mut receive_len: DWORD = DUMMY_DWORD;
unsafe {
assert!(send_buffer.len() <= std::u32::MAX as usize);
assert!(receive_buffer.len() <= std::u32::MAX as usize);
try_pcsc!(ffi::SCardControl(
self.handle,
control_code,
send_buffer.as_ptr(),
send_buffer.len() as DWORD,
receive_buffer.as_mut_ptr(),
receive_buffer.len() as DWORD,
&mut receive_len,
));
Ok(&receive_buffer[0..receive_len as usize])
}
}
}
impl Drop for Card {
fn drop(&mut self) {
unsafe {
// Error is ignored here; to do proper error handling,
// disconnect() should be called manually.
//
// Disposition is hard-coded to ResetCard here; to use
// another method, disconnect() should be called manually.
let _err = ffi::SCardDisconnect(self.handle, Disposition::ResetCard.into_raw());
}
}
}
unsafe impl Send for Card {}
unsafe impl Sync for Card {}
impl<'tx> Transaction<'tx> {
/// End the transaction.
///
/// In case of error, ownership of the transaction is returned to the
/// caller.
///
/// This function wraps `SCardEndTransaction` ([pcsclite][1],
/// [MSDN][2]).
///
/// [1]: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b
/// [2]: https://msdn.microsoft.com/en-us/library/aa379477.aspx
///
/// ## Note
///
/// `Transaction` implements `Drop` which automatically ends the
/// transaction using `Disposition::LeaveCard`; you only need to call
/// this function if you want to handle errors or use a different
/// disposition method.
pub fn end(self, disposition: Disposition) -> Result<(), (Transaction<'tx>, Error)> {
unsafe {
let err = ffi::SCardEndTransaction(self.card.handle, disposition.into_raw());
if err != 0 {
return Err((self, Error::from_raw(err)));
}
// Skip the drop, we did it "manually".
forget(self);
Ok(())
}
}
}
impl<'tx> Drop for Transaction<'tx> {
fn drop(&mut self) {
unsafe {
// Error is ignored here; to do proper error handling,
// end() should be called manually.
//
// Disposition is hard-coded to LeaveCard here; to use
// another method, end() should be called manually.
let _err = ffi::SCardEndTransaction(self.card.handle, Disposition::LeaveCard.into_raw());
}
}
}
impl<'tx> Deref for Transaction<'tx> {
type Target = Card;
fn deref(&self) -> &Card {
self.card
}
}