PKCS11KeyStore.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
 
#ifndef ACSDKPKCS11_PRIVATE_PKCS11KEYSTORE_H_
#define ACSDKPKCS11_PRIVATE_PKCS11KEYSTORE_H_
 
#include <memory>
#include <unordered_map>
 
#include <acsdkCryptoInterfaces/KeyStoreInterface.h>
#include <acsdkPkcs11/private/PKCS11Functions.h>
#include <acsdkPkcs11/private/PKCS11Key.h>
#include <acsdkPkcs11/private/PKCS11KeyDescriptor.h>
#include <acsdkPkcs11/private/PKCS11Session.h>
#include <acsdkPkcs11/private/PKCS11Slot.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
 
namespace alexaClientSDK {
namespace acsdkPkcs11 {
 
using alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType;
using alexaClientSDK::acsdkCryptoInterfaces::KeyStoreInterface;
using alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface;
 
class PKCS11KeyStore : public KeyStoreInterface {
public:
    static std::shared_ptr<KeyStoreInterface> create(
        const std::shared_ptr<MetricRecorderInterface>& metricRecorder = nullptr) noexcept;
 
    ~PKCS11KeyStore() noexcept override;
    bool encrypt(
        const std::string& keyAlias,
        AlgorithmType type,
        const IV& iv,
        const DataBlock& plaintext,
        KeyChecksum& checksum,
        DataBlock& ciphertext) noexcept override;
    bool encryptAE(
        const std::string& keyAlias,
        AlgorithmType type,
        const IV& iv,
        const DataBlock& aad,
        const DataBlock& plaintext,
        KeyChecksum& checksum,
        DataBlock& ciphertext,
        Tag& tag) noexcept override;
    bool decrypt(
        const std::string& keyAlias,
        AlgorithmType type,
        const KeyChecksum& checksum,
        const IV& iv,
        const DataBlock& ciphertext,
        DataBlock& plaintext) noexcept override;
    bool decryptAD(
        const std::string& keyAlias,
        AlgorithmType type,
        const KeyChecksum& checksum,
        const IV& iv,
        const DataBlock& aad,
        const DataBlock& ciphertext,
        const Tag& tag,
        DataBlock& plaintext) noexcept override;
    bool getDefaultKeyAlias(std::string& keyAlias) noexcept override;
 
private:
    PKCS11KeyStore(const std::shared_ptr<MetricRecorderInterface>& metricRecorder) noexcept;
 
    bool init() noexcept;
 
    std::shared_ptr<PKCS11Key> loadKey(const std::string& objectLabel, AlgorithmType type) noexcept;
 
    std::shared_ptr<PKCS11Key> loadKeyLocked(PKCS11KeyDescriptor&& descriptor) noexcept;
 
    void submitMetric(const std::string& activity, const std::string& eventName, uint64_t count, bool failure) noexcept;
 
    std::shared_ptr<MetricRecorderInterface> m_metricRecorder;
 
    std::shared_ptr<PKCS11Functions> m_functions;
 
    std::shared_ptr<PKCS11Session> m_session;
 
    std::mutex m_keysMutex;
 
    std::unordered_map<PKCS11KeyDescriptor, std::shared_ptr<PKCS11Key>> m_keys;
 
    std::string m_defaultKeyAlias;
};
 
}  // namespace acsdkPkcs11
}  // namespace alexaClientSDK
 
#endif  // ACSDKPKCS11_PRIVATE_PKCS11KEYSTORE_H_