1.5.7. Migration to 7.12.0¶
Caution
The minimum required system GLIBC version on GNU/Linux is now 2.28.
The minimum required Windows version is now Windows 10, version 1809 or Windows Server 2019.
1.5.7.1. Installer¶
Caution
Please manually uninstall any old version of the Axivion Suite before installing 7.12. Do not install version 7.12 of Axivion Suite over an older version (e.g., 7.11).
In previous versions, a guided installer for Windows was provided as an alternative
to extracting the .zip or .tar.gz archives. Starting with 7.12.0,
this has been replaced by a new cross-platform installer; a guided installer is now available for all three supported platforms (as an
.exe on Windows, .run on GNU/Linux, and .dmg on macOS).
Users on macOS or GNU/Linux who previously extracted the
Axivion Suite manually can now use the guided installer
as a simpler alternative that includes conveniences such as application shortcuts.
When using the guided installer, running setup.sh is no longer necessary,
as the installer
handles those steps automatically.
For a full overview of the new installer (including its usage for unattended/headless workflows), please refer to Basic Installation. The following sections document specific migration steps to prevent breaking existing setups.
Installer files¶
The distribution files for the Axivion Suite have been renamed as follows:
Name in 7.11 |
Name in 7.12 |
|
|---|---|---|
Windows Installer |
|
|
macOS Installer |
— |
|
GNU/Linux Installer |
— |
|
Windows Archive |
|
|
macOS Archive |
|
|
GNU/Linux Archive |
|
|
In addition, note that the <ver> part now uses dots instead of
underscores (e.g., 7.12.0 instead of 7_12_0).
Linux Dependencies¶
The installer has the following new dependencies on Linux:
GLIBC 2.28+
GLIBCXX 3.4.28+
- The installer is built with the Qt Installer Framework on Qt 6.8. This adds the following requirements:
X11 (or XWayland on Wayland systems)
GL libraries: libEGL.so.1, libGLX.so.0, libOpenGL.so.0
XCB libraries: libxcb-cursor.so.0, libxcb-icccm.so.4, libxcb-image.so.0, libxcb-keysyms.so.1, libxcb-randr.so.0, libxcb-render-util.so.0, libxcb-shape.so.0, libxcb-sync.so.1, libxcb-xfixes.so.0, libxcb-xkb.so.1, libxkbcommon-x11.so.0
The Qt for X11 Requirements page (specifically “Platform Plugin Dependencies”) provides additional details.
Run ldd ./Axivion-*-gnu_linux.run | grep "not found" to check for missing dependencies.
Please note that these dependencies refer only to the installer, not the installed Axivion Suite itself.
Default install locations¶
The default installation locations for Axivion Suite on Windows remain unchanged and are listed here for completeness. macOS and GNU/Linux previously had no default locations; they now use the locations shown below.
- Install for current user:
Windows:
%LOCALAPPDATA%\BauhausmacOS:
~/Applications/bauhaus-suite.Linux:
~/.local/bauhaus-suite.
- Install for all users:
Windows:
C:\Program Files (x86)\BauhausmacOS:
/Applications/bauhaus-suite.Linux:
/opt/bauhaus-suite.
License handling¶
The previous installer allowed you to install a license file (.key) after
installation.
This option remains available in the new installer, alongside the
new alternative of licensing the installation via a Qt Account.
Uninstalling¶
While the old Windows installer provided bauhaus-uninstaller.exe, the new installer includes maintenancetool.exe in the installation folder to fully uninstall Axivion Suite. This maintenance tool is also available on macOS and GNU/Linux, provided that
you used the guided installer instead of directly extracting the .tar.gz archive.
Note that uninstalling Axivion Suite via the “Installed Apps” page in Settings may not work
correctly on Windows 11. Instead, you must either uninstall via the “Programs and Features” page in the
Control Panel,
or directly run the maintenancetool.exe in the installation folder.
1.5.7.2. Project Configuration¶
The default behavior for missing configuration files has changed: it is now an error if a configuration file referenced in an interface layer or the
BAUHAUS_CONFIG
variable cannot be found. This change helps identify
problems
early when configuration files are renamed or filenames are mistyped.
This may cause errors in configurations that worked in previous versions.
To fix such errors, please correct or remove any incorrect file references indicated by the error messages. If a file reference is intended but the file is not always present (e.g., it is generated), the reference can be made optional (see Optional layers).
As a last resort, the previous behavior of tolerating missing configuration files can be
restored by passing the --continue_on_missing_config parameter to
axivion_ci and axivion_analysis. This is not recommended, as it
disables the improved error checking of the new approach.
1.5.7.3. Continuous Integration¶
Local Build¶
The configuration option /Project/local_mode.reference_version.continue_with_old_reference_data
has been removed in favor of a dedicated Offline Local Build mode. This mode
allows for a Local Build without a running dashboard or a reference version for
comparison. Currently, this feature is supported only by the
Visual Studio Code Plugin and the
Local Build without Plugins;
other plugins will be supported in future releases.
1.5.7.4. Entry point configuration¶
The configuration of additional entry points via EntryPoints-EntriesByAttribute is now enabled by default. With the default configuration, routines with interrupt set as an attribute will be considered entry points. This applies to both C++ attributes and GCC-style attributes.
1.5.7.5. IR¶
In class Composite_Type, the members Friend_Routines and Friend_Classes have been merged into a single member Friends. This member now holds all friend declarations, including templates that previously did not appear in either member.
1.5.7.6. Dashboard¶
LDAP/ActiveDirectory¶
The following security-relevant hint has been added to the documentation:
Caution
LDAP/ActiveDirectory users are not
automatically deleted from the
internal user database when they are
deleted from the LDAP/ActiveDirectory server.
To prevent these users from accessing the Dashboard (via internal password or
Dashboard provided API Tokens)
after deletion from your LDAP/ActiveDirectory server, ensure that the
Log in permission is only
granted to these users via an LDAP group membership.
Dashboard Windows Service¶
If the dashboard is running as a Windows service, the service registration must be updated due to an update to the Windows Service Wrapper used by the Axivion Dashboard.
First, remove the service registration by executing sc stop <service_name> and sc delete <service_name> from an administrator command prompt. Then reinstall the
service by invoking dashserver install.
Note that the service wrapper now requires .NET Framework 4.6.1 or higher.
Internal Passwords for LDAP users¶
Previously, users could use their LDAP password to change and/or set a new internal password. Internal passwords can now only be changed after confirming the previous internal password. Importantly, this prevents users authenticated via LDAP/Active Directory from setting an internal password unless an administrator has explicitly set one for them. This gives administrators full control over whether users can authenticate using an internal password.
1.5.7.7. Stylechecks¶
Renamed rule group¶
The rule group Generic has been renamed to Miscellaneous to avoid potential
confusion with the new GeneralPurpose rule group, which now
provides best
practice checks.
Rules previously part of Generic have been moved into either
Miscellaneous or GeneralPurpose, as appropriate.
The migration from Generic to Miscellaneous occurs automatically for JSON configuration files; however, other occurrences, such as those in Python
configuration
files, must be replaced manually.
Note that control comments inside the source code will continue to work with the old rule names.
Structured links instead of secondary positions¶
References to other source locations have been moved to dedicated rows in the issue details sidebar for several rules. For example, findings attached to a function call may now have a “Callee” row that includes a link to the corresponding function. Previously, these were reported as “secondary positions” in an “Additional SLocs” row.
This may require changes to post-processing code that uses the secondary_sloc repeated field of bauhaus.analysis_results.Style_Violation.
The secondary locations are now available via entries in the extra_info field, e.g., as follows:
# before:
for sloc in sv.secondary_sloc:
...
# now:
from bauhaus.analysis.post_processing import find_slocs_in_extra_info_entry
for entry in sv.extra_info:
if entry.key != "Callee":
continue
for sloc in find_slocs_in_extra_info_entry(entry.value_xml):
...
Default behavior of rules utilizing taint analysis¶
Taint analysis identifies data flows originating from specific code locations of interest (sources) that reach other locations (sinks) which should not be reached without being sanitized – that is, checked for validity or modified so the flow is no longer sensitive. For example, a routine that returns a password entered at a prompt may be considered a source, writing to a database may be considered a sink, and proper password hashing may be considered a sanitizer.
Prior to this release, the logic for identifying sources and sinks was defective, causing too many locations to be flagged. The following rules were affected:
To address this issue, we introduced new options all_external_functions_as_sources and all_external_functions_as_sources to all of these rules and provided sensible defaults. If enabled, non-excluded external functions are considered
sources (or sinks), where ‘external’ means ‘declaration-only within the IR or declared in a system header’. Reasonable default exclusions have been
implemented, but further exclusions can be configured in the external_source and sinks options of these rules.
Due to these changes, you may initially see substantially more false-positive findings with the aforementioned rules, as more locations may be spuriously considered default sources or sinks. In that case, you should add these locations/routines as exclusions. If you believe an exclusion is universal (such as a library function that never produces tainted data), please contact our support team so we can assess the proposal and implement it internally.
1.5.7.8. CloneDetection rules adjustments¶
The clone detection rules have been grouped into a new group called
“CloneDetections,” and
the rule CloneDetection has been renamed to
C++CloneDetection for consistency with other language-specific clone detection rules.
The migration from CloneDetection to C++CloneDetection occurs
automatically for
JSON configuration files; other occurrences, such as those in Python configuration files, must be replaced manually.
1.5.7.9. Axivion Suite Plugin for Visual Studio Code¶
When the username is omitted in the plugin’s Dashboard configuration (the
axivion.dashboards entries in the Visual Studio Code settings.json,
not an Axivion Suite configuration file, see Configuration),
the plugin now falls back to “anon_auth” to support anonymous authentication.
Previously, the system username was used.
If the previous behavior is required, use the new environment variable syntax in
the Visual Studio Code settings.json:
{
"id": "...",
"url": "...",
"username": "${env:USER}"
}
USER (GNU/Linux and macOS) and USERNAME (Windows) are
treated as
interchangeable; if the specified variable is not set, the plugin falls back
to the other, ensuring a single spelling works across all platforms.
1.5.7.10. Metrics¶
Renamed Metric-LOC to Metric-Lines.Routine.Body.LOC¶
The metric rule Metric-LOC has been renamed to
Metric-Lines.Routine.Body.LOC to better reflect what is measured.
Similarly, the default value of the rfg_metric_name option has
changed from Metric.LOC to Metric.Lines.Routine.Body.LOC.
The rule name will be migrated automatically for JSON configuration files; other
occurrences, such as those in Python configuration files, must be replaced
manually. Similarly, any uses of the old rfg attribute name Metic.LOC
must be manually changed to Metric.Lines.Routine.Body.LOC.
Caution
This change will cause all existing violations of the Metric-LOC rule to be removed
and re-added under Metric-Lines.Routine.Body.LOC.
1.5.7.11. UI Tools¶
Wayland support for UI Tools¶
Gravis, axivion_config and irviewer now run in native Wayland mode
on Linux Wayland sessions. Before version 7.12.0, they used the XWayland
compatibility layer.
If compatibility problems with the Wayland compositor occur, these programs may
fail
to display their main window and appear to hang. In such cases, they can be switched back to XWayland compatibility mode by setting the
environment variable QT_QPA_PLATFORM=xcb.
Gravis configuration¶
Changed interpretation of graph style configuration (High-DPI support)¶
Starting with version 7.12.0, Gravis offers improved support for high-DPI screens. More user interface elements will now appear consistently on high-DPI screens and standard-resolution displays. All stored measurements now use device-independent pixels, which may require changes to custom graph style configurations.
Before version 7.12.0, all pixel measurements in the Gravis configuration (edge
widths, node symbol border widths, and arrow sizes) were interpreted as device-dependent
screen pixels and had to be configured to match the pixel density of the current
display. On systems with high-DPI displays, it was recommended to use a custom
configuration file that doubled the default edge and
node symbol border widths. A custom configuration was provided that could be installed to $(HOME)/.bauhaus/gravis.json (Linux/macOS) or
%USERHOME%\.bauhaus\gravis.json (Windows).
Starting with version 7.12, measurements are interpreted as device-independent pixels and are scaled by the system DPI scale factor. Consequently, the default configuration is suitable for both standard-resolution and high-DPI displays. Additionally, Gravis configuration files can now be shared between systems with different displays.
Custom configurations for high-DPI devices are no longer necessary; keeping such a file in place will now double the widths of edges and node symbol borders. It is recommended to remove these changes.
If the provided configuration file was used as-is, simply remove it from the location mentioned above. If the file contains other configuration changes, the
width fields in the /Tools/Gravis/graph_style/edge_types setting and the pen-width and expanded-pen-width fields in the
/Tools/Gravis/graph_style/node_types
setting should be adapted. This can be done in the graphical user
interface.
Note
Stored layouts have been device-independent since version 7.6.8 and can be used on both standard-resolution and high-DPI displays without adaptation.