gnuk/doc/intro.rst

66 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2012-07-21 00:26:51 +00:00
Introduction
============
What's Gnuk?
------------
Gnuk is an implementation of USB cryptographic token for GNU Privacy
Guard. Gnuk supports OpenPGP card protocol version 2, and it runs on
STM32F103 processor.
2016-07-08 03:55:09 +00:00
This document explains about Gnuk 1.2, which comes with ECC algorithm.
2012-07-21 00:26:51 +00:00
Cryptographic token and feature of Gnuk
---------------------------------------
2012-08-02 08:11:42 +00:00
Cryptographic token is a store of private keys and it computes cryptographic
functions on the device.
The idea is to separate important secrets to independent device,
from where nobody can extract them.
2012-07-21 00:26:51 +00:00
Development Environment
-----------------------
2012-08-02 08:11:42 +00:00
See :doc:`development` for development environment for Gnuk.
Gnuk is developed on the environment where there are only Free Software.
Target boards for running Gnuk
------------------------------
Hardware requirement for Gnuk is the micro controller STM32F103.
2016-06-21 05:44:51 +00:00
In version 1.2, Gnuk supports following boards.
2012-08-02 08:11:42 +00:00
* FST-01 (Flying Stone Tiny ZERO-ONE)
* Olimex STM32-H103
2012-07-21 00:26:51 +00:00
2016-06-21 05:44:51 +00:00
* ST Nucleo F103
2013-10-24 07:02:50 +00:00
2016-06-21 05:44:51 +00:00
* Nitrokey Start
2012-08-02 08:11:42 +00:00
Host prerequisites for using Gnuk Token
---------------------------------------
2012-07-21 00:26:51 +00:00
* GNU Privacy Guard (GnuPG)
* libusb
2013-12-25 02:33:00 +00:00
* [Optional] SSH: openssh
2012-07-21 00:26:51 +00:00
2016-07-08 03:55:09 +00:00
* [experimental] Web: scute, firefox
2012-07-21 00:26:51 +00:00
2012-08-02 08:11:42 +00:00
Usages
------
2012-07-21 00:26:51 +00:00
* Sign with GnuPG
* Decrypt with GnuPG
2013-10-24 07:02:50 +00:00
* Use with OpenSSH through gpg-agent (as ssh-agent)
2016-07-08 03:55:09 +00:00
* [experimental] Use with Firefox through Scute for X.509 client certificate authentication