Преглед на файлове

Few more consistency to README

alex.kopachov преди 3 години
родител
ревизия
bfdd5aac36
променени са 3 файла, в които са добавени 12 реда и са изтрити 9 реда
  1. 8 4
      .github/conf-file_description.md
  2. 4 4
      README.md
  3. 0 1
      fbt.ps1

+ 8 - 4
.github/conf-file_description.md

@@ -28,7 +28,8 @@ File format is standard for Flipper Zero device. Each line has one setting ident
 
 **Default value:** none
 
-**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. **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**
+**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.
+**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**
 
 ### Crypto
 
@@ -36,7 +37,8 @@ File format is standard for Flipper Zero device. Each line has one setting ident
 
 **Default value:** none
 
-**Description:** Used internally to verify user's PIN. Should not be changed manually. **Important note: changing or loosing this value will lead to incorrect PIN verification and it will not be possible to signin into app**
+**Description:** Used internally to verify user's PIN. Should not be changed manually.
+**Important note: changing or loosing this value will lead to incorrect PIN verification and it will not be possible to signin into app**
 
 ### Timezone
 
@@ -44,7 +46,8 @@ File format is standard for Flipper Zero device. Each line has one setting ident
 
 **Default value:** 0.000000
 
-**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 you 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. **Important note: if you timezone offset is negative, use negative sign, like this `-2.0`, however if you timezone offset is positive DO NOT use explicit positive sign, just put offset without any sign like this `2.0`**
+**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 you 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.
+**Important note: if you timezone offset is negative, use negative sign, like this `-2.0`, however if you timezone offset is positive DO NOT use explicit positive sign, just put offset without any sign like this `2.0`**
 
 ### TokenName
 
@@ -60,7 +63,8 @@ File format is standard for Flipper Zero device. Each line has one setting ident
 
 **Default value:** none
 
-**Description:** Token secret. It can be either an array of encrypted bytes OR pure unencrypted token secret. **Important note: if app finds pure unencrypted token in config file app will encrypt it and replace in a config file for security purposes**
+**Description:** Token secret. It can be either an array of encrypted bytes OR pure unencrypted token secret.
+**Important note: if app finds pure unencrypted token in config file app will encrypt it and replace in a config file for security purposes**
 
 ### TokenAlgo
 

+ 4 - 4
README.md

@@ -13,15 +13,15 @@ If you don't want to build the app yourself then just pull FAP file from [latest
 
 ## How to build it?
 
-Just pull the repo with recursive submodule initialization and then run `./build.ps1` command to build the app. Once done FAP files will be available in the `build` directory.
+Pull the repo with recursive submodule initialization and then run `./build.ps1` command to build the app. Once done FAP files will be available in the `build` directory.
 
-## Config file
+## Where is config file?
 
 At first start app will create new config file (default location is [`/ext/apps/Misc/totp.conf`](https://github.com/akopachov/flipper-zero_authenticator/blob/master/totp/services/config/config.c#:~:text=%23define%20CONFIG_FILE_DIRECTORY_PATH,totp.conf%22)).
 
 Detailed description of file format can be found [here](.github/conf-file_description.md)
 
-## Security
+## Is it secure?
 
 Flipper Authenticator stores token secrets in config file in encrypted form. Encryption is done using standard Flipepr Zero API, which states that it is using AES encryption with built-in into flipper secret key and initialization vector (IV) generated by the app at initial setup XOR-ed by user's PIN.
 
@@ -31,7 +31,7 @@ If user provides plain token secret manually straight to a config file, once app
 
 Let me know if you have an ideas of how we can make Flipper Authenticator even more secure.
 
-## Support
+## How to support author?
 
 * [Buy me a coffee](https://buycoffee.to/akopachov)
 * BTC: `bc1qu9k48q93uhvr9w5cn8fzz5yxuvh4e27c6hnczq`

+ 0 - 1
fbt.ps1

@@ -19,7 +19,6 @@ Write-Host "Using $firmware_name firmware to run FBT"
 if ((Test-Path -Path "$firmware_path\applications_user\totp") -ne $True) {
     $mklink_command = "mklink /D $firmware_path\applications_user\totp ..\..\totp"
     if (!(New-Object Security.Principal.WindowsPrincipal([Security.Principal.WindowsIdentity]::GetCurrent())).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
-        Write-Host $PSScriptRoot
         Start-Process -FilePath 'cmd' -ArgumentList ( "/C", "cd $PSScriptRoot & $mklink_command") -Verb RunAs
     } else {
         Invoke-Expression -Command $mklink_command