[mercedesme] New authorization process (openhab#18342)

* change auth process

Signed-off-by: Bernd Weymann <[email protected]>

Author: weymann

bundles/org.openhab.binding.mercedesme/README.md

@@ -7,12 +7,11 @@ This binding provides access to your Mercedes Benz vehicle like _Mercedes Me_ Sm
 First time users shall follow the following sequence
 
 1. Setup and configure [Bridge](#bridge-configuration)
-2. Follow the [Bridge Authorization](#bridge-authorization) process
-3. [Discovery](#discovery) shall find now vehicles associated to your account
-4. Add your vehicle from discovery and [configure](#thing-configuration) it with correct VIN
-5. Connect your desired items in UI or [text-configuration](#full-example)
-6. Optional: you can [Discover your Vehicle](#discover-your-vehicle) more deeply
-7. In case of problems check [Troubleshooting](#troubleshooting) section
+2. [Discovery](#discovery) shall find now vehicles associated to your account
+3. Add your vehicle from discovery and [configure](#thing-configuration) it with correct VIN
+4. Connect your desired items in UI or [text-configuration](#full-example)
+5. Optional: you can [Discover your Vehicle](#discover-your-vehicle) more deeply
+6. In case of problems check [Troubleshooting](#troubleshooting) section
 
 ## Supported Things
 
@@ -35,14 +34,20 @@ There's no manual discovery!
 
 Bridge needs configuration in order to connect properly to your Mercedes Me account.
 
-| Name            | Type    | Description                             | Default     | Required | Advanced |
-|-----------------|---------|-----------------------------------------|-------------|----------|----------|
-| email           | text    | Mercedes Me registered email Address    | N/A         | yes      | no       |
-| pin             | text    | Mercedes Me Smartphone App PIN          | N/A         | no       | no       |
-| region          | text    | Your region                             | EU          | yes      | no       |
-| refreshInterval | integer | API refresh interval                    | 15          | yes      | no       |
-| callbackIP      | text    | IP Address of openHAB Device            | N/A         | yes      | yes      |
-| callbackPort    | integer | Port Number of openHAB Device           | N/A         | yes      | yes      |
+| Name              | Type    | Description                                 | Default                   | Required |
+|-------------------|---------|---------------------------------------------|---------------------------|----------|
+| email             | text    | Mercedes Me registered email Address        | N/A                       | yes      |
+| refreshToken      | text    | Refresh Token from MB Token Requester app   | takeover previous token   | yes      |
+| pin               | text    | Mercedes Me Smartphone App PIN              | N/A                       | no       |
+| region            | text    | Your region                                 | EU                        | yes      |
+| refreshInterval   | integer | API refresh interval                        | 15                        | yes      |
+
+`refreshToken` is needed to get access to your Mercedes Me account.
+Users already running this binding can stay on default value `takeover previous token`.
+New users need to generate `refreshToken` with [MB Token Requester app]( https://github.com/ReneNulschDE/mbapi2020/wiki/How%E2%80%90to:-create-the-access-and-refresh-token ).
+It simulates the Mercedes Me application *only for authorization process* on your computer, **not your openHAB system!**
+The generated *refresh token* has to be pasted into the bridge configuration.
+The generated *token* can be ignored!
 
 Set `region` to your location
 
@@ -63,46 +68,6 @@ Commands protected by PIN
 - Open / Ventilate Windows
 - Open / Lift Sunroof
 
-IP `callbackIP` and port `callbackPort` will be auto-detected.
-If you're running on server with more than one network interface please select manually.
-
-### Bridge Authorization
-
-Authorization is needed to activate the Bridge which is connected to your Mercedes Me Account.
-The Bridge will indicate in the status headline if authorization is needed including the URL which needs to be opened in your browser.
-
-Three steps are needed
-
-1. Open the mentioned URL like 192.168.x.x:8090/mb-auth
-Opening this URL will request a PIN  which will be send to your configured email.
-Check your Mail Account if you received the PIN.
-Click on _Continue_ to proceed with Step 2.
-
-2. Enter your PIN in the shown field.
-Leave GUID as identifier as it is.
-Click on _Submit_ button.
-
-3. Confirmation shall be shown that authorization was successful.
-
-In case of non successful authorization check your log for errors.
-Below screenshots are illustrating the authorization flow.
-
-### After Bridge Setup
-
-<img src="./doc/OH-Step0.png" width="500" height="240"/>
-
-### Authorization Step 1
-
-<img src="./doc/OH-Step1.png" width="500" height="200"/>
-
-### Authorization Step 2
-
-<img src="./doc/OH-Step2.png" width="500" height="200"/>
-
-### Authorization Step 3
-
-<img src="./doc/OH-Step3.png" width="400" height="130"/>
-
 ## Thing Configuration
 
 | Name            | Type    | Description                                         | Default | Required | Advanced |
@@ -814,7 +779,7 @@ Keep these 3 channels disconnected during normal operation.
 ### Things file
 
 ```java
-Bridge mercedesme:account:4711   "Mercedes Me John Doe" [ email="YOUR_MAIL_ADDRESS", region="EU", pin=9876, refreshInterval=15] {
+Bridge mercedesme:account:4711   "Mercedes Me John Doe" [ email="YOUR_MAIL_ADDRESS", region="EU", pin=9876, refreshToken="abc", refreshInterval=15] {
          Thing bev eqa           "Mercedes EQA"        [ vin="VEHICLE_VIN", batteryCapacity=66.5]
 }
 ```

bundles/org.openhab.binding.mercedesme/doc/OH-Step0.png

@@ -268,7 +268,6 @@ public class Constants {
     public static final String OH_CHANNEL_CONSTANT = "constant";
     public static final String OH_CHANNEL_BONUS_RANGE = "bonus";
 
-    public static final String CALLBACK_ENDPOINT = "/mb-auth";
     // https://developer.mercedes-benz.com/content-page/api_migration_guide
     public static final String IMAGE_BASE_URL = "https://api.mercedes-benz.com/vehicle_images/v2";
     public static final String IMAGE_EXTERIOR_RESOURCE_URL = IMAGE_BASE_URL + "/vehicles/%s";
@@ -278,9 +277,7 @@ public class Constants {
     public static final String STATUS_EMAIL_MISSING = ".status.email-missing";
     public static final String STATUS_REGION_MISSING = ".status.region-missing";
     public static final String STATUS_REFRESH_INVALID = ".status.refresh-invalid";
-    public static final String STATUS_IP_MISSING = ".status.ip-missing";
-    public static final String STATUS_PORT_MISSING = ".status.port-missing";
-    public static final String STATUS_SERVER_RESTART = ".status.server-restart";
+    public static final String STATUS_REFRESH_TOKEN_MISSING = ".status.refresh-token-missing";
     public static final String STATUS_BRIDGE_MISSING = ".status.bridge-missing";
 
     public static final String SPACE = " ";
@@ -346,7 +343,6 @@ public class Constants {
     public static final String MAX_SOC_KEY = "maxsoc";
     public static final String AUTO_UNLOCK_KEY = "autolock";
 
-    public static final String JUNIT_SERVER_ADDR = "http://999.999.999.999:99999/mb-auth";
     public static final String JUNIT_TOKEN = "junitTestToken";
     public static final String JUNIT_REFRESH_TOKEN = "junitRefreshToken";
 }

bundles/org.openhab.binding.mercedesme/doc/OH-Step1.png

@@ -31,7 +31,6 @@
 import org.openhab.core.i18n.UnitProvider;
 import org.openhab.core.io.net.http.HttpClientFactory;
 import org.openhab.core.items.MetadataRegistry;
-import org.openhab.core.net.NetworkAddressService;
 import org.openhab.core.storage.StorageService;
 import org.openhab.core.thing.Bridge;
 import org.openhab.core.thing.Thing;
@@ -65,7 +64,6 @@ public class MercedesMeHandlerFactory extends BaseThingHandlerFactory {
     private final MercedesMeDiscoveryService discoveryService;
     private final MercedesMeCommandOptionProvider mmcop;
     private final MercedesMeStateOptionProvider mmsop;
-    private final NetworkAddressService networkService;
     private @Nullable ServiceRegistration<?> discoveryServiceReg;
     private @Nullable MercedesMeMetadataAdjuster mdAdjuster;
 
@@ -76,10 +74,8 @@ public MercedesMeHandlerFactory(@Reference HttpClientFactory hcf, @Reference Sto
             final @Reference LocaleProvider lp, final @Reference LocationProvider locationP,
             final @Reference TimeZoneProvider tzp, final @Reference MercedesMeCommandOptionProvider cop,
             final @Reference MercedesMeStateOptionProvider sop, final @Reference UnitProvider up,
-            final @Reference MetadataRegistry mdr, final @Reference ItemChannelLinkRegistry iclr,
-            final @Reference NetworkAddressService nas) {
+            final @Reference MetadataRegistry mdr, final @Reference ItemChannelLinkRegistry iclr) {
         this.storageService = storageService;
-        networkService = nas;
         localeProvider = lp;
         locationProvider = locationP;
         mmcop = cop;
@@ -112,8 +108,7 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
                 discoveryServiceReg = bundleContext.registerService(DiscoveryService.class.getName(), discoveryService,
                         null);
             }
-            return new AccountHandler((Bridge) thing, discoveryService, httpClient, localeProvider, storageService,
-                    networkService);
+            return new AccountHandler((Bridge) thing, discoveryService, httpClient, localeProvider, storageService);
         } else if (THING_TYPE_BEV.equals(thingTypeUID) || THING_TYPE_COMB.equals(thingTypeUID)
                 || THING_TYPE_HYBRID.equals(thingTypeUID)) {
             return new VehicleHandler(thing, locationProvider, mmcop, mmsop);

bundles/org.openhab.binding.mercedesme/doc/OH-Step2.png

@@ -26,9 +26,7 @@ public class AccountConfiguration {
 
     public String email = NOT_SET;
     public String region = NOT_SET;
+    public String refreshToken = "takeover previous token";
     public String pin = NOT_SET;
     public int refreshInterval = 15;
-
-    public String callbackIP = NOT_SET;
-    public int callbackPort = -1;
 }

bundles/org.openhab.binding.mercedesme/doc/OH-Step3.png

@@ -33,6 +33,6 @@ public class TokenResponse {
     @SerializedName("token_type")
     public String tokenType = Constants.NOT_SET;
     @SerializedName("expires_in")
-    public int expiresIn;
-    public String createdOn = Instant.now().toString();
+    public int expiresIn = 0;
+    public String createdOn = Instant.MIN.toString();
 }