PKCS11Key.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_PKCS11KEY_H_
#define ACSDKPKCS11_PRIVATE_PKCS11KEY_H_
 
#include <memory>
#include <string>
 
#include <acsdkCryptoInterfaces/AlgorithmType.h>
#include <acsdkPkcs11/private/PKCS11API.h>
 
namespace alexaClientSDK {
namespace acsdkPkcs11 {
 
class PKCS11Session;
 
using alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType;
 
class PKCS11Key {
public:
    PKCS11Key(std::shared_ptr<PKCS11Session>&& session, CK_OBJECT_HANDLE keyHandle) noexcept;
 
    bool isCompatible(AlgorithmType type) noexcept;
 
    bool getAttributes(std::vector<unsigned char>& checksum, bool& neverExtractable) noexcept;
 
    bool encrypt(
        AlgorithmType algorithmType,
        const std::vector<unsigned char>& iv,
        const std::vector<unsigned char>& aad,
        const std::vector<unsigned char>& plaintext,
        std::vector<unsigned char>& ciphertext,
        std::vector<unsigned char>& tag) noexcept;
 
    bool decrypt(
        AlgorithmType algorithmType,
        const std::vector<unsigned char>& iv,
        const std::vector<unsigned char>& aad,
        const std::vector<unsigned char>& ciphertext,
        const std::vector<unsigned char>& tag,
        std::vector<unsigned char>& plaintext) noexcept;
 
    bool configureMechanism(
        CK_MECHANISM_TYPE mechanismType,
        const std::vector<unsigned char>& iv,
        const std::vector<unsigned char>& aad,
        CK_MECHANISM& params,
        CK_GCM_PARAMS& gcmParams) noexcept;
 
private:
    std::shared_ptr<PKCS11Session> m_session;
 
    CK_OBJECT_HANDLE m_keyHandle;
};
 
}  // namespace acsdkPkcs11
}  // namespace alexaClientSDK
 
#endif  // ACSDKPKCS11_PRIVATE_PKCS11KEY_H_