Skip to content

Commit 595e1f7

Browse files
authored
Updated docs (#39)
1 parent d6e6ba0 commit 595e1f7

File tree

1 file changed

+98
-14
lines changed

1 file changed

+98
-14
lines changed

docs/conf-file_description.md

+98-14
Original file line numberDiff line numberDiff line change
@@ -6,82 +6,164 @@ File format is standard for Flipper Zero device. Each line has one setting ident
66

77
## Available keys
88

9-
### Filetype
9+
<details>
10+
<summary><h3 style="display: inline">Filetype</h3></summary>
11+
<p>
1012

1113
**Type:** const string
1214

1315
**Default value:** `Flipper TOTP plugin config file`
1416

1517
**Description:** File type definition. Used internally. Should not be updated manually
1618

17-
### Version
19+
</p>
20+
</details>
21+
22+
<details>
23+
<summary><h3 style="display: inline">Version</h3></summary>
24+
<p>
1825

1926
**Type:** const unsigned int
2027

2128
**Default value:** `2`
2229

2330
**Description:** File version. Used internally. Should not be updated manually.
2431

25-
### BaseIV
32+
</p>
33+
</details>
34+
35+
<details>
36+
<summary><h3 style="display: inline">BaseIV</h3></summary>
37+
<p>
2638

2739
**Type:** array of bytes
2840

2941
**Default value:** none
3042

3143
**Description:** Initialization vector (IV) which is getting generated randomly at first app start. It is used to setup encryption subsytem. Should not be updated manually.
32-
**Important note: changing or loosing this value will lead to incorrect decryption of all the encrypted data in the application and as a result it will not be possible to generate valid TOTP tokens**
3344

34-
### Crypto
45+
**Important note:** changing or loosing this value will lead to incorrect decryption of all the encrypted data in the application and as a result it will not be possible to generate valid TOTP tokens
46+
47+
</p>
48+
</details>
49+
50+
<details>
51+
<summary><h3 style="display: inline">Crypto</h3></summary>
52+
<p>
3553

3654
**Type:** array of bytes
3755

3856
**Default value:** none
3957

4058
**Description:** Used internally to verify user's PIN. Should not be changed manually.
41-
**Important note: changing or loosing this value will lead to incorrect PIN verification and it will not be possible to signin into app**
4259

43-
### Timezone
60+
**Important note:** changing or loosing this value will lead to incorrect PIN verification and it will not be possible to signin into app
61+
62+
</p>
63+
</details>
64+
65+
<details>
66+
<summary><h3 style="display: inline">Timezone</h3></summary>
67+
<p>
4468

4569
**Type:** float
4670

4771
**Default value:** 0.000000
4872

4973
**Description:** Timezone offset **in hours**. Need to be modified manually. Because of Flipper Zero API doesn't provide an access to timezone offset it is necessary to set it manually for correct TOTP tokens generation. You may find your timezone offset (or another name is "UTC offset") [here](https://www.timeanddate.com/time/zone/timezone/utc) or on any other website found in google.
50-
**Important note: if your timezone offset is negative, use negative sign, like this `-2.0`, however if your timezone offset is positive DO NOT use explicit positive sign, just put offset without any sign like this `2.0`**
5174

52-
### TokenName
75+
**Important note:** if your timezone offset is negative, use negative sign, like this `-2.0`, however if your timezone offset is positive DO NOT use explicit positive sign, just put offset without any sign like this `2.0`
76+
77+
</p>
78+
</details>
79+
80+
<details>
81+
<summary><h3 style="display: inline">PinIsSet</h3></summary>
82+
<p>
83+
84+
**Type:** bool
85+
86+
**Default value:** none
87+
88+
**Description:** Used internally to identify whether user set PIN or not. Should not be changed manually.
89+
90+
**Important note:** changing or loosing this value will lead to incorrect PIN verification and it will not be possible to signin into app
91+
92+
</p>
93+
</details>
94+
95+
<details>
96+
<summary><h3 style="display: inline">NotificationMethod</h3></summary>
97+
<p>
98+
99+
**Type:** enum (available options are `0`, `1`, `2`, `3`)
100+
101+
**Default value:** `3`
102+
103+
**Description:** How to notify user when new token is generated or badusb mode is activated. Possible values are:
104+
105+
* `0` - do not notify
106+
* `1` - notify using sound only
107+
* `2` - notify using vibro only
108+
* `3` - notify using sound and vibro
109+
110+
</p>
111+
</details>
112+
113+
<details>
114+
<summary><h3 style="display: inline">TokenName</h3></summary>
115+
<p>
53116

54117
**Type:** string
55118

56119
**Default value:** none
57120

58121
**Description:** Token name which will be visible in the UI and used just to let user identify token. Can be modified manually.
59122

60-
### TokenSecret
123+
</p>
124+
</details>
125+
126+
<details>
127+
<summary><h3 style="display: inline">TokenSecret</h3></summary>
128+
<p>
61129

62130
**Type:** array of bytes OR string
63131

64132
**Default value:** none
65133

66134
**Description:** Token secret. It can be either an array of encrypted bytes OR pure unencrypted token secret.
67-
**Important note: if app finds pure unencrypted token in config file app will encrypt it and replace in a config file for security purposes**
68135

69-
### TokenAlgo
136+
**Important note:** if app finds pure unencrypted token in config file app will encrypt it and replace in a config file for security purposes
137+
138+
</p>
139+
</details>
140+
141+
<details>
142+
<summary><h3 style="display: inline">TokenAlgo</h3></summary>
143+
<p>
70144

71145
**Type:** enum (available options are: `sha1`, `sha256`, `sha512`)
72146

73147
**Default value:** `sha1`
74148

75-
**Description:** Token hashing algorithm to be used to generate TOTP code. If you don't know which to use - use `sha1`.
149+
**Description:** Token hashing algorithm to be used to generate TOTP code. If you don't know which one to use - use `sha1`.
150+
151+
</p>
152+
</details>
76153

77-
### TokenDigits
154+
<details>
155+
<summary><h3 style="display: inline">TokenDigits</h3></summary>
156+
<p>
78157

79158
**Type:** enum (available options are `6` and `8`)
80159

81160
**Default value:** `6`
82161

83162
**Description:** Defines TOTP code length. If you don't know which to use - use `6` as majority of websites requires 6-digits code.
84163

164+
</p>
165+
</details>
166+
85167
## Example config file
86168

87169
```text
@@ -90,6 +172,8 @@ Version: 2
90172
BaseIV: AD F2 DE F3 31 92 C8 77 4B EB BF FE 7D E1 27 51
91173
Crypto: FE CC 38 99 28 A9 28 6B BC E1 E3 92 B9 02 8A DF
92174
Timezone: 2.000000
175+
PinIsSet: true
176+
NotificationMethod: 3
93177
TokenName: Test plain
94178
TokenSecret: 95 6B CE 3E 2F 01 AF 29 B2 9A DE CA E7 EF F5 B1
95179
TokenAlgo: sha1

0 commit comments

Comments
 (0)