1 /*
2 * Copyright (c) 2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "tls_connect_context.h"
17
18 #include <cstdint>
19 #include <string>
20 #include <string_view>
21 #include <vector>
22
23 #include "constant.h"
24 #include "napi_utils.h"
25 #include "netstack_log.h"
26
27 namespace OHOS {
28 namespace NetStack {
29 namespace TlsSocket {
30 namespace {
31 constexpr const char *ALPN_PROTOCOLS = "ALPNProtocols";
32 constexpr const char *SECURE_OPTIONS = "secureOptions";
33 constexpr const char *CA_NAME = "ca";
34 constexpr const char *CERT_NAME = "cert";
35 constexpr const char *KEY_NAME = "key";
36 constexpr const char *PASSWD_NAME = "passwd";
37 constexpr const char *PROTOCOLS_NAME = "protocols";
38 constexpr const char *SIGNATURE_ALGORITHMS = "signatureAlgorithms";
39 constexpr const char *USE_REMOTE_CIPHER_PREFER = "useRemoteCipherPrefer";
40 constexpr const char *CIPHER_SUITE = "cipherSuite";
41 constexpr const char *ADDRESS_NAME = "address";
42 constexpr const char *FAMILY_NAME = "family";
43 constexpr const char *PORT_NAME = "port";
44 constexpr const char *VERIFY_MODE_NAME = "bidirectionAuthentication";
45 constexpr uint32_t CA_CHAIN_LENGTH = 10;
46 constexpr uint32_t PROTOCOLS_SIZE = 10;
47 constexpr std::string_view PARSE_ERROR = "options is not type of TLSConnectOptions";
48
ReadNecessaryOptions(napi_env env,napi_value secureOptions,TLSSecureOptions & secureOption)49 bool ReadNecessaryOptions(napi_env env, napi_value secureOptions, TLSSecureOptions &secureOption)
50 {
51 if (!NapiUtils::HasNamedProperty(env, secureOptions, CA_NAME)) {
52 return false;
53 }
54 napi_value caCert = NapiUtils::GetNamedProperty(env, secureOptions, CA_NAME);
55 std::vector<std::string> caVec;
56 if (NapiUtils::GetValueType(env, caCert) == napi_string) {
57 std::string ca = NapiUtils::GetStringPropertyUtf8(env, secureOptions, CA_NAME);
58 caVec.push_back(ca);
59 }
60 if (NapiUtils::GetValueType(env, caCert) == napi_object) {
61 uint32_t arrayLong = NapiUtils::GetArrayLength(env, caCert);
62 if (arrayLong > CA_CHAIN_LENGTH) {
63 return false;
64 }
65 napi_value element = nullptr;
66 for (uint32_t i = 0; i < arrayLong; i++) {
67 element = NapiUtils::GetArrayElement(env, caCert, i);
68 std::string ca = NapiUtils::GetStringFromValueUtf8(env, element);
69 caVec.push_back(ca);
70 }
71 }
72 secureOption.SetCaChain(caVec);
73
74 if (NapiUtils::HasNamedProperty(env, secureOptions, KEY_NAME)) {
75 secureOption.SetKey(SecureData(NapiUtils::GetStringPropertyUtf8(env, secureOptions, KEY_NAME)));
76 }
77 if (NapiUtils::HasNamedProperty(env, secureOptions, CERT_NAME)) {
78 secureOption.SetCert(NapiUtils::GetStringPropertyUtf8(env, secureOptions, CERT_NAME));
79 }
80 if (NapiUtils::HasNamedProperty(env, secureOptions, VERIFY_MODE_NAME)) {
81 VerifyMode tempVerifyMode = !NapiUtils::GetBooleanProperty(env, secureOptions, VERIFY_MODE_NAME)
82 ? VerifyMode::ONE_WAY_MODE
83 : VerifyMode::TWO_WAY_MODE;
84 secureOption.SetVerifyMode(tempVerifyMode);
85 } else {
86 secureOption.SetVerifyMode(VerifyMode::ONE_WAY_MODE);
87 }
88 return true;
89 }
90 } // namespace
91
TLSConnectContext(napi_env env,EventManager * manager)92 TLSConnectContext::TLSConnectContext(napi_env env, EventManager *manager) : BaseContext(env, manager) {}
93
ParseParams(napi_value * params,size_t paramsCount)94 void TLSConnectContext::ParseParams(napi_value *params, size_t paramsCount)
95 {
96 if (!CheckParamsType(params, paramsCount)) {
97 return;
98 }
99 connectOptions_ = ReadTLSConnectOptions(GetEnv(), params);
100
101 if (paramsCount == PARAM_OPTIONS_AND_CALLBACK) {
102 SetParseOK(SetCallback(params[ARG_INDEX_1]) == napi_ok);
103 return;
104 }
105 SetParseOK(true);
106 }
107
CheckParamsType(napi_value * params,size_t paramsCount)108 bool TLSConnectContext::CheckParamsType(napi_value *params, size_t paramsCount)
109 {
110 if (paramsCount == PARAM_JUST_OPTIONS) {
111 if (NapiUtils::GetValueType(GetEnv(), params[ARG_INDEX_0]) != napi_object) {
112 NETSTACK_LOGE("tlsConnectContext first param is not object");
113 SetNeedThrowException(true);
114 SetError(PARSE_ERROR_CODE, PARSE_ERROR.data());
115 return false;
116 }
117 return true;
118 }
119
120 if (paramsCount == PARAM_OPTIONS_AND_CALLBACK) {
121 if (NapiUtils::GetValueType(GetEnv(), params[ARG_INDEX_0]) != napi_object) {
122 NETSTACK_LOGE("tls ConnectContext first param is not object");
123 SetNeedThrowException(true);
124 SetError(PARSE_ERROR_CODE, PARSE_ERROR.data());
125 return false;
126 }
127 if (NapiUtils::GetValueType(GetEnv(), params[ARG_INDEX_1]) != napi_function) {
128 NETSTACK_LOGE("tls ConnectContext second param is not function");
129 return false;
130 }
131 return true;
132 }
133 return false;
134 }
135
ReadTLSConnectOptions(napi_env env,napi_value * params)136 TLSConnectOptions TLSConnectContext::ReadTLSConnectOptions(napi_env env, napi_value *params)
137 {
138 TLSConnectOptions options;
139 Socket::NetAddress address = ReadNetAddress(GetEnv(), params);
140 TLSSecureOptions secureOption = ReadTLSSecureOptions(GetEnv(), params);
141 options.SetNetAddress(address);
142 options.SetTlsSecureOptions(secureOption);
143 if (NapiUtils::HasNamedProperty(GetEnv(), params[0], ALPN_PROTOCOLS)) {
144 napi_value alpnProtocols = NapiUtils::GetNamedProperty(GetEnv(), params[0], ALPN_PROTOCOLS);
145 uint32_t arrayLength = NapiUtils::GetArrayLength(GetEnv(), alpnProtocols);
146 arrayLength = arrayLength > PROTOCOLS_SIZE ? PROTOCOLS_SIZE : arrayLength;
147 napi_value elementValue = nullptr;
148 std::vector<std::string> alpnProtocolVec;
149 for (uint32_t i = 0; i < arrayLength; i++) {
150 elementValue = NapiUtils::GetArrayElement(GetEnv(), alpnProtocols, i);
151 std::string alpnProtocol = NapiUtils::GetStringFromValueUtf8(GetEnv(), elementValue);
152 alpnProtocolVec.push_back(alpnProtocol);
153 }
154 options.SetAlpnProtocols(alpnProtocolVec);
155 }
156 return options;
157 }
158
ReadTLSSecureOptions(napi_env env,napi_value * params)159 TLSSecureOptions TLSConnectContext::ReadTLSSecureOptions(napi_env env, napi_value *params)
160 {
161 TLSSecureOptions secureOption;
162
163 if (!NapiUtils::HasNamedProperty(GetEnv(), params[ARG_INDEX_0], SECURE_OPTIONS)) {
164 return secureOption;
165 }
166 napi_value secureOptions = NapiUtils::GetNamedProperty(GetEnv(), params[ARG_INDEX_0], SECURE_OPTIONS);
167 if (!ReadNecessaryOptions(env, secureOptions, secureOption)) {
168 return secureOption;
169 }
170
171 if (NapiUtils::HasNamedProperty(GetEnv(), secureOptions, PASSWD_NAME)) {
172 secureOption.SetKeyPass(SecureData(NapiUtils::GetStringPropertyUtf8(env, secureOptions, PASSWD_NAME)));
173 }
174
175 if (NapiUtils::HasNamedProperty(GetEnv(), secureOptions, PROTOCOLS_NAME)) {
176 napi_value protocolVector = NapiUtils::GetNamedProperty(env, secureOptions, PROTOCOLS_NAME);
177 uint32_t num = NapiUtils::GetArrayLength(GetEnv(), protocolVector);
178 num = num > PROTOCOLS_SIZE ? PROTOCOLS_SIZE : num;
179 napi_value element = nullptr;
180 std::vector<std::string> protocolVec;
181 for (uint32_t i = 0; i < num; i++) {
182 element = NapiUtils::GetArrayElement(GetEnv(), protocolVector, i);
183 std::string protocol = NapiUtils::GetStringFromValueUtf8(GetEnv(), element);
184 protocolVec.push_back(protocol);
185 }
186 secureOption.SetProtocolChain(protocolVec);
187 }
188
189 if (NapiUtils::HasNamedProperty(GetEnv(), secureOptions, SIGNATURE_ALGORITHMS)) {
190 std::string signatureAlgorithms = NapiUtils::GetStringPropertyUtf8(env, secureOptions, SIGNATURE_ALGORITHMS);
191 secureOption.SetSignatureAlgorithms(signatureAlgorithms);
192 }
193
194 if (NapiUtils::HasNamedProperty(GetEnv(), secureOptions, USE_REMOTE_CIPHER_PREFER)) {
195 bool useRemoteCipherPrefer = NapiUtils::GetBooleanProperty(env, secureOptions, USE_REMOTE_CIPHER_PREFER);
196 secureOption.SetUseRemoteCipherPrefer(useRemoteCipherPrefer);
197 }
198
199 if (NapiUtils::HasNamedProperty(GetEnv(), secureOptions, CIPHER_SUITE)) {
200 std::string cipherSuite = NapiUtils::GetStringPropertyUtf8(env, secureOptions, CIPHER_SUITE);
201 secureOption.SetCipherSuite(cipherSuite);
202 }
203
204 return secureOption;
205 }
206
ReadNetAddress(napi_env env,napi_value * params)207 Socket::NetAddress TLSConnectContext::ReadNetAddress(napi_env env, napi_value *params)
208 {
209 Socket::NetAddress address;
210 napi_value netAddress = NapiUtils::GetNamedProperty(GetEnv(), params[0], ADDRESS_NAME);
211
212 std::string addr = NapiUtils::GetStringPropertyUtf8(GetEnv(), netAddress, ADDRESS_NAME);
213
214 if (NapiUtils::HasNamedProperty(GetEnv(), params[0], FAMILY_NAME)) {
215 uint32_t family = NapiUtils::GetUint32Property(GetEnv(), params[0], FAMILY_NAME);
216 address.SetFamilyByJsValue(family);
217 }
218 address.SetAddress(addr);
219
220 if (NapiUtils::HasNamedProperty(GetEnv(), netAddress, PORT_NAME)) {
221 uint16_t port = static_cast<uint16_t>(NapiUtils::GetUint32Property(GetEnv(), netAddress, PORT_NAME));
222 address.SetPort(port);
223 }
224 return address;
225 }
226 } // namespace TlsSocket
227 } // namespace NetStack
228 } // namespace OHOS
229