1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/* C:B**************************************************************************
This software is Copyright 2014-2017 Bright Plaza Inc. <drivetrust@drivetrust.com>
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
/*
* Manage tDtaLexicon
*/
#include "DtaLexicon.h"
#include <vector>
class DtaCommand;
class DtaDev;
class DtaResponse;
using namespace std;
/** Encapsulate the session management functionality */
class DtaSession {
public:
/** Constructor
* @param device the device the session is to be conducted with
*/
DtaSession(DtaDev * device);
/** Destructor ends the session if required */
~DtaSession();
/** start an anonymous session
* @param SP the Security Provider to start the session with */
uint8_t start(OPAL_UID SP);
/** Start an authenticated session with any user(1-8) or admint (OPAL only)
* @param SP the securitly provider to start the session with
* @param HostChallenge the password to start the session
* @param SignAuthority the Signing authority (in a simple session this is the user)
* */
#ifdef MULTISTART
uint8_t unistart(OPAL_UID SP, char * HostChallenge, vector<uint8_t> SignAuthority);
#endif
/** Start an authenticated session (OPAL only)
* @param SP the securitly provider to start the session with
* @param HostChallenge the password to start the session
* @param SignAuthority the Signing authority (in a simple session this is the user)
*/
uint8_t start(OPAL_UID SP, char * HostChallenge, OPAL_UID SignAuthority);
/** Start an authenticated session (OPAL only)
* @param SP the securitly provider to start the session with
* @param HostChallenge the password to start the session
* @param SignAuthority the Signing authority (in a simple session this is the user)
* */
uint8_t start(OPAL_UID SP, char * HostChallenge, vector<uint8_t> SignAuthority);
/** Authenticate an already started session
* @param Authority the authority to authenticate
* @param Challenge the password
*/
uint8_t authenticate(vector<uint8_t> Authority, char * Challenge);
/** assign the security protocol to be used in the sessiion
* @param value the security protocol number
*/
void setProtocol(uint8_t value);
/** The password is not to be hashed.
* This is used when the factory default password or the PSID password is
* used to authenticate a session
*/
void dontHashPwd();
/** expect the session to abort.
* this is used when the method called will abort the session (revert)
* to suppress the normal error checking
*/
void expectAbort();
/** return the authorization the session has started under */
uint8_t authuser();
/** send a command to the device in this session
* @param cmd The DtaCommand object
* @param response The MesdResponse object
*/
uint8_t sendCommand(DtaCommand * cmd, DtaResponse & response);
private:
/** Default constructor, private should never be called */
DtaSession();
/** return a string explaining the method status
* @param status the method status code returned
*/
char * methodStatus(uint8_t status);
DtaDev * d; /**< Pointer to device this session is with */
uint32_t bufferpos = 0; /**< psooition in the response buffer the parser is at */
uint32_t TSN = 0; /**< TPer session number */
uint32_t HSN = 0; /**< Host session number */
uint8_t willAbort = 0; /**< Command is expected to abort */
uint8_t hashPwd = 1; /**< hash the password when authenticating */
uint8_t SecurityProtocol = 0x01; /**< The seurity protocol to be used */
uint8_t lastRC; /**< last return code */
uint8_t sessionauth; /** authid for multistart */
};
|
