Skip to content

Latest commit

 

History

History
805 lines (706 loc) · 33.7 KB

CHANGES.rst

File metadata and controls

805 lines (706 loc) · 33.7 KB
Raw

Changelog

Version 1.2.0 [Unreleased]

Work in progress.

Version 1.1.0 [2024-11-22]

Features

Changes

  • Removing a VPN template from a device will not deleted the certificates associated with the VPNClient. Instead, the certificates will be marked as revoked.
  • Allowed reusing VNI across all the tunnels created using an instance VXLAN over WireGuard VPN.
  • Added a data migration for updating hwmode configuration option of radio to "band". The hwmode option is deprecated on OpenWrt > 21.
  • The configuration push update will not flag the configuration status as "applied". The status will be update once the OpenWISP Config agent on the device reports the status.
  • Updated DeviceConnection.connect to attempt all available credentials.
  • Changed the on_cascade property of BaseDeviceLocation.location and BaseDeviceLocation.floorplan from PROTECTED to CASCADE.
  • Controller views will return HTTP 404 response for devices belonging to disabled organizations.
  • Show a loading indicator for commands in progress.
  • Added VPN subnet CIDR to device's system-defined variables.
  • Allowed defining subnet and IP address for VPNs with OpenVPN backend.
  • Changed the target link for configuration error notifications to the "Configuration" tab of the device.
  • JSONSchema Editor widget allows to define extra CSS classes. It will ignore fields with manual class.
  • Increased the soft time limit for celery task that operates of bulk objects.
  • Added notifications for background subnet division rule errors.
  • Added name and mac_address to device list filters in the API.
  • Use autocomplete fields for related fields.

Dependencies:

  • Bumped django-sortedm2m~=4.0.0.
  • Bumped django-reversion~=5.1.0.
  • Bumped django-taggit~=4.0.0.
  • Bumped netjsonconfig~=1.1.0.
  • Bumped django-x509~=1.2.0.
  • Bumped django-loci~=1.1.0.
  • Bumped django-flat-json-widget~=0.3.0.
  • Bumped openwisp-users~=1.1.0.
  • Bumped openwisp-utils[celery]~=1.1.1.
  • Bumped openwisp-notifications~=1.1.0.
  • Bumped openwisp-ipam~=1.1.0.
  • Bumped djangorestframework-gis~=1.1.
  • Bumped paramiko[ed25519]~=3.5.0.
  • Bumped scp~=0.15.0.
  • Bumped django-cache-memoize~=0.2.0.
  • Bumped shortuuid~=1.0.13.
  • Bumped netaddr~=1.3.0.
  • Bumped django-import-export~=3.3.0.
  • Added support for Django 4.1.x and 4.2.x.
  • Added support for Python 3.10.
  • Dropped support for Python 3.7.
  • Dropped support for Django 3.0.x and 3.1.x.

Bugfixes

Version 1.0.3 [2022-08-03]

Bugfixes

Version 1.0.2 [2022-07-01]

Bugfixes

Version 1.0.1 [2022-05-11]

Bugfixes

  • Admin: show main group information in DeviceGroupAdmin list: - name - organization - modified - created
  • Fixed uncaught exception triggered on the deletion of VPN client certificates
  • SSH connection: fixed OpenWrt <= 19 authentication failure
  • The SSH connection is now explicitly closed when the authentication fails to avoid leaving lingering SSH connection objects open

Version 1.0.0 [2022-04-29]

Features

Changes

Backward incompatible changes

  • Since django-sortedm2m, the widget we use to implement ordered templates, clears all the many to many relationships every time it has to make changes, we had to stop deleting VpnClient instances related to VPN templates on post_clear m2m signals If you wrote any custom derivative which relies on calls like device.config.templates.clear() to delete related VpnClient instances and their x509 certificates, you will have to update your code to remove all the templates using their primary keys, instead of using clear()
  • The default behavior for the resolution of conflicting management IPs between devices of different organizations has been changed; by default, in this new version, the system assumes it's using only 1 management tunnel for all the organizations, so different devices from any organization will not have the same management IP to avoid conflicts. The old behaviour can be restored by setting OPENWISP_CONTROLLER_SHARED_MANAGEMENT_IP_ADDRESS_SPACE to False
  • OPENWISP_CONTROLLER_BACKEND_DEVICE_LIST has been renamed to OPENWISP_CONTROLLER_CONFIG_BACKEND_FIELD_SHOWN
  • Device.check_management_ip_changed has been changed to private API Device._check_management_ip_changed

Dependencies

  • Dropped support for Python 3.6
  • Dropped support for Django 2.2
  • Added support for Python 3.8 and 3.9
  • Added support for Django 3.2 and 4.0
  • Upgraded django-sortedm2m to 3.1.x
  • Upgraded django-reversion to 4.0.x
  • Upgraded django-taggit to 2.1.x
  • Upgraded djangorestframework-gis to 0.18.0
  • Upgraded paramiko[ed25519] to 2.10.3
  • Upgraded scp to 0.14.2
  • Upgraded django-flat-json-widget to 0.2.x
  • Upgraded celery to 5.2.x
  • Upgraded channels to 3.0.x
  • Upgraded django-x509 to 1.1.x
  • Upgraded django-loci to 1.0.x
  • Upgraded netjsonconfig to 1.0.x
  • Upgraded openwisp-utils to 1.0.x
  • Upgraded openwisp-users to 1.0.x
  • Upgraded openwisp-notifications to 1.0.x
  • Upgraded openwisp-ipam to 1.0.x
  • Added shortuuid 1.0.x
  • Added netaddr 0.8.x
  • Added django-cache-memoize to 0.1

Other changes

  • Reworked implementation of config_modified signal:
    • the signal is now always emitted on templates changes m2m events, also if config.status is modified, with the differences that only post_add and post_remove m2m events are used, while post_clear is ignored, which fixes the duplicate signal emission caused by the implementation of sortedm2m;
    • added action and previous_status arguments, which allow to understand where the config_modified signal is being emitted from, this allows more advanced usage of the signal by custom implementations
  • Context variable follows template order: If two or more applied templates have "default_values" with the same keys, then the context variables of the template which comes later in the order will be used
  • New credentials created with auto_add set to True will get added to the existing devices in a background task. This improves the responsiveness of the web application
  • Decoupled admin LogEntry from Template model
  • Device admin only lists relevant templates, i.e. templates that are shared or belong to the device's organization
  • Improved UX of system-defined variables
  • Name of Vpn, Template and Credentials objects is unique only within the same organization and within the shared objects
  • Added functionality to configure connection failure reasons for which the system should not send notifications. Added old_failure_reason parameter in openwisp_controller.connection.signals.is_working_changed signal
  • Allowed searching devices using their location address in Device admin.
  • Removed deprecated api/device-location/<pk> endpoint
  • Made device name unique per organization instead of unique system wide
  • Added time limits to background celery tasks

Bugfixes

  • Fixed a bug which caused VpnClient instances to be recreated every time the configuration templates of a device were changed, which caused x590 certificates to be destroyed and recreated as well
  • Hardened config validation of OpenVPN backend. The validation fails if the openvpn key is missing from the configuration
  • Fixed a bug that caused issues in updating related Config whenever a template's default_values were changed
  • Fixed pop-up view of CA and Cert not displaying data
  • Fixed config status stays applied after clearing all device templates
  • Fixed VpnClient not created when multiple VPN templates are added
  • Fixed configuration editor raising validation error when using variables in fields with maxLength set
  • Fixed connection notifications reporting outdated status
  • Fixed migrations referencing non-swappable OpenWISP modules that broke OpenWISP's extensibility
  • Fixed bugs in restoring deleted devices using django-reversion
  • Fixed cloning of shared templates
  • Disallowed blank values for key_length or digest fields for CA and Cert objects
  • Fixed template ordering bug in the configuration preview on Device admin The order of templates was not always retained when generating the preview of a config object

Version 0.8.4 [2021-04-09]

Bugfixes

Security

  • Patched security bugs in internal HTTP endpoints which allowed to obtain UUID of other organizations and other sensitive information

Version 0.8.3 [2020-12-18]

Bugfixes

Version 0.8.2 [2020-12-11]

Bugfixes

  • Fixed the bug that prevented users from adding/editing access credentials.

Changes

  • Increased django-x509 version to 0.9.2
  • Increased django-flat-json-widget version to 0.1.2
  • Changed the preview button colors for better readability
  • Added help text for device name field

Version 0.8.1 [2020-12-02]

Bugfixes

  • Fixed tests that were dependent on specific settings of the Django project.

Version 0.8.0 [2020-11-23]

Features

  • Added possibility to extend openwisp-controller
  • Added flat JSON widget for configuration variables
  • Added JSON Schema widget to credentials admin
  • Added device_registered signal
  • Added OpenWISP Notifications module as a dependency, which brings support for web and email notifications for important events
  • Allow using a different device model in update_config: his allows OpenWISP Monitoring to override the can_be_updated method to take into account the monitoring status, so that push updates won't be attempted
  • Added notifications for changes of is_working status of credentials
  • UX, automatically add/remove default values to device context: automatically add or remove default values of templates to the configuration context (a.k.a. configuration variables) when templates are added or removed from devices
  • UX: added system defined variables section

Changes

  • Backward incompatible: the code of django-netjsonconfig was merged in openwisp-controller to simplify maintenance
  • Changed API of device_location view for consistency: /api/device-location/{id}/ becomes /api/v1/device/{id}/location/, the old URL is kept for backward compatibility but will be removed in the future
  • Backward incompatible change: schema url endpoint changed to <controller-url>/config/schema.json and it's now in config namespace instead of admin namespace
  • Changed VPN DH length to 2048 and move its generation to the background because it's a lot slower
  • Admin: Order Device, Template and VPN alphabetically by default
  • Admin: Added mac_address field to the device list page (DeviceAdmin.list_display)
  • Increased max_length of common name to 64
  • Changed the config apply logic to avoid restarting the openwisp-config deamon if the configuration apply procedure is already being run
  • Made template config field required in most cases
  • Changed DeviceConnection.failure_reason field to TextField, this avoids possible exception if failed_reason is very long, which may happen in some corner cases
  • Made Device verbose_name configurable, see OPENWISP_CONTROLLER_DEVICE_VERBOSE_NAME
  • Increased netjsonconfig version to 0.9.x (which brings support for new interface types, see the change log of netjsonconfig for more information)
  • Increased django-x509 version to 0.9.x
  • Increased django-loci version to 0.4.x (which brings many bug fixes to the mapping feature, as long as support for geo-coding and reverse geo-coding, see the change log of django-loci for more information)
  • Increased openwisp-users version from 0.2.x to 0.5.x (which brings many interesting improvements to multi-tenancy, see the change log of openwisp-users for more information)
  • Increased django-taggit version to 1.3.x
  • Increased openwisp-utils version to 0.7.x
  • Increased django-rest-framework-gis version to 0.16.x
  • Added support for django 3.1

Bugfixes

  • Fixed JSON validation error when dealing with OpenVPN configuration
  • Ensured unique in HARDWARE_ID_OPTIONS defaults to False
  • Avoid need of migration if HARDWARE_ID_OPTIONS is changed
  • JS: prevent crash if backend value is empty
  • Do not execute default template selection if device exists
  • Close preview overlay on errors
  • Avoid triggering config_modified signal during registration
  • UI: Fixed whitespace after overview tab in in device page
  • Validate Config.context and Template.default_values: Config.context and Template.default_values must always be a dictionary, falsy values will be converted to empty dictionary automatically
  • Fixed failures in update_config operation: the update_config operation will be executed only when the transaction is committed to the database; also handled rare but possible error conditions
  • Handled device not existing case in update_config task
  • Fixed auto cert feature failure when device name is too long
  • UI: avoid showing main scrollbar in preview mode
  • Fixed OPENWISP_CONTROLLER_BACKEND_DEVICE_LIST = False
  • UI fixed advanced mode bugs: positioning is done using css instead of js. Removed body scrollbar when in advanced mode. Back to normal mode with ESC key. Hidden netjsonconfig docs hint on narrow screens.
  • Avoid simultaneous update_config tasks: since now the launch of the task is executed when the transaction is committed to the database, also the check for other updates in progress must be moved there
  • Fixed OPENWISP_CONTROLLER_CONTEXT setting getting modified at run time
  • Fixed z-index of preview overlay: the z-index is increased so it's higher than the main navigation menu to avoid the possibility of triggering the main menu inadvertently
  • Prevent sending config_modified signal multiple times
  • Fix timeout when changing template: slow operations are moved to the background
  • Fixed variablle validation: now all the available context (device variables, system variables) are taken into account when performing validation
  • Removed unnecessary static() call from media assets

Version 0.7.0.post1 [2020-07-01]

  • Increased minimum django-netjsonconfig version to 0.12

Version 0.7.0 [2020-07-01]

  • [feature] Added signals: config_status_changed, checksum_requested, config_download_requested
  • [feature] Added the possibility of specifying default values for variables used in templates
  • [feature] Added banner_timeout
  • [feature] Emit signal when DeviceConnection.is_working changes
  • [change] Backward incompatible change: the config_modified signal is not emitted anymore when the device is created
  • [change] VPN files now have 0600 permissions by default
  • [change] Increased minimum netjsonconfig version to 0.8.0
  • [change] Increased minimum paramiko version to 2.7.1
  • [change] Increased minimum celery version to 4.4.3
  • [fix] Avoid errors being hidden by tabs
  • [fix] Fixed clashes between javascript schema validation and variables
  • [fix] Fixed exception when adding device credential without type
  • [fix] Fixed exception when auto adding device credentials to devices which don't have a configuration
  • [fix] Avoid multiple devices having the same management IP address (multiple devices having the same last IP is allowed because last IP is almost always a public address)
  • [docs] Documented SSH timeouts
  • [docs] Update outdated steps in README instructions

Version 0.6.0 [2020-04-02]

  • Added controller view that allows to update the device information (firmware version used)
  • Recover deleted object views in recoverable objects now show latest objects first
  • Added NETJSONCONFIG_HARDWARE_ID_AS_NAME setting

Version 0.5.2 [2020-03-18]

  • [controller] Added NETJSONCONFIG_REGISTRATION_SELF_CREATION
  • [models] Handled accidental duplication of files across templates
  • [controller] Update hardware device info during registration (if the device already exists, the registration will update its info)
  • [admin] Moved hardware_id field in device list admin
  • [bugfix] Fixed broken preview when using hardware_id context var
  • [models] Flagged hardware_id as not unique (it's unique_together with organization)
  • [admin] Hidden device configuration context field into advanced options
  • [models] Removed LEDE from the OpenWRT backend label
  • [docker] Added REDIS_URL to docker-compose.yml and settings.py (for dev and test env)

Version 0.5.1 [2020-02-28]

  • [models] Improved consistent key generation, now a consisten key is generated also when creating devices from the admin interface (or via model API), before it was only done during registration
  • [admin] Fixed unsaved changes JS bug that was triggered in certain cases
  • [deps] Switched back to jsonfield

Version 0.5.0 [2020-02-05]

  • [deps] Upgraded to django 3, upgraded dependencies
  • [deps] Dropped support for python 2
  • [x509] Fixed serial number max length (imported from django-x509)
  • [admin] Fixed bug that caused organization field to be missing when importing a CA or certificate

Version 0.4.0 [2020-01-09]

  • [feature] Added connection module (possibility to SSH into devices)
  • [feature] Added default operator group
  • [feature] Added management IP feature
  • [change] Changed configuration status: running has been renamed to applied
  • [admin] Added NETJSONCONFIG_MANAGEMENT_IP_DEVICE_LIST setting
  • [admin] Added NETJSONCONFIG_BACKEND_DEVICE_LIST setting
  • [x509] Fixed common_name redundancy
  • [admin] Hidden "Download Configuration" button when no config is available
  • [controller] Register view now updates device details
  • [deps] Added support for Django 2.1 and Django 2.2
  • [models] Added support for hardware ID / serial number
  • [device] Add context field to device
  • [bugfix] Show error when the preview is experiencing issues
  • [ux] Group device change form in tabs
  • [ux] Show loading indicator while loading preview
  • [vpn] Add controller views (download & checksum) for VPN config
  • [vpn] Fixed DH params in preview #107
  • [change] Moved urls to admin namespace
  • [feature] Implement copy/clone templates
  • [feature] Added API to get context of device
  • [bugfix] Ensure atomicity of transactions with database during auto-registration

Version 0.3.2 [2018-02-19]

  • [requirements] Updated requirements and added support for django 2.0

Version 0.3.1 [2017-12-20]

  • [pki] Reimplemented serial numbers as UUID integers
  • [pki] Added switcher that facilitates importing certificates
  • [pki] [admin] Removed serial_number from certificate list

Version 0.3.0 [2017-12-17]

  • [feature] Added geographic and indoor mapping module
  • [feature] Aded Dockerfile

Version 0.2.5 [2017-12-02]

  • #21: [admin] Added a link to password reset in login form

Version 0.2.4 [2017-11-07]

  • Added support for django-x509 0.3.0

Version 0.2.3 [2017-08-29]

  • 934be13: [models] Updated sortedm2m __str__ definition
  • b76e4e2: [requirements] django-netjsonconfig>=0.6.3,<0.7.0

Version 0.2.2 [2017-07-10]

Version 0.2.1 [2017-07-05]

  • 0064b98: [device] Added system field
  • c7fe513: [docs] Added "Installing for development" section to README
  • c75fa68: [openwisp-utils] Moved shared logic to openwisp-utils
  • 819cb21: [requirements] django-netjsonconfig>=0.6.2,<0.7.0

Version 0.2.0 [2017-05-24]

  • #3: [feature] Added support for template tags
  • #7: [feature] Added Device model
  • #9: [admin] Load default templates JS logic only when required
  • 298b2a2: [admin] Avoid setting extra_content to mutable object
  • d173c24: [migrations] Squashed 0001 and 0002 to avoid postgres error
  • f5fb628: [migrations] Updated indexes
  • 6200b7a: [Template] Fixed auto_client bug

Version 0.1.4 [2017-04-21]

  • #2: [admin] Added templates in config filter

Version 0.1.3 [2017-03-11]

  • db77ae7: [controller] Added "error: " prefix in error responses

Version 0.1.2 [2017-03-15]

  • 3c61053: [admin] Ensure preview button is present
  • 0087483: [models] Converted OrganizationConfigSettings to UUID primary key

Version 0.1.1 [2017-03-10]

Version 0.1.0 [2017-03-08]

  • added multi-tenancy (separation of organizations) to openwisp2
  • added email confirmation of new users (via django-allauth)