DtaDevEnterprise.h

/* C:B**************************************************************************
This software is Copyright 2014-2017 Bright Plaza Inc. <drivetrust@drivetrust.com>
This software is Copyright 2017 Spectra Logic Corporation

This file is part of sedutil.

sedutil is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

sedutil is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with sedutil.  If not, see <http://www.gnu.org/licenses/>.

 * C:E********************************************************************** */
#pragma once
class DtaCommand;
class DtaSession;

#include "os.h"
#include "DtaOptions.h"
#include "DtaDev.h"
#include "DtaDevOS.h"
#include "DtaStructures.h"
#include "DtaLexicon.h"
#include "DtaResponse.h"   // wouldn't take class
#include <vector>

using namespace std;
/** Device Class represents a disk device, conforming to the TCG Enterprise standard
*/

class DtaDevEnterprise : public DtaDevOS {
public:
        /** Constructor using an OS specific device descriptor.
         * @param devref reference to device is OS specific lexicon 
         *  */
	DtaDevEnterprise(const char * devref);
         /** Default destructor, does nothing*/
	~DtaDevEnterprise();
        /** Inform TPer of the communication propertied I wiah to use and 
         * receive the TPer maximum values
         */
	uint8_t properties();
         /** Send a command to the device and wait for the response
         * @param cmd the DtaCommand object containg the command
         * @param response the DtaResonse object containing the response
         * @param protocol The security protocol number to use for the command
         */
	uint8_t exec(DtaCommand * cmd, DtaResponse & resp, uint8_t protocol = 0x01);
         /** return the communications ID to be used for sessions to this device */
	uint16_t comID();
        /** Change the SID password from it's MSID default 
         * @param newpassword  new password for SID 
         */
	uint8_t takeOwnership(char * newpassword);
        /** Change the passwords for the enabled Bandmasters and the Erasemaster 
         * from the MSID default.
         * @param defaultPassword the MSID password
         * @param newPassword the nesw password to be set
         *  */
	uint8_t initLSPUsers(char * defaultPassword, char * newPassword);
        /** retrieve the MSID password */
	uint8_t printDefaultPassword();
        /** retrieve a single row from a table 
         * @param table the UID of the table
         * @param startcol the starting column of data requested
         * @param endcol the ending column of the data requested 
         */
	uint8_t getTable(vector<uint8_t> table, const char * startcol,
		const char * endcol);
         /** Set the SID password.
         * Requires special handling because password is not always hashed.
         * @param oldpassword  current SID password
         * @param newpassword  value password is to be changed to
         * @param hasholdpwd  is the old password to be hashed before being added to the bytestream
         * @param hashnewpwd  is the new password to be hashed before being added to the bytestream
         */ 
	uint8_t setSIDPassword(char * oldpassword, char * newpassword,
		uint8_t hasholdpwd = 1, uint8_t hashnewpwd = 1);
        /** set a single column in an object table 
         * @param table the UID of the table
         * @param name the column name to be set
         * @param value data to be stored the the column 
         */
	uint8_t setTable(vector<uint8_t> table, const char *name,
		vector<uint8_t> value);
        /** set a single column in a table 
         * @param table the UID of the table
         * @param name the column name to be set
         * @param value data to be stored the the column 
         */
	uint8_t setTable(vector<uint8_t> table, const char *name,
		OPAL_TOKEN value);
    /** dummy code not implemented the the enterprise SSC */
	uint8_t activateLockingSP(char * password);
	/** dummy code not implemented in teh enterprise SSC*/
	uint8_t activateLockingSP_SUM(uint8_t lockingrange, char * password);
	/** dummy code not implemented in teh enterprise SSC*/
	uint8_t eraseLockingRange_SUM(uint8_t lockingrange, char * password);
        /** dummy code not implemented in teh enterprise SSC*/
	uint8_t revertLockingSP(char * password, uint8_t keep = 0);
        /** get the UID or CPIN ID of a user from their character name*/
	uint8_t getAuth4User(char * userid, uint8_t column, std::vector<uint8_t> &userData);
        /** Enable a Bandmaster Not functional */
	uint8_t enableUser(char * password, char * userid, OPAL_TOKEN status = OPAL_TOKEN::OPAL_TRUE);
         /** Primitive to set the MBRDone flag.
         * @param state 0 or 1  
         * @param Admin1Password Locking SP authority with access to flag
         */
	uint8_t setMBRDone(uint8_t state, char * Admin1Password);
        /** Primitive to set the MBREnable flag.
         * @param state 0 or 1  
         * @param Admin1Password Locking SP authority with access to flag
         */
	uint8_t setMBREnable(uint8_t state, char * Admin1Password);

