com.github.martinpaljak:apdu4j-core

Working with smart card readers? This is for you.

License	License MIT GPL
GroupId	GroupId com.github.martinpaljak
ArtifactId	ArtifactId apdu4j-core
Last Version	Last Version 2020r3
Release Date	Release Date Apr 1, 2021
Type	Type jar
Description	Description Working with smart card readers? This is for you.

Download apdu4j-core

Filename	Size
apdu4j-core-2020r3.pom
apdu4j-core-2020r3.jar	14 KB
apdu4j-core-2020r3-sources.jar	20 KB
apdu4j-core-2020r3-javadoc.jar	92 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.martinpaljak/apdu4j-core/ -->
<dependency>
    <groupId>com.github.martinpaljak</groupId>
    <artifactId>apdu4j-core</artifactId>
    <version>2020r3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.martinpaljak/apdu4j-core/
implementation 'com.github.martinpaljak:apdu4j-core:2020r3'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.martinpaljak/apdu4j-core/
implementation ("com.github.martinpaljak:apdu4j-core:2020r3")

Apache Buildr

'com.github.martinpaljak:apdu4j-core:jar:2020r3'

Apache Ivy

<dependency org="com.github.martinpaljak" name="apdu4j-core" rev="2020r3">
  <artifact name="apdu4j-core" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.martinpaljak', module='apdu4j-core', version='2020r3')
)

Scala SBT

libraryDependencies += "com.github.martinpaljak" % "apdu4j-core" % "2020r3"

Leiningen

