Clone this repo:
  1. 8f84d22 Merge "Added ready_se directory. All seready applets and HAL reference implementations are placed here." by Shawn Willden · 5 weeks ago master
  2. f5a1db8 Add HW-backed security team to OWNERS by Shawn Willden · 5 weeks ago
  3. 84f37d4 Added ready_se directory. All seready applets and HAL reference by subrahmanyaman · 7 weeks ago
  4. 607c5b2 [LSC] Add LOCAL_LICENSE_KINDS to external/libese am: 6266a7f3bb am: 3abeb8e4a6 am: aa920747bc by Bob Badour · 11 months ago android-s-v2-preview-1 android12--mainline-release android12-dev android12-qpr1-d-release android12-qpr1-d-s1-release android12-qpr1-d-s2-release android12-qpr1-d-s3-release android12-qpr1-release android-12.0.0_r16 android-12.0.0_r18 android-12.0.0_r19 android-12.0.0_r20 android-12.0.0_r21 android-12.0.0_r26 android-12.0.0_r27 android-mainline-12.0.0_r4 android-s-v2-beta-2 android-s-v2-preview-2
  5. aa92074 [LSC] Add LOCAL_LICENSE_KINDS to external/libese am: 6266a7f3bb am: 3abeb8e4a6 by Bob Badour · 11 months ago


Document last updated: 13 Jan 2017


libese provides a minimal transport wrapper for communicating with embedded secure elements. Embedded secure elements typically adhere to smart card standards whose translation is not always smooth when migrated to an always connected bus, like SPI. The interfaces exposed by libese should enable higher level “terminal” implementations to be written on top and/or a service which provides a similar interface.

Behind the interface, libese should help smooth over the differences between eSEs and smart cards use in the hardware adapter implementations. Additionally, a T=1 implementation is supplied, as it appears to be the most common wire transport for these chips.


Public client interface for Embedded Secure Elements.

Prior to use in a file, import all necessary variables with:


Instantiate in a function with:



struct EseInterface my_ese = ESE_INITIALIZER(SOME_HAL_IMPL);


struct EseInterface *my_ese = malloc(sizeof(struct EseInterface));
ese_init(my_ese, SOME_HAL_IMPL);

To initialize the hardware abstraction, call:


To release any claimed resources, call


when interface use is complete.

To perform a transmit-receive cycle, call

ese_transceive(my_ese, ...);

with a filled transmit buffer with total data length and an empty receive buffer and a maximum fill length. A negative return value indicates an error and a hardware specific code and string may be collected with calls to


The EseInterface is not safe for concurrent access. (Patches welcome! ;).


libese is broken into multiple pieces:

  • libese
  • libese-sysdeps
  • libese-hw
  • libese-teq1

libese provides the headers and wrappers for writing libese clients and for implementing hardware backends. It depends on a backend being provided as per libese-hw and on libese-sysdeps.

libese-sysdeps provides the system level libraries that are needed by libese provided software. If libese is being ported to a new environment, like a bootloader or non-Linux OS, this library may need to be replaced. (Also take a look at libese/include/ese/log.h for the macro definitions that may be needed.)

libese-hw provides existing libese hardware backends.

libese-teq1 provides a T=1 compatible transcieve function that may be used by a hardware backend. It comes with some prequisites for use, such as a specifically structured set of error messages and EseInteface pad usage, but otherwise it does not depends on any specific functionality not abstracted via the libese EseOperations structure.

Supported backends

There are two test backends, fake and echo, as well as one real backend for the NXP PN80T/PN81A.

The NXP backends support both a direct kernel driver and a Linux SPIdev interface.