Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[lutron] update instructions for LEAP authentication #16510

Merged
merged 3 commits into from
Apr 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 65 additions & 13 deletions bundles/org.openhab.binding.lutron/doc/leapnotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,86 @@
Unlike LIP, which was designed to use a simple serial or telnet connection and authenticates using a username/password, LEAP uses a SSL connection and authenticates using certificates.
This necessarily makes configuration more complicated.
There are several open source utilities available for generating the certificate files necessary to access your Caseta or RA2 Select hub.
One good choice is the get_lutron_cert.py script included with the popular pylutron library which is available on Github at https://github.com/gurumitts/pylutron-caseta .
On a unix-like system, you can easily retrieve it using curl with a command like:
One good choice is included with the popular pylutron library which is available on Github at https://github.com/gurumitts/pylutron-caseta.
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
On a Unix-like system, you can easily install it via `pip`:

```
curl https://raw.githubusercontent.com/gurumitts/pylutron-caseta/dev/get_lutron_cert.py >get_lutron_cert.py
$ pip install pylutron_caseta[cli]
Defaulting to user installation because normal site-packages is not writeable
Collecting pylutron_caseta[cli]
...
Installing collected packages: pylutron_caseta
Successfully installed pylutron_caseta-0.20.0
```

Remember that the get_lutron_cert.py script must be run using python3, not 2!
Also, the script will prompt you to press the button on your smart hub to authorize key generation, so you should be somewhere near the hub when you run it.
Running it will not affect your existing hub configuration or Lutron app installations.
First, you need to locate your bridge using `leap-scan`:
```
$ leap-scan
Lutron-05701a1c.local. 192.168.1.10 fe80::5a2b:aee:ed11:c6d5
<Ctrl-C>
```

Then, you can pair with the found device using the address found above:

```
$ lap-pair Lutron-05701a1c.local. --cert caseta.crt --key caseta.key --cacert caseta-bridge.crt
Press the small black button on the back of the bridge to complete pairing.
Successfully paired with 1.119
```

Running this will not affect your existing hub configuration or Lutron app installations.
When it has completed, it will have generated three files: caseta.crt, caseta.key, and caseta-bridge.crt.

Once the key and certificate files have been generated, you will need to load them into a java keystore.


You can load a keystore from the key and certificate files on a linux system with the following commands.
You can load a keystore from the key and certificate files on a Linux system with the following commands.
You’ll need access to both the java keytool and openssl.

```
openssl pkcs12 -export -in caseta.crt -inkey caseta.key -out caseta.p12 -name caseta
$ openssl pkcs12 -export -in caseta.crt -inkey caseta.key -out caseta.p12 -name caseta
Enter Export Password:
Verifying - Enter Export Password:
$ keytool -importkeystore -destkeystore lutron.keystore -srckeystore caseta.p12 -srcstoretype PKCS12 -alias caseta
Importing keystore caseta.p12 to lutron.keystore...
Enter destination keystore password:
Re-enter new password:
Enter source keystore password:
$ keytool -importcert -file caseta-bridge.crt -keystore lutron.keystore -alias caseta-bridge
Enter keystore password:
Owner: CN=SmartBridge572B0A11C6D5, O="Lutron Electronics Co., Inc.", L=Coopersburg, ST=Pennsylvania, C=US
Issuer: CN=SmartBridge572B0A11C6D5, O="Lutron Electronics Co., Inc.", L=Coopersburg, ST=Pennsylvania, C=US
Serial number: 1
Valid from: Fri Oct 30 18:00:00 MDT 2015 until: Thu Oct 25 18:00:00 MDT 2035
Certificate fingerprints:
SHA1: 20:BE:07:23:0D:61:E7:EE:C4:17:C5:A2:6D:AB:85:0D:64:CF:2A:51
SHA256: C3:51:D0:C0:8C:15:7D:21:34:6F:B6:91:5E:0F:03:85:AB:06:DB:74:63:2D:7B:22:F2:1C:CB:12:7E:3C:29:E2
Signature algorithm name: SHA256withECDSA
Subject Public Key Algorithm: 256-bit EC (secp256r1) key
Version: 3

Extensions:

#1: ObjectId: 2.5.29.19 Criticality=true
BasicConstraints:[
CA:true
PathLen: no limit
]

keytool -importkeystore -destkeystore lutron.keystore -srckeystore caseta.p12 -srcstoretype PKCS12 -srcstorepass secret -alias caseta
#2: ObjectId: 2.5.29.15 Criticality=true
KeyUsage [
DigitalSignature
Key_Encipherment
Data_Encipherment
Key_Agreement
Key_CertSign
Crl_Sign
]

keytool -importcert -file caseta-bridge.crt -keystore lutron.keystore -alias caseta-bridge
Trust this certificate? [no]: yes
Certificate was added to keystore
```

Respond to the password prompt(s) with a password, and then use that password in the -srcstorepass parameter of the keytool command and in the keystorePassword parameter for leapbridge.
In the example above, the pkcs12 store password was set to “secret”, but hopefully you can think of a better one!
Respond to the password prompt(s) with a password.
The lutron.keystore file that you end up with is the one you’ll need to give the binding access to.
The caseta.p12 file is just an intermediate file that you can delete later.

Expand Down