src/tools/spake2p/Cmd_GenVerifier.cpp

/*
 *
 *    Copyright (c) 2022 Project CHIP Authors
 *    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.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License 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.
 */

/**
 *    @file
 *      This file implements the command handler for the 'spake2p' tool
 *      that generates Verifier.
 *
 */

#include "spake2p.h"

#include <cstring>
#include <fstream>
#include <iomanip>
#include <iostream>

#include <CHIPVersion.h>
#include <crypto/CHIPCryptoPAL.h>
#include <lib/support/Base64.h>
#include <lib/support/CHIPArgParser.hpp>
#include <lib/support/CHIPMem.h>
#include <protocols/secure_channel/PASESession.h>
#include <setup_payload/SetupPayload.h>

using namespace chip::Crypto;

namespace {

using namespace chip::ArgParser;

#define CMD_NAME "spake2p gen-verifier"

bool HandleOption(const char * progName, OptionSet * optSet, int id, const char * name, const char * arg);

// clang-format off
OptionDef gCmdOptionDefs[] =
{
    { "count",           kArgumentRequired, 'c' },
    { "pin-code",        kArgumentRequired, 'p' },
    { "pin-code-file",   kArgumentRequired, 'f' },
    { "iteration-count", kArgumentRequired, 'i' },
    { "salt-len",        kArgumentRequired, 'l' },
    { "salt",            kArgumentRequired, 's' },
    { "out",             kArgumentRequired, 'o' },
    { }
};

const char * const gCmdOptionHelp =
    "   -c, --count <int>\n"
    "\n"
    "       The number of pin-code/verifier parameter sets to be generated. If not specified,\n"
    "       one set will be generated.\n"
    "\n"
    "   -p, --pin-code <int>\n"
    "\n"
    "       SPAKE2P setup PIN code. The value should be positive integer in range [1..99999998].\n"
    "       If not specified, the PIN code value will be randomly generated.\n"
    "       When count is more than one, only first set will use the specified PIN code value\n"
    "       and others will be randomly generated.\n"
    "       The following PIN codes SHALL NOT be used due to their trivial, insecure nature:\n"
    "          * 00000000\n"
    "          * 11111111\n"
    "          * 22222222\n"
    "          * 33333333\n"
    "          * 44444444\n"
    "          * 55555555\n"
    "          * 66666666\n"
    "          * 77777777\n"
    "          * 88888888\n"
    "          * 99999999\n"
    "          * 12345678\n"
    "          * 87654321\n"
    "\n"
    "   -f, --pin-code-file <file>\n"
    "\n"
    "       A file which contains all the PIN codes to generate verifiers.\n"
    "       Each line in this file should be a valid PIN code in the decimal number format. If the row count\n"
    "       of this file is less than the number of pin-code/verifier parameter sets to be generated, the\n"
    "       first few verifier sets will be generated using the PIN codes in this file, and the next will\n"
    "       use the random PIN codes.\n"
    "       The following file is a example with 5 PIN codes:\n"
    "       1234\n"
    "       2345\n"
    "       3456\n"
    "       4567\n"
    "       5678\n"
    "\n"
    "   -i, --iteration-count <int>\n"
    "\n"
    "       SPAKE2P PBKDF iteration count. The value should be positive integer in range [1000..100000].\n"
    "\n"
    "   -l, --salt-len <int>\n"
    "\n"
    "       SPAKE2P PBKDF salt input length. The value should be in range [16..32].\n"
    "       If not specified, the 'salt' input should be specified and the length will be\n"
    "       extracted from 'salt'. When both 'salt-len' and 'salt' are specified, the length\n"
    "       should match the length of the specified 'salt' string.\n"
    "\n"
    "   -s, --salt <string>\n"
    "\n"
    "       SPAKE2P PBKDF salt input value. Length of salt string should be in range [16..32].\n"
    "       If not specified, the 'salt-len' input should be specified and the 'salt' velue will be\n"
    "       randomly generated. When 'count' is more than one, only first set will use the specified\n"
    "       'salt' value and others will be randomly generated.\n"
    "\n"
    "   -o, --out <file>\n"
    "\n"
    "       File to contain the generated SPAKE2P PBKDF parameters. Specify '-' for stdout.\n"
    "       The format of the output file is:\n"
    "           Index,PIN Code,Iteration Count,Salt,Verifier\n"
    "           index of the parameter set in the list,'pin-code','iteration-count','salt'(Base-64 encoded),'verifier'(Base-64 encoded)\n"
    "           ....\n"
    "\n"
    ;

OptionSet gCmdOptions =
{
    HandleOption,
    gCmdOptionDefs,
    "COMMAND OPTIONS",
    gCmdOptionHelp
};

HelpOptions gHelpOptions(
    CMD_NAME,
    "Usage: " CMD_NAME " [ <options...> ]\n",
    CHIP_VERSION_STRING "\n" COPYRIGHT_STRING,
    "Generate a CHIP certificate"
);

OptionSet *gCmdOptionSets[] =
{
    &gCmdOptions,
    &gHelpOptions,
    nullptr
};
// clang-format on

uint32_t gCount          = 1;
uint32_t gPinCode        = chip::kSetupPINCodeUndefinedValue;
uint32_t gIterationCount = 0;
uint8_t gSalt[BASE64_MAX_DECODED_LEN(BASE64_ENCODED_LEN(kSpake2p_Max_PBKDF_Salt_Length))];
uint8_t gSaltDecodedLen   = 0;
uint8_t gSaltLen          = 0;
const char * gOutFileName = nullptr;
std::ifstream gPinCodeFile;

static uint32_t GetNextPinCode()
{
    if (!gPinCodeFile.is_open())
    {
        return chip::kSetupPINCodeUndefinedValue;
    }
    std::string pinCodeStr;
    uint32_t pinCode = chip::kSetupPINCodeUndefinedValue;
    std::getline(gPinCodeFile, pinCodeStr);
    if (!gPinCodeFile.fail())
    {
        if (pinCodeStr.length() > 8)
        {
            pinCodeStr = pinCodeStr.substr(0, 8);
        }
        pinCode = static_cast<uint32_t>(atoi(pinCodeStr.c_str()));
        if (!chip::SetupPayload::IsValidSetupPIN(pinCode))
        {
            std::cerr << "The line " << pinCodeStr << " in PIN codes file is invalid, using a random PIN code.\n";
            pinCode = chip::kSetupPINCodeUndefinedValue;
        }
    }
    return pinCode;
}

bool HandleOption(const char * progName, OptionSet * optSet, int id, const char * name, const char * arg)
{
    switch (id)
    {
    case 'c':
        if (!ParseInt(arg, gCount) || gCount == 0)
        {
            PrintArgError("%s: Invalid value specified for parameter set count: %s\n", progName, arg);
            return false;
        }
        break;
    case 'p':
        // Specifications sections 5.1.1.6 and 5.1.6.1
        if (!ParseInt(arg, gPinCode) || (!chip::SetupPayload::IsValidSetupPIN(gPinCode)))
        {
            PrintArgError("%s: Invalid value specified for pin-code parameter: %s\n", progName, arg);
            return false;
        }
        break;

    case 'f':
        gPinCodeFile.open(arg, std::ios::in);
        if (gPinCodeFile.fail())
        {
            PrintArgError("%s: Failed to open the PIN code file: %s\n", progName, arg);
            return false;
        }
        gPinCode = GetNextPinCode();
        break;

    case 'i':
        if (!ParseInt(arg, gIterationCount) ||
            !(gIterationCount >= kSpake2p_Min_PBKDF_Iterations && gIterationCount <= kSpake2p_Max_PBKDF_Iterations))
        {
            PrintArgError("%s: Invalid value specified for the iteration-count parameter: %s\n", progName, arg);
            return false;
        }
        break;

    case 'l':
        if (!ParseInt(arg, gSaltLen) || !(gSaltLen >= kSpake2p_Min_PBKDF_Salt_Length && gSaltLen <= kSpake2p_Max_PBKDF_Salt_Length))
        {
            PrintArgError("%s: Invalid value specified for salt length parameter: %s\n", progName, arg);
            return false;
        }
        break;

    case 's':
        if (strlen(arg) > BASE64_ENCODED_LEN(kSpake2p_Max_PBKDF_Salt_Length))
        {
            std::cerr << progName << ": Salt parameter too long: " << arg << "\n";
            return false;
        }

        gSaltDecodedLen = static_cast<uint8_t>(chip::Base64Decode32(arg, static_cast<uint32_t>(strlen(arg)), gSalt));

        // The first check was just to make sure Base64Decode32 would not write beyond the buffer.
        // Now double-check if the length is correct.
        if (gSaltDecodedLen > kSpake2p_Max_PBKDF_Salt_Length)
        {
            std::cerr << progName << ": Salt parameter too long: " << arg << "\n";
            return false;
        }

        if (gSaltDecodedLen < kSpake2p_Min_PBKDF_Salt_Length)
        {
            std::cerr << progName << ": Salt parameter too short: " << arg << "\n";
            return false;
        }

        break;

    case 'o':
        gOutFileName = arg;
        break;

    default:
        PrintArgError("%s: Unhandled option: %s\n", progName, name);
        return false;
    }

    return true;
}

} // namespace

