pyscard - Python for smart cards

pyscard - Python smart card library - is a Python module adding smart cards support to Python 3.9 and higher.

Download

The pyscard project is available from different sources:

• pypi https://pypi.python.org/pypi/pyscard

• github https://github.com/LudovicRousseau/pyscard

Patch/bug reports

Report bugs or issues on github issues.

Report patches as github pull requests.

Architecture

Pyscard consists of:

• smartcard.scard, an extension module wrapping the WinSCard API (smart card base components) also known as PC/SC, and

• smartcard, a higher level Python framework built on top of the raw PC/SC API.

Documentation

pyscard user’s guide

High level API documentation, smartcard module

Low level API documentation, smartcard.scard module

Samples

High level API samples: See pyscard smartcard framework samples

Low level API samples: See PCSC wrapper samples

Index

Contents:

• pyscard user’s guide
  • Copyright
  • Introduction
  • Smart Cards
  • Quick-start
    • The reader-centric approach
    • The Answer To Reset (ATR)
    • The card-centric approach
      • Requesting a card by ATR
      • Requesting any card
      • Custom CardTypes
      • Selecting the card communication protocol
    • The object-centric approach
  • Tracing APDUs
    • The brute force
    • Using card connection observers to trace apdu transmission
      • Full sample code
  • Testing for APDU transmission errors
    • The brute force for testing APDU transmission errors
    • Checking APDU transmission errors with error checkers
      • Error checkers
      • Error checking chains
      • Filtering exceptions
      • Full sample code
      • Detecting response APDU errors for a card connection
      • Writing a custom error checker
  • Smartcard readers
    • Listing Smartcard Readers
    • Organizing Smartcard Readers into reader groups
    • Monitoring readers
  • Smart Cards
    • Monitoring Smart Cards
    • Sending APDUs to a Smart Card Obtained from Card Monitoring
  • Connections
    • Creating a Connection from a CardRequest
    • Creating Connection from CardMonitoring
      • Full sample code
    • Card Connection Decorators
      • Exclusive Card Connection Decorator
      • Exclusive Transmit Card Connection Decorator
      • Secure Channel Card Connection Decorator
  • A word on cryptography
    • Binary strings and list of bytes
    • Secret key cryptography
• pyscard smartcard framework samples
  • Display the ATR of inserted cards
  • Selecting the DF_TELECOM of a card
  • A simple apdu tracer and interpreter
  • Tracing connection events
  • Decorating Card Connections to add custom behavior
  • Detecting response apdu errors
  • Implementing a custom ErrorChecker
  • Implementing a custom card type
  • Monitoring smartcard readers
  • Monitoring smartcard insertion/removal
  • APDU/ATR byte to string utilities
• PCSC wrapper samples
  • send a Control Code to a card or reader
  • get the ATR of a card
  • get the attributes of a card
  • wait for card insertion/removal
  • list the cards introduced in the system
  • list the interfaces supported by a card
  • locate cards in the system
  • manage readers and reader groups
  • list smart card readers
  • select the DF_TELECOM of a SIM card
  • perform a simple smart card transaction
• License

Indices and tables

• Index

• Module Index

• Search Page