Add resetState documentation

Summary:
Add documentation to `ConnectionContextStore::resetState`.

Useful to have, I guess.

Reviewed By: passy

Differential Revision: D46849937

fbshipit-source-id: 7dec76e23b566f460f0b22e0fa14b73e16a142f0
This commit is contained in:
Lorenzo Blasa
2023-06-21 13:33:10 -07:00
committed by Facebook GitHub Bot
parent 5e5b56b684
commit 3f6424930a

View File

@@ -38,6 +38,16 @@ class ConnectionContextStore {
*/
folly::Optional<FlipperCertificateExchangeMedium> getLastKnownMedium();
void storeConnectionConfig(folly::dynamic& config);
/**
* Reset state just removes all certificate exchange related files stored on
* the client. These are:
* - Certificate Sign Request (CSR)
* - CA Certificate
* - Server Certificate
* - Client Certificate
* - Client Key
* - Configuration file (includes device identifier)
*/
bool resetState();
/** Convert and save to disk the existing certificate to PKCS #12 format.