         /** Set the password of a locking SP user.
         * @param password  current password
         * @param userid the userid whose password is to be changed 
         * @param newpassword  value password is to be changed to
         */
	uint8_t setPassword(char * password, char * userid, char * newpassword);
	/** dummy code not implemented in the enterprise SSC*/
	uint8_t setNewPassword_SUM(char * password, char * userid, char * newpassword);
	uint8_t setLockingRange(uint8_t lockingrange, uint8_t lockingstate,
		char * password);
	/** dummy code not implemented in the enterprise SSC*/
	uint8_t setLockingRange_SUM(uint8_t lockingrange, uint8_t lockingstate,
		char * password);
	/** Setup a locking range.  Initialize a locking range, set it's start
	*  LBA and length, initialize it as unlocked with locking disabled.
	*  @param lockingrange The Locking Range to be setup
	*  @param start  Starting LBA
	*  @param length Number of blocks
	*  @param password Password of administrator
	*/
	uint8_t setupLockingRange(uint8_t lockingrange, uint64_t start,
		uint64_t length, char * password);
	/** dummy code not implemented in the enterprise SSC*/
	uint8_t setupLockingRange_SUM(uint8_t lockingrange, uint64_t start,
		uint64_t length, char * password);
	/** List status of locking ranges.
	*  @param password Password of administrator
	*/
	uint8_t listLockingRanges(char * password, int16_t rangeid);
	/** Change the active state of a locking range
	* @param lockingrange The number of the locking range (0 = global)
	* @param enabled  enable (true) or disable (false) the lockingrange
	* @param password password of administrative authority for locking range
	*/
	uint8_t configureLockingRange(uint8_t lockingrange, uint8_t enabled, char * password);
	/** Generate a new encryption key for a locking range.
	* @param lockingrange locking range number
	* @param password password of the locking administrative authority
	*/
	uint8_t rekeyLockingRange(uint8_t lockingrange, char * password);
	uint8_t setBandsEnabled(int16_t lockingrange, char * password);
        /** Reset the TPER to its factory condition   
         * ERASES ALL DATA!
         * @param password password of authority (SID or PSID)
         * @param PSID true or false is the authority the PSID
         *   */
	uint8_t revertTPer(char * password, uint8_t PSID = 0, uint8_t AdminSP = 0);
	    /** Erase a locking range
	    * @param lockingrange The number of the locking range (0 = global)
	    * @param password Password of administrative authority for locking range
	    */
	uint8_t eraseLockingRange(uint8_t lockingrange, char * password);
       /** Loads a disk image file to the shadow MBR table.
         * @param password the password for the administrative authority with access to the table
         * @param filename the filename of the disk image
         */
	uint8_t loadPBA(char * password, char * filename);
         /** User command to prepare the device for management by sedutil. 
         * Specific to the SSC that the device supports
         * @param password the password that is to be assigned to the SSC master entities 
         */
	uint8_t initialSetup(char * password);
	/** dummy code not implemented in the enterprise SSC*/
	uint8_t setup_SUM(uint8_t lockingrange, uint64_t start, uint64_t length, char *Admin1Password, char * password);
        /** Displays the identify and discovery 0 information */
	void puke();
         /** Dumps an object for diagnostic purposes
         * @param sp index into the OPALUID table for the SP the object is in
         * @param auth the authority ti use for the dump
         * @param pass the password for the suthority
         * @param objID the UID of the object to dump
         *  */
	uint8_t objDump(char *sp, char * auth, char *pass, char * objID);
         /** Issue any command to the drive for diagnostic purposes
         * @param sp index into the OPALUID table for the SP the object is in
         * @param hexauth the authority ti use for the dump
         * @param pass the password for the suthority
         * @param hexinvokingUID caller of the method
         * @param hexmethod the method to call
         * @param hexparms  the parameter list for the command
         * 
         */
	uint8_t rawCmd(char *sp, char *hexauth, char *pass,
		char *hexinvokingUID, char *hexmethod, char *hexparms);

protected:
	uint8_t getDefaultPassword();
private:
    uint8_t getMaxRanges(char * password, uint16_t *maxRanges);
    uint8_t getMaxRangesOpal(char * password, uint16_t *maxRanges);
};