Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Edit qrexec command line tools descriptions

Browse Source
This commit is contained in:
pierwill 2019-12-05 22:13:15 -08:00
parent c967c7b145
commit 5bc91a4bcd
No known key found for this signature in database
GPG Key ID: D48E7EBDF0C3AEA0
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
developer/services/qrexec-internals.md
View File

@ -31,10 +31,14 @@ These tools are not designed to be used by users directly.
`/usr/sbin/qrexec-daemon` `/usr/sbin/qrexec-daemon`
One instance is required for every active domain. One instance is required for every active domain.
Responsible for: `qrexex-daemon` is responsible for both:
* Handling execution and service requests from **dom0** (source: `qrexec-client`). - handling execution and service requests from **dom0** (source: `qrexec-client`); and
* Handling service requests from the associated domain (source: `qrexec-client-vm`, then `qrexec-agent`). - handling service requests from the associated domain (source: `qrexec-client-vm`, then `qrexec-agent`).
* Command line: `qrexec-daemon domain-id domain-name [default user]`
Command line usage:
`qrexec-daemon domain-id domain-name [default user]`
* `domain-id`: Numeric Qubes ID assigned to the associated domain. * `domain-id`: Numeric Qubes ID assigned to the associated domain.
* `domain-name`: Associated domain name. * `domain-name`: Associated domain name.
* `default user`: Optional. If passed, `qrexec-daemon` uses this user as default for all execution requests that don't specify one. * `default user`: Optional. If passed, `qrexec-daemon` uses this user as default for all execution requests that don't specify one.
@ -50,12 +54,14 @@ Internal program used to evaluate the RPC policy and decide whether an RPC call
`/usr/bin/qrexec-client` `/usr/bin/qrexec-client`
Used to pass execution and service requests to `qrexec-daemon`. Used to pass execution and service requests to `qrexec-daemon`.
Command line parameters:
* `-d target-domain-name`: Specifies the target for the execution/service request. Command line usage:
* `-l local-program`: Optional. If present, `local-program` is executed and its stdout/stdin are used when sending/receiving data to/from the remote peer.
* `-e`: Optional. If present, stdout/stdin are not connected to the remote peer. Only process creation status code is received. * `-d target-domain-name`: Specifies the target for the execution/service request.
* `-c <request-id,src-domain-name,src-domain-id>`: used for connecting a VM-VM service request by `qrexec-policy`. Details described below in the service example. * `-l local-program`: Optional. If present, `local-program` is executed and its stdout/stdin are used when sending/receiving data to/from the remote peer.
* `cmdline`: Command line to pass to `qrexec-daemon` as the execution/service request. Service request format is described below in the service example. * `-e`: Optional. If present, stdout/stdin are not connected to the remote peer. Only process creation status code is received.
* `-c <request-id,src-domain-name,src-domain-id>`: used for connecting a VM-VM service request by `qrexec-policy`. Details described below in the service example.
* `cmdline`: Command line to pass to `qrexec-daemon` as the execution/service request. Service request format is described below in the service example.
## VM tools implementation ## VM tools implementation
@ -67,7 +73,8 @@ One instance runs in each active domain.
Responsible for: Responsible for:
* Handling service requests from `qrexec-client-vm` and passing them to connected `qrexec-daemon` in dom0. * Handling service requests from `qrexec-client-vm` and passing them to connected `qrexec-daemon` in dom0.
* Executing associated `qrexec-daemon` execution/service requests. * Executing associated `qrexec-daemon` execution/service requests.
* Command line parameters: none.
The `qrexec-agent` command takes no paramaters.
### qrexec-client-vm ### qrexec-client-vm
@ -75,7 +82,11 @@ Responsible for:
Runs in an active domain. Runs in an active domain.
Used to pass service requests to `qrexec-agent`. Used to pass service requests to `qrexec-agent`.
* Command line: `qrexec-client-vm target-domain-name service-name local-program [local program arguments]`
Command line usage:
`qrexec-client-vm target-domain-name service-name local-program [local program arguments]`
* `target-domain-name`: Target domain for the service request. Source is the current domain. * `target-domain-name`: Target domain for the service request. Source is the current domain.
* `service-name`: Requested service name. * `service-name`: Requested service name.
* `local-program`: `local-program` is executed locally and its stdin/stdout are connected to the remote service endpoint. * `local-program`: `local-program` is executed locally and its stdin/stdout are connected to the remote service endpoint.