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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (c) 2014, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 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.
*
* Neither the name of the Ford Motor Company 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.
*/
#ifndef SRC_COMPONENTS_INCLUDE_SECURITY_MANAGER_SSL_CONTEXT_H_
#define SRC_COMPONENTS_INCLUDE_SECURITY_MANAGER_SSL_CONTEXT_H_
#include <cstddef> // for size_t typedef
#include <string>
#include <ctype.h>
#include <algorithm>
#include "utils/custom_string.h"
// TODO(EZamakhov): update brief info
/**
* \class security_manager::SSLContext
* \brief Class responsible for SSL connection establishing
* and data encryption and decryption within this connection
*
* \fn security_manager::SSLContext::DoHandshakeStep(
* const uint8_t* in_data, size_t in_data_size,
* const uint8_t** out_data, size_t *out_data_size)
* \brief Performs SSL handshake
* In order to establish an SSL connection it's
* necessary to perform handshake process. During this process
* client and server negotiate about encryption algorithms to use
* and produce a session key.
*
* \param in_data [in] data sent by other side
* \param in_data_size [in] size of data in \ref in_data buffer
* \param out_data [out] response of SSL context if there is one. If not,
* equals NULL
* \param out_data_size [out] length of response. On no response, equals 0
*/
namespace security_manager {
namespace custom_str = utils::custom_string;
class SSLContext {
public:
enum HandshakeResult {
Handshake_Result_Success,
Handshake_Result_Fail,
Handshake_Result_AbnormalFail,
Handshake_Result_CertExpired,
Handshake_Result_NotYetValid,
Handshake_Result_CertNotSigned,
Handshake_Result_AppIDMismatch,
Handshake_Result_AppNameMismatch,
};
struct HandshakeContext {
HandshakeContext() : expected_sn(""), expected_cn("") {}
HandshakeContext(const custom_str::CustomString& exp_sn,
const custom_str::CustomString& exp_cn)
: expected_sn(exp_sn), expected_cn(exp_cn), system_time(time(NULL)) {}
custom_str::CustomString expected_sn;
custom_str::CustomString expected_cn;
time_t system_time;
};
virtual HandshakeResult StartHandshake(const uint8_t** const out_data,
size_t* out_data_size) = 0;
virtual HandshakeResult DoHandshakeStep(const uint8_t* const in_data,
size_t in_data_size,
const uint8_t** const out_data,
size_t* out_data_size) = 0;
virtual bool Encrypt(const uint8_t* const in_data,
size_t in_data_size,
const uint8_t** const out_data,
size_t* out_data_size) = 0;
virtual bool Decrypt(const uint8_t* const in_data,
size_t in_data_size,
const uint8_t** const out_data,
size_t* out_data_size) = 0;
virtual bool IsInitCompleted() const = 0;
virtual bool IsHandshakePending() const = 0;
/**
* @brief GetCertificateDueDate gets certificate expiration date
* @param due_date - certificate expiration time to be received
* @return True if certificate expiration date received
* otherwise False
*/
virtual bool GetCertificateDueDate(time_t& due_date) const = 0;
virtual bool HasCertificate() const = 0;
virtual size_t get_max_block_size(size_t mtu) const = 0;
virtual std::string LastError() const = 0;
virtual void ResetConnection() = 0;
virtual void SetHandshakeContext(const HandshakeContext& hsh_ctx) = 0;
virtual ~SSLContext() {}
};
} // namespace security_manager
#endif // SRC_COMPONENTS_INCLUDE_SECURITY_MANAGER_SSL_CONTEXT_H_
|
