Skip to content

Commit

Permalink
Add links to the table
Browse files Browse the repository at this point in the history
  • Loading branch information
@sfodagain
sfodagain committed Feb 2, 2024
1 parent 35cf17f commit 05928ed
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions documents/MIGRATION_GUIDE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,17 @@ section of the MQTT5 user guide for detailed information and code snippets on ea
| Connection Type/Feature | V1 SDK - Node.js | V1 SDK - Browser |V2 SDK - Node.js | V2 SDK - Browser |User guide section|
|------------------------------------------------------------------------|---------------------------------------|---------------------------------------|----------------------------------|----------------------------------|------------------|
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | |
| MQTT over Secure WebSocket with Cognito Authentication Method | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | |
| MQTT over Secure WebSocket with Custom Authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | |
| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | |
| MQTT with PKCS12 Method | $${\Large\color{orange}&#10004\*}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | |
| MQTT with Custom Key Operation Method | $${\Large\color{orange}&#10004\*}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | |
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | |
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | |
| HTTP Proxy | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | |
✔* - In order to get this connection type work in V1 SDK, you need to create KeyStore.
✔** - Though V1 does not allow to specify HTTP proxy, it is possible to configure systemwide proxy.
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication-1) |
| MQTT over Secure WebSocket with Cognito Authentication Method | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) |
| MQTT over Secure WebSocket with Custom Authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-custom-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-custom-authentication) |
| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-x509-based-mutual-tls) |
| MQTT with PKCS12 Method | $${\Large\color{orange}&#10004\*}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs12-method) |
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | TODO Node.js section |
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs11-method) |
| HTTP Proxy | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy-1) |
${\Large\color{orange}&#10004\*}$ - In order to get this connection type work in V1 SDK, you need to create KeyStore.
${\Large\color{orange}&#10004\*\*} - Though V1 does not allow to specify HTTP proxy, it is possible to configure systemwide proxy.
_Example of creating connection in V1_
Expand Down

0 comments on commit 05928ed

Please sign in to comment.