311 lines
18 KiB
HTML
311 lines
18 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Android Smart Card Emulator — vsmartcard 2023-09-27 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<link rel="shortcut icon" href="../_static/chip.ico"/>
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Tizen Smart Card Emulator" href="../TCardEmulator/README.html" />
|
||
<link rel="prev" title="Remote Smart Card Reader" href="../remote-reader/README.html" />
|
||
<meta charset='utf-8'>
|
||
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
||
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js "></script>
|
||
<script type="text/javascript" src="../_static/js/jquery-fix.js "></script>
|
||
<script type="text/javascript" src="../_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
|
||
<script type="text/javascript" src="../_static/bootstrap-sphinx.js "></script>
|
||
|
||
</head><body>
|
||
|
||
<a href="https://github.com/frankmorgner/vsmartcard"
|
||
class="visible-desktop hidden-xs"><img
|
||
id="gh-banner"
|
||
style="position: absolute; top: 50px; right: 0; border: 0;"
|
||
src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png"
|
||
alt="Fork me on GitHub"></a>
|
||
<script>
|
||
// Adjust banner height.
|
||
$(function () {
|
||
var navHeight = $(".navbar .container").css("height");
|
||
$("#gh-banner").css("top", navHeight);
|
||
});
|
||
</script>
|
||
|
||
|
||
<div id="navbar" class="navbar navbar-default ">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="navbar-brand" href="../index.html">
|
||
vsmartcard</a>
|
||
<span class="navbar-text navbar-version pull-left"><b></b></span>
|
||
</div>
|
||
|
||
<div class="collapse navbar-collapse nav-collapse">
|
||
<ul class="nav navbar-nav">
|
||
|
||
|
||
<li class="dropdown globaltoc-container">
|
||
<a role="button"
|
||
id="dLabelGlobalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="../index.html">Site <b class="caret"></b></a>
|
||
<ul class="dropdown-menu globaltoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelGlobalToc"><ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../virtualsmartcard/README.html">Virtual Smart Card</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../remote-reader/README.html">Remote Smart Card Reader</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Android Smart Card Emulator</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../TCardEmulator/README.html">Tizen Smart Card Emulator</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../pcsc-relay/README.html">PC/SC Relay</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../ccid/README.html">USB CCID Emulator</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../virtualsmartcard/api.html">Creating a Virtual Smart Card</a></li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a role="button"
|
||
id="dLabelLocalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="#">Page <b class="caret"></b></a>
|
||
<ul class="dropdown-menu localtoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelLocalToc"><ul>
|
||
<li><a class="reference internal" href="#">Android Smart Card Emulator</a><ul>
|
||
<li><a class="reference internal" href="#download-and-install">Download and Install</a></li>
|
||
<li><a class="reference internal" href="#question">Question</a></li>
|
||
<li><a class="reference internal" href="#notes-and-references">Notes and References</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
<a href="../remote-reader/README.html" title="Previous Chapter: Remote Smart Card Reader"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Remote Smart ...</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../TCardEmulator/README.html" title="Next Chapter: Tizen Smart Card Emulator"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Tizen Smart C... »</span>
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li class="hidden-sm"></li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
<form class="navbar-form navbar-right" action="../search.html" method="get">
|
||
<div class="form-group">
|
||
<input type="text" name="q" class="form-control" placeholder="Search" />
|
||
</div>
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="body col-md-12 content" role="main">
|
||
|
||
<div class="section" id="android-smart-card-emulator">
|
||
<span id="acardemulator"></span><h1>Android Smart Card Emulator<a class="headerlink" href="#android-smart-card-emulator" title="Permalink to this headline">¶</a></h1>
|
||
<div class="sidebar">
|
||
<p class="sidebar-title">Use an Android phone as contact-less smart card</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">License</dt>
|
||
<dd class="field-odd"><p>GPL version 3</p>
|
||
</dd>
|
||
<dt class="field-even">Tested Platform</dt>
|
||
<dd class="field-even"><p>Android, CyanogenMod</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<p>The Android Smart Card Emulator allows the emulation of a contact-less smart card.
|
||
The emulator uses Android’s <abbr title="host card emulation">HCE</abbr> to fetch APDUs from a contact-less reader.
|
||
The app allows to process the Command APDUs either by delegating them to a
|
||
remote virtual smart card or by a built-in Java Card simulator. The response
|
||
APDUs are then returned to the smart card reader. Together with
|
||
<a class="reference internal" href="../TCardEmulator/README.html#tcardemulator"><span class="std std-ref">Tizen Smart Card Emulator</span></a> it is also possible to use a smartwatch as communication
|
||
device instead of the phone.</p>
|
||
<p>With the built-in Java Card runtime of <a class="reference external" href="http://www.jcardsim.org/">jCardSim</a> <a class="footnote-reference brackets" href="#id4" id="id5">1</a> the app includes the following
|
||
Applets:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://developers.yubico.com/ykneo-openpgp/">OpenPGP Applet</a> <a class="footnote-reference brackets" href="#id6" id="id7">2</a> (application identifier <code class="docutils literal notranslate"><span class="pre">D2760001240102000000000000010000</span></code>)</p></li>
|
||
<li><p><a class="reference external" href="https://developers.yubico.com/ykneo-oath/">OATH Applet</a> <a class="footnote-reference brackets" href="#id8" id="id9">3</a> (application identifier <code class="docutils literal notranslate"><span class="pre">A000000527210101</span></code>)</p></li>
|
||
<li><p><a class="reference external" href="http://www.pwendland.net/IsoApplet/">ISO Applet</a> <a class="footnote-reference brackets" href="#id10" id="id11">4</a> (application identifier <code class="docutils literal notranslate"><span class="pre">F276A288BCFBA69D34F31001</span></code>)</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/vletoux/GidsApplet">GIDS Applet</a> <a class="footnote-reference brackets" href="#id12" id="id13">5</a> (application identifier <code class="docutils literal notranslate"><span class="pre">A000000397425446590201</span></code>)</p></li>
|
||
</ul>
|
||
<p>The remote interface can be used together with the <a class="reference internal" href="../virtualsmartcard/README.html#vicc"><span class="std std-ref">Virtual Smart Card</span></a>, which allows
|
||
emulating the following cards:</p>
|
||
<ul class="simple">
|
||
<li><p>Generic ISO-7816 smart card</p></li>
|
||
<li><p>German electronic identity card (nPA)</p></li>
|
||
<li><p>Electronic passport</p></li>
|
||
</ul>
|
||
<p>The remote interface can also be used together with the <a class="reference internal" href="../pcsc-relay/README.html#pcsc-relay"><span class="std std-ref">PC/SC Relay</span></a>,
|
||
which allows emulating a contactless card from an existing contact-based card
|
||
(by relaying the commands from PC/SC to the phone).</p>
|
||
<p>You may also attach your own simulation to the remote interface by implementing
|
||
a simple interface through a socket communication.</p>
|
||
<div class="system-message">
|
||
<p class="system-message-title">System Message: WARNING/2 (<span class="docutils literal">\input{$wd/bilder/tikzstyles.tex}
|
||
\node (reader) {\includegraphics[width=3cm]{$wd/bilder/my_cardreader.pdf}};
|
||
\node [below=0cm of reader, kleiner] {Contact-less Reader};
|
||
\node (phone) [right=1cm of reader] {\includegraphics[width=3cm]{$wd/bilder/smartphone.pdf}};
|
||
\node (app) [at=(phone.center)] {\includegraphics[width=2.8cm, height=4.9cm]{$wd/bilder/ACardEmulator.png}};
|
||
|
||
\begin{pgfonlayer}{background}
|
||
\draw [rfid] (reader.center) -- (phone.west) ;
|
||
\end{pgfonlayer}</span>)</p>
|
||
<p>!pdf2svg command cannot be run</p>
|
||
</div>
|
||
<p class="caption"><span class="caption-text">Simulate a contact-less Java Card with Android Smart Card Emulator</span></p>
|
||
</div><div class="system-message">
|
||
<p class="system-message-title">System Message: WARNING/2 (<span class="docutils literal">\input{$wd/bilder/tikzstyles.tex}
|
||
\node (reader) {\includegraphics[width=3cm]{$wd/bilder/my_cardreader.pdf}};
|
||
\node [below=0cm of reader, kleiner] {Contact-less Reader};
|
||
\node (phone) [right=1cm of reader] {\includegraphics[width=3cm]{$wd/bilder/smartphone.pdf}};
|
||
\node (app) [at=(phone.center)] {\includegraphics[width=2.8cm, height=4.9cm]{$wd/bilder/ACardEmulator.png}};
|
||
\node (vicc) [aktivbox, right=2cm of phone, kleiner] {\texttt{vicc --reversed}};
|
||
|
||
\begin{pgfonlayer}{background}
|
||
\draw [rfid] (reader.center) -- (phone.west) ;
|
||
\path[linie] (phone) edge node {\includegraphics[width=1.5cm]{$wd/bilder/simplecloud.pdf}} (vicc) ;
|
||
\end{pgfonlayer}</span>)</p>
|
||
<p>!pdf2svg command cannot be run</p>
|
||
</div>
|
||
<p class="caption"><span class="caption-text">Simulate a contact-less smart card with a remote virtual smart card</span></p>
|
||
</div><div class="system-message">
|
||
<p class="system-message-title">System Message: WARNING/2 (<span class="docutils literal">\input{$wd/bilder/tikzstyles.tex}
|
||
\node (reader) {\includegraphics[width=3cm]{$wd/bilder/my_cardreader.pdf}};
|
||
\node [below=0cm of reader, kleiner] {Contact-less Reader};
|
||
\node (phone) [right=1cm of reader] {\includegraphics[width=3cm]{$wd/bilder/smartphone.pdf}};
|
||
\node (app) [at=(phone.center)] {\includegraphics[width=2.8cm, height=4.9cm]{$wd/bilder/ACardEmulator.png}};
|
||
\node (pcsc-relay) [aktivbox, right=2cm of phone, kleiner] {\texttt{pcsc-relay --emulator=vpcd}};
|
||
\node (card) [below=.5cm of pcsc-relay)] {\includegraphics[width=0.8cm]{$wd/bilder/smartcard.pdf}};
|
||
\node (reader2) [below=1cm of pcsc-relay] {\includegraphics[width=1.3cm]{$wd/bilder/my_cardreader.pdf}};
|
||
|
||
\begin{pgfonlayer}{background}
|
||
\draw [rfid] (reader.center) -- (phone.west) ;
|
||
\path[linie] (phone) edge node {\includegraphics[width=1.5cm]{$wd/bilder/simplecloud.pdf}} (pcsc-relay) ;
|
||
\path[linie] (pcsc-relay) edge (reader2) ;
|
||
\end{pgfonlayer}</span>)</p>
|
||
<p>!pdf2svg command cannot be run</p>
|
||
</div>
|
||
<p class="caption"><span class="caption-text">Relaying a contact-based smart card with pcsc-relay</span></p>
|
||
</div><p>The Android Smart Card Emulator has the following dependencies:</p>
|
||
<ul class="simple">
|
||
<li><p>NFC hardware built into the smartphone for <abbr title="host card emulation">HCE</abbr></p></li>
|
||
<li><p>Android 4.4 “KitKat” (or newer) or CyanogenMod 11 (or newer)</p></li>
|
||
<li><p>permissions for a data connection (communication with Virtual Smart Card) and
|
||
for using NFC (communication to the reader); scanning the configuration via
|
||
QR code requires permission to access the camera</p></li>
|
||
<li><p>Virtual Smart Card <a class="reference internal" href="../virtualsmartcard/README.html#vicc-install"><span class="std std-ref">installed on the host computer</span></a> for
|
||
using the remote interface</p></li>
|
||
</ul>
|
||
<p>Please note that the currently emulated applets are verifying the PIN by
|
||
transmitting it without any protection between card and terminal. You may want
|
||
to have a look at <a class="reference external" href="http://sar.informatik.hu-berlin.de/research/publications/SAR-PR-2014-08/SAR-PR-2014-08_.pdf">Erik Nellesson’s</a>
|
||
<a class="reference external" href="https://github.com/eriknellessen/Virtual-Keycard">Virtual Keycard</a> <a class="footnote-reference brackets" href="#id14" id="id15">6</a>, which uses the PACE protocol for PIN verification.</p>
|
||
<div class="section" id="download-and-install">
|
||
<span id="acardemulator-install"></span><h2>Download and Install<a class="headerlink" href="#download-and-install" title="Permalink to this headline">¶</a></h2>
|
||
<p>The Android Smart Card Emulator is available on <a class="reference external" href="https://f-droid.org/repository/browse/?fdid=com.vsmartcard.remotesmartcardreader.app">F-Droid</a> <a class="footnote-reference brackets" href="#id16" id="id17">7</a>.</p>
|
||
<a class="reference external image-reference" href="https://f-droid.org/repository/browse/?fdid=com.vsmartcard.acardemulator"><img alt="Android Smart Card Emulator on F-Droid" src="../_images/acardemu-qrcode.png" style="width: 265px; height: 265px;" /></a>
|
||
<p>To manually compile the app you need to fetch the sources and initialize the
|
||
submodules:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/frankmorgner/vsmartcard.git
|
||
<span class="nb">cd</span> vsmartcard
|
||
git submodule update --init --recursive
|
||
</pre></div>
|
||
</div>
|
||
<p>We use <a class="reference external" href="http://developer.android.com/sdk/installing/studio.html">Android Studio</a> <a class="footnote-reference brackets" href="#id18" id="id19">8</a> to build and deploy the application. Use
|
||
<span class="menuselection">File ‣ Open</span> to select <code class="file docutils literal notranslate"><span class="pre">vsmartcard/ACardEmulator</span></code>.
|
||
Attach your smartphone and choose <span class="menuselection">Run ‣ Run ‘app’</span>.</p>
|
||
</div>
|
||
<div class="section" id="question">
|
||
<h2>Question<a class="headerlink" href="#question" title="Permalink to this headline">¶</a></h2>
|
||
<p>Do you have questions, suggestions or contributions? Feedback of any kind is
|
||
more than welcome! Please use our <a class="reference external" href="https://github.com/frankmorgner/vsmartcard/issues">project trackers</a>.</p>
|
||
</div>
|
||
<div class="section" id="notes-and-references">
|
||
<h2>Notes and References<a class="headerlink" href="#notes-and-references" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="footnote brackets">
|
||
<dt class="label" id="id4"><span class="brackets"><a class="fn-backref" href="#id5">1</a></span></dt>
|
||
<dd><p><a class="reference external" href="http://www.jcardsim.org/">http://www.jcardsim.org/</a></p>
|
||
</dd>
|
||
<dt class="label" id="id6"><span class="brackets"><a class="fn-backref" href="#id7">2</a></span></dt>
|
||
<dd><p><a class="reference external" href="https://developers.yubico.com/ykneo-openpgp/">https://developers.yubico.com/ykneo-openpgp/</a></p>
|
||
</dd>
|
||
<dt class="label" id="id8"><span class="brackets"><a class="fn-backref" href="#id9">3</a></span></dt>
|
||
<dd><p><a class="reference external" href="https://developers.yubico.com/ykneo-oath/">https://developers.yubico.com/ykneo-oath/</a></p>
|
||
</dd>
|
||
<dt class="label" id="id10"><span class="brackets"><a class="fn-backref" href="#id11">4</a></span></dt>
|
||
<dd><p><a class="reference external" href="http://www.pwendland.net/IsoApplet/">http://www.pwendland.net/IsoApplet/</a></p>
|
||
</dd>
|
||
<dt class="label" id="id12"><span class="brackets"><a class="fn-backref" href="#id13">5</a></span></dt>
|
||
<dd><p><a class="reference external" href="https://github.com/vletoux/GidsApplet">https://github.com/vletoux/GidsApplet</a></p>
|
||
</dd>
|
||
<dt class="label" id="id14"><span class="brackets"><a class="fn-backref" href="#id15">6</a></span></dt>
|
||
<dd><p><a class="reference external" href="https://github.com/eriknellessen/Virtual-Keycard">https://github.com/eriknellessen/Virtual-Keycard</a></p>
|
||
</dd>
|
||
<dt class="label" id="id16"><span class="brackets"><a class="fn-backref" href="#id17">7</a></span></dt>
|
||
<dd><p><a class="reference external" href="https://f-droid.org/repository/browse/?fdid=com.vsmartcard.remotesmartcardreader.app">https://f-droid.org/repository/browse/?fdid=com.vsmartcard.remotesmartcardreader.app</a></p>
|
||
</dd>
|
||
<dt class="label" id="id18"><span class="brackets"><a class="fn-backref" href="#id19">8</a></span></dt>
|
||
<dd><p><a class="reference external" href="http://developer.android.com/sdk/installing/studio.html">http://developer.android.com/sdk/installing/studio.html</a></p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<footer class="footer">
|
||
<div class="container">
|
||
<p class="pull-right">
|
||
<a href="#">Back to top</a>
|
||
|
||
</p>
|
||
<p>
|
||
© Copyright 2009-2023 by Dominik Oepen and Frank Morgner.<br/>
|
||
</p>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html> |