feitian/OpenSK_USB
0
0
Fork 0
mirror of https://github.com/FeitianTech/OpenSK_USB.git synced 2026-08-28 10:40:45 -07:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 656aa00 with MkDocs version: 1.1.2

Browse Source
This commit is contained in:
superskybird
2021-01-18 11:26:49 +08:00
parent 3e6cb5fc65
commit 432546a58a
6 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
hardware/index.html
+10 -10
View File
@@ -413,7 +413,7 @@
<h1 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h1>
<p>We have two types of OpenSK, V1 and V2. They have almost same schematic but different casing.<br />
Currently only <strong>V2</strong> is available to the market.</p>
Currently, only <strong>V2</strong> is available to the market.</p>
<hr />
<h2 id="opensk-v2">OpenSK V2<a class="headerlink" href="#opensk-v2" title="Permanent link">&para;</a></h2>
<p><img alt="OpenSK V1" src="../images/G9_OpenSK_logo.png" width="400px"> </p>
@@ -423,14 +423,14 @@ Currently only <strong>V2</strong> is available to the market.</p>
<p>The LED and User button are together. The button material is transparent, so user can see LED light through the button.</p>
</div>
<h3 id="1-switch-to-bootloader-mode">1. Switch To bootloader mode<a class="headerlink" href="#1-switch-to-bootloader-mode" title="Permanent link">&para;</a></h3>
<p>After user connects the device to computer, <strong>push and hold on</strong> the user button for <strong>more than 8</strong> seconds and then release the button. If the red LED is breathing, OpenSK is in bootloader mode. </p>
<p>After user connects the device to a computer, <strong>push and hold on</strong> the user button for <strong>more than 8</strong> seconds and then release the button. If the red LED is breathing, OpenSK is in bootloader mode. </p>
<h3 id="2-led-status">2. LED status<a class="headerlink" href="#2-led-status" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th align="left">LED behaviour</th>
<th align="left">LED behavior</th>
<th align="left">Mode type</th>
<th align="left">Triger Method</th>
<th align="left">Trigger Method</th>
</tr>
</thead>
<tbody>
@@ -457,24 +457,24 @@ Currently only <strong>V2</strong> is available to the market.</p>
</tbody>
</table>
<h3 id="3-hardware">3. Hardware<a class="headerlink" href="#3-hardware" title="Permanent link">&para;</a></h3>
<p>The hardawre schematic and PCB are shared <a href="../hardware_files/OpenSK_V2.zip">here</a>. </p>
<p>The hardware schematic and PCB are shared <a href="../hardware_files/OpenSK_V2.zip">here</a>. </p>
<hr />
<h2 id="opensk-v1">OpenSK V1<a class="headerlink" href="#opensk-v1" title="Permanent link">&para;</a></h2>
<p><img alt="OpenSK V1" src="../images/K46_with_label_reset.png" width="300px"> </p>
<p>It has a 3D-printed case with one user button and one RESET button.</p>
<h3 id="1-switch-to-bootloader-mode_1">1. Switch To bootloader mode<a class="headerlink" href="#1-switch-to-bootloader-mode_1" title="Permanent link">&para;</a></h3>
<p>After connect OpenSK to USB port, please insert a paper clip or a SIM-eject tool to the RESET button hole to switch it to bootloader mode. This is similar as user pushes the <a href="https://infocenter.nordicsemi.com/index.jsp?topic=%2Fug_nrf52840_dongle%2FUG%2Fnrf52840_Dongle%2Fprogramming.html">RESET button</a> on original nRF52840 USB dongle. </p>
<p>After connecting OpenSK to the USB port, please insert a paper clip or a SIM-eject tool to the RESET button hole to switch it to bootloader mode. This is similar to user pushes the <a href="https://infocenter.nordicsemi.com/index.jsp?topic=%2Fug_nrf52840_dongle%2FUG%2Fnrf52840_Dongle%2Fprogramming.html">RESET button</a> on the original nRF52840 USB dongle. </p>
<div class="admonition note">
<p class="admonition-title">NOTE</p>
<p>RESET button hole is covered by OpenSK label. So if you want to program the firmware occasionally, you can choose not to cover the label although we send the label to you together with OpenSK hardware.</p>
<p>The RESET button hole is covered by OpenSK label. So if you want to program the firmware occasionally, you can choose not to cover the label although we send the label to you together with OpenSK hardware.</p>
</div>
<h3 id="2-led-status_1">2. LED status<a class="headerlink" href="#2-led-status_1" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th align="left">LED behaviour</th>
<th align="left">LED behavior</th>
<th align="left">Mode type</th>
<th align="left">Triger Method</th>
<th align="left">Trigger Method</th>
</tr>
</thead>
<tbody>
@@ -501,7 +501,7 @@ Currently only <strong>V2</strong> is available to the market.</p>
</tbody>
</table>
<h3 id="3-hardware_1">3. Hardware<a class="headerlink" href="#3-hardware_1" title="Permanent link">&para;</a></h3>
<p>The hardawre schematic and PCB files can be downloaded <a href="../hardware_files/OpenSK_V1.zip">here</a>. </p>
<p>The hardware schematic and PCB files can be downloaded <a href="../hardware_files/OpenSK_V1.zip">here</a>. </p>
index.html
+22 -22
View File
@@ -227,8 +227,8 @@
</li>
<li class="md-nav__item">
<a href="#develop-environment-and-configuration" class="md-nav__link">
Develop Environment and configuration
<a href="#development-environment-and-configuration" class="md-nav__link">
Development Environment and configuration
</a>
</li>
@@ -356,8 +356,8 @@
</li>
<li class="md-nav__item">
<a href="#develop-environment-and-configuration" class="md-nav__link">
Develop Environment and configuration
<a href="#development-environment-and-configuration" class="md-nav__link">
Development Environment and configuration
</a>
</li>
@@ -399,7 +399,7 @@
<h1 id="_1"><img alt="OpenSK logo" src="images/OpenSK.svg" width="200px"><img alt="FIDO logo" src="images/FIDO_logo_black_RGB.png" style="margin: 0px 0px 40px 0px;" width="250px"><a class="headerlink" href="#_1" title="Permanent link">&para;</a></h1>
<h2 id="welcome-to-feitian-opensk-usb-dongle">Welcome to Feitian OpenSK USB Dongle<a class="headerlink" href="#welcome-to-feitian-opensk-usb-dongle" title="Permanent link">&para;</a></h2>
<p>OpenSK was <a href="https://security.googleblog.com/2020/01/say-hello-to-opensk-fully-open-source.html" title="Say hello to OpenSK: a fully open-source security key implementation">announced</a> by Google at January 30, 2020. It is a fully open-source FIDO security key implementation, include hardware and software. </p>
<p>OpenSK was <a href="https://security.googleblog.com/2020/01/say-hello-to-opensk-fully-open-source.html" title="Say hello to OpenSK: a fully open-source security key implementation">announced</a> by Google on January 30, 2020. It is a fully open-source FIDO security key implementation, include hardware and software. </p>
<p>In that <a href="https://security.googleblog.com/2020/01/say-hello-to-opensk-fully-open-source.html" title="Say hello to OpenSK: a fully open-source security key implementation">announcement</a>, Google said<br />
<div class="highlight"><pre><span></span><code> By opening up OpenSK as a research platform, our hope is that
it will be used by researchers, security key manufacturers,
@@ -407,27 +407,27 @@
accelerate security key adoption.
</code></pre></div>
The firmware of OpenSK is developed in Rust and it implements both FIDO U2F and FIDO2 <a href="https://fidoalliance.org/specs/fido2/fido-client-to-authenticator-protocol-v2.1-rd-20191217.html">specifications</a>. These specifications are released by <a href="https://fidoalliance.org/" title="FIDO Alliance">FIDO Alliance</a>, which is an open industry association with a focused mission: authentication standards to help reduce the world’s over-reliance on passwords. FEITIAN is the Board Member.</p>
<p>To help and accelerate FIDO security key adoption, FEITIAN improves the housing and makes new design of OpenSK USB Dongle, remove unused PCB components, public the design. Users can build firmware from source code of <a href="https://github.com/google/opensk" title="OpenSK">Google OpenSK github repository</a> without changing anything, provision it to this OpenSK hardware, to experence and try <a href="https://fidoalliance.org/" title="FIDO Alliance">FIDO</a> authentications.</p>
<p>Before you try to program firmware to OpenSK, please read original <a href="https://github.com/google/OpenSK">OpenSK guide</a> at first. The following documents are most like additional remarks.</p>
<p>To help and accelerate FIDO security key adoption, FEITIAN improves the housing and makes new designs of OpenSK USB Dongle, removes unused PCB components, public the design. Users can build firmware from the source code of <a href="https://github.com/google/opensk" title="OpenSK">Google OpenSK github repository</a> without changing anything, provision it to this OpenSK hardware, to experience and try <a href="https://fidoalliance.org/" title="FIDO Alliance">FIDO</a> authentications.</p>
<p>Before you try to program firmware to OpenSK, please read the original <a href="https://github.com/google/OpenSK">OpenSK guide</a> at first. The following documents are most like additional remarks.</p>
<h3 id="opensk-model">OpenSK Model<a class="headerlink" href="#opensk-model" title="Permanent link">&para;</a></h3>
<p>We have two model of OpenSK USB Dongle, V1 and V2. They are designed according to <a href="https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-Dongle">nRF52840 USB dongle</a>, which is used by Google OpenSK firmware. The difference between V1 and V2 is the method to enter bootloader mode. </p>
<p>To OpenSK V1, user should insert a paper clip or a SIM-eject tool to the RESET button hole to enter bootloader mode. This is similar as user push the RESET button on nRF52840 USB dongle. </p>
<p>To OpenSK V2, after user connects the device to computer, he should push and hold on the user button for more 8 seconds, then OpenSK will be in bootloader mode. </p>
<p>For detailed informations, please refer to <a href="hardware/">hardware description page</a>.</p>
<p>We have two models of OpenSK USB Dongle, V1 and V2. They are designed according to the <a href="https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-Dongle">nRF52840 USB dongle</a>, which is used by Google OpenSK firmware. The difference between V1 and V2 is the method to enter bootloader mode. </p>
<p>To OpenSK V1, user should insert a paper clip or a SIM-eject tool to the RESET button hole to enter bootloader mode. This is similar to user push the RESET button on the nRF52840 USB dongle. </p>
<p>To OpenSK V2, after user connects the device to a computer, he should push and hold on to the user button for more than 8 seconds, then OpenSK will be in bootloader mode. </p>
<p>For detailed information, please refer to the <a href="hardware/">hardware description page</a>.</p>
<h2 id="programming-firmware">Programming firmware<a class="headerlink" href="#programming-firmware" title="Permanent link">&para;</a></h2>
<h3 id="pre-requisite">Pre-requisite<a class="headerlink" href="#pre-requisite" title="Permanent link">&para;</a></h3>
<ul>
<li>The OpenSK USB Dongle V1 or V2.<br />
Before you program the firmware to OpenSK USB Dongle, you should switch it to bootloader mode. Please refer to <a href="hardware/">Harware Page</a> to learn how to switch OpenSK to bootloader mode.</li>
<li>Read Original OpenSK guide.<br />
Before you perform following opertaions, please read <a href="https://github.com/google/opensk">OpenSK</a> and its <a href="https://github.com/google/OpenSK/blob/master/docs/install.md">installation guide</a> to learn how to customize your security key, for example, to change the signature counter mechnisam and Attestation Certificate.</li>
Before you program the firmware to OpenSK USB Dongle, you should switch it to bootloader mode. Please refer to the <a href="hardware/">Hardware Page</a> to learn how to switch OpenSK to bootloader mode.</li>
<li>Read the Original OpenSK guide.<br />
Before you perform the following operations, please read <a href="https://github.com/google/opensk">OpenSK</a> and its <a href="https://github.com/google/OpenSK/blob/master/docs/install.md">installation guide</a> to learn how to customize your security key, for example, to change the signature counter mechanism and Attestation Certificate.</li>
<li>Install <a href="https://pypi.org/project/nrfutil/">nrfutil</a> tool.<br />
This tool allows you to directly flash firmware to OpenSK over USB without additional hardware.</li>
</ul>
<h3 id="develop-environment-and-configuration">Develop Environment and configuration<a class="headerlink" href="#develop-environment-and-configuration" title="Permanent link">&para;</a></h3>
<h3 id="development-environment-and-configuration">Development Environment and configuration<a class="headerlink" href="#development-environment-and-configuration" title="Permanent link">&para;</a></h3>
<ol>
<li>Prepare develop environment.<br />
You should prepare developing environment by yourself according to <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#software">this section</a>.</li>
<li>Prepare a Development environment.<br />
You should prepare a Development environment by yourself according to <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#software">this section</a>.</li>
<li>
<p>Clone <a href="https://github.com/google/opensk" title="OpenSK">Google OpenSK github repository</a>.<br />
<div class="highlight"><pre><span></span><code>$ git clone --recursive https://github.com/google/OpenSK.git
@@ -440,24 +440,24 @@ If you just cloned this repository, you need to run the following script: </p>
</ol>
<p><div class="highlight"><pre><span></span><code>$ ./setup.sh
</code></pre></div>
For more information, please refer to <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#initial-setup">Initial setup</a>. </p>
For more information, please refer to the <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#initial-setup">Initial setup</a>. </p>
<ol>
<li>Configure the OpenSK security parameter.<br />
Please follow the description to change <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#replacing-the-certificates">Attestation Certificate</a> as you want. If you are not familar with OpenSK and FIDO, we recommend you do not change anything.</li>
Please follow the description to change the <a href="https://github.com/google/OpenSK/blob/master/docs/install.md#replacing-the-certificates">Attestation Certificate</a> as you want. If you are not familiar with OpenSK and FIDO, we recommend you do not change anything.</li>
</ol>
<h3 id="flashing-the-firmware">Flashing the firmware<a class="headerlink" href="#flashing-the-firmware" title="Permanent link">&para;</a></h3>
<p>Although you can download the firmware to our OpenSK V1 and V2 by using J-LINK as described in <a href="https://github.com/google/OpenSK/blob/master/docs/install.md">OpenSK installation guide</a>, we recommend you program the firmware through USB interface, it is more convenient. </p>
<p>Although you can download the firmware to our OpenSK V1 and V2 by using J-LINK as described in <a href="https://github.com/google/OpenSK/blob/master/docs/install.md">OpenSK installation guide</a>, we recommend you program the firmware through the USB interface, it is more convenient. </p>
<ol>
<li>Switch OpenSK to bootloader mode.<br />
Please refer to <a href=".#opensk-model">OpenSK Model</a> or <a href="hardware/">hardware page</a> to learn how to switch OpenSK to bootloader mode.<br />
The LEDs show different behaviour in differet mode. Please refer to <a href="hardware/">hardware page</a> to see LED status of OpenSK V1 and V2 .</li>
The LEDs show different behavior in different mode. Please refer to the <a href="hardware/">hardware page</a> to see LED status of OpenSK V1 and V2.</li>
<li>Program the OpenSK USB dongle.<br />
<div class="highlight"><pre><span></span><code>$ ./deploy.py --board=nrf52840_dongle_dfu --opensk --programmer=nordicdfu
</code></pre></div>
When prompt <br />
<div class="highlight"><pre><span></span><code>Press [ENTER] when ready.
</code></pre></div>
Just press Enter, the firmware will be flahsed to your OpenSK USB Dongle. </li>
Just press Enter, the firmware will be flashed to your OpenSK USB Dongle. </li>
</ol>
<div class="admonition note">
<p class="admonition-title">NOTE</p>
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+4 -4
View File
@@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2020-12-28</lastmod>
<lastmod>2021-01-18</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-12-28</lastmod>
<lastmod>2021-01-18</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-12-28</lastmod>
<lastmod>2021-01-18</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-12-28</lastmod>
<lastmod>2021-01-18</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.
test/index.html
+11 -11
View File
@@ -257,8 +257,8 @@
</li>
<li class="md-nav__item">
<a href="#-googel-advanced-protection" class="md-nav__link">
- Googel Advanced Protection
<a href="#-google-advanced-protection" class="md-nav__link">
- Google Advanced Protection
</a>
</li>
@@ -412,8 +412,8 @@
</li>
<li class="md-nav__item">
<a href="#-googel-advanced-protection" class="md-nav__link">
- Googel Advanced Protection
<a href="#-google-advanced-protection" class="md-nav__link">
- Google Advanced Protection
</a>
</li>
@@ -473,13 +473,13 @@
<h1>Test FIDO</h1>
<p>Congratulations that you have got your own OpenSK USB dongle, now you can try FIDO functions to do fast online authentication. OpenSK implements <a href="https://fidoalliance.org/fido2/">FIDO2(CTAP2)</a> and FIDO U2F specifications, it can support any website leveraging <a href="https://www.w3.org/TR/webauthn/">W3C WebAuthN</a>. </p>
<p>Congratulations that you have got your OpenSK USB dongle, now you can try FIDO functions to do fast online authentication. OpenSK implements <a href="https://fidoalliance.org/fido2/">FIDO2(CTAP2)</a> and FIDO U2F specifications, it can support any website leveraging <a href="https://www.w3.org/TR/webauthn/">W3C WebAuthN</a>. </p>
<h2 id="manage-opensk">Manage OpenSK<a class="headerlink" href="#manage-opensk" title="Permanent link">&para;</a></h2>
<p>There are two ways to manage your OpenSK USB Dongle, include Reset, Set PIN and Change PIN. </p>
<p>There are two ways to manage your OpenSK USB Dongle, include Reset, Set PIN, and Change PIN. </p>
<h4 id="windows-settings">Windows Settings<a class="headerlink" href="#windows-settings" title="Permanent link">&para;</a></h4>
<ol>
<li>Open the <strong>Windows Settings app</strong>, select <strong>Accounts</strong>, select <strong>Sign-in options</strong>, select <strong>Security Key</strong>, and then select <strong>Manage</strong>.</li>
<li>You can then attach OpenSK to USB port to manage it as as you want. </li>
<li>You can then attach OpenSK to the USB port to manage it as you want. </li>
</ol>
<div class="admonition note">
<p class="admonition-title">NOTE</p>
@@ -495,7 +495,7 @@
</ol>
<div class="admonition note">
<p class="admonition-title">NOTE</p>
<p>I don't know the exact version of Chrome which started to add this UI, but please update it to latest version to have this function.</p>
<p>I don't know the exact version of Chrome that started to add this UI, but please update it to the latest version to have this function.</p>
</div>
<h2 id="demo-websites">Demo Websites<a class="headerlink" href="#demo-websites" title="Permanent link">&para;</a></h2>
<p>There are a lot of Demo websites list <a href="https://github.com/herrjemand/awesome-webauthn#demos">here</a>, you can try and test. <br />
@@ -507,7 +507,7 @@ Here I recommend <br />
<p>I can not guaranty that all the demo websites can work well with OpenSK.</p>
</div>
<h2 id="real-use-cases">Real use cases<a class="headerlink" href="#real-use-cases" title="Permanent link">&para;</a></h2>
<p>There are a lot of online servides which can use FIDO2/U2F to do 2FA or passwordless authentication, please refer to <a href="https://www.ftsafe.com/article/620.html">FEITIAN website</a> and click corresponding service ICON to learn.</p>
<p>There are a lot of online services that can use FIDO2/U2F to do 2FA or passwordless authentication, please refer to <a href="https://www.ftsafe.com/article/620.html">FEITIAN website</a> and click corresponding service ICON to learn.</p>
<p>Here just emphasize services from two big FIDO players, Google and Microsoft.</p>
<h3 id="google">Google<a class="headerlink" href="#google" title="Permanent link">&para;</a></h3>
<h4 id="-google-2-step-verification">- Google 2-Step Verification<a class="headerlink" href="#-google-2-step-verification" title="Permanent link">&para;</a></h4>
@@ -515,7 +515,7 @@ Here I recommend <br />
<li>Please refer to <a href="https://support.google.com/accounts/answer/185839?co=GENIE.Platform%3DAndroid&amp;hl=en">Google's help</a> to bind OpenSK to your Google services. Or </li>
<li>Take a look at 2.1 of <a href="https://www.ftsafe.com/download/webdownload/FIDO/Manual/FEITIAN%20U2F%20scenarios%20instructions.pdf">Feitian's help document</a> to bind and try OpenSK instead of ePass FIDO security key.</li>
</ul>
<h4 id="-googel-advanced-protection">- Googel Advanced Protection<a class="headerlink" href="#-googel-advanced-protection" title="Permanent link">&para;</a></h4>
<h4 id="-google-advanced-protection">- Google Advanced Protection<a class="headerlink" href="#-google-advanced-protection" title="Permanent link">&para;</a></h4>
<ul>
<li>Please refer to <a href="https://landing.google.com/advancedprotection/">landing page</a> or <a href="https://support.google.com/accounts/answer/7519408?co=GENIE.Platform%3DAndroid&amp;hl=en&amp;oco=0">help page</a> of Google Advanced Protection to get how to setup. </li>
</ul>
@@ -529,7 +529,7 @@ Here I recommend <br />
<p>Surely there are a lot of other online services except for Google's and Microsoft's, you can learn from<br />
- <a href="https://download.ftsafe.com/files/FIDO/fido2/FEITIAN%20FIDO2%20scenarios%20instructions.pdf">FIDO2 Scenarios</a> and <a href="https://www.ftsafe.com/download/webdownload/FIDO/Manual/FEITIAN%20U2F%20scenarios%20instructions.pdf">U2F Scenarios</a> from Feitian's resources.<br />
- <a href="https://xpass.freshdesk.com/support/solutions/60000318639">Knowledge Base</a> from Feitian<br />
- <a href="https://fido.ftsafe.com/catalog/">fido.ftsafe.com</a> Dedicated FIDO website from Feitian. Here you can find list of online services to use FIDO.</p>
- <a href="https://fido.ftsafe.com/catalog/">fido.ftsafe.com</a> Dedicated FIDO website from Feitian. Here you can find the list of online services to use FIDO.</p>