bool Cmd_GenVerifier(int argc, char * argv[])
{
    std::ofstream outFile;
    std::ostream * outStream = &outFile;
    if (argc == 1)
    {
        gHelpOptions.PrintBriefUsage(stderr);
        return true;
    }

    bool res = ParseArgs(CMD_NAME, argc, argv, gCmdOptionSets);
    VerifyOrReturnValue(res, false);

    if (gIterationCount == 0)
    {
        std::cerr << "Please specify the iteration-count parameter.\n";
        return false;
    }

    if (gSaltDecodedLen == 0 && gSaltLen == 0)
    {
        std::cerr << "Please specify at least one of the 'salt' or 'salt-len' parameters.\n";
        return false;
    }
    if (gSaltDecodedLen != 0 && gSaltLen != 0 && gSaltDecodedLen != gSaltLen)
    {
        std::cerr << "The specified 'salt-len' doesn't match the length of 'salt' parameter.\n";
        return false;
    }
    if (gSaltLen == 0)
    {
        gSaltLen = gSaltDecodedLen;
    }

    if (gOutFileName == nullptr)
    {
        std::cerr << "Please specify the output file name, or - for stdout.\n";
        return false;
    }

    if (strcmp(gOutFileName, "-") != 0)
    {
        outFile.open(gOutFileName, std::ios::binary | std::ios::trunc);
        if (!outFile.is_open())
        {
            std::cerr << "Unable to create file " << gOutFileName << "\n" << strerror(errno) << "\n";
            return false;
        }
    }
    else
    {
        outStream = &std::cout;
    }
    (*outStream) << "Index,PIN Code,Iteration Count,Salt,Verifier\n";
    if (outStream->fail())
    {
        std::cerr << "Error writing to output file: " << strerror(errno) << "\n";
    }

    for (uint32_t i = 0; i < gCount; i++)
    {
        uint8_t salt[kSpake2p_Max_PBKDF_Salt_Length];
        if (gSaltDecodedLen == 0)
        {
            CHIP_ERROR err = chip::Crypto::DRBG_get_bytes(salt, gSaltLen);
            if (err != CHIP_NO_ERROR)
            {
                std::cerr << "DRBG_get_bytes() failed.\n";
                return false;
            }
        }
        else
        {
            memcpy(salt, gSalt, gSaltLen);
        }

        Spake2pVerifier verifier;
        CHIP_ERROR err = chip::PASESession::GeneratePASEVerifier(verifier, gIterationCount, chip::ByteSpan(salt, gSaltLen),
                                                                 (gPinCode == chip::kSetupPINCodeUndefinedValue), gPinCode);
        if (err != CHIP_NO_ERROR)
        {
            std::cerr << "GeneratePASEVerifier() failed.\n";
            return false;
        }

        Spake2pVerifierSerialized serializedVerifier;
        chip::MutableByteSpan serializedVerifierSpan(serializedVerifier);
        err = verifier.Serialize(serializedVerifierSpan);
        if (err != CHIP_NO_ERROR)
        {
            std::cerr << "Spake2pVerifier::Serialize() failed.\n";
            return false;
        }

        char saltB64[BASE64_ENCODED_LEN(kSpake2p_Max_PBKDF_Salt_Length) + 1];
        uint32_t saltB64Len = chip::Base64Encode32(salt, gSaltLen, saltB64);
        saltB64[saltB64Len] = '\0';

        char verifierB64[BASE64_ENCODED_LEN(kSpake2p_VerifierSerialized_Length) + 1];
        uint32_t verifierB64Len     = chip::Base64Encode32(serializedVerifier, kSpake2p_VerifierSerialized_Length, verifierB64);
        verifierB64[verifierB64Len] = '\0';

        (*outStream) << i << "," << std::setfill('0') << std::setw(8) << gPinCode << "," << gIterationCount << "," << saltB64 << ","
                     << verifierB64 << "\n";
        if (outStream->fail())
        {
            std::cerr << "Error writing to output file: " << strerror(errno) << "\n";
            return false;
        }

        // If the file with PIN codes is not provided, the PIN code on next iteration will be randomly generated.
        gPinCode = GetNextPinCode();
        // On the next iteration the Salt will be randomly generated.
        gSaltDecodedLen = 0;
    }

    gPinCodeFile.close();
    return true;
}