Skip to content

Commit 0f8c618

Browse files
Merge pull request #80 from thinksilicon/master
Update README.md to match signature validation.
2 parents 4b92069 + 725d038 commit 0f8c618

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ This is hosted by a webserver and contains information about the latest firmware
4444
"version": 2,
4545
"host": "192.168.0.100",
4646
"port": 80,
47-
"bin": "/fota/esp32-fota-http-2.bin",
48-
"check_signature": true
47+
"bin": "/fota/esp32-fota-http-2.bin"
4948
}
5049
```
5150

@@ -55,8 +54,7 @@ Version information can be either a single number or a semantic version string.
5554
{
5655
"type": "esp32-fota-http",
5756
"version": "2.5.1",
58-
"url": "http://192.168.0.100/fota/esp32-fota-http-2.bin",
59-
"check_signature": true
57+
"url": "http://192.168.0.100/fota/esp32-fota-http-2.bin"
6058
}
6159
```
6260

@@ -124,7 +122,7 @@ void loop()
124122
You can now sign your firmware image with an RSA public/private key pair and have the ESP32 check if the signature is correct before
125123
it switches over to the new image.
126124
127-
In order to use this feature, enable `check_signature` in `firmware.json`. Next create a key-pair to sign your firmware image:
125+
In order to use this feature just set the boolean `validate` to `true` in the constructor. Next create a key-pair to sign your firmware image:
128126
```
129127
openssl genrsa -out priv_key.pem 4096
130128
openssl rsa -in priv_key.pem -pubout > rsa_key.pub
@@ -160,4 +158,4 @@ This relies on [semver.c by h2non](https://github.com/h2non/semver.c) for semant
160158
* @nuclearcat
161159
* @thinksilicon
162160
* @nuclearcat
163-
* @hpsaturn
161+
* @hpsaturn

0 commit comments

Comments
 (0)