Files
flipper/xplat/Flipper/ConnectionContextStore.h
Lorenzo Blasa 3f6424930a Add resetState documentation
Summary:
Add documentation to `ConnectionContextStore::resetState`.

Useful to have, I guess.

Reviewed By: passy

Differential Revision: D46849937

fbshipit-source-id: 7dec76e23b566f460f0b22e0fa14b73e16a142f0
2023-06-21 13:33:10 -07:00

69 lines
1.8 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <folly/Optional.h>
#include <folly/dynamic.h>
#include <string>
#include "FlipperCertificateExchangeMedium.h"
#include "FlipperInitConfig.h"
namespace facebook {
namespace flipper {
class ConnectionContextStore {
public:
enum StoreItem {
CSR,
FLIPPER_CA,
CLIENT_CERT,
PRIVATE_KEY,
CERTIFICATE,
CONNECTION_CONFIG,
};
ConnectionContextStore(DeviceData deviceData);
bool hasRequiredFiles();
std::string getCertificateSigningRequest();
std::string getCertificateDirectoryPath();
std::string getCACertificatePath();
std::string getDeviceId();
std::string getPath(StoreItem storeItem);
/**
* Get medium over which the certificate was received.
*/
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.
* @return Returns a pair where `first` contains the certificate file path and
* `second` contains the certificate export password. If there's an error, the
* pair will contain both empty strings.
*/
std::pair<std::string, std::string> getCertificate();
private:
DeviceData deviceData_;
std::string csr = "";
std::string absoluteFilePath(const char* filename);
};
} // namespace flipper
} // namespace facebook