From 66ebf75abec484a588c1e19e22ebbe3336b2ca7e Mon Sep 17 00:00:00 2001 From: Sandeep Mistry Date: Tue, 5 Nov 2019 17:19:14 -0500 Subject: [PATCH 01/30] Add signing example --- examples/ECCX08Signing/ECCX08Signing.ino | 93 ++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 examples/ECCX08Signing/ECCX08Signing.ino diff --git a/examples/ECCX08Signing/ECCX08Signing.ino b/examples/ECCX08Signing/ECCX08Signing.ino new file mode 100644 index 0000000..c9d9695 --- /dev/null +++ b/examples/ECCX08Signing/ECCX08Signing.ino @@ -0,0 +1,93 @@ +/* + ECCX08 Signing + + This sketch uses the ECC508 or ECC608 to sign some data + using the private key of a key slot, the signature + is printed to the Serial monitor. Then the signature is + verified using the public key of the slot. + + NOTE: the input data must be 64 bytes in length! + + Circuit: + - MKR board with ECC508 or ECC608 on board + + created 5 November 2019 + by Sandeep Mistry +*/ + +#include + +const byte input[64] = { + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, + 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, + 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, + 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f +}; + +const int slot = 0; + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("ECCX08 Signing"); + Serial.println(); + + if (!ECCX08.begin()) { + Serial.println("Failed to communicate with ECC508/ECC608!"); + while (1); + } + + if (!ECCX08.locked()) { + Serial.println("The ECC508/ECC608 is not locked!"); + while (1); + } + + // print the input + Serial.print("Input is: "); + printBufferHex(input, sizeof(input)); + + // retrieve the public key + byte publicKey[64]; + ECCX08.generatePublicKey(slot, publicKey); + + // print the public key + Serial.print("Public key of slot "); + Serial.print(slot); + Serial.print(" is: "); + printBufferHex(publicKey, sizeof(publicKey)); + + // calculate the signature, input MUST be 64-byte array + byte signature[64]; + ECCX08.ecSign(slot, input, signature); + + // print the signature + Serial.print("Signature using slot "); + Serial.print(slot); + Serial.print(" is: "); + printBufferHex(signature, sizeof(signature)); + + Serial.println(); + + // To make the signature verifcation fail, uncomment the next line: + // signature[0] = 0x00; + + // validate the signature + if (ECCX08.ecdsaVerify(input, signature, publicKey)) { + Serial.println("Verified signature successfully :D"); + } else { + Serial.println("oh no! failed to verify signature :("); + } +} + +void loop() { + // do nothing +} + +void printBufferHex(const byte input[], int inputLength) { + for (int i = 0; i < inputLength; i++) { + Serial.print(input[i] >> 4, HEX); + Serial.print(input[i] & 0x0f, HEX); + } + Serial.println(); +} From 9e9cf8f8774282716c150d37e19b55e903664aa7 Mon Sep 17 00:00:00 2001 From: Anthony Elder Date: Wed, 10 Nov 2021 09:24:05 +0000 Subject: [PATCH 02/30] Support custom I2C address --- library.properties | 2 +- src/ECCX08.cpp | 6 ++++++ src/ECCX08.h | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/library.properties b/library.properties index f2bd877..883a6dc 100644 --- a/library.properties +++ b/library.properties @@ -6,5 +6,5 @@ sentence=Arduino Library for the Atmel/Microchip ECC508 and ECC608 crypto chips paragraph= category=Communication url=https://github.com/arduino-libraries/ArduinoECCX08 -architectures=samd,megaavr,mbed,mbed_nano,mbed_portenta +architectures=samd,megaavr,mbed,mbed_nano,mbed_portenta,esp32 includes=ArduinoECCX08.h diff --git a/src/ECCX08.cpp b/src/ECCX08.cpp index 8bb1a9a..6145dd4 100644 --- a/src/ECCX08.cpp +++ b/src/ECCX08.cpp @@ -38,6 +38,12 @@ ECCX08Class::~ECCX08Class() { } +int ECCX08Class::begin(uint8_t i2cAddress) +{ + _address = i2cAddress; + return begin(); +} + int ECCX08Class::begin() { _wire->begin(); diff --git a/src/ECCX08.h b/src/ECCX08.h index 50490a5..0439b17 100644 --- a/src/ECCX08.h +++ b/src/ECCX08.h @@ -30,6 +30,7 @@ class ECCX08Class virtual ~ECCX08Class(); int begin(); + int begin(uint8_t i2cAddress); void end(); int serialNumber(byte sn[]); From e9da0a8a27db022adf23307e95eb62a973f03a99 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 10 Jan 2022 00:49:06 -0800 Subject: [PATCH 03/30] Add GitHub Actions workflow to synchronize with shared repository labels (#40) On every push that changes relevant files, and periodically, configure the repository's issue and pull request labels according to the universal, shared, and local label configuration files. --- .github/workflows/sync-labels.yml | 138 ++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 .github/workflows/sync-labels.yml diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml new file mode 100644 index 0000000..3ee6feb --- /dev/null +++ b/.github/workflows/sync-labels.yml @@ -0,0 +1,138 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md +name: Sync Labels + +# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +on: + push: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + pull_request: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + schedule: + # Run daily at 8 AM UTC to sync with changes to shared label configurations. + - cron: "0 8 * * *" + workflow_dispatch: + repository_dispatch: + +env: + CONFIGURATIONS_FOLDER: .github/label-configuration-files + CONFIGURATIONS_ARTIFACT: label-configuration-files + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Download JSON schema for labels configuration file + id: download-schema + uses: carlosperate/download-file-action@v1 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json + location: ${{ runner.temp }}/label-configuration-schema + + - name: Install JSON schema validator + run: | + sudo npm install \ + --global \ + ajv-cli \ + ajv-formats + + - name: Validate local labels configuration + run: | + # See: https://github.com/ajv-validator/ajv-cli#readme + ajv validate \ + --all-errors \ + -c ajv-formats \ + -s "${{ steps.download-schema.outputs.file-path }}" \ + -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" + + download: + needs: check + runs-on: ubuntu-latest + + strategy: + matrix: + filename: + # Filenames of the shared configurations to apply to the repository in addition to the local configuration. + # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels + - universal.yml + + steps: + - name: Download + uses: carlosperate/download-file-action@v1 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} + + - name: Pass configuration files to next job via workflow artifact + uses: actions/upload-artifact@v2 + with: + path: | + *.yaml + *.yml + if-no-files-found: error + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + sync: + needs: download + runs-on: ubuntu-latest + + steps: + - name: Set environment variables + run: | + # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" + + - name: Determine whether to dry run + id: dry-run + if: > + github.event_name == 'pull_request' || + ( + ( + github.event_name == 'push' || + github.event_name == 'workflow_dispatch' + ) && + github.ref != format('refs/heads/{0}', github.event.repository.default_branch) + ) + run: | + # Use of this flag in the github-label-sync command will cause it to only check the validity of the + # configuration. + echo "::set-output name=flag::--dry-run" + + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Download configuration files artifact + uses: actions/download-artifact@v2 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + path: ${{ env.CONFIGURATIONS_FOLDER }} + + - name: Remove unneeded artifact + uses: geekyeggo/delete-artifact@v1 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + - name: Merge label configuration files + run: | + # Merge all configuration files + shopt -s extglob + cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" + + - name: Install github-label-sync + run: sudo npm install --global github-label-sync + + - name: Sync labels + env: + GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + # See: https://github.com/Financial-Times/github-label-sync + github-label-sync \ + --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ + ${{ steps.dry-run.outputs.flag }} \ + ${{ github.repository }} From e30e8f008d85878cfebb7e81fc7c5cbbbb3be83f Mon Sep 17 00:00:00 2001 From: pennam Date: Tue, 1 Mar 2022 14:48:13 +0100 Subject: [PATCH 04/30] Release v1.3.6 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 883a6dc..8b5bd71 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoECCX08 -version=1.3.5 +version=1.3.6 author=Arduino maintainer=Arduino sentence=Arduino Library for the Atmel/Microchip ECC508 and ECC608 crypto chips From 82ec8c14f7fab2e54150a03531d7439a245ad6e5 Mon Sep 17 00:00:00 2001 From: Raul Leclair Date: Thu, 1 Dec 2022 09:04:40 -0800 Subject: [PATCH 05/30] Adding HMAC and nonce functionality for ATECC608 (#45) Co-authored-by: Dane Walton --- examples/ECCX08HMAC/ECCX08HMAC.ino | 78 +++++++++++++++++++++ src/ECCX08.cpp | 108 +++++++++++++++++++++++++++++ src/ECCX08.h | 7 ++ 3 files changed, 193 insertions(+) create mode 100644 examples/ECCX08HMAC/ECCX08HMAC.ino diff --git a/examples/ECCX08HMAC/ECCX08HMAC.ino b/examples/ECCX08HMAC/ECCX08HMAC.ino new file mode 100644 index 0000000..935334d --- /dev/null +++ b/examples/ECCX08HMAC/ECCX08HMAC.ino @@ -0,0 +1,78 @@ +/* + ECCX08 HMAC functionality example + + This sketch uses the ECC608 to generate an hmac on some data. + Stores key using nonce. + + Tested on the Arduino Nano RP2040. + + created 10 October 2022 + by Raul Leclair +*/ + +#include + +#define TEMPKEY_SLOT 0xFFFF + +byte nonceKey[] = { + 0x10, 0x10, 0x10, 0x10 +}; + +byte data[] = { + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, + 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, +}; + +int dataLength = sizeof(data); + +void setup() { + Serial.begin(115200); + while (!Serial); + + if (!ECCX08.begin()) { + Serial.println("Failed to initialize ECCX08 board."); + while (1); + } + + // Perform nonce + if (!ECCX08.nonce(nonceKey)) + { + Serial.println("Failed to perform nonce."); + while (1); + } + + // Starting HMAC operation on tempkey slot + if (!ECCX08.beginHMAC(TEMPKEY_SLOT)) { + Serial.println("Failed to start HMAC operation."); + while (1); + } + + if (!ECCX08.updateHMAC(data, dataLength)) { + Serial.println("Failed to update HMAC operation."); + while (1); + } + + byte resultHMAC[32]; + if (!ECCX08.endHMAC(resultHMAC)) { + Serial.println("Failed to end HMAC operation"); + while (1); + } + + Serial.println("HMAC Result: "); + for (int i = 0; i < sizeof(resultHMAC); i++) { + char hexChar[2]; + sprintf(hexChar, "%02X", resultHMAC[i]); + Serial.print(hexChar); + Serial.print(" "); + } +} + +void loop() { +} diff --git a/src/ECCX08.cpp b/src/ECCX08.cpp index 6145dd4..a858668 100644 --- a/src/ECCX08.cpp +++ b/src/ECCX08.cpp @@ -440,6 +440,114 @@ int ECCX08Class::lock() return 1; } + +int ECCX08Class::beginHMAC(uint16_t keySlot) +{ + // HMAC implementation is only for ATECC608 + uint8_t status; + long ecc608ver = 0x0600000; + long eccCurrVer = version() & 0x0F00000; + + if (eccCurrVer != ecc608ver) { + return 0; + } + + if (!wakeup()) { + return 0; + } + + if (!sendCommand(0x47, 0x04, keySlot)) { + return 0; + } + + delay(9); + + if (!receiveResponse(&status, sizeof(status))) { + return 0; + } + + delay(1); + idle(); + + if (status != 0) { + return 0; + } + + return 1; +} + +int ECCX08Class::updateHMAC(const byte data[], int length) { + uint8_t status; + + if (!wakeup()) { + return 0; + } + + // Processing message + int currLength = 0; + while (length) { + data += currLength; + + if (length > 64) { + currLength = 64; + } else { + currLength = length; + } + length -= currLength; + + if (!sendCommand(0x47, 0x01, currLength, data, currLength)) { + return 0; + } + + delay(9); + + if (!receiveResponse(&status, sizeof(status))) { + return 0; + } + + delay(1); + } + idle(); + + if (status != 0) { + return 0; + } + + return 1; +} + +int ECCX08Class::endHMAC(byte result[]) +{ + return endHMAC(NULL, 0, result); +} + +int ECCX08Class::endHMAC(const byte data[], int length, byte result[]) +{ + if (!wakeup()) { + return 0; + } + + if (!sendCommand(0x47, 0x02, length, data, length)) { + return 0; + } + + delay(9); + + if (!receiveResponse(result, 32)) { + return 0; + } + + delay(1); + idle(); + + return 1; +} + +int ECCX08Class::nonce(const byte data[]) +{ + return challenge(data); +} + int ECCX08Class::wakeup() { _wire->setClock(_wakeupFrequency); diff --git a/src/ECCX08.h b/src/ECCX08.h index 0439b17..54fdc3a 100644 --- a/src/ECCX08.h +++ b/src/ECCX08.h @@ -59,6 +59,13 @@ class ECCX08Class int readConfiguration(byte data[]); int lock(); + int beginHMAC(uint16_t keySlot); + int updateHMAC(const byte data[], int length); + int endHMAC(byte result[]); + int endHMAC(const byte data[], int length, byte result[]); + + int nonce(const byte data[]); + private: int wakeup(); int sleep(); From 0fd7aa51b0957ed3dbc21d1988df9166670d1379 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Fri, 2 Dec 2022 09:10:45 +0100 Subject: [PATCH 06/30] Release 1.3.7 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 8b5bd71..c4e1244 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoECCX08 -version=1.3.6 +version=1.3.7 author=Arduino maintainer=Arduino sentence=Arduino Library for the Atmel/Microchip ECC508 and ECC608 crypto chips From a11f92a5ac95cf892c9a210bebe7e89adb662678 Mon Sep 17 00:00:00 2001 From: per1234 Date: Fri, 27 Jan 2023 19:27:49 -0800 Subject: [PATCH 07/30] Fix typos in documentation --- examples/ECCX08HMAC/ECCX08HMAC.ino | 2 +- examples/ECCX08RandomNumber/ECCX08RandomNumber.ino | 2 +- examples/ECCX08Signing/ECCX08Signing.ino | 6 +++--- .../Tools/ECCX08SelfSignedCert/ECCX08SelfSignedCert.ino | 2 +- src/ECCX08.cpp | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/examples/ECCX08HMAC/ECCX08HMAC.ino b/examples/ECCX08HMAC/ECCX08HMAC.ino index 935334d..222651b 100644 --- a/examples/ECCX08HMAC/ECCX08HMAC.ino +++ b/examples/ECCX08HMAC/ECCX08HMAC.ino @@ -1,7 +1,7 @@ /* ECCX08 HMAC functionality example - This sketch uses the ECC608 to generate an hmac on some data. + This sketch uses the ECC608 to generate an HMAC on some data. Stores key using nonce. Tested on the Arduino Nano RP2040. diff --git a/examples/ECCX08RandomNumber/ECCX08RandomNumber.ino b/examples/ECCX08RandomNumber/ECCX08RandomNumber.ino index 4744c1e..4a6a3b6 100644 --- a/examples/ECCX08RandomNumber/ECCX08RandomNumber.ino +++ b/examples/ECCX08RandomNumber/ECCX08RandomNumber.ino @@ -2,7 +2,7 @@ ECCX08 Random Number This sketch uses the ECC508 or ECC608 to generate a random number - every second and print it to the Serial monitor + every second and print it to the Serial Monitor Circuit: - MKR board with ECC508 or ECC608 on board diff --git a/examples/ECCX08Signing/ECCX08Signing.ino b/examples/ECCX08Signing/ECCX08Signing.ino index c9d9695..fe92d3e 100644 --- a/examples/ECCX08Signing/ECCX08Signing.ino +++ b/examples/ECCX08Signing/ECCX08Signing.ino @@ -3,7 +3,7 @@ This sketch uses the ECC508 or ECC608 to sign some data using the private key of a key slot, the signature - is printed to the Serial monitor. Then the signature is + is printed to the Serial Monitor. Then the signature is verified using the public key of the slot. NOTE: the input data must be 64 bytes in length! @@ -69,14 +69,14 @@ void setup() { Serial.println(); - // To make the signature verifcation fail, uncomment the next line: + // To make the signature verification fail, uncomment the next line: // signature[0] = 0x00; // validate the signature if (ECCX08.ecdsaVerify(input, signature, publicKey)) { Serial.println("Verified signature successfully :D"); } else { - Serial.println("oh no! failed to verify signature :("); + Serial.println("Oh no! Failed to verify signature :("); } } diff --git a/examples/Tools/ECCX08SelfSignedCert/ECCX08SelfSignedCert.ino b/examples/Tools/ECCX08SelfSignedCert/ECCX08SelfSignedCert.ino index a83562b..a5cade8 100644 --- a/examples/Tools/ECCX08SelfSignedCert/ECCX08SelfSignedCert.ino +++ b/examples/Tools/ECCX08SelfSignedCert/ECCX08SelfSignedCert.ino @@ -4,7 +4,7 @@ This sketch can be used to generate a self signed certificate for a private key generated in an ECC508/ECC608 crypto chip slot. The issue and expired date, and signature are stored in another - slot for reconstrution. + slot for reconstruction. If the ECC508/ECC608 is not configured and locked it prompts the user to configure and lock the chip with a default TLS diff --git a/src/ECCX08.cpp b/src/ECCX08.cpp index a858668..0164343 100644 --- a/src/ECCX08.cpp +++ b/src/ECCX08.cpp @@ -62,7 +62,7 @@ int ECCX08Class::begin() void ECCX08Class::end() { - // First wake up the device otherwise the chip didn't react to a sleep commando + // First wake up the device otherwise the chip didn't react to a sleep command wakeup(); sleep(); #ifdef WIRE_HAS_END @@ -627,7 +627,7 @@ int ECCX08Class::challenge(const byte message[]) return 0; } - // Nounce, pass through + // Nonce, pass through if (!sendCommand(0x16, 0x03, 0x0000, message, 32)) { return 0; } @@ -807,7 +807,7 @@ int ECCX08Class::addressForSlotOffset(int slot, int offset) int ECCX08Class::sendCommand(uint8_t opcode, uint8_t param1, uint16_t param2, const byte data[], size_t dataLength) { - int commandLength = 8 + dataLength; // 1 for type, 1 for length, 1 for opcode, 1 for param1, 2 for param2, 2 for crc + int commandLength = 8 + dataLength; // 1 for type, 1 for length, 1 for opcode, 1 for param1, 2 for param2, 2 for CRC byte command[commandLength]; command[0] = 0x03; From 5c0af6eb4ab0d05c6db6664d291c633a804f7cae Mon Sep 17 00:00:00 2001 From: Mattia Pennasilico Date: Thu, 2 Mar 2023 14:30:55 +0100 Subject: [PATCH 08/30] Add missing mbed_opta and mbed_giga platforms --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index c4e1244..9f3ede4 100644 --- a/library.properties +++ b/library.properties @@ -6,5 +6,5 @@ sentence=Arduino Library for the Atmel/Microchip ECC508 and ECC608 crypto chips paragraph= category=Communication url=https://github.com/arduino-libraries/ArduinoECCX08 -architectures=samd,megaavr,mbed,mbed_nano,mbed_portenta,esp32 +architectures=samd,megaavr,mbed,mbed_nano,mbed_portenta,mbed_opta,mbed_giga,esp32 includes=ArduinoECCX08.h From b7f79d8fdc77bbe4921378eb014a2f4ebb39585e Mon Sep 17 00:00:00 2001 From: Federico Di Gregorio Date: Wed, 28 Jun 2023 14:55:03 +0200 Subject: [PATCH 09/30] fix: input length for ECCX08.ecSign() is 32 bytes When using ECCX08.ecSign() the input buffer should be exactly 32 bytes long. The old example worked only because the signature was generated and then checked on the first 32 bytes of the 64 bytes buffer. --- examples/ECCX08Signing/ECCX08Signing.ino | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/examples/ECCX08Signing/ECCX08Signing.ino b/examples/ECCX08Signing/ECCX08Signing.ino index fe92d3e..4f5ba46 100644 --- a/examples/ECCX08Signing/ECCX08Signing.ino +++ b/examples/ECCX08Signing/ECCX08Signing.ino @@ -6,7 +6,7 @@ is printed to the Serial Monitor. Then the signature is verified using the public key of the slot. - NOTE: the input data must be 64 bytes in length! + NOTE: the input data must be 32 bytes in length! Circuit: - MKR board with ECC508 or ECC608 on board @@ -17,11 +17,9 @@ #include -const byte input[64] = { +const byte input[32] = { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, - 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, - 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, - 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f + 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f }; const int slot = 0; @@ -57,7 +55,7 @@ void setup() { Serial.print(" is: "); printBufferHex(publicKey, sizeof(publicKey)); - // calculate the signature, input MUST be 64-byte array + // calculate the signature, input MUST be 32-byte array byte signature[64]; ECCX08.ecSign(slot, input, signature); From cbcf89417c2fc668e35172abb63a2c3fb2e68f69 Mon Sep 17 00:00:00 2001 From: maihde Date: Sun, 16 Jul 2023 18:54:18 -0400 Subject: [PATCH 10/30] Update ECCX08.h with method description --- src/ECCX08.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ECCX08.h b/src/ECCX08.h index 54fdc3a..ead8468 100644 --- a/src/ECCX08.h +++ b/src/ECCX08.h @@ -66,6 +66,9 @@ class ECCX08Class int nonce(const byte data[]); + long incrementCounter(int keyId); + long readCounter(int keyId); + private: int wakeup(); int sleep(); From 0fe82c9ca32fa51020a1db64abc8f4989970419d Mon Sep 17 00:00:00 2001 From: maihde Date: Sun, 16 Jul 2023 18:57:03 -0400 Subject: [PATCH 11/30] Update ECCX08.cpp with counter functions --- src/ECCX08.cpp | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/src/ECCX08.cpp b/src/ECCX08.cpp index 0164343..3b7383e 100644 --- a/src/ECCX08.cpp +++ b/src/ECCX08.cpp @@ -548,6 +548,54 @@ int ECCX08Class::nonce(const byte data[]) return challenge(data); } +long ECCX08Class::incrementCounter(int keyId) +{ + uint32_t counter; // the counter can go up to 2,097,151 + + if (!wakeup()) { + return -1; + } + + if (!sendCommand(0x24, 1, keyId)) { + return -1; + } + + delay(20); + + if (!receiveResponse(&counter, sizeof(counter))) { + return -1; + } + + delay(1); + idle(); + + return counter; +} + +long ECCX08Class::readCounter(int keyId) +{ + uint32_t counter; // the counter can go up to 2,097,151 + + if (!wakeup()) { + return -1; + } + + if (!sendCommand(0x24, 0, keyId)) { + return -1; + } + + delay(20); + + if (!receiveResponse(&counter, sizeof(counter))) { + return -1; + } + + delay(1); + idle(); + + return counter; +} + int ECCX08Class::wakeup() { _wire->setClock(_wakeupFrequency); @@ -892,4 +940,4 @@ uint16_t ECCX08Class::crc16(const byte data[], size_t length) ECCX08Class ECCX08(CRYPTO_WIRE, 0x60); #else ECCX08Class ECCX08(Wire, 0x60); -#endif \ No newline at end of file +#endif From 086e7b8b775cbefc02eea4bfdbb483b9c00e1b29 Mon Sep 17 00:00:00 2001 From: pennam Date: Tue, 25 Jul 2023 13:06:15 +0200 Subject: [PATCH 12/30] CI: Add new boards to compile examples workflow --- .github/workflows/compile-examples.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 0e142aa..f29bcd3 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -43,6 +43,8 @@ jobs: - fqbn: arduino:samd:mkrnb1500 - fqbn: arduino:samd:mkrvidor4000 - fqbn: arduino:mbed_nano:nanorp2040connect + - fqbn: arduino:mbed_opta:opta + - fqbn: arduino:mbed_giga:giga steps: - name: Checkout From 6ced7ecd17d1afeeb15d9ca849b1aac341c0180f Mon Sep 17 00:00:00 2001 From: pennam Date: Tue, 2 Jan 2024 14:52:47 +0100 Subject: [PATCH 13/30] ECCX08 monotonic counter feature - rename keyId to counterId - add counterId value check - split functions to keep library style --- src/ECCX08.cpp | 50 ++++++++++++++++++++++++++++++++++++++------------ src/ECCX08.h | 6 ++++-- 2 files changed, 42 insertions(+), 14 deletions(-) diff --git a/src/ECCX08.cpp b/src/ECCX08.cpp index 3b7383e..502497b 100644 --- a/src/ECCX08.cpp +++ b/src/ECCX08.cpp @@ -548,51 +548,77 @@ int ECCX08Class::nonce(const byte data[]) return challenge(data); } -long ECCX08Class::incrementCounter(int keyId) +int ECCX08Class::incrementCounter(int counterId, long& counter) { - uint32_t counter; // the counter can go up to 2,097,151 + if (counterId < 0 || counterId > 1) { + return 0; + } if (!wakeup()) { - return -1; + return 0; } - if (!sendCommand(0x24, 1, keyId)) { - return -1; + if (!sendCommand(0x24, 1, counterId)) { + return 0; } delay(20); if (!receiveResponse(&counter, sizeof(counter))) { - return -1; + return 0; } delay(1); idle(); + return 1; +} + +long ECCX08Class::incrementCounter(int counterId) +{ + long counter; // the counter can go up to 2,097,151 + + if(!incrementCounter(counterId, counter)) { + return -1; + } + return counter; } -long ECCX08Class::readCounter(int keyId) +int ECCX08Class::readCounter(int counterId, long& counter) { - uint32_t counter; // the counter can go up to 2,097,151 + if (counterId < 0 || counterId > 1) { + return 0; + } if (!wakeup()) { - return -1; + return 0; } - if (!sendCommand(0x24, 0, keyId)) { - return -1; + if (!sendCommand(0x24, 0, counterId)) { + return 0; } delay(20); if (!receiveResponse(&counter, sizeof(counter))) { - return -1; + return 0; } delay(1); idle(); + return 1; +} + +long ECCX08Class::readCounter(int counterId) +{ + long counter; // the counter can go up to 2,097,151 + + if(!readCounter(counterId, counter)) { + return -1; + } + return counter; } diff --git a/src/ECCX08.h b/src/ECCX08.h index ead8468..c2f21e1 100644 --- a/src/ECCX08.h +++ b/src/ECCX08.h @@ -66,8 +66,10 @@ class ECCX08Class int nonce(const byte data[]); - long incrementCounter(int keyId); - long readCounter(int keyId); + int incrementCounter(int counterId, long& counter); + long incrementCounter(int counterId); + int readCounter(int counterId, long& counter); + long readCounter(int counterId); private: int wakeup(); From e83baebaaec06971801789fc012cca5857b66dda Mon Sep 17 00:00:00 2001 From: pennam Date: Tue, 2 Jan 2024 15:13:05 +0100 Subject: [PATCH 14/30] Add library build configuration file ECCX08UtilsConfig.h file can be used to include/exclude utility library objects from the build process. By default all the utilities are built unless ArduinoIoTCloud.h file is included --- src/utility/ASN1Utils.cpp | 3 +++ src/utility/ECCX08CSR.cpp | 4 ++- src/utility/ECCX08JWS.cpp | 3 +++ src/utility/ECCX08SelfSignedCert.cpp | 3 +++ src/utility/ECCX08UtilsConfig.h | 39 ++++++++++++++++++++++++++++ src/utility/PEMUtils.cpp | 3 +++ 6 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 src/utility/ECCX08UtilsConfig.h diff --git a/src/utility/ASN1Utils.cpp b/src/utility/ASN1Utils.cpp index f722ff1..594f391 100644 --- a/src/utility/ASN1Utils.cpp +++ b/src/utility/ASN1Utils.cpp @@ -410,4 +410,7 @@ int ASN1UtilsClass::appendEcdsaWithSHA256(byte out[]) return 12; } +#include "ECCX08UtilsConfig.h" +#if defined(ECCX08_ENABLE_ASN1) ASN1UtilsClass ASN1Utils; +#endif diff --git a/src/utility/ECCX08CSR.cpp b/src/utility/ECCX08CSR.cpp index df71b57..fde7099 100644 --- a/src/utility/ECCX08CSR.cpp +++ b/src/utility/ECCX08CSR.cpp @@ -173,5 +173,7 @@ void ECCX08CSRClass::setCommonName(const char* commonName) _commonName = commonName; } - +#include "ECCX08UtilsConfig.h" +#if defined(ECCX08_ENABLE_CSR) ECCX08CSRClass ECCX08CSR; +#endif diff --git a/src/utility/ECCX08JWS.cpp b/src/utility/ECCX08JWS.cpp index 8ae5648..fe2dc9d 100644 --- a/src/utility/ECCX08JWS.cpp +++ b/src/utility/ECCX08JWS.cpp @@ -160,4 +160,7 @@ String ECCX08JWSClass::sign(int slot, const String& header, const String& payloa return sign(slot, header.c_str(), payload.c_str()); } +#include "ECCX08UtilsConfig.h" +#if defined(ECCX08_ENABLE_JWS) ECCX08JWSClass ECCX08JWS; +#endif diff --git a/src/utility/ECCX08SelfSignedCert.cpp b/src/utility/ECCX08SelfSignedCert.cpp index 0fadbc2..045160b 100644 --- a/src/utility/ECCX08SelfSignedCert.cpp +++ b/src/utility/ECCX08SelfSignedCert.cpp @@ -406,4 +406,7 @@ void ECCX08SelfSignedCertClass::appendCertInfo(uint8_t publicKey[], uint8_t buff *out++ = 0x00; } +#include "ECCX08UtilsConfig.h" +#if defined(ECCX08_ENABLE_SSC) ECCX08SelfSignedCertClass ECCX08SelfSignedCert; +#endif diff --git a/src/utility/ECCX08UtilsConfig.h b/src/utility/ECCX08UtilsConfig.h new file mode 100644 index 0000000..cafdc76 --- /dev/null +++ b/src/utility/ECCX08UtilsConfig.h @@ -0,0 +1,39 @@ +/* + This file is part of the ArduinoECCX08 library. + Copyright (c) 2023 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _ECCX08_UTILS_CONFIG_H_ +#define _ECCX08_UTILS_CONFIG_H_ + +#if defined __has_include + #if !__has_include ("ArduinoIoTCloud.h") + #define ECCX08_ENABLE_ASN1 1 + #define ECCX08_ENABLE_CSR 1 + #define ECCX08_ENABLE_JWS 1 + #define ECCX08_ENABLE_SSC 1 + #define ECCX08_ENABLE_PEM 1 + #endif +#else + #define ECCX08_ENABLE_ASN1 1 + #define ECCX08_ENABLE_CSR 1 + #define ECCX08_ENABLE_JWS 1 + #define ECCX08_ENABLE_SSC 1 + #define ECCX08_ENABLE_PEM 1 +#endif + +#endif diff --git a/src/utility/PEMUtils.cpp b/src/utility/PEMUtils.cpp index e619e65..d8f9c8c 100644 --- a/src/utility/PEMUtils.cpp +++ b/src/utility/PEMUtils.cpp @@ -68,4 +68,7 @@ String PEMUtilsClass::base64Encode(const byte in[], unsigned int length, const c return out; } +#include "ECCX08UtilsConfig.h" +#if defined(ECCX08_ENABLE_PEM) PEMUtilsClass PEMUtils; +#endif From 6b15f79a758c3c1a53630ccf3a913c277f47a1e6 Mon Sep 17 00:00:00 2001 From: pennam Date: Tue, 2 Jan 2024 15:22:07 +0100 Subject: [PATCH 15/30] ECCX08 monotonic counter example sketch --- examples/ECCX08Counter/ECCX08Counter.ino | 43 ++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 examples/ECCX08Counter/ECCX08Counter.ino diff --git a/examples/ECCX08Counter/ECCX08Counter.ino b/examples/ECCX08Counter/ECCX08Counter.ino new file mode 100644 index 0000000..319543b --- /dev/null +++ b/examples/ECCX08Counter/ECCX08Counter.ino @@ -0,0 +1,43 @@ +/* + ECCX08 Counter + + This sketch uses the ECC508 or ECC608 to increment a monotonic + counter at each startup + + Circuit: + - Any board with ECC508 or ECC608 on board + +*/ + +#include + +const int keyId = 5; +long counter = -1; + +void setup() { + Serial.begin(9600); + while (!Serial); + + if (!ECCX08.begin()) { + Serial.println("Failed to communicate with ECC508/ECC608!"); + while (1); + } + + if (!ECCX08.incrementCounter(keyId, counter)) { + Serial.println("Failed to increment counter"); + while (1); + } +} + +void loop() { + if (!ECCX08.readCounter(keyId, counter)) { + Serial.println("Failed to read counter"); + while (1); + } + + Serial.print("Counter value = "); + Serial.println(counter); + + delay(1000); +} + From 8d705de33a8d38b7a5d18e7369f2424e3ce3d2e4 Mon Sep 17 00:00:00 2001 From: pennam Date: Wed, 10 Jan 2024 21:56:17 +0100 Subject: [PATCH 16/30] Build configuration: use a more flexible and already used pattern --- .../ECCX08UtilsConfig.h => ECCX08Config.h} | 18 ++++-------------- src/utility/ASN1Utils.cpp | 4 ++-- src/utility/ECCX08CSR.cpp | 4 ++-- src/utility/ECCX08JWS.cpp | 4 ++-- src/utility/ECCX08SelfSignedCert.cpp | 4 ++-- src/utility/PEMUtils.cpp | 4 ++-- 6 files changed, 14 insertions(+), 24 deletions(-) rename src/{utility/ECCX08UtilsConfig.h => ECCX08Config.h} (67%) diff --git a/src/utility/ECCX08UtilsConfig.h b/src/ECCX08Config.h similarity index 67% rename from src/utility/ECCX08UtilsConfig.h rename to src/ECCX08Config.h index cafdc76..bec5739 100644 --- a/src/utility/ECCX08UtilsConfig.h +++ b/src/ECCX08Config.h @@ -17,23 +17,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef _ECCX08_UTILS_CONFIG_H_ -#define _ECCX08_UTILS_CONFIG_H_ +#ifndef _ECCX08_CONFIG_H_ +#define _ECCX08_CONFIG_H_ #if defined __has_include - #if !__has_include ("ArduinoIoTCloud.h") - #define ECCX08_ENABLE_ASN1 1 - #define ECCX08_ENABLE_CSR 1 - #define ECCX08_ENABLE_JWS 1 - #define ECCX08_ENABLE_SSC 1 - #define ECCX08_ENABLE_PEM 1 + #if __has_include () + #include #endif -#else - #define ECCX08_ENABLE_ASN1 1 - #define ECCX08_ENABLE_CSR 1 - #define ECCX08_ENABLE_JWS 1 - #define ECCX08_ENABLE_SSC 1 - #define ECCX08_ENABLE_PEM 1 #endif #endif diff --git a/src/utility/ASN1Utils.cpp b/src/utility/ASN1Utils.cpp index 594f391..7f34f76 100644 --- a/src/utility/ASN1Utils.cpp +++ b/src/utility/ASN1Utils.cpp @@ -17,6 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +#include "ECCX08Config.h" #include "ASN1Utils.h" int ASN1UtilsClass::versionLength() @@ -410,7 +411,6 @@ int ASN1UtilsClass::appendEcdsaWithSHA256(byte out[]) return 12; } -#include "ECCX08UtilsConfig.h" -#if defined(ECCX08_ENABLE_ASN1) +#if !defined(ECCX08_DISABLE_ASN1) ASN1UtilsClass ASN1Utils; #endif diff --git a/src/utility/ECCX08CSR.cpp b/src/utility/ECCX08CSR.cpp index fde7099..44fd0f9 100644 --- a/src/utility/ECCX08CSR.cpp +++ b/src/utility/ECCX08CSR.cpp @@ -17,6 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +#include "ECCX08Config.h" #include "ArduinoECCX08.h" #include "ASN1Utils.h" @@ -173,7 +174,6 @@ void ECCX08CSRClass::setCommonName(const char* commonName) _commonName = commonName; } -#include "ECCX08UtilsConfig.h" -#if defined(ECCX08_ENABLE_CSR) +#if !defined(ECCX08_DISABLE_CSR) ECCX08CSRClass ECCX08CSR; #endif diff --git a/src/utility/ECCX08JWS.cpp b/src/utility/ECCX08JWS.cpp index fe2dc9d..687feab 100644 --- a/src/utility/ECCX08JWS.cpp +++ b/src/utility/ECCX08JWS.cpp @@ -17,6 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +#include "ECCX08Config.h" #include "ECCX08.h" #include "ASN1Utils.h" @@ -160,7 +161,6 @@ String ECCX08JWSClass::sign(int slot, const String& header, const String& payloa return sign(slot, header.c_str(), payload.c_str()); } -#include "ECCX08UtilsConfig.h" -#if defined(ECCX08_ENABLE_JWS) +#if !defined(ECCX08_DISABLE_JWS) ECCX08JWSClass ECCX08JWS; #endif diff --git a/src/utility/ECCX08SelfSignedCert.cpp b/src/utility/ECCX08SelfSignedCert.cpp index 045160b..006ec3a 100644 --- a/src/utility/ECCX08SelfSignedCert.cpp +++ b/src/utility/ECCX08SelfSignedCert.cpp @@ -17,6 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +#include "ECCX08Config.h" #include "ArduinoECCX08.h" extern "C" { @@ -406,7 +407,6 @@ void ECCX08SelfSignedCertClass::appendCertInfo(uint8_t publicKey[], uint8_t buff *out++ = 0x00; } -#include "ECCX08UtilsConfig.h" -#if defined(ECCX08_ENABLE_SSC) +#if !defined(ECCX08_DISABLE_SSC) ECCX08SelfSignedCertClass ECCX08SelfSignedCert; #endif diff --git a/src/utility/PEMUtils.cpp b/src/utility/PEMUtils.cpp index d8f9c8c..ba75e88 100644 --- a/src/utility/PEMUtils.cpp +++ b/src/utility/PEMUtils.cpp @@ -17,6 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +#include "ECCX08Config.h" #include "PEMUtils.h" String PEMUtilsClass::base64Encode(const byte in[], unsigned int length, const char* prefix, const char* suffix) @@ -68,7 +69,6 @@ String PEMUtilsClass::base64Encode(const byte in[], unsigned int length, const c return out; } -#include "ECCX08UtilsConfig.h" -#if defined(ECCX08_ENABLE_PEM) +#if !defined(ECCX08_DISABLE_PEM) PEMUtilsClass PEMUtils; #endif From 15597a6b54e17a10f833500300f439dde8d7b9e1 Mon Sep 17 00:00:00 2001 From: Mattia Pennasilico Date: Wed, 31 Jan 2024 09:09:37 +0100 Subject: [PATCH 17/30] Release v1.3.8 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 9f3ede4..cbfd78b 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoECCX08 -version=1.3.7 +version=1.3.8 author=Arduino maintainer=Arduino sentence=Arduino Library for the Atmel/Microchip ECC508 and ECC608 crypto chips From edf43b7e916db0228d8b8ee1130a93b96a395188 Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Fri, 16 Feb 2024 07:14:51 +0100 Subject: [PATCH 18/30] Configure Dependabot to check for outdated actions used in workflows (#56) Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to be outdated, it will submit a pull request to update them. NOTE: Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating to ). When the action author has provided a major version ref, use that instead (e.g., ). Dependabot will automatically close its PR once the workflow has been updated. More information: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot --- .github/dependabot.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..fa738ec --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file +version: 2 + +updates: + # Configure check for outdated GitHub Actions actions in workflows. + # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot + - package-ecosystem: github-actions + directory: / # Check the repository's workflows under /.github/workflows/ + schedule: + interval: daily + labels: + - "topic: infrastructure" From 60d4b823125b3fc722e28198c0d9004d847ab956 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:15:46 +0100 Subject: [PATCH 19/30] Bump actions/download-artifact from 2 to 4 (#57) Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 2 to 4. - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/v2...v4) --- updated-dependencies: - dependency-name: actions/download-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 3ee6feb..fc99b73 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -108,7 +108,7 @@ jobs: uses: actions/checkout@v2 - name: Download configuration files artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v4 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} path: ${{ env.CONFIGURATIONS_FOLDER }} From 519f727daa934300ea1fcdd4fbbb71040f2983f8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:16:04 +0100 Subject: [PATCH 20/30] Bump actions/checkout from 2 to 4 (#58) Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/arduino-lint.yml | 2 +- .github/workflows/compile-examples.yml | 2 +- .github/workflows/spell-check.yml | 2 +- .github/workflows/sync-labels.yml | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/arduino-lint.yml b/.github/workflows/arduino-lint.yml index 4b3b6d5..bebb3cb 100644 --- a/.github/workflows/arduino-lint.yml +++ b/.github/workflows/arduino-lint.yml @@ -17,7 +17,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Arduino Lint uses: arduino/arduino-lint-action@v1 diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index f29bcd3..44df4b4 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -48,7 +48,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Compile examples uses: arduino/compile-sketches@main diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 7ad1475..6e49bc9 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -17,7 +17,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md - name: Spell check diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index fc99b73..94d64aa 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -27,7 +27,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Download JSON schema for labels configuration file id: download-schema @@ -105,7 +105,7 @@ jobs: echo "::set-output name=flag::--dry-run" - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Download configuration files artifact uses: actions/download-artifact@v4 From e79aa4f7ea3695c96999d565c1ec8354006397b6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:16:21 +0100 Subject: [PATCH 21/30] Bump actions/upload-artifact from 2 to 4 (#59) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v2...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/compile-examples.yml | 2 +- .github/workflows/sync-labels.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 44df4b4..0938379 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -66,7 +66,7 @@ jobs: sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} - name: Save memory usage change report as artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: name: ${{ env.SKETCHES_REPORTS_PATH }} path: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 94d64aa..c668874 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -70,7 +70,7 @@ jobs: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} - name: Pass configuration files to next job via workflow artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: path: | *.yaml From ae8d40cba411b8f2962e6f783c258bd3375edb18 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:16:57 +0100 Subject: [PATCH 22/30] Bump geekyeggo/delete-artifact from 1 to 4 (#60) Bumps [geekyeggo/delete-artifact](https://github.com/geekyeggo/delete-artifact) from 1 to 4. - [Release notes](https://github.com/geekyeggo/delete-artifact/releases) - [Changelog](https://github.com/GeekyEggo/delete-artifact/blob/main/CHANGELOG.md) - [Commits](https://github.com/geekyeggo/delete-artifact/compare/v1...v4) --- updated-dependencies: - dependency-name: geekyeggo/delete-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index c668874..d939848 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -114,7 +114,7 @@ jobs: path: ${{ env.CONFIGURATIONS_FOLDER }} - name: Remove unneeded artifact - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v4 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} From a351e075cfd9c400ccceb7235e71261384151ac0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 16 Feb 2024 07:17:12 +0100 Subject: [PATCH 23/30] Bump carlosperate/download-file-action from 1 to 2 (#61) Bumps [carlosperate/download-file-action](https://github.com/carlosperate/download-file-action) from 1 to 2. - [Release notes](https://github.com/carlosperate/download-file-action/releases) - [Commits](https://github.com/carlosperate/download-file-action/compare/v1...v2) --- updated-dependencies: - dependency-name: carlosperate/download-file-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/sync-labels.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index d939848..47ac50a 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -31,7 +31,7 @@ jobs: - name: Download JSON schema for labels configuration file id: download-schema - uses: carlosperate/download-file-action@v1 + uses: carlosperate/download-file-action@v2 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json location: ${{ runner.temp }}/label-configuration-schema @@ -65,7 +65,7 @@ jobs: steps: - name: Download - uses: carlosperate/download-file-action@v1 + uses: carlosperate/download-file-action@v2 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} From 66f991a072b949128678f92b62c9684d2cb2fd67 Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Fri, 16 Feb 2024 08:24:21 +0100 Subject: [PATCH 24/30] Fix regression re report-size-deltas after updating actions/upload-artifact. (#62) For more information see https://github.com/arduino/report-size-deltas/blob/main/docs/FAQ.md#size-deltas-report-workflow-triggered-by-schedule-event . --- .github/workflows/compile-examples.yml | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 0938379..25f7204 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -33,18 +33,31 @@ jobs: matrix: board: - fqbn: arduino:mbed:envie_m7 + artifact-name-suffix: arduino-mbed-envie_m7 - fqbn: arduino:megaavr:uno2018 + artifact-name-suffix: arduino-megaavr-uno2018 - fqbn: arduino:samd:mkr1000 + artifact-name-suffix: arduino-samd-mkr1000 - fqbn: arduino:samd:mkrwifi1010 + artifact-name-suffix: arduino-samd-mkrwifi1010 - fqbn: arduino:samd:nano_33_iot + artifact-name-suffix: arduino-samd-nano_33_iot - fqbn: arduino:samd:mkrwan1300 + artifact-name-suffix: arduino-samd-mkr1300 - fqbn: arduino:samd:mkrwan1310 + artifact-name-suffix: arduino-samd-mkrwan1310 - fqbn: arduino:samd:mkrgsm1400 + artifact-name-suffix: arduino-samd-mkrgsm1400 - fqbn: arduino:samd:mkrnb1500 + artifact-name-suffix: arduino-samd-mkrnb1500 - fqbn: arduino:samd:mkrvidor4000 + artifact-name-suffix: arduino-samd-mkrvidor4000 - fqbn: arduino:mbed_nano:nanorp2040connect + artifact-name-suffix: arduino-mbed_nano-nanorp2040connect - fqbn: arduino:mbed_opta:opta + artifact-name-suffix: arduino-mbed_opta-opta - fqbn: arduino:mbed_giga:giga + artifact-name-suffix: arduino-mbed_giga-giga steps: - name: Checkout @@ -68,5 +81,5 @@ jobs: - name: Save memory usage change report as artifact uses: actions/upload-artifact@v4 with: - name: ${{ env.SKETCHES_REPORTS_PATH }} + name: sketches-report-${{ matrix.board.artifact-name-suffix }} path: ${{ env.SKETCHES_REPORTS_PATH }} From b26acea6777c762cbe224ebf782186ca9a8ad511 Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Wed, 21 Feb 2024 07:06:18 +0100 Subject: [PATCH 25/30] Fix regression: report size delta size on PR. (#63) The necessary steps have in fact been documented here: https://github.com/arduino/report-size-deltas/blob/main/docs/FAQ.md#workflow-triggered-by-pull_request-event but I have overlooked them when I fixed the upload issue. With this PR the size deltas are - once again - reported within the PR. --- .github/workflows/compile-examples.yml | 27 ++++++++++++++++++++---- .github/workflows/report-size-deltas.yml | 21 ------------------ .gitignore | 1 + 3 files changed, 24 insertions(+), 25 deletions(-) delete mode 100644 .github/workflows/report-size-deltas.yml create mode 100644 .gitignore diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 25f7204..ff8d550 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -20,13 +20,14 @@ on: # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch repository_dispatch: +env: + # It's convenient to set variables for values used multiple times in the workflow. + SKETCHES_REPORTS_PATH: sketches-reports + jobs: - build: + compile: runs-on: ubuntu-latest - env: - SKETCHES_REPORTS_PATH: sketches-reports - strategy: fail-fast: false @@ -83,3 +84,21 @@ jobs: with: name: sketches-report-${{ matrix.board.artifact-name-suffix }} path: ${{ env.SKETCHES_REPORTS_PATH }} + + # When using a matrix to compile for multiple boards, it's necessary to use a separate job for the deltas report + report: + needs: compile # Wait for the compile job to finish to get the data for the report + if: github.event_name == 'pull_request' # Only run the job when the workflow is triggered by a pull request + runs-on: ubuntu-latest + + steps: + # This step is needed to get the size data produced by the compile jobs + - name: Download sketches reports artifacts + uses: actions/download-artifact@v4 + with: + # All workflow artifacts will be downloaded to this location. + path: ${{ env.SKETCHES_REPORTS_PATH }} + + - uses: arduino/report-size-deltas@v1 + with: + sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml deleted file mode 100644 index c69650f..0000000 --- a/.github/workflows/report-size-deltas.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Report Size Deltas - -on: - schedule: - - cron: '*/5 * * * *' - # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch - workflow_dispatch: - # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch - repository_dispatch: - -jobs: - report: - runs-on: ubuntu-latest - - steps: - # See: https://github.com/arduino/actions/blob/master/libraries/report-size-deltas/README.md - - name: Comment size deltas reports to PRs - uses: arduino/report-size-deltas@main - with: - # The name of the workflow artifact created by the "Compile Examples" workflow - sketches-reports-source: sketches-reports diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f11b75 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ From cf1f6f41cf22534962c24a126219bfcb493532db Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Wed, 21 Feb 2024 18:44:08 +0100 Subject: [PATCH 26/30] Revert "Fix regression: report size delta size on PR. (#63)" This reverts commit b26acea6777c762cbe224ebf782186ca9a8ad511. --- .github/workflows/compile-examples.yml | 27 ++++-------------------- .github/workflows/report-size-deltas.yml | 21 ++++++++++++++++++ .gitignore | 1 - 3 files changed, 25 insertions(+), 24 deletions(-) create mode 100644 .github/workflows/report-size-deltas.yml delete mode 100644 .gitignore diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index ff8d550..25f7204 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -20,14 +20,13 @@ on: # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch repository_dispatch: -env: - # It's convenient to set variables for values used multiple times in the workflow. - SKETCHES_REPORTS_PATH: sketches-reports - jobs: - compile: + build: runs-on: ubuntu-latest + env: + SKETCHES_REPORTS_PATH: sketches-reports + strategy: fail-fast: false @@ -84,21 +83,3 @@ jobs: with: name: sketches-report-${{ matrix.board.artifact-name-suffix }} path: ${{ env.SKETCHES_REPORTS_PATH }} - - # When using a matrix to compile for multiple boards, it's necessary to use a separate job for the deltas report - report: - needs: compile # Wait for the compile job to finish to get the data for the report - if: github.event_name == 'pull_request' # Only run the job when the workflow is triggered by a pull request - runs-on: ubuntu-latest - - steps: - # This step is needed to get the size data produced by the compile jobs - - name: Download sketches reports artifacts - uses: actions/download-artifact@v4 - with: - # All workflow artifacts will be downloaded to this location. - path: ${{ env.SKETCHES_REPORTS_PATH }} - - - uses: arduino/report-size-deltas@v1 - with: - sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml new file mode 100644 index 0000000..c69650f --- /dev/null +++ b/.github/workflows/report-size-deltas.yml @@ -0,0 +1,21 @@ +name: Report Size Deltas + +on: + schedule: + - cron: '*/5 * * * *' + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch + repository_dispatch: + +jobs: + report: + runs-on: ubuntu-latest + + steps: + # See: https://github.com/arduino/actions/blob/master/libraries/report-size-deltas/README.md + - name: Comment size deltas reports to PRs + uses: arduino/report-size-deltas@main + with: + # The name of the workflow artifact created by the "Compile Examples" workflow + sketches-reports-source: sketches-reports diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9f11b75..0000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.idea/ From 2e0fa4594a129e75032ac09ea12bda016c2b1c7d Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Wed, 21 Feb 2024 18:44:45 +0100 Subject: [PATCH 27/30] Correct workflow artifact name pattern in size deltas report workflow The "sketches-reports-source" input of the "arduino/report-size-deltas" GitHub Actions action defines the regular expression that matches the names of the sketches report workflow artifacts produced by the "Compile Examples" workflow. The key string in the names of these artifacts was set to "sketches-report" when the "Compile Examples" workflow was adjusted for compatibility with the breaking changes introduced by updating to version 4.x of the workflow's "actions/upload-artifact" GitHub Actions action dependency. The pattern set in the size deltas report workflow was "sketches-reports". The "s" at the end of that pattern caused it to no longer match against the key string in the artifact names after that adjustment of the "Compile Examples" workflow, resulting in size deltas reports no longer being generated by the workflow. Although a minimal fix would be to simply remove the "s" from the end of the pattern, the decision was made to use a more strict regular expression. This will make it easier for maintainers and contributors to understand that this value is a regular expression and the exact nature of how that regular expression functions (which is less clear when relying on the "arduino/report-size-deltas" action's partial pattern matching behavior). --- .github/workflows/report-size-deltas.yml | 4 ++-- .gitignore | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml index c69650f..cd4763d 100644 --- a/.github/workflows/report-size-deltas.yml +++ b/.github/workflows/report-size-deltas.yml @@ -17,5 +17,5 @@ jobs: - name: Comment size deltas reports to PRs uses: arduino/report-size-deltas@main with: - # The name of the workflow artifact created by the "Compile Examples" workflow - sketches-reports-source: sketches-reports + # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow + sketches-reports-source: ^sketches-report-.+ \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f11b75 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ From 18b9826a41e4179156308f50bb34d9d1f1f4adad Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 19 Mar 2024 14:47:35 +0100 Subject: [PATCH 28/30] Bump geekyeggo/delete-artifact from 4 to 5 (#65) Bumps [geekyeggo/delete-artifact](https://github.com/geekyeggo/delete-artifact) from 4 to 5. - [Release notes](https://github.com/geekyeggo/delete-artifact/releases) - [Changelog](https://github.com/GeekyEggo/delete-artifact/blob/main/CHANGELOG.md) - [Commits](https://github.com/geekyeggo/delete-artifact/compare/v4...v5) --- updated-dependencies: - dependency-name: geekyeggo/delete-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 47ac50a..53a9f54 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -114,7 +114,7 @@ jobs: path: ${{ env.CONFIGURATIONS_FOLDER }} - name: Remove unneeded artifact - uses: geekyeggo/delete-artifact@v4 + uses: geekyeggo/delete-artifact@v5 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} From 58e4c36cefa62cab6535a2cc03ef71f0e8adc01e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 9 Oct 2024 04:14:31 +0000 Subject: [PATCH 29/30] Bump arduino/arduino-lint-action from 1 to 2 Bumps [arduino/arduino-lint-action](https://github.com/arduino/arduino-lint-action) from 1 to 2. - [Release notes](https://github.com/arduino/arduino-lint-action/releases) - [Commits](https://github.com/arduino/arduino-lint-action/compare/v1...v2) --- updated-dependencies: - dependency-name: arduino/arduino-lint-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/arduino-lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/arduino-lint.yml b/.github/workflows/arduino-lint.yml index bebb3cb..b6114a1 100644 --- a/.github/workflows/arduino-lint.yml +++ b/.github/workflows/arduino-lint.yml @@ -20,7 +20,7 @@ jobs: uses: actions/checkout@v4 - name: Arduino Lint - uses: arduino/arduino-lint-action@v1 + uses: arduino/arduino-lint-action@v2 with: official: true library-manager: update From 81994bc9c2cdd8551532c9a5c27669c72dd88119 Mon Sep 17 00:00:00 2001 From: per1234 Date: Fri, 9 May 2025 02:23:44 -0700 Subject: [PATCH 30/30] Add dedicated license file Standardization in license documentation is important because, in addition to making it easy for humans to find this vital information, it allows machines to automate the process of license type determination, which is useful both for discovering suitable open source projects as well as checking open source license compliance. Previously, the open source license of this project was not documented in a dedicated license file. Due to this, even though the project is licensed under a standardized open source license, the open license type could not be identified with 100% confidence by machines (e.g., the Licensee Gem used by the GitHub website), which meant identification could only be made by a human carefully evaluating the license text. The project's license is hereby documented in a standardized license file. The result is that the project's open source license type can now be automatically identified. This does not result in any change to the project licensing. --- LICENSE.txt | 504 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 504 insertions(+) create mode 100644 LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..8000a6f --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it!