Skip to content

Commit c202748

Browse files
KhushbuShah25KhushbuShah25
committed
Feature: Support for security 2 provisioning.
- Added security 2 layer in provisioning module. - Enabled security 2 by default while provisioning. - Ensured backward compatibility for earlier security schemes.
1 parent c6fb3a9 commit c202748

25 files changed

+3539
-34
lines changed

‎provisioning/src/main/java/com/espressif/provisioning/ESPConstants.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ public enum TransportType {
2828

2929
public enum SecurityType {
3030
SECURITY_0,
31-
SECURITY_1
31+
SECURITY_1,
32+
SECURITY_2
3233
}
3334

3435
public enum ProvisionFailureReason {

‎provisioning/src/main/java/com/espressif/provisioning/ESPDevice.java

+98-16
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
package com.espressif.provisioning;
1616

17+
import static java.lang.Thread.sleep;
18+
1719
import android.Manifest;
1820
import android.bluetooth.BluetoothDevice;
1921
import android.content.Context;
@@ -41,6 +43,7 @@
4143
import com.espressif.provisioning.security.Security;
4244
import com.espressif.provisioning.security.Security0;
4345
import com.espressif.provisioning.security.Security1;
46+
import com.espressif.provisioning.security.Security2;
4447
import com.espressif.provisioning.transport.BLETransport;
4548
import com.espressif.provisioning.transport.SoftAPTransport;
4649
import com.espressif.provisioning.transport.Transport;
@@ -62,8 +65,6 @@
6265
import espressif.WifiConstants;
6366
import espressif.WifiScan;
6467

65-
import static java.lang.Thread.sleep;
66-
6768
/**
6869
* ESPDevice class to hold device information. This will give facility to connect device, send data to device and
6970
* do provisioning of it.
@@ -82,10 +83,13 @@ public class ESPDevice {
8283
private WiFiScanListener wifiScanListener;
8384
private ProvisionListener provisionListener;
8485
private ResponseListener responseListener;
86+
87+
// Transport & security type must be set before session init.
8588
private ESPConstants.TransportType transportType;
8689
private ESPConstants.SecurityType securityType;
8790

8891
private String proofOfPossession = "";
92+
private String userName = "";
8993
private String versionInfo;
9094
private int totalCount;
9195
private int startIndex;
@@ -343,6 +347,24 @@ public String getProofOfPossession() {
343347
return proofOfPossession;
344348
}
345349

350+
/**
351+
* This method is used to set username. It is used for Sec2 security type.
352+
*
353+
* @param username Username.
354+
*/
355+
public void setUserName(String username) {
356+
this.userName = username;
357+
}
358+
359+
/**
360+
* This method is used to get username. It is used for Sec2 security type.
361+
*
362+
* @return Returns Username.
363+
*/
364+
public String getUserName() {
365+
return userName;
366+
}
367+
346368
/**
347369
* This method is used to get version information to determine what features are enabled in a device and act accordingly.
348370
*
@@ -407,6 +429,16 @@ public ESPConstants.SecurityType getSecurityType() {
407429
return securityType;
408430
}
409431

432+
/**
433+
* This method is used to set / change security type.
434+
* This should be call before session creation.
435+
*
436+
* @return Returns security type.
437+
*/
438+
public void setSecurityType(ESPConstants.SecurityType secType) {
439+
securityType = secType;
440+
}
441+
410442
/**
411443
* This method is used to get Wi-Fi access point.
412444
*
@@ -557,26 +589,76 @@ public void onFailure(Exception e) {
557589

558590
public void initSession(final ResponseListener listener) {
559591

560-
if (securityType.equals(ESPConstants.SecurityType.SECURITY_0)) {
561-
security = new Security0();
562-
} else {
563-
security = new Security1(proofOfPossession);
564-
}
592+
try {
593+
JSONObject jsonObject = new JSONObject(getVersionInfo());
594+
JSONObject provInfo = jsonObject.getJSONObject("prov");
565595

566-
session = new Session(transport, security);
596+
String deviceVersion = provInfo.getString("ver");
597+
Log.d(TAG, "Device Version : " + deviceVersion);
598+
Log.d(TAG, "sec_ver value : " + provInfo.optInt("sec_ver"));
599+
Log.d(TAG, "Has sec_ver key : " + provInfo.has("sec_ver"));
567600

568-
session.init(null, new Session.SessionListener() {
601+
if (provInfo.has("sec_ver")) {
569602

570-
@Override
571-
public void OnSessionEstablished() {
572-
listener.onSuccess(null);
603+
int serVer = provInfo.optInt("sec_ver");
604+
Log.d(TAG, "Security Version : " + serVer);
605+
606+
switch (serVer) {
607+
case 0:
608+
securityType = ESPConstants.SecurityType.SECURITY_0;
609+
break;
610+
case 1:
611+
securityType = ESPConstants.SecurityType.SECURITY_1;
612+
break;
613+
case 2:
614+
default:
615+
securityType = ESPConstants.SecurityType.SECURITY_2;
616+
break;
617+
}
618+
} else {
619+
Log.e(TAG, "Older firmware as Sec version not found.");
620+
if (securityType == ESPConstants.SecurityType.SECURITY_2) {
621+
securityType = ESPConstants.SecurityType.SECURITY_1;
622+
}
573623
}
624+
} catch (JSONException e) {
625+
e.printStackTrace();
626+
Log.d(TAG, "Capabilities JSON not available.");
627+
}
574628

575-
@Override
576-
public void OnSessionEstablishFailed(Exception e) {
577-
listener.onFailure(e);
629+
try {
630+
Log.d(TAG, "Init session with : " + securityType);
631+
632+
switch (securityType) {
633+
case SECURITY_0:
634+
security = new Security0();
635+
break;
636+
case SECURITY_1:
637+
security = new Security1(proofOfPossession);
638+
break;
639+
case SECURITY_2:
640+
security = new Security2(userName, proofOfPossession);
641+
break;
578642
}
579-
});
643+
644+
session = new Session(transport, security);
645+
646+
session.init(null, new Session.SessionListener() {
647+
648+
@Override
649+
public void OnSessionEstablished() {
650+
listener.onSuccess(null);
651+
}
652+
653+
@Override
654+
public void OnSessionEstablishFailed(Exception e) {
655+
listener.onFailure(e);
656+
}
657+
});
658+
} catch (Exception e) {
659+
e.printStackTrace();
660+
listener.onFailure(e);
661+
}
580662
}
581663

582664
private void sendData(final String path, byte[] data, final ResponseListener listener) {

‎provisioning/src/main/java/com/espressif/provisioning/ESPProvisionManager.java

+20-12
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ public void receiveDetections(Detector.Detections<Barcode> detections) {
165165
String deviceName = jsonObject.optString("name");
166166
String pop = jsonObject.optString("pop");
167167
String transport = jsonObject.optString("transport");
168-
int security = jsonObject.optInt("security", 1);
168+
int security = jsonObject.optInt("security", ESPConstants.SecurityType.SECURITY_2.ordinal());
169+
String userName = jsonObject.optString("username");
169170
String password = jsonObject.optString("password");
170171
isScanned = true;
171172

@@ -203,15 +204,12 @@ public void run() {
203204
qrCodeScanListener.onFailure(new RuntimeException("Transport is not available"));
204205
}
205206

206-
if (security == 0) {
207-
securityType = ESPConstants.SecurityType.SECURITY_0;
208-
} else {
209-
securityType = ESPConstants.SecurityType.SECURITY_1;
210-
}
207+
securityType = setSecurityType(security);
211208

212209
espDevice = new ESPDevice(context, transportType, securityType);
213210
espDevice.setDeviceName(deviceName);
214211
espDevice.setProofOfPossession(pop);
212+
espDevice.setUserName(userName);
215213

216214
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q && transportType.equals(ESPConstants.TransportType.TRANSPORT_SOFTAP)) {
217215

@@ -264,7 +262,8 @@ public void onDecoded(@NonNull final Result result) {
264262
String deviceName = jsonObject.optString("name");
265263
String pop = jsonObject.optString("pop");
266264
String transport = jsonObject.optString("transport");
267-
int security = jsonObject.optInt("security", 1);
265+
int security = jsonObject.optInt("security", ESPConstants.SecurityType.SECURITY_2.ordinal());
266+
String userName = jsonObject.optString("username");
268267
String password = jsonObject.optString("password");
269268
isScanned = true;
270269

@@ -305,15 +304,12 @@ public void run() {
305304
return;
306305
}
307306

308-
if (security == 0) {
309-
securityType = ESPConstants.SecurityType.SECURITY_0;
310-
} else {
311-
securityType = ESPConstants.SecurityType.SECURITY_1;
312-
}
307+
securityType = setSecurityType(security);
313308

314309
espDevice = new ESPDevice(context, transportType, securityType);
315310
espDevice.setDeviceName(deviceName);
316311
espDevice.setProofOfPossession(pop);
312+
espDevice.setUserName(userName);
317313

318314
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q && transportType.equals(ESPConstants.TransportType.TRANSPORT_SOFTAP)) {
319315

@@ -421,6 +417,18 @@ private void isDeviceAvailable(final ESPDevice device, String password, QRCodeSc
421417
handler.post(searchDeviceTask);
422418
}
423419

420+
private ESPConstants.SecurityType setSecurityType(int security) {
421+
switch (security) {
422+
case 0:
423+
return ESPConstants.SecurityType.SECURITY_0;
424+
case 1:
425+
return ESPConstants.SecurityType.SECURITY_1;
426+
case 2:
427+
default:
428+
return ESPConstants.SecurityType.SECURITY_2;
429+
}
430+
}
431+
424432
class SearchDeviceTask implements Runnable {
425433

426434
private ESPDevice device;

0 commit comments

Comments
 (0)