From 499e04edb39a3e0d93a3028ced72341adc34f4be Mon Sep 17 00:00:00 2001 From: DokurOmkar Date: Wed, 10 Jul 2024 13:12:48 -0700 Subject: [PATCH] VH 1314 - Allow V2X-Hub Web UI browser access without self signed certificate warning acceptance (#622) # PR Details ## Description In this PR, initialization script is updated to ignore the certificates for localhost on google chrome and chromium browsers to remove the manual step of navigating to websocket URL and accepting self signed certificate. This will allow to access V2X-Hub Web UI without accepting the risk in an other tab. ## Related Issue [VH-1314](https://usdot-carma.atlassian.net/browse/VH-1314) ## Motivation and Context ## How Has This Been Tested? This has been tested locally by running the initialization script and making sure that the web page opens with the login screen. ## Types of changes - [x] Defect fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that cause existing functionality to change) ## Checklist: - [ ] I have added any new packages to the sonar-scanner.properties file - [ ] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [ ] I have read the **CONTRIBUTING** document. [V2XHUB Contributing Guide](https://github.com/usdot-fhwa-OPS/V2X-Hub/blob/develop/Contributing.md) - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. [VH-1314]: https://usdot-carma.atlassian.net/browse/VH-1314?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --- configuration/README.md | 14 ++++++++++++++ configuration/initialization.sh | 3 +-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/configuration/README.md b/configuration/README.md index d1ff943de..244f180b5 100644 --- a/configuration/README.md +++ b/configuration/README.md @@ -59,3 +59,17 @@ To support execution in a simulated environment, V2X-Hub is in the process of in * **V2XHUB_IP** – Environment variable for storing IP address of V2X Hub. * **INFRASTRUCTURE_ID** – Environment variable for storing infrastructure id of V2X Hub. * **SENSOR_JSON_FILE_PATH** – Environment variable for storing path to sensor configuration file. This is an optional simulation environment variable that allows for setting up simulated sensor for a V2X-Hub instance. Example file can be found in the **CDASimAdapterPlugin** tests [here](../src/v2i-hub/CDASimAdapter/test/sensors.json). + +### Access V2X-Hub +To access V2X-Hub UI, either chromium or google-chrome browser can be used by running the following commands: +``` +chromium-browser --ignore-certificate-errors +``` +or + +``` +google-chrome --ignore-certificate-errors + ``` + +> [!NOTE] +> V2X-Hub Server uses a secure WebSocket connection to communicate with the browser. For this, V2X-Hub Server uses a self-signed certificate instead of one signed by a trusted certificate authority (CA). Most of the browsers do not trust this until explicitly told to do so by navigating to the WebSocket URL (https://:19760) and accepting the risk. The `--ignore-certificate-errors` option instructs the browser to ignore certificate errors and warnings which removes manual effort of accepting this risk on V2X-Hub deployments. **Using the browser with this option enabled to access the internet or any other application is not advised as it is a security risk**. \ No newline at end of file diff --git a/configuration/initialization.sh b/configuration/initialization.sh index e6dc5acf0..82b556ebb 100755 --- a/configuration/initialization.sh +++ b/configuration/initialization.sh @@ -148,5 +148,4 @@ fi cd "$mysqlDir" || return # return in case cd fails ./add_v2xhub_user.bash -chromium-browser "http://127.0.0.1" > /dev/null 2>&1 & -chromium-browser "https://127.0.0.1:19760" > /dev/null 2>&1 & +chromium-browser --ignore-certificate-errors localhost > /dev/null 2>&1 &