CryptoCodecInterface.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_CRYPTOCODECINTERFACE_H_
#define ACSDK_CRYPTOINTERFACES_CRYPTOCODECINTERFACE_H_

#include <vector>

namespace alexaClientSDK {
namespace cryptoInterfaces {

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

    typedef std::vector<unsigned char> Key;

    typedef std::vector<unsigned char> IV;

    typedef std::vector<unsigned char> Tag;

    virtual ~CryptoCodecInterface() noexcept = default;

    virtual bool init(const Key& key, const IV& iv) noexcept = 0;

    virtual bool processAAD(const DataBlock& dataIn) noexcept = 0;

    virtual bool processAAD(DataBlock::const_iterator dataInBegin, DataBlock::const_iterator dataInEnd) noexcept = 0;

    virtual bool process(const DataBlock& dataIn, DataBlock& dataOut) noexcept = 0;

    virtual bool process(
        DataBlock::const_iterator dataInBegin,
        DataBlock::const_iterator dataInEnd,
        DataBlock& dataOut) noexcept = 0;

    virtual bool finalize(DataBlock& dataOut) noexcept = 0;

    virtual bool getTag(Tag& tag) noexcept = 0;

    virtual bool setTag(const Tag& tag) noexcept = 0;
};

}  // namespace cryptoInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_CRYPTOINTERFACES_CRYPTOCODECINTERFACE_H_