[com.github.martinpaljak/apdu4j-core "2020r3"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.slf4j : slf4j-api	jar	1.7.30

test (2)

Group / Artifact	Type	Version
org.slf4j : slf4j-simple	jar	1.7.30
org.testng : testng	jar	7.4.0

Project Modules

There are no modules declared in this project.

apdu4j ·

Command line tool and library of useful Java classes for working with smart cards and smart card readers via JSR268 (commonly known as javax.smartcardio). While focus is on desktop PC/SC readers, some code can be re-used with arbitrary "APDU-command-response-ish" interfaces, either as CommandAPDU/ResponseAPDU pairs or plain byte arrays.

Features

PinPad support (PC/SC v2 part 10 / CCID)
Fixes all the stupid things with Java on non-windows platforms: OSX, Debian, Ubuntu, Fedora, CentOS, FreeBSD.
Java tools for convenient APDU logging, PIN handling and more
Bundles jnasmartcardio in the command line tool for easy testing with a sane javax.smartcardio implementation with reader locking
Easy to use RemoteTerminal for building central services
- Combine with GlobalPlatformPro for flexible central provisioning

Jump to ...

Get it now!

Download latest pre-built .JAR or .EXE from release area
Or fetch from github and build it yourself, it is really easy (more instructions in CONTRIBUTING):

git clone https://github.com/martinpaljak/apdu4j
cd apdu4j
./mvnw package

Usage from command line

Before you begin:
- You can run the command line utility anywhere where Java runs, like this:
```
java -jar apdu4j.jar
```
- But it is easier to add an alias or use a wrapper.
- On Linux add an alias to the shell like this:
```
alias sc="java -jar $(PWD)/apdu4j.jar"
# Now you can avoid typing java -jar and sc works from any folder
sc -h
```
- On Windows just use pre-packaged apdu4j.exe like this or rename it:
```
apdu4j.exe -h
```
Display all options:
```
sc -h
```
List readers:
```
sc -l
```
Will produce something like
```
[ ] Gemalto Ezio Shield 01 00
[*] ACS ACR 38U-CCID 02 00
```
The presence of a card or token is indicated with the asterisk

Be verbose:

sc -l -v

Will produce:

# Using jnasmartcardio.Smartcardio - JNA2PCSC version 0.2
# Found 4 terminals
[X] [   ] Yubico Yubikey 4 U2F+CCID
          3BF81300008131FE15597562696B657934D4
[ ] [VMD] Gemalto Ezio Shield 01 00
[*] [   ] ACS ACR 38U-CCID 02 00
          3BF91300008131FE454A434F503234325233A2
[ ] [   ] ACS ACR 38U-CCID 03 00

In addition to the ATR of the inserted card below the reader, PinPad features of the terminal are shown: V - PIN verification, M - PIN modification, D - display. X instead of the asterisk indicates a reader used exclusively by some other application.

Take you directly to the online ATR database
```
sc -l -v -w
```
Use a virtual smart card reader provider (format for -p is jar:class:args, where args part can be URL-encoded):
```
sc -p some.jar:com.example.VirtualTerminalProvider:tcp%3A%2F%2F192.168.1.1%3A7000 -lv
```
Send the APDU 00A40C0000 to the card:
```
sc -a 00A40C0000
```
The same with forced T=0 protocol (similar for T=1):
```
sc -t0 -a 00A40C0000
```
The same, with an additional APDU, while dumping everything to card.dump
```
sc -t0 -a 00A40C0000 -a 80:01:04:00:00 -dump card.dump
```
SunPCSC - use specific PC/SC library:
```
sc -lib /usr/local/lib/pcsclite.so -l
```
SunPCSC - don't issue GET RESPONSE commands:
```
sc -no-get-response -a 00A4040000 -v
```
Show APDU-s sent to the card (using LoggingCardTerminal):

add -debug or -d to your command
Be verbose:

add -verbose or -v to your command

Usage from Java

Include the dependency

<dependency>
    <groupId>com.github.martinpaljak</groupId>
    <artifactId>apdu4j</artifactId>
    <version>17.11.26</version>
</dependency>

More information can be found from Javadocs, which are always improving.

Before anything make sure you set the necessary properties to make javax.smartcardio work without tuning:

import apdu4j.TerminalManager;
TerminalManager.fixPlatformPaths();

LoggingCardTerminal

Show a debugging trace (like -d) of PC/SC calls and exhanged APDU-s with timing on System.out:

import apdu4j.LogginCardTerminal;
        
TerminalFactory f = TerminalFactory.getDefault();
CardReader r = f.terminals().terminal("Your Smart Card Reader Name");
reader = LoggingCardTerminal.getInstance(reader);
// Now use javax.smartcardio as you normally do

This will give you output similar to:

SCardConnect("SCM Microsystems Inc. SCR 355 00 00", T=*) -> T=1, 3BFC180000813180459067464A00680804000000000E
SCardBeginTransaction("SCM Microsystems Inc. SCR 355 00 00")
A>> T=1 (4+0000) 00A40400 00 
A<< (0018+2) (17ms) 6F108408A000000003000000A5049F6501FF 9000
A>> T=1 (4+0000) 80CA9F7F 00 
A<< (0000+2) (11ms) 6A88

Dump all APDU communication with a card to a file:

import apdu4j.LogginCardTerminal;
        
TerminalFactory tf = TerminalFactory.getDefault();
CardReader r = tf.terminals().terminal("Your Smart Card Reader Name");
FileOutputStream o = new FileOutputStream(new File("card.dump"));
reader = LoggingCardTerminal.getInstance(reader, o);
// Now use javax.smartcardio as you normally do

This will make a dump file similar to this:

# Generated on Wed, 31 Dec 2014 18:10:35 +0200 by apdu4j
# Using SCM Microsystems Inc. SCR 355 00 00
# ATR: 3BFE1800008031FE4553434536302D43443038312D6E46A9
# PROTOCOL: T=1
#
# Sent
00A4040000
# Received in 24ms
6F108408A000000003000000A5049F6501FF9000
# Sent
80500000084D080A4D1C5EBC92
# Received in 70ms
00001248950019F738700103002421796B41BB3B7014659BFC8A54B2479000

NEW release

Similar and related projects

SCUBA (LGPL) - http://scuba.sourceforge.net/
- :| written in Java
- :( no command line utility
- :) has Provider-s for weird hardware
jnasmartcardio (CC0) - https://github.com/jnasmartcardio/jnasmartcardio
- :| written in Java
- :) provides a "better" wrapper for system PC/SC service with JNA as a Provider
- :) used by apdu4j
OpenCard Framework (OPEN CARD CONSORTIUM SOURCE LICENSE) - http://www.openscdp.org/ocf/
- :| written in Java
- :( really old (pre-2000, comparable to CT-API)
- :( no command line utility
intarsys smartcard-io (BSD) - https://github.com/intarsys/smartcard-io
- :| written in Java
- :| similar to jnasmartcardio (alternative native Provider)
OpenSC (opensc-tool, LGPL) - https://github.com/OpenSC/OpenSC
- :| written in C
- :| related to rest of OpenSC, but allows to send APDU-s from command line with opensc-tool -s XX:XX:XX:XX
Countless other apdu/script tools
- :| written in different languages
- :| use different input formats and script files
- :| just FYI

History and motivation

When working with GlobalPlatformPro and JavaCard-s, some low level code wanted to sneak into projects where it did not belong, so it made sense to capture it into a separate library. Also, while command line tools for accessing readers on APDU (PC/SC) level existed for C, nothing was available for doing the same via Java stack, thus the need for a DWIM command line tool.

Included/used open source projects

picocli for parsing command line (Apache 2.0)
Launch4j for generating .exe (BSD/MIT)
jnasmartcardio for PC/SC access (CC0 / public domain)

License

Contact

[email protected]

Versions

Version
2020r3 Apr 1, 2021
2020b1 Jan 10, 2020
19.05.08 May 8, 2019
19.04.20 Apr 21, 2019
19.04.02 Apr 2, 2019

com.github.martinpaljak:apdu4j-core

License

GroupId

ArtifactId

Last Version

Release Date

Type

Description

Download apdu4j-core

How to add to project

Dependencies

compile (1)

test (2)

Project Modules

apdu4j ·

Features

Jump to ...

Get it now!

Usage from command line

Usage from Java

LoggingCardTerminal

Similar and related projects

History and motivation

Included/used open source projects

License

Contact

Versions