PKCS11KeyDescriptor.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_PKCS11KEYDESCRIPTOR_H_
#define ACSDKPKCS11_PRIVATE_PKCS11KEYDESCRIPTOR_H_
 
#include <functional>
#include <string>
 
#include <acsdkCryptoInterfaces/AlgorithmType.h>
#include <acsdkPkcs11/private/PKCS11API.h>
 
namespace alexaClientSDK {
namespace acsdkPkcs11 {
 
struct PKCS11KeyDescriptor {
    std::string objectLabel;
 
    CK_KEY_TYPE keyType;
 
    CK_ULONG keyLen;
 
    PKCS11KeyDescriptor(PKCS11KeyDescriptor&& arg) noexcept = default;
 
    PKCS11KeyDescriptor(const std::string& objectLabel, acsdkCryptoInterfaces::AlgorithmType algorithmType) noexcept;
 
    PKCS11KeyDescriptor(const std::string& objectLabel, CK_KEY_TYPE keyType, CK_ULONG keyLen) noexcept;
 
    static bool mapAlgorithmToKeyParams(
        acsdkCryptoInterfaces::AlgorithmType algorithmType,
        CK_KEY_TYPE& keyType,
        CK_ULONG& keyLen);
};
 
}  // namespace acsdkPkcs11
}  // namespace alexaClientSDK
 
namespace std {
 
template <>
struct hash<alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor> {
    std::size_t operator()(const alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor& arg) const noexcept;
};
 
template <>
struct equal_to<alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor> {
    bool operator()(
        const alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor& arg1,
        const alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor& arg2) const noexcept;
};
 
// Dumps PKCS11KeyDescriptor data into stream (for logging).
std::ostream& operator<<(std::ostream& out, const alexaClientSDK::acsdkPkcs11::PKCS11KeyDescriptor& arg) noexcept;
 
}  // namespace std
 
#endif  // ACSDKPKCS11_PRIVATE_PKCS11KEYDESCRIPTOR_H_