KeyStoreInterface.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 ACSDK_CRYPTOINTERFACES_KEYSTOREINTERFACE_H_
#define ACSDK_CRYPTOINTERFACES_KEYSTOREINTERFACE_H_

#include <memory>
#include <string>
#include <vector>

#include "AlgorithmType.h"

namespace alexaClientSDK {
namespace cryptoInterfaces {

class KeyStoreInterface {
public:
    typedef std::vector<unsigned char> DataBlock;

    typedef std::vector<unsigned char> IV;

    typedef std::vector<unsigned char> KeyChecksum;

    typedef std::vector<unsigned char> Tag;

    virtual ~KeyStoreInterface() noexcept = default;

    virtual bool encrypt(
        const std::string& keyAlias,
        AlgorithmType type,
        const IV& iv,
        const DataBlock& plaintext,
        KeyChecksum& checksum,
        DataBlock& ciphertext) noexcept = 0;

    virtual bool encryptAE(
        const std::string& keyAlias,
        AlgorithmType type,
        const IV& iv,
        const DataBlock& aad,
        const DataBlock& plaintext,
        KeyChecksum& checksum,
        DataBlock& ciphertext,
        Tag& tag) noexcept = 0;

    virtual bool decrypt(
        const std::string& keyAlias,
        AlgorithmType type,
        const KeyChecksum& checksum,
        const IV& iv,
        const DataBlock& ciphertext,
        DataBlock& plaintext) noexcept = 0;

    virtual 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 = 0;

    virtual bool getDefaultKeyAlias(std::string& keyAlias) noexcept = 0;
};

}  // namespace cryptoInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_CRYPTOINTERFACES_KEYSTOREINTERFACE_H_