diff --git a/README.md b/README.md index ccab302..0952f44 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,8 @@ Additional information TODO (wish list) ---------------- -* add helper polkit-qt integration -* security notes / project architecture +* add helper polkit-qt integration ? +* update to show error messages if debug=true * autotests Links diff --git a/sources/gui/docs/netctl-gui-security-notes.html b/sources/gui/docs/netctl-gui-security-notes.html index a76781e..5c3c418 100644 --- a/sources/gui/docs/netctl-gui-security-notes.html +++ b/sources/gui/docs/netctl-gui-security-notes.html @@ -10,11 +10,10 @@
  1. Description
  2. Architecture
    3. -
  3. KDE components security
    4. -
  4. Graphical interface security
  5. Library security
  6. Helper security
    7. - +
  7. Graphical interface security
    8. +
  8. KDE components security
  9. External links
@@ -26,33 +25,8 @@

Architecture

architecture -

KDE components security

-

There are two netctl-based commands which are run from the DataEngine

- -

Both of them do not require any additional privileges normally. Also DataEngine has two other command which will be run from; they should define external IP. According to the idea that user can set any command to run, this module is not secure. But running commands will not do more than user can do from console himself.

- -

The widget gets information from DataEngine, thus it does not require any additional permissions to show information. But netctl calls with root privileges are used to control netctl. In this case used commands are

- -

All netctl-based commands requires root privileges and sudo (and any other alternatives) is used normally as prefix to the commands. The netctl-auto command does not require additional permissions.

- -

The other way is to use DBus communication with the helper. In this case user should have rights to start the helper.

- -

Graphical interface security

-

Graphical interface may interact with netctl over DBus (the helper) and over the library. Please refer to their notes to any additional information. If user uses helper he should have permissions to run it.

- -

Library security

-

According to the scheme library gets information from netctl and can control it. Also it provides some additional functions such as a profile creation and removal and access to wpa_supplicant functions. Some function does not require additional permissions, but other ones do it. All dynamic arguments including profile names and paths are in double quotes to avoid white spaces problem. The functions which requires root privileges are:

+

Library security

+

According to the scheme the library gets information from netctl and can control it. Also it provides some additional functions such as a profile creation and removal and access to wpa_supplicant functions. Some functions do not require additional permissions, but other ones do it. All dynamic arguments including profile names and paths are in double quotes to avoid white spaces problem. The functions which require root privileges are:

+

If library will be initialized with FORCE_SUDO=true than it will use sudo command (which can be transferred to the library by SUDO_PATH option). Otherwise it will try to set UID of children processes to 0. Please note that sudo command and UID setting will be used only for those commands which require it.

+ +

Helper security

+

First of all the helper does not interact with netctl directly, it uses the library to do it. So all library security notes are applicable here. To start the helper and to create DBus services user must be in netcwork group by default (or must be root). But you may change it by editing $DBUS_SYSTEMCONF_PATH/org.netctlgui.helper.conf policy file (/etc/dbus-1/system.d/org.netctlgui.helper.conf by default). Please refer to DBus documentation to do it.

+ +

There are two binaries netctgui-helper and netctlgui-helper-suid. They are the same, but the second one has SUID bit, so it can be running by normal user without any password. Please note that it is dangerous and recommended way is to use systemd daemon. In this case you may not install netctlgui-helper-suid binary.

+ +

There are two configuration files $HOME/.config/netctl-gui.conf and /etc/netctl-gui.conf. The first one is a user configuration and the second one is a system-wide. Please note that by default user configuration has higher priority than system-wide, but running with --system flag user configuration will not be reading. The helper and GUI configurations are the same (although some keys aren't needed).

+ +

Graphical interface security

+

Graphical interface may interact with netctl over DBus (the helper) and over the library. Please refer to their notes to any additional information. If user uses helper he should have permissions to run it.

+ +

KDE components security

+

There are two netctl-based commands which are run from the DataEngine

+ +

Both of them do not require any additional privileges normally. Also DataEngine has two other command which will be run from; they should define external IP. According to the idea that user can set any command to run, this module is not secure. But running commands will not do more than user can do from console himself.

+ +

The widget gets information from DataEngine, thus it does not require any additional permissions to show information. But netctl calls are used to control netctl. In this case used commands are

+ +

All netctl-based commands require root privileges and sudo (and any other alternatives) is used normally as prefix to the commands. The netctl-auto command does not require additional permissions.

+ +

The other way is to use DBus communication with the helper. In this case user should have rights to start the helper.

+

External links