diff options
| author | cajun-rat <phil@advancedtelematic.com> | 2018-05-04 15:03:11 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-04 15:03:11 +0200 |
| commit | 8c71253e0f045fc9664e0a16596ddc100c9492c3 (patch) | |
| tree | 11979071bfd24284c966339164f46c4f116f612a | |
| parent | e246bdc1617acc4667cc0f4dd5baf4ef0d738e45 (diff) | |
| parent | f4e53220276ff9cf3caa7c997e32f6f5a91e3128 (diff) | |
| download | meta-updater-8c71253e0f045fc9664e0a16596ddc100c9492c3.tar.gz | |
Merge pull request #304 from advancedtelematic/feat/PRO-5331/remove-sota-env
Provide example aktualizr configuration recipes and documentation
| -rw-r--r-- | README.adoc | 23 | ||||
| -rw-r--r-- | lib/oeqa/selftest/cases/updater.py | 9 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/aktualizr-auto-prov.bb | 10 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/aktualizr-ca-implicit-prov.bb | 11 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/aktualizr-hsm-prov.bb | 6 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/aktualizr-implicit-prov.bb | 6 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/aktualizr_git.bb | 12 | ||||
| -rw-r--r-- | recipes-sota/aktualizr/environment.inc | 8 | ||||
| -rw-r--r-- | recipes-sota/config/aktualizr-disable-send-ip.bb | 22 | ||||
| -rw-r--r-- | recipes-sota/config/aktualizr-example-interface.bb | 21 | ||||
| -rw-r--r-- | recipes-sota/config/aktualizr-log-debug.bb | 22 | ||||
| -rw-r--r-- | recipes-sota/config/files/LICENSE | 373 |
12 files changed, 488 insertions, 35 deletions
diff --git a/README.adoc b/README.adoc index 749bcf3..c47dd1d 100644 --- a/README.adoc +++ b/README.adoc | |||
| @@ -23,9 +23,9 @@ If you don't already have a Yocto project that you want to add OTA to, you can u | |||
| 23 | 23 | ||
| 24 | If you already have a Yocto-based project and you want to add atomic filesystem updates to it, you just need to do three things: | 24 | If you already have a Yocto-based project and you want to add atomic filesystem updates to it, you just need to do three things: |
| 25 | 25 | ||
| 26 | 1. Clone the `meta-updater` layer and add it to your https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf[bblayers.conf]. | 26 | 1. Clone the `meta-updater` layer and add it to your https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf[bblayers.conf]. |
| 27 | 2. Clone BSP integration layer (`meta-updater-$\{PLATFORM}`, e.g. https://github.com/advancedtelematic/meta-updater-raspberrypi[meta-updater-raspberrypi]) and add it to your `conf/bblayers.conf`. If your board isn't supported yet, you could write a BSP integration for it yourself. See the <<Adding support for your board>> section for the details. | 27 | 2. Clone BSP integration layer (`meta-updater-$\{PLATFORM}`, e.g. https://github.com/advancedtelematic/meta-updater-raspberrypi[meta-updater-raspberrypi]) and add it to your `conf/bblayers.conf`. If your board isn't supported yet, you could write a BSP integration for it yourself. See the <<Adding support for your board>> section for the details. |
| 28 | 3. Set up your https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-DISTRO[distro]. If you are using "poky", the default distro in Yocto, you can change it in your `conf/local.conf` to "poky-sota". Alternatively, if you are using your own or third party distro configuration, you can add `INHERIT += " sota"` to it, thus combining capabilities of your distro with meta-updater features. | 28 | 3. Set up your https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-DISTRO[distro]. If you are using "poky", the default distro in Yocto, you can change it in your `conf/local.conf` to "poky-sota". Alternatively, if you are using your own or third party distro configuration, you can add `INHERIT += " sota"` to it, thus combining capabilities of your distro with meta-updater features. |
| 29 | 29 | ||
| 30 | You can then build your image as usual, with bitbake. After building the root file system, bitbake will then create an https://ostree.readthedocs.io/en/latest/manual/adapting-existing/[OSTree-enabled version] of it, commit it to your local OSTree repo and (optionally) push it to a remote server. Additionally, a live disk image will be created (normally named `$\{IMAGE_NAME}.-sdimg-ota` e.g. `core-image-raspberrypi3.rpi-sdimg-ota`). You can control this behaviour through <<sota-related-variables-in-localconf,variables in your local.conf>>. | 30 | You can then build your image as usual, with bitbake. After building the root file system, bitbake will then create an https://ostree.readthedocs.io/en/latest/manual/adapting-existing/[OSTree-enabled version] of it, commit it to your local OSTree repo and (optionally) push it to a remote server. Additionally, a live disk image will be created (normally named `$\{IMAGE_NAME}.-sdimg-ota` e.g. `core-image-raspberrypi3.rpi-sdimg-ota`). You can control this behaviour through <<sota-related-variables-in-localconf,variables in your local.conf>>. |
| 31 | 31 | ||
| @@ -47,7 +47,7 @@ and get as a result an `ostree_repo` folder in your images directory (`tmp/deplo | |||
| 47 | 47 | ||
| 48 | * your OSTree repository, with the rootfs committed as an OSTree deployment, | 48 | * your OSTree repository, with the rootfs committed as an OSTree deployment, |
| 49 | * an `otaimg` bootstrap image, which is an OSTree physical sysroot as a burnable filesystem image, and optionally | 49 | * an `otaimg` bootstrap image, which is an OSTree physical sysroot as a burnable filesystem image, and optionally |
| 50 | * some machine-dependent live images (e.g. `.rpi-sdimg-ota` for Raspberry Pi or `.porter-sdimg-ota` Renesas Porter board). | 50 | * some machine-dependent live images (e.g. `.wic` for Raspberry Pi or `.porter-sdimg-ota` Renesas Porter board). |
| 51 | 51 | ||
| 52 | Although `aglsetup.sh` hooks provide reasonable defaults for SOTA-related variables, you may want to tune some of them. | 52 | Although `aglsetup.sh` hooks provide reasonable defaults for SOTA-related variables, you may want to tune some of them. |
| 53 | 53 | ||
| @@ -86,9 +86,8 @@ Although we have used U-Boot so far, other boot loaders can be configured work w | |||
| 86 | * `OSTREE_OSNAME` - OS deployment name on your target device. For more information about deployments and osnames see the https://ostree.readthedocs.io/en/latest/manual/deployment/[OSTree documentation]. Defaults to "poky". | 86 | * `OSTREE_OSNAME` - OS deployment name on your target device. For more information about deployments and osnames see the https://ostree.readthedocs.io/en/latest/manual/deployment/[OSTree documentation]. Defaults to "poky". |
| 87 | * `OSTREE_INITRAMFS_IMAGE` - initramfs/initrd image that is used as a proxy while booting into OSTree deployment. Do not change this setting unless you are sure that your initramfs can serve as such a proxy. | 87 | * `OSTREE_INITRAMFS_IMAGE` - initramfs/initrd image that is used as a proxy while booting into OSTree deployment. Do not change this setting unless you are sure that your initramfs can serve as such a proxy. |
| 88 | * `SOTA_PACKED_CREDENTIALS` - when set, your ostree commit will be pushed to a remote repo as a bitbake step. This should be the path to a zipped credentials file in https://github.com/advancedtelematic/aktualizr/blob/master/docs/credentials.adoc[the format accepted by garage-push]. | 88 | * `SOTA_PACKED_CREDENTIALS` - when set, your ostree commit will be pushed to a remote repo as a bitbake step. This should be the path to a zipped credentials file in https://github.com/advancedtelematic/aktualizr/blob/master/docs/credentials.adoc[the format accepted by garage-push]. |
| 89 | * `SOTA_CLIENT_PROV` - which provisioning method to use. Valid options are https://github.com/advancedtelematic/aktualizr/blob/master/docs/automatic-provisioning.adoc[`aktualizr-auto-prov`], https://github.com/advancedtelematic/aktualizr/blob/master/docs/implicit-provisioning.adoc[`aktualizr-implicit-prov`], and `aktualizr-hsm-prov`. The default is `aktualizr-auto-prov`. This can also be set to an empty string to avoid using a provisioning recipe. | 89 | * `SOTA_CLIENT_PROV` - which provisioning method to use. Valid options are https://github.com/advancedtelematic/aktualizr/blob/master/docs/automatic-provisioning.adoc[`aktualizr-auto-prov`], https://github.com/advancedtelematic/aktualizr/blob/master/docs/implicit-provisioning.adoc[`aktualizr-implicit-prov`], and https://github.com/advancedtelematic/aktualizr/blob/master/docs/hsm-provisioning.adoc[`aktualizr-hsm-prov`]. The default is `aktualizr-auto-prov`. This can also be set to an empty string to avoid using a provisioning recipe. |
| 90 | * `SOTA_CLIENT_FEATURES` - extensions to aktualizr. The only valid option is `hsm` (to build with HSM support) | 90 | * `SOTA_CLIENT_FEATURES` - extensions to aktualizr. The only valid option is `hsm` (to build with HSM support) |
| 91 | * `SOTA_LEGACY_SECONDARY_INTERFACE` - path to a https://github.com/advancedtelematic/aktualizr/blob/master/docs/legacysecondary.adoc[legacy secondary interface] installed on the device. To use the example interface from the Aktualizr repo, use `/usr/bin/example-interface` and make sure `IMAGE_INSTALL_append` includes `aktualizr-examples`. | ||
| 92 | * `SOTA_SECONDARY_ECUS` - a list of paths separated by spaces of JSON configuration files for virtual secondaries on the host. These will be installed into `/var/sota/ecus` on the device. | 91 | * `SOTA_SECONDARY_ECUS` - a list of paths separated by spaces of JSON configuration files for virtual secondaries on the host. These will be installed into `/var/sota/ecus` on the device. |
| 93 | * `SOTA_VIRTUAL_SECONDARIES` - a list of paths separated by spaces of JSON configuration files for virtual secondaries installed on the device. If `SOTA_SECONDARY_ECUS` is used to install them, then you can expect them to be installed in `/var/sota/ecus`. | 92 | * `SOTA_VIRTUAL_SECONDARIES` - a list of paths separated by spaces of JSON configuration files for virtual secondaries installed on the device. If `SOTA_SECONDARY_ECUS` is used to install them, then you can expect them to be installed in `/var/sota/ecus`. |
| 94 | 93 | ||
| @@ -142,6 +141,20 @@ garage-push --repo=/path/to/ostree-repo --ref=mybranch --credentials=/path/to/cr | |||
| 142 | 141 | ||
| 143 | You can set `SOTA_PACKED_CREDENTIALS` in your `local.conf` to automatically synchronize your build results with a remote server. Credentials are stored in an archive as described in the https://github.com/advancedtelematic/aktualizr/blob/master/docs/credentials.adoc[aktualizr documentation]. | 142 | You can set `SOTA_PACKED_CREDENTIALS` in your `local.conf` to automatically synchronize your build results with a remote server. Credentials are stored in an archive as described in the https://github.com/advancedtelematic/aktualizr/blob/master/docs/credentials.adoc[aktualizr documentation]. |
| 144 | 143 | ||
| 144 | === aktualizr configuration | ||
| 145 | |||
| 146 | https://github.com/advancedtelematic/aktualizr[Aktualizr] supports a variety of https://github.com/advancedtelematic/aktualizr/blob/master/docs/configuration.adoc[configuration options via a configuration file and the command line]. There are two primary ways to control aktualizr's configuration from meta-updater. | ||
| 147 | |||
| 148 | First, you can set `SOTA_CLIENT_PROV` to control which provisioning recipe is used. Each recipe installs an appropriate `sota.toml` file from aktualizr according to the provisioning needs. See the <<sota-related-variables-in-localconf,SOTA-related variables in local.conf>> section for more information. | ||
| 149 | |||
| 150 | Second, you can write recipes to install additional config files with customized options. A few recipes already exist to address common needs and provide an example: | ||
| 151 | |||
| 152 | * link:recipes-sota/config/aktualizr-example-interface.bb[aktualizr-example-interface.bb] will configure aktualizr to connect to an example interface for a legacy flasher. This is intended to be used in conjunction with the `aktualizr-examples` package. See https://github.com/advancedtelematic/aktualizr/blob/master/docs/legacysecondary.adoc[legacysecondary.adoc] in the aktualizr repo for more information. | ||
| 153 | * link:recipes-sota/config/aktualizr-disable-send-ip.bb[aktualizr-disable-send-ip.bb] disables the reporting of networking information to the server. This is enabled by default and supported by https://app.atsgarage.com[ATS Garage]. However, if you are using a different server that does not support this feature, you may want to disable it in aktualizr. | ||
| 154 | * link:recipes-sota/config/aktualizr-log-debug.bb[aktualizr-log-debug.bb] sets the log level of aktualizr to 0 (trace). The default is 2 (info). This recipe is intended for development and debugging purposes. | ||
| 155 | |||
| 156 | To use these recipes, you will need to add them to your image with a line such as `IMAGE_INSTALL_append = " aktualizr-log-debug "` in your `local.conf`. | ||
| 157 | |||
| 145 | == Development configuration | 158 | == Development configuration |
| 146 | 159 | ||
| 147 | There are a few settings that can be controlled in `local.conf` to simplify the development process: | 160 | There are a few settings that can be controlled in `local.conf` to simplify the development process: |
diff --git a/lib/oeqa/selftest/cases/updater.py b/lib/oeqa/selftest/cases/updater.py index 2ef5a3b..6dcc8df 100644 --- a/lib/oeqa/selftest/cases/updater.py +++ b/lib/oeqa/selftest/cases/updater.py | |||
| @@ -150,6 +150,8 @@ class AutoProvTests(OESelftestTestCase): | |||
| 150 | self.meta_qemu = None | 150 | self.meta_qemu = None |
| 151 | self.append_config('MACHINE = "qemux86-64"') | 151 | self.append_config('MACHINE = "qemux86-64"') |
| 152 | self.append_config('SOTA_CLIENT_PROV = " aktualizr-auto-prov "') | 152 | self.append_config('SOTA_CLIENT_PROV = " aktualizr-auto-prov "') |
| 153 | # Test aktualizr-example-interface package. | ||
| 154 | self.append_config('IMAGE_INSTALL_append = " aktualizr-examples aktualizr-example-interface "') | ||
| 153 | self.qemu, self.s = qemu_launch(machine='qemux86-64') | 155 | self.qemu, self.s = qemu_launch(machine='qemux86-64') |
| 154 | 156 | ||
| 155 | def tearDownLocal(self): | 157 | def tearDownLocal(self): |
| @@ -183,6 +185,12 @@ class AutoProvTests(OESelftestTestCase): | |||
| 183 | self.assertTrue(ran_ok, 'aktualizr-info failed: ' + stderr.decode() + stdout.decode()) | 185 | self.assertTrue(ran_ok, 'aktualizr-info failed: ' + stderr.decode() + stdout.decode()) |
| 184 | 186 | ||
| 185 | verifyProvisioned(self, machine) | 187 | verifyProvisioned(self, machine) |
| 188 | # Test aktualizr-example-interface package. | ||
| 189 | stdout, stderr, retcode = self.qemu_command('aktualizr-info') | ||
| 190 | self.assertIn(b'hardware ID: example1', stdout, | ||
| 191 | 'Legacy secondary initialization failed: ' + stderr.decode() + stdout.decode()) | ||
| 192 | self.assertIn(b'hardware ID: example2', stdout, | ||
| 193 | 'Legacy secondary initialization failed: ' + stderr.decode() + stdout.decode()) | ||
| 186 | 194 | ||
| 187 | 195 | ||
| 188 | class RpiTests(OESelftestTestCase): | 196 | class RpiTests(OESelftestTestCase): |
| @@ -591,6 +599,7 @@ class PrimaryTests(OESelftestTestCase): | |||
| 591 | self.assertEqual(retcode, 0, "Unable to run aktualizr --help") | 599 | self.assertEqual(retcode, 0, "Unable to run aktualizr --help") |
| 592 | self.assertEqual(stderr, b'', 'Error: ' + stderr.decode()) | 600 | self.assertEqual(stderr, b'', 'Error: ' + stderr.decode()) |
| 593 | 601 | ||
| 602 | |||
| 594 | def qemu_launch(efi=False, machine=None, imagename=None): | 603 | def qemu_launch(efi=False, machine=None, imagename=None): |
| 595 | logger = logging.getLogger("selftest") | 604 | logger = logging.getLogger("selftest") |
| 596 | logger.info('Running bitbake to build core-image-minimal') | 605 | logger.info('Running bitbake to build core-image-minimal') |
diff --git a/recipes-sota/aktualizr/aktualizr-auto-prov.bb b/recipes-sota/aktualizr/aktualizr-auto-prov.bb index 07e5bb8..1a42184 100644 --- a/recipes-sota/aktualizr/aktualizr-auto-prov.bb +++ b/recipes-sota/aktualizr/aktualizr-auto-prov.bb | |||
| @@ -16,8 +16,6 @@ SRC_URI = " \ | |||
| 16 | require environment.inc | 16 | require environment.inc |
| 17 | require credentials.inc | 17 | require credentials.inc |
| 18 | 18 | ||
| 19 | export SOTA_PACKED_CREDENTIALS | ||
| 20 | |||
| 21 | do_install() { | 19 | do_install() { |
| 22 | if [ -n "${SOTA_AUTOPROVISION_CREDENTIALS}" ]; then | 20 | if [ -n "${SOTA_AUTOPROVISION_CREDENTIALS}" ]; then |
| 23 | bbwarn "SOTA_AUTOPROVISION_CREDENTIALS are ignored. Please use SOTA_PACKED_CREDENTIALS" | 21 | bbwarn "SOTA_AUTOPROVISION_CREDENTIALS are ignored. Please use SOTA_PACKED_CREDENTIALS" |
| @@ -32,12 +30,12 @@ do_install() { | |||
| 32 | bbwarn "OSTREE_PUSH_CREDENTIALS is ignored. Please use SOTA_PACKED_CREDENTIALS" | 30 | bbwarn "OSTREE_PUSH_CREDENTIALS is ignored. Please use SOTA_PACKED_CREDENTIALS" |
| 33 | fi | 31 | fi |
| 34 | 32 | ||
| 35 | install -d ${D}${libdir}/sota | 33 | install -m 0700 -d ${D}${libdir}/sota/conf.d |
| 36 | install -d ${D}${localstatedir}/sota | 34 | install -m 0700 -d ${D}${localstatedir}/sota |
| 37 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then | 35 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then |
| 38 | aktualizr_toml=${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'secondary-network', 'sota_autoprov_primary.toml', 'sota_autoprov.toml', d)} | 36 | aktualizr_toml=${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'secondary-network', 'sota_autoprov_primary.toml', 'sota_autoprov.toml', d)} |
| 39 | 37 | ||
| 40 | install -m 0644 ${STAGING_DIR_NATIVE}${libdir}/sota/${aktualizr_toml} ${D}${libdir}/sota/sota.toml | 38 | install -m 0644 ${STAGING_DIR_NATIVE}${libdir}/sota/${aktualizr_toml} ${D}${libdir}/sota/conf.d/20-sota.toml |
| 41 | 39 | ||
| 42 | # deploy SOTA credentials | 40 | # deploy SOTA credentials |
| 43 | if [ -e ${SOTA_PACKED_CREDENTIALS} ]; then | 41 | if [ -e ${SOTA_PACKED_CREDENTIALS} ]; then |
| @@ -49,7 +47,7 @@ do_install() { | |||
| 49 | } | 47 | } |
| 50 | 48 | ||
| 51 | FILES_${PN} = " \ | 49 | FILES_${PN} = " \ |
| 52 | ${libdir}/sota/sota.toml \ | 50 | ${libdir}/sota/conf.d/20-sota.toml \ |
| 53 | ${localstatedir}/sota \ | 51 | ${localstatedir}/sota \ |
| 54 | ${localstatedir}/sota/sota_provisioning_credentials.zip \ | 52 | ${localstatedir}/sota/sota_provisioning_credentials.zip \ |
| 55 | " | 53 | " |
diff --git a/recipes-sota/aktualizr/aktualizr-ca-implicit-prov.bb b/recipes-sota/aktualizr/aktualizr-ca-implicit-prov.bb index 51e313d..a118dfd 100644 --- a/recipes-sota/aktualizr/aktualizr-ca-implicit-prov.bb +++ b/recipes-sota/aktualizr/aktualizr-ca-implicit-prov.bb | |||
| @@ -26,7 +26,7 @@ export SOTA_CACERT_PATH | |||
| 26 | export SOTA_CAKEY_PATH | 26 | export SOTA_CAKEY_PATH |
| 27 | 27 | ||
| 28 | do_install() { | 28 | do_install() { |
| 29 | install -d ${D}${libdir}/sota | 29 | install -m 0700 -d ${D}${libdir}/sota/conf.d |
| 30 | 30 | ||
| 31 | if [ -z "${SOTA_PACKED_CREDENTIALS}" ]; then | 31 | if [ -z "${SOTA_PACKED_CREDENTIALS}" ]; then |
| 32 | bberror "SOTA_PACKED_CREDENTIALS are required for implicit provisioning" | 32 | bberror "SOTA_PACKED_CREDENTIALS are required for implicit provisioning" |
| @@ -51,21 +51,20 @@ do_install() { | |||
| 51 | bberror "SOTA_CAKEY_PATH should be set when using implicit provisioning" | 51 | bberror "SOTA_CAKEY_PATH should be set when using implicit provisioning" |
| 52 | fi | 52 | fi |
| 53 | 53 | ||
| 54 | install -d ${D}${libdir}/sota | 54 | install -m 0700 -d ${D}${localstatedir}/sota |
| 55 | install -d ${D}${localstatedir}/sota | 55 | install -m 0644 ${STAGING_DIR_NATIVE}${libdir}/sota/sota_implicit_prov_ca.toml ${D}${libdir}/sota/conf.d/20-sota.toml |
| 56 | install -m 0644 ${STAGING_DIR_NATIVE}${libdir}/sota/sota_implicit_prov_ca.toml ${D}${libdir}/sota/sota.toml | ||
| 57 | aktualizr_cert_provider --credentials ${SOTA_PACKED_CREDENTIALS} \ | 56 | aktualizr_cert_provider --credentials ${SOTA_PACKED_CREDENTIALS} \ |
| 58 | --device-ca ${SOTA_CACERT_PATH} \ | 57 | --device-ca ${SOTA_CACERT_PATH} \ |
| 59 | --device-ca-key ${SOTA_CAKEY_PATH} \ | 58 | --device-ca-key ${SOTA_CAKEY_PATH} \ |
| 60 | --root-ca \ | 59 | --root-ca \ |
| 61 | --server-url \ | 60 | --server-url \ |
| 62 | --local ${D}${localstatedir}/sota \ | 61 | --local ${D}${localstatedir}/sota \ |
| 63 | --config ${D}${libdir}/sota/sota.toml | 62 | --config ${D}${libdir}/sota/conf.d/20-sota.toml |
| 64 | } | 63 | } |
| 65 | 64 | ||
| 66 | FILES_${PN} = " \ | 65 | FILES_${PN} = " \ |
| 67 | ${localstatedir}/sota/* \ | 66 | ${localstatedir}/sota/* \ |
| 68 | ${libdir}/sota/sota.toml \ | 67 | ${libdir}/sota/conf.d/20-sota.toml \ |
| 69 | ${libdir}/sota/root.crt \ | 68 | ${libdir}/sota/root.crt \ |
| 70 | " | 69 | " |
| 71 | 70 | ||
diff --git a/recipes-sota/aktualizr/aktualizr-hsm-prov.bb b/recipes-sota/aktualizr/aktualizr-hsm-prov.bb index 5f8da3c..290167f 100644 --- a/recipes-sota/aktualizr/aktualizr-hsm-prov.bb +++ b/recipes-sota/aktualizr/aktualizr-hsm-prov.bb | |||
| @@ -18,15 +18,15 @@ require environment.inc | |||
| 18 | require credentials.inc | 18 | require credentials.inc |
| 19 | 19 | ||
| 20 | do_install() { | 20 | do_install() { |
| 21 | install -d ${D}${libdir}/sota | 21 | install -m 0700 -d ${D}${libdir}/sota/conf.d |
| 22 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then | 22 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then |
| 23 | aktualizr_implicit_writer -c ${SOTA_PACKED_CREDENTIALS} --no-root-ca \ | 23 | aktualizr_implicit_writer -c ${SOTA_PACKED_CREDENTIALS} --no-root-ca \ |
| 24 | -i ${STAGING_DIR_NATIVE}${libdir}/sota/sota_hsm_prov.toml -o ${D}${libdir}/sota/sota.toml -p ${D} | 24 | -i ${STAGING_DIR_NATIVE}${libdir}/sota/sota_hsm_prov.toml -o ${D}${libdir}/sota/conf.d/20-sota.toml -p ${D} |
| 25 | fi | 25 | fi |
| 26 | } | 26 | } |
| 27 | 27 | ||
| 28 | FILES_${PN} = " \ | 28 | FILES_${PN} = " \ |
| 29 | ${libdir}/sota/sota.toml \ | 29 | ${libdir}/sota/conf.d/20-sota.toml \ |
| 30 | " | 30 | " |
| 31 | 31 | ||
| 32 | # vim:set ts=4 sw=4 sts=4 expandtab: | 32 | # vim:set ts=4 sw=4 sts=4 expandtab: |
diff --git a/recipes-sota/aktualizr/aktualizr-implicit-prov.bb b/recipes-sota/aktualizr/aktualizr-implicit-prov.bb index cf3d22c..2f9980a 100644 --- a/recipes-sota/aktualizr/aktualizr-implicit-prov.bb +++ b/recipes-sota/aktualizr/aktualizr-implicit-prov.bb | |||
| @@ -18,15 +18,15 @@ require environment.inc | |||
| 18 | require credentials.inc | 18 | require credentials.inc |
| 19 | 19 | ||
| 20 | do_install() { | 20 | do_install() { |
| 21 | install -d ${D}${libdir}/sota | 21 | install -m 0700 -d ${D}${libdir}/sota/conf.d |
| 22 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then | 22 | if [ -n "${SOTA_PACKED_CREDENTIALS}" ]; then |
| 23 | aktualizr_implicit_writer -c ${SOTA_PACKED_CREDENTIALS} \ | 23 | aktualizr_implicit_writer -c ${SOTA_PACKED_CREDENTIALS} \ |
| 24 | -i ${STAGING_DIR_NATIVE}${libdir}/sota/sota_implicit_prov.toml -o ${D}${libdir}/sota/sota.toml -p ${D} | 24 | -i ${STAGING_DIR_NATIVE}${libdir}/sota/sota_implicit_prov.toml -o ${D}${libdir}/sota/conf.d/20-sota.toml -p ${D} |
| 25 | fi | 25 | fi |
| 26 | } | 26 | } |
| 27 | 27 | ||
| 28 | FILES_${PN} = " \ | 28 | FILES_${PN} = " \ |
| 29 | ${libdir}/sota/sota.toml \ | 29 | ${libdir}/sota/conf.d/20-sota.toml \ |
| 30 | ${libdir}/sota/root.crt \ | 30 | ${libdir}/sota/root.crt \ |
| 31 | " | 31 | " |
| 32 | 32 | ||
diff --git a/recipes-sota/aktualizr/aktualizr_git.bb b/recipes-sota/aktualizr/aktualizr_git.bb index 9e2dc3c..f455013 100644 --- a/recipes-sota/aktualizr/aktualizr_git.bb +++ b/recipes-sota/aktualizr/aktualizr_git.bb | |||
| @@ -5,7 +5,7 @@ SECTION = "base" | |||
| 5 | LICENSE = "MPL-2.0" | 5 | LICENSE = "MPL-2.0" |
| 6 | LIC_FILES_CHKSUM = "file://${S}/LICENSE;md5=9741c346eef56131163e13b9db1241b3" | 6 | LIC_FILES_CHKSUM = "file://${S}/LICENSE;md5=9741c346eef56131163e13b9db1241b3" |
| 7 | 7 | ||
| 8 | DEPENDS = "boost curl openssl libarchive libsodium asn1c-native " | 8 | DEPENDS = "boost curl openssl libarchive libsodium asn1c-native sqlite3 " |
| 9 | DEPENDS_append_class-target = "ostree ${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'hsm', ' libp11', '', d)} " | 9 | DEPENDS_append_class-target = "ostree ${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'hsm', ' libp11', '', d)} " |
| 10 | DEPENDS_append_class-native = "glib-2.0-native " | 10 | DEPENDS_append_class-native = "glib-2.0-native " |
| 11 | 11 | ||
| @@ -22,7 +22,7 @@ SRC_URI = " \ | |||
| 22 | file://aktualizr-secondary.socket \ | 22 | file://aktualizr-secondary.socket \ |
| 23 | file://aktualizr-serialcan.service \ | 23 | file://aktualizr-serialcan.service \ |
| 24 | " | 24 | " |
| 25 | SRCREV = "9a813ab0857a2448ac2c2dbc5300e47164db7f01" | 25 | SRCREV = "5fa9a79f1fb29266c862a9a6cb32082bb77844a5" |
| 26 | BRANCH ?= "master" | 26 | BRANCH ?= "master" |
| 27 | 27 | ||
| 28 | S = "${WORKDIR}/git" | 28 | S = "${WORKDIR}/git" |
| @@ -54,21 +54,21 @@ EXTRA_OECMAKE_append_class-native = " -DBUILD_SOTA_TOOLS=ON \ | |||
| 54 | do_install_append () { | 54 | do_install_append () { |
| 55 | rm -fr ${D}${libdir}/systemd | 55 | rm -fr ${D}${libdir}/systemd |
| 56 | rm -f ${D}${libdir}/sota/sota.toml # Only needed for the Debian package | 56 | rm -f ${D}${libdir}/sota/sota.toml # Only needed for the Debian package |
| 57 | install -d ${D}${libdir}/sota | 57 | install -m 0700 -d ${D}${libdir}/sota/conf.d |
| 58 | install -m 0644 ${S}/config/sota_secondary.toml ${D}/${libdir}/sota/sota_secondary.toml | 58 | install -m 0644 ${S}/config/sota_secondary.toml ${D}/${libdir}/sota/sota_secondary.toml |
| 59 | install -d ${D}${systemd_unitdir}/system | 59 | install -d ${D}${systemd_unitdir}/system |
| 60 | install -m 0644 ${WORKDIR}/aktualizr-secondary.socket ${D}${systemd_unitdir}/system/aktualizr-secondary.socket | 60 | install -m 0644 ${WORKDIR}/aktualizr-secondary.socket ${D}${systemd_unitdir}/system/aktualizr-secondary.socket |
| 61 | install -m 0644 ${WORKDIR}/aktualizr-secondary.service ${D}${systemd_unitdir}/system/aktualizr-secondary.service | 61 | install -m 0644 ${WORKDIR}/aktualizr-secondary.service ${D}${systemd_unitdir}/system/aktualizr-secondary.service |
| 62 | install -m 0700 -d ${D}${sysconfdir}/sota/conf.d | ||
| 62 | } | 63 | } |
| 63 | 64 | ||
| 64 | do_install_append_class-target () { | 65 | do_install_append_class-target () { |
| 65 | install -d ${D}${systemd_unitdir}/system | 66 | install -m 0755 -d ${D}${systemd_unitdir}/system |
| 66 | aktualizr_service=${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'serialcan', '${WORKDIR}/aktualizr-serialcan.service', '${WORKDIR}/aktualizr.service', d)} | 67 | aktualizr_service=${@bb.utils.contains('SOTA_CLIENT_FEATURES', 'serialcan', '${WORKDIR}/aktualizr-serialcan.service', '${WORKDIR}/aktualizr.service', d)} |
| 67 | install -m 0644 ${aktualizr_service} ${D}${systemd_unitdir}/system/aktualizr.service | 68 | install -m 0644 ${aktualizr_service} ${D}${systemd_unitdir}/system/aktualizr.service |
| 68 | } | 69 | } |
| 69 | 70 | ||
| 70 | do_install_append_class-native () { | 71 | do_install_append_class-native () { |
| 71 | install -d ${D}${libdir}/sota | ||
| 72 | install -m 0644 ${S}/config/sota_autoprov.toml ${D}/${libdir}/sota/sota_autoprov.toml | 72 | install -m 0644 ${S}/config/sota_autoprov.toml ${D}/${libdir}/sota/sota_autoprov.toml |
| 73 | install -m 0644 ${S}/config/sota_autoprov_primary.toml ${D}/${libdir}/sota/sota_autoprov_primary.toml | 73 | install -m 0644 ${S}/config/sota_autoprov_primary.toml ${D}/${libdir}/sota/sota_autoprov_primary.toml |
| 74 | install -m 0644 ${S}/config/sota_hsm_prov.toml ${D}/${libdir}/sota/sota_hsm_prov.toml | 74 | install -m 0644 ${S}/config/sota_hsm_prov.toml ${D}/${libdir}/sota/sota_hsm_prov.toml |
| @@ -85,7 +85,9 @@ FILES_${PN} = " \ | |||
| 85 | ${bindir}/aktualizr \ | 85 | ${bindir}/aktualizr \ |
| 86 | ${bindir}/aktualizr-info \ | 86 | ${bindir}/aktualizr-info \ |
| 87 | ${bindir}/aktualizr-check-discovery \ | 87 | ${bindir}/aktualizr-check-discovery \ |
| 88 | ${libdir}/sota/conf.d \ | ||
| 88 | ${systemd_unitdir}/system/aktualizr.service \ | 89 | ${systemd_unitdir}/system/aktualizr.service \ |
| 90 | ${sysconfdir}/sota/conf.d \ | ||
| 89 | " | 91 | " |
| 90 | 92 | ||
| 91 | FILES_${PN}-common = " \ | 93 | FILES_${PN}-common = " \ |
diff --git a/recipes-sota/aktualizr/environment.inc b/recipes-sota/aktualizr/environment.inc index 09da6b7..16e789e 100644 --- a/recipes-sota/aktualizr/environment.inc +++ b/recipes-sota/aktualizr/environment.inc | |||
| @@ -1,17 +1,11 @@ | |||
| 1 | export SOTA_LEGACY_SECONDARY_INTERFACE | ||
| 2 | export SOTA_VIRTUAL_SECONDARIES | 1 | export SOTA_VIRTUAL_SECONDARIES |
| 3 | 2 | ||
| 4 | do_install_append() { | 3 | do_install_append() { |
| 5 | if [ -n "${SOTA_LEGACY_SECONDARY_INTERFACE}" ]; then | ||
| 6 | AKTUALIZR_PARAMETERS_LEGACYSEC="--legacy-interface ${SOTA_LEGACY_SECONDARY_INTERFACE}" | ||
| 7 | fi | ||
| 8 | |||
| 9 | AKTUALIZR_PARAMETERS_CONFIGFILE="--config /usr/lib/sota/sota.toml" | ||
| 10 | for sec in ${SOTA_VIRTUAL_SECONDARIES}; do | 4 | for sec in ${SOTA_VIRTUAL_SECONDARIES}; do |
| 11 | AKTUALIZR_PARAMETERS_VIRTUALSECS="${AKTUALIZR_PARAMETERS_VIRTUALSECS} --secondary-config $sec" | 5 | AKTUALIZR_PARAMETERS_VIRTUALSECS="${AKTUALIZR_PARAMETERS_VIRTUALSECS} --secondary-config $sec" |
| 12 | done | 6 | done |
| 13 | 7 | ||
| 14 | echo "AKTUALIZR_CMDLINE_PARAMETERS=${AKTUALIZR_PARAMETERS_CONFIGFILE} ${AKTUALIZR_PARAMETERS_LEGACYSEC} ${AKTUALIZR_PARAMETERS_VIRTUALSECS}" > ${D}${libdir}/sota/sota.env | 8 | echo "AKTUALIZR_CMDLINE_PARAMETERS=${AKTUALIZR_PARAMETERS_VIRTUALSECS}" > ${D}${libdir}/sota/sota.env |
| 15 | } | 9 | } |
| 16 | 10 | ||
| 17 | FILES_${PN}_append = " ${libdir}/sota/sota.env" | 11 | FILES_${PN}_append = " ${libdir}/sota/sota.env" |
diff --git a/recipes-sota/config/aktualizr-disable-send-ip.bb b/recipes-sota/config/aktualizr-disable-send-ip.bb new file mode 100644 index 0000000..ce492e9 --- /dev/null +++ b/recipes-sota/config/aktualizr-disable-send-ip.bb | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | SUMMARY = "Disable IP reporting in Aktualizr" | ||
| 2 | DESCRIPTION = "Configures aktualizr to disable IP reporting to the server" | ||
| 3 | HOMEPAGE = "https://github.com/advancedtelematic/aktualizr" | ||
| 4 | SECTION = "base" | ||
| 5 | LICENSE = "MPL-2.0" | ||
| 6 | LIC_FILES_CHKSUM = "file://${WORKDIR}/LICENSE;md5=9741c346eef56131163e13b9db1241b3" | ||
| 7 | |||
| 8 | SRC_URI = " \ | ||
| 9 | file://LICENSE \ | ||
| 10 | " | ||
| 11 | |||
| 12 | do_install_append () { | ||
| 13 | install -m 0700 -d ${D}${libdir}/sota/conf.d | ||
| 14 | echo "[telemetry]\nreport_network = false\n" > ${D}${libdir}/sota/conf.d/30-disable-send-ip.toml | ||
| 15 | } | ||
| 16 | |||
| 17 | FILES_${PN} = " \ | ||
| 18 | ${libdir}/sota/conf.d/30-disable-send-ip.toml \ | ||
| 19 | " | ||
| 20 | |||
| 21 | # vim:set ts=4 sw=4 sts=4 expandtab: | ||
| 22 | |||
diff --git a/recipes-sota/config/aktualizr-example-interface.bb b/recipes-sota/config/aktualizr-example-interface.bb new file mode 100644 index 0000000..52ebe1c --- /dev/null +++ b/recipes-sota/config/aktualizr-example-interface.bb | |||
| @@ -0,0 +1,21 @@ | |||
| 1 | SUMMARY = "Aktualizr example interface" | ||
| 2 | DESCRIPTION = "Aktualizr example interface for legacy secondaries" | ||
| 3 | HOMEPAGE = "https://github.com/advancedtelematic/aktualizr" | ||
| 4 | SECTION = "base" | ||
| 5 | LICENSE = "MPL-2.0" | ||
| 6 | LIC_FILES_CHKSUM = "file://${WORKDIR}/LICENSE;md5=9741c346eef56131163e13b9db1241b3" | ||
| 7 | |||
| 8 | SRC_URI = " \ | ||
| 9 | file://LICENSE \ | ||
| 10 | " | ||
| 11 | |||
| 12 | do_install_append () { | ||
| 13 | install -m 0700 -d ${D}${libdir}/sota/conf.d | ||
| 14 | echo "[uptane]\nlegacy_interface = \"/usr/bin/example-interface\"\n" > ${D}${libdir}/sota/conf.d/30-example-interface.toml | ||
| 15 | } | ||
| 16 | |||
| 17 | FILES_${PN} = " \ | ||
| 18 | ${libdir}/sota/conf.d/30-example-interface.toml \ | ||
| 19 | " | ||
| 20 | |||
| 21 | # vim:set ts=4 sw=4 sts=4 expandtab: | ||
diff --git a/recipes-sota/config/aktualizr-log-debug.bb b/recipes-sota/config/aktualizr-log-debug.bb new file mode 100644 index 0000000..e32a414 --- /dev/null +++ b/recipes-sota/config/aktualizr-log-debug.bb | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | SUMMARY = "Set debug logging in Aktualizr" | ||
| 2 | DESCRIPTION = "Configures aktualizr to log at a debugging level" | ||
| 3 | HOMEPAGE = "https://github.com/advancedtelematic/aktualizr" | ||
| 4 | SECTION = "base" | ||
| 5 | LICENSE = "MPL-2.0" | ||
| 6 | LIC_FILES_CHKSUM = "file://${WORKDIR}/LICENSE;md5=9741c346eef56131163e13b9db1241b3" | ||
| 7 | |||
| 8 | SRC_URI = " \ | ||
| 9 | file://LICENSE \ | ||
| 10 | " | ||
| 11 | |||
| 12 | do_install_append () { | ||
| 13 | install -m 0700 -d ${D}${libdir}/sota/conf.d | ||
| 14 | echo "[logger]\nloglevel = 0\n" > ${D}${libdir}/sota/conf.d/90-log-debug.toml | ||
| 15 | } | ||
| 16 | |||
| 17 | FILES_${PN} = " \ | ||
| 18 | ${libdir}/sota/conf.d/90-log-debug.toml \ | ||
| 19 | " | ||
| 20 | |||
| 21 | # vim:set ts=4 sw=4 sts=4 expandtab: | ||
| 22 | |||
diff --git a/recipes-sota/config/files/LICENSE b/recipes-sota/config/files/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/recipes-sota/config/files/LICENSE | |||
| @@ -0,0 +1,373 @@ | |||
| 1 | Mozilla Public License Version 2.0 | ||
| 2 | ================================== | ||
| 3 | |||
| 4 | 1. Definitions | ||
| 5 | -------------- | ||
| 6 | |||
| 7 | 1.1. "Contributor" | ||
| 8 | means each individual or legal entity that creates, contributes to | ||
| 9 | the creation of, or owns Covered Software. | ||
| 10 | |||
| 11 | 1.2. "Contributor Version" | ||
| 12 | means the combination of the Contributions of others (if any) used | ||
| 13 | by a Contributor and that particular Contributor's Contribution. | ||
| 14 | |||
| 15 | 1.3. "Contribution" | ||
| 16 | means Covered Software of a particular Contributor. | ||
| 17 | |||
| 18 | 1.4. "Covered Software" | ||
| 19 | means Source Code Form to which the initial Contributor has attached | ||
| 20 | the notice in Exhibit A, the Executable Form of such Source Code | ||
| 21 | Form, and Modifications of such Source Code Form, in each case | ||
| 22 | including portions thereof. | ||
| 23 | |||
| 24 | 1.5. "Incompatible With Secondary Licenses" | ||
| 25 | means | ||
| 26 | |||
| 27 | (a) that the initial Contributor has attached the notice described | ||
| 28 | in Exhibit B to the Covered Software; or | ||
| 29 | |||
| 30 | (b) that the Covered Software was made available under the terms of | ||
| 31 | version 1.1 or earlier of the License, but not also under the | ||
| 32 | terms of a Secondary License. | ||
| 33 | |||
| 34 | 1.6. "Executable Form" | ||
| 35 | means any form of the work other than Source Code Form. | ||
| 36 | |||
| 37 | 1.7. "Larger Work" | ||
| 38 | means a work that combines Covered Software with other material, in | ||
| 39 | a separate file or files, that is not Covered Software. | ||
| 40 | |||
| 41 | 1.8. "License" | ||
| 42 | means this document. | ||
| 43 | |||
| 44 | 1.9. "Licensable" | ||
| 45 | means having the right to grant, to the maximum extent possible, | ||
| 46 | whether at the time of the initial grant or subsequently, any and | ||
| 47 | all of the rights conveyed by this License. | ||
| 48 | |||
| 49 | 1.10. "Modifications" | ||
| 50 | means any of the following: | ||
| 51 | |||
| 52 | (a) any file in Source Code Form that results from an addition to, | ||
| 53 | deletion from, or modification of the contents of Covered | ||
| 54 | Software; or | ||
| 55 | |||
| 56 | (b) any new file in Source Code Form that contains any Covered | ||
| 57 | Software. | ||
| 58 | |||
| 59 | 1.11. "Patent Claims" of a Contributor | ||
| 60 | means any patent claim(s), including without limitation, method, | ||
| 61 | process, and apparatus claims, in any patent Licensable by such | ||
| 62 | Contributor that would be infringed, but for the grant of the | ||
| 63 | License, by the making, using, selling, offering for sale, having | ||
| 64 | made, import, or transfer of either its Contributions or its | ||
| 65 | Contributor Version. | ||
| 66 | |||
| 67 | 1.12. "Secondary License" | ||
| 68 | means either the GNU General Public License, Version 2.0, the GNU | ||
| 69 | Lesser General Public License, Version 2.1, the GNU Affero General | ||
| 70 | Public License, Version 3.0, or any later versions of those | ||
| 71 | licenses. | ||
| 72 | |||
| 73 | 1.13. "Source Code Form" | ||
| 74 | means the form of the work preferred for making modifications. | ||
| 75 | |||
| 76 | 1.14. "You" (or "Your") | ||
| 77 | means an individual or a legal entity exercising rights under this | ||
| 78 | License. For legal entities, "You" includes any entity that | ||
| 79 | controls, is controlled by, or is under common control with You. For | ||
| 80 | purposes of this definition, "control" means (a) the power, direct | ||
| 81 | or indirect, to cause the direction or management of such entity, | ||
| 82 | whether by contract or otherwise, or (b) ownership of more than | ||
| 83 | fifty percent (50%) of the outstanding shares or beneficial | ||
| 84 | ownership of such entity. | ||
| 85 | |||
| 86 | 2. License Grants and Conditions | ||
| 87 | -------------------------------- | ||
| 88 | |||
| 89 | 2.1. Grants | ||
| 90 | |||
| 91 | Each Contributor hereby grants You a world-wide, royalty-free, | ||
| 92 | non-exclusive license: | ||
| 93 | |||
| 94 | (a) under intellectual property rights (other than patent or trademark) | ||
| 95 | Licensable by such Contributor to use, reproduce, make available, | ||
| 96 | modify, display, perform, distribute, and otherwise exploit its | ||
| 97 | Contributions, either on an unmodified basis, with Modifications, or | ||
| 98 | as part of a Larger Work; and | ||
| 99 | |||
| 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer | ||
| 101 | for sale, have made, import, and otherwise transfer either its | ||
| 102 | Contributions or its Contributor Version. | ||
| 103 | |||
| 104 | 2.2. Effective Date | ||
| 105 | |||
| 106 | The licenses granted in Section 2.1 with respect to any Contribution | ||
| 107 | become effective for each Contribution on the date the Contributor first | ||
| 108 | distributes such Contribution. | ||
| 109 | |||
| 110 | 2.3. Limitations on Grant Scope | ||
| 111 | |||
| 112 | The licenses granted in this Section 2 are the only rights granted under | ||
| 113 | this License. No additional rights or licenses will be implied from the | ||
| 114 | distribution or licensing of Covered Software under this License. | ||
| 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a | ||
| 116 | Contributor: | ||
| 117 | |||
| 118 | (a) for any code that a Contributor has removed from Covered Software; | ||
| 119 | or | ||
| 120 | |||
| 121 | (b) for infringements caused by: (i) Your and any other third party's | ||
| 122 | modifications of Covered Software, or (ii) the combination of its | ||
| 123 | Contributions with other software (except as part of its Contributor | ||
| 124 | Version); or | ||
| 125 | |||
| 126 | (c) under Patent Claims infringed by Covered Software in the absence of | ||
| 127 | its Contributions. | ||
| 128 | |||
| 129 | This License does not grant any rights in the trademarks, service marks, | ||
| 130 | or logos of any Contributor (except as may be necessary to comply with | ||
| 131 | the notice requirements in Section 3.4). | ||
| 132 | |||
| 133 | 2.4. Subsequent Licenses | ||
| 134 | |||
| 135 | No Contributor makes additional grants as a result of Your choice to | ||
| 136 | distribute the Covered Software under a subsequent version of this | ||
| 137 | License (see Section 10.2) or under the terms of a Secondary License (if | ||
| 138 | permitted under the terms of Section 3.3). | ||
| 139 | |||
| 140 | 2.5. Representation | ||
| 141 | |||
| 142 | Each Contributor represents that the Contributor believes its | ||
| 143 | Contributions are its original creation(s) or it has sufficient rights | ||
| 144 | to grant the rights to its Contributions conveyed by this License. | ||
| 145 | |||
| 146 | 2.6. Fair Use | ||
| 147 | |||
| 148 | This License is not intended to limit any rights You have under | ||
| 149 | applicable copyright doctrines of fair use, fair dealing, or other | ||
| 150 | equivalents. | ||
| 151 | |||
| 152 | 2.7. Conditions | ||
| 153 | |||
| 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted | ||
| 155 | in Section 2.1. | ||
| 156 | |||
| 157 | 3. Responsibilities | ||
| 158 | ------------------- | ||
| 159 | |||
| 160 | 3.1. Distribution of Source Form | ||
| 161 | |||
| 162 | All distribution of Covered Software in Source Code Form, including any | ||
| 163 | Modifications that You create or to which You contribute, must be under | ||
| 164 | the terms of this License. You must inform recipients that the Source | ||
| 165 | Code Form of the Covered Software is governed by the terms of this | ||
| 166 | License, and how they can obtain a copy of this License. You may not | ||
| 167 | attempt to alter or restrict the recipients' rights in the Source Code | ||
| 168 | Form. | ||
| 169 | |||
| 170 | 3.2. Distribution of Executable Form | ||
| 171 | |||
| 172 | If You distribute Covered Software in Executable Form then: | ||
| 173 | |||
| 174 | (a) such Covered Software must also be made available in Source Code | ||
| 175 | Form, as described in Section 3.1, and You must inform recipients of | ||
| 176 | the Executable Form how they can obtain a copy of such Source Code | ||
| 177 | Form by reasonable means in a timely manner, at a charge no more | ||
| 178 | than the cost of distribution to the recipient; and | ||
| 179 | |||
| 180 | (b) You may distribute such Executable Form under the terms of this | ||
| 181 | License, or sublicense it under different terms, provided that the | ||
| 182 | license for the Executable Form does not attempt to limit or alter | ||
| 183 | the recipients' rights in the Source Code Form under this License. | ||
| 184 | |||
| 185 | 3.3. Distribution of a Larger Work | ||
| 186 | |||
| 187 | You may create and distribute a Larger Work under terms of Your choice, | ||
| 188 | provided that You also comply with the requirements of this License for | ||
| 189 | the Covered Software. If the Larger Work is a combination of Covered | ||
| 190 | Software with a work governed by one or more Secondary Licenses, and the | ||
| 191 | Covered Software is not Incompatible With Secondary Licenses, this | ||
| 192 | License permits You to additionally distribute such Covered Software | ||
| 193 | under the terms of such Secondary License(s), so that the recipient of | ||
| 194 | the Larger Work may, at their option, further distribute the Covered | ||
| 195 | Software under the terms of either this License or such Secondary | ||
| 196 | License(s). | ||
| 197 | |||
| 198 | 3.4. Notices | ||
| 199 | |||
| 200 | You may not remove or alter the substance of any license notices | ||
| 201 | (including copyright notices, patent notices, disclaimers of warranty, | ||
| 202 | or limitations of liability) contained within the Source Code Form of | ||
| 203 | the Covered Software, except that You may alter any license notices to | ||
| 204 | the extent required to remedy known factual inaccuracies. | ||
| 205 | |||
| 206 | 3.5. Application of Additional Terms | ||
| 207 | |||
| 208 | You may choose to offer, and to charge a fee for, warranty, support, | ||
| 209 | indemnity or liability obligations to one or more recipients of Covered | ||
| 210 | Software. However, You may do so only on Your own behalf, and not on | ||
| 211 | behalf of any Contributor. You must make it absolutely clear that any | ||
| 212 | such warranty, support, indemnity, or liability obligation is offered by | ||
| 213 | You alone, and You hereby agree to indemnify every Contributor for any | ||
| 214 | liability incurred by such Contributor as a result of warranty, support, | ||
| 215 | indemnity or liability terms You offer. You may include additional | ||
| 216 | disclaimers of warranty and limitations of liability specific to any | ||
| 217 | jurisdiction. | ||
| 218 | |||
| 219 | 4. Inability to Comply Due to Statute or Regulation | ||
| 220 | --------------------------------------------------- | ||
| 221 | |||
| 222 | If it is impossible for You to comply with any of the terms of this | ||
| 223 | License with respect to some or all of the Covered Software due to | ||
| 224 | statute, judicial order, or regulation then You must: (a) comply with | ||
| 225 | the terms of this License to the maximum extent possible; and (b) | ||
| 226 | describe the limitations and the code they affect. Such description must | ||
| 227 | be placed in a text file included with all distributions of the Covered | ||
| 228 | Software under this License. Except to the extent prohibited by statute | ||
| 229 | or regulation, such description must be sufficiently detailed for a | ||
| 230 | recipient of ordinary skill to be able to understand it. | ||
| 231 | |||
| 232 | 5. Termination | ||
| 233 | -------------- | ||
| 234 | |||
| 235 | 5.1. The rights granted under this License will terminate automatically | ||
| 236 | if You fail to comply with any of its terms. However, if You become | ||
| 237 | compliant, then the rights granted under this License from a particular | ||
| 238 | Contributor are reinstated (a) provisionally, unless and until such | ||
| 239 | Contributor explicitly and finally terminates Your grants, and (b) on an | ||
| 240 | ongoing basis, if such Contributor fails to notify You of the | ||
| 241 | non-compliance by some reasonable means prior to 60 days after You have | ||
| 242 | come back into compliance. Moreover, Your grants from a particular | ||
| 243 | Contributor are reinstated on an ongoing basis if such Contributor | ||
| 244 | notifies You of the non-compliance by some reasonable means, this is the | ||
| 245 | first time You have received notice of non-compliance with this License | ||
| 246 | from such Contributor, and You become compliant prior to 30 days after | ||
| 247 | Your receipt of the notice. | ||
| 248 | |||
| 249 | 5.2. If You initiate litigation against any entity by asserting a patent | ||
| 250 | infringement claim (excluding declaratory judgment actions, | ||
| 251 | counter-claims, and cross-claims) alleging that a Contributor Version | ||
| 252 | directly or indirectly infringes any patent, then the rights granted to | ||
| 253 | You by any and all Contributors for the Covered Software under Section | ||
| 254 | 2.1 of this License shall terminate. | ||
| 255 | |||
| 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all | ||
| 257 | end user license agreements (excluding distributors and resellers) which | ||
| 258 | have been validly granted by You or Your distributors under this License | ||
| 259 | prior to termination shall survive termination. | ||
| 260 | |||
| 261 | ************************************************************************ | ||
| 262 | * * | ||
| 263 | * 6. Disclaimer of Warranty * | ||
| 264 | * ------------------------- * | ||
| 265 | * * | ||
| 266 | * Covered Software is provided under this License on an "as is" * | ||
| 267 | * basis, without warranty of any kind, either expressed, implied, or * | ||
| 268 | * statutory, including, without limitation, warranties that the * | ||
| 269 | * Covered Software is free of defects, merchantable, fit for a * | ||
| 270 | * particular purpose or non-infringing. The entire risk as to the * | ||
| 271 | * quality and performance of the Covered Software is with You. * | ||
| 272 | * Should any Covered Software prove defective in any respect, You * | ||
| 273 | * (not any Contributor) assume the cost of any necessary servicing, * | ||
| 274 | * repair, or correction. This disclaimer of warranty constitutes an * | ||
| 275 | * essential part of this License. No use of any Covered Software is * | ||
| 276 | * authorized under this License except under this disclaimer. * | ||
| 277 | * * | ||
| 278 | ************************************************************************ | ||
| 279 | |||
| 280 | ************************************************************************ | ||
| 281 | * * | ||
| 282 | * 7. Limitation of Liability * | ||
| 283 | * -------------------------- * | ||
| 284 | * * | ||
| 285 | * Under no circumstances and under no legal theory, whether tort * | ||
| 286 | * (including negligence), contract, or otherwise, shall any * | ||
| 287 | * Contributor, or anyone who distributes Covered Software as * | ||
| 288 | * permitted above, be liable to You for any direct, indirect, * | ||
| 289 | * special, incidental, or consequential damages of any character * | ||
| 290 | * including, without limitation, damages for lost profits, loss of * | ||
| 291 | * goodwill, work stoppage, computer failure or malfunction, or any * | ||
| 292 | * and all other commercial damages or losses, even if such party * | ||
| 293 | * shall have been informed of the possibility of such damages. This * | ||
| 294 | * limitation of liability shall not apply to liability for death or * | ||
| 295 | * personal injury resulting from such party's negligence to the * | ||
| 296 | * extent applicable law prohibits such limitation. Some * | ||
| 297 | * jurisdictions do not allow the exclusion or limitation of * | ||
| 298 | * incidental or consequential damages, so this exclusion and * | ||
| 299 | * limitation may not apply to You. * | ||
| 300 | * * | ||
| 301 | ************************************************************************ | ||
| 302 | |||
| 303 | 8. Litigation | ||
| 304 | ------------- | ||
| 305 | |||
| 306 | Any litigation relating to this License may be brought only in the | ||
| 307 | courts of a jurisdiction where the defendant maintains its principal | ||
| 308 | place of business and such litigation shall be governed by laws of that | ||
| 309 | jurisdiction, without reference to its conflict-of-law provisions. | ||
| 310 | Nothing in this Section shall prevent a party's ability to bring | ||
| 311 | cross-claims or counter-claims. | ||
| 312 | |||
| 313 | 9. Miscellaneous | ||
| 314 | ---------------- | ||
| 315 | |||
| 316 | This License represents the complete agreement concerning the subject | ||
| 317 | matter hereof. If any provision of this License is held to be | ||
| 318 | unenforceable, such provision shall be reformed only to the extent | ||
| 319 | necessary to make it enforceable. Any law or regulation which provides | ||
| 320 | that the language of a contract shall be construed against the drafter | ||
| 321 | shall not be used to construe this License against a Contributor. | ||
| 322 | |||
| 323 | 10. Versions of the License | ||
| 324 | --------------------------- | ||
| 325 | |||
| 326 | 10.1. New Versions | ||
| 327 | |||
| 328 | Mozilla Foundation is the license steward. Except as provided in Section | ||
| 329 | 10.3, no one other than the license steward has the right to modify or | ||
| 330 | publish new versions of this License. Each version will be given a | ||
| 331 | distinguishing version number. | ||
| 332 | |||
| 333 | 10.2. Effect of New Versions | ||
| 334 | |||
| 335 | You may distribute the Covered Software under the terms of the version | ||
| 336 | of the License under which You originally received the Covered Software, | ||
| 337 | or under the terms of any subsequent version published by the license | ||
| 338 | steward. | ||
| 339 | |||
| 340 | 10.3. Modified Versions | ||
| 341 | |||
| 342 | If you create software not governed by this License, and you want to | ||
| 343 | create a new license for such software, you may create and use a | ||
| 344 | modified version of this License if you rename the license and remove | ||
| 345 | any references to the name of the license steward (except to note that | ||
| 346 | such modified license differs from this License). | ||
| 347 | |||
| 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary | ||
| 349 | Licenses | ||
| 350 | |||
| 351 | If You choose to distribute Source Code Form that is Incompatible With | ||
| 352 | Secondary Licenses under the terms of this version of the License, the | ||
| 353 | notice described in Exhibit B of this License must be attached. | ||
| 354 | |||
| 355 | Exhibit A - Source Code Form License Notice | ||
| 356 | ------------------------------------------- | ||
| 357 | |||
| 358 | This Source Code Form is subject to the terms of the Mozilla Public | ||
| 359 | License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| 361 | |||
| 362 | If it is not possible or desirable to put the notice in a particular | ||
| 363 | file, then You may include the notice in a location (such as a LICENSE | ||
| 364 | file in a relevant directory) where a recipient would be likely to look | ||
| 365 | for such a notice. | ||
| 366 | |||
| 367 | You may add additional accurate notices of copyright ownership. | ||
| 368 | |||
| 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice | ||
| 370 | --------------------------------------------------------- | ||
| 371 | |||
| 372 | This Source Code Form is "Incompatible With Secondary Licenses", as | ||
| 373 | defined by the Mozilla Public License, v. 2.0. | ||
