Giter Club home page Giter Club logo

az-firmware-updater's Introduction

build status

Azure IoT Firmware Updater

Helps simplify the work needed to control the process flow for updating firmware in node.js when using Azure IoT Hub

npm install az-firmware-updater

Getting started

You will need an existing Azure IoT Hub.

To use the firmware updater on your client device (see samples for a complete solution):

const Protocol = require('azure-iot-device-mqtt').Mqtt;
const Client = require('azure-iot-device').Client;
const FirmwareUpdater = require('az-firmware-updater');

const client = Client.fromConnectionString('your-connection-string', Protocol);

client.open(function (err) {
    if (err) {
        console.log(`client error: ${err}`);
    } else {
        console.log('client connected.');

        const options = {
            applyImage: function (imageName) {
                return new Promise(function (fulfill, reject) {

                    // put your custom apply logic here.
                    setTimeout(function () {
                        console.log(`Applied the image: ${imageName}`);
                        fulfill();
                    }, 4000);
                });
            }
        }
        const firmwareUpdater = new FirmwareUpdater(client, options);
        
        client.onDeviceMethod('firmwareUpdate', function (request, response) {
            response.send(200, 'Firmware update started.');

            firmwareUpdater.initiateFirmwareUpdateFlow(request.payload.firmwareUrl, function (err) {
                if (err) {
                    console.log("firmware update failed");
                } else {
                    console.log("Completed firmwareUpdate flow");
                }
            });
        });
    }
});

Options

There are many options you can overload. Docs coming soon.

Getting Public Key for Cert Pinning

echo -n | openssl s_client -connect <your-url>:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > cert.pem
openssl x509 -noout -in cert.pem -fingerprint

az-firmware-updater's People

Contributors

jsturtevant avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

noopkat

az-firmware-updater's Issues

support for non anonymous blob containers

Having non anonymous sources for firmware files would be a common use case.

This could potentially be supported with zero changes to the public API interface.

Some rough pseudo code to give you an idea of a suggested approach:

// from lib/downloader.js

function downloadFirmware(uriToFile, options = {}) {
    const parsedUri = url.parse(uriToFile);

    const accountName = parsedUri.hostname.split('.')[0].replace('-secondary', '');
    // it's too late at night for wrestling with javascript date formatting T^T
    const canonicalizedHeaders = ['x-ms-date:Fri, 11 Oct 2017 21:49:13 GMT', 'x-ms-version:2009-09-19'].join('\n');
    const canonicalizedResource = `/${accountname}${parsedUri.path.replace(/\/$/, '')}`;
    const toSign = `GET\n\n\n\n\n\n\n\n\n\n\n\n${canonicalizedHeaders}\n${canonicalizedResource}`;
    const signed = someFancyHmacSigningFunction(toSign);
    const signature = toBase64(signed);

    var requestInfo = {
        hostname: parsedUri.hostname,
        port: 443,
        path: parsedUri.path,
        method: 'GET',
        headers: {
           Authorization: `SharedKey ${accountName}:${signature}`
        },
        //disable session caching
        agent: new https.Agent({
            maxCachedSessions: 0
        })
    };
...

bitmoji

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.