src/core/crypto/ecdsa.hpp

/*
 *  Copyright (c) 2018, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 *   This file includes definitions for performing ECDSA signing.
 */

#ifndef ECDSA_HPP_
#define ECDSA_HPP_

#include "openthread-core-config.h"

#include <stdint.h>
#include <stdlib.h>

#include <openthread/error.h>

namespace ot {
namespace Crypto {

/**
 * @addtogroup core-security
 *
 * @{
 *
 */

/**
 * This class implements ECDSA signing.
 *
 */
class Ecdsa
{
public:
    /**
     * This method creates ECDSA sign.
     *
     * @param[out]    aOutput            An output buffer where ECDSA sign should be stored.
     * @param[inout]  aOutputLength      The length of the @p aOutput buffer.
     * @param[in]     aInputHash         An input hash.
     * @param[in]     aInputHashLength   The length of the @p aInputHash buffer.
     * @param[in]     aPrivateKey        A private key in PEM format.
     * @param[in]     aPrivateKeyLength  The length of the @p aPrivateKey buffer.
     *
     * @retval  OT_ERROR_NONE         ECDSA sign has been created successfully.
     * @retval  OT_ERROR_NO_BUFS      Output buffer is too small.
     * @retval  OT_ERROR_INVALID_ARGS Private key is not valid EC Private Key.
     * @retval  OT_ERROR_FAILED       Error during signing.
     *
     */
    static otError Sign(uint8_t *      aOutput,
                        uint16_t &     aOutputLength,
                        const uint8_t *aInputHash,
                        uint16_t       aInputHashLength,
                        const uint8_t *aPrivateKey,
                        uint16_t       aPrivateKeyLength);
};

/**
 * @}
 *
 */

} // namespace Crypto
} // namespace ot

#endif // ECDSA_HPP_