Skip to content

Commit

Permalink
[lgwebos] Mask access key (openhab#7771)
Browse files Browse the repository at this point in the history 
Fix openhab#7758

* [lgwebos] Mask access key
* Mark the access key as a password in the thing configuration

Signed-off-by: Laurent Garnier <[email protected]>
Signed-off-by: CSchlipp <[email protected]>
  • Loading branch information
@lolodomo @CSchlipp
lolodomo authored and CSchlipp committed Jul 26, 2020
1 parent b24f0d4 commit c56fbdd
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 27 deletions.
2 changes: 1 addition & 1 deletion ...ng.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/LGWebOSHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ public String getKey() {
@Override
public void storeKey(@Nullable String key) {
if (!getKey().equals(key)) {
logger.debug("store new key");
logger.info("Store {} as access Key in the thing configuration", key);
// store it current configuration and avoiding complete re-initialization via handleConfigurationUpdate
getLGWebOSConfig().key = key;

Expand Down
71 changes: 45 additions & 26 deletions ...g.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/handler/LGWebOSTVSocket.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ public void onError(String message) {
};

this.requests.put(id, new ServiceSubscription<>("dummy", payload, x -> x, dummyListener));
sendMessage(packet);
sendMessage(packet, !key.isEmpty());
}

private int nextRequestId() {
Expand Down Expand Up @@ -361,24 +361,45 @@ public void unsubscribe(ServiceSubscription<?> subscription) {
}

private void sendMessage(JsonObject json) {
sendMessage(json, false);
}

private void sendMessage(JsonObject json, boolean checkKey) {
String msg = GSON.toJson(json);
Session s = this.session;
try {
if (s != null) {
logger.trace("Message [out]: {}", msg);
if (logger.isTraceEnabled()) {
logger.trace("Message [out]: {}", checkKey ? GSON.toJson(maskKeyInJson(json)) : msg);
}
s.getRemote().sendString(msg);
} else {
logger.warn("No Connection to TV, skipping [out]: {}", msg);
logger.warn("No Connection to TV, skipping [out]: {}",
checkKey ? GSON.toJson(maskKeyInJson(json)) : msg);
}
} catch (IOException e) {
logger.warn("Unable to send message.", e);
}
}

private JsonObject maskKeyInJson(JsonObject json) {
if (json.has("payload") && json.getAsJsonObject("payload").has("client-key")) {
JsonObject jsonCopy = json.deepCopy();
JsonObject payload = jsonCopy.getAsJsonObject("payload");
payload.remove("client-key");
payload.addProperty("client-key", "***");
return jsonCopy;
}
return json;
}

@OnWebSocketMessage
public void onMessage(String message) {
logger.trace("Message [in]: {}", message);
Response response = GSON.fromJson(message, Response.class);
JsonElement payload = response.getPayload();
JsonObject jsonPayload = payload == null ? null : payload.getAsJsonObject();
String messageToLog = (jsonPayload != null && jsonPayload.has("client-key")) ? "***" : message;
logger.trace("Message [in]: {}", messageToLog);
ServiceCommand<?> request = null;

if (response.getId() != null) {
Expand All @@ -398,33 +419,33 @@ public void onMessage(String message) {
switch (response.getType()) {
case "response":
if (request == null) {
logger.debug("No matching request found for response message: {}", message);
logger.debug("No matching request found for response message: {}", messageToLog);
break;
}
if (response.getPayload() == null) {
logger.debug("No payload in response message: {}", message);
if (payload == null) {
logger.debug("No payload in response message: {}", messageToLog);
break;
}
try {
request.processResponse(response.getPayload().getAsJsonObject());
request.processResponse(jsonPayload);
} catch (RuntimeException ex) {
// An uncaught runtime exception in @OnWebSocketMessage annotated method will cause the web socket
// implementation to call @OnWebSocketError callback in which we would reset the connection.
// Users have the ability to create miss-configurations in which IllegalArgumentException could be
// thrown
logger.warn("Error while processing message: {} - in response to request: {} - Error Message: {}",
message, request, ex.getMessage());
messageToLog, request, ex.getMessage());
}
break;
case "error":
logger.debug("Error: {}", message);
logger.debug("Error: {}", messageToLog);

if (request == null) {
logger.warn("No matching request found for error message: {}", message);
logger.warn("No matching request found for error message: {}", messageToLog);
break;
}
if (response.getPayload() == null) {
logger.warn("No payload in error message: {}", message);
if (payload == null) {
logger.warn("No payload in error message: {}", messageToLog);
break;
}
try {
Expand All @@ -435,39 +456,37 @@ public void onMessage(String message) {
// Users have the ability to create miss-configurations in which IllegalArgumentException could be
// thrown
logger.warn("Error while processing error: {} - in response to request: {} - Error Message: {}",
message, request, ex.getMessage());
messageToLog, request, ex.getMessage());
}
break;
case "hello":
if (state != State.CONNECTING) {
logger.debug("Skipping response {}, not in CONNECTING state, state was {}", message, state);
logger.debug("Skipping response {}, not in CONNECTING state, state was {}", messageToLog, state);
break;
}
if (response.getPayload() == null) {
logger.warn("No payload in error message: {}", message);
if (jsonPayload == null) {
logger.warn("No payload in error message: {}", messageToLog);
break;
}
JsonObject deviceDescription = response.getPayload().getAsJsonObject();
Map<String, String> map = new HashMap<>();
map.put(PROPERTY_DEVICE_OS, deviceDescription.get("deviceOS").getAsString());
map.put(PROPERTY_DEVICE_OS_VERSION, deviceDescription.get("deviceOSVersion").getAsString());
map.put(PROPERTY_DEVICE_OS_RELEASE_VERSION,
deviceDescription.get("deviceOSReleaseVersion").getAsString());
map.put(PROPERTY_DEVICE_OS, jsonPayload.get("deviceOS").getAsString());
map.put(PROPERTY_DEVICE_OS_VERSION, jsonPayload.get("deviceOSVersion").getAsString());
map.put(PROPERTY_DEVICE_OS_RELEASE_VERSION, jsonPayload.get("deviceOSReleaseVersion").getAsString());
map.put(PROPERTY_LAST_CONNECTED, Instant.now().toString());
config.storeProperties(map);
sendRegister();
break;
case "registered":
if (state != State.REGISTERING) {
logger.debug("Skipping response {}, not in REGISTERING state, state was {}", message, state);
logger.debug("Skipping response {}, not in REGISTERING state, state was {}", messageToLog, state);
break;
}
if (response.getPayload() == null) {
logger.warn("No payload in registered message: {}", message);
if (jsonPayload == null) {
logger.warn("No payload in registered message: {}", messageToLog);
break;
}
this.requests.remove(response.getId());
config.storeKey(response.getPayload().getAsJsonObject().get("client-key").getAsString());
config.storeKey(jsonPayload.get("client-key").getAsString());
setState(State.REGISTERED);
break;
}
Expand Down
1 change: 1 addition & 0 deletions bundles/org.openhab.binding.lgwebos/src/main/resources/ESH-INF/config/config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<parameter name="key" type="text" required="false">
<label>Access Key</label>
<description>Key exchanged with TV after pairing.</description>
<context>password</context>
</parameter>
<parameter name="macAddress" type="text" required="false">
<label>MAC Address</label>
Expand Down

0 comments on commit c56fbdd

Please sign in to comment.