config.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. #pragma once
  2. #include "../../types/plugin_state.h"
  3. #include "../../types/token_info.h"
  4. #include "config_file_context.h"
  5. #include "constants.h"
  6. #include "token_info_iterator.h"
  7. typedef uint8_t TotpConfigFileOpenResult;
  8. typedef uint8_t TotpConfigFileUpdateResult;
  9. /**
  10. * @brief Tries to take a config file backup
  11. * @param plugin_state application state
  12. * @return backup path if backup successfully taken; \c NULL otherwise
  13. */
  14. char* totp_config_file_backup(const PluginState* plugin_state);
  15. /**
  16. * @brief Loads basic information from an application config file into application state without loading all the tokens
  17. * @param plugin_state application state
  18. * @return Config file open result
  19. */
  20. bool totp_config_file_load(PluginState* const plugin_state);
  21. /**
  22. * @brief Updates timezone offset in an application config file
  23. * @param plugin_state application state
  24. * @return Config file update result
  25. */
  26. bool totp_config_file_update_timezone_offset(const PluginState* plugin_state);
  27. /**
  28. * @brief Updates notification method in an application config file
  29. * @param plugin_state application state
  30. * @return Config file update result
  31. */
  32. bool totp_config_file_update_notification_method(const PluginState* plugin_state);
  33. /**
  34. * @brief Updates automation method in an application config file
  35. * @param plugin_state application state
  36. * @return Config file update result
  37. */
  38. bool totp_config_file_update_automation_method(const PluginState* plugin_state);
  39. /**
  40. * @brief Updates application user settings
  41. * @param plugin_state application state
  42. * @return Config file update result
  43. */
  44. bool totp_config_file_update_user_settings(const PluginState* plugin_state);
  45. /**
  46. * @brief Updates crypto signatures information
  47. * @param plugin_state application state
  48. * @return Config file update result
  49. */
  50. bool totp_config_file_update_crypto_signatures(const PluginState* plugin_state);
  51. /**
  52. * @brief Reset all the settings to default
  53. * @param plugin_state application state
  54. */
  55. void totp_config_file_reset(PluginState* const plugin_state);
  56. /**
  57. * @brief Closes config file and releases all the resources
  58. * @param plugin_state application state
  59. */
  60. void totp_config_file_close(PluginState* const plugin_state);
  61. /**
  62. * @brief Updates config file encryption by re-encrypting it using new user's PIN and new randomly generated IV
  63. * @param plugin_state application state
  64. * @param new_crypto_key_slot new crypto key slot to be used
  65. * @param new_pin new user's PIN
  66. * @param new_pin_length new user's PIN length
  67. * @return \c true if config file encryption successfully updated; \c false otherwise
  68. */
  69. bool totp_config_file_update_encryption(
  70. PluginState* plugin_state,
  71. uint8_t new_crypto_key_slot,
  72. const uint8_t* new_pin,
  73. uint8_t new_pin_length);
  74. /**
  75. * @brief Ensures application config file uses latest encryption and upgrades encryption if needed
  76. * @param plugin_state application state
  77. * @param pin user's PIN
  78. * @param pin_length user's PIN length
  79. * @return \c true if operation succeeded; \c false otherwise
  80. */
  81. bool totp_config_file_ensure_latest_encryption(
  82. PluginState* plugin_state,
  83. const uint8_t* pin,
  84. uint8_t pin_length);
  85. /**
  86. * @brief Gets token info iterator context
  87. * @param plugin_state application state
  88. * @return token info iterator context
  89. */
  90. TokenInfoIteratorContext* totp_config_get_token_iterator_context(const PluginState* plugin_state);