Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.51 KB

Development_documentation.md

File metadata and controls

67 lines (46 loc) · 2.51 KB
Raw

File naming convention

All files used by config editor are prefixed with 50-config. They are automatically generated, manual changes may be overwritten at any point.

Clickable URLs

To add a label with a URL that's to be opened in the default dispvm, add it's label to _handle_urls.

Policy Handlers

The generic class PolicyHandlers allows for handling of simple policy files, with some variability for rules where we want to set target vm, or target= and default_target params.

Widget naming convention

Every instance of PolicyHandler has its own prefix.

Normal policy handler

The following widgets are required:

  • Gtk.ListBox {prefix}_main_list that will contain fundamental rules
  • Gtk.ListBox {prefix}_exception_list that will contain exceptions to the rules
  • Gtk.Button {prefix}_add_rule_button for the add new rule button
  • Gtk.EventBox {prefix}_raw_event for the button for clickable raw rule expander
  • Gtk.Box {prefix}_raw_box box containing widgets with raw rule text
  • Gtk.Image {prefix}_raw_expander Image for the expanding triangle icon
  • Gtk.TextView {prefix}_raw_text raw text of the rule
  • Gtk.Button {prefix}_raw_save button for saving the raw rule text changes
  • Gtk.Button {prefix}_raw_cancel button for cancelling the raw rule text changes
  • Gtk.RadioButton {prefix}_enable_radio RadioButton to enable custom policy changes
  • Gtk.RadioButton {prefix}_disable_radio RadioButton to set default policy
  • Gtk.Box {prefix}_problem_box box with information about conflicting policy files
  • Gtk.ListBox {prefix}_problem_files_list list of conflicting policy files
  • Gtk.Box {prefix}_error_box has information about errors in loaded policy
  • Gtk.ListBox {prefix}_error_list list of erroneous policy rules

Dispvm-related policy handler

  • Gtk.ListBox {prefix}_exception_list for exception RuleListBoxRows
  • Gtk.Button {prefix}_add_rule_button button to add new rules
  • Gtk.Box {prefix}_current_state_box box that contains the current state of dispvm
  • Gtk.Box {prefix}_error_box box that contains info about policy errors
  • Gtk.Box {prefix}_problem_box box that contains info about conflicting files
  • Gtk.ListBox {prefix}_error_list list of encountered policy errors
  • Gtk.ListBox {prefix}_problem_files_list list of conflicting policy files

Testing

Run mypy in main directory:

mypy

Run pylint in main directory:

python3 -m pylint qubes_config --rcfile=.pylintrc

Run pytest in main directory (requires the rest of qubes sources to be available)

./runtest.sh