Open source javacard applet implementing a crypto-currency hardware wallet with full BIP32/BIP39 support.
Satochip stands for Secure Anonymous Trustless and Open Chip. It is a javacard applet that can be used as a secure hardware wallet running for example on a Yubikey Neo. The Satochip applet has full BIP32/BIP39 supports.
Using Satochip, an initial BIP32 seed is imported in the javacard and private keys are derived as requested by an external application. Private keys are never exported outside of the secure chip. To improve performances, the result of key derivation is cached in secure memory for future requests so that a specific derivation path is only computed once.
The Satochip also supports the import of regular (non-BIP32 keys) such as vanity keys. Here again, private keys cannot be exported outside of the secure chip. Up to 16 regular keys can be imported on the chip. In any case, the private keys can be used to sign transactions and Bitcoin messages, if sufficient credentials are provided.
Access to private keys (creation, derivation and signature) is enforced through the use of PIN code (from 4 to 16 chars).
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Advantages:
- Code is free and open source (no NDA required);
- Code is easy to read and maintain (javacard is a subset of java);
- Multiple form factor could be supported in addition to Yubikey (e.g sim cards);
- Plug and play;
- Smartcards have a long experience in dealing with security and physical security in particular;
- Can be easily used or extended for other crypto-currencies;
- A test package is run during build to ensure that critical functionalities are implemented correctly.
Also, if used with a Yubikey:
- Yubikey has minimal size and is practically indestructible;
- The Yubico company is not going anywhere anytime soon;
- Many promising functionalities: NFC, Yubikey OTP, U2F, ...;
- Possibility to use the HMAC-SHA1 challenge-response of the Yubikey as second factor for additional security against malwares.
Disadvantages:
- Building the applet might be a bit tricky;
- The software implementation of HMAC-SHA512 could have an potential impact on the physical security against side-channel attacks (for attackers with physical access to the chip).
To support Bitcoin signatures, the javacard must support ALG_ECDSA_SHA_256, which in practice requires a javacard compliant with the JavaCard 3.0.1 specification. Note that this is a necessary but not sufficient condition since javacards typically implements only a subset of the specification. A detailed list of javacard and their supported features is available here.
An interesting guide to consult before shopping can be found here.
Important remark: the Yubikeys currently sold by Yubico are configured for production only and it is not possible to load the applet on these dongles (see this link for more details). Only the development Yubikeys (with serial number below 3,000,000) are suitable for our use!
Available for purchase here. (MOQ: 5 pieces).
More info here (Note however that Swissbit does not sell its product directly to end users but only to business partners).
Available for purchase here. (MOQ: 1 piece).
You can build the javacard CAP files or use the lastest built version.
To generate the CAP file from the sources, you can use the ant-javacard Ant task (see the instruction on the ant-javacard github repository).
- Clone Satochip applet repository:
git clone https://github.com/Toporin/SatochipApplet.git
- Download Ant-Javacard latest release in the
libfolder:
https://github.com/martinpaljak/ant-javacard/releases/latest/download/ant-javacard.jar
- Install Apache Ant:
sudo apt install ant
- Use/install recommended java JDK 8 or 11
sudo update-alternatives --config java
- Download javacard SDK into satochip project in
sdksfolder:
git submodule add https://github.com/martinpaljak/oracle_javacard_sdks sdks
- run ant:
ant
The .cap file should build in the SatochipApplet folder.
Once you have a CAP file, you have to download it on the chip card. You can use GlobalPlatformPro to do this:
- Download the latest release from https://github.com/martinpaljak/GlobalPlatformPro/releases
- (Put the CAP file in the same folder as the GPJ jar file for convenience)
- To list the applets loaded on a smartcard:
gp.exe -l - To load the SatoChip applet:
gp.exe -install .\SatoChip-0.12-05.cap - To delete the SatoChip applet:
gp.exe -uninstall .\SatoChip-0.12-05.cap - You can also use the gp.jar library:
java -jar gp.jar -install .\SatoChip-0.12-05.cap
A more detailed tutorial is available on the GlobalPlatformPro repository.
To use the applet, you have to connect your client application to the smartcard and send command APDU. These commands will be processed by the smartcard who will then send a response APDU.
-
Bitcoin: the Bitcoin Electrum-Satochip is a version of Electrum that was slightly modified to integrate the Satochip hardware wallet.
-
Litecoin: the Litecoin Electrum-Satochip is a version of Electrum for Litecoin that was slightly modified to integrate the Satochip hardware wallet.
-
Bitcoin Cash: the Electron Cash-Satochip is a version of Electron Cash that was slightly modified to integrate the Satochip hardware wallet. Note: Satochip is natively supported by Electron Cash, we strongly encourage you to download the client from the official website.
-
eCash (XEC): Satochip is natively supported by Electrum ABC, we strongly encourage you to download the client from the official website.
-
Metamask: you can use your Satochip hardware wallet with a forked version of Metamask called Satomask. To allow the communication between the card and your web browser, you will need the Satochip Bridge.
-
MyEtherWallet: you can use your Satochip hardware wallet with a forked version of MyEtherWallet called MEW Satochip. To allow the communication between the card and your web browser, you will need the Satochip Bridge.
SatoChipClient is a small java library that allows to easily interface the SatoChip applet to your application through a simple set of API. An example of application is the BitcoinWallet java application, that uses SatoChipClient through another Bitcoin library called BitcoinCore.
- The CardEdge javacard applet is derived from the MUSCLE framework.
- The Bitcoin transaction parser is derived from Btchip.
- The BitcoinWallet application is based on ScripterRon BitcoinWallet client and BitcoinCore library.
This application is distributed under the GNU Affero General Public License version 3.
Some parts of the code may be licensed under a different (MIT-like) license. Contact us if you feel that some license combination is inappropriate.
