You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
131 lines
5.5 KiB
131 lines
5.5 KiB
// Copyright (c) 2014-2019, The Monero Project
|
|
//
|
|
// 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 electrum-words.h
|
|
*
|
|
* \brief Mnemonic seed generation and wallet restoration from them.
|
|
*
|
|
* This file and its cpp file are for translating Electrum-style word lists
|
|
* into their equivalent byte representations for cross-compatibility with
|
|
* that method of "backing up" one's wallet keys.
|
|
*/
|
|
|
|
#ifndef ELECTRUM_WORDS_H
|
|
#define ELECTRUM_WORDS_H
|
|
|
|
#include <string>
|
|
#include <cstdint>
|
|
#include "crypto/crypto.h" // for declaration of crypto::secret_key
|
|
|
|
namespace epee { class wipeable_string; }
|
|
|
|
/*!
|
|
* \namespace crypto
|
|
*
|
|
* \brief crypto namespace.
|
|
*/
|
|
namespace crypto
|
|
{
|
|
/*!
|
|
* \namespace crypto::ElectrumWords
|
|
*
|
|
* \brief Mnemonic seed word generation and wallet restoration helper functions.
|
|
*/
|
|
namespace ElectrumWords
|
|
{
|
|
|
|
const int seed_length = 24;
|
|
const std::string old_language_name = "EnglishOld";
|
|
/*!
|
|
* \brief Converts seed words to bytes (secret key).
|
|
* \param words String containing the words separated by spaces.
|
|
* \param dst To put the secret data restored from the words.
|
|
* \param len The number of bytes to expect, 0 if unknown
|
|
* \param duplicate If true and len is not zero, we accept half the data, and duplicate it
|
|
* \param language_name Language of the seed as found gets written here.
|
|
* \return false if not a multiple of 3 words, or if word is not in the words list
|
|
*/
|
|
bool words_to_bytes(const epee::wipeable_string &words, epee::wipeable_string& dst, size_t len, bool duplicate,
|
|
std::string &language_name);
|
|
/*!
|
|
* \brief Converts seed words to bytes (secret key).
|
|
* \param words String containing the words separated by spaces.
|
|
* \param dst To put the secret key restored from the words.
|
|
* \param language_name Language of the seed as found gets written here.
|
|
* \return false if not a multiple of 3 words, or if word is not in the words list
|
|
*/
|
|
bool words_to_bytes(const epee::wipeable_string &words, crypto::secret_key& dst,
|
|
std::string &language_name);
|
|
|
|
/*!
|
|
* \brief Converts bytes to seed words.
|
|
* \param src Secret data
|
|
* \param len Secret data length in bytes (positive multiples of 4 only)
|
|
* \param words Space delimited concatenated words get written here.
|
|
* \param language_name Seed language name
|
|
* \return true if successful false if not. Unsuccessful if wrong key size.
|
|
*/
|
|
bool bytes_to_words(const char *src, size_t len, epee::wipeable_string& words,
|
|
const std::string &language_name);
|
|
|
|
/*!
|
|
* \brief Converts bytes (secret key) to seed words.
|
|
* \param src Secret key
|
|
* \param words Space delimited concatenated words get written here.
|
|
* \param language_name Seed language name
|
|
* \return true if successful false if not. Unsuccessful if wrong key size.
|
|
*/
|
|
bool bytes_to_words(const crypto::secret_key& src, epee::wipeable_string& words,
|
|
const std::string &language_name);
|
|
|
|
/*!
|
|
* \brief Gets a list of seed languages that are supported.
|
|
* \param languages A vector is set to the list of languages.
|
|
* \param english whether to get the names in English or the language language
|
|
*/
|
|
void get_language_list(std::vector<std::string> &languages, bool english = false);
|
|
|
|
/*!
|
|
* \brief Tells if the seed passed is an old style seed or not.
|
|
* \param seed The seed to check (a space delimited concatenated word list)
|
|
* \return true if the seed passed is a old style seed false if not.
|
|
*/
|
|
bool get_is_old_style_seed(const epee::wipeable_string &seed);
|
|
|
|
/*!
|
|
* \brief Returns the name of a language in English
|
|
* \param name the name of the language in its own language
|
|
* \return the name of the language in English
|
|
*/
|
|
std::string get_english_name_for(const std::string &name);
|
|
}
|
|
}
|
|
|
|
#endif
|