summaryrefslogtreecommitdiff
path: root/manual/plugins/passmgr.tex
blob: b93e6e0fca9a5642f1332c8d99088a859e1760c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
% $Id$ %
\subsection{Password Manager}
This plugin allows you to generate one-time passwords as a second
factor of authentication for online services which support it, such as
GitHub and Google. This plugin supports both counter-based (HOTP), and
time-based (TOTP) password schemes. It also supports storing static
passwords securely.

\subsubsection{Adding Accounts}
To add a new account, choose the ``Import Account(s)'' menu
option. There are two ways to import an account, either from a file
containing account information in URI format, or manual entry.

\opt{rtc}{ It is important to note that for TOTP (time-based) accounts
  to work properly, the clock on your device MUST be accurate to no
  less than 30 seconds from the time on the authentication server, and
  the correct time zone must be configured in the plugin.  See
  \reference{ref:Timeanddateactual} for more information.  }

\subsubsection{URI Import}
This method of adding an account reads a list of URIs from a file. It
expects each URI to be on a line by itself in the following format:

\begin{verbatim}
otpauth://[hotp OR totp]/[account name]?secret=[Base32 secret][&counter=X][&period=X][&digits=X]
\end{verbatim}

An example is shown below, provisioning a TOTP key for an account called ``bob'':

\begin{verbatim}
otpauth://totp/bob?secret=JBSWY3DPEHPK3PXP
\end{verbatim}

Any other URI options are not supported and will be ignored.

This option will also look for ``username:password'' lines and import
those as static passwords.

Most services will provide a scannable QR code that encodes a OTP
URI. In order to use those, first scan the QR code separately and save
the URI to a file on your device. If necessary, rewrite the URI so it
is in the format shown above. For example, GitHub's URI has a slash
after the provider. In order for this URI to be properly parsed, you
must rewrite the account name so that it does not contain a slash.

\subsubsection{Manual Import}
If direct URI import is not possible, the plugin supports the manual
entry of data associated with an account. After you select the
``Manual Entry'' option, it will prompt you for an account name. You
may type anything you wish, but it should be memorable. It will then
prompt you for the Base32-encoded secret. Most services will provide
this to you directly, but some may only provide you with a QR code. In
these cases, you must scan the QR code separately, and then enter the
string following the ``secret='' parameter on your Rockbox device
manually.

On devices with a real-time clock, \opt{rtc}{like yours,} the plugin
will ask whether the account is a time-based account
(TOTP). \opt{rtc}{If you answer ``yes'' to this question, it will ask
  for further information regarding the account. Usually it is safe to
  accept the defaults here. } However, if your device lacks a
real-time clock, the plugin's functionality will be restricted to
HMAC-based (HOTP) accounts only. If this is the case, the plugin will
prompt you for information regarding the HOTP setup.

\subsubsection{Account Export}
This plugin allows you to export account data to a file for backup and
transfer purposes. This option is located under the ``Advanced''
menu. It will prompt for for a filename, and will write all your
account data to the specified file. This file can be imported by this
plugin using the ``From URI List'' option when importing. Please note
that you should not attempt to copy the ``passmgr.dat'' from the
.rockbox directory to another device.

\subsubsection{Encryption}
This plugin supports the optional encryption of account data while
stored on disk. This feature is located under the ``Advanced'' menu
option. Upon enabling this feature, you must enter an encryption
password that will need to be entered each time the plugin starts
up. It is recommended that you use a strong, alphanumeric password of
at least 8 characters in order to frustrate attempts to guess the
password. Be sure not to forget this password. In the event that the
password is lost, it is nearly impossible to recover your account
data.

Account data is encrypted with 128-bit AES encryption in counter
mode. The key is derived from the your password and a nonce by using
PBKDF2-HMAC-SHA1, with a variable number of iterations, calibrated by
default to take 250 milliseconds. This parameter can be adjusted using
the ``Change KDF Delay'' option under the ``Encryption'' submenu. The
nonce is generated from the system's current tick and the real-time
clock, if available, making collision unlikely. Some later-model iPods
have a hardware AES core with a hardcoded, device-specific key that
cannot easily be extracted. When available, the device-specific key is
used to encrypt the actual encryption key, tying the ciphertext to the
device, making a brute-force attack more difficult. One should note
that this does not rely completely rely on the hardware encryption
key, it merely utilizes it as part of defense in depth.


\opt{rtc} {
  \subsubsection{Time Zone Configuration}
  In order for TOTP accounts to work properly, the plugin must be able
  to determine the current UTC time. This means that, first, your
  device's clock must be synchronized with UTC time, and second, that
  the plugin knows what time zone the clock is using. The plugin will
  prompt you on its first run for this piece of information. However,
  should this setting need changing at a later time, possibly due to
  Daylight Saving Time adjustment, it is located under the
  ``Advanced'' submenu. NOTE: in the UI simulator, use the ``UTC''
  setting no matter what the clock may read. }