Skip to content

Commit e3fe0cf

Browse files
committed
Add information on logging and security requirements.
Signed-off-by: Mike Lazar <mihai_lazar@dell.com>
1 parent 6fce350 commit e3fe0cf

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

doc/mgmt/Docker to Host communication.md

+18-7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Docker to Host communication
1818
| Rev | Date | Author | Change Description |
1919
|:---:|:-----------:|:------------------:|-----------------------------------|
2020
| 0.1 | 10/28/2019 | Nirenjan Krishnan | Initial version |
21+
|:---:|:-----------:|:------------------:|-----------------------------------|
22+
| 0.2 | 12/16/2019 | Mike Lazar | Add details about architecture |
23+
2124

2225
# About this Manual
2326
This document provides general information about the Docker to Host
@@ -31,9 +34,9 @@ however, it does not describe the individual host-specific features.
3134
# Definition/Abbreviation
3235

3336
### Table 1: Abbreviations
34-
| **Term** | **Meaning** |
35-
|--------------------------|-------------------------------------|
36-
| XYZ | Term description |
37+
| **Term** | **Meaning** |
38+
|--------------------------|---------------------------------------------------|
39+
| D-Bus | Desktop Bus: https://en.wikipedia.org/wiki/D-Bus |
3740

3841
# 1 Feature Overview
3942

@@ -56,6 +59,9 @@ the Docker container and the host.
5659
host.
5760
* The host communication API shall be available in Translib, and shall provide
5861
both synchronous and asynchronous communication methods.
62+
* It shall be possible to configure the identity of the Linux user accounts who have access to a D-Bus socket.
63+
* It shall be possible to configure containers in such a way that only certain containers (e.g. SONiC Mgmt.)
64+
have access to the D-Bus socket.
5965

6066
### 1.1.2 Configuration and Management Requirements
6167

@@ -117,16 +123,21 @@ channel (asynchronous request).
117123
The architecture of a D-Bus host service in a SONiC environment is illustrated in the diagram below:
118124
![](images/docker-to-host-services-architecture.jpg)
119125

120-
Note. The Linux D-Bus implementation uses Unix domain sockets for client to D-Bus service communications.
121-
All containers that use D-Bus services will bind mount
126+
Note. The Linux D-Bus implementation uses Unix domain sockets for client to D-Bus service communications.
127+
All containers that use D-Bus services will bind mount
122128
(-v /var/run/dbus:/var/run/dbus:rw) the host directory where D-Bus service sockets are created.
129+
This ensures that only the desired containers access the D-Bus host services.
123130

124131
D-Bus provides a reliable communication channel between client (SONiC management container) and service (native host OS) – all actions are acknowledged and can provide return values. It should be noted that acknowledgements are important for operations such as “image upgrade” or “config-save”. In addition, D-Bus methods can return values of many types – not just ACKs. For instance, they can return strings, useful to return the output of a command.
125132

126-
127133
### 3.1.1 Security of D-Bus Communications
128134
In addition to standard Linux security mechanisms for file/Unix socket access rights (read/write), D-Bus provides a separate security layer, using the D-Bus service configuration files.
129-
This allows finer grain access control to D-Bus objects and methods.
135+
This allows finer grain access control to D-Bus objects and methods - D-Bus can restrict access only to certain Linux users.
136+
137+
### 3.1.2 Command Logging
138+
139+
It is possible to track and log the user name and the command that the user has requested.
140+
The log record is created in the system log.
130141

131142
## 3.2 DB Changes
132143
### 3.2.1 CONFIG DB

0 commit comments

Comments
 (0)