Ajax::TShell::Provision Class Reference

This class implements a TShell command that is used to provision a GM6000 unit at production. More...

Detailed Description

This class implements a TShell command that is used to provision a GM6000 unit at production.

This class assumes that the following MP exists: mp::serialNumber mp::modelNumber TODO: mp::XYZ - Algorithm stuffs....

#include <Provision.h>

Inheritance diagram for Ajax::TShell::Provision:

Collaboration diagram for Ajax::TShell::Provision:

Public Member Functions
const char *	getUsage () const noexcept
	See Cpl::TShell::Command `.
const char *	getHelp () const noexcept
	See Cpl::TShell::Command.
	Provision (Cpl::Container::SList< Cpl::TShell::Command > &commandList, Ajax::Main::PersonalityRecord &personalityRecord, Cpl::Persistent::RecordServer &recordServer, Driver::Crypto::Hash &sha512HashFunction, Cpl::TShell::Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
	Constructor.
Cpl::TShell::Command::Result_T	execute (Cpl::TShell::Context_ &context, char *cmdString, Cpl::Io::Output &outfd) noexcept
	See Cpl::TShell::Command.
Public Member Functions inherited from Cpl::TShell::Cmd::Command
const char *	getVerb () const noexcept
	See Cpl::TShell::Command.
Security::Permission_T	getMinPermissionRequired () const noexcept
	See Cpl::TShell::Command.
Public Member Functions inherited from Cpl::TShell::Command
virtual	~Command ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Static Public Attributes
static constexpr const char *	verb = "prov"
	The command verb/identifier.
static constexpr const char *	usage = "prov <modelNumber> <serialNumber> <consolePwd> <h-outS> <h-maxY> <h-errS> <h-dErrS> <h-outK0> <h-outK1> <h-outK2> <h-outK3> <h-outK4> <fanLow> <fanMed> <fanHi> <maxCap>"
	The command usage string.
static constexpr const char *	detailedHelp = " Provisions the GM6000 with its 'personality'"
	The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

Protected Member Functions
bool	hashPassword (const char *plaintext, Cpl::Text::String &workBufferMem, Cpl::Text::String &workDigestMem, Cpl::Text::String &outputBufferMemory) noexcept
	Helper function.
Protected Member Functions inherited from Cpl::TShell::Cmd::Command
	Command (Cpl::Container::SList< Cpl::TShell::Command > &commandList, const char *verb, Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
	Constructor.
Protected Member Functions inherited from Cpl::TShell::Command
	Command ()
	Constructor.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
Cpl::Persistent::RecordServer &	m_recordServer
	Persistent Storage Server.
Ajax::Main::PersonalityRecord &	m_personalityRec
	Personality record that I write to.
Driver::Crypto::Hash &	m_sha512
	Hash function to use. The expectation is this a SHA512 has function.
Protected Attributes inherited from Cpl::TShell::Cmd::Command
const char *	m_verb
	Command verb.
Security::Permission_T	m_minPermissionLevel
	Minimum required user permission need to execute me.

Additional Inherited Members
Public Types inherited from Cpl::TShell::Command
enum	Result_T {   eSUCCESS = 0 , eERROR_BAD_SYNTAX = 1 , eERROR_INVALID_CMD = 2 , eERROR_IO = 3 ,   eERROR_MISSING_ARGS = 4 , eERROR_EXTRA_ARGS = 5 , eERROR_INVALID_ARGS = 6 , eERROR_FAILED = 7 }
	Possible result codes when executing a command. More...
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Types inherited from Cpl::TShell::Cmd::Command
enum	CondResult_T { eFALSE , eTRUE , eERROR }
	Result when processing a conditional statement. More...

Constructor & Destructor Documentation

Provision()

Ajax::TShell::Provision::Provision ( Cpl::Container::SList< Cpl::TShell::Command > & commandList, Ajax::Main::PersonalityRecord & personalityRecord, Cpl::Persistent::RecordServer & recordServer, Driver::Crypto::Hash & sha512HashFunction, Cpl::TShell::Security::Permission_T minPermLevel = OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL )

noexcept

Constructor.

Member Function Documentation

execute()

Cpl::TShell::Command::Result_T Ajax::TShell::Provision::execute ( Cpl::TShell::Context_ & context, char * cmdString, Cpl::Io::Output & outfd )

virtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getHelp()

const char * Ajax::TShell::Provision::getHelp ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getUsage()

const char * Ajax::TShell::Provision::getUsage ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command `.

Implements Cpl::TShell::Command.

hashPassword()

bool Ajax::TShell::Provision::hashPassword ( const char * plaintext, Cpl::Text::String & workBufferMem, Cpl::Text::String & workDigestMem, Cpl::Text::String & outputBufferMemory )

protectednoexcept

Helper function.

Member Data Documentation

detailedHelp

constexpr const char* Ajax::TShell::Provision::detailedHelp = " Provisions the GM6000 with its 'personality'"

staticconstexpr

The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

m_personalityRec

Ajax::Main::PersonalityRecord& Ajax::TShell::Provision::m_personalityRec

protected

Personality record that I write to.

m_recordServer

Cpl::Persistent::RecordServer& Ajax::TShell::Provision::m_recordServer

protected

Persistent Storage Server.

m_sha512

Driver::Crypto::Hash& Ajax::TShell::Provision::m_sha512

protected

Hash function to use. The expectation is this a SHA512 has function.

usage

constexpr const char* Ajax::TShell::Provision::usage = "prov <modelNumber> <serialNumber> <consolePwd> <h-outS> <h-maxY> <h-errS> <h-dErrS> <h-outK0> <h-outK1> <h-outK2> <h-outK3> <h-outK4> <fanLow> <fanMed> <fanHi> <maxCap>"

staticconstexpr

The command usage string.

verb

constexpr const char* Ajax::TShell::Provision::verb = "prov"

staticconstexpr

The command verb/identifier.

---

The documentation for this class was generated from the following file:

• Ajax/TShell/Provision.h