virtru_client.h

Go to the documentation of this file.

/*
* Copyright © 2018 - 2019 Virtru Corporation
*
* SPDX - License - Identifier: MIT
*
*/
//
//  Virtru TDF3 SDK
//
//  Created by Sujan Reddy on 2019/07/17.
//

#ifndef VIRTRU_TDF3_SDK_VIRTRU_CLIENT_H
#define VIRTRU_TDF3_SDK_VIRTRU_CLIENT_H

#include <string>
#include <vector>

#include "virtru_policy.h"
#include "virtru_encrypt_file_params.h"
#include "virtru_encrypt_stream_params.h"
#include "virtru_encrypt_data_params.h"
#include "virtru_encrypt_string_params.h"
#include "tdf_constants.h"
#include "virtru_credentials.h"


namespace virtru {

    class ILogger;
    class VirtruTDF3Builder;
    class EncryptFileParams;

    class Client {
    public:
        Client(std::string owner, std::string appId);

        Client(std::string owner, std::string apiKey, std::string apiSecret);

        Client(std::string owner, std::string organizationName, std::string clientId, std::string clientSecret);

        Client(const Credentials& credentials);

        Client() = delete;

        ~Client();

        Client(const Client& client) = delete;

        Client& operator=(const Client& client)  = delete;

        Client(Client&& client) = delete;

        Client& operator=(Client&& client)  = delete;

    public: 

        void setKasUrl(const std::string& kasUrl);

        void setOIDCProviderUrl(const std::string& oidcUrl);

        void setEasUrl(const std::string& easUrl);

        void setAcmUrl(const std::string& acmUrl);

        void setSecureReaderURL(const std::string& srUrl);

        void setEncryptedStorageURL(const std::string& encryptedStorageUrl);

        void setRCAServiceURL(const std::string& rcaServiceURL);

        void setProtocol(Protocol protocol);

        void setOffline(bool state);

        void setKeyAccessType(KeyAccessType keyAccessType);

    public: 
        void enableConsoleLogging(LogLevel logLevel = LogLevel::Current);

        //JAVACPPSKIPBEGIN
        void setExternalLogger(std::shared_ptr<ILogger> externalLogger, LogLevel logLevel = LogLevel::Current);
        //JAVACPPSKIPEND

    public: 
        void setCertAuthority(const std::string& certAuthority);

    public: // Encrypt and Decrypt
        std::string encryptFile(const EncryptFileParams& encryptFileParam);

        std::pair<std::string, std::string> encryptFileToRCA(const EncryptFileParams& encryptFileParam);

        std::string encryptStream(const EncryptStreamParams& encryptStreamParams);

        //JAVACPPSKIPBEGIN
        std::pair<std::string, std::string> encryptString(const EncryptStringParams& encryptStringParams);
        //JAVACPPSKIPEND

        std::pair<std::string, std::string> encryptStringToRCA(const EncryptStringParams& encryptStringParams);

        void decryptFile(const std::string& inFilepath, const std::string& outFilepath);

        void decryptRCAToFile(const std::string& rcaLink, const std::string& outFilepath);

        void decryptStream(std::istream& inStream, std::ostream& outStream);

        std::string decryptString(std::string tdfData);

        std::string decryptRCAToString(const std::string& rcaLink);

    public: // Update policy
        void updatePolicyForUUID(const Policy& policy, const std::string& policyUUID);

        void updatePolicyForUUIDs(const Policy& policy, const std::vector<std::string>& policyUUIDs);

        void updatePolicyForFile(const Policy& policy, const std::string& tdfFile);

        void updatePolicyForFiles(const Policy& policy, const std::vector<std::string>& files);

        void revokePolicy(const std::string& policyUUID);

        void revokePolicies(const std::vector<std::string>& policyUUIDs);

        void revokeFile(const std::string& tdfFile);

        void revokeFiles(const std::vector<std::string>& files);

    public: // Retrieve policy
        Policy fetchPolicyForUUID(const std::string& policyUUID);

        std::string getUserId();

    private:
        void initClient();

        std::string prepareForEncrypt(const EncryptParams& encryptParams);

    private: 
        std::unique_ptr<VirtruTDF3Builder> m_virtruTDF3Builder;
    };
}



#endif // VIRTRU_TDF3_SDK_VIRTRU_CLIENT_H