Fix bn.c.
[gnuk/gnuk.git] / doc / intro.rst
1 Introduction
2 ============
3
4
5 What's Gnuk?
6 ------------
7
8 Gnuk is an implementation of USB cryptographic token for GNU Privacy
9 Guard.  Gnuk supports OpenPGP card protocol version 2, and it runs on
10 STM32F103 processor.
11
12 This document explains about Gnuk 1.2, which comes with ECC algorithm.
13
14
15 Cryptographic token and feature of Gnuk
16 ---------------------------------------
17
18 Cryptographic token is a store of private keys and it computes cryptographic
19 functions on the device.
20
21 The idea is to separate important secrets to independent device, 
22 from where nobody can extract them.
23
24
25 Development Environment
26 -----------------------
27
28 See :doc:`development` for development environment for Gnuk.
29 Gnuk is developed on the environment where there are only Free Software.
30
31
32 Target boards for running Gnuk
33 ------------------------------
34
35 Hardware requirement for Gnuk is the micro controller STM32F103.
36 In version 1.2, Gnuk supports following boards.
37
38 * FST-01 (Flying Stone Tiny ZERO-ONE)
39
40 * Olimex STM32-H103
41
42 * ST Nucleo F103
43
44 * Nitrokey Start
45
46
47 Host prerequisites for using Gnuk Token
48 ---------------------------------------
49
50 * GNU Privacy Guard (GnuPG)
51
52 * libusb
53
54 * [Optional] SSH: openssh
55
56 * [experimental] Web: scute, firefox
57
58
59 Usages
60 ------
61
62 * Sign with GnuPG
63 * Decrypt with GnuPG
64 * Use with OpenSSH through gpg-agent (as ssh-agent)
65 * [experimental] Use with Firefox through Scute for X.509 client certificate